EcoStruxure Building Operation

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

Introduction
1 About This Guide ........................................................ 47
1.1 Purpose of This Guide ............................................................... 49
1.2 How This Guide is Organized .................................................... 50
1.3 Safety Information ...................................................................... 51

2 Additional Information ................................................. 53

2.1 Where to Find Additional Information ......................................... 55

Reference
3 EcoStruxure Building Management ............................ 59
3.1 EcoStruxure Building Management Overview ........................... 61
3.1.1 Work Interface Overview .......................................................... 61
3.1.2 EcoStruxure BMS Server Overview ......................................... 61
3.1.3 Function Overview .................................................................. 61
3.1.4 Engineering Tools Overview ................................................... 61
3.1.5 Protocol Overview ................................................................... 61
3.1.6 Hardware Overview ................................................................ 62
3.1.7 Licensing, Installation, and Localization Overview ................. 62
3.1.8 System Registration Overview ................................................. 62
3.1.9 System Upgrade Overview ..................................................... 62
3.2 Work Interface Overview ............................................................ 63
3.2.1 WebStation Overview .............................................................. 63
3.2.2 WorkStation Overview .............................................................. 63
3.2.3 WebHelp Overview ................................................................. 63
3.3 Function Overview ..................................................................... 64
3.3.1 Alarm Overview ....................................................................... 64
3.3.2 Schedules Overview ............................................................... 64
3.3.3 Trend Overview ....................................................................... 64
3.3.4 User Account Management Overview .................................... 64
3.3.5 Backup and Restore Overview ............................................... 64
3.3.6 Documents Overview .............................................................. 65
3.3.7 Search Overview ..................................................................... 65
3.3.8 Shortcuts Overview ................................................................. 65

04-30005-01-en, May 2019 System

5
 3.3.9 Cloud Connectivity Overview ................................................... 65
3.4 Engineering Tools Overview ..................................................... 66
3.4.1 Spreadsheet Overview ............................................................ 66
3.4.2 Bindings Overview .................................................................. 66
3.4.3 Text Reports Overview ............................................................. 66
3.4.4 Import and Export Overview ................................................... 66
3.4.5 Script Overview ....................................................................... 66
3.4.6 Function Block Editor Overview .............................................. 67
3.4.7 Graphics Editor Overview ....................................................... 67
3.4.8 WebReports Overview ............................................................ 67
3.4.9 Project Configuration Tool Overview ........................................ 67
3.4.10 Vista Conversion Overview ...................................................... 67
3.4.11 Continuum Conversion Overview ............................................ 68
3.4.12 SmartXKiosk Overview ............................................................. 68
3.4.13 SmartX AD-Link Overview ........................................................ 68
3.5 Protocols Overview .................................................................... 69
3.5.1 I/O Modules Overview ............................................................. 69
3.5.2 MP Series Controller Overview ............................................... 69
3.5.3 BACnet Overview .................................................................... 69
3.5.4 b3 BACnet Device Overview .................................................. 69
3.5.5 MNB BACnet Device Overview ................................................ 70
3.5.6 LonWorks Overview ................................................................ 70
3.5.7 Xenta LonWorks Device Overview .......................................... 70
3.5.8 MNL LonWorks Device Overview ........................................... 70
3.5.9 Modbus Overview ................................................................... 70
3.5.10 I/NET Overview ........................................................................ 71
3.5.11 NETWORK 8000 Overview ...................................................... 71
3.5.12 MicroNet Overview .................................................................. 71
3.5.13 Sigma Overview ....................................................................... 71
3.5.14 Infinet Device Overview .......................................................... 71
3.5.15 SmartDrivers Overview ............................................................ 72
3.5.16 Web Services Overview ........................................................... 72
3.6 Licensing, Installation, and Localization Overview .................... 73
3.6.1 Licensing Overview ................................................................ 73
3.6.2 Installation Overview ............................................................... 73
3.6.3 Regional and Language Overview ......................................... 73

4 Installation .................................................................. 75
4.1 Installation Overview .................................................................. 77
4.1.1 Installation Packages ............................................................... 77
4.1.2 Products .................................................................................. 77
4.1.3 Installation Folder ..................................................................... 77
4.1.4 Installation Example ................................................................. 78
4.1.5 Installation Reparation ............................................................. 78
4.1.6 Reinstall ................................................................................... 78
4.1.7 System Upgrade Overview ...................................................... 78
4.1.8 Uninstallation ........................................................................... 79

System 04-30005-01-en, May 2019

6
 4.1.9 Version Numbers and Parallel Installations ............................. 79
4.1.10 Software Administrator ............................................................. 79
4.2 Products .................................................................................... 80
4.2.1 WorkStation ............................................................................. 80
4.2.2 Graphics Editor ........................................................................ 80
4.2.3 Script Editor ............................................................................. 80
4.2.4 Menta Editor ............................................................................. 81
4.2.5 Function Block Editor ............................................................... 81
4.2.6 WorkPlace Tech ....................................................................... 82
4.2.7 Enterprise Central .................................................................... 82
4.2.8 Enterprise Server ..................................................................... 82
4.2.9 Software Administrator ............................................................. 83
4.2.10 Device Administrator ............................................................... 83
4.2.11 License Administrator .............................................................. 83
4.2.12 License Server ......................................................................... 83
4.2.13 WebReports ............................................................................. 83
4.2.14 Language Package ................................................................. 84
4.3 Installation Example ................................................................... 85
4.4 Version Numbers and Parallel Installations ................................ 87
4.5 Installing the License Administrator and the License Server ..... 89
4.6 Installing WorkStation and Client Tools ...................................... 91
4.7 Installing a Language Pack ....................................................... 93
4.8 Installing Enterprise Central ....................................................... 94
4.9 Installing the Enterprise Server .................................................. 96
4.10 Installing the Device Administrator ............................................ 99

5 Installation Repair ..................................................... 101

5.1 Installation Reparation ............................................................. 103
5.2 Repairing the License Administrator and the License Server .. 104
5.3 Repairing WorkStation and Client Tools Installation ................ 106
5.4 Repairing the Enterprise Server ............................................... 108
5.5 Repairing the Device Administrator Installation ....................... 110

6 Reinstallation ............................................................ 111

6.1 Reinstallation ........................................................................... 113
6.2 Reinstalling the License Administrator and the License
Server ...................................................................................... 114
6.3 Reinstalling WorkStation and Client Tools ................................ 115
6.4 Reinstalling the Enterprise Server ............................................ 117
6.5 Reinstalling the Device Administrator Installation .................... 119

7 Computer Maintenance ............................................ 121

7.1 Replace Enterprise Server or WebReports Computer
Workflow .................................................................................. 123
7.1.1 Preparation ............................................................................ 123
7.1.2 Install EcoStruxure Building Operation Software ................... 124
7.1.3 Restore the Enterprise Server Database ............................... 125
7.1.4 WebReports Migration Preparation ....................................... 127

04-30005-01-en, May 2019 System

7
 7.1.5 Install WebReports ................................................................. 128

8 Uninstallation ............................................................ 131

8.1 Uninstallation ........................................................................... 133
8.2 Uninstalling the License Administrator .................................... 134
8.3 Uninstalling the License Server ............................................... 135
8.4 Uninstalling a Language Pack ................................................. 136
8.5 Uninstalling WorkStation .......................................................... 137
8.6 Uninstalling Enterprise Central ................................................ 138
8.7 Uninstalling Enterprise Server .................................................. 139
8.8 Uninstalling Device Administrator ............................................ 140

9 Installation User interface ......................................... 141

9.1 Installation Wizard – Choose Components Page ..................... 143
9.2 Installation Wizard – Installation Type Page ............................. 145
9.3 Installation Wizard – License Server Configuration Page ........ 146
9.4 Server Installation Wizard – Configuration Page ...................... 147

10 Licensing Introduction ............................................. 149

10.1 Licensing Overview ................................................................. 151
10.1.1 Licensing Model .................................................................... 151
10.1.2 License System ...................................................................... 151
10.1.3 License Management ............................................................ 151
10.1.4 Service and Maintenance ...................................................... 151
10.1.5 License Information ............................................................... 151
10.2 Licensing Model ...................................................................... 153
10.2.1 Client and Engineering Tool Licenses ................................... 153
10.2.2 Field Bus Device Licenses ..................................................... 153
10.2.3 SNMP Licenses ...................................................................... 153
10.2.4 Web Services Licenses ......................................................... 154
10.2.5 Licensing Enforcement .......................................................... 154
10.2.6 License Lifetime ..................................................................... 154
10.3 Field Bus Device Licenses ....................................................... 155
10.4 Licensing Enforcement ............................................................ 156
10.4.1 License Violation .................................................................... 156
10.5 License Information ................................................................. 157
10.5.1 Recommended Setup ............................................................ 157
10.5.2 Servers .................................................................................. 157
10.5.3 License Status ....................................................................... 157
10.6 License System ....................................................................... 159
10.6.1 License Activation Server ...................................................... 159
10.6.2 License Server ....................................................................... 159
10.6.3 License Administrator ............................................................ 159
10.6.4 Licenses ................................................................................ 160
10.7 License Management .............................................................. 161
10.7.1 License System Installation and Configuration ...................... 161
10.7.2 Network License Management .............................................. 162
10.7.3 Local License Management .................................................. 162

System 04-30005-01-en, May 2019

8
 10.8 Service and Maintenance ....................................................... 163
10.8.1 License Service Maintenance ................................................ 163
10.8.2 License Maintenance ............................................................. 163
10.8.3 Diagnostics ............................................................................ 163
10.8.4 License Log File ..................................................................... 164
10.9 License Maintenance .............................................................. 165
10.9.1 Local License Removal .......................................................... 165
10.9.2 Network License Return ......................................................... 165
10.9.3 Lost License ........................................................................... 165
10.9.4 License Repair ....................................................................... 165
10.9.5 License Backup ..................................................................... 165
10.10 Licenses .................................................................................. 166
10.10.1 End User License Agreement ................................................ 167
10.10.2 Local Licenses ....................................................................... 167
10.10.3 Network Licenses ................................................................. 168
10.10.4 Time-Limited Licenses ........................................................... 168
10.10.5 Permanent License ................................................................ 168
10.10.6 License Selection Process ..................................................... 168
10.11 Viewing Activated Licenses .................................................... 169
10.12 Editing Registration Details ...................................................... 170
10.13 License Selection Process ....................................................... 171
10.14 Order Information Request ...................................................... 172
10.15 Lost License ............................................................................. 174
10.16 License Repair ......................................................................... 175
10.17 License Backup ....................................................................... 176
10.18 Backing Up Licenses .............................................................. 177
10.19 Restoring Licenses .................................................................. 178

11 Type of Licenses ....................................................... 179

11.1 Network Licenses ................................................................... 181
11.2 Network License Management ................................................ 185
11.2.1 Order Information Request .................................................... 185
11.2.2 Network Licenses Activation .................................................. 185
11.2.3 Enterprise Server Address Configuration .............................. 185
11.2.4 WorkStation and Client Tools Address Configuration ............ 186
11.3 Network Licenses Activation .................................................... 187
11.4 Network License Return ........................................................... 189
11.5 Activating Network Licenses ................................................... 191
11.6 Removing a Local License or Returning a Network License .... 192
11.7 Repairing a Network License .................................................. 193
11.8 Local Licenses ......................................................................... 194
11.9 Local License Management .................................................... 195
11.9.1 Local License Activation ........................................................ 195
11.10 Activating a Local License ...................................................... 196

12 Licensing Configuration and Diagnostics ................. 197

12.1 Enterprise Server Address Configuration ................................ 199

04-30005-01-en, May 2019 System

9
 12.2 WorkStation and Client Tools Address Configuration .............. 201
12.3 Viewing Diagnostic Information ............................................... 202
12.4 Copying Diagnostics to the Clipboard .................................... 203
12.5 Showing the Licenses Log File ............................................... 204

13 License Server and License Administrator ............... 205

13.1 License Server ......................................................................... 207
13.1.1 Flexnet License Manager, License Server Manager ............. 207
13.2 Starting the License Server ...................................................... 208
13.3 Stopping the License Server .................................................... 209
13.4 Restarting the License Server .................................................. 210
13.5 Flexnet License Administrator, License Server Manager ........ 211
13.5.1 License Server Port Number .................................................. 212
13.5.2 FLEXnet License Administrator Port Number ........................ 213
13.6 Accessing Flexnet lmadmin ..................................................... 214
13.7 Changing the Flexnet lmadmin License Server Manager Port
Number .................................................................................... 215
13.8 License Administrator .............................................................. 216
13.8.1 Registration Details ................................................................ 216
13.8.2 License Server Address ........................................................ 216
13.9 Starting License Administrator ................................................. 217
13.10 License Server Address ........................................................... 218
13.11 Configuring the Address to the License Server ....................... 220
13.12 License Server Reset ............................................................... 221
13.13 Resetting the License Server ................................................... 222
13.14 Configuring License Server Recovery Settings ..................... 223
13.15 License Server Maintenance ................................................... 224
13.15.1 License Server Address Change ........................................... 224
13.15.2 License Server Reinstallation ................................................ 224
13.15.3 License Server Replacement ................................................. 224
13.15.4 License Server Reset ............................................................. 226
13.16 Device Administrator Licenses ................................................ 227
13.16.1 Licenses on SmartX Servers .................................................. 227
13.16.2 Entitlements, Products, and Licenses .................................... 227
13.16.3 Assign and Activate Licenses ................................................ 227
13.16.4 Certificates ............................................................................ 228
13.17 Entitlements, Products, and Licenses ...................................... 229
13.18 Assign and Activate Licenses ................................................. 230
13.18.1 Assign Licenses ..................................................................... 230
13.18.2 Activate Licenses ................................................................... 230
13.19 Device Administrator Licensing Workflow ............................... 231
13.20 Adding an Entitlement to Device Administrator ....................... 232
13.21 Removing an Entitlement ........................................................ 233
13.22 Assigning Licenses .................................................................. 234
13.23 Activating Licenses Online ..................................................... 235
13.24 Offline Activation of Licenses Workflow ................................... 236
13.25 Creating the Request Files ....................................................... 237

System 04-30005-01-en, May 2019

10
 13.26 Uploading the Request Files and Downloading the Response
Files ......................................................................................... 238
13.27 Sending the Response Files to the SmartX Server ................... 239

14 Licensing User Interface ........................................... 241

14.1 Registration Details View ......................................................... 243
14.2 Licenses View ......................................................................... 245
14.3 Licenses View Toolbar ............................................................. 246
14.4 Licenses View Icons ................................................................ 247
14.5 Licenses View Columns ........................................................... 248
14.6 Add License Dialog Box .......................................................... 249
14.7 License Activation Dialog Box ................................................. 250
14.8 License Progress Dialog Box ................................................... 252
14.9 License Server Address View .................................................. 253
14.10 Diagnostics View ..................................................................... 254
14.11 License Violation Bar ............................................................... 255
14.12 License Information Enterprise Server and SmartX Server ...... 256
14.13 License Information Enterprise Central .................................... 258
14.14 Add Entitlement Dialog Box ..................................................... 260
14.15 Assign Licenses View .............................................................. 261
14.16 Show Licenses View Toolbar ................................................... 263
14.17 Entitlements View ..................................................................... 264
14.18 Entitlements Contents View ...................................................... 265
14.19 Entitlements Product Licenses View ........................................ 267
14.20 Activate Licenses Dialog Box ................................................. 269
14.21 License Settings Dialog Box .................................................... 270
14.22 Offline Response Files Dialog Box .......................................... 271
14.23 License Status Bar ................................................................... 272

15 Software Administrator ............................................. 273

15.1 Software Administrator ............................................................ 275
15.1.1 Service ................................................................................... 275
15.1.2 Ports ...................................................................................... 275
15.1.3 Database Location ................................................................. 275
15.1.4 Enterprise Server and Enterprise Central System Logs ......... 275
15.2 Starting Software Administrator ............................................... 276
15.3 Configuring Server Port Settings .............................................. 277
15.4 Starting the Enterprise Central Windows Service .................... 278
15.5 Stopping the Enterprise Central Windows Service .................. 279
15.6 Starting the Enterprise Server or Enterprise Central Windows
Service ..................................................................................... 280
15.7 Stopping the Enterprise Server Windows Service ................... 281
15.8 Restarting the Enterprise Server Windows Service .................. 282
15.9 Enterprise Server and Enterprise Central System Logs ........... 283
15.10 Viewing the Enterprise Server or Enterprise Central System
Log ........................................................................................... 284
15.11 Resolving Enterprise Server or Enterprise Central Port
Conflicts ................................................................................... 285

04-30005-01-en, May 2019 System

11
 15.12 Software Administrator – Enterprise Central View .................... 286
15.13 Software Administrator – Enterprise Server View ..................... 288

16 Localization Language and Units ............................. 291

16.1 Regional and Language Overview .......................................... 293
16.1.1 Language and Translation Packages .................................... 293
16.1.2 Value Presentation ................................................................. 293
16.1.3 Time and Time Zone .............................................................. 293
16.2 Configuring Regional Settings ................................................. 294
16.3 Language Packages ............................................................... 295
16.3.1 Languages in WorkStation .................................................... 295
16.3.2 Languages in WebStation ...................................................... 295
16.4 Changing the WorkStation Language ...................................... 296
16.5 Adding a Language in WebStation .......................................... 297
16.6 Changing the Language in WebStation ................................... 298
16.7 Value Presentation ................................................................... 299
16.7.1 Units ...................................................................................... 299
16.7.2 Metric Prefixes ....................................................................... 299
16.7.3 Precision Format .................................................................... 299
16.8 Units ......................................................................................... 300
16.8.1 Delta Temperature Conversion ............................................. 300
16.9 Changing the WorkStation Measurement System .................... 302
16.10 Adding or Changing a Unit and Prefix for a Value ................... 303
16.11 Metric Prefixes ......................................................................... 304
16.12 Precision Format ...................................................................... 306
16.13 Adding a Unit Conversion Exception ....................................... 307
16.14 Removing a Unit Conversion Exception ................................... 308
16.15 Delta Temperature Conversion ............................................... 309

17 Localization Time and Time Zone ............................. 311

17.1 Time and Time Zone ................................................................ 313
17.1.1 Network Time ......................................................................... 313
17.1.2 Time and Time Zone Configuration in WorkStation ................ 313
17.1.3 Time and Time Zone Configuration in Enterprise Server and
Enterprise Central .................................................................. 313
17.1.4 Time and Time Zone Configuration in SmartX Server ........... 313
17.2 Lead and Shadow Relationship ............................................... 315
17.2.1 Synchronize Network Time Settings ...................................... 316
17.2.2 Synchronize Time Zone Settings ........................................... 316
17.2.3 Content Type Synchronization ............................................... 316
17.2.4 Schedule and Calendar Synchronization .............................. 316
17.2.5 Alarm Control Panel Synchronization ..................................... 316
17.3 Time and Time Zone Configuration in WorkStation .................. 318
17.3.1 Server Time in WorkStation .................................................... 318
17.4 Time and Time Zone Configuration in Enterprise Server and
Enterprise Central .................................................................... 319
17.5 Time and Time Zone Configuration in Automation Server ........ 320
17.6 Changing the Time Zone of an EcoStruxure BMS Server ....... 321

System 04-30005-01-en, May 2019

12
 17.7 Creating a Custom Time Zone of an EcoStruxure BMS Server 322
17.8 Configuring Enterprise Server, Enterprise Central, and
WorkStation Date and Time ..................................................... 323
17.9 Synchronizing the SmartX Server Clock ................................. 324
17.10 Manually Changing the SmartX Server Time and Date ............ 325
17.11 Network Time ........................................................................... 326
17.11.1 Network Time on WorkStation, Enterprise Server, and Enterprise
Central ................................................................................... 326
17.11.2 Network Time Server on a SmartX Server .............................. 326
17.11.3 Authenticated Network Time Servers ..................................... 326
17.12 Synchronize Network Time Settings ........................................ 328
17.13 Synchronizing Time Settings on Multiple SmartX Servers ........ 329
17.14 Synchronize Time Zone Settings ............................................. 330
17.15 Synchronizing Time Zone Settings on Multiple SmartX
Servers ..................................................................................... 331

18 Localization User Interface ....................................... 333

18.1 Select Unit Dialog Box ............................................................. 335
18.2 Date and Time Properties – Basic Tab ..................................... 336
18.3 Date and Time Properties – Time Tab ...................................... 337
18.4 Time Zone Properties – Basic Tab .......................................... 339
18.5 Time Zone Properties – Zone Info Tab ..................................... 340
18.6 Date & Time View ..................................................................... 342
18.7 SmartX Server – Date & Time View .......................................... 345
18.8 Add or Remove Languages Dialog Box .................................. 348
18.9 Unit Conversion Exceptions View ............................................ 349

19 User Account Management ...................................... 351

19.1 User Account Management Overview ..................................... 353
19.1.1 User Accounts and User Account Groups ............................ 354
19.1.2 Domains ................................................................................ 354
19.1.3 Software Permissions ............................................................. 354
19.1.4 Log on Methods ..................................................................... 354
19.1.5 Workspace Management ....................................................... 354
19.1.6 Automatic Logoff .................................................................... 355
19.1.7 Guest User Account .............................................................. 355
19.1.8 Automatic Logoff to Guest Account ....................................... 355
19.1.9 Guest Log On in WebStation ................................................. 355
19.2 Opening the Account Management Control Panel .................. 356
19.3 User Accounts and User Account Groups .............................. 357
19.3.1 Windows Active Directory User Groups ................................ 358
19.3.2 WorkStation Account Management ....................................... 359
19.4 Creating a User Account ......................................................... 360
19.5 Editing a User Account Profile ................................................. 361
19.6 Renaming a User Account ...................................................... 362
19.7 Disabling a User Account ........................................................ 363
19.8 Enabling a Disabled User Account .......................................... 364
19.9 Setting an Expiration Date for a User Account ......................... 365

04-30005-01-en, May 2019 System

13
 19.10 Removing the Expiration Date for a User Account ................... 366
19.11 Deleting a User Account .......................................................... 367
19.12 Automatic Logoff ...................................................................... 368
19.13 Setting the Automatic Logoff Time ........................................... 369
19.14 Guest User Account ................................................................ 370
19.15 Automatic Logoff to Guest Account ......................................... 371
19.16 1Configuring a User Account Group to Log off to the Guest User
Account ................................................................................... 372

20 User Account Groups ............................................... 373

20.1 Windows Active Directory User Groups ................................... 375
20.2 Creating a User Account Group .............................................. 377
20.3 Editing the Description of a User Account Group .................... 379
20.4 Adding a User Account to a User Account Group .................. 380
20.5 Removing a User Account from a User Account Group .......... 381
20.6 Reviewing the User Account Group Memberships for a User
Account ................................................................................... 382
20.7 Adding a User Account Group to a User Account Group ........ 383
20.8 Removing a User Account Group from another User Account
Group ....................................................................................... 384
20.9 Reviewing the User Account Group Memberships for a User
Account Group ........................................................................ 385
20.10 Preventing a Group of Users from Exiting WorkStation ............ 386
20.11 Enabling a Group of Users to Exit WorkStation ........................ 387
20.12 Deleting a User Account Group ............................................... 388

21 Domains .................................................................... 389

21.1 Domains ................................................................................... 391
21.1.1 Windows Active Directory Domain ......................................... 392
21.1.2 Server Local Domain ............................................................. 393
21.1.3 Administration Accounts in Server Local Domain .................. 393
21.2 Log On Methods ...................................................................... 394
21.2.1 Log On as a Windows User ................................................... 394
21.2.2 Log On as an EcoStruxure Building Operation User ............. 394
21.2.3 Password Administration ....................................................... 394
21.3 Guest Logon in WebStation ..................................................... 395
21.4 Creating and Configuring a Domain ........................................ 396
21.5 Editing the Windows Domain Name ......................................... 397
21.6 Editing the Description of a Domain ........................................ 398
21.7 Editing the Maximum Logon Attempts ..................................... 399
21.8 Assigning a SmartX Server to a Domain .................................. 400
21.9 Removing a SmartX Server from a Domain .............................. 401
21.10 Deleting a Domain ................................................................... 402
21.11 Administration Accounts in EcoStruxure BMS Server Local
Domain .................................................................................... 403
21.11.1 Admin Account ...................................................................... 403
21.11.2 Reports Administrator Account .............................................. 403

22 Software Permissions ............................................... 405

System 04-30005-01-en, May 2019

14
 22.1 Software Permissions .............................................................. 407
22.1.1 Path Permissions ................................................................... 407
22.1.2 Command Permissions .......................................................... 407
22.1.3 Extended Software Permissions ............................................ 407
22.1.4 Relative Path Permissions ...................................................... 407
22.1.5 Type Permissions ................................................................... 408
22.1.6 Software Permissions Management ...................................... 408
22.2 Path Permissions ..................................................................... 409
22.2.1 Path Permissions Rules ......................................................... 409
22.2.2 Relative Path Permissions ...................................................... 409
22.3 Path Permissions Rules ............................................................ 410
22.4 Assigning Path Permissions to User Accounts or User Account
Groups ..................................................................................... 411
22.5 Editing Path Permissions of User Accounts or User Account
Groups ..................................................................................... 412
22.6 Removing Path Permissions from User Accounts or User Account
Groups ..................................................................................... 413
22.7 Command Permissions ........................................................... 414
22.7.1 Command Permissions Rules ................................................ 414
22.8 Command Permissions Rules .................................................. 415
22.9 Assigning Command Permissions to User Account Groups ... 417
22.10 Editing Command Permissions of User Account Groups ........ 418
22.11 Removing Command Permissions from User Account
Groups ..................................................................................... 419
22.12 Extended Software Permissions .............................................. 420
22.13 Relative Path Permissions ........................................................ 421
22.13.1 Relative Path Permissions Rules ............................................ 421
22.14 Relative Path Permissions Rules .............................................. 422
22.15 Creating Relative Path Templates ............................................ 423
22.16 Editing Relative Path Permissions Templates .......................... 424
22.17 Deleting Relative Path Templates ............................................ 425
22.18 Assigning Relative Path Permissions to User Accounts or User
Account Groups ....................................................................... 426
22.19 Removing Relative Path Permissions from User Accounts or User
Account Groups ....................................................................... 427
22.20 Type Permissions .................................................................... 428
22.20.1 Custom Type Permissions ..................................................... 428
22.20.2 In-built Type Permissions ....................................................... 428
22.20.3 Type Permission Rules .......................................................... 428
22.21 Type Permissions Rules ........................................................... 429
22.22 Creating Type Permissions Templates .................................... 430
22.23 Editing Type Permissions Templates ....................................... 431
22.24 Removing Path Permissions Templates ................................... 432
22.25 Assigning Type Permissions to User Accounts or User Account
Groups ..................................................................................... 433
22.26 Removing Type Permissions from User Accounts or User Account
Groups ..................................................................................... 434
22.27 Software Permissions Management ........................................ 435

04-30005-01-en, May 2019 System

15
 22.27.1 Software Permissions, User Accounts and User Account Groups
Management ......................................................................... 435
22.27.2 Software Permissions Rules Management ............................. 435
22.28 Software Permissions, User Accounts, and User Account
Groups ..................................................................................... 436
22.29 Software Permissions Rules Management ............................... 438

23 Login Configuration .................................................. 439

23.1 Password Administration ......................................................... 441
23.2 Editing a User Account Password ........................................... 442
23.3 Allowing Users to Change their Password ............................... 443
23.4 Changing Your Password ........................................................ 444
23.5 Changing the Password for Local Administrator Accounts ..... 445
23.6 Turning off Remember Me On This Computer ......................... 446
23.7 Forcing a User to Change the Password at Next Logon .......... 447
23.8 Preventing Users from Changing Their Passwords ................. 448
23.9 Resetting the Administrator Password ..................................... 449

24 Workspaces .............................................................. 451

24.1 Workspace Management ........................................................ 453
24.1.1 Predefined Workspaces ........................................................ 453
24.1.2 Workspace Components and Customization ........................ 454
24.1.3 WebStation in Kiosk Mode ..................................................... 454
24.2 Predefined Workspaces .......................................................... 455
24.3 Workspace Components and Customization .......................... 456
24.3.1 Workspace Customization ..................................................... 457
24.3.2 Workspace Content References ............................................ 457
24.3.3 Panel Components ................................................................ 457
24.4 Workspace Customization ....................................................... 458
24.4.1 Customized Navigation .......................................................... 458
24.4.2 Workspace Path, Object, and Command Customization ..... 459
24.5 Workspace Path, Object, and Command Customization ........ 460
24.6 Workspace Content References .............................................. 461
24.7 Creating a Workspace ............................................................. 462
24.8 Editing the Layout of a Workspace .......................................... 464
24.9 Editing the Description of a Workspace ................................... 465
24.10 Adding a Component to a Workspace ..................................... 466
24.11 Removing a Component from a Workspace ............................ 467
24.12 Editing a Workspace Component ............................................ 468
24.13 Adding a Workspace to a User Account Group ...................... 469
24.14 Removing a Workspace from a User Account Group .............. 470
24.15 Reviewing the Workspace Memberships for a User Account
Group ....................................................................................... 471
24.16 Panel Components .................................................................. 472
24.17 Creating a Panel ..................................................................... 473
24.18 Editing a Panel ......................................................................... 474
24.19 Customized Navigation ............................................................ 475
24.20 Customized Navigation Workflow ............................................ 476

System 04-30005-01-en, May 2019

16
 24.21 WebStation in Kiosk Mode ....................................................... 477
24.21.1 Kiosk Mode ............................................................................ 477
24.21.2 Remove the Toolbars from WebStation ................................. 477

25 Audit Trails ................................................................ 479

25.1 WorkStation Account Management ......................................... 481
25.1.1 Audit Trailing of User Activity ................................................. 481
25.1.2 WorkStation Account Validation ............................................. 481
25.2 Audit Trailing of User Activity ................................................... 482
25.3 Disabling Audit Trail for a Group of Users ............................... 484
25.4 Enabling Audit Trail for a Group of Users ................................ 485
25.5 Viewing an Audit Trail Log ....................................................... 486
25.6 WorkStation Account Validation ............................................... 487

26 User Management User Interface ............................ 489

26.1 User Management System Tree Icons ..................................... 493
26.2 Domain Properties ................................................................... 494
26.3 Profile Properties ...................................................................... 496
26.4 Workspace Properties ............................................................. 497
26.5 Pane Properties ....................................................................... 499
26.6 Panel Properties ....................................................................... 500
26.7 Navigation Pane ....................................................................... 502
26.8 Building Operation WorkStation Window ................................. 503
26.9 Domain Control Panel .............................................................. 505
26.10 Edit Permissions Dialog Box .................................................... 506
26.11 Account Management Control Panel ....................................... 508
26.12 Select Default Workspace Window .......................................... 512
26.13 Change Password Dialog Box ................................................. 513
26.14 Domain Wizard – Authentication Page ..................................... 514
26.15 Domain Wizard – Domain Members Page ............................... 515
26.16 Domain Wizard – Domain Policies Page .................................. 516
26.17 Domain – Summary Tab ........................................................... 517
26.18 Domain – Policies Tab ............................................................. 518
26.19 Domain – Domain Members Tab ............................................. 519
26.20 User Account – Summary Tab ................................................. 520
26.21 User Account – Group Membership Tab ................................. 521
26.22 User Account – Profile Tab ...................................................... 523
26.23 User Account – Software Permissions Tab .............................. 524
26.24 User Account – Audit Trailing Events Tab ................................ 525
26.25 User Account Group Properties .............................................. 526
26.26 User Account Properties .......................................................... 528
26.27 Guest Account Properties ........................................................ 530
26.28 User Account Group Wizard – Users Belonging to this Group
Page ........................................................................................ 532
26.29 User Account Group Wizard – Workspaces Belonging to this
Group Page ............................................................................. 533
26.30 User Account Group Wizard – Windows Group Name and Group
Policies Page ........................................................................... 535

04-30005-01-en, May 2019 System

17
 26.31 User Account Group – Summary Tab ...................................... 537
26.32 User Account Group – Policies Tab ......................................... 538
26.33 User Account Group – Group Membership Tab ...................... 539
26.34 User Account Group – Software Permissions Tab ................... 541
26.35 User Account Group – Workspaces Tab ................................. 543
26.36 User Account Wizard – General Page ..................................... 544
26.37 User Account Wizard – Member Of Page ................................ 545
26.38 User Account Management Folder Properties ......................... 547
26.39 Workspace Wizard – Workspace Configuration Page ............. 548
26.40 Workspace Wizard – Pane Configuration Page ....................... 550
26.41 Workspace – Summary Tab ..................................................... 551
26.42 Workspace – Content Tab ....................................................... 552
26.43 Workspace – Members Tab ..................................................... 554
26.44 Edit Layout Workspace ............................................................ 555
26.45 Panel Wizard – Panel Configuration Page ............................... 556
26.46 Domains Properties ................................................................. 557
26.47 Local Properties ....................................................................... 558
26.48 Work Area Window Properties ................................................. 559
26.49 Create Work Area Window Wizard – Name Page .................... 560
26.50 Windows User Group Dialog Box ............................................ 561

27 Connect Agent .......................................................... 563

27.1 Connect Agent Overview ......................................................... 565
27.2 Configuring Connect Agent Settings ....................................... 566
27.3 Transferring Crash Information ................................................ 567
27.3.1 Crash Information .................................................................. 567
27.4 Applying Proxy Settings to the Connect Agent Service Log
On ............................................................................................ 568
27.5 Configuring Windows Firewall for Connect Agent ................... 569
27.6 Getting Connect Agent Debug Information ............................. 570

28 Connect Agent User Interface .................................. 571

28.1 Connect Agent Settings - Basic Tab ....................................... 573
28.2 Connect Agent Settings - Advanced Tab ............................... 574

29 Alarms Introduction .................................................. 575

29.1 Alarms Overview ...................................................................... 577
29.1.1 Alarm States ........................................................................... 577
29.1.2 Alarm Types ........................................................................... 577
29.1.3 Alarm Functions ..................................................................... 577
29.1.4 Alarm Control Panel Objects in Multiple Servers ................... 578
29.1.5 Alarms Pane and Alarm View Customization ......................... 578
29.1.6 Alarm Filters ........................................................................... 578
29.1.7 Mass Create ........................................................................... 578
29.2 Alarm States ............................................................................ 579
29.2.1 Alarm Handling Issues ........................................................... 579
29.3 Alarm Control Panel Objects in Multiple Servers ..................... 580
29.4 Alarms Pane and Alarm View Customization ........................... 581

System 04-30005-01-en, May 2019

18
 29.5 Styling the Alarm States in the Alarms Pane and Alarm Views . 582
29.6 Displaying Milliseconds in Alarm Views ................................... 583
29.7 Displaying an Alarm View when an Alarm is Triggered ........... 584
29.8 Viewing the Events of an Alarm ................................................ 585
29.9 Navigating to the Alarm Object of a Triggered Alarm .............. 586
29.10 Navigating to the Source Object of a Triggered Alarm ............ 587
29.11 Alarm View and Event View Standard Filter and Layout .......... 588
29.12 Saving an Alarm View Standard Layout ................................... 589
29.13 Resetting the Alarm View Standard Layout to Factory Default . 590
29.14 Fitting the Column Width to the Contents ................................. 591
29.15 Editing an Alarm View Standard Filter ...................................... 592
29.16 Displaying Alarms Assigned to the Logged On User Account 593
29.17 Displaying Alarms Assigned to the Logged On User Account
Groups ..................................................................................... 594
29.18 Alarm Filters ............................................................................. 595
29.18.1 Filter condition wildcards ....................................................... 600
29.19 Creating a Filtered Alarm View ................................................. 601
29.20 Filter Condition Wildcards ....................................................... 602
29.21 Alarm Handling Issues ............................................................. 604
29.22 Configure Alarm Filters on Enterprise Central Workflow ......... 605

30 Alarm Types .............................................................. 607

30.1 Alarm Types ............................................................................. 609
30.1.1 Change of State Alarms ......................................................... 609
30.1.2 Out of Range Alarms .............................................................. 609
30.1.3 Out of Reference Range Alarms ............................................ 609
30.1.4 Multistate Alarms ................................................................... 609
30.1.5 Matching Text String Alarms .................................................. 610
30.1.6 Variable Status Alarms ........................................................... 610
30.1.7 Sum Alarms ............................................................................ 610
30.1.8 Enumeration Alarms ............................................................... 610
30.1.9 System Alarms ....................................................................... 610
30.1.10 EcoStruxure Web Service Alarm Item .................................... 611
30.2 Change of State Alarms ........................................................... 612
30.3 Creating a Change of State Alarm .......................................... 613
30.4 Configuring a Change of State Alarm ...................................... 616
30.5 Multistate Alarms ..................................................................... 620
30.6 Creating a Multistate Alarm ...................................................... 621
30.7 Configuring a Multistate Alarm ................................................ 624
30.8 Matching Text String Alarms .................................................... 628
30.9 Creating a Matching Text String Alarm .................................... 629
30.10 Configuring a Matching Text String Alarm ............................... 632
30.11 Variable Status Alarms ............................................................. 636
30.12 Creating a Variable Status Alarm ............................................. 637
30.13 Configuring a Variable Status Alarm ........................................ 640
30.14 Out of Range Alarms ................................................................ 644
30.15 Creating an Out of Range Alarm .............................................. 645

04-30005-01-en, May 2019 System

19
 30.16 Configuring an Out of Range Alarm ......................................... 648
30.17 Out of Reference Range Alarms .............................................. 652
30.18 Creating an Out of Reference Range Alarm ............................ 653
30.19 Configuring an Out of Reference Range Alarm ....................... 656
30.20 Sum Alarms .............................................................................. 661
30.21 Creating a Sum Alarm .............................................................. 662
30.22 Configuring a Sum Alarm ......................................................... 665
30.23 Enumeration Alarms ................................................................. 669
30.24 Creating an Enumeration Alarm ............................................... 670
30.25 Configuring an Enumeration Alarm .......................................... 673
30.26 System Alarms ......................................................................... 677
30.26.1 System Alarm Handling ......................................................... 677
30.26.2 System Alarm ID List .............................................................. 677
30.27 System Alarm Handling ........................................................... 678
30.28 System Alarm ID List ................................................................ 681
30.28.1 System Alarm IDs A-D ........................................................... 681
30.28.2 System Alarm IDs E-L ............................................................ 681
30.28.3 System Alarm IDs M-NW8 R .................................................. 681
30.28.4 System Alarm IDs NW8 S-NW8 Z .......................................... 681
30.28.5 System Alarm IDs P-S ............................................................ 681
30.28.6 System Alarm IDs List T-X ..................................................... 681
30.29 System Alarm ID A-D ............................................................... 682
30.30 System Alarm ID E-L ................................................................ 686
30.31 System Alarm ID M-NW8 R ...................................................... 689
30.32 System Alarm ID NW8 S-NW8 Z .............................................. 692
30.33 System Alarm ID P-S ................................................................ 693
30.34 System Alarm ID T-X ................................................................ 694
30.35 Configuring the Description of an Alarm .................................. 696

31 Alarm Functions ........................................................ 697

31.1 Alarm Functions ....................................................................... 699
31.1.1 Alarm Filters .......................................................................... 699
31.1.2 Time Delay ............................................................................. 699
31.1.3 Shunt Variable ........................................................................ 699
31.1.4 Deadband ............................................................................. 699
31.1.5 Alarm Messages .................................................................... 699
31.1.6 Alarm Priority .......................................................................... 700
31.1.7 Alarm Categories ................................................................... 700
31.1.8 Acknowledgements ............................................................... 700
31.1.9 User Actions .......................................................................... 700
31.1.10 Notifications ........................................................................... 700
31.1.11 Automatic Assignments ......................................................... 701
31.1.12 Unit of Measure in Alarms ...................................................... 701
31.1.13 Alarm Attachments ................................................................ 701
31.1.14 Custom Audible Alarm Alerts ................................................. 701
31.1.15 Alarm Decoration ................................................................... 701
31.1.16 Alarm Control Panel Synchronization ..................................... 702

System 04-30005-01-en, May 2019

20
 31.2 Time Delay ............................................................................... 703
31.3 Configuring the Delay Time of an Alarm .................................. 704
31.4 Shunt Variables ........................................................................ 705
31.5 Editing the Shunt Variables ...................................................... 706
31.6 Deadband ................................................................................ 707
31.7 Alarm Messages ...................................................................... 708
31.8 Configuring the Alarm Message of an Alarm ........................... 709
31.9 Alarm Priority ............................................................................ 710
31.10 Configuring the Priority of an Alarm ......................................... 711
31.11 Configuring the System Alarm Priority ..................................... 712
31.12 Alarm Categories ..................................................................... 713
31.13 Creating a Category ................................................................. 714
31.14 Configuring the Category of an Alarm ..................................... 715
31.15 Editing a Category ................................................................... 716
31.16 Acknowledgements ................................................................. 717
31.16.1 No Acknowledge ................................................................... 717
31.16.2 Single Acknowledge .............................................................. 717
31.16.3 Extended Acknowledge ......................................................... 717
31.16.4 System Information Alarms .................................................... 717
31.17 Configuring the Acknowledgement Type of an Alarm ............. 718
31.18 No Acknowledgement ............................................................. 719
31.19 Single Acknowledgement ........................................................ 721
31.20 Extended Acknowledgement ................................................... 723
31.21 Alarm Attachments .................................................................. 725
31.22 Adding an Attachment to an Alarm .......................................... 726
31.23 Adding an Attachment to Multiple Alarms ............................... 727
31.24 Copying Attachments to Multiple Alarms ................................. 728
31.25 Removing an Attachment from an Alarm ................................. 729
31.26 Removing Attachments from Multiple Alarms .......................... 730
31.27 Alarm Substitution Codes ........................................................ 731
31.27.1 Alarm Messages .................................................................... 735
31.28 Alarm Assignments .................................................................. 736
31.28.1 Manual Assignments ............................................................. 737
31.28.2 Automatic Assignments ......................................................... 737
31.29 Automatic Assignments ........................................................... 738
31.30 Creating an Automatic Assignment ......................................... 739
31.31 Unit of Measure in Alarms ........................................................ 741
31.32 Configuring the Limits of an Alarm ........................................... 742
31.33 Configuring the Flashing of an Alarm ....................................... 743
31.34 Configuring the Audibility of an Alarm ..................................... 744
31.35 Configuring the Audibility of an Alarm in Reset State ............... 745
31.36 Custom Audible Alarm Alerts ................................................... 747
31.37 Custom Audible Alarm Alert Workflow ..................................... 748
31.38 Adding an Audio File for a Custom Audible Alarm Alert ......... 749
31.39 Configuring a Custom Audible Alarm Alert ............................. 750
31.40 Turning off a Visual and Audible Alert ...................................... 751
31.41 Alarm Control Panel Synchronization ....................................... 752

04-30005-01-en, May 2019 System

21
 31.42 Synchronizing Alarm Control Panels ........................................ 753
31.43 Viewing the Events of an Alarm ................................................ 754

32 User Actions ............................................................. 755

32.1 User Actions ............................................................................ 757
32.1.1 Comments ............................................................................. 757
32.1.2 Cause Notes .......................................................................... 757
32.1.3 Action Notes .......................................................................... 757
32.1.4 Checklists .............................................................................. 758
32.1.5 Summary of User Actions ...................................................... 758
32.2 Comments ............................................................................... 759
32.3 Cause Notes ............................................................................ 760
32.4 Creating a Cause Note ............................................................ 761
32.5 Editing a Cause Note ............................................................... 762
32.6 Adding a Cause Note to an Alarm ........................................... 763
32.7 Action Notes ............................................................................ 764
32.8 Creating an Action Note ........................................................... 765
32.9 Editing an Action Note ............................................................. 766
32.10 Adding an Action Note to an Alarm .......................................... 767
32.11 Checklists ................................................................................ 768
32.12 Creating a Checklist ................................................................. 769
32.13 Editing a Checklist ................................................................... 770
32.14 Adding a Checklist to an Alarm ............................................... 771
32.15 Configuring Forced User Actions ............................................ 772

33 Alarm Decoration ...................................................... 773

33.1 Alarm Decoration ..................................................................... 775
33.2 Creating an Alarm Decoration Rule ......................................... 777
33.3 Configuring an Alarm Decoration Rule .................................... 780

34 Notifications and Notification Reports ...................... 785

34.1 Notifications ............................................................................. 787
34.1.1 Alarm Substitution Codes ...................................................... 788
34.1.2 Notification Distribution Methods ........................................... 788
34.1.3 Notification Reports ............................................................... 788
34.1.4 Notification Workflow ............................................................. 789
34.1.5 Date and Time Formatting ..................................................... 789
34.1.6 Text Formatting ...................................................................... 789
34.2 Creating an Alarm Triggered Notification ................................ 790
34.3 Configuring an Alarm Triggered Notification .......................... 794
34.4 Creating a Variable Triggered Notification ............................... 796
34.5 Configuring a Variable Triggered Notification .......................... 799
34.6 Notification Distribution Methods ............................................. 801
34.6.1 Client Notification Distribution Method ................................... 801
34.6.2 Email Notification Distribution Method ................................... 801
34.6.3 SNMP Notification Distribution Method .................................. 801
34.6.4 Write to File Notification Distribution Method ......................... 801
34.7 Email Notification Distribution Method ..................................... 802

System 04-30005-01-en, May 2019

22
 34.8 SNMP Notification Distribution Method .................................... 804
34.9 Write to File Notification Distribution Method ........................... 805
34.10 Accessing a Notification Written to a File ................................. 806
34.11 Saving a Notification Written to a File ....................................... 807
34.12 Deleting a Notification Written to a File .................................... 808
34.13 Manually Triggering a Notification ........................................... 809
34.14 Notification Reports ................................................................. 810
34.14.1 Events Substitution Codes ..................................................... 812
34.14.2 Properties and Watch Substitution Codes ............................. 813
34.14.3 Trend Logs Substitution Codes ............................................. 813
34.14.4 Date and Time Formatting ..................................................... 813
34.14.5 Text Formatting ...................................................................... 813
34.14.6 Notification Report Example 1 ............................................... 813
34.14.7 Notification Report Example 2 ............................................... 814
34.15 Notification Report Workflow .................................................... 815
34.16 Creating a Notification Report Template .................................. 816
34.17 Configuring a Notification Report Template ............................. 826
34.18 Events Substitution Codes ....................................................... 827
34.19 Properties and Watch Substitution Codes ............................... 831
34.20 Trend Logs Substitution Codes ............................................... 832
34.21 Date and Time Formatting ....................................................... 833
34.22 Text Formatting ........................................................................ 835
34.23 Notification Report Example 1 ................................................. 837
34.24 Notification Report Example 2 ................................................. 841

35 Alarms User Interface ............................................... 847

35.1 Alarms Pane and Alarm View .................................................. 853
35.2 Alarms Pane and Alarm View Toolbar ...................................... 854
35.3 Alarms Pane and Alarm View Icons ......................................... 856
35.4 Alarm and Event Detail View ................................................... 857
35.5 Add/Remove Columns Dialog Box (Alarms) ............................ 858
35.6 Add/Remove Conditions Dialog Box ....................................... 863
35.7 Alarm System Tree Icons ......................................................... 864
35.8 Change of State Alarm Properties – Basic Tab ........................ 866
35.9 Change of State Alarm Properties – Alarm Settings Tab .......... 868
35.10 Enumeration Alarm Properties – Basic Tab ............................. 871
35.11 Enumeration Alarm Properties – Alarm Settings Tab ............... 874
35.12 Matching Text String Alarm Properties – Basic Tab ................. 877
35.13 Matching Text String Alarm Properties – Alarm Settings Tab .. 880
35.14 Multistate Alarm Properties – Basic Tab .................................. 883
35.15 Multistate Alarm Properties – Alarm Settings Tab .................... 886
35.16 Out of Range Alarm Properties – Basic Tab ............................ 889
35.17 Out of Range Alarm Properties – Alarm Settings Tab .............. 892
35.18 Out of Reference Range Alarm Properties – Basic Tab ........... 895
35.19 Out of Reference Range Alarm Properties – Alarm Settings .... 898
35.20 Sum Alarm Properties – Basic Tab .......................................... 901
35.21 Sum Alarm Properties – Alarm Settings Tab ............................ 903

04-30005-01-en, May 2019 System

23
 35.22 Variable Status Alarm Properties – Basic Tab .......................... 906
35.23 Variable Status Alarm Properties – Alarm Settings Tab ........... 909
35.24 Function Block Program Internal Alarm Properties - Basic
Tab ........................................................................................... 912
35.25 Function Block Program Internal Alarm Properties - Alarm
Settings Tab ............................................................................. 915
35.26 Create Alarm Wizard – Presentation Page ............................... 918
35.27 Create Alarm Wizard – User Action Page ................................ 920
35.28 Create Alarm Wizard – Attachment Page ................................ 921
35.29 Create Change of State Alarm Wizard – Alarm Trigger Page .. 922
35.30 Create Multistate Alarm Wizard – Alarm Trigger Page ............. 924
35.31 Create Matching Text String Alarm Wizard – Alarm Trigger
Page ........................................................................................ 926
35.32 Create Out of Range Alarm Wizard – Alarm Trigger Page ....... 928
35.33 Create Out of Reference Range Alarm Wizard – Alarm Trigger
Page ........................................................................................ 930
35.34 Create Sum Alarm Wizard – Alarm Trigger Page ..................... 932
35.35 Create Enumeration Alarm Wizard – Alarm Trigger Page ........ 934
35.36 Create Variable Status Alarm Wizard – Alarm Trigger Page .... 936
35.37 Create Attachment Wizard – Configure Attachment Page ....... 938
35.38 Alarm Trigger Properties - Basic Tab ....................................... 939
35.39 Alarm Trigger Properties – Range Tab .................................... 940
35.40 Alarm Trigger Properties – Value tab ....................................... 941
35.41 Alarm Trigger Properties – Value tab ....................................... 942
35.42 Attachment Properties ............................................................. 943
35.43 Alarm Control Panel Properties ................................................ 944
35.44 User Action Properties ............................................................. 945
35.45 Alarm Styles View ..................................................................... 946
35.46 Alarm Styles Properties ............................................................ 947
35.47 Acknowledged Style Properties ............................................... 948
35.48 Alarm Style Properties .............................................................. 949
35.49 Disabled Style Properties ......................................................... 950
35.50 Fault Style Properties ............................................................... 951
35.51 Reset Style Properties .............................................................. 952
35.52 Alarm Control Panel – Categories View ................................... 953
35.53 Add Category Dialog Box ........................................................ 954
35.54 Edit Category Dialog Box ......................................................... 955
35.55 Category Properties ................................................................. 956
35.56 Categories Properties .............................................................. 957
35.57 Alarm Control Panel – Cause Notes View ................................ 959
35.58 Add Cause Note Dialog Box .................................................... 961
35.59 Edit Cause Note Dialog Box ..................................................... 962
35.60 Cause Notes Properties ........................................................... 963
35.61 Cause Note Group Properties .................................................. 965
35.62 Cause Note Properties ............................................................. 967
35.63 Alarm Control Panel – Action Notes View ................................. 968
35.64 Add Action Note Dialog Box .................................................... 969

System 04-30005-01-en, May 2019

24
 35.65 Edit Action Note Dialog Box ..................................................... 970
35.66 Action Notes Properties ........................................................... 971
35.67 Action Note Group Properties .................................................. 973
35.68 Action Note Properties ............................................................. 975
35.69 Alarm Control Panel – Checklists View .................................... 976
35.70 Add Checklist Dialog Box ........................................................ 977
35.71 Edit Checklist Dialog Box ......................................................... 979
35.72 Add Checklist Step Dialog Box ................................................ 981
35.73 Edit Checklist Step Dialog Box ................................................ 982
35.74 Checklists Properties ............................................................... 983
35.75 Checklist Properties ................................................................. 985
35.76 Checklist Step Properties ......................................................... 987
35.77 Alarm – Basic Settings View ..................................................... 988
35.78 Select Conditions Dialog Box .................................................. 989
35.79 Create Assignment Wizard – Assignment Page ...................... 991
35.80 Assignment View ..................................................................... 993
35.81 Assignment Properties ............................................................. 995
35.82 Users and Groups Dialog Box ................................................. 997
35.83 Alarm View Properties ............................................................ 1000
35.84 Progress View ........................................................................ 1001
35.85 Alarm Handling Properties ..................................................... 1002
35.86 Alarms Pane Context Menu ................................................... 1003
35.87 Alarms Pane Context Menu - View Submenu ......................... 1006
35.88 Alarms Pane Context Menu - Alarm View Settings Submenu 1007
35.89 Alarm State Sort Order Dialog Box ........................................ 1009
35.90 Alarm Triggered Notification View ......................................... 1010
35.91 Alarm Triggered Notification Properties - Basic Tab .............. 1012
35.92 Create Alarm Triggered Notification Wizard – Configure Alarm
Triggered Notification Page ................................................... 1014
35.93 Variable Triggered Notification View ...................................... 1017
35.94 Variable Triggered Notification Properties - Basic Tab .......... 1019
35.95 Create Variable Triggered Notification Wizard – Configure
Variable Triggered Notification Page ..................................... 1021
35.96 Create Notification Wizard - Configure Email Page ............... 1023
35.97 Create Notification Wizard - Configure SNMP Page .............. 1025
35.98 Create Notification Wizard - Configure Write to File Page ...... 1027
35.99 Notification Report Template View ......................................... 1028
35.100 Notification Report Template Properties - Basic Tab ............. 1030
35.101 Create Notification Report Template Wizard – Configure
Notification Report Template Page ........................................ 1032
35.102 Create Report Data Wizard - Configure Events Page ............ 1034
35.103 Create Report Data Wizard - Configure Properties Page ...... 1036
35.104 Create Report Data Wizard - Configure Relative Properties Page
............................................................................................... 1038
35.105 Create Report Data Wizard – Configure Relative Search
Page ...................................................................................... 1040
35.106 Create Report Data Wizard - Configure Relative Trend Log Page
............................................................................................... 1042

04-30005-01-en, May 2019 System

25
 35.107 Create Report Data Wizard – Configure Relative Watch View
Page ...................................................................................... 1044
35.108 Create Report Data Wizard – Configure Search Page ........... 1046
35.109 Create Report Data Wizard - Configure Trend Log Page ..... 1047
35.110 Create Report Data Wizard – Configure Watch Page ............ 1049
35.111 Alarm Decoration View ........................................................... 1050
35.112 Alarm Decoration Rule Properties – Alarm Settings Tab ........ 1051
35.113 Create Alarm Decoration Rule Wizard - Filter Page ............... 1055
35.114 Create Alarm Decoration Rule Wizard - Presentation Page ... 1057
35.115 Create Alarm Decoration Rule Wizard - User Action Page .... 1059

36 Events ..................................................................... 1061

36.1 How Events Work .................................................................. 1063
36.1.1 Events Pane and Event View Customization ........................ 1063
36.1.2 Event Filter Conditions ......................................................... 1064
36.1.3 Favorites .............................................................................. 1064
36.1.4 Archive Overview ................................................................. 1064
36.2 Events Pane and Event View Customization .......................... 1065
36.3 Styling a Certain Event in the Events Pane or Event View ...... 1066
36.4 Displaying Milliseconds in Event Views ................................. 1068
36.5 Alarm View and Event View Standard Filter and Layout ........ 1069
36.6 Saving an Event View Standard Layout ................................. 1070
36.7 Resetting the Event View Standard Layout to Factory
Default ................................................................................... 1071
36.8 Editing an Event View Standard Filter .................................... 1072
36.9 Event Filter Conditions ........................................................... 1073
36.10 Applying an Event Time Filter ................................................ 1079
36.11 Creating a Filtered Event View ............................................... 1080
36.12 Filter Condition Wildcards ..................................................... 1081
36.13 Viewing Events in This Branch ............................................... 1083
36.14 Viewing Events for Properties of Bound Objects ................... 1084
36.15 Viewing Events from the Watch Pane .................................... 1085

37 Events User Interface ............................................. 1087

37.1 Events Pane and Event View .................................................. 1089
37.2 Events Pane and Event View Toolbar .................................... 1090
37.3 Event Styles Dialog Box ......................................................... 1091
37.4 Event View Properties ............................................................ 1093
37.5 Add/Remove Columns Dialog Box (Events) .......................... 1095
37.6 Events Pane Context Menu .................................................... 1100
37.7 Events Pane Context Menu - Event View Settings Submenu . 1101

38 Trend Log Introduction ........................................... 1103

38.1 Trends Overview .................................................................... 1105
38.1.1 Trend Log Types .................................................................. 1107
38.1.2 Trend Log Functions ............................................................ 1107
38.1.3 Trend Units .......................................................................... 1107
38.1.4 Trend Charts ........................................................................ 1107

System 04-30005-01-en, May 2019

26
 38.1.5 Trend Log Lists .................................................................... 1107
38.1.6 Multi Trend Log Lists ............................................................ 1108
38.1.7 Move or Copy Trend Logs or Extended Trend Logs ............ 1108
38.1.8 Mass Create ......................................................................... 1108
38.2 Clearing a Trend Log ............................................................. 1109
38.3 Editing or Commenting a Trend Log Record ........................ 1110
38.4 Displaying the History of a Trend Log Record ....................... 1111
38.5 Trend Units ............................................................................ 1112
38.6 Enabling a Trend Log ............................................................ 1114
38.7 Disabling a Trend Log ........................................................... 1115

39 Trend Log Types ..................................................... 1117

39.1 Trend Log Types .................................................................... 1119
39.1.1 Change of Value Trend Logs ............................................... 1121
39.1.2 Interval Trend Logs ............................................................. 1121
39.1.3 Manual Trend Logs ............................................................. 1121
39.1.4 Variable Triggered Trend Logs ........................................... 1121
39.1.5 Implicit Trend Logs ............................................................. 1121
39.1.6 Meter Function .................................................................... 1122
39.2 Interval Trend Logs ............................................................... 1123
39.2.1 Interval Time Zone ............................................................... 1125
39.2.2 Interval Trend Log Delta ...................................................... 1125
39.3 Interval Trend Log Delta ........................................................ 1128
39.4 Creating an Interval Trend Log ............................................. 1131
39.5 Configuring an Interval Trend Log ......................................... 1133
39.6 Editing the Interval of an Interval Trend Log .......................... 1135
39.7 Editing the Delta in an Interval Trend Log .............................. 1136
39.8 Meter Function ....................................................................... 1137
39.9 Managing Meter Replacement ............................................. 1140
39.10 Displaying Meter Change History .......................................... 1141
39.11 Change of Value Trend Logs ................................................. 1142
39.12 Creating a Change of Value Trend Log ................................ 1145
39.13 Configuring a Change of Value Trend Log ............................ 1147
39.14 Variable Triggered Trend Logs .............................................. 1149
39.15 Creating a Variable Triggered Trend Log .............................. 1152
39.16 Configuring a Variable Triggered Trend Log ......................... 1154
39.17 Manual Trend Logs ................................................................ 1156
39.18 Creating a Manual Trend Log ................................................ 1159
39.19 Configuring a Manual Trend Log ........................................... 1160
39.20 Adding a Trend Log Record to a Manual Trend Log ............. 1162
39.21 Implicit Trend Logs ............................................................... 1163

40 Trend Log Functions ............................................... 1165

40.1 Trend Log Functions .............................................................. 1167
40.1.1 Log Record Storage ............................................................ 1167
40.1.2 Trend Log Activation ............................................................ 1167
40.1.3 Extended Trend Logs .......................................................... 1167

04-30005-01-en, May 2019 System

27
 40.2 Log Record Storage .............................................................. 1168
40.3 Trend Log Activation .............................................................. 1169
40.3.1 Activation Variable ............................................................... 1169
40.3.2 Start at activation time .......................................................... 1170
40.4 Extended Trend Logs ............................................................ 1171
40.4.1 Archive Overview ................................................................. 1175
40.4.2 Extended Trend Log Meter Support .................................... 1175
40.5 Creating an Extended Trend Log ........................................... 1176
40.6 Configuring an Extended Trend Log ...................................... 1177
40.7 Editing the Threshold Property of an Extended Trend Log .... 1179
40.8 Editing the Maximum Transfer Interval Property of an Extended
Trend Log .............................................................................. 1180
40.9 Editing the Log Size for a Trend Log ...................................... 1181
40.10 Editing an Extended Trend Log to be Included in Reports .... 1182
40.11 Manually Transferring Records to the Extended Trend Log .. 1183
40.12 Viewing Related Trends ........................................................ 1184
40.13 Viewing Related Trends for Properties Bound to a Graphic .. 1185

41 Trend Charts ........................................................... 1187

41.1 Trend Charts .......................................................................... 1189
41.1.1 Trend Chart Series ............................................................... 1195
41.1.2 Trend Chart Axes in WorkStation ......................................... 1195
41.1.3 Trend Chart Axes in WebStation .......................................... 1195
41.1.4 Real-Time Plotting ................................................................ 1195
41.1.5 Time Zone Modes in a Trend Chart ..................................... 1196
41.1.6 Calculation Methods ............................................................ 1196
41.1.7 Period Timestamps in Trend Charts and Trend Log Lists .... 1196
41.1.8 Temporary Trend Charts ...................................................... 1196
41.1.9 Multi Trend Log Lists ............................................................ 1196
41.1.10 Floating Point Values NaN, INF, and –INF ........................... 1197
41.2 Creating a Trend Chart that Monitors a Variable in Real-
Time ....................................................................................... 1198
41.3 Creating a Trend Chart that Monitors a Trend Log Series ..... 1199
41.4 Configuring a Trend Chart ..................................................... 1200
41.5 Attaching a Calculation Method to a Trend Chart Series ....... 1202
41.6 Showing Trend Chart Grid Lines ............................................ 1203
41.7 Trend Series ........................................................................... 1204
41.8 Adding a Trend Log Series to a Trend Chart ......................... 1206
41.9 Adding a Real-Time Trend Series to a Trend Chart ............... 1207
41.10 Trend Chart Axes ................................................................... 1208
41.11 Editing the Trend Chart Settings ............................................ 1210
41.12 Manually Configuring the Y-Axis Scale ................................. 1211
41.13 Configuring the X-Axis with a Relative Time Span ................. 1212
41.14 Configuring the X-Axis with an Absolute Time Span .............. 1213
41.15 Automatically Configuring the Y-Axis Scale .......................... 1214
41.16 Scrolling the Trend Chart X-Axis to the Current Time ............. 1215
41.17 Assigning a Series to a Y-Axis ............................................... 1216

System 04-30005-01-en, May 2019

28
 41.18 Real-Time Plotting .................................................................. 1217
41.19 Creating a Real-Time Plot Trend Chart .................................. 1218
41.20 Activating Trend Chart Live Update ....................................... 1219
41.21 Time Zone Modes in a Trend Chart ....................................... 1220
41.21.1 Local Time ........................................................................... 1220
41.21.2 Predefined Time Zone ......................................................... 1221
41.22 Configuring the Trend Chart Time Zone ................................ 1223
41.23 Temporary Trend Charts ........................................................ 1224
41.24 Viewing a Trend Log in a Temporary Trend Chart ................ 1225
41.25 Saving a Temporary Trend Chart ........................................... 1226
41.26 Viewing a Trend Chart in a Multi Trend Log List .................... 1227
41.27 Floating Point Values NaN, INF, and –INF ............................. 1228
41.27.1 Basic Property Tab and Watch Window .............................. 1228
41.27.2 Trends ................................................................................. 1229

42 Trend Log Lists ....................................................... 1235

42.1 Trend Log Lists ...................................................................... 1237
42.1.1 Time Zone Modes in a Trend Log List .................................. 1239
42.1.2 Calculation Methods ............................................................ 1239
42.1.3 Period Timestamps in Trend Charts and Trend Log Lists .... 1239
42.1.4 Temporary Trend Log Lists .................................................. 1239
42.1.5 Floating Point Values NaN, INF, and -INF ............................ 1239
42.1.6 ............................................................................................. 1239
42.2 Creating a Trend Log List ...................................................... 1240
42.3 Configuring a Trend Log List ................................................. 1241
42.4 Time Zone Modes in a Trend Log List ................................... 1242
42.4.1 Local Time Zone .................................................................. 1242
42.4.2 Server Time Zone ................................................................. 1242
42.4.3 UTC Time Zone .................................................................... 1243
42.5 Displaying the Trend Log List Time Stamps with Fractions ... 1245
42.6 Configuring the Trend Log List Time Zone ............................ 1246
42.7 Calculation Methods .............................................................. 1247
42.7.1 None .................................................................................... 1247
42.7.2 Maximum ............................................................................. 1247
42.7.3 Minimum .............................................................................. 1248
42.7.4 Average ............................................................................... 1249
42.7.5 Sum ..................................................................................... 1250
42.7.6 Delta .................................................................................... 1251
42.7.7 Delta over Period ................................................................. 1252
42.7.8 Meter Consumption ............................................................. 1252
42.7.9 Period Timestamps in Trend Charts and Trend Log Lists ... 1252
42.8 Attaching a Calculation Method to a Trend Log List .............. 1253
42.9 Temporary Trend Log Lists .................................................... 1254
42.10 Viewing a Trend Log in a Temporary Trend Log List ............. 1255
42.11 Saving a Temporary Trend Log List ....................................... 1256

43 Multi Trend Log Lists .............................................. 1257

04-30005-01-en, May 2019 System

29
 43.1 Multi Trend Log Lists ............................................................. 1259
43.1.1 Time Zone Modes in a Trend Log List .................................. 1259
43.1.2 Calculation Methods ............................................................ 1259
43.1.3 Floating Point Values NaN, INF, and -INF ............................ 1260
43.2 Creating a Multi Trend Log List ............................................. 1261
43.3 Configuring a Multi Trend Log List ........................................ 1262
43.4 Adding a Trend Log to a Multi Trend Log List ....................... 1263
43.5 Configuring a Trend Log Series in a Multi Trend Log List ..... 1264
43.6 Removing a Trend Log from a Multi Trend Log List .............. 1265
43.7 Exporting a Multi Trend Log List to .XML .............................. 1266
43.8 Exporting a Multi Trend Log List to .CSV ............................... 1267
43.9 Viewing Trend Logs in a Temporary Multi Trend Log List ..... 1268
43.10 Saving a Temporary Multi Trend Log List .............................. 1269
43.11 Saving a Multi Trend Log List Standard Layout ..................... 1270

44 Trends User interface ............................................. 1271

44.1 Trend Log System Tree Icons ................................................ 1275
44.2 Actions Menu – Activation Submenu ..................................... 1276
44.3 Actions Menu – View Submenu .............................................. 1277
44.4 Actions Menu – Modification Submenu .................................. 1279
44.5 Change of Value Trend Log Properties – Basic Tab .............. 1280
44.6 Interval Trend Log Properties – Basic Tab ............................. 1282
44.7 Manual Trend Log Properties – Basic Tab ............................. 1284
44.8 Variable Triggered Trend Log Properties – Basic Tab ........... 1285
44.9 Extended Trend Log Properties – Basic Tab ......................... 1287
44.10 Change of Value Trend Log Properties – Meter Info Tab ....... 1289
44.11 Interval Trend Log Properties – Meter Info Tab ...................... 1291
44.12 Manual Trend Log Properties – Meter Info Tab ...................... 1293
44.13 Variable Triggered Trend Log Properties – Meter Info Tab .... 1295
44.14 Extended Trend Log Properties – Meter Info Tab .................. 1297
44.15 Manage Replacement of Meter Dialog Box ........................... 1299
44.16 Meter Change History Dialog Box .......................................... 1301
44.17 Trend Chart Properties .......................................................... 1303
44.18 Trend Chart View ................................................................... 1305
44.19 Trend Chart Toolbar ............................................................... 1306
44.20 Trend Chart Event Icons ........................................................ 1308
44.21 Trend Chart Navigation Bar ................................................... 1311
44.22 Series Tab Context Menu ....................................................... 1312
44.23 Trend Chart Settings Dialog Box – Axes Tab ......................... 1313
44.24 Trend Chart Settings Dialog Box – Series Tab ....................... 1315
44.25 Trend Chart Settings Dialog Box – Calculation Tab ............... 1317
44.26 Trend Chart Series Properties ................................................ 1318
44.27 Real Time Trend Series Properties ......................................... 1320
44.28 Trend Log List Properties ....................................................... 1321
44.29 Trend Log List View ............................................................... 1323
44.30 Trend Log List Toolbar ........................................................... 1324
44.31 Trend Log List Event Icons .................................................... 1326

System 04-30005-01-en, May 2019

30
 44.32 Trend Log List – Log Info View ............................................... 1328
44.33 Trend Log List Context Menu ................................................. 1329
44.34 Add/Remove Columns Dialog Box (Trends) .......................... 1330
44.35 Add Trend Log Record Dialog Box ........................................ 1331
44.36 Edit/Comment Trend Log Record Dialog Box ........................ 1332
44.37 Edited Value History Dialog Box ............................................ 1333
44.38 Multi Trend Log List Properties - Basic Tab ........................... 1334
44.39 Multi Trend Log List View ....................................................... 1336
44.40 Multi Trend Log List Toolbar .................................................. 1337
44.41 Multi Trend Log Settings Dialog Box – General Tab .............. 1338
44.42 Multi Trend Log Settings Dialog Box – Series Tab ................. 1340
44.43 Multi Trend Log List Series Properties ................................... 1342
44.44 Multi Trend Log List Context Menu ........................................ 1343
44.45 Multi Trend Log List Header Context Menu ........................... 1344
44.46 Create Interval Trend Log Wizard – Configure Interval Trend Log
Page ...................................................................................... 1345
44.47 Create Trend Log Wizard – Configure Change of Value Trend Log
Page ...................................................................................... 1347
44.48 Create Variable Triggered Trend Log Wizard – Configure Variable
Triggered Trend Log Page .................................................... 1349
44.49 Create Manual Trend Log Wizard – Configure Manual Log
Page ...................................................................................... 1351
44.50 Create Trend Log Wizard – Initial Meter Settings Page ......... 1352
44.51 Create Extended Trend Log Wizard – Configure Extended Trend
Log Page ............................................................................... 1353
44.52 Create Trend Chart Wizard – Configure Trend Chart Page ... 1355
44.53 Create Trend Chart Wizard – Configure Real-Time Trend Series
Page ...................................................................................... 1357
44.54 Create Trend Chart Wizard – Configure Trend Log Series
Page ...................................................................................... 1358
44.55 Create Trend Log List Wizard – Configure Trend Log List
Page ...................................................................................... 1359
44.56 Create Multi Trend Log Wizard - Configure Multi Trend Log List
Page ...................................................................................... 1360
44.57 Create Trend Log Wizard – Connect Objects to the Trend Log
Page ...................................................................................... 1361
44.58 Create Multi Trend Log List Wizard – Configure Trend Log Series
Page ...................................................................................... 1362

45 Mass Create Alarms and Trends ............................ 1363

45.1 Mass Create .......................................................................... 1365
45.1.1 Object or Property Variable Type ........................................ 1365
45.1.2 Suffix and Prefix ................................................................... 1366
45.1.3 Mass Create Unit Management ........................................... 1366
45.1.4 Mass Create from Properties with the Search Method ......... 1366
45.1.5 Mass Create Path Options ................................................... 1366
45.2 Mass Create Unit Management ............................................ 1367
45.3 Object or Property Variable Type ........................................... 1368
45.4 Suffix and Prefix ..................................................................... 1370

04-30005-01-en, May 2019 System

31
 45.5 Mass Create Path Options ..................................................... 1371
45.6 Mass Creating Alarms ........................................................... 1374
45.7 Mass Creating Alarms Using the Search Method .................. 1375
45.8 Mass Creating Trend Logs .................................................... 1377
45.9 Mass Creating Trend Logs Using the Search Method ........... 1378
45.10 Mass Creating Extended Trend Logs .................................... 1379
45.11 Mass Creating Extended Trend Logs Using the Search
Method ................................................................................... 1380
45.12 Mass Create Object Wizard – Name Page ............................ 1381

46 Schedules Introduction ........................................... 1383

46.1 Schedules Overview .............................................................. 1385
46.1.1 Schedule Editor Overview ................................................... 1385
46.1.2 Priorities ............................................................................... 1385
46.1.3 Schedule Types ................................................................... 1385
46.1.4 Schedule Events .................................................................. 1386
46.1.5 Calendars in WorkStation .................................................... 1386
46.1.6 Schedule and Calendar Synchronization ............................ 1386
46.1.7 Schedule Bindings ............................................................... 1386
46.2 Schedule Bindings ................................................................ 1387
46.2.1 Binding Examples ................................................................ 1387
46.3 Configuring a Schedule as a Shadow ................................... 1388

47 Schedule Editor ...................................................... 1389

47.1 Schedule Editor Overview ..................................................... 1391
47.1.1 Basic View of the Schedule Editor ....................................... 1391
47.1.2 Advanced View of the Schedule Editor ................................ 1391
47.1.3 Schedule Colors ................................................................. 1391
47.2 Basic View of the Schedule Editor ......................................... 1392
47.3 Advanced View of the Schedule Editor ................................. 1393
47.3.1 Mode ................................................................................... 1393
47.3.2 View ..................................................................................... 1393
47.3.3 Combined ............................................................................ 1394
47.4 Time Zones ............................................................................ 1395
47.5 Priorities ................................................................................. 1396
47.5.1 Exception Events ................................................................. 1396
47.6 Editing an Event Priority ......................................................... 1398
47.7 Configuring a Time Value Period for a Schedule ................... 1399
47.8 Editing a Schedule Event Time Span ..................................... 1400
47.9 Modifying a Schedule Using the Text View ............................ 1401
47.10 Modifying a Schedule Using the Graphic View ...................... 1403
47.11 Schedule Colors in WorkStation ............................................ 1404
47.11.1 Basic Schedule View ........................................................... 1404
47.11.2 Advanced Schedule View .................................................... 1405

48 Schedule Types ...................................................... 1407

48.1 Schedule Types .................................................................... 1409
48.1.1 Analog Schedules ................................................................ 1409

System 04-30005-01-en, May 2019

32
 48.1.2 Digital Schedules ................................................................. 1409
48.1.3 Multistate Schedules ............................................................ 1409
48.2 Digital Schedules ................................................................... 1410
48.3 Creating a Digital Schedule ................................................... 1411
48.4 Binding a Digital Value to a Digital Schedule ......................... 1412
48.5 Multistate Schedules .............................................................. 1413
48.6 Creating a Multistate Schedule .............................................. 1414
48.7 Binding a Multistate Value to a Multistate Schedule .............. 1415
48.8 Analog Schedules .................................................................. 1416
48.9 Creating an Analog Schedule ................................................ 1417
48.10 Binding an Analog Value to an Analog Schedule .................. 1418

49 Schedule Events ..................................................... 1419

49.1 Schedule Events .................................................................... 1421
49.1.1 Weekly Events in WorkStation .............................................. 1421
49.1.2 Weekly Events in WebStation ............................................... 1421
49.1.3 Exception Events in WorkStation ......................................... 1421
49.1.4 Exception Events in WebStation .......................................... 1422
49.1.5 Priorities ............................................................................... 1422
49.1.6 Time Zones .......................................................................... 1422
49.2 Displaying Client Time and Server Time in a Schedule ......... 1423
49.3 Deleting a Date List Entry from a Calendar ........................... 1424
49.4 Weekly Events in WorkStation ................................................ 1425
49.5 Adding a Weekly Event ......................................................... 1426
49.6 Editing a Weekly Event .......................................................... 1427
49.7 Exception Events in WorkStation ........................................... 1428
49.7.1 Date Exception Events ......................................................... 1428
49.7.2 Date Range Exception Events ............................................. 1428
49.7.3 Calculated Exception Events ............................................... 1429
49.7.4 Calendar Exception Events ................................................. 1429
49.8 Adding a Date Exception Event ............................................ 1430
49.9 Editing a Date Exception Event .............................................. 1431
49.10 Adding a Date Range Exception Event ................................. 1433
49.11 Editing a Date Range Exception Event .................................. 1434
49.12 Adding a Calculated Exception Event ................................... 1436
49.13 Editing a Calculated Exception Event .................................... 1437
49.14 Adding a Calendar Exception Event ...................................... 1439
49.15 Editing a Calendar Exception Event ...................................... 1440
49.16 Deleting an Exception Event from a Schedule ....................... 1442
49.17 Adding a Weekly Event to a Xenta Schedule ......................... 1443
49.18 Editing a Weekly Event in a Xenta Schedule .......................... 1444
49.19 Deleting a Weekly Event from a Xenta Schedule ................... 1445
49.20 Adding an Exception Event to a Xenta Schedule .................. 1446
49.21 Editing an Exception Event in a Xenta Schedule ................... 1447
49.22 Deleting an Exception Event from a Xenta Schedule ............. 1448

50 Calendars ............................................................... 1449

04-30005-01-en, May 2019 System

33
 50.1 Calendar Editor Overview ...................................................... 1451
50.2 Calendars in WorkStation ...................................................... 1452
50.2.1 Calendar Editor Overview .................................................... 1452
50.2.2 Calendar Events .................................................................. 1452
50.3 Calendar Events .................................................................... 1453
50.3.1 Date Calendar Events .......................................................... 1453
50.3.2 Date Range Calendar Events .............................................. 1453
50.3.3 Calculated Calendar Events ................................................ 1454
50.4 Creating a Calendar ............................................................... 1455
50.5 Adding a Date Calendar Event .............................................. 1456
50.6 Adding a Date Range Calendar Event ................................... 1457
50.7 Adding a Calculated Date Calendar Event ............................ 1458
50.8 Configuring a Calendar as a Shadow ................................... 1459
50.9 Storing Expired Calendar Events ........................................... 1460
50.10 Editing a Date Calendar Event ............................................... 1461
50.11 Editing a Date Range Calendar Event ................................... 1462
50.12 Editing a Calculated Date Calendar Event ............................ 1463
50.13 Schedule and Calendar Synchronization .............................. 1464

51 Schedules User Interface ....................................... 1467

51.1 Schedule Editor – Basic View ................................................ 1469
51.2 Basic Schedule Editor Toolbar .............................................. 1470
51.3 Advanced Schedule Editor – Graphic View .......................... 1471
51.4 Advanced Schedule Editor Toolbar ...................................... 1472
51.5 Edit Effective Period Dialog Box ........................................... 1473
51.6 Edit Exception Dialog Box ..................................................... 1474
51.7 Edit Time Value Period Dialog Box ........................................ 1475
51.8 Snap To Submenu ................................................................. 1476
51.9 Show Client Time Zone ......................................................... 1477
51.10 Analog Schedule Properties – Basic Tab .............................. 1478
51.11 Schedule Properties - Boolean Time Value Pair ..................... 1480
51.12 Schedule Properties - Enumerated Time Value Pair .............. 1482
51.13 Schedule Properties - Integer Time Value Pair ...................... 1483
51.14 Schedule Properties - On Off Time Value Pair ....................... 1484
51.15 Schedule Properties - Real Time Value Pair ........................... 1485
51.16 Schedule Properties - Unsigned Time Value Pair .................. 1486
51.17 Schedule Event Properties Dialog Box – Weekly View .......... 1487
51.18 Schedule Event Properties Dialog Box – Single Date Exception
View ...................................................................................... 1489
51.19 Schedule Event Properties Dialog Box – Date Range Exception
View ...................................................................................... 1491
51.20 Schedule Event Properties Dialog Box – Calculated Exception
View ....................................................................................... 1493
51.21 Schedule Event Properties Dialog Box – Calendar Reference
View ...................................................................................... 1496
51.22 Calendar Editor View ............................................................. 1498
51.23 Calendar Editor Toolbar ......................................................... 1499
51.24 Calendar Properties – Basic Tab ........................................... 1500

System 04-30005-01-en, May 2019

34
 51.25 Edit Calendar Entry Dialog Box – Add Date ........................... 1501
51.26 Edit Calendar Entry Dialog Box – Date Range ...................... 1502
51.27 Edit Calendar Entry Dialog Box – Calculated Date ............... 1503
51.28 Xenta Schedule Editor ........................................................... 1504
51.29 Xenta Schedule Dialog Box .................................................. 1506

52 WorkStation ............................................................. 1507

52.1 WorkStation ............................................................................ 1509
52.1.1 EcoStruxure Building Operation Objects ............................. 1509
52.1.2 User Account Management Overview ................................. 1509
52.1.3 Workspace Management ..................................................... 1509
52.1.4 Database Mode ................................................................... 1509
52.2 Control Panel ......................................................................... 1510
52.3 Opening Control Panel ........................................................... 1511
52.4 Quick Filter ............................................................................ 1512
52.5 Hyperlinks .............................................................................. 1514
52.6 Creating a Hyperlink .............................................................. 1515
52.7 Utilities ................................................................................... 1516
52.7.1 Signal Generator .................................................................. 1516
52.7.2 Simple Math Operators ........................................................ 1516
52.7.3 Timed Force Objects ........................................................... 1516
52.8 Creating a Utility Object ......................................................... 1517
52.9 Timed Force Objects ............................................................. 1518
52.9.1 Timed Force Analog Object ................................................. 1518
52.9.2 Timed Force Digital Object .................................................. 1518
52.9.3 Timed Force Multistate Object ............................................. 1519
52.10 Timed Force Analog Object ................................................... 1520
52.11 Timed Force Digital Object .................................................... 1521
52.12 Timed Force Multistate Object ............................................... 1522
52.12.1 State Configuration .............................................................. 1522
52.13 Timed Force Multistate Object State Configuration ............... 1523
52.14 Configuring State Values in a Timed Force Multistate Object 1524
52.15 Configuring a Timed Force Object for Force Until ................. 1526
52.16 Configuring a Timed Force Object for Force Duration ........... 1527
52.17 Database Mode ..................................................................... 1528
52.17.1 Database Mode Indication and Default ............................... 1528
52.17.2 Database Mode Guidelines ................................................. 1528
52.18 Configuring WorkStation to run in Database Mode ................ 1529
52.19 Default System Folder ............................................................ 1530

53 WorkStation User Interface ..................................... 1535

53.1 Basic Functionality Icons in the System Tree Pane ................ 1539
53.2 File Menu .............................................................................. 1540
53.3 File Menu – New Submenu .................................................... 1542
53.4 Edit Menu ............................................................................... 1553
53.5 Actions Menu ......................................................................... 1555
53.6 Actions Menu – Activation Submenu ..................................... 1565

04-30005-01-en, May 2019 System

35
 53.7 Actions Menu – Advanced Submenu ..................................... 1566
53.8 Actions Menu – Advanced Commands Submenu ................. 1567
53.9 Actions Menu – Modification Submenu .................................. 1568
53.10 Actions Menu – View Submenu .............................................. 1569
53.11 Actions Menu - View Submenu - In Watch pane Submenu .... 1571
53.12 Actions Menu – Actions Submenu ......................................... 1572
53.13 Column Row Context Menu ................................................... 1573
53.14 Drag and Drop Context Menu ................................................ 1574
53.15 Drag and Drop Context Menu – New Submenu ..................... 1575
53.16 Watch Pane and Watch View ................................................. 1576
53.17 Watch Pane and Watch View Toolbar .................................... 1577
53.18 Watch Select Property Dialog Box ......................................... 1578
53.19 Add/Remove Columns Dialog Box (Watch) ........................... 1579
53.20 Tools Menu ............................................................................ 1580
53.21 Tools Menu - Measurement System Submenu ...................... 1581
53.22 Options Dialog Box ................................................................ 1582
53.23 Control Panel Tab .................................................................. 1583
53.24 Progress View – Advanced .................................................... 1586
53.25 Progress View – Simple ......................................................... 1587
53.26 Operation Details Dialog Box ................................................. 1588
53.27 Error Details – Progress View ................................................. 1589
53.28 Create Object Wizard – Naming the Object Page ................. 1590
53.29 Create Object Wizard – Create Server from a Backup Set
Page ...................................................................................... 1592
53.30 List View ................................................................................. 1593
53.31 List View Toolbar .................................................................... 1595
53.32 List View Context Menu .......................................................... 1596
53.33 List View Context Menu - Advanced Submenu ..................... 1598
53.34 List View Context Menu - List View Settings Submenu ......... 1599
53.35 System Tree Pane .................................................................. 1600
53.36 System Tree Pane Toolbar ..................................................... 1601
53.37 Confirm Delete Dialog Box ..................................................... 1602
53.38 Rename Object Dialog Box ................................................... 1603
53.39 General Information Properties – Basic Tab .......................... 1604
53.40 References Tab ..................................................................... 1606
53.41 Tags Dialog Box .................................................................... 1607
53.42 Configure Dialog Box – Configuration Tab ............................ 1608
53.43 Configure Dialog Box – Operation Tab .................................. 1610
53.44 Search Icons .......................................................................... 1611
53.45 Search View ........................................................................... 1612
53.46 Search View Toolbar .............................................................. 1614
53.47 Search Toolbar ...................................................................... 1615
53.48 Search View Context Menu .................................................... 1616
53.49 Add/Remove Columns Dialog Box (Search) .......................... 1617
53.50 Select Folder Dialog Box ....................................................... 1619
53.51 Select Types Dialog Box ........................................................ 1620
53.52 Select Conditions Dialog Box ................................................ 1621

System 04-30005-01-en, May 2019

36
 53.53 Add/Remove Columns Dialog Box (List View) ....................... 1622
53.54 Analog Value Properties ........................................................ 1623
53.55 Digital Value Properties .......................................................... 1624
53.56 Multistate Value Properties .................................................... 1625
53.57 String Value Properties .......................................................... 1626
53.58 Time Stamp Value Properties ................................................. 1627
53.59 Signal Generator Properties - Basic Tab ............................... 1628
53.60 Simple Math Operator Properties - Basic Tab ....................... 1629
53.61 Timed Force Analog Object Properties – Basic Tab .............. 1630
53.62 Timed Force Analog Object Properties – Parameters Tab .... 1631
53.63 Timed Force Digital Object Properties – Basic Tab ............... 1632
53.64 Timed Force Digital Object Properties – Parameters Tab ...... 1633
53.65 Timed Force Multistate Object Properties – Basic Tab .......... 1634
53.66 Timed Force Multistate Object Properties – Parameters Tab 1635
53.67 Timed Force Multistate Object Properties – State Configuration
Tab ......................................................................................... 1636
53.68 Create Hyperlink Wizard – Assign the URL Page .................. 1637
53.69 Select Object Dialog Box ....................................................... 1638
53.70 Select Object and Property Dialog Box ................................. 1639
53.71 Progress View ........................................................................ 1640
53.72 Status Bar .............................................................................. 1641
53.73 System Object Properties ...................................................... 1642
53.74 System Control Panel Properties ........................................... 1643
53.75 Commit Page ......................................................................... 1644
53.76 Objects and Trends Dialog Box ............................................. 1645
53.77 Duplicate Dialog Box ............................................................. 1647
53.78 Rename Dialog Box ............................................................... 1648
53.79 Save Layout as Content Type Dialog Box .............................. 1649
53.80 Manage Content Types Dialog Box ....................................... 1650
53.81 Select Content Type Dialog Box ............................................ 1651
53.82 Building Operation WorkStation Error .................................... 1652

54 WebStation ............................................................. 1653

54.1 Time and Date ....................................................................... 1655
54.2 Configuring Time and Date using WebStation ...................... 1656

55 WebStation User Interface ..................................... 1657

55.1 Time and Date Editor in WebStation ..................................... 1659

56 EcoStruxure Building Operation Objects ................ 1661

56.1 EcoStruxure Building Operation Objects .............................. 1663
56.1.1 Object Names ...................................................................... 1663
56.1.2 Object Properties ................................................................. 1663
56.1.3 Content Types ...................................................................... 1663
56.1.4 List View Features ................................................................ 1663
56.2 Object Names ........................................................................ 1664
56.2.1 Mass Edit ............................................................................. 1664
56.3 Object Properties ................................................................... 1665

04-30005-01-en, May 2019 System

37
 56.4 Opening an Object in a New Window .................................... 1667
56.5 Object Tab Display ................................................................ 1668
56.6 Showing the Same Tab While Navigating Between Objects .. 1669
56.7 Showing Non-Presentation Objects in the System Tree
Pane ....................................................................................... 1670
56.8 Creating a Folder ................................................................... 1671
56.9 Copy, Paste, Duplicate, Move, Rename, and Delete ............. 1672
56.10 Copying a Folder or Object .................................................... 1674
56.11 Duplicating an Object ............................................................ 1675
56.12 Renaming a Folder or Object ................................................. 1676
56.13 Deleting an Object ................................................................. 1677
56.14 Adding and Removing Columns ............................................ 1678
56.15 Mass Edit ............................................................................... 1679
56.16 Mass Editing Objects ............................................................. 1680
56.17 Mass Renaming Objects ....................................................... 1681
56.18 Mass Renaming Objects Using Copy and Paste .................. 1682
56.19 Mass Changing Units ............................................................. 1683
56.20 List View Features .................................................................. 1684
56.21 Renaming in List View ............................................................ 1685
56.22 Content Types ....................................................................... 1686
56.22.1 Content Type Synchronization ............................................. 1687
56.23 Creating a Content Type ........................................................ 1688
56.24 Applying a Content Type ....................................................... 1689
56.25 Renaming a Content Type ..................................................... 1690
56.26 Clearing a Content Type ........................................................ 1691
56.27 Deleting a Content Type ........................................................ 1692
56.28 Content Type Synchronization ............................................... 1693
56.29 Synchronizing Content Types ................................................ 1694
56.30 Semantic Tagging .................................................................. 1695
56.31 Tagging with Semantic Tags ................................................. 1696

57 Archive .................................................................... 1697

57.1 Archiving Overview ................................................................ 1699
57.1.1 Archive Log Files ................................................................. 1700
57.1.2 Archiving Formats and Storage ........................................... 1700
57.1.3 Archive Folders, Files, and Names ...................................... 1700
57.1.4 Archiving Server Compatibility ............................................ 1700
57.1.5 System Alarms for Archiving ................................................ 1701
57.1.6 Manual and Scheduled Archiving ........................................ 1701
57.2 Archiving EcoStruxure BMS Server Compatibility .................. 1702
57.3 Enabling the Archiving Function and Defining the Archive
Folder ..................................................................................... 1703
57.4 Archive Formats and Storage ................................................ 1704
57.4.1 Archive Storage and Validation ........................................... 1704
57.5 Manual and Scheduled Archiving .......................................... 1705
57.6 Manually Creating an Archive ................................................ 1706
57.7 Creating a Scheduled Archive ............................................... 1707

System 04-30005-01-en, May 2019

38
 57.8 Removing Extended Trend Logs from the Archive ................ 1708
57.9 Removing Events from the Archive ........................................ 1709
57.10 Archive Folders, Files, and Names ........................................ 1710
57.10.1 Archive Folder Names ......................................................... 1710
57.10.2 Archive System Resource Files ........................................... 1710
57.10.3 File Names for Extended Trend Log Archives ..................... 1711
57.10.4 File Names for Events Log Archives .................................... 1711
57.10.5 Unique Archive File Names ................................................. 1711
57.10.6 Archive Log Contents .......................................................... 1711
57.11 Archive Log Contents ............................................................ 1712
57.11.1 Columns and Descriptions .................................................. 1712
57.11.2 Event and Alarm Enumerations ............................................ 1716
57.11.3 Trend Log Enumerations ..................................................... 1716
57.12 Event and Alarm Enumerations ............................................. 1717
57.12.1 Alarm State .......................................................................... 1717
57.12.2 Assigned State ..................................................................... 1717
57.12.3 BACnet Alarm Type ............................................................. 1717
57.12.4 Basic Evaluation State ......................................................... 1718
57.12.5 Disabled Cause ................................................................... 1718
57.12.6 Evaluation State ................................................................... 1718
57.12.7 Hidden ................................................................................. 1719
57.12.8 Previous Alarm State ............................................................ 1719
57.12.9 System Alarm ID .................................................................. 1719
57.12.10 System Event ID ................................................................... 1720
57.13 System Alarm ID Enumerations ............................................. 1721
57.14 System Event ID Enumerations .............................................. 1730
57.15 Trend Log Enumerations ........................................................ 1737

58 Archive User Interface ............................................ 1739

58.1 Archive Settings Manager Dialog Box ................................... 1741
58.2 Add Extended Trend Logs Dialog Box .................................. 1743
58.3 Archiving Settings Properties – Basic Tab ............................. 1744
58.4 Archiving Settings Properties – Content Tab ......................... 1745
58.5 Archive Icons in the System Tree ........................................... 1747
58.6 Event Archive File ................................................................. 1748
58.7 Trend Log Archive File ........................................................... 1751

59 Search .................................................................... 1753

59.1 Search Overview ................................................................... 1755
59.1.1 Simple Search ...................................................................... 1755
59.1.2 Search ................................................................................. 1755
59.1.3 Saved Search ...................................................................... 1755
59.1.4 Relative or Locked Search Path ........................................... 1755
59.2 Simple Search ....................................................................... 1757
59.2.1 Wildcard Search .................................................................. 1757
59.2.2 Search Result List ................................................................ 1758
59.3 Searching for Objects Using Simple Search ......................... 1759

04-30005-01-en, May 2019 System

39
 59.4 Saving a Search ..................................................................... 1760
59.5 Search .................................................................................. 1761
59.5.1 Wildcard Search .................................................................. 1761
59.5.2 Forced Values Search ......................................................... 1762
59.5.3 Object Types Search ........................................................... 1762
59.5.4 Properties Conditions Search .............................................. 1762
59.5.5 Setpoint Search Example .................................................... 1762
59.5.6 Non-Validated Programs Search Example .......................... 1763
59.5.7 Search Result List ................................................................ 1763
59.6 Properties Conditions Search ................................................ 1764
59.7 Searching for Objects or Properties ....................................... 1767
59.8 Displaying Property Bindings in a Search Result ................... 1768
59.9 Displaying the Retain Level in a Search Result ...................... 1769
59.10 Displaying Value Transfer Settings in a Search Result .......... 1770
59.11 Setpoint Search Example ....................................................... 1771
59.12 Non-Validated Programs Search Example ............................ 1774
59.13 Searching for Forced Values ................................................. 1777

60 Shortcuts ................................................................ 1779

60.1 Shortcuts Overview ................................................................ 1781
60.1.1 Shortcut Functionality .......................................................... 1781
60.1.2 Shortcut Targets .................................................................. 1781
60.1.3 User Access to Shortcuts and Targets ................................ 1781
60.1.4 Shortcut Creation ................................................................. 1782
60.1.5 Shortcut Presentation ........................................................... 1782
60.2 Shortcut Functionality ............................................................ 1783
60.3 Shortcut Targets .................................................................... 1784
60.4 User Access to Shortcuts and Targets .................................. 1785
60.5 Shortcut Creation ................................................................... 1786
60.5.1 Shortcuts in EcoStruxure BMS Servers and Folders ............ 1786
60.5.2 Shortcuts to Objects and Points .......................................... 1787
60.6 Shortcut Presentation ............................................................. 1788
60.7 Viewing Shortcuts .................................................................. 1789
60.8 Viewing Shortcut Properties ................................................... 1790
60.9 Creating a Shortcut ................................................................ 1791
60.10 Configuring the Target of a Shortcut ...................................... 1792

61 Shortcuts User Interface ......................................... 1793

61.1 Shortcuts Icon ........................................................................ 1795
61.2 Create Shortcut Wizard – Shortcut Target Page .................... 1796
61.3 Shortcut Properties – Basic Tab ............................................. 1797

62 Documents ............................................................. 1799

62.1 Documents Overview ............................................................. 1801
62.2 Creating a Document ............................................................. 1802
62.3 Document Policy .................................................................... 1803
62.4 Adding a File Extension to the Permitted File Extensions List 1804

System 04-30005-01-en, May 2019

40
 62.5 Editing a File Extension on the Permitted File Extensions
List ........................................................................................ 1805
62.6 Removing a File Extension from the Permitted File Extensions
List ......................................................................................... 1806

63 Documents User Interface ...................................... 1807

63.1 Document Properties – Basic Tab ......................................... 1809
63.2 New Document Wizard – Import Document Page ................. 1810
63.3 Document Policy View ........................................................... 1811
63.4 Document Policy Toolbar ....................................................... 1812
63.5 Add File Extension Dialog Box ............................................... 1813
63.6 Edit File Extension Dialog Box ............................................... 1814

64 Backup and Restore ............................................... 1815

64.1 Backup and Restore Overview .............................................. 1817
64.1.1 Backup ................................................................................ 1817
64.1.2 Restore ................................................................................ 1817
64.1.3 BACnet Backup and Restore ............................................... 1817
64.1.4 Archiving Overview .............................................................. 1817
64.1.5 Comparison of Backup and Restore Methods ..................... 1818
64.1.6 Retain Level ......................................................................... 1818
64.2 Comparison of Backup and Restore Methods ...................... 1819
64.3 Retain Level .......................................................................... 1821
64.4 Configuring the Retain Level .................................................. 1823

65 Backups .................................................................. 1825

65.1 Backup .................................................................................. 1827
65.1.1 Types of Data ....................................................................... 1827
65.1.2 Backup Sets ......................................................................... 1827
65.1.3 Scheduled Backups ............................................................ 1827
65.1.4 Manual Backups .................................................................. 1827
65.1.5 Mass Backup ....................................................................... 1828
65.1.6 System Backup .................................................................... 1828
65.1.7 Backup Status ...................................................................... 1828
65.2 Types of Data ......................................................................... 1829
65.3 Backup Status ........................................................................ 1830
65.4 Checking the Backup Status of an EcoStruxure BMS Server 1831
65.5 Manual Backups .................................................................... 1832
65.5.1 Backup Set Naming ............................................................. 1832
65.5.2 Local Backup and Restore of EcoStruxure BMS Servers .... 1832
65.5.3 Remote Backup and Restore of SmartX Servers ................. 1833
65.6 Mass Backup ......................................................................... 1834
65.7 Backing Up EcoStruxure BMS Servers Manually ................... 1835
65.8 System Backup ...................................................................... 1836
65.9 Local Backup and Restore of EcoStruxure BMS Servers ...... 1838
65.9.1 Local Backup and Restore of a Standalone SmartX Server 1838
65.9.2 Local Backup and Restore of an Enterprise Server ............. 1838
65.9.3 Local Backup and Restore of an Enterprise Central ............ 1838

04-30005-01-en, May 2019 System

41
 65.10 Remote Backup and Restore of SmartX Servers ................... 1839

66 Backup Sets ........................................................... 1841

66.1 Backup Sets .......................................................................... 1843
66.1.1 Backup Sets Location .......................................................... 1843
66.1.2 Backup Sets and Server Name ............................................ 1843
66.1.3 Backup Set Storage and Protection ..................................... 1843
66.1.4 Backup Set Import from WorkStation ................................... 1843
66.1.5 Automatic Purge of Backup Sets ......................................... 1844
66.2 Location of Backup Sets ........................................................ 1845
66.2.1 Multi Server System ............................................................. 1845
66.2.2 Stand-alone System ............................................................. 1845
66.3 Backup Set Storage and Protection ....................................... 1847
66.4 Locating the Local Backup Path on the Enterprise Server or
Enterprise Central .................................................................. 1849
66.5 Saving an Enterprise Server or Enterprise Central Backup Set to
Another Location .................................................................... 1850
66.6 Saving a SmartX Server Backup Set to Another Location ...... 1851
66.7 Copying a Backup Set to the Enterprise Server or Enterprise
Central Local Directory .......................................................... 1852
66.8 Backup Set Import from WorkStation ..................................... 1853
66.9 Importing a Backup Set to an Enterprise Server or Enterprise
Central ................................................................................... 1855
66.10 Importing a Backup Set to SmartX Server .............................. 1856
66.11 Automatic Purge of Backup Sets ........................................... 1857
66.12 Configuring Purge Settings on an Enterprise Server ............. 1858
66.13 Configuring Purge Settings on an Enterprise Central ............ 1859
66.14 Deleting a Backup Set from an Enterprise Server or Enterprise
Central ................................................................................... 1860

67 Scheduled Backups .............................................. 1861

67.1 Scheduled Backups .............................................................. 1863
67.1.1 Backup Rules ....................................................................... 1863
67.1.2 Backup Schedules ............................................................... 1864
67.1.3 Synchronized Backups ........................................................ 1864
67.2 Backup Rules ......................................................................... 1865
67.3 Creating a Backup Rule ......................................................... 1866
67.4 Editing a Backup Rule ........................................................... 1867
67.5 Deleting a Backup Rule ......................................................... 1868
67.6 Removing a Lead Rule from a Backup Rule .......................... 1869
67.7 Backup Schedules ................................................................. 1870
67.8 Editing a Backup Schedule ................................................... 1871
67.9 Synchronized Backups .......................................................... 1872
67.10 Synchronizing EcoStruxure BMS Server Backups on a
Network .................................................................................. 1873

68 Restore ................................................................... 1875

68.1 Restore .................................................................................. 1877
68.1.1 Restored Data ...................................................................... 1877

System 04-30005-01-en, May 2019

42
 68.1.2 SmartX Server Replacement Using Restore ........................ 1877
68.1.3 Duplicate SmartX Server Using Restore .............................. 1877
68.2 Restored Data ........................................................................ 1878
68.3 Restoring the EcoStruxure BMS Server ................................. 1880
68.4 Restoring a SmartX Server from the Enterprise Server .......... 1881
68.5 Restoring an Enterprise Server from the Enterprise Central .. 1882
68.6 SmartX Server Replacement Using Restore .......................... 1883
68.6.1 SmartX Server Replacement Using Restore Workflow ......... 1884
68.7 SmartX Server Replacement Using Restore Workflow ........... 1885
68.8 Duplicate SmartX Server from a Backup Set ......................... 1887
68.8.1 Duplicate SmartX Server from a Backup Set Workflow ........ 1888
68.9 Duplicating a SmartX Server Using Restore ......................... 1890

69 Backup and Restore User Interface ....................... 1891

69.1 Backup and Restore Manager Properties (Enterprise Central) –
Basic Tab ............................................................................... 1893
69.2 Backup and Restore Manager Properties (Enterprise Server) –
Basic Tab ............................................................................... 1895
69.3 Backup and Restore Manager Properties (SmartX Servers) –
Basic Tab ............................................................................... 1897
69.4 Backup and Restore Manager on the Enterprise Server ....... 1898
69.5 Backup and Restore Manager on a SmartX Server .............. 1900
69.6 Backup Options Dialog Box ................................................... 1901
69.7 Create Object Wizard – Configure Backup Rule Page .......... 1903
69.8 Backup Rule Properties – Basic Tab ..................................... 1904
69.9 Backup Rules View ................................................................ 1905
69.10 Backup Rules Toolbar ........................................................... 1906
69.11 Backup Rules List .................................................................. 1907
69.12 Digital Schedule Properties – Basic Tab ................................ 1908
69.13 Backup Set Properties – Basic Tab ....................................... 1910
69.14 Backup Sets View .................................................................. 1911
69.15 Backup Status Dialog Box ..................................................... 1912
69.16 Control Panel – Backup and Archiving .................................. 1913
69.17 Backup Rule Dialog Box ........................................................ 1914
69.18 Backup and Restore System Tree Icons ................................ 1915
69.19 Restore Options Dialog Box ................................................... 1916
69.20 Restore Status Dialog Box ..................................................... 1918
69.21 Backup and Restore Folder Properties .................................. 1919

04-30005-01-en, May 2019 System

43
Introduction

The Introduction part contains information on the purpose of

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

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

1.1 Purpose of This Guide

This guide provides information on how to configure and administer alarms,
trend logs, schedules, and other features of the EcoStruxure Building Operation
software. This information is intended to help you understand the EcoStruxure
BMS and user interface, as well as how to perform tasks in the system.

04-30005-01-en, May 2019 System

49
1 About This Guide
1.2 How This Guide is Organized

1.2 How This Guide is Organized

This EcoStruxure Building Operation Guide is divided into the following parts:

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

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

System 04-30005-01-en, May 2019

50
 1 About This Guide
1.3 Safety Information

1.3 Safety Information

Important Information
Read these instructions carefully and look at the equipment to become familiar
with the device before trying to install, operate, service or maintain it. The
following special messages may appear throughout this bulletin or on the
equipment to warn of potential hazards or to call attention to information that
clarifies or simplifies a procedure.

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

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

This is the safety alert symbol. It is used to alert you to potential

personal injury hazards. Obey all safety messages that follow this
symbol to avoid possible injury or death.

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

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

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

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

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

04-30005-01-en, May 2019 System

51
2 Additional Information

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

2.1 Where to Find Additional Information

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

Figure: Help in EcoStruxure Building Operation software

Some EcoStruxure Building Operation software products give you context-

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

The WebHelp site

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

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

Figure: Home page search

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

Filtering the information

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

04-30005-01-en, May 2019 System

55
2 Additional Information
2.1 Where to Find Additional Information

Figure: Search filters

System 04-30005-01-en, May 2019

56
Reference

The Reference part contains conceptual information,

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

Topics
EcoStruxure Building Management Overview
Work Interface Overview
Function Overview
Engineering Tools Overview
Protocols Overview
Licensing, Installation, and Localization Overview
 3 EcoStruxure Building Management
3.1 EcoStruxure Building Management Overview

3.1 EcoStruxure Building Management

Overview
EcoStruxure Building Management is an integration platform for monitoring,
control, and management of energy, lighting, fire safety, security and HVAC.

3.1.1 Work Interface Overview

You use interfaces to set up, manage and operate the EcoStruxure BMS on a
daily basis.
For more information, see section 3.2 “Work Interface Overview” on page 63.

3.1.2 EcoStruxure BMS Server Overview

EcoStruxure BMS servers are used to engineer and supervise Building
Management Systems.
For more information, see the EcoStruxure BMS Server Overview topic on
WebHelp.

3.1.3 Function Overview

The EcoStruxure Building Operation software gives you a number of functions to
monitor and manage your facilities.
For more information, see section 3.3 “Function Overview” on page 64.

3.1.4 Engineering Tools Overview

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

3.1.5 Protocol Overview

The EcoStruxure Building Operation software supports the major communication
protocols in building automation and security management.
For more information, see section 3.5 “Protocols Overview” on page 69.

04-30005-01-en, May 2019 System

61
3 EcoStruxure Building Management
3.1 EcoStruxure Building Management Overview

3.1.6 Hardware Overview

The Schneider Electric hardware devices for the EcoStruxure BMS include
terminal bases, PS-24V power supplies, I/O modules, SmartX servers such as
SmartX AS-P servers and SmartX AS-B servers, SmartX IP Controller devices
such as MP-Cs, MP-Vs, IP-IO modules, and RP-Cs, SmartX Sensors, and ADs.
For more information, see the Hardware Overview topic on WebHelp.

3.1.7 Licensing, Installation, and Localization

Overview
To be able to run the EcoStruxure Building Operation software you need to
install and licensing the software.
For more information, see section 3.6 “Licensing, Installation, and Localization
Overview” on page 73.

3.1.8 System Registration Overview

Registering your EcoStruxure Building Operation software ensures that you get
better services, warranty, and critical system information.
For more information, see the System Registration topic on WebHelp.

3.1.9 System Upgrade Overview

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

System 04-30005-01-en, May 2019

62
 3 EcoStruxure Building Management
3.2 Work Interface Overview

3.2 Work Interface Overview

You use interfaces to set up, manage and operate the EcoStruxure BMS on a
daily basis.

3.2.1 WebStation Overview

WebStation is your web-based interface to your EcoStruxure BMS. You use
WebStation to perform work on a daily basis in the EcoStruxure BMS.
For more information, see the WebStation Overview topic on WebHelp.

3.2.2 WorkStation Overview

WorkStation is your main interface to your EcoStruxure BMS. You use
WorkStation to perform all work on a daily basis in the EcoStruxure BMS.
For more information, see the WorkStation Overview topic on WebHelp.

3.2.3 WebHelp Overview

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

04-30005-01-en, May 2019 System

63
3 EcoStruxure Building Management
3.3 Function Overview

3.3 Function Overview

The EcoStruxure Building Operation software gives you a number of functions to
monitor and manage your facilities.

3.3.1 Alarm Overview

You use an alarm to monitor a variable and to alert you if the monitored variable
matches the configured alarm conditions.
For more information, see section 29.1 “Alarms Overview” on page 577.

3.3.2 Schedules Overview

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

3.3.3 Trend Overview

The function of a trend log is to log the variable that it is connected to and store
the records.
For more information, see section 38.1 “Trends Overview” on page 1105.

3.3.4 User Account Management Overview

When logging on to an EcoStruxure BMS server, you have to authenticate
yourself by using a valid user account. The user account has to belong to the
same domain as the server you log on to.
For more information, see section 19.1 “User Account Management Overview”
on page 353.

3.3.5 Backup and Restore Overview

You backup your EcoStruxure BMS server data so that it can be restored after
damage or loss due to hardware or software failures, security threats, or
application testing.
For more information, see section 64.1 “Backup and Restore Overview” on page
1817.

System 04-30005-01-en, May 2019

64
 3 EcoStruxure Building Management
3.3 Function Overview

3.3.6 Documents Overview

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

3.3.7 Search Overview

Use Search in WorkStation to find and view objects in the database.
For more information, see section 59.1 “Search Overview” on page 1755.

3.3.8 Shortcuts Overview

In the EcoStruxure Building Operation software, you can create shortcuts to
objects in the System Tree pane. A shortcut is a link to a target EcoStruxure BMS
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 60.1 “Shortcuts Overview” on page 1781.

3.3.9 Cloud Connectivity Overview

When cloud connectivity is enabled, the EcoStruxure BMS sends data from the
system to the central storage for diagnostics and analysis along with data from
other buildings and sites.
For more information, see the Cloud Connectivity Overview topic on WebHelp.

04-30005-01-en, May 2019 System

65
3 EcoStruxure Building Management
3.4 Engineering Tools Overview

3.4 Engineering Tools Overview

You engineer your system using the engineering tools.

3.4.1 Spreadsheet Overview

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

3.4.2 Bindings Overview

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

3.4.3 Text Reports Overview

A text report provides a simple and quick method of obtaining a customized
view of object property attributes.
For more information, see the Text Reports Overview topic on WebHelp.

3.4.4 Import and Export Overview

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

3.4.5 Script Overview

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

System 04-30005-01-en, May 2019

66
 3 EcoStruxure Building Management
3.4 Engineering Tools Overview

3.4.6 Function Block Editor Overview

Function Block Editor is a graphical programming tool for EcoStruxure BMS
servers and MP Series controllers, which you use to create function block
programs that control and monitor building automation systems. For example,
you create a basic program, called OfficeLight, to control lighting in a room
based on occupancy.
For more information, see the Function Block Editor Overview topic on WebHelp.

3.4.7 Graphics Editor Overview

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

3.4.8 WebReports Overview

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

3.4.9 Project Configuration Tool Overview

Project Configuration Tool, with Project Configuration Tool client and
WorkStation, is an offline engineering platform that is used for project
configuration, virtual EcoStruxure BMS server configuration, and deployment.
Project Configuration Tool supports the major communication protocols in the
same way as other EcoStruxure Building Operation software products.
For more information, see the Project Configuration Tool Overview topic on
WebHelp.

3.4.10 Vista Conversion Overview

To assess whether or not to convert a Vista system to an EcoStruxure BMS, you
run an analysis of the Vista database export file to get information on the
potential outcome of a conversion. The analysis is performed in TAC Vista
Conversion Tool. If the analysis confirms that the Vista database is suitable for
conversion, you can convert the database in TAC Vista Conversion Tool.
For more information, see the Vista Conversion Overview topic on WebHelp.

04-30005-01-en, May 2019 System

67
3 EcoStruxure Building Management
3.4 Engineering Tools Overview

3.4.11 Continuum Conversion Overview

Conversion is the process by which a customer's site is moved from Andover
Continuum's legacy Building Management System to the EcoStruxure BMS. The
Continuum Conversion Tool takes an ASCII dump from the Continuum system
and creates EcoStruxure Building Operation objects that correspond to the
objects in the ASCII dump file.
For more information, see the Continuum Conversion Overview topic on
WebHelp.

3.4.12 SmartXKiosk Overview

SmartXKiosk allows you to configure AD as a dedicated HMI for local access to
EcoStruxure BMS servers.
For more information, see the SmartXKiosk Overview topic on WebHelp.

3.4.13 SmartX AD-Link Overview

SmartX AD-Link allows you to use a USB connection for TCP/IP network
communication between AD and an EcoStruxure BMS server.
For more information, see the SmartX AD-Link Overview topic on WebHelp.

System 04-30005-01-en, May 2019

68
 3 EcoStruxure Building Management
3.5 Protocols Overview

3.5 Protocols Overview

The EcoStruxure Building Operation software supports the major communication
protocols in building automation and security management.

3.5.1 I/O Modules Overview

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

3.5.2 MP Series Controller Overview

The MP Series controller is an IP-enabled, native BACnet field controller from
Schneider Electric. It is a highly flexible, open protocol device that is fully
programmable through the EcoStruxure Building Operation software for control
and supervision of equipment typically used in HVAC applications. Its mix of
universal I/O and intelligent SmartX sensor support allows for a wide-range of
control solutions.
For more information, see the MP Series Controller Overview topic on WebHelp.

3.5.3 BACnet Overview

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

3.5.4 b3 BACnet Device Overview

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

04-30005-01-en, May 2019 System

69
3 EcoStruxure Building Management
3.5 Protocols Overview

3.5.5 MNB BACnet Device Overview

MNB BACnet devices are a family of programmable, stand-alone devices that
provide direct digital control in a building's environmental control system. MNB
BACnet devices comprise MNB-70, MNB-300, MNB-V1, MNB-V2 and MNB-
1000 devices. MNB devices support S-Link sensors, which are designed
specifically for use with these devices.
For more information, see the MNB BACnet Device Overview topic on WebHelp.

3.5.6 LonWorks Overview

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

3.5.7 Xenta LonWorks Device Overview

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

3.5.8 MNL LonWorks Device Overview

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

3.5.9 Modbus Overview

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

System 04-30005-01-en, May 2019

70
 3 EcoStruxure Building Management
3.5 Protocols Overview

3.5.10 I/NET Overview

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

3.5.11 NETWORK 8000 Overview

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

3.5.12 MicroNet Overview

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

3.5.13 Sigma Overview

Sigma is a building management system that comprises controller device and
communications components which can be applied to a variety of environmental
and building control services. The system components are seamlessly linked by
a suite of user interface and control software called Satchwell Sigma.
For more information, see the Sigma Overview topic on WebHelp.

3.5.14 Infinet Device Overview

Infinet devices are intelligent, programmable, stand-alone devices that provide
cost-effective Direct Digital Control of air handlers and systems, as well as
individual terminal units: VAV boxes, fan powered induction units, unit
ventilators, and heat pumps. Using the EcoStruxure Building Operation
software, you configure an Infinet network that connects WorkStation with
SmartX AS-P servers and Infinet devices. Their true peer-to-peer
communications protocol provides the Infinet series with the ability to instantly
communicate with a SmartX AS-P server and its entire network of devices.
For more information, see the Infinet Device Overview topic on WebHelp.

04-30005-01-en, May 2019 System

71
3 EcoStruxure Building Management
3.5 Protocols Overview

3.5.15 SmartDrivers Overview

The SmartDriver functionality enables you to create customized interfaces in an
EcoStruxure BMS that monitors and controls third-party devices from an
EcoStruxure BMS server.
For more information, see the SmartDrivers Overview topic on WebHelp.

3.5.16 Web Services Overview

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

System 04-30005-01-en, May 2019

72
 3 EcoStruxure Building Management
3.6 Licensing, Installation, and Localization Overview

3.6 Licensing, Installation, and Localization

Overview
To be able to run the EcoStruxure Building Operation software you need to
install and licensing the software.

3.6.1 Licensing Overview

The EcoStruxure Building Operation software is available for all to download and
install. However, you need valid licenses to use the software. The number of
users of the software is limited to the number of licenses owned by the
customer.
For more information, see section 10.1 “Licensing Overview” on page 151.

3.6.2 Installation Overview

The EcoStruxure Building Operation software products are installed using
installation packages.
For more information, see section 4.1 “Installation Overview” on page 77.

3.6.3 Regional and Language Overview

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

04-30005-01-en, May 2019 System

73
4 Installation

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

4.1 Installation Overview

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

4.1.1 Installation Packages

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

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

4.1.3 Installation Folder

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

04-30005-01-en, May 2019 System

77
4 Installation
4.1 Installation Overview

NOTICE
In cases where more than one version of WorkStation is installed on the same
computer, each version of WorkStation is installed in its own folder. When
WorkPlace Tech Editor is also selected in the Installation wizard, a copy of
WorkPlace Tech Editor matching the WorkStation version is installed.
However, all versions of WorkPlace Tech Editor are installed in a single,
designated folder, separate from the WorkStation folders.

The installers save a detailed log file on each installation. The files are stored in
the installation folder and are given the same name as the installer file, for
example, Workstation-x.y.z.log.

4.1.4 Installation Example

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

4.1.5 Installation Reparation

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

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

4.1.7 System Upgrade Overview

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

System 04-30005-01-en, May 2019

78
 4 Installation
4.1 Installation Overview

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

4.1.9 Version Numbers and Parallel Installations

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

4.1.10 Software Administrator

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

04-30005-01-en, May 2019 System

79
4 Installation
4.2 Products

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

4.2.1 WorkStation
WorkStation is the interface where you supervise your EcoStruxure BMS. In
WorkStation you can also create, modify, and delete some of the objects that are
used to build an EcoStruxure BMS.

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

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 52.1 “WorkStation” on page 1509.

4.2.2 Graphics Editor

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

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

The installation of Graphics Editor is bundled into the WorkStation installation

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

4.2.3 Script Editor

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

System 04-30005-01-en, May 2019

80
 4 Installation
4.2 Products

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

The installation of Script Editor is bundled into the WorkStation installation

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

4.2.4 Menta Editor

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

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

The installation of Menta Editor is bundled into the WorkStation installation

package.
For more information, see TAC Menta, Technical Manual (04-00030).

4.2.5 Function Block Editor

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

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

The installation of Function Block Editor is bundled into the WorkStation

installation package.
For more information, see the Function Block Editor Overview topic on WebHelp.

04-30005-01-en, May 2019 System

81
4 Installation
4.2 Products

4.2.6 WorkPlace Tech

The WorkPlace Tech component of WorkStation consists of two graphical tools:
WorkPlace Tech Monitor and WorkPlace Tech Editor. With WorkPlace Tech
Editor, you can create, modify, monitor, and troubleshoot MNL LonWorks and
MNB BACnet device applications. With WorkPlace Tech Monitor, you can
monitor and troubleshoot applications in MNL LonWorks and MNB BACnet
devices.

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

The installation of WorkPlace Tech is bundled into the WorkStation installation

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

NOTICE
The WorkPlace Tech Editor component requires the installation of the
appropriate version of Microsoft Visio.
For more information, see the WorkPlace Tech Editor topic on WebHelp.
For more information, see the Information Technology System Planning Guide
topic on WebHelp.

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

4.2.7 Enterprise Central

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

4.2.8 Enterprise Server

Enterprise Server is the hierarchical EcoStruxure BMS server at the top of the
system architecture hierarchy of a medium size Building Management System,
or at the middle of the hierarchy in a large system. Enterprise Server is primary
used for administration, system supervision and engineering of SmartX servers.
Enterprise Server aggregates data that can be accessed by Enterprise Central.

System 04-30005-01-en, May 2019

82
 4 Installation
4.2 Products

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

For more information, see the Enterprise Server topic on WebHelp.

4.2.9 Software Administrator

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

4.2.10 Device Administrator

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

4.2.11 License Administrator

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

4.2.12 License Server

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

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

04-30005-01-en, May 2019 System

83
4 Installation
4.2 Products

4.2.14 Language Package

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

System 04-30005-01-en, May 2019

84
 4 Installation
4.3 Installation Example

4.3 Installation Example

Schneider Electric recommends that you install the license server framework
before installing other EcoStruxure Building Operation software applications and
SmartX servers. The license server installation is included in the License
Administrator license package. During the installation of WorkStation or
Enterprise Server, the installation software asks for the address to the license
server.
License files used to activate time-limited local licenses can be distributed
under certain circumstances.
For more information, see section 11.8 “Local Licenses” on page 194.

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

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

Figure: Installation and configuration order

04-30005-01-en, May 2019 System

85
4 Installation
4.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 11.2 “Network License
Management” on page 185.
• 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-30005-01-en, May 2019

86
 4 Installation
4.4 Version Numbers and Parallel Installations

4.4 Version Numbers and Parallel

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

Figure: The EcoStruxure Building Operation version number structure

Table: The EcoStruxure Building Operation Version Number Structure

Version number Description

Major Increment when major functionality

changes are released.

Minor Increment when minor functionality

changes are released.

Maintenance Increment when correctional changes are

released.

Build A sequential number to guarantee

uniqueness of the version release.

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

04-30005-01-en, May 2019 System

87
4 Installation
4.4 Version Numbers and Parallel Installations

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

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

NOTICE
• You cannot install parallel License Administrators.
• You should always run the latest maintenance version of the License
Administrator or License Server for your EcoStruxure Building Operation
version.

Version history log

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

System 04-30005-01-en, May 2019

88
 4 Installation
4.5 Installing the License Administrator and the License Server

4.5 Installing the License Administrator and

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

To install the License Administrator and License Server

1. Double-click on the License Administrator installation file to start the
installation wizard.
2. Click Yes to confirm that you want to run the License Administrator
installation package.
3. Click Next
Next.
4. In the License Agreement page, make sure that you agree with the End
User License Agreement (EULA) and then click I Agree
Agree.
5. In the Installation Folder page, browse to the folder where you want to
install License Administrator and License Server and then click Next
Next.

NOTICE
• When upgrading to a later version, the installation path is changed to
the default installation folder for that version. The default installation
folder is always located on the C: drive
• The complete installation path can have maximum 115 characters.

NOTICE
• EcoStruxure Building Operation products are installed in the same
folder that you selected for the first product you installed

6. In the Choose Components page, select the components you want to

install and then click Next
Next.
7. In the License Server Configuration page, in the License Server Address
box, type @ and then type the address to the license server.

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

8. Click Install
Install.

04-30005-01-en, May 2019 System

89
4 Installation
4.5 Installing the License Administrator and the License Server

9. In the Installation Complete page, click Next

Next.

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

10. Click Finish

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

System 04-30005-01-en, May 2019

90
 4 Installation
4.6 Installing WorkStation and Client Tools

4.6 Installing WorkStation and Client Tools

You install WorkStation and client tools to create and supervise your EcoStruxure
BMS.

NOTICE
• Ensure that you have working and available WorkStation, Graphics, Script,
WorkPlace Tech Editor, and Menta / Function Block licenses. A working
license for each product is required to start and log on. For more
information, see section 10.10 “Licenses” on page 166.
• It is recommended that you install the latest release of .NET 4.5 version
before installing WorkStation and Client Tools.

For more information, see section 4.1 “Installation Overview” on page 77.

To install WorkStation and client tools

1. Install the latest release of .NET version 4.5.
2. Double-click on the WorkStation installation file to start the installation
wizard.

NOTICE
If User Account Control (UAC) is enabled, you must run the installer as
administrator. Right-click the installation file and then click Run as
administrator
administrator.

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

04-30005-01-en, May 2019 System

91
4 Installation
4.6 Installing WorkStation and Client Tools

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

NOTICE
• When upgrading to a later version, the installation path is changed to
the default installation folder for that version. The default installation
folder is always located on the C: drive
• The complete installation path can have maximum 115 characters.

NOTICE
• EcoStruxure Building Operation products are installed in the same
folder that you selected for the first product you installed.
• If you are installing WorkStation and client tools on a 64-bit operating
system and you specify a location under \Program Files\
Files\, WorkPlace
Tech Editor and its components are installed in the folder \Program
Files (x86)\
(x86)\.

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

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

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

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

10. Click Install

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

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

System 04-30005-01-en, May 2019

92
 4 Installation
4.7 Installing a Language Pack

4.7 Installing a Language Pack

You install a language pack to upgrade an existing language pack with a newer
version, or to install an additional language pack.

NOTICE
• A WorkStation installation is a prerequisite to install additional language
packs.
• The version of the language pack to install must correspond with your
WorkStation version.

For more information, see section 16.3 “Language Packages” on page 295.

To install language pack

1. Double-click on the language pack installation file to start the installation
wizard.
2. In the Installation wizard, click Yes
Yes.
3. In the Language Pack Setup screen, click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
5. Click Next
Next.

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

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

04-30005-01-en, May 2019 System

93
4 Installation
4.8 Installing Enterprise Central

4.8 Installing Enterprise Central

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

To install Enterprise Central

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

NOTICE
If User Account Control (UAC) is enabled, you must run the installer as
administrator. Right-click the installation file and then click Run as
administrator
administrator.

2. In the User Account Control page, click Yes to confirm that you want to run
the installation package.
3. In the Welcome to the Enterprise Central Setup page, click Next
Next.
4. In the License Agreement page, make sure that you agree with the End
User License Agreement (EULA) and then, click I Agree
Agree.
5. In the Installation Folder - Program Files page, click Next
Next.
6. In the Installation Folder - Database Files page, in Database Folder box,
enter the path to the location where you want to save the Enterprise Central
database.

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

7. Click Next
Next.
8. In the Communication Ports page, in the HTTP Port box, type the port
number the Enterprise Central listens to when communicating through the
Hypertext Transfer Protocol.
9. In the HTTPS Port box, type the port number Enterprise Central listens to
when communicating through the Hypertext Transfer Protocol Secure.
10. In the TCP Port box, type the port number Enterprise Central listens to
when communicating through the Transmission Control Protocol.
11. Click Next
Next.
12. In the Windows Service page, select the account:
• Select Local system to run Enterprice Central service under the Local
system account.
• Select Custom to run the EcoStruxure BMS server from a customized
location.
13. In the User account in format DOMAIN/USER box, type the user account
name.

System 04-30005-01-en, May 2019

94
 4 Installation
4.8 Installing Enterprise Central

14. Click Verify Account to make sure this user account exists.
15. In the User account password box, type password.
16. In the Confirm password box, type password.
17. Click Next
Next.
18. In the License Server page, in the License Server address box, type @
and then type the address to the License Server.

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

19. Click Next

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

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

22. In the Installation Completed page, click Next

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

04-30005-01-en, May 2019 System

95
4 Installation
4.9 Installing the Enterprise Server

4.9 Installing the Enterprise Server

You install the Enterprise Server to collect data throughout the EcoStruxure BMS
while providing supervisory control.

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

For more information, see section 4.1 “Installation Overview” on page 77.

To install the Enterprise Server

1. In Windows, disable any anti-virus program.
2. Double-click on the Enterprise Server installation file to start the installation
wizard.

NOTICE
If User Account Control (UAC) is enabled, you must run the installer as
administrator. Right-click the installation file and then click Run as
administrator
administrator.

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

NOTICE
• When upgrading to a later version, the installation path is changed to
the default installation folder for that version. The default installation
folder is always located on the C: drive
• The complete installation path can have maximum 115 characters.

NOTICE
• EcoStruxure Building Operation products are installed in the same
folder that you selected for the first product you installed

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

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

System 04-30005-01-en, May 2019

96
 4 Installation
4.9 Installing the Enterprise Server

8. Click Next
Next.
9. In the HTTP Port box, type the port number the Enterprise Server listens to
when communicating through the Hypertext Transfer Protocol.
10. In the HTTPS Port box, type the port number the Enterprise Server listens
to when communicating through the Hypertext Transfer Protocol Secure.
11. In the TCP Port box, type the port number the Enterprise Server listens to
when communicating through the Transmission Control Protocol.
12. Click Next
Next.
13. Select Local system to run the Enterprice Server service under the Local
system account.

NOTICE
• For security reasons, it is recommended that you run the Enterprise
Server service under a custom Windows user account with limited
permissions.
• To run the Enterprise Server service under a custom Windows account,
select Custom, enter the domain and user account names, click Verify
Account to verify that the account exists, and then type the user
account password.
• To be able to log on to WebStation, the selected Windows user account
has to have write permissions to C:\Program Files (x86)\Schneider
Electric EcoStruxure\Building Operation X.X\Enterprise Server.

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

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

15. Click Next

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

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

18. Click Finish

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

04-30005-01-en, May 2019 System

97
4 Installation
4.9 Installing the Enterprise Server

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

NOTICE
In case of a port conflict, users are not able to log on to the EcoStruxure
BMS. In Software Administrator, resolve any port conflict. For more
information, see section 15.11 “Resolving Enterprise Server or Enterprise
Central Port Conflicts” on page 285..

System 04-30005-01-en, May 2019

98
 4 Installation
4.10 Installing the Device Administrator

4.10 Installing the Device Administrator

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

To install the Device Administrator

1. Double-click on the Device Administrator installation file to start the
installation wizard.
2. Click Yes
Yes, to confirm that you want to run the Device Administrator
installation package.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
5. Browse to the folder where you want to install Device Administrator and
click Next
Next.

NOTICE
• When upgrading to a later version, the installation path is changed to
the default installation folder for that version. The default installation
folder is always located on the C: drive
• The complete installation path can have maximum 115 characters.

NOTICE
• EcoStruxure Building Operation products are installed in the same
folder that you selected for the first product you installed

6. Select Device Administrator and then click Next.

7. Click Next
Next.

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

8. Click Finish
Finish.

04-30005-01-en, May 2019 System

99
5 Installation Repair

Topics
Installation Reparation
Repairing the License Administrator and the License Server
Repairing WorkStation and Client Tools Installation
Repairing the Enterprise Server
Repairing the Device Administrator Installation
 5 Installation Repair
5.1 Installation Reparation

5.1 Installation Reparation

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

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

04-30005-01-en, May 2019 System

103
5 Installation Repair
5.2 Repairing the License Administrator and the License Server

5.2 Repairing the License Administrator and

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

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

To repair the License Administrator and License Server

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

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

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

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

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

System 04-30005-01-en, May 2019

104
 5 Installation Repair
5.2 Repairing the License Administrator and the License Server

13. Click Install

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

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

15. Click Finish

Finish.

04-30005-01-en, May 2019 System

105
5 Installation Repair
5.3 Repairing WorkStation and Client Tools Installation

5.3 Repairing WorkStation and Client Tools

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

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

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

For more information, see section 5.1 “Installation Reparation” on page 103.

To repair the WorkStation and client tool installation

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

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

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

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

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

System 04-30005-01-en, May 2019

106
 5 Installation Repair
5.3 Repairing WorkStation and Client Tools Installation

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

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

11. Click Install

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

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

13. Click Finish

Finish.

04-30005-01-en, May 2019 System

107
5 Installation Repair
5.4 Repairing the Enterprise Server

5.4 Repairing the Enterprise Server

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

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

For more information, see section 5.1 “Installation Reparation” on page 103.

To repair the Enterprise Server

1. Ensure that you have a backup of the Enterprise Server data.
2. In Windows, disable any anti-virus program.

NOTICE
The Enterprise Server Windows Service is automatically stopped.

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

wizard.
4. Click Yes to confirm that you want to run the EcoStruxure Building
Operation installation package.
5. Click Next
Next.
6. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
7. In the Installation Folder page, click Next
Next.
8. Accept the database folder or browse to select another installation folder
for the database and then click Next
Next.

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

9. Click Next
Next.
10. In the Installation Type page, select Repair current version to repair the
current Enterprise Server installation.
11. Click Next
Next.
12. In the Communication Ports page, in the HTTP Port box, type the port
number the Enterprise Server listens to when communicating through the
Hypertext Transfer Protocol.
13. In the HTTPS Port box, type the port number the Enterprise Server listens
to when communicating through the Hypertext Transfer Protocol Secure.
14. In the TCP Port box, type the port number the Enterprise Server listens to
when communicating through the Transmission Control Protocol.

System 04-30005-01-en, May 2019

108
 5 Installation Repair
5.4 Repairing the Enterprise Server

15. Click Next

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

NOTICE
• For security reasons, it is recommended that you run the Enterprise
Server service under a custom Windows user account with limited
permissions.
• To run the Enterprise Server service under a custom Windows account,
select Custom, enter the domain and user account names, click Verify
Account to verify that the account exists, and then type the user
account password.
• To be able to log on to WebStation, the selected Windows user account
has to have write permissions to C:\Program Files (x86)\Schneider
Electric EcoStruxure\Building Operation X.X\Enterprise Server.

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

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

18. Click Next

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

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

21. Click Finish

Finish.

04-30005-01-en, May 2019 System

109
5 Installation Repair
5.5 Repairing the Device Administrator Installation

5.5 Repairing the Device Administrator

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

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

For more information, see section 5.1 “Installation Reparation” on page 103.

To repair the Device Administrator installation

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

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

9. Click Finish
Finish.

System 04-30005-01-en, May 2019

110
6 Reinstallation

Topics
Reinstallation
Reinstalling the License Administrator and the License
Server
Reinstalling WorkStation and Client Tools
Reinstalling the Enterprise Server
Reinstalling the Device Administrator Installation
 6 Reinstallation
6.1 Reinstallation

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

NOTICE
Back up the Enterprise Server before reinstalling the product. All user settings,
database information, and system files related to this product are erased and
replaced. For more information, see section 65.7 “Backing Up EcoStruxure
BMS Servers Manually” on page 1835.

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

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

04-30005-01-en, May 2019 System

113
6 Reinstallation
6.2 Reinstalling the License Administrator and the License Server

6.2 Reinstalling the License Administrator

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

To reinstall the License Administrator and License Server

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

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

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

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

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

13. Click Install

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

System 04-30005-01-en, May 2019

114
 6 Reinstallation
6.3 Reinstalling WorkStation and Client Tools

6.3 Reinstalling WorkStation and Client

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

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

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

For more information, see section 6.1 “Reinstallation ” on page 113.

To reinstall WorkStation and client tool installation

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

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

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

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

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

04-30005-01-en, May 2019 System

115
6 Reinstallation
6.3 Reinstalling WorkStation and Client Tools

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

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

11. Click Install

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

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

14. Click Next

Next.
15. Click Finish
Finish.

System 04-30005-01-en, May 2019

116
 6 Reinstallation
6.4 Reinstalling the Enterprise Server

6.4 Reinstalling the Enterprise Server

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

NOTICE
Back up the Enterprise Server before reinstalling the product. All user settings,
database information, and system files related to this product are erased and
replaced. For more information, see section 65.7 “Backing Up EcoStruxure
BMS Servers Manually” on page 1835.

For more information, see section 6.1 “Reinstallation ” on page 113.

To reinstall the Enterprise Server

1. Ensure that you have a backup of the Enterprise Server data.
2. In Windows, disable any anti-virus program.
3. Double-click the Enterprise Server installation file to start the installation
wizard.
4. Click Yes to confirm that you want to run the EcoStruxure Building
Operation installation package.

NOTICE
The Enterprise Server Windows Service is automatically stopped.

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

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

9. Click Next
Next.
10. In the Installation Type page, select Uninstall current version before
reinstalling
reinstalling.
11. Click Next
Next.
12. In Communication Ports page, in the HTTP Port box, type the port number
the Enterprise Server listens to when communicating through the Hypertext
Transfer Protocol.
13. In the HTTPS Port box, type the port number the Enterprise Server listens
to when communicating through the Hypertext Transfer Protocol Secure.

04-30005-01-en, May 2019 System

117
6 Reinstallation
6.4 Reinstalling the Enterprise Server

14. In the TCP Port box, type the port number the Enterprise Server listens to
when communicating through the Transmission Control Protocol.
15. Click Next
Next.
16. In the Windows Service page, select Local system to run the Enterprise
Server under the Local system account.

NOTICE
• For security reasons, it is recommended that you run the Enterprise
Server service under a custom Windows user account with limited
permissions.
• To run the Enterprise Server service under a custom Windows account,
select Custom, enter the domain and user account names, click Verify
Account to verify that the account exists, and then type the user
account password.
• To be able to log on to WebStation, the selected Windows user account
has to have write permissions to C:\Program Files (x86)\Schneider
Electric EcoStruxure\Building Operation X.X\Enterprise Server.

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

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

18. Click Next

Next.
19. Revise the information on the Summary page and then click Install
Install.
20. Click Uninstall to remove the Enterprise Server from your computer.
21. Click Close to confirm the uninstallation of the Enterprise Server.
22. Click Next.

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

23. Click Finish

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

System 04-30005-01-en, May 2019

118
 6 Reinstallation
6.5 Reinstalling the Device Administrator Installation

6.5 Reinstalling the Device Administrator

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

To reinstall the Device Administrator installation

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

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

10. In the Installation Complete page, click Next

Next.
11. Click Finish
Finish.

04-30005-01-en, May 2019 System

119
7 Computer Maintenance

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

7.1 Replace Enterprise Server or

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

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

Figure: Enterprise Server Replacement Preparation flowchart

04-30005-01-en, May 2019 System

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

Perform a system backup of EcoStruxure BMS servers

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

Stop Enterprise Server Windows service

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

Stop License Server Windows service

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

Stop Reporting Agent Windows service

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

Replace operating system or migrate Enterprise Server

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

Start Reporting Agent Windows service

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

7.1.2 Install EcoStruxure Building Operation

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

System 04-30005-01-en, May 2019

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

Figure: Reinstall EcoStruxure Building Operation software flowchart

Install Enterprise Server

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

Install other EcoStruxure Building Operation software

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

7.1.3 Restore the Enterprise Server Database

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

04-30005-01-en, May 2019 System

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

Figure: Restore Enterprise Database flowchart

Stop Reporting Agent Windows service

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

System 04-30005-01-en, May 2019

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

Restore Enterprise Server database

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

Verify TCP protocol and server communication

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

Verify control and monitoring operations

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

Back up the EcoStruxure BMS servers

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

Install WorkStation Language Pack

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

Install WebStation Language Pack

If you want to use a language pack in WebStation, install the language pack and
change the language setting in WebStation.
For more information, see section 16.5 “Adding a Language in WebStation” on
page 297.
For more information, see section 16.6 “Changing the Language in WebStation”
on page 298.
The process of changing the operating system or replacing the computer is now
complete.

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

7.1.4 WebReports Migration Preparation

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

04-30005-01-en, May 2019 System

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

Figure: WebReports Migration Preparation flowchart

Detach WebReports database

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

Export Reports schedules

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

7.1.5 Install WebReports

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

System 04-30005-01-en, May 2019

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

Figure: Reinstall WebReports flowchart

Configure Windows roles and features

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

Install Microsoft SQL Server

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

Attach WebReports database

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

04-30005-01-en, May 2019 System

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

Confirm administrator role memberships for WebReports database

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

Install WebReports Installer

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

Install WebReports and select upgrade option

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

Import or recreate Reports schedules

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

System 04-30005-01-en, May 2019

130
8 Uninstallation

Topics
Uninstallation
Uninstalling the License Administrator
Uninstalling the License Server
Uninstalling a Language Pack
Uninstalling WorkStation
Uninstalling Enterprise Central
Uninstalling Enterprise Server
Uninstalling Device Administrator
 8 Uninstallation
8.1 Uninstallation

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

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

NOTICE
Back up the EcoStruxure BMS server before uninstalling the product. All user
settings, database information, and system files related to this product are
erased. Files and backups created by the user remain and are not erased. For
more information, see section 65.7 “Backing Up EcoStruxure BMS Servers
Manually” on page 1835.

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

04-30005-01-en, May 2019 System

133
8 Uninstallation
8.2 Uninstalling the License Administrator

8.2 Uninstalling the License Administrator

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

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

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

To uninstall the License Administrator

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

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

System 04-30005-01-en, May 2019

134
 8 Uninstallation
8.3 Uninstalling the License Server

8.3 Uninstalling the License Server

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

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

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

To uninstall the License Server

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

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

04-30005-01-en, May 2019 System

135
8 Uninstallation
8.4 Uninstalling a Language Pack

8.4 Uninstalling a Language Pack

You uninstall a language pack before you uninstall Workstation.

To uninstall a language pack

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

System 04-30005-01-en, May 2019

136
 8 Uninstallation
8.5 Uninstalling WorkStation

8.5 Uninstalling WorkStation

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

NOTICE
Before you uninstall WorkStation, make sure that you do not have any
language pack installed. If you have language packs installed, you must
uninstall them before you uninstall WorkStation.

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

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

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

NOTICE
A common installation component is shared by all versions of WorkPlace
Tech, whether they are versions of WorkPlace Tech Editor or WorkPlace
Tech Tool. On a computer where multiple versions of WorkPlace Tech
Editor, WorkPlace Tech Tool, or both coexist, uninstalling any one version
of WorkPlace Tech causes this common component to also be
uninstalled. You can restore the shared component automatically, either
by starting a version of WorkPlace Tech Editor that was installed with
WorkStation version 1.2 or later, or by starting WorkPlace Tech Tool 5.8 or
later.
Version 1.1 of WorkStation does not allow parallel installation. If version
1.1 is the only version that remains, it must be reinstalled to restore the
shared WorkPlace Tech component. For more information, see
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-
27745) for a troubleshooting topic that restores this shared component in
WorkStation 1.1.

3. Click Close
Close.

04-30005-01-en, May 2019 System

137
8 Uninstallation
8.6 Uninstalling Enterprise Central

8.6 Uninstalling Enterprise Central

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

NOTICE
Back up the EcoStruxure BMS server before uninstalling the product. All user
settings, database information, and system files related to this product are
erased. Files and backups created by the user remain and are not erased. For
more information, see section 65.7 “Backing Up EcoStruxure BMS Servers
Manually” on page 1835.

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

To uninstall Enterprise Central

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

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

System 04-30005-01-en, May 2019

138
 8 Uninstallation
8.7 Uninstalling Enterprise Server

8.7 Uninstalling Enterprise Server

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

NOTICE
Back up the EcoStruxure BMS server before uninstalling the product. All user
settings, database information, and system files related to this product are
erased. Files and backups created by the user remain and are not erased. For
more information, see section 65.7 “Backing Up EcoStruxure BMS Servers
Manually” on page 1835.

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

To uninstall Enterprise Server

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

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

04-30005-01-en, May 2019 System

139
8 Uninstallation
8.8 Uninstalling Device Administrator

8.8 Uninstalling Device Administrator

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

To uninstall Device Administrator

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

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

System 04-30005-01-en, May 2019

140
9 Installation User interface

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

9.1 Installation Wizard – Choose

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

Figure: Choose Components page

Table: Choose Components Page

Component Description

Device Administrator Select to install Device Administrator,

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

License Administrator Select to install the License Administrator,

which you use to configure and maintain
the license system.

License Server Select to install the license server, which

you use to manage network licenses.

WorkStation Select to install WorkStation, which you use

to configure and supervise your
EcoStruxure BMS.

Graphics Editor Select to install Graphics Editor, which you

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

Script Editor Select to install Script Editor, which you

use to create custom script program for
your Building Automation System.

04-30005-01-en, May 2019 System

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

Continued
Component Description

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

Continuum Conversion Tool Select to install the Continuum Conversion

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

Workplace Tech Editor Select to install Workplace Tech Editor,

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

Language Packs Select to install the languages available for

the user interface of the installed
components.

Enterprise Server Select to install Enterprise Server, which

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

System 04-30005-01-en, May 2019

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

9.2 Installation Wizard – Installation Type

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

Figure: Installation Type

Table: Installation Type

Component Description

Uninstall current version before Select to uninstall your current installation

reinstalling before the installation of a fresh copy
starts.

Repair current version Select to repair your current installation.

Upgrade current version Select to upgrade your current installation

to a newer version.

Upgrade existing database Select to upgrade your current Enterprise

Server database to a newer version.

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

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

Replace database Select to replace your current Enterprise

Server database with an empty installation.

04-30005-01-en, May 2019 System

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

9.3 Installation Wizard – License Server

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

Figure: License server configuration page

Table: License Server Configuration Page

Component Description

License Server Address Type the address to the license server

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

System 04-30005-01-en, May 2019

146
 9 Installation User interface
9.4 Server Installation Wizard – Configuration Page

9.4 Server Installation Wizard –

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

Figure: Configuration page

Table: Configuration Page

Component Description

HTTP Port Type the port number that the Enterprise

Server listens to when communicating
through the Hypertext Transfer Protocol.

HTTPS Port Type the port number that the Enterprise

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

TCP Port Type the port number that the Enterprise

Server listens to when communicating
through the Transmission Control Protocol.

04-30005-01-en, May 2019 System

147
10 Licensing Introduction

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

10.1 Licensing Overview

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

10.1.1 Licensing Model

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

10.1.2 License System

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

10.1.3 License Management

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

10.1.4 Service and Maintenance

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

10.1.5 License Information

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

04-30005-01-en, May 2019 System

151
10 Licensing Introduction
10.1 Licensing Overview

For more information, see section 10.5 “License Information” on page 157.

System 04-30005-01-en, May 2019

152
 10 Licensing Introduction
10.2 Licensing Model

10.2 Licensing Model

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

10.2.1 Client and Engineering Tool Licenses

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

10.2.2 Field Bus Device Licenses

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

10.2.3 SNMP Licenses

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

04-30005-01-en, May 2019 System

153
10 Licensing Introduction
10.2 Licensing Model

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

10.2.4 Web Services Licenses

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

10.2.5 Licensing Enforcement

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

10.2.6 License Lifetime

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

System 04-30005-01-en, May 2019

154
 10 Licensing Introduction
10.3 Field Bus Device Licenses

10.3 Field Bus Device Licenses

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

04-30005-01-en, May 2019 System

155
10 Licensing Introduction
10.4 Licensing Enforcement

10.4 Licensing Enforcement

License enforcement is the process of checking whether a software application
has a valid license available to it at runtime. In the EcoStruxure BMS, this is
accomplished by a license violation bar in WorkStation and WebStation if you do
not have enough licenses.
If a client, such as WorkStation or one of the editors, attempts to start and cannot
locate an available license, the client does not start.

10.4.1 License Violation

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

Figure: License violation bar in WorkStation

For more information, see section 14.11 “License Violation Bar” on page 255.

System 04-30005-01-en, May 2019

156
 10 Licensing Introduction
10.5 License Information

10.5 License Information

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

10.5.1 Recommended Setup

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

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

Enterprise Central
The Enterprise Central displays all licenses for the Enterprise Central. The
License Information in Enterprise Central also displays information regarding all
Enterprise Servers attached to the Enterprise Server and for all SmartX servers
attached to the Enterprise Servers.
In the License Information in Enterprise Central you can select a specific
Enterprise server and check the licenses for that server.

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

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

10.5.3 License Status

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

04-30005-01-en, May 2019 System

157
10 Licensing Introduction
10.5 License Information

• Smart Drivers
• SNMP Notifications

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

System 04-30005-01-en, May 2019

158
 10 Licensing Introduction
10.6 License System

10.6 License System

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

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

10.6.1 License Activation Server

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

10.6.2 License Server

The License Server manages the administration of network licenses. An
EcoStruxure BMS running with network licenses must contain at least one
License Server.
For more information, see section 13.1 “License Server” on page 207.

10.6.3 License Administrator

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

04-30005-01-en, May 2019 System

159
10 Licensing Introduction
10.6 License System

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

System 04-30005-01-en, May 2019

160
 10 Licensing Introduction
10.7 License Management

10.7 License Management

The EcoStruxure Building Operation license system consists of, for example, a
License Server, WorkStation with client tools, and the Enterprise Server. The
number of each component varies depending on the system size and
architecture.
In this example, the License Server and Enterprise Server are located on the
same computer. Several WorkStations check out licenses from the License
Server through the local area network. Network licenses are activated on the
License Server by the License Activation Server that is controlled by Schneider
Electric.

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

10.7.1 License System Installation and

Configuration
Schneider Electric recommends that you install the license server framework
before installing other EcoStruxure Building Operation software applications and
SmartX servers. The license server installation is included in the License
Administrator license package. During the installation of WorkStation or
Enterprise Server, the installation software asks for the address to the license
server.

04-30005-01-en, May 2019 System

161
10 Licensing Introduction
10.7 License Management

For more information, see section 4.3 “Installation Example” on page 85.

10.7.2 Network License Management

When you activate a license, the license is transferred from the License
Activation Server to your License Server. When activating a license, details
about the transaction and registration details are stored with the license on the
License Server.
For more information, see section 11.2 “Network License Management” on page
185.

10.7.3 Local License Management

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

System 04-30005-01-en, May 2019

162
 10 Licensing Introduction
10.8 Service and Maintenance

10.8 Service and Maintenance

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

10.8.1 License Service Maintenance

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

10.8.2 License Maintenance

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

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

04-30005-01-en, May 2019 System

163
10 Licensing Introduction
10.8 Service and Maintenance

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

10.8.4 License Log File

You can get a log file of the license to get information regarding licenses, for
example when you are troubleshooting.
For more information, see section 12.5 “Showing the Licenses Log File ” on page
204.

System 04-30005-01-en, May 2019

164
 10 Licensing Introduction
10.9 License Maintenance

10.9 License Maintenance

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

10.9.1 Local License Removal

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

10.9.2 Network License Return

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

10.9.3 Lost License

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

10.9.4 License Repair

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

10.9.5 License Backup

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

04-30005-01-en, May 2019 System

165
10 Licensing Introduction
10.10 Licenses

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

Table: EcoStruxure Building Operation Licenses

License File Name Description

Client Station client.station Use this license to start and

run WorkStation and
WebStation.

Client tool licenses client.graphiceditor This license product group

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

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

run an Enterprise Central.

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

run an Enterprise Server.

Enterprise Server under server.ec.es Use this license to start and

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

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

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

SmartDriver smartdriver.license Use this license to allow

SmartDrivers.

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

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

System 04-30005-01-en, May 2019

166
 10 Licensing Introduction
10.10 Licenses

Continued
License File Name Description

SNMP server.alarms.snmp Use this license to allow

SNMP notifications.

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

run Web Services, EWS
Consume.

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

SRV run Web Services, EWS
Consume.

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

SRV run Web Services, EWS
Consume.

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

Cons run Web Services.

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

run a demo version of Cloud
Connectivity.

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

run Cloud Connectivity.

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

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

10.10.1 End User License Agreement

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

10.10.2 Local Licenses

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

04-30005-01-en, May 2019 System

167
10 Licensing Introduction
10.10 Licenses

10.10.3 Network Licenses

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

10.10.4 Time-Limited Licenses

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

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

10.10.5 Permanent License

A permanent license does not expire.

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

10.10.6 License Selection Process

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

System 04-30005-01-en, May 2019

168
 10 Licensing Introduction
10.11 Viewing Activated Licenses

10.11 Viewing Activated Licenses

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

To view activated licenses

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

04-30005-01-en, May 2019 System

169
10 Licensing Introduction
10.12 Editing Registration Details

10.12 Editing Registration Details

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

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

For more information, see section 13.8 “License Administrator” on page 216.

To edit registration details

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

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

System 04-30005-01-en, May 2019

170
 10 Licensing Introduction
10.13 License Selection Process

10.13 License Selection Process

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

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

04-30005-01-en, May 2019 System

171
10 Licensing Introduction
10.14 Order Information Request

10.14 Order Information Request

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

Figure: Entitle Certificate with entitlement ID

Figure: Work flow when requesting order information

System 04-30005-01-en, May 2019

172
 10 Licensing Introduction
10.14 Order Information Request

Table: Request Order Information

Number Description

1 The Entitlement ID
ID, which contains the
licenses to activate, is entered into the
License Administrator.

2 The License Administrator sends the

entitlement ID to the License Activation
Server.

3 The License Activation Server sends the

order information to the License
Administrator.

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

04-30005-01-en, May 2019 System

173
10 Licensing Introduction
10.15 Lost License

10.15 Lost License

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

System 04-30005-01-en, May 2019

174
 10 Licensing Introduction
10.16 License Repair

10.16 License Repair

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

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

04-30005-01-en, May 2019 System

175
10 Licensing Introduction
10.17 License Backup

10.17 License Backup

Schneider Electric recommends backing up the License Server files on a regular
basis. To back up the license files, copy all files in the folder to an external
resource. This backup is primarily intended for cases when hardware or the
operating system malfunctions.
Backed up licenses can only be restored on the same License Server that the
files were backed up from. If you plan to move the licenses to another License
Servers, you first have to return the licenses to the License Activtation Server
and then activate them on the new License Server.
The License Server files are located in: \ProgramData\FLEXnet in Windows.
Licenses restored from a backup can be considered damaged by the License
Server. For more information, see section 10.16 “License Repair” on page 175.

System 04-30005-01-en, May 2019

176
 10 Licensing Introduction
10.18 Backing Up Licenses

10.18 Backing Up Licenses

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

To back up licenses
1. Close all EcoStruxure Building Operation applications, such as License
Administrator, WorkStation, and Enterprise Server.
2. On the License Server, browse to the folder \ProgramData\FLEXnet.
3. Copy all files in the FLEX-net folder that start with taclic_ and paste the files
onto your external backup resource.

04-30005-01-en, May 2019 System

177
10 Licensing Introduction
10.19 Restoring Licenses

10.19 Restoring Licenses

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

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

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

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

System 04-30005-01-en, May 2019

178
11 Type of Licenses

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

11.1 Network Licenses

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

04-30005-01-en, May 2019 System

181
11 Type of Licenses
11.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-30005-01-en, May 2019

182
 11 Type of Licenses
11.1 Network Licenses

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

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

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

04-30005-01-en, May 2019 System

183
11 Type of Licenses
11.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-30005-01-en, May 2019

184
 11 Type of Licenses
11.2 Network License Management

11.2 Network License Management

When you activate a license, the license is transferred from the License
Activation Server to your License Server. When activating a license, details
about the transaction and registration details are stored with the license on the
License Server.
The examples in these sections are adaptable on all systems including the ones
where License Server, WorkStation, and Enterprise Server are located on the
same computer.
The license activation procedure consists of four steps:
• Request order information
• Activate network license on License Server
• Configure Enterprise Server’s address to the License Server
• Configure WorkStation’s address to the License Server

11.2.1 Order Information Request

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

11.2.2 Network Licenses Activation

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

11.2.3 Enterprise Server Address Configuration

After licenses are activated on the License Server, you configure the Enterprise
Server connection to the License Server. The address to the License Server is
defined either during the installation of Enterprise Server, through License
Administrator, or Windows registry.
For more information, see section 12.1 “Enterprise Server Address
Configuration” on page 199.

04-30005-01-en, May 2019 System

185
11 Type of Licenses
11.2 Network License Management

11.2.4 WorkStation and Client Tools Address

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

System 04-30005-01-en, May 2019

186
 11 Type of Licenses
11.3 Network Licenses Activation

11.3 Network Licenses Activation

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

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

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

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

04-30005-01-en, May 2019 System

187
11 Type of Licenses
11.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-30005-01-en, May 2019

188
 11 Type of Licenses
11.4 Network License Return

11.4 Network License Return

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

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

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

1 In the License Administrator, select the

licenses to return.

2 The License Administrator returns the

licenses to the License Activation Server.

04-30005-01-en, May 2019 System

189
11 Type of Licenses
11.4 Network License Return

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

System 04-30005-01-en, May 2019

190
 11 Type of Licenses
11.5 Activating Network Licenses

11.5 Activating Network Licenses

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

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

For more information, see section 10.10 “Licenses” on page 166.

To activate network licenses

1. In License Administrator, click the Licenses tab.
2. On the Licenses toolbar, click the Add license from entitlement ID button
.
3. In the Add License dialog box, in the Enter license entitlement ID box,
type the entitlement ID that contains the licenses to activate.

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

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

04-30005-01-en, May 2019 System

191
11 Type of Licenses
11.6 Removing a Local License or Returning a Network License

11.6 Removing a Local License or Returning

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

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

To remove a local license or return a network license

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

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

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

System 04-30005-01-en, May 2019

192
 11 Type of Licenses
11.7 Repairing a Network License

11.7 Repairing a Network License

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

To repair a network license

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

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

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

04-30005-01-en, May 2019 System

193
11 Type of Licenses
11.8 Local Licenses

11.8 Local Licenses

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

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

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

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

System 04-30005-01-en, May 2019

194
 11 Type of Licenses
11.9 Local License Management

11.9 Local License Management

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

11.9.1 Local License Activation

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

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

04-30005-01-en, May 2019 System

195
11 Type of Licenses
11.10 Activating a Local License

11.10 Activating a Local License

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

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

For more information, see section 10.10 “Licenses” on page 166.

To activate a local license

1. In License Administrator, click the Licenses tab.

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

System 04-30005-01-en, May 2019

196
12 Licensing Configuration and
Diagnostics

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

12.1 Enterprise Server Address

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

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

Table: Enterprise Server Configuration

Number Description

1 Configure the Enterprise Server address to

the License Server.

2 Remove any activated local licenses.

3 When the Enterprise Server starts, it

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

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

network license from a License Server. A checked out network license is not
physically moved to or activated on the Enterprise Server. The license remains
in the License Server but is allocated to the dedicated Enterprise Server. The
license is therefore not available for other EcoStruxure BMS server to check out.

04-30005-01-en, May 2019 System

199
12 Licensing Configuration and Diagnostics
12.1 Enterprise Server Address Configuration

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

System 04-30005-01-en, May 2019

200
 12 Licensing Configuration and Diagnostics
12.2 WorkStation and Client Tools Address Configuration

12.2 WorkStation and Client Tools Address

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

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

Table: WorkStation Configuration

Number Description

1 Configure the WorkStation and client tool

address to the License Server.

2 Remove any activated local licenses.

3 When you logon to WorkStation or start a

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

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

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

04-30005-01-en, May 2019 System

201
12 Licensing Configuration and Diagnostics
12.3 Viewing Diagnostic Information

12.3 Viewing Diagnostic Information

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

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

202
 12 Licensing Configuration and Diagnostics
12.4 Copying Diagnostics to the Clipboard

12.4 Copying Diagnostics to the Clipboard

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

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

203
12 Licensing Configuration and Diagnostics
12.5 Showing the Licenses Log File

12.5 Showing the Licenses Log File

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

To show the licenses log file

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

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

System 04-30005-01-en, May 2019

204
13 License Server and License
Administrator

Topics
License Server
Starting the License Server
Stopping the License Server
Restarting the License Server
Flexnet License Administrator, License Server Manager
Accessing Flexnet lmadmin
Changing the Flexnet lmadmin License Server Manager Port
Number
License Administrator
Starting License Administrator
License Server Address
Configuring the Address to the License Server
License Server Reset
Resetting the License Server
Configuring License Server Recovery Settings
License Server Maintenance
Device Administrator Licenses
Entitlements, Products, and Licenses
Assign and Activate Licenses
13 Device Administrator Licensing Workflow
Adding an Entitlement to Device Administrator
Removing an Entitlement
Assigning Licenses
Activating Licenses Online
Offline Activation of Licenses Workflow
Creating the Request Files
Uploading the Request Files and Downloading the
Response Files
Sending the Response Files to the SmartX Server
 13 License Server and License Administrator
13.1 License Server

13.1 License Server

The License Server manages the administration of network licenses. An
EcoStruxure BMS running with network licenses must contain at least one
License Server.
The License Server is designed to not require user intervention. The License
Server is a Microsoft Windows service named Building Operation License
Server. Because of the lack of user interface and graphical notifications that
display the status of the License Server, it is recommended that you configure
the License Server to automatically restart if it unexpectedly stops. For more
information, see section 13.14 “Configuring License Server Recovery Settings ”
on page 223.
You use the License Administrator to activate network licenses on the License
Server. The network licenses are then checked out from the License Server by
WorkStation, editors, or Enterprise Server. For more information, see section
13.8 “License Administrator” on page 216.

13.1.1 Flexnet License Manager, License Server

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

04-30005-01-en, May 2019 System

207
13 License Server and License Administrator
13.2 Starting the License Server

13.2 Starting the License Server

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

To start the License Server

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

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

2. Right-click Building Operation License Server

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

System 04-30005-01-en, May 2019

208
 13 License Server and License Administrator
13.3 Stopping the License Server

13.3 Stopping the License Server

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

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

209
13 License Server and License Administrator
13.4 Restarting the License Server

13.4 Restarting the License Server

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

To restart the License Server

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

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

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

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

System 04-30005-01-en, May 2019

210
 13 License Server and License Administrator
13.5 Flexnet License Administrator, License Server Manager

13.5 Flexnet License Administrator, License

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

Figure: FLEXnet License Administrator, Dashboard part.

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

04-30005-01-en, May 2019 System

211
13 License Server and License Administrator
13.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 .

13.5.1 License Server Port Number

With a default installation, the License Server port range is set to 27000-27009. A
valid number is any unused port between 0 and 64000.

System 04-30005-01-en, May 2019

212
 13 License Server and License Administrator
13.5 Flexnet License Administrator, License Server Manager

Figure: FLEXnet License Administrator, License Server Configuration

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

For more information, click FLEXnet License Administrator Help button .

13.5.2 FLEXnet License Administrator Port Number

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

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

04-30005-01-en, May 2019 System

213
13 License Server and License Administrator
13.6 Accessing Flexnet lmadmin

13.6 Accessing Flexnet lmadmin

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

To access Flexnet lmadmin

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

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

For more information, click the Flexnet lmadmin Help button .

System 04-30005-01-en, May 2019

214
 13 License Server and License Administrator
13.7 Changing the Flexnet lmadmin License Server Manager Port Number

13.7 Changing the Flexnet lmadmin License

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

To change the Flexnet lmadmin License Server Manager port

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

4. Save the file and close the editor.

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

04-30005-01-en, May 2019 System

215
13 License Server and License Administrator
13.8 License Administrator

13.8 License Administrator

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

13.8.1 Registration Details

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

NOTICE
Only English letters are allowed in the license details.

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

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

13.8.2 License Server Address

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

System 04-30005-01-en, May 2019

216
 13 License Server and License Administrator
13.9 Starting License Administrator

13.9 Starting License Administrator

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

To start License Administrator

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

04-30005-01-en, May 2019 System

217
13 License Server and License Administrator
13.10 License Server Address

13.10 License Server Address

During the installation of License Administrator on WorkStations or Enterprise
Servers, you need to type the network address to the License Server where
network licenses are available for check out. The address to the License Server
can later be entered or edited through License Administrator or directly in the
Windows registry of the computer or Enterprise Server that hosts the licensed
product.
In a 32-bit operating system, the License Server address is stored in the
Windows registry key: HKEY_LOCAL_MACHINE\SOFTWARE\Schneider
Electric\StruxureWare\License Administrator\TACLIC_LICENSE_FILE. In a 64-bit
operating system, there is a separate area in the registry for all running 32-bit
programs.
The address to a License Server must begin with @ and is either a hostname or
IP address. If the communication to the License Server is through a port other
than the default port range 27000-27009, the port number is defined in front of
the @, Port-number@hostname.

Table: Example of License Server Address

Address Description

19650@localhost Connects to localhost through port 19650

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

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

[email protected] Connects to License Server 192.166.248.2

through port 14650

To separate License Server addresses in License Administrator, use a

semicolon.

System 04-30005-01-en, May 2019

218
 13 License Server and License Administrator
13.10 License Server Address

Figure: Example of License Server addresses in License Administrator

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

04-30005-01-en, May 2019 System

219
13 License Server and License Administrator
13.11 Configuring the Address to the License Server

13.11 Configuring the Address to the License

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

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

For more information, see section 11.2 “Network License Management” on page
185.

To configure the address to the License Server

1. In License Administrator, click the Licenses server address view.
2. In the License server address box, type @ and then type the address to the
License Server.

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

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

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

System 04-30005-01-en, May 2019

220
 13 License Server and License Administrator
13.12 License Server Reset

13.12 License Server Reset

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

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

04-30005-01-en, May 2019 System

221
13 License Server and License Administrator
13.13 Resetting the License Server

13.13 Resetting the License Server

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

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

For more information, see section 13.12 “License Server Reset” on page 221.

To reset the License Server

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

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

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

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

System 04-30005-01-en, May 2019

222
 13 License Server and License Administrator
13.14 Configuring License Server Recovery Settings

13.14 Configuring License Server Recovery

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

To configure the license server recovery settings

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

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

2. Right-click Building Operation License Server

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

04-30005-01-en, May 2019 System

223
13 License Server and License Administrator
13.15 License Server Maintenance

13.15 License Server Maintenance

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

13.15.1 License Server Address Change

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

13.15.2 License Server Reinstallation

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

13.15.3 License Server Replacement

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

System 04-30005-01-en, May 2019

224
 13 License Server and License Administrator
13.15 License Server Maintenance

Figure: Replacing the License Server or moving licenses

Table: Replace of Licenses or Move of Licenses

Number Description

1 All licenses, located on the old License

Server, are returned to the License
Activation Server.

2 The License Activation Server activates the

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

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

04-30005-01-en, May 2019 System

225
13 License Server and License Administrator
13.15 License Server Maintenance

13.15.4 License Server Reset

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

System 04-30005-01-en, May 2019

226
 13 License Server and License Administrator
13.16 Device Administrator Licenses

13.16 Device Administrator Licenses

Device Administrator is used to manage and organize the licenses on SmartX
server.

13.16.1 Licenses on SmartX Servers

Licenses are needed with some of the features of a SmartX server.

WebStation
Every SmartX server contains one default license that allows you to connect to
the SmartX server with one instance of WebStation.
If you want more instances of WebStation to connect to that SmartX server, more
licenses are required. Licenses are required for the total number of WebStation
clients simultaneously connected to a SmartX server. For a SmartX server to
communicate with ten WebStation clients at the same time, 10 licenses are
needed.

SmartDrivers
To be able to use SmartDrivers on a SmartX server, one or more, license is
needed for every SmartDriver that runs on the SmartX server.

SNMP Notifications
To be able to use SNMP Notification on a SmartX server, a license is required.
One license for SNMP Notifications allows you to use any number of SNMP
Notifications on that SmartX server.

Personal Dashboards
To be able to create personal dashboards on a SmartX server, you need a
license. Personal dashboards are used in WebStation.
One license allows the connected users of that SmartX server to create any
number of Personal Dashboards.

13.16.2 Entitlements, Products, and Licenses

Licenses are bought as products and delivered in Entitlements. An Entitlement is
a container that can contain several products. The products contain the licenses
and they can differ in quantity and contents.
For more information, see section 13.17 “Entitlements, Products, and Licenses”
on page 229.

13.16.3 Assign and Activate Licenses

When you have added the Entitlement to Device Administrator you must assign
and activate the licenses.

04-30005-01-en, May 2019 System

227
13 License Server and License Administrator
13.16 Device Administrator Licenses

For more information, see section 13.18 “Assign and Activate Licenses” on page
230.

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

System 04-30005-01-en, May 2019

228
 13 License Server and License Administrator
13.17 Entitlements, Products, and Licenses

13.17 Entitlements, Products, and Licenses

Licenses are bought as products and delivered in Entitlements. An Entitlement is
a container that can contain several products. The products contain the licenses
and they can differ in quantity and contents.
The Entitlements are added to the Device Administrator. After the Entitlements
are added to the Device Administrator, you can view the products and then
assign the licenses to the connected SmartX servers.
You can add one or many Entitlements to the Device Administrator.
After the purchase, the Entitlements are delivered in an e-mail.

Example
You have a site with five SmartX servers. You assume that the maximum number
of WebStation clients simultaneously connected to each SmartX server at the
same time are 10. Therefore, you need 50 client licenses. You want all SmartX
servers to use SNMP notification and allow the users to create personal
dashboards. Only two SmartX servers need SmartDrivers.

Figure: An example of an Entitlement.

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

04-30005-01-en, May 2019 System

229
13 License Server and License Administrator
13.18 Assign and Activate Licenses

13.18 Assign and Activate Licenses

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

13.18.1 Assign Licenses

Assigning licenses is the process of distribute the licenses from the Entitlement
to the SmartX servers in the list.

13.18.2 Activate Licenses

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

Online activation
Online activation is implemented immediately. Online activation requires that the
SmartX server is connect to the internet.
For more information, see section 13.23 “Activating Licenses Online ” on page
235.

Offline activation
Offline activation is used when the SmartX server does not have any access to
the internet. Offline activation is a multi-step process.
The offline activation is based on a process where you, after the assigning is
completed, create a set of request files using Device Administrator. The request
files are then uploaded to the FlexNet Operations Administrator server. Th
FlexNet Operations administrator server process the request files and create a
set of response files. The response files are downloaded and copied to the
computer that runs Device Administrator. From the Device Administrator the
response files are sent to the SmartX server. When this is done the licenses are
activated.
For more information, see section 13.24 “Offline Activation of Licenses
Workflow” on page 236.

NOTICE
Activated licenses cannot be deactivated.

System 04-30005-01-en, May 2019

230
 13 License Server and License Administrator
13.19 Device Administrator Licensing Workflow

13.19 Device Administrator Licensing

Workflow
Use this workflow to add licenses to SmartX servers using Device Administrator.

Figure: Device Administrator licensing workflow

Add Entitlements to Device Administrator

Add an Entitlement that contains products and licenses to Device Administrator.
For more information, see section 13.20 “Adding an Entitlement to Device
Administrator” on page 232.

Assign licenses to a SmartX server

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

Activate licenses on a SmartX server

When all licenses are assigned for the different features on the SmartX server
you must activate the licenses.
For more information, see section 13.23 “Activating Licenses Online ” on page
235.
If you want to activate licenses offline use the Offline Activation of Licenses
workflow.
For more information, see section 13.24 “Offline Activation of Licenses
Workflow” on page 236.

NOTICE
Activated licenses cannot be deactivated.

04-30005-01-en, May 2019 System

231
13 License Server and License Administrator
13.20 Adding an Entitlement to Device Administrator

13.20 Adding an Entitlement to Device

Administrator
You add an Entitlement so that you can get a list of the licenses that you can
assign.
For more information, see section 13.19 “Device Administrator Licensing
Workflow” on page 231.

To Adding an Entitlement to Device Administrator

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

System 04-30005-01-en, May 2019

232
 13 License Server and License Administrator
13.21 Removing an Entitlement

13.21 Removing an Entitlement

You remove unused Entitlements.
For more information, see section 13.17 “Entitlements, Products, and Licenses”
on page 229.

To remove an Entitlement
1. In the Device Administrator, click Entitlements
Entitlements.
2. Click Entitlements
Entitlements.
3. in the Entitlement Contents view, click the Entitlement you want to remove.
4. Click Delete
Delete.
Removed Entitlements can be added again.

NOTICE
Removing an Entitlement from Device Administrator does not, in any way,
affect the already activated licenses on the SmartX servers.

04-30005-01-en, May 2019 System

233
13 License Server and License Administrator
13.22 Assigning Licenses

13.22 Assigning Licenses

All licenses must be assigned before they can be activated.
For more information, see section 13.16 “Device Administrator Licenses” on
page 227.

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

5. Click the Save current list button .

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

System 04-30005-01-en, May 2019

234
 13 License Server and License Administrator
13.23 Activating Licenses Online

13.23 Activating Licenses Online

You activate licenses so that you can access the features.
For more information, see section 13.16 “Device Administrator Licenses” on
page 227.

NOTICE
Activated licenses cannot be deactivated.

To activate licenses online

1. In Device Administrator, click Servers
Servers.
2. Select Show licenses
licenses.
3. Select the SmartX servers where you want to activate the licenses.
4. Click Activate licenses
licenses.
5. In the Activate Licenses dialog box, click Activate Licenses
Licenses.
All assigned licenses are now activated.
The progress and result can be viewed in the Detailed Progress Dialog Box. For
more information, see the Detailed Progress Dialog Box topic on WebHelp.

04-30005-01-en, May 2019 System

235
13 License Server and License Administrator
13.24 Offline Activation of Licenses Workflow

13.24 Offline Activation of Licenses Workflow

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

Figure: Offline activation of licenses workflow

Creating the request files

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

Uploading the Request Files and Downloading the Response Files

Upload the request files to FlexNet Operations Administrator server. After the
files are processed, you download the response files to activate the licenses on
the SmartX servers.
For more information, see section 13.26 “Uploading the Request Files and
Downloading the Response Files ” on page 238.

Sending Response Files to the SmartX servers

In Device Administrator, send the response files to the SmartX server to
complete the license activation.
For more information, see section 13.27 “Sending the Response Files to the
SmartX Server” on page 239.

System 04-30005-01-en, May 2019

236
 13 License Server and License Administrator
13.25 Creating the Request Files

13.25 Creating the Request Files

You create request file that you send to FlexNet Operations Administrator Server
to get response files.
For more information, see section 13.16 “Device Administrator Licenses” on
page 227.

NOTICE
Activated licenses cannot be deactivated.

To create the request files

1. In Device Administrator, click Servers
Servers.
2. Select Show Licenses
Licenses.
3. Select the SmartX servers.
4. Click Activate licenses
licenses.
5. In the Activate Licenses dialog box, select Offline activation
activation.
6. Click Activate Licenses
Licenses.
7. Select a location for the request files.
8. Click OK
OK.
The request files must be uploaded to FlexNet Operations Administrator server
so that you can download the response files.

04-30005-01-en, May 2019 System

237
13 License Server and License Administrator
13.26 Uploading the Request Files and Downloading the Response Files

13.26 Uploading the Request Files and

Downloading the Response Files
You upload the request files to the FlexNet Operations Administrator server so
that you can receive the response files.
For more information, see section 13.16 “Device Administrator Licenses” on
page 227.

To upload the request files and download the response files

1. Browse to the FlexNet Operations administrator server, Operation page at
https://schneider-electric.flexnetoperations.com.
2. In the Login screen, select With Entitle ID
ID.
3. In the Entitlement ID box, enter the Entitlement ID..
4. Click Log in
in.
5. On the Device menu, click Offline Device Management
Management.
6. In the Offline Device Management dialog box, click Generate license.
7. Click Upload
Upload.
The request files are now processed. This may take a while. When the
response files are ready, you get the message License has been
generated successfully, please click here to download the new license
license.
8. Click Download
Download.
9. Save the downloaded response files.
The response files are saved in the same folder structure as the request
files.
10. The response files must be copied to the computer that runs Device
Administrator so that the response files can be sent to the SmartX servers.

System 04-30005-01-en, May 2019

238
 13 License Server and License Administrator
13.27 Sending the Response Files to the SmartX Server

13.27 Sending the Response Files to the

SmartX Server
You send the request files to the SmartX servers to complete the offline
activation of licenses.
For more information, see section 13.16 “Device Administrator Licenses” on
page 227.

NOTICE
Activated licenses cannot be deactivated.

To send response files to the SmartX server

1. In Device Administrator, click Servers
Servers.
2. Select Show licenses
licenses.
3. Select the SmartX servers.
4. Click Send response files
files.
5. In the Select Response file dialog box, click Select folder
folder.
6. Browse to the response files.
7. Click OK
OK.
All assigned licenses are now activated.

04-30005-01-en, May 2019 System

239
14 Licensing User Interface

Topics
Registration Details View
Licenses View
Licenses View Toolbar
Licenses View Icons
Licenses View Columns
Add License Dialog Box
License Activation Dialog Box
License Progress Dialog Box
License Server Address View
Diagnostics View
License Violation Bar
License Information Enterprise Server and SmartX Server
License Information Enterprise Central
Add Entitlement Dialog Box
Assign Licenses View
Show Licenses View Toolbar
Entitlements View
Entitlements Contents View
Entitlements Product Licenses View
Activate Licenses Dialog Box
14 License Settings Dialog Box
Offline Response Files Dialog Box
License Status Bar
 14 Licensing User Interface
14.1 Registration Details View

14.1 Registration Details View

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

NOTICE
Only English letters are allowed in the license details.

Figure: Registration details view

Table: Registration Details View

Component Description

License owner Type the name of the organization that

purchased the license.

Industry Select the end user’s field of business.

Type of project Select the proposed fields of application

for the license.

Name Type the name of the account manager

that supplied the license.

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

manager that supplied the license.

04-30005-01-en, May 2019 System

243
14 Licensing User Interface
14.1 Registration Details View

Continued
Component Description

Telephone number Type the phone number of the account

manager that supplied the license.

System 04-30005-01-en, May 2019

244
 14 Licensing User Interface
14.2 Licenses View

14.2 Licenses View

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

Figure: Licenses view

Table: Licenses View

Number Description

Use the Licenses view toolbar to activate

or remove licenses. For more information,
see section 14.3 “Licenses View Toolbar”
on page 246.

Use the Licenses view columns to view

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

Use the Licenses view icons to get

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

04-30005-01-en, May 2019 System

245
14 Licensing User Interface
14.3 Licenses View Toolbar

14.3 Licenses View Toolbar

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

Table: Licenses View Toolbar

Button Description

Add license from entitlement ID

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

Add license from file

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

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

Repair license
Click to repair a damaged network license.

Show log
Click to open the license log file.

System 04-30005-01-en, May 2019

246
 14 Licensing User Interface
14.4 Licenses View Icons

14.4 Licenses View Icons

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

Table: Licenses View Icons

Icon Description

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

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

Damaged Local License

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

Damaged Network License

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

04-30005-01-en, May 2019 System

247
14 Licensing User Interface
14.5 Licenses View Columns

14.5 Licenses View Columns

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

Product Displays the name of the license product.

Version Displays the version number of the

licenses.

Quantity Displays the amount of licenses that are

activated.

Status Displays the current license status.

Location Displays whether the license is a local or

network license.

Expiration date Displays the date when the license

expires.

Creation date Displays the date when the local license

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

System 04-30005-01-en, May 2019

248
 14 Licensing User Interface
14.6 Add License Dialog Box

14.6 Add License Dialog Box

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

Figure: Add license dialog box

Table: Add License Dialog Box

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

249
14 Licensing User Interface
14.7 License Activation Dialog Box

14.7 License Activation Dialog Box

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

Figure: License activation dialog box

Table: License Activation Dialog Box

Component Description

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

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

Product Displays the name of the license.

Version Displays the version number of the license.

Location Displays whether the license is a local

license or a network license.

Quantity Displays the number of licenses tha are

available to activate.

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

System 04-30005-01-en, May 2019

250
 14 Licensing User Interface
14.7 License Activation Dialog Box

Continued
Component Description

Activate (button) Click to activate the selected number of

licenses.

04-30005-01-en, May 2019 System

251
14 Licensing User Interface
14.8 License Progress Dialog Box

14.8 License Progress Dialog Box

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

Figure: License progress dialog box

Table: License Progress Dialog Box

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

252
 14 Licensing User Interface
14.9 License Server Address View

14.9 License Server Address View

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

Figure: License Server address view

Table: License Server Address View

Component Description

License server address Type the address to the License Server

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

04-30005-01-en, May 2019 System

253
14 Licensing User Interface
14.10 Diagnostics View

14.10 Diagnostics View

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

Figure: Diagnostic view

Table: Diagnostics View

Button Description

Refresh the list

Click to populate or refresh the diagnostic
list.

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

System 04-30005-01-en, May 2019

254
 14 Licensing User Interface
14.11 License Violation Bar

14.11 License Violation Bar

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

Figure: License violation bar

Table: License Violation Bar

Component Description

Licensing Information Click to open License Manager to get

more information regarding required
licenses.
For more information, see section 14.12
“License Information Enterprise Server and
SmartX Server” on page 256.

Hide Click Hide to hide the License Violation

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

04-30005-01-en, May 2019 System

255
14 Licensing User Interface
14.12 License Information Enterprise Server and SmartX Server

14.12 License Information Enterprise Server

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

Figure: License Information

Table: License Information

Property Description

Automation Server Licenses Displays the number of licenses for SmartX

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

System 04-30005-01-en, May 2019

256
 14 Licensing User Interface
14.12 License Information Enterprise Server and SmartX Server

Continued
Property Description

Fieldbus Device Licenses Displays the number of licenses for the

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

Smart Driver Licenses Displays the number of licenses for the

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

SNMP Notification Licenses Display the licenses for the SNMP

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

04-30005-01-en, May 2019 System

257
14 Licensing User Interface
14.13 License Information Enterprise Central

14.13 License Information Enterprise Central

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

Figure: License Information Enterprise Central dialog box

Table: License Information Enterprise Central Dialog Box

Component Description

Select Server Select to view license status for the

Enterprise Central or any Enterprise Server
attached to the Enterprise Server. For more
information, see section 14.12 “License
Information Enterprise Server and SmartX
Server” on page 256.

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

Server Name Displays the name of the servers attached

to the Enterprise Central.

System 04-30005-01-en, May 2019

258
 14 Licensing User Interface
14.13 License Information Enterprise Central

Continued
Component Description

Server Type Displays the server type.

Automation Servers Displays the number of licenses for SmartX

servers attached to the Enterprise server.
Required/Activated.

ES hosted Fieldbus devices Displays the number of licenses for

fieldbuses attached to the Enterprise
Server. Required/Activated.

Smart Drivers Displays the number of licenses for Smart

Drivers attached to the Enterprise Server.
Required/Activated.

SNMP Notification Displays the number of licenses for SNMP

Notifications for the Enterprise Server.
Required/Activated.

04-30005-01-en, May 2019 System

259
14 Licensing User Interface
14.14 Add Entitlement Dialog Box

14.14 Add Entitlement Dialog Box

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

Figure: Add Entitlement dialog box

Table: Add Entitlement Dialog Box

Component Description

Entitlement ID Type the Entitlement ID.

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

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

System 04-30005-01-en, May 2019

260
 14 Licensing User Interface
14.15 Assign Licenses View

14.15 Assign Licenses View

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

Figure: Assign Licenses view

Table: Assign Licenses View

Number Description

License status column

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

Show licenses view toolbar

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

Product name column

Displays the products in the Entitlements.
For more information, see section 13.17
“Entitlements, Products, and Licenses” on
page 229.

Available licenses column

Displays the number of available licenses
for each product.

04-30005-01-en, May 2019 System

261
14 Licensing User Interface
14.15 Assign Licenses View

Continued
Number Description

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

Available feature licenses column

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

System 04-30005-01-en, May 2019

262
 14 Licensing User Interface
14.16 Show Licenses View Toolbar

14.16 Show Licenses View Toolbar

Use the Show Licenses view toolbar to manage licenses.

Table: Show Licenses View Toolbar

Button Description

Add Server Click to add a SmartX server to the list. For

more information, see the Connect to
SmartX Servers topic on WebHelp.

Activate Licenses Click to activate the licenses on the

selected SmartX server. For more
information, see section 13.18 “Assign and
Activate Licenses” on page 230.

License Setting Click to the License Setting dialog box.

For more information, see section 14.21
“License Settings Dialog Box” on page
270.

Offline Response Files Click to active licenses in offline mode

using response files. For more information,
see section 13.24 “Offline Activation of
Licenses Workflow” on page 236.

Refresh License Status Click to refresh license status for the

selected SmartX servers.

Current state Select to view the current status of the

activated licenses.

Edited state Select to view the the sum of assigned and

activated licenses.

Show licenses Select to show the Show licenses view

toolbar.

04-30005-01-en, May 2019 System

263
14 Licensing User Interface
14.17 Entitlements View

14.17 Entitlements View

Use the Entitlements view to view entitlements.

Figure: Entitlements view

Table: Entitlements View

Component Description

Add Entitlement Click to add an Entitlement.

For more information, see section 13.16
“Device Administrator Licenses” on page
227.

Add demo license Click to add a demo license.

Refresh all Click to refresh the list of Entitlements.

Entitlement Click on the Entitlement to see the content

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

System 04-30005-01-en, May 2019

264
 14 Licensing User Interface
14.18 Entitlements Contents View

14.18 Entitlements Contents View

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

Figure: Entitlements Contents view

Table: Entitlements Contents View

Component Description

Refresh Click to refresh the list of Entitlements.

Delete Click to delete the selected Entitlement

and its products from Device
Administrator.

Product name Displays the product name of the product

that contains the licenses in the row for the
product.

Activation ID Displays the activation ID. The activation

ID is unique for the product and cannot be
changed.

Clients Displays the number of WebStation clients

that can simultaneously connect to the
SmartX server for the product in this
Entitlement.

04-30005-01-en, May 2019 System

265
14 Licensing User Interface
14.18 Entitlements Contents View

Continued
Component Description

Smart Drivers Displays the number of Smart Drivers that

can simultaneously connect to the SmartX
server for the product in this Entitlement.

SNMP Notifications Displays the number of SNMP Notifications

that can simultaneously be used on the
SmartX server for the product in this
Entitlement.

Personal Dashboards Displays the number of Personalized

Dashboards that can simultaneously be
used on the SmartX server for the product
in this Entitlement.

Total Displays the total number of licenses for

the product in this Entitlement.

Available Displays the available number of licenses

for the product in this Entitlement.

System 04-30005-01-en, May 2019

266
 14 Licensing User Interface
14.19 Entitlements Product Licenses View

14.19 Entitlements Product Licenses View

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

Figure: Entitlements Product Licenses view

Table: Entitlements Product Licenses View

Component Description

Add entitlement Click to add an Entitlement.

For more information, see section 13.16
“Device Administrator Licenses” on page
227.

Add demo license Click to add a demo license.

For more information, see section 13.16
“Device Administrator Licenses” on page
227.

Refresh all Click to refresh the list.

Product name Displays the product name of the product

that contains the licenses in the row for the
product.

Activation ID Displays the activation ID. The activation

ID is unique for the product and cannot be
changed.

04-30005-01-en, May 2019 System

267
14 Licensing User Interface
14.19 Entitlements Product Licenses View

Continued
Component Description

Clients Displays the product's number of

WebStation clients that can simultaneously
connect to the SmartX server.

SmartDrivers Displays the product's number of

SmartDrivers that can simultaneously
connect to the SmartX server.

SNMP Notifications Displays the product's number of SNMP

Notifications that can simultaneously be
used on the SmartX server.

Personal Dashboards Displays the product's number of

Personalized Dashboards that can
simultaneously be used on the SmartX
server.

Total Displays the product's total number of

licenses.

Available Displays the product's available number of

licenses for the product that are not
activated.

System 04-30005-01-en, May 2019

268
 14 Licensing User Interface
14.20 Activate Licenses Dialog Box

14.20 Activate Licenses Dialog Box

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

Figure: Activate Licenses dialog box

Table: Activate Licenses Dialog Box

Component Description

Offline activation Select if you want to activate the licenses

offline. For more information, see section
13.24 “Offline Activation of Licenses
Workflow” on page 236.

Activate licenses Click to activate licenses immediately if

your SmartX servers are connected to
internet.

04-30005-01-en, May 2019 System

269
14 Licensing User Interface
14.21 License Settings Dialog Box

14.21 License Settings Dialog Box

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

Figure: License settings dialog box

Table: License Settings Dialog Box

Component Description

Server address Displays the address to the server

managing the licensing.

User name Displays user name to the server

managing the licensing.

Password Displays the password to the server

managing the licensing.

License model Displays the license model.

Log level Select to log the communication between

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

System 04-30005-01-en, May 2019

270
 14 Licensing User Interface
14.22 Offline Response Files Dialog Box

14.22 Offline Response Files Dialog Box

Use the Offline Response files dialog box for offline activation of licenses.

Figure: Offline Response files dialog box

Table: Offline Response Files Dialog Box

Component Description

Select folder Click to browse to the folder that contains

the response files.

Activate Click to activate licenses.

04-30005-01-en, May 2019 System

271
14 Licensing User Interface
14.23 License Status Bar

14.23 License Status Bar

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

Ok License status is ok for all servers.

Uncommitted license assignment One or more servers have uncommitted

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

License violation One or more SmartX servers have license

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

Demo license One or more servers are using a demo

license.

System 04-30005-01-en, May 2019

272
15 Software Administrator

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

15.1 Software Administrator

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

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

15.1.2 Ports
The Enterprise Server and Enterprise Central use HTTP and TCP protocols to
communicate with other servers and clients. In the Software Administrator, you
configure the port number of each protocol the server listens to when
communicating through a specific protocol.
To configure a protocol port number, you first have to stop the running
Enterprise Server or Enterprise Central service.

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

15.1.3 Database Location

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

15.1.4 Enterprise Server and Enterprise Central

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

04-30005-01-en, May 2019 System

275
15 Software Administrator
15.2 Starting Software Administrator

15.2 Starting Software Administrator

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

To start Software Administrator

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

System 04-30005-01-en, May 2019

276
 15 Software Administrator
15.3 Configuring Server Port Settings

15.3 Configuring Server Port Settings

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

To configure server ports

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

04-30005-01-en, May 2019 System

277
15 Software Administrator
15.4 Starting the Enterprise Central Windows Service

15.4 Starting the Enterprise Central Windows

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

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

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

For more information, see section 15.1 “Software Administrator” on page 275.

To start the Enterprise Central Windows service

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

System 04-30005-01-en, May 2019

278
 15 Software Administrator
15.5 Stopping the Enterprise Central Windows Service

15.5 Stopping the Enterprise Central

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

To stop the Enterprise Central Windows service

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

04-30005-01-en, May 2019 System

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

15.6 Starting the Enterprise Server or

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

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

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

For more information, see section 15.1 “Software Administrator” on page 275.

To start the Enterprise Server Enterprise Central Windows

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

System 04-30005-01-en, May 2019

280
 15 Software Administrator
15.7 Stopping the Enterprise Server Windows Service

15.7 Stopping the Enterprise Server

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

To stop the Enterprise Server Windows service

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

04-30005-01-en, May 2019 System

281
15 Software Administrator
15.8 Restarting the Enterprise Server Windows Service

15.8 Restarting the Enterprise Server

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

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

For more information, see section 15.1 “Software Administrator” on page 275.

To restart the Enterprise Server Windows service

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

System 04-30005-01-en, May 2019

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

15.9 Enterprise Server and Enterprise

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

04-30005-01-en, May 2019 System

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

15.10 Viewing the Enterprise Server or

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

To view the Enterprise Server or Enterprise Central system log

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

System 04-30005-01-en, May 2019

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

15.11 Resolving Enterprise Server or

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

To resolve Enterprise Server or Enterprise Central port

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

04-30005-01-en, May 2019 System

285
15 Software Administrator
15.12 Software Administrator – Enterprise Central View

15.12 Software Administrator – Enterprise

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

Figure: Enterprise Central view

Table: Enterprise Central View

Component Description

Status Displays the current status of the

Enterprise Central Windows service.

Start Service Click to start Enterprise Central.

Stop Service Click to stop Enterprise Central.

HTTP Port Type the port number that Enterprise

Central listens to when communicating
through the Hypertext Transfer Protocol.

HTTPS Port Type the port number that Enterprise

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

TCP Port Type the port number that Enterprise

Central listens to when communicating
through the Transmitting Control Protocol.

System Displays the system log.

System 04-30005-01-en, May 2019

286
 15 Software Administrator
15.12 Software Administrator – Enterprise Central View

Continued
Component Description

Path Displays the path to the folder where the

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

A warning indicates that you entered a

conflicting port number or that the service
is stopping.

04-30005-01-en, May 2019 System

287
15 Software Administrator
15.13 Software Administrator – Enterprise Server View

15.13 Software Administrator – Enterprise

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

Figure: Enterprise Server view

Table: Enterprise Server View

Component Description

Status Displays the current status of the

Enterprise Server Windows service.

Start Service Click to start the Enterprise Server.

Stop Service Click to stop the Enterprise Server.

HTTP Port Type the port number that the Enterprise

Server listens to when communicating
through the Hypertext Transfer Protocol.

HTTPS Port Type the port number that the Enterprise

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

TCP Port Type the port number that the Enterprise

Server listens to when communicating
through the Transmitting Control Protocol.

System Displays the system log.

System 04-30005-01-en, May 2019

288
 15 Software Administrator
15.13 Software Administrator – Enterprise Server View

Continued
Component Description

Path Displays the path to the folder where the

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

A warning indicates that you entered a

conflicting port number or that the service
is stopping.

04-30005-01-en, May 2019 System

289
16 Localization Language and
Units

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

16.1 Regional and Language Overview

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

16.1.1 Language and Translation Packages

The EcoStruxure Building Operation software supports several different
languages. To be able to install a new language you need a language pack.
For more information, see section 16.3 “Language Packages” on page 295.

16.1.2 Value Presentation

The EcoStruxure Building Operation software handles values and numbers with
the highest precision. By default, the unit of a value is converted according to
the regional settings of the user’s operating system.
For more information, see section 16.7 “Value Presentation” on page 299.

16.1.3 Time and Time Zone

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

04-30005-01-en, May 2019 System

293
16 Localization Language and Units
16.2 Configuring Regional Settings

16.2 Configuring Regional Settings

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

To change regional settings

1. Close all EcoStruxure Building Operation software 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-30005-01-en, May 2019

294
 16 Localization Language and Units
16.3 Language Packages

16.3 Language Packages

The EcoStruxure Building Operation software supports several different
languages. To be able to install a new language you need a language pack.

16.3.1 Languages in WorkStation

At the main installation, WorkStation contains English and languages that are
avaílable at the time. To support a language, WorkStation needs the specific
language package.
You can change the display language from within WorkStation. The changes
take effect when you restart WorkStation.

NOTICE
• When no language has been actively selected in WorkStation, the language
given by the regional settings of the computer's operating system apply
provided that the language package for that language is installed.
• If the language package for the language given by the regional setting is not
installed, the WorkStation user interface is displayed in English.
• In Windows Control Panel
Panel, you can check whether or not a language
package is installed on the computer.

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.
WorkStation and servers are built on a multilingual language platform that
supports all characters included in the Basic Multilingual Plan,
http://unicode.org.

16.3.2 Languages in WebStation

The default language in WebStation is English but this can be changed. The
language pack for the language has to be installed on the EcoStruxure BMS
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 EcoStruxure BMS server, you need
the language pack file supplied by Schneider Electric.

04-30005-01-en, May 2019 System

295
16 Localization Language and Units
16.4 Changing the WorkStation Language

16.4 Changing the WorkStation Language

You change the language in WorkStation to view the WorkStation user interface
in a different language.
For more information, see section 16.3 “Language Packages” on page 295.

To change the WorkStation language

1. On the Tools menu, point to Language and then click language.
2. In the Change language dialog box, click Yes to restart the computer
immediately.

NOTICE
You need to restart the program for the changes to take effect.

The WorkStation user interface is displayed in the selected language.

System 04-30005-01-en, May 2019

296
 16 Localization Language and Units
16.5 Adding a Language in WebStation

16.5 Adding a Language in WebStation

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

NOTICE
To add a language in WebStation, you must log on with a user account that
belongs to a user account group that has the property Allow members to
access Automation Server Web Configuration selected in the Policies view.

NOTICE
When an EcoStruxure BMS server is upgraded, the language pack in
WebStation must be added once again.

For more information, see section 16.3 “Language Packages” on page 295.

To add a language in WebStation

1. In WebStation, on the Settings menu, click Options
Options.
2. In the Add or remove languages dialog box, click Upload new language
language.
3. Browse to the language pack .zip file for the language you want to add.
4. Click Open
Open.

04-30005-01-en, May 2019 System

297
16 Localization Language and Units
16.6 Changing the Language in WebStation

16.6 Changing the Language in WebStation

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

To change the language in WebStation

1. In WebStation, on the Settings menu, click Options
Options.
2. Click Change regional settings
settings.
3. In the Regional settings dialog box, select the language you want to use.
4. Click OK
OK.

System 04-30005-01-en, May 2019

298
 16 Localization Language and Units
16.7 Value Presentation

16.7 Value Presentation

The EcoStruxure Building Operation software handles values and numbers with
the highest precision. By default, the unit of a value is converted according to
the regional settings of the user’s operating system.

16.7.1 Units
The EcoStruxure Building Operation software supports both the SI metric system
and the US Customary System for units of measurement.
There are four optional ways to display units:
• As MS Windows
• As configured in object
• International System of Units (Metric)
• United States Customary Units (US)
For more information, see section 16.8 “Units” on page 300.

16.7.2 Metric Prefixes

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

16.7.3 Precision Format

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

04-30005-01-en, May 2019 System

299
16 Localization Language and Units
16.8 Units

16.8 Units
The EcoStruxure Building Operation software supports both the SI metric system
and the US Customary System for units of measurement.
There are four optional ways to display units:
• As MS Windows
• As configured in object
• International System of Units (Metric)
• United States Customary Units (US)
For example, the temperature 42,82 °C is stored in the EcoStruxure Building
Operation software. A WorkStation on an operating system with the US
Customary System converts the temperature and displays it as 109.08 °F.
As MS Windows
By default, values are converted into the unit given by the regional settings of
the operating system.
As configured in object
Units displayed as configured in the object means that no conversion is done.
The unit the user selected when creating, for example, a trend log is displayed
regardless of regional settings. When this option is selected, the unit conversion
exceptions feature is disabled.
International System of Units (Metric)
Values displayed in International System of Units means that the values are
converted into metric unit regardless of the unit the object was given when
created.
United States Customary Units (US)
Values displayed in United States Customary Units means that the values are
converted into US unit regardless of the unit the object was given when created.
When you select a different unit system, the values are converted immediately.
Values are not converted in the following WorkStation screens:
• Alarms and trend logs in wizards
• Customized alarm views
• Alarm and trend log properties panes

16.8.1 Delta Temperature Conversion

NOTICE
• The EcoStruxure Building Operation software 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.

System 04-30005-01-en, May 2019

300
 16 Localization Language and Units
16.8 Units

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 section 16.15 “Delta Temperature Conversion ” on
page 309.

04-30005-01-en, May 2019 System

301
16 Localization Language and Units
16.9 Changing the WorkStation Measurement System

16.9 Changing the WorkStation

Measurement System
You can change the WorkStation measurement system to display values in
different units of measure.
For more information, see section 16.8 “Units” on page 300.

To change the WorkStation measurement system

1. On the Tools menu, point to Measurement system and then click the
measurement system.
(In FM: TaskClosing) The units of measure are immediately converted into the
units of measure of the selected measurement system.

System 04-30005-01-en, May 2019

302
 16 Localization Language and Units
16.10 Adding or Changing a Unit and Prefix for a Value

16.10 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 16.8 “Units” on page 300.

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. In the Basic tab, click the Configuration button .

4. In the Configuration tab, select Unit
Unit.
5. In the Unit box, enter the unit.
6. In the Prefix box, select the prefix of the unit.
7. Click Select
Select.
8. In the Value dialog box, click OK
OK.
9. In the Properties dialog box, click OK
OK.

04-30005-01-en, May 2019 System

303
16 Localization Language and Units
16.11 Metric Prefixes

16.11 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

10-2 0.01 centi c

10-1 0.1 deci d

- - - -

101 10 deca da

102 100 hecto h

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

System 04-30005-01-en, May 2019

304
 16 Localization Language and Units
16.11 Metric Prefixes

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 US customary default length unit is yard.

04-30005-01-en, May 2019 System

305
16 Localization Language and Units
16.12 Precision Format

16.12 Precision Format

Values in the EcoStruxure Building Operation software are stored in the
EcoStruxure 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.

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

System 04-30005-01-en, May 2019

306
 16 Localization Language and Units
16.13 Adding a Unit Conversion Exception

16.13 Adding a Unit Conversion Exception

You add unit conversion exceptions to override the selected unit conversion
system. If you have selected to display units as configured in object, the unit
conversion exceptions feature is disabled.
For more information, see section 16.8 “Units” on page 300.

To add a unit conversion exception

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Domains
Domains.
4. In the Domains list, select a domain for the unit conversion exception.
5. Click Unit Conversion Exceptions
Exceptions.

6. In the Unit Conversion Exceptions view, click Add .

7. In the Unit Selection dialog box, select the unit for which you want a
conversion exception.
8. Click Select
Select.
9. In the Unit Conversion Exceptions view, in the SI Display Unit column,
select the unit to be displayed in an SI metric system.
10. In the US Display Unit column, select the unit to be displayed in a US
customary system.

11. Click the Save button .

The unit conversion exception takes effect immediately unless unit conversion is
disabled.

04-30005-01-en, May 2019 System

307
16 Localization Language and Units
16.14 Removing a Unit Conversion Exception

16.14 Removing a Unit Conversion Exception

You remove unit conversion exceptions to return to the selected unit conversion
system.
For more information, see section 16.8 “Units” on page 300.

To remove a unit conversion exception

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Domains
Domains.
4. In the Domain Control Panel, in the Domains list, select the domain where
you want to remove a unit conversion exception.
5. Click Unit Conversion Exceptions
Exceptions.
6. Select the unit conversion exception you want to remove.

7. Click the Remove button .

8. Click the Save button .

System 04-30005-01-en, May 2019

308
 16 Localization Language and Units
16.15 Delta Temperature Conversion

16.15 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.
If you set a delta temperature to a unit within the unit category Temperature,
EcoStruxure Building Operation software incorrectly converts the value as an
absolute temperature. By setting the delta temperature to a unit within the unit
category Temperature Diff, EcoStruxure Building Operation software correctly
converts the delta value.

Proof
Temperature A: 23°C (73.4°F)
Temperature B: -18°C (-0.4°F)
Diff Temperature = Temperature B - Temperature A
-18°C - 23°C = 41°C
-0.4°F - 73.4°F = 73.8°F

Incorrect delta conversion

Inccorrect conversion of a delta temperature from Celsius to Fahrenheit, when
the unit of the value in EcoStruxure Building Operation software is set to °C.
T°F=T°C x 9/5 + 32:
41°C x 9/5 + 32= 108.8°F
The correct delta value is 73.8°F, not 108.8°F .

Correct delta conversion

Correct conversion of a delta temperature from Celsius to Fahrenheit, when the
unit of the value in EcoStruxure Building Operation software is set to D°C.
DT°F=DT°C x 9/5:
D41°C x 9/5= D73.8°F
The conversion results in the correct delta value of 73.8°F.

NOTICE
By default, units are converted automatically depending on your operating
system's regional settings. You can also select to display values in units
according to the International System of Units (SI), the United States
Customary Units (US), or as configured in the connected objects, that is, the
original unit of the value. For more information, see section 16.8 “Units” on
page 300.

04-30005-01-en, May 2019 System

309
16 Localization Language and Units
16.15 Delta Temperature Conversion

NOTICE
• The EcoStruxure Building Operation software 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.

System 04-30005-01-en, May 2019

310
17 Localization Time and Time
Zone

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

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

17.1.1 Network Time

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

17.1.2 Time and Time Zone Configuration in

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

17.1.3 Time and Time Zone Configuration in

Enterprise Server and Enterprise Central
The Enterprise Server and Enterprise Central time and date settings are
configured through the operating system settings on which the Enterprise Server
and Enterprise Central are installed. The time zone offset, configured through
the Enterprise Server or Enterprise Central, is added by the EcoStruxure
Building Operation software to the UTC time. The Enterprise Server and
Enterprise Central time zone settings are therefore independent of the operating
system time zone settings.
For more information, see section 17.4 “Time and Time Zone Configuration in
Enterprise Server and Enterprise Central” on page 319.

17.1.4 Time and Time Zone Configuration in SmartX

Server
To adjust the SmartX server time, time zone, and DST, you have to access the
SmartX server through a WorkStation.

04-30005-01-en, May 2019 System

313
17 Localization Time and Time Zone
17.1 Time and Time Zone

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

System 04-30005-01-en, May 2019

314
 17 Localization Time and Time Zone
17.2 Lead and Shadow Relationship

17.2 Lead and Shadow Relationship

For some objects on an EcoStruxure BMS server, for example the time zone
object and schedule object, you can establish a lead and shadow relationship to
the parent EcoStruxure BMS server. 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 Enterprise Server object with an Enterprise Central object, you define the
lead object, in this case the Enterprise Central object, in the properties of the
Enterprise Server.
A server on a higher level, such as an Enterprise Central, typically acts as the
lead. However, a lead and shadow relationship can be established between two
SmartX servers.

04-30005-01-en, May 2019 System

315
17 Localization Time and Time Zone
17.2 Lead and Shadow Relationship

When you configure lead objects on an Enterprise Central, the shadow objects
on Enterprise Servers can, in turn, control objects on SmartX server.

17.2.1 Synchronize Network Time Settings

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

17.2.2 Synchronize Time Zone Settings

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

17.2.3 Content Type Synchronization

When you have predefined content types that you want to use for specific types
of folders or container objects on an EcoStruxure BMS server, you can reuse the
content types on another EcoStruxure BMS server. You reuse the content types
by configuring a lead-shadow relationship on the shadow object.
For more information, see section 56.28 “Content Type Synchronization” on
page 1693.

17.2.4 Schedule and Calendar Synchronization

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

17.2.5 Alarm Control Panel Synchronization

When you have predefined Alarm Control Panel objects, for example user
actions or alarm decorators, that you want to reuse on another EcoStruxure BMS
server, you configure a lead-shadow relationship on the shadow Alarm Control
Panel.

System 04-30005-01-en, May 2019

316
 17 Localization Time and Time Zone
17.2 Lead and Shadow Relationship

For more information, see section 31.41 “Alarm Control Panel Synchronization”
on page 752.

04-30005-01-en, May 2019 System

317
17 Localization Time and Time Zone
17.3 Time and Time Zone Configuration in WorkStation

17.3 Time and Time Zone Configuration in

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

Figure: WorkStation displays all times as local time, according to the operating system
settings on which WorkStation is installed.

For example, a WorkStation in Athens surveys a SmartX 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
SmartX server triggers an alarm at 07:43 Eastern time. WorkStation instantly
reports the alarm but presents the alarm with the timestamp 14:43 which is the
local time in Greece.
Some features in WorkStation, such as trend log and schedule, allow you to
change the displayed time to UTC or server local time.

17.3.1 Server Time in WorkStation

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

System 04-30005-01-en, May 2019

318
 17 Localization Time and Time Zone
17.4 Time and Time Zone Configuration in Enterprise Server and Enterprise Central

17.4 Time and Time Zone Configuration in

Enterprise Server and Enterprise
Central
The Enterprise Server and Enterprise Central time and date settings are
configured through the operating system settings on which the Enterprise Server
and Enterprise Central are installed. The time zone offset, configured through
the Enterprise Server or Enterprise Central, is added by the EcoStruxure
Building Operation software to the UTC time. The Enterprise Server and
Enterprise Central 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 the EcoStruxure Building
Operation software to the UTC time.The same is true regarding the Enterprise Central.

To adjust your operating system clock, refer to your manufacturer’s manual for
the operating system. The Enterprise Server and Enterprise Central time zones
are configured through WorkStation.

NOTICE
• The Date and Time synchronization for Automation Server do not affect the
Enterprise Server clock. For more information, see section 17.12
“Synchronize Network Time Settings” on page 328.

04-30005-01-en, May 2019 System

319
17 Localization Time and Time Zone
17.5 Time and Time Zone Configuration in Automation Server

17.5 Time and Time Zone Configuration in

Automation Server
To adjust the SmartX server time, time zone, and DST, you have to access the
SmartX server through a WorkStation.
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 SmartX server time zone
settings.
When adjusting the SmartX server time through WorkStation, it is the SmartX
server operating system clock you adjust. The EcoStruxure Building Operation
software has a transparent layer above the SmartX 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 the EcoStruxure
Building Operation software adds the time zone offset and DST

Instead of configuring the time of each SmartX server, you can create a lead and
shadow relationship that makes it possible to configure several SmartX servers
through a single Enterprise Server.

System 04-30005-01-en, May 2019

320
 17 Localization Time and Time Zone
17.6 Changing the Time Zone of an EcoStruxure BMS Server

17.6 Changing the Time Zone of an

EcoStruxure BMS Server
You change the time zone of an EcoStruxure BMS server to adjust the UTC
offset according to the region where the EcoStruxure BMS server is located.
For more information, see section 17.4 “Time and Time Zone Configuration in
Enterprise Server and Enterprise Central” on page 319.

To change the time zone of an EcoStruxure BMS server

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Network time and time zones
zones.
4. In the Date & Time View
View, select Predefined time zone and then select the
time zone the EcoStruxure BMS 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.

04-30005-01-en, May 2019 System

321
17 Localization Time and Time Zone
17.7 Creating a Custom Time Zone of an EcoStruxure BMS Server

17.7 Creating a Custom Time Zone of an

EcoStruxure BMS Server
If your time zone is not listed in Predefined time zone
zone, you create and configure
a custom time zone for the EcoStruxure BMS server.
For more information, see section 17.1 “Time and Time Zone” on page 313.

To customize a time zone of an EcoStruxure BMS server

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Network time and time zones.
4. In the Date & Time View
View, 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.

NOTICE
• 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-30005-01-en, May 2019

322
 17 Localization Time and Time Zone
17.8 Configuring Enterprise Server, Enterprise Central, and WorkStation Date and Time

17.8 Configuring Enterprise Server,

Enterprise Central, and WorkStation
Date and Time
You adjust the date and time of an Enterprise Server, Enterprise Central, or
WorkStation through the operating system where Enterprise Server, Enterprise
Central, or WorkStation is installed.
For more information, see section 17.3 “Time and Time Zone Configuration in
WorkStation” on page 318.

To configure Enterprise Server, Enterprise Central, and

WorkStation Date and Time
1. Close all EcoStruxure Building Operation software applications.
2. For more information on how to adjust the date and time, refer to the
manufacturer’s manual for the operating system.

NOTICE
The time zone settings for an Enterprise Server and Enterprise Central are
configured through WorkStation and not the operating system.

04-30005-01-en, May 2019 System

323
17 Localization Time and Time Zone
17.9 Synchronizing the SmartX Server Clock

17.9 Synchronizing the SmartX Server Clock

You configure the SmartX server to synchronize its clock with a network time
server.
For more information, see section 17.11 “Network Time” on page 326.

To synchronize the SmartX server clock

1. In WorkStation, in the System Tree pane, select the SmartX BMS server
you want to configure.
2. Click the Control Panel tab.
3. Click Network time and time zones
zones.
4. In the SmartX server Date & time view, select Network time
synchronization
synchronization.
5. In the Primary time server box, type the address to the primary time server
that you want to synchronize the SmartX server clock with.
6. In the Secondary time server box, type the address to the time server that
you want to synchronize the SmartX server clock with if the primary time
server is not available.

7. Click the Save button .

System 04-30005-01-en, May 2019

324
 17 Localization Time and Time Zone
17.10 Manually Changing the SmartX Server Time and Date

17.10 Manually Changing the SmartX Server

Time and Date
You manually adjust the SmartX server clock if it is not synchronized with a
network time server.

NOTICE
• The Date & Time view displays the local time in the perspective of the
SmartX server time zone settings and not in the perspective of WorkStation.

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

To manually change the SmartX server time and date

1. In WorkStation, in the System Tree pane, select the SmartX server you
want to configure.
2. Click the Control Panel tab.
3. Click Network time and time zones
zones.
4. In the SmartX server Date & time view, select Manually adjust date & time
time.
5. In the Local date & time boxes, enter the date and time of the SmartX
server.

6. Click the Save button .

04-30005-01-en, May 2019 System

325
17 Localization Time and Time Zone
17.11 Network Time

17.11 Network Time

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

17.11.1 Network Time on WorkStation, Enterprise

Server, and Enterprise Central
The network time settings on WorkStation, Enterprise Server, and Enterprise
Central are configured through the operating system settings on the computer
where WorkStation, Enterprise Server, or Enterprise Central are installed. For
more information on how to configure network time settings, refer to the
manufacturer’s manual for the operating system.

17.11.2 Network Time Server on a SmartX Server

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

17.11.3 Authenticated Network Time Servers

To increase the security of your system, you can use authenticated network
time. By using authenticated network time, you decrease the risk that someone
will tamper with your time setting.
To be able to use authenticated network time, you connect your EcoStruxure
BMS server to an authenticated time server. You need the secure key ID and
and key value password that is provided by the authenticated time server
administrator.
You can use the lead/shadow relationship to transfer the authenticated time
server setting and its secure key ID and key value password from the lead
server or you can configure the secure time server manually on your
EcoStruxure BMS server. When you use the lead/shadow relationship the
Enterprise Server transfers the setting for the time server to the SmartX server.
The SmartX server then uses the authenticated time server configuration to go
online and get the correct time from the secure time server.
The lead/shadow relationship can also be used to transfer the settings from the
time server on an Enterprise Central to an Enterprise Server.

System 04-30005-01-en, May 2019

326
 17 Localization Time and Time Zone
17.11 Network Time

Figure: The lead and shadow relationship.

04-30005-01-en, May 2019 System

327
17 Localization Time and Time Zone
17.12 Synchronize Network Time Settings

17.12 Synchronize Network Time Settings

You can establish a lead and shadow relationship to synchronize the time on all
your EcoStruxure BMS 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.
The Network time synchronization on shadow Automation Servers option on
the Enterprise Server contains the addresses that are inherited by all shadow
SmartX servers. If you disable this option, established shadow and lead
relationships consist but the shadow SmartX servers do not synchronize their
network time server addresses with the lead Enterprise Server. Instead, the
SmartX servers use their own time settings.

NOTICE
• The addresses in the Automation Server - Date & Time do not affect the
Enterprise Server time and date settings. For more information, see section
17.11 “Network Time” on page 326.

System 04-30005-01-en, May 2019

328
 17 Localization Time and Time Zone
17.13 Synchronizing Time Settings on Multiple SmartX Servers

17.13 Synchronizing Time Settings on Multiple

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

To synchronize time settings on multiple SmartX servers

1. In WorkStation, in the System Tree pane, select the Enterprise Server you
want to configure.
2. Click the Date & Time tab.
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.
5. In the Primary time server box, type the address to the time server that you
want to synchronize the shadow SmartX servers' clocks with.
6. In the Secondary time server box, type the address to the time server that
you want to synchronize shadow SmartX servers' clocks with if the primary
time server is not available.
7. If you are using Authenticated Network Time, select Authenticated
Network time synchronization and enter the Key id and the Key value for
the time servers.
8. On the File menu, click Save
Save.
9. In the Search box, type “Date and Time” to search for the date and time
object on all connected SmartX servers in your EcoStruxure BMS.

10. Click the Search button .

11. In the Search view, select the SmartX servers with the time and date you
want to synchronize with the Enterprise Server time server settings.

12. Click the Show/Hide Property Grid button .

13. Click the Time tab.
14. In the Lead object box, enter /[Enterprise Server Name]/System/Time
Settings/Date and Time
Time.
15. On the File menu, click Save
Save.

04-30005-01-en, May 2019 System

329
17 Localization Time and Time Zone
17.14 Synchronize Time Zone Settings

17.14 Synchronize Time Zone Settings

You can establish a lead and shadow relationship to synchronize the time zone
settings on all your EcoStruxure BMS servers. The Time Zone object on the lead
server contains the time zone settings that are inherited by shadow servers.
This is done automaticallly when you create a new server. For more information,
see the Creating a SmartX Server topic on WebHelp.

System 04-30005-01-en, May 2019

330
 17 Localization Time and Time Zone
17.15 Synchronizing Time Zone Settings on Multiple SmartX Servers

17.15 Synchronizing Time Zone Settings on

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

To synchronize the time zone settings on multiple SmartX

servers
1. In WorkStation, in the Search box, type “Time Zone” to search for the time
zone object on all connected SmartX servers in your EcoStruxure BMS.

2. Click the Search button .

3. In the Search view, select the SmartX 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-30005-01-en, May 2019 System

331
18 Localization User Interface

Topics
Select Unit 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
Date & Time View
SmartX Server – Date & Time View
Add or Remove Languages Dialog Box
Unit Conversion Exceptions View
 18 Localization User Interface
18.1 Select Unit Dialog Box

18.1 Select Unit Dialog Box

Use the Select Unit dialog box to define the unit and metric prefix of a value.

Figure: Select Unit dialog box

Table: Select Unit Dialog Box

Component Description

Quick filter Type the name of the category or unit you

are searching for. For more information,
see section 52.4 “Quick Filter ” on page
1512.

Units Select the category and unit of the value.

For more information, see section 16.8
“Units” on page 300.

Prefix Select the prefix of the unit.

Selected unit Displays the defined unit with prefix.

04-30005-01-en, May 2019 System

335
18 Localization User Interface
18.2 Date and Time Properties – Basic Tab

18.2 Date and Time Properties – Basic Tab

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

Figure: Basic tab

System 04-30005-01-en, May 2019

336
 18 Localization User Interface
18.3 Date and Time Properties – Time Tab

18.3 Date and Time Properties – Time Tab

Use the Time tab to configure the network time server addresses or establish a
lead and shadow relationship on EcoStruxure BMS 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 SmartX server.

NTP Server 1 Type the address to the primary time

server to which the shadow SmartX server
date and time object synchronizes its
clock.

NTP Server 2 Type the address to the secondary time

server to which the shadow SmartX
servers' date and time object synchronizes
its clock.

Lead object Enter the object that acts as the lead for
this object.

04-30005-01-en, May 2019 System

337
18 Localization User Interface
18.3 Date and Time Properties – Time Tab

Continued
Component Description

Primary time server Key Id Type the ID of the authentication key for
the primary time server.

Secondary time server Key Id Type the ID of the authentication key for
the secondary time server.

Password Type the password for the primary time

server.

Confirm Password Type the password for the primary time

server again.

Password Type the password for the secondary time

server.

Confirm Password Type the password for the secondary time

server again.

Authenticate Network Time Select if you want to use authenticated

Synchronization network time synchronizing.

System 04-30005-01-en, May 2019

338
 18 Localization User Interface
18.4 Time Zone Properties – Basic Tab

18.4 Time Zone Properties – Basic Tab

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

Figure: Basic tab

04-30005-01-en, May 2019 System

339
18 Localization User Interface
18.5 Time Zone Properties – Zone Info Tab

18.5 Time Zone Properties – Zone Info Tab

Use the Zone Info tab to configure the time zone settings or establish a lead and
shadow relationship on EcoStruxure BMS servers.

Figure: Zone info tab

Table: Zone Info Tab

Component Description

Time zone Select the time zone the EcoStruxure BMS

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.

Description Type a description or name for the

customized time zone DST settings.

System 04-30005-01-en, May 2019

340
 18 Localization User Interface
18.5 Time Zone Properties – Zone Info Tab

Continued
Component Description

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.

04-30005-01-en, May 2019 System

341
18 Localization User Interface
18.6 Date & Time View

18.6 Date & Time View

Use the Date & Time view to configure shadow SmartX server network time
settings, and the time zone of the Enterprise Central or Enterprise Server.

Figure: Date & time view

Table: Date & Time View

Component Description

Network time synchronization Select to define the primary and secondary

network time server addresses for
connected shadow SmartX server.

Enable Select to define the primary and secondary

network time server addresses for
connected shadow SmartX server.

Authenticate Network time Select if you want to use authenticated

synchronization network time synchronizing.

Primary time server Type the address to the primary time

server to which the shadow SmartX server
date and time object synchronizes its
clock.

Secondary time server Type the address to the secondary time

server to which the shadow SmartX
servers' date and time object synchronizes
its clock.

Key id Type the ID of the authentication key for

the primary time server.

System 04-30005-01-en, May 2019

342
 18 Localization User Interface
18.6 Date & Time View

Continued
Component Description

Key id Type the ID of the authentication key for

the secondary time server.

Key value Type the password for the primary time

server.

Key value Type the password for the secondary time

server.

Manually adjust date & time Select to use manual date and time
configuration for connected shadow
SmartX server.

Disable Select to disable all SmartX server date

and time shadow relationships and use the
SmartX server own date and time
configurations.

Predefined time zone Select the time zone the EcoStruxure BMS
server belongs to.

Custom time zone Select to manually define the EcoStruxure

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

04-30005-01-en, May 2019 System

343
18 Localization User Interface
18.6 Date & Time View

Continued
Component Description

Time - End Select the time that daylight saving time

ends.

System 04-30005-01-en, May 2019

344
 18 Localization User Interface
18.7 SmartX Server – Date & Time View

18.7 SmartX Server – Date & Time View

Use the Date & Time view to configure the SmartX server time and time zone.

Figure: Date & Time View

Table: Date & Time View

Component Description

Network time synchronization Select to synchronize the SmartX server

clock with a network time server.

Authenticate Network time Select if you want to use authenticated

synchronization network time synchronizing.

Primary time server Type the address to the primary time

server to which the shadow SmartX server
date and time object synchronizes its
clock.

Secondary time server Type the address to the secondary time

server to which the shadow SmartX
servers' date and time object synchronizes
its clock.

Key id Type the ID of the authentication key for

the primary time server.

04-30005-01-en, May 2019 System

345
18 Localization User Interface
18.7 SmartX Server – Date & Time View

Continued
Component Description

Key id Type the ID of the authentication key for

the secondary time server.

Key value Type the password for the primary time

server.

Key value Type the password for the secondary time

server.

Manually adjust date & time Select to manually set the SmartX server
clock.

Local date & time Enter the date and time you want to set the
SmartX server clock to. This time is
displayed in SmartX server local time.

Predefined time zone Select the time zone the EcoStruxure BMS
server belongs to.

Custom time zone Select to manually define the EcoStruxure

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

System 04-30005-01-en, May 2019

346
 18 Localization User Interface
18.7 SmartX Server – Date & Time View

Continued
Component Description

Time- End Select the time that daylight saving time

ends.

04-30005-01-en, May 2019 System

347
18 Localization User Interface
18.8 Add or Remove Languages Dialog Box

18.8 Add or Remove Languages Dialog Box

Use the Add or remove languages dialog box to add or remove language that
can be selected in WebStation.

Figure: Add or remove languages dialog box

Table: Add or Remove Languages Dialog Box

Component Description

Upload new language Click to add a language to the list. For

more information, see section 16.3
“Language Packages” on page 295.

Remove Click to remove the selected language. For

more information, see section 16.3
“Language Packages” on page 295.

System 04-30005-01-en, May 2019

348
 18 Localization User Interface
18.9 Unit Conversion Exceptions View

18.9 Unit Conversion Exceptions View

Use the Unit Conversion Exceptions view to override regional settings within a
domain.

Figure: Unit Conversion Exceptions view

Component Description

Add
Click to add a unit conversion exception to
the list.

Remove
Click to remove a unit conversion
exception from the list.

Show/Hide Group Box

Click to display the Show/Hide Group box
to group and sort objects. For more
information, see the Group and Sort
Objects topic on WebHelp.

Quick filter Enter a word or a character to filter on. For

more information, see section 52.4 “Quick
Filter ” on page 1512.

Configured Unit Enter the configured unit that is to trigger a

conversion exception. The configured unit
is the unit that is native to the value/object
before being localized by any operating
system.

SI Display Unit Enter how the configured unit is to be

displayed in an SI metric system.

US Display Unit Enter how the configured unit is to be

displayed in a US customary system.

04-30005-01-en, May 2019 System

349
18 Localization User Interface
18.9 Unit Conversion Exceptions View

NOTICE
Users in a domain become subjects to added unit conversion exceptions the
next time they log on.

System 04-30005-01-en, May 2019

350
19 User Account Management

Topics
User Account Management Overview
Opening the Account Management Control Panel
User Accounts and User Account Groups
Creating a User Account
Editing a User Account Profile
Renaming a User Account
Disabling a User Account
Enabling a Disabled User Account
Setting an Expiration Date for a User Account
Removing the Expiration Date for a User Account
Deleting a User Account
Automatic Logoff
Setting the Automatic Logoff Time
Guest User Account
Automatic Logoff to Guest Account
1Configuring a User Account Group to Log off to the Guest
User Account
 19 User Account Management
19.1 User Account Management Overview

19.1 User Account Management Overview

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

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

The EcoStruxure BMS considers a user account valid when:

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

04-30005-01-en, May 2019 System

353
19 User Account Management
19.1 User Account Management Overview

• The user account group belongs to a domain

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

19.1.1 User Accounts and User Account Groups

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

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

19.1.3 Software Permissions

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

19.1.4 Log on Methods

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

19.1.5 Workspace Management

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

System 04-30005-01-en, May 2019

354
 19 User Account Management
19.1 User Account Management Overview

19.1.6 Automatic Logoff

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

19.1.7 Guest User Account

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

19.1.8 Automatic Logoff to Guest Account

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

19.1.9 Guest Log On in WebStation

A guest logon is used when you want the user to get immediate access to the
EcoStruxure Building Operation software using WebStation.
For more information, see section 21.3 “Guest Logon in WebStation” on page
395.

04-30005-01-en, May 2019 System

355
19 User Account Management
19.2 Opening the Account Management Control Panel

19.2 Opening the Account Management

Control Panel
You open the Account Management control panel in the Work area to create and
configure EcoStruxure Building Operation objects.
For more information, see section 52.2 “Control Panel” on page 1510.

To open the Account Management control panel

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

System 04-30005-01-en, May 2019

356
 19 User Account Management
19.3 User Accounts and User Account Groups

19.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 23.1 “Password Administration” on page 441.
• The user account is unique within the domain it belongs to. For example, an
admin user account is located in Domain A. This account cannot be used to
administrate Domain B. For more information, see section 21.1 “Domains”
on page 391.
• Manage accounts at the domain level using a default administrator account.
For more information, see section 21.11 “Administration Accounts in
EcoStruxure BMS Server Local Domain” on page 403.
• Track user activity at the user-account level. For more information, see
section 25.2 “Audit Trailing of User Activity” on page 482.

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

357
19 User Account Management
19.3 User Accounts and User Account Groups

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

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

19.3.1 Windows Active Directory User Groups

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

System 04-30005-01-en, May 2019

358
 19 User Account Management
19.3 User Accounts and User Account Groups

19.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 25.1 “WorkStation Account Management” on
page 481.

04-30005-01-en, May 2019 System

359
19 User Account Management
19.4 Creating a User Account

19.4 Creating a User Account

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

To create a user account

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

NOTICE
The password is validated against the criteria for passwords in the
EcoStruxure Building Operation software.

16. In the Confirm Password box, type the password again.

17. Click Create
Create.
18. Click OK
OK.

System 04-30005-01-en, May 2019

360
 19 User Account Management
19.5 Editing a User Account Profile

19.5 Editing a User Account Profile

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

To edit a user account profile

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

9. Click the Save button .

04-30005-01-en, May 2019 System

361
19 User Account Management
19.6 Renaming a User Account

19.6 Renaming a User Account

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

To rename a user account

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

System 04-30005-01-en, May 2019

362
 19 User Account Management
19.7 Disabling a User Account

19.7 Disabling a User Account

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

To disable a user account

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

8. Click the Save button .

04-30005-01-en, May 2019 System

363
19 User Account Management
19.8 Enabling a Disabled User Account

19.8 Enabling a Disabled User Account

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

To enable a disabled user account

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

System 04-30005-01-en, May 2019

364
 19 User Account Management
19.9 Setting an Expiration Date for a User Account

19.9 Setting an Expiration Date for a User

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

To set an expiration date for a user account

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

8. Click the Save button .

04-30005-01-en, May 2019 System

365
19 User Account Management
19.10 Removing the Expiration Date for a User Account

19.10 Removing the Expiration Date for a User

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

To remove the expiration date for a user account

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

System 04-30005-01-en, May 2019

366
 19 User Account Management
19.11 Deleting a User Account

19.11 Deleting a User Account

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

To delete a user account

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

6. Click the Delete button .

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

04-30005-01-en, May 2019 System

367
19 User Account Management
19.12 Automatic Logoff

19.12 Automatic Logoff

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

System 04-30005-01-en, May 2019

368
 19 User Account Management
19.13 Setting the Automatic Logoff Time

19.13 Setting the Automatic Logoff Time

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

To set the automatic logoff time

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

04-30005-01-en, May 2019 System

369
19 User Account Management
19.14 Guest User Account

19.14 Guest User Account

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

System 04-30005-01-en, May 2019

370
 19 User Account Management
19.15 Automatic Logoff to Guest Account

19.15 Automatic Logoff to Guest Account

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

04-30005-01-en, May 2019 System

371
19 User Account Management
19.16 1Configuring a User Account Group to Log off to the Guest User Account

19.16 1Configuring a User Account Group to

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

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

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

System 04-30005-01-en, May 2019

372
20 User Account Groups

Topics
Windows Active Directory User Groups
Creating a User Account Group
Editing the Description of a User Account Group
Adding a User Account to a User Account Group
Removing a User Account from a User Account Group
Reviewing the User Account Group Memberships for a User
Account
Adding a User Account Group to a User Account Group
Removing a User Account Group from another User Account
Group
Reviewing the User Account Group Memberships for a User
Account Group
Preventing a Group of Users from Exiting WorkStation
Enabling a Group of Users to Exit WorkStation
Deleting a User Account Group
 20 User Account Groups
20.1 Windows Active Directory User Groups

20.1 Windows Active Directory User Groups

You can map Windows Active Directory groups to EcoStruxure Building
Operation user account groups if the EcoStruxure Building Operation software
runs on a network that uses this directory to manage users and user account
groups. An EcoStruxure Building Operation user account group that includes a
Windows account group can be member of another EcoStruxure Building
Operation user account group.
You can map Windows Active Directory universal and global groups to
EcoStruxure Building Operation user groups, but you cannot map Windows
Active Directory domain local user groups.
Mapping Windows Active Directory account groups to EcoStruxure Building
Operation user account groups has advantages both for administrators and
operators. Administrators can manage the user accounts in the Windows Active
Directory, rather than managing the accounts in two places. Any changes are
instantly implemented to the mapped EcoStruxure Building Operation user
account group. Operators only have to remember the Windows login. Once
logged in to a Windows user account that is mapped to an EcoStruxure Building
Operation account, the user is authenticated to access WorkStation without
having to log in a second time.

NOTICE
• Windows Active Directory account groups can only be mapped on
EcoStruxure BMS servers that are running on Microsoft Windows operating
system. SmartX servers cannot map Windows Active Directory groups.

For example, the Windows Active Directory user account groups Main Admin
and Main User are mapped to the EcoStruxure Building Operation user account
groups Administrators and External Users. The External Users user account
group is a member of the Operator user account group. The Administrators
account group, which is a member of the External Users, inherits access to the
Operator workspace.

NOTICE
If several Windows Active Directory account groups have the same name, any
EcoStruxure Building Operation user account group mapped to one of these
groups will also be mapped to the other Windows Active Directory account
groups with the same name.

04-30005-01-en, May 2019 System

375
20 User Account Groups
20.1 Windows Active Directory User Groups

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

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

System 04-30005-01-en, May 2019

376
 20 User Account Groups
20.2 Creating a User Account Group

20.2 Creating a User Account Group

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

To create a user account group

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

11. Click the Add button .

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

15. Click the Add button .

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

04-30005-01-en, May 2019 System

377
20 User Account Groups
20.2 Creating a User Account Group

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

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

NOTICE
To connect a Windows Active Directory user account group to an
EcoStruxure Building Operation user account group, you need to
establish the connection between the EcoStruxure Building Operation
domain and Active Directory Windows domain. For more information, see
section 21.4 “Creating and Configuring a Domain” on page 396.
Windows Active Directory account groups can only be mapped on
EcoStruxure BMS servers that are running on Microsoft Windows
operating system. SmartX servers cannot map Windows Active Directory
groups.

24. In the Windows group name box, select the Windows Active Directory user
account group you want to map to the EcoStruxure Building Operation user
account group.

NOTICE
You can map Windows Active Directory universal and global account
groups to EcoStruxure Building Operation user account groups, but you
cannot map Windows Active Directory domain local user account groups.

25. Click Create

Create.

System 04-30005-01-en, May 2019

378
 20 User Account Groups
20.3 Editing the Description of a User Account Group

20.3 Editing the Description of a User

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

To edit the description of a user account group

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

8. Click the Save button .

04-30005-01-en, May 2019 System

379
20 User Account Groups
20.4 Adding a User Account to a User Account Group

20.4 Adding a User Account to a User

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

To add a user account to a user account group

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

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

System 04-30005-01-en, May 2019

380
 20 User Account Groups
20.5 Removing a User Account from a User Account Group

20.5 Removing a User Account from a User

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

To remove a user account from a user account group

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

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

04-30005-01-en, May 2019 System

381
20 User Account Groups
20.6 Reviewing the User Account Group Memberships for a User Account

20.6 Reviewing the User Account Group

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

To review the group memberships for a user account

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

System 04-30005-01-en, May 2019

382
 20 User Account Groups
20.7 Adding a User Account Group to a User Account Group

20.7 Adding a User Account Group to a User

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

To add a user account group to a user account group

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

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

8. Click the Save button .

04-30005-01-en, May 2019 System

383
20 User Account Groups
20.8 Removing a User Account Group from another User Account Group

20.8 Removing a User Account Group from

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

To remove a user account group from another user account

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

from and click the Remove button .

8. On the File menu, click Save
Save.

System 04-30005-01-en, May 2019

384
 20 User Account Groups
20.9 Reviewing the User Account Group Memberships for a User Account Group

20.9 Reviewing the User Account Group

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

To review the user account group memberships for a user

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

04-30005-01-en, May 2019 System

385
20 User Account Groups
20.10 Preventing a Group of Users from Exiting WorkStation

20.10 Preventing a Group of Users from

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

To prevent a group of users from exiting WorkStation

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

8. Click the Save button.

System 04-30005-01-en, May 2019

386
 20 User Account Groups
20.11 Enabling a Group of Users to Exit WorkStation

20.11 Enabling a Group of Users to Exit

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

To enable a group of users to exit WorkStation

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

04-30005-01-en, May 2019 System

387
20 User Account Groups
20.12 Deleting a User Account Group

20.12 Deleting a User Account Group

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

To delete a user account group

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

6. Click the Delete button .

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

System 04-30005-01-en, May 2019

388
21 Domains

Topics
Domains
Log On Methods
Guest Logon in WebStation
Creating and Configuring a Domain
Editing the Windows Domain Name
Editing the Description of a Domain
Editing the Maximum Logon Attempts
Assigning a SmartX Server to a Domain
Removing a SmartX Server from a Domain
Deleting a Domain
Administration Accounts in EcoStruxure BMS Server Local
Domain
 21 Domains
21.1 Domains

21.1 Domains
An EcoStruxure Building Operation domain contains user accounts, user
account groups, software permissions, workspaces, and one or several
EcoStruxure BMS servers. The EcoStruxure BMS server that hosts and
administers the domain is called the domain controller.
Normally, a user account or user account group that is a member of a domain
that hosts several EcoStruxure Building Operation servers has access to all
servers within the domain without additional logon. The user account or user
account group can have restricted path permissions preventing the user to
access the servers.
You can set up domains in several ways. You can have a communication
domain that only contains EcoStruxure Building Operation servers and another
domain that contains users, workspaces, and software permissions. Or you can
have a combined domain that manages both servers and users.

NOTICE
An EcoStruxure Building Operation server can belong to more than one
domain.

For example, an EcoStruxure BMS consists of two domains, the Inner City
domain and the Outer city domain. The user Larry has a user account in the
Inner City domain. The Inner City domain contains several Enterprise Servers
and Automation Servers. One of the Automation Servers belongs to both the
Inner City domain and the Outer City domain. Larry cannot access the servers in
the Outer City domain, except for the shared Automation Server.

04-30005-01-en, May 2019 System

391
21 Domains
21.1 Domains

Figure: EcoStruxure Building Operation domain and its components.

NOTICE
You cannot change the name of a domain that is shared between EcoStruxure
BMS servers.

If an Enterprise Server is a member of an Enterprise Central domain, you add

SmartX servers to the same domain from the Enterprise Server domain
membership.

21.1.1 Windows Active Directory Domain

If your domain controller is within a network that has a Windows Active Directory,
you can establish a connection between your EcoStruxure Building Operation
domain and the Windows Active Directory. This connection enables inherited
user account groups from the Windows Active Directory to EcoStruxure Building
Operation software, and allows users to log on to WorkStation with their
Windows user accounts.

System 04-30005-01-en, May 2019

392
 21 Domains
21.1 Domains

Do not name an EcoStruxure Building Operation domain with the same name as
any Windows domain in your network. An EcoStruxure Building Operation
domain and a Windows domain in your network that are named in the same way
can cause conflicts when you use an integrated Windows log on for the
EcoStruxure Building Operation domains.

NOTICE
If the Windows Active Directory name is changed, you have to manually
update the change in EcoStruxure Building Operation software.

EcoStruxure Building Operation software supports Fully Qualified Domain

Name (FQDN) and NetBIOS name. The NetBIOS name is displayed in the Log
on screen even if FQDN is used as a log on method.

21.1.2 Server Local Domain

By default, all servers have a local domain that includes a local administrator
account, administrator user account group, and administrator workspace. The
local domain of a server cannot hold an EcoStruxure Building Operation multi-
server system. When logging on to the local domain of a server, you access only
the unique server.
A local domain and its content cannot be deleted, edited or include other
EcoStruxure Building Operation servers.

NOTICE
On a Local domain, you cannot view bound values from an EcoStruxure BMS
server higher or on the same tier in the EcoStruxure BMS hierarchy.

21.1.3 Administration Accounts in Server Local

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

04-30005-01-en, May 2019 System

393
21 Domains
21.2 Log On Methods

21.2 Log On Methods

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

21.2.1 Log On as a Windows User

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

21.2.2 Log On as an EcoStruxure Building

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

21.2.3 Password Administration

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

System 04-30005-01-en, May 2019

394
 21 Domains
21.3 Guest Logon in WebStation

21.3 Guest Logon in WebStation

A guest logon is used when you want the user to get immediate access to the
EcoStruxure Building Operation software using WebStation.
When using a guest logon for WebStation, the user does not have to provide a
user name or password. Anyone who tries to access the system is logged on
automatically if the guest log on is used.
The guest logon is created using WorkStation and must be named GUEST and
use the password GUEST. The guest logon is valid for the domain it is created
on. The guest logon can be added to any user group in the system.
The guest account can be used immediately after you have created it. But if you
have logged on to WebStation before you created the guest account, you have
to clear cookies in the browser to log on automatically using the guest account.

04-30005-01-en, May 2019 System

395
21 Domains
21.4 Creating and Configuring a Domain

21.4 Creating and Configuring a Domain

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

To create and configure a domain

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

NOTICE
• The Domain Members page appears only if there are any EcoStruxure
BMS servers available to connect to the domain.
• You cannot directly add a SmartX server to a domain in an Enterprise
Central, you need to add an Enterprise Server to the domain first.

11. Click the Add button .

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

System 04-30005-01-en, May 2019

396
 21 Domains
21.5 Editing the Windows Domain Name

21.5 Editing the Windows Domain Name

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

To edit the Windows domain name

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

7. Click the Save button .

04-30005-01-en, May 2019 System

397
21 Domains
21.6 Editing the Description of a Domain

21.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 21.1 “Domains” on page 391.

To edit the description of a domain

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

7. Click the Save button .

System 04-30005-01-en, May 2019

398
 21 Domains
21.7 Editing the Maximum Logon Attempts

21.7 Editing the Maximum Logon Attempts

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

To edit the maximum logon attempts

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

04-30005-01-en, May 2019 System

399
21 Domains
21.8 Assigning a SmartX Server to a Domain

21.8 Assigning a SmartX Server to a Domain

You assign a SmartX server to a domain in the live system to extend your current
domain.
For more information, see section 21.1 “Domains” on page 391.

To assign a SmartX server to a domain

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

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

7. Click the Save button .

System 04-30005-01-en, May 2019

400
 21 Domains
21.9 Removing a SmartX Server from a Domain

21.9 Removing a SmartX Server from a

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

To remove a SmartX server from a domain

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

server , and click the Remove button .

7. On the File menu, click Save
Save.

04-30005-01-en, May 2019 System

401
21 Domains
21.10 Deleting a Domain

21.10 Deleting a Domain

You delete a domain that is not anymore necessary in the EcoStruxure BMS.
For more information, see section 21.1 “Domains” on page 391.

NOTICE
• You cannot delete the default local domain that was installed with the
system.
• You cannot restore a domain that you have deleted.

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

5. Click the Delete button .

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

System 04-30005-01-en, May 2019

402
 21 Domains
21.11 Administration Accounts in EcoStruxure BMS Server Local Domain

21.11 Administration Accounts in EcoStruxure

BMS Server Local Domain
You can manage user accounts on a domain controller by logging on to the
local domain of the EcoStruxure BMS server, using the local administrator and
local reports administrator accounts.

21.11.1 Admin Account

Each EcoStruxure BMS server has a local administrator account, named admin.
This account is preferably used to log on to the EcoStruxure BMS server the first
time to create a new domain with an administration account. To manage and
administrate the new domain, it is recommended that you log on to the domain
with your domain administration account.
The local administrator account cannot be changed or deleted.

21.11.2 Reports Administrator Account

SystemReportsService is the user account for the Reporting Agent service. The
account allows the Reporting Agent service to log on to the Enterprise Server.
This user account is set up during the installation of the Enterprise Server and
WorkStation and does not require any configuration.
The SystemReportsService is disabled in Enterprise Central and needs to be
configured. The password also needs to be set before the Report Server is used
with Enterprise Central.
For more information, see the WebReports User Accounts topic on WebHelp.

04-30005-01-en, May 2019 System

403
22 Software Permissions

Topics
Software Permissions
Path Permissions
Path Permissions Rules
Assigning Path Permissions to User Accounts or User
Account Groups
Editing Path Permissions of User Accounts or User Account
Groups
Removing Path Permissions from User Accounts or User
Account Groups
Command Permissions
Command Permissions Rules
Assigning Command Permissions to User Account Groups
Editing Command Permissions of User Account Groups
Removing Command Permissions from User Account
Groups
Extended Software Permissions
Relative Path Permissions
Relative Path Permissions Rules
Creating Relative Path Templates
Editing Relative Path Permissions Templates
Deleting Relative Path Templates
22 Assigning Relative Path Permissions to User Accounts or
User Account Groups
Removing Relative Path Permissions from User Accounts or
User Account Groups
Type Permissions
Type Permissions Rules
Creating Type Permissions Templates
Editing Type Permissions Templates
Removing Path Permissions Templates
Assigning Type Permissions to User Accounts or User
Account Groups
Removing Type Permissions from User Accounts or User
Account Groups
Software Permissions Management
Software Permissions, User Accounts, and User Account
Groups
Software Permissions Rules Management
 22 Software Permissions
22.1 Software Permissions

22.1 Software Permissions

Software permissions are used to manage privileges that user account groups
and user accounts own to objects in Building Operation software. In the
EcoStruxure Building Operation software, you can assign two types of software
permissions to user account groups and user accounts: path permissions and
command permissions. You can also assign extended permissions to all the
instances of folder structure or of a custom type.

22.1.1 Path Permissions

Path permissions grant a specific set of permissions to a user account or a user
account group to all the folders and objects defined in a path in the EcoStruxure
Building Operations software.
For more information, see section 22.2 “Path Permissions” on page 409.

22.1.2 Command Permissions

Command permissions grant a specific set of permissions to a user account or a
user account group to commands in the EcoStruxure Building Operation
database. You use command permissions to configure exceptions from path
permissions.
For more information, see section 22.7 “Command Permissions ” on page 414.

22.1.3 Extended Software Permissions

Extended Permissions are used to manage privileges of a user account group or
a user account with respect to the instances of a folder structure or to the
instances of custom type.
There are two types of extended software permissions:
• Relative path permissions. For more information, see section 22.13 “Relative
Path Permissions” on page 421.
• Type permissions. For more information, see section 22.20 “Type
Permissions” on page 428.

22.1.4 Relative Path Permissions

Relative path permissions for a folder structure grant a specific set of
permissions to a user account group or to a user account to all the folders
accessible in a predefined path and its folder structure. Relative path
permissions enable a user accounts group or a user account to reuse a specific
path permission.
For more information, see section 22.13 “Relative Path Permissions” on page
421.

04-30005-01-en, May 2019 System

407
22 Software Permissions
22.1 Software Permissions

22.1.5 Type Permissions

Extended permissions for a type grant a specific set of permissions to a user
accounts group or to a user account to all instances of this type. There are two
types of type permissions. Custom type permissions grant permissions for types
created by the users. In-build type permissions grant permissions for types
provided by default with the system.
For more information, see section 22.20 “Type Permissions” on page 428.

22.1.6 Software Permissions Management

Software permissions can be combined between them.
For more information, see section 22.27 “Software Permissions Management” on
page 435.

System 04-30005-01-en, May 2019

408
 22 Software Permissions
22.2 Path Permissions

22.2 Path Permissions

Path permissions are used to give a user account group or a user account
access to the objects defined in the path. The permissions configured on a path
apply to all path sub-levels unless you configure new permissions for the path
sub-level.
Path permissions grant a specific set of permissions to a user account or a user
account group to all the folders, sub-folders and objects contained in these
folders (such as alarms, values or graphics) of a certain folder structure in the
EcoStruxure Building Operations software.
The permissions defined on a path apply to all its sub-paths unless you
configure new permission for a sub-path. Path permissions provided at the top
level of the system are symbolized “/”. Path permissions provided to sub-levels
of the system are symbolized “/[sub-level name]. Parent server is not included in
the path, for instance “/Enterprise server” will only grant access to that specific
server and not sub-servers.

22.2.1 Path Permissions Rules

A user account or a user account group can be granted the following path
permissions: Read, Write, Create, Delete, Edit, Force and Command.
For more information, see section 22.3 “Path Permissions Rules” on page 410.

22.2.2 Relative Path Permissions

Relative path permissions for a folder structure grant a specific set of
permissions to a user account group or to a user account to all the folders
accessible in a predefined path and its folder structure. Relative path
permissions enable a user accounts group or a user account to reuse a specific
path permission.
For more information, see section 22.13 “Relative Path Permissions” on page
421.

04-30005-01-en, May 2019 System

409
22 Software Permissions
22.3 Path Permissions Rules

22.3 Path Permissions Rules

A user account or a user account group can be granted the following path
permissions: Read, Write, Create, Delete, Edit, Force and Command.
Path permissions configured on lower levels of the path overrule permissions
configured on higher levels.

Table: Software Permissions Rules

Property Description

Read Permits viewing and listing path content

Write Permits an administrator to change

configurations except for bindings,
programs, and graphics

Create Permits creating new objects on the path

Delete Permits deleting objects under the path.

Delete permissions are required on a
folder to delete its contents

Edit Permits editing objects on the path

Force Permits forcing values on the path

Command Permits the execution of commands on the

path. Command permissions can override
this permission for specific commands

Inherited Indicates that the permissions are inherited

from the parent folder

NOTICE
You need delete permissions to rename, paste and duplicate folders and
objects in EcoStruxure Building Operation software.

Example
A user account group Janitors owns the permission Read to the /Trend_Logs
path and the permissions Read and Write to its sub-path
/Trend_Logs/Trend_Charts. Paul and Susan belonging to Janitors have a
permission to modify configurations of objects in /Trend_Log/Trend_Charts sub-
path, but can only view all the remining objects in /Trend_Logs path.

System 04-30005-01-en, May 2019

410
 22 Software Permissions
22.4 Assigning Path Permissions to User Accounts or User Account Groups

22.4 Assigning Path Permissions to User

Accounts or User Account Groups
You assign path permissions to user accounts or to user account groups to
control access and user operations in the EcoStruxure Building Operation
software.

NOTICE
• To facilitate the administration of users and software permissions, it is
recommended that you assign software permissions to groups rather than to
individual user accounts. For more information, see section 22.28 “Software
Permissions, User Accounts, and User Account Groups” on page 436.

For more information, see section 22.2 “Path Permissions” on page 409.

To assign path permissions to a user account or a user

account group
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the account management control panel, in the Domain list box, select
the domain the user account or the user account group belongs to.
5. In the User Accounts list box or the User Account Groups list box, select
the user account or the user account group, you want to assign path
permissions.
6. Click Software permissions
permissions.
7. To the Permissions tab,to the Path list, drag the folder or object to which
you want to grant the user account or the user account group access to.

NOTICE
Select to add the the system's top level path.

8. Select the path you created.

9. In the permissions column, select a set of permissions.
10. On the File menu, click Save
Save.

04-30005-01-en, May 2019 System

411
22 Software Permissions
22.5 Editing Path Permissions of User Accounts or User Account Groups

22.5 Editing Path Permissions of User

Accounts or User Account Groups
You edit the path permissions of an individual user account or of a user
accountgroup to modify the access the user account or the user account group
is granted to EcoStruxure Building Operation software.
For more information, see section 22.2 “Path Permissions” on page 409.

To edit the path permissions of a user account or a user

account group
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the account management control panel, in the Domain list box, select
the domain the user account or the user account group belongs to.
5. In the User Accounts list box or the User Account Groups list box, select
the user account or the user account group, you want to edit path
permissions.
6. Click Software permissions
permissions.
7. In the Permissions tab, in the Path list, select the path for which you want
to edit the permissions.
8. In the permissions column, select a set of permission.

9. Click the Save button .

System 04-30005-01-en, May 2019

412
 22 Software Permissions
22.6 Removing Path Permissions from User Accounts or User Account Groups

22.6 Removing Path Permissions from User

Accounts or User Account Groups
You remove a permission of an individual user account to a folder or an object
when the user account no longer is to access the folder or object.
For more information, see section 22.2 “Path Permissions” on page 409.

To remove path permissions from a user account or user

account groups
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the account management control panel, in the Domain list box, select
the domain the user account or the user account group belongs to.
5. In the User Accounts list box or the User Account Groups list box, select
the user account or the user account group, whose path permissions you
want to remove.
6. Click Software permissions
permissions.
7. In the Permissions tab, in the Path list, select the path for which you want
to remove the permissions.
8. Click the Remove button.

9. Click the Save button .

04-30005-01-en, May 2019 System

413
22 Software Permissions
22.7 Command Permissions

22.7 Command Permissions

Command permissions are used to control the operations the members of a user
account group can perform on a category of objects in the EcoStruxure Building
Operation database. You use command permissions to configure exceptions
from path permissions.

22.7.1 Command Permissions Rules

You use command permissions to configure exceptions from path permissions.
You can set the following permissions for a command: no setting, deny, allow.
For more information, see section 22.8 “Command Permissions Rules” on page
415.

System 04-30005-01-en, May 2019

414
 22 Software Permissions
22.8 Command Permissions Rules

22.8 Command Permissions Rules

You use command permissions to configure exceptions from path permissions.
You can set the following permissions for a command: no setting, deny, allow.
• No Setting: No Setting is the default command permission setting. No
Setting means that the Command property in the path permission, for the
folder where the object is located, decides whether the user has permission
to modify the object or not.
• Deny: Users are not allowed to use the command.
• Allow: Users are allowed to use the command.

Examples
You allow a user account group only to add comments to trend log records. All
other command permissions for trend logs have the Deny permission. Users
with the Deny command permission can comment on existing records but are
not allowed to perform other actions such as adding records or clearing the
trend log. This assumes that the users have path permission to access the trend
logs.
In another example, the user account group has the path permissions read,
write, create, delete, edit, force, and command to a folder that contains BACnet
objects. To prevent the users in the user account group from updating the
BACnet firmware, you use the Deny command permission for this action. All
other command permissions are changed to No Setting. Due to the full set of
path permissions, the users can perform all commands on BACnet devices, but
not update the firmware.

Figure: The user account group has full permission to open and modify BacNet objects,
beside performing firmware update.

In afinal example, the user account group has the path permission Read to the
Enterprise Server. To enable the users in the user account group to perform all
commands on trend logs in the system, you change all the command
permissions on the Trends category to Allow.

04-30005-01-en, May 2019 System

415
22 Software Permissions
22.8 Command Permissions Rules

A user account can be a member of several user account groups with different
permissions. The priority between different permissions follow a set of
permission rules. You can use these permission rules to manage the type of
data and commands the user has access to within a workspace, panel, or
domain. For more information, see section 22.29 “Software Permissions Rules
Management” on page 438.

System 04-30005-01-en, May 2019

416
 22 Software Permissions
22.9 Assigning Command Permissions to User Account Groups

22.9 Assigning Command Permissions to

User Account Groups
You assign command permissions to user account groups to control access and
user operations in the EcoStruxure Building Operation software.
For more information, see section 22.8 “Command Permissions Rules” on page
415.

To assign command permissions to a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the account management control panel, in the Domain list box, select
the domain the user account or the user account group belongs to.
5. In the User Account Groups list box, select the user account group, you
want to assign command permissions to.
6. In the User Account Groups area, click Software permissions
permissions.
7. In the Permissions tab, in the Command Permissions area, in the
Category column, select a category that you want to configure permissions
for.
8. In the Command column, select a command.
9. In the Permission list for the command, select a permission.

10. Click the Save button .

04-30005-01-en, May 2019 System

417
22 Software Permissions
22.10 Editing Command Permissions of User Account Groups

22.10 Editing Command Permissions of User

Account Groups
You editcommand permissions of user account groups to modify access and
user operations in the EcoStruxure Building Operation software.
For more information, see section 22.8 “Command Permissions Rules” on page
415.

To edit command permissions of a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the account management control panel, in the Domain list box, select
the domain the user account group belongs to.
5. In the User Account Groups list box, select the user account group, you
want to edit command permissions of.
6. In the User Account Groups area, click Software permissions
permissions.
7. In the Permissions tab, in the Command Permissions area, in the
Category column, select a category that you want to edit permissions for.
8. In the Command column, select a command.
9. In the Permission list for the command, select a permission.

10. Click the Save button .

System 04-30005-01-en, May 2019

418
 22 Software Permissions
22.11 Removing Command Permissions from User Account Groups

22.11 Removing Command Permissions from

User Account Groups
You remove a user account goup's path permission to remove the permission to
a folder or an object the user account group no longer is to have permissions to.
For more information, see section 22.28 “Software Permissions, User Accounts,
and User Account Groups” on page 436.
For more information, see section 22.8 “Command Permissions Rules” on page
415.

To remove command permissions from a user account group

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the account management control panel, in the Domain list box, select
the domain the user account group belongs to.
5. In the User Account Groups list box, select the user account group, whose
command permissions you want to remove.
6. Click Software permissions
permissions.
7. In the Permissions tab, in the Command Permissions area, in the
Category column, select a category, whose command permisions you want
to remove.
8. In the Command column, select a command.
9. In the Permission list for the command, select No Setting
Setting.

10. Click the Save button .

04-30005-01-en, May 2019 System

419
22 Software Permissions
22.12 Extended Software Permissions

22.12 Extended Software Permissions

Extended Permissions are used to manage privileges of a user account group or
a user account with respect to the instances of a folder structure or to the
instances of custom type.
There are two types of extended software permissions:
• Relative path permissions. For more information, see section 22.13 “Relative
Path Permissions” on page 421.
• Type permissions. For more information, see section 22.20 “Type
Permissions” on page 428.

System 04-30005-01-en, May 2019

420
 22 Software Permissions
22.13 Relative Path Permissions

22.13 Relative Path Permissions

Relative path permissions for a folder structure grant a specific set of
permissions to a user account group or to a user account to all the folders
accessible in a predefined path and its folder structure. Relative path
permissions enable a user accounts group or a user account to reuse a specific
path permission.
Furthermore, you can add and delete permissions for this folder structure.

Example
The same set of objects and properties (values, trends, alarms, graphics etc.) is
defined in 100 rooms in your building. You define a relative path template that
models the folder structure of the rooms in the building, and you define
permissions to this folder structure. You define a relative path template by
choosing one example of the folder structure. All similar folder structures
following the same pattern will inherit permissions defined on the template.
Finally, you also define permissions for specific user accounts and user account
groups.

22.13.1 Relative Path Permissions Rules

You set permissions on a relative path twice.
First, you set permissions on the objects in the template. Objects in the template
can be granted the following path permissions: Read, Write, Create, Delete,
Edit, Force and Command.
Second, you set permissions for user accounts and user account groups. A user
account or a user account group can be granted the following path permissions:
Read, Write, Create, Delete, Edit, Force and Command.
For more information, see section 22.14 “Relative Path Permissions Rules” on
page 422.

04-30005-01-en, May 2019 System

421
22 Software Permissions
22.14 Relative Path Permissions Rules

22.14 Relative Path Permissions Rules

You set permissions on a relative path twice.
First, you set permissions on the objects in the template. Objects in the template
can be granted the following path permissions: Read, Write, Create, Delete,
Edit, Force and Command.
Second, you set permissions for user accounts and user account groups. A user
account or a user account group can be granted the following path permissions:
Read, Write, Create, Delete, Edit, Force and Command.

Table: Software Permissions Rules

Property Description

Read Permits viewing and listing path content

Write Permits an administrator to change

configurations except for bindings,
programs, and graphics

Create Permits creating new objects on the path

Delete Permits deleting objects under the path.

Delete permissions are required on a
folder to delete its contents

Edit Permits editing objects on the path

Force Permits forcing values on the path

Command Permits the execution of commands on the

path. Command permissions can override
this permission for specific commands

Inherited Indicates that the permissions are inherited

from the parent folder

NOTICE
You need delete permissions to rename, paste and duplicate folders and
objects in EcoStruxure Building Operation software.

System 04-30005-01-en, May 2019

422
 22 Software Permissions
22.15 Creating Relative Path Templates

22.15 Creating Relative Path Templates

You create a relative path template to facilitate the process of assigning path
permissions.
For more information, see the Concept Title topic on WebHelp.

To create a relative path template

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Relative path permissions
permissions.
4. In the File menu, click New and then click Relative path permissions
permissions.
5. In the Create Object dialog box, in the Name box, type the name of your
path permission.
6. In the Path box, enter the path.
7. In the Description box, type a description.
8. Click Create
Create.
9. In the System Tree pane, select the relative path permission you just
created.
10. In the Relative to box, browse to the path you want your permission to be
relative to.
11. Select +.
12. In the Select Object window, select the object you want to add to the
permission path.
13. In the rules table, choose the permission level for the path.

14. Click the Save button .

You can assign the created type permissions to user accounts or user account
groups.

04-30005-01-en, May 2019 System

423
22 Software Permissions
22.16 Editing Relative Path Permissions Templates

22.16 Editing Relative Path Permissions

Templates
You modify a relative path permission by adding or withdrawing permissions for
this folder structure. The changes will be accounted in all the instance.
For more information, see the Concept Title topic on WebHelp.

To edit a relative path permissions template

1. In Workstation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Relative path permissions
permissions.
4. In the Tree Pane select the relative path permissions you want to edit.
5. In the permissions column, select permissions that you want to assign and
unselect permissions you want to withdraw.

6. Click the Save button .

You modified permissions that user accounts and user account groups have to
a folder structure.

System 04-30005-01-en, May 2019

424
 22 Software Permissions
22.17 Deleting Relative Path Templates

22.17 Deleting Relative Path Templates

You delete relative path template to restructure your policy of permission
assignment.
For more information, see the Concept Title topic on WebHelp.

To delete a relative path template

1. In Workstation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Relative path permissions
permissions.
4. In the List View tab, in the Name column, select the relative path you want
to delete.
5. In the Edit menu, select Delete
Delete.
6. In the Confirm Delete dialog box, click Yes
Yes.

NOTICE
By deleting relative path template, you removes all its occurences in user
accounts and user account groups permissions.

By applying a well designed premission policy you improve the ergonomy of

your system.

04-30005-01-en, May 2019 System

425
22 Software Permissions
22.18 Assigning Relative Path Permissions to User Accounts or User Account Groups

22.18 Assigning Relative Path Permissions to

User Accounts or User Account Groups
You assign relative path permissions to grant user accounts or user account
groups access to a specific path structure in the EcoStruxure Building Operation
software.

To assign a relative path permissions to user accounts or user

account groups
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the User Accounts list or the User Account Groups list, select the user
account or the user account group, you want to assign the relative path
permission to.
5. Click Software permissions
permissions.
6. In the Path Permissions pane, browse to the path you want and click +.
7. In the permissions column, select permissions that you want to assign.
8. In the Relative path permissions column, browse to the relative path
permissions you want to use.

9. Click the Save button .

You can edit and remove relative path permissions from user accounts and user
account groups.

System 04-30005-01-en, May 2019

426
 22 Software Permissions
22.19 Removing Relative Path Permissions from User Accounts or User Account Groups

22.19 Removing Relative Path Permissions

from User Accounts or User Account
Groups
You remove relative path permissions from user accounts or user account
groups to modify users access to spacific folder structures.
For more information, see the Concept Title topic on WebHelp. For more
information, see section 22.14 “Relative Path Permissions Rules” on page 422.

To remove relative path permissions from user accounts or

user account groups
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the User Accounts list box or the User Account Groups list box, select
the user account or the user account group you want to remove the relative
path permissions from.
5. Click Software permissions
permissions.
6. In the Path Permissions pane, browse to the path you want to remove.
7. In the Relative path permissions column erase the url.

8. Click the Save button

User accounts or user account groups are no longer granted permissions to a
specific folder structure.

04-30005-01-en, May 2019 System

427
22 Software Permissions
22.20 Type Permissions

22.20 Type Permissions

Extended permissions for a type grant a specific set of permissions to a user
accounts group or to a user account to all instances of this type. There are two
types of type permissions. Custom type permissions grant permissions for types
created by the users. In-build type permissions grant permissions for types
provided by default with the system.

22.20.1 Custom Type Permissions

Custom type permissions are type permissions for a type created by a user.

22.20.2 In-built Type Permissions

In-built type permissions are type permissions for a type provided by default
with the system.

22.20.3 Type Permission Rules

You set permissions on a type twice.
First, you set permissions on the type of object. Types can be granted the
following path permissions: Read, Write, Create, Delete, Edit, Force, Command
and Inherited. You need to assign at least Read permissions on the type.
Second, you set permissions for user accounts and user account groups. A user
account or a user account group can be granted or refused permissions to the
type.
For more information, see section 22.21 “Type Permissions Rules” on page 429.

System 04-30005-01-en, May 2019

428
 22 Software Permissions
22.21 Type Permissions Rules

22.21 Type Permissions Rules

You set permissions on a type twice.
First, you set permissions on the type of object. Types can be granted the
following path permissions: Read, Write, Create, Delete, Edit, Force, Command
and Inherited. You need to assign at least Read permissions on the type.
Second, you set permissions for user accounts and user account groups. A user
account or a user account group can be granted or refused permissions to the
type.

Table: Software Permissions Rules

Property Description

Read Permits viewing and listing path content

Write Permits an administrator to change

configurations except for bindings,
programs, and graphics

Create Permits creating new objects on the path

Delete Permits deleting objects under the path.

Delete permissions are required on a
folder to delete its contents

Edit Permits editing objects on the path

Force Permits forcing values on the path

Command Permits the execution of commands on the

path. Command permissions can override
this permission for specific commands

Inherited Indicates that the permissions are inherited

from the parent folder

NOTICE
You need delete permissions to rename, paste and duplicate folders and
objects in EcoStruxure Building Operation software.

04-30005-01-en, May 2019 System

429
22 Software Permissions
22.22 Creating Type Permissions Templates

22.22 Creating Type Permissions Templates

You create a type permissions template to grant user accounts or user account
groups access to a specific type.
For more information, see section 22.20 “Type Permissions” on page 428.

To create a type permissions template

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Type permissions
permissions.
4. In the File menu, choose New and then select Type permissions
permissions.
5. In the Create Object dialog box, in the Name box, type the name of your
type permissions.
6. In the Path box, enter the path.
7. In the Description box, type a description.
8. Click Create
Create.
9. In the System Tree pane, select the type permissions you just created.
10. In the Relative to box, select an instance of the type you want your
permission to be relative to.
11. In the Type name box, verify the name of your type.
12. Select +.
13. In the Select Object window, select the object you want to add to the
permission path.
14. In the rules table, choose the permission level for the type.

15. Click the Save button .

You can assign the created type permissions to user accounts or user account
groups.

System 04-30005-01-en, May 2019

430
 22 Software Permissions
22.23 Editing Type Permissions Templates

22.23 Editing Type Permissions Templates

You edit type permissions template to change permissions to this type.
For more information, see section 22.21 “Type Permissions Rules” on page 429.

To edit a type permissions template

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Type permissions
permissions.
4. In the System Tree pane, select the type permissions you want to edit.
5. In the Relative object list, choose the object you want to edit.
6. In the rules table, choose permissions for the type.

7. Click the Save button .

A user account or a user account group is now granted a new set of permissions
for a given type.

04-30005-01-en, May 2019 System

431
22 Software Permissions
22.24 Removing Path Permissions Templates

22.24 Removing Path Permissions Templates

You remove path permissions templates to disable all user accounts and user
account groups from accessinga specific folder structure.

To remove a path permissions template

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Type permissions
permissions.
4. In the System Tree pane, select the type permissions you want to remove.
5. In the Edit menu, select Delete
Delete.
The template of a path permission is deleted.

System 04-30005-01-en, May 2019

432
 22 Software Permissions
22.25 Assigning Type Permissions to User Accounts or User Account Groups

22.25 Assigning Type Permissions to User

Accounts or User Account Groups
You assign type permissions to grant user accounts or user account groups
access to a specific type in the EcoStruxure Building Operation software.
For more information, see section 22.20 “Type Permissions” on page 428.

To assign type permissions to user accounts or user account

groups
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the User Accounts list box or the User Account Groups list box, select
the user account or the user account group, you want to assign the type
permission to.
5. Click Software permissions
permissions.
6. In the Type Permissions pane, click +.
7. Browse to the type you want to assign permissions to and click Select
Select.

8. Click the Save button .

NOTICE
You need at least Read permission on the path where the instance of the
type belongs to.

Type permissions are assign to the user account or the user account group.

04-30005-01-en, May 2019 System

433
22 Software Permissions
22.26 Removing Type Permissions from User Accounts or User Account Groups

22.26 Removing Type Permissions from User

Accounts or User Account Groups
You remove type permissions from a user account or a user account group to
withdraw their permissions to a specific type.
For more information, see section 22.21 “Type Permissions Rules” on page 429.

To remove type permissions from a user account or a user

account group
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. In the Control Panel tab, in the User Management list, select the user
account, or the user account group, you what to assign the type
permissions to.
3. Click Software permissions
permissions.
4. In the Type Permissions pane, select the type permissions you want to
remove.
5. Click the Delete button.
Type permissions are removed from the user account or the user account
groups.

System 04-30005-01-en, May 2019

434
 22 Software Permissions
22.27 Software Permissions Management

22.27 Software Permissions Management

Software permissions can be combined between them.

22.27.1 Software Permissions, User Accounts and

User Account Groups Management
Software permissions can be assigned to individual user accounts and to user
account groups.
For more information, see section 22.28 “Software Permissions, User Accounts,
and User Account Groups” on page 436.

22.27.2 Software Permissions Rules Management

You manage software permissions by combining various types of permissions.
For more information, see section 22.8 “Command Permissions Rules” on page
415.

04-30005-01-en, May 2019 System

435
22 Software Permissions
22.28 Software Permissions, User Accounts, and User Account Groups

22.28 Software Permissions, User Accounts,

and User Account Groups
Software permissions can be assigned to individual user accounts and to user
account groups.
Path permissions can be assigned to both, individual user accounts and user
account groups. Command permissions can be assigned to user account
groups only and cannot be assigned to individual user accounts. If you want to
assign command permissions to individual user account, you need to create a
group with one individual. You assign command permissions to modify specific
permissions that user account groups possess to specific objects on the given
path.
Relative path permissions and type permissions can be assigned to both,
individual user accounts and user account groups.
If no software permissions are configured for a user account or user account
group, the user has no access to EcoStruxure Building Operation software. By
default, new user accounts and new user account groups have no permissions
to access EcoStruxure Building Operation software. Changes to the software
permissions of a user account group or user account are applied the next time
the user logs on.
You can also combine software permissions with other general policies for the
user accounts that are members to the user account groups. For example, you
can enable or disable the ability of the group members to change their
passwords or to choose the workspace.
For optimal efficiency, assign software permissions to user account groups
rather than individual user accounts, wherever possible. Using this approach,
you can associate user accounts to at least one user account group for
controlled permission to EcoStruxure Building Operation applications. A user
account group can comprise both user accounts and other user account
groups. You group user accounts and user account groups with similar
interests. For instance, you can group software permissions with user accounts
based on common tasks and responsibilities

Example
You create a user account for Paul and associate him with the two user account
groups: Administrators and Janitors. You associate Paul with those two user
account groups. You grant Administrators and Janitors certain software
permissions. Paul inherits software permissions of both user account groups.

System 04-30005-01-en, May 2019

436
 22 Software Permissions
22.28 Software Permissions, User Accounts, and User Account Groups

Figure: Users inherit the user account group permissions of which they are members

04-30005-01-en, May 2019 System

437
22 Software Permissions
22.29 Software Permissions Rules Management

22.29 Software Permissions Rules

Management
You manage software permissions by combining various types of permissions.
By using a well-planned strategy of assigning software permissions, you can
optimize performances of the users. You can also apply your policies to control
exploitation of the EcoStruxure BMS.

Table: Software Permissions Rules

Property Description

Read Permits viewing and listing path content

Write Permits an administrator to change

configurations except for bindings,
programs, and graphics

Create Permits creating new objects on the path

Delete Permits deleting objects under the path.

Delete permissions are required on a
folder to delete its contents

Edit Permits editing objects on the path

Force Permits forcing values on the path

Command Permits the execution of commands on the

path. Command permissions can override
this permission for specific commands

Inherited Indicates that the permissions are inherited

from the parent folder

NOTICE
You need delete permissions to rename, paste and duplicate folders and
objects in EcoStruxure Building Operation software.

Building Operation software uses basic rules to determine software permissions

priorities.
• Command permissions of a user account are inherited from the most
advanced permissions in any group the user belongs to. The command
permission Allow overrules Deny
Deny, and Deny overrules No Setting
Setting.
Example. Paul belongs to Janitors and to Administrators. Janitors does not
have permission to accept an alarm, but Administrators have. Paul inherits
the permission to accept the alarm from Administrators.
• Relative path permissions configured for an individual user account
overrule permissions inherited from user account groups.
• Type permissions overwrite path permissions.

System 04-30005-01-en, May 2019

438
23 Login Configuration

Topics
Password Administration
Editing a User Account Password
Allowing Users to Change their Password
Changing Your Password
Changing the Password for Local Administrator Accounts
Turning off Remember Me On This Computer
Forcing a User to Change the Password at Next Logon
Preventing Users from Changing Their Passwords
Resetting the Administrator Password
 23 Login Configuration
23.1 Password Administration

23.1 Password Administration

As a WorkStation administrator, you can change users’ passwords, force users
to change their passwords at next logon, or enable and disable the possibility
for users to change their passwords.
Passwords are managed at the user account group level. EcoStruxure Building
Operation software applies password changes to all user accounts that belong
to the user account group.

NOTICE
• If you are an administrator and have forgotten your password, contact the
EcoStruxure BMS support team.

04-30005-01-en, May 2019 System

441
23 Login Configuration
23.2 Editing a User Account Password

23.2 Editing a User Account Password

You edit the password for a user account to give a user that has been locked out
of the EcoStruxure BMS by exceeding the number of allowed failed logon
attempts a new password.
For more information, see section 23.1 “Password Administration” on page 441.

To edit a user account password

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In Domain Control Panel
Panel, in the Domain box, select the domain the user
account to belongs to.
5. In the User Accounts list box, select the user account for which you wish to
change the password.
6. Click Summary
Summary.
7. On the Summary tab, in the Password box, type the new password.
8. In the Confirm Password box, confirm the password by retyping it.

9. Click the Save button .

System 04-30005-01-en, May 2019

442
 23 Login Configuration
23.3 Allowing Users to Change their Password

23.3 Allowing Users to Change their

Password
You allow a group of users to change their password. The default setting is that
all users can change their password.
For more information, see section 22.28 “Software Permissions, User Accounts,
and User Account Groups” on page 436.

To allow users to change their password

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

8. Click the Save button .

04-30005-01-en, May 2019 System

443
23 Login Configuration
23.4 Changing Your Password

23.4 Changing Your Password

You change your EcoStruxure Building Operation user password on a regular
basis to keep your information secure.

To change your password

1. In WorkStation, on the File menu, click Change Password
Password.
2. In the Change Password dialog box, in the Old Password box, type your
current password.
3. In the New password box, type your new password.
4. In the Confirm password box, type your new password again.
5. Click OK
OK.

System 04-30005-01-en, May 2019

444
 23 Login Configuration
23.5 Changing the Password for Local Administrator Accounts

23.5 Changing the Password for Local

Administrator Accounts
You change the password for the local administrator (admin) accounts on the
EcoStruxure BMS servers to prevent unauthorized access.
For more information, see section 23.1 “Password Administration” on page 441.

To change the password for local administrator accounts

1. In WorkStation, in the Search box, type “admin” to search for the local
administrator account on all EcoStruxure BMS servers in your EcoStruxure
BMS.

2. Click the Search button .

3. In the Search view, select the local administrator accounts you want to
change the password for.
4. On the File menu, click Properties
Properties.
5. Click the Basic tab.
6. In the Password box, type the new password.
7. In the Confirm Password box, type the password again.
8. On the File menu, click Save
Save.

04-30005-01-en, May 2019 System

445
23 Login Configuration
23.6 Turning off Remember Me On This Computer

23.6 Turning off Remember Me On This

Computer
You turn off Remember me on this computer to clear the information you have
stored in the Building Operation WorkStation window. For example, you want to
be able to use different accounts when logging on, or log on to different
EcoStruxure BMS server in the domain.
For more information, see section 21.2 “Log On Methods” on page 394.

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.

System 04-30005-01-en, May 2019

446
 23 Login Configuration
23.7 Forcing a User to Change the Password at Next Logon

23.7 Forcing a User to Change the Password

at Next Logon
You force a user to change the password at next logon to increase the security,
for example, when distributing a user account to a new user.
For more information, see section 23.1 “Password Administration” on page 441.

To force a user to change the password at next logon

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

8. Click the Save button .

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

04-30005-01-en, May 2019 System

447
23 Login Configuration
23.8 Preventing Users from Changing Their Passwords

23.8 Preventing Users from Changing Their

Passwords
You prevent a group of users from changing their passwords.
For more information, see section 23.1 “Password Administration” on page 441.

To prevent users from changing their passwords

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

8. Click the Save button.

System 04-30005-01-en, May 2019

448
 23 Login Configuration
23.9 Resetting the Administrator Password

23.9 Resetting the Administrator Password

You reset the administrator password, if you are an administrator. For example if
you have locked yourself out of WorkStation. Schneider Electric Buildings
support team provides you with a temporary password for logging on to
EcoStruxure BMS and changing your administrator password.
For more information, see section 23.1 “Password Administration” on page 441.

NOTICE
• To authenticate yourself to the Schneider Electric Buildings support team,
you have to state your user name and password, the unique session ID (from
the failed logon attempt), and the domain you tried to log on to. To show the
session ID you need to press SHIFT and click the EcoStruxure Building
Operations icon in the WorkStation logon dialog box.

To reset the administrator password

1. Contact Schneider Electric Support and get a temporary password.
2. In WorkStation, log on using the temporary password.
3. Change your password.

04-30005-01-en, May 2019 System

449
24 Workspaces

Topics
Workspace Management
Predefined Workspaces
Workspace Components and Customization
Workspace Customization
Workspace Path, Object, and Command Customization
Workspace Content References
Creating a Workspace
Editing the Layout of a Workspace
Editing the Description of a Workspace
Adding a Component to a Workspace
Removing a Component from a Workspace
Editing a Workspace Component
Adding a Workspace to a User Account Group
Removing a Workspace from a User Account Group
Reviewing the Workspace Memberships for a User Account
Group
Panel Components
Creating a Panel
Editing a Panel
Customized Navigation
24 Customized Navigation Workflow
WebStation in Kiosk Mode
 24 Workspaces
24.1 Workspace Management

24.1 Workspace Management

The workspace defines the content and layout of WorkStation. The content and
layout of the workspace can be adapted different tasks for user accounts or user
account groups.
You can create different workspaces for different user categories and link them
to user account groups. A user has access to all workspaces linked to the user
account groups in which the user is a member. This way, users can easily switch
workspaces during a work session. For example, Paul, a member of the
Administrators and Janitors user account groups, has access to the
Administrator workspace and Janitor workspace.

Figure: Users gain access to the workspaces linked to their user account groups

If a user account or user account group is assigned to more than one

workspace, WorkStation asks you to select a default workspace at the first log
on. The next time you log on to the EcoStruxure BMS on the same computer,
your default workspace is automatically displayed. Once logged in, you can
change your default workspace settings.

24.1.1 Predefined Workspaces

Some workspace layouts are included in the EcoStruxure Building Operation
software and cannot be deleted or edited. Those workspaces are located in the
local domain of the EcoStruxure BMS server.
For more information, see section 24.2 “Predefined Workspaces” on page 455.

04-30005-01-en, May 2019 System

453
24 Workspaces
24.1 Workspace Management

24.1.2 Workspace Components and Customization

A workspace consists of panes, windows, and a work area that can be
customized to suit a user's specific needs. Dialog boxes are presented on top of
the workspace.
For more information, see section 24.3 “Workspace Components and
Customization” on page 456.

24.1.3 WebStation in Kiosk Mode

You can configure to run WebStation in Internet Explorer in kiosk mode if you
want to limit the users’ access to toolbar and shortcuts in Internet Explorer.
For more information, see section 24.21 “WebStation in Kiosk Mode” on page
477.

System 04-30005-01-en, May 2019

454
 24 Workspaces
24.2 Predefined Workspaces

24.2 Predefined Workspaces

Some workspace layouts are included in the EcoStruxure Building Operation
software and cannot be deleted or edited. Those workspaces are located in the
local domain of the EcoStruxure BMS server.

Table: Predefined Workspaces

Predefined Workspaces Description

System Default Workspace The System Default Workspace displays if

there is no workspace available for users
that log on to WorkStation. For example,
the EcoStruxure Building Operation
software uses this workspace when the
user account group the user belongs to
has no workspaces associated with it, or
the user's default workspace is deleted by
the system administrator.

Administration Workspace The Administration Workspace displays if

there is no other workspace available for
administrators logging on to WorkStation.
The purpose of the Administration
workspace is to ensure that users with
administrator rights always have access to
all properties and functions.

Engineering Workspace In addition to the System Default

Workspace and Administration Workspace
that are installed when an EcoStruxure
Building Operation software is installed,
you also have the option to install a
predefined engineering workspace. The
purpose of the Engineering workspace is
to configure WorkStation, view events and
alarms.

04-30005-01-en, May 2019 System

455
24 Workspaces
24.3 Workspace Components and Customization

24.3 Workspace Components and

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

Figure: Workspace components

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

System 04-30005-01-en, May 2019

456
 24 Workspaces
24.3 Workspace Components and Customization

24.3.1 Workspace Customization

You customize the workspace layout to control access and meet the specific
requirements of a user account group. For example, you hide or show panes
and toolbars. You can save a workspace layout on the EcoStruxure BMS server.
In this case, the layout becomes the default workspace layout for all users in the
user account group the workspace belongs to. Workspaces are task oriented,
which means that a user can switch workspaces during a single WorkStation
session.
For more information, see section 24.4 “Workspace Customization” on page
458.

24.3.2 Workspace Content References

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

24.3.3 Panel Components

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

04-30005-01-en, May 2019 System

457
24 Workspaces
24.4 Workspace Customization

24.4 Workspace Customization

You customize the workspace layout to control access and meet the specific
requirements of a user account group. For example, you hide or show panes
and toolbars. You can save a workspace layout on the EcoStruxure BMS server.
In this case, the layout becomes the default workspace layout for all users in the
user account group the workspace belongs to. Workspaces are task oriented,
which means that a user can switch workspaces during a single WorkStation
session.
You can configure a workspace to contain a limited number of views to which
users have access. Specifically, you can add, edit, move, or remove the
following panes and windows:
• Advanced Schedule Pane
• Alarms Pane
• Basic Schedule Pane
• Calendar Pane
• Events Pane
• Function Block Program Pane
• Graphic Pane
• Multi Trend Log List Pane
• Navigation Pane
• Panel Pane
• System Tree Pane
• Trend Chart Pane
• Trend Log List Pane
• Watch Pane
• Work Area Window
For example, you can create a workspace that displays an Alarms pane and a
graphic in the work area representing a building.

24.4.1 Customized Navigation

You use the Navigation Pane to build a customized structure for navigation. The
Navigation pane can be used in a workspace or a panel.
For more information, see section 24.19 “Customized Navigation” on page 475.

System 04-30005-01-en, May 2019

458
 24 Workspaces
24.4 Workspace Customization

24.4.2 Workspace Path, Object, and Command

Customization
Software permissions limit the paths, objects, and commands that are available
in a workspace. For example, a user with No Access permissions for a particular
path cannot see any of the path objects displayed in the System Tree pane. A
user with Read permissions for a path can see the path objects but cannot issue
any commands because the objects are not made available.
For more information, see section 24.5 “Workspace Path, Object, and Command
Customization” on page 460.

04-30005-01-en, May 2019 System

459
24 Workspaces
24.5 Workspace Path, Object, and Command Customization

24.5 Workspace Path, Object, and

Command Customization
Software permissions limit the paths, objects, and commands that are available
in a workspace. For example, a user with No Access permissions for a particular
path cannot see any of the path objects displayed in the System Tree pane. A
user with Read permissions for a path can see the path objects but cannot issue
any commands because the objects are not made available.
For more information, see section 22.1 “Software Permissions” on page 407.
Workspaces and software permissions are linked to user account groups. User
accounts inherit the workspaces and permissions of all user account groups in
which the user account is a member. For more information, see section 22.28
“Software Permissions, User Accounts, and User Account Groups” on page
436.

System 04-30005-01-en, May 2019

460
 24 Workspaces
24.6 Workspace Content References

24.6 Workspace Content References

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

04-30005-01-en, May 2019 System

461
24 Workspaces
24.7 Creating a Workspace

24.7 Creating a Workspace

You create a customized workspace so that the WorkStation windows and
panes are tailored to meet the operational needs of a user or a user account
group.

NOTICE
You need to log off from the EcoStruxure BMS server for the changes to take
effect.

For more information, see section 24.3 “Workspace Components and

Customization” on page 456.

To create a workspace
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the Domain box, select the domain where you want to create the
workspace.
5. In the Workspaces area, click Add
Add.
6. In the Create Object dialog box, in the Name box, type a name for the
workspace.
7. In the Description box, type a description for the workspace.
8. Click Next
Next.
9. In the Workspace Configuration page, select Visible to display the
standard toolbars and menus in the workspace.
10. In the Root path (Applies to Address Bar and System Tree) box, type the
path to the folder that you want to be the root folder for the System Tree and
the Address bar.

11. Click the Add button to add panes to the workspace.

12. In the Create Object dialog box, in the object type list, select the type of
pane you want to add to the Work area.
13. In the Name box, type a name for the pane.
14. In the Description box, type a description for the pane.
15. Click Next
Next.
16. In the Pane Configuration page, in the Default dock position box, select
the location of the pane for display in the WorkStation window.
17. In the Default visibility box, select Hidden to make the pane available only
from the View menu and not open in the Work area.
18. In the Display name box, type the name to be displayed on the pane.
Continued on next page

System 04-30005-01-en, May 2019

462
 24 Workspaces
24.7 Creating a Workspace

19. In the Initial path box, enter the path to the object you want to display in the
pane.
20. Click Create
Create.
21. In the Workspace wizard, click Create
Create.

04-30005-01-en, May 2019 System

463
24 Workspaces
24.8 Editing the Layout of a Workspace

24.8 Editing the Layout of a Workspace

You edit the layout of a workspace to arrange the panes in the Work area to
meet the operational needs of a user or a user group.
For more information, see section 24.3 “Workspace Components and
Customization” on page 456.

To edit the layout of a workspace

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the Domain Control Panel, in the Domain box, select the domain the
workspace belongs to.
5. In the Workspaces box, select the workspace you want to edit.
6. Click Edit Layout
Layout.
7. In the workspace, resize the frames and adjust the dock positions of the
panes.
8. On the File menu, click Save to save and exit the layout editor.

System 04-30005-01-en, May 2019

464
 24 Workspaces
24.9 Editing the Description of a Workspace

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

To edit the description of a workspace

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

8. Click the Save button .

04-30005-01-en, May 2019 System

465
24 Workspaces
24.10 Adding a Component to a Workspace

24.10 Adding a Component to a Workspace

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

NOTICE
You need to log off from the EcoStruxure BMS server for the changes to take
effect.

For more information, see section 24.1 “Workspace Management” on page 453.

To add a component to a workspace

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the Account Management Control Panel, in the Domain box, select the
domain the workspace belongs to.
5. In the Workspaces list, select the workspace.
6. Click Content
Content.
7. Click Add
Add.
8. In the Create Object wizard, select the type of component you want to add
to the workspace.
9. In the Name box, type a name for the component.
10. In the Location box, change the location of the component you are adding
if you do not want to save the component at the default location.
11. In the Description box, type a description for the component.
12. Click Next
Next.
13. In the Default dock position box, select the dock position of the
component.
14. In the Default visibility box, select Visible to display the graphic in the
workspace.
15. In the Display name box, type the name to be displayed on the pane.
16. In the Initial path box, select the System Tree location of the component to
add to the workspace.
17. Click Create
Create.

System 04-30005-01-en, May 2019

466
 24 Workspaces
24.11 Removing a Component from a Workspace

24.11 Removing a Component from a

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

NOTICE
You need to log off from the EcoStruxure BMS server for the changes to take
effect.

For more information, see section 24.1 “Workspace Management” on page 453.

To remove a component from a workspace

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In the Domain box, select the domain the workspace belongs to.
5. In the Workspaces list, select the workspace you want to configure.
6. Click Content
Content.
7. In the Components list, select the component you want to remove from the
workspace.

8. Click the Remove button .

9. On the File menu, click Save
Save.

04-30005-01-en, May 2019 System

467
24 Workspaces
24.12 Editing a Workspace Component

24.12 Editing a Workspace Component

You edit the workspace components to adapt the usage of the workspace.

NOTICE
You need to log off from the EcoStruxure BMS server for the changes to take
effect.

For more information, see section 24.1 “Workspace Management” on page 453.

To edit a workspace component

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Account management
management.
4. In Domain Manager, in the Domain box, select the domain the workspace
belongs to.
5. In the Workspaces list, select the workspace.
6. Click Content
Content.
7. In the Content list, select the component you want to edit.

8. Click the Edit button .

9. In the properties pane, edit the workspace component properties.
10. Click OK
OK.
11. On the File menu, click Save
Save.

System 04-30005-01-en, May 2019

468
 24 Workspaces
24.13 Adding a Workspace to a User Account Group

24.13 Adding a Workspace to a User Account

Group
You add a workspace to a user account group to make the workspace available
to the users that are members of the user account group.
For more information, see section 24.3 “Workspace Components and
Customization” on page 456.

To add a workspace to a user account group

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

the user account group and click the Add button .

8. Click the Save button .

04-30005-01-en, May 2019 System

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

24.14 Removing a Workspace from a User

Account Group
You remove a workspace from a user account group so that it no longer is
available to the users belonging to the user account group.
For more information, see section 24.1 “Workspace Management” on page 453.

To remove a workspace from a user account group

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

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

System 04-30005-01-en, May 2019

470
 24 Workspaces
24.15 Reviewing the Workspace Memberships for a User Account Group

24.15 Reviewing the Workspace

Memberships for a User Account Group
You review the workspace memberships for a user account group to determine
if the user account group, for example, needs additional workspaces.
For more information, see section 24.1 “Workspace Management” on page 453.

To review the workspace memberships for a user account

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

04-30005-01-en, May 2019 System

471
24 Workspaces
24.16 Panel Components

24.16 Panel Components

You use a panel to combine different viewable windows, for example, a graphic,
trend chart, report, or another panel into a seamless view. A panel consists of
one or several panes and one work area. The panel is available through the
System Tree pane and opens as a window in the work area of the current
workspace.

Figure: Example of panel components

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

NOTICE
• A panel cannot contain a System Tree pane.
• A maximum of six levels of panels are allowed in a single pane. However, the
recommendation for a good user experience is to only use three levels.

In a graphic or in the content of a pane or work area, you can create links that
point to a panel. By using panels, you streamline the information you want to
present to the user. For example, you have a graphic that represents a room. In
the room illustration, you add a fan symbol to which you link a panel containing
panes and a work area that displays the current room airflow and temperature.
You can use a navigation pane to build a customized structure for navigation.
The navigation pane can be used in a panel. For more information, see section
24.19 “Customized Navigation” on page 475.

System 04-30005-01-en, May 2019

472
 24 Workspaces
24.17 Creating a Panel

24.17 Creating a Panel

You create panels to customize framing in a workspace. For example, panels
can display particular graphics or menus that are visible as frames in the
WorkStation Work area.
For more information, see section 24.16 “Panel Components” on page 472.

To create a panel
1. In WorkStation, in the System Tree pane, select in the folder where you
want to create the panel.
2. On the File menu, point to New and then click Panel
Panel.
3. In the Create Object wizard, in the Name box, type a name for the panel.
4. In the Description box, type a description for the panel.
5. Click Next
Next.

6. In the Panel Configuration page, click the Add button to add an

object to the panel.you add an object to the panel.
7. In the Create Object wizard, in the object type list, select the type of panel
component you want to add.
8. In the Name box, type a name for the component.
9. In the Description box, type a description for the panel component.
10. Click Next
Next.
11. In the Pane Configuration page, in the Show toolbar box, select Yes to
show the toolbar of the component.
12. In the Default dock position box, select where the component should be
located.
13. In the Default visibility box, select Visible to show the component in the
panel by default.
14. In the Display name box, type the name to be displayed on the pane.
15. In the Initial path box, enter the path to the object you are adding to the
panel.
16. Click Create
Create.
17. In the Work area initial path box, enter the initial object that displays when
viewing this panel.
18. In the Show toolbars box, select Yes to display the toolbar for the object
listed in the initial path.
19. Click Create
Create.

04-30005-01-en, May 2019 System

473
24 Workspaces
24.18 Editing a Panel

24.18 Editing a Panel

You edit the properties of the panel and the components included in the panel to
rearange its appearance.
For more information, see section 24.16 “Panel Components” on page 472.

To edit a panel
1. In WorkStation, in the System Tree pane, select the panel you want to edit.
2. On the File menu, click Properties
Properties.
3. In the Panel properties, edit the properties of the panel.
4. Click OK
OK.
5. Click Close
Close.

System 04-30005-01-en, May 2019

474
 24 Workspaces
24.19 Customized Navigation

24.19 Customized Navigation

You use the Navigation Pane to build a customized structure for navigation. The
Navigation pane can be used in a workspace or a panel.
The content of a navigation pane is a referenced menu object. The objects in a
navigation pane have the same context menus as they do in the System Tree
pane. The navigation pane is static and only displays objects that were added to
the menu object.
Navigation Pane components are not shown in WebStation in this version.

04-30005-01-en, May 2019 System

475
24 Workspaces
24.20 Customized Navigation Workflow

24.20 Customized Navigation Workflow

Use this workflow to create a customized navigation pane in a workspace or
panel.

Figure: Create a customized navigation pane flow chart

Create a menu
Create a menu object to be used in the navigation pane.
For more information, see the Creating a Menu topic on WebHelp.

Create a workspace or a panel

Create the workspace or panel where you want to add the navigation pane.
For more information, see section 24.7 “Creating a Workspace” on page 462.
For more information, see section 24.17 “Creating a Panel ” on page 473.

Add a navigation pane to the workspace or panel with the menu as

initial path
Add a navigation pane to the workspace or panel and use the menu as initial
path.
For more information, see section 24.10 “Adding a Component to a Workspace”
on page 466.
For more information, see section 24.17 “Creating a Panel ” on page 473.

System 04-30005-01-en, May 2019

476
 24 Workspaces
24.21 WebStation in Kiosk Mode

24.21 WebStation in Kiosk Mode

You can configure to run WebStation in kiosk mode when you want to limit the
users’ access to a web browser.

24.21.1 Kiosk Mode

You can display WebStation in kiosk mode with web browsers that supports
kiosk mode. Refer to the browser documentation on how to use kiosk mode.
When kiosk mode is used, the toolbar, menus, and right-click menu, are
disabled in the web browser. Most keyboard shortcuts, such as alt + F4 to close
Internet Explorer, still work.
Use the guest log on if you want the user to get immediate access to WebStation
in kiosk mode. For more information, see section 21.3 “Guest Logon in
WebStation” on page 395.

24.21.2 Remove the Toolbars from WebStation

You can remove the toolbars from WebStation in both kiosk mode and without
kiosk mode.
Use the syntax /?kiosk/ to remove all toolbars.
The text string /?kiosk/ must be placed after the server address.
For example, you want to run this SmartX server without any toolbars:
https://10.142.0.227/#%2FAutomation%20Server
You add the /?kiosk/
https://10.142.0.227/?kiosk/Automation%20Server

NOTICE
The /?kiosk/ does not configure the browser to run in kiosk mode. It only
removes the toolbars.

04-30005-01-en, May 2019 System

477
25 Audit Trails

Topics
WorkStation Account Management
Audit Trailing of User Activity
Disabling Audit Trail for a Group of Users
Enabling Audit Trail for a Group of Users
Viewing an Audit Trail Log
WorkStation Account Validation
 25 Audit Trails
25.1 WorkStation Account Management

25.1 WorkStation Account Management

As a WorkStation administrator, you can change passwords, track user
activities, validate accounts, and set up user and user and user group accounts.

25.1.1 Audit Trailing of User Activity

An audit trail tracks all actions of a user that has logged on to the system. For
example, you can view when a user logged on or off WorkStation, what
commands the user made, and if the user changed or removed an object. Not
all user actions are logged. For example, the system does not log user interface
navigation and workspace switching.
For more information, see section 25.2 “Audit Trailing of User Activity” on page
482.

25.1.2 WorkStation Account Validation

All user account information is stored centrally in the EcoStruxure Building
Operation user database, which contains information about software
permissions, user account memberships, workspaces, and domains.
For more information, see section 25.6 “WorkStation Account Validation” on
page 487.

04-30005-01-en, May 2019 System

481
25 Audit Trails
25.2 Audit Trailing of User Activity

25.2 Audit Trailing of User Activity

An audit trail tracks all actions of a user that has logged on to the system. For
example, you can view when a user logged on or off WorkStation, what
commands the user made, and if the user changed or removed an object. Not
all user actions are logged. For example, the system does not log user interface
navigation and workspace switching.
For each user action, the system logs the following information:
• User name and domain name
• Date and time of the logged action
• Path of the object that was changed
• Type of action, such as Object created
• Old values and new values
The audit trailing log shown in WorkStation is simple a filtered Event view that
shows user related events. You can limit the number of events that are shown in
the Audit trail log:
• Select a time span
• Select how many of the most recent events to view.

NOTICE
• The system retains a user's historic audit trail even if the user is deleted from
the system.
• Audit trailing is enabled by default.

Audit Trail Configuration at the User Account Group Level

Audit trailing is enabled and disabled at the user account group level in the user
account group policies. The default setting is that audit trail is enabled.
A user inherits the settings from all user account groups the user is a member of.
To activate audit trailing for a user, enable audit trailing for one of the user
account groups the user is a member of. To disable audit trail logging for a user,
you must disable audit trail logging for all user account groups that the user is a
member of.
In addition, you can enable audit trailing as a policy in a user account group.

System 04-30005-01-en, May 2019

482
 25 Audit Trails
25.2 Audit Trailing of User Activity

Figure: The Policies tab with audit trailing enabled

04-30005-01-en, May 2019 System

483
25 Audit Trails
25.3 Disabling Audit Trail for a Group of Users

25.3 Disabling Audit Trail for a Group of

Users
You disable audit trail for a group of users that do not need auditing, such as
users who can only view the objects in the system. To disable audit trail for a
user, you must disable audit trail for all user account groups the user is, directly
or indirectly, a member of. Audit trail is by default enabled.

NOTICE
• The system retains a user's historic audit trail even if the user is deleted from
the system.
• Audit trailing is enabled by default.

For more information, see section 25.2 “Audit Trailing of User Activity” on page
482.

To disable audit trail for a group of users

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

8. Click the Save button .

System 04-30005-01-en, May 2019

484
 25 Audit Trails
25.4 Enabling Audit Trail for a Group of Users

25.4 Enabling Audit Trail for a Group of

Users
You enable audit trail for a group of users to be able to trace their actions and
activities. To enable audit trail for a user, it is enough that audit trail is enabled
for one of the user account groups the user is a member of. The feature is by
default enabled.
For more information, see section 25.2 “Audit Trailing of User Activity” on page
482.

To enable audit trail for a group of users

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

8. Click the Save button .

04-30005-01-en, May 2019 System

485
25 Audit Trails
25.5 Viewing an Audit Trail Log

25.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 25.2 “Audit Trailing of User Activity” on page
482.

To view an audit trail log

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

System 04-30005-01-en, May 2019

486
 25 Audit Trails
25.6 WorkStation Account Validation

25.6 WorkStation Account Validation

All user account information is stored centrally in the EcoStruxure Building
Operation user database, which contains information about software
permissions, user account memberships, workspaces, and domains.

Account Validation
When you log on to WorkStation you have to quote your user name and
password together with the domain and EcoStruxure BMS server you want to log
on to. The EcoStruxure Building Operation software confirms that you are using
a valid user account and verifies that correct password is used. The EcoStruxure
Building Operation software also authenticates access to workspaces
associated with your user account group memberships. After validation, the
EcoStruxure Building Operation software retrieves your software permissions
and stores them in a user token, valid for this log on session.

NOTICE
User name, password, and domain name are case sensitive.

WorkStation User Token

A user token remains active as long as you are logged onto WorkStation. Any
changes to your software permissions during your current sessions take effect
the next time you log on.

04-30005-01-en, May 2019 System

487
26 User Management User
Interface

Topics
User Management System Tree Icons
Domain Properties
Profile Properties
Workspace Properties
Pane Properties
Panel Properties
Navigation Pane
Building Operation WorkStation Window
Domain Control Panel
Edit Permissions Dialog Box
Account Management Control Panel
Select Default Workspace Window
Change Password Dialog Box
Domain Wizard – Authentication Page
Domain Wizard – Domain Members Page
Domain Wizard – Domain Policies Page
Domain – Summary Tab
Domain – Policies Tab
26 Domain – Domain Members Tab
User Account – Summary Tab
User Account – Group Membership Tab
User Account – Profile Tab
User Account – Software Permissions Tab
User Account – Audit Trailing Events Tab
User Account Group Properties
User Account Properties
Guest Account Properties
User Account Group Wizard – Users Belonging to this Group
Page
User Account Group Wizard – Workspaces Belonging to this
Group Page
User Account Group Wizard – Windows Group Name and
Group Policies Page
User Account Group – Summary Tab
User Account Group – Policies Tab
User Account Group – Group Membership Tab
User Account Group – Software Permissions Tab
User Account Group – Workspaces Tab
User Account Wizard – General Page
User Account Wizard – Member Of Page
User Account Management Folder Properties
Workspace Wizard – Workspace Configuration Page
Workspace Wizard – Pane Configuration Page
Workspace – Summary Tab
Workspace – Content Tab
Workspace – Members Tab
Edit Layout Workspace
Panel Wizard – Panel Configuration Page
26 Domains Properties
Local Properties
Work Area Window Properties
Create Work Area Window Wizard – Name Page
Windows User Group Dialog Box
 26 User Management User Interface
26.1 User Management System Tree Icons

26.1 User Management System Tree Icons

Use the User Management System Tree icons to get information on the objects
in the System Tree pane.

Table: User Management Icons

Icon Description

Panel
Indicates the object is a panel. For more
information, see section 24.16 “Panel
Components” on page 472.

Folder of User Accounts

Indicates that the folder contains user
accounts. For more information, see
section 19.3 “User Accounts and User
Account Groups” on page 357.

User Account
Indicates that the object is a user account.
For more information, see section 19.3
“User Accounts and User Account
Groups” on page 357.

Domain
Indicates that the object is a domain. For
more information, see section 21.1
“Domains” on page 391.

User Account Groups

Indicates that the object is a user account
group. For more information, see section
19.3 “User Accounts and User Account
Groups” on page 357.

Workspace
Indicates that the object is a workspace.
For more information, see section 24.1
“Workspace Management” on page 453.

04-30005-01-en, May 2019 System

493
26 User Management User Interface
26.2 Domain Properties

26.2 Domain Properties

Use the Domain properties to configure the properties of a domain.

Figure: Domain properties

Table: Domain Properties

Component Description

Maximum logon attempts Select the maximum number of failed

logon attempts that a user can make
before WorkStation is temporarily locked.

Password Type the password EcoStruxure BMS

servers internally use to enhance the
EcoStruxure BMS server communication
security in the domain.

Confirm Password Type the password EcoStruxure BMS

servers internally use to enhance the
EcoStruxure BMS server communication
security in the domain.

System 04-30005-01-en, May 2019

494
 26 User Management User Interface
26.2 Domain Properties

Continued
Component Description

Windows domain name Type the name of the Windows domain

where the Windows Active directory is
located from which you want to map user
account groups. For more information, see
section 20.1 “Windows Active Directory
User Groups” on page 375.

04-30005-01-en, May 2019 System

495
26 User Management User Interface
26.3 Profile Properties

26.3 Profile Properties

Use the Profile properties to edit the information about the user the account
belongs to.

Figure: Profile properties

Table: Profile Properties

Component Description

First name Type the first name of the user.

Middle name Type the middle name of the user.

Last name Type the last name of the user.

Home email address Type the email address of the user.

Work email address Type the work email address of the user.

System 04-30005-01-en, May 2019

496
 26 User Management User Interface
26.4 Workspace Properties

26.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 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
Click to edit a workspace pane. For more
information, see section 26.5 “Pane
Properties” on page 499.

Remove
Click to remove a workspace pane.

Menu Select Visible to show the menu in the

workspace.

04-30005-01-en, May 2019 System

497
26 User Management User Interface
26.4 Workspace Properties

Continued
Component Description

Toolbar Select Visible to show the toolbar in the

workspace.

Address bar Select Visible to show the address bar in

the workspace.

Status bar Select Visible to show the status bar in the

workspace.

Search bar Select Visible to show the search bar in the

workspace.

History bar Select Visible to show the history bar in the

workspace.

Root path Enter the path for the workspace

component.

System 04-30005-01-en, May 2019

498
 26 User Management User Interface
26.5 Pane Properties

26.5 Pane Properties

Use the Pane properties to configure the settings of the pane.

Figure: Pane properties

Table: Pane Properties

Component Description

Show toolbar Select Yes to show the toolbars for the

pane component.

Default dock position Select where to place the pane in the

workspace.

Default visibility Select Hidden to hide the pane.

Dipslay name Type the pane name that is to be

displayed. Display name is available only
in Workstation.

Initial path Enter the path to the pane component.

04-30005-01-en, May 2019 System

499
26 User Management User Interface
26.6 Panel Properties

26.6 Panel Properties

Use the Panel properties to configure the properties of a panel.

Figure: Panel properties

Table: Panel Properties

Component Description

Work area initial path Enter the path, for example a graphical
link, that points to the panel.

Show toolbars Select Yes to show the toolbars of the

panel.

Add
Click to add a pane component to the
panel. For more information, see section
53.28 “Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
Click to edit a pane component. For more
information, see section 26.5 “Pane
Properties” on page 499.

System 04-30005-01-en, May 2019

500
 26 User Management User Interface
26.6 Panel Properties

Continued
Component Description

Remove
Click to remove a panel component.

04-30005-01-en, May 2019 System

501
26 User Management User Interface
26.7 Navigation Pane

26.7 Navigation Pane

Use the Navigation pane to create a customized structure for navigation.

Figure: Navigation pane

Table: Navigation Pane

Component Description

Displays menus and sub menus in the

navigation structure.

System 04-30005-01-en, May 2019

502
 26 User Management User Interface
26.8 Building Operation WorkStation Window

26.8 Building Operation WorkStation Window

Use the Building Operation WorkStation window to log on to WorkStation.

Figure: Building Operation WorkStation

Table: Building Operation WorkStation

Component Description

User name Type the user name of your EcoStruxure

Building Operation user account. For more
information, see section 19.3 “User
Accounts and User Account Groups” on
page 357.

Password Type the password of your EcoStruxure

Building Operation user account or of your
Windows user account.

04-30005-01-en, May 2019 System

503
26 User Management User Interface
26.8 Building Operation WorkStation Window

Continued
Component Description

Domain Type the name of the EcoStruxure Building

Operation domain that you want to log on
to. If you do not enter a domain, you are
logged on to the local domain. For more
information, see section 21.1 “Domains” on
page 391.

Server Select the Server hypertext transfer

protocol option for communication with the
EcoStruxure BMS server.
Enter an EcoStruxure BMS server name or
an IP address for the EcoStruxure BMS
server you want to log on to.

Log on as Click to log on to WorkStation with your

Windows user account. For more
information, see section 19.3 “User
Accounts and User Account Groups” on
page 357.

Remember me on this computer Select to save the entered information. The

information is automatically filled in the
next time you log on.

Log on Click to log on to WorkStation.

Click here to learn more about Building Click to open the WebHelp home page.
Operation For more information, see the WebHelp
Overview topic on WebHelp.

System 04-30005-01-en, May 2019

504
 26 User Management User Interface
26.9 Domain Control Panel

26.9 Domain Control Panel

Use the Domain Control Panel to create and configure domains.

Table: Domain Control Panel

Component Description

Server Displays the EcoStruxure BMS server that

acts as domain controller.

Domains Select a domain to edit.

Add Click to create a new domain. For more

information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.

Delete Click to delete a domain.

List domains Click to view all domains in the List View.

Unit Conversion Exceptions Click to enter unit conversion exceptions

for the selected domain.

Account management Click to open the Account Management

Control Panel. For more information, see
section 26.11 “Account Management
Control Panel” on page 508.

Summary Click to open the Summary tab for the

domain. For more information, see section
26.17 “Domain – Summary Tab” on page
517.

Policies Click to open the Policies tab where you

edit the policies of the domain. For more
information, see section 26.18 “Domain –
Policies Tab” on page 518.

Domain members Click to open the Domain members tab

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

04-30005-01-en, May 2019 System

505
26 User Management User Interface
26.10 Edit Permissions Dialog Box

26.10 Edit Permissions Dialog Box

Use the Edit Permissions dialog box to grant or limit the permissions users or
user groups have to a path.

Figure: Edit Permissions dialog box

Table: Edit Permissions Dialog Box

Component Description

Path Displays the path of the selected object.

Quick filter Use the quick filter to filter on the user or

user group whose permissions you want to
configure or on a specific path permission.
For more information, see section 52.4
“Quick Filter ” on page 1512.

Name Select the user account or user account

group whose path permissions you want to
configure.

Permission Select the specific path permissions. For

more information, see section 22.29
“Software Permissions Rules
Management” on page 438.

Account type: Users Select the user account whose path

permission you want to configure.

Account type: Groups Select the user account group whose path
permission you want to configure.

System 04-30005-01-en, May 2019

506
 26 User Management User Interface
26.10 Edit Permissions Dialog Box

Continued
Component Description

Add users and groups Click to open the Users and Groups dialog
box where you select the user accounts or
user account groups that you want to grant
permissions or whose permissions you
want to limit. For more information, see
section 35.82 “Users and Groups Dialog
Box” on page 997.

04-30005-01-en, May 2019 System

507
26 User Management User Interface
26.11 Account Management Control Panel

26.11 Account Management Control Panel

Use the Account Management Control Panel to create and configure user
account groups, user accounts, and workspaces.

Figure: Account management control panel

Table: Account Management Control Panel

Component Description

Server Displays the selected EcoStruxure BMS

server.

Domain Select a domain. The domain you logged

onto is the default domain.

User Accounts Select a user account.

Add (user account) Click to add a new user account. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.

Delete (user account) Click to delete a user account. For more

information, see section 53.37 “Confirm
Delete Dialog Box” on page 1602.

List users Click to open the user accounts list view

where you can select a user account. For
more information, see the List View topic
on WebHelp.

System 04-30005-01-en, May 2019

508
 26 User Management User Interface
26.11 Account Management Control Panel

Continued
Component Description

Summary (user account) Click to open the user accounts Summary

tab with information about the user
account, such as expiration date an the
password for the user account. For more
information, see section 26.20 “User
Account – Summary Tab” on page 520.

Group membership (user account) Click to open the Group Membership tab
where you can edit the group membership
of the selected user account. For more
information, see section 26.21 “User
Account – Group Membership Tab” on
page 521.

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
26.23 “User Account – Software
Permissions Tab” on page 524.

Audit trailing events Click to open the Audit Trailing Events tab
where you can view the user triggered
events for the selected user account. For
more information, see section 26.24 “User
Account – Audit Trailing Events Tab” on
page 525.

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 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Delete (user account group) Click to delete a user account group. For
more information, see section 53.37
“Confirm Delete Dialog Box” on page
1602.

List groups (user account groups) Click to open the user account groups list
view where you can select a user account
group. For more information, see the List
View topic on WebHelp.

Summary (user account groups) Click to open the user account groups
Summary tab where you can edit the
description of the group. For more
information, see section 26.31 “User
Account Group – Summary Tab” on page
537.

04-30005-01-en, May 2019 System

509
26 User Management User Interface
26.11 Account Management Control Panel

Continued
Component Description

Group membership (user account groups) Click to open the Group Membership tab
where you can edit the groups
membership in other groups, and add and
remove user accounts. For more
information, see section 26.33 “User
Account Group – Group Membership Tab”
on page 539.

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 26.34 “User
Account Group – Software Permissions
Tab” on page 541.

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 26.35 “User
Account Group – Workspaces Tab” on
page 543.

Policies Click to open the Policies tab where you

can edit the policies of the user account
group. For more information, see section
26.32 “User Account Group – Policies Tab”
on page 538.

Workspaces Select a workspace.

Add (workspaces) Click to add a new workspace. For more

information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.

Delete (workspaces) Click to delete a workspace. For more

information, see section 53.37 “Confirm
Delete Dialog Box” on page 1602.

List workspaces Click to open the Workspace menu where

you can select a workspace. For more
information, see the List View topic on
WebHelp.

Summary (workspaces) Click to open the workspace Summary tab

where you can edit the description of the
workspace. For more information, see
section 26.41 “Workspace – Summary
Tab” on page 551.

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 26.43 “Workspace – Members
Tab” on page 554.

System 04-30005-01-en, May 2019

510
 26 User Management User Interface
26.11 Account Management Control Panel

Continued
Component Description

Content Click to open the Content tab where you

edit the content of the workspace. For
more information, see section 26.42
“Workspace – Content Tab” on page 552.

Edit layout Click to open the view where you edit the
layout of the workspace. For more
information, see section 26.44 “Edit Layout
Workspace” on page 555.

04-30005-01-en, May 2019 System

511
26 User Management User Interface
26.12 Select Default Workspace Window

26.12 Select Default Workspace Window

Use the Select Default Workspace window to select the workspace you want to
open by default when you log on to WorkStation.

Figure: Select default workspace window

Table: Select Default Workspace Window

Component Description

Select Default Workspace Select a default workspace in the list of

workspaces available to you.

System 04-30005-01-en, May 2019

512
 26 User Management User Interface
26.13 Change Password Dialog Box

26.13 Change Password Dialog Box

Use the Change Password dialog box to change your password.

Figure: Change Password dialog box

Table: Change Password Dialog Box

Component Description

Old password Type your old password.

New password Type your new password.

Confirm password Type your new password again.

04-30005-01-en, May 2019 System

513
26 User Management User Interface
26.14 Domain Wizard – Authentication Page

26.14 Domain Wizard – Authentication Page

Use the Authentication page to map the EcoStruxure Building Operation
domain to a Windows Active Directory domain.

Figure: Authentication page

Table: Authentication Page

Component Description

Windows domain name Type the name of the Windows domain

where the Windows Active directory is
located from which you want to map user
account groups. For more information, see
section 20.1 “Windows Active Directory
User Groups” on page 375.

System 04-30005-01-en, May 2019

514
 26 User Management User Interface
26.15 Domain Wizard – Domain Members Page

26.15 Domain Wizard – Domain Members

Page
Use the Domain Members page to add SmartX server to the domain.

Figure: Domain members page

Table: Domain Members Page

Component Description

Available Servers List of all available SmartX servers.

Servers that are members of this Domain List of all SmartX servers in the domain.

Add All
Click to add all available SmartX servers to
the domain.

Add
Click to add a SmartX server to the
domain.

Remove
Click to remove a SmartX server from the
domain.

Remove All
Click to remove all SmartX server from the
domain.

04-30005-01-en, May 2019 System

515
26 User Management User Interface
26.16 Domain Wizard – Domain Policies Page

26.16 Domain Wizard – Domain Policies Page

Use the Domain Policies page to enter domain polices that are applicable to all
user accounts in the domain.

Figure: Domain policies page

Table: Domain Policies page

Component Description

Maximum logon attempts Select the maximum number of failed

logon attempts that a user can make
before WorkStation is temporarily locked.

System 04-30005-01-en, May 2019

516
 26 User Management User Interface
26.17 Domain – Summary Tab

26.17 Domain – Summary Tab

Use the Summary tab to edit the description and domain controller password for
a domain.

Figure: Summary tab

Table: Summary Tab

Component Description

Description Type a description of the object.

Windows domain name Type the name of the Windows domain

where the Windows Active directory is
located from which you want to map user
account groups. For more information, see
section 20.1 “Windows Active Directory
User Groups” on page 375.

Domain Controller Displays the path and name of the domain

controller.

04-30005-01-en, May 2019 System

517
26 User Management User Interface
26.18 Domain – Policies Tab

26.18 Domain – Policies Tab

Use the Policies tab to edit the policies for the domain. For example, the number
of failed logon attempts a user can make before the account is temporarily
locked.

Figure: Policies tab

Table: Policies tab

Component Description

Maximum logon attempts Enter the maximum number of failed logon

attempts a user can make before the
user´s account is temporarily locked.

System 04-30005-01-en, May 2019

518
 26 User Management User Interface
26.19 Domain – Domain Members Tab

26.19 Domain – Domain Members Tab

Use the Domain Members tab to add and remove EcoStruxure BMS servers to
and from the domain.

Figure: Domain members tab

Table: Domain Members Tab

Component Description

Available Servers List of all available EcoStruxure BMS

servers.

Servers that are members of this Domain List of all EcoStruxure BMS servers in the
domain.

Add All
Click to add all available EcoStruxure BMS
servers to the domain.

Add
Click to add an EcoStruxure BMS server to
the domain.

Remove
Click to remove an EcoStruxure BMS
server from the domain.

Remove All
Click to remove all EcoStruxure BMS
servers from the domain.

04-30005-01-en, May 2019 System

519
26 User Management User Interface
26.20 User Account – Summary Tab

26.20 User Account – Summary Tab

Use the Summary tab to edit the basic settings for a user account. For example,
you can enable or disable the user account, or change the password for the
account.

Figure: Summary tab

Table: Summary Tab

Component Description

Expires on Enter an expiration date and time for the

user account. By default, there is no
expiration date for the account.

Disabled Select True to disable the user account.

Force password change Select True to force the user to change

password after the initial logon.

Password Type the password again.

Confirm password Type the password again.

System 04-30005-01-en, May 2019

520
 26 User Management User Interface
26.21 User Account – Group Membership Tab

26.21 User Account – Group Membership Tab

Use the Group Membership tab to edit the group membership settings for a
user account.

Figure: Group membership tab

Table: Group Membership Tab

Component Description

Available User Account Groups Lists available user account groups the
account can be a member of.

Selected User Account Groups Lists the user account groups the account
is a member of.

Add all
Click to connect all available user account
groups to the user account.

Add
Click to connect a user account group to
the user account.

04-30005-01-en, May 2019 System

521
26 User Management User Interface
26.21 User Account – Group Membership Tab

Continued
Component Description

Remove
Click to remove a user account group from
the user account.

Remove all
Click to remove all user account groups
from the user account.

Workspace Workspaces the user account has access

to.

Owner The user account groups a workspace is a

member of.

System 04-30005-01-en, May 2019

522
 26 User Management User Interface
26.22 User Account – Profile Tab

26.22 User Account – Profile Tab

Use the Profile tab to edit the information about the user the account belongs to.

Figure: Profile tab

Table: Profile Tab

Component Description

First name Type the first name of the user.

Middle name Type the middle name of the user.

Last name Type the last name of the user.

Home email address Type the email address of the user.

Work email address Type the work email address of the user.

04-30005-01-en, May 2019 System

523
26 User Management User Interface
26.23 User Account – Software Permissions Tab

26.23 User Account – Software Permissions

Tab
Use the Software Permissions tab to enter individual path permissions for a
user account.

NOTICE
• To simplify the task of administering software permissions, it is
recommended that you assign software permissions to user account groups
rather than user accounts.

Figure: Software permissions tab

Table: Software Permissions Tab

Component Description

Add
Click to add a path to the list of paths the
user account can access.

Delete
Click to remove a path from the list of paths
the user account group can access. For
more information, see section 53.37
“Confirm Delete Dialog Box” on page
1602.

Path The paths the user account has access to.

Permission Click to assign a permission level to a path

you have selected. For more information,
see section 22.29 “Software Permissions
Rules Management” on page 438.

Owner The owner of the path the user account has

access to. Owner can be one or more user
account groups the user account is a
member of or the user account.

System 04-30005-01-en, May 2019

524
 26 User Management User Interface
26.24 User Account – Audit Trailing Events Tab

26.24 User Account – Audit Trailing Events

Tab
Use the Audit Trailing Events tab to monitor the events triggered by the actions
of a user.

Figure: Audit trailing events tab

Table: Audit Trailing Events Tab

Component Description

Pause
Click to pause the reading of events.

Event filter
Click to select the conditions for the event
display. For more information, see the
Select Conditions Dialog Box – Events
Filter Properties topic on WebHelp.

Favorites
Click to open the Favorites menu where
you select, add, and manage favorites.
For more information, see the Favorites
Menu topic on WebHelp.

Click to open the event time filter where

you select the time and date period for the
events you want to display.
For more information, see section 36.10
“Applying an Event Time Filter” on page
1079.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

04-30005-01-en, May 2019 System

525
26 User Management User Interface
26.25 User Account Group Properties

26.25 User Account Group Properties

Use the User Account Group properties dialog box to configure the properties
of a user account group.

Figure: User account group properties

Table: User Account Group Properties

Component Description

Allow members to close WorkStation Select to let users log off and close
WorkStation.

Log user actions of group members Select to enable audit trailing for users
belonging to this group.

Allow members to access Automation Select to enable users to access the Web
Server Web Configuration Configuration where you configure the
settings of an Automation Server.

Allow members to access security Select to enable users to access security

configuration configuration.

System 04-30005-01-en, May 2019

526
 26 User Management User Interface
26.25 User Account Group Properties

Continued
Component Description

Windows group name Select the Windows Active Directory user

account group that you want to map to this
EcoStruxure Building Operation user
account group. For more information, see
section 20.1 “Windows Active Directory
User Groups” on page 375.

Automatic logoff inactivity time Select the time the logged on user account
can be idle before it is automatically
logged off from WorkStation.

Log off to guest account Select to automatically log on to the guest

account when a user that belongs to the
user account group is manually or
automatically logged off from WorkStation.
For more information, see section 19.15
“Automatic Logoff to Guest Account” on
page 371.

04-30005-01-en, May 2019 System

527
26 User Management User Interface
26.26 User Account Properties

26.26 User Account Properties

Use the User Account properties dialog box to configure the properties of a
user account.

Figure: User account properties

Table: User Account Properties

Component Description

Click to create a new user profile. For more

information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.

Click to edit a user profile. For more

information, see section 26.3 “Profile
Properties” on page 496.

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.

System 04-30005-01-en, May 2019

528
 26 User Management User Interface
26.26 User Account Properties

Continued
Component Description

Password Type the password again.

Confirm Password Type the password again.

Expires on Enter an expiration date and time for the

user account. By default, there is no
expiration date for the account.

Password never expires Select True to disable password's

expiration date.

System of measurement Displays the system of measurement for

the user account.

04-30005-01-en, May 2019 System

529
26 User Management User Interface
26.27 Guest Account Properties

26.27 Guest Account Properties

Use the Guest Account Properties dialog box to view or edit the properties of
the user account.

Figure: Guest Account Properties

Table: Guest Account Properties

Property Description

Add
Click to add a user profile to the user
account. For more information, see section
19.3 “User Accounts and User Account
Groups” on page 357.

Edit
Click to edit the selected user profile. For
more information, see section 19.3 “User
Accounts and User Account Groups” on
page 357.

System 04-30005-01-en, May 2019

530
 26 User Management User Interface
26.27 Guest Account Properties

Continued
Property Description

Remove
Click to remove the selected user profile.
For more information, see section 19.3
“User Accounts and User Account
Groups” on page 357.

Expires on Enter the date and time the Guest user

account is to expire.

Disabled Select True to disable the Guest user

account.

System of measurement Select the measurement system to be used

when the Guest user account is logged on.
For more information, see section 16.9
“Changing the WorkStation Measurement
System” on page 302.

04-30005-01-en, May 2019 System

531
26 User Management User Interface
26.28 User Account Group Wizard – Users Belonging to this Group Page

26.28 User Account Group Wizard – Users

Belonging to this Group Page
Use the Users Belonging to this Group page to add users to the group.

Figure: Users belonging to this group page

Table: Users Belonging to this Group Page

Component Description

Available User Accounts Lists available user accounts.

Selected User Accounts Lists user accounts that are members of

the user account group.

Add all
Click to add all user accounts to the user
account group.

Add
Click to add a user account to the user
account group.

Remove
Click to remove a user account from the
user account group.

Remove all
Click to remove all user accounts from the
user account group.

System 04-30005-01-en, May 2019

532
 26 User Management User Interface
26.29 User Account Group Wizard – Workspaces Belonging to this Group Page

26.29 User Account Group Wizard –

Workspaces Belonging to this Group
Page
Use the Workspaces Belonging to this Group page to add workspaces to the
group.

Figure: Workspaces belonging to this group page

Table: Workspaces Belonging to this Group Page

Component Description

Select from Select a user account group with

workspaces you want to include in the user
account group.

Selected Workspaces Lists available workspaces.

Available Workspaces Lists the workspaces that are added to the

user account group.

Add all
Click to add all available workspaces to
the user account group.

Add
Click to add a workspace to the user
account group.

Remove
Click to remove a workspace from the user
account group.

04-30005-01-en, May 2019 System

533
26 User Management User Interface
26.29 User Account Group Wizard – Workspaces Belonging to this Group Page

Continued
Component Description

Remove all
Click to remove all workspaces from the
user account group.

System 04-30005-01-en, May 2019

534
 26 User Management User Interface
26.30 User Account Group Wizard – Windows Group Name and Group Policies Page

26.30 User Account Group Wizard – Windows

Group Name and Group Policies Page
Use the Windows Group Name and Group Policies page to map a Windows
Active Directory and enter policies for the group.

Figure: Windows group name and group policies page

Table: Windows Group Name and Group Policies Page

Component Description

User interactivity Select to let users log off and close

WorkStation.

Audit trailing Select to enable audit trailing for users

belonging to this group.

Password Select to allow members of this user

account group to change their password.
Not applicable if the user account group is
mapped to a Windows Active Directory
user account group.

Web configuration Select to enable users to access the Web

Configuration where you configure the
settings of a SmartX server. For more
information, see the SmartX Server Device
Configuration in WebStation topic on
WebHelp.

Automatic logoff Select to log off users in this group after a

defined time of inactivity. For more
information, see section 19.12 “Automatic
Logoff” on page 368.

04-30005-01-en, May 2019 System

535
26 User Management User Interface
26.30 User Account Group Wizard – Windows Group Name and Group Policies Page

Continued
Component Description

On logoff switch to guest account Select to logoff users in this group to the
guest account after a defined time of
inactivity. For more information, see
section 19.15 “Automatic Logoff to Guest
Account” on page 371.

Windows group name Select the Windows Active Directory user

account group that you want to map to this
EcoStruxure Building Operation user
account group. For more information, see
section 20.1 “Windows Active Directory
User Groups” on page 375.

System 04-30005-01-en, May 2019

536
 26 User Management User Interface
26.31 User Account Group – Summary Tab

26.31 User Account Group – Summary Tab

Use the Summary tab to edit the description of a user account group.

Figure: Summary tab

Table: Summary Tab

Component Description

Description Type a description of the object.

Windows Domain Displays the name of the Windows domain

this user account group is mapped to.

Windows group name Select the Windows Active Directory user

account group that you want to map to this
EcoStruxure Building Operation user
account group. For more information, see
section 20.1 “Windows Active Directory
User Groups” on page 375.

04-30005-01-en, May 2019 System

537
26 User Management User Interface
26.32 User Account Group – Policies Tab

26.32 User Account Group – Policies Tab

Use the Policies tab to edit the policy settings for a user account group.

Figure: Policies tab

Table: Policies Tab

Component Description

Allow members to close WorkStation Select to let users log off and close
WorkStation.

Log user actions of group members Select to enable audit trailing for users
belonging to this group.

Allow members to change password Select to enable users to change their

passwords.

Allow members to access Automation Select to enable users to access the Web
Server Web Configuration Configuration where you configure the
settings of a SmartX server. For more
information, see the SmartX Server Device
Configuration in WebStation topic on
WebHelp.

Automatic logoff Select to log off users in this group after a

defined time of inactivity. For more
information, see section 19.12 “Automatic
Logoff” on page 368.

On logoff switch to guest account Select to logoff users in this group to the
guest account after a defined time of
inactivity. For more information, see
section 19.15 “Automatic Logoff to Guest
Account” on page 371.

System 04-30005-01-en, May 2019

538
 26 User Management User Interface
26.33 User Account Group – Group Membership Tab

26.33 User Account Group – Group

Membership Tab
Use the Group Membership tab to edit the group membership settings of a user
account group.

Figure: Group membership tab

Table: Group Membership Tab

Component Description

Available User Accounts Lists available user accounts that can be

added to the user account group.

Selected User Accounts Lists user accounts that have been added
to the user account group.

Available User Account Groups Lists user account groups that can be
added to the user account group.

Selected User Account Groups Lists user account groups that have been
added to the user account group.

04-30005-01-en, May 2019 System

539
26 User Management User Interface
26.33 User Account Group – Group Membership Tab

Continued
Component Description

Add all
Click to add all available user accounts or
user account groups to the list of selected
user accounts or user account groups.

Add
Click to add the user account or user
account group to the list of selected user
accounts or user account groups.

Remove
Click to remove the user account or user
account group from the list of selected
user accounts or user account groups.

Remove all
Click to remove all user accounts or user
account groups from the list of selected
user accounts or user account groups.

System 04-30005-01-en, May 2019

540
 26 User Management User Interface
26.34 User Account Group – Software Permissions Tab

26.34 User Account Group – Software

Permissions Tab
Use the Software Permissions tab to add software permissions to a user
account group by adding paths and assigning command permissions to the
group.

Figure: Software permissions tab

Table: Software Permissions Tab

Component Description

Add
Click to add a path to the list of paths the
user account group can access.

Add System
Click to add the the system's top level
path.

04-30005-01-en, May 2019 System

541
26 User Management User Interface
26.34 User Account Group – Software Permissions Tab

Continued
Component Description

Delete
Click to remove a path from the list of paths
the user account group can access. For
more information, see section 53.37
“Confirm Delete Dialog Box” on page
1602.

Path Displays the paths that have been defined

for the user account group.

Permission Select a permission level for the path. For

more information, see section 22.29
“Software Permissions Rules
Management” on page 438.

Owner Displays the user account group the path

has been added to.

Category Click a category to display the commands

included in the category.

Command Displays all commands for the category.

Permission Select a permission level for a command.

Command Displays all commands that are available

to the user account group members.

Permission Select a permission level for the command.

Owner Displays the user account groups the

commands have been added to.

System 04-30005-01-en, May 2019

542
 26 User Management User Interface
26.35 User Account Group – Workspaces Tab

26.35 User Account Group – Workspaces Tab

Use the Workspaces tab to edit the workspace membership settings for a user
account group.

Figure: Workspaces tab

Table: Workspaces Tab

Component Description

Available Workspaces Lists workspaces that are available to add

to the user account group.

Selected Workspaces Lists workspaces that are available to add

to the user account group.

Add all
Click to add all available workspaces to
the user account group.

Add
Click to add a workspace to the user
account group.

Remove
Click to remove a workspace from the user
account group.

Remove all
Click to remove all workspaces from the
user account group.

04-30005-01-en, May 2019 System

543
26 User Management User Interface
26.36 User Account Wizard – General Page

26.36 User Account Wizard – General Page

Use the General page to enter information about the user the account belongs
to, and a password for the account.

Figure: General page

Table: General Page

Component Description

First name Type the first name of the user.

Middle name Type the middle name of the user.

Last name Type the last name of the user.

Home email address Type the email address of the user.

Work email address Type the work email address of the user.

Expires on Enter an expiration date and time for the

user account. By default, there is no
expiration date for the account.

Password Type the password.

Confirm Password Type the password again.

System 04-30005-01-en, May 2019

544
 26 User Management User Interface
26.37 User Account Wizard – Member Of Page

26.37 User Account Wizard – Member Of

Page
Use the Member Of page to make the user account a member of an existing
user account group.

Figure: Member of page

Table: Member of Page

Component Description

Select from Select a user account that is member of

the user account group you want to
connect your user account.

Available User Accounts Groups Lists available user account groups.

Selected User Accounts Groups Lists user account groups that are
connected to the user account group.

Add all
Click to add all user account groups to the
user account.

Add
Click to add a user account group to the
user account.

Remove
Click to remove a user account group from
the user account.

04-30005-01-en, May 2019 System

545
26 User Management User Interface
26.37 User Account Wizard – Member Of Page

Continued
Component Description

Remove all
Click to remove all user account groups
from the user account.

System 04-30005-01-en, May 2019

546
 26 User Management User Interface
26.38 User Account Management Folder Properties

26.38 User Account Management Folder

Properties
Use the User Account Management Folder Properties view or dialog box to
configure and view the general and object-reference properties. For more
information, see section 53.39 “General Information Properties – Basic Tab” on
page 1604.

Figure: User Account management folder properties

04-30005-01-en, May 2019 System

547
26 User Management User Interface
26.39 Workspace Wizard – Workspace Configuration Page

26.39 Workspace Wizard – Workspace

Configuration Page
Use the Workspace configuration page to add, edit, and remove workspace
components.

Figure: Workspace configuration page

Table: Workspace Configuration Page

Component Description

Menu Select Visible to show the menu in the

workspace.

Address bar Select Visible to show the address bar in

the workspace.

Search bar Select Visible to show the search bar in the

workspace.

Toolbar Select Visible to show the toolbar in the

workspace.

Status bar Select Visible to show the status bar in the

workspace.

History bar Select Visible to show the history bar in the

workspace.

Root path (Applies to Address Bar and Enter the path to the workspace
System Tree) component.

System 04-30005-01-en, May 2019

548
 26 User Management User Interface
26.39 Workspace Wizard – Workspace Configuration Page

Continued
Component Description

Listed components Lists the standard components included in

the workspace. Select a component and
click the Add
Add, Edit or Remove button.

Click to add a new component to the

workspace. For more information, see
section 53.28 “Create Object Wizard –
Naming the Object Page” on page 1590.

Click to edit a component. The workspace

properties pane is displayed. For more
information, see section 26.5 “Pane
Properties” on page 499.

Click to remove a component.

04-30005-01-en, May 2019 System

549
26 User Management User Interface
26.40 Workspace Wizard – Pane Configuration Page

26.40 Workspace Wizard – Pane

Configuration Page
Use the Pane configuration page to determine the layout of the component you
are adding to the workspace.

Figure: Pane configuration page

Table: Pane Configuration Page

Component Description

Show toolbar Select No to hide the component toolbar.

Default dock position Select a default dock position in the

workspace for the component.

Default visibility Select Hidden to hide the component.

Display name Type the pane name that is to be

displayed. Display name is available only
in WorkStation.

Initial path Click to change the location of the

component. For more information, see
section 26.39 “Workspace Wizard –
Workspace Configuration Page” on page
548.

System 04-30005-01-en, May 2019

550
 26 User Management User Interface
26.41 Workspace – Summary Tab

26.41 Workspace – Summary Tab

Use the Summary tab to edit the description of the workspace.

Figure: Summary tab

Table: Summary Tab

Component Description

Name Displays the name of the workspace.

Description Displays the description of the workspace.

Location Displays the location of the workspace.

04-30005-01-en, May 2019 System

551
26 User Management User Interface
26.42 Workspace – Content Tab

26.42 Workspace – Content Tab

Use the Content tab to edit the content and layout of a workspace.

Figure: Content tab

Table: Content Tab

Component Description

Menu Select Visible to show the menu in the

workspace.

Address bar Select Visible to show the address bar in

the workspace.

Search bar Select Visible to show the search bar in the

workspace.

Toolbar Select Visible to show the toolbar in the

workspace.

Status bar Select Visible to show the status bar in the

workspace.

History bar Select Visible to show the history bar in the

workspace.

Root path (Applies to Address Bar and Displays the path to the basic node of the
System Tree) workspace. For more information, see
section 24.6 “Workspace Content
References” on page 461.

System 04-30005-01-en, May 2019

552
 26 User Management User Interface
26.42 Workspace – Content Tab

Continued
Component Description

Add
Click to open the Create Object Wizard,
where you add a new component to the
workspace. For more information, see
section 53.28 “Create Object Wizard –
Naming the Object Page” on page 1590.

Edit
Click to edit a pane. For more information,
see section 26.5 “Pane Properties” on
page 499.

Remove
Click to remove a component.

04-30005-01-en, May 2019 System

553
26 User Management User Interface
26.43 Workspace – Members Tab

26.43 Workspace – Members Tab

Use the Members tab to edit the workspace user account group associations.

Figure: Members tab

Table: Members tab

Component Description

Available User Account Groups Lists user account groups that are
available to be connected to the
workspace.

Selected User Account Groups Lists user account groups that are
connected to the workspace.

Add all
Click to connect all available user account
groups to the workspace.

Add
Click to connect a user account group to
the workspace.

Remove
Click to disconnect a user account group
from the workspace.

Remove all
Click to disconnect all user account
groups from the workspace.

System 04-30005-01-en, May 2019

554
 26 User Management User Interface
26.44 Edit Layout Workspace

26.44 Edit Layout Workspace

Use the Edit Layout Workspace to edit the layout of a workspace. You can also
move and resize panes and panels and save the changes.

Figure: Edit layout workspace

Table: Edit Layout Workspace

Button Description

Save
Click to store and close the workspace
layout.

04-30005-01-en, May 2019 System

555
26 User Management User Interface
26.45 Panel Wizard – Panel Configuration Page

26.45 Panel Wizard – Panel Configuration

Page
Use the Panel Configuration page to add components to the panel.

Figure: Panel configuration page

Table: Panel Configuration Page

Component Description

Add
Click to add a new component to the
panel. For more information, see section
53.28 “Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
Click to edit the properties of a component.
For more information, see section 26.5
“Pane Properties” on page 499.

Remove
Click to remove a component from the
panel.

Work area initial path Click to enter the path for the Work area
component.

Show toolbars Select Yes to show the toolbars for the

Work area component.

System 04-30005-01-en, May 2019

556
 26 User Management User Interface
26.46 Domains Properties

26.46 Domains Properties

Use the Domains properties to configure the EcoStruxure Building Operation
domains.

Figure: Domains properties

Table: Domains Properties

Component Description

Default Logon Domain Select the domain the user logs on to by

default. For more information, see section
21.1 “Domains” on page 391.

04-30005-01-en, May 2019 System

557
26 User Management User Interface
26.47 Local Properties

26.47 Local Properties

Use the Local properties to configure the local EcoStruxure Building Operation
domain.

Figure: Local properties

Table: Local Properties

Component Description

Maximum logon attempts Enter the maximum number of failed logon

attempts a user can make before the
user´s account is temporarily locked.

System 04-30005-01-en, May 2019

558
 26 User Management User Interface
26.48 Work Area Window Properties

26.48 Work Area Window Properties

Use the Work Area Window Properties view or dialog box to view or edit the path
of the default object to be presented in the Work Area.

Figure: Work Area Window properties

Table: Work Area Window Properties

Property Description

Initial path Displays the path of the default object

presented the Work Area Window. For
more information, see section 24.3
“Workspace Components and
Customization” on page 456.

04-30005-01-en, May 2019 System

559
26 User Management User Interface
26.49 Create Work Area Window Wizard – Name Page

26.49 Create Work Area Window Wizard –

Name Page
Use the Name page to enter the path to the default object to be presented in the
Work Area Window.

Figure: Name page properties

Table: Name Page Properties

Property Description

Initial path Enter the path of the default object to be

presented the Work Area Window.
For more information, see section 24.3
“Workspace Components and
Customization” on page 456.

System 04-30005-01-en, May 2019

560
 26 User Management User Interface
26.50 Windows User Group Dialog Box

26.50 Windows User Group Dialog Box

Use the Windows User Group dialog box to view or change the users added to
the group.

Figure: Windows User Group

Table: Windows User Group

Component Description

Quick filter Enter a word or a character to filter on. For

more information, see section 52.4 “Quick
Filter ” on page 1512.

List Select the users you want to add to the

group. For more information, see section
20.1 “Windows Active Directory User
Groups” on page 375.

04-30005-01-en, May 2019 System

561
27 Connect Agent

Topics
Connect Agent Overview
Configuring Connect Agent Settings
Transferring Crash Information
Applying Proxy Settings to the Connect Agent Service Log
On
Configuring Windows Firewall for Connect Agent
Getting Connect Agent Debug Information
 27 Connect Agent
27.1 Connect Agent Overview

27.1 Connect Agent Overview

Connect Agent is the service that runs along with the Enterprise Central and
Enterprise Servers attached to it to collect and transfer crash information of
EcoStruxure BMS servers (Enterprise Central, Enterprise Servers and SmartX
servers attached to Enterprise Servers).
To transfer the crash information, the Connect Agent service Log on needs to
meet the following conditions:
• sufficient user rights to access system folders and internet
• Internet proxy settings, if required
• Port number 22 available to access the following URL:
servercd.smartstruxure.schneider-electric.com
Connect Agent can collect and transfer crash information only when the site
administrator or the end-user provides consent to allow Schneider Electric to
receive system diagnostic and performance data of the system.
To enable the Connect Agent function, set Enable crash information transfer to
True. For more information, see section 27.2 “Configuring Connect Agent
Settings” on page 566.

04-30005-01-en, May 2019 System

565
27 Connect Agent
27.2 Configuring Connect Agent Settings

27.2 Configuring Connect Agent Settings

You configure the Connect Agent Settings to enable the agent to transfer the
crash information of the EcoStruxure BMS servers to the Connect storage server.
For more information, see section 27.1 “Connect Agent Overview” on page 565.

To configure Connect Agent Settings

1. In WorkStation, in the System Tree pane, expand the System folder.
2. Expand the Connect Settings folder and select Connect Agent Settings
Settings.
3. On the File menu, click Properties
Properties.
4. In the Enable crash information transfer box, select True
True.
5. Click the Advanced tab.
6. In Maximum bandwidth box, select the maximum bandwidth at which the
crash information can be transfered. If '0' is selected, the crash information
is transfered at maximum bandwidth.

System 04-30005-01-en, May 2019

566
 27 Connect Agent
27.3 Transferring Crash Information

27.3 Transferring Crash Information

The crash information is transfered within 30 minutes from the crash creation.
For Connect Agent to transfer the crash information, the Connect Agent service
Log on needs to meet the following conditions:
• Sufficient user rights to access system folders and internet
• Internet proxy settings, if required
• Port number 22 available to access the following URL:
servercd.smartstruxure.schneider-electric.com
To test whether Port number 22 is available to access the above URLs, use
PuTTY with SSH. These URLs do not respond to a ping but the address gets
resolved and with PuTTY you can then get to the Log On prompt.
The user (site administrator or end-user) needs to provide consent to collect the
information.
The Connect Agent settings need to be configured for the crash information to
be transferred. For more information, see section 27.2 “Configuring Connect
Agent Settings” on page 566.

27.3.1 Crash Information

Crash dump is generated only for Enterprise Server or Enterprise Central and
takes 2 to 3 minutes to produce. It is then zipped in the
C:\ProgramData\Schneider Electric EcoStruxure\Building Operation
x.y\Enterprise Server\db\Crash information folder. When the crash information
is successfully zipped, the .done file is created. After the .done file is created,
the Connect Agent service restarts the Enterprise Server. After few minutes, the
Connect Agent service then sends the zip file to the Connect storage server.
After successful transfer of the zip file, the Connect Agent service deletes the zip
file.
The actual crash dumps gets generated in the C:\ProgramData\Schneider
Electric EcoStruxure\Building Operation x.y\Enterprise Server\db\logs folder.
You can find the crash information log file
SE.SBO.S2ConnectESCrashAgentLog at location C:\Program Files
(x86)\Schneider Electric EcoStruxure\Building Operation 2.0\Enterprise Server

04-30005-01-en, May 2019 System

567
27 Connect Agent
27.4 Applying Proxy Settings to the Connect Agent Service Log On

27.4 Applying Proxy Settings to the Connect

Agent Service Log On
If the system needs proxy settings to browse the Internet, you need to apply the
same settings to the Connect Agent service log on to ensure that system and
crash information is available on Connect Agent server storage.
For more information, see section 27.1 “Connect Agent Overview” on page 565.

To apply proxy settings to the Connect Agent service log on

1. Run the command BITSADMIN in cmd.exe as administrator.
2. Restart the Connect Agent service.
For more information on BITSADMIN command, refer following links:
http://msdn.microsoft.com/en-us/library/aa362813(v=vs.85).aspx
http://myserverissick.com/2010/05/how-to-set-proxy-settings-for-the-
localsystem-and-networkservice-accounts

System 04-30005-01-en, May 2019

568
 27 Connect Agent
27.5 Configuring Windows Firewall for Connect Agent

27.5 Configuring Windows Firewall for

Connect Agent
You configure Windows Firewall for Connect Agent to ensure that the system
and crash information is available on Connect storage server.
For more information, see section 27.1 “Connect Agent Overview” on page 565.

To configuring Windows Firewall for Connect Agent

1. On the Windows toolbar, select Start and then click Control Panel
Panel.
2. Click System and Security and then click Check firewall status
status.
3. Click Advanced settings and then click Outbound Rules
Rules.
4. Click New Rule
Rule.
5. Select Program and click Next
Next.
6. Enter the SE.SBO.S2ConnectESAgent.exe program path. (For example,
C:\Program Files (x86)\Schneider Electric EcoStruxure\Building Operation
x.y\S2ConnectAgent\bin\SE.SBO.S2ConnectESAgent.exe). Click Next Next.
7. Select Allow the connection and click Next
Next.
8. Select the profiles and click Next
Next.
9. In the Name box, type the name for the rule.
10. Click Finish
Finish.

04-30005-01-en, May 2019 System

569
27 Connect Agent
27.6 Getting Connect Agent Debug Information

27.6 Getting Connect Agent Debug

Information
You need debug information to analyse why the crash information is not
available on Connect storage server. Debug information is retrieved from the
crash log files.
For more information, see section 27.1 “Connect Agent Overview” on page 565.

To get Connect Agent Debug Information

1. In Windows, navigate to \Program Files (x86)\Schneider Electric
EcoStruxure\Building Operation x.y\S2ConnectAgent\bin
x.y\S2ConnectAgent\bin.
2. Open SE.SBO.S2ConnectESAgent.exe.config or
SE.SBO.S2ConnectESCrashCollector.exe.config in notepad (Run as
administrator).
3. For the level value parameter, type DEBUG
DEBUG.
The detailed debug information is retrieved in the crash log files.

System 04-30005-01-en, May 2019

570
28 Connect Agent User Interface

Topics
Connect Agent Settings - Basic Tab
Connect Agent Settings - Advanced Tab
 28 Connect Agent User Interface
28.1 Connect Agent Settings - Basic Tab

28.1 Connect Agent Settings - Basic Tab

Use the Basic dialog box to configure the settings of Connect Agent to enable
transfer of crash information of the EcoStruxure BMS servers to the Connect
storage server.

Figure: Basic tab

Table: Basic Tab

Component Description

Enable crash information transfer Select True to enable the Connect Agent
service to transfer crash information to the
Connect storage server.

04-30005-01-en, May 2019 System

573
28 Connect Agent User Interface
28.2 Connect Agent Settings - Advanced Tab

28.2 Connect Agent Settings - Advanced

Tab
Use the Advanced tab to configure the advanced settings of Connect Agent.

Figure: Advanced tab

Table: Advanced Tab

Component Description

Maximum bandwidth Select the bandwidth at which the crash

information is to be transfered. If '0' is
selected, the crash information is
transfered at maximum bandwidth.

System 04-30005-01-en, May 2019

574
29 Alarms Introduction

Topics
Alarms Overview
Alarm States
Alarm Control Panel Objects in Multiple Servers
Alarms Pane and Alarm View Customization
Styling the Alarm States in the Alarms Pane and Alarm
Views
Displaying Milliseconds in Alarm Views
Displaying an Alarm View when an Alarm is Triggered
Viewing the Events of an Alarm
Navigating to the Alarm Object of a Triggered Alarm
Navigating to the Source Object of a Triggered Alarm
Alarm View and Event View Standard Filter and Layout
Saving an Alarm View Standard Layout
Resetting the Alarm View Standard Layout to Factory
Default
Fitting the Column Width to the Contents
Editing an Alarm View Standard Filter
Displaying Alarms Assigned to the Logged On User Account
Displaying Alarms Assigned to the Logged On User Account
Groups
29 Alarm Filters
Creating a Filtered Alarm View
Filter Condition Wildcards
Alarm Handling Issues
Configure Alarm Filters on Enterprise Central Workflow
 29 Alarms Introduction
29.1 Alarms Overview

29.1 Alarms Overview

You use an alarm to monitor a variable and to alert you if the monitored variable
matches the configured alarm conditions.
You can configure an alarm to send a message to a specified user or user group
when the alarm is triggered or force the user that acknowledges the alarm to
write a cause note. You can also configure the alarm to flash and play a sound
when it is triggered.
Suppose you want to monitor the temperature of a freezer protector on a
compressor. You create an alarm that triggers when the temperature drops too
low. A message is automatically sent to an assigned operator who
acknowledges the alarm and corrects the problem.

Figure: Triggered, reset, and acknowledged alarms presented in Alarms pane

29.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 29.2 “Alarm States” on page 579.

29.1.2 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 30.1 “Alarm Types” on page 609.

29.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 31.1 “Alarm Functions” on page 699.

04-30005-01-en, May 2019 System

577
29 Alarms Introduction
29.1 Alarms Overview

29.1.4 Alarm Control Panel Objects in Multiple

Servers
In a multi-server system, you create Alarm Control Panel objects, such as
checklists and actions notes, on the Enterprise Server or on the Enterprise
Central.
SmartX servers that are connected to that Enterprise Server inherit Alarm Control
Panel objects automatically. The copies on the connected SmartX 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 SmartX servers even if the Enterprise Server goes
offline.
An Enterprise Server that is connected to the Enterprise Central will not
automatically inherit alarm objects.
For more information, see section 29.3 “Alarm Control Panel Objects in Multiple
Servers” on page 580.

29.1.5 Alarms Pane and Alarm View Customization

You use the Alarms pane and the Alarm View to view and administer alarms.
When an alarm is triggered, it is displayed in the Alarms pane or Alarm Views
together with information about the alarm. You can edit the Alarm View filter to
display the Alarm View only when certain alarms are triggered. You can create
and use more than one Alarm View. The Alarms pane and each Alarm View can
be customized with an alarm filter to show information that is relevant to the user
who supervises the alarms. Customized settings are lost when you perform a
system upgrade.
For more information, see section 29.4 “Alarms Pane and Alarm View
Customization” on page 581.

29.1.6 Alarm Filters

Alarm filters 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 filters to
determine the conditions that have to be met before a sum alarm is triggered, an
email notification is sent, a write to file notification is written, or an alarm is
automatically assigned to a user.
For more information, see section 29.18 “Alarm Filters” on page 595.

29.1.7 Mass Create

You use the mass create feature to create multiple identical alarms or trend logs
for different objects, instead of creating the alarms or trend logs one by one.
From trend logs, you can mass create extended trend logs.
For more information, see section 45.1 “Mass Create ” on page 1365.

System 04-30005-01-en, May 2019

578
 29 Alarms Introduction
29.2 Alarm States

29.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. Normal state = 0.

Alarm state When an alarm is triggered, the state of the

alarm changes from the normal state to
alarm state. Alarm state = 1.

Acknowledge state A user or user group has acknowledged

the alarm. Acknowledged state = 2.

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. Reset state = 3.

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.
Disabled state = 4.
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.

Fault state If a BACnet device reports values that it

knows are not trustworthy, the monitoring
alarm is put in fault state. Fault state = 5.

You can configure the alarm in different ways whether or not a user has to
acknowledge the alarm before it returns to normal state.
For more information, see section 31.16 “Acknowledgements” on page 717.

29.2.1 Alarm Handling Issues

When an alarm is triggered it appears in the alarm list. You can acknowledge,
disable, or hide alarms in the alarm list. An acknowledged alarm disappears
from the alarm list when it has been reset to normal state.
For more information, see section 29.21 “Alarm Handling Issues” on page 604.

04-30005-01-en, May 2019 System

579
29 Alarms Introduction
29.3 Alarm Control Panel Objects in Multiple Servers

29.3 Alarm Control Panel Objects in Multiple

Servers
In a multi-server system, you create Alarm Control Panel objects, such as
checklists and actions notes, on the Enterprise Server or on the Enterprise
Central.
SmartX servers that are connected to that Enterprise Server inherit Alarm Control
Panel objects automatically. The copies on the connected SmartX 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 SmartX servers even if the Enterprise Server goes
offline.
An Enterprise Server that is connected to the Enterprise Central will not
automatically inherit alarm objects.

NOTICE
You need to export Alarm Control Panel objects from the child server
(Enterprise Server or a SmartX server) and import them to the parent server
(Enterprise Central or Enterprise Server) before you synchronize the Alarm
Control Panel. During synchronization, all the Alarm Control Panel objects are
erased from the child server. In particular, ensure that you secured the Alarm
Control Panel of your SmartX server before adding it to the Enterprise Server.
For more information, see section 31.42 “Synchronizing Alarm Control Panels”
on page 753.

System 04-30005-01-en, May 2019

580
 29 Alarms Introduction
29.4 Alarms Pane and Alarm View Customization

29.4 Alarms Pane and Alarm View

Customization
You use the Alarms pane and the Alarm View to view and administer alarms.
When an alarm is triggered, it is displayed in the Alarms pane or Alarm Views
together with information about the alarm. You can edit the Alarm View filter to
display the Alarm View only when certain alarms are triggered. You can create
and use more than one Alarm View. The Alarms pane and each Alarm View can
be customized with an alarm filter to show information that is relevant to the user
who supervises the alarms. Customized settings are lost when you perform a
system upgrade.
In the Alarms pane and Alarm Views, you can also open a detailed view to
inspect all properties for a selected alarm.

Figure: The Alarms pane

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

Alarm View standard filter and layout

A standard layout defines the columns that are included in the Alarms pane,
Events pane, Alarm View, or Event View, the order in which they are displayed,
whether or not the alarms or events are grouped in any way and whether they
are displayed in an ascending or descending order. A standard filter defines the
conditions that have to be met before the alarms or events are displayed in the
pane or a View. The standard layout and filter is saved for the pane or View to
which you made the changes. The standard layout and filter is displayed for all
users of the the EcoStruxure BMS.
For more information, see section 36.5 “Alarm View and Event View Standard
Filter and Layout” on page 1069.

04-30005-01-en, May 2019 System

581
29 Alarms Introduction
29.5 Styling the Alarm States in the Alarms Pane and Alarm Views

29.5 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 29.4 “Alarms Pane and Alarm View
Customization” on page 581.

To style the alarm states in the Alarms pane and Alarm Views
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Styling
Styling.
4. In the Alarm Styles view, double-click the alarm state you want to style.
5. In the Font box, click the Browse button.
6. In the Font dialog box, select the font, font style, and font size that you want
to use in the Alarms pane and Alarm Views.
7. Click OK
OK.
8. In the Background color box, click the Browse button.
9. In the Color dialog box, select the color for the background of the alarm
state row.
10. Click OK
OK.
11. In the Font color box
box, click the Browse button.
12. Select the color for the font of the alarm state text.
13. Click OK
OK.

14. Click the Save button .

System 04-30005-01-en, May 2019

582
 29 Alarms Introduction
29.6 Displaying Milliseconds in Alarm Views

29.6 Displaying Milliseconds in Alarm Views

You display milliseconds in Alarm Views to verify the millisecond an alarm was
triggered.
For more information, see section 29.4 “Alarms Pane and Alarm View
Customization” on page 581.

To display milliseconds in Alarm Views

1. In WorkStation, select an Alarm View.
2. On the File menu, click Properties
Properties.
3. In the Show milliseconds box, select True
True.
4. Click OK
OK.
The Alarm View time properties display milliseconds for all logged on users.

04-30005-01-en, May 2019 System

583
29 Alarms Introduction
29.7 Displaying an Alarm View when an Alarm is Triggered

29.7 Displaying an Alarm View when an

Alarm is Triggered
You configure an Alarm View to automatically open in a new window when an
alarm is triggered.

To display an Alarm View when an alarm is triggered

1. In WorkStation, in the Alarms pane, right-click anywhere.
2. Point to Alarm View settings and then click Display Alarm View on alarm.

System 04-30005-01-en, May 2019

584
 29 Alarms Introduction
29.8 Viewing the Events of an Alarm

29.8 Viewing the Events of an Alarm

You view the events of an alarm when you want to check the historical data of
the alarm.

To view the events of an alarm

1. In WorkStation, in the Alarms pane, right-click anywhere.
2. Point to View
View.
3. Click View history
history.

04-30005-01-en, May 2019 System

585
29 Alarms Introduction
29.9 Navigating to the Alarm Object of a Triggered Alarm

29.9 Navigating to the Alarm Object of a

Triggered Alarm
You navigate to the alarm object of a triggered alarm to view or edit the
configuration of the alarm.
For more information, see section 30.1 “Alarm Types” on page 609.

To navigate to the alarm object of a triggered alarm

1. In WorkStation, in the Alarms pane or Alarm View
View, right-click the alarm
whose alarm object you want to navigate to.
2. Click Go to alarm object
object.
The alarm object is selected in the System Tree pane and opened in the Work
area.

System 04-30005-01-en, May 2019

586
 29 Alarms Introduction
29.10 Navigating to the Source Object of a Triggered Alarm

29.10 Navigating to the Source Object of a

Triggered Alarm
You navigate to the source object of a triggered alarm to view or edit the
configuration of the source object.
For more information, see section 30.1 “Alarm Types” on page 609.

To navigate to the source object of a triggered alarm

1. In WorkStation, in the Alarms pane or Alarm View
View, right-click the alarm
whose source object you want to navigate to.
2. Click Go to source object
object.
The source object that triggered the alarm is selected in the System Tree pane
and opened in the Work area.

04-30005-01-en, May 2019 System

587
29 Alarms Introduction
29.11 Alarm View and Event View Standard Filter and Layout

29.11 Alarm View and Event View Standard

Filter and Layout
A standard layout defines the columns that are included in the Alarms pane,
Events pane, Alarm View, or Event View, the order in which they are displayed,
whether or not the alarms or events are grouped in any way and whether they
are displayed in an ascending or descending order. A standard filter defines the
conditions that have to be met before the alarms or events are displayed in the
pane or a View. The standard layout and filter is saved for the pane or View to
which you made the changes. The standard layout and filter is displayed for all
users of the the EcoStruxure BMS.
You can edit the layout and filter conditions of the standard layout and filter
provided you have write permissions on the pane or View from which you are
making the changes. When you change the standard layout and filter from a
pane or View, the changes are only applied on that specific pane or View and for
all users who view that pane or View. Other Views in the system are not affected.
You can revert your layout changes.
Standard filters in Alarm Views and Event Views support relative paths for the
Source property. You can reuse the Alarm View or Event View and have the
Source path of the alarms or events dynamically change depending on where
you paste, import, move or duplicate the Alarm View or Event View. For example,
in a relative path: '../../*' where '../' represents a folder or other container object
and '*' represents anything below the folder or container object.

System 04-30005-01-en, May 2019

588
 29 Alarms Introduction
29.12 Saving an Alarm View Standard Layout

29.12 Saving an Alarm View Standard Layout

You save a standard layout to make a change to the Alarms pane or an Alarm
View layout available to all users.
For more information, see section 36.5 “Alarm View and Event View Standard
Filter and Layout” on page 1069.

To save an Alarm View standard layout

1. In WorkStaton, in the Alarms pane or an Alarm View, right-click anywhere in
the column header row and then click Add/Remove columns
columns.
2. In the Add/Remove Columns dialog box, select the columns that you want
to add or clear columns that you want to remove from the Alarm View
standard layout.
3. Click OK
OK.
4. Move the Alarms pane or Alarm View columns to the position where you
want them by dragging the column heading.
5. Click the arrow that appears next to a column heading to choose
ascending or descending alphanumeric sort order for the content of that
column.

6. Right-click the column heading row and select Group box .

7. Drag a column heading to the group box to group the alarms by that
category.
8. Right-click anywhere in the Alarms pane or Alarm View, point to Alarm
View settings and then click Save as standard layout
layout.
The standard layout is applied on the Alarms pane or the Alarm View from which
you made the changes and is applied when a user opens the Alarms pane or
Alarm View.

04-30005-01-en, May 2019 System

589
29 Alarms Introduction
29.13 Resetting the Alarm View Standard Layout to Factory Default

29.13 Resetting the Alarm View Standard

Layout to Factory Default
You reset the standard layout for the Alarms pane or Alarm View to revert a
change that you have made to the standard layout.
For more information, see section 36.5 “Alarm View and Event View Standard
Filter and Layout” on page 1069.

To reset the Alarm View standard layout to factory default

1. In WorkStation, right-click anywhere in the Alarms pane or Alarm View list.
2. Point to Alarm View settings and then click Reset standard layout to
factory default
default.
The Alarms pane or Alarm View standard layout is reset to the factory default
layout.

System 04-30005-01-en, May 2019

590
 29 Alarms Introduction
29.14 Fitting the Column Width to the Contents

29.14 Fitting the Column Width to the Contents

You fit the column width to the content to see all, or as much as possible, of the
content displayed in each of the columns in the Alarms pane, Alarm View,
Events pane, Event View, Multi Trend Log List, List View, or Search.
For more information, see section 36.5 “Alarm View and Event View Standard
Filter and Layout” on page 1069.

To fit the column width to the contents

1. In the pane or View, right-click anywhere in the column heading row and
then click Auto fit to contents
contents.
The width of all the columns in the pane or View is adjusted so that all or as
much as possible of the column content is displayed.

04-30005-01-en, May 2019 System

591
29 Alarms Introduction
29.15 Editing an Alarm View Standard Filter

29.15 Editing an Alarm View Standard Filter

You edit a standard filter to narrow what is displayed in the Alarms pane or an
Alarm View for all users in the EcoStruxure Building Operation software.
For more information, see section 36.5 “Alarm View and Event View Standard
Filter and Layout” on page 1069.

To edit an Alarm View standard filter

1. In WorkStation, right-click anywhere in the Alarms pane or Alarm View,
point to Alarm View settings, and then click Edit standard filter
filter.

2. In the Select Conditions dialog box, click the Add condition button.
3. Select the condition you want to add to the Alarm View standard filter.
4. Select the sub condition that has to be met before the alarm is displayed in
the Alarms pane or Alarm View.
5. Click OK
OK.
The standard filter is applied for all users who open the changed Alarms pane or
Alarm View.

System 04-30005-01-en, May 2019

592
 29 Alarms Introduction
29.16 Displaying Alarms Assigned to the Logged On User Account

29.16 Displaying Alarms Assigned to the

Logged On User Account
You edit the standard Alarm View filter to display alarms assigned to the current
user when you want the Alarm View to only display alarms assigned to the
logged on user account.
For more information, see section 29.18 “Alarm Filters” on page 595.

To display alarms assigned to the logged on user account

1. In WorkStation, select a row in the Alarms pane or an Alarm View
View.
2. On the Actions menu, click Edit standard Alarm View filter
filter.

3. Click the Add condition button .

4. In the Add/Remove Conditions dialog box, select Assigned to name
name.
5. Click OK
OK.

6. In the Select Conditions dialog box, click the Add row button .
7. In the new row, type '@(CurrentUser)'.
8. Click OK
OK.
The standard Alarm View filter is changed for all users in the EcoStruxure BMS
and only displays alarms for the logged on user.

04-30005-01-en, May 2019 System

593
29 Alarms Introduction
29.17 Displaying Alarms Assigned to the Logged On User Account Groups

29.17 Displaying Alarms Assigned to the

Logged On User Account Groups
You edit the standard Alarm View filter to display alarms assigned to the current
user when you want the Alarm View to only display alarms assigned to the
logged on user account and the user account groups the logged on user
account belongs to.
For more information, see section 29.18 “Alarm Filters” on page 595.

To display alarms assigned to the logged on user account

groups
1. In WorkStation, select a row in the Alarms pane or an Alarm View
View.
2. On the Actions menu, click Edit standard Alarm View filter
filter.

3. Click the Add condition button .

4. In the Add/Remove Conditions dialog box, select Assigned to name
name.
5. Click OK
OK.

6. In the Select Conditions dialog box, click the Add row button .
7. In the new row, type '@(CurrentGroups)'.
8. Click OK
OK.
The standard Alarm View filter is changed for all users in the EcoStruxure BMS
and only displays alarms for the logged on user account and the user account
groups the logged on user account belongs to.

System 04-30005-01-en, May 2019

594
 29 Alarms Introduction
29.18 Alarm Filters

29.18 Alarm Filters

Alarm filters 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 filters to
determine the conditions that have to be met before a sum alarm is triggered, an
email notification is sent, a write to file notification is written, or an alarm is
automatically assigned to a user.
You filter on a condition category and then select the sub conditions for that
category.
Examples:
You filter on Type and then select Alarm Record if you only want EcoStruxure
Building Operation alarms to be displayed in the Alarms pane or Alarm View.
You filter on Type and then select Extended System Alarm Record and Simple
System Alarm Record if you only want EcoStruxure Building Operation system
alarms to be displayed in the Alarms pane or Alarm View.

NOTICE
To edit the filter conditions of an alarm, assignment, or notification, you have to
open the alarm, assignment, or notification by clicking it.

Table: Alarm Filter Conditions

Component Description

Acknowledge time Enter the property to filter by the time and

date the alarm was acknowledged.

Acknowledged by Type the property to filter by the name of

the user that acknowledged the alarm.
Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Acknowledgement required Select the property to filter BACnet alarms

by whether the notification requires
acknowledgement. True specifies that an
acknowledgement is required.

Alarm state Select the property to filter alarms by the

present state of the alarm.

Alarm text Type the property to filter alarms by the

alarm messages that are added to the
alarm. Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Assigned state Select the property to filter alarms that

have been assigned to and accepted by
any user or group.

04-30005-01-en, May 2019 System

595
29 Alarms Introduction
29.18 Alarm Filters

Continued
Component Description

Assigned to domain Type the property to filter alarms by the

domain of the user or group that the alarm
is assigned to. Wildcards can be used. For
more information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Assigned to ID Type the property to filter alarms by the ID

of the user or group that the alarm is
assigned to. Wildcards can be used. For
more information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Assigned to name Type the property to filter alarms by the

name of the user or group that the alarm is
assigned to. Wildcards can be used. For
more information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

BACnet alarm type Select the property to filter alarms by the

BACnet alarm that monitors a variable
within a BACnet network.

BACnet notification Enter the property to filter alarms by the

BACnet Notification Class of the event.

BACnet notification type Select the property to filter alarms by the

BACnet notification, whether the
notification is an event or an alarm.

Basic evaluation state Select the property to filter alarms by the

current evaluation state of the alarm. True
indicates that the alarm is triggered.

Category Type the property to filter alarms by the

category name of the alarm. Wildcards can
be used. For more information, see section
36.12 “Filter Condition Wildcards ” on page
1081.

Command value Enter the property to filter alarms by the

value that was commanded.

Confirmed notification Select the property to filter alarms by the

request requires acknowledgement, by the
recipient's computer.

Count Enter the property to filter alarms by the

number of times the alarm has toggled
between the alarm and reset state.

Deadband Enter the property to filter alarms by the

deadband value of the alarm.

Device name Type the property to filter events by the

name of the I/NET device that generated
the alarm. Wildcards can be used. For
more information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

System 04-30005-01-en, May 2019

596
 29 Alarms Introduction
29.18 Alarm Filters

Continued
Component Description

Disabled by Select the property to filter alarms by the

name of the user who disabled the alarm.

Disabled cause Select the property to filter alarms by the

cause for disabling the alarm. An alarm is
either disabled by user, shunt variable, or if
the alarm is incorrectly configured.

Error limit Enter the property to filter alarms by the

difference limit that was exceeded.

Evaluation state Select the property to filter alarms by the

present evaluation state of the alarm. For
example, Upper limit alarm is displayed
when the monitored value reaches the
upper alarm limit.

Event from state Select the property to filter alarms by the

BACnet From State. The From State
indicates the Event State of the object prior
to the occurrence of the event that initiated
the notification.

EWS ID Type the property to filter alarms by the ID

the alarm has on the external system.
Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

EWS source ID Type the property to filter alarms by the

external ID of the object that generated the
alarm. Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Exceeded limit Enter the property to filter alarms by the

limit that was exceeded.

Exceeding value Enter the property to filter alarms by the

value that exceeded a limit.

Feedback value Enter the property to filter alarms by the

value that differs from the Command value.

First name Type the property to filter alarms by the

first name of the individual whose key/card
was used at the I/NET door point.
Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Hidden Select the property to filter alarms by the

visible status. True is displayed when the
object is hidden.

Individual Enter the property to filter alarms by the

individual number of the individual whose
key/card was used at the I/NET door point.

04-30005-01-en, May 2019 System

597
29 Alarms Introduction
29.18 Alarm Filters

Continued
Component Description

INET Address Type the system address of the I/NET

point, or station address of the I/NET host
or controller, that generated the event.

Last name Type the property to filter alarms by the last

name of the individual whose key/card was
used at the I/NET door point. Wildcards
can be used. For more information, see
section 36.12 “Filter Condition Wildcards ”
on page 1081.

Logging Select the property to filter alarms by

whether or not associated alarm events are
generated and recorded in the Event log.

Message text Select the property to filter alarms by a

message of up to 64 characters that has
been assigned to the I/NET point.

Monitored variable Type the property to filter alarms by the

monitored variable. Wildcards can be
used. For more information, see section
36.12 “Filter Condition Wildcards ” on page
1081.

New mode Enter the property to filter alarms by the

new mode of the referenced object.

New state Enter the property to filter alarms by the

new state of the referenced property.

New value Type the property to filter alarms by the

new value of the referenced property.
Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Operation expected Enter the property to filter alarms by the

next operation requested by the
referenced object.

Possible operator actions Select the property to filter alarms by the

possible actions one can perform on the
record, given permissions.

Previous alarm state Select the property to filter alarms by the

previous state of the alarm.

Priority Enter the property to filter alarms by the

current priority level of the alarm state.

Process ID Enter the property to filter alarms by the

unique process ID in the receiving device
for which a BACnet notification is intended.

System 04-30005-01-en, May 2019

598
 29 Alarms Introduction
29.18 Alarm Filters

Continued
Component Description

Referenced bit string Type the property to filter alarms by the

new value of the referenced bit string
property. Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Referenced value Enter the property to filter alarms by the

value of the referenced property.

Setpoint value Enter the property to filter alarms by the

value of the reference variable.

Sigma event parameters Type the property to filter alarms by the

Sigma event parameter. Wildcards can be
used. For more information, see section
36.12 “Filter Condition Wildcards ” on page
1081.

Sigma event type Select the property to filter alarms by the

Sigma event type.

Source Type the property to filter alarms by the

path of the source object. Relative paths
can be used for Sum Alarms, Assignments
and Alarm triggered notification. Wildcards
can be used. For more information, see
section 36.12 “Filter Condition Wildcards ”
on page 1081.

Source name Type the property to filter alarms by the

external name of the object that generated
the alarm. Wildcards can be used. For
more information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Source server Type the property to filter alarms by the

path where the alarm is located. Wildcards
can be used. For more information, see
section 36.12 “Filter Condition Wildcards ”
on page 1081.

Station name Type the name assigned to the I/NET

controller from which the event originated.

Status flags Select the property to filter alarms by the

status flag.

System alarm ID Select the property to filter alarms by the

alarm ID generated by the system.

Tenant Enter the property to filter alarms by the

tenant number of the individual whose
key/card was used at the I/NET door point.

Timestamp Enter the property to filter alarms by the

time and date.

04-30005-01-en, May 2019 System

599
29 Alarms Introduction
29.18 Alarm Filters

Continued
Component Description

Triggered time Enter the property to filter alarms by the

time and date of the last state transfer from
normal state to alarm state.

Type Select the property to filter alarms by the

type of the object.

Value at change Type the property to filter alarms by the

value of the monitored variable. Wildcards
can be used. For more information, see
section 36.12 “Filter Condition Wildcards ”
on page 1081.

29.18.1 Filter condition wildcards

A wildcard is one or more characters used to simplify the process of setting up
filter conditons. You use wildcards to substitute characters or combinations of
characters in object properties, such as names or descriptions. For example,
instead of setting up five filter conditions for values with names beginning with a,
b, c, d, or e, you can set up one single filter condition for values with a name
beginning with any of the characters in the range [a-e].
For more information, see section 36.12 “Filter Condition Wildcards ” on page
1081.

System 04-30005-01-en, May 2019

600
 29 Alarms Introduction
29.19 Creating a Filtered Alarm View

29.19 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 29.4 “Alarms Pane and Alarm View
Customization” on page 581.

To create a filtered Alarm View

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS 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 Create Object wizard, 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 standard Alarm View filter to filter the
Alarm View.
9. In the Select Conditions dialog box, 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.

NOTICE
• 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-30005-01-en, May 2019 System

601
29 Alarms Introduction
29.20 Filter Condition Wildcards

29.20 Filter Condition Wildcards

A wildcard is one or more characters used to simplify the process of setting up
filter conditons. You use wildcards to substitute characters or combinations of
characters in object properties, such as names or descriptions. For example,
instead of setting up five filter conditions for values with names beginning with a,
b, c, d, or e, you can set up one single filter condition for values with a name
beginning with any of the characters in the range [a-e].

Table: Wildcard Characters

Character Description

* Use to match any combination of

characters, including no character

? Use to match any one character exactly

[ Use to begin a SET, that is, a number of

characters or a range

] Use to end a SET

[] Use to match any one character specified

within the SET, that is, enclosed by the
brackets

! Use to exclude the characters or range(s)

of a SET

- Use in a range within a SET: 0-9, a-z, A-Z

\ Use to ignore the wildcard character and

search for it as any other character

Any other character has to match exactly.

You can specify any number of characters or a range within brackets. In this
case, the filter includes one character specified within the brackets and any
number of characters specified outside the brackets.
Examples:
*at - Matches "at" and all objects ending with "at"
?t - Matches all two-character objects ending with "t"
[CB]at - Matches "Cat" and "Bat", that is, objects beginning with any one
character specified within the SET and ending with "at"
[A-C]at - Matches "Aat", "Bat", and "Cat"
[CB][au]t - Matches "Cat", "Cut", "Bat", and "But"
[!a-b0-1q]at - Matches all three-character objects ending with 'at' except "aat",
"bat", "0at", "1at" and "qat"
\\ - Matches "\"
b\\t - Matches ”b\t”

System 04-30005-01-en, May 2019

602
 29 Alarms Introduction
29.20 Filter Condition Wildcards

Table: Wildcard Availability for Different Features

Feature * ? [b] [a-c] [\]] [!a-c]

Alarm View Yes Yes Not Not Not Not

Filter available available available available
Conditions

Event View Yes Yes Yes Yes Not Not

Filter available available
Conditions

Sum Alarm Yes Yes Yes Yes Yes Yes

Filter
Conditions

Notification Yes Yes Yes Yes Yes Yes

s Filter
Condition

Assignmen Yes Yes Yes Yes Yes Yes

ts Filter
Conditions

04-30005-01-en, May 2019 System

603
29 Alarms Introduction
29.21 Alarm Handling Issues

29.21 Alarm Handling Issues

When an alarm is triggered it appears in the alarm list. You can acknowledge,
disable, or hide alarms in the alarm list. An acknowledged alarm disappears
from the alarm list when it has been reset to normal state.
When the alarm database is lost after an upgrade or is corrupt after an
EcoStruxure BMS server crash, all alarms are re-evaluated. The alarms that are
still active are resent to the alarm database. However, the information that an
alarm has been acknowledged, disabled, or hidden is lost and you have repeat
the operation you performed on the alarm before the data loss.
When an alarm has been triggered and reset to normal state without having
been acknowledged, the alarm remains in the alarm list until it is acknowledged.
If the alarm is lost, an alarm refresh does not make the alarm reappear in the
alarm list. The alarm is reset and has no alarm state to send.
Most system information alarms are only messages. These alarms cannot be in
an alarm state, thus, an alarm refresh does not make the system information
alarms reappear in the alarm list.

System 04-30005-01-en, May 2019

604
 29 Alarms Introduction
29.22 Configure Alarm Filters on Enterprise Central Workflow

29.22 Configure Alarm Filters on Enterprise

Central Workflow
Alarm filters 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 filters to
determine the conditions that have to be met before a sum alarm is triggered, an
email notification is sent, a write to file notification is written, or an alarm is
automatically assigned to a user.

Figure: Custom audible alarm alert flowchart

Synchrone Alarm Control Panels

Synchronize Alarm Control Panels to configure a lead-shadow relationship
between Enterprise Central and the Enterprise Server on which the alarms
reside.
For more information, see section 31.42 “Synchronizing Alarm Control Panels”
on page 753.

Create a Category
On Enterprise Central, create the alarm Category 2 for the the Enterprise Server
or SmartX server alarms you want to display on Enterprise Central.
For more information, see section 31.13 “Creating a Category” on page 714.

Create an Alarm Decoration Rule

On Enterprise Central, create an alarm decoration rule to override one or several
properties of aggregated alarms when the conditions of the alarm decoration
rule are met. For this chosen condition, configure Category 2.

04-30005-01-en, May 2019 System

605
29 Alarms Introduction
29.22 Configure Alarm Filters on Enterprise Central Workflow

For more information, see section 33.2 “Creating an Alarm Decoration Rule” on
page 777.

Create a Filtered Alarm View

On Enterprise Central, create a filtered Alarm View that only displays the
Category 2 alarms.
For more information, see section 29.19 “Creating a Filtered Alarm View” on
page 601.

System 04-30005-01-en, May 2019

606
30 Alarm Types

Topics
Alarm Types
Change of State Alarms
Creating a Change of State Alarm
Configuring a Change of State Alarm
Multistate Alarms
Creating a Multistate Alarm
Configuring a Multistate Alarm
Matching Text String Alarms
Creating a Matching Text String Alarm
Configuring a Matching Text String Alarm
Variable Status Alarms
Creating a Variable Status Alarm
Configuring a Variable Status Alarm
Out of Range Alarms
Creating an Out of Range Alarm
Configuring an Out of Range Alarm
Out of Reference Range Alarms
Creating an Out of Reference Range Alarm
Configuring an Out of Reference Range Alarm
Sum Alarms
30 Creating a Sum Alarm
Configuring a Sum Alarm
Enumeration Alarms
Creating an Enumeration Alarm
Configuring an Enumeration Alarm
System Alarms
System Alarm Handling
System Alarm ID List
System Alarm ID A-D
System Alarm ID E-L
System Alarm ID M-NW8 R
System Alarm ID NW8 S-NW8 Z
System Alarm ID P-S
System Alarm ID T-X
Configuring the Description of an Alarm
 30 Alarm Types
30.1 Alarm Types

30.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.
Alarms can monitor values from external sources, such as LonWorks and
BACnet devices, as well as values from EcoStruxure BMS servers. Some alarms
are also based on system information, such as device restart or network status.

30.1.1 Change of State Alarms

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 30.2 “Change of State Alarms” on page 612.

30.1.2 Out of Range Alarms

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 30.14 “Out of Range Alarms” on page 644.

30.1.3 Out of Reference Range Alarms

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 30.17 “Out of Reference Range Alarms” on
page 652.

30.1.4 Multistate Alarms

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 30.5 “Multistate Alarms” on page 620.

04-30005-01-en, May 2019 System

609
30 Alarm Types
30.1 Alarm Types

30.1.5 Matching Text String Alarms

A matching text string alarm evaluates if the monitored value equals the given
text strings.
For more information, see section 30.8 “Matching Text String Alarms” on page
628.

30.1.6 Variable Status Alarms

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 30.11 “Variable Status Alarms” on page 636.

30.1.7 Sum Alarms

A sum alarm can be seen as a collection of alarms that have one or several
common denominators. The conditions you use to filter which alarms the sum
alarm monitors are the same conditions you use to filter the Alarms pane or an
Alarm View. You can use wildcards when setting up filter conditions. For more
information, see section 36.12 “Filter Condition Wildcards ” on page 1081.
For more information, see section 30.20 “Sum Alarms” on page 661.

30.1.8 Enumeration Alarms

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 30.23 “Enumeration Alarms” on page 669.

30.1.9 System Alarms

System alarms monitor system entities, such as online status for SmartX servers
or field devices. The system alarms are generated by the EcoStruxure Building
Operation software. Users cannot create new system alarms. The possible
causes of a system alarm are gathered in an enumeration called System alarm
ID. When a system alarm is triggered, the cause of the alarm is indicated in the
System alarm ID column in the Alarms pane or Alarm View. Some system alarms
have additional information in the Alarm text column.
For more information, see section 30.26 “System Alarms” on page 677.

System 04-30005-01-en, May 2019

610
 30 Alarm Types
30.1 Alarm Types

30.1.10 EcoStruxure Web Service Alarm Item

The EcoStruxure Web Service alarm item is a representation of an alarm on an
EcoStruxure Web Service. The alarm item is automatically created when you
host an EcoStruxure Web Service alarm on your system.
For more information, see the EcoStruxure Web Service Alarm Item topic on
WebHelp.

04-30005-01-en, May 2019 System

611
30 Alarm Types
30.2 Change of State Alarms

30.2 Change of State Alarms

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 31.1 “Alarm Functions” on page 699.

System 04-30005-01-en, May 2019

612
 30 Alarm Types
30.3 Creating a Change of State Alarm

30.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 30.2 “Change of State Alarms” on page 612.

To create a change of state alarm

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS server where you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the Create Object dialog box, 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.
7. In the Alarm Trigger page, 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 Variables
Variables, in the Alarm delay box, enter the
time delay.
11. In the Reset delay box, enter the time delay.
12. Select Invert to have the alarm enabled when the first shunt variable is
active.
13. In the Shunt variable 1 box, enter the binary variable that enables or
disables the alarm.
14. In the Operator list, select AND or OR to add logic between the first shunt
variable and the second shunt variable.
15. Select Invert to have the alarm enabled when the second shunt variable is
active.
16. In the Shunt variable 2 box, enter the binary variable that enables or
disables the alarm.
17. Click Next
Next.
18. In the Presentation page, in the Alarm message box, type the message to
display when the monitored variable exceeds the alarm limit.
19. In the Reset message box, type the message to display when the alarm is
reset.
Continued on next page

04-30005-01-en, May 2019 System

613
30 Alarm Types
30.3 Creating a Change of State Alarm

20. In the Category box, enter the category the alarm belongs to.
21. In the Category 2 box, enter the second category the alarm belongs to.
22. In the Prefix for alarm source name box, type a prefix that is added to the
beginning of the source name property of an alarm record.

NOTICE
You can add alarm substitution codes to a prefix for the alarm source
name. For more information, see section 31.27 “Alarm Substitution
Codes” on page 731.

23. In the Alarm priority box, enter the priority for the alarm state.
24. Select Same priority to let the Reset priority box inherit the value in the
Alarm priority box.
25. In the Reset priority box, enter the priority for the reset state.
26. Select Auto hide to automatically hide the alarm in the Alarms pane or
Alarm View.
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 play a sound when the alarm is triggered.
29. In the Custom audio box, enter the path to the custom audio file you want
to play when the alarm is triggered.

NOTICE
If you have selected Audible alert but not selected any custom audio file,
the default alarm sound is played when the alarm is triggered.

30. Select Disable state-change logging to prevent an alarm state change

from creating an event.
31. Click Next
Next.
32. In the User Action page, 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.
33. In the Cause note group box, enter a cause note group that you want to
connect to the alarm.
34. In the Action note group box, enter an action note group that you want to
connect to the alarm.
35. In the Checklist box, enter a checklist that you want to connect to the
alarm.
36. Select When acknowledging an alarm: Comment to force the user to add
a comment to the alarm before the alarm can be acknowledged.
37. Select When acknowledging an alarm: Cause note to force the user to edit
the connected cause note before the alarm can be acknowledged.

System 04-30005-01-en, May 2019

614
 30 Alarm Types
30.3 Creating a Change of State Alarm

38. Select When acknowledging an alarm: Action note to force the user to edit
the connected action note before the alarm can be acknowledged.
39. Select When acknowledging an alarm: Checklist to force the user to go
through the connected checklist before the alarm can be acknowledged.
40. Under Required User Actions
Actions, select the actions for Comment
Comment, Cause
note
note, and Action note to specify how the user should respond to the
actions.
41. Click Next
Next.

42. In the Attachment page, click the Add attachment button to add an
attachment.
43. In the Select Object dialog box, select the object you want to attach to the
alarm.
44. Click Select
Select.
45. On the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
46. Click Create
Create.

04-30005-01-en, May 2019 System

615
30 Alarm Types
30.4 Configuring a Change of State Alarm

30.4 Configuring a Change of State Alarm

You configure the properties of a change of state alarm to meet the unique
needs of your site.
For more information, see section 30.2 “Change of State Alarms” on page 612.

To configure a change of state alarm

1. In WorkStation, in the System Tree pane, select the change of state alarm
you want to configure.
2. On the File menu, click Properties
Properties.
3. Edit the basic settings:
Property Description

Type Displays the alarm type of the alarm.

Name Displays the name of the alarm.

Description Type to change the description of the

alarm.

4. Edit the alarm trigger properties:

Property Description

Trigger value Select True to trigger the alarm when

the monitored variable is equal to True.
Select False to trigger the alarm when
the monitored variable is equal to False.

Montiored variable Enter the path to the variable that is

monitored by the alarm.

Disable alarm Select to disable the alarm, for example,

before deployment.

Alarm state Displays the present state of the alarm.

For more information, see section 29.2
“Alarm States” on page 579.

Alarm delay (s) Enter the time, in seconds, the alarm

has to be within the alarm criteria before
the alarm is triggered.

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.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

System 04-30005-01-en, May 2019

616
 30 Alarm Types
30.4 Configuring a Change of State Alarm

Continued
Property Description

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable.
For more information, see section 31.4
“Shunt Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4
“Shunt Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

5. Edit the presentation properties:

Property Description

Alarm message Type the message to display when the

alarm in in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Prefix for alarm source name Add a substitution code or type a prefix
that is added to the beginning of the
source name property of an alarm
record.
For more information, see section 31.27
“Alarm Substitution Codes” on page
731.

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

04-30005-01-en, May 2019 System

617
30 Alarm Types
30.4 Configuring a Change of State Alarm

Continued
Property Description

Reset priority Enter the priority level of the alarm when

it is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Same priority Select to set all priorities to the same

value.
For more information, see section 31.9
“Alarm Priority” on page 710.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.

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.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Custom audio Enter the path to the custom audio file

you want to play when the alarm is
triggered.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm
State-Change Logging topic on
WebHelp.

6. Edit the user action properties:

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.

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.

Required User Actions Select what actions the user has to

perform when any of the listed events
occur.

System 04-30005-01-en, May 2019

618
 30 Alarm Types
30.4 Configuring a Change of State Alarm

7. Edit the attachment properties:

Property Description

Add attachment
Click to add an attachment to the alarm.
For more information, see section 31.21
“Alarm Attachments” on page 725.

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.

8. Click OK
OK.

04-30005-01-en, May 2019 System

619
30 Alarm Types
30.5 Multistate Alarms

30.5 Multistate Alarms

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.

NOTICE
• 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 31.1 “Alarm Functions” on page 699.

System 04-30005-01-en, May 2019

620
 30 Alarm Types
30.6 Creating a Multistate Alarm

30.6 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 EcoStruxure
BMS server where you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the Create Object wizard, 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. In the Alarm Trigger page, click the Add row button.

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.

NOTICE
• To define a unit of the alarm, the monitored variable must have a
defined unit.

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. In the Alarm Trigger page, 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. Select Invert to have the alarm enabled when the first shunt variable is
active.
20. In the Shunt variable 1 box, enter the binary variable that enables or
disables the alarm.

04-30005-01-en, May 2019 System

621
30 Alarm Types
30.6 Creating a Multistate Alarm

21. In the Operator list, select AND or OR to add logic between the first shunt
variable and the second shunt variable.
22. Select Invert to have the alarm enabled when the second shunt variable is
active.
23. In the Shunt variable 2 box, enter the binary variable that enables or
disables the alarm.
24. Click Next
Next.
25. In the Presentation page, in the Alarm message box, enter the message to
display when the monitored variable goes with or is equal to the alarm
limits.
26. In the Reset message box, enter the message to display when the alarm is
reset.
27. In the Category box, enter the category the alarm belongs to..
28. In the Category 2 box, enter the second category the alarm belongs to.
29. In the Prefix for alarm source name box, type a prefix that is added to the
beginning of the source name property of an alarm record.

NOTICE
You can add alarm substitution codes to a prefix for the alarm source
name. For more information, see section 31.27 “Alarm Substitution
Codes” on page 731.

30. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
31. Select Same priority to let all priorities inherit the value in the Alarm priority
box.
32. In the Reset priority box, enter the priority of the alarm when it is reset.
33. Select Auto hide to automatically hide the alarm from the Alarms pane or
Alarm View.
34. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
35. Select Audible alert to make the alarm sound when it is triggered.
36. In the Custom audio box, enter the path to the custom audio file you want
to play when the alarm is triggered.

NOTICE
If you have selected Audible alert but not selected any custom audio file,
the default alarm sound is played when the alarm is triggered.

37. Select Disable state-change logging to prevent an alarm state change

from creating an event.
38. Click Next
Next.

System 04-30005-01-en, May 2019

622
 30 Alarm Types
30.6 Creating a Multistate Alarm

39. In the User Action page, 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.
40. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
41. In the Action note group box, select the action note group that you want to
connect to the alarm.
42. In the Checklist box, select the checklist that you want to connect to the
alarm.
43. Select When acknowledging an alarm: Comment to force the user to add
a comment to the alarm before the alarm can be acknowledged.
44. Select When acknowledging an alarm: Cause note to force the user to edit
the connected cause note before the alarm can be acknowledged.
45. Select When acknowledging an alarm: Action note to force the user to edit
the connected action note before the alarm can be acknowledged.
46. Select When acknowledging an alarm: Checklist to force the user to go
through the connected checklist before the alarm can be acknowledged.
47. 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.
48. Click Next
Next.

49. In the Attachment page, click the Add attachment button to add an
attachment to the alarm.
50. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.
51. In the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
52. Click Create
Create.

04-30005-01-en, May 2019 System

623
30 Alarm Types
30.7 Configuring a Multistate Alarm

30.7 Configuring a Multistate Alarm

You configure the properties of a multistate alarm to meet the unique needs of
your site.
For more information, see section 30.5 “Multistate Alarms” on page 620.

To configure a multistate alarm

1. In WorkStation, in the System Tree pane, select the multistate alarm you
want to configure.
2. On the File menu, click Properties
Properties.
3. Edit the basic settings:
Property Description

Type Displays the alarm type of the alarm.

Name Displays the name of the alarm.

Description Type to change the description of the

alarm.

4. Edit the alarm trigger properties:

Property Description

Trigger alarm when variable is Select the value that triggers the alarm.

Add row
Click to add another alarm condition
that triggers the alarm.

Remove row
Click to remove an alarm condition.

Montiored variable Enter the path to the variable that is

monitored by the alarm.

Disable alarm Select to disable the alarm, for example,

before deployment.

Alarm state Displays the present state of the alarm.

For more information, see section 29.2
“Alarm States” on page 579.

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

System 04-30005-01-en, May 2019

624
 30 Alarm Types
30.7 Configuring a Multistate Alarm

Continued
Property Description

Alarm delay (s) Enter the time, in seconds, the alarm

has to be within the alarm criteria before
the alarm is triggered.

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.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable.
For more information, see section 31.4
“Shunt Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4
“Shunt Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

5. Edit the presentation properties:

Property Description

Alarm message Type the message to display when the

alarm in in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

04-30005-01-en, May 2019 System

625
30 Alarm Types
30.7 Configuring a Multistate Alarm

Continued
Property Description

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Prefix for alarm source name Add a substitution code or type a prefix
that is added to the beginning of the
source name property of an alarm
record.
For more information, see section 31.27
“Alarm Substitution Codes” on page
731.

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when

it is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Same priority Select to set all priorities to the same

value.
For more information, see section 31.9
“Alarm Priority” on page 710.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.

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.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Custom audio Enter the path to the custom audio file

you want to play when the alarm is
triggered.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm
State-Change Logging topic on
WebHelp.

System 04-30005-01-en, May 2019

626
 30 Alarm Types
30.7 Configuring a Multistate Alarm

6. Edit the user action properties:

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.

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.

Required User Actions Select what actions the user has to

perform when any of the listed events
occur.

7. Edit the attachment properties:

Property Description

Add attachment
Click to add an attachment to the alarm.
For more information, see section 31.21
“Alarm Attachments” on page 725.

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.

8. Click OK
OK.

04-30005-01-en, May 2019 System

627
30 Alarm Types
30.8 Matching Text String Alarms

30.8 Matching Text String Alarms

A matching text string alarm evaluates if the monitored value equals the given
text strings.

NOTICE
• The text string is case sensitive and must be written exactly as the monitored
variable text output.
• Wildcards cannot be used in the text string.

For example, a script program inside a b3 Continuum system generates text

strings that you want to monitor. You configure the matching text string alarm to
trigger an alarm when a certain string is sent from the device.
Matching text string alarms can be configured using shunt variable and time
delay. For more information, see section 31.1 “Alarm Functions” on page 699.

System 04-30005-01-en, May 2019

628
 30 Alarm Types
30.9 Creating a Matching Text String Alarm

30.9 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 EcoStruxure
BMS server where you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the Create Object wizard, 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. In the Alarm Trigger page, 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.

NOTICE
• The text string is case sensitive and must be written exactly as the
monitored variable text output.
• Wildcards cannot be used in the text string.

8. Click the Add row button 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 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. Select Invert to have the alarm enabled when the first shunt variable is
active.
14. In the Shunt variable 1 box, enter the binary variable that enables or
disables the alarm.
15. In the Operator list, select AND or OR to add logic between the first shunt
variable and the second shunt variable.
16. Select Invert to have the alarm enabled when the second shunt variable is
active.
17. In the Shunt variable 2 box, enter the binary variable that enables or
disables the alarm
18. Click Next
Next.

04-30005-01-en, May 2019 System

629
30 Alarm Types
30.9 Creating a Matching Text String Alarm

19. In the Presentation page, in the Alarm message box, enter the message to
display when the monitored variable goes with or is equal to the alarm
limits.
20. In the Reset message box, enter the message to display when the alarm is
reset.
21. In the Category box, enter the category the alarm belongs to.
22. In the Category 2 box, enter the second category the alarm belongs to..
23. In the Prefix for alarm source name box, type a prefix that is added to the
beginning of the source name property of an alarm record.

NOTICE
You can add alarm substitution codes to a prefix for the alarm source
name. For more information, see section 31.27 “Alarm Substitution
Codes” on page 731.

24. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
25. Select Same priority to let all priorities inherit the value in the Alarm priority
box.
26. In the Reset priority box, enter the priority of the alarm when it is reset.
27. Select Auto hide to automatically hide the alarm from the Alarms pane or
Alarm View.
28. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
29. Select Audible alert to make the alarm sound when it is triggered.
30. In the Custom audio box, enter the path to the custom audio file you want
to play when the alarm is triggered.

NOTICE
If you have selected Audible alert but not selected any custom audio file,
the default alarm sound is played when the alarm is triggered.

31. Select Disable state-change logging to prevent an alarm state change

from creating an event.
32. Click Next
Next.
33. In the User Action page, 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.

System 04-30005-01-en, May 2019

630
 30 Alarm Types
30.9 Creating a Matching Text String Alarm

34. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
35. In the Action note group box, select the action note group that you want to
connect to the alarm.
36. In the Checklist box, select the checklist that you want to connect to the
alarm.
37. Select When acknowledging an alarm: Comment to force the user to add
a comment to the alarm before the alarm can be acknowledged.
38. Select When acknowledging an alarm: Cause note to force the user to edit
the connected cause note before the alarm can be acknowledged.
39. Select When acknowledging an alarm: Action note to force the user to edit
the connected action note before the alarm can be acknowledged.
40. Select When acknowledging an alarm: Checklist to force the user to go
through the connected checklist before the alarm can be acknowledged.
41. Under Required user actions
actions, select the actions for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
42. Click Next
Next.

43. In the Attachment page, click the Add attachment button .

44. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.
45. In the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
46. Click Create
Create.

04-30005-01-en, May 2019 System

631
30 Alarm Types
30.10 Configuring a Matching Text String Alarm

30.10 Configuring a Matching Text String

Alarm
You configure the properties of a matching text string alarm to meet the unique
needs of your site.
For more information, see section 30.8 “Matching Text String Alarms” on page
628.

To configure a matching text string alarm

1. In WorkStation, in the System Tree pane, select the matching text string
alarm you want to configure.
2. On the File menu, click Properties
Properties.
3. Edit the basic settings:
Property Description

Type Displays the alarm type of the alarm.

Name Displays the name of the alarm.

Description Type to change the description of the

alarm.

4. Edit the alarm trigger properties:

Property Description

Trigger alarm when variable is Select the value that triggers the alarm.

Add row
Click to add another alarm condition
that triggers the alarm.

Remove row
Click to remove an alarm condition.

Montiored variable Enter the path to the variable that is

monitored by the alarm.

Disable alarm Select to disable the alarm, for example,

before deployment.

Alarm state Displays the present state of the alarm.

For more information, see section 29.2
“Alarm States” on page 579.

System 04-30005-01-en, May 2019

632
 30 Alarm Types
30.10 Configuring a Matching Text String Alarm

Continued
Property 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

Alarm delay (s) Enter the time, in seconds, the alarm

has to be within the alarm criteria before
the alarm is triggered.

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.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable.
For more information, see section 31.4
“Shunt Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4
“Shunt Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

5. Edit the presentation properties:

Property Description

Alarm message Type the message to display when the

alarm in in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

04-30005-01-en, May 2019 System

633
30 Alarm Types
30.10 Configuring a Matching Text String Alarm

Continued
Property Description

Reset message Type the message to display when the

alarm is reset.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Prefix for alarm source name Add a substitution code or type a prefix
that is added to the beginning of the
source name property of an alarm
record.
For more information, see section 31.27
“Alarm Substitution Codes” on page
731.

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when

it is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Same priority Select to set all priorities to the same

value.
For more information, see section 31.9
“Alarm Priority” on page 710.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.

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.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Custom audio Enter the path to the custom audio file

you want to play when the alarm is
triggered.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

System 04-30005-01-en, May 2019

634
 30 Alarm Types
30.10 Configuring a Matching Text String Alarm

Continued
Property Description

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm
State-Change Logging topic on
WebHelp.

6. Edit the user action properties:

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.

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.

Required User Actions Select what actions the user has to

perform when any of the listed events
occur.

7. Edit the attachment properties:

Property Description

Add attachment
Click to add an attachment to the alarm.
For more information, see section 31.21
“Alarm Attachments” on page 725.

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.

8. Click OK
OK.

04-30005-01-en, May 2019 System

635
30 Alarm Types
30.11 Variable Status Alarms

30.11 Variable Status Alarms

The variable status alarm monitors the status of a variable. The alarm is
triggered when the value of the monitored variable is either forced, overridden or
offline. If you configure the alarm to trigger on all statuses, the alarm is triggered
immediately when the variable changes to one of the statuses.
The override status indicates that the value of a variable is adjusted by the I/O
hardware, and is not the measured value. For more information, see the Output
Override Status topic on WebHelp.
The force status indicates that the value of a variable is adjusted by the
software, and is not the measured value. For more information, see the Force
and Unforce Buttons topic on WebHelp.
The offline status indicates that the status of the monitored variable is offline.
For example, you can use the variable status alarm to get a notification when a
technician overrides the variable on an I/O module.
You can configure the variable status alarms using shunt variable and time
delay. For more information, see section 31.1 “Alarm Functions” on page 699.

Monitored Value in Alarms Pane or Alarm View

The Value at change column, in the Alarms pane or Alarm View, displays the
value of the monitored variable when the alarm changed state. For a variable
status alarm, the Value at change column displays the status of the monitored
variable:
• (Blank: Neither forced, overridden, nor offline)
• Forced
• Overridden
• Offline
• Any combination of forced, overridden, and offline

System 04-30005-01-en, May 2019

636
 30 Alarm Types
30.12 Creating a Variable Status Alarm

30.12 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 EcoStruxure
BMS server where you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. Inthe Create Object wizard, 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.
7. In the Alarm Trigger page, select Forced to trigger the alarm when the
monitored variable status changes to force.
8. Select Overridden to trigger the alarm when the monitored variable status
changes to override.
9. Select Offline to trigger the alarm when the device with the monitored
variable is offline.
10. In the Monitored variable box, enter the variable that the alarm monitors.
11. In the Disable alarm box, select to create the alarm in disabled mode.
12. In the Alarm delay box, enter the time delay before the alarm is triggered.
13. In the Reset delay box, enter the time delay before the alarm is reset.
14. Select Invert to have the alarm enabled when the first shunt variable is
active.
15. In the Shunt variable 1 box, enter the binary variable that enables or
disables the alarm.
16. In the Operator list, select AND or OR to add logic between the first shunt
variable and the second shunt variable.
17. Select Invert to have the alarm enabled when the second shunt variable is
active.
18. In the Shunt variable 2 box, enter the binary variable that enables or
disables the alarm.
19. Click Next
Next.
20. In the Presentation page, in the Alarm message box, enter the message to
display when the monitored variable goes with or is equal to the alarm
limits.
21. In the Reset message box, enter the message to display when the alarm is
reset.
Continued on next page

04-30005-01-en, May 2019 System

637
30 Alarm Types
30.12 Creating a Variable Status Alarm

22. In the Category box, enter the category the alarm belongs to.
23. In the Category 2 box, enter the second category the alarm belongs to.
24. In the Prefix for alarm source name box, type a prefix that is added to the
beginning of the source name property of an alarm record.

NOTICE
You can add alarm substitution codes to a prefix for the alarm source
name. For more information, see section 31.27 “Alarm Substitution
Codes” on page 731.

25. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
26. Select Same priority to let all priorities inherit the value in the Alarm priority
box.
27. In the Reset priority box, enter the priority of the alarm when it is reset.
28. Select Auto hide to automatically hide the alarm from the Alarms pane or
Alarm View.
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 the alarm sound when it is triggered.
31. In the Custom audio box, enter the path to the custom audio file you want
to play when the alarm is triggered.

NOTICE
If you have selected Audible alert but not selected any custom audio file,
the default alarm sound is played when the alarm is triggered.

32. Select Disable state-change logging to prevent an alarm state change

from creating an event.
33. Click Next
Next.
34. In the User Action page, 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.
35. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
36. In the Action note group box, select the action note group that you want to
connect to the alarm.
37. In the Checklist box, select the checklist that you want to connect to the
alarm.

System 04-30005-01-en, May 2019

638
 30 Alarm Types
30.12 Creating a Variable Status Alarm

38. Select When acknowledging an alarm: Comment to force the user to add
a comment to the alarm before the alarm can be acknowledged.
39. Select When acknowledging an alarm: Cause note to force the user to edit
the connected cause note before the alarm can be acknowledged.
40. Select When acknowledging an alarm: Action note to force the user to edit
the connected action note before the alarm can be acknowledged.
41. Select When acknowledging an alarm: Checklist to force the user to go
through the connected checklist before the alarm can be acknowledged.
42. Under Required user actions
actions, select the actions for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
43. Click Next
Next.

44. In the Attachment page, click the Add attachment button to add an
attachment to the alarm.
45. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.
46. In the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
47. Click Create
Create.

04-30005-01-en, May 2019 System

639
30 Alarm Types
30.13 Configuring a Variable Status Alarm

30.13 Configuring a Variable Status Alarm

You configure the properties of a variable status alarm to meet the unique needs
of your site.
For more information, see section 30.11 “Variable Status Alarms” on page 636.

To configure a variable status alarm

1. In WorkStation, in the System Tree pane, select the variable status alarm
you want to configure.
2. On the File menu, click Properties
Properties.
3. Edit the basic settings:
Property Description

Type Displays the alarm type of the alarm.

Name Displays the name of the alarm.

Description Type to change the description of the

alarm.

4. Edit the alarm trigger properties:

Property Description

Trigger when variable is Select the statuses of the monitored

variable that trigger the alarm.
• Forced means that the alarm is
triggered when the monitored
variable status is forced. For more
information, see the Force and
Unforce Buttons topic on
WebHelp.
• Overridden means that the alarm is
triggered when the monitored
variable status is overridden. For
more information, see the Output
Override Status topic on WebHelp.
• Offline means that the alarm is
triggered when the monitored
variable is off line.

Montiored variable Enter the path to the variable that is

monitored by the alarm.

Disable alarm Select to disable the alarm, for example,

before deployment.

Alarm state Displays the present state of the alarm.

For more information, see section 29.2
“Alarm States” on page 579.

System 04-30005-01-en, May 2019

640
 30 Alarm Types
30.13 Configuring a Variable Status Alarm

Continued
Property 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

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

Reset delay (s) Enter the time, in seconds, the alarm

has to be within the alarm criteria before
the alarm is triggered.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable.
For more information, see section 31.4
“Shunt Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4
“Shunt Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

5. Edit the presentation properties:

Property Description

Alarm message Type the message to display when the

alarm in in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

04-30005-01-en, May 2019 System

641
30 Alarm Types
30.13 Configuring a Variable Status Alarm

Continued
Property Description

Reset message Type the message to display when the

alarm is reset.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Prefix for alarm source name Add a substitution code or type a prefix
that is added to the beginning of the
source name property of an alarm
record.
For more information, see section 31.27
“Alarm Substitution Codes” on page
731.

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when

it is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Same priority Select to set all priorities to the same

value.
For more information, see section 31.9
“Alarm Priority” on page 710.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.

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.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Custom audio Enter the path to the custom audio file

you want to play when the alarm is
triggered.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

System 04-30005-01-en, May 2019

642
 30 Alarm Types
30.13 Configuring a Variable Status Alarm

Continued
Property Description

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm
State-Change Logging topic on
WebHelp.

6. Edit the user action properties:

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.

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.

Required User Actions Select what actions the user has to

perform when any of the listed events
occur.

7. Edit the attachement properties:

Property Description

Add attachment
Click to add an attachment to the alarm.
For more information, see section 31.21
“Alarm Attachments” on page 725.

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.

8. Click OK
OK.

04-30005-01-en, May 2019 System

643
30 Alarm Types
30.14 Out of Range Alarms

30.14 Out of Range Alarms

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 31.1 “Alarm Functions” on page
699.

System 04-30005-01-en, May 2019

644
 30 Alarm Types
30.15 Creating an Out of Range Alarm

30.15 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 30.14 “Out of Range Alarms” on page 644.

To create an out of range alarm

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS server where you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the Create Object wizard, 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.
7. In the Alarm Trigger page, 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.

NOTICE
• If the monitored value has a unit of measurement defined, the alarm
limits and deadband are assigned that unit by default.

12. In the Unit Selection dialog box, 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 to create the alarm in disabled mode.
16. Under Time Delay and Shunt Variables
Variables, in the Alarm delay box, enter the
time delay.
17. In the Reset delay box, enter the time delay.
18. Select Invert to have the alarm enabled when the first shunt variable is
active.
19. In the Shunt variable 1 box, enter the digital variable that enables or
disables the alarm.
20. In the Operator list, select AND or OR to add logic between the first shunt
variable and the second shunt variable.
21. Select Invert to have the alarm enabled when the second shunt variable is
active.

04-30005-01-en, May 2019 System

645
30 Alarm Types
30.15 Creating an Out of Range Alarm

22. In the Shunt variable 2 box, enter the digital variable that enables or
disables the alarm.
23. Click Next
Next.
24. In the Presentation page, in the Above upper limit message box, type the
message to display when the alarm exceeds the upper limit.
25. In the Below lower limit message box, type the message to display when
the alarm falls below the lower limit.
26. In the Reset message box, type the message to display when the alarm is
reset.
27. In the Category box, enter the category the alarm belongs to.
28. In the Category 2 box, enter the second category the alarm belongs to.
29. In the Prefix for alarm source name box, type a prefix that is added to the
beginning of the source name property of an alarm record.

NOTICE
You can add alarm substitution codes to a prefix for the alarm source
name. For more information, see section 31.27 “Alarm Substitution
Codes” on page 731.

30. In the Above upper limit priority box, enter the priority for the upper limit of
the alarm state.
31. Select Same priority to let all priorities inherit the value in the Above upper
limit priority box.
32. In the Below lower limit priority box, enter the priority for the lower limit of
the alarm state.
33. In the Reset priority box, enter the priority for the reset state.
34. Select Auto hide to automatically hide the alarm from the Alarms pane or
Alarm View.
35. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
36. Select Audible alert to make the alarm sound when it is triggered.
37. In the Custom audio box, enter the path to the custom audio file you want
to play when the alarm is triggered.

NOTICE
If you have selected Audible alert but not selected any custom audio file,
the default alarm sound is played when the alarm is triggered.

38. Select Disable state-change logging to prevent an alarm state change

from creating an event.
39. Click Next
Next.

System 04-30005-01-en, May 2019

646
 30 Alarm Types
30.15 Creating an Out of Range Alarm

40. In the User Action page, 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.
41. In the Cause note group box, enter the cause note group that you want to
connect to the alarm.
42. In the Action note group box, enter the action note group that you want to
connect to the alarm.
43. In the Checklist box, enter the checklist that you want to connect to the
alarm.
44. Select When acknowledging an alarm: Comment to force the user to add
a comment to the alarm before the alarm can be acknowledged.
45. Select When acknowledging an alarm: Cause note to force the user to edit
the connected cause note before the alarm can be acknowledged.
46. Select When acknowledging an alarm: Action note to force the user to edit
the connected action note before the alarm can be acknowledged.
47. Select When acknowledging an alarm: Checklist to force the user to go
through the connected checklist before the alarm can be acknowledged.
48. Under Required User Actions
Actions, select the actions for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
49. Click Next
Next.

50. In the Attachment page, click the Add attachment button to add an
attachment.
51. In the Select Object dialog box, select the object you want to attach to the
alarm.
52. Click Select
Select.
53. In the Display on alarm column, select the check box to automatically
open the attachment when the alarm is triggered.
54. Click Create
Create.

04-30005-01-en, May 2019 System

647
30 Alarm Types
30.16 Configuring an Out of Range Alarm

30.16 Configuring an Out of Range Alarm

You configure the properties of an out of range alarm to meet the unique needs
of your site.
For more information, see section 30.14 “Out of Range Alarms” on page 644.

To configure an out of range alarm

1. In WorkStation, in the System Tree pane, select the out of range alarm you
want to configure.
2. On the File menu, click Properties
Properties.
3. Edit the basic settings:
Property Description

Type Displays the alarm type of the alarm.

Name Displays the name of the alarm.

Description Type to change the description of the

alarm.

4. Edit the alarm trigger properties:

Property 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 Select to disable the alarm, for example,

before deployment.

Alarm state Displays the present state of the alarm.

For more information, see section 29.2
“Alarm States” on page 579.

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

System 04-30005-01-en, May 2019

648
 30 Alarm Types
30.16 Configuring an Out of Range Alarm

Continued
Property Description

Alarm delay (s) Enter the time, in seconds, the alarm

has to be within the alarm criteria before
the alarm is triggered.

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.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable.
For more information, see section 31.4
“Shunt Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4
“Shunt Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

5. Edit the presentation properties:

Property Description

Above upper limit message Type the message to display when the
variable exceeds the upper limit of the
alarm.
For more information, see section 31.7
“Alarm Messages” on page 708.

Below lower limit message Type the message to display when the
variable falls below the lower limit.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.
For more information, see section 31.7
“Alarm Messages” on page 708.

04-30005-01-en, May 2019 System

649
30 Alarm Types
30.16 Configuring an Out of Range Alarm

Continued
Property Description

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Prefix for alarm source name Add a substitution code or type a prefix
that is added to the beginning of the
source name property of an alarm
record.
For more information, see section 31.27
“Alarm Substitution Codes” on page
731.

Above upper limit priority Enter the priority level of the alrm when
the variable exceeds the upper limit.
For more information, see section 31.9
“Alarm Priority” on page 710.

Below lower limit priority Enter the priority level of the alarm when
the variable falls below the lower limit.
For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when

it is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Same priority Select to set all priorities to the same

value.
For more information, see section 31.9
“Alarm Priority” on page 710.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.

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.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

System 04-30005-01-en, May 2019

650
 30 Alarm Types
30.16 Configuring an Out of Range Alarm

Continued
Property Description

Custom audio Enter the path to the custom audio file

you want to play when the alarm is
triggered.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm
State-Change Logging topic on
WebHelp.

6. Edit the user action properties:

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.

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.

Required User Actions Select what actions the user has to

perform when any of the listed events
occur.

7. Edit the attachment properties:

Property Description

Add attachment
Click to add an attachment to the alarm.
For more information, see section 31.21
“Alarm Attachments” on page 725.

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.

8. Click OK
OK.

04-30005-01-en, May 2019 System

651
30 Alarm Types
30.17 Out of Reference Range Alarms

30.17 Out of Reference Range Alarms

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.

NOTICE
• 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 31.1 “Alarm Functions”
on page 699.

System 04-30005-01-en, May 2019

652
 30 Alarm Types
30.18 Creating an Out of Reference Range Alarm

30.18 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 EcoStruxure
BMS server where you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the Create Object wizard, 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.
7. In the Alarm Trigger page, 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.

NOTICE
• If the monitored value has a unit of measurement defined, the alarm
limits and deadband are assigned that unit by default.

12. In the Unit Selection dialog box, 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.
19. Select Invert to have the alarm enabled when the first shunt variable is
active.

04-30005-01-en, May 2019 System

653
30 Alarm Types
30.18 Creating an Out of Reference Range Alarm

20. In the Alarm Trigger page, in the Shunt variable 1 box, enter the digital
variable that enables or disables the alarm.
21. In the Operator list, select AND or OR to add logic between the first shunt
variable and the second shunt variable.
22. Select Invert to have the alarm enabled when the second shunt variable is
active.
23. In the Shunt variable 2 box, enter the digital variable that enables or
disables the alarm.
24. Click Next
Next.
25. In the Presentation page, in the Above upper limit message box, type the
message to display when the monitored variable exceeds the upper alarm
limit.
26. In the Below lower limit message box, type the message to display when
the monitored variable falls below the lower alarm limit.
27. In the Reset message box, type the message to display when the alarm is
reset.
28. In the Category box, enter the category the alarm belongs to.
29. In the Category 2 box, enter the second category the alarm belongs to.
30. In the Prefix for alarm source name box, type a prefix that is added to the
beginning of the source name property of an alarm record.

NOTICE
You can add alarm substitution codes to a prefix for the alarm source
name. For more information, see section 31.27 “Alarm Substitution
Codes” on page 731.

31. In the Above upper limit priority box, enter the priority of the alarm when
the monitored variable exceeds the upper alarm limit.
32. Select Same priority to let all priorities inherit the value in the Above upper
limit priority box.
33. In the Below lower limit priority box, enter the priority of the alarm when the
monitored variable falls bellow the lower alarm limit.
34. In the Reset priority box, enter the priority for alarm when it is reset.
35. Select Auto hide to automatically hide the alarm from the Alarms pane or
Alarm View.
36. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
37. Select Audible alert to make a sound when the alarm is triggered.
38. In the Custom audio box, enter the path to the custom audio file you want
to play when the alarm is triggered.

NOTICE
If you have selected Audible alert but not selected any custom audio file,
the default alarm sound is played when the alarm is triggered.

System 04-30005-01-en, May 2019

654
 30 Alarm Types
30.18 Creating an Out of Reference Range Alarm

39. Select Disable state-change logging to prevent an alarm state change

from creating an event.
40. Click Next
Next.
41. In the User Action page, 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.
42. In the Cause note group box, enter the cause note group that you want to
connect to the alarm.
43. In the Action note group box, enter the action note group that you want to
connect to the alarm.
44. In the Checklist box, enter the checklist that you want to connect to the
alarm.
45. Select When acknowledging an alarm: Comment to force the user to add
a comment to the alarm before the alarm can be acknowledged.
46. Select When acknowledging an alarm: Cause note to force the user to edit
the connected cause note before the alarm can be acknowledged.
47. Select When acknowledging an alarm: Action note to force the user to edit
the connected action note before the alarm can be acknowledged.
48. Select When acknowledging an alarm: Checklist to force the user to go
through the connected checklist before the alarm can be acknowledged.
49. Under Required user actions
actions, select the actions for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
50. Click Next
Next.

51. In the Attachment page, click the Add attachment button to add an
attachment to the alarm.
52. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.
53. On the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
54. Click Create
Create.

04-30005-01-en, May 2019 System

655
30 Alarm Types
30.19 Configuring an Out of Reference Range Alarm

30.19 Configuring an Out of Reference Range

Alarm
You configure the properties of a out of reference range alarm to meet the
unique needs of your site.
For more information, see section 30.17 “Out of Reference Range Alarms” on
page 652.

To configure an out of reference range alarm

1. In WorkStation, in the System Tree pane, select the out of reference range
alarm you want to configure.
2. On the File menu, click Properties
Properties.
3. Edit the basic settings:
Property Description

Type Displays the alarm type of the alarm.

Name Displays the name of the alarm.

Description Type to change the description of the

alarm.

4. Edit the alarm trigger properties:

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

Reference variable Enter the reference variable that is

compared with the monitored variable.

Disable alarm Select to disable the alarm, for example,

before deployment.

Alarm state Displays the present state of the alarm.

For more information, see section 29.2
“Alarm States” on page 579.

System 04-30005-01-en, May 2019

656
 30 Alarm Types
30.19 Configuring an Out of Reference Range Alarm

Continued
Property 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

Alarm delay (s) Enter the time, in seconds, the alarm

has to be within the alarm criteria before
the alarm is triggered.

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.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable.
For more information, see section 31.4
“Shunt Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4
“Shunt Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

657
30 Alarm Types
30.19 Configuring an Out of Reference Range Alarm

5. Edit the presentation properties:

Property Description

Above upper limit message Type the message to display when the
variable exceeds the upper limit of the
alarm.
For more information, see section 31.7
“Alarm Messages” on page 708.

Below lower limit message Type the message to display when the
variable falls below the lower limit.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.
For more information, see section 31.7
“Alarm Messages” on page 708.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Prefix for alarm source name Add a substitution code or type a prefix
that is added to the beginning of the
source name property of an alarm
record.
For more information, see section 31.27
“Alarm Substitution Codes” on page
731.

Above upper limit priority Enter the priority level of the alrm when
the variable exceeds the upper limit.
For more information, see section 31.9
“Alarm Priority” on page 710.

Below lower limit priority Enter the priority level of the alarm when
the variable falls below the lower limit.
For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when

it is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Same priority Select to set all priorities to the same

value.
For more information, see section 31.9
“Alarm Priority” on page 710.

System 04-30005-01-en, May 2019

658
 30 Alarm Types
30.19 Configuring an Out of Reference Range Alarm

Continued
Property Description

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.

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.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Custom audio Enter the path to the custom audio file

you want to play when the alarm is
triggered.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm
State-Change Logging topic on
WebHelp.

6. Edit the user action properties:

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.

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.

Required User Actions Select what actions the user has to

perform when any of the listed events
occur.

7. Edit the attachment properties:

Property Description

Add attachment
Click to add an attachment to the alarm.
For more information, see section 31.21
“Alarm Attachments” on page 725.

Continued on next page

04-30005-01-en, May 2019 System

659
30 Alarm Types
30.19 Configuring an Out of Reference Range Alarm

Continued
Property Description

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.

8. Click OK
OK.

System 04-30005-01-en, May 2019

660
 30 Alarm Types
30.20 Sum Alarms

30.20 Sum Alarms

A sum alarm can be seen as a collection of alarms that have one or several
common denominators. The conditions you use to filter which alarms the sum
alarm monitors are the same conditions you use to filter the Alarms pane or an
Alarm View. You can use wildcards when setting up filter conditions. For more
information, see section 36.12 “Filter Condition Wildcards ” on page 1081.
For example, when an alarm is triggered you want to light a red indication 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.
In a multi-server system, a Sum Alarm created on the a parent server functions
as a container for alarms triggered on the child servers. For example, a Sum
Alarm created on an Enterprise Central functions as a container for all alarms
triggered in the system:
• on the Enterprise Servers connected to the Enterprise Central
• alarms on the SmartX servers connected to those Enterprise Servers
The advantage of creating the sum alarm on the parent server is that you do not
need to create separate sum alarms for child server.

04-30005-01-en, May 2019 System

661
30 Alarm Types
30.21 Creating a Sum Alarm

30.21 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 EcoStruxure
BMS server where you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the Create Object wizard, 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.

7. In the Alarm Trigger page, click the Add condition button to add
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 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. Select Invert to have the alarm enabled when the first shunt variable is
active.
13. In the Shunt variable 1 box, enter the binary variable that enables or
disables the alarm.
14. In the Operator list, select AND or OR to add logic between the first shunt
variable and the second shunt variable.
15. Select Invert to have the alarm enabled when the second shunt variable is
active.
16. In the Shunt variable 2 box, enter the binary variable that enables or
disables the alarm.
17. Click Next
Next.
18. In the Presentation page, in the Alarm message box, enter the message to
display when the monitored variable goes with or is equal to the alarm
limits.
19. In the Reset message box, enter the message to display when the alarm is
reset.
20. In the Category box, enter the category the alarm belongs to.
21. In the Category 2 box, enter the second category the alarm belongs to.
Continued on next page

System 04-30005-01-en, May 2019

662
 30 Alarm Types
30.21 Creating a Sum Alarm

22. In the Prefix for alarm source name box, type a prefix that is added to the
beginning of the source name property of an alarm record.

NOTICE
You can add alarm substitution codes to a prefix for the alarm source
name. For more information, see section 31.27 “Alarm Substitution
Codes” on page 731.

23. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
24. Select Same priority 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. Select Auto hide to automatically hide the alarm from the Alarms pane or
Alarm View.
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. In the Custom audio box, enter the path to the custom audio file you want
to play when the alarm is triggered.

NOTICE
If you have selected Audible alert but not selected any custom audio file,
the default alarm sound is played when the alarm is triggered.

30. Select Disable state-change logging to prevent an alarm state change

from creating an event.
31. Click Next
Next.
32. In the User Action page, 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.
33. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
34. In the Action note group box, select the action note group that you want to
connect to the alarm.
35. In the Checklist box, select the checklist that you want to connect to the
alarm.
36. Select When acknowledging an alarm: Comment to force the user to add
a comment to the alarm before the alarm can be acknowledged.

04-30005-01-en, May 2019 System

663
30 Alarm Types
30.21 Creating a Sum Alarm

37. Select When acknowledging an alarm: Cause note to force the user to edit
the connected cause note before the alarm can be acknowledged.
38. Select When acknowledging an alarm: Action note to force the user to edit
the connected action note before the alarm can be acknowledged.
39. Select When acknowledging an alarm: Checklist to force the user to go
through the connected checklist before the alarm can be acknowledged.
40. Under Required user actions
actions, select the actions for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
41. Click Next
Next.

42. In the Attachment page, 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. In 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-30005-01-en, May 2019

664
 30 Alarm Types
30.22 Configuring a Sum Alarm

30.22 Configuring a Sum Alarm

You configure the properties of a sum alarm to meet the unique needs of your
site.
For more information, see section 30.20 “Sum Alarms” on page 661.

To configure a sum alarm

1. In WorkStation, in the System Tree pane, select the sum alarm you want to
configure.
2. On the File menu, click Properties
Properties.
3. Edit the basic settings:
Property Description

Type Displays the alarm type of the alarm.

Name Displays the name of the alarm.

Description Type to change the description of the

alarm.

4. Edit the alarm trigger properties:

Property Description

Add condition
Select the alarm filter conditions for the
alarms you want to include.

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.

Clear all
Click to clear the selected conditions.

Disable alarm Select to disable the alarm, for example,

before deployment.

Alarm state Displays the present state of the alarm.

For more information, see section 29.2
“Alarm States” on page 579.

Matching alarms count Displays the number of alarms that

currently meet the criteria of the sum
alarm.

04-30005-01-en, May 2019 System

665
30 Alarm Types
30.22 Configuring a Sum Alarm

Continued
Property Description

Alarm delay (s) Enter the time, in seconds, the alarm

has to be within the alarm criteria before
the alarm is triggered.

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.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable.
For more information, see section 31.4
“Shunt Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4
“Shunt Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

5. Edit the presentation properties:

Property Description

Alarm message Type the message to display when the

alarm in in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

System 04-30005-01-en, May 2019

666
 30 Alarm Types
30.22 Configuring a Sum Alarm

Continued
Property Description

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Prefix for alarm source name Add a substitution code or type a prefix
that is added to the beginning of the
source name property of an alarm
record.
For more information, see section 31.27
“Alarm Substitution Codes” on page
731.

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when

it is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Same priority Select to set all priorities to the same

value.
For more information, see section 31.9
“Alarm Priority” on page 710.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.

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.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Custom audio Enter the path to the custom audio file

you want to play when the alarm is
triggered.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm
State-Change Logging topic on
WebHelp.

04-30005-01-en, May 2019 System

667
30 Alarm Types
30.22 Configuring a Sum Alarm

6. Edit the user action properties:

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.

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.

Required User Actions Select what actions the user has to

perform when any of the listed events
occur.

7. Edit the attachment properties:

Property Description

Add attachment
Click to add an attachment to the alarm.
For more information, see section 31.21
“Alarm Attachments” on page 725.

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.

8. Click OK
OK.

System 04-30005-01-en, May 2019

668
 30 Alarm Types
30.23 Enumeration Alarms

30.23 Enumeration Alarms

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.
Enumeration alarms can be configured using shunt variable and time delay. For
more information, see section 31.1 “Alarm Functions” on page 699.

04-30005-01-en, May 2019 System

669
30 Alarm Types
30.24 Creating an Enumeration Alarm

30.24 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 EcoStruxure
BMS server where you want to create the alarm.
2. On the File menu, point to New and then click Alarm
Alarm.
3. In the Create Object wizard, 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.
7. In the Alarm Trigger page, 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. In the Disable alarm box, select 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. Select Invert to have the alarm enabled when the first shunt variable is
active.
13. In the Shunt variable 1 box, enter the binary variable that enables or
disables the alarm.
14. In the Operator list, select AND or OR to add logic between the first shunt
variable and the second shunt variable.
15. Select Invert to have the alarm enabled when the second shunt variable is
active.
16. In the Shunt variable 2 box, enter the binary variable that enables or
disables the alarm.
17. Click Next
Next.
18. In the Presentation page, in the Alarm message box, enter the message to
display when the monitored variable goes with or is equal to the alarm
limits.
19. In the Reset message box, enter the message to display when the alarm is
reset.
20. In the Category box, enter the category the alarm belongs to.
21. In the Category 2 box, enter the second category the alarm belongs to.
Continued on next page

System 04-30005-01-en, May 2019

670
 30 Alarm Types
30.24 Creating an Enumeration Alarm

22. In the Prefix for alarm source name box, type a prefix that is added to the
beginning of the source name property of an alarm record.

NOTICE
You can add alarm substitution codes to a prefix for the alarm source
name. For more information, see section 31.27 “Alarm Substitution
Codes” on page 731.

23. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
24. Select Same priority 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. Select Auto hide to automatically hide the alarm from the Alarms pane or
Alarm View.
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. In the Custom audio box, enter the path to the custom audio file you want
to play when the alarm is triggered.

NOTICE
If you have selected Audible alert but not selected any custom audio file,
the default alarm sound is played when the alarm is triggered.

30. Select Disable state-change logging to prevent an alarm state change

from creating an event.
31. Click Next
Next.
32. In the User Action page, 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.
33. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
34. In the Action note group box, select the action note group that you want to
connect to the alarm.
35. In the Checklist box, select the checklist that you want to connect to the
alarm.
36. Select When acknowledging an alarm: Comment to force the user to add
a comment to the alarm before the alarm can be acknowledged.

04-30005-01-en, May 2019 System

671
30 Alarm Types
30.24 Creating an Enumeration Alarm

37. Select When acknowledging an alarm: Cause note to force the user to edit
the connected cause note before the alarm can be acknowledged.
38. Select When acknowledging an alarm: Action note to force the user to edit
the connected action note before the alarm can be acknowledged.
39. Select When acknowledging an alarm: Checklist to force the user to go
through the connected checklist before the alarm can be acknowledged.
40. Under Required User Actions
Actions, select the actions for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
41. Click Next
Next.

42. In the Attachment page, 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. In 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-30005-01-en, May 2019

672
 30 Alarm Types
30.25 Configuring an Enumeration Alarm

30.25 Configuring an Enumeration Alarm

You configure the properties of an enumeration alarm to meet the unique needs
of your site.
For more information, see section 30.23 “Enumeration Alarms” on page 669.

To configure an enumeration alarm

1. In WorkStation, in the System Tree pane, select the enumeration alarm you
want to configure.
2. On the File menu, click Properties
Properties.
3. Edit the basic settings:
Property Description

Type Displays the alarm type of the alarm.

Name Displays the name of the alarm.

Description Type to change the description of the

alarm.

4. Edit the alarm trigger properties:

Property Description

Trigger alarm when variable is Select the enumeration values that

trigger the alarm.

Montiored variable Enter the variable together with the

enumeration to monitor.

Disable alarm Select to disable the alarm, for example,

before deployment.

Alarm state Displays the present state of the alarm.

For more information, see section 29.2
“Alarm States” on page 579.

Disabled cause Select to disable the alarm, for example,

before deployment.

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

Reset delay (s) Enter the time, in seconds, the alarm

has to be within the alarm criteria before
the alarm is triggered.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

673
30 Alarm Types
30.25 Configuring an Enumeration Alarm

Continued
Property Description

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable.
For more information, see section 31.4
“Shunt Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4
“Shunt Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value
is active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

5. Edit the presentation properties:

Property Description

Alarm message Type the message to display when the

alarm in in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Prefix for alarm source name Add a substitution code or type a prefix
that is added to the beginning of the
source name property of an alarm
record.
For more information, see section 31.27
“Alarm Substitution Codes” on page
731.

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

System 04-30005-01-en, May 2019

674
 30 Alarm Types
30.25 Configuring an Enumeration Alarm

Continued
Property Description

Reset priority Enter the priority level of the alarm when

it is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Same priority Select to set all priorities to the same

value.
For more information, see section 31.9
“Alarm Priority” on page 710.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.

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.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Custom audio Enter the path to the custom audio file

you want to play when the alarm is
triggered.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm
State-Change Logging topic on
WebHelp.

6. Edit the user action properties:

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.

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.

Required User Actions Select what actions the user has to

perform when any of the listed events
occur.

04-30005-01-en, May 2019 System

675
30 Alarm Types
30.25 Configuring an Enumeration Alarm

7. Edit the attachment properties:

Property Description

Add attachment
Click to add an attachment to the alarm.
For more information, see section 31.21
“Alarm Attachments” on page 725.

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.

8. Click OK
OK.

System 04-30005-01-en, May 2019

676
 30 Alarm Types
30.26 System Alarms

30.26 System Alarms

System alarms monitor system entities, such as online status for SmartX servers
or field devices. The system alarms are generated by the EcoStruxure Building
Operation software. Users cannot create new system alarms. The possible
causes of a system alarm are gathered in an enumeration called System alarm
ID. When a system alarm is triggered, the cause of the alarm is indicated in the
System alarm ID column in the Alarms pane or Alarm View. Some system alarms
have additional information in the Alarm text column.
For example, an EcoStruxure 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:”.

30.26.1 System Alarm Handling

System alarms are usually 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 returns to normal state.
For more information, see section 30.27 “System Alarm Handling” on page 678.

30.26.2 System Alarm ID List

You use System Alarm IDs to filter the content of the Alarms pane or an Alarm
View. You also use System Alarm IDs to set up notifications that are sent to a
recipient when a specific alarm condition is met.
For more information, see section 30.28 “System Alarm ID List” on page 681.

04-30005-01-en, May 2019 System

677
30 Alarm Types
30.27 System Alarm Handling

30.27 System Alarm Handling

System alarms are usually 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 returns to normal state.

Figure: System alarm acknowledgement loop where the alarm is acknowledged in alarm
state

System 04-30005-01-en, May 2019

678
 30 Alarm Types
30.27 System Alarm Handling

Figure: System alarm acknowledgement loop where the alarm is acknowledged in reset
state

Simple system alarms are system alarms with a simplified state handling. When
you acknowledge a simple system alarm, it disappears from the Alarms pane,
regardless of the current alarm state. For example, a simple system alarm
notifies the user when a EcoStruxure BMS server or field device performs a
warm start.

04-30005-01-en, May 2019 System

679
30 Alarm Types
30.27 System Alarm Handling

Figure: Simple system alarm acknowledgement loop where the alarm is acknowledged in
alarm state

System 04-30005-01-en, May 2019

680
 30 Alarm Types
30.28 System Alarm ID List

30.28 System Alarm ID List

You use System Alarm IDs to filter the content of the Alarms pane or an Alarm
View. You also use System Alarm IDs to set up notifications that are sent to a
recipient when a specific alarm condition is met.

30.28.1 System Alarm IDs A-D

Listed below are the System Alarms with IDs that begin with the letters A-D.
For more information, see section 30.29 “System Alarm ID A-D” on page 682.

30.28.2 System Alarm IDs E-L

Listed below are the System Alarms with IDs that begin with the letters E-L.
For more information, see section 30.30 “System Alarm ID E-L” on page 686.

30.28.3 System Alarm IDs M-NW8 R

Listed below are the System Alarms with IDs that begin with the letters M-NW8
R.
For more information, see section 30.31 “System Alarm ID M-NW8 R” on page
689.

30.28.4 System Alarm IDs NW8 S-NW8 Z

Listed below are the System Alarms with IDs that begin with the letters NW8 S-
NW8 Z.
For more information, see section 30.32 “System Alarm ID NW8 S-NW8 Z” on
page 692.

30.28.5 System Alarm IDs P-S

Listed below are the System Alarms with IDs that begin with the letters P-S.
For more information, see section 30.33 “System Alarm ID P-S” on page 693.

30.28.6 System Alarm IDs List T-X

Listed below are the System Alarms with IDs that begin with the letters T-X.
For more information, see section 30.34 “System Alarm ID T-X” on page 694.

04-30005-01-en, May 2019 System

681
30 Alarm Types
30.29 System Alarm ID A-D

30.29 System Alarm ID A-D

Listed below are the System Alarms with IDs that begin with the letters A-D.

Table: System Alarms A

System Alarm ID Description

A configuration error was detected in A configuration error was detected in one

server communication setup during startup or more server communication setups
during startup.

A log data transfer was missed The extended trend may have failed to
read records.

A log sample was missed A log sample was missed.

Alarm signal trigger buffer full The alarm is unable to handle all value
changes.

Archive directory does not exist The directory path is not valid.

Archive directory does not exist. Retrying The directory path is not valid. The system
in 5 minutes will restart the archive process in 5
minutes.

Archive path must be set to enable The destination path for the archive file is
archiving not defined.

Archiving canceled due to configuration The archiving process was canceled due
change to configuration changes made during the
process.

Archiving failed because of an ongoing The archiving process failed due to an

operation ongoing operation in EcoStruxure Building
Operation software.

Archiving is not enabled Archiving is disabled when a manual

archive is initiated.

Table: System Alarms B

System Alarm ID Description

BACnet did not start The BACnet communication protocol did

not start.
This alarm can also apply to Infinet. Be
sure to check the path of the alarm to
determine whether it refers to BACnet or
Infinet.

BACnet server failure There was an internal BACnet error.

This alarm can also apply to Infinet. Be
sure to check the path of the alarm to
determine whether it refers to BACnet or
Infinet.

System 04-30005-01-en, May 2019

682
 30 Alarm Types
30.29 System Alarm ID A-D

Continued
System Alarm ID Description

Bad lead object reference Updating shadow object failed because

the lead object has an empty type.

Bad lead object type Updating shadow object failed. Type

mismatch between lead object and
shadow object.

Blacklisted device detected The physical device currently occupying

the slot configured for this module has
previously reported a Device Address
Changed error, and the configuration will
not be loaded to the device. For more
information, see the Device Address
Changed topic on WebHelp.

Table: System Alarms C

System Alarm ID Description

Cannot enable archiving The Archiving function is not enabled.

Cannot verify lead object status Updating shadow object failed. Status of
the lead object is unknown.

Communication failed Communication failed

Communication failed Authentication error Wrong domain or wrong credentials in

server to server communication.

Communication failed Authorization error Insufficient user permissions to

communicate with server.

Communication failed Configuration error Server communication failed to start with

current communication settings.

Communication failed Domain is not The requested communication domain is

available not defined in the server.

Communication failed Hostname is invalid Bad configuration of host name.

Communication failed Unexpected Server Server path is invalid.

fullpath

Communication failed Unexpected Server The server you tried to add is not
type compatible with the system.

Communication failed Version Mismatch Communication attempt failed between

servers with incompatible versions.

Corrupt backup set is detected A corrupt backup set was generated on a

SmartX server. Backup the server again.

CWS Alarm Poll failed The EcoStruxure Web Services interface

failed to poll an alarm from an EcoStruxure
Web Services server.

04-30005-01-en, May 2019 System

683
30 Alarm Types
30.29 System Alarm ID A-D

Continued
System Alarm ID Description

CWS Browse failed The EcoStruxure Web Services nterface

failed to browse the database from an
EcoStruxure Web Services server.

CWS GetHistory failed The EcoStruxure Web Services interface

failed to get a trend log from an
EcoStruxure Web Services server.

CWS GetObject failed The EcoStruxure Web Services interface

failed to get an EcoStruxure Web Services
object from an EcoStruxure Web Services
server.

CWS Method Error The EcoStruxure Web Services interface

failed while calling an EcoStruxure Web
Services method from an EcoStruxure Web
Services server.

CWS Value Poll failed The EcoStruxure Web Services interface

failed to poll a value from an EcoStruxure
Web Services server.

Table: System Alarms D

System Alarm ID Description

Database file is corrupt A file in the configuration is corrupt.

Database update failed There was a failure when trying to save a

value or setting.

Device address changed The physical IO module detects a change

in its communication address, which is
likely due to a hardware failure on the IO
bus. This alarm requires immediate
attention. For more information, see the
Device Address Changed topic on
WebHelp.

Device offline The server cannot connect to the specified

device.

Driver loading disabled The loading of SmartDriver driver is

disabled. For more information, see the
Load SmartDriver Drivers at Startup topic
on WebHelp.

Driver unexpectedly timed out The SmartX server software encountered

an unexpected problem while trying to
communicate with the IO driver of the
server.

Duplicate device address More than one device has the same MAC
address and network ID.

System 04-30005-01-en, May 2019

684
 30 Alarm Types
30.29 System Alarm ID A-D

Continued
System Alarm ID Description

Duplicate device identifier There are two or more devices within an

interface with the same device identifier.
The system may trigger a system alarm
and place the duplicate in the
Unconfigured Devices folder. For more
information, see the Unconfigured Devices
topic on WebHelp.

Duplicate device name There are two or more devices in a

container or network with the same device
name.

Duplicate network identifier There are two or more networks within an

interface with the same Network identifier.
The system may trigger a system alarm
and place the duplicate in the
Unconfigured Devices folder. For more
information, see the Unconfigured Devices
topic on WebHelp.

Duplicate of local network There are two or more networks within an

interface with the same Local Network
identifier. The system may trigger a system
alarm and place the duplicate in the
Unconfigured Devices folder. For more
information, see the Unconfigured Devices
topic on WebHelp.

04-30005-01-en, May 2019 System

685
30 Alarm Types
30.30 System Alarm ID E-L

30.30 System Alarm ID E-L

Listed below are the System Alarms with IDs that begin with the letters E-L.

Table: System Alarms E

System Alarm ID Description

Email service configuration error No email server is specified.

Email service failed to connect to SMTP The email service failed to connect to the
server SMTP server.

Email service failed to login to SMTP server The email service failed to log on to the
SMTP server.

Email service failed to send message The email service failed to send the
message.

Email service no recipient email address There was no recipient to send the email
to.

Email service no sender and recipient There was no sender email specified and
email address no recipient to send the email to.

Email service no sender email address There was no sender email specified.

Error in log definition Xenta trend log configuration error.

Error in retrieving Xenta device Trend Log Xenta trend log retrieving error.
data

Error - Upgrade using DFU mode File system is corrupt. Upgrade using DFU
mode.

Table: System Alarms F

System Alarm ID Description

Failed to create object The attempt to create an object failed.

Failed to initialize references An object has a reference or binding to a

property or another object that cannot be
found.

Failure backing up server database A backup operation failed. If the

information is available, the server path
and technical reason for the failure is
supplied in the alarm information.

Failure restoring server database A restore operation failed. If the information

is available, the alarm also contains the
EcoStruxure BMS configuration path for
the server that ran the restore.

System 04-30005-01-en, May 2019

686
 30 Alarm Types
30.30 System Alarm ID E-L

Continued
System Alarm ID Description

Failure retrieving backup set from remote The Enterprise Server failed to retrieve a
server newly generated backup set from a SmartX
server. The name of the SmartX server is
supplied. If the information is available, the
file name of the backup set is also
supplied.

File I/O error Failed to write to file.

Table: System Alarms I

System Alarm ID Description

Invalid archive path The archive path is not valid.

Invalid archiving format The archiving format is not supported.

Invalid device address The device address is not valid.

Invalid device identifier The identifier on the specified device is

invalid.

Invalid license server configuration Two or more Enterprise Servers get their
licenses from the same license server. This
is not the recommended setup.

IO driver unexpectedly timed out The IO driver timed out unexpectedly.

IO error when generating archive There is a detected error during the

archive generation.

IO error when writing to archive temporary There is a detected error when the archive
is saved to a predefined directory.

IO error, cannot write to archive directory! There is a detected error when the archive
is saved to a predefined directory.

IO error, cannot write to archive directory! There is a detected error when the archive
Retrying in 5 minutes is saved to a predefined directory. The
system will restart the archive process in 5
minutes.

IO error, not enough space left in the The destination directory does not have
archive directory enough storage space for the archive.

IO error, not enough space left in the The destination directory does not have
archive directory! Retrying in 5 minutes! enough storage space for the archive. The
system will restart the archive process in 5
minutes.

IP connection offline Modbus TCP connection timeout.

04-30005-01-en, May 2019 System

687
30 Alarm Types
30.30 System Alarm ID E-L

Table: System Alarms L

System Alarm ID Description

License violation The amount of required licenses is greater

than the amount of existing licenses on the
License Server.

Local administrator account has empty or Local administrator account has empty or
default password default password.

Log full The Xenta trend log is full.

Log stopped because it is full The Xenta trend log stopped because it is
full.

Log variable error A Xenta trend log variable is missing or

invalid.

Logging started The Xenta trend log started logging.

Logging stopped The Xenta trend log stopped logging.

System 04-30005-01-en, May 2019

688
 30 Alarm Types
30.31 System Alarm ID M-NW8 R

30.31 System Alarm ID M-NW8 R

Listed below are the System Alarms with IDs that begin with the letters M-NW8
R.

Table: System Alarms M

System Alarm ID Description

Module type mismatch The module type based on the user’s

configuration is different from the type of
the actual physical module occupying the
same slot.

More than one server with the same name There is more than one EcoStruxure BMS
in the system server with the same name in the
EcoStruxure BMS.

Table: System Alarms Ne-No

System Alarm ID Description

NETWORK 8000 message An unknown NETWORK 8000 message

with specific included contents was
received.

NETWORK 8000 message end End of a NETWORK 8000 unknown

message.

Network offline The server cannot connect to the specified

network.

New application program The Xenta device has received a new valid
application.

No file name set No file name has been specified.

No valid Blueprint File Invalid Xenta device program definition.

Not enough flash memory for log The request was valid but could not be
performed because there is not enough
flash memory.

Not enough RAM memory for log The request was valid but could not be
performed because there is not enough
RAM memory.

Notification files storage capacity reached Storage capacity has been reached for
notification files. For more information, see
section 34.12 “Deleting a Notification
Written to a File” on page 808.

04-30005-01-en, May 2019 System

689
30 Alarm Types
30.31 System Alarm ID M-NW8 R

Table: System Alarms NW8 A-D

System Alarm ID Description

NW8 Application error 1 The pressure sensor in the MnFlo controller

failed.

NW8 Application error 16 Heat Setpoint in the MnHpfc controller is

greater than the Cool Setpoint.

NW8 Application error 2 The MnFlo controller has a large negative

pressure, greater than –0.1 in. WC.

NW8 Application error 4 The MnFlo controller has a large positive

pressure, greater than 2.2 in. WC.

NW8 Application modified Something in the database of the controller

has changed.

NW8 AS1 diagnostic The input AS:1 on the PEM1 controller is

either open or shorted.

NW8 ASD message An alarm was received from an unknown

source.

NW8 AT1 diagnostic The AT:1 input on a PEM1 controller is

either open or shorted.

NW8 AT2 diagnostic The AT:2 input on a PEM1 controller is

either open or shorted.

NW8 Command failure The controller did not recognize the

command.

NW8 Configuration error The configuration settings of the controller

are not compatible with the hardware.

NW8 Damper range error This indicates the damper has a full stroke
range of less than 14° of rotation.

NW8 Database initialized The database in the controller was reset to

its initial state.

NW8 Database modified Some properties in the database of the

controller have changed.

NW8 Device cold reset The controller has been reset and the
contents of RAM were lost. All historical
data is lost.

NW8 Device reset The MICROFLO II controller has been reset

after the last communication with the
EcoStruxure BMS server.

NW8 Device warm reset The controller has been reset but the
contents of RAM were not lost. The
historical data has been maintained.

NW8 Duct temperature out of range The Duct Temperature is enabled and out
of range.

System 04-30005-01-en, May 2019

690
 30 Alarm Types
30.31 System Alarm ID M-NW8 R

Table: System Alarms NW8 E-R

System Alarm ID Description

NW8 EEprom checksum error The controller’s EEPROM memory has a

checksum error.

NW8 EEprom memory error The EEPROM Memory in the Flo2 controller
has been corrupted.

NW8 Freeze error The blocks in the controller are not

executing. This error is usually due to a
corrupted database.

NW8 Joins LCM network event The LCM controller is now communicating.

NW8 Joins network event The controller is now communicating.

NW8 Leaves LCM network event The LCM controller is no longer

communicating.

NW8 Leaves network event The controller is no longer communicating.

NW8 Leaves/joins LCM network An LCM controller has joined or left the
LCM network.

NW8 Leaves/joins network A controller has joined or left the network.

NW8 Missing changeover input Missing changeover input for a fan coil
application.

NW8 No U-Link communication There is no active U-Link communication to

the sensor.

NW8 Pressure error The Velocity Pressure is out of range (-0.2

to 2.1 in. WC).

NW8 RAM failure The controller is unable to read or write

RAM.

NW8 Relay failure The controller has detected that the relay
xx (from 01 to 48) action did not follow the
command.

NW8 ROM failure The controller may have a bad ROM chip.

04-30005-01-en, May 2019 System

691
30 Alarm Types
30.32 System Alarm ID NW8 S-NW8 Z

30.32 System Alarm ID NW8 S-NW8 Z

Listed below are the System Alarms with IDs that begin with the letters NW8 S-
NW8 Z.

Table: System Alarms NW8 S

System Alarm ID Description

NW8 Sensor input failure The controller has detected an input

sensor range failure.

NW8 Setpoint out of range The Flo2 Remote Setpoint is enabled and
out of range.

NW8 System fault 32 Missing changeover input for an MnHpfc

fan coil application.

Table: System Alarms NW8 U

System Alarm ID Description

NW8 UI diagnostic The measured input value at UI:xx (from

UI:1 to UI:8) is outside the standard range
for the configured sensor for a
MICROZONE II controller.

NW8 Unrecognized command The controller did not recognize the

command.

Table: System Alarms NW8 Z

System Alarm ID Description

NW8 Zone temperature out of range The MicroFol II zone temperature is out of
range.

System 04-30005-01-en, May 2019

692
 30 Alarm Types
30.33 System Alarm ID P-S

30.33 System Alarm ID P-S

Listed below are the System Alarms with IDs that begin with the letters P-S.

Table: System Alarms P

System Alarm ID Description

Parser failed Failed to parse Xenta application.

Port offline Lon interface is offline.

Table: System Alarms S

System Alarm ID Description

Serial port in use The serial port is already in use.

Server configuration error Server configuration error.

Server not restarted Backup in process Server is not restarted because a Backup
operation is ongoing.

Server not restarted Other Server is not restarted for a reason other
than a backup and restore operation is in
progress.

Server not restarted Restore in process Server is not restarted because a Restore
operation is ongoing.

Server offline Server is offline.

Shadow update failed Processing the update of a shadow object

failed.

Signal alarm Used for testing purposes only.

Signal Event Used for testing purposes only.

SNMP send trap failure Failed to send SNMP message.

System cold start System cold start initiated by system.

System cold start initiated by operator System cold start initiated by operator.

System factory reset Server restart initiated by factory reset.

System warm start System warm start initiated by system.

System warm start initiated by operator System warm start initiated by operator.

04-30005-01-en, May 2019 System

693
30 Alarm Types
30.34 System Alarm ID T-X

30.34 System Alarm ID T-X

Listed below are the System Alarms with IDs that begin with the letters T-X.

Table: System Alarms T

System Alarm ID Description

Task 1 CPU limit reached, disabling real Too many applications assigned to Task 1.
time priority Real time priority disabled. Execution time
not guaranteed.

Task 2 CPU limit reached, disabling real Too many applications assigned to Task 2.
time priority Real time priority disabled. Execution time
not guaranteed.

Task period extended Task execution overrun. Period extended.

Too many log definitions Too many Xenta trend log definitions.

Trend storage capacity reached The trend storage capacity has been
reached.

Table: System Alarms U

System Alarm ID Description

Unable to access lead object Updating shadow object failed. Lead

object could not be read.

Unable to access shadow object Updating shadow object failed. Shadow

object could not be read.

Unhandled buffer ready notification The system received a BACnet buffer

ready alarm, but there is no extended
trend log monitoring for that trend. Data
may be lost because no extended trend
log is collecting it.

Unit is locked A Xenta device is locked.

Unit is unlocked A Xenta device is unlocked.

Table: System Alarms W

System Alarm ID Description

Web server failure Bad web server configuration or bad

security certificate.

Wrong alarm unit The alarm is configured with a unit that is

incompatible with the monitored point’s
unit.

System 04-30005-01-en, May 2019

694
 30 Alarm Types
30.34 System Alarm ID T-X

Table: System Alarms X

System Alarm ID Description

X509 certificate error Security certificate error.

Xenta central schedule update failure Xenta central schedule did not update
because of too few schedule definitions, in
one or many Xenta device schedules
connected to this central schedule.

Xenta schedule update failure Communication failure during Xenta

schedule update.

04-30005-01-en, May 2019 System

695
30 Alarm Types
30.35 Configuring the Description of an Alarm

30.35 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. In the properties pane, click the Basic Settings tab.
3. In the Description box, type a description for the object.

4. Click the Save button .

System 04-30005-01-en, May 2019

696
31 Alarm Functions

Topics
Alarm Functions
Time Delay
Configuring the Delay Time of an Alarm
Shunt Variables
Editing the Shunt Variables
Deadband
Alarm Messages
Configuring the Alarm Message of an Alarm
Alarm Priority
Configuring the Priority of an Alarm
Configuring the System Alarm Priority
Alarm Categories
Creating a Category
Configuring the Category of an Alarm
Editing a Category
Acknowledgements
Configuring the Acknowledgement Type of an Alarm
No Acknowledgement
Single Acknowledgement
Extended Acknowledgement
31 Alarm Attachments
Adding an Attachment to an Alarm
Adding an Attachment to Multiple Alarms
Copying Attachments to Multiple Alarms
Removing an Attachment from an Alarm
Removing Attachments from Multiple Alarms
Alarm Substitution Codes
Alarm Assignments
Automatic Assignments
Creating an Automatic Assignment
Unit of Measure in Alarms
Configuring the Limits of an Alarm
Configuring the Flashing of an Alarm
Configuring the Audibility of an Alarm
Configuring the Audibility of an Alarm in Reset State
Custom Audible Alarm Alerts
Custom Audible Alarm Alert Workflow
Adding an Audio File for a Custom Audible Alarm Alert
Configuring a Custom Audible Alarm Alert
Turning off a Visual and Audible Alert
Alarm Control Panel Synchronization
Synchronizing Alarm Control Panels
Viewing the Events of an Alarm
 31 Alarm Functions
31.1 Alarm Functions

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

31.1.1 Alarm Filters

Alarm filters 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 filters to
determine the conditions that have to be met before a sum alarm is triggered, an
email notification is sent, a write to file notification is written, or an alarm is
automatically assigned to a user.
For more information, see section 29.18 “Alarm Filters” on page 595.

31.1.2 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 31.2 “Time Delay” on page 703.

31.1.3 Shunt Variable

A shunt variable is a binary value that works as an on/off switch for the alarm.
For more information, see section 31.4 “Shunt Variables” on page 705.

31.1.4 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 31.6 “Deadband” on page 707.

31.1.5 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 31.7 “Alarm Messages” on page 708.

04-30005-01-en, May 2019 System

699
31 Alarm Functions
31.1 Alarm Functions

31.1.6 Alarm 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 31.9 “Alarm Priority” on page 710.

31.1.7 Alarm 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.
Each alarm can belong to two categories.
For more information, see section 31.12 “Alarm Categories” on page 713.

31.1.8 Acknowledgements
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 31.16 “Acknowledgements” on page 717.

31.1.9 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 32.1 “User Actions” on page 757.

31.1.10 Notifications
Notifications are used for notifying users or user groups that a certain alarm or
other event, such as a schedule or an application condition, has occurred in the
system. The notification contains a prewritten message that can be displayed as
a popup message, sent as an email, sent to an SNMP manager, or written to a
text file.
For more information, see section 34.1 “Notifications” on page 787.

System 04-30005-01-en, May 2019

700
 31 Alarm Functions
31.1 Alarm Functions

31.1.11 Automatic Assignments

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 31.29 “Automatic Assignments” on page 738.

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

NOTICE
You cannot define a unit to an alarm that monitors a unitless variable.

For more information, see section 31.31 “Unit of Measure in Alarms” on page
741.

31.1.13 Alarm Attachments

You can add attachments to alarm objects, except System Information alarms.
An attachment is a link pointing to an object in the system. When an alarm that
has an attachment is triggered, 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.
For more information, see section 31.21 “Alarm Attachments” on page 725.

31.1.14 Custom Audible Alarm Alerts

A custom audible alarm alert is an audio file that is played when an alarm is
triggered.
For more information, see section 31.36 “Custom Audible Alarm Alerts” on page
747.

31.1.15 Alarm Decoration

If you want to override an alarm configuration for a specific alarm or group of
alarms you can use an alarm decoration rule.
For more information, see section 33.1 “Alarm Decoration” on page 775.

04-30005-01-en, May 2019 System

701
31 Alarm Functions
31.1 Alarm Functions

31.1.16 Alarm Control Panel Synchronization

When you have predefined Alarm Control Panel objects, for example user
actions or alarm decorators, that you want to reuse on another EcoStruxure BMS
server, you configure a lead-shadow relationship on the shadow Alarm Control
Panel.
For more information, see section 31.41 “Alarm Control Panel Synchronization”
on page 752.

System 04-30005-01-en, May 2019

702
 31 Alarm Functions
31.2 Time Delay

31.2 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 EcoStruxure Building Operation alarms except
for system information alarms.

04-30005-01-en, May 2019 System

703
31 Alarm Functions
31.3 Configuring the Delay Time of an Alarm

31.3 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. In the properties pane, 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-30005-01-en, May 2019

704
 31 Alarm Functions
31.4 Shunt Variables

31.4 Shunt Variables

A shunt variable is a binary value that works as an on/off switch for the alarm.
When an alarm is shunted the alarm stops evaluating, that is, no longer listens to
the alarm trigger that can cause the alarm to change state. If the alarm is in
Normal or Acknowledged state when it is shunted, the alarm changes to
Disabled state. If the alarm is in Alarm or Reset state when it is shunted, it
remains in that state. When you acknowledge a shunted alarm it changes to
Disabled state. When a shunted alarm is unshunted, the alarm starts evaluating
again, that is, starts to listen to the alarm trigger that can cause the alarm to
change state.
You can invert the shunt variable, which means that the alarm is shunted when
the shunt variable is set to False.
You can set two shunt variables for every type of EcoStruxure Building
Operation alarm. You combine the two shunt variables by using a shunt operator
with AND or OR logic instead of writing a program to handle the logic.
Examples:
When the flow from a pump exceeds the configured limit, an alarm is triggered.
The alarm is only relevant if the pump is switched on. To enable the alarm only
when the pump is switched on, you set a shunt variable on the alarm.
When a pump is switched off, an alarm is triggered. You can invert the shunt
variable so that the alarm is enabled when the pump is switched on.

04-30005-01-en, May 2019 System

705
31 Alarm Functions
31.5 Editing the Shunt Variables

31.5 Editing the Shunt Variables

You add or edit the shunt variables connected to an alarm, to enable or disable
the alarm.

To edit the shunt variables

1. In WorkStation, in the System Tree pane, select the alarm for the shunt
variables you want to edit.
2. Click the Alarm Trigger tab.
3. Select Invert if you want to invert the shunt variable.
4. In the Shunt variable 1 box, enter a digital variable that is used as a shunt
variable.
5. Select an AND or OR operator if you want to add a second shunt variable.
6. Select Invert to invert the second shunt variable.
7. In the Shunt variable 2 box, enter a digital variable that is used as a shunt
variable.

8. Click the Save button .

System 04-30005-01-en, May 2019

706
 31 Alarm Functions
31.6 Deadband

31.6 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-30005-01-en, May 2019 System

707
31 Alarm Functions
31.7 Alarm Messages

31.7 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.
If the alarm is an EcoStruxure Building Operation alarm, you can use substitution
codes in the alarm message to spell out current object values. Substitution
codes are usually used to spell out current object values.

Table: Alarm Message Substitution Codes for EcoStruxure Building Operation

Alarms
Component Description

@(F) Displays the full path of the monitored

variable.

@(O) Displays the monitored variable name.

@(P) Displays the monitored property.

@(V) Displays the value of the monitored

variable at the time of the state change.

For example, you create an alarm that is monitoring a temperature object named
T64. You write an alarm message that says: “The point @(O) is too hot.” When
the temperature value increases to 35, the alarm is triggered. The alarm with its
alarm message is presented in the Alarms pane and Alarm Views: “The point
T64 is too hot.”

System 04-30005-01-en, May 2019

708
 31 Alarm Functions
31.8 Configuring the Alarm Message of an Alarm

31.8 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. In the properties pane, 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-30005-01-en, May 2019 System

709
31 Alarm Functions
31.9 Alarm Priority

31.9 Alarm 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 whether a lower number means high or low priority in the
EcoStruxure Building Operation software. By default, 0 is the highest priority.
The configuration is done on Alarm Control Panel properties and applies to all
users and all servers in the system.
You can configure different priority levels for different states of an alarm. The
configuration is done on the alarm. The default priority of an alarm is 100.
However, you can change this number to any integer between 0 and 999.
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-30005-01-en, May 2019

710
 31 Alarm Functions
31.10 Configuring the Priority of an Alarm

31.10 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. In the properties pane, 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-30005-01-en, May 2019 System

711
31 Alarm Functions
31.11 Configuring the System Alarm Priority

31.11 Configuring the System Alarm Priority

You configure the system alarm priority to define whether a lower number means
high or low priority.
For more information, see section 31.9 “Alarm Priority” on page 710.

NOTICE
By default, 0 is the highest priority.

To configure the system alarm priority

1. In Workstation, in the System Tree pane, expand the EcoStruxure BMS
server for which you want to configure the system alarm priority.
2. Expand the System folder.
3. Select Alarm Control Panel
Panel.
4. On the File menu, click Properties
Properties.
5. In the Alarm Control Panel dialog box, in the Low alarm priority is more
important box, select False to change the highest alarm priority to 999.
6. Click OK
OK.
The change is applied the next time a user logs on.

System 04-30005-01-en, May 2019

712
 31 Alarm Functions
31.12 Alarm Categories

31.12 Alarm 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.
Each alarm can belong to two categories.
Example 1:
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.
Example 2:
You create a Category 2 called 'Alarms to Enterprise Central' on an Enterprise
Server. You then create an alarm decoration rule and configure the Category 2
of the alarm decoration rule to 'Alarms to Enterprise Central'. On Enterprise
Central, you configure an alarm filter to show alarms where the Category 2
property is 'Alarms to Enterprise Central'.
For more information, see section 29.22 “Configure Alarm Filters on Enterprise
Central Workflow ” on page 605.

04-30005-01-en, May 2019 System

713
31 Alarm Functions
31.13 Creating a Category

31.13 Creating a Category

You create a category to group alarms so that alarms are more easily identified.
For more information, see section 31.12 “Alarm Categories” on page 713.

To create a category
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Categories
Categories.

4. In the Categories tab, click the Add category button .

5. In the Add Category dialog box, 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-30005-01-en, May 2019

714
 31 Alarm Functions
31.14 Configuring the Category of an Alarm

31.14 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. In the properties pane, click the Presentation tab.
3. In the Category box, enter a category for the alarm.

4. Click the Save button .

04-30005-01-en, May 2019 System

715
31 Alarm Functions
31.15 Editing a Category

31.15 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, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Categories
Categories.
4. In the Categories tab, select the category you want to edit.

5. Click the Edit category button .

NOTICE
• To permanently remove a category from the categories list, click the

Remove category button .

6. In the Edit Category dialog box, in the Name box, type a name for the
category.
7. In the Description box, type a description for the category
8. Click OK
OK.

9. Click the Save button .

System 04-30005-01-en, May 2019

716
 31 Alarm Functions
31.16 Acknowledgements

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

31.16.1 No Acknowledge
When you select the acknowledgment type No acknowledgement, the triggered
alarm returns to normal state and disappears from the alarm view when the
monitored variable no longer meets the criteria to trigger the alarm. You select
this user action when the user only needs to see a status and does not need to
take any action on the alarm, for example, to see if a space is occupied or not.
For more information, see section 31.18 “No Acknowledgement” on page 719.

31.16.2 Single Acknowledge

When you select the acknowledgment type Single acknowledgment, the user
needs to acknowledge the alarm in the alarm view before the alarm returns to
normal state and disappears from the alarm view.
For more information, see section 31.19 “Single Acknowledgement” on page
721.

31.16.3 Extended Acknowledge

When you select the acknowledgement type Extended acknowledgment, the
user needs to acknowledge the alarm in the alarm view in reset state, before the
alarm returns to normal state and disappears from the alarm view.
For more information, see section 31.20 “Extended Acknowledgement” on page
723.

31.16.4 System Information Alarms

No acknowledgement type can be set for simple system alarms. You have to
acknowledge the alarm to send it back to Normal state. If you do not
acknowledge the alarm, it remains in Alarm state. For more information, see
section 30.26 “System Alarms” on page 677.

04-30005-01-en, May 2019 System

717
31 Alarm Functions
31.17 Configuring the Acknowledgement Type of an Alarm

31.17 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. In the properties pane, 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.

System 04-30005-01-en, May 2019

718
 31 Alarm Functions
31.18 No Acknowledgement

31.18 No Acknowledgement
When you select the acknowledgment type No acknowledgement, the triggered
alarm returns to normal state and disappears from the alarm view when the
monitored variable no longer meets the criteria to trigger the alarm. You select
this user action when the user only needs to see a status and does not need to
take any action on the alarm, for example, to see if a space is occupied or not.

Figure: No acknowledgement loop where the alarm does not have to be acknowledged
before the alarm returns to normal state.

The user can acknowledge the alarm in the alarm view to let other users know
that the alarm has been noted. The acknowledgment is optional and the alarm
does not require an acknowledgement to return to normal state.

04-30005-01-en, May 2019 System

719
31 Alarm Functions
31.18 No Acknowledgement

Figure: No acknowledgement loop where the alarm is acknowledged before it returns to

normal state.

System 04-30005-01-en, May 2019

720
 31 Alarm Functions
31.19 Single Acknowledgement

31.19 Single Acknowledgement

When you select the acknowledgment type Single acknowledgment, the user
needs to acknowledge the alarm in the alarm view before the alarm returns to
normal state and disappears from the alarm view.
If the user acknowledges the alarm when it is in alarm state, the alarm is set to
acknowledged state. When the problem that triggered the alarm is corrected,
that is when the monitored variable no longer meets the criteria to trigger the
alarm, the alarm returns to normal state.

Figure: Single acknowledgement loop where the alarm is acknowledged in alarm state

If the user did not acknowledge the alarm when it was in alarm state, and the
monitored variable no longer meets the criteria to trigger the alarm, the alarm is
set to reset state. The user needs to acknowledge the alarm in reset state to
make it return to normal state. In this case, the alarm can toggle between alarm
state and reset state several times before a user acknowledges the alarm.

04-30005-01-en, May 2019 System

721
31 Alarm Functions
31.19 Single Acknowledgement

Figure: Single acknowledgement loop where the alarm is acknowledged in reset state

System 04-30005-01-en, May 2019

722
 31 Alarm Functions
31.20 Extended Acknowledgement

31.20 Extended Acknowledgement

When you select the acknowledgement type Extended acknowledgment, the
user needs to acknowledge the alarm in the alarm view in reset state, before the
alarm returns to normal state and disappears from the alarm view.
If the user acknowledges the alarm when it is in alarm state, the alarm is set to
acknowledged state. When the problem that triggered the alarm is corrected,
that is when the monitored variable no longer meets the criteria to trigger the
alarm, the alarm is set to reset state. The user needs to acknowledge the alarm
in reset state to make it return to normal state.

Figure: Extended acknowledgement loop where the alarm reset state has to be
acknowledged before the alarm returns to normal state

If the user did not acknowledge the alarm when it was in alarm state and the
monitored variable no longer meets the criteria to trigger the alarm, the alarm is
set to reset state. The user needs to acknowledge the alarm in reset state to
make it return to normal state. In this case, the alarm can toggle between alarm
state and reset state several times before a user acknowledges the alarm.

04-30005-01-en, May 2019 System

723
31 Alarm Functions
31.20 Extended Acknowledgement

Figure: Extended acknowledgement loop where the alarm toggles between alarm state
and reset state

System 04-30005-01-en, May 2019

724
 31 Alarm Functions
31.21 Alarm Attachments

31.21 Alarm Attachments

You can add attachments to alarm objects, except System Information alarms.
An attachment is a link pointing to an object in the system. When an alarm that
has an attachment is triggered, 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.
An attachment can be: a voice message, a report, a trend chart, a schedule, a
Microsoft Word file, a PDF file, a video recording, or a pop-up window that
contains information regarding the alarm.
You can add the same attachment or set of attachments to multiple alarms in a
single operation. You can also delete the attachments that belong to multiple
alarms in a single operation. If you add an attachment that already has been
attached to an alarm, the later attachment is added as a duplicate.
You can open attachments provided that the program or editor associated with
the attachment is locally installed on your computer. For example, if the
attachment is a PDF file, you can open the file if Adobe Reader or a similar
program is installed on your computer.

04-30005-01-en, May 2019 System

725
31 Alarm Functions
31.22 Adding an Attachment to an Alarm

31.22 Adding an Attachment to an Alarm

You add an attachment, for example a .pdf file or a trend log, to assist the user
when diagnosing or solving the problem that caused the alarm.
For more information, see section 31.21 “Alarm Attachments” on page 725.

To add an attachment to an alarm

1. In WorkStation, in the Alarm View of the alarm, click the Attachment tab.

2. Click the Add button .

3. In the Select Object dialog box, browse to the item you want to attach to
the alarm.
4. Click Select
Select.
(In FM: TaskClosing) The selected attachment appears in the Attachment list of
the alarm and is attached when the alarm is triggered.

System 04-30005-01-en, May 2019

726
 31 Alarm Functions
31.23 Adding an Attachment to Multiple Alarms

31.23 Adding an Attachment to Multiple

Alarms
You add an attachment, for example a .pdf file or trend log, to assist the user
when diagnosing or solving the problem that caused an alarm.
For more information, see section 31.21 “Alarm Attachments” on page 725.

To add an attachment to multiple alarms

1. In WorkStation, in the list view, select the alarms to which you want to add
the alarm attachment.
2. On the Actions menu, point to Advanced
Advanced.
3. Click Add attachment
attachment.
4. In the Select Object dialog box, select the item that you want to attach to
the alarms.
5. Click Select
Select.
6. Click Yes if you want the attachment to display when the alarm is triggered.
The attachment is added to all selected alarms.

04-30005-01-en, May 2019 System

727
31 Alarm Functions
31.24 Copying Attachments to Multiple Alarms

31.24 Copying Attachments to Multiple Alarms

You copy alarm attachments from one alarm to one or several other alarms
where you want the same set of alarm attachments.
For more information, see section 31.21 “Alarm Attachments” on page 725.

To copy attachments to multiple alarms

1. In WorkStation, in the list view, select the alarms where you want to paste
the alarm attachments.
2. On the Actions menu, point to Advanced
Advanced.
3. Click Copy attachments from
from.
4. In the list view, select the alarm from which you want to copy the alarm
attachments.
All the selected target alarms get copies of the alarm attachments from the
source alarm.

System 04-30005-01-en, May 2019

728
 31 Alarm Functions
31.25 Removing an Attachment from an Alarm

31.25 Removing an Attachment from an Alarm

You remove an attachment from an alarm to meet the unique needs of your site
For more information, see section 31.1 “Alarm Functions” on page 699.

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.

NOTICE

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

04-30005-01-en, May 2019 System

729
31 Alarm Functions
31.26 Removing Attachments from Multiple Alarms

31.26 Removing Attachments from Multiple

Alarms
You remove all alarm attachments, for example, .pdf files or a trend logs that are
no longer relevant for assisting you when diagnosing or solving the problem that
caused an alarm.
For more information, see section 31.21 “Alarm Attachments” on page 725.

To remove attachments from multiple alarms

1. In WorkStation, in the list view, select the alarms from which you want to
remove all alarm attachments.
2. On the Actions menu, point to Advanced and then click Remove all
attachments
attachments.
3. In the Remove all Attachments dialog box, click Yes
Yes.
All alarm attachments are removed from the selected alarms.

System 04-30005-01-en, May 2019

730
 31 Alarm Functions
31.27 Alarm Substitution Codes

31.27 Alarm Substitution Codes

Alarm substitution codes represent the information you want to dynamically add
to alarm messages and notifications when an alarm is triggered.
A substitution code for notifications has the form @([property]) where [property]
is replaced by one of the alarm properties.
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."

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 are added

to the alarm.

@(AssignedID) Writes the unique ID of the user the alarm

is assigned to.

@(AssignedState) Writes the current assigned state the alarm

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.

04-30005-01-en, May 2019 System

731
31 Alarm Functions
31.27 Alarm Substitution Codes

Continued
Code Description

@(ConfirmedNotification) Writes an indication whether a BACnet

notification was issued as a confirmed or
unconfirmed BACnet message.

@(Count) Writes the number of times the alarm has

toggled between the alarm and reset
states.

@(Deadband) Writes the value of the deadband used for

limit checking for BACnet out of range
alarms.

@(DeviceName) Writes the name of the I/NET device that

generated the event.

@(DisabledCause) Writes the cause of the alarm being

disabled. An alarm can be disabled by
User, Shunt variable, and System. If the
alarm isn't configured correctly it can be
disabled by System.

@(ErrorLimit) Writes the difference limit that was

exceeded for BACnet floating limit alarms.

@(EvaluationState) Writes the present evaluation state of the

alarm. For example, Upper limit alarm is
displayed when the monitored value
reaches the upper alarm limit.

@(EventFromState) Writes the event state of the object prior to

the occurence of the alarm condition for
BACnet alarms.

@(CWSid) Writes the EcoStruxure Web Service

identification of the alarm on the external
system.

@(CWSSourceId) Writes the EcoStruxure Web Service

identification of the external object that
generated the alarm.

@(ExceededLimit) Writes the value of the limit that was

exceeded for BACnet out of range alarms.

@(ExceedingValue) Writes the value that exceeded a limit for

BACnet out of range alarms.

@(FeedbackValue) Writes the value that differs from the

commanded value for a BACnet command
failure alarm.

@(FirstName) Writes the first name of the individual

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

732
 31 Alarm Functions
31.27 Alarm Substitution Codes

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.

@(MessageText) Writes the text of an I/NET action or

dispatch message, if there is one.

@(MonitoredObject->DESCR) Writes the description property of the

monitored object. This requires that a
MonitoredVariable is configured.

@(MonitoredObject->NAME) Writes the name property of the monitored

object. This requires that a
MonitoredVariable is configured.

@(MonitoredObject->NOTE1) Writes the note 1 property of the monitored

object. This requires that a
MonitoredVariable is configured.

@(MonitoredObject->NOTE2) Writes the note 2 property of the monitored

object. This requires that a
MonitoredVariable is configured.

@(MonitoredObject->LabelText) Writes the label text of the monitored

object. This requires that a
MonitoredVariable is configured.

@(MonitoredValue) Writes the value that caused the alarm to

become active or inactive.

@(MonitoredVariable) Writes the path of the monitored variable.

@(NewMode) Writes the new mode of the monitored

object for a BACnet change of value alarm.

@(NewState) Writes the new state of the monitored

object for a BACnet change of state or
change of life safety alarm.

@(NewValue) Writes the new value of the monitored

property for a BACnet change of value
alarm.

@(NotificationClass) Writes the distribution information of an

alarm notification within a BACnet system.

@(OperationExpected) Writes the next operation requested by the

monitored object for a BACnet change of
life safety alarm.

04-30005-01-en, May 2019 System

733
31 Alarm Functions
31.27 Alarm Substitution Codes

Continued
Code Description

@(OriginalAlarmText) Writes the alarm text from the matched

alarm. This substitution code is only
available for Alarm Decorators.

@(PossibleOperatorActions) Writes the possible actions one can

perform on the record, given permissions.

@(PreviousAlarmState) Writes the previous alarm state.

@(Priority) Writes the current priority level of the alarm

state.

@(ProcessId) Writes the process identifier configured by

the notification for a BACnet alarm.

@(ReferencedBitString) Writes the new value of the monitored

bitstring property for a BACnet change of
bitstring alarm.

@ (Report) Writes the name of the report connected to

the notification.

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

@(SourceName) Writes the name of the source object that

generated the alarm.

@(SourceObject->DESCR) Writes the description property of the

source object.

@(SourceObject->NAME) Writes the name property of the source

object.

@(SourceObject->NOTE1) Writes the note 1 property of the source

object.

@(SourceObject->NOTE2) Writes the note 2 property of the source

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.

System 04-30005-01-en, May 2019

734
 31 Alarm Functions
31.27 Alarm Substitution Codes

Continued
Code Description

@(TimeStamp) Writes the time and date when the event

was generated.

@(TriggeredTimestamp) Writes the time and date of the state

transfer from normal state to alarm state.

@(TYPE) Writes the record type.

31.27.1 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 31.7 “Alarm Messages” on page 708.

04-30005-01-en, May 2019 System

735
31 Alarm Functions
31.28 Alarm Assignments

31.28 Alarm Assignments

A triggered alarm can be manually or automatically assigned to a specific user
or user group that seems to be most suited to correct the problem.
An assigned alarm indicates for other users that someone is working with the
problem that caused the alarm. The name of the user that is assigned to the
alarm together with the assignment status is displayed in the Alarms pane in
WorkStation or WebStation, and in the Events pane in WorkStation.
If an alarm is assigned to you, you can either accept the assignment request or
reject it. Rejecting the assignment request means setting the assignment alarm
back to unassigned. If you accept the assignment but realize that you are not
the right person to correct the problem, you can release the assignment or
assign the alarm to another user. If nobody has assigned an alarm, you can do a
self-assign. When self-assigning, the status of the assignment is changed from
unassigned to accepted with your name.
You can assign an alarm to a user independent of the current assignment state.

Figure: Assignment schedule triggered by an alarm

Table: Assign Statuses

Status Description

Unassigned Nobody is assigned to the alarm.

Assigned An assignment request is sent to a user or

user group.

Accepted The assigned user or user-group has

accepted the assignment request.

System 04-30005-01-en, May 2019

736
 31 Alarm Functions
31.28 Alarm Assignments

31.28.1 Manual Assignments

You or your supervisor can manually send an assignment request to the user or
user group that seems most suitable to correct the problem that triggered the
alarm. When manually sending an assignment request, you can define the time
the user has to respond to the request. If the user does not respond to the
assignment within the time limit, the request is automatically rejected and the
assign status changes back to unassigned.

31.28.2 Automatic Assignments

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 31.29 “Automatic Assignments” on page 738.

04-30005-01-en, May 2019 System

737
31 Alarm Functions
31.29 Automatic Assignments

31.29 Automatic Assignments

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.
You can create automatic assignments for recipients whose user accounts
reside on the same EcoStruxure BMS server as the automatic assignment.
When creating an automatic assignment, you configure the condition that needs
to occur before the EcoStruxure Building Operation software 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 greater than zero.
For example, a schedule is configured to generate the value 2 between 06:30-
18:00 and the value 4 between 18:00-06:30. The schedule is connected to two
assignments with the same conditions. One assignment sends an assignment
request to the ordinary operator when the schedule generates value 2. The other
assignment is active when the schedule 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.

System 04-30005-01-en, May 2019

738
 31 Alarm Functions
31.30 Creating an Automatic Assignment

31.30 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 31.29 “Automatic Assignments” on page 738.

To create an automatic assignment

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS server where you want to create the assignment.
2. On the File menu, point to New and then click Assignment
Assignment.
3. In the Create Object wizard, in the Name box, type a name for the
assignment.
4. In the Description box, type a description for the assignment.
5. Click Next
Next.
6. In the Assignment page, in the Status box, select Enabled to activate the
assignment.
7. Enter a schedule or other multistate variable to activate the notification:
• In the Schedule box, enter the schedule or other multistate variable
that contains the value that activates the assignment.
• In the Active value box, enter the value, generated by the connected
schedule or other multistate variable, that activates the assignment.
8. In the Assigned to box, click the browse button to open the dialog box
where you select the user or user group that is to receive the assignment
request.

NOTICE
You can only select users or user groups that reside on the same
EcoStruxure BMS server as the automatic assignment.

9. In the Users and Groups dialog box, in the Domain box, select the domain
that the users or user groups belong to.
10. Select the users or user groups that are to receive the assignment request.
11. Click Add
Add.
12. Click OK
OK.

13. Click the Add Condition button to set up the conditions that generate
the assignment.
14. Enter the settings of the condition.

NOTICE
You can add several assignment conditions to specify when to write the
assignment.

04-30005-01-en, May 2019 System

739
31 Alarm Functions
31.30 Creating an Automatic Assignment

15. Click the Add row button to add another condition of the same
condition type.
16. Click Create
Create.

System 04-30005-01-en, May 2019

740
 31 Alarm Functions
31.31 Unit of Measure in Alarms

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

NOTICE
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, the EcoStruxure Building Operation software
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 the EcoStruxure Building Operation software. The EcoStruxure Building
Operation software triggers a system alarm to notify that the alarm is disabled
due to an impossible unit conversion.

04-30005-01-en, May 2019 System

741
31 Alarm Functions
31.32 Configuring the Limits of an Alarm

31.32 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. In the properties pane, 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
Yes.

System 04-30005-01-en, May 2019

742
 31 Alarm Functions
31.33 Configuring the Flashing of an Alarm

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

04-30005-01-en, May 2019 System

743
31 Alarm Functions
31.34 Configuring the Audibility of an Alarm

31.34 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 alert to make the alarm sound when it is triggered.

4. Click the Save button .

System 04-30005-01-en, May 2019

744
 31 Alarm Functions
31.35 Configuring the Audibility of an Alarm in Reset State

31.35 Configuring the Audibility of an Alarm in

Reset State
You configure an alarm to make a sound when it is in reset state and alarm state
so that the operator can hear the alarm.

To configure the audibility of an alarm in reset state

1. In WorkStation, in the System Tree pane, select the alarm you want to
configure.
2. Click the Presentation tab.
3. Select Audible alert to make the alarm sound when it is triggered.

4. Click the Save button

5. In the computer file system, locate the file named
SE.SBO.WorkStation.exe.config in the folder where WorkStation is installed.
6. Open the SE.SBO.WorkStation.exe.config file in a text editor.
Continued on next page

04-30005-01-en, May 2019 System

745
31 Alarm Functions
31.35 Configuring the Audibility of an Alarm in Reset State

7. On the row saying: <add key="AudibleAlertOnResetState"

value="false"/
value="false"/>>, replace the word "false" with "true" to make the alert
audible when an alarm is in reset state.

8. On the File menu, click Save to save the changes you made to the file.
9. Restart WorkStation.

System 04-30005-01-en, May 2019

746
 31 Alarm Functions
31.36 Custom Audible Alarm Alerts

31.36 Custom Audible Alarm Alerts

A custom audible alarm alert is an audio file that is played when an alarm is
triggered.
When several alarms with configured audible alerts are triggered, only the
audible alert of the alarm with the highest priority is played. If several alarms with
the same priority are triggered, only the audible alert of the latest triggered alarm
is played.
To make it easier to find alarms with configured audible alerts in the Alarms
pane or an Alarm View, you can combine audible and flashing alerts. You can
disable the audible alert of an alarm.
You can configure alarm filters and alarm decoration rules to include custom
audible alarm alerts.

Custom Audible Alarm Alert Workflow

To configure a custom audible alert for an alarm, you add the audio file to the
EcoStruxure BMS server and then connect the alarm to the audio file.
For more information, see section 31.37 “Custom Audible Alarm Alert Workflow”
on page 748.

Audio Files
The following audio file formats are supported:
• m4a
• mp3
• mp4
• wav
• wma
You save the audio files you want to use for custom audible alarm alerts in the
System folder of the EcoStruxure BMS server where the audio file is to be
played. You have to log on to the server where the audio files are saved to hear
the custom audible alarm alerts.
To hear custom audible alerts for all alarms in a multi-server system when
logged on to an Enterprise Central, add the audio files to the System folder of
the Enterprise Central.
To hear custom audible alerts for all alarms in a multi-server system when
logged on to an Enterprise Server, add the audio files to the System folder of the
Enterprise Server.
To hear custom audible alarm alerts when logged on to a SmartX server, add the
audio files to the System folder of that SmartX server.

04-30005-01-en, May 2019 System

747
31 Alarm Functions
31.37 Custom Audible Alarm Alert Workflow

31.37 Custom Audible Alarm Alert Workflow

A custom audible alarm alert is an audio file that is played when an alarm is
triggered.

Figure: Custom audible alarm alert flowchart

Add an Audio File for a Custom Audible Alarm Alert

Add the custom audio file to the EcoStruxure BMS server where you want to hear
the custom audible alarm alert.
For more information, see section 31.38 “Adding an Audio File for a Custom
Audible Alarm Alert ” on page 749.

Configure a Custom Audible Alarm Alert

Configure the alarm to play the custom audio file when the alarm is triggered or
reset.
For more information, see section 31.39 “Configuring a Custom Audible Alarm
Alert ” on page 750.

System 04-30005-01-en, May 2019

748
 31 Alarm Functions
31.38 Adding an Audio File for a Custom Audible Alarm Alert

31.38 Adding an Audio File for a Custom

Audible Alarm Alert
You add an audio file that you want to use to configure a custom audio alert for
an alarm.
For more information, see section 31.36 “Custom Audible Alarm Alerts” on page
747.

To add an audio file for a custom audible alarm alert

1. In WorkStation, expand the EcoStruxure BMS server where the audio file is
to be played.
2. On the EcoStruxure BMS server where the audio file is to be played, select
the Audio folder in the System folder.
3. On the File menu, point to New and then click Audio file
file.
4. In the Create Object wizard, in the list, select the audio file format of the
audio file you want to add.
5. In the Name box, type a name for the audio file.
6. In the Description box, type a description for the audio file.
7. Click Next
Next.
8. In the Audio file box, enter the path of the audio file.
9. Click Create
Create.
The audio file can now be connected to the audible alert of an alarm.

04-30005-01-en, May 2019 System

749
31 Alarm Functions
31.39 Configuring a Custom Audible Alarm Alert

31.39 Configuring a Custom Audible Alarm

Alert
You configure a custom audible alert for an alarm to play an audio file when the
alarm is triggered.
For more information, see section 31.36 “Custom Audible Alarm Alerts” on page
747.

To configuring a custom audible alarm alert

1. In WorkStation, expand the EcoStruxure BMS server where the alarm is to
be played.
2. In the System folder, select the Audio folder and ensure the audio file has
been added.
3. Select the alarm for which you want to configure the custom audible alert.
4. Click the Presentation tab of the alarm.
5. Select Audible alert
alert.
6. In the Custom audio box, enter the path of the audio file you want to use.

7. Click the Save button .

System 04-30005-01-en, May 2019

750
 31 Alarm Functions
31.40 Turning off a Visual and Audible Alert

31.40 Turning off a Visual and Audible Alert

You temporarily turn off an alarm alert when you no longer need it. If the alarm
has both a visual and an audible alert, you turn off both in one operation.
For more information, see section 31.36 “Custom Audible Alarm Alerts” on page
747.

To turn off a visual and audible alert

1. In WorkStation, in the Alarms pane or Alarm View, right-click the alarm with
the configured visual or audible alert.
2. In the Alarms pane or Alarm View, right-click the alarm with the configured
visual or audible alert.
3. Click Turn off visual and audible alert
alert.

04-30005-01-en, May 2019 System

751
31 Alarm Functions
31.41 Alarm Control Panel Synchronization

31.41 Alarm Control Panel Synchronization

When you have predefined Alarm Control Panel objects, for example user
actions or alarm decorators, that you want to reuse on another EcoStruxure BMS
server, you configure a lead-shadow relationship on the shadow Alarm Control
Panel.
Lead-shadow relationship means that properties of the lead object are
propagated to the shadow object.
Alarm Control Panels objects saved on an Enterprise Central are not
automatically propagated to Alarm Control Panel objects on Enterprise Servers
in the EcoStruxure BMS. Alarm Control Panel objects saved on an Enterprise
Server are automatically propagated to Alarm Control Panel objects on SmartX
servers in the EcoStruxure BMS.
When you have configured a lead-shadow relationship, the shadow objects
becomes read-only.
You can disconnect an Alarm Control Panel on a lower-tier EcoStruxure BMS
server. The disconnected Alarm Control Panel then becomes writeable. When
you have disconnected the Alarm Control Panel, the current configuration of the
Alarm Control Panel is retained.

System 04-30005-01-en, May 2019

752
 31 Alarm Functions
31.42 Synchronizing Alarm Control Panels

31.42 Synchronizing Alarm Control Panels

You synchronize Alarm Control Panels to reuse the Alarm Control Panel on a
parent EcoStruxure BMS server.

NOTICE
Export Alarm Control Panel objects from the child server (Enterprise Server or
Automation Server) and import them to the parent server (Enterprise Central or
Enterprise Server) before you synchronize the Alarm Control Panel. During
synchronization, all the Alarm Control Panel objects are erased from the child
server.

To synchronize Alarm Control Panels

1. Make sure that you have exported Alarm Control Panel objects from the
child server and imported them to the parent server.
2. In WorkStation, in the System Tree pane, expand the System folder.
3. Select Alarm Control Panel
Panel.
4. On the Actions menu, point to Advanced and then click Synchronize with
parent server
server.
5. Click Yes
Yes.

04-30005-01-en, May 2019 System

753
31 Alarm Functions
31.43 Viewing the Events of an Alarm

31.43 Viewing the Events of an Alarm

You view the events of an alarm when you want to check the historical data of
the alarm.

To view the events of an alarm

1. In WorkStation, in the Alarms pane, right-click anywhere.
2. Point to View
View.
3. Click View history
history.

System 04-30005-01-en, May 2019

754
32 User Actions

Topics
User Actions
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
Configuring Forced User Actions
 32 User Actions
32.1 User Actions

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

NOTICE
When an Enterprise Central is connected to an Enterprise Server, all existing
checklists, action notes, cause notes, and categories on the Enterprise Server
are preserved until you chose to manually synchronize with the parent server.
When an Enterprise Server is connected to a SmartX server, all existing
checklists, action notes, cause notes, and categories on the SmartX server are
removed and replaced with the objects from the Enterprise Server.

32.1.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 32.2 “Comments” on page 759.

32.1.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 choices.
For more information, see section 32.3 “Cause Notes” on page 760.

32.1.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 32.7 “Action Notes” on page 764.

04-30005-01-en, May 2019 System

757
32 User Actions
32.1 User Actions

32.1.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 32.11 “Checklists” on page 768.

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

problems that can have easily report the cause that
caused the alarm. triggered the alarm.

Action Notes A predefined list of possible Use the action notes to

actions that can correct the easily report the actions that
problem. were taken to correct the
problem that triggered the
alarm.

Checklists A predefined list of steps Use the checklist to

that guides the user to solve navigate the user step-by-
the problem that can have step to solve the problem.
triggered the alarm.

System 04-30005-01-en, May 2019

758
 32 User Actions
32.2 Comments

32.2 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.
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.
When you add a comment to an alarm, an event is created and the comment is
added to the Last comment column on the alarm record. Only the last added
comment is shown on the alarm record. The last comment is deleted if the alarm
goes back to Normal state and then is triggered again.

04-30005-01-en, May 2019 System

759
32 User Actions
32.3 Cause Notes

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

Figure: 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-30005-01-en, May 2019

760
 32 User Actions
32.4 Creating a Cause Note

32.4 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 32.3 “Cause Notes” on page 760.

To create a cause note

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Cause notes
notes.
4. In the Alarm Control Panel
Panel, in the Cause notes view, click the Add cause

note button .
5. In the Add Cause Note dialog box, in the Name box, type the name of the
new cause note.
6. 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.
7. In the Description box, type a description for the cause note.
8. Click OK
OK.

9. Click the Save button .

04-30005-01-en, May 2019 System

761
32 User Actions
32.5 Editing a Cause Note

32.5 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, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Cause notes
notes.
4. In the Cause notes view, select the cause note you want to edit.

5. Click the Edit cause note button .

NOTICE
• To permanently remove a cause note from the cause notes list, click the

Remove cause note button .

6. In the Edit Cause Note dialog box, in the Name box, type a name for the
cause note.
7. In the Group name box, type a name to create a new group or select an
existing group.
8. In the Description box, type a description for the cause note.
9. Click OK
OK.

10. Click the Save button .

System 04-30005-01-en, May 2019

762
 32 User Actions
32.6 Adding a Cause Note to an Alarm

32.6 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 32.3 “Cause Notes” on page 760.

To add a cause note to an alarm

1. In WorkStation, in the System Tree pane, select the alarm object to which
you want to add a cause note.
2. In the User Action tab, 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-30005-01-en, May 2019 System

763
32 User Actions
32.7 Action Notes

32.7 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: 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-30005-01-en, May 2019

764
 32 User Actions
32.8 Creating an Action Note

32.8 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 32.7 “Action Notes” on page 764.

To create an action note

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Action notes
notes.
4. In the Alarm
larm Control Panel
Panel, in the Action notes view, click the Add action

note button .
5. In the Add Action Note dialog box, in the Name box, type the name of the
new 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 .

04-30005-01-en, May 2019 System

765
32 User Actions
32.9 Editing an Action Note

32.9 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, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Action notes
notes.
4. In the Action notes view, select the action note you want to edit.

5. Click the Edit action note button .

NOTICE
• To permanently remove an action note from the action notes list, click

the Remove action note button .

6. In the Edit Action Note dialog box, in the Name box, type a name for the
action note.
7. In the Group name box, type a name to create a new group or select an
existing group.
8. In the Description box, type a description for the action note.
9. Click OK
OK.

10. Click the Save button .

System 04-30005-01-en, May 2019

766
 32 User Actions
32.10 Adding an Action Note to an Alarm

32.10 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 32.7 “Action Notes” on page 764.

To add an action note to an alarm

1. In WorkStation, 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-30005-01-en, May 2019 System

767
32 User Actions
32.11 Checklists

32.11 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.
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-30005-01-en, May 2019

768
 32 User Actions
32.12 Creating a Checklist

32.12 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 32.11 “Checklists” on page 768.

To create a checklist
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Checklists
Checklists.
4. In the Alarm Control Panel
Panel, in the Checklist view, click the Add checklist

button .
5. In the Add Checklist dialog box, in the Name box, type the name of the
new checklist.
6. In the Description box, type a description for the checklist.

7. Click the Add step button .

8. In the Add Checklist Step dialog box, in the Name box, type the text for the
step to create.
9. Click OK.

NOTICE
• You can add several steps to the checklist.

10. In the Add Checklist dialog box, click OK

OK.

11. Click the Save button .

04-30005-01-en, May 2019 System

769
32 User Actions
32.13 Editing a Checklist

32.13 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, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Checklists
Checklists.

4. In the Checklist view, click the Edit checklist button .

NOTICE
• To permanently remove a checklist, click the Remove checklist

button .

5. In the Edit Checklist dialog box, in the Name box, type the name of the new
checklist.
6. In the Description box, type a description for the checklist.

7. Select a step in the checklist and click the Edit step button to edit the
checklist step.

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

8. In the Edit checklist step dialog box, in the Name box, type the new text for
the step.
9. Click OK
OK.

10. Select a step in the checklist and click the Move step up button to
move the step upwards in the checklist.

11. Select a step in the checklist and click the Move step down button to
move the step downwards in the checklist.
12. In the Edit Checklist dialog box, click OK
OK.

13. Click the Save button .

System 04-30005-01-en, May 2019

770
 32 User Actions
32.14 Adding a Checklist to an Alarm

32.14 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 32.11 “Checklists” on page 768.

To add a checklist to an alarm

1. In WorkStation, in the System Tree pane, select the alarm object to which
you want to add a checklist.
2. In the User Action tab, in the Checklist box, enter the checklist 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-30005-01-en, May 2019 System

771
32 User Actions
32.15 Configuring Forced User Actions

32.15 Configuring Forced User Actions

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. In the properties pane, 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.

System 04-30005-01-en, May 2019

772
33 Alarm Decoration

Topics
Alarm Decoration
Creating an Alarm Decoration Rule
Configuring an Alarm Decoration Rule
 33 Alarm Decoration
33.1 Alarm Decoration

33.1 Alarm Decoration

If you want to override an alarm configuration for a specific alarm or group of
alarms you can use an alarm decoration rule.
An alarm decoration rule is similar to a filter. In the alarm decoration rule, you
configure the conditons that have to be met before the alarm decoration rule is
executed on an alarm. When configuring the alarm decoration rule, you
configure the alarm properties you want the alarm decoration rule to override
when an alarm that meets the conditons is triggered.
You can configure the following alarm and alarm styling properties in an alarm
decoration rule:
• Alarm text message
• Category
• Prefix for an alarm source name
• Alarm priority
• Auto hide
• Flashing alert
• Audible alert
• Disable state-change logging
• Background color
• Font color
• Font
• Cause note group
• Action note group
• Checklist
• Required user actions
• Alarm attachment (the new attachment is added to the original attachment)

NOTICE
If you are logged on to a SmartX server, an attachment used in the the alarm
decoration rule has to be stored on that SmartX server.

For example, if you configure the font, font color, and background color in an
alarm decoration rule, then an alarm record that matches the alarm decoration
rule criteria gets the specified colors in the Alarms pane or an Alarm View.
In the Alarm Decoration view, a preview of the selected conditions is displayed.
You can configure more than one alarm decoration rule and an alarm can meet
the conditions of more than one rule. You configure the order in which the alarm
decoration rules are executed by moving them up or down in a list. When an
alarm that matches the conditions is triggered, the alarm decoration rules are
executed from the lowest to the highest number in the list.
When an alarm changes state, the properties configured in the alarm decoration
rule are still active. The original configuration can change the alarm message
and the priority. If an alarm meets the conditions of a different alarm decoration
rule due to a state change, the properties change according to the configuration

04-30005-01-en, May 2019 System

775
33 Alarm Decoration
33.1 Alarm Decoration

in this alarm decoration rule. If you have not configured any font or color
properties in the alarm decoration rule, the font and color properties defined in
the alarm styles are applied. For more information, see section 35.45 “Alarm
Styles View” on page 946.
In a multi-server system, you create the alarm decoration rule on the Enterprise
Server. The alarm decoration rule is propagated to all the SmartX servers in the
EcoStruxure BMS. If you want to create an alarm decoration rule in the
Enterprise Central and propagate it to the Enterprise Server and SmartX servers,
you must first choose to synchronize the Alarm Control Panel in each Enterprise
Server to parent server. For more information, see section 31.42 “Synchronizing
Alarm Control Panels” on page 753.

System 04-30005-01-en, May 2019

776
 33 Alarm Decoration
33.2 Creating an Alarm Decoration Rule

33.2 Creating an Alarm Decoration Rule

You create an alarm decoration rule to override one or several properties of an
alarm when the conditions of the alarm decoration rule are met.
For more information, see section 33.1 “Alarm Decoration” on page 775.

To create an alarm decoration rule

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

4. In the Alarm Decoration view, click the Add decoration button .

5. In the Create Object wizard, in the Name box, type a name for the alarm
decoration rule.
6. In the Path box, view the path to the location where the alarm decoration
rule is stored.
7. In the Description box, type a description for the alarm triggered
notification.
8. Click Next
Next.

9. Click Add condition to add the conditions that have to be met before
the alarm decoration rule becomes active.
10. In the Add/Remove Conditions dialog box, select the conditions.
11. Click OK
OK.
12. In the Presentation page, select the Override boxes for the alarm
presentation properties you want to override when the alarm decoration
rule conditions are met.
Continued on next page

04-30005-01-en, May 2019 System

777
33 Alarm Decoration
33.2 Creating an Alarm Decoration Rule

13. Complete the following steps:

• In the Alarm text message box, type the message to display when the
alarm decoration rule conditions are met.
• In the Category box, type the path to the category the alarm is to
belong to when the alarm decoration rule conditions are met.
• In the Prefix for alarm source name box, type a prefix that is to be
added to the alarm source name when the alarm decoration rule
conditions are met.
• In the Priority box, enter the priority of the alarm state when the alarm
decoration rule conditions are met.
• Select the Auto hide box to automatically hide the alarm in the
Alarms pane or Alarm Views when the alarm decoration rule conditions
are met.
• Select the Flashing alert box, to make the alarm flash in the Alarms
pane and Alarm Views when the alarm is triggered and when the alarm
decoration rule conditions are met.
• Select the Audible alert box, to make the alarm sound when it is
triggered and when the alarm decoration rule conditions are met.
• Select the Disable state-change logging box, to prevent an alarm state
change from creating an event when the alarm is triggered and when
the alarm decoration rule conditions are met.
• In the Background color box, enter the background color of the row for
triggered alarms in the Alarms pane and Alarm Views when the alarm
decoration rule conditions are met.
• In the Font color box, enter the font color to use for triggered alarms in
the Alarms pane and Alarm Views when the alarm decoration rule
conditions are met.
• In the Font box, enter the font to use for triggered alarms in the Alarms
pane and Alarm Views when the alarm decoration rule conditions are
met.
14. Click Next
Next.
15. In the User Action page, select the Override boxes for the user action
properties you want to override when the alarm decoration rule conditions
are met.
16. In the Cause note group box, enter the path to a cause note group that you
want to connect to the alarm when the alarm decoration rule conditions are
met.
17. In the Action note group box, enter the path to an action note group that
you want to connect to the alarm when the alarm decoration rule conditions
are met.
18. In the Checklist box, enter the path to a checklist that you want to connect
to the alarm when the alarm decoration rule conditions are met.
19. Select When acknowledging an alarm
alarm: Comment to force the user to add
a comment to the alarm before the alarm can be acknowledged.
20. Select When acknowledging an alarm
alarm: Cause note to force the user to edit
the connected cause note before the alarm can be acknowledged.
Continued on next page

System 04-30005-01-en, May 2019

778
 33 Alarm Decoration
33.2 Creating an Alarm Decoration Rule

21. Select When acknowledging an alarm

alarm: Action note to force the user to edit
the connected action note before the alarm can be acknowledged
22. Select When acknowledging an alarm
alarm: Checklist to force the user to go
through the connected checklist before the alarm can be acknowledged
23. Select the actions for Comment
Comment, Cause note
note, and Action note to specify
how the user should respond to the actions when the alarm decoration rule
conditions are met.
24. Click Next
Next.

25. Click the Add attachment button to add an attachment.

NOTICE
If you are logged on to a SmartX server, an attachment used in the the
alarm decoration rule has to be stored on that SmartX server.

26. In the Select Object dialog box, select the attachment and then click
Select
Select.
27. Click Create
Create.
The properties defined in the alarm decoration rule are applied on the alarm
when an alarm that meets the conditions of the alarm decoration rule changes
state.

04-30005-01-en, May 2019 System

779
33 Alarm Decoration
33.3 Configuring an Alarm Decoration Rule

33.3 Configuring an Alarm Decoration Rule

You configure an alarm decoration rule to change the properties that are
overridden.
For more information, see section 33.1 “Alarm Decoration” on page 775.

To configure an alarm decoration rule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Under Alarm
Alarm, click Decoration
Decoration.
4. Click Alarm Decoration
Decoration.
5. In the list, select the alarm decoration rule you want to configure and then

click the Edit decoration button.

6. Click the Basic Settings tab.
7. Configure the basic settings:
Property Description

Type Displays the object type.

Name Displays the name of the alarm

decoration rule.

Description Type to change the description of the

alarm decoration rule.

8. Click the Filter tab.

9. Configure the filter settings:
Property Description

Add condition
Click to add the conditions that have to
be met before the alarm decoration rule
becomes active and overrides the
original configuration of the alarm. For
more information, see section 35.6
“Add/Remove Conditions Dialog Box”
on page 863.

Remove condition
Click to remove the selected condition.

Add row
Click to add another condition that has
to be met before the alarm decoration
rule becomes active.

System 04-30005-01-en, May 2019

780
 33 Alarm Decoration
33.3 Configuring an Alarm Decoration Rule

Continued
Property Description

Remove row
Click to remove the selected alarm
decoration rule condition.

Clear all Click to clear the selected conditions.

10. Click the Presentation tab.

11. Configure the presentation properties:
Property Description

Override Select the boxes for the alarm

presentation properties you want to
override when the alarm decoration rule
conditions are met.

Alarm text message Type the message to display when the

alarm is in Alarm state and the alarm
decoration rule conditions are met.
For more information, see section 31.7
“Alarm Messages” on page 708.

Category Enter the category that the alarm

belongs to when the alarm decoration
conditions are met.
For more information, see the
Categories topic on WebHelp.

Prefix for alarm source name Type a prefix that is added to the
beginning of the source name property
of an alarm record.

Priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.

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.

Disable state-change logging Select to prevent an alarm state change

from creating an event.

Continued on next page

04-30005-01-en, May 2019 System

781
33 Alarm Decoration
33.3 Configuring an Alarm Decoration Rule

Continued
Property Description

Background color Enter the background color of the row

for triggered alarms in the Alarms pane
and Alarm Views when the alarm
decoration rule conditions are met.
For more information, see section 35.45
“Alarm Styles View” on page 946.

Font color Enter the font color to use for triggered

alarms in the Alarms pane and Alarm
Views when the alarm decoration rule
conditions are met.
For more information, see section 35.45
“Alarm Styles View” on page 946.

Font Enter the font to use for triggered alarms

in the Alarms pane and Alarm Views
when the alarm decoration rule
conditions are met.
For more information, see section 35.45
“Alarm Styles View” on page 946.

12. Click the User Action tab.

13. Configure the user action properties.:
Property Description

Override Select the boxes for the user action

properties you want to override when
the alarm decoration rule conditions are
met.

Cause note group Enter the cause note group that is used
by the alarm when the alarm decoration
rule conditions are met.
For more information, see section 32.1
“User Actions” on page 757.

Action note group Enter the action note group that is used
by the alarm when the alarm decoration
rule conditions are met.
For more information, see section 32.1
“User Actions” on page 757.

Checklist Enter the checklist that belongs to the

alarm when the alarm decoration rule
conditions are met.
For more information, see section 32.1
“User Actions” on page 757.

System 04-30005-01-en, May 2019

782
 33 Alarm Decoration
33.3 Configuring an Alarm Decoration Rule

Continued
Property Description

Required User Actions Select what actions the user has to

perform when any of the listed events
occur and when the alarm decoration
rule conditions are met.
For more information, see section 32.1
“User Actions” on page 757.

14. Click the Attachment tab.

15. Configure the attachment properties:
Property Description

Add attachment
Click to add an attachment to the alarm
decoration rule. For more information,
see section 31.21 “Alarm Attachments”
on page 725.

Remove attachment
Click to remove the selected attachment
from the alarm decoration rule.

Navigate to
Click to open the attachment that is
selected in the attachment list.

Type View the object type of the attachment.

Name View the name of the attachment.

Display on alarm Select to display the attachment when

the alarm is triggered.

Path View the path of the attachment.

04-30005-01-en, May 2019 System

783
34 Notifications and Notification
Reports

Topics
Notifications
Creating an Alarm Triggered Notification
Configuring an Alarm Triggered Notification
Creating a Variable Triggered Notification
Configuring a Variable Triggered Notification
Notification Distribution Methods
Email Notification Distribution Method
SNMP Notification Distribution Method
Write to File Notification Distribution Method
Accessing a Notification Written to a File
Saving a Notification Written to a File
Deleting a Notification Written to a File
Manually Triggering a Notification
Notification Reports
Notification Report Workflow
Creating a Notification Report Template
Configuring a Notification Report Template
Events Substitution Codes
34 Properties and Watch Substitution Codes
Trend Logs Substitution Codes
Date and Time Formatting
Text Formatting
Notification Report Example 1
Notification Report Example 2
 34 Notifications and Notification Reports
34.1 Notifications

34.1 Notifications
Notifications are used for notifying users or user groups that a certain alarm or
other event, such as a schedule or an application condition, has occurred in the
system. The notification contains a prewritten message that can be displayed as
a popup message, sent as an email, sent to an SNMP manager, or written to a
text file.
There are two types of notifications:
• alarm triggered notifications
• variable triggered notifications
Alarm triggered notifications are based on alarm filter conditions that have to be
met before the notification is triggered.
Variable triggered notifications are based on a variable whose condition (true,
false, or both) has to be met before the notification is triggered. You can also
trigger notifications manually by using the trigger notification command.

NOTICE
• You have to have permissions to the alarm that triggered the notification to
receive an alarm triggered notification as a client notification or via email.

Figure: A notification is triggered and sends a notification report using one or more
distribution methods

When setting up the notification, you configure the message text and the
conditions that trigger the notification. When configuring the notification
message text, you can use substitution codes to add current system information.
For more information, see Alarm Substitution Codes

04-30005-01-en, May 2019 System

787
34 Notifications and Notification Reports
34.1 Notifications

If you want a schedule condition to be met before the notification is enabled, you
can add a schedule to the notification. For example, you only want an email to
be sent on weekends. You configure the active value to match the value of a
multistate schedule when the notification is to be active. This only applies for
alarm triggered notifications.
In a multi-server system, a notification object created on the Enterprise Server or
on the Enterprise Central notifies on alarms triggered in the child servers. The
advantage of creating the notification object on the Enterprise Server or on the
Enterprise Central is that you do not need to create separate notification objects
for each child server server.
You can configure the notification so that it is localized to any language for
which a language pack is available on the server. The default language is US
English. If you choose to localize the notification, enumerations and display
names are translated with the correlating names available in the language pack.
You can configure the notification to use any of the following decimal separators:
• '.' (period)
• ',' (comma)
By default, the decimal separator is '.' (period).

34.1.1 Alarm Substitution Codes

Alarm substitution codes represent the information you want to dynamically add
to alarm messages and notifications when an alarm is triggered.
For more information, see section 31.27 “Alarm Substitution Codes” on page
731.

34.1.2 Notification Distribution Methods

There are four different ways to distribute a notification to a recipient:
• Client
• Email
• SNMP
• Write to File
For more information, see section 34.6 “Notification Distribution Methods” on
page 801.

34.1.3 Notification Reports

You can configure notification reports to include important information on the
EcoStruxure BMS. Notification reports are distributed when a notification is
triggered.
For more information, see section 34.14 “Notification Reports” on page 810.

System 04-30005-01-en, May 2019

788
 34 Notifications and Notification Reports
34.1 Notifications

34.1.4 Notification Workflow

Use the notification workflow to create a notification including a notification
report template.
For more information, see section 34.15 “Notification Report Workflow” on page
815.

34.1.5 Date and Time Formatting

You can customize how date and time are presented in a notification text or a
notification report text.
For more information, see section 34.21 “Date and Time Formatting ” on page
833.

34.1.6 Text Formatting

You can customize the presentation of decimals, value types, width, and
alignment in a notification text or a notification report text.
For more information, see section 34.22 “Text Formatting” on page 835.

04-30005-01-en, May 2019 System

789
34 Notifications and Notification Reports
34.2 Creating an Alarm Triggered Notification

34.2 Creating an Alarm Triggered

Notification
You configure an alarm triggered notification to notify users when an alarm
condition is met.
For more information, see section 34.1 “Notifications” on page 787.

To create an alarm triggered notification

1. In WorkStation, in the System Tree pane, click the folder where you want to
add the alarm triggered notification.
2. On the File menu, point to New and then click Notification
Notification.
3. In the Create Object wizard, in the object type list, select Alarm Triggered
Notification
Notification.
4. In the Name box, type a name for the alarm triggered notification.
5. In the Description box, type a description for the alarm triggered
notification.
6. Click Next
Next.
7. In the Configure Alarm Triggered Notification page, in the Status box,
select Disabled to deactivate the notification function.
8. In the Activation schedule box, enter the schedule that contains the value
that activates the notification.
9. In the Schedule value when active box, enter the value, generated by the
connected schedule, that activates the notification.
10. To add a notification report to the notification, in the Report template box,
enter the path to the notification report template. For more information, see
section 34.14 “Notification Reports” on page 810.
11. In the Decimal symbol box, select the decimal symbol to be used in the
notification and notification report.
12. To localize the notification, in the Localization box, select a language
among the language packs installed on the EcoStruxure BMS server.
13. In the Notification text box, enter and edit the notification text.

NOTICE
You can use substitution codes, blank spaces, blank rows, and all
printable characters in the notification text.

14. From the list of substitution codes, drag the substitution codes you want to
use in the notification text to the Notification text box.

System 04-30005-01-en, May 2019

790
 34 Notifications and Notification Reports
34.2 Creating an Alarm Triggered Notification

15. Click the Add button to add a notification distribution method for the
notification.

NOTICE
You can distribute the same notification in more than one way.

16. To add a Client distribution method, select Client and complete the
following steps:
• In the Name box, type a name for the distribution method.
• In the Description box, type a description for the distribution method.
• Click Create
Create.
17. To add an Email distribution method, select Email and complete the
following steps:
• In the Name box, type a name for the distribution method.
• In the Description box, type a description for the distribution method.
• Click Next
Next.
• In the Subject box, type a subject that is displayed in the 'Subject' row
of the email.
• In the To users and groups box, enter the EcoStruxure Building
Operation users or user groups to whom the email notification is to be
sent. For more information, see section 35.82 “Users and Groups
Dialog Box” on page 997.
• In the To email address box, type the email address of an alternative
recipient.
• Select Send as attachment to send the notification as an attachment to
the email.
• In the Attachment filename box, type the name of the attachment file.

• Click the Configure button to configure a reference for a dynamic

attachment file name.
• Click Create
Create.

NOTICE
• A user account can have two email addresses: home and work. Only
the work email address is used for email distribution of notifications.
However, email notifications are sent only when the account has a work
email address.
• The email cannot be sent if the user does not have permission to the
triggered alarm.

04-30005-01-en, May 2019 System

791
34 Notifications and Notification Reports
34.2 Creating an Alarm Triggered Notification

18. To add an SNMP distribution method, select SNMP and complete the
following steps:
• In the Name box, type a name for the distribution method.
• In the Description box, type a description for the distribution method.
• In the Address box, type the address to the SNMP manager that
receives the notification.
• Click Next
Next.
• In the Port box, type the port that is used by the SNMP manager that
receives the notification.
• In the User name box, type the user name of the user on the SNMP
manager that receives the notification.
• In the Security level box, select the security level.
• In the Authentication protocol box, select the authentication level.
• In the Authentication password box, enter the password of the user on
the SNMP manager that is to receive the notification.
• In the Confirm password box, type the password again.
• In the Privacy encryption protocol box, enter the privacy encryption
protocol of the user on the SNMP manager that is to receive the
notification.
• In the Privacy password box, enter the privacy password used to
encrypt the message being sent.
• In the Confirm password box, type the password again.
• Click Create
Create.
19. To add a Write to file distribution method, select Write to file and complete
the following steps:
• In the Name box, type a name for the distribution method.
• In the Description box, type a description for the distribution method.
• Click Next
Next.
• In the File name box, type a name for the file.

• Click the Configure button to configure a reference for a dynamic

file name.
• In the Uniqueness box, select whether to append or prepend a
timestamp to the file name, or generate the file without any timestamp.
• In the Overwrite box, select True to overwrite the file when a new file is
generated.
• Click Create
Create.
20. In the Notify on transition to boxes, select the alarm states that trigger the
notification.

21. Click the Add button to add an alarm filter condition for the
notification. For more information, see section 29.18 “Alarm Filters” on page
595.

System 04-30005-01-en, May 2019

792
 34 Notifications and Notification Reports
34.2 Creating an Alarm Triggered Notification

22. Click Create

Create.

04-30005-01-en, May 2019 System

793
34 Notifications and Notification Reports
34.3 Configuring an Alarm Triggered Notification

34.3 Configuring an Alarm Triggered

Notification
You configure an alarm triggered notification to notify users when an alarm
condition is met.
For more information, see section 34.1 “Notifications” on page 787.

To configure an alarm triggered notification

1. In WorkStation, in the System Tree pane, select the alarm triggered
notification you want to configure.
2. Click the Alarm Triggered Notification tab.
3. Edit the properties:
Property Description

Status Select Disabled to deactivate the

notification function.

Activation schedule Enter the schedule that contains the

value that activates the notification.

Schedule value when active Enter the value, generated by the

connected schedule or other multistate
variable, that activates the notification.

Report template Enter the path to the report template.

For more information, see section 34.14
“Notification Reports” on page 810.

Decimal symbol Select the decimal symbol to be used in

the notification and the notification
report template.

Localization Select a language among the language

packs installed on the EcoStruxure BMS
server.

Notification text Edit the notification text.

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

Add
Click to add a distribution method to the
notification.
For more information, see section 34.6
“Notification Distribution Methods” on
page 801.

Continued on next page

System 04-30005-01-en, May 2019

794
 34 Notifications and Notification Reports
34.3 Configuring an Alarm Triggered Notification

Continued
Property Description

Edit
Click to configure the selected
distribution method in the notification.
For more information, see section 34.6
“Notification Distribution Methods” on
page 801.

Remove
Click to remove the selected distribution
method from the notification.
For more information, see section 34.6
“Notification Distribution Methods” on
page 801.

4. On the File menu, click Save

Save.

04-30005-01-en, May 2019 System

795
34 Notifications and Notification Reports
34.4 Creating a Variable Triggered Notification

34.4 Creating a Variable Triggered

Notification
You create a variable triggered notification to notify users when a variable meets
the configured trigger condition.
For more information, see section 34.1 “Notifications” on page 787.

To create a variable triggered notification

1. In WorkStation, in the System Tree pane, select the folder where you want
to add the variable triggered notification.
2. On the File menu, point to New and then click Notification
Notification.
3. In the object type list, select Variable Triggered Notification
Notification.
4. In the Name box, type a name for the variable triggered notification.
5. In the Description box, type a description for the variable triggered
notification.
6. Click Next
Next.
7. In the Create Object wizard, in the Trigger variable box, enter the variable
that triggers the notification.
8. In the Trigger condition box, select when you want the notification to be
triggered: when the trigger variable changes to True, changes to False, or
on all changes.
9. To add a notification report to the notification, in the Report template box,
enter the path to the notification report template. For more information, see
section 34.14 “Notification Reports” on page 810.
10. In the Generate report relative to box, enter the path to the object that is
relative to the generated notification report.
11. In the Decimal symbol box, select the decimal symbol to be used in the
notification and notification report.
12. To localize the notification, in the Localization box, select a language
among the language packs installed on the EcoStruxure BMS server.
13. In the Notification text box, enter and edit the notification text.

NOTICE
You can use substitution codes, blank spaces, blank rows, and all
printable characters in the notification text.

14. From the list of substitution codes, drag the substitution codes you want to
use in the notification text to the Notification text box.
15. In the Configure Variable Triggered Notification page, click the Add

button to add a notification distribution method for the notification.

System 04-30005-01-en, May 2019

796
 34 Notifications and Notification Reports
34.4 Creating a Variable Triggered Notification

16. To add a Client distribution method, select Client and complete the
following steps:
• In the Name box, type a name for the distribution method.
• In the Description box, type a description for the distribution method.
• Click Create
Create.
17. To add an Email distribution method, select Email and complete the
following steps:
• In the Name box, type a name for the distribution method.
• In the Description box, type a description for the distribution method.
• Click Next
Next.
• In the Subject box, type a subject that is displayed in the 'Subject' row
of the email.
• In the To users and groups box, enter the EcoStruxure Building
Operation users or user groups to whom the email notification is to be
sent. For more information, see section 35.82 “Users and Groups
Dialog Box” on page 997.
• In the To email address box, type the email address of an alternative
recipient.
• Select Send as attachment to send the notification as an attachment to
the email.
• In the Attachment filename box, type the name of the attachment file.

• Click the Configure button to configure a reference for a dynamic

attachment file name.
• Click Create
Create.

04-30005-01-en, May 2019 System

797
34 Notifications and Notification Reports
34.4 Creating a Variable Triggered Notification

18. To add an SNMP distribution method, select SNMP and complete the
following steps:
• In the Name box, type a name for the distribution method.
• In the Description box, type a description for the distribution method.
• In the Address box, type the address to the SNMP manager that
receives the notification.
• Click Next
Next.
• In the Port box, type the port that is used by the SNMP manager that
receives the notification.
• In the User name box, type the user name of the user on the SNMP
manager that receives the notification.
• In the Security level box, select the security level.
• In the Authentication protocol box, select the authentication level.
• In the Authentication password box, enter the password of the user on
the SNMP manager that is to receive the notification.
• In the Confirm password box, type the password again.
• In the Privacy encryption protocol box, enter the privacy encryption
protocol of the user on the SNMP manager that is to receive the
notification.
• In the Privacy password box, enter the privacy password used to
encrypt the message being sent.
• In the Confirm password box, type the password again.
• Click Create
Create.
19. To add a Write to file distribution method, select Write to file and complete
the following steps:
• In the Name box, type a name for the distribution method.
• In the Description box, type a description for the distribution method.
• Click Next
Next.
• In the File name box, type a name for the file.

• Click the Configure button to configure a reference for a dynamic

file name.
• In the Uniqueness box, select whether to append or prepend a
timestamp to the file name, or generate the file without any timestamp.
• In the Overwrite box, select True to overwrite the file when a new file is
generated.
• Click Create
Create.
20. Click Create
Create.

System 04-30005-01-en, May 2019

798
 34 Notifications and Notification Reports
34.5 Configuring a Variable Triggered Notification

34.5 Configuring a Variable Triggered

Notification
You create a variable triggered notification to notify users when a variable meets
the configured trigger condition.
For more information, see section 34.1 “Notifications” on page 787.

To configure a variable triggered Notification

1. In WorkStation, in the System Tree pane, select the alarm triggered
notification you want to configure.
2. Click the Variable Triggered Notification tab.
3. Edit the properties:
Property Description

Trigger variable Enter the variable that triggers the

notification.

Trigger condition Select when you want the notification to

be triggered: when the trigger variable
changes to true, changes to false, or all
changes.

Report template Enter the path to the report template.

For more information, see section 34.14
“Notification Reports” on page 810.

Generate report relative to Enter the path to the object that is

relative to the generated notification
report.

Decimal symbol Select the decimal symbol to be used in

the notification and the notification
report template.

Localization Select a language among the language

packs installed on the EcoStruxure BMS
server.

Notification text Edit the notification text.

Add
Click to add a distribution method to the
notification.
For more information, see section 34.6
“Notification Distribution Methods” on
page 801.

Continued on next page

04-30005-01-en, May 2019 System

799
34 Notifications and Notification Reports
34.5 Configuring a Variable Triggered Notification

Continued
Property Description

Edit
Click to configure the selected
distribution method in the notification.
For more information, see section 34.6
“Notification Distribution Methods” on
page 801.

Remove
Click to remove the selected distribution
method from the notification.
For more information, see section 34.6
“Notification Distribution Methods” on
page 801.

4. On the File menu, click Save

Save.

System 04-30005-01-en, May 2019

800
 34 Notifications and Notification Reports
34.6 Notification Distribution Methods

34.6 Notification Distribution Methods

There are four different ways to distribute a notification to a recipient:
• Client
• Email
• SNMP
• Write to File

34.6.1 Client Notification Distribution Method

The client notification distribution method displays the notification as a system
tray popup in WorkStation when the configured alarm or variable condition is
met.

34.6.2 Email Notification Distribution Method

Notifications distributed by email are sent through the SMTP protocol when the
configured alarm or variable condition is met. If the recipient is a user account
and the notification is triggered by an alarm, the notification is only displayed if
the logged on user is authorized to view the alarm.
For more information, see section 34.7 “Email Notification Distribution Method”
on page 802.

34.6.3 SNMP Notification Distribution Method

SNMP alarms are typically used when the alarm receiver does not have access
to the EcoStruxure Building Operation software or when a central unit, for
example the IT department, wants to collect alarms from different sources in one
place.
For more information, see section 34.8 “SNMP Notification Distribution Method”
on page 804.

34.6.4 Write to File Notification Distribution Method

The write to file notification is written to a text file when the configured notification
condition is met.
For more information, see section 34.9 “Write to File Notification Distribution
Method” on page 805.

04-30005-01-en, May 2019 System

801
34 Notifications and Notification Reports
34.7 Email Notification Distribution Method

34.7 Email Notification Distribution Method

Notifications distributed by email are sent through the SMTP protocol when the
configured alarm or variable condition is met. If the recipient is a user account
and the notification is triggered by an alarm, the notification is only displayed if
the logged on user is authorized to view the alarm.
On the EcoStruxure BMS server where the notification is triggered, you need to
enter a sender email address to send from and select the email server the email
is sent through. For more information, see the Selecting and Specifying an Email
Server for Email Notifications topic on WebHelp.
You can send a notification by email to recipients whose user accounts reside
on the same EcoStruxure BMS server as the notification. Make sure that the
recipients of an alarm triggered notification have user accounts with permissions
to handle the alarm that triggered the notification.
For example, you create an alarm triggered notification distributed by email 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 email
address when any alarm in building C is triggered. For more information, see
section 35.96 “Create Notification Wizard - Configure Email Page” on page
1023..
You can send the notification by email to multiple recipients by adding a semi-
colon between the email addresses without any blank space, or by selecting a
user or user group. By selecting a user group, you make sure that the
notifications are sent to the EcoStruxure Building Operation software users who
are members of the group at any given time. For more information, see section
35.82 “Users and Groups Dialog Box” on page 997..
You can send the notification as an email message text or as an attachment to
the email. You can make the attachment file name dynamic by replacing it with a
string variable whose value you control from a program.

NOTICE
If the EcoStruxure BMS server fails to send a notification by email, this is
indicated by a system information alarm. For more information, see section
30.26 “System Alarms” on page 677..

If you import a notification with a user account or user account group that does
not exist on the EcoStruxure BMS server, the user account or user account
group is displayed in red text in the distribution method settings of the imported
notification.

System 04-30005-01-en, May 2019

802
 34 Notifications and Notification Reports
34.7 Email Notification Distribution Method

Figure: A user account or user account group that does not exist on the EcoStruxure BMS
server is indicated in red

04-30005-01-en, May 2019 System

803
34 Notifications and Notification Reports
34.8 SNMP Notification Distribution Method

34.8 SNMP Notification Distribution Method

SNMP alarms are typically used when the alarm receiver does not have access
to the EcoStruxure Building Operation software or when a central unit, for
example the IT department, wants to collect alarms from different sources in one
place.
You can send notifications as SNMP traps from any EcoStruxure BMS server
using SNMP version 3. The EcoStruxure BMS server can send one or many traps
depending on the setting.
You configure the SNMP trap to send the notification message.
Notifications sent using SNMP trap are written to the event log.
SNMP is also used to send information regarding the status of a SmartX server.
For more information, see the EcoStruxure BMS Servers topic on WebHelp..

System 04-30005-01-en, May 2019

804
 34 Notifications and Notification Reports
34.9 Write to File Notification Distribution Method

34.9 Write to File Notification Distribution

Method
The write to file notification is written to a text file when the configured notification
condition is met.
You can configure whether new information is appended to the existing file,
overwrites the current content of the file, or if it is written to a unique file. By
default, new information is appended to the existing file. If the file does not exist,
a new text file is created.
You can make the file name dynamic by replacing it with a string variable whose
value you control from a program.
The text file is saved in the EcoStruxure Building Operation database folder:
'...db/notifications'. You can access the notification file from the WorkStation
'System' folder, 'Notification files' subfolder of the EcoStruxure BMS server
where the file was generated. You can open the notification file with a text editor
installed on the computer.
You can save the file to a different location and rename it. You can also delete
the notification file.

NOTICE
When you delete the notification file, it is deleted from the physical device.

04-30005-01-en, May 2019 System

805
34 Notifications and Notification Reports
34.10 Accessing a Notification Written to a File

34.10 Accessing a Notification Written to a File

You access a notification written to a file on an EcoStruxure BMS server to read
the contents.
For more information, see section 34.9 “Write to File Notification Distribution
Method” on page 805.

To access a notification written to a file

1. In WorkStation, in the System Tree pane, expand the System folder.
2. Expand the Notification Files folder.
3. Click the file.
The file is opened in a text editor.

System 04-30005-01-en, May 2019

806
 34 Notifications and Notification Reports
34.11 Saving a Notification Written to a File

34.11 Saving a Notification Written to a File

You save a notification written to a file in a different location, for example, to store
the file or to include the file in an email message.
For more information, see section 34.9 “Write to File Notification Distribution
Method” on page 805.

To save a notification written to a file

1. In WorkStation, in the System Tree pane, expand the System folder.
2. Expand the Notification Files folder.
3. In the List view, select the notification file you want to save to a different
location.
4. On the Actions menu, click Save as
as.
5. In the Save As dialog box, select the folder where you want to save the
notification file and type a name for the file.
6. Click Save
Save.
You can now attach the notification file to an email message or save it to an
external storage device.

04-30005-01-en, May 2019 System

807
34 Notifications and Notification Reports
34.12 Deleting a Notification Written to a File

34.12 Deleting a Notification Written to a File

You delete a notification written to a file on an EcoStruxure BMS server to free up
space.
For more information, see section 34.9 “Write to File Notification Distribution
Method” on page 805.

To delete a notification written to a file

1. In WorkStation, in the System Tree pane, expand the System folder.
2. Expand the Notification Files folder.
3. In the List view, select the notification file(s) you want to delete.
4. Press Delete on the keyboard.
5. In the Confirm Delete dialog box, click Yes
Yes.
When you delete the notification file, it is deleted from the physical device.

System 04-30005-01-en, May 2019

808
 34 Notifications and Notification Reports
34.13 Manually Triggering a Notification

34.13 Manually Triggering a Notification

You trigger a notification to test if you have configured it correctly or to generate
a variable triggered notification when you want to trigger a notification report.
For more information, see section 34.1 “Notifications” on page 787.

To manually trigger a notification

1. In WorkStation, in the System Tree pane, select the notification you want to
trigger.
2. On the Actions menu, click Trigger notification
notification.
If configured correctly, you receive the notification.

04-30005-01-en, May 2019 System

809
34 Notifications and Notification Reports
34.14 Notification Reports

34.14 Notification Reports

You can configure notification reports to include important information on the
EcoStruxure BMS. Notification reports are distributed when a notification is
triggered.

Figure: Notification report

The notification report content is configured in a notification report template that

can be used and reused in notifications.
You define the contents of the notification report by configuring the following
information:
• Text adapted for the notification report
• Events
• Properties
• Trend log records
• Search results
• Watch View properties
The notification report template text can consist of any printable characters,
blank spaces, line feeds, and substitution codes.
You configure data type groups for the events, properties, search results, trend
logs, and Watch View properties you want to include in the notification report
template. The data type group names become substitution codes that you can
add to the notification report template. A data type group can be, for example, a
list of trend log values or properties.
You can use Quick filter to find a specific substitution code in a list of available
substitution codes.

System 04-30005-01-en, May 2019

810
 34 Notifications and Notification Reports
34.14 Notification Reports

An auto-complete feature helps you complete the name of a substitution code

when you start typing. You can add a substitution code to the notification report
template text by dragging it from the list of substitution codes.
By default, when a notification report is triggered it attempts to retrieve all the
values and log data for up to 5 seconds. The timeout property is configurable.
Absolute Path or Relative Path to the Objects Connected to the Trend Log or
Property
You can configure events, properties, search, trend logs, or Watch Views to
point to a specific object (absolute path) or to be relative to an object (relative
path).
When used in an alarm triggered notification, a relative path is relevant only
when there are several identical structures of objects, for example, folders
representing room or a devices. The contents of the report depend on which
alarm in the structure that triggered the notification.
When used in a variable triggered notification, you can configure the path the
notification report is generated relative to.

NOTICE
If you have more than one Relative Trend Log or Relative Properties data type
group in the same notification report, you can only have one relative reference
point for them all.

Example:
A notification report template including a trend log with a relative path to an
alarm is used, 'Room 1'. There are two more folders in the system with content
identical to the contents of the 'Room 1' folder. When an alarm is triggered in
'Room 3', the trend log data related to the triggered alarm in 'Room 3' is
presented in the notification report.

NOTICE
• If you use an absolute path for the property, you can move or rename the
property without any data loss when the notification report is generated.
• If you use a relative path for the property and move or rename the property,
you will lose data when the report is generated.

04-30005-01-en, May 2019 System

811
34 Notifications and Notification Reports
34.14 Notification Reports

Figure: Notification report with a relative path to the objects connected to the trend log or
property

34.14.1 Events Substitution Codes

Events substitution codes represent the information you want to display when a
notification report is triggered. The information is dynamically filled in from the
events that are included in the notification report.
For more information, see section 34.18 “Events Substitution Codes” on page
827.

System 04-30005-01-en, May 2019

812
 34 Notifications and Notification Reports
34.14 Notification Reports

34.14.2 Properties and Watch Substitution Codes

Properties and Watch substitution codes represent the information you want to
display when a notification report is triggered. The information is dynamically
filled in from the properties or Watch data that are included in the notification
report.
For more information, see section 34.19 “Properties and Watch Substitution
Codes” on page 831.

34.14.3 Trend Logs Substitution Codes

Events substitution codes represent the information you want to display when a
notification report is triggered. The information is dynamically filled in from the
events that are included in the notification report.
For more information, see section 34.20 “Trend Logs Substitution Codes” on
page 832.

34.14.4 Date and Time Formatting

You can customize how date and time are presented in a notification text or a
notification report text.
For more information, see section 34.21 “Date and Time Formatting ” on page
833.

34.14.5 Text Formatting

You can customize the presentation of decimals, value types, width, and
alignment in a notification text or a notification report text.
For more information, see section 34.22 “Text Formatting” on page 835.

34.14.6 Notification Report Example 1

In the example EcoStruxure BMS, we have created Building A and Building B
with a number of identical rooms. Building A has three rooms: Room 1, Room 2,
and Room 3. Building B has three rooms: Room 1, Room 2, and Room 3. Each
room has a value and a trend log that logs the room temperature. Each room
also has a value and a trend log that logs the CO2 percentage in the air. The
values are connected to alarms.
For more information, see section 34.23 “Notification Report Example 1” on page
837.

04-30005-01-en, May 2019 System

813
34 Notifications and Notification Reports
34.14 Notification Reports

34.14.7 Notification Report Example 2

In the example EcoStruxure BMS, we have created Building A and Building B
with a number of identical rooms. We have also created a folder for the
repeption area in Building A. In the Reception folder, we have created an analog
value and a trend log that logs the temperature in the reception area. The value
is connected to an alarm. A notification report that contains the log data is to be
displayed in a web browser when a user manually triggers the notification.
For more information, see section 34.24 “Notification Report Example 2” on page
841.

System 04-30005-01-en, May 2019

814
 34 Notifications and Notification Reports
34.15 Notification Report Workflow

34.15 Notification Report Workflow

Use the notification workflow to create a notification including a notification
report template.

Figure: Notification workflow

Note how the building is presented in the EcoStruxure BMS

Note how the building is presented in the EcoStruxure BMS. You need this
information to evaluate whether or not you can use relative properties or trend
logs in your notification report template.

Create the notification report template

On the server where you plan to create the notification, create a notification
report template.
For more information, see section 34.16 “Creating a Notification Report
Template” on page 816.

Create the notification

On the server where you created the notification report template, create the
notification.
For more information, see section 34.2 “Creating an Alarm Triggered
Notification” on page 790.
For more information, see section 34.4 “Creating a Variable Triggered
Notification” on page 796.

04-30005-01-en, May 2019 System

815
34 Notifications and Notification Reports
34.16 Creating a Notification Report Template

34.16 Creating a Notification Report Template

You create a notification report template to get a notification report when an
alarm or a variable triggers a notification.
For more information, see section 34.14 “Notification Reports” on page 810.

To create a notification report template

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS server where you want to create the notification report template.
2. On the File menu, point to New and then click Notification
Notification.
3. In the Create Object wizard, in the object type list, click Notification Report
Template
Template.
4. In the Name box, type a name for the notification report template.
5. In the Description box, type a description for the notification report
template.
6. Click Next
Next.
7. In the Configure Notification Report Template page, click the Add button

to add a data type to the notification report template.

Continued on next page

System 04-30005-01-en, May 2019

816
 34 Notifications and Notification Reports
34.16 Creating a Notification Report Template

8. To add the Events data type, select Events and complete the following
steps:
• In the Name box, type a name for the report data type template.
• In the Description box, type a description for the report data type.
• Click Next
Next.
• Select the Add relative source box to add a relative source to the filter.
• In the Relative to box, enter the object with the relation to the
notification report template that you want to use as a template for
where notification reports are generated.
• In the Relative source box, add the object in relation to the 'Relative to'
property.
• In the Source preview box, view how the source appears in the
notification report text.

• Click the Add button to add a condition for when the event is
written to the notification report.
• In the Add/Remove Conditions dialog box, select the conditions that
have to be met before the event is written to the notification report.
• In the Template box, enter the text or substitution codes you want to
use in the notification report.
• From the list of available substitution codes, add the substitution codes
you want to use in the notification or notification report to the Template
box.
• In the Template delimiter box, enter the delimiter you want to use to
separate the event records in the notification report.
• In the Preview box, view how the events appear in the notification
report text.
• In the Substitute missing data with box, enter the text or characters to
replace missing data.
In the Number of events box, enter the maximum number of events to
add to the notification report.
• Click Create
Create.

NOTICE
You can use substitution codes, blank spaces, blank rows, and all
printable characters in the notification text.

04-30005-01-en, May 2019 System

817
34 Notifications and Notification Reports
34.16 Creating a Notification Report Template

9. To add the Properties data type, select Properties and complete the
following steps:
• In the Name box, type a name for the report data type template.
• In the Description box, type a description for the report data type.
• Click Next
Next.

• Click the Add button to add a property to the notification report

template.
• In the Select Object and Properties dialog box, select the object and
properties that you want to use in the notification report template.
• In the Property template box, enter the text or substitution codes you
want to use in the notification report.
• From the list of available substitution codes, add the substitution codes
you want to use in the notification or notification report to the Property
template box.
• In the Property delimiter box, enter the delimiter you want to use to
separate the properties in the notification report.
• In the Preview box, view how the properties values appear in the
notification report text.
• In the Substitute missing data with box, enter the text or characters to
replace missing data.
• Click Create
Create.

NOTICE
You can use substitution codes, blank spaces, blank rows, and all
printable characters in the notification text.

10. In the Configure Notification Report Template page, click the Add button

to add a data type to the notification report template.

System 04-30005-01-en, May 2019

818
 34 Notifications and Notification Reports
34.16 Creating a Notification Report Template

11. To add the relative properties data type, select Relative Properties and
complete the following steps:
• In the Name box, type a name for the report data type template.
• In the Description box, type a description for the report data type.
• Click Next
Next.
• In the Relative to box, enter the object with the relation to the
notification report template that you want to use as a template for
where notification reports are generated.

• Click the Add button to add properties to the notification report

template.
• In the Select Object and Properties dialog box, select the object and
properties that you want to use in the notification report template.
• In the Property template box, enter the text or substitution codes you
want to use in the notification report.
• From the list of available substitution codes, add the substitution codes
you want to use in the notification or notification report to the Property
template box.
• In the Property delimiter box, enter the delimiter you want to use to
separate the properties in the notification report.
• In the Preview box, view how the properties appear in the notification
report text.
• In the Substitute missing data with box, enter the text or characters to
replace missing data.
• Click Create
Create.

NOTICE
If you have more than one relative data type in the same notification
report, you can only have one relative reference point for all of the relative
data types.

NOTICE
You can use substitution codes, blank spaces, blank rows, and all
printable characters in the notification text.

12. In the Configure Notification Report Template page, click the Add button

to add a data type to the notification report template.

04-30005-01-en, May 2019 System

819
34 Notifications and Notification Reports
34.16 Creating a Notification Report Template

13. To add the relative search data type, select Relative Search and complete
the following steps:
• In the Name box, type a name for the report data type template.
• In the Description box, type a description for the report data type.
• Click Next
Next.
• In the Relative to box, enter the object with the relation to the
notification report template that you want to use as a template for
where notification reports are generated.
• In the Relative search path box, enter the search query in relation to
the 'Relative to' property.
• In the Template box, enter the text or substitution codes you want to
use in the notification report.
• From the list of available substitution codes, add the substitution codes
you want to use in the notification or notification report to the Template
box.
• In the Template delimiter box, enter the delimiter you want to use to
separate the search results in the notification report.
• In the Preview box, view how the relative search results appear in the
notification report text.
• In the Substitute missing data with box, enter the text or characters to
replace missing data.
• Click Create
Create.

NOTICE
If you have more than one relative data type in the same notification
report, you can only have one relative reference point for all of the relative
data types.

NOTICE
You can use substitution codes, blank spaces, blank rows, and all
printable characters in the notification text.

14. In the Configure Notification Report Template page, click the Add button

to add a data type to the notification report template.

System 04-30005-01-en, May 2019

820
 34 Notifications and Notification Reports
34.16 Creating a Notification Report Template

15. To add the relative trend log data type, select Relative Trend Log and
complete the following steps:
• In the Name box, type a name for the report data type template.
• In the Description box, type a description for the report data type.
• Click Next
Next.
• In the Relative to box, enter the object with the relation to the
notification report template that you want to use as a template for
where notification reports are generated.
• In the Relative log path box, add the trend log in relation to the
'Relative to' property.
• In the Record template box, enter the text or substitution codes you
want to use in the notification report.
• From the list of available substitution codes, add the substitution codes
you want to use in the notification or notification report to the Record
template box.
• In the Record delimiter box, enter the delimiter you want to use to
separate the trend log records in the notification report.
• In the Preview box, view how the trend log records appear in the
notification report text.
• In the Substitute missing data with box, enter the text or characters to
replace missing data.
• Click Create
Create.

NOTICE
If you have more than one relative data type in the same notification
report, you can only have one relative reference point for all of the relative
data types.

NOTICE
You can use substitution codes, blank spaces, blank rows, and all
printable characters in the notification text.

16. In the Configure Notification Report Template page, click the Add button

to add a data type to the notification report template.

04-30005-01-en, May 2019 System

821
34 Notifications and Notification Reports
34.16 Creating a Notification Report Template

17. To add the Relative Watch View data type, select Relative Watch View and
complete the following steps:
• In the Name box, type a name for the report data type template.
• In the Description box, type a description for the report data type.
• Click Next
Next.
• In the Relative to box, enter the object with the relation to the
notification report template that you want to use as a template for
where notification reports are generated.
• In the Relative Watch View path box, enter the Watch View in relation
to the 'Relative to' property.
• In the Template box, enter the text or substitution codes you want to
use in the notification report.
• From the list of available substitution codes, add the substitution codes
you want to use in the notification or notification report to the Template
box.
• In the Template delimiter box, enter the delimiter you want to use to
separate the Watch View properties in the notification report.
• In the Preview box, view how the Watch View properties appear in the
notification report text.
• In the Substitute missing data with box, enter the text or characters to
replace missing data.
• Click Create
Create.

NOTICE
If you have more than one relative data type in the same notification
report, you can only have one relative reference point for all of the relative
data types.

NOTICE
You can use substitution codes, blank spaces, blank rows, and all
printable characters in the notification text.

18. In the Configures Notification Report Template page, click the Add button

to add a data type to the notification report template.

System 04-30005-01-en, May 2019

822
 34 Notifications and Notification Reports
34.16 Creating a Notification Report Template

19. To add the search data type, select Search and complete the following
steps:
• In the Name box, type a name for the report data type template.
• In the Description box, type a description for the report data type.
• Click Next
Next.
• In the Name box, type a name for the Search data type group.
• In the Search query box, enter the path to the saved search query
whose result you want to use in the notification or notification report.
• In the Template box, enter the text or substitution codes you want to
use in the notification report.
• From the list of available substitution codes, add the substitution codes
you want to use in the notification or notification report to the Template
box.
• In the Template delimiter box, enter the delimiter you want to use to
separate the search results in the notification report.
• In the Preview box, view how the search results appear in the
notification report text.
• In the Substitute missing data with box, enter the text or characters to
replace missing data.
• Click Create
Create.

NOTICE
You can use substitution codes, blank spaces, blank rows, and all
printable characters in the notification text.

20. In the Configure Notification Report Templat

Template page, click the Add button

to add a data type to the notification report template.

04-30005-01-en, May 2019 System

823
34 Notifications and Notification Reports
34.16 Creating a Notification Report Template

21. To add the trend log data type, select Trend Log and complete the
following steps:
• In the Name box, type a name for the report data type template.
• In the Description box, type a description for the report data type.
• Click Next
Next.
• In the Log reference box, add the path to the trend log you want to use
in the notification report.
• In the Record template box, enter the text or substitution codes you
want to use in the notification report.
• From the list of available substitution codes, add the substitution codes
you want to use in the notification or notification report to the Record
template box.
• In the Record delimiter box, enter the delimiter you want to use to
separate the trend log records in the notification report.
• In the Preview box, view how the trend log records appear in the
notification report text.
• In the Substitute missing data with box, enter the text or characters to
replace missing data.
• In the Number of records box, enter the maximum number of trend log
records you want to display in the notification report.
• Click Create
Create.

NOTICE
You can use substitution codes, blank spaces, blank rows, and all
printable characters in the notification text.

22. In the Configure Notification Report Template page, in the Add button

to add a data type to the notification report template.

System 04-30005-01-en, May 2019

824
 34 Notifications and Notification Reports
34.16 Creating a Notification Report Template

23. To add the Watch View data type, select Watch View and complete the
following steps:
• In the Name box, type a name for the report data type template.
• In the Description box, type a description for the report data type.
• Click Next
Next.
• In the Watch View box, enter the path to the saved Watch View whose
properties you want to use in the notification or notification report.
• In the Template box, enter the text or substitution codes you want to
use in the notification report.
• From the list of available substitution codes, add the substitution codes
you want to use in the notification or notification report to the Template
box.
• In the Template delimiter box, enter the delimiter you want to use to
separate the Watch View properties in the notification report.
• In the Preview box, view how the Watch View properties appear in the
notification report text.
• In the Substitute missing data with box, enter the text or characters to
replace missing data.
• Click Create
Create.

NOTICE
You can use substitution codes, blank spaces, blank rows, and all
printable characters in the notification text.

24. In the Report text box, enter the report text you want to display in the
notification report.
25. From the list of available substitution codes, drag the substitution codes
you want to use in the notification report text to the Report text box.
26. Click Create
Create.
You can use the notification report template in a notification.

04-30005-01-en, May 2019 System

825
34 Notifications and Notification Reports
34.17 Configuring a Notification Report Template

34.17 Configuring a Notification Report

Template
You configure a notification report template to get a notification report when an
alarm or a variable triggers a notification.
For more information, see section 34.14 “Notification Reports” on page 810.

To configure a notification report template

1. In WorkStation, in the System Tree pane, select the notification report
template you want to configure.
2. In the Notification Report Template view, configure the properties:
Property Description

Report data Use Report data to add, edit, or remove

data type groups to the notification
report template.

Add
Click to add a report data type to the
notification report template.

Edit
Click to edit the properties of the
selected report data type.

Remove
Click to remove the selected report data
type.

Report text Enter text to include in the notification

report template.

Timeout Enter the number of seconds the

notification attempts to fetch values
from the EcoStruxure Building
Operation database before canceling.

3. On the File menu, click Save

Save.
You can use the notification report template in a notification.

System 04-30005-01-en, May 2019

826
 34 Notifications and Notification Reports
34.18 Events Substitution Codes

34.18 Events Substitution Codes

Events substitution codes represent the information you want to display when a
notification report is triggered. The information is dynamically filled in from the
events that are included in the notification report.

Table: Events Substitution Codes for Notification Reports

Code Description

@(AcknowledgeTime) Writes the time and date an alarm was

acknowledged.

@(AlarmState) Writes the alarm state.

@(AlarmText) Writes the alarm message that was added

to the alarm.

@(AssignedState) Writes the assigned state the alarm had.

The possible values are: Unassigned,
Assigned, and Accepted.

@(AssignedToDomain) Writes the domain of the user or group that

an alarm was assigned to.

@(AssignedToUniqueUserId) Writes the ID of the user or group that an

alarm was assigned to.

@(AssignedToName) Writes the name of the user or group that

an alarm was assigned to.

@(BACnetEventType) Writes the BACnet alarm that monitored a

variable within a BACnet network.

@(BasicEvaluationState) Writes the basic evaluation state of an

alarm. The value True indicates that an
alarm was triggered.

@(Category) Writes the category name.

@(Command) Writes the executed command.

@(Comment) Writes the comment that was added to an

alarm.

@(ControlSource) Writes the initials of the controlling I/NET

operator.

@(ControlDescr) Writes the 4 bit I/NET state descriptor.

@(Count) Writes the number of times an alarm has

toggled between the alarm and reset state.

@(Description) Writes the description.

@(DeviceName) Writes the name of the I/NET device that

generated the event.

04-30005-01-en, May 2019 System

827
34 Notifications and Notification Reports
34.18 Events Substitution Codes

Continued
Code Description

@(DisabledCause) Writes the cause for why the alarm was

disabled. An alarm can be disabled by
user, shunt variable and/or system (it is
disabled by system if the alarm was
incorrectly configured).

@(DomainName) Writes the domain a user belonged to.

@(EvaluationState) Writes the evaluation state an alarm had.

For example, Upper limit alarm is
displayed if the monitored value reached
the upper alarm limit.

@(CWSId) Writes the ID of the event on the external

system.

@(CWSSourceId) Writes the ID of the external object that

generated the event.

@(FirstName) Writes the first name of the individual

whose key/card was used at the I/NET
door point.

@(ForcedValue) Writes the forced values.

@(GroupName) Writes the name of the cause note or action

note group the user edited.

@(Hidden) Writes the visible status an object had.

False is displayed when an object was
shown.

@(IndivNdx) Writes the individual number of the

individual whose key/card was used at the
I/NET door point.

@(InetAdr) Writes the system address of the point, or

station address of the host or controller
that generated the event.

@(InetEventTypeId) Writes the I/NET event type.

@(LastName) Writes the last name of the individual

whose key/card was used at the I/NET
door point.

@(LinkName) Writes the name assigned to the link of the

device from which the event originated.

@(MessageText) Writes the text of an I/NET action or

dispatch message, if there is one.

@(MonitoredVariable) Writes the path to the monitored variable.

@(Note) Writes the event notes.

@(PreviousAlarmState) Writes the previous alarm state.

System 04-30005-01-en, May 2019

828
 34 Notifications and Notification Reports
34.18 Events Substitution Codes

Continued
Code Description

@(Priority) Writes the priority an alarm had.

@(SigmaEventParams) Writes the Sigma event parameter.

@(SigmaEventType) Writes the Sigma event type.

@(Source) Writes the path of the source object.

@(SourceName) Writes the name of the external object that

generated the event.

@(SourceServer) Writes the server path of the source object.

@(TextField) Writes the (up to) 4 text characters that

represent the text state of a discrete point
or the unit description of an analog point.

@(StationName) Writes the name assigned to the controller

from which the event originated.

@(SystemAlarmId) Writes the alarm ID generated by the

system.

@(SystemEventId) Writes the event 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 an alarm went

from normal state to alarm state.

@(TYPE) Writes the event type.

@(UniqueAlarmId) Writes the unique alarm ID of an alarm.

@(UniqueUserId) Writes the ID of a user.

@(ItemName) Writes the events of which the user has

edited checklist, cause note group, or
action note group items.

@(UserName) Writes the name of the user that generated

the event.

@(ValueAfter) Writes the value of an object after it was

changed.

@(MonitoredValue) Writes the value the monitored variable

had when the alarm was triggered.

@(ValueBefore) Writes the value of an object before it was

changed.

04-30005-01-en, May 2019 System

829
34 Notifications and Notification Reports
34.18 Events Substitution Codes

Continued
Code Description

@(Zone) Writes the I/NET security zone number

associated with a security event (0-63).

System 04-30005-01-en, May 2019

830
 34 Notifications and Notification Reports
34.19 Properties and Watch Substitution Codes

34.19 Properties and Watch Substitution

Codes
Properties and Watch substitution codes represent the information you want to
display when a notification report is triggered. The information is dynamically
filled in from the properties or Watch data that are included in the notification
report.

Table: Properties Substitution Codes for Notification Reports

Code Description

@(DisplayName) Writes the property display name.

@(ObjectName) Writes the name of the object that has the

property.

@(ObjectPath) Writes the path of the object that has the

property.

@(PropertyName) Writes the property name.

@(Unit) Writes the property unit.

@(Value) Writes the property value.

04-30005-01-en, May 2019 System

831
34 Notifications and Notification Reports
34.20 Trend Logs Substitution Codes

34.20 Trend Logs Substitution Codes

Trend logs substitution codes represent the information you want to display
when a notification report is triggered. The information is dynamically filled in
from the trend log records.

Table: Trend Logs Substitution Codes for Notification Reports

Code Description

@(Comment) Writes the log record comment.

@(Event) Writes the log record event.

@(RecordType) Writes the log record type.

@(SeqNo) Writes the log record sequence number.

@(Status) Writes the log record value status.

@(Timestamp) Writes the time when the log record was

created.

@(User) Writes the log record user.

@(Value) Writes the log record value

System 04-30005-01-en, May 2019

832
 34 Notifications and Notification Reports
34.21 Date and Time Formatting

34.21 Date and Time Formatting

You can customize how date and time are presented in a notification text or a
notification report text.
Example:
Time: @(Timestamp:%a %m-%d-%y) => Time: Tue 12-02-15

Table: Date and Time Formatting (The table uses the example time: 2015-09-
22 – 07:11:00)
Format specifier Description Example

%a Abbreviated weekday Tue

name.

%A Long weekday name. Tuesday

%b Abbreviated month name. Sep

%B Full month name. September

%d Day of the month as 22

decimal 01 to 31

%j Day of year as decimal from 265

001 to 366 for leap years,
001 - 365 for non-leap
years.

%m Month name as a decimal 09

01 to 12.

%U The week number of the 38

current year as a decimal
number, range 00 to 53,
starting with the first Sunday
as the first day of week 01.
In 2005, Jan 1st fell on a
Saturday, so it fell within
week 00 of 2005 (week 00
spans 2004-Dec-26 to
2005-Jan-01. This also
happened to be week 53 of
2004).

%w Weekday as decimal 2
number 0 to 6.

%W Week number 00 to 53 38
where Monday is first day of
week 1.

%x Implementation-defined 09/22/15
date format from the locale.

%y Two-digit year. 15

%Y Four-digit year. 2015

04-30005-01-en, May 2019 System

833
34 Notifications and Notification Reports
34.21 Date and Time Formatting

Continued
Format specifier Description Example

%f Fractional seconds are 000000

always used, even when
their value is zero.

%H The hour as a decimal 07

number using a 24-hour
clock (range 00 to 23).

%I The hour as a decimal 07

number using a 12-hour
clock (range 01 to 12).

%M The minute as a decimal 11

number (range 00 to 59).

%p Either `AM' or `PM' AM

according to the given time
value, or the corresponding
strings for the current
locale.

%R The time in 24-hour notation 07:11

(%H:%M).

%s Seconds with fractional 00.000000

seconds.

%S Seconds only. 00

%T The time in 24-hour notation 07:11:00

(%H:%M:%S).

%Q Offset from UTC. +2H, -9H

System 04-30005-01-en, May 2019

834
 34 Notifications and Notification Reports
34.22 Text Formatting

34.22 Text Formatting

You can customize the presentation of decimals, value types, width, and
alignment in a notification text or a notification report text.

Decimals
You can customize the presentation of the number of decimals using the
following text formatting codes:
Code Description

@(Value) Displays 2 decimals

@(Value:%.1f) Displays 1 decimal

@(Value:%.4f) Displays 4 decimals

The default number of decimals displayed in a notification or notification report

is two.

Value types
You can customize the presentation of the value types using the following text
formatting codes:
Code Description

t Value type

s String

f Float

Width and alignment

You can customize the width and alignment of data in a notification or
notification report using the following text formatting codes:
Code Description

%wt At least w wide, right aligned

%-wt At least w wide, left aligned

%=wt At least w wide, center aligned

%w.ct At least w wide, right aligned, max c long

%-w.ct At least w wide, left aligned, max c long

%=w.ct At least w wide, center aligned, max c long

In this example, we have an alarm with the source '/Server/Alarm1' with a

monitored value of 0.5.

04-30005-01-en, May 2019 System

835
34 Notifications and Notification Reports
34.22 Text Formatting

Figure: This alarm has the source '/Server/Alarm1'

System 04-30005-01-en, May 2019

836
 34 Notifications and Notification Reports
34.23 Notification Report Example 1

34.23 Notification Report Example 1

In the system example, we have created Building A and Building B with a
number of identical rooms. Building A has three rooms: Room 1, Room 2, and
Room 3. Building B has three rooms: Room 1, Room 2, and Room 3. Each room
has a value and a trend log that logs the room temperature. Each room also has
a value and a trend log that logs the CO2 percentage in the air. The values are
connected to alarms.
The EcoStruxure BMS, named University X ES1, also has a value and a trend log
that logs the outdoor temperature.

Figure: Example 1 - Room structure

We have created a notification report template. A notification report template

functions as a template for how report content is added to a notification every
time the notification is triggered. For more information, see section 34.14
“Notification Reports” on page 810.

Figure: Notification Report Template

04-30005-01-en, May 2019 System

837
34 Notifications and Notification Reports
34.23 Notification Report Example 1

A notification report can contain four different types of information:

• Properties: In our example, this is the name of the EcoStruxure BMS
containing Building A and Building B, that is, 'University X

ES1'.
• Relative Properties: In our example, this is the room temperature value
relative to the Room 1 folder in Building A and also the CO2 value relative to

Room 1.
• Relative Trend Log: In in our example, this is one trend log for the room
temperature and one trend log for the CO2 percentage in Building A, Room
1. The trend logs share the relative reference point, since relative trend logs
and relative properties only can have one single reference point per

notification report.

System 04-30005-01-en, May 2019

838
 34 Notifications and Notification Reports
34.23 Notification Report Example 1

• Trend Log: In our example, this is the trend log that logs the outdoor
temperature. The trend log is placed in a separate folder outside the

Building folders.
Room 1 functions as a template where relative properties and trend logs are
used.
We have edited the notification report contents of each data type group by
adding substitution codes and free text. The report content of each added data
type group is displayed as a substitution code in the notification report text main
editor where we have made the final adjustments to the notification report text.

Figure: Substitution codes in notification reports.

An alarm triggered notification has been created. The alarm triggered

notification is triggered when an alarm with either of the source names 'Room
Temperature Notification Out of Range Alarm' or 'CO2 Out of Range Alarm' is
triggered.

Figure: Alarm triggered notification

04-30005-01-en, May 2019 System

839
34 Notifications and Notification Reports
34.23 Notification Report Example 1

Depending on which room the triggered alarm belongs to, the notification in turn
triggers the notification report for the properties and trend logs of that room. The
notification report is then distributed according to the configured distribution
methods. In this example, the distribution method is a write to file notification.
The notification report file is generated in the 'Notification Files' folder in the
'System' folder of the EcoStruxure BMS.

Figure: Notification Report

System 04-30005-01-en, May 2019

840
 34 Notifications and Notification Reports
34.24 Notification Report Example 2

34.24 Notification Report Example 2

In the system example, we have created Building A and Building B with a
number of identical rooms. We have also created a folder for the repeption area
in Building A. In the Reception folder, we have created an analog value and a
trend log that logs the temperature in the reception area. The value is connected
to an alarm. A notification report that contains the log data is to be displayed in a
web browser when a user manually triggers the notification.
We have created a variable triggered notification.

Figure: Variable triggered notification

We have created a notification report template. The notification report template

functions as a template for how notification report content is displayed when the
notification is triggered. For more information, see section 34.14 “Notification
Reports” on page 810.
The template is configured to be displayed as a simple web page that lists the
temperature data in an HTML table.

04-30005-01-en, May 2019 System

841
34 Notifications and Notification Reports
34.24 Notification Report Example 2

Figure: The notification report text in HTML including the trend log data

The trend report data is configured to display each log record as a new table
row with two cells: Timestamp and Value.

System 04-30005-01-en, May 2019

842
 34 Notifications and Notification Reports
34.24 Notification Report Example 2

Figure: The trend log part of the notification report text in HTML

We have created a variable triggered notification.

04-30005-01-en, May 2019 System

843
34 Notifications and Notification Reports
34.24 Notification Report Example 2

Figure: Variable triggered notification

The notification is configured to distribute the notification report as a write to file

notification with the HTML file extension. The notification report is generated
when a user manually triggers the variable triggered notification that uses the
notification report template.

System 04-30005-01-en, May 2019

844
 34 Notifications and Notification Reports
34.24 Notification Report Example 2

Figure: The file name in the notification specifies the file type that is to be generated

The file is accessed from the 'Notification Files' folder of the 'System' folder and
is opened in a web browser.

Figure: The notification report opened in a web browser

04-30005-01-en, May 2019 System

845
35 Alarms User Interface

Topics
Alarms Pane and Alarm View
Alarms Pane and Alarm View Toolbar
Alarms Pane and Alarm View Icons
Alarm and Event Detail View
Add/Remove Columns Dialog Box (Alarms)
Add/Remove Conditions Dialog Box
Alarm System Tree Icons
Change of State Alarm Properties – Basic Tab
Change of State Alarm Properties – Alarm Settings Tab
Enumeration Alarm Properties – Basic Tab
Enumeration Alarm Properties – Alarm Settings Tab
Matching Text String Alarm Properties – Basic Tab
Matching Text String Alarm Properties – Alarm Settings Tab
Multistate Alarm Properties – Basic Tab
Multistate Alarm Properties – Alarm Settings Tab
Out of Range Alarm Properties – Basic Tab
Out of Range Alarm Properties – Alarm Settings Tab
Out of Reference Range Alarm Properties – Basic Tab
Out of Reference Range Alarm Properties – Alarm Settings
Sum Alarm Properties – Basic Tab
35 Sum Alarm Properties – Alarm Settings Tab
Variable Status Alarm Properties – Basic Tab
Variable Status Alarm Properties – Alarm Settings Tab
Function Block Program Internal Alarm Properties - Basic
Tab
Function Block Program Internal Alarm Properties - Alarm
Settings Tab
Create Alarm Wizard – Presentation Page
Create Alarm Wizard – User Action Page
Create Alarm Wizard – Attachment Page
Create Change of State Alarm Wizard – Alarm Trigger Page
Create Multistate Alarm Wizard – Alarm Trigger Page
Create Matching Text String Alarm Wizard – Alarm Trigger
Page
Create Out of Range Alarm Wizard – Alarm Trigger Page
Create Out of Reference Range Alarm Wizard – Alarm
Trigger Page
Create Sum Alarm Wizard – Alarm Trigger Page
Create Enumeration Alarm Wizard – Alarm Trigger Page
Create Variable Status Alarm Wizard – Alarm Trigger Page
Create Attachment Wizard – Configure Attachment Page
Alarm Trigger Properties - Basic Tab
Alarm Trigger Properties – Range Tab
Alarm Trigger Properties – Value tab
Alarm Trigger Properties – Value tab
Attachment Properties
Alarm Control Panel Properties
User Action Properties
Alarm Styles View
Alarm Styles Properties
35 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
35 Checklist Step Properties
Alarm – Basic Settings View
Select Conditions Dialog Box
Create Assignment Wizard – Assignment Page
Assignment View
Assignment Properties
Users and Groups Dialog Box
Alarm View Properties
Progress View
Alarm Handling Properties
Alarms Pane Context Menu
Alarms Pane Context Menu - View Submenu
Alarms Pane Context Menu - Alarm View Settings Submenu
Alarm State Sort Order Dialog Box
Alarm Triggered Notification View
Alarm Triggered Notification Properties - Basic Tab
Create Alarm Triggered Notification Wizard – Configure
Alarm Triggered Notification Page
Variable Triggered Notification View
Variable Triggered Notification Properties - Basic Tab
Create Variable Triggered Notification Wizard – Configure
Variable Triggered Notification Page
Create Notification Wizard - Configure Email Page
Create Notification Wizard - Configure SNMP Page
Create Notification Wizard - Configure Write to File Page
Notification Report Template View
Notification Report Template Properties - Basic Tab
Create Notification Report Template Wizard – Configure
Notification Report Template Page
Create Report Data Wizard - Configure Events Page
35 Create Report Data Wizard - Configure Properties Page
Create Report Data Wizard - Configure Relative Properties
Page
Create Report Data Wizard – Configure Relative Search
Page
Create Report Data Wizard - Configure Relative Trend Log
Page
Create Report Data Wizard – Configure Relative Watch
View Page
Create Report Data Wizard – Configure Search Page
Create Report Data Wizard - Configure Trend Log Page
Create Report Data Wizard – Configure Watch Page
Alarm Decoration View
Alarm Decoration Rule Properties – Alarm Settings Tab
Create Alarm Decoration Rule Wizard - Filter Page
Create Alarm Decoration Rule Wizard - Presentation Page
Create Alarm Decoration Rule Wizard - User Action Page
 35 Alarms User Interface
35.1 Alarms Pane and Alarm View

35.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 35.2 “Alarms Pane
and Alarm View Toolbar” on page 854.

Use the columns to sort, show, and hide

information about the triggered alarms. For
more information, see the Add/Remove
Columns Dialog Box topic on WebHelp.

Use the Detail view to get information

about the selected alarm. For more
information, see section 35.4 “Alarm and
Event Detail View ” on page 857.

Use the list to get information about a

triggered alarm and its current status. For
more information, see section 35.3 “Alarms
Pane and Alarm View Icons” on page 856.

04-30005-01-en, May 2019 System

853
35 Alarms User Interface
35.2 Alarms Pane and Alarm View Toolbar

35.2 Alarms Pane and Alarm View Toolbar

Use the Alarms pane and Alarm View toolbar to manage the alarms.

Table: Alarms Pane and Alarm View Toolbar

Button Description

Acknowledge
Click to acknowledge alarm state or reset
state.
For more information, see the Alarm
Acknowledgements topic on WebHelp.

Enable alarm
Click to enable the alarm. If the alarm state
changed, for example, from alarm state to
normal state during the time the alarm was
disabled, the alarm is given the new state
once it is enabled.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Disable alarm
Click to disable the alarm. The alarm is
inactivated and cannot be acknowledged
or reset until it is enabled.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Unhide alarm
Click to show the alarm.
For more information, see the Hide and
Show Alarms topic on WebHelp.

Hide alarm
Click to hide the alarm in the Alarms pane
or Alarm View. The alarm is still logged in
the Event log.
For more information, see the Hide and
Show Alarms topic on WebHelp.

Add comment
Click to add a comment to the alarm.
For more information, see the Alarm
Comments topic on WebHelp.

Add cause note

Click to add a cause note to the alarm.
For more information, see the Cause Notes
topic on WebHelp.

System 04-30005-01-en, May 2019

854
 35 Alarms User Interface
35.2 Alarms Pane and Alarm View Toolbar

Continued
Button Description

Add action note

Click to add an action note to the alarm.
For more information, see the Action Notes
topic on WebHelp.

Checklist
Click to view the checklist for the alarm.
For more information, see the Checklists
topic on WebHelp.

Show disabled alarms

Click to toggle between showing and
hiding disabled alarms.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Show hidden alarms

Click to toggle between hiding alarms and
showing hidden alarms.
For more information, see the Hide and
Show Alarms topic on WebHelp.

Go to alarm object
Click to open the settings of the alarm in
the Work Area.

Edit user filter

Click to select the conditions for the
temporary alarm display in the Alarms
pane. When you close the view, the filter
conditions are lost. For more information,
see section 29.18 “Alarm Filters” on page
595.

Favorites
Click to open the Favorites menu where
you select, add, and manage favorites.

04-30005-01-en, May 2019 System

855
35 Alarms User Interface
35.3 Alarms Pane and Alarm View Icons

35.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 29.2 “Alarm
States” on page 579.

Alarm
Indicates that an alarm is triggered. For
more information, see section 29.2 “Alarm
States” on page 579.

Acknowledged
Indicates that a user has acknowledged
the alarm. The problem that caused the
alarm has not been corrected. For more
information, see section 29.2 “Alarm
States” on page 579.

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 29.2 “Alarm
States” on page 579.

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 29.2
“Alarm States” on page 579.

Fault
Indicates that the value reported from
hardware, such as a BACnet device, is not
trustworthy. For more information, see
section 29.2 “Alarm States” on page 579.

Attachment
Indicates that the alarm has an object
attached. For more information, see
section 31.21 “Alarm Attachments” on
page 725.

System 04-30005-01-en, May 2019

856
 35 Alarms User Interface
35.4 Alarm and Event Detail View

35.4 Alarm and Event Detail 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 and Event Detail View

Component Description

Quick filter Enter a word or a character to filter on. For

more information, see section 52.4 “Quick
Filter ” on page 1512.

Property Displays all possible columns of the

selected alarm or event.

Value Displays the value.

04-30005-01-en, May 2019 System

857
35 Alarms User Interface
35.5 Add/Remove Columns Dialog Box (Alarms)

35.5 Add/Remove Columns Dialog Box

(Alarms)
Use the Add/Remove Columns dialog box to add or remove columns from the
Alarms pane or an Alarm View.

Figure: Add/Remove Columns dialog box

Table: Add/Remove Columns Dialog Box

Component Description

Acknowledge time Select to display the time and date when

the alarm was acknowledged. For more
information, see the Alarm
Acknowledgements topic on WebHelp.

Acknowledged by Select to display the name of the individual

who acknowledged the alarm. For more
information, see the Alarm
Acknowledgements topic on WebHelp.

Acknowledgement required Select to display the required

acknowledgement to acknowledge the
alarm. For more information, see the Alarm
Acknowledgements topic on WebHelp.

Alarm state Select to display the state of the alarm. For

more information, see section 29.2 “Alarm
States” on page 579.

Alarm text Select to display the alarm message that is

added to the alarm. For more information,
see section 31.7 “Alarm Messages” on
page 708.

System 04-30005-01-en, May 2019

858
 35 Alarms User Interface
35.5 Add/Remove Columns Dialog Box (Alarms)

Continued
Component Description

Assigned state Select to display the assigned state of the

alarm. For more information, see section
31.28 “Alarm Assignments” on page 736.

Assigned to domain Select to display the domain of the user or

user group that an alarm is assigned to.
For more information, see section 21.1
“Domains” on page 391.

Assigned to ID Select to display the ID of the user or

group that an alarm was assigned to.

Assigned to name Select to display the name of the user or

user group that an alarm has been
assigned to.

BACnet alarm type Select to display the BACnet alarm type of

the alarm that monitored a variable within a
BACnet network.

BACnet notification Select to display the distribution

information of an alarm notification within a
BACnet system

BACnet notification type Select to display the distribution

information type of an alarm notification
within a BACnet system..

Basic evaluation state Select to display the basic evaluation state

of an alarm. The value True indicates that
an alarm is triggered.

Category Select to display the alarm category name.

Command value Select to display the value that was

commanded.

Confirmed notification Select to display whether or not the

EcoStruxure BMS server that received
transmission of data has sent a
confirmation to the sending device that the
data has been received.

Count Select to display the number of times an

alarm has toggled between the alarm and
reset state. For more information, see the
Count topic on WebHelp.

Deadband Select to display the deadband value of

the alarm.

Device name Select to display the name of the I/NET

device that generated the alarm.

Disabled by Select to display the name of the user who

disabled the alarm.

04-30005-01-en, May 2019 System

859
35 Alarms User Interface
35.5 Add/Remove Columns Dialog Box (Alarms)

Continued
Component Description

Disabled cause Select to display the cause for disabling

the alarm. An alarms can be disabled by a
user, a shunt variable, or, if incorrectly
configured, by the system.

Error limit Select to display the difference limit that

was exceeded.

Evaluation state Select to display the evaluation state of an

alarm. For example, Upper limit alarm is
displayed if the monitored variable
reached the upper alarm limit.

Event from state Select to display the event state after the
occurrence that initiated the notification.

EWS ID Select to display the EcoStruxure Web

Service identification of the alarm in the
external system.

EWS source ID Select to display the EcoStruxure Web

Service identification of the external object
that generated the alarm.

Exceeded limit Select to display the limit that was

exceeded.

Exceeding value Select to display the value that exceeded

the limit.

Feedback value Select to display the value that differs from

the Command value.

First name Select to display the first name of the

individual whose key/card was used at the
I/NET door point.

Hidden Select to display the visible status of an

object. False is displayed when an object
is shown.

Individual Select to display the individual number of

the individual whose key/card was used at
the I/NET door point.

Last comment Select to display the last comment on a

triggered alarm.

Last name Select to display the last name of the

individual whose key/card was used at the
I/NET door point.

Logging Select to display whether or not associated

alarm events are generated and recorded
in the event log.

Message text Select to display the text of an I/NET action

or dispatch message, if there is one.

System 04-30005-01-en, May 2019

860
 35 Alarms User Interface
35.5 Add/Remove Columns Dialog Box (Alarms)

Continued
Component Description

Monitored variable Select to display the path of the monitored

variable.

New mode Select to display the new mode of the

referenced object.

New state Select to display the new state of the

referenced object.

New value Select to display the new value of the

referenced property.

Operation expected Select to display the next operation

requested by the referenced object.

Possible operator actions Select to display the actions available to

the operator.

Previous alarm state Select to display the previous alarm state

of an alarm.

Priority Select to display the priority of an alarm.

Process ID Not used.

Reference bit string Select to display the new value of the

referenced bitstring property.

Sequence number Select to display the alarm sequence

number on the present EcoStruxure BMS
server.

Setpoint value Select to display the value of the reference

variable.

Sigma event parameters Select to display parameters of the Sigma

event that generated the alarm.

Sigma event type Select to display the type of Sigma event

that generated the alarm.

Source Select to display path of the source object.

Source name Select to display the name of the source

object.

Source server Select to display the server path of the

source object.

Status flags Select to display the status flag of the

object.

System alarm ID Select to display the alarm ID generated

by the system.

04-30005-01-en, May 2019 System

861
35 Alarms User Interface
35.5 Add/Remove Columns Dialog Box (Alarms)

Continued
Component Description

Tenant Select to display tenant number of the

individual whose key/card was used at the
I/NET door point.

Timestamp Select to display the time and date when

the alarm was generated.

Triggered time Select to filter alarms by the time and date

the alarm went from normal state to alarm
state.

Type Select to display the alarm type. For more

information, see section 53.39 “General
Information Properties – Basic Tab” on
page 1604.

Value at change Select to display the value the monitored

variable had when the alarm was
triggered.

System 04-30005-01-en, May 2019

862
 35 Alarms User Interface
35.6 Add/Remove Conditions Dialog Box

35.6 Add/Remove Conditions Dialog Box

Use the Add/Remove Conditions dialog box to add or remove conditions from
the Alarms pane, Alarm View, Events pane, Event View, Alarm Triggered
Notification View, Assignment View, or Sum Alarm View.

Figure: Add/Remove Conditions dialog box

04-30005-01-en, May 2019 System

863
35 Alarms User Interface
35.7 Alarm System Tree Icons

35.7 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 29.1 “Alarms Overview” on page
577.
Alarm
Indicates that the object is an alarm. For
more information, see section 30.1 “Alarm
Types” on page 609.

Alarm handling
Indicates alarm handling objects that can
be connected to an alarm. For more
information, see section 31.1 “Alarm
Functions” on page 699.

Action note
Indicates the object is an action note. For
more information, see section 32.7 “Action
Notes” on page 764.

Category
Indicates the object is a category that you
can use to group together alarms. For
more information, see the Categories topic
on WebHelp.

Cause note
Indicates the object is a cause note. For
more information, see section 32.3 “Cause
Notes” on page 760.

Checklist
Indicates the object is a checklist. For
more information, see section 32.11
“Checklists” on page 768.

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 29.4 “Alarms Pane and Alarm
View Customization” on page 581.

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 29.1 “Alarms
Overview” on page 577.

System 04-30005-01-en, May 2019

864
 35 Alarms User Interface
35.7 Alarm System Tree Icons

Continued
Icon Description

Assignment
Indicates the object is an assignment. For
more information, see section 31.29
“Automatic Assignments” on page 738.

Notification
Indicates the object is an Email notification
or a Write to file notification. For more
information, see section 34.1
“Notifications” on page 787.

04-30005-01-en, May 2019 System

865
35 Alarms User Interface
35.8 Change of State Alarm Properties – Basic Tab

35.8 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 29.2 “Alarm
States” on page 579.

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

866
 35 Alarms User Interface
35.8 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

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.

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.
For more information, see section 31.2
“Time Delay” on page 703.

Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the
alarm is triggered.
For more information, see section 31.2
“Time Delay” on page 703.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 1 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Shunt operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 2 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

867
35 Alarms User Interface
35.9 Change of State Alarm Properties – Alarm Settings Tab

35.9 Change of State Alarm Properties –

Alarm Settings Tab
Use the Alarm Settings tab to change the alarm properties of a change of state
alarm.

Figure: Alarm Settings tab

Table: Alarm Settings Tab

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.
For more information, see section 31.16
“Acknowledgements” on page 717.

Alarm message Type the message to display when the

alarm is in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.

System 04-30005-01-en, May 2019

868
 35 Alarms User Interface
35.9 Change of State Alarm Properties – Alarm Settings Tab

Continued
Property Description

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when it

is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Cause note group Enter the cause note group used by the
alarm.
For more information, see section 32.3
“Cause Notes” on page 760.

Action note group Enter the action note group used by the
alarm.
For more information, see section 32.7
“Action Notes” on page 764.

Checklist Enter the checklist that belongs to the

alarm.
For more information, see section 32.11
“Checklists” on page 768.

Checklist required Select to require that a checklist is filled in

before acknowledging the alarm.

Prefix for alarm source name Type a prefix that is added to the
beginning of the source name property of
an alarm record.

Disable alarm Select to disable the alarm, for example,

before deployment.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.
For more information, see the Hide and
Show Alarms topic on WebHelp.

04-30005-01-en, May 2019 System

869
35 Alarms User Interface
35.9 Change of State Alarm Properties – Alarm Settings Tab

Continued
Property Description

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm State-
Change Logging topic on WebHelp.

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

Custom audio Enter the path to the custom audio file you
want to play when the alarm is triggered.

Edit
(Action Requirements) Click to open the property pane where you
edit the selected user action.
For more information, see section 35.44
“User Action Properties” on page 945.

Add
(Attachments) Click to open the Create Object:
Attachment wizard where you add an
attachment.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
(Attachments) Click to open the property pane where you
configure the attachment.
For more information, see section 35.42
“Attachment Properties” on page 943.

Remove
(Attachments) Click to remove an attachment that is
connected to the alarm.

System 04-30005-01-en, May 2019

870
 35 Alarms User Interface
35.10 Enumeration Alarm Properties – Basic Tab

35.10 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 29.2 “Alarm
States” on page 579.

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.

04-30005-01-en, May 2019 System

871
35 Alarms User Interface
35.10 Enumeration Alarm Properties – Basic Tab

Continued
Component Description

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

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 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.

Edit
Click to edit the alarm trigger item.
For more information, see section 35.39
“Alarm Trigger Properties – Range Tab” on
page 940.
For more information, see section 35.40
“Alarm Trigger Properties – Value tab” on
page 941.

Remove
Click to remove an alarm trigger item.

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.
For more information, see section 31.2
“Time Delay” on page 703.

Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the
alarm is triggered.
For more information, see section 31.2
“Time Delay” on page 703.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

System 04-30005-01-en, May 2019

872
 35 Alarms User Interface
35.10 Enumeration Alarm Properties – Basic Tab

Continued
Component Description

Invert shunt value 1 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Shunt operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 2 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

873
35 Alarms User Interface
35.11 Enumeration Alarm Properties – Alarm Settings Tab

35.11 Enumeration Alarm Properties – Alarm

Settings Tab
Use the Alarm Settings tab to change the alarm properties of an enumeration
alarm.

Figure: Alarm Settings tab

Table: Alarm Settings Tab

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.
For more information, see section 31.16
“Acknowledgements” on page 717.

Alarm message Type the message to display when the

alarm is in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.

System 04-30005-01-en, May 2019

874
 35 Alarms User Interface
35.11 Enumeration Alarm Properties – Alarm Settings Tab

Continued
Property Description

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when it

is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Cause note group Enter the cause note group used by the
alarm.
For more information, see section 32.3
“Cause Notes” on page 760.

Action note group Enter the action note group used by the
alarm.
For more information, see section 32.7
“Action Notes” on page 764.

Checklist Enter the checklist that belongs to the

alarm.
For more information, see section 32.11
“Checklists” on page 768.

Checklist required Select to require that a checklist is filled in

before acknowledging the alarm.

Prefix for alarm source name Type a prefix that is added to the
beginning of the source name property of
an alarm record.

Disable alarm Select to disable the alarm, for example,

before deployment.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.
For more information, see the Hide and
Show Alarms topic on WebHelp.

04-30005-01-en, May 2019 System

875
35 Alarms User Interface
35.11 Enumeration Alarm Properties – Alarm Settings Tab

Continued
Property Description

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm State-
Change Logging topic on WebHelp.

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

Custom audio Enter the path to the custom audio file you
want to play when the alarm is triggered.

Edit
(Action Requirements) Click to open the property pane where you
edit the selected user action.
For more information, see section 35.44
“User Action Properties” on page 945.

Add
(Attachments) Click to open the Create Object:
Attachment wizard where you add an
attachment.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
(Attachments) Click to open the property pane where you
configure the attachment.
For more information, see section 35.42
“Attachment Properties” on page 943.

Remove
(Attachments) Click to remove an attachment that is
connected to the alarm.

System 04-30005-01-en, May 2019

876
 35 Alarms User Interface
35.12 Matching Text String Alarm Properties – Basic Tab

35.12 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 29.2 “Alarm
States” on page 579.

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.

04-30005-01-en, May 2019 System

877
35 Alarms User Interface
35.12 Matching Text String 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

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 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
Click to edit the alarm trigger item. For
more information, see section 35.41 “Alarm
Trigger Properties – Value tab” on page
942.

Remove
Click to remove an alarm trigger item.

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.
For more information, see section 31.2
“Time Delay” on page 703.

Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the
alarm is triggered.
For more information, see section 31.2
“Time Delay” on page 703.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 1 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

System 04-30005-01-en, May 2019

878
 35 Alarms User Interface
35.12 Matching Text String Alarm Properties – Basic Tab

Continued
Component Description

Shunt operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 2 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

879
35 Alarms User Interface
35.13 Matching Text String Alarm Properties – Alarm Settings Tab

35.13 Matching Text String Alarm Properties –

Alarm Settings Tab
Use the Alarm Settings tab to change the alarm properties of a matching text
string alarm.

Figure: Alarm Settings tab

Table: Alarm Settings Tab

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.
For more information, see section 31.16
“Acknowledgements” on page 717.

Alarm message Type the message to display when the

alarm is in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.

System 04-30005-01-en, May 2019

880
 35 Alarms User Interface
35.13 Matching Text String Alarm Properties – Alarm Settings Tab

Continued
Property Description

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when it

is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Cause note group Enter the cause note group used by the
alarm.
For more information, see section 32.3
“Cause Notes” on page 760.

Action note group Enter the action note group used by the
alarm.
For more information, see section 32.7
“Action Notes” on page 764.

Checklist Enter the checklist that belongs to the

alarm.
For more information, see section 32.11
“Checklists” on page 768.

Checklist required Select to require that a checklist is filled in

before acknowledging the alarm.

Prefix for alarm source name Type a prefix that is added to the
beginning of the source name property of
an alarm record.

Disable alarm Select to disable the alarm, for example,

before deployment.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.
For more information, see the Hide and
Show Alarms topic on WebHelp.

04-30005-01-en, May 2019 System

881
35 Alarms User Interface
35.13 Matching Text String Alarm Properties – Alarm Settings Tab

Continued
Property Description

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm State-
Change Logging topic on WebHelp.

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

Custom audio Enter the path to the custom audio file you
want to play when the alarm is triggered.

Edit
(Action Requirements) Click to open the property pane where you
edit the selected user action.
For more information, see section 35.44
“User Action Properties” on page 945.

Add
(Attachments) Click to open the Create Object:
Attachment wizard where you add an
attachment.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
(Attachments) Click to open the property pane where you
configure the attachment.
For more information, see section 35.42
“Attachment Properties” on page 943.

Remove
(Attachments) Click to remove an attachment that is
connected to the alarm.

System 04-30005-01-en, May 2019

882
 35 Alarms User Interface
35.14 Multistate Alarm Properties – Basic Tab

35.14 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 29.2 “Alarm
States” on page 579.

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.

04-30005-01-en, May 2019 System

883
35 Alarms User Interface
35.14 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

Monitored variable Enter the path to the variable that is

monitored by the alarm.

Click to create a new alarm trigger item,

either an integer or range value. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.

Click to edit the alarm trigger item.

For more information, see section 35.39
“Alarm Trigger Properties – Range Tab” on
page 940.
For more information, see section 35.40
“Alarm Trigger Properties – Value tab” on
page 941.

Click to remove an alarm trigger item.

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.
For more information, see section 31.2
“Time Delay” on page 703.

Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the
alarm is triggered.
For more information, see section 31.2
“Time Delay” on page 703.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 1 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

System 04-30005-01-en, May 2019

884
 35 Alarms User Interface
35.14 Multistate Alarm Properties – Basic Tab

Continued
Component Description

Shunt operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 2 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

885
35 Alarms User Interface
35.15 Multistate Alarm Properties – Alarm Settings Tab

35.15 Multistate Alarm Properties – Alarm

Settings Tab
Use the Alarm Settings tab to change the alarm properties of a multistate alarm.

Figure: Alarm Settings tab

Table: Alarm Settings Tab

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.
For more information, see section 31.16
“Acknowledgements” on page 717.

Alarm message Type the message to display when the

alarm is in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.

System 04-30005-01-en, May 2019

886
 35 Alarms User Interface
35.15 Multistate Alarm Properties – Alarm Settings Tab

Continued
Property Description

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when it

is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Cause note group Enter the cause note group used by the
alarm.
For more information, see section 32.3
“Cause Notes” on page 760.

Action note group Enter the action note group used by the
alarm.
For more information, see section 32.7
“Action Notes” on page 764.

Checklist Enter the checklist that belongs to the

alarm.
For more information, see section 32.11
“Checklists” on page 768.

Checklist required Select to require that a checklist is filled in

before acknowledging the alarm.

Prefix for alarm source name Type a prefix that is added to the
beginning of the source name property of
an alarm record.

Disable alarm Select to disable the alarm, for example,

before deployment.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.
For more information, see the Hide and
Show Alarms topic on WebHelp.

04-30005-01-en, May 2019 System

887
35 Alarms User Interface
35.15 Multistate Alarm Properties – Alarm Settings Tab

Continued
Property Description

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm State-
Change Logging topic on WebHelp.

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

Custom audio Enter the path to the custom audio file you
want to play when the alarm is triggered.

Edit
(Action Requirements) Click to open the property pane where you
edit the selected user action.
For more information, see section 35.44
“User Action Properties” on page 945.

Add
(Attachments) Click to open the Create Object:
Attachment wizard where you add an
attachment.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
(Attachments) Click to open the property pane where you
configure the attachment.
For more information, see section 35.42
“Attachment Properties” on page 943.

Remove
(Attachments) Click to remove an attachment that is
connected to the alarm.

System 04-30005-01-en, May 2019

888
 35 Alarms User Interface
35.16 Out of Range Alarm Properties – Basic Tab

35.16 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 29.2 “Alarm
States” on page 579.

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.

04-30005-01-en, May 2019 System

889
35 Alarms User Interface
35.16 Out of Range 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

Monitored variable Enter the path to the variable that is

monitored by the alarm.

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.

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.
For more information, see section 31.2
“Time Delay” on page 703.

Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the
alarm is triggered.
For more information, see section 31.2
“Time Delay” on page 703.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 1 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Shunt operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

System 04-30005-01-en, May 2019

890
 35 Alarms User Interface
35.16 Out of Range Alarm Properties – Basic Tab

Continued
Component Description

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 2 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

891
35 Alarms User Interface
35.17 Out of Range Alarm Properties – Alarm Settings Tab

35.17 Out of Range Alarm Properties – Alarm

Settings Tab
Use the Alarm Settings tab to change the alarm properties of an out of range
alarm.

Figure: Alarm Settings tab

Table: Alarm Settings Tab

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.
For more information, see section 31.16
“Acknowledgements” on page 717.

Above upper limit message Type the message to display when the
variable exceeds the upper limit of the
alarm.
For more information, see section 31.7
“Alarm Messages” on page 708.

System 04-30005-01-en, May 2019

892
 35 Alarms User Interface
35.17 Out of Range Alarm Properties – Alarm Settings Tab

Continued
Property Description

Below lower limit message Type the message to display when the
variable falls below the lower limit.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.
For more information, see section 31.7
“Alarm Messages” on page 708.

Above upper limit priority Enter the priority level of the alarm when
the variable exceeds the upper limit.
For more information, see section 31.9
“Alarm Priority” on page 710.

Below lower limit priority Enter the priority level of the alarm when
the variable falls below the lower limit.
For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when it

is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Cause note group Enter the cause note group used by the
alarm.
For more information, see section 32.3
“Cause Notes” on page 760.

Action note group Enter the action note group used by the
alarm.
For more information, see section 32.7
“Action Notes” on page 764.

Checklist Enter the checklist that belongs to the

alarm.
For more information, see section 32.11
“Checklists” on page 768.

Checklist required Select to require that a checklist is filled in

before acknowledging an alarm.

04-30005-01-en, May 2019 System

893
35 Alarms User Interface
35.17 Out of Range Alarm Properties – Alarm Settings Tab

Continued
Property Description

Prefix for alarm source name Type a prefix that is added to the
beginning of the source name property of
an alarm record.

Disable alarm Select to disable the alarm, for example,

before deployment.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.
For more information, see the Hide and
Show Alarms topic on WebHelp.

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm State-
Change Logging topic on WebHelp.

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.

Custom audio Enter the path to the custom audio file you
want to play when the alarm is triggered.

Edit
(Action Requirements)
Click to open the property pane where you
edit the selected user action.
For more information, see section 35.68
“Action Note Properties” on page 975.

Add
(Attachments)
Click to open the Create Object:
Attachment wizard, where you add an
attachment.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
(Attachments)
Click to open the property pane where you
configure the attachment.
For more information, see section 35.42
“Attachment Properties” on page 943.

Remove
(Attachments)
Click to remove an attachment that is
connected to the alarm.

System 04-30005-01-en, May 2019

894
 35 Alarms User Interface
35.18 Out of Reference Range Alarm Properties – Basic Tab

35.18 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 29.2 “Alarm
States” on page 579.

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.

04-30005-01-en, May 2019 System

895
35 Alarms User Interface
35.18 Out of Reference Range 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

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.

Upper deviation limit Enter the highest value the monitored

variable can increase to before the alarm is
triggered.

Lower deviation 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.
For more information, see section 31.6
“Deadband” on page 707.

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.
For more information, see section 31.2
“Time Delay” on page 703.

Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the
alarm is triggered.
For more information, see section 31.2
“Time Delay” on page 703.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 1 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

System 04-30005-01-en, May 2019

896
 35 Alarms User Interface
35.18 Out of Reference Range Alarm Properties – Basic Tab

Continued
Component Description

Shunt operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 2 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

897
35 Alarms User Interface
35.19 Out of Reference Range Alarm Properties – Alarm Settings

35.19 Out of Reference Range Alarm

Properties – Alarm Settings
Use the Alarm Settings tab to change the alarm properties of an out of reference
range alarm.

Figure: Alarm Settings tab

Table: Alarm Settings Tab

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.
For more information, see section 31.16
“Acknowledgements” on page 717.

Above upper limit message Type the message to display when the
variable exceeds the upper limit of the
alarm.
For more information, see section 31.7
“Alarm Messages” on page 708.

System 04-30005-01-en, May 2019

898
 35 Alarms User Interface
35.19 Out of Reference Range Alarm Properties – Alarm Settings

Continued
Property Description

Below lower limit message Type the message to display when the
variable falls below the lower limit.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.
For more information, see section 31.7
“Alarm Messages” on page 708.

Above upper limit priority Enter the priority level of the alarm when
the variable exceeds the upper limit.
For more information, see section 31.9
“Alarm Priority” on page 710.

Below lower limit priority Enter the priority level of the alarm when
the variable falls below the lower limit.
For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when it

is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Cause note group Enter the cause note group used by the
alarm.
For more information, see section 32.3
“Cause Notes” on page 760.

Action note group Enter the action note group used by the
alarm.
For more information, see section 32.7
“Action Notes” on page 764.

Checklist Enter the checklist that belongs to the

alarm.
For more information, see section 32.11
“Checklists” on page 768.

Checklist required Select to require that a checklist is filled in

before acknowledging an alarm.

04-30005-01-en, May 2019 System

899
35 Alarms User Interface
35.19 Out of Reference Range Alarm Properties – Alarm Settings

Continued
Property Description

Prefix for alarm source name Type a prefix that is added to the
beginning of the source name property of
an alarm record.

Disable alarm Select to disable the alarm, for example,

before deployment.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.
For more information, see the Hide and
Show Alarms topic on WebHelp.

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm State-
Change Logging topic on WebHelp.

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.

Custom audio Enter the path to the custom audio file you
want to play when the alarm is triggered.

Edit
(Action Requirements)
Click to open the property pane where you
edit the selected user action.
For more information, see section 35.68
“Action Note Properties” on page 975.

Add
(Attachments)
Click to open the Create Object:
Attachment wizard, where you add an
attachment.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
(Attachments)
Click to open the property pane where you
configure the attachment.
For more information, see section 35.42
“Attachment Properties” on page 943.

Remove
(Attachments)
Click to remove an attachment that is
connected to the alarm.

System 04-30005-01-en, May 2019

900
 35 Alarms User Interface
35.20 Sum Alarm Properties – Basic Tab

35.20 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 29.2 “Alarm
States” on page 579.

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.

04-30005-01-en, May 2019 System

901
35 Alarms User Interface
35.20 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

Matching alarms count Displays the number of alarms that

currently meet the criteria of the sum
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.
For more information, see section 31.2
“Time Delay” on page 703.

Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the
alarm is triggered.
For more information, see section 31.2
“Time Delay” on page 703.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 1 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Shunt operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 2 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

System 04-30005-01-en, May 2019

902
 35 Alarms User Interface
35.21 Sum Alarm Properties – Alarm Settings Tab

35.21 Sum Alarm Properties – Alarm Settings

Tab
Use the Alarm Settings Tab tab to change the alarm properties of a sum alarm.

Figure: Alarm Settings tab

Table: Alarm Settings Tab

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.
For more information, see section 31.16
“Acknowledgements” on page 717.

Alarm message Type the message to display when the

alarm is in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.

04-30005-01-en, May 2019 System

903
35 Alarms User Interface
35.21 Sum Alarm Properties – Alarm Settings Tab

Continued
Property Description

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when it

is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Cause note group Enter the cause note group used by the
alarm.
For more information, see section 32.3
“Cause Notes” on page 760.

Action note group Enter the action note group used by the
alarm.
For more information, see section 32.7
“Action Notes” on page 764.

Checklist Enter the checklist that belongs to the

alarm.
For more information, see section 32.11
“Checklists” on page 768.

Checklist required Select to require that a checklist is filled in

before acknowledging the alarm.

Prefix for alarm source name Type a prefix that is added to the
beginning of the source name property of
an alarm record.

Disable alarm Select to disable the alarm, for example,

before deployment.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.
For more information, see the Hide and
Show Alarms topic on WebHelp.

System 04-30005-01-en, May 2019

904
 35 Alarms User Interface
35.21 Sum Alarm Properties – Alarm Settings Tab

Continued
Property Description

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm State-
Change Logging topic on WebHelp.

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

Custom audio Enter the path to the custom audio file you
want to play when the alarm is triggered.

Edit
(Action Requirements) Click to open the property pane where you
edit the selected user action.
For more information, see section 35.44
“User Action Properties” on page 945.

Add
(Attachments) Click to open the Create Object:
Attachment wizard where you add an
attachment.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
(Attachments) Click to open the property pane where you
configure the attachment.
For more information, see section 35.42
“Attachment Properties” on page 943.

Remove
(Attachments) Click to remove an attachment that is
connected to the alarm.

04-30005-01-en, May 2019 System

905
35 Alarms User Interface
35.22 Variable Status Alarm Properties – Basic Tab

35.22 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 29.2 “Alarm
States” on page 579.

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

906
 35 Alarms User Interface
35.22 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

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.
• Forced means that the alarm is
triggered when the monitored variable
status is forced. For more information,
see the Force and Unforce Buttons
topic on WebHelp.
• Overridden means that the alarm is
triggered when the monitored variable
status is overridden. For more
information, see the Output Override
Status topic on WebHelp.
• Offline means that the alarm is
triggered when the monitored variable
is off line.

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.
For more information, see section 31.2
“Time Delay” on page 703.

Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the
alarm is triggered.
For more information, see section 31.2
“Time Delay” on page 703.

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 1 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

907
35 Alarms User Interface
35.22 Variable Status Alarm Properties – Basic Tab

Continued
Component Description

Shunt operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 2 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

System 04-30005-01-en, May 2019

908
 35 Alarms User Interface
35.23 Variable Status Alarm Properties – Alarm Settings Tab

35.23 Variable Status Alarm Properties –

Alarm Settings Tab
Use the Alarm Settings tab to change the alarm properties of a variable status
alarm.

Figure: Alarm Settings tab

Table: Alarm Settings Tab

Property Description

Acknowledgement type Select the type of acknowledgement for

the alarm.
For more information, see section 31.16
“Acknowledgements” on page 717.

Alarm message Type the message to display when the

alarm is in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.

04-30005-01-en, May 2019 System

909
35 Alarms User Interface
35.23 Variable Status Alarm Properties – Alarm Settings Tab

Continued
Property Description

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when it

is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Cause note group Enter the cause note group used by the
alarm.
For more information, see section 32.3
“Cause Notes” on page 760.

Action note group Enter the action note group used by the
alarm.
For more information, see section 32.7
“Action Notes” on page 764.

Checklist Enter the checklist that belongs to the

alarm.
For more information, see section 32.11
“Checklists” on page 768.

Checklist required Select to require that a checklist is filled in

before acknowledging the alarm.

Prefix for alarm source name Type a prefix that is added to the
beginning of the source name property of
an alarm record.

Disable alarm Select to disable the alarm, for example,

before deployment.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.
For more information, see the Hide and
Show Alarms topic on WebHelp.

System 04-30005-01-en, May 2019

910
 35 Alarms User Interface
35.23 Variable Status Alarm Properties – Alarm Settings Tab

Continued
Property Description

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm State-
Change Logging topic on WebHelp.

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

Custom audio Enter the path to the custom audio file you
want to play when the alarm is triggered.

Edit
(Action Requirements) Click to open the property pane where you
edit the selected user action.
For more information, see section 35.44
“User Action Properties” on page 945.

Add
(Attachments) Click to open the Create Object:
Attachment wizard where you add an
attachment.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
(Attachments) Click to open the property pane where you
configure the attachment.
For more information, see section 35.42
“Attachment Properties” on page 943.

Remove
(Attachments) Click to remove an attachment that is
connected to the alarm.

04-30005-01-en, May 2019 System

911
35 Alarms User Interface
35.24 Function Block Program Internal Alarm Properties - Basic Tab

35.24 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 53.39 “General
Information Properties – Basic Tab” on page 1604.

Figure: Basic tab

Table: Basic Tab

Component Description

Alarm state Displays the present state of the alarm. For

more information, see section 29.2 “Alarm
States” on page 579.

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

912
 35 Alarms User Interface
35.24 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

Monitored variable Enter the path to the variable that is

monitored by the alarm.

Trigger value Select the statuses of the monitored

variable that trigger the alarm.
• Forced means that the alarm is
triggered when the monitored variable
status is forced. For more information,
see the Force and Unforce Buttons
topic on WebHelp.
• Overridden means that the alarm is
triggered when the monitored variable
status is overridden. For more
information, see the Output Override
Status topic on WebHelp.
• Offline means that the alarm is
triggered when the monitored variable
is off line.

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 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 1 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Shunt operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

913
35 Alarms User Interface
35.24 Function Block Program Internal Alarm Properties - Basic Tab

Continued
Component Description

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert shunt value 2 Select to invert the shunt value, that is,
enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

System 04-30005-01-en, May 2019

914
 35 Alarms User Interface
35.25 Function Block Program Internal Alarm Properties - Alarm Settings Tab

35.25 Function Block Program Internal Alarm

Properties - Alarm Settings Tab
Use the Function Block Program Internal Alarm Properties - Alarm Settings tab
to change the alarm settings of a function block program internal alarm.

Figure: Function block program internal alarm properties - alarm settings tab

Table: Function Block Program Internal Alarm Properties - Alarm Settings Tab
Component Description

Acknowledgement type Select the type of acknowledgement for

the alarm.
For more information, see the Alarm
Acknowledgements topic on WebHelp.

Alarm message Type the message to display when the

alarm is in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

04-30005-01-en, May 2019 System

915
35 Alarms User Interface
35.25 Function Block Program Internal Alarm Properties - Alarm Settings Tab

Continued
Component Description

Reset message Type the message to display when the

alarm is reset.
For more information, see section 31.7
“Alarm Messages” on page 708.

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Cause note group Enter the cause note group that is used by
the alarm.
For more information, see section 32.3
“Cause Notes” on page 760.

Action note group Enter the action note group that is used by
the alarm.
For more information, see section 32.7
“Action Notes” on page 764.

Checklist Enter the checklist that belongs to the

alarm.
For more information, see section 32.11
“Checklists” on page 768.

Checklist required Select to force the user to check each step

in the checklist before the alarm can be
acknowledged.

Prefix for alarm source name Type a prefix that is added to the
beginning of the source name property of
an alarm record.

Disable alarm Select to disable the alarm, for example,

before deployment.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.

Disable state-change logging Select to prevent an alarm state change

from creating an event.
For more information, see the Alarm State-
Change Logging topic on WebHelp.

System 04-30005-01-en, May 2019

916
 35 Alarms User Interface
35.25 Function Block Program Internal Alarm Properties - Alarm Settings Tab

Continued
Component Description

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.

Custom audio Enter the path to the custom audio file you
want to play when the alarm is triggered.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Edit
Click to open the property pane where you
edit the selected user action. For more
information, see section 35.44 “User Action
Properties” on page 945.

Add
Click to open the Create Object:
Attachment wizard, where you add an
attachment. For more information, see
section 53.28 “Create Object Wizard –
Naming the Object Page” on page 1590.

Edit
Click to open the property pane where you
configure the attachment. For more
information, see section 35.42 “Attachment
Properties” on page 943.

Remove
Click to remove an attachment that is
connected to the alarm.

04-30005-01-en, May 2019 System

917
35 Alarms User Interface
35.26 Create Alarm Wizard – Presentation Page

35.26 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

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.

Alarm message Type the message to display when the

alarm is in Alarm state.
For more information, see section 31.7
“Alarm Messages” on page 708.

Reset message Type the message to display when the

alarm is reset.
For more information, see section 31.7
“Alarm Messages” on page 708.

Category Enter the category the alarm belongs to.

For more information, see section 31.12
“Alarm Categories” on page 713.

System 04-30005-01-en, May 2019

918
 35 Alarms User Interface
35.26 Create Alarm Wizard – Presentation Page

Continued
Component Description

Category 2 Enter the second category the alarm

belongs to.
For more information, see section 31.12
“Alarm Categories” on page 713.

Prefix for alarm source name Add a substitution code or type a prefix
that is added to the beginning of the
source name property of an alarm record.
For more information, see section 31.27
“Alarm Substitution Codes” on page 731.

Above upper limit priority Enter the priority level of the alarm when
the variable exceeds the upper limit.
For more information, see section 31.9
“Alarm Priority” on page 710.

Below lower limit priority Enter the priority level of the alarm when
the variable falls below the lower limit.
For more information, see section 31.9
“Alarm Priority” on page 710.

Alarm priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Reset priority Enter the priority level of the alarm when it

is reset.
For more information, see section 31.9
“Alarm Priority” on page 710.

Same priority Select to set all priorities to the same value.

For more information, see section 31.9
“Alarm Priority” on page 710.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.

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.

Custom audio Enter the path to the custom audio file you
to play when the alarm is triggered.
For more information, see section 31.36
“Custom Audible Alarm Alerts” on page
747.

Disable state-change logging Select to prevent an alarm state change

from creating an event.

04-30005-01-en, May 2019 System

919
35 Alarms User Interface
35.27 Create Alarm Wizard – User Action Page

35.27 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 31.16
“Acknowledgements” on page 717.

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.

Required user action Select what actions the user has to perform
when any of the listed events occur.

System 04-30005-01-en, May 2019

920
 35 Alarms User Interface
35.28 Create Alarm Wizard – Attachment Page

35.28 Create Alarm Wizard – Attachment

Page
Use the Attachment page to add attachments to an alarm or an alarm
decoration.

Figure: Attachment page

Table: Attachment Page or Tab

Property Description

Add attachment
Click to add an attachment to the alarm
decoration rule. For more information, see
section 31.21 “Alarm Attachments” on
page 725.

Remove attachment
Click to remove the selected attachment
from the alarm decoration rule.

Navigate to
Click to open the attachment that is
selected in the attachment list.

Type View the object type of the attachment.

Name View the name of the attachment.

Display on alarm Select to display the attachment when the

alarm is triggered.

Path View the path of the attachment.

04-30005-01-en, May 2019 System

921
35 Alarms User Interface
35.29 Create Change of State Alarm Wizard – Alarm Trigger Page

35.29 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 Select to disable the alarm, for example,

before deployment.

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 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

System 04-30005-01-en, May 2019

922
 35 Alarms User Interface
35.29 Create Change of State Alarm Wizard – Alarm Trigger Page

Continued
Component Description

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

923
35 Alarms User Interface
35.30 Create Multistate Alarm Wizard – Alarm Trigger Page

35.30 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

Add row
Click to add another alarm condition that
triggers the alarm.

Remove row
Click to remove an alarm condition.

between Select a range. If the monitored variable is

within this range, the alarm is triggered.

equal to Select a value. If the monitored variable is

equal to this value, the alarm is triggered.

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 29.2 “Alarm
States” on page 579.

System 04-30005-01-en, May 2019

924
 35 Alarms User Interface
35.30 Create Multistate 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 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Set unit
Enter the unit of the alarm.

04-30005-01-en, May 2019 System

925
35 Alarms User Interface
35.31 Create Matching Text String Alarm Wizard – Alarm Trigger Page

35.31 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

Add row
Click to add another alarm condition that
triggers the alarm.

Remove row
Click to remove an alarm condition.

equal to Type a text string. When the monitored

variable matches this text string, the alarm
is triggered.

Monitored variable Enter the path to the variable that is

monitored by the alarm.

Disable alarm Select to disable the alarm, for example,

before deployment.

Alarm delay Enter the time, in seconds, the alarm has to

be within the alarm criteria before the
alarm is triggered.

System 04-30005-01-en, May 2019

926
 35 Alarms User Interface
35.31 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 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

927
35 Alarms User Interface
35.32 Create Out of Range Alarm Wizard – Alarm Trigger Page

35.32 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 Select to disable the alarm, for example,

before deployment.

Alarm delay Enter the time, in seconds, the alarm has to

be within the alarm criteria before the
alarm is triggered.

System 04-30005-01-en, May 2019

928
 35 Alarms User Interface
35.32 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 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Set unit
Enter the unit of the alarm.

04-30005-01-en, May 2019 System

929
35 Alarms User Interface
35.33 Create Out of Reference Range Alarm Wizard – Alarm Trigger Page

35.33 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 Select to disable the alarm, for example,

before deployment.

Reference variable Enter the reference variable that is

compared with the monitored variable.

Alarm delay Enter the time, in seconds, the alarm has to

be within the alarm criteria before the
alarm is triggered.

System 04-30005-01-en, May 2019

930
 35 Alarms User Interface
35.33 Create Out of Reference 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 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Set unit
Enter the unit of the alarm.

04-30005-01-en, May 2019 System

931
35 Alarms User Interface
35.34 Create Sum Alarm Wizard – Alarm Trigger Page

35.34 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 29.18
“Alarm Filters” on page 595.
You can use wildcards when setting up
filter conditions. For more information, see
section 36.12 “Filter Condition Wildcards ”
on page 1081.

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.

Clear all
Click to clear the selected conditions.

System 04-30005-01-en, May 2019

932
 35 Alarms User Interface
35.34 Create Sum Alarm Wizard – Alarm Trigger Page

Continued
Component Description

Alarm State Displays the alarm state of the alarm. For

more information, see section 29.2 “Alarm
States” on page 579.

Matching alarms count Displays the number of alarms that

currently meet the criteria of the sum
alarm.

Disable alarm Select to disable the alarm, for example,

before deployment.

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 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

933
35 Alarms User Interface
35.35 Create Enumeration Alarm Wizard – Alarm Trigger Page

35.35 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 Select to disable the alarm, for example,

before deployment.

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 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

System 04-30005-01-en, May 2019

934
 35 Alarms User Interface
35.35 Create Enumeration Alarm Wizard – Alarm Trigger Page

Continued
Component Description

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

935
35 Alarms User Interface
35.36 Create Variable Status Alarm Wizard – Alarm Trigger Page

35.36 Create Variable Status Alarm Wizard –

Alarm Trigger Page
Use the Alarm Trigger page to configure the trigger settings of the variable
status alarm.

Figure: Variable 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 the Force and
Unforce Buttons topic on WebHelp.

Overridden Select to trigger the alarm when the

monitored variable status is overridden.
For more information, see the Output
Override Status topic on WebHelp.

Monitored variable Enter the path to the variable that is

monitored by the alarm.

Disable alarm Select to disable the alarm, for example,

before deployment.

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.

System 04-30005-01-en, May 2019

936
 35 Alarms User Interface
35.36 Create Variable Status Alarm Wizard – Alarm Trigger Page

Continued
Component Description

Shunt variable 1 Enter the shunt variable that is used to

enable or disable the alarm. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

Operator Select AND or OR to add logic between

the first and the second shunt variable. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Shunt variable 2 Enter the second shunt variable that is

used to enable or disable the alarm. For
more information, see section 31.4 “Shunt
Variables” on page 705.

Invert Select to invert the shunt value, that is,

enable the alarm when the shunt value is
active and disable the alarm when the
shunt value is inactive. For more
information, see section 31.4 “Shunt
Variables” on page 705.

04-30005-01-en, May 2019 System

937
35 Alarms User Interface
35.37 Create Attachment Wizard – Configure Attachment Page

35.37 Create Attachment Wizard – Configure

Attachment Page
Use the Configure Attachment page to set up the attachment you want to attach
to the alarm.

Figure: Configure Attachment page

Table: Configure Attachment Page

Property Description

Object reference Enter the path to the item you want to

attach to the alarm.

Display on alarm Select True to automatically open and

display the attachment when the alarm is
triggered.

System 04-30005-01-en, May 2019

938
 35 Alarms User Interface
35.38 Alarm Trigger Properties - Basic Tab

35.38 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
53.39 “General Information Properties – Basic Tab” on page 1604.

Figure: AlarmTrigger Properties

04-30005-01-en, May 2019 System

939
35 Alarms User Interface
35.39 Alarm Trigger Properties – Range Tab

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

940
 35 Alarms User Interface
35.40 Alarm Trigger Properties – Value tab

35.40 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-30005-01-en, May 2019 System

941
35 Alarms User Interface
35.41 Alarm Trigger Properties – Value tab

35.41 Alarm Trigger Properties – Value tab

Use the Value tab to type the text string that triggers the Matching text string
alarm.

Figure: Value tab

Table: Value Tab

Component Description

Value Type the text string that triggers the alarm.

System 04-30005-01-en, May 2019

942
 35 Alarms User Interface
35.42 Attachment Properties

35.42 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 path to the item you want to

attach to the alarm.

04-30005-01-en, May 2019 System

943
35 Alarms User Interface
35.43 Alarm Control Panel Properties

35.43 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 17.2 “Lead
and Shadow Relationship” on page 315.

Decimal symbol Select the decimal symbol to be used in

the notification and the notification report
template.

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

System 04-30005-01-en, May 2019

944
 35 Alarms User Interface
35.44 User Action Properties

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

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.

04-30005-01-en, May 2019 System

945
35 Alarms User Interface
35.45 Alarm Styles View

35.45 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 35.47 “Acknowledged Style
Properties” on page 948.

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 35.48
“Alarm Style Properties” on page 949.

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 35.49
“Disabled Style Properties” on page 950.

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 35.50 “Fault Style Properties” on
page 951.

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 35.51 “Reset
Style Properties” on page 952.

System 04-30005-01-en, May 2019

946
 35 Alarms User Interface
35.46 Alarm Styles Properties

35.46 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
53.39 “General Information Properties – Basic Tab” on page 1604.General and
References Properties

Figure: Alarm Styles Properties

04-30005-01-en, May 2019 System

947
35 Alarms User Interface
35.47 Acknowledged Style Properties

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

System 04-30005-01-en, May 2019

948
 35 Alarms User Interface
35.48 Alarm Style Properties

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

04-30005-01-en, May 2019 System

949
35 Alarms User Interface
35.49 Disabled Style Properties

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

System 04-30005-01-en, May 2019

950
 35 Alarms User Interface
35.50 Fault Style Properties

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

04-30005-01-en, May 2019 System

951
35 Alarms User Interface
35.51 Reset Style Properties

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

System 04-30005-01-en, May 2019

952
 35 Alarms User Interface
35.52 Alarm Control Panel – Categories View

35.52 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 35.53 “Add
Category Dialog Box” on page 954.

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 35.54 “Edit
Category Dialog Box” on page 955.

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 the Group and Sort
Objects topic on WebHelp.

04-30005-01-en, May 2019 System

953
35 Alarms User Interface
35.53 Add Category Dialog Box

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

System 04-30005-01-en, May 2019

954
 35 Alarms User Interface
35.54 Edit Category Dialog Box

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

04-30005-01-en, May 2019 System

955
35 Alarms User Interface
35.55 Category Properties

35.55 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
53.39 “General Information Properties – Basic Tab” on page 1604.

Figure: Category properties

System 04-30005-01-en, May 2019

956
 35 Alarms User Interface
35.56 Categories Properties

35.56 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 53.39 “General Information Properties – Basic
Tab” on page 1604.

Figure: Categories properties

Table: Categories Properties

Property Description

Name Displays the category name. For more

information, see the Categories topic on
WebHelp.

Add
Click to open the Category wizard, where
you add a category.

Edit
Click to edit the properties of the selected
category. For more information, see
section 35.55 “Category Properties” on
page 956.

04-30005-01-en, May 2019 System

957
35 Alarms User Interface
35.56 Categories Properties

Continued
Property Description

Remove
Click to remove the selected category.

System 04-30005-01-en, May 2019

958
 35 Alarms User Interface
35.57 Alarm Control Panel – Cause Notes View

35.57 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 35.58 “Add Cause
Note Dialog Box” on page 961.

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 35.59 “Edit
Cause Note Dialog Box” on page 962.
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 the Group and Sort
Objects topic on WebHelp.

Collapse all
Click to collapse the groups in the list to
hide underlying items.

04-30005-01-en, May 2019 System

959
35 Alarms User Interface
35.57 Alarm Control Panel – Cause Notes View

Continued
Button Description

Expand all
Click to expand the groups in the list to
display underlaying items.

System 04-30005-01-en, May 2019

960
 35 Alarms User Interface
35.58 Add Cause Note Dialog Box

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

04-30005-01-en, May 2019 System

961
35 Alarms User Interface
35.59 Edit Cause Note Dialog Box

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

System 04-30005-01-en, May 2019

962
 35 Alarms User Interface
35.60 Cause Notes Properties

35.60 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 53.39 “General Information
Properties – Basic Tab” on page 1604.

Figure: Cause Notes properties

Table: Cause Notes Properties

Property Description

Name Displays the name of the cause note

group. For more information, see section
32.3 “Cause Notes” on page 760.

Add
Click to open the Cause Note Group
wizard, where you add a cause note
group.

04-30005-01-en, May 2019 System

963
35 Alarms User Interface
35.60 Cause Notes Properties

Continued
Property Description

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
35.61 “Cause Note Group Properties” on
page 965.

Remove
Click to remove the selected cause note
group.

System 04-30005-01-en, May 2019

964
 35 Alarms User Interface
35.61 Cause Note Group Properties

35.61 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 32.3 “Cause
Notes” on page 760.

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 35.62 “Cause
Note Properties” on page 967.

04-30005-01-en, May 2019 System

965
35 Alarms User Interface
35.61 Cause Note Group Properties

Continued
Property Description

Remove
Click to remove the selected cause note.

System 04-30005-01-en, May 2019

966
 35 Alarms User Interface
35.62 Cause Note Properties

35.62 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 53.39 “General Information
Properties – Basic Tab” on page 1604.

Figure: Cause Note properties

Table: Cause Note Properties

Property Description

Properties Type the display name of the cause note.

For more information, see section 32.3
“Cause Notes” on page 760.

04-30005-01-en, May 2019 System

967
35 Alarms User Interface
35.63 Alarm Control Panel – Action Notes View

35.63 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 35.64 “Add Action
Note Dialog Box” on page 969.

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 35.65 “Edit
Action Note Dialog Box” on page 970.

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 the Group and Sort
Objects topic on WebHelp.

Collapse all
Click to collapse the groups in the list to
hide underlying items.

Expand all
Click to expand the groups in the list to
display underlaying items.

System 04-30005-01-en, May 2019

968
 35 Alarms User Interface
35.64 Add Action Note Dialog Box

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

04-30005-01-en, May 2019 System

969
35 Alarms User Interface
35.65 Edit Action Note Dialog Box

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

System 04-30005-01-en, May 2019

970
 35 Alarms User Interface
35.66 Action Notes Properties

35.66 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 53.39 “General Information
Properties – Basic Tab” on page 1604.

Figure: Action Notes properties

Table: Action Notes Properties

Property Description

Name Displays the name of the action note

group. For more information, see section
32.7 “Action Notes” on page 764.

Add
Click to open the Action Note Group
wizard, where you add an action note
group.

04-30005-01-en, May 2019 System

971
35 Alarms User Interface
35.66 Action Notes Properties

Continued
Property Description

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 35.67
“Action Note Group Properties” on page
973.

Remove
Click to remove the selected action note
group.

System 04-30005-01-en, May 2019

972
 35 Alarms User Interface
35.67 Action Note Group Properties

35.67 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 32.7 “Action
Notes” on page 764.

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 35.68 “Action Note
Properties” on page 975.

04-30005-01-en, May 2019 System

973
35 Alarms User Interface
35.67 Action Note Group Properties

Continued
Property Description

Remove
Click to remove the selected action note.

System 04-30005-01-en, May 2019

974
 35 Alarms User Interface
35.68 Action Note Properties

35.68 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 53.39 “General Information
Properties – Basic Tab” on page 1604.

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 32.7
“Action Notes” on page 764.

04-30005-01-en, May 2019 System

975
35 Alarms User Interface
35.69 Alarm Control Panel – Checklists View

35.69 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
35.64 “Add Action Note Dialog Box” on
page 969.

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
35.71 “Edit Checklist Dialog Box” on page
979.

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 the Group and Sort
Objects topic on WebHelp.

System 04-30005-01-en, May 2019

976
 35 Alarms User Interface
35.70 Add Checklist Dialog Box

35.70 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 35.72 “Add Checklist Step Dialog
Box” on page 981.

Edit step
Click to open the Edit checklist step dialog
box where you edit a checklist step. For
more information, see section 35.73 “Edit
Checklist Step Dialog Box” on page 982.

Remove step
Click to remove the selected step from the
checklist.

04-30005-01-en, May 2019 System

977
35 Alarms User Interface
35.70 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.

System 04-30005-01-en, May 2019

978
 35 Alarms User Interface
35.71 Edit Checklist Dialog Box

35.71 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 35.72 “Add Checklist Step Dialog
Box” on page 981.

Edit step
Click to open the Edit checklist step dialog
box where you edit a checklist step. For
more information, see section 35.73 “Edit
Checklist Step Dialog Box” on page 982.

Remove step
Click to remove the selected step from the
checklist.

04-30005-01-en, May 2019 System

979
35 Alarms User Interface
35.71 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.

System 04-30005-01-en, May 2019

980
 35 Alarms User Interface
35.72 Add Checklist Step Dialog Box

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

04-30005-01-en, May 2019 System

981
35 Alarms User Interface
35.73 Edit Checklist Step Dialog Box

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

System 04-30005-01-en, May 2019

982
 35 Alarms User Interface
35.74 Checklists Properties

35.74 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 32.11 “Checklists” on page 768.

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 35.75 “Checklist Properties” on
page 985.

04-30005-01-en, May 2019 System

983
35 Alarms User Interface
35.74 Checklists Properties

Continued
Property Description

Remove
Click to remove the selected checklist.

System 04-30005-01-en, May 2019

984
 35 Alarms User Interface
35.75 Checklist Properties

35.75 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 53.39 “General Information
Properties – Basic Tab” on page 1604.

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 32.1 “User
Actions” on page 757.

Add
Click to start the Checklist Step wizard.

Edit
Click to edit the properties of the checklist
step. For more information, see section
35.76 “Checklist Step Properties” on page
987.

04-30005-01-en, May 2019 System

985
35 Alarms User Interface
35.75 Checklist Properties

Continued
Property Description

Remove
Click to remove the selected checklist
step.

System 04-30005-01-en, May 2019

986
 35 Alarms User Interface
35.76 Checklist Step Properties

35.76 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 53.39 “General Information Properties – Basic Tab” on page 1604.

Figure: Checklist Step properites

Table: Checklist Step Properties

Property Description

Checklist step Displays the checklist step instruction. For

more information, see section 32.1 “User
Actions” on page 757.

Position Enter the position of the step on the

checklist.

04-30005-01-en, May 2019 System

987
35 Alarms User Interface
35.77 Alarm – Basic Settings View

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

System 04-30005-01-en, May 2019

988
 35 Alarms User Interface
35.78 Select Conditions Dialog Box

35.78 Select Conditions Dialog Box

Use the Select Conditions dialog box to sort out the alarms of interest in the
Alarms pane or an Alarm View
View, or the events in the Events pane or an Event
View
View.

Figure: Select Conditions dialog box

Table: Select Conditions Dialog Box

Component Description

Add condition
Select the alarm filter conditions for the
alarms you want to include.

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.

04-30005-01-en, May 2019 System

989
35 Alarms User Interface
35.78 Select Conditions Dialog Box

Continued
Component Description

Remove row
Click to remove a condition row.

Clear all
Click to clear the selected conditions.

System 04-30005-01-en, May 2019

990
 35 Alarms User Interface
35.79 Create Assignment Wizard – Assignment Page

35.79 Create Assignment Wizard –

Assignment Page
Use the Assignment page to set the assignment conditions that have to be met
for the alarm to be assigned.

Figure: Assignment page

Table: Assignment Page

Component Description

Status Enter the schedule or other multistate

variable that contains the value that
activates the assignment.

Schedule Enter the schedule or other multistate

variable that contains the value that
activates the assignment.

Active value Enter the value, generated by the

connected schedule or other multistate
variable, that is to activate this assignment
object.

Assigned to Click the browse button to open the Users

and Groups dialog box where you select
the EcoStruxure Building Operation user or
user group to receive the assignment
request. For more information, see section
35.82 “Users and Groups Dialog Box” on
page 997.

[Conditions list] Use the conditions list to add or remove

conditions for when the alarm is to be
assigned and to make condition settings.

04-30005-01-en, May 2019 System

991
35 Alarms User Interface
35.79 Create Assignment Wizard – Assignment Page

Continued
Component Description

Add condition
Click to add a condition that has to be met
for the alarm to get assigned to the
recipient.
For more information, see section 29.18
“Alarm Filters” on page 595.

Remove condition
Click to remove a condition that has to be
met for the assignment to be sent to the
recipient.

Add row
Click to add a row to the condition.

Remove row
Click to remove the row from the condition.

Clear all
Click to clear the selected conditions.

System 04-30005-01-en, May 2019

992
 35 Alarms User Interface
35.80 Assignment View

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

Status Select Disabled to deactivate the

assignment function.

Schedule Enter the schedule or other multistate

variable that contains the value that is to be
used to activate the assignment.

Active value Enter the value, generated by the

connected schedule or other multistate
variable, that is to activate this assignment
object.

Assigned to Click the browse button to open the Users

and Groups dialog box where you select
the EcoStruxure Building Operation user or
user group to receive the assignment
request. For more information, see section
35.82 “Users and Groups Dialog Box” on
page 997.

04-30005-01-en, May 2019 System

993
35 Alarms User Interface
35.80 Assignment View

Continued
Component Description

(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 a condition that has to be met
for the alarm to get assigned to the
recipient.
For more information, see section 29.18
“Alarm Filters” on page 595.

Remove condition
Click to remove a condition that has to be
met for the assignment to be sent to the
recipient.

Add row
Click to add a row to the condition.

Remove row
Click to remove the row from the condition.

Clear all
Click to clear the selected conditions.

System 04-30005-01-en, May 2019

994
 35 Alarms User Interface
35.81 Assignment Properties

35.81 Assignment Properties

Use the Assignment properties to configure which user or user group receives
the assignment request.

Figure: Assignment properties

Table: Assignment Properties

Component Description

Status Select Disabled to deactivate the

assignment function.

Schedule Enter the schedule or other multistate

variable that contains the value that is to be
used to activate the assignment.

Active value Enter the value, generated by the

connected schedule or other multistate
variable, that is to activate this assignment
object.

04-30005-01-en, May 2019 System

995
35 Alarms User Interface
35.81 Assignment Properties

Continued
Component Description

Assigned to Click the browse button to open the Users

and Groups dialog box where you select
the EcoStruxure Building Operation user or
user group to receive the assignment
request. For more information, see section
35.82 “Users and Groups Dialog Box” on
page 997.

System 04-30005-01-en, May 2019

996
 35 Alarms User Interface
35.82 Users and Groups Dialog Box

35.82 Users and Groups Dialog Box

Use the Users and Groups dialog box to select the users or groups of users to
receive an email notification for an alarm, a recipient for an alarm assigment
request, or to select users or groups whose context-sensitive path permissions
you want to configure.

NOTICE
You can only select users or user groups that reside on the same EcoStruxure
BMS server as the email notification.

Figure: Users and Groups dialog box for email notifications

04-30005-01-en, May 2019 System

997
35 Alarms User Interface
35.82 Users and Groups Dialog Box

Figure: Users and Groups dialog box for automatic alarm assignments

System 04-30005-01-en, May 2019

998
 35 Alarms User Interface
35.82 Users and Groups Dialog Box

Figure: Users and Groups dialog box for context-sensitive path permissions

Table: Users and Group Dialog Box

Component Description

Domain Select the domain the user or user group

belongs to.

Quick filter Use the quick filter to filter on the user or

user group to which you want to assign an
alarm. For more information, see section
52.4 “Quick Filter ” on page 1512.

User account type: Users Select the user account to which you want
to send an email notification or send an
assignment request.

User account type: Groups Select the user account group to which
you want to send an email notification or
send an assignment request.

Add Use the Add button to add the user or user

group to the email notification or
assignment.

04-30005-01-en, May 2019 System

999
35 Alarms User Interface
35.83 Alarm View Properties

35.83 Alarm View Properties

Use the Alarm View properties to configure and view the general and object
references properties. For more information, see section 53.39 “General
Information Properties – Basic Tab” on page 1604.

Figure: Alarm properties

Property Description

Display on alarm Select True to automatically open and

display the attachment when the alarm is
triggered.

Show milliseconds Select True to display the alarm timestamp

in milliseconds.

System 04-30005-01-en, May 2019

1000
 35 Alarms User Interface
35.84 Progress View

35.84 Progress View

The Progress view displays information about time-consuming operations
between WorkStation and the EcoStruxure BMS 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-30005-01-en, May 2019 System

1001
35 Alarms User Interface
35.85 Alarm Handling Properties

35.85 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
53.39 “General Information Properties – Basic Tab” on page 1604.

Figure: Alarm Handling Properties

System 04-30005-01-en, May 2019

1002
 35 Alarms User Interface
35.86 Alarms Pane Context Menu

35.86 Alarms Pane Context Menu

Use the Alarms pane context menu to manage the alarms in the Alarms pane.

Figure: Alarms pane context menu

Table: Alarms Pane Context Menu

Command Description

Acknowledge Click to acknowledge the alarm state or

reset state.
For more information, see the Alarm
Acknowledgements topic on WebHelp.

Enable alarm Click to enable the alarm. If the alarm state

changed, for example from alarm state to
normal state during the time the alarm was
disabled, the alarm is given the new state
once it is enabled.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

Disable alarm Click to disable the alarm. The alarm is

disabled and cannot be acknowledged or
reset until it is enabled.
For more information, see the Disable and
Enable Alarms topic on WebHelp.

04-30005-01-en, May 2019 System

1003
35 Alarms User Interface
35.86 Alarms Pane Context Menu

Continued
Command Description

Recheck Click to update the current alarm state.

Show alarm Click to show the alarm.

For more information, see the Hide and
Show Alarms topic on WebHelp.

Hide alarm Click to hide the alarm from the Alarms

pane. The alarm is still logged in the event
log.
For more information, see the Hide and
Show Alarms topic on WebHelp.

Enable state-change logging Click to start logging an event each time

the alarm is changing its state.
For more information, see the Alarm State-
Change Logging topic on WebHelp.

Disable state-change logging Click to stop logging an event every time

the alarm is changing its state.
For more information, see the Alarm State-
Change Logging topic on WebHelp.

Self-assign Click to assign the alarm to yourself.

For more information, see section 31.28
“Alarm Assignments” on page 736.

Assign Click to assign the alarm to another user.

For more information, see section 31.28
“Alarm Assignments” on page 736.

Reject Click to reject the alarm.

For more information, see section 31.28
“Alarm Assignments” on page 736.

Accept Click to accept the alarm.

For more information, see section 31.28
“Alarm Assignments” on page 736.

Release Click to release an alarm that is assigned

to you.
For more information, see section 31.28
“Alarm Assignments” on page 736.

Add comment Click to add a comment to the alarm.

For more information, see the Alarm
Comments topic on WebHelp.

Add cause note Click to add a cause note to the alarm.

For more information, see the Cause Notes
topic on WebHelp.

System 04-30005-01-en, May 2019

1004
 35 Alarms User Interface
35.86 Alarms Pane Context Menu

Continued
Command Description

Add action note Click to add an action note to the alarm.

For more information, see the Action Notes
topic on WebHelp.

Checklist Click to view the checklist of the alarm.

For more information, see the Checklists
topic on WebHelp.

Turn off visual and audible alert Click to turn off visual and audible alert.

Attachments Click to open the file or document that is

attached to the alarm.
For more information, see section 31.21
“Alarm Attachments” on page 725.

Go to alarm object Click to open the settings of the alarm in

the Work area.

Go to source object Click to open the object that triggered the

alarm in the Work area.

View Click to view the history, comments, cause

notes, action notes, or checklists of an
alarm in the work area. For more
information, see section 35.87 “Alarms
Pane Context Menu - View Submenu” on
page 1006.

Alarm View settings Click to open the Alarm View settings

submenu where you can make a number
of Alarm View settings for the current
Alarms pane or Alarm View. For more
information, see section 35.88 “Alarms
Pane Context Menu - Alarm View Settings
Submenu” on page 1007.

04-30005-01-en, May 2019 System

1005
35 Alarms User Interface
35.87 Alarms Pane Context Menu - View Submenu

35.87 Alarms Pane Context Menu - View

Submenu
Use the View submenu to view the history, comments, cause notes, action
notes, or checklists of an alarm.

Figure: View submenu

Table: View Submenu

Command Description

View history Click to display the historical events of the

alarm. For more information, see section
37.1 “Events Pane and Event View” on
page 1089.

View comments Click to display comments linked to the

alarm. For more information, see the Alarm
Comments topic on WebHelp.

View cause notes Click to display cause notes linked to the

alarm. For more information, see section
32.3 “Cause Notes” on page 760.

View action notes Click to display action notes linked to the

alarm. For more information, see section
32.7 “Action Notes” on page 764.

View checklist Click to display checklists linked to the

alarm. For more information, see section
32.11 “Checklists” on page 768.

System 04-30005-01-en, May 2019

1006
 35 Alarms User Interface
35.88 Alarms Pane Context Menu - Alarm View Settings Submenu

35.88 Alarms Pane Context Menu - Alarm View

Settings Submenu
Use the Alarm View Settings submenu to change the way alarms are presented.

Figure: Alarm View settings submenu

Table: Alarm View Settings Submenu

Command Description

Display Alarm View on alarm Click to display an Alarm View in a new

window when an alarm is triggered. For
more information, see section 29.7
“Displaying an Alarm View when an Alarm
is Triggered” on page 584.

Edit standard filter Click to open the Select Conditions dialog

box, where you sort out the information in
the Alarms pane or an Alarm View. For
more information, see section 35.78
“Select Conditions Dialog Box” on page
989.

Save as standard layout Click to save the current Alarms pane or

Alarm View layout as the standard layout
for all users and for the Alarms pane or the
specific Alarm View.

Reset standard layout to factory default Click to reset the Alarms pane or Alarm
View standard layout to factory default.

Add/Remove columns Click to open the Add/Remove columns

dialog box to add or remove columns from
the Alarms pane or Alarm View. For more
information, see the Add/Remove Columns
Dialog Box topic on WebHelp.

Properties Click to open the Alarm View properties

dialog box to view and edit the properties
of the Alarms pane or Alarm View. For
more information, see section 35.83 “Alarm
View Properties” on page 1000.

04-30005-01-en, May 2019 System

1007
35 Alarms User Interface
35.88 Alarms Pane Context Menu - Alarm View Settings Submenu

Continued
Command Description

Alarm state sort order Click to open the Alarm state sort order
dialog box to determine how alarms will be
sorted when the column State is used for
sorting the alarms in the Alarms pane or an
Alarm View. For more information, see the
Changing the Alarm State Sort Order topic
on WebHelp.

Detail view Click to open a detailed view for the

selected alarm. For more information, see
section 35.4 “Alarm and Event Detail
View ” on page 857.

System 04-30005-01-en, May 2019

1008
 35 Alarms User Interface
35.89 Alarm State Sort Order Dialog Box

35.89 Alarm State Sort Order Dialog Box

Use the Alarm State Sort Order dialog box to change the order in which alarms
of different states are displayed in the Alarms pane or the Alarm Views in the
EcoStruxure Building Operation software.

Figure: Alarm State Sort Order dialog box

Table: Alarm State Sort Order Dialog Box

Component Description

Click to move the selected alarm state up.

Click to move the selected alarm state

down.

04-30005-01-en, May 2019 System

1009
35 Alarms User Interface
35.90 Alarm Triggered Notification View

35.90 Alarm Triggered Notification View

Use the Alarm Triggered Notification view to view and edit the configuration of
an alarm triggered notification.

Figure: Alarm triggered notification view

System 04-30005-01-en, May 2019

1010
 35 Alarms User Interface
35.90 Alarm Triggered Notification View

Table: Alarm Triggered Notification View

Number Description

Properties
Use the properties to configure how the
notification is activated, what notification
report to connect to the notification, and
what properties to use for the notification
text. For more information, see section
35.91 “Alarm Triggered Notification
Properties - Basic Tab” on page 1012..

Notification text
Use the notification text to edit the contents
and formatting of the notification text. For
more information, see section 34.1
“Notifications” on page 787..

Quick filter
Use the Quick filter to enter a word to filter
on. For more information, see section 52.4
“Quick Filter ” on page 1512..

Substitution codes list

Use the alarm substitution codes list to
select the data you want to include in the
notification. For more information, see
section 31.27 “Alarm Substitution Codes”
on page 731..

Distribution method
Use the distribution method to start a
wizard where you configure how the
notification is distributed.
For more information, see section 35.96
“Create Notification Wizard - Configure
Email Page” on page 1023.
For more information, see section 35.97
“Create Notification Wizard - Configure
SNMP Page” on page 1025.
For more information, see section 35.98
“Create Notification Wizard - Configure
Write to File Page” on page 1027.

Filter Settings
Use the filter settings to select the alarm
filter conditions that have to be met before
the notification is triggered. For more
information, see section 29.18 “Alarm
Filters” on page 595..

04-30005-01-en, May 2019 System

1011
35 Alarms User Interface
35.91 Alarm Triggered Notification Properties - Basic Tab

35.91 Alarm Triggered Notification Properties -

Basic Tab
Use the Basic tab to view or edit the properties of the alarm triggered
notification.

Figure: Alarm triggered notification properties

Table: Alarm Triggered Notification Properties

Property Description

Status Select Disabled to deactivate the

notification function.

Activation schedule Enter the schedule that contains the value

that activates the notification.

Schedule value when active Enter the value, generated by the

connected schedule or other multistate
variable, that activates the notification.

Report template Enter the path to the report template.

For more information, see section 34.14
“Notification Reports” on page 810.

System 04-30005-01-en, May 2019

1012
 35 Alarms User Interface
35.91 Alarm Triggered Notification Properties - Basic Tab

Continued
Property Description

Decimal symbol Select the decimal symbol to be used in

the notification and the notification report
template.

Localization Select a language among the language

packs installed on the EcoStruxure BMS
server.

Notification text Edit the notification text.

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

Add
Click to add a distribution method to the
notification.
For more information, see section 34.6
“Notification Distribution Methods” on page
801.

Edit
Click to configure the selected distribution
method in the notification.
For more information, see section 34.6
“Notification Distribution Methods” on page
801.

Remove
Click to remove the selected distribution
method from the notification.
For more information, see section 34.6
“Notification Distribution Methods” on page
801.

04-30005-01-en, May 2019 System

1013
35 Alarms User Interface
35.92 Create Alarm Triggered Notification Wizard – Configure Alarm Triggered Notification Page

35.92 Create Alarm Triggered Notification

Wizard – Configure Alarm Triggered
Notification Page
Use the Configure Alarm Triggered Notification page to create an alarm
triggered notification.

Figure: Configure Alarm Triggered Notification page

Table: Alarm Triggered Notification Page

Property Description

Status Select Disabled to deactivate the

notification function.

Activation schedule Enter the schedule that contains the value

that activates the notification.

Schedule value when active Enter the value, generated by the

connected schedule or other multistate
variable, that activates the notification.

Report template Enter the path to the report template.

For more information, see section 34.14
“Notification Reports” on page 810.

Decimal symbol Select the decimal symbol to be used in

the notification and the notification report
template.

Localization Select a language among the language

packs installed on the EcoStruxure BMS
server.

System 04-30005-01-en, May 2019

1014
 35 Alarms User Interface
35.92 Create Alarm Triggered Notification Wizard – Configure Alarm Triggered Notification Page

Continued
Property Description

Notification text Edit the notification text.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

Substitution codes list Add the substitution codes you want to use
in the notification or notification report.
For more information, see section 31.27
“Alarm Substitution Codes” on page 731.

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

Add
Click to add a distribution method to the
notification.
For more information, see section 34.6
“Notification Distribution Methods” on page
801.

Edit
Click to configure the selected distribution
method in the notification.
For more information, see section 34.6
“Notification Distribution Methods” on page
801.

Remove
Click to remove the selected distribution
method from the notification.
For more information, see section 34.6
“Notification Distribution Methods” on page
801.

Add condition
Click to add a condition that has to be met
for the notification to be displayed or sent.
For more information, see section 29.18
“Alarm Filters” on page 595.

Remove condition
Click to remove a condition that has to be
met for the notification to be displayed or
sent.
For more information, see section 29.18
“Alarm Filters” on page 595.

Add row
Click to add a row to the condition.

04-30005-01-en, May 2019 System

1015
35 Alarms User Interface
35.92 Create Alarm Triggered Notification Wizard – Configure Alarm Triggered Notification Page

Continued
Property Description

Remove row
Click to remove the row from the condition.

Clear all
Click to clear the selected conditions.

System 04-30005-01-en, May 2019

1016
 35 Alarms User Interface
35.93 Variable Triggered Notification View

35.93 Variable Triggered Notification View

Use the Variable Triggered Notification view to view and edit the configuration
of a variable triggered notification.

Figure: Variable triggered notification view

Table: Variable Triggered Notification View

Number Description

Properties
Use the properties to configure how the
notification should be activated, for the
report template connected to the
notification, and for notification text
properties. For more information, see
section 35.94 “Variable Triggered
Notification Properties - Basic Tab” on
page 1019..

04-30005-01-en, May 2019 System

1017
35 Alarms User Interface
35.93 Variable Triggered Notification View

Continued
Number Description

Notification text
Use the notification text to edit the contents
and formatting of the notification text. For
more information, see section 34.1
“Notifications” on page 787..

Quick filter
Use the quick filter to enter a word to filter
the alarm substitution codes on. For more
information, see section 52.4 “Quick Filter ”
on page 1512..

Substitution codes list

Use the Report @(Report) substitution
code to write the notification report text in
the notification.

Distribution method
Use the distribution method to start a
wizard where you select how the
notification is distributed. For more
information, see section 34.6 “Notification
Distribution Methods” on page 801..

System 04-30005-01-en, May 2019

1018
 35 Alarms User Interface
35.94 Variable Triggered Notification Properties - Basic Tab

35.94 Variable Triggered Notification

Properties - Basic Tab
Use the Basic tab to view or edit the properties of the variable triggered
notification.

Figure: Variable triggered notification properties

Table: Variable Triggered Notification Properties

Property Description

Trigger variable Enter the variable that triggers the

notification.

Trigger condition Select when you want the notification to be

triggered: when the trigger variable
changes to true, changes to false, or all
changes.

Report template Enter the path to the report template.

For more information, see section 34.14
“Notification Reports” on page 810.

Generate report relative to Enter the path to the object that is relative
to the generated notification report.

04-30005-01-en, May 2019 System

1019
35 Alarms User Interface
35.94 Variable Triggered Notification Properties - Basic Tab

Continued
Property Description

Decimal symbol Select the decimal symbol to be used in

the notification and the notification report
template.

Localization Select a language among the language

packs installed on the EcoStruxure BMS
server.

Notification text Edit the notification text.

Add
Click to add a distribution method to the
notification.
For more information, see section 34.6
“Notification Distribution Methods” on page
801.

Edit
Click to configure the selected distribution
method in the notification.
For more information, see section 34.6
“Notification Distribution Methods” on page
801.

Remove
Click to remove the selected distribution
method from the notification.
For more information, see section 34.6
“Notification Distribution Methods” on page
801.

System 04-30005-01-en, May 2019

1020
 35 Alarms User Interface
35.95 Create Variable Triggered Notification Wizard – Configure Variable Triggered Notification Page

35.95 Create Variable Triggered Notification

Wizard – Configure Variable Triggered
Notification Page
Use the Configure Variable Triggered Notification page to create a variable
triggered notification.

Figure: Configure Variable Triggered Notification page

Table: Configure Variable Triggered Notification Page

Property Description

Trigger variable Enter the variable that triggers the

notification.

Trigger condition Select when you want the notification to be

triggered: when the trigger variable
changes to true, changes to false, or all
changes.

Report template Enter the path to the report template.

For more information, see section 34.14
“Notification Reports” on page 810.

Generate report relative to Enter the path to the object that is relative
to the generated notification report.

Decimal symbol Select the decimal symbol to be used in

the notification and the notification report
template.

04-30005-01-en, May 2019 System

1021
35 Alarms User Interface
35.95 Create Variable Triggered Notification Wizard – Configure Variable Triggered Notification Page

Continued
Property Description

Localization Select a language among the language

packs installed on the EcoStruxure BMS
server.

Notification text Edit the notification text.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

Substitution codes list Use the Report @(Report) substitution

code to write the notification report text in
the notification.

Add
Click to add a distribution method to the
notification.
For more information, see section 34.6
“Notification Distribution Methods” on page
801.

Edit
Click to configure the selected distribution
method in the notification.
For more information, see section 34.6
“Notification Distribution Methods” on page
801.

Remove
Click to remove the selected distribution
method from the notification.
For more information, see section 34.6
“Notification Distribution Methods” on page
801.

System 04-30005-01-en, May 2019

1022
 35 Alarms User Interface
35.96 Create Notification Wizard - Configure Email Page

35.96 Create Notification Wizard - Configure

Email Page
Use the Configure Email page to configure the email properties of the
notification.

Figure: Configure Email page

Table: Configure Email Page

Component Description

Subject Type the subject text or the substitution

code for the subject text the email
notification is to have when sent.

To users and groups Click the browse button to open the Users
and Groups dialog box where you select
the EcoStruxure Building Operation users
or user groups to whom the email
notification is to be sent. For more
information, see section 35.82 “Users and
Groups Dialog Box” on page 997.

To email address Type the email address of an alternative

recipient.

Send as attachment Select to add send the notification as an

attachment in the email.

Attchment filename Type a file name for the notification

attachment.

04-30005-01-en, May 2019 System

1023
35 Alarms User Interface
35.96 Create Notification Wizard - Configure Email Page

Continued
Component Description

Click to open the Configure dialog box

where you configure a reference for a
dynamic attachment file name. For more
information, see section 53.42 “Configure
Dialog Box – Configuration Tab” on page
1608.

System 04-30005-01-en, May 2019

1024
 35 Alarms User Interface
35.97 Create Notification Wizard - Configure SNMP Page

35.97 Create Notification Wizard - Configure

SNMP Page
Use the Configure SNMP page to configure the SNMP properties of the
notification.

Figure: Configure SNMP page

Table: Configure SNMP Page

Component Description

Address Type the address to the SNMP manager

that receives the notification.

Port Type the port that is used by the SNMP

manager that receives the notification.

User name Type the user name of the user on the

SNMP manager that receives the
notification.

Security level Select the security level.

Authentication protocol Select the authentication level:

• SHA-1
• MD5

Authentication password Enter the password of the user on the

SNMP manager that is to receive the
notification.

Confirm password Type the password again.

04-30005-01-en, May 2019 System

1025
35 Alarms User Interface
35.97 Create Notification Wizard - Configure SNMP Page

Continued
Component Description

Privacy encryption protocol Enter the privacy encryption protocol of the

user on the SNMP manager that is to
receive the notification:
• AES-128
• DES

Privacy password Enter the privacy password used to

encrypt the message being sent.

Confirm password Type the password again.

System 04-30005-01-en, May 2019

1026
 35 Alarms User Interface
35.98 Create Notification Wizard - Configure Write to File Page

35.98 Create Notification Wizard - Configure

Write to File Page
Use the Configure Write to File page to configure the write to file properties of
the notification.

Figure: Configure Write to File page

Table: Configure Write to File Page

Component Description

File name Type a name for the file.

Click to open the Configure dialog box

where you configure a reference for a
dynamic file name. For more information,
see section 53.42 “Configure Dialog Box –
Configuration Tab” on page 1608.

Uniqueness Select whether to append or prepend a

timestamp to the file name, or generate the
file without any timestamp.

Overwrite Select True to overwrite the file when a

new file is generated.

04-30005-01-en, May 2019 System

1027
35 Alarms User Interface
35.99 Notification Report Template View

35.99 Notification Report Template View

Use the Notification Report Template view to view and edit the properties of the
notification report template.

Figure: Notification Report Template view

Table: Notification Report Template View

Number Description

Report data
Use the Report data to add, edit, or
remove data types in the notification report
template.

Quick filter
Use the Quick filter to enter a word to filter
on. For more information, see section 52.4
“Quick Filter ” on page 1512.

System 04-30005-01-en, May 2019

1028
 35 Alarms User Interface
35.99 Notification Report Template View

Continued
Number Description

Substitution codes list

Use the substitution codes list to drag the
substitution codes you want to use to
generate the notification or notification
report text to the text box.
For more information, see section 34.19
“Properties and Watch Substitution Codes”
on page 831.
For more information, see section 34.20
“Trend Logs Substitution Codes” on page
832.

Report text
Use the Report text to edit the contents
and formatting of the notification report
text. For more information, see section
34.14 “Notification Reports” on page 810.

Timeout
Use the timeout function to enter the
maximum amount of time the report waits
for values to be retrieved from the
EcoStruxure BMS before canceling.

04-30005-01-en, May 2019 System

1029
35 Alarms User Interface
35.100 Notification Report Template Properties - Basic Tab

35.100 Notification Report Template Properties

- Basic Tab
Use the Basic tab to view or edit the properties of the notification report
template.

Figure: Notification Report Template properties

Table: Notification Report Template Properties

Property Description

Report data Use Report data to add, edit, or remove

data type groups to the notification report
template.

Add
Click to add a report data type to the
notification report template.

Edit
Click to edit the properties of the selected
report data type.

System 04-30005-01-en, May 2019

1030
 35 Alarms User Interface
35.100 Notification Report Template Properties - Basic Tab

Continued
Property Description

Remove
Click to remove the selected report data
type.

Report text Enter text to include in the notification

report template.

Timeout Enter the number of seconds the

notification attempts to fetch values from
the EcoStruxure Building Operation
database before canceling.

04-30005-01-en, May 2019 System

1031
35 Alarms User Interface
35.101 Create Notification Report Template Wizard – Configure Notification Report Template Page

35.101 Create Notification Report Template

Wizard – Configure Notification Report
Template Page
Use the Configure Notification Report Page to configure the properties of the
notification report template.

Figure: Configure Notification Report Template page

Table: Configure Notification Report Template Page

Property Description

Add
Click to add a report data type to the
notification report template.

Edit
Click to edit the properties of the selected
report data type.

Remove
Click to remove the selected report data
type.

Report text Enter text to include in the notification

report template.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

System 04-30005-01-en, May 2019

1032
 35 Alarms User Interface
35.101 Create Notification Report Template Wizard – Configure Notification Report Template Page

Continued
Property Description

Substitution codes list Add the substitution codes you want to use
in the notification or notification report.
For more information, see section 34.19
“Properties and Watch Substitution Codes”
on page 831.
For more information, see section 34.20
“Trend Logs Substitution Codes” on page
832.

04-30005-01-en, May 2019 System

1033
35 Alarms User Interface
35.102 Create Report Data Wizard - Configure Events Page

35.102 Create Report Data Wizard - Configure

Events Page
Use the Configure Events page to configure the content and the presentation of
data in a notification report template.

Figure: Configure Events page

Table: Configure Events Page

Component Description

Name Type a name for the data type group.

Add relative source Select to enable adding a relative source

to the filter.

Relative to Enter the object with the relation to the

notification report template that you want to
use as a template for where notification
reports are generated.

Relative source Enter the object in relation to the Relative

to property.

Source preview View how the source appears in the

notification report text.

Add
Click to add events to the notification
report template.

System 04-30005-01-en, May 2019

1034
 35 Alarms User Interface
35.102 Create Report Data Wizard - Configure Events Page

Continued
Component Description

Remove
Click to remove the selected event from
the notification report template.

Clear all
Click to remove all events from the
notification report template.

Template Enter the text or substitution codes you

want to use in the notification report.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

Substitution codes list Add the substitution codes you want to use
in the notification or notification report.

Template delimiter Enter the delimiter you want to use to

separate the event records, search result,
or Watch View properties in the notification
report.

Preview View how the events, properties, search,

trend log records, or watch appear in the
notification report text.

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

Number of events Enter the maximum number of event

records to add to the notification report.

04-30005-01-en, May 2019 System

1035
35 Alarms User Interface
35.103 Create Report Data Wizard - Configure Properties Page

35.103 Create Report Data Wizard - Configure

Properties Page
Use the Configure Properties page to configure the content and the
presentation of data in a notification report template.

Figure: Configure Properties page

Table: Configure Properties Page

Component Description

Name Type a name for the data type group.

Properties Use Properties to add, edit, or remove

properties in the data type group.

Add
Click to add properties to the notification
report template.

Edit
Click to edit the selected property.

Remove
Click to remove the selected property from
the notification report template.

Property template Enter the text or substitution codes you

want to use in the notification report.

System 04-30005-01-en, May 2019

1036
 35 Alarms User Interface
35.103 Create Report Data Wizard - Configure Properties Page

Continued
Component Description

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..
For more information, see section 52.4
“Quick Filter ” on page 1512.

Substitution codes list Add the substitution codes you want to use
in the notification or notification report.

Property delimiter Enter any printable character, space, or a

new line feed that you want to use to
separate the properties in the notification
report.

Preview Use to view how the properties or trend log

records appear in the notification report
text.

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

04-30005-01-en, May 2019 System

1037
35 Alarms User Interface
35.104 Create Report Data Wizard - Configure Relative Properties Page

35.104 Create Report Data Wizard - Configure

Relative Properties Page
Use the Configure Relative Properties page to configure the content and the
presentation of data in a notification report template.

Figure: Configure Relative Properties page

Table: Configure Relative Properties Page

Component Description

Name Type a name for the data type group.

Relative to Enter the object with the relation to the

notification report template that you want to
use as a template for where notification
reports are generated.

Properties Use Properties to add, edit, or remove

properties in the data type group.

Add
Click to add properties to the notification
report template.

Edit
Click to edit the selected property.

Remove
Click to remove the selected property from
the notification report template.

System 04-30005-01-en, May 2019

1038
 35 Alarms User Interface
35.104 Create Report Data Wizard - Configure Relative Properties Page

Continued
Component Description

Property template Enter the text or substitution codes you

want to use in the notification report.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

Substitution codes list Add the substitution codes you want to use
in the notification or notification report.

Property delimiter Enter any printable character, space, or a

new line feed that you want to use to
separate the properties in the notification
report.

Preview Use to view how the properties or trend log

records appear in the notification report
text.

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

04-30005-01-en, May 2019 System

1039
35 Alarms User Interface
35.105 Create Report Data Wizard – Configure Relative Search Page

35.105 Create Report Data Wizard – Configure

Relative Search Page
Use the Configure Relative Search page to configure the content and the
presentation of data in a notification report template.

Figure: Configure Relative Search page

Table: Configure Relative Search Page

Property Description

Name Type a name for the data type group.

Relative to Enter the object with the relation to the

notification report template that you want to
use as a template for where notification
reports are generated.

Relative search path Enter the search query in relation to the

'Relative to' property.

Template Enter the text or substitution codes you

want to use in the notification report.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

Template delimiter Enter the delimiter you want to use to

separate the event records, search result,
or Watch View properties in the notification
report.

Preview Displays how the relative search results

appear in the notification report text.

System 04-30005-01-en, May 2019

1040
 35 Alarms User Interface
35.105 Create Report Data Wizard – Configure Relative Search Page

Continued
Property Description

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

04-30005-01-en, May 2019 System

1041
35 Alarms User Interface
35.106 Create Report Data Wizard - Configure Relative Trend Log Page

35.106 Create Report Data Wizard - Configure

Relative Trend Log Page
Use the Configure Relative Trend Log page to configure the content and the
presentation of data in a notification report template.

Figure: Configure Relative Trend Log page

Table: Configure Relative Trend Log Page

Component Description

Name Type a name for the data type group.

Relative to Enter the object with the relation to the

notification report template that you want to
use as a template for where notification
reports are generated.

Relative log path Add the trend log in relation to the 'Relative
to' property.

Record template Enter the text or substitution codes you

want to use in the notification report.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

Substitution codes list Add the substitution codes you want to use
in the notification or notification report.

Record delimiter Enter any printable character, space, or a

new line feed that you want to use to
separate the trend log records in the
notification report.

System 04-30005-01-en, May 2019

1042
 35 Alarms User Interface
35.106 Create Report Data Wizard - Configure Relative Trend Log Page

Continued
Component Description

Preview Use to view how the properties or trend log

records appear in the notification report
text.

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

Number of records Enter the maximum number of trend log

records you want to display in the
notification report.

04-30005-01-en, May 2019 System

1043
35 Alarms User Interface
35.107 Create Report Data Wizard – Configure Relative Watch View Page

35.107 Create Report Data Wizard – Configure

Relative Watch View Page
Use the Configure Relative Watch View page to configure the content and the
presentation of data in a notification report template.

Figure: Configure Relative Watch View page

Table: Configure Relative Watch View Page

Property Description

Name Type a name for the data type group.

Relative to Enter the object with the relation to the

notification report template that you want to
use as a template for where notification
reports are generated.

Relative watch view path Enter the Watch View in relation to the
'Relative to' property.

Template Enter the text or substitution codes you

want to use in the notification report.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

Template delimiter Enter the delimiter you want to use to

separate the event records, search result,
or Watch View properties in the notification
report.

Preview Displays how the Watch View properties

appear in the notification report text.

System 04-30005-01-en, May 2019

1044
 35 Alarms User Interface
35.107 Create Report Data Wizard – Configure Relative Watch View Page

Continued
Property Description

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

04-30005-01-en, May 2019 System

1045
35 Alarms User Interface
35.108 Create Report Data Wizard – Configure Search Page

35.108 Create Report Data Wizard – Configure

Search Page
Use the Configure Search page to configure the content and the presentation of
data in a notification report template.

Figure: Configure Search page

Table: Configure Search Page

Property Description

Name Type a name for the data type group.

Search query Enter the path to the saved search query

whose results you want to add to the
notification report.

Template Enter the text or substitution codes you

want to use in the notification report.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

Template delimiter Enter the delimiter you want to use to

separate the event records, search result,
or Watch View properties in the notification
report.

Preview Displays how the search results appear in

the notification report text.

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

System 04-30005-01-en, May 2019

1046
 35 Alarms User Interface
35.109 Create Report Data Wizard - Configure Trend Log Page

35.109 Create Report Data Wizard - Configure

Trend Log Page
Use the Configure Trend Log page to configure the content and the
presentation of data in a notification report template.

Figure: Configure Trend Log page

Table: Configure Trend Log page

Component Description

Name Type a name for the data type group.

Log reference Add the path to the trend log you want to
use in the notification report.

Record template Enter the text or substitution codes you

want to use in the notification report.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

Substitution codes list Add the substitution codes you want to use
in the notification or notification report.

Record delimiter Enter any printable character, space, or a

new line feed that you want to use to
separate the trend log records in the
notification report.

Preview Use to view how the properties or trend log

records appear in the notification report
text.

04-30005-01-en, May 2019 System

1047
35 Alarms User Interface
35.109 Create Report Data Wizard - Configure Trend Log Page

Continued
Component Description

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

Number of records Enter the maximum number of trend log

records you want to display in the
notification report.

System 04-30005-01-en, May 2019

1048
 35 Alarms User Interface
35.110 Create Report Data Wizard – Configure Watch Page

35.110 Create Report Data Wizard – Configure

Watch Page
Use the Configure Watch page to configure the content and the presentation of
data in a notification report template.

Figure: Configure Watch page

Table: Configure Watch Page

Property Description

Name Type a name for the data type group.

Watch View Enter the path to the saved Watch View

whose properties you want to add to the
notification report.

Template Enter the text or substitution codes you

want to use in the notification report.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

Template delimiter Enter the delimiter you want to use to

separate the event records, search result,
or Watch View properties in the notification
report.

Preview Displays how the Watch View properties

appear in the notification report text.

Substitute missing data with Enter the text that is displayed when a
value is missing. By default, a missing
value displays nothing at all.

04-30005-01-en, May 2019 System

1049
35 Alarms User Interface
35.111 Alarm Decoration View

35.111 Alarm Decoration View

Use the Alarm Decoration view to view and edit alarm decoration rules.

Figure: Alarm Decoration view

Table: Alarm Decoration View

Property Description

Add decoration
Click to open the Create alarm decoration
rule wizard. For more information, see
section 35.113 “Create Alarm Decoration
Rule Wizard - Filter Page” on page 1055.

Edit decoration
Click to edit the selected alarm decoration
rule.

Remove decoration
Click to remove the selected alarm
decoration rule.

Move up
Click to move the execution order of the
selected alarm decoration rule up.

Move down
Click to move the execution order of the
selected alarm decoration rule down.

Order Displays the order in which the alarm

decoration rules are executed.

Name Displays the name of an alarm decoration

rule.

Description Displays the description of an alarm

decoration rule.

Filter Displays a preview of the filter configured

in the alarm decoration rule.

System 04-30005-01-en, May 2019

1050
 35 Alarms User Interface
35.112 Alarm Decoration Rule Properties – Alarm Settings Tab

35.112 Alarm Decoration Rule Properties –

Alarm Settings Tab
Use the Alarm Settings tab to view and configure the properties of the alarm
decoration rule.

Figure: Alarm Settings tab

Table: Alarm Settings Tab

Property Description

Override alarm text Select to override the original alarm text

message when the alarm decoration rule
conditions are met.

Alarm text message Type the alarm text message to display

when the alarm is in Alarm state and the
alarm decoration rule conditions are met.
For more information, see section 31.7
“Alarm Messages” on page 708.

Override priority Select to override the original priority

property.

04-30005-01-en, May 2019 System

1051
35 Alarms User Interface
35.112 Alarm Decoration Rule Properties – Alarm Settings Tab

Continued
Property Description

Priority Enter the priority of an alarm that meets the

conditions of the alarm decoration rule. For
more information, see section 31.9 “Alarm
Priority” on page 710.

Override category Select to override the original category

property.

Category Enter the category of an alarm that meets

the conditions of the alarm decoration rule.
For more information, see the Categories
topic on WebHelp.

Override cause note group Select to override the original cause note
group.

Cause note group Enter the cause note group of an alarm that
meets the conditions of the alarm
decoration rule. For more information, see
section 32.1 “User Actions” on page 757.

Override action note group Select to override the original action note
group.

Action note group Enter the action note group of an alarm that
meets the conditions of the alarm
decoration rule. For more information, see
section 32.1 “User Actions” on page 757.

Override checklist Select to override the original checklist

property.

Checklist Enter the checklist of an alarm that meets

the conditions of the alarm decoration rule.
For more information, see section 32.1
“User Actions” on page 757.

Checklist required Select to require a checklist for an alarm

that meets the conditions of the alarm
decoration rule.

Override prefix for alarm source name Select to override the original prefix for an
alarm source name property.

Prefix for alarm source name Enter the prefix for an alarm source name
of an alarm that meets the conditions of the
alarm decoration rule.

Override auto hide Select to override the original auto hide

configuration.

Auto hide Select to auto hide an alarm that meets the

conditions of the alarm decoration rule.

Override disable state-change logging Select to override the original disable

state-change logging configuration.

System 04-30005-01-en, May 2019

1052
 35 Alarms User Interface
35.112 Alarm Decoration Rule Properties – Alarm Settings Tab

Continued
Property Description

Disable state-change logging Select to disable state-change logging of

an alarm that meets the conditions of the
alarm decoration rule.

Override flashing alert Select to override the original flashing alert

property.

Flashing alert Select to add a flashing alert to an alarm

that meets the conditions of the alarm
decoration rule.

Override audible alert Select to override the original audible alert

property.

Audible alert Select to add an audible alert to an alarm

that meets the conditions of the alarm
decoration rule.

Override font Select to override the original font property.

Font Enter the font to be displayed in the Alarms

pane or an Alarm View when an alarm that
meets the conditions of the alarm
decoration rule changes state. For more
information, see section 35.45 “Alarm
Styles View” on page 946.

Override font color Select to override the original font color

property.

Font color Enter the font color to be displayed in the

Alarms pane or an Alarm View when an
alarm that meets the conditions of the
alarm decoration rule changes state. For
more information, see section 35.45 “Alarm
Styles View” on page 946.

Override background color Select to override the original background

color property.

Background color Enter the background color to be

displayed in the Alarms pane or an Alarm
View when an alarm that meets the
conditions of the alarm decoration rule
changes state. For more information, see
section 35.45 “Alarm Styles View” on page
946.

Required user actions Select to override the original required user

action properties. For more information,
see section 32.1 “User Actions” on page
757.

Add
Click to add an action requirement. For
more information, see section 32.1 “User
Actions” on page 757.

04-30005-01-en, May 2019 System

1053
35 Alarms User Interface
35.112 Alarm Decoration Rule Properties – Alarm Settings Tab

Continued
Property Description

Edit
Click to configure the actions required of
the user when an alarm that meets the
conditions of the alarm decoration rule
changes state. For more information, see
section 32.1 “User Actions” on page 757.

Remove
Click to remove the selected action
requirement. For more information, see
section 32.1 “User Actions” on page 757.

Add
Click to add an attachment to an alarm that
meets the conditions of the alarm
decoration rule. For more information, see
section 31.21 “Alarm Attachments” on
page 725.

Edit
Click to edit the display condition and the
object reference of the selected
attachment. For more information, see
section 31.21 “Alarm Attachments” on
page 725.

Remove
Click to remove the selected attachment.
For more information, see section 31.21
“Alarm Attachments” on page 725.

Display on alarm Select True to automatically open and

display the attachment when an alarm that
meets the conditions of the alarm
decoration rule is triggered. For more
information, see section 31.21 “Alarm
Attachments” on page 725.

System 04-30005-01-en, May 2019

1054
 35 Alarms User Interface
35.113 Create Alarm Decoration Rule Wizard - Filter Page

35.113 Create Alarm Decoration Rule Wizard -

Filter Page
Use the Filter page or tab to configure the conditions that have to be met before
the alarm decoration rule overrides the original properties configured for the
alarm.

Figure: Filter page

Table: Filter Page or Tab

Property Description

Add condition
Click to add the conditions that have to be
met before the alarm decoration rule
becomes active and overrides the original
configuration of the alarm. For more
information, see section 35.6
“Add/Remove Conditions Dialog Box” on
page 863.

Remove condition
Click to remove the selected condition.

Add row
Click to add another condition that has to
be met before the alarm decoration rule
becomes active.

Remove row
Click to remove the selected alarm
decoration rule condition.

04-30005-01-en, May 2019 System

1055
35 Alarms User Interface
35.113 Create Alarm Decoration Rule Wizard - Filter Page

Continued
Property Description

Clear all Click to clear the selected conditions.

System 04-30005-01-en, May 2019

1056
 35 Alarms User Interface
35.114 Create Alarm Decoration Rule Wizard - Presentation Page

35.114 Create Alarm Decoration Rule Wizard -

Presentation Page
Use the Presentation page or tab to configure the presentation properties when
the alarm decoration rule conditions are met.

Figure: Presentation page

Table: Presentation Page or Tab

Property Description

Override Select the boxes for the alarm presentation

properties you want to override when the
alarm decoration rule conditions are met.

Alarm text message Type the message to display when the

alarm is in Alarm state and the alarm
decoration rule conditions are met.
For more information, see section 31.7
“Alarm Messages” on page 708.

Category Enter the category that the alarm belongs

to when the alarm decoration conditions
are met.
For more information, see the Categories
topic on WebHelp.

Prefix for alarm source name Type a prefix that is added to the
beginning of the source name property of
an alarm record.

04-30005-01-en, May 2019 System

1057
35 Alarms User Interface
35.114 Create Alarm Decoration Rule Wizard - Presentation Page

Continued
Property Description

Priority Enter the priority level of the alarm.

For more information, see section 31.9
“Alarm Priority” on page 710.

Auto hide Select to automatically hide the alarm in

the Alarms pane or Alarm View.

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.

Disable state-change logging Select to prevent an alarm state change

from creating an event.

Background color Enter the background color of the row for

triggered alarms in the Alarms pane and
Alarm Views when the alarm decoration
rule conditions are met.
For more information, see section 35.45
“Alarm Styles View” on page 946.

Font color Enter the font color to use for triggered

alarms in the Alarms pane and Alarm
Views when the alarm decoration rule
conditions are met.
For more information, see section 35.45
“Alarm Styles View” on page 946.

Font Enter the font to use for triggered alarms in

the Alarms pane and Alarm Views when
the alarm decoration rule conditions are
met.
For more information, see section 35.45
“Alarm Styles View” on page 946.

System 04-30005-01-en, May 2019

1058
 35 Alarms User Interface
35.115 Create Alarm Decoration Rule Wizard - User Action Page

35.115 Create Alarm Decoration Rule Wizard -

User Action Page
Use the User Action page or tab configure the user action required when the
alarm decoration rule conditions are met.

Figure: User Action page

Table: User Action Page or Tab

Property Description

Override Select the boxes for the user action

properties you want to override when the
alarm decoration rule conditions are met.

Cause note group Enter the cause note group that is used by
the alarm when the alarm decoration rule
conditions are met.
For more information, see section 32.1
“User Actions” on page 757.

Action note group Enter the action note group that is used by
the alarm when the alarm decoration rule
conditions are met.
For more information, see section 32.1
“User Actions” on page 757.

Checklist Enter the checklist that belongs to the

alarm when the alarm decoration rule
conditions are met.
For more information, see section 32.1
“User Actions” on page 757.

04-30005-01-en, May 2019 System

1059
35 Alarms User Interface
35.115 Create Alarm Decoration Rule Wizard - User Action Page

Continued
Property Description

Required User Actions Select what actions the user has to perform
when any of the listed events occur and
when the alarm decoration rule conditions
are met.
For more information, see section 32.1
“User Actions” on page 757.

System 04-30005-01-en, May 2019

1060
36 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
Displaying Milliseconds in Event Views
Alarm View and Event View Standard Filter and Layout
Saving an Event View Standard Layout
Resetting the Event View Standard Layout to Factory
Default
Editing an Event View Standard Filter
Event Filter Conditions
Applying an Event Time Filter
Creating a Filtered Event View
Filter Condition Wildcards
Viewing Events in This Branch
Viewing Events for Properties of Bound Objects
Viewing Events from the Watch Pane
 36 Events
36.1 How Events Work

36.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 EcoStruxure BMS, when
a setpoint was changed, if a notification was written to a file, if an email
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 SmartX servers were online or offline and when the
software was upgraded. The event log is useful for tracking down all information
in your system.
To limit the events displayed in the WorkStation Events pane, you can use the
time interval filter or a number of other filters. An indicator tells you the number of
displayed events.
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.
In WorkStation, you can also view all events for a branch. A branch can be, for
example, a folder or a network including all contents.
When you view Events in this branch, the events are based on the path of the
branch. This means that there is no complete list of historical events for objects
that have been moved into the branch. Historical events are also lost if the
container has been moved or renamed. Events for objects that has been
removed or deleted from the container are displayed.
In the Events view, you can also open a detailed view to inspect all properties for
a selected event.
For scheduled events, changes are encoded:
• Monday: WS00001
• Tuesday: WS00002
• Wednesday: WS00003
• Thursday: WS00004
• Friday: WS00005
• Saturday: WS00006
• Sunday: WS00007

36.1.1 Events Pane and Event View Customization

You can style certain events to bring out those that are of more 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 more information, see section 36.2 “Events Pane and Event View
Customization” on page 1065.

04-30005-01-en, May 2019 System

1063
36 Events
36.1 How Events Work

36.1.2 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.
For more information, see section 36.9 “Event Filter Conditions” on page 1073.

36.1.3 Favorites
When you make layout or filter changes to certain panes and views, you can
save the changes as a favorite. The purpose of the favorite is to quickly and
temporarily change the Standard layout and narrow what is displayed in the
pane or view by applying the favorite filter conditions.
For more information, see the Favorites topic on WebHelp.

36.1.4 Archive Overview

Archiving is the process of preserving historical data, which is comprised of
selected events and extended trend logs. For example, some facilities are
required to maintain archives to comply with government regulations. Another
example is in secure facilities where they must maintain records of who logged
in or who changed setpoints. Archiving is not a backup function because
archive data cannot be imported back into the system.
For more information, see section 57.1 “Archiving Overview” on page 1699.

System 04-30005-01-en, May 2019

1064
 36 Events
36.2 Events Pane and Event View Customization

36.2 Events Pane and Event View

Customization
You can style certain events to bring out those that are of more 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.
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.

Event View standard filter and layout

A standard layout defines the columns that are included in the Alarms pane,
Events pane, Alarm View, or Event View, the order in which they are displayed,
whether or not the alarms or events are grouped in any way and whether they
are displayed in an ascending or descending order. A standard filter defines the
conditions that have to be met before the alarms or events are displayed in the
pane or a View. The standard layout and filter is saved for the pane or View to
which you made the changes. The standard layout and filter is displayed for all
users of the the EcoStruxure BMS.
For more information, see section 36.5 “Alarm View and Event View Standard
Filter and Layout” on page 1069.

04-30005-01-en, May 2019 System

1065
36 Events
36.3 Styling a Certain Event in the Events Pane or Event View

36.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 36.2 “Events Pane and Event View
Customization” on page 1065.

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 the Add style button.
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.

NOTICE
• You can add several event categories to specify the event in detail.

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. In the Color dialog box, 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-30005-01-en, May 2019

1066
 36 Events
36.3 Styling a Certain Event in the Events Pane or Event View

You can add several event styles to different associated events.

04-30005-01-en, May 2019 System

1067
36 Events
36.4 Displaying Milliseconds in Event Views

36.4 Displaying Milliseconds in Event Views

You display milliseconds in Event Views to verify the millisecond an event was
triggered.
For more information, see section 36.2 “Events Pane and Event View
Customization” on page 1065.

To display milliseconds in Event Views

1. In WorkStation, select an Event View.
2. On the File menu, click Properties
Properties.
3. In the Show milliseconds box, select True
True.
4. Click OK
OK.
The Event View time properties display milliseconds for all logged on users.

System 04-30005-01-en, May 2019

1068
 36 Events
36.5 Alarm View and Event View Standard Filter and Layout

36.5 Alarm View and Event View Standard

Filter and Layout
A standard layout defines the columns that are included in the Alarms pane,
Events pane, Alarm View, or Event View, the order in which they are displayed,
whether or not the alarms or events are grouped in any way and whether they
are displayed in an ascending or descending order. A standard filter defines the
conditions that have to be met before the alarms or events are displayed in the
pane or a View. The standard layout and filter is saved for the pane or View to
which you made the changes. The standard layout and filter is displayed for all
users of the the EcoStruxure BMS.
You can edit the layout and filter conditions of the standard layout and filter
provided you have write permissions on the pane or View from which you are
making the changes. When you change the standard layout and filter from a
pane or View, the changes are only applied on that specific pane or View and for
all users who view that pane or View. Other Views in the system are not affected.
You can revert your layout changes.
Standard filters in Alarm Views and Event Views support relative paths for the
Source property. You can reuse the Alarm View or Event View and have the
Source path of the alarms or events dynamically change depending on where
you paste, import, move or duplicate the Alarm View or Event View. For example,
in a relative path: '../../*' where '../' represents a folder or other container object
and '*' represents anything below the folder or container object.

04-30005-01-en, May 2019 System

1069
36 Events
36.6 Saving an Event View Standard Layout

36.6 Saving an Event View Standard Layout

You save a standard layout to make a change to the Events pane or an Event
View layout available to all users.
For more information, see section 36.5 “Alarm View and Event View Standard
Filter and Layout” on page 1069.

To save an Event View standard layout

1. In WorkStaton, in the Events pane or an Event View, right-click anywhere in
the column header row and then click Add/Remove columns
columns.
2. Select the columns that you want to add or clear columns that you want to
remove from the Alarm View standard layout.
3. Click OK
OK.
4. Move the Events pane or Event View columns to the position where you
want them by dragging the column heading.
5. Click the arrow that appears next to a column heading to choose
ascending or descending alphanumeric sort order for the content of that
column.

6. Right-click the column heading row and select Group box .

7. Drag a column heading to the group box to group the events by that
category.

8. Right-click anywhere in the Events pane or Event View, point to Event View
settings and then click Save as standard layout
layout.
The standard layout is applied on the Events pane or the Event View from which
you made the changes and is applied when a user opens the Events pane or
Event View.

System 04-30005-01-en, May 2019

1070
 36 Events
36.7 Resetting the Event View Standard Layout to Factory Default

36.7 Resetting the Event View Standard

Layout to Factory Default
You reset the standard layout for the Events pane or Event View to revert a
change that you have made to the standard layout.
For more information, see section 36.5 “Alarm View and Event View Standard
Filter and Layout” on page 1069.

To reset the Event View standard layout to factory default

1. In WorkStation, right-click anywhere in the Events pane or Event View list.
2. Point to Event View settings and then click Reset standard layout to
factory default
default.
The Events pane or Event View standard layout is reset to the factory default
layout.

04-30005-01-en, May 2019 System

1071
36 Events
36.8 Editing an Event View Standard Filter

36.8 Editing an Event View Standard Filter

You edit a standard filter to narrow what is displayed in the Events pane or an
Event View for all users in the EcoStruxure Building Operation software.
For more information, see section 36.5 “Alarm View and Event View Standard
Filter and Layout” on page 1069.

To edit an Event View standard filter

1. In WorkStation, right-click anywhere in the Events pane or Event View, point
to Event View settings, and then click Edit standard filter
filter.
2. In the Add/Remove Conditions dialog box, click the Add condition

button .
3. In the Select Conditions dialog box, select the conditions you want to add
to the Events pane or Event View standard filter.
4. Click OK
OK.

5. Click the Add row button to add another row for the same condition.
6. Enter the sub condition that has to be met before the event is displayed in
the Events pane or Event View.
7. Click OK
OK.
The standard filter is applied for all users who open the changed Events pane or
Event View.

System 04-30005-01-en, May 2019

1072
 36 Events
36.9 Event Filter Conditions

36.9 Event Filter Conditions

Event filter conditions are used to set up the conditions for the events you want
to be displayed in the Events pane or an Event View.
You can use wildcards when setting up filter conditions. For more information,
see section 36.12 “Filter Condition Wildcards ” on page 1081.

Table: Event Filter Conditions

Component Description

Acknowledge time Enter the property to filter events by the

time and date an alarm was
acknowledged.

Alarm state Select the property to filter events by the

alarm state.

Alarm text Type the property to filter events by the

alarm message that was added to the
alarm. Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Assigned state Select the property to filter events by the

assigned state the alarm had. The possible
values are Unassigned, Assigned and
Accepted.

Assigned to domain Type the property to filter events by the

domain of the user or group that an alarm
was assigned to. Wildcards can be used.
For more information, see section 36.12
“Filter Condition Wildcards ” on page 1081.

Assigned to ID Type the property to filter events by the ID

of the user or group that an alarm was
assigned to. Wildcards can be used. For
more information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Assigned to name Type the property to filter events by the

name of the user or group that an alarm
was assigned to. Wildcards can be used.
For more information, see section 36.12
“Filter Condition Wildcards ” on page 1081.

BACnet alarm type Select the property to filter events by the

BACnet alarm that monitored a variable
within a BACnet network.

Basic evaluation state Select the property to filter events by the

basic evaluation state of an alarm. The
value True indicates that an alarm was
triggered.

Category Type the property to filter events by the

category name. Wildcards can be used.
For more information, see section 36.12
“Filter Condition Wildcards ” on page 1081.

04-30005-01-en, May 2019 System

1073
36 Events
36.9 Event Filter Conditions

Continued
Component Description

Command Type the property to filter events by the

executed command. Wildcards can be
used. For more information, see section
36.12 “Filter Condition Wildcards ” on page
1081.

Comment Type the property to filter events by the

comment that was added to an alarm.
Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Control source Type the property to filter events by the

initials of the controlling I/NET operator.
Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Control state Select the property to filter events by the 4

bit I/NET state descriptor.

Count Enter the property to filter events by the

number of times an alarm has toggled
between the alarm and reset state.

Description Type the property to filter events by their

description. Wildcards can be used. For
more information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Device name Type the property to filter events by the

name of the I/NET device that generated
the event. Wildcards can be used. For
more information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Disabled cause Select the property to filter events by the

cause for why the alarm was disabled. An
alarm can be disabled by user, shunt
variable and/or system (it’s disabled by
system if the alarm was incorrectly
configured).

Domain name Select the property to filter events by the

domain a user belonged to.

Evaluation state Select the property to filter events by the

evaluation state an alarm had. For
example, Upper limit alarm is displayed if
the monitored value reached the upper
alarm limit.

EWS ID Type the property to filter events by the id

of the event on the external system.
Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

System 04-30005-01-en, May 2019

1074
 36 Events
36.9 Event Filter Conditions

Continued
Component Description

EWS source ID Type the property to filter events by the id

of the external object that generated the
event. Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

First name Type the property to filter events by the first

name of the individual whose key/card was
used at the I/NET door point. Wildcards
can be used. For more information, see
section 36.12 “Filter Condition Wildcards ”
on page 1081.

Forced value Type the property to filter events by forced

values. Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Group Type the property to filter events by the

name of the cause note or action note
group the user edited. Wildcards can be
used. For more information, see section
36.12 “Filter Condition Wildcards ” on page
1081.

Hidden Select the property to filter events by the

visible status an object had. False is
displayed when an object was shown.

Individual Enter the property to filter events by the

individual number of the individual whose
key/card was used at the I/NET door point.

INET address Type the property to filter events by the

system address of the point, or station
address of the host or controller that
generated the event. Wildcards can be
used. For more information, see section
36.12 “Filter Condition Wildcards ” on page
1081.

INET event type Select the property to filter events by the

I/NET event type.

Last name Type the property to filter events by the last

name of the individual whose key/card was
used at the I/NET door point. Wildcards
can be used. For more information, see
section 36.12 “Filter Condition Wildcards ”
on page 1081.

Link name Type the property to filter events by the

name assigned to the link of the device
from which the event originated. Wildcards
can be used. For more information, see
section 36.12 “Filter Condition Wildcards ”
on page 1081.

04-30005-01-en, May 2019 System

1075
36 Events
36.9 Event Filter Conditions

Continued
Component Description

Message text Type the property to filter events by the text

of an I/NET actio or dispatch message, if
there is one.

Monitored variable Type the property to filter events by path to

the monitored variable. Wildcards can be
used. For more information, see section
36.12 “Filter Condition Wildcards ” on page
1081.

Note Type the property to filter events by their

note. Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Previous alarm state Select the property to filter events by the

previous alarm state.

Priority Enter the property to filter events by the

priority an alarm had.

Sigma event parameters Type the property to filter events by the

Sigma event parameter. Wildcards can be
used. For more information, see section
36.12 “Filter Condition Wildcards ” on page
1081.

Sigma event type Select the property to filter events by the

Sigma event type.

Source Type the property to filter events by the

path of the source object. Wildcards can
be used. For more information, see section
36.12 “Filter Condition Wildcards ” on page
1081.

Source name Type the property to filter events by the

name of the external object that generated
the event. Wildcards can be used. For
more information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Source server Type the property to filter events by the

server path of the source object. Wildcards
can be used. For more information, see
section 36.12 “Filter Condition Wildcards ”
on page 1081.

State Type the property to filter events by (up to)

4 text characters that represent the text
state of a discrete point or the unit
description of an analog point. Wildcards
can be used. For more information, see
section 36.12 “Filter Condition Wildcards ”
on page 1081.

System 04-30005-01-en, May 2019

1076
 36 Events
36.9 Event Filter Conditions

Continued
Component Description

Station name Type the property to filter events by the

name assigned to the controller from which
the event originated. Wildcards can be
used. For more information, see section
36.12 “Filter Condition Wildcards ” on page
1081.

System alarm ID Select the property to filter events by the

alarm ID generated by the system.

System event ID Select the property to filter events by the

event ID generated by the system.

Tenant Enter the property to filter events by the

tenant number of the individual whose
key/card was used at the I/NET door point.

Timestamp Enter the property to filter events by the

time and date when the event was
generated.

Triggered time Enter the property to filter events by the

time and date an alarm went from normal
state to alarm state.

Type Select the property to filter events by event

type.

Unique alarm ID Type the property to filter events by the

unique alarm ID of an alarm. Wildcards
can be used. For more information, see
section 36.12 “Filter Condition Wildcards ”
on page 1081.

Unique user ID Type the property to filter events by the ID

of a user. Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

User action item Type the property to filter events of which

the user has edited checklist, cause note
group, or action note group items.
Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

User name Type the property to filter events by the

name of the user that generated the event.
Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Value after Type the property to filter events by the

value of an object after it was changed.
Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

04-30005-01-en, May 2019 System

1077
36 Events
36.9 Event Filter Conditions

Continued
Component Description

Value at change Type the property to filter events by the

value the monitored variable had when the
alarm was triggered. Wildcards can be
used. For more information, see section
36.12 “Filter Condition Wildcards ” on page
1081.

Value before Type the property to filter events by the

value of an object before it was changed.
Wildcards can be used. For more
information, see section 36.12 “Filter
Condition Wildcards ” on page 1081.

Zone Select the property to filter events by I/NET

security zone number associated with a
security event (0-63).

Filter condition wildcards

A wildcard is one or more characters used to simplify the process of setting up
filter conditons. You use wildcards to substitute characters or combinations of
characters in object properties, such as names or descriptions. For example,
instead of setting up five filter conditions for values with names beginning with a,
b, c, d, or e, you can set up one single filter condition for values with a name
beginning with any of the characters in the range [a-e].
For more information, see section 36.12 “Filter Condition Wildcards ” on page
1081.

System 04-30005-01-en, May 2019

1078
 36 Events
36.10 Applying an Event Time Filter

36.10 Applying an Event Time Filter

You use the event time filter to limit the number of events displayed in the Events
pane or to narrow a search based on a particular time interval.

NOTICE
• The time filter is a temporary filter for the logged on user. To save a time
filter, you have to add it as a Favorite. For more information, see the Favorites
topic on WebHelp.
• If you have auto hidden the Events pane or Event View, you have to
temporarily pin the pane or View before applying the event time filter. For
more information, see the Pane Menu topic on WebHelp.

For more information, see section 36.1 “How Events Work ” on page 1063.

To apply an event time filter

1. In WorkStation, open the Events pane.

2. Click the period selection button .

3. Select the period you want to filter on:

• To display the events for the past 24 hours, click the Day button .

• To display the events for the past week, click the Week button .

• To display the events for the past month, click the Month button .

• To display the events for the past year, click the Year button .
4. To modify the selected start time or date, select the Start box, enter a start
time, and click a different start date in the calendar.
5. To modify the selected end time or date, select the End box, enter an end
time, and click a different end date in the calendar.
6. Click Apply
Apply.
The Events pane displays the events generated within the selected date and
time interval.

04-30005-01-en, May 2019 System

1079
36 Events
36.11 Creating a Filtered Event View

36.11 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 36.2 “Events Pane and Event View
Customization” on page 1065.

To create a filtered Event View

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS server where you want to create the event.
2. On the File menu, point to New and then click View
View.
3. In the Create Object wizard, 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 created.
8. On the Actions menu, click Edit standard Event View filter
filter.

9. In the Select Conditions dialog box, click the Add Condition button
and select a condition.
10. In the Add/Remove Conditions dialog box, select a condition and then
click OK
OK.
11. In the Select Conditions dialog box, enter the settings of the condition.

NOTICE
You can add several event view conditions to specify when to write to the
Event View.

12. Click the Add row button to add another condition of the same type.
13. Click OK
OK.

System 04-30005-01-en, May 2019

1080
 36 Events
36.12 Filter Condition Wildcards

36.12 Filter Condition Wildcards

A wildcard is one or more characters used to simplify the process of setting up
filter conditons. You use wildcards to substitute characters or combinations of
characters in object properties, such as names or descriptions. For example,
instead of setting up five filter conditions for values with names beginning with a,
b, c, d, or e, you can set up one single filter condition for values with a name
beginning with any of the characters in the range [a-e].

Table: Wildcard Characters

Character Description

* Use to match any combination of

characters, including no character

? Use to match any one character exactly

[ Use to begin a SET, that is, a number of

characters or a range

] Use to end a SET

[] Use to match any one character specified

within the SET, that is, enclosed by the
brackets

! Use to exclude the characters or range(s)

of a SET

- Use in a range within a SET: 0-9, a-z, A-Z

\ Use to ignore the wildcard character and

search for it as any other character

Any other character has to match exactly.

You can specify any number of characters or a range within brackets. In this
case, the filter includes one character specified within the brackets and any
number of characters specified outside the brackets.
Examples:
*at - Matches "at" and all objects ending with "at"
?t - Matches all two-character objects ending with "t"
[CB]at - Matches "Cat" and "Bat", that is, objects beginning with any one
character specified within the SET and ending with "at"
[A-C]at - Matches "Aat", "Bat", and "Cat"
[CB][au]t - Matches "Cat", "Cut", "Bat", and "But"
[!a-b0-1q]at - Matches all three-character objects ending with 'at' except "aat",
"bat", "0at", "1at" and "qat"
\\ - Matches "\"
b\\t - Matches ”b\t”

04-30005-01-en, May 2019 System

1081
36 Events
36.12 Filter Condition Wildcards

Table: Wildcard Availability for Different Features

Feature * ? [b] [a-c] [\]] [!a-c]

Alarm View Yes Yes Not Not Not Not

Filter available available available available
Conditions

Event View Yes Yes Yes Yes Not Not

Filter available available
Conditions

Sum Alarm Yes Yes Yes Yes Yes Yes

Filter
Conditions

Notification Yes Yes Yes Yes Yes Yes

s Filter
Condition

Assignmen Yes Yes Yes Yes Yes Yes

ts Filter
Conditions

System 04-30005-01-en, May 2019

1082
 36 Events
36.13 Viewing Events in This Branch

36.13 Viewing Events in This Branch

You view events in this branch when you want to view all the events below a
certain branch in the system. A branch can be any object that can contain other
objects, for example, a folder or a network.
For more information, see section 36.1 “How Events Work ” on page 1063.

To view events in this branch

1. In the System Tree pane, select the object that you want to view the events
for.
2. On the Actions menu, point to View and then click Events in this branch
branch.
The events for the selected object and all its contents are displayed in the work
area.

04-30005-01-en, May 2019 System

1083
36 Events
36.14 Viewing Events for Properties of Bound Objects

36.14 Viewing Events for Properties of Bound

Objects
You can view events for the properties of bound objects, such as blocks in a
program or components in a graphic.
For more information, see section 36.1 “How Events Work ” on page 1063.

To view events for properties of bound objects

1. In WorkStation, in the System Tree pane, select the program or graphic
containing the bound object.
2. In the Graphic View, right-click the part of the program or graphic that
contains the bound property whose events you want to view.
3. Point to View and then click Events
Events.
The events of the properties in the bound object are displayed in an Events View
in the WorkStation work area.

System 04-30005-01-en, May 2019

1084
 36 Events
36.15 Viewing Events from the Watch Pane

36.15 Viewing Events from the Watch Pane

You can view events for properties selected in the Watch pane.
For more information, see section 36.1 “How Events Work ” on page 1063.

To view events from the Watch pane

1. In WorkStation, in the System Tree pane, select the object with the
property whose events you want to view.
2. Drag the object containing the property to the Watch pane.
3. Select the property in the Watch pane.
4. Right-click the selection.
5. Point to View and then click Events
Events.
The events of the property are displayed in an Event View in the WorkStation
work area.

04-30005-01-en, May 2019 System

1085
37 Events User Interface

introduction to this topic

Topics
Events Pane and Event View
Events Pane and Event View Toolbar
Event Styles Dialog Box
Event View Properties
Add/Remove Columns Dialog Box (Events)
Events Pane Context Menu
Events Pane Context Menu - Event View Settings Submenu
 37 Events User Interface
37.1 Events Pane and Event View

37.1 Events Pane and Event View

Use the Events pane and Event Views to view system or individual point events.

Figure: Events pane

Table: Events Pane and Event View

Number Description

Use the paus/play button to pause or

resume showing new events. For more
information, see section 37.2 “Events Pane
and Event View Toolbar” on page 1090.

Click to open the period selector where

you select the time and date period for the
events you want to display.

Use the Quick filter to enter a word to filter

on. For more information, see section 52.4
“Quick Filter ” on page 1512.

Use the columns to sort, hide, or show

information about the events. For more
information, see the Add/Remove Columns
Dialog Box topic on WebHelp.

Use the Detail view to display all

information about a selected event.

04-30005-01-en, May 2019 System

1089
37 Events User Interface
37.2 Events Pane and Event View Toolbar

37.2 Events Pane and Event View Toolbar

Use the Events pane and Event View toolbar to manage the events.

Table: Events Pane and Event View Toolbar

Button Description

Click to stop showing new events.

Click to start showing new events.

Event filter
Click to select the conditions for the event
display. For more information, see section
35.78 “Select Conditions Dialog Box” on
page 989.

Favorites
Click to open the Favorites menu where
you select, add, and manage favorites.

Click to open the period selector where

you select the time and date period for the
events you want to display.

Quick filter Enter a word or a character to filter on. For

more information, see section 52.4 “Quick
Filter ” on page 1512.

System 04-30005-01-en, May 2019

1090
 37 Events User Interface
37.3 Event Styles Dialog Box

37.3 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 style
Click to add and configure a new event to
style.

Delete style
Click to remove an event style.

Move up
Click to increase the priority of an event.

Move down
Click to decrease the priority of an event.

Priority Enter the priority of the event to style.

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.

04-30005-01-en, May 2019 System

1091
37 Events User Interface
37.3 Event Styles Dialog Box

Continued
Component Description

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

1092
 37 Events User Interface
37.4 Event View Properties

37.4 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

Show milliseconds Select True to display time properties

including milliseconds.

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.

04-30005-01-en, May 2019 System

1093
37 Events User Interface
37.4 Event View Properties

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

System 04-30005-01-en, May 2019

1094
 37 Events User Interface
37.5 Add/Remove Columns Dialog Box (Events)

37.5 Add/Remove Columns Dialog Box

(Events)
Use the Add/Remove columns dialog box to add or remove columns from the
Events pane or an Event View.

Figure: Add/Remove Columns dialog box

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 31.16
“Acknowledgements” on page 717.

Alarm state Select to display the alarm state. For more

information, see section 29.2 “Alarm
States” on page 579.

Alarm text Select to display the alarm message that

was added to the alarm. For more
information, see section 31.7 “Alarm
Messages” on page 708.

Assigned state Select to display the assigned state the

alarm had. For more information, see
section 31.28 “Alarm Assignments” on
page 736.

Assigned to domain Select to display the domain of the user or

group that an alarm was assigned to. For
more information, see section 21.1
“Domains” on page 391.

04-30005-01-en, May 2019 System

1095
37 Events User Interface
37.5 Add/Remove Columns Dialog Box (Events)

Continued
Component Description

Assigned to ID Select to display the ID of the user or

group that an alarm was assigned to.

Assigned to name Select to display the name of the user or

group that an alarm was assigned to. For
more information, see section 31.1 “Alarm
Functions” on page 699.

BACnet alarm type Select to display the BACnet alarm that

monitored a variable within a BACnet
network.

Basic evaluation state Select to display the basic evaluation state

of an alarm. The value True indicates that
an alarm was triggered.

Category Select to display the alarm category name.

Command Select to display the executed command.

Comment Select to display the comment that was

added to an alarm.

Control Source Select to display the initials of the

controlling I/NET operator.

Control State Select to display the 4 bit I/NET state

descriptor.

Count Select to display the number of times an

alarm has toggled between the alarm and
reset state. For more information, see the
Count topic on WebHelp.

Description Select to display the event description. For

more information, see section 53.39
“General Information Properties – Basic
Tab” on page 1604.

Device Name Select to display the name of the I/NET

device that generated the event.

Disabled cause Select to display the cause for why the

alarm was disabled. An alarm can be
disabled by user, shunt variable and/or
system (it’s disabled by system if the alarm
was incorrectly configured).

Domain name Select to display the domain a user

belonged to. For more information, see
section 21.1 “Domains” on page 391.

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.

System 04-30005-01-en, May 2019

1096
 37 Events User Interface
37.5 Add/Remove Columns Dialog Box (Events)

Continued
Component Description

EWS ID Select to display the EcoStruxure Web

Service identification of the event on the
external system.

EWS source ID Select to display the EcoStruxure Web

Service identification of the external object
that generated the event.

EWS source name Select to display the events ty the name of

the external object that generated the
event.

First Name Select to display the first name of the

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 a Sigma

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

04-30005-01-en, May 2019 System

1097
37 Events User Interface
37.5 Add/Remove Columns Dialog Box (Events)

Continued
Component Description

Sequence number Select to display the event sequence

number on the present server.

Sigma event parameters Select to display parameters of the Sigma

event.

Sigma event type Select to display the Sigma event type.

Source Select to display the path of the source

object.

Source server Select to display the server path of the

source object.

State Select to display the events in (up to) 4 text

characters that represent the text state of a
discrete point or the unit description of an
analog point.

StationName Select to display the name assigned to the

device from which the event originated.

System alarm ID Select to display the alarm ID generated

by the system.

System event ID Select to display the event ID generated by

the system.

Tenant Select to display the tenant number of the

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 34.1
“Notifications” on page 787.

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 53.39 “General
Information Properties – Basic Tab” on
page 1604.

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.

System 04-30005-01-en, May 2019

1098
 37 Events User Interface
37.5 Add/Remove Columns Dialog Box (Events)

Continued
Component Description

User name Select to display the name of the user that

generated the event.. For more
information, see section 36.2 “Events Pane
and Event View Customization” on page
1065.

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.

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

1099
37 Events User Interface
37.6 Events Pane Context Menu

37.6 Events Pane Context Menu

Use the Events pane context menu to pause or resume the reading of events
and to access the Event View settings.

Figure: Events pane context menu

Table: Events Pane Context Menu

Command Description

Pause Click to pause the reading of events.

Resume Click to resume the reading of events.

Event View settings Click to open the Event View Settings

submenu where you can make a number
of Event View settings for the current
Events pane or Event View. For more
information, see section 37.7 “Events Pane
Context Menu - Event View Settings
Submenu” on page 1101.

System 04-30005-01-en, May 2019

1100
 37 Events User Interface
37.7 Events Pane Context Menu - Event View Settings Submenu

37.7 Events Pane Context Menu - Event View

Settings Submenu
Use the Event View settings submenu to change the way events are presented.

Figure: Event View settings submenu

Table: Event View Settings submenu

Command Description

Edit event filter Click to open the Select conditions dialog

box where you sort the information in the
Events pane or an Event View. For more
information, see section 35.78 “Select
Conditions Dialog Box” on page 989.

Save as standard layout Click to save the current Events pane or

Event View layout as the standard layout
for all users and for the Events pane or the
specific Event View.

Reset standard layout to factory default Click to reset the Events pane or Event
View standard layout to factory default.

Add/Remove columns Click to open the Add/Remove columns

dialog box to add or remove columns from
the Events pane or Event View. For more
information, see section 37.5
“Add/Remove Columns Dialog Box
(Events)” on page 1095.

Properties Click to open the Event View dialog box to

view and edit the properties of the Events
pane or Event View. For more information,
see section 37.4 “Event View Properties”
on page 1093.

Edit the style of associated events Click to open the Event Styles dialog box
where you edit the style of a certain event.
For more information, see section 37.3
“Event Styles Dialog Box” on page 1091.

Detail view Click to open a detail view for the selected

event. For more information, see section
35.4 “Alarm and Event Detail View ” on
page 857.

04-30005-01-en, May 2019 System

1101
38 Trend Log Introduction

Topics
Trends 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
 38 Trend Log Introduction
38.1 Trends Overview

38.1 Trends 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-30005-01-en, May 2019 System

1105
38 Trend Log Introduction
38.1 Trends Overview

Figure: Trend overview.

NOTICE
System 04-30005-01-en, May 2019
1106
 38 Trend Log Introduction
38.1 Trends Overview

A trend log that monitors an enumeration records the enumeration value and
not the enumeration definition.
For more information, see section 57.12 “Event and Alarm Enumerations” on
page 1717.
For more information, see section 57.15 “Trend Log Enumerations” on page
1737.

38.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 39.1 “Trend Log Types” on page 1119.

38.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 40.1 “Trend Log Functions” on page 1167.

38.1.3 Trend Units

You can define the unit of a trend log when the trend log is created or on a
previously created trend log where no unit has been set.
For more information, see section 38.5 “Trend Units” on page 1112.

38.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 41.1 “ Trend Charts” on page 1189.

38.1.5 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.
For more information, see section 42.1 “Trend Log Lists” on page 1237.

04-30005-01-en, May 2019 System

1107
38 Trend Log Introduction
38.1 Trends Overview

38.1.6 Multi Trend Log Lists

You configure a multi trend log list to display values from multiple trend logs in
one list. You compare values in a multi trend log list when you commission or
validate an EcoStruxure BMS.
For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

38.1.7 Move or Copy Trend Logs or Extended

Trend Logs
When moving or copying a trend log or extended trend log to another
EcoStruxure BMS server, only the configuration of the trend log is transferred. If
you copy the trend log to another EcoStruxure BMS server, all recorded values
are preserved in the original trend log while the copy on the other EcoStruxure
BMS server does not contain any recorded values. If you move the trend log to
another EcoStruxure BMS server, the configuration of the trend log is preserved
but the record values are lost.

NOTICE
Recorded values are lost when you move or copy a trend log to another
EcoStruxure BMS server.

38.1.8 Mass Create

You use the mass create feature to create multiple identical alarms or trend logs
for different objects, instead of creating the alarms or trend logs one by one.
From trend logs, you can mass create extended trend logs.
For more information, see section 45.1 “Mass Create ” on page 1365.

System 04-30005-01-en, May 2019

1108
 38 Trend Log Introduction
38.2 Clearing a Trend Log

38.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 38.1 “Trends Overview” on page 1105.

NOTICE
• 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 EcoStruxure
BMS 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
Yes.
The trend log is now cleared.

04-30005-01-en, May 2019 System

1109
38 Trend Log Introduction
38.3 Editing or Commenting a Trend Log Record

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

NOTICE
• When editing an extended trend log record, the changes do not affect
corresponding record in the connected trend log.

For more information, see section 42.1 “Trend Log Lists” on page 1237.

To edit a trend log record

1. In WorkStation, in the System Tree pane, select the trend log list you want
to edit.
2. Select the record you want to edit, and then click the Edit/comment trend

log record button .

3. In the Edit/comment trend log record dialog box, 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-30005-01-en, May 2019

1110
 38 Trend Log Introduction
38.4 Displaying the History of a Trend Log Record

38.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 42.1 “Trend Log Lists” on page 1237.

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

1111
38 Trend Log Introduction
38.5 Trend Units

38.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.
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 get the initial unit of the connected trend log. If you change
the unit of the connected trend log, it does not affect the unit of the extended
trend log. If no unit has been set on the connected trend log, the extended trend
log does not get a unit. You can change the unit of an extended trend log.
By default, trend charts and trend log lists display the values according to the
unit that is defined in your operating system settings. You can select to display
units in a different unit system, or display units as configured in the connected
objects.
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-30005-01-en, May 2019

1112
 38 Trend Log Introduction
38.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.

04-30005-01-en, May 2019 System

1113
38 Trend Log Introduction
38.6 Enabling a Trend Log

38.6 Enabling a Trend Log

You enable trend log to start recording values.
For more information, see section 40.3 “Trend Log Activation” on page 1169.

To enable a trend log

1. In WorkStation, System Tree pane, select the folder or EcoStruxure BMS
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.

System 04-30005-01-en, May 2019

1114
 38 Trend Log Introduction
38.7 Disabling a Trend Log

38.7 Disabling a Trend Log

You disable a trend log to stop recording values.
For more information, see section 40.3 “Trend Log Activation” on page 1169.

To disable a trend log

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS 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.

04-30005-01-en, May 2019 System

1115
39 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 Function
Managing Meter Replacement
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
39 Implicit Trend Logs
 39 Trend Log Types
39.1 Trend Log Types

39.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 SmartX
server goes off line, it is recommended that you place trend logs as closely to
the logged variable as possible. Preferably, on the SmartX 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.
All trend log types can be configured to log meter consumption and handle
meter replacement. For more information, see section 39.8 “Meter Function” on
page 1137.
You can use extended trend logs to structure the log data and to store it where
there is greater storage capacity. For more information, see section 40.4
“Extended Trend Logs” on page 1171.
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 38.1 “Trends Overview” on
page 1105.

04-30005-01-en, May 2019 System

1119
39 Trend Log Types
39.1 Trend Log Types

Figure: Trend wizard flow chart

You can manually add records to any type of trend log.

System 04-30005-01-en, May 2019

1120
 39 Trend Log Types
39.1 Trend Log Types

39.1.1 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, record a variable that has an unequal
oscillation.
For more information, see section 39.11 “Change of Value Trend Logs” on page
1142.

39.1.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.
For more information, see section 39.2 “Interval Trend Logs ” on page 1123.

39.1.3 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 the EcoStruxure BMS.
For more information, see section 39.17 “Manual Trend Logs” on page 1156.

39.1.4 Variable Triggered Trend Logs

The variable triggered trend log records the variable when the conditions of the
associated trigger variable are met. 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 39.14 “Variable Triggered Trend Logs” on
page 1149.

39.1.5 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 the
EcoStruxure Building Operation software depending on the measured unit of the
device that is connected to the IO port.
For more information, see section 39.21 “Implicit Trend Logs ” on page 1163.

04-30005-01-en, May 2019 System

1121
39 Trend Log Types
39.1 Trend Log Types

39.1.6 Meter Function

The meter function adds meter properties to any trend log type to seamlessly
handle consumption calculations independent of meter rollover or meter
exchange.
For more information, see section 39.8 “Meter Function” on page 1137.

System 04-30005-01-en, May 2019

1122
 39 Trend Log Types
39.2 Interval Trend Logs

39.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-30005-01-en, May 2019 System

1123
39 Trend Log Types
39.2 Interval Trend Logs

Figure: Interval trend log schematic.

System 04-30005-01-en, May 2019

1124
 39 Trend Log Types
39.2 Interval Trend Logs

The interval of the interval trend log is aligned with the activation time of the
trend. For example, if the activation time is 09:01:00 and the interval is 15
minutes, the trend will log at 09:16:00, 09:31:00, 09:46:00, and so on.

39.2.1 Interval Time Zone

By default, the interval log uses UTC to determine when to take the next log
sample. When the interval is longer than 1 hour and you want to continue to log
that interval after a Daylight Savings Time change, use Server Local Time. For
example, the log interval is every 24th hour at midnight and you want to continue
to log at midnight even after a DST change, so you use Server Local Time.
During the DST change in the Spring, the log sample will register after 23 hours.
After the DST change in the Autumn, the log sample will register after 25 hours.

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

NOTICE
• To log a variable only according to the time interval, set Delta to zero.

04-30005-01-en, May 2019 System

1125
39 Trend Log Types
39.2 Interval Trend Logs

Figure: Interval trend log with delta schematic.

System 04-30005-01-en, May 2019

1126
 39 Trend Log Types
39.2 Interval Trend Logs

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.

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

Interval trend log meter functionality

An interval trend log can be created with initial meter settings. The interval trend
log supports the meter change command and meter consumption calculation.
You can view the last meter change information on the interval trend log object.
For more information, see section 39.8 “Meter Function” on page 1137.

04-30005-01-en, May 2019 System

1127
39 Trend Log Types
39.3 Interval Trend Log Delta

39.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 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-30005-01-en, May 2019

1128
 39 Trend Log Types
39.3 Interval Trend Log Delta

Figure: Interval trend log delta schematic

04-30005-01-en, May 2019 System

1129
39 Trend Log Types
39.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.

NOTICE
• 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-30005-01-en, May 2019

1130
 39 Trend Log Types
39.4 Creating an Interval Trend Log

39.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 39.2 “Interval Trend Logs ” on page 1123.

To create an interval trend log

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS 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 Create Object wizard, in the object type list, select Interval Trend
Log
Log.
4. In the Name box, type a name for the trend log.
5. In the Description box, type a description for the trend log.
6. Click Next
Next.
7. In the Configure Interval Trend Log page, in the Logged variable box,
enter the variable that you want to log.

8. Click the Set unit button .

9. In the Unit Selection dialog box, select a unit for the trend log values.
10. In the Prefix box, select the prefix of the unit.
11. Click Select
Select.
12. In the Delta box, enter the minimum value change that triggers a new
record.
13. In the Activation variable box, enter a variable to start recording values
when the acitvation variable is true
14. In the Activation time box, enter the exact time for the recording to begin.
15. In the Interval time zone box, select Server Local Time to avoid problems
with DST for logging intervals more frequent than 1 hour.
16. In the Interval box, type the log frequency.
17. In the Log size box, type the log size to be stored before old values are
overwritten.
18. In the Available trend storage box, check that the available number of
records is not exceeded.
19. In the Clear when enabled box, select True to clear the trend log every
time the trend log is enabled.
20. Click Next
Next.
21. In the Initial Meter Settings page, in the Set initial meter box, select True
to enable the meter function.
22. In the Start time box, enter the time when the meter was installed.
Continued on next page

04-30005-01-en, May 2019 System

1131
39 Trend Log Types
39.4 Creating an Interval Trend Log

23. In the Start value box, enter the value of the new meter when it was
installed.
24. In the Min value box, enter the first value of the new meter after roll-over.
25. In the Max value box, enter the last value of the new meter before roll-over.
26. Click Next
Next.
27. In the Connect Objects to the Trend Log page, in the Extended Trend Log
box, click the Browse button to create an extended trend log and connect it
to the trend log.
28. In the Trend Log List box, click the Browse button to create a trend log list
and connect it to the trend log.
29. 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.
30. Click Create
Create.

System 04-30005-01-en, May 2019

1132
 39 Trend Log Types
39.5 Configuring an Interval Trend Log

39.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 39.2 “Interval Trend Logs ” on page 1123.

To configure an interval trend log

1. In WorkStation, in the System Tree pane, click the interval trend log you
want to configure.
2. On the File menu, click Properties
Properties.
3. In the properties dialog box, click the Basic tab.
4. Edit the basic properties:
Property Description

Status Displays the status of the trend log.

Enabled Displays True if the trend log is

enabled.

Logged variable Enter the variable you want to log.

Delta Select the minimum value change that

triggers a new record.
For more information, see section 39.3
“Interval Trend Log Delta” on page
1128.

Activation variable Enter the variable that makes the trend

log start recording values when the
variable is True
True.
For more information, see section 40.3
“Trend Log Activation” on page 1169.

Activation time Specify the time when the trend log is to

start recording values.
For more information, see section 40.3
“Trend Log Activation” on page 1169.

Interval Type how often to log the variable. The

interval defines the time between two
log records.

Log size Select the number of records to store

before old records are overwritten,
including internal records generated by
the trend log.
For more information, see section 40.2
“Log Record Storage” on page 1168.

Clear when enabled Select True to clear the trend log when
it is enabled.

5. Click the Meter Info tab.

04-30005-01-en, May 2019 System

1133
39 Trend Log Types
39.5 Configuring an Interval Trend Log

6. Edit the meter properties:

Property Description

Is meter log Select True if the trend log meter

function is active.
For more information, see section 39.8
“Meter Function” on page 1137.

Meter change time Enter the time when the meter was
changed.

Meter change user Enter the name of the user account that
changed the meter.

End time Enter the time when the old meter was
replaced.

End value Enter the value the old meter had when
it was replaced.

Start time Enter the time when the new meter was
installed.

Start value Enter the value of the new meter when it

was installed.

Meter constant Enter the constant of the new meter. If

the meter counts in kilo (103), the
constant is 1000.

Min value Enter the first value of the new meter

after roll-over.

Max value Enter the last value of the new meter

before roll-over.

7. Click OK
OK.

System 04-30005-01-en, May 2019

1134
 39 Trend Log Types
39.6 Editing the Interval of an Interval Trend Log

39.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 39.2 “Interval Trend Logs ” on page 1123.

To edit the interval of an interval trend log

1. In WorkStation, in the System Tree pane, click the interval trend log whose
interval you want to edit.
2. In the Interval box, type the new value.

3. Click the Save button .

04-30005-01-en, May 2019 System

1135
39 Trend Log Types
39.7 Editing the Delta in an Interval Trend Log

39.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 39.2 “Interval Trend Logs ” on page 1123.

To edit the delta in an interval trend log

1. In WorkStation, in the System Tree pane, click the interval trend log whose
delta you want to edit.
2. In the Delta box, edit the value.

3. Click the Save button .

System 04-30005-01-en, May 2019

1136
 39 Trend Log Types
39.8 Meter Function

39.8 Meter Function

The meter function adds meter properties to any trend log type to seamlessly
handle consumption calculations independent of meter rollover or meter
exchange.
You create and configure the meter function in trend logs using WorkStation.
For example, in the figure below, the meter function in the 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.

04-30005-01-en, May 2019 System

1137
39 Trend Log Types
39.8 Meter Function

Figure: Meter trend log

System 04-30005-01-en, May 2019

1138
 39 Trend Log Types
39.8 Meter Function

The calculation function supports negative meter consumption values, which

can be used to handle cases where you need to subtract consumption, for
example, when energy is produced on site.
When physically replacing an old meter with a new one, you have to configure
the meter function of the trend log by adding the configuration and values of
both the old and the new meter. These configurations and values are the
foundation when handling a meter rollover or calculating consumption though
meter replacement. For more information, see section 39.9 “Managing Meter
Replacement ” on page 1140.

Figure: Manage replacement of meter dialog box where you enter the values of both the
old and the new meter

NOTICE
• 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 39.9 “Managing Meter
Replacement ” on page 1140.

04-30005-01-en, May 2019 System

1139
39 Trend Log Types
39.9 Managing Meter Replacement

39.9 Managing Meter Replacement

You have to manage the meter configuration and values each time a meter is
replaced.
For more information, see section 39.8 “Meter Function” on page 1137.

To manage meter replacement

1. In WorkStation, in the System Tree pane, select the trend log whose meter
configuration you want to manage.
2. On the File menu, click Properties
Properties.
3. In the End time box, enter the end time of the old meter.
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 start time of the new meter.
6. In the Start value box, type the current value of the new meter.
7. In the Meter constant box, type the constant value of the new meter.

NOTICE
• Type the constant of the new meter if unit conversion is not used in the
trend log, for example, the old trend log counted in grams and the new
one counts in kilos (103) type 1000.
• If unit conversion is used in the trend log - do not change the meter
constant.

8. In the Min value box, type the first value of the new meter when it rolls over.
9. In the Max value box, type the last value of the new meter before it rolls
over.
10. Click OK
OK.

System 04-30005-01-en, May 2019

1140
 39 Trend Log Types
39.10 Displaying Meter Change History

39.10 Displaying Meter Change History

You view, through a trend log list, all meter change events that are registered by
the meter trend log.

NOTICE
• The meter change history is only applicable for the meter trend log.

For more information, see section 39.8 “Meter Function” on page 1137.

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 Close
Close.
It is important that all meter changes are registered in the Manage replacement
of meter dialog box.

04-30005-01-en, May 2019 System

1141
39 Trend Log Types
39.11 Change of Value Trend Logs

39.11 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, record a variable that has an unequal
oscillation.

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

System 04-30005-01-en, May 2019

1142
 39 Trend Log Types
39.11 Change of Value Trend Logs

Figure: Change of value trend log schematic.

04-30005-01-en, May 2019 System

1143
39 Trend Log Types
39.11 Change of Value Trend Logs

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 40.3 “Trend Log Activation” on page 1169.
You can configure the maximum log interval in a change of value trend log. The
maximum log interval is the maximum time that can elapse between two
recordings regardless of whether the value has changed or not. The maximum
log interval is calculated from the last actual recording. When the maximum log
interval is configured, it bypasses the delta and the recording is triggered when
the configured time period has elapsed.

Change of value trend log meter functionality

A change of value trend log can be created with initial meter settings . The
change of value trend log supports the meter change command and meter
consumption calculation. You can view the last meter change information on the
change of value trend log object. For more information, see section 39.8 “Meter
Function” on page 1137.

System 04-30005-01-en, May 2019

1144
 39 Trend Log Types
39.12 Creating a Change of Value Trend Log

39.12 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 39.11 “Change of Value Trend Logs” on page
1142.

To create a change of value trend log

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS 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 Create Object dialog box, in object type list, select Change of Value
Trend Log
Log.
4. In the Name box, type a name for the trend log.
5. In the Description box, type a description for the trend log.
6. Click Next
Next.
7. In the Configure Change of Value Trend Log page, 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. Click the Set unit button .

10. In the Unit Selection dialog box, 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 Activation variable box, enter the variable that is to make the trend
log start recording values when the variable is true
14. In the Activation time box, specify the time when the trend log is to start
recording values.
15. In the Maximum log interval box, select the maximum time that can pass
between two recordings regardless of whether the delta value has been
exceeded or not.
16. In the Log size box, enter the number of records to be stored before old
records are overwritten.
17. In the Available trend storage box, check that the available number of
records is not exceeded.
18. In the Clear when enabled box, select True to clear the trend log every
time the trend log is enabled.
19. Click Next
Next.
20. In the Initial Meter Settings page, in the Set initial meter box, select True
to enable the meter function.
21. In the Start time box, enter the time when the meter was installed.
Continued on next page

04-30005-01-en, May 2019 System

1145
39 Trend Log Types
39.12 Creating a Change of Value Trend Log

22. In the Start value box, enter the value of the new meter when it was
installed.
23. In the Min value box, enter the first value of the new meter after roll-over.
24. In the Max value box, enter the last value of the new meter before roll-over.
25. Click Next
Next.
26. In the Connect Objects to the Trend Log page, in the Extended Trend
Log box, click the Browse button to create an extended trend log and
connect it to the trend log.
27. In the Trend Log List box, click the Browse button to create a trend log list
and connect it to the trend log.
28. 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.
29. Click Create
Create.

System 04-30005-01-en, May 2019

1146
 39 Trend Log Types
39.13 Configuring a Change of Value Trend Log

39.13 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 39.11 “Change of Value Trend Logs” on page
1142.

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. In the properties dialog box, click the Basic tab.
4. Edit the basic properties:
Property Description

Status Displays the status of the trend log.

Enabled Displays True if the trend log is

enabled.

Logged variable Enter the variable that you want to log.

Delta Select the minimum value change that

triggers a new record.

Activation variable Enter the variable that makes the trend

log start recording values when the
variable is True
True.
For more information, see section 40.3
“Trend Log Activation” on page 1169.

Activation time Specify the time when the trend log is to

start recording values.
For more information, see section 40.3
“Trend Log Activation” on page 1169.

Maximum log interval Select the maximum time that can pass
between two recordings regardless if
the delta value has been exceeded or
not.

Log size Select the number of records to store

before old records are overwritten,
including internal records generated by
the trend log.
For more information, see section 40.2
“Log Record Storage” on page 1168.

Clear when enabled Select True to clear the trend log when
it is enabled.

5. Click the Meter Info tab.

04-30005-01-en, May 2019 System

1147
39 Trend Log Types
39.13 Configuring a Change of Value Trend Log

6. Edit the meter properties:

Property Description

Is meter log Select True if the trend log meter

function is active.
For more information, see section 39.8
“Meter Function” on page 1137.

Meter change time Enter the time when the meter was
changed.

Meter change user Enter the name of the user account that
changed the meter.

End time Enter the time when the old meter was
replaced.

End value Enter the value the old meter had when
it was replaced.

Start time Enter the time when the new meter was
installed.

Start value Enter the value of the new meter when it

was installed.

Meter constant Enter the constant of the new meter. If

the meter counts in kilo (103), the
constant is 1000.

Min value Enter the first value of the new meter

after roll-over.

Max value Enter the last value of the new meter

before roll-over.

7. Click OK
OK.

System 04-30005-01-en, May 2019

1148
 39 Trend Log Types
39.14 Variable Triggered Trend Logs

39.14 Variable Triggered Trend Logs

The variable triggered trend log records the variable when the conditions of the
associated trigger variable are met. 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 regard to time or delta.

04-30005-01-en, May 2019 System

1149
39 Trend Log Types
39.14 Variable Triggered Trend Logs

Figure: Variable triggered trend log schematic

System 04-30005-01-en, May 2019

1150
 39 Trend Log Types
39.14 Variable Triggered Trend Logs

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

Variable triggered trend log meter functionality

A variable triggered trend log can be created with initial meter settings. The
variable triggered trend log supports the meter change command and meter
consumption calculation. You can view the last meter change information on the
variable triggered trend log object. For more information, see section 39.8
“Meter Function” on page 1137.

04-30005-01-en, May 2019 System

1151
39 Trend Log Types
39.15 Creating a Variable Triggered Trend Log

39.15 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 39.14 “Variable Triggered Trend Logs” on
page 1149.

To create a variable triggered trend log

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS 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 Create Object wizard, in the object type list, 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.
7. In the Configure Variable Triggered Trend Log page, in the Logged
variable box, enter the variable you want to log.

8. Click the Set unit button .

9. In the Unit selection dialog box, select a unit for the trend log values.
10. In the Prefix box, select the prefix of the unit.
11. Click Select
Select.
12. In the Trigger variable box, enter the variable that triggers the log.
13. In the Trigger condition box, select Change to true to log the variable
when the trigger variable changes to true.
14. In the Log size box, select the number of records to be stored before old
records are overwritten.
15. In the Available trend storage box, check that the available number of
records is not exceeded.
16. In the Clear when enabled box, select True to clear the trend log every
time the trend log is enabled.
17. Click Next
Next.
18. In the Initial Meter Settings page, in the Set initial meter box, select True
to enable the meter function.
19. In the Start time box, enter the time when the meter was installed.
20. In the Start value box, enter the value of the new meter when it was
installed.
Continued on next page

System 04-30005-01-en, May 2019

1152
 39 Trend Log Types
39.15 Creating a Variable Triggered Trend Log

21. In the Min value box, enter the first value of the new meter after roll-over.
22. In the Max value box, enter the last value of the new meter before roll-over
23. Click Next
Next.
24. In the Connect Objects to the Trend Log page, in the Extended Trend Log
box, click the Browse button to create an extended trend log and connect it
to the trend log.
25. In the Trend Log List box, click the Browse button to create a trend log list
and connect it to the trend log.
26. 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.
27. Click Create
Create.
The variable triggered trend log is created in the selected folder.

04-30005-01-en, May 2019 System

1153
39 Trend Log Types
39.16 Configuring a Variable Triggered Trend Log

39.16 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 39.14 “Variable Triggered Trend Logs” on
page 1149.

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. In the properties dialog box, click the Basic tab.
4. Edit the basic properties:
Component Description

Status Displays the status of the trend log.

Enabled Displays True if the trend log is

enabled.

Logged variable Enter the variable you want to log.

Delta Select the minimum value change that

triggers a new record.

Trigger variable Enter the variable that triggers the trend

log to start recording.

Trigger condition Select when you want the variable

recorded: when the trigger variable
changes to True, changes to False, or at
all changes.
For more information, see section 39.14
“Variable Triggered Trend Logs” on
page 1149.

Log size Select the number of records to store

before old records are overwritten,
including internal records generated by
the trend log.
For more information, see section 40.2
“Log Record Storage” on page 1168.

Clear when enabled Select True to clear the trend log when
it is enabled.

5. Click the Meter info tab.

System 04-30005-01-en, May 2019

1154
 39 Trend Log Types
39.16 Configuring a Variable Triggered Trend Log

6. Edit the meter properties:

Property Description

Is meter log Select True if the trend log meter

function is active.
For more information, see section 39.8
“Meter Function” on page 1137.

Meter change time Enter the time when the meter was
changed.

Meter change user Enter the name of the user account that
changed the meter.

End time Enter the time when the old meter was
replaced.

End value Enter the value the old meter had when
it was replaced.

Start time Enter the time when the new meter was
installed.

Start value Enter the value of the new meter when it

was installed.

Meter constant Enter the constant of the new meter. If

the meter counts in kilo (103), the
constant is 1000.

Min value Enter the first value of the new meter

after roll-over.

Max value Enter the last value of the new meter

before roll-over.

7. Click OK
OK.

04-30005-01-en, May 2019 System

1155
39 Trend Log Types
39.17 Manual Trend Logs

39.17 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 the EcoStruxure BMS.
The default size of a manual trend log is 100 records.

System 04-30005-01-en, May 2019

1156
 39 Trend Log Types
39.17 Manual Trend Logs

Figure: Manual trend log schematic.

04-30005-01-en, May 2019 System

1157
39 Trend Log Types
39.17 Manual Trend Logs

Manual trend log meter functionality

A manual trend log can be created with initial meter settings. The manual trend
log supports the meter change command and meter consumption calculation.
You can view the last meter change information on the manual trend log object.
For more information, see section 39.8 “Meter Function” on page 1137.

System 04-30005-01-en, May 2019

1158
 39 Trend Log Types
39.18 Creating a Manual Trend Log

39.18 Creating a Manual Trend Log

You create a manual trend log that records data that you manually enter.
For more information, see section 39.17 “Manual Trend Logs” on page 1156.

To create a manual trend log

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS 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 Create Object wizard, in the object type list, 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.
7. In the Configure Manual Log page, in the Unit box, click Browse button.
8. In the Select Unit dialog box, select a unit for the trend log values.
9. In the Prefix box, select the prefix of the unit.
10. Click Select
Select.
11. Click Next
Next.
12. In the Initial Meter Settings page, in the Set initial meter box, select True
to enable the meter function.
13. In the Start time box, enter the time when the meter was installed.
14. In the Start value box, enter the value of the new meter when it was
installed.
15. In the Min value box, enter the first value of the new meter after roll-over.
16. In the Max value box, enter the last value of the new meter before roll-over
17. Clilck Next
Next.
18. In the Connect Objects to the Trend Log page, 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 trend log to an existing trend chart.
21. 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.

04-30005-01-en, May 2019 System

1159
39 Trend Log Types
39.19 Configuring a Manual Trend Log

39.19 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 39.17 “Manual Trend Logs” on page 1156.

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. In the properties dialog box, click the Basic tab.
4. Edit the basic properties:
Component Description

Unit Enter the unit the trend log stores the

records in.

Click to open the configuration dialog

box where you configure the property.
For more information, see section 53.42
“Configure Dialog Box – Configuration
Tab” on page 1608.

5. Click the Meter Info tab.

6. Edit the meter properties:

Property Description

Is meter log Select True if the trend log meter

function is active.
For more information, see section 39.8
“Meter Function” on page 1137.

Meter change time Enter the time when the meter was
changed.

Meter change user Enter the name of the user account that
changed the meter.

End time Enter the time when the old meter was
replaced.

End value Enter the value the old meter had when
it was replaced.

Start time Enter the time when the new meter was
installed.

Start value Enter the value of the new meter when it

was installed.

Continued on next page

System 04-30005-01-en, May 2019

1160
 39 Trend Log Types
39.19 Configuring a Manual Trend Log

Continued
Property Description

Meter constant Enter the constant of the new meter. If

the meter counts in kilo (103), the
constant is 1000.

Min value Enter the first value of the new meter

after roll-over.

Max value Enter the last value of the new meter

before roll-over.

7. Click OK
OK.

04-30005-01-en, May 2019 System

1161
39 Trend Log Types
39.20 Adding a Trend Log Record to a Manual Trend Log

39.20 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 39.17 “Manual Trend Logs” on page 1156.

To add a trend log record to a manual trend log

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS 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 Add Trend Log Record dialog box, in the Time stamp box, enter the
date and time of the new value.
5. In the Value box, enter the value.
6. In the Comment box, type a comment.
7. Click Add record
record.
8. Click Close
Close.
The record is now added to the trend log.

System 04-30005-01-en, May 2019

1162
 39 Trend Log Types
39.21 Implicit Trend Logs

39.21 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 the
EcoStruxure Building Operation software depending on the measured unit of the
device that is connected to the IO port.

NOTICE
• 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-30005-01-en, May 2019 System

1163
40 Trend Log Functions

Topics
Trend Log Functions
Log Record Storage
Trend Log Activation
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 Log Size for a Trend Log
Editing an Extended Trend Log to be Included in Reports
Manually Transferring Records to the Extended Trend Log
Viewing Related Trends
Viewing Related Trends for Properties Bound to a Graphic
 40 Trend Log Functions
40.1 Trend Log Functions

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

40.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 40.2 “Log Record Storage” on page 1168.

40.1.2 Trend Log Activation

The interval trend log and change of value trend log start recording values when
the configured activation conditions are met. If an activation variable is used,
both the activation variable and the activation time have to be true for the trend
log to start recording.
For more information, see section 40.3 “Trend Log Activation” on page 1169.

40.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 40.4 “Extended Trend Logs” on page 1171.

04-30005-01-en, May 2019 System

1167
40 Trend Log Functions
40.2 Log Record Storage

40.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.
Additional internal records can be generated by the log itself. These records
may not be visible. Internal records are a part of the log usage.
If you try to configure a trend log to store a larger number of log records than the
EcoStruxure BMS server can manage, the trend log is not created.

Figure: Circular storing, schematic

System 04-30005-01-en, May 2019

1168
 40 Trend Log Functions
40.3 Trend Log Activation

40.3 Trend Log Activation

The interval trend log and change of value trend log start recording values when
the configured activation conditions are met. If an activation variable is used,
both the activation variable and the activation time have to be true for the trend
log to start recording.
On all trend logs, you can stop recording values by disabling the trend log. To
resume recording, you enable the trend log. For more information, see section
38.7 “Disabling a Trend Log” on page 1115.

40.3.1 Activation Variable

You configure an activation variable 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 also have the trend log stop recording when the variable, such as a fan,
goes off. For example, you can use this feature to log the effective time a fan is
on.

Figure: Activation variable that follows the activation time

04-30005-01-en, May 2019 System

1169
40 Trend Log Functions
40.3 Trend Log Activation

40.3.2 Start at activation time

You configure an activation time to have the trend log start recording values at a
specified time.
For Interval Trend Logs, the logging interval is aligned with the activation time.
For more information, see section 39.2 “Interval Trend Logs ” on page 1123.

Figure: Trend log that starts recording at activation time

System 04-30005-01-en, May 2019

1170
 40 Trend Log Functions
40.4 Extended Trend Logs

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

NOTICE
• The extended trend log cannot log a variable.
• The extended trend log gets the initial value of the connected trend log.
• 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.
• The extended trend log must have the same unit as the monitored trend log
to correctly display values.

04-30005-01-en, May 2019 System

1171
40 Trend Log Functions
40.4 Extended Trend Logs

Figure: Do not connect more than one extended trend log to a trend log or extended trend
log.

The extended trend log is often saved on an Enterprise Server or an Enterprise

Central with more storage capacity than the SmartX server where the ordinary
trend log is saved. This extra storage capacity enables the Enterprise Server or
Enterprise Central 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
EcoStruxure BMS server that runs the trend
log and the extended trend log.

System 04-30005-01-en, May 2019

1172
 40 Trend Log Functions
40.4 Extended Trend Logs

Continued
Function Explanation

Threshold Transfers records every time a specific

percentage threshold of records on the
trend log is reached.

Maximum transfer interval Transfers records at a specific time interval

even though the threshold or Smart log
condition is not reached.

Transfer trigger variable Transfers records when triggered by a

variable that changes state from false to
true, for example, a digital schedule. The
transfer takes place regardless of the
transfer threshold. This function can be
used to ensure that the extended trend log
contains all records, for example, to
generate a complete report at the end of
every month.

Force transfer Executed by the user to manually force a

transfer even though transfer threshold is
not reached.

When you create extend trend logs for BACnet trend logs, be sure to create the
extended trend log on the same EcoStruxure BMS server that hosts the BACnet
device and its trend log. This ensures that they remain synchronized in the event
the server needs to be restored. For more information, see the Extended
Logging for External BACnet Trend Logs Workflow topic on WebHelp.

04-30005-01-en, May 2019 System

1173
40 Trend Log Functions
40.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.

System 04-30005-01-en, May 2019

1174
 40 Trend Log Functions
40.4 Extended Trend Logs

When you edit a record in the extended trend log, the changes do not affect the
connected trend log. If you edit a record in the trend log, the changes are
transferred to the extended trend log next time a transfer occurs. You can edit
both the trend log and the corresponding record in the extended trend log, but
the edit is written twice in the extended trend log record under certain
circumstances:
• the record in the extended trend log is manually updated
• the corresponding edit is transferred from the trend log to the extended
trend log
The trend log list or trend chart displays the last written value of an edited
record.
Example 1: You edit a record in a trend log that is connected to an extended
trend log. The extended trend log is updated with the edited record. After the
transfer, you update the corresponding record in the extended trend log. The
trend log list and trend chart connected to the extended trend log display the
last value of the record, which in this case is the extended trend log edit.
Example 2: You edit a record in a trend log that is connected to an extended
trend log. Before the extended trend log is updated with the edited record, you
edit the corresponding record in the extended trend log. After a while the trend
log transfers its edited record to the extended trend log. The trend log list and
trend chart connected to the extended trend log display the edited trend log
record value and not the edited extended trend log record value. In this case,
the trend log list and trend chart display the last value that was written to the
extended trend log, not the last edited value.
You can view all edits, automatically transferred or manually added, in the
record history.

40.4.1 Archive Overview

Archiving is the process of preserving historical data, which is comprised of
selected events and extended trend logs. For example, some facilities are
required to maintain archives to comply with government regulations. Another
example is in secure facilities where they must maintain records of who logged
in or who changed setpoints. Archiving is not a backup function because
archive data cannot be imported back into the system.
For more information, see section 57.1 “Archiving Overview” on page 1699.

40.4.2 Extended Trend Log Meter Support

You can view the meter properties of the connected trend log, if the meter
function is enabled on the connected trend log. For more information, see
section 39.8 “Meter Function” on page 1137.

04-30005-01-en, May 2019 System

1175
40 Trend Log Functions
40.5 Creating an Extended Trend Log

40.5 Creating an Extended Trend Log

You create an extended trend log to store log records for a longer period of time
and free up memory in the SmartX server. Extended trend logs are also required
for generating reports using EcoStruxure Building Operation WebReports.
For more information, see section 40.4 “Extended Trend Logs” on page 1171.

To create an extended trend log

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS 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 Create Object wizard, in the object type list, select Extended Trend
Log
Log.
4. In the Name box, type a name for the extended trend log.
5. In the Description box, type a description for the extended log.
6. Click Next
Next.
7. In the Configure Extended Trend Log page, in the Monitored trend log
box, enter the trend log that you want to transfer records from.
8. In the Smart log box, select if you want to use smart log:
• Select True to enable the EcoStruxure Building Operation software to
automatically optimize the transfer rate of records from the monitored
trend log to the extended trend log.
• Select False to manually specify the percentage threshold at which the
trend log transfers its records to the extended trend log, and then
select the percentage in the Threshold box.
9. In the Maximum transfer interval box, select the maximum length of time
that can pass between transfers.
10. In the Configure Extended Trend Log page, in the Transfer trigger
variable box, enter a trigger variable to force a transfer of all records from
the trend log to the extended trend log. For more information, see section
40.4 “Extended Trend Logs” on page 1171.
11. In the Log size box, enter the number of records to be stored before old
ones are overwritten.
12. In the Available trend storage box, ensure that the available number of
records is not exceeded.
13. In the Include in reports box, select True to make the extended trend log
available to WebReports.
14. Click Create
Create.
The extended trend log is created and transfers and stores records from a trend
log.

System 04-30005-01-en, May 2019

1176
 40 Trend Log Functions
40.6 Configuring an Extended Trend Log

40.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 40.4 “Extended Trend Logs” on page 1171.

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. In the properties dialog box, click the Basic tab.
4. Edit the basic properties:
Component Description

Monitored trend log Enter the path to the trend log you want
to transfer records from.

Unit The unit of an extended trend log

created from the trend log wizard at the
same time as the connected trend log
inherits the unit of measurement from
the connected trend log.
The unit of an extended trend log that is
manually connected to a trend log
needs to be manually configured to use
the same unit of measurement as the
connected trend log.

Smart log Select True to optimize the transfer of

the monitored trend log to the extended
trend log.

Threshold Select the percentage threshold at

which the trend log transfers its records
to the extended trend log.

Maximum transfer interval Select the maximum length of time that

can pass between transfers from the
monitored trend log to the extended
trend log.

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 40.4
“Extended Trend Logs” on page 1171.

Log size Select the number of records to store

before old records are overwritten,
including internal records generated by
the trend log.
For more information, see section 40.2
“Log Record Storage” on page 1168.

04-30005-01-en, May 2019 System

1177
40 Trend Log Functions
40.6 Configuring an Extended Trend Log

Continued
Component Description

Include in reports Select True to include the extended

trend log data in reports.

5. Click the Meter Info tab.

6. View the meter properties:

Property Description

Is meter log Displays True if the trend log meter

function is active.
For more information, see section 39.8
“Meter Function” on page 1137.

Meter change time Displays the time when the meter was
changed.

Meter change user Displays the name of the user account

that changed the meter.

End time Displays the time when the old meter

was replaced.

End value Displays the value the old meter had

when it was replaced.

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.

NOTICE
Meter properties are only available if the meter properties of the
connected trend log are active.

7. Click OK
OK.

System 04-30005-01-en, May 2019

1178
 40 Trend Log Functions
40.7 Editing the Threshold Property of an Extended Trend Log

40.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 40.4 “Extended Trend Logs” on page 1171.

To edit the threshold property of an extended trend log

1. In WorkStation, in the System Tree pane, click the extended trend log
whose threshold property you want to edit.
2. In the Extended Trend Log properties, in the Threshold box, select the new
value.

3. Click the Save button .

04-30005-01-en, May 2019 System

1179
40 Trend Log Functions
40.8 Editing the Maximum Transfer Interval Property of an Extended Trend Log

40.8 Editing the Maximum Transfer Interval

Property of an Extended Trend Log
You edit the maximum transfer interval property to establish the time interval
between two transfers.
For more information, see section 40.4 “Extended Trend Logs” on page 1171.

To edit the maximum transfer interval property of an extended

trend log
1. In WorkStation, in the System Tree pane, click the extended trend log
whose maximum transfer interval you want to edit.
2. In the Extended Trend Log properties, in the Maximum transfer interval
box, select the new value.

3. Click the Save button .

System 04-30005-01-en, May 2019

1180
 40 Trend Log Functions
40.9 Editing the Log Size for a Trend Log

40.9 Editing the Log Size 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 40.2 “Log Record Storage” on page 1168.

To edit the log size for a trend log

1. In WorkStation, in the System Tree pane, click the trend log whose log size
you want to edit.
2. In the Extended Trend Log properties, in the Log size box, enter the new
value.

3. Click the Save button .

04-30005-01-en, May 2019 System

1181
40 Trend Log Functions
40.10 Editing an Extended Trend Log to be Included in Reports

40.10 Editing an Extended Trend Log to be

Included in Reports
You edit extended trend logs to be included in reports if you want trend log data
to appear in the reports.
For more information, see the How Reports Work topic on WebHelp.

To edit an extended trend log to be included in reports

1. In WorkStation, in the System Tree pane, click the extended trend log you
want to include in reports.
2. In the Extended Trend Log properties, in the Include in Reports box, select
True
True.

3. Click the Save button .

The extended trend log is set up to be included in reports.

System 04-30005-01-en, May 2019

1182
 40 Trend Log Functions
40.11 Manually Transferring Records to the Extended Trend Log

40.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 40.4 “Extended Trend Logs” on page 1171.

To manually transfer records to the extended trend log

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS 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 and then click Force transfer
transfer.
The monitored trend log is now transferred to the extended trend log.

04-30005-01-en, May 2019 System

1183
40 Trend Log Functions
40.12 Viewing Related Trends

40.12 Viewing Related Trends

You can view the trends related to one or several selected objects or properties.

To view related trends

1. In WorkStation, in the System Tree pane, select the folder containing the
objects whose related trends you want to view.
2. In the List View
View, select the object or objects for which you want to view
related trends.
3. On the Actions menu, point to View and then click Trends
Trends.
4. In the Objects list, select the object whose related trends you want to view.
5. In the Trends list, select the trend you want to view.
6. Click Open
Open.
The selected trend opens the WorkStation work area.

System 04-30005-01-en, May 2019

1184
 40 Trend Log Functions
40.13 Viewing Related Trends for Properties Bound to a Graphic

40.13 Viewing Related Trends for Properties

Bound to a Graphic
You can view the trends related to one or several properties bound to, for
example, components in a graphic or elements in a graphic group.

To view related trends for properties bound to a graphic

1. In WorkStation, in the System Tree pane, select the graphic containing the
bound properties whose related trends you want to view.
2. In the Graphic View, right-click the component or element in the graphic
bound to the properties.
3. Point to View and then click Trends
Trends.
4. In the Objects list, select the object whose related trends you want to view.
5. In the Trends list, select the trend you want to view.
6. Click Open
Open.
The selected trend opens in the WorkStation work area.

04-30005-01-en, May 2019 System

1185
41 Trend Charts

Topics
Trend Charts
Creating a Trend Chart that Monitors a Variable in Real-
Time
Creating a Trend Chart that Monitors a Trend Log Series
Configuring a Trend Chart
Attaching a Calculation Method to a Trend Chart Series
Showing Trend Chart Grid Lines
Trend Series
Adding a Trend Log Series to a Trend Chart
Adding a Real-Time Trend Series to a Trend Chart
Trend Chart Axes
Editing the Trend Chart Settings
Manually Configuring the Y-Axis Scale
Configuring the X-Axis with a Relative Time Span
Configuring the X-Axis with an Absolute Time Span
Automatically Configuring the Y-Axis Scale
Scrolling the Trend Chart X-Axis to the Current Time
Assigning a Series to a Y-Axis
Real-Time Plotting
Creating a Real-Time Plot Trend Chart
41 Activating Trend Chart Live Update
Time Zone Modes in a Trend Chart
Configuring the Trend Chart Time Zone
Temporary Trend Charts
Viewing a Trend Log in a Temporary Trend Chart
Saving a Temporary Trend Chart
Viewing a Trend Chart in a Multi Trend Log List
Floating Point Values NaN, INF, and –INF
 41 Trend Charts
41.1 Trend Charts

41.1 Trend Charts

A trend chart displays the records of a trend log or an extended trend log as a
series.
A trend chart series that presents a trend log is automatically updated with the
latest records, if Live update in WorkStation or Automatic scroll in WebStation 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. The calculation function
supports negative consumption values, which can be used to handle cases
where you need to subtract consumption for, for example, energy produced on
site.

04-30005-01-en, May 2019 System

1189
41 Trend Charts
41.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-30005-01-en, May 2019

1190
 41 Trend Charts
41.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.

04-30005-01-en, May 2019 System

1191
41 Trend Charts
41.1 Trend Charts

If two extended trend logs are connected between the trend log and the trend
chart, the transfer that occurs when a trend chart presents records live only
transfers the records from the nearest extended trend log. The transfer threshold
rate between the trend log and the first connected trend log remains unaffected.

System 04-30005-01-en, May 2019

1192
 41 Trend Charts
41.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.

04-30005-01-en, May 2019 System

1193
41 Trend Charts
41.1 Trend Charts

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

1194
 41 Trend Charts
41.1 Trend Charts

Dynamic Trend Chart Title

Trend charts support relative property references for the trend chart title. You
can reuse the trend chart and have the trend chart title dynamically changed
depending on where you paste a copy, make a duplicate, import, or move the
trend chart. The Chart title property of the trend chart is the first part of the trend
chart title and the Description property of the trend chart is the last part of the
trend chart title. For example, in a relative property reference: '../../NAME' where
'../' represents a folder or container object.
If the Chart title property is empty or contains an unresolved reference, the trend
chart object name is the first part of the trend chart title.
The trend chart title is visible in trend chart printouts.

41.1.1 Trend Chart Series

In a trend chart, a series can be presented as a line, discrete line, digital, or
bars. In a trend chart, series can be presented in different colors and with
different line weights.
In WorkStation, in a multi trend log list, series are presented as text and can be
exported to .XML or .CSV.
For more information, see section 41.7 “Trend Series” on page 1204.

41.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 41.10 “Trend Chart Axes” on page 1208.

41.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 the Trend Chart Axes in WebStation topic on
WebHelp.

41.1.4 Real-Time Plotting

The real-time plot is a variable displayed directly in the trend chart. The real-time
plot is an instant reflection of the variable, so the history of the real-time plot is
lost when the trend chart is closed. However, the history is not lost for I/O points
that have implicit logs where approximately 500 records of history are displayed.
For more information, see section 41.18 “Real-Time Plotting” on page 1217.

04-30005-01-en, May 2019 System

1195
41 Trend Charts
41.1 Trend Charts

41.1.5 Time Zone Modes in a Trend Chart

In a trend chart, you can present the records of a trend log in different time
zones: local time or a predefined time zone.
For more information, see section 41.21 “Time Zone Modes in a Trend Chart” on
page 1220.

41.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 42.7 “Calculation Methods” on page 1247.

41.1.7 Period Timestamps in Trend Charts and

Trend Log Lists
When a calculated value for a period is presented, the middle of the period is
used as the timestamp.
Example:
The calculated value for the period 8:00-9:00 is stamped 8:30. If there is a value
at 9:01, the next period is 9:00-10:00, which is stamped as 9:30. The full period
may not have passed yet, but the value can be presented even if parts of the
period are in the future.

41.1.8 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 41.23 “Temporary Trend Charts” on page
1224.

41.1.9 Multi Trend Log Lists

You can view a trend chart in a multi trend log list to be able to export it and print
it. The trend chart series settings and calculation are retained in the multi trend
log list.
For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

System 04-30005-01-en, May 2019

1196
 41 Trend Charts
41.1 Trend Charts

41.1.10 Floating Point Values NaN, INF, and –INF

In the EcoStruxure Building Operation software, the floating point values “Not a
Number”, positive infinity, or negative infinity may be displayed in the Basic
property tab, in a trend log list, or a trend chart.
For more information, see section 41.27 “Floating Point Values NaN, INF, and
–INF” on page 1228.

04-30005-01-en, May 2019 System

1197
41 Trend Charts
41.2 Creating a Trend Chart that Monitors a Variable in Real-Time

41.2 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 41.18 “Real-Time Plotting” on page 1217.

To create a trend chart that monitors a variable in real-time

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS server where you want to create the trend chart.
2. On the File menu, point to New and then click Trend
Trend.
3. In the Create Object wizard, in the object type list, 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.
7. In the Configure Trend Chart page, 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 the Add button.

12. In the Create Object wizard, in the object type list, 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 Configure Real-time Trend Series page, 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.
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.

System 04-30005-01-en, May 2019

1198
 41 Trend Charts
41.3 Creating a Trend Chart that Monitors a Trend Log Series

41.3 Creating a Trend Chart that Monitors a

Trend Log Series
You create a trend chart that monitors trend log series.
For more information, see section 41.1 “ Trend Charts” on page 1189.

To Create a trend chart that monitors a trend log series

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS server where you want to create the trend chart.
2. On the File menu, point to New and then click Trend
Trend.
3. In the Create Object wizard, 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.
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.
12. In the Create Object wizard, 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 Configure Trend Log Series page, 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.
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-30005-01-en, May 2019 System

1199
41 Trend Charts
41.4 Configuring a Trend Chart

41.4 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 41.1 “ Trend Charts” on page 1189.

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. In the properties dialog box, click the Basic tab.
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.

Show grid lines for X-axis Select True to show grid lines for the x-
axis.

Chart title Enter the property reference or relative

property reference to the folder or other
container whose name you want to
include in the trend chart title.

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.

System 04-30005-01-en, May 2019

1200
 41 Trend Charts
41.4 Configuring a Trend Chart

Continued
Property Description

Right y-axis maximum Enter the maximum value of the right y-

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 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
Click to edit a selected series. For more
information, see section 44.26 “Trend
Chart Series Properties” on page 1318.

Remove
Click to remove a selected series.

5. Click the Series tab.

6. Edit the series properties.
7. Click OK
OK.

04-30005-01-en, May 2019 System

1201
41 Trend Charts
41.5 Attaching a Calculation Method to a Trend Chart Series

41.5 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 42.7 “Calculation Methods” on page 1247.

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. In the Trend Chart Settings dialog box, 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.
7. In the Period box, select the time span for which the calculation method is
to be executed.

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

System 04-30005-01-en, May 2019

1202
 41 Trend Charts
41.6 Showing Trend Chart Grid Lines

41.6 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 44.23 “Trend Chart Settings Dialog Box – Axes
Tab” on page 1313.

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.

04-30005-01-en, May 2019 System

1203
41 Trend Charts
41.7 Trend Series

41.7 Trend Series

In a trend chart, a series can be presented as a line, discrete line, digital, or
bars. In a trend chart, series can be presented in different colors and with
different line weights.
In WorkStation, in a multi trend log list, series are presented as text and can be
exported to .XML or .CSV.

Figure: Types of series presentation, schematic

To make reading easier in a trend chart, records can be presented with markers.
Markers can only be shown for lines and discrete lines, not for digital or bars.

System 04-30005-01-en, May 2019

1204
 41 Trend Charts
41.7 Trend Series

Figure: Presentation with markers, schematic

04-30005-01-en, May 2019 System

1205
41 Trend Charts
41.8 Adding a Trend Log Series to a Trend Chart

41.8 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 41.7 “Trend Series” on page 1204.

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

1206
 41 Trend Charts
41.9 Adding a Real-Time Trend Series to a Trend Chart

41.9 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 41.7 “Trend Series” on page 1204.

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. In the Trend Chart Properties dialog box, under Series Configuration

Settings
Settings, click the Add button .
4. In the Create Object wizard, 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.
8. In the Configure Real-time Trend Series page, 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.
11. Click Create
Create.
12. Click OK
OK.

04-30005-01-en, May 2019 System

1207
41 Trend Charts
41.10 Trend Chart Axes

41.10 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

System 04-30005-01-en, May 2019

1208
 41 Trend Charts
41.10 Trend Chart Axes

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.

Figure: Grid lines, schematic

04-30005-01-en, May 2019 System

1209
41 Trend Charts
41.11 Editing the Trend Chart Settings

41.11 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 41.10 “Trend Chart Axes” on page 1208.

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. In the Trend Chart Settings dialog box, edit the trend chart settings.
4. Click OK
OK.

System 04-30005-01-en, May 2019

1210
 41 Trend Charts
41.12 Manually Configuring the Y-Axis Scale

41.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 41.10 “Trend Chart Axes” on page 1208.

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. In the Trend chart settings dialog box, 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.

04-30005-01-en, May 2019 System

1211
41 Trend Charts
41.13 Configuring the X-Axis with a Relative Time Span

41.13 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 41.10 “Trend Chart Axes” on page 1208.

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. In the trend chart view, on the toolbar, click Open trend chart settings

button .
3. In the Trend chart settings dialog box, 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-30005-01-en, May 2019

1212
 41 Trend Charts
41.14 Configuring the X-Axis with an Absolute Time Span

41.14 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 41.10 “Trend Chart Axes” on page 1208.

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. In the trend chart view, on the toolbar, click the Open trend chart settings

button .
3. In the Trend chart settings dialog box, 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-30005-01-en, May 2019 System

1213
41 Trend Charts
41.15 Automatically Configuring the Y-Axis Scale

41.15 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 41.10 “Trend Chart Axes” on page 1208.

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. In the Trend Chart Settings dialog box, 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.

System 04-30005-01-en, May 2019

1214
 41 Trend Charts
41.16 Scrolling the Trend Chart X-Axis to the Current Time

41.16 Scrolling 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 41.10 “Trend Chart Axes” on page 1208.

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 Current time button .
The trend chart displays the trend chart with the client’s current time as the
rightmost x-axis point.

04-30005-01-en, May 2019 System

1215
41 Trend Charts
41.17 Assigning a Series to a Y-Axis

41.17 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 41.10 “Trend Chart Axes” on page 1208.

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. In the Trend Chart Settings dialog box, 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-30005-01-en, May 2019

1216
 41 Trend Charts
41.18 Real-Time Plotting

41.18 Real-Time Plotting

The real-time plot is a variable displayed directly in the trend chart. The real-time
plot is an instant reflection of the variable, so the history of the real-time plot is
lost when the trend chart is closed. However, the history is not lost for I/O points
that have implicit logs where approximately 500 records of history are displayed.

Figure: Real-time plot, schematic

A real-time plot trend chart updates and draws a solid series each time it
registers that the variable has a new value. If the variable remains on the same
value, the series is drawn as a dotted line.
When you save a real-time plot trend chart, a trend chart object is created that
you can reach from the System Tree pane.

NOTICE
• A real-time plot can only be displayed in a trend chart and not in a trend log
list.

04-30005-01-en, May 2019 System

1217
41 Trend Charts
41.19 Creating a Real-Time Plot Trend Chart

41.19 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 41.18 “Real-Time Plotting” on page 1217.

To create a real-time plot trend chart

1. In WorkStation, in the System Tree pane, select the variable you want to
display in a real-time plot trend chart.
2. On the Actions menu, point to View and then click New Trend chart.

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.

System 04-30005-01-en, May 2019

1218
 41 Trend Charts
41.20 Activating Trend Chart Live Update

41.20 Activating Trend Chart Live Update

You activate the live update of a trend chart to automatically update the trend
chart with the latest records.
For more information, see section 41.1 “ Trend Charts” on page 1189.

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. In the Trend Chart View, in the navigation bar, select Live update
update.

04-30005-01-en, May 2019 System

1219
41 Trend Charts
41.21 Time Zone Modes in a Trend Chart

41.21 Time Zone Modes in a Trend Chart

In a trend chart, you can present the records of a trend log in different time
zones: local time or a predefined time zone.
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 SmartX server time, time zone, and DST, you have to access the
SmartX server through a WorkStation.

41.21.1 Local Time

A trend chart presented in Local time displays trend logs with time stamps
adjusted for the client computer time zone.
The client computer does not consider the local time of the EcoStruxure BMS
server where the variable is logged. The same variable logged on EcoStruxure
BMS servers in different time zones is displayed with matching time stamps for
corresponding values.

System 04-30005-01-en, May 2019

1220
 41 Trend Charts
41.21 Time Zone Modes in a Trend Chart

Figure: Local time zone, schematic

41.21.2 Predefined Time Zone

A trend chart presented in a predefined time zone displays trend logs in the time
of the selected time zone regardless of where the EcoStruxure BMS server is
located.
The same variable logged on EcoStruxure BMS servers in different time zones
are displayed with adjusted time stamps for corresponding values. Use
predefined time zone when you need to compare trend logs on EcoStruxure
BMS servers located in different time zones.

04-30005-01-en, May 2019 System

1221
41 Trend Charts
41.21 Time Zone Modes in a Trend Chart

Figure: Predefined time zone, schematic

System 04-30005-01-en, May 2019

1222
 41 Trend Charts
41.22 Configuring the Trend Chart Time Zone

41.22 Configuring the Trend Chart Time Zone

You display the time of the records in local time, server time, or in the time of a
predefined time zone. By changing the time zone settings you make it easier to
interpret the time stamp.
For more information, see section 41.21 “Time Zone Modes in a Trend Chart” on
page 1220.

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. In the trend chart view, on the toolbar, click the Open trend chart settings

button .
3. In the Trend Chart Settings dialog box, in the Time zone box, select a time
zone to display the trend chart time stamps in:
• Select Local time to display the time stamps in real time from the
perspective of the client.
• Select a predfined time zone to display the time stamps in real time
from the perspective of the selected time zone.
4. Click OK
OK.
The x-axis is now set according to the selected time zone.

04-30005-01-en, May 2019 System

1223
41 Trend Charts
41.23 Temporary Trend Charts

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

Figure: Trend log displayed in a temporary trend log list and temporary trend chart

NOTICE
You have to manually refresh the trend log list.

System 04-30005-01-en, May 2019

1224
 41 Trend Charts
41.24 Viewing a Trend Log in a Temporary Trend Chart

41.24 Viewing a Trend Log in a Temporary

Trend Chart
You open a trend log as a temporary trend chart to view the recorded values
graphically. When you close the temporary trend chart, the chart is not saved.
For more information, see section 41.23 “Temporary Trend Charts” on page
1224.

To view a trend log in a temporary trend chart

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS 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 the View submenu and then click In Trend
Chart
Chart.
The temporary trend chart is displayed in the work area under a generic name.

04-30005-01-en, May 2019 System

1225
41 Trend Charts
41.25 Saving a Temporary Trend Chart

41.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-30005-01-en, May 2019

1226
 41 Trend Charts
41.26 Viewing a Trend Chart in a Multi Trend Log List

41.26 Viewing a Trend Chart in a Multi Trend

Log List
You view a trend chart in a multi trend log list to be able to export the
information.
For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

To view a trend chart in a multi trend log list

1. In WorkStation, in the System Tree pane, select the trend chart you want to
view in a multi trend log list.

2. On the trend chart toolbar, click the View in multi trend log list button .
The trend chart is displayed in one single multi trend log list that you can export
to an .XML or a .CSV file.

04-30005-01-en, May 2019 System

1227
41 Trend Charts
41.27 Floating Point Values NaN, INF, and –INF

41.27 Floating Point Values NaN, INF, and

–INF
In the EcoStruxure Building Operation software, the floating point values “Not a
Number”, positive infinity, or negative infinity may be displayed in the Basic
property tab, in a trend log list, or a trend chart.
The IEEE standard for Floating-point Arithmetic representation is used for these
values:
NaN: A floating point value meaning “Not a Number”. Support for NaN is
provided for interoperability with other devices or systems that produce NaN
values.
Positive Infinity or Negative Infinity: Floating point value, sometimes represented
as Infinity, –Infinity, INF, or –INF. Support for positive and negative infinity is
provided for interoperability with other devices or systems that produce these
values.
For more information, see Institute of Electrical and Electronics Engineers
document IEEE 754.

41.27.1 Basic Property Tab and Watch Window

Certain object properties may display values representing “Not a Number”,
positive infinity, or negative infinity. These values are displayed in accordance
with the localization settings, observing capitalization and sign (positive or
negative). The presentations of these values with English localization are shown
in the table and examples below.

Table: Display of Values

Value Property Tab Presentation Watch Window
Presentation

Not a Number NaN NaN

Positive Infinity Infinity Infinity

Negative Infinity –Infinity –Infinity

In the Basic Property Tab

You can view property values representing “Not a Number”, positive infinity, or
negative infinity in the Basic property tab.

System 04-30005-01-en, May 2019

1228
 41 Trend Charts
41.27 Floating Point Values NaN, INF, and –INF

Figure: Example of NaN, Infinity, or –Infinity Value Displayed in Basic Property Tab

In the Watch Window

You can monitor property values representing “Not a Number”, positive infinity,
or negative infinity in the Watch Window.

Figure: Example of NaN, Infinity, or –Infinity Value Displayed in Watch Window

41.27.2 Trends
Property values representing “Not a Number”, positive infinity, or negative
infinity can be trended and displayed in the trend log and trend chart. The
presentations of these values with English localization are shown in the table
and examples below.

Table: Presentation of Values

Value Trend Log Presentation Trend Chart Presentation

Not a Number NaN NaN

Positive Infinity Infinity INF

Negative Infinity –Infinity –INF

In the Trend Log List

You can view the trend data in a trend log list. For more information, see section
42.1 “Trend Log Lists” on page 1237.

04-30005-01-en, May 2019 System

1229
41 Trend Charts
41.27 Floating Point Values NaN, INF, and –INF

Figure: NaN, Infinity, and –Infinity Displayed in Trend Log List

In Trend Charts
You can view the trend data in a trend chart. For more information, see section
41.1 “ Trend Charts” on page 1189.
When you select the Line option for a trend chart, the values are plotted on a line
and displayed as abbreviations. You can view the complete value by hovering
the pointer over any of these values. In the example that follows, the trend chart
settings are set to Show markers so that it is easier to read the chart.

System 04-30005-01-en, May 2019

1230
 41 Trend Charts
41.27 Floating Point Values NaN, INF, and –INF

Figure: NaN, Infinity, and –Infinity Displayed in Trend Chart

Component Displayed Value Tool Tip

INF

–INF

NaN

The same series can be presented in different ways by selecting the Discrete
Line
Line, Digital
Digital, or Bars option, as shown in the following examples. For more
information, see section 41.7 “Trend Series” on page 1204.

04-30005-01-en, May 2019 System

1231
41 Trend Charts
41.27 Floating Point Values NaN, INF, and –INF

Figure: Trend Chart with Discrete Line Display Option Selected

System 04-30005-01-en, May 2019

1232
 41 Trend Charts
41.27 Floating Point Values NaN, INF, and –INF

Figure: Trend Chart with Digital Display Option Selected

04-30005-01-en, May 2019 System

1233
41 Trend Charts
41.27 Floating Point Values NaN, INF, and –INF

Figure: Trend Chart with Bars Display Option Selected

System 04-30005-01-en, May 2019

1234
42 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
Viewing a Trend Log in a Temporary Trend Log List
Saving a Temporary Trend Log List
 42 Trend Log Lists
42.1 Trend Log Lists

42.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-30005-01-en, May 2019 System

1237
42 Trend Log Lists
42.1 Trend Log Lists

Figure: Trend log list, schematic

You can manually add records to a trend log list for any type of trend log.

System 04-30005-01-en, May 2019

1238
 42 Trend Log Lists
42.1 Trend Log Lists

42.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, EcoStruxure BMS server time zone, and UTC time zone.
For more information, see section 42.4 “Time Zone Modes in a Trend Log List”
on page 1242.

42.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 42.7 “Calculation Methods” on page 1247.

42.1.3 Period Timestamps in Trend Charts and

Trend Log Lists
When a calculated value for a period is presented, the middle of the period is
used as the timestamp.
Example:
The calculated value for the period 8:00-9:00 is stamped 8:30. If there is a value
at 9:01, the next period is 9:00-10:00, which is stamped as 9:30. The full period
may not have passed yet, but the value can be presented even if parts of the
period are in the future.

42.1.4 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 42.9 “Temporary Trend Log Lists” on page
1254.

42.1.5 Floating Point Values NaN, INF, and -INF

In the EcoStruxure Building Operation software, the floating point values “Not a
Number”, positive infinity, or negative infinity may be displayed in the Basic
property tab, in a trend log list, or a trend chart.
For more information, see section 41.27 “Floating Point Values NaN, INF, and
–INF” on page 1228.

42.1.6

04-30005-01-en, May 2019 System

1239
42 Trend Log Lists
42.2 Creating a Trend Log List

42.2 Creating a Trend Log List

You create a trend log list to display records from a trend log.

NOTICE
• 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 42.1 “Trend Log Lists” on page 1237.

To create a trend log list

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS 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 Create Object wizard, in the object list, select Trend Log List
List.
4. In the Name box, type a name for the trend log list.
5. In the Description box, type a description for the trend log list.
6. Click Next
Next.
7. In the Configure Trend Log List page, in the Display trend log box, enter
the trend log you want to display in the 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-30005-01-en, May 2019

1240
 42 Trend Log Lists
42.3 Configuring a Trend Log List

42.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 42.1 “Trend Log Lists” on page 1237.

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 42.4 “Time Zone Modes in a
Trend Log List” on page 1242.

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 Enter a custom time span for which the

calculation method is to be executed.

Custom period alignment Enter the time when you want the
custom period to start.

4. Click OK
OK.

04-30005-01-en, May 2019 System

1241
42 Trend Log Lists
42.4 Time Zone Modes in a Trend Log List

42.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, EcoStruxure BMS server time zone, and UTC time zone.

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

42.4.2 Server Time Zone

Use server time zone to display in real time from the perspective of the
EcoStruxure BMS 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-30005-01-en, May 2019

1242
 42 Trend Log Lists
42.4 Time Zone Modes in a Trend Log List

Figure: Trend log list displayed on a client with server time zone.

42.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-30005-01-en, May 2019 System

1243
42 Trend Log Lists
42.4 Time Zone Modes in a Trend Log List

Figure: Trend log list displayed on a client with UTC time zone.

System 04-30005-01-en, May 2019

1244
 42 Trend Log Lists
42.5 Displaying the Trend Log List Time Stamps with Fractions

42.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 42.1 “Trend Log Lists” on page 1237.

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

1245
42 Trend Log Lists
42.6 Configuring the Trend Log List Time Zone

42.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 EcoStruxure BMS server. By changing the time
zone settings you make it easier to interpret the time stamp.
For more information, see section 42.4 “Time Zone Modes in a Trend Log List”
on page 1242.

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. In the trend log list view, on the toolbar, click the Open trend log list

settings button .
3. In the properties dialog box, 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 EcoStruxure BMS 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-30005-01-en, May 2019

1246
 42 Trend Log Lists
42.7 Calculation Methods

42.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:
• None
• Maximum
• Minimum
• Average
• Sum
• Delta
• Delta over period
• Meter consumption

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

42.7.1 None
No calculation is performed. The actual values are presented.

42.7.2 Maximum
The maximum value of each period is presented.

04-30005-01-en, May 2019 System

1247
42 Trend Log Lists
42.7 Calculation Methods

Figure: Maximum calculation method, schematic

NOTICE
If the log point is offline or no value is produced during the interval, no value is
displayed.

42.7.3 Minimum
The minimum value of each period is presented.

System 04-30005-01-en, May 2019

1248
 42 Trend Log Lists
42.7 Calculation Methods

Figure: Minimum calculation method, schematic

NOTICE
If the log point is offline or no value is produced during the interval, no value is
displayed.

42.7.4 Average
The average of the values in each period is calculated and presented.

04-30005-01-en, May 2019 System

1249
42 Trend Log Lists
42.7 Calculation Methods

Figure: Average calculation method, schematic

NOTICE
If the log point is offline or no value is produced during the interval, no value is
displayed.

42.7.5 Sum
The sum of the values in each period is calculated and presented.

System 04-30005-01-en, May 2019

1250
 42 Trend Log Lists
42.7 Calculation Methods

Figure: Sum calculation method, schematic

42.7.6 Delta
The change to the previous value is calculated and presented.

Figure: Delta calculation method, schematic

04-30005-01-en, May 2019 System

1251
42 Trend Log Lists
42.7 Calculation Methods

42.7.7 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

42.7.8 Meter Consumption

Meter consumption is a delta over period calculation with meter functionality. For
more information, see section 39.8 “Meter Function” on page 1137.

42.7.9 Period Timestamps in Trend Charts and

Trend Log Lists
When a calculated value for a period is presented, the middle of the period is
used as the timestamp.
Example:
The calculated value for the period 8:00-9:00 is stamped 8:30. If there is a value
at 9:01, the next period is 9:00-10:00, which is stamped as 9:30. The full period
may not have passed yet, but the value can be presented even if parts of the
period are in the future.

System 04-30005-01-en, May 2019

1252
 42 Trend Log Lists
42.8 Attaching a Calculation Method to a Trend Log List

42.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 42.7 “Calculation Methods” on page 1247.

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 Trend Log List properties, 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.
5. In the Period box, select the time span for which the calculation method is
to be executed.

NOTICE
• 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-30005-01-en, May 2019 System

1253
42 Trend Log Lists
42.9 Temporary Trend Log Lists

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

Figure: Trend log displayed in a temporary trend log list and temporary trend chart

NOTICE
You have to manually refresh the trend log list.

System 04-30005-01-en, May 2019

1254
 42 Trend Log Lists
42.10 Viewing a Trend Log in a Temporary Trend Log List

42.10 Viewing a Trend Log in a Temporary

Trend Log List
You open a trend log in a temporary trend log list to view the recorded values in
a list. When you close the temporary trend log list, the list is not saved.
For more information, see section 42.9 “Temporary Trend Log Lists” on page
1254.

To view a trend log in a temporary trend log list

1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS server where the trend log is located.
2. Select the trend log you want to open as a temporary trend log list.
3. On the Actions menu, point to View and then click In Trend Log List
List.
(In FM: TaskClosing) The trend log list is displayed in the work area under a
generic name.

04-30005-01-en, May 2019 System

1255
42 Trend Log Lists
42.11 Saving a Temporary Trend Log List

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

System 04-30005-01-en, May 2019

1256
43 Multi Trend Log Lists

Topics
Multi Trend Log Lists
Creating a Multi Trend Log List
Configuring a Multi Trend Log List
Adding a Trend Log to a Multi Trend Log List
Configuring a Trend Log Series in a Multi Trend Log List
Removing a Trend Log from a Multi Trend Log List
Exporting a Multi Trend Log List to .XML
Exporting a Multi Trend Log List to .CSV
Viewing Trend Logs in a Temporary Multi Trend Log List
Saving a Temporary Multi Trend Log List
Saving a Multi Trend Log List Standard Layout
 43 Multi Trend Log Lists
43.1 Multi Trend Log Lists

43.1 Multi Trend Log Lists

You configure a multi trend log list to display values from multiple trend logs in
one list. You compare values in a multi trend log list when you commission or
validate an EcoStruxure BMS.
For example, on a b3 BACnet device, there are two inputs: SpaceTemp and
SpaceHumidity. Both inputs have logs set up intrinsically. You want to print the
last 3 days of history for these inputs. You create a multi trend log list for both
inputs. You can export the multi trend log list to a .CSV file or an .XML and then
use an external editor to compare the values.
If a trend log has no available value for a given time stamp in a multi trend log
list, then the trend log displays an empty cell for that specific time. You can fill
that empty cell with the latest known value.
You can change the column order in the multi trend log list and save the change.
You can add, edit, or remove trend logs from the multi trend log list at any time.
You can also edit how trend logs are displayed in the multi trend log list. For
more information, see section 43.5 “Configuring a Trend Log Series in a Multi
Trend Log List ” on page 1264.

NOTICE
You can add a trend log to a multi trend log list using drag and drop.

You can configure the individual trend log series in a multi trend log list.

NOTICE
All configurations on individual trend log series are overriden if you configure
the multi trend log list.

Temporary multi trend log list

You can view a group of trend log lists in a atemporary multi trend log list without
creating a multi trend log list. For more information, see section 43.9 “Viewing
Trend Logs in a Temporary Multi Trend Log List ” on page 1268.

43.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, EcoStruxure BMS server time zone, and UTC time zone.
For more information, see section 42.4 “Time Zone Modes in a Trend Log List”
on page 1242.

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

04-30005-01-en, May 2019 System

1259
43 Multi Trend Log Lists
43.1 Multi Trend Log Lists

For more information, see section 42.7 “Calculation Methods” on page 1247.

NOTICE
If you have selected a calculation method on a series, event icons are not
displayed on that series in the multi trend log list.

43.1.3 Floating Point Values NaN, INF, and -INF

In the EcoStruxure Building Operation software, the floating point values “Not a
Number”, positive infinity, or negative infinity may be displayed in the Basic
property tab, in a trend log list, or a trend chart.
For more information, see section 41.27 “Floating Point Values NaN, INF, and
–INF” on page 1228.

System 04-30005-01-en, May 2019

1260
 43 Multi Trend Log Lists
43.2 Creating a Multi Trend Log List

43.2 Creating a Multi Trend Log List

You create a multi trend log list to display values from multiple trend logs in one
list so that you can compare the values, for example, when commissioning or
validating an EcoStruxure BMS.
For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

To create a Multi Trend Log List

1. In WorkStation, in the System Tree pane, select the location where you
want to create the multi trend log list.
2. On the File menu, point to New and then click Trend
Trend.
3. In the Create Object wizard, in the object type list, select Multi Trend Log
List
List.
4. In the Name box, type a name for the multi trend log list.
5. In the Description box, type a description for the multi trend log list.
6. Click Next
Next.
7. In the Configure Multi Trend Log List page, in the Log space (records)
box, enter the maximum number of rows to display in the multi trend log list.

8. In the Series box, click the Add button to add a trend log to the multi
trend log list.
9. In the Name box, type a name for the trend series based on the added
trend log.
10. In the Description box, type a description for the trend series.
11. Click Next
Next.
12. In the Display trend log box, enter the path to the trend log you want to add
to the multi trend log list.
13. Click Create
Create.

14. In the Series box, click the Add button to add another trend log to the
multi trend log list.

15. In the Series box, select a trend series and then click the Edit button
to edit how the trend series is displayed.

16. In the Series box, click the Remove button to remove a trend series
from the multi trend log list.
17. Click Create
Create.
The multi trend log list displays values from the trend logs you have added to the
multi trend log list.

04-30005-01-en, May 2019 System

1261
43 Multi Trend Log Lists
43.3 Configuring a Multi Trend Log List

43.3 Configuring a Multi Trend Log List

You configure a multi trend log list to display values from multiple trend logs in
one list so that you can compare the values, for example, when commissioning
or validating an EcoStruxure BMS.

NOTICE
When you configure a multi trend log list, the changes override all
configurations on the individual trend log series in the multi trend log list.

For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

To configure a Multi Trend Log List

1. In WorkStation, in the System Tree pane, select the multi trend log list you
want to configure.

2. Click the Open multi trend log list settings button .

3. Configure the properties on the General tab.
Property Description

Log space (records) Select the maximum number of records

to display in the list.

Time zone Select the time zone in which the log

records are presented.

Calculation method Select a calculation method.

For more information, see section 42.7
“Calculation Methods” on page 1247.

Delta over period Select True to apply a period to the

delta calculation method.
For more information, see section 42.7
“Calculation Methods” on page 1247.

Period Select the time span for which the

calculation method is to be executed.

Custom period Enter a custom time span for which the

calculation method is to be executed.

Custom period alignment Enter the time when you want the
custom period to start.

4. Click OK
OK.

System 04-30005-01-en, May 2019

1262
 43 Multi Trend Log Lists
43.4 Adding a Trend Log to a Multi Trend Log List

43.4 Adding a Trend Log to a Multi Trend

Log List
You add a trend log to a multi trend log list to display values from the trend log
and compare them to values of other trend logs already in the multiple trend
logs list, for example, when commissioning or validating an EcoStruxure BMS.
For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

To add a trend log to a multi trend log list

1. In WorkStation, in the System Tree pane, select the multi trend log list to
which you want to add a trend log.
2. Locate the trend log you want to add and drag it to the multi trend log list.

3. Click the Save button .

04-30005-01-en, May 2019 System

1263
43 Multi Trend Log Lists
43.5 Configuring a Trend Log Series in a Multi Trend Log List

43.5 Configuring a Trend Log Series in a

Multi Trend Log List
You configure an individual trend log series in a multi trend log list to change
how the values of the trend log series are presented in the multi trend log list.

NOTICE
When you edit an individual trend log series, the changes are overridden by
any configuration on the multi trend log list.

For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

To configure a trend log series in a multi trend log list

1. In WorkStation, in the System Tree pane, select the multi trend log list
containing the individual trend log series whose properties you want to edit.
2. In the Multi trend log list viewer, on the toolbar, click the Open multi trend

log list settings button .

3. In the Multi Trend Log List Settings dialog box, click the Series tab.
4. Edit the series properties:
Property Description

Data series Select the individual trend log series

whose properties you want to edit.

Display trend log Displays the selected trend log in the

Data series list.

Calculation method Select a calculation method.

For more information, see section 42.7
“Calculation Methods” on page 1247.

Delta over period Select True to apply a period to the

delta calculation method.
For more information, see section 42.7
“Calculation Methods” on page 1247.

Period Select the time span for which the

calculation method is to be executed.

Custom period Enter a custom time span for which the

calculation method is to be executed.

Custom period alignment Enter the time when you want the
custom period to start.

5. Click OK
OK.

System 04-30005-01-en, May 2019

1264
 43 Multi Trend Log Lists
43.6 Removing a Trend Log from a Multi Trend Log List

43.6 Removing a Trend Log from a Multi

Trend Log List
You remove a trend log from a multi trend log list when you no longer want to
compare the values of the trend log to other trends logs in the multi trend log list.
For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

To remove a trend log from a multi trend log list

1. In WorkStation, in the System Tree pane, select the multi trend log list
containing the individual trend log you want to remove.

2. Click the Open multi trend log list settings button .

3. In the Multi Trend Log Settings dialog box, click the Series tab.
4. Select the trend log series you want to remove.

5. Click the Remove button .

6. Click OK
OK.

04-30005-01-en, May 2019 System

1265
43 Multi Trend Log Lists
43.7 Exporting a Multi Trend Log List to .XML

43.7 Exporting a Multi Trend Log List to

.XML
You export a multi trend log list to view the multi trend log list in an editor that
opens the .XML format.
For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

To export a multi trend log list to .XML

1. In WorkStation, in the System Tree pane, select the multi trend log list you
want to export to .XML.

2. Click the Export to .XML button.

3. Select where to save the .XML file.
4. Click Save
Save.
The .XML file is saved in the selected location and can be opened from an editor
that can read .XML files.

System 04-30005-01-en, May 2019

1266
 43 Multi Trend Log Lists
43.8 Exporting a Multi Trend Log List to .CSV

43.8 Exporting a Multi Trend Log List to

.CSV
You export a multi trend log list to view the multi trend log list in an editor that
opens the comma separated .CSV format.
For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

To export a multi trend log list to .CSV

1. In WorkStation, in the System Tree pane, select the multi trend log list you
want to export to .CSV.

2. Click the Export to .CSV button .

3. Select where to save the .CSV file.
4. Click Save
Save.
The .CSV file is saved in the selected location and can be opened from an editor
that can read .CSV files.

04-30005-01-en, May 2019 System

1267
43 Multi Trend Log Lists
43.9 Viewing Trend Logs in a Temporary Multi Trend Log List

43.9 Viewing Trend Logs in a Temporary

Multi Trend Log List
You view trend logs in a temporary multi trend log list to compare the values of
the trend logs in the multi trend log list without saving the multi trend log list for
reuse.
For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

To view trend logs in a temporary multi trend log list

1. In WorkStation, in the System Tree pane, select folder containing the trend
logs you want to view.
2. In the List View, right-click the trend logs you want to view, point to View
View,
and click In Multi Trend Log List
List.
The trend logs are opened in a multi trend log list. If you want to reuse the multi
trend log list, you can save it.

System 04-30005-01-en, May 2019

1268
 43 Multi Trend Log Lists
43.10 Saving a Temporary Multi Trend Log List

43.10 Saving a Temporary Multi Trend Log

List
You save a temporary multi trend log list when you want to reuse the multi trend
log list.
For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

To save a temporary multi trend log list

1. In WorkStation, in the System Tree pane, select folder containing the trend
logs you want to view.
2. In the List View, right-click the trend logs you want to view, point to View
View,
and click In Multi Trend Log List
List.

3. Click the Save button .

The multi trend log list is saved in the folder containing the trends included in the
multi trend log list.

04-30005-01-en, May 2019 System

1269
43 Multi Trend Log Lists
43.11 Saving a Multi Trend Log List Standard Layout

43.11 Saving a Multi Trend Log List Standard

Layout
You save a standard layout to make a change to the multi trend log list available
to all users.
For more information, see section 43.1 “Multi Trend Log Lists” on page 1259.

To save a multi trend log list standard layout

1. In WorkStaton, in the multi trend log list view, drag to move a column to a
new position.
2. Right-click anywhere in the multi trend log list and then click Save as
standard layout
layout.
The standard layout is overwritten when you save other configurations made to
the multi trend log list.

System 04-30005-01-en, May 2019

1270
44 Trends User interface

Topics
Trend Log System Tree Icons
Actions Menu – Activation Submenu
Actions Menu – View Submenu
Actions Menu – Modification Submenu
Change of Value Trend Log Properties – Basic Tab
Interval Trend Log Properties – Basic Tab
Manual Trend Log Properties – Basic Tab
Variable Triggered Trend Log Properties – Basic Tab
Extended Trend Log Properties – Basic Tab
Change of Value Trend Log Properties – Meter Info Tab
Interval Trend Log Properties – Meter Info Tab
Manual Trend Log Properties – Meter Info Tab
Variable Triggered Trend Log Properties – Meter Info Tab
Extended Trend Log Properties – Meter Info Tab
Manage Replacement of Meter Dialog Box
Meter Change History Dialog Box
Trend Chart Properties
Trend Chart View
Trend Chart Toolbar
Trend Chart Event Icons
44 Trend Chart Navigation Bar
Series Tab Context 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 Properties
Trend Log List View
Trend Log List Toolbar
Trend Log List Event Icons
Trend Log List – Log Info View
Trend Log List Context Menu
Add/Remove Columns Dialog Box (Trends)
Add Trend Log Record Dialog Box
Edit/Comment Trend Log Record Dialog Box
Edited Value History Dialog Box
Multi Trend Log List Properties - Basic Tab
Multi Trend Log List View
Multi Trend Log List Toolbar
Multi Trend Log Settings Dialog Box – General Tab
Multi Trend Log Settings Dialog Box – Series Tab
Multi Trend Log List Series Properties
Multi Trend Log List Context Menu
Multi Trend Log List Header Context Menu
Create Interval Trend Log Wizard – Configure Interval Trend
Log Page
Create Trend Log Wizard – Configure Change of Value
Trend Log Page
44 Create Variable Triggered Trend Log Wizard – Configure
Variable Triggered Trend Log Page
Create Manual Trend Log Wizard – Configure Manual Log
Page
Create Trend Log Wizard – Initial Meter Settings Page
Create Extended Trend Log Wizard – Configure Extended
Trend Log Page
Create Trend Chart Wizard – Configure Trend Chart Page
Create Trend Chart Wizard – Configure Real-Time Trend
Series Page
Create Trend Chart Wizard – Configure Trend Log Series
Page
Create Trend Log List Wizard – Configure Trend Log List
Page
Create Multi Trend Log Wizard - Configure Multi Trend Log
List Page
Create Trend Log Wizard – Connect Objects to the Trend
Log Page
Create Multi Trend Log List Wizard – Configure Trend Log
Series Page
 44 Trends User interface
44.1 Trend Log System Tree Icons

44.1 Trend Log System Tree Icons

This section describes the icons in WorkStation that relate to trend logs.

Table: Trend Log Icons in WorkStation

Icon Description

Trend log
Indicates the object is a trend log. For
more information, see the Trend Logs topic
on WebHelp.

Trend chart
Indicates the object is a trend chart. For
more information, see section 41.1 “ Trend
Charts” on page 1189.

Trend log list

Indicates the object is a trend log list. For
more information, see section 42.1 “Trend
Log Lists” on page 1237.

04-30005-01-en, May 2019 System

1275
44 Trends User interface
44.2 Actions Menu – Activation Submenu

44.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-30005-01-en, May 2019

1276
 44 Trends User interface
44.3 Actions Menu – View Submenu

44.3 Actions Menu – View Submenu

Use the View submenu to display object related events, temporary trend charts,
or trend log lists.

Figure: Acations menu - View submenu

Table: Actions Menu – View Submenu

Command Description

Contingency log chart Click to display a Contingency Log chart

for a Sigma object. For more information,
see the Viewing a Contingency Log Chart
or List topic on WebHelp.

Contingency log list Click to display a Contingency Log list for a

Sigma object. For more information, see
the Viewing a Contingency Log Chart or
List topic on WebHelp.

Events Click to open an Events pane that displays

the events related to a specific object. For
more information, see section 37.1 “Events
Pane and Event View” on page 1089.

Events in this branch Click to open an Events pane that displays

all events for the selected branch, for
example, a folder. For more information,
see section 36.1 “How Events Work ” on
page 1063.

Trends Click to view related trend objects. For

more information, see section 53.76 “
Objects and Trends Dialog Box” on page
1645.

In Trend Chart Click to open a trend log as a temporary

trend chart. For more information, see
section 41.23 “Temporary Trend Charts”
on page 1224.

In Trend Log List Click to open a trend log as a temporary

trend log list. For more information, see
section 42.9 “Temporary Trend Log Lists”
on page 1254.

Report Click to open a report.

04-30005-01-en, May 2019 System

1277
44 Trends User interface
44.3 Actions Menu – View Submenu

Continued
Command Description

Text Report Click to enable the selection of a Sigma

text report relating to the object selected.
For more information, see the Text Report
View topic on WebHelp.

In Watch pane Use the In Watch pane submenu to select

the property of the variable you want to
monitor. For more information, see section
53.11 “Actions Menu - View Submenu - In
Watch pane Submenu” on page 1571.

System 04-30005-01-en, May 2019

1278
 44 Trends User interface
44.4 Actions Menu – Modification Submenu

44.4 Actions Menu – Modification Submenu

Use the Modification submenu to manually add a trend log record or import
trend log data from an .XML file to a trend log.

Figure: The trend log Actions menu, Modification submenu

Table: Modification Submenu

Command Description

Add log record Click to open the Add trend log record
dialog box where you add values and
comments to a manual trend log. For more
information, see the Manually Adding a
Trend Log Record to a Trend Log topic on
WebHelp..

Import log data Click to open an .XML file and import the
log data to the selected trend log. For more
information, see the Importing Log Data to
a Trend Log topic on WebHelp..

04-30005-01-en, May 2019 System

1279
44 Trends User interface
44.5 Change of Value Trend Log Properties – Basic Tab

44.5 Change of Value Trend Log Properties –

Basic Tab
Use the Basic tab to configure the Change of value trend log.

Figure: Change of value trend log properties - Basic tab

Table: Change of Value Trend Log Properties - Basic Tab

Property Description

Status Displays the status of the trend log.

Enabled Displays True if the trend log is enabled.

Logged variable Enter the variable that you want to log.

Delta Select the minimum value change that

triggers a new record.

Activation variable Enter the variable that makes the trend log
start recording values when the variable is
True
True.
For more information, see section 40.3
“Trend Log Activation” on page 1169.

System 04-30005-01-en, May 2019

1280
 44 Trends User interface
44.5 Change of Value Trend Log Properties – Basic Tab

Continued
Property Description

Activation time Specify the time when the trend log is to

start recording values.
For more information, see section 40.3
“Trend Log Activation” on page 1169.

Maximum log interval Select the maximum time that can pass
between two recordings regardless if the
delta value has been exceeded or not.

Log size Select the number of records to store

before old records are overwritten,
including internal records generated by
the trend log.
For more information, see section 40.2
“Log Record Storage” on page 1168.

Clear when enabled Select True to clear the trend log when it is
enabled.

04-30005-01-en, May 2019 System

1281
44 Trends User interface
44.6 Interval Trend Log Properties – Basic Tab

44.6 Interval Trend Log Properties – Basic

Tab
Use the Basic tab to configure the Interval trend log.

Figure: Interval trend log properties - Basic tab

Table: Interval Trend Log Properties - Basic Tab

Property Description

Status Displays the status of the trend log.

Enabled Displays True if the trend log is enabled.

Logged variable Enter the variable you want to log.

Delta Select the minimum value change that

triggers a new record.
For more information, see section 39.3
“Interval Trend Log Delta” on page 1128.

System 04-30005-01-en, May 2019

1282
 44 Trends User interface
44.6 Interval Trend Log Properties – Basic Tab

Continued
Property Description

Activation variable Enter the variable that makes the trend log
start recording values when the variable is
True
True.
For more information, see section 40.3
“Trend Log Activation” on page 1169.

Activation time Specify the time when the trend log is to

start recording values.
For more information, see section 40.3
“Trend Log Activation” on page 1169.

Interval Type how often to log the variable. The

interval defines the time between two log
records.

Log size Select the number of records to store

before old records are overwritten,
including internal records generated by
the trend log.
For more information, see section 40.2
“Log Record Storage” on page 1168.

Clear when enabled Select True to clear the trend log when it is
enabled.

04-30005-01-en, May 2019 System

1283
44 Trends User interface
44.7 Manual Trend Log Properties – Basic Tab

44.7 Manual Trend Log Properties – Basic

Tab
Use the Basic tab to configure the Manual trend log.

Figure: Manual trend log properties - Basic tab

Table: Manual Trend Log Properties - Basic Tab

Component Description

Unit Enter the unit the trend log stores the

records in.

Click to open the configuration dialog box

where you configure the property.
For more information, see section 53.42
“Configure Dialog Box – Configuration
Tab” on page 1608.

System 04-30005-01-en, May 2019

1284
 44 Trends User interface
44.8 Variable Triggered Trend Log Properties – Basic Tab

44.8 Variable Triggered Trend Log

Properties – Basic Tab
Use the Basic tab to configure the Variable triggered trend log.

Figure: Variable triggered trend log properties - Basic tab

Table: Variable Triggered Trend Log Properties - Basic Tab

Component Description

Status Displays the status of the trend log.

Enabled Displays True if the trend log is enabled.

Logged variable Enter the variable you want to log.

Delta Select the minimum value change that

triggers a new record.

Trigger variable Enter the variable that triggers the trend

log to start recording.

04-30005-01-en, May 2019 System

1285
44 Trends User interface
44.8 Variable Triggered Trend Log Properties – Basic Tab

Continued
Component Description

Trigger condition Select when you want the variable

recorded: when the trigger variable
changes to True, changes to False, or at all
changes.
For more information, see section 39.14
“Variable Triggered Trend Logs” on page
1149.

Log size Select the number of records to store

before old records are overwritten,
including internal records generated by
the trend log.
For more information, see section 40.2
“Log Record Storage” on page 1168.

Clear when enabled Select True to clear the trend log when it is
enabled.

System 04-30005-01-en, May 2019

1286
 44 Trends User interface
44.9 Extended Trend Log Properties – Basic Tab

44.9 Extended Trend Log Properties – Basic

Tab
Use the Basic tab to configure the Extended trend log.

Figure: Extended Trend Log properties - Basic Tab

Table: Extended Trend Log Properties - Basic Tab

Component Description

Monitored trend log Enter the path to the trend log you want to
transfer records from.

Unit The unit of an extended trend log created

from the trend log wizard at the same time
as the connected trend log inherits the unit
of measurement from the connected trend
log.
The unit of an extended trend log that is
manually connected to a trend log needs
to be manually configured to use the same
unit of measurement as the connected
trend log.

04-30005-01-en, May 2019 System

1287
44 Trends User interface
44.9 Extended Trend Log Properties – Basic Tab

Continued
Component Description

Smart log Select True to optimize the transfer of the

monitored trend log to the extended trend
log.

Threshold Select the percentage threshold at which

the trend log transfers its records to the
extended trend log.

Maximum transfer interval Select the maximum length of time that can
pass between transfers from the monitored
trend log to the extended trend log.

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 40.4
“Extended Trend Logs” on page 1171.

Log size Select the number of records to store

before old records are overwritten,
including internal records generated by
the trend log.
For more information, see section 40.2
“Log Record Storage” on page 1168.

Include in reports Select True to include the extended trend

log data in reports.

System 04-30005-01-en, May 2019

1288
 44 Trends User interface
44.10 Change of Value Trend Log Properties – Meter Info Tab

44.10 Change of Value Trend Log Properties –

Meter Info Tab
Use the Meter Info tab to configure the meter function of the trend log.

Figure: Meter Info tab

Table: Meter Info Tab

Property Description

Is meter log Displays True if the trend log meter

function is active.
For more information, see section 39.8
“Meter Function” on page 1137.

Meter change time Displays the time when the meter was
changed.

Meter change user Displays the name of the user account that
changed the meter.

End time Displays the time when the old meter was
replaced.

04-30005-01-en, May 2019 System

1289
44 Trends User interface
44.10 Change of Value Trend Log Properties – Meter Info Tab

Continued
Property Description

End value Displays the value the old meter had when
it was replaced.

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

1290
 44 Trends User interface
44.11 Interval Trend Log Properties – Meter Info Tab

44.11 Interval Trend Log Properties – Meter

Info Tab
Use the Meter Info tab to configure the meter function of the trend log.

Figure: Meter Info tab

Table: Meter Info Tab

Property Description

Is meter log Displays True if the trend log meter

function is active.
For more information, see section 39.8
“Meter Function” on page 1137.

Meter change time Displays the time when the meter was
changed.

Meter change user Displays the name of the user account that
changed the meter.

End time Displays the time when the old meter was
replaced.

04-30005-01-en, May 2019 System

1291
44 Trends User interface
44.11 Interval Trend Log Properties – Meter Info Tab

Continued
Property Description

End value Displays the value the old meter had when
it was replaced.

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

1292
 44 Trends User interface
44.12 Manual Trend Log Properties – Meter Info Tab

44.12 Manual Trend Log Properties – Meter

Info Tab
Use the Meter Info tab to configure the meter function of the trend log.

Figure: Meter Info tab

Table: Meter Info Tab

Property Description

Is meter log Displays True if the trend log meter

function is active.
For more information, see section 39.8
“Meter Function” on page 1137.

Meter change time Displays the time when the meter was
changed.

Meter change user Displays the name of the user account that
changed the meter.

End time Displays the time when the old meter was
replaced.

04-30005-01-en, May 2019 System

1293
44 Trends User interface
44.12 Manual Trend Log Properties – Meter Info Tab

Continued
Property Description

End value Displays the value the old meter had when
it was replaced.

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

1294
 44 Trends User interface
44.13 Variable Triggered Trend Log Properties – Meter Info Tab

44.13 Variable Triggered Trend Log

Properties – Meter Info Tab
Use the Meter Info tab to configure the meter function of the trend log.

Figure: Meter Info tab

Table: Meter Info Tab

Property Description

Is meter log Displays True if the trend log meter

function is active.
For more information, see section 39.8
“Meter Function” on page 1137.

Meter change time Displays the time when the meter was
changed.

Meter change user Displays the name of the user account that
changed the meter.

End time Displays the time when the old meter was
replaced.

04-30005-01-en, May 2019 System

1295
44 Trends User interface
44.13 Variable Triggered Trend Log Properties – Meter Info Tab

Continued
Property Description

End value Displays the value the old meter had when
it was replaced.

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

1296
 44 Trends User interface
44.14 Extended Trend Log Properties – Meter Info Tab

44.14 Extended Trend Log Properties – Meter

Info Tab
Use the Meter Info tab to configure the meter function of the trend log.

Figure: Meter Info tab

Table: Meter Info Tab

Property Description

Is meter log Displays True if the trend log meter

function is active.
For more information, see section 39.8
“Meter Function” on page 1137.

Meter change time Displays the time when the meter was
changed.

Meter change user Displays the name of the user account that
changed the meter.

End time Displays the time when the old meter was
replaced.

04-30005-01-en, May 2019 System

1297
44 Trends User interface
44.14 Extended Trend Log Properties – Meter Info Tab

Continued
Property Description

End value Displays the value the old meter had when
it was replaced.

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

1298
 44 Trends User interface
44.15 Manage Replacement of Meter Dialog Box

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

NOTICE
• 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-30005-01-en, May 2019 System

1299
44 Trends User interface
44.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-30005-01-en, May 2019

1300
 44 Trends User interface
44.16 Meter Change History Dialog Box

44.16 Meter Change History Dialog Box

Use the Meter Change History dialog box to display all meter changes together
with the replaced meters settings.

NOTICE
• 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-30005-01-en, May 2019 System

1301
44 Trends User interface
44.16 Meter Change History Dialog Box

Continued
Component Description

Max value Displays the last value of the new meter

before roll-over.

System 04-30005-01-en, May 2019

1302
 44 Trends User interface
44.17 Trend Chart Properties

44.17 Trend Chart Properties

Use the Trend Chart Properties dialog box to configure the general properties
of the trend chart.

Figure: Trend 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.

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.

Show grid lines for X-axis Select True to show grid lines for the x-
axis.

04-30005-01-en, May 2019 System

1303
44 Trends User interface
44.17 Trend Chart Properties

Continued
Property Description

Chart title Enter the property reference or relative

property reference to the folder or other
container whose name you want to include
in the trend chart title.

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 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 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
Click to edit a selected series. For more
information, see section 44.26 “Trend
Chart Series Properties” on page 1318.

Remove
Click to remove a selected series.

System 04-30005-01-en, May 2019

1304
 44 Trends User interface
44.18 Trend Chart View

44.18 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 Series tab shortcut menu to

manage the appearance of a trend log
series. For more information, see section
44.22 “Series Tab Context Menu” on page
1312.

Use the trend chart toolbar to adjust the

visible trend chart area. For more
information, see section 44.19 “Trend
Chart Toolbar” on page 1306.

Use the trend log event icons to get

information about a specific record. For
more information, see section 44.20 “Trend
Chart Event Icons” on page 1308.

Use the navigation bar to horizontally

adjust the visible trend chart area. For
more information, see section 44.21 “Trend
Chart Navigation Bar” on page 1311.

04-30005-01-en, May 2019 System

1305
44 Trends User interface
44.19 Trend Chart Toolbar

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

System 04-30005-01-en, May 2019

1306
 44 Trends User interface
44.19 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 44.23
“Trend Chart Settings Dialog Box – Axes
Tab” on page 1313.
For more information, see the Trend Chart
Settings Dialog Box – X Axis Tab topic on
WebHelp.

View in multi trend log list

Opens the trend chart in a multi trend log
list. For more information, see section
44.39 “Multi Trend Log List View” on page
1336.

04-30005-01-en, May 2019 System

1307
44 Trends User interface
44.20 Trend Chart Event Icons

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

System 04-30005-01-en, May 2019

1308
 44 Trends User interface
44.20 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.

INF value was logged

Indicates that a positive Infinity value was
logged.

-INF value was logged

Indicates that a negative Infinity value was
logged.

NaN value was logged

Indicates that an unknown value ("Not a
Number") was logged.

Null value was logged

Indicates that a Null value was logged.

System clock changed

Indicates that the system date and time of
the EcoStruxure BMS server where the
trend log is located has been changed. For
more information, see section 17.1 “Time
and Time Zone” on page 313.

04-30005-01-en, May 2019 System

1309
44 Trends User interface
44.20 Trend Chart Event Icons

Continued
Icon Description

Override
Indicates that the recorded value is
overridden by the hardware and is not the
measured value. For more information, see
the Output Override Status topic on
WebHelp.
Forced
Indicates that the recorded value is forced
by the software and is not the measured
value. For more information, see the
Forced I/O Point Values topic on WebHelp.

Log database restored

Indicates that the log database has been
restored and that, when the log restarts,
there can be a time gap in the log series.

Log reset by extended log

Indicates that the log has been cleared by
the extended trend log due to a log
database restore.

Transfer was missed

Indicates that the extended trend log has
miss records between fetches. That is, the
monitored log has created and lost records
before the extended trend log has been
able to fetch the records.

System 04-30005-01-en, May 2019

1310
 44 Trends User interface
44.21 Trend Chart Navigation Bar

44.21 Trend Chart Navigation Bar

Use the Trend Chart navigation bar to horizontally scroll the trend chart.

Table: Trend Chart Navigation Bar

Component Description

Log start
Click to scroll back to the first value of the
trend chart in WorkStation.

Fast backward
Click to scroll fast backward.

Backward
Click to scroll back.

Live update Select to have the trend chart automatically

adjust itself according to the latest trend
log record in WorkStation.

Forward
Click to scroll forward.

Fast forward
Click to scroll fast forward.

Current time
Click to scroll forward to the latest value of
the trend chart in WorkStation.

04-30005-01-en, May 2019 System

1311
44 Trends User interface
44.22 Series Tab Context Menu

44.22 Series Tab Context Menu

Use the series tab context menu to 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 context menu

Table: Series Tab Context 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-30005-01-en, May 2019

1312
 44 Trends User interface
44.23 Trend Chart Settings Dialog Box – Axes Tab

44.23 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 for the trend chart. The
time zone is the displayed time
perspective of the trend log.

Show grid lines Select to show horizontal grid lines.

04-30005-01-en, May 2019 System

1313
44 Trends User interface
44.23 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-30005-01-en, May 2019

1314
 44 Trends User interface
44.24 Trend Chart Settings Dialog Box – Series Tab

44.24 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

Display variable/trend log Displays the referenced variable or trend

log. To change the reference, browse to a
different variable or trend log.

Data series Displays all series in the trend chart. Select

a series to display its presentation
properties.

Series presentation Select the presentation type of the series.

Assigned to y-axis Select Left to attach the series to the left y-

axis.

Weight Type the weight of the line. The value has

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

04-30005-01-en, May 2019 System

1315
44 Trends User interface
44.24 Trend Chart Settings Dialog Box – Series Tab

Continued
Component Description

Color Enter the color of the series.

System 04-30005-01-en, May 2019

1316
 44 Trends User interface
44.25 Trend Chart Settings Dialog Box – Calculation Tab

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

04-30005-01-en, May 2019 System

1317
44 Trends User interface
44.26 Trend Chart Series Properties

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

System 04-30005-01-en, May 2019

1318
 44 Trends User interface
44.26 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 Enter a custom time span for which the

calculation method is to be executed

Custom period alignment Enter the time when you want the custom
period to start.

04-30005-01-en, May 2019 System

1319
44 Trends User interface
44.27 Real Time Trend Series Properties

44.27 Real Time Trend Series Properties

Use the Basic tab to configure and view real time trend properties. For more
information, see section 53.39 “General Information Properties – Basic Tab” on
page 1604.

Figure: Real Time Series Properties - Basic tab

System 04-30005-01-en, May 2019

1320
 44 Trends User interface
44.28 Trend Log List Properties

44.28 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 42.4 “Time Zone Modes in a Trend
Log List” on page 1242.

Calculation method Select a calculation method.

04-30005-01-en, May 2019 System

1321
44 Trends User interface
44.28 Trend Log List Properties

Continued
Component Description

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 Enter a custom time span for which the

calculation method is to be executed.

Custom period alignment Enter the time when you want the custom
period to start.

System 04-30005-01-en, May 2019

1322
 44 Trends User interface
44.29 Trend Log List View

44.29 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 44.30 “Trend Log
List Toolbar” on page 1324.

Use the log info to get detailed information

about the trend log list. For more
information, see section 44.32 “Trend Log
List – Log Info View” on page 1328.

Use the trend log list columns to sort the

trend log records. For more information,
see the Add/Remove Columns Dialog Box
topic on WebHelp.

Use the trend log list context menu to edit,

add, or show the history of trend log
records. For more information, see section
44.33 “Trend Log List Context Menu” on
page 1329.

Use the trend log event icons to get

information about a specific record. For
more information, see section 44.31 “Trend
Log List Event Icons” on page 1326.

04-30005-01-en, May 2019 System

1323
44 Trends User interface
44.30 Trend Log List Toolbar

44.30 Trend Log List Toolbar

Use the trend log list toolbar to manage the trend log list and records.

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 44.31 “Trend
Log List Event Icons” on page 1326.

Show time stamps with fractions

Click to show the time stamps with
hundredths.

Show decimal values

Click to display the values as decimals.

Show values as bitstrings

Click to display the values as bitstrings.

Show values as booleans

Click to display the values as booleans.

Add trend log record

Click to open the Add trend log record
dialog box where you can add one or more
values to the trend log. Refresh the trend
log list to see the added values. For more
information, see section 44.35 “Add Trend
Log Record Dialog Box” on page 1331.

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 44.36
“Edit/Comment Trend Log Record Dialog
Box” on page 1332.

Clear trend log

Click to clear all the records from the trend
log.

System 04-30005-01-en, May 2019

1324
 44 Trends User interface
44.30 Trend Log List Toolbar

Continued
Button Description

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 44.16 “Meter Change History
Dialog Box” on page 1301.

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 44.28 “Trend Log
List Properties” on page 1321.

Log space (records) Type the maximum number of log records

to display in the trend log list.

Apply
Click to limit the number of log space
records to the number typed in the box.

04-30005-01-en, May 2019 System

1325
44 Trends User interface
44.31 Trend Log List Event Icons

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

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

1326
 44 Trends User interface
44.31 Trend Log List Event Icons

Continued
Icon Description

System clock changed

Indicates that the system date or time,
where the trend log is located, has been
changed. For more information, see
section 17.1 “Time and Time Zone” on
page 313.

Override
Indicates that the recorded value is
overridden by the hardware and is not the
measured value. For more information, see
the Output Override Status topic on
WebHelp.
Forced
Indicates that the recorded value is forced
by the software and is not the measured
value. For more information, see the
Forced I/O Point Values topic on WebHelp.

Log database restored

Indicates that the log database has been
restored and that, when the log restarts,
there can be a time gap in the log series.

Log reset by extended log

Indicates that the commands from the
extended trend log have been cleared
from the trend log.

04-30005-01-en, May 2019 System

1327
44 Trends User interface
44.32 Trend Log List – Log Info View

44.32 Trend Log List – Log Info View

When expanded, the Log Info view displays a summary of the data recorded in
the trend log list.

NOTICE
• 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-30005-01-en, May 2019

1328
 44 Trends User interface
44.33 Trend Log List Context Menu

44.33 Trend Log List Context Menu

Right-click a row in a trend log list to open the trend log list context menu, where
you can edit a record, show the history of a record, or copy the trend log list
data.

Figure: Trend log list context menu

Table: Trend Log List Context 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 44.36
“Edit/Comment Trend Log Record Dialog
Box” on page 1332.

Show history Click to open the Edited value history

dialog box where you can view the edits
done to log record values For more
information, see section 44.37 “Edited
Value History Dialog Box” on page 1333.

Copy Click to copy the list data to the clipboard.

04-30005-01-en, May 2019 System

1329
44 Trends User interface
44.34 Add/Remove Columns Dialog Box (Trends)

44.34 Add/Remove Columns Dialog Box

(Trends)
Use the Add/Remove Columns dialog box to add or remove columns from the
trend log list.

Figure: Add/Remove Columns dialog box

Table: Add/Remove Columns Dialog Box

Component Descriptin

Comment Select to display the comment added by a

user or system. For more information, see
section 32.2 “Comments” on page 759.

Events Select to display any events that occurred.

Sample status Select to display the condition when the

sample was recorded.

Sequence number Select to display the event sequence

number on the present EcoStruxure BMS
server.

Time stamp Select to display the time and date when

the event was generated.

User Select to display the user name that

generated the event.

Value Select to display the value.

System 04-30005-01-en, May 2019

1330
 44 Trends User interface
44.35 Add Trend Log Record Dialog Box

44.35 Add Trend Log Record Dialog Box

Use the Add trend log record dialog box to add a trend log record to a trend log.

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 Enter the value of the new record.

Comment Type a comment for the record.

04-30005-01-en, May 2019 System

1331
44 Trends User interface
44.36 Edit/Comment Trend Log Record Dialog Box

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

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.

System 04-30005-01-en, May 2019

1332
 44 Trends User interface
44.37 Edited Value History Dialog Box

44.37 Edited Value History Dialog Box

Use the Edited value history dialog box to view the changes to a trend log value
in the trend log.

Figure: Edited value history dialog box

Table: Edited Value History Dialog Box

Component Description

Timestamp Displays the time the value was edited.

Value Displays the value of the record when

edited.

User Displays the name of the user that edited

the record.

04-30005-01-en, May 2019 System

1333
44 Trends User interface
44.38 Multi Trend Log List Properties - Basic Tab

44.38 Multi Trend Log List Properties - Basic

Tab
Use the Multi Trend Log List Properties - Basic tab to configure the basic
properties of the multi trend log list.

Figure: Multi Trend Log List properties - Basic tab

Table: Multi Trend Log List Properties - Basic Tab

Property Description

Log space (records) Select the maximum number of records to

display in the list.

Show events Select True to display events in the list.

Selecting False 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 the time zone in which the log

records are presented.

System 04-30005-01-en, May 2019

1334
 44 Trends User interface
44.38 Multi Trend Log List Properties - Basic Tab

Continued
Property Description

Calculation method Select a calculation method.

For more information, see section 42.7
“Calculation Methods” on page 1247.

Delta over period Select True to apply a period to the delta

calculation method.
For more information, see section 42.7
“Calculation Methods” on page 1247.

Period Select the time span for which the

calculation method is to be executed.

Custom period Enter a custom time span for which the

calculation method is to be executed.

Custom period alignment Enter the time when you want the custom
period to start.

Add
Click to add a series to the multi trend log
list. For more information, see section
44.54 “Create Trend Chart Wizard –
Configure Trend Log Series Page” on page
1358..

Edit
Click to edit a selected series.

Remove
Click to remove a selected series.

04-30005-01-en, May 2019 System

1335
44 Trends User interface
44.39 Multi Trend Log List View

44.39 Multi Trend Log List View

Use the Multi Trend Log List view to view, edit, or export the contents of the
mulit trend log list.

Figure: Multi Trend Log List view

Table: Multi Trend Log List View

Number Description

Use the multi trend log list toolbar to

manage or export records from multiple
trend logs. For more information, see
section 44.40 “Multi Trend Log List
Toolbar” on page 1337.

Use the multi trend log list columns to

compare trend log records. For more
information, see section 29.14 “Fitting the
Column Width to the Contents” on page
591.

System 04-30005-01-en, May 2019

1336
 44 Trends User interface
44.40 Multi Trend Log List Toolbar

44.40 Multi Trend Log List Toolbar

Use the trend log list toolbar to manage the multi trend log list.

Table: Multi Trend Log List Toolbar

Number Description

Show real values

Click to display only actual values.

Fill values
Click to fill gaps in the list with the latest
known values.

Show timestamps with fractions

Displays the log records per millisecond.

Export to .XML
Click to open an Export dialog box where
you can export the contents of the multi
trend log list to an .XML file.

Export to .CSV
Click to open an Export dialog box where
you can export the contents of the multi
trend log list to a .CSV file.

Open multi trend log list settings

Click to open the Multi Trend Log List
Settings dialog box where you edit the
properties that control how trend log
records are presented in a the multi trend
log list. For more information, see section
44.41 “Multi Trend Log Settings Dialog
Box – General Tab” on page 1338.. For
more information, see section 44.42 “Multi
Trend Log Settings Dialog Box – Series
Tab” on page 1340..

04-30005-01-en, May 2019 System

1337
44 Trends User interface
44.41 Multi Trend Log Settings Dialog Box – General Tab

44.41 Multi Trend Log Settings Dialog Box –

General Tab
Use the General tab to edit the properties that control how all the trend log
series are presented in a multi trend log list.

NOTICE
Changes made on the General tab override settings made on individual series
on the Series tab.

Figure: General tab

Table: Multi Trend Log Settings – General Tab

Property Description

Log space (records) Select the maximum number of records to

display in the list.

Time zone Select the time zone in which the log

records are presented.

System 04-30005-01-en, May 2019

1338
 44 Trends User interface
44.41 Multi Trend Log Settings Dialog Box – General Tab

Continued
Property Description

Calculation method Select a calculation method.

For more information, see section 42.7
“Calculation Methods” on page 1247.

Delta over period Select True to apply a period to the delta

calculation method.
For more information, see section 42.7
“Calculation Methods” on page 1247.

Period Select the time span for which the

calculation method is to be executed.

Custom period Enter a custom time span for which the

calculation method is to be executed.

Custom period alignment Enter the time when you want the custom
period to start.

04-30005-01-en, May 2019 System

1339
44 Trends User interface
44.42 Multi Trend Log Settings Dialog Box – Series Tab

44.42 Multi Trend Log Settings Dialog Box –

Series Tab
Use the Series tab to edit the calculation method and period properties of an
individual trend log series.

NOTICE
Configurations made on an individual series are overridden by the
configuration of the mulit trend log list.

Figure: Series tab

Table: Multi Trend Log List Settings – Series Tab

Property Description

Data series Select the individual trend log series

whose properties you want to edit.

Display trend log Displays the selected trend log in the Data
series list.

System 04-30005-01-en, May 2019

1340
 44 Trends User interface
44.42 Multi Trend Log Settings Dialog Box – Series Tab

Continued
Property Description

Calculation method Select a calculation method.

For more information, see section 42.7
“Calculation Methods” on page 1247.

Delta over period Select True to apply a period to the delta

calculation method.
For more information, see section 42.7
“Calculation Methods” on page 1247.

Period Select the time span for which the

calculation method is to be executed.

Custom period Enter a custom time span for which the

calculation method is to be executed.

Custom period alignment Enter the time when you want the custom
period to start.

04-30005-01-en, May 2019 System

1341
44 Trends User interface
44.43 Multi Trend Log List Series Properties

44.43 Multi Trend Log List Series Properties

Use the Series Properties dialog box to configure the properties of the trend log
series in a multi trend log list.

Figure: Series properties

Table: Series Properties

Property Description

Display trend log Enter the trend log to display in the multi
trend log list.

System 04-30005-01-en, May 2019

1342
 44 Trends User interface
44.44 Multi Trend Log List Context Menu

44.44 Multi Trend Log List Context Menu

Use the Multi Trend Log List context menu to manage the multi trend log list.

Figure: Multi trend log list context menu

Table: Multi Trend Log List Context Menu

Command Description

Export to .XML Click to open a standard Export dialog box

where you can select a name and a
location for the.XML file.

Export to .CSV Click to open a standard Export dialog box

where you can select a name and a
location for the.CSV file

Copy Click to copy the selected content of the

multi trend log list to the clipboard.

Save as standard layout Click to save the multi trend log list layout
as the standard layout.

Open multi trend log list settings Click to open the Multi trend log list
settings dialog box where you edit the
properties that control how all the trend log
series are presented in a multi trend log list
and where you edit the calculation method
and period properties of an individual
trend log series.
For more information, see section 44.41
“Multi Trend Log Settings Dialog Box –
General Tab” on page 1338.
For more information, see section 44.42
“Multi Trend Log Settings Dialog Box –
Series Tab” on page 1340.

04-30005-01-en, May 2019 System

1343
44 Trends User interface
44.45 Multi Trend Log List Header Context Menu

44.45 Multi Trend Log List Header Context

Menu
Use the Multi Trend Log List header context menu to edit how trends are
displayed in the multi trend log list.

Figure: Multi trend log list header context menu

Table: Multi Trend Log List Header Context Menu

Command Description

Auto fit to contents Click to fit the column width to the content.

Group box Click to open the Group box where you

group objects to get a better overview of
the objects in the multi trend log list.

System 04-30005-01-en, May 2019

1344
 44 Trends User interface
44.46 Create Interval Trend Log Wizard – Configure Interval Trend Log Page

44.46 Create Interval 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.

Set unit
Click to open the Unit Selection dialog box
where you select the unit. For more
information, see section 18.1 “ Select Unit
Dialog Box” on page 335.

Delta Select the minimum value change that

triggers a new record.

Activation variable Enter the variable that is to make the trend

log start recording values when the
variable is true.

Activation time Specify the time when the trend log is to

start recording values.

Interval Type how often to log the variable, the

interval defines the time between two log
records.

04-30005-01-en, May 2019 System

1345
44 Trends User interface
44.46 Create Interval Trend Log Wizard – Configure Interval Trend Log Page

Continued
Component Description

Log size Select the number of records to store

before old records are overwritten
including internal records generated by
the trend.

Available trend storage Displays the trend storage usage and the
number of records left in the trend storage.

Clear when enabled Select True to clear the trend log when it is
enabled.

System 04-30005-01-en, May 2019

1346
 44 Trends User interface
44.47 Create Trend Log Wizard – Configure Change of Value Trend Log Page

44.47 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 fof Value Trend Log page

Table: Configure Change of Value Trend Log Page

Component Description

Logged variable Enter the variable that you want to log.

Set unit
Click to open the Unit Selection dialog box
where you select the unit. For more
information, see section 18.1 “ Select Unit
Dialog Box” on page 335.

Delta Select the minimum value change that

triggers a new record.

Activation variable Enter the variable that is to start the trend

log.

Activation time Type the start time of the trend log.

Maximum log interval Select the maximum time that can pass
between two recordings regardless of
whether the delta value has been
exceeded or not.

04-30005-01-en, May 2019 System

1347
44 Trends User interface
44.47 Create Trend Log Wizard – Configure Change of Value Trend Log Page

Continued
Component Description

Log size Select the number of records to store

before old records are overwritten
including internal records generated by
the trend.

Available trend storage Displays the trend storage usage and the
number of records left in the trend storage.

Clear when enabled Select True to clear the trend log when it is
enabled.

System 04-30005-01-en, May 2019

1348
 44 Trends User interface
44.48 Create Variable Triggered Trend Log Wizard – Configure Variable Triggered Trend Log Page

44.48 Create Variable Triggered Trend Log

Wizard – Configure Variable Triggered
Trend Log Page
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.

Set unit
Click to open the Unit Selection dialog box
where you select the unit. For more
information, see section 18.1 “ Select Unit
Dialog Box” on page 335.

Delta Select the minimum value change that

triggers a new record.

Trigger variable Enter the variable that triggers the trend

log to start recording.

Trigger condition Select when you want the variable

recorded: when trigger variable changes
to true, changes to false, or all changes.
For more information, see section 39.14
“Variable Triggered Trend Logs” on page
1149.

04-30005-01-en, May 2019 System

1349
44 Trends User interface
44.48 Create Variable Triggered Trend Log Wizard – Configure Variable Triggered Trend Log Page

Continued
Component Description

Log size Select the number of records to store

before old records are overwritten
including internal records generated by
the trend.

Available trend storage Displays the trend storage usage and the
number of records left in the trend storage.

Clear when enabled Select True to clear the trend log when it is
enabled.

System 04-30005-01-en, May 2019

1350
 44 Trends User interface
44.49 Create Manual Trend Log Wizard – Configure Manual Log Page

44.49 Create Manual 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 38.5
“Trend Units” on page 1112.

04-30005-01-en, May 2019 System

1351
44 Trends User interface
44.50 Create Trend Log Wizard – Initial Meter Settings Page

44.50 Create Trend Log Wizard – Initial Meter

Settings Page
Use the Initial Meter Settings page to set the initial values for the meter.

Figure: Initial Meter Settings page

Table: Initital Meter Settings Page

Property Description

Set initial meter Select True to enable the meter function.

Start time Enter the time when the new meter was
installed.

Start value Enter the value of the new meter when it

was installed.

Min value Enter the first value of the new meter after
roll-over.

Max value Enter the last value of the new meter before
roll-over.

System 04-30005-01-en, May 2019

1352
 44 Trends User interface
44.51 Create Extended Trend Log Wizard – Configure Extended Trend Log Page

44.51 Create Extended 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.

Threshold Select the percentage threshold at which

the trend log transfers its records to the
extended trend log.

Maximum transfer interval Select the maximum length of time that can
pass between transfers from the monitored
trend log to the extended trend log.

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 40.4 “Extended
Trend Logs” on page 1171.

04-30005-01-en, May 2019 System

1353
44 Trends User interface
44.51 Create Extended Trend Log Wizard – Configure Extended Trend Log Page

Continued
Component Description

Log size Select the number of records to store

before old records are overwritten
including internal records generated by
the trend.

Available trend storage Displays the trend storage usage and the
number of records left in the trend storage.

Include in reports? Select True to include the extended trend

log data in reports.

System 04-30005-01-en, May 2019

1354
 44 Trends User interface
44.52 Create Trend Chart Wizard – Configure Trend Chart Page

44.52 Create Trend Chart 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
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.

04-30005-01-en, May 2019 System

1355
44 Trends User interface
44.52 Create Trend Chart Wizard – Configure Trend Chart Page

Continued
Component Description

Add
Click to add a series to the trend chart. For
more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Edit
Click to edit a selected series. For more
information, see section 44.26 “Trend
Chart Series Properties” on page 1318.

Remove
Click to remove a selected series.

System 04-30005-01-en, May 2019

1356
 44 Trends User interface
44.53 Create Trend Chart Wizard – Configure Real-Time Trend Series Page

44.53 Create Trend Chart 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 has

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

04-30005-01-en, May 2019 System

1357
44 Trends User interface
44.54 Create Trend Chart Wizard – Configure Trend Log Series Page

44.54 Create Trend Chart Wizard – Configure

Trend Log Series Page
Use the Configure Trend Log Series page to add a series to the trend chart or
multiple trend log list 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 has

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

System 04-30005-01-en, May 2019

1358
 44 Trends User interface
44.55 Create Trend Log List Wizard – Configure Trend Log List Page

44.55 Create Trend Log List 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 list.

04-30005-01-en, May 2019 System

1359
44 Trends User interface
44.56 Create Multi Trend Log Wizard - Configure Multi Trend Log List Page

44.56 Create Multi Trend Log Wizard -

Configure Multi Trend Log List Page
Use the Configure Multi Trend Log List page to configure the settings of the
multi trend log list.

Figure: Configure Multi Trend Log List page

Table: Configure Multi Trend Log List Page

Property Description

Log space (records) Select the maximum number of records to

display in the list.

Click to add a series to the multi trend log

list. For more information, see section
44.54 “Create Trend Chart Wizard –
Configure Trend Log Series Page” on page
1358..

Click to edit a selected series.

Click to remove a selected series.

Series Displays all series in the trend chart.

System 04-30005-01-en, May 2019

1360
 44 Trends User interface
44.57 Create Trend Log Wizard – Connect Objects to the Trend Log Page

44.57 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-30005-01-en, May 2019 System

1361
44 Trends User interface
44.58 Create Multi Trend Log List Wizard – Configure Trend Log Series Page

44.58 Create Multi Trend Log List Wizard –

Configure Trend Log Series Page
Use the Configure Trend Log Series page to enter the trend log to display in the
multi trend log list.

Figure: Configure Trend Log Series page

Table: Configure Trend Log Series Page

Component Description

Display trend log Enter the trend log to display in the multi
trend log list.

System 04-30005-01-en, May 2019

1362
45 Mass Create Alarms and
Trends

Topics
Mass Create
Mass Create Unit Management
Object or Property Variable Type
Suffix and Prefix
Mass Create Path Options
Mass Creating Alarms
Mass Creating Alarms Using the Search Method
Mass Creating Trend Logs
Mass Creating Trend Logs Using the Search Method
Mass Creating Extended Trend Logs
Mass Creating Extended Trend Logs Using the Search
Method
Mass Create Object Wizard – Name Page
 45 Mass Create Alarms and Trends
45.1 Mass Create

45.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 the EcoStruxure Building Operation software 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 seven identical
interval trend logs that monitor individual objects are automatically created.

Figure: Mass creating identical trend logs from different variables.

45.1.1 Object or Property Variable Type

In the EcoStruxure Building Operation database, you can create alarms or trend
logs that are suitable for the variable type you have selected.
For more information, see section 45.3 “Object or Property Variable Type” on
page 1368.

04-30005-01-en, May 2019 System

1365
45 Mass Create Alarms and Trends
45.1 Mass Create

45.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 45.4 “Suffix and Prefix” on page 1370.

45.1.3 Mass Create Unit Management

You can only mass create alarms with identical units or no unit. When you mass
create trend logs, each trend log gets the same unit as the logged variable.
For more information, see section 45.2 “Mass Create Unit Management ” on
page 1367.

45.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 SmartX servers. By performing a search for the reliability
property you can select the points that you want to monitor in the search result
list.

45.1.5 Mass Create Path Options

You have three options when deciding where to create new alarms, trend logs,
and extended trend logs:
• The same folder as each selected object
• A different folder, relative to the path of each selected object
• A single folder for all created objects

System 04-30005-01-en, May 2019

1366
 45 Mass Create Alarms and Trends
45.2 Mass Create Unit Management

45.2 Mass Create Unit Management

You can only mass create alarms with identical units or no unit. When you mass
create trend logs, each trend log gets the same unit as the logged variable.

Figure: Objects and properties with no unit are given the unit that is defined for the other
objects.

04-30005-01-en, May 2019 System

1367
45 Mass Create Alarms and Trends
45.3 Object or Property Variable Type

45.3 Object or Property Variable Type

In the EcoStruxure Building Operation database, 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, the EcoStruxure
Building Operation software 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-30005-01-en, May 2019

1368
 45 Mass Create Alarms and Trends
45.3 Object or Property Variable Type

NOTICE
A trend log that monitors an enumeration records the enumeration value and
not the enumeration definition.
For more information, see section 57.12 “Event and Alarm Enumerations” on
page 1717.
For more information, see section 57.15 “Trend Log Enumerations” on page
1737.

04-30005-01-en, May 2019 System

1369
45 Mass Create Alarms and Trends
45.4 Suffix and Prefix

45.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.
EcoStruxure Building Operation software 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-30005-01-en, May 2019

1370
 45 Mass Create Alarms and Trends
45.5 Mass Create Path Options

45.5 Mass Create Path Options

You have three options when deciding where to create new alarms, trend logs,
and extended trend logs:
• The same folder as each selected object
• A different folder, relative to the path of each selected object
• A single folder for all created objects
The same folder as each selected object
By default, the alarms, trend logs, and extended trend logs are created in the
same folder as each selected object. When you create all objects in the same
folder as each selected object, the objects end up in the same folder as the
value they are based on.

Figure: The same folder as each selected object

A different path, relative to each selected object

When you create all objects in a different folder, relative to the path of each
selected folder, you have to browse to a destination folder for one of the alarms
or trend logs. The path relationship 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 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-30005-01-en, May 2019 System

1371
45 Mass Create Alarms and Trends
45.5 Mass Create Path Options

Figure: A different path, relative to each selected object

A single folder for all created objects

When you create all objects in a single folder, you can specify the folder in which
you want to create all the alarms, trend logs, and extended trend logs. When you
create all objects in a different folder relative to the path of each selected object,
you can specify where the new alarms trend logs, and extended trend logs are
created in relation to the connected variable. When you mass create alarms and
trends by selecting values and dragging them to a single folder in the System
Tree pane, the alarms and trends are created in the folder to which you drag the
values.

System 04-30005-01-en, May 2019

1372
 45 Mass Create Alarms and Trends
45.5 Mass Create Path Options

Figure: A single folder for all created objects

04-30005-01-en, May 2019 System

1373
45 Mass Create Alarms and Trends
45.6 Mass Creating Alarms

45.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 45.1 “Mass Create ” on page 1365.

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 Create Object wizard, 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.
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. In the Destination box, enter the destination where you want to create the
alarms. If you use A different folder, relative to the selected object
object, this
destination 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.

NOTICE
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. If you use A different folder, relative to the selected object

object, 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.
9. 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 30.6 “Creating a Multistate Alarm” on
page 621.
• For more information, see section 30.12 “Creating a Variable Status Alarm”
on page 637.
• For more information, see section 30.24 “Creating an Enumeration Alarm”
on page 670.
• For more information, see section 30.9 “Creating a Matching Text String
Alarm” on page 629.
• For more information, see section 30.15 “Creating an Out of Range Alarm”
on page 645.
• For more information, see section 30.18 “Creating an Out of Reference
Range Alarm” on page 653.
• For more information, see section 30.3 “Creating a Change of State Alarm ”
on page 613.

System 04-30005-01-en, May 2019

1374
 45 Mass Create Alarms and Trends
45.7 Mass Creating Alarms Using the Search Method

45.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 45.1 “Mass Create ” on page 1365.

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.
4. On the File menu, point to New and then click Alarm
Alarm.
5. In the Create Object wizard, 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. In the Destination box, select the destination where you want to create the
alarms. If you use A different folder, relative to the selected object
object, this
destination 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.

NOTICE
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. If you use A different folder, relative to the selected object

object, verify that the
additional line shows the resulting relative path pattern that you intend, and
the way this pattern applies to an example object in the list.
11. 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 30.6 “Creating a Multistate Alarm” on
page 621.
• For more information, see section 30.12 “Creating a Variable Status Alarm”
on page 637.
• For more information, see section 30.24 “Creating an Enumeration Alarm”
on page 670.

04-30005-01-en, May 2019 System

1375
45 Mass Create Alarms and Trends
45.7 Mass Creating Alarms Using the Search Method

• For more information, see section 30.9 “Creating a Matching Text String
Alarm” on page 629.
• For more information, see section 30.15 “Creating an Out of Range Alarm”
on page 645.
• For more information, see section 30.18 “Creating an Out of Reference
Range Alarm” on page 653.
• For more information, see section 30.3 “Creating a Change of State Alarm ”
on page 613.

System 04-30005-01-en, May 2019

1376
 45 Mass Create Alarms and Trends
45.8 Mass Creating Trend Logs

45.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 45.1 “Mass Create ” on page 1365.

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 Create Object wizard, 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.
7. In the Destination box, enter the destination where you want to create the
trend logs. If you use A different folder, relative to the selected object
object, this
destination 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.

NOTICE
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.
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 39.12 “Creating a Change of Value Trend
Log ” on page 1145.
• For more information, see section 39.4 “Creating an Interval Trend Log ” on
page 1131.
• For more information, see section 39.15 “Creating a Variable Triggered
Trend Log” on page 1152.

04-30005-01-en, May 2019 System

1377
45 Mass Create Alarms and Trends
45.9 Mass Creating Trend Logs Using the Search Method

45.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 45.1 “Mass Create ” on page 1365.

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 .

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 Create Object wizard, 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.
9. In the Destination box, enter the destination where you want to create the
trend logs. If you use A different folder, relative to the selected object
object, this
destination 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.

NOTICE
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.
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 39.12 “Creating a Change of Value Trend
Log ” on page 1145.
• For more information, see section 39.4 “Creating an Interval Trend Log ” on
page 1131.
• For more information, see section 39.15 “Creating a Variable Triggered
Trend Log” on page 1152.

System 04-30005-01-en, May 2019

1378
 45 Mass Create Alarms and Trends
45.10 Mass Creating Extended Trend Logs

45.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 45.1 “Mass Create ” on page 1365.

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 Create Object wizard, 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.
6. In the Destination box, enter the destination where you want to create the
trend logs. If you use A different folder, relative to the selected object
object, this
destination 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.

NOTICE
If the specified relative path pattern leads to an unavailable position for
any of the objects in the list, Next and Create are disabled.

7. Click Next
Next.
For more information, see section 40.5 “Creating an Extended Trend Log” on
page 1176.

04-30005-01-en, May 2019 System

1379
45 Mass Create Alarms and Trends
45.11 Mass Creating Extended Trend Logs Using the Search Method

45.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 45.1 “Mass Create ” on page 1365.

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.
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. In the Destination box, enter the destination where you want to create the
trend logs. If you use A different folder, relative to the selected object
object, this
destination 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.

NOTICE
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.
For more information, see section 40.5 “Creating an Extended Trend Log” on
page 1176.

System 04-30005-01-en, May 2019

1380
 45 Mass Create Alarms and Trends
45.12 Mass Create Object Wizard – Name Page

45.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
56.1 “EcoStruxure Building Operation
Objects ” on page 1663.

Prefix Type a label that is added in front of the

object name. For more information, see
section 45.4 “Suffix and Prefix” on page
1370.

Suffix Type a label that is added after the object

name. For more information, see section
45.4 “Suffix and Prefix” on page 1370.

Description Type a description that explains what the

object is used for.

Destination Select the destination folder option where

you want to create the objects. For more
information, see section 45.5 “Mass Create
Path Options” on page 1371.

04-30005-01-en, May 2019 System

1381
45 Mass Create Alarms and Trends
45.12 Mass Create Object Wizard – Name Page

Continued
Property Description

Location Displays the folder where the alarms or

trends are created.
If you create alarms or trends in a different
path, relative to each selected object, you
can browse in a different location.
For more information, see section 45.5
“Mass Create Path Options” on page 1371.

System 04-30005-01-en, May 2019

1382
46 Schedules Introduction

Topics
Schedules Overview
Schedule Bindings
Configuring a Schedule as a Shadow
 46 Schedules Introduction
46.1 Schedules Overview

46.1 Schedules Overview

A schedule is a sequence of events that determines when essential events
occur in a building automation system: doors locking or unlocking, temperature
raised or lowered, or equipment turned on or off.
For example, the lighting in an office building needs to be automated to
conserve energy during non-business hours. To regulate the lights from Monday
through Friday, you create a weekly schedule that turns the lights on at 07:00
and switches them off at 20:00. If there are any non-routine events, such as
holidays, you can use exception events to override the schedule and turn the
lights off. For more information, see section 49.7 “Exception Events in
WorkStation” on page 1428.

46.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 47.1 “Schedule Editor Overview” on page
1391.

46.1.2 Priorities
Priority is a number that corresponds to a preassigned level of importance.
When used in schedules, priority numbers range from one to sixteen. One is the
most important or highest priority and sixteen is the lowest priority.
For more information, see section 47.5 “Priorities” on page 1396.

46.1.3 Schedule Types

You can create three types of schedules: Digital, Multistate, or Analog. You
create a digital schedule if the schedule needs to control a device with two
output states, such as On or Off. You create a multistate schedule if the
schedule needs to control a device that has output states based on multiple
states, such as low, medium, or high. You create an analog schedule if the
schedule controls a device that gauges the output in real numbers.
For more information, see section 48.1 “Schedule Types ” on page 1409.

04-30005-01-en, May 2019 System

1385
46 Schedules Introduction
46.1 Schedules Overview

46.1.4 Schedule Events

A schedule can have two types of events: weekly events and exception
events. Weekly events occur every week at specified times. Exception
events occur when the schedule deviates from the weekly schedule, such as
during holidays. Exception events override the weekly events when there is an
overlap.
For more information, see section 49.1 “Schedule Events” on page 1421.

46.1.5 Calendars in WorkStation

A calendar is a list of dates. The calendar provides the schedule with the dates
when the exception events shall occur. To save time, you can reference a single
calendar rather than entering several exception events in a schedule.
For more information, see section 50.2 “Calendars in WorkStation” on page
1452.

46.1.6 Schedule and Calendar Synchronization

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

46.1.7 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
destination reads the value from the source.
For more information, see section 46.2 “Schedule Bindings” on page 1387.

System 04-30005-01-en, May 2019

1386
 46 Schedules Introduction
46.2 Schedule Bindings

46.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
destination reads the value from the source.

Figure: Binding diagram

In EcoStruxure BMS, 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.

46.2.1 Binding Examples

Bindings are used in schedules the same way that bindings are used throughout
the system. You bind a schedule to a point in order to control the value with the
schedule. The following examples demonstrate the different uses of schedules
and bindings.

Analog Schedule
You bind an analog schedule to an analog output, such as a thermostat setpoint.
When the schedule dictates a change in temperature, the system sends the
output information to the setpoint for the thermostat to act on. For more
information, see section 48.10 “Binding an Analog Value to an Analog Schedule”
on page 1418.

Digital Schedule
You bind a digital schedule to a digital output, such as a light switch. The system
will switch the light on or off depending on the value set in the schedule. For
more information, see section 48.4 “Binding a Digital Value to a Digital
Schedule” on page 1412.

Multistate Schedule
You bind a multistate schedule to a multistate output, such as an air handler.
When the schedule dictates a change in air flow, the system will send the output
information to the air handler depending on the value of the state set in the
schedule. For more information, see section 48.7 “Binding a Multistate Value to a
Multistate Schedule” on page 1415.

04-30005-01-en, May 2019 System

1387
46 Schedules Introduction
46.3 Configuring a Schedule as a Shadow

46.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 50.13 “Schedule and Calendar
Synchronization” on page 1464.

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 properties dialog box, in the Lead object box, enter the schedule that
you want to synchronize the shadow schedule with.
4. Click OK
OK.

System 04-30005-01-en, May 2019

1388
47 Schedule Editor

Topics
Schedule Editor Overview
Basic View of the Schedule Editor
Advanced View of the Schedule Editor
Time Zones
Priorities
Editing an Event Priority
Configuring a Time Value Period for a Schedule
Editing a Schedule Event Time Span
Modifying a Schedule Using the Text View
Modifying a Schedule Using the Graphic View
Schedule Colors in WorkStation
 47 Schedule Editor
47.1 Schedule Editor Overview

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

47.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 47.2 “Basic View of the Schedule Editor” on
page 1392.

47.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 47.3 “Advanced View of the Schedule Editor ”
on page 1393.

47.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 47.11 “Schedule Colors in WorkStation” on
page 1404.

04-30005-01-en, May 2019 System

1391
47 Schedule Editor
47.2 Basic View of the Schedule Editor

47.2 Basic View of the Schedule Editor

The Basic view of the Schedule Editor serves as a workspace to plan and
design a schedule. You use this editor to create, manage, and display weekly
scheduled events and exception events.
You can also display the client time zone and the server time zone in the Basic
view. This is convenient if your EcoStruxure BMS server is located in a time zone
that is different from the time zone where you are configuring the schedule. For
more information, see section 47.4 “Time Zones” on page 1395.
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, November 12 is an exception event so it
does not follow the same scheduled events as the rest of the week. The lights
are off all day. For the rest of the week, the lights turn on at 07:00 and turn off at
18:00.

Figure: Basic view of the Schedule Editor

System 04-30005-01-en, May 2019

1392
 47 Schedule Editor
47.3 Advanced View of the Schedule Editor

47.3 Advanced View of the Schedule Editor

The Advanced view of the Schedule Editor has the features of the Basic view
with some additional capabilities. All the tasks that you can perform in the Basic
view, you can also perform in the Advanced view.
Unlike the Basic view, the Advanced view lists the exception and weekly events
in an event tree. In addition, there is a Combined option that displays all the
weekly and exception events for a selected date.
Two toggles provide additional options:
• Mode
Mode: Switches between an editor or preview mode.
• View
View: Switches between a graphical or text view.

Figure: Advanced view of the Schedule Editor

47.3.1 Mode
The Mode toggle provides the following capabilities:
• Edit Schedule mode where you can view or edit a weekly event or an
exception event.
• Preview Events for Selected Date mode where you can preview (but not
edit) all the weekly schedules and exceptions for a selected date. However,
only the effective weekly and exception events display for that date.
Typically, you see one weekly and one exception event.

47.3.2 View
The View toggle provides the following capabilities:
• Graphic View where you can view or edit a weekly event or an exception
event. For more information, see section 47.10 “Modifying a Schedule Using
the Graphic View” on page 1403.
• Text View where you can define specific time sequences or to break down
a time value into hundredths of a second. For more information, see section
47.9 “Modifying a Schedule Using the Text View” on page 1401.

04-30005-01-en, May 2019 System

1393
47 Schedule Editor
47.3 Advanced View of the Schedule Editor

Figure: Text View

47.3.3 Combined
You can view all of the events for a selected date using both the Combined
option and Preview Events for Selected Date mode. Events can include
exception and weekly events, and the Default value. You can toggle the
combined events between the Graphic View or Text View View.

Figure: Combined Events in Graphic View

Figure: Combined Events in Text View

For more information, see section 51.4 “Advanced Schedule Editor Toolbar ” on
page 1472.

System 04-30005-01-en, May 2019

1394
 47 Schedule Editor
47.4 Time Zones

47.4 Time Zones

When you create a schedule, the time zone of the EcoStruxure BMS server that
contains the schedule determines the execution of the events. If the schedule is
copied to an EcoStruxure BMS 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. The
schedule editor 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.

04-30005-01-en, May 2019 System

1395
47 Schedule Editor
47.5 Priorities

47.5 Priorities
Priority is a number that corresponds to a preassigned level of importance.
When used in schedules, priority numbers range from one to sixteen. One is the
most important or highest priority and sixteen is the lowest priority.

47.5.1 Exception Events

An exception event occurs instead of the scheduled weekly events for a single
date, date range, calculated date, or calendar reference.
Exception events always take precedence over weekly events. When two
exception events overlap, priorities can determine which event takes
precedence over the other. Generally, priorities resolve the following conflicts:
• Two events with different priorities occur on the same day and time. In this
case, the higher priority takes control of the schedule.
For example, a schedule that is set at priority 14 controls a fan in an office
area at low speed during normal business hours. A Special Meeting event
scheduled at 11:00 is set at priority 12 for medium speed. Therefore, the
schedule adjusts the fan from low to medium for the meeting and ignores
the priority 14 event until the priority 12 event ends.
• Two events with the same priority level occur on the same day and time. In
this case, the position in the Event tree determines which priority takes
control of the schedule. The position depends on when exception event was
created.
In the following example, two exception events are set at Priority 12. Winter
Break was created first followed by Scout Meeting. Therefore, Winter Break
takes precedence over Scout meeting because that event was created first.

In the Advanced Schedule Editor, an event tree lists the exception events in
separate folders according to priority level. For example, an exception event set
at priority 10 is contained in a Priority 10 folder. If no priority is specified,
EcoStruxure Building Operation software places the event in the default folder,
Priority 16. No event folders display in the event tree if all exception events use
the default priority. For more information, see section 47.3 “Advanced View of
the Schedule Editor ” on page 1393.
By default, all exception events are set at priority 16, but you can change priority
level. For more information, see section 47.6 “Editing an Event Priority” on page
1398.

System 04-30005-01-en, May 2019

1396
 47 Schedule Editor
47.5 Priorities

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 47.11 “Schedule Colors in WorkStation” on
page 1404.

04-30005-01-en, May 2019 System

1397
47 Schedule Editor
47.6 Editing an Event Priority

47.6 Editing an Event Priority

You edit an event priority to change the exception event to a higher or lower
priority.

To edit an event priority

1. In WorkStation, in the System Tree pane, right click the schedule you want
to edit and click Open
Open.
2. In the Work area, click the Basic view of the Schedule editor.
3. In the Event grid, select the exception event you want to edit.

4. On the Basic toolbar, click the Edit schedule event button .

5. In the Schedule
chedule Event Properties dialog box, in the Priority box, enter the
priority level for the event.
6. Click OK
OK.

System 04-30005-01-en, May 2019

1398
 47 Schedule Editor
47.7 Configuring a Time Value Period for a Schedule

47.7 Configuring a Time Value Period for a

Schedule
You configure a time value period to modify weekly or exception events in an
EcoStruxure Building Operation schedule or BACnet schedule.
For more information, see section 47.3 “Advanced View of the Schedule Editor ”
on page 1393.

To configure a time value period for a schedule

1. In WorkStation, in the System Tree pane, select the schedule that you want
to modify.
2. Click the Advanced tab of the editor.
3. Expand the Exceptions or Weekly folder.
4. Right click on the time period that you want to modify and click Properties
Properties.

5. Modify the properties.

Component Description

Value Enter the value associated with the event.

Start Time Click the up or down arrows to select the hours, minutes, and
seconds for the start time. You can also type the time if you
want.

End Time Click the up or down arrows to select the hours, minutes, and
seconds for the end time. You can also type the time if you
want.

No End Time Click the checkbox to have the event last all day.

6. Click OK
OK.

04-30005-01-en, May 2019 System

1399
47 Schedule Editor
47.8 Editing a Schedule Event Time Span

47.8 Editing a Schedule Event Time Span

You edit a schedule event time span when you need to shorten or lengthen the
time span of the event.
For more information, see section 47.3 “Advanced View of the Schedule Editor ”
on page 1393.

To edit a schedule event time span

1. In WorkStation, in the System Tree pane, select the schedule containing
the event you want to edit the time span for.
2. In the schedule editor, click the Advanced tab.
3. Expand the Exceptions folder or the Weekly folder depending on which
type of event you want to edit the time span for.
4. Select the event time bar that you want to edit the time span for.

5. Click on the edge of the event time bar and drag it to the required time. The
selectable times are displayed in a tool tip.

6. On the File menu, click Save

Save.

System 04-30005-01-en, May 2019

1400
 47 Schedule Editor
47.9 Modifying a Schedule Using the Text View

47.9 Modifying a Schedule Using the Text

View
Use the Text View of the Advanced Schedule editor to edit specific time
sequences and break down a time value into hundredths of a second.
For more information, see section 47.3 “Advanced View of the Schedule Editor ”
on page 1393.

To modify a schedule using the Text View

1. Select a schedule in the System Tree pane.
2. In the Schedule Editor, click the Advanced tab.
3. In the Schedule Event Tree, complete one of the following tasks:
• To modify an exception, expand the Exceptions folder and Priority x
folder. Then, select an exception.
• To modify a day, expand the Weekly folder and select a day.

4. Click the Text View button .

5. Right-click on the time period that you want to modify and click Properties
Properties.
6. Edit the properties.
Component Description

Hour Enter the hour portion of the time that you want the schedule
Value to be set to.
Select Any hour if you want the schedule to be evaluated every
hour at the defined minute, second, and hundredths of a
second.

Minute Enter the minute portion of the time that you want the schedule
Value to be set to.
Select Any minute if you want the schedule to be evaluated
every minute at the defined hour, second, and hundredths of a
second.

Second Enter the second portion of the time that you want the schedule
Value to be set to.
Select Any second if you want the schedule to be evaluated
every second at the defined hour, minute, and hundredths of a
second.

Hundredths Enter the hundredths of a second portion of the time that you
want the schedule Value to be set to.
Select Any hundredths if you want the schedule to be
evaluated every hundredths at the defined hour, minute, and
seconds.

Value Enter a value to write to the property reference at the scheduled

time, such as True.

04-30005-01-en, May 2019 System

1401
47 Schedule Editor
47.9 Modifying a Schedule Using the Text View

7. Click OK
OK.
8. On the File menu, click Save
Save.

System 04-30005-01-en, May 2019

1402
 47 Schedule Editor
47.10 Modifying a Schedule Using the Graphic View

47.10 Modifying a Schedule Using the

Graphic View
Use the Graphic View of the Advanced Schedule editor to edit the properties of
an exception or weekly event.
For more information, see section 47.3 “Advanced View of the Schedule Editor ”
on page 1393.

To modify a schedule using the Graphic View

1. Select a schedule in the System Tree pane.
2. In the Schedule Editor, click the Advanced tab.
3. In the Schedule Event Tree, choose one of the following tasks:
• To modify an exception, expand the Exceptions folder and Priority x
folder. Then, select an exception.
• To modify a day, expand the Weekly folder and select a day.

4. Click the Graphic View button .

5. Right-click on the time period that you want to modify and click Properties
Properties.
6. Edit the properties.
Component Description

Value Enter the value associated with the event.

Start Time Click the up or down arrows to select the hours, minutes, and
seconds for the start time. You can also type the time if you
want.

End Time Click the up or down arrows to select the hours, minutes, and
seconds for the end time. You can also type the time if you
want.

No End Time Click the checkbox to have the event last all day.

7. Click OK
OK.
8. On the File menu, click Save
Save.

04-30005-01-en, May 2019 System

1403
47 Schedule Editor
47.11 Schedule Colors in WorkStation

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

47.11.1 Basic Schedule View

In the Event grid, weekly events and exception events display in distinct colors
to clearly identify them. Similar events that are next to each other are highlighted
in different shades of the same color so you can easily see the start and stop
time. For example, a meeting scheduled from 8:00 to 12:00 is dark green while
the weekday event from 12:00 to 17:00 is in light green. In the Calendar view,
you can view the weekly events and exception events across several months
and the selected day in black.

Figure: Basic Schedule Editor colors

Table: Basic Schedule Editor Colors

Color Description

Cream Event grid: default value

Green Event grid: weekly events

Blue Event grid: exception events

Light blue Calendar view: exception events

Black Calendar view: selected day

System 04-30005-01-en, May 2019

1404
 47 Schedule Editor
47.11 Schedule Colors in WorkStation

Priority Level Conflicts

The Event grid also highlights a conflict in dark blue if there are two exception
events that overlap on the same day and have different values, but are set at the
same priority level.

Figure: Priority level conflict

For more information, see section 47.5 “Priorities” on page 1396.

47.11.2 Advanced Schedule View

In the Event gride, weekly and exception events are both green in the Advanced
Schedule. Events that are next to each other in the schedule are presented in
different intensities of green so you can easily see the start and stop time of
these events. In the Calendar view, you can view the exception events
presented in light blue. The selected event is presented in a darker blue.

04-30005-01-en, May 2019 System

1405
47 Schedule Editor
47.11 Schedule Colors in WorkStation

Figure: Advanced Schedule Editor colors

Table: Advanced Schedule Editor Colors

Color Description

White Event grid: default value

Green Event grid: weekly and exception events

Light blue Calendar view: exception events

Blue Calendar view: selected exception event

System 04-30005-01-en, May 2019

1406
48 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
 48 Schedule Types
48.1 Schedule Types

48.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.

48.1.1 Analog Schedules

An analog schedule controls a device that gauges the output in real numbers.
The real numbers include positive or negative numbers, fractions, and decimal
values.
For more information, see section 48.8 “Analog Schedules” on page 1416.

48.1.2 Digital Schedules

A digital schedule controls a device that has an on output state and an off output
state.
For more information, see section 48.2 “Digital Schedules” on page 1410.

48.1.3 Multistate Schedules

A multistate schedule controls a device that has output states based on integers
or positive whole numbers including zero.
For more information, see section 48.5 “Multistate Schedules” on page 1413.

04-30005-01-en, May 2019 System

1409
48 Schedule Types
48.2 Digital Schedules

48.2 Digital Schedules

A digital schedule controls a device that has an on output state and an off output
state.
For example, you can create a digital weekly schedule that is bound to a digital
output, such as a light switch. To turn on the lights Monday through Friday from
08:00 to 17:00, you can set the value to On when the schedule is active and Off
when the schedule is inactive.

Figure: Digital Schedule

System 04-30005-01-en, May 2019

1410
 48 Schedule Types
48.3 Creating a Digital Schedule

48.3 Creating a Digital Schedule

You create a digital schedule to control the state of a digital value.
For more information, see section 48.2 “Digital Schedules” on page 1410.

To create a digital schedule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
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 Create Object wizard, 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-30005-01-en, May 2019 System

1411
48 Schedule Types
48.4 Binding a Digital Value to a Digital Schedule

48.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 46.2 “Schedule Bindings” on page 1387.

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 Bindings View, 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.
5. Drag the digital schedule to the Binding column for the digital value.

6. On the File menu, click Save

Save.

System 04-30005-01-en, May 2019

1412
 48 Schedule Types
48.5 Multistate Schedules

48.5 Multistate Schedules

A multistate schedule controls a device that has output states based on integers
or positive whole numbers including zero.
For example, you can create a multistate weekly schedule that is bound to a
multistate value to control an air handler unit in an office building. To regulate the
air circulation Monday through Friday from 08:00 to 17:00, you can set the value
to 2 (occupied) when the schedule is active and 1 (unoccupied) when the
schedule is inactive.

Figure: Multistate Schedule

04-30005-01-en, May 2019 System

1413
48 Schedule Types
48.6 Creating a Multistate Schedule

48.6 Creating a Multistate Schedule

You create a multistate schedule to control the state of a multistate value.
For more information, see section 48.5 “Multistate Schedules” on page 1413.

To create a multistate schedule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
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 Create Object wizard, 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.

System 04-30005-01-en, May 2019

1414
 48 Schedule Types
48.7 Binding a Multistate Value to a Multistate Schedule

48.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 46.2 “Schedule Bindings” on page 1387.

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 Bindings View, 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 .

04-30005-01-en, May 2019 System

1415
48 Schedule Types
48.8 Analog Schedules

48.8 Analog Schedules

An analog schedule controls a device that gauges the output in real numbers.
The real numbers include positive or negative numbers, fractions, and decimal
values.
For example, you can create an analog schedule to regulate a thermostat
setpoint in an office area. To control the temperature from 08:00 to 17:00, you
can set the value to 22 °C (70 °F) when the schedule is active and 16 °C (62 °F)
when the schedule is inactive.

Figure: Analog Schedule

System 04-30005-01-en, May 2019

1416
 48 Schedule Types
48.9 Creating an Analog Schedule

48.9 Creating an Analog Schedule

You create an analog schedule to control the state of an analog value.
For more information, see section 48.8 “Analog Schedules” on page 1416.

To create an analog schedule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server or the folder.
2. On the File menu, point to New and then click Schedule
Schedule.
3. In the Create Object wizard, 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 the schedule to an
analog value.

04-30005-01-en, May 2019 System

1417
48 Schedule Types
48.10 Binding an Analog Value to an Analog Schedule

48.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 46.2 “Schedule Bindings” on page 1387.

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 Bindings View, 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 .

System 04-30005-01-en, May 2019

1418
49 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
Adding a Weekly Event
Editing a Weekly Event
Exception Events in WorkStation
Adding a Date Exception Event
Editing a Date Exception Event
Adding a Date Range Exception Event
Editing a Date Range Exception Event
Adding a Calculated Exception Event
Editing a Calculated Exception Event
Adding a Calendar Exception Event
Editing a Calendar Exception Event
Deleting an Exception Event from a Schedule
Adding a Weekly Event to a Xenta Schedule
Editing a Weekly Event in a Xenta Schedule
Deleting a Weekly Event from a Xenta Schedule
Adding an Exception Event to a Xenta Schedule
49 Editing an Exception Event in a Xenta Schedule
Deleting an Exception Event from a Xenta Schedule
 49 Schedule Events
49.1 Schedule Events

49.1 Schedule Events

A schedule can have two types of events: weekly events and exception
events. Weekly events occur every week at specified times. Exception
events occur when the schedule deviates from the weekly schedule, such as
during holidays. Exception events override the weekly events when there is an
overlap.
For each schedule except Xenta schedules, 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
Xenta schedules do not have any default values.
Example:
The weekly event for a fan is set to '08:00 - 17:00'. An exception event is set to
'17:00 - 20:00' for a specific date. The exception event overrides the weekly
event so that the fan only runs from 17:00 to 20:00 on the specified date.
Xenta schedule events occur in the following order of precedence:
• Exception events
• Weekly events

49.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 49.4 “Weekly Events in WorkStation” on page
1425.

49.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 the Weekly Events in WebStation topic on WebHelp.

49.1.3 Exception Events in WorkStation

An exception event occurs instead of the scheduled weekly events for a single
date, date range, calculated date, or calendar reference.

04-30005-01-en, May 2019 System

1421
49 Schedule Events
49.1 Schedule Events

For more information, see section 49.7 “Exception Events in WorkStation” on

page 1428.

49.1.4 Exception Events in WebStation

An exception event occurs instead of the scheduled weekly events for a single
date, date range, calculated date, or calendar reference.
For more information, see the Exception Events in WebStation topic on
WebHelp.

49.1.5 Priorities
Priority is a number that corresponds to a preassigned level of importance.
When used in schedules, priority numbers range from one to sixteen. One is the
most important or highest priority and sixteen is the lowest priority.
For more information, see section 47.5 “Priorities” on page 1396.

49.1.6 Time Zones

When you create a schedule, the time zone of the EcoStruxure BMS server that
contains the schedule determines the execution of the events. If the schedule is
copied to an EcoStruxure BMS server in a different time zone, the specified
dates and times relate to the new time zone.
For more information, see section 47.4 “Time Zones” on page 1395.

System 04-30005-01-en, May 2019

1422
 49 Schedule Events
49.2 Displaying Client Time and Server Time in a Schedule

49.2 Displaying Client Time and Server Time

in a Schedule
You display the client time and the EcoStruxure BMS 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-30005-01-en, May 2019 System

1423
49 Schedule Events
49.3 Deleting a Date List Entry from a Calendar

49.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-30005-01-en, May 2019

1424
 49 Schedule Events
49.4 Weekly Events in WorkStation

49.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.

Figure: Weekly events in an EcpStruxure Building Operation schedule

If there are any non-routine events, such as holidays, you can use exception
events to override the schedule. For more information, see section 49.7
“Exception Events in WorkStation” on page 1428.

04-30005-01-en, May 2019 System

1425
49 Schedule Events
49.5 Adding a Weekly Event

49.5 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 49.4 “Weekly Events in WorkStation” on page
1425.

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-30005-01-en, May 2019

1426
 49 Schedule Events
49.6 Editing a Weekly Event

49.6 Editing a Weekly Event

You edit a weekly event to change the information about a weekly event on a
single day.

To edit a weekly 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 weekly event you want to edit.

4. On the Basic toolbar, click the Edit schedule event button .

5. In the Schedule event properties dialog box, edit the properties.
Component Description

Event type Click Weekly to select a weekly event

type.

Days of week Select the days of the week that apply to

this schedule.

All Day Select to create an all day event.

Click to add a line to the Times and

values box.

Click to delete an entry from the Times

and values box.

6. Click Ok
Ok.

04-30005-01-en, May 2019 System

1427
49 Schedule Events
49.7 Exception Events in WorkStation

49.7 Exception Events in WorkStation

An exception event occurs instead of the scheduled weekly events for a single
date, date range, calculated date, or 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.

49.7.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

49.7.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-30005-01-en, May 2019

1428
 49 Schedule Events
49.7 Exception Events in WorkStation

49.7.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

49.7.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-30005-01-en, May 2019 System

1429
49 Schedule Events
49.8 Adding a Date Exception Event

49.8 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 49.7 “Exception Events in WorkStation” on
page 1428.

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

.
4. Click Exception
Exception.
5. In Schedule Event Properties dialog box, 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.
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-30005-01-en, May 2019

1430
 49 Schedule Events
49.9 Editing a Date Exception Event

49.9 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 containing
the date exception event you want to edit.
2. Click the Basic tab.
3. In the calendar view, select the date when the date exception event you
want to edit is valid.

4. In the event grid, select the date exception event you want to edit.

5. Click the Edit schedule event button .

6. In the Schedule Event Properties dialog box, 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.

Click to add a line to the Times and values box.

Click to delete an entry from the Times and values box.

All Day Select to create an all day event.

04-30005-01-en, May 2019 System

1431
49 Schedule Events
49.9 Editing a Date Exception Event

Continued
Component Description

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
Day,
Last day
day, Odd days or Even days 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.

7. Click OK
OK.

System 04-30005-01-en, May 2019

1432
 49 Schedule Events
49.10 Adding a Date Range Exception Event

49.10 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 .

4. In the Schedules Event Properties dialog box, 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.
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-30005-01-en, May 2019 System

1433
49 Schedule Events
49.11 Editing a Date Range Exception Event

49.11 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 containing
the date range exception event you want to edit.
2. Click the Basic tab.
3. In the calendar view, select the date when the date range exception event
you want to edit is valid.

4. In the event grid, select the date range exception event you want to edit.

5. Click the Edit schedule event button .

6. In the Schedule Event Properties dialog box, 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.

Click to add a line to the Times and values box.

Click to delete an entry from the Times and values box.

All Day Select to create an all day event.

Name Type a name for the event.

System 04-30005-01-en, May 2019

1434
 49 Schedule Events
49.11 Editing a Date Range Exception Event

Continued
Property Description

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
Day,
Last day
day, Odd days or Even days 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.

7. Click OK
OK.

04-30005-01-en, May 2019 System

1435
49 Schedule Events
49.12 Adding a Calculated Exception Event

49.12 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 .

4. In the Schedule Event Properties dialog box, 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.

System 04-30005-01-en, May 2019

1436
 49 Schedule Events
49.13 Editing a Calculated Exception Event

49.13 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 .

5. In the Schedule Event Properties dialog box, 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.

Click to add a line to the Times and values box.

Click to delete an entry from the Times and values box.

All Day Select to create 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 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
week, Second week
week, Third week
week, Fourth week
week, Last week
week,
Any week
week.
• First week – the first through the seventh day of the
month. The second week is then considered day of month
eight through fourteen and so on. Since the dates do not
necessarily correspond to the first row of the calendar,
they may include dates from both the first and second row
of the calendar.
• Fifth week – days 29 through 31 if they exist. It is always
less than seven days and is non-existent in February
except in a leap year.
• Last week – the last seven days of the month. It differs
from the Fifth week
week.

Continued on next page

04-30005-01-en, May 2019 System

1437
49 Schedule Events
49.13 Editing a Calculated Exception Event

Continued
Property Description

Day of week Select a day of the week. Setting the value to Any Day ensures
consistency with the rest of the date specification, this is the
recommended setting.

6. Click OK
OK.

System 04-30005-01-en, May 2019

1438
 49 Schedule Events
49.14 Adding a Calendar Exception Event

49.14 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 50.2 “Calendars in WorkStation” on page
1452.

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

.
4. In the Schedule Event Properties dialog box, 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.
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.

NOTICE
• 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-30005-01-en, May 2019 System

1439
49 Schedule Events
49.15 Editing a Calendar Exception Event

49.15 Editing a Calendar Exception Event

You edit a calendar exception event to change the information about an
exception event.

To edit a calendar exception event

1. In WorkStation, in the System Tree pane, select the schedule containing
the calendar exception event you want to edit.
2. Click the Basic tab.
3. In the calendar view, select the date when the calendar exception event
you want to edit is valid.

4. In the event grid, select the clendar exception event you want to edit.

5. Click the Edit schedule event button .

6. In the Schedule Event Properties dialog box, edit the properties:
Property Description

Event type Click Exception to display the exception types.

Exception type Select Calendar to initiate a calendar reference.

All Day Select to create an all day event.

Click to add a line to the Times and values box.

Click to delete an entry from the Times and values box.

Continued on next page

System 04-30005-01-en, May 2019

1440
 49 Schedule Events
49.15 Editing a Calendar Exception Event

Continued
Property Description

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.

7. Click OK
OK.
8. On the File menu, click Save
Save.

04-30005-01-en, May 2019 System

1441
49 Schedule Events
49.16 Deleting an Exception Event from a Schedule

49.16 Deleting an Exception Event from a

Schedule
You delete an exception event from a schedule when the exception is no longer
valid.

To delete an exception event from a schedule

1. In WorkStation, in the System Tree pane, select the schedule that you want
to modify.
2. Click the Advanced tab of the Schedule Editor.
3. In the Schedule Event Tree, expand the Exceptions folder.

4. Select the event and click the Delete button .

System 04-30005-01-en, May 2019

1442
 49 Schedule Events
49.17 Adding a Weekly Event to a Xenta Schedule

49.17 Adding a Weekly Event to a Xenta

Schedule
You add weekly events to a Xenta schedule to determine when the event is to
regularly occur. Weekly events always occur regularly unless overridden by an
exception event.

NOTICE
You cannot add, edit, or delete schedule events in a Xenta Schedule when a
Xenta Central schedule has been assigned to it.
The number of events a Xenta Central schedule can have is determined by the
Menta application.

For more information, see the Schedules for Xenta LonWorks Devices topic on
WebHelp.

To add a weekly event to a Xenta schedule

1. In WorkStation, in the System Tree pane, select the schedule to which you
want to add the weekly event.

2. In the Xenta Schedule editor, click the New button for a weekly event.
3. In the Xenta Schedule dialog box, in the Time interval box, select the time
range for the weekly event.
4. In the Start time box, enter the time when the weekly event starts.
5. In the End time box, enter the time when the weekly event ends.
6. Select the weekdays the weekly event is to be in service.
7. Click OK
OK.

04-30005-01-en, May 2019 System

1443
49 Schedule Events
49.18 Editing a Weekly Event in a Xenta Schedule

49.18 Editing a Weekly Event in a Xenta

Schedule
You edit a weekly event to change the time range, start and stop time, or
weekdays of the weekly event.

NOTICE
You cannot add, edit, or delete schedule events in a Xenta Schedule when a
Xenta Central schedule has been assigned to it.
The number of events a Xenta Central schedule can have is determined by the
Menta application.

For more information, see the Schedules for Xenta LonWorks Devices topic on
WebHelp.

To edit a weekly event in a Xenta schedule

1. In WorkStation, in the System Tree pane, select the schedule containing
the weekly event you want to edit.
2. In the Xenta Schedule editor, in the weekly event table, select the event

and click the Edit button .

3. In the Time interval box, select the time range the weekly event is to be in
service.
4. In the Start time box, enter the time when the weekly event starts.
5. In the End time box, enter the time when the weekly event ends.
6. Select the weekdays the weekly event starts.
7. Click OK
OK.

System 04-30005-01-en, May 2019

1444
 49 Schedule Events
49.19 Deleting a Weekly Event from a Xenta Schedule

49.19 Deleting a Weekly Event from a Xenta

Schedule
You delete a weekly event when the event is no longer to regularly occur.

NOTICE
You cannot add, edit, or delete schedule events in a Xenta Schedule when a
Xenta Central schedule has been assigned to it.
The number of events a Xenta Central schedule can have is determined by the
Menta application.

For more information, see the Schedules for Xenta LonWorks Devices topic on
WebHelp.

To delete a weekly event from a Xenta schedule

1. In WorkStation, in the System Tree pane, select the schedule containing
the weekly event you want to delete.
2. In the Xenta Schedule editor, in the weekly event table, select the event

and click the Delete button .

04-30005-01-en, May 2019 System

1445
49 Schedule Events
49.20 Adding an Exception Event to a Xenta Schedule

49.20 Adding an Exception Event to a Xenta

Schedule
You add an exception event to configure an exception that is to apply instead of
a scheduled weekly event for a single date, date range, or a time pair.

NOTICE
You cannot add, edit, or delete schedule events in a Xenta Schedule when a
Xenta Central schedule has been assigned to it.
The number of events a Xenta Central schedule can have is determined by the
Menta application.

NOTICE
An added exception event overrides any weekly events for all of the selected
days.

For more information, see the Schedules for Xenta LonWorks Devices topic on
WebHelp.

To add an exception event to a Xenta schedule

1. In WorkStation, in the System Tree pane, select the schedule to which you
want to add the exception event.

2. In the Xenta Schedule editor, click the New button for an exception
event.
3. In the Xenta Schedule dialog box, in the Time span box, select the time
range the exception event is to be in service.
4. In the Start date box, enter the date when the exception event starts.
5. In the End date box, enter the date when the exception event ends.
6. In the Start time box, enter the time when the exception event starts.
7. In the End time box, enter the time when the exception event ends.
8. Select the weekdays the exception event is to be in service.
9. Click OK
OK.

System 04-30005-01-en, May 2019

1446
 49 Schedule Events
49.21 Editing an Exception Event in a Xenta Schedule

49.21 Editing an Exception Event in a Xenta

Schedule
You edit an exception event to change the time range, start and stop date, start
and stop time, or weekdays of an exception event.

NOTICE
You cannot add, edit, or delete schedule events in a Xenta Schedule when a
Xenta Central schedule has been assigned to it.
The number of events a Xenta Central schedule can have is determined by the
Menta application.

For more information, see the Schedules for Xenta LonWorks Devices topic on
WebHelp.

To edit an exception event in a Xenta schedule

1. In WorkStation, in the System Tree pane, select the schedule containing
the exception event you want to edit.
2. In the Xenta Schedule editor, in the exception event table, select the event

and click the Edit button .

3. In the Time span box, select the time range the exception event is to be in
service.
4. In the Start date box, enter the date when the exception event starts.
5. In the End date box, enter the date when the exception event ends.
6. In the Start time box, enter the time when the exception starts.
7. In the End time box, enter the time when the exception ends.
8. Select the weekdays the exception event starts.
9. Click OK
OK.

04-30005-01-en, May 2019 System

1447
49 Schedule Events
49.22 Deleting an Exception Event from a Xenta Schedule

49.22 Deleting an Exception Event from a

Xenta Schedule
You delete an exception event when you no longer need the exception to make
an exception from a weekly event.

NOTICE
You cannot add, edit, or delete schedule events in a Xenta Schedule when a
Xenta Central schedule has been assigned to it.
The number of events a Xenta Central schedule can have is determined by the
Menta application.

For more information, see the Schedules for Xenta LonWorks Devices topic on
WebHelp.

To delete an exception event from a Xenta schedule

1. In WorkStation, in the System Tree pane, select the schedule containing
the exception event you want to delete.
2. In the Xenta Schedule editor, in the exception event table, select the event

and click the Delete button .

System 04-30005-01-en, May 2019

1448
50 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
 50 Calendars
50.1 Calendar Editor Overview

50.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-30005-01-en, May 2019 System

1451
50 Calendars
50.2 Calendars in WorkStation

50.2 Calendars in WorkStation

A calendar is a list of dates. The calendar provides the schedule with the dates
when the exception events shall occur. To save time, you can reference a single
calendar rather than entering several exception events in a schedule.

Figure: Exception events in a calendar

Many schedules can make a reference to the calendar. You can define the
group of dates once rather than over and over again in multiple schedules, a
potentially tedious task if your building control system contains many schedules.

50.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 50.1 “Calendar Editor Overview” on page
1451.

50.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 50.3 “Calendar Events” on page 1453.

System 04-30005-01-en, May 2019

1452
 50 Calendars
50.3 Calendar Events

50.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

50.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.

50.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.

04-30005-01-en, May 2019 System

1453
50 Calendars
50.3 Calendar Events

50.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.

System 04-30005-01-en, May 2019

1454
 50 Calendars
50.4 Creating a Calendar

50.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 50.2 “Calendars in WorkStation” on page
1452.

To create a calendar
1. In WorkStation, in the System Tree pane, select the folder or EcoStruxure
BMS server where you want to create the calendar.
2. On the File menu, point to New and then click Schedule
Schedule.
3. On the Choosing the Type and Naming the Object page, in the object type
list, select Calendar
Calendar.
4. In the Name box, type a name for the 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-30005-01-en, May 2019 System

1455
50 Calendars
50.5 Adding a Date Calendar Event

50.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 50.3 “Calendar Events” on page 1453.

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 Edit Calendar Entry dialog box, 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.
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.

System 04-30005-01-en, May 2019

1456
 50 Calendars
50.6 Adding a Date Range Calendar Event

50.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 50.3 “Calendar Events” on page 1453.

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 Edit Calendar Entry dialog box, 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.
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-30005-01-en, May 2019 System

1457
50 Calendars
50.7 Adding a Calculated Date Calendar Event

50.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 50.3 “Calendar Events” on page 1453.

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 Edit Calendar Entry dialog box, 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.
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.

System 04-30005-01-en, May 2019

1458
 50 Calendars
50.8 Configuring a Calendar as a Shadow

50.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.

NOTICE
• Schedules cannot refer to a calendar located on another EcoStruxure BMS
server. You need to create shadow calendars in all EcoStruxure BMS
servers that contain schedules that are to refer to the calendar.

For more information, see section 50.13 “Schedule and Calendar

Synchronization” on page 1464.

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 Calendar properties, in the Lead object box, enter the calendar that
you want to synchronize the shadow calendar with.
4. Click OK
OK.

04-30005-01-en, May 2019 System

1459
50 Calendars
50.9 Storing Expired Calendar Events

50.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 Basic tab, in the Remove past events box, select False to keep all
events. Selecting True will remove events that are older than 60 days.

4. Click the Save button .

System 04-30005-01-en, May 2019

1460
 50 Calendars
50.10 Editing a Date Calendar Event

50.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.
4. In the Edit Calendar Entry dialog box, 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
Day, Last day
day, Odd days or Even days 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-30005-01-en, May 2019 System

1461
50 Calendars
50.11 Editing a Date Range Calendar Event

50.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.
4. In the Edit Calendar Entry dialog box, 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
Day, Last day
day, Odd days or Even days 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.

System 04-30005-01-en, May 2019

1462
 50 Calendars
50.12 Editing a Calculated Date Calendar Event

50.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.
4. In the Edit Calendar Entry dialog box, 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
week, Second week
week, Third week
week, Fourth week
week, Last week
week,
Any week
week.
• First week – the first through the seventh day of the
month. Be aware that it does not necessarily
correspond to the first row of the calendar since it may
include dates from both the first and second row of the
calendar.
• Fifth week – days 29 through 31 if they exist. It is
always less than seven days and is non-existent in
February except in a leap year.
• Last week – the last seven days of the month. It differs
from the Fifth 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-30005-01-en, May 2019 System

1463
50 Calendars
50.13 Schedule and Calendar Synchronization

50.13 Schedule and Calendar Synchronization

When you configure a schedule that controls events in a single part of a
building, you might also want the same events to occur in other areas of the
building. You can establish a lead and shadow relationship to synchronize the
events in schedules and dates in calendars.
For 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.
EcoStruxure BMS supports lead and shadow schedules where exception
events, weekly events, and other configuration properties are duplicated in the
shadow schedules.

System 04-30005-01-en, May 2019

1464
 50 Calendars
50.13 Schedule and Calendar Synchronization

EcoStruxure BMS also supports lead and shadow calendars where the date list
is duplicated in the shadow calendars.

04-30005-01-en, May 2019 System

1465
51 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 Submenu
Show Client Time Zone
Analog Schedule Properties – Basic Tab
Schedule Properties - Boolean Time Value Pair
Schedule Properties - Enumerated Time Value Pair
Schedule Properties - Integer Time Value Pair
Schedule Properties - On Off Time Value Pair
Schedule Properties - Real Time Value Pair
Schedule Properties - Unsigned Time Value Pair
Schedule Event Properties Dialog Box – Weekly View
Schedule Event Properties Dialog Box – Single Date
Exception View
51 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
Xenta Schedule Editor
Xenta Schedule Dialog Box
 51 Schedules User Interface
51.1 Schedule Editor – Basic View

51.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. For more
information, see section 47.2 “Basic View of the Schedule Editor” on
page 1392.

Basic View toolbar

Displays the toolbar to manage schedules. For more information, see
section 51.2 “Basic Schedule Editor Toolbar ” on page 1470.

Event grid
Displays weekly and exception events in Graphic view.
An Unable to display events error message displays when there is any
scheduled event (weekly or exception) less than 5 minutes in length on a
particular day. To view or change this scheduled event, use the Text
view in the Advanced Tab. For more information, see section 47.9
“Modifying a Schedule Using the Text View” on page 1401.

04-30005-01-en, May 2019 System

1469
51 Schedules User Interface
51.2 Basic Schedule Editor Toolbar

51.2 Basic Schedule Editor Toolbar

Use the Basic Schedule Editor toolbar to manage schedules.

Table: Basic Schedule Editor Toolbar

Button Description

New schedule event

Click to create a new schedule event.

Edit schedule events

Click to edit a selected event.

Delete
Click to delete events in the schedule.

View all schedule events

Click to display weekly and exception events for the selected week.

View weekly schedule events

Click to display weekly events.

System 04-30005-01-en, May 2019

1470
 51 Schedules User Interface
51.3 Advanced Schedule Editor – Graphic View

51.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

Schedule event tree

Displays weekly and exception events.

Client and server time bar

Displays the client time and the EcoStruxure BMS server time.

Advanced view toolbar

Click the buttons to manage schedules. For more information, see section
51.4 “Advanced Schedule Editor Toolbar ” on page 1472.

Time value periods

Displays the beginning and end times and the values associated with the
scheduled events.

Calendar overview
Displays in blue the dates that contain exception events.

04-30005-01-en, May 2019 System

1471
51 Schedules User Interface
51.4 Advanced Schedule Editor Toolbar

51.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 for selected date

Click to display all the configured events for a selected day.

Add Exception
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.

System 04-30005-01-en, May 2019

1472
 51 Schedules User Interface
51.5 Edit Effective Period Dialog Box

51.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
Day, Last
day
day, Odd days or Even days 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.

04-30005-01-en, May 2019 System

1473
51 Schedules User Interface
51.6 Edit Exception Dialog Box

51.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.

System 04-30005-01-en, May 2019

1474
 51 Schedules User Interface
51.7 Edit Time Value Period Dialog Box

51.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 Enter the value associated with the event.

Start Time Click the up or down arrows to select the hours, minutes, and
seconds for the start time. You can also type the time if you want.

End Time Click the up or down arrows to select the hours, minutes, and
seconds for the end time. You can also type the time if you want.

No End Time Click the checkbox to have the event last all day.

04-30005-01-en, May 2019 System

1475
51 Schedules User Interface
51.8 Snap To Submenu

51.8 Snap To Submenu

Use the Snap To menu to edit the grid time interval for the shedule view to
define how precis you can be when editing the time span of a schedule event
using the drag and drop method in the Advanced Schedule Editor. The default
time interval is 15 minutes.

Figure: Snap To submenu

System 04-30005-01-en, May 2019

1476
 51 Schedules User Interface
51.9 Show Client Time Zone

51.9 Show Client Time Zone

Use Show client time zone to toggle between displaying the client time zone in
addition to the EcoStruxure BMS server time zone in the Advanced Schedule
Editor.

Figure: Show Client Time Zone

04-30005-01-en, May 2019 System

1477
51 Schedules User Interface
51.10 Analog Schedule Properties – Basic Tab

51.10 Analog Schedule Properties – Basic

Tab
Use the Basic tab to view the schedule status information and to configure the
schedule.

Figure: Analog Schedule properties – Basic tab

Table: Analog Schedule Properties – Basic Tab

Component Description

Value Select the value associated with the 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 valuea Displays what the Value property will be

when it next changes.

Next transition timea Displays the date and time the value will
change.

System 04-30005-01-en, May 2019

1478
 51 Schedules User Interface
51.10 Analog Schedule Properties – Basic Tab

Continued
Component Description

Time to next transition (min)a Displays the amount of time in minutes

before the value changes.

Following transition valuea Displays the subsequent value following

the next transition value.

Following transition timea Displays the subsequent date and time

following the next transition time.

Time to following transition (min)a 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 delete

events older than 72 hours.

Effective period Enter the range of time a schedule is in

service.

Default value Select the value of the schedule when

there are no events in effect.

Lead object Select a lead schedule to reference.

a) The schedule only looks 8 days into the future to obtain this value. If there is no transition in the
next 8 days, the maximum date and time will be displayed.

04-30005-01-en, May 2019 System

1479
51 Schedules User Interface
51.11 Schedule Properties - Boolean Time Value Pair

51.11 Schedule Properties - Boolean Time

Value Pair
Use the Basic tab to configure the time and value pair for a property reference
with the boolean datatype of true or false.

Figure: Basic tab

Table: Basic Tab

Component Description

Hour Enter the hour portion of the time that you

want the schedule Value to be set to.
Select Any hour if you want the schedule
to be evaluated every hour at the defined
minute, second, and hundredths of a
second.

Minute Enter the minute portion of the time that

you want the schedule Value to be set to.
Select Any minute if you want the
schedule to be evaluated every minute at
the defined hour, second, and hundredths
of a second.

Second Enter the second portion of the time that

you want the schedule Value to be set to.
Select Any second if you want the
schedule to be evaluated every second at
the defined hour, minute, and hundredths
of a second.

System 04-30005-01-en, May 2019

1480
 51 Schedules User Interface
51.11 Schedule Properties - Boolean Time Value Pair

Continued
Component Description

Hundredths Enter the hundredths of a second portion

of the time that you want the schedule
Value to be set to.
Select Any hundredths if you want the
schedule to be evaluated every
hundredths at the defined hour, minute,
and seconds.

Value Enter a value to write to the property

reference at the scheduled time, such as
True.

04-30005-01-en, May 2019 System

1481
51 Schedules User Interface
51.12 Schedule Properties - Enumerated Time Value Pair

51.12 Schedule Properties - Enumerated Time

Value Pair
Use the Basic tab to configure the time and value pair for a property reference
with a datatype of enumerated.

Figure: Basic tab

Table: Basic Tab

Property Description

Hour Enter the hour portion of the time that you want the schedule Value to
be set to.
Select Any hour if you want the schedule to be evaluated every hour
at the defined minute, second, and hundredths of a second.

Minute Enter the minute portion of the time that you want the schedule Value
to be set to.
Select Any minute if you want the schedule to be evaluated every
minute at the defined hour, second, and hundredths of a second.

Second Enter the second portion of the time that you want the schedule Value
to be set to.
Select Any second if you want the schedule to be evaluated every
second at the defined hour, minute, and hundredths of a second.

Hundredths Enter the hundredths of a second portion of the time that you want the
schedule Value to be set to.
Select Any hundredths if you want the schedule to be evaluated
every hundredths at the defined hour, minute, and seconds.

Value Enter a value with the datatype of enumerated to be written to the

property reference at the scheduled time.

System 04-30005-01-en, May 2019

1482
 51 Schedules User Interface
51.13 Schedule Properties - Integer Time Value Pair

51.13 Schedule Properties - Integer Time

Value Pair
Use the Basic tab to configure the time and value pair for a property reference
with a datatype of integer.

Figure: Basic tab

Table: Basic Tab

Property Description

Hour Enter the hour portion of the time that you want the schedule Value to
be set to.
Select Any hour if you want the schedule to be evaluated every hour
at the defined minute, second, and hundredths of a second.

Minute Enter the minute portion of the time that you want the schedule Value
to be set to.
Select Any minute if you want the schedule to be evaluated every
minute at the defined hour, second, and hundredths of a second.

Second Enter the second portion of the time that you want the schedule Value
to be set to.
Select Any second if you want the schedule to be evaluated every
second at the defined hour, minute, and hundredths of a second.

Hundredths Enter the hundredths of a second portion of the time that you want the
schedule Value to be set to.
Select Any hundredths if you want the schedule to be evaluated
every hundredths at the defined hour, minute, and seconds.

Value Enter a value with the datatype of integer to be written to the property
reference at the scheduled time.

04-30005-01-en, May 2019 System

1483
51 Schedules User Interface
51.14 Schedule Properties - On Off Time Value Pair

51.14 Schedule Properties - On Off Time

Value Pair
Use the Basic tab to configure the time and value pair for a property reference
with a value of on or off.

Figure: Basic tab

Table: Basic Tab

Property Description

Hour Enter the hour portion of the time that you want the schedule Value to
be set to.
Select Any hour if you want the schedule to be evaluated every hour
at the defined minute, second, and hundredths of a second.

Minute Enter the minute portion of the time that you want the schedule Value
to be set to.
Select Any minute if you want the schedule to be evaluated every
minute at the defined hour, second, and hundredths of a second.

Second Enter the second portion of the time that you want the schedule Value
to be set to.
Select Any second if you want the schedule to be evaluated every
second at the defined hour, minute, and hundredths of a second.

Hundredths Enter the hundredths of a second portion of the time that you want the
schedule Value to be set to.
Select Any hundredths if you want the schedule to be evaluated
every hundredths at the defined hour, minute, and seconds.

Value Select On or Off to write the value to the property reference at the
scheduled time.

System 04-30005-01-en, May 2019

1484
 51 Schedules User Interface
51.15 Schedule Properties - Real Time Value Pair

51.15 Schedule Properties - Real Time Value

Pair
Use the Basic tab to configure the time and value pair for a property reference
with a datatype of real.

Figure: Basic tab

Table: Basic Tab

Property Description

Hour Enter the hour portion of the time that you want the schedule Value to
be set to.
Select Any hour if you want the schedule to be evaluated every hour
at the defined minute, second, and hundredths of a second.

Minute Enter the minute portion of the time that you want the schedule Value
to be set to.
Select Any minute if you want the schedule to be evaluated every
minute at the defined hour, second, and hundredths of a second.

Second Enter the second portion of the time that you want the schedule Value
to be set to.
Select Any second if you want the schedule to be evaluated every
second at the defined hour, minute, and hundredths of a second.

Hundredths Enter the hundredths of a second portion of the time that you want the
schedule Value to be set to.
Select Any hundredths if you want the schedule to be evaluated
every hundredths at the defined hour, minute, and seconds.

Value Enter a value with the datatype of real to be written to the property
reference at the scheduled time.

04-30005-01-en, May 2019 System

1485
51 Schedules User Interface
51.16 Schedule Properties - Unsigned Time Value Pair

51.16 Schedule Properties - Unsigned Time

Value Pair
Use the Basic tab to configure the time and value pair for a property reference
with a datatype of unsigned.

Figure: Basic tab

Table: Basic Tab

Property Description

Hour Enter the hour portion of the time that you want the schedule Value to
be set to.
Select Any hour if you want the schedule to be evaluated every hour
at the defined minute, second, and hundredths of a second.

Minute Enter the minute portion of the time that you want the schedule Value
to be set to.
Select Any minute if you want the schedule to be evaluated every
minute at the defined hour, second, and hundredths of a second.

Second Enter the second portion of the time that you want the schedule Value
to be set to.
Select Any second if you want the schedule to be evaluated every
second at the defined hour, minute, and hundredths of a second.

Hundredths Enter the hundredths of a second portion of the time that you want the
schedule Value to be set to.
Select Any hundredths if you want the schedule to be evaluated
every hundredths at the defined hour, minute, and seconds.

Value Enter a value with the datatype of unsigned to be written to the

property reference at the scheduled time.

System 04-30005-01-en, May 2019

1486
 51 Schedules User Interface
51.17 Schedule Event Properties Dialog Box – Weekly View

51.17 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.

Days of week Select the days of the week that apply to

this schedule.

Click to add a line to the Times and values

box.

04-30005-01-en, May 2019 System

1487
51 Schedules User Interface
51.17 Schedule Event Properties Dialog Box – Weekly View

Continued
Component Description

Click to delete an entry from the Times and

values box.

All day Select to create an all day event.

System 04-30005-01-en, May 2019

1488
 51 Schedules User Interface
51.18 Schedule Event Properties Dialog Box – Single Date Exception View

51.18 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.

Exception type Select Single date for the exception type to

apply to the schedule.

04-30005-01-en, May 2019 System

1489
51 Schedules User Interface
51.18 Schedule Event Properties Dialog Box – Single Date Exception View

Continued
Component Description

Click to add a line to the Times and values

box.

Click to delete an entry from the Times and

values box.

All Day Select to create an all day event.

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 DayDay, Last day
day, Odd days
or Even days 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-30005-01-en, May 2019

1490
 51 Schedules User Interface
51.19 Schedule Event Properties Dialog Box – Date Range Exception View

51.19 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.

Exception type Select Date range as an exception type to

apply to the schedule.

04-30005-01-en, May 2019 System

1491
51 Schedules User Interface
51.19 Schedule Event Properties Dialog Box – Date Range Exception View

Continued
Component Description

Click to add a line to the Times and values

box.

Click to delete an entry from the Times and

values box.

All Day Select to create 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 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 DayDay, Last day
day, Odd days
or Even days 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-30005-01-en, May 2019

1492
 51 Schedules User Interface
51.20 Schedule Event Properties Dialog Box – Calculated Exception View

51.20 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.

Exception type Select Calculated for an exception type to

apply to the schedule.

04-30005-01-en, May 2019 System

1493
51 Schedules User Interface
51.20 Schedule Event Properties Dialog Box – Calculated Exception View

Continued
Component Description

Click to add a line to the Times and values

box.

Click to delete an entry from the Times and

values box.

All Day Select to create 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
week, Second
week
week, Third week
week, Fourth week
week, Last
week
week, Any week
week.
• First week – the first through the
seventh day of the month. The second
week is then considered day of month
eight through fourteen and so on.
Since the dates do not necessarily
correspond to the first row of the
calendar, they may include dates
from both the first and second row of
the calendar.
• Fifth week – days 29 through 31 if
they exist. It is always less than seven
days and is non-existent in February
except in a leap year.
• Last week – the last seven days of the
month. It differs from the Fifth week
week.

System 04-30005-01-en, May 2019

1494
 51 Schedules User Interface
51.20 Schedule Event Properties Dialog Box – Calculated Exception View

Continued
Component Description

Week of month Select a week of the month for the

exception event or First week
week, Second
week
week, Third week
week, Fourth week
week, Last
week
week, Any week
week.
• First week – the first through the
seventh day of the month. Be aware
that it does not necessarily
correspond to the first row of the
calendar since it may include dates
from both the first and second row of
the calendar.
• Fifth week – days 29 through 31 if
they exist. It is always less than seven
days and is non-existent in February
except in a leap year.
• Last week – the last seven days of the
month. It differs from the Fifth 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-30005-01-en, May 2019 System

1495
51 Schedules User Interface
51.21 Schedule Event Properties Dialog Box – Calendar Reference View

51.21 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.

Exception type Select Calendar to initiate a calendar

reference.

System 04-30005-01-en, May 2019

1496
 51 Schedules User Interface
51.21 Schedule Event Properties Dialog Box – Calendar Reference View

Continued
Component Description

Click to add a line to the Times and values

box.

Click to delete an entry from the Times and

values box.

All Day Select to create 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.

04-30005-01-en, May 2019 System

1497
51 Schedules User Interface
51.22 Calendar Editor View

51.22 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 50.3 “Calendar Events” on
page 1453.

Use the Calendar Editor toolbar to add and delete calendar events. For
more information, see section 51.23 “Calendar Editor Toolbar” on page
1499.

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
50.1 “Calendar Editor Overview” on page 1451.

System 04-30005-01-en, May 2019

1498
 51 Schedules User Interface
51.23 Calendar Editor Toolbar

51.23 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 51.25 “Edit Calendar Entry Dialog Box – Add Date” on page
1501.

Add Date Range

Click to add an event that contains a date range. For more information,
see section 51.26 “Edit Calendar Entry Dialog Box – Date Range ” on
page 1502.

Add Calculated Date

Click to add an event that recurs on a regular basis. For more information,
see section 51.27 “Edit Calendar Entry Dialog Box – Calculated Date ” on
page 1503.

Delete
Click to delete events in the schedule.

04-30005-01-en, May 2019 System

1499
51 Schedules User Interface
51.24 Calendar Properties – Basic Tab

51.24 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 remove calendar

entries that are older than 60 days.

Lead object Select a lead calendar if you are creating a

shadow calendar.

System 04-30005-01-en, May 2019

1500
 51 Schedules User Interface
51.25 Edit Calendar Entry Dialog Box – Add Date

51.25 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
Day, Last
day
day, Odd days or Even days 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-30005-01-en, May 2019 System

1501
51 Schedules User Interface
51.26 Edit Calendar Entry Dialog Box – Date Range

51.26 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
Day, Last
day
day, Odd days or Even days 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-30005-01-en, May 2019

1502
 51 Schedules User Interface
51.27 Edit Calendar Entry Dialog Box – Calculated Date

51.27 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
week,
Second week
week, Third week
week, Fourth week
week, Last week
week, Any week
week.
• First week – the first through the seventh day of the month. Be
aware that it does not necessarily correspond to the first row of
the calendar since it may include dates from both the first and
second row of the calendar.
• Fifth week – days 29 through 31 if they exist. It is always less
than seven days and is non-existent in February except in a
leap year.
• Last week – the last seven days of the month. It differs from the
Fifth 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-30005-01-en, May 2019 System

1503
51 Schedules User Interface
51.28 Xenta Schedule Editor

51.28 Xenta Schedule Editor

Use the Xenta Schedule Editor to view and configure weekly events and
exception events for a Xenta schedule.

Figure: Xenta Schedule editor

Table: Xenta Schedule Editor

Number Description

Weekly (Maximum) Displays the maximum number of weekly

events the schedule can have. For more
information, see the Number of Scheduled
Events for Xenta LonWorks Devices topic
on WebHelp.

Central weekly schedule/Central Enter a central weekly or exception

exceptions schedule/Lead central schedule reference, or enter a lead Xenta
schedule Central Schedule reference in a Xenta
Central schedule.

Lead central schedule Enter a lead Xenta Central Schedule

reference.

System 04-30005-01-en, May 2019

1504
 51 Schedules User Interface
51.28 Xenta Schedule Editor

Continued
Number Description

New
Click to open the Xenta Schedule dialog
box, where you can add an event. For
more information, see section 51.29 “Xenta
Schedule Dialog Box ” on page 1506.

Edit
Click to open the Xenta Schedule dialog
box, where you can edit an event. For more
information, see section 51.29 “Xenta
Schedule Dialog Box ” on page 1506.

Delete
Click to delete a selected event.

Weekly event table Displays the weekly events for the Xenta
schedule or Xenta Central schedule.

Exceptions (Maximum) Displays the maximum number of

exceptions events the schedule can have.
For more information, see the Number of
Scheduled Events for Xenta LonWorks
Devices topic on WebHelp.

New
Click to open the Xenta Schedule dialog
box, where you can add an event. For
more information, see section 51.29 “Xenta
Schedule Dialog Box ” on page 1506.

Edit
Click to open the Xenta Schedule dialog
box, where you can edit an event. For more
information, see section 51.29 “Xenta
Schedule Dialog Box ” on page 1506.

Delete
Click to delete a selected event.

Exceptions event table Displays the exception events for the Xenta
schedule.

04-30005-01-en, May 2019 System

1505
51 Schedules User Interface
51.29 Xenta Schedule Dialog Box

51.29 Xenta Schedule Dialog Box

Use the Xenta Schedule dialog box to edit the exception start and stop date,
time interval, and weekday of a weekly or exception event.

Figure: Xenta Schedule dialog box

Table: Xenta Schedule Editor

Preperty Description

[Time span/On all day/Off all day menu] Click to select the time range the schedule
should be in service, or select On all day or
Off all day.

Start date/Stop date Enter the date range when the schedule
should be in service.

Start time/Stop time Enter the time range when the schedule
should be in service.

Result Displays the result of the selected time

range.

[List of weekdays] Select the weekdays the schedule should

be in service.

System 04-30005-01-en, May 2019

1506
52 WorkStation

Topics
WorkStation
Control Panel
Opening Control Panel
Quick Filter
Hyperlinks
Creating a Hyperlink
Utilities
Creating a Utility Object
Timed Force Objects
Timed Force Analog Object
Timed Force Digital Object
Timed Force Multistate Object
Timed Force Multistate Object State Configuration
Configuring State Values in a Timed Force Multistate Object
Configuring a Timed Force Object for Force Until
Configuring a Timed Force Object for Force Duration
Database Mode
Configuring WorkStation to run in Database Mode
Default System Folder
 52 WorkStation
52.1 WorkStation

52.1 WorkStation
WorkStation is the interface where you supervise your EcoStruxure BMS. In
WorkStation you can also create, modify, and delete objects that are used to
build an EcoStruxure BMS.

NOTICE
Ensure that you have a working and available WorkStation license. A working
license is required to log on to WorkStation. For more information, see section
10.10 “Licenses” on page 166.

52.1.1 EcoStruxure Building Operation Objects

The EcoStruxure 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 permissions, you can
configure objects in a many different way.
For more information, see section 56.1 “EcoStruxure Building Operation
Objects ” on page 1663.

52.1.2 User Account Management Overview

When logging on to an EcoStruxure BMS server, you have to authenticate
yourself by using a valid user account. The user account has to belong to the
same domain as the server you log on to.
For more information, see section 19.1 “User Account Management Overview”
on page 353.

52.1.3 Workspace Management

The workspace defines the content and layout of WorkStation. The content and
layout of the workspace can be adapted different tasks for user accounts or user
account groups.
For more information, see section 24.1 “Workspace Management” on page 453.

52.1.4 Database Mode

In WorkStation you use database mode when you want to save configuration
changes to the EcoStruxure BMS server database but not send the changes to
SmartX servers or other devices.
For more information, see section 52.17 “Database Mode” on page 1528.

04-30005-01-en, May 2019 System

1509
52 WorkStation
52.2 Control Panel

52.2 Control Panel

The Control Panel gives you easy access to some of the common functions in
the EcoStruxure Building Operation software.
Each EcoStruxure BMS server has a control panel. For more information, see
section 52.3 “Opening Control Panel” on page 1511.
You access control panel of each of the servers in your EcoStruxure BMS by
choosing the server you want to work with in the System Tree Pane, and then
clicking on the Control Panel tab. The toolbar icon Control Panel and the item
Control Panel in the Tools menu display the control panel for the server you are
logged on to.
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

Control Panel displays active links to the features that the logged on user
account has permissions for.

System 04-30005-01-en, May 2019

1510
 52 WorkStation
52.3 Opening Control Panel

52.3 Opening Control Panel

You use Control Panel to get easy access to some of the most used functions on
servers in the EcoStruxure BMS.
For more information, see section 52.2 “Control Panel” on page 1510.

To open Control Panel

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.

04-30005-01-en, May 2019 System

1511
52 WorkStation
52.4 Quick Filter

52.4 Quick Filter

You use Quick filter to filter out the objects by their names from the list. You can
either type the name in the Quick filter box or drag an item from a column in the
Alarms pane, the Events pane, an Alarm view, or an Event view and drop it 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 of the view. For
example, if you filter on “20” you do not get any hits. But if you add the column
Value, you get hits on the temperature, which is 20, and the setpoint which is 20.
The Quick filter for the Event View filters on records that have already been
retrieved from the server.

Figure: Quick filter filters on all visible columns in the view

System 04-30005-01-en, May 2019

1512
 52 WorkStation
52.4 Quick Filter

Quick filter is used in the following components in WorkStation:

• List View
• Alarms pane
• Alarm Views
• Events pane
• Event Views
• Alarm or Event details views
• Watch pane
• Watch Views
• Add/Remove columns dialog box
• Create object wizard

Figure: The Quick filter is used in many components, such as the List View (upper left), the
Watch pane (bottom left), and the Add/Remove dialog box (upper right).

04-30005-01-en, May 2019 System

1513
52 WorkStation
52.5 Hyperlinks

52.5 Hyperlinks
The EcoStruxure Building Operation software 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.
The EcoStruxure Building Operation software 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: The EcoStruxure Building Operation software supports hyperlinks

System 04-30005-01-en, May 2019

1514
 52 WorkStation
52.6 Creating a Hyperlink

52.6 Creating a Hyperlink

You create a hyperlink in WorkStation to get easy access to important
information on the Internet.
For more information, see section 52.5 “Hyperlinks” on page 1514.

To create a hyperlink
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server or folder where you want to create the hyperlink.
2. On the File menu, point to New and then click Hyperlink
Hyperlink.
3. In the Create Object dialog box, 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 Assign the URL page, in the URL box, type the URL for the
hyperlink.

NOTICE
You have to include http:// or https:// in the URL.

7. Click Create
Create.

04-30005-01-en, May 2019 System

1515
52 WorkStation
52.7 Utilities

52.7 Utilities
The EcoStruxure Building Operation software is equipped with three types of
utilities: Signal Generators, Simple Math Operators, and Timed Force objects.
These utilities are used for testing, for example, trend logs and alarms.
For more information, see section 52.1 “WorkStation” on page 1509.

52.7.1 Signal Generator

Signal Generator is used to create a sinusoidal, square, or saw tooth curve.
Signal generator can also be used to generate a setpoint, an alarm, or an event.

52.7.2 Simple Math Operators

Simple Math Operator is used to add, subtract, multiply, and divide a one value
from another.

52.7.3 Timed Force Objects

Timed Force objects are utility objects that force an override of the actual value
of an analog, digital, or multistate output for a period of time specified either as a
time duration or as a selected end date and time.
For more information, see section 52.9 “Timed Force Objects” on page 1518.

System 04-30005-01-en, May 2019

1516
 52 WorkStation
52.8 Creating a Utility Object

52.8 Creating a Utility Object

You create a utility object for use during system maintenance or testing. A utility
object can be created at the top level of an EcoStruxure BMS server. However,
for the sake of organization it is recommended that you create the utility object
inside a folder on the server.
For more information, see section 52.7 “Utilities” on page 1516.

To create a utility object

1. In WorkStation, in the System Tree pane, select the folder.
2. In the File menu, point to New and then click Utility
Utility.
3. In the object type list of the Create Object wizard, select the object type.
4. In the Name box, type a name for the utility object.
5. In the Description box, type a description and then click Create
Create.
The utility object is created. If you created a Signal Generator or Simple Math
Operator object, you next configure the object, using the Basic properties tab. If
you created a Timed Force object, you next configure the object's force type as
either force until or force duration, using the Basic properties tab, and then use
the Parameters tab to configure other object properties as needed.

04-30005-01-en, May 2019 System

1517
52 WorkStation
52.9 Timed Force Objects

52.9 Timed Force Objects

Timed Force objects are utility objects that force an override of the actual value
of an analog, digital, or multistate output for a period of time specified either as a
time duration or as a selected end date and time.
A Timed Force object is typically used during maintenance or testing. For
example, an area of a facility must run in occupied mode until 7:00 p.m., past
the time when occupied mode normally ends, so that a sensor can be replaced.
To automate the release of the force, the facilities engineer uses a Timed Force
object configured to a Force until value of 7:00 p.m. In another example, the
facilities engineer must cycle valves and dampers to verify that they are
operating properly. Using a Timed Force object with the Force duration value
configured to a desired value in minutes, the engineer can cause these devices
to automatically stop after cycling for the required amount of time.
You can add a Timed Force object anywhere that a utility object is allowed.
A Timed Force object is placed in a data stream in series, for example between
the output of one object and the linked input of another object or between a
hardware input point and a software input.
When applying a force, you can use a Timed Force object to specify the end
time of the force in either of two ways:
• Time duration: You can choose the duration of the force, to any value
between 1 and 1440 minutes. When you configure a time duration, the
ending time of the force is automatically calculated and then displayed.
• Ending date and time: You can specify the exact future date and time at
which you want the force to end. In the event of an unexpected shut down of
the server, the date and time values are restored when the server restarts.
You can configure the frequency at which the input value is sent to the output, at
any value between 0.5 and 60 seconds. You can also configure the frequency at
which the input is updated from other objects or devices, selecting from a list of
frequency values between 100 milliseconds and 15 minutes.

52.9.1 Timed Force Analog Object

The Timed Force Analog object has a single analog input that can be bound to
another object to receive a value. The input's value is passed directly to a single
analog output, which can be bound to an object that is to be controlled. An
active timed force can be changed or cancelled as needed.
For more information, see section 52.10 “Timed Force Analog Object” on page
1520.

52.9.2 Timed Force Digital Object

The Timed Force Digital object has a single digital input that can be bound to
another object to receive a value. The input's value is passed directly to a single
digital output, which can be bound to an object that is to be controlled. An active
timed force can be changed or cancelled as needed.
For more information, see section 52.11 “Timed Force Digital Object” on page
1521.

System 04-30005-01-en, May 2019

1518
 52 WorkStation
52.9 Timed Force Objects

52.9.3 Timed Force Multistate Object

The Timed Force Multistate object has a single multistate input that can be
bound to another object to receive a value. The input's value is passed directly
to a single multistate output, which can be bound to an object that is to be
controlled. With a Timed Force Multistate object, you can select and then force
the display of a text string associated with one of the states created in the
object. An active timed force can be changed or cancelled as needed.
For more information, see section 52.12 “Timed Force Multistate Object” on
page 1522.

04-30005-01-en, May 2019 System

1519
52 WorkStation
52.10 Timed Force Analog Object

52.10 Timed Force Analog Object

The Timed Force Analog object has a single analog input that can be bound to
another object to receive a value. The input's value is passed directly to a single
analog output, which can be bound to an object that is to be controlled. An
active timed force can be changed or cancelled as needed.
As with other Timed Force objects, the end time of the force can be configured
as either a time duration or an end date and time.

System 04-30005-01-en, May 2019

1520
 52 WorkStation
52.11 Timed Force Digital Object

52.11 Timed Force Digital Object

The Timed Force Digital object has a single digital input that can be bound to
another object to receive a value. The input's value is passed directly to a single
digital output, which can be bound to an object that is to be controlled. An active
timed force can be changed or cancelled as needed.
As with other Timed Force objects, the end time of the force can be configured
as either a time duration or an end date and time.

04-30005-01-en, May 2019 System

1521
52 WorkStation
52.12 Timed Force Multistate Object

52.12 Timed Force Multistate Object

The Timed Force Multistate object has a single multistate input that can be
bound to another object to receive a value. The input's value is passed directly
to a single multistate output, which can be bound to an object that is to be
controlled. With a Timed Force Multistate object, you can select and then force
the display of a text string associated with one of the states created in the
object. An active timed force can be changed or cancelled as needed.
As with other Timed Force objects, the end time of the force can be configured
as either a time duration or an end date and time.

52.12.1 State Configuration

The state configuration of a Timed Force Multistate object allows specific
multistate values to be associated with text strings. The result is that for a given
state, the value displayed to the user is the text string associated with the
particular numeric multistate value.
For more information, see section 52.13 “Timed Force Multistate Object State
Configuration” on page 1523.

System 04-30005-01-en, May 2019

1522
 52 WorkStation
52.13 Timed Force Multistate Object State Configuration

52.13 Timed Force Multistate Object State

Configuration
The state configuration of a Timed Force Multistate object allows specific
multistate values to be associated with text strings. The result is that for a given
state, the value displayed to the user is the text string associated with the
particular numeric multistate value.
A Timed Force Multistate object allows up to 256 states to be created. Each of
these states has a default text string value of "State [state value]", which can be
edited to display an appropriate description of the state, such as "Unoccupied"
or "Standby". The state text string can be constructed using any of the
characters allowed in the EcoStruxure Building Operation software.
For more information, see section 52.14 “Configuring State Values in a Timed
Force Multistate Object” on page 1524.

04-30005-01-en, May 2019 System

1523
52 WorkStation
52.14 Configuring State Values in a Timed Force Multistate Object

52.14 Configuring State Values in a Timed

Force Multistate Object
In a Timed Force Multistate object, you configure one or more state values to
define a text string associated with each of those values.
For more information, see section 52.13 “Timed Force Multistate Object State
Configuration” on page 1523.

To configure state values in a Timed Force Multistate object

1. In WorkStation, in the System Tree pane, locate and then select the Timed
Force Multistate object.
2. Click the State Configuration tab.
3. Enter the number of states that you want to create.

4. On the State Configuration tab, click the Save button .

5. In the State Definitions list, select a state and then click the Edit button

.
Continued on next page

System 04-30005-01-en, May 2019

1524
 52 WorkStation
52.14 Configuring State Values in a Timed Force Multistate Object

6. Click the Basic tab.

7. In the Label box, type a description you want to associate with the state
number and then click OKOK.

8. On the State Configuration tab, click the Save button .

9. Repeat steps 5 through 8 for each state that you created.
The states of the Timed Force Multistate object are each configured with text
strings. When one of those states is selected and then forced on the object's
Basic tab, the text string associated with that state is displayed.

04-30005-01-en, May 2019 System

1525
52 WorkStation
52.15 Configuring a Timed Force Object for Force Until

52.15 Configuring a Timed Force Object for

Force Until
You configure a Timed Force object for a force until override when you want that
force to end at a specified date and time.
For more information, see section 52.9 “Timed Force Objects” on page 1518.

To configure a Timed Force object for force until

1. In WorkStation, in the System Tree pane, select a Timed Force Analog
object, Timed Force Digital object, or Timed Force Multistate object.
2. In the Parameters tab, edit the update time or transfer rate of the Timed

Force object and then click the Save button .

3. Click the Basic tab.
4. In the Force type select list, select Force until
until.
5. In the Force until date and time boxes, configure the date and time you
want the force to end.

6. Click the Save button .

7. Click Force and then in the Value box, type the override value.

8. Click the Save button .

(In FM: TaskClosing) The analog, digital, or multistate override value is in force
until the configured expiration date and time are reached.

System 04-30005-01-en, May 2019

1526
 52 WorkStation
52.16 Configuring a Timed Force Object for Force Duration

52.16 Configuring a Timed Force Object for

Force Duration
You configure a Timed Force object for a force duration override when you want
that force to end after a specified period of time.
For more information, see section 52.9 “Timed Force Objects” on page 1518.

To configure a Timed Force object for force duration

1. In WorkStation, in the System Tree pane, select a Timed Force Analog
object, Timed Force Digital object, or Timed Force Multistate object.
2. In the Parameters tab, edit the update time or transfer rate of the Timed

Force object and then click the Save button .

3. Click the Basic tab.
4. In the Force type select list, select Force duration
duration. This is the default
selection when you create a new Timed Force object.
5. In the Force duration box, configure the time duration, in minutes, for the
force to remain in effect.

6. Click the Save button .

7. Click Force and then in the Value box, type the override value.

8. Click the Save button .

(In FM: TaskClosing) The analog, digital, or multistate override value is in force
until the configured time duration ends.

04-30005-01-en, May 2019 System

1527
52 WorkStation
52.17 Database Mode

52.17 Database Mode

In WorkStation you use database mode when you want to save configuration
changes to the EcoStruxure BMS server database but not send the changes to
SmartX servers or other devices.
Once you have selected to run WorkStation in database mode, the setting is
saved for profile of the user account you used to log on to WorkStation. If you log
on to WorkStation with the same user account but on a different computer,
WorkStation opens in database mode.

52.17.1 Database Mode Indication and Default

When WorkStation is in database mode, there is an indication in the status bar.
By default, database mode is switched off.
When you open WorkStation from Project Configuration Tool, WorkStation always
opens in database mode.

52.17.2 Database Mode Guidelines

When using database mode, consider the following:
• Database mode is not recommended when working on live I/A Series MNL,
NETWORK 8000, and MNB devices.
• Run-time interactions between the EcoStruxure BMS server and BACnet
devices (including the MP Series controllers) still function. For example,
watch window and Graphics still display value updates and alarms are still
processed from the device.
• BACnet device commands (including those utilized in the MP Series
controller) still execute. As a result, you can perform uploads and
downloads in database mode.

System 04-30005-01-en, May 2019

1528
 52 WorkStation
52.18 Configuring WorkStation to run in Database Mode

52.18 Configuring WorkStation to run in

Database Mode
You configure WorkStation to run in database mode when you want to save
configuration changes to the EcoStruxure BMS server database but not send the
changes to SmartX servers or other devices.
For more information, see section 52.17 “Database Mode” on page 1528.

To configure WorkStation to run in Database Mode

1. In WorkStation, click the Tools menu.
2. Click Database mode
mode.
3. Click Yes
Yes.
Database mode is indicated by a database icon in the status bar. Changes you
make from now on are saved to the EcoStruxure BMS server database but not
sent to any physical devices. To send the configuration changes to physical
devices you have to deploy.

04-30005-01-en, May 2019 System

1529
52 WorkStation
52.19 Default System Folder

52.19 Default System Folder

You use the default System folder for a number of engineering operations in your
EcoStruxure BMS.

Figure: Default System folder

Table: Default System Folder

Item Description

Alarm Control Panel Use Alarm Control Panel to manage

overrides of alarm configurations, actions
required when alarms are triggered, and
the appearance of alarms in different alarm
states.
For more information, see section 33.1
“Alarm Decoration” on page 775.
For more information, see section 32.1
“User Actions” on page 757.
For more information, see section 35.45
“Alarm Styles View” on page 946.

System 04-30005-01-en, May 2019

1530
 52 WorkStation
52.19 Default System Folder

Continued
Item Description

Backup and Restore Use the Backup and Restore folder to

manage backup rules, backup set, and to
open Backup and Restore Manager for
Enterprise Server and Enterprise Central to
supervise the backup settings in the
EcoStruxure BMS.
For more information, see section 67.2
“Backup Rules” on page 1865.
For more information, see section 66.1
“Backup Sets” on page 1843.
For more information, see section 69.4
“Backup and Restore Manager on the
Enterprise Server” on page 1898.

Binding Templates Use Binding Templates to add and view

binding templates in the Building
Operation EcoStruxure BMS.
For more information, see the Binding
Templates topic on WebHelp.

Connect Settings Use Connect Settings to enable the

transfer of system information and crash
information of the EcoStruxure BMS
servers to the Connect storage server.
For more information, see section 27.1
“Connect Agent Overview” on page 565.

Content Types Use Content Types to view the folders and

container objects that use a content type.
For more information, see section 56.22
“Content Types” on page 1686.

Domains Use Domains to add and view domains in

the EcoStruxure BMS.
For more information, see section 21.1
“Domains” on page 391.

EcoStruxure Web Services Use ExoStruxure Web Services to

configure how information in XML format is
translated so that it can be understood by
EcoStruxure BMS servers and displayed in
WorkStation.
For more information, see the Web
Services topic on WebHelp.

Firmware Use Firmware to save MPx firmware on the

server.

Hardware Use Hardware to view the hardware

included in the EcoStruxure BMS.
For more information, see the Hardware
Overview topic on WebHelp.

04-30005-01-en, May 2019 System

1531
52 WorkStation
52.19 Default System Folder

Continued
Item Description

Interface Manager Use the Interface Manager to view the

priority levels based on the BACnet
standard and set the COV subscription
frequency and renewal rate on a lead
EcoStruxure BMS server for the BACnet
system.
For more information, see the Interface
Manager for BACnet – Basic Tab topic on
WebHelp.

LonWorks Binding Profile Use LonWorks Binding Profiles to view

binding profiles that determine the
behavior of LonWorks bindings.
For more information, see the LonWorks
Binding Profiles topic on WebHelp.

Modules For more information, see the I/O Modules

Overview topic on WebHelp.

Notification Files Use Notification Reports to view files

containing important information on the
EcoStruxure BMS.
For more information, see section 34.14
“Notification Reports” on page 810.

Ports For more information, see the Automation

Server Communication Ports topic on
WebHelp.

Report Manager User Report Manager to configure certain

parameters required to generate, view,
and create reports in WorkStation.
For more information, see the Report
Manager Configuration topic on WebHelp.

SmartDrivers Use SmartDrivers to add customized

interfaces in the EcoStruxure BMS that
monitors and controls third-party devices
from an EcoStruxure BMS server.
For more information, see the SmartDrivers
Overview topic on WebHelp.

Tasks Use Tasks to connect Function block and

Script programs to tasks.
For more information, see the Tasks topic
on WebHelp.

System 04-30005-01-en, May 2019

1532
 52 WorkStation
52.19 Default System Folder

Continued
Item Description

Time Settings Use Time Settings to configure

EcoStruxure BMS server time settings and
time zone setting.
For more information, see the Date & Time
View topic on WebHelp.
For more information, see section 18.7
“SmartX Server – Date & Time View” on
page 345.

Archive Settings Use Archive Settings to configure how data

from selected events and extended trend
logs is to be preserved.
For more information, see section 57.1
“Archiving Overview” on page 1699.

Bindings Diagnostics Use Bindings Diagnostics to check the

database for unresolved or invalid
references.
For more information, see the Bindings
Diagnostics topic on WebHelp.

Security Manager Use System Manager configure features

that help you increase the security in your
EcoStruxure BMS.
For more information, see the Security
Overview topic on WebHelp.

Server Communication Use Server Communication to view the

communication settings of the server. For
more information, see the EcoStruxure
BMS Server Communication topic on
WebHelp.

SystemControlPanel Use Control Panel to access some of the

most used functions in the EcoStruxure
BMS.
For more information, see section 53.23
“Control Panel Tab” on page 1583.

04-30005-01-en, May 2019 System

1533
53 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 - In Watch pane Submenu
Actions Menu – Actions Submenu
Column Row Context Menu
Drag and Drop Context Menu
Drag and Drop Context Menu – New Submenu
Watch Pane and Watch View
Watch Pane and Watch View Toolbar
Watch Select Property Dialog Box
Add/Remove Columns Dialog Box (Watch)
Tools Menu
53 Tools Menu - Measurement System Submenu
Options Dialog Box
Control Panel Tab
Progress View – Advanced
Progress View – Simple
Operation Details Dialog Box
Error Details – Progress View
Create Object Wizard – Naming the Object Page
Create Object Wizard – Create Server from a Backup Set
Page
List View
List View Toolbar
List View Context Menu
List View Context Menu - Advanced Submenu
List View Context Menu - List View Settings Submenu
System Tree Pane
System Tree Pane Toolbar
Confirm Delete Dialog Box
Rename Object Dialog Box
General Information Properties – Basic Tab
References Tab
Tags Dialog Box
Configure Dialog Box – Configuration Tab
Configure Dialog Box – Operation Tab
Search Icons
Search View
Search View Toolbar
Search Toolbar
Search View Context Menu
53 Add/Remove Columns Dialog Box (Search)
Select Folder Dialog Box
Select Types Dialog Box
Select Conditions Dialog Box
Add/Remove Columns Dialog Box (List View)
Analog Value Properties
Digital Value Properties
Multistate Value Properties
String Value Properties
Time Stamp Value Properties
Signal Generator Properties - Basic Tab
Simple Math Operator Properties - Basic Tab
Timed Force Analog Object Properties – Basic Tab
Timed Force Analog Object Properties – Parameters Tab
Timed Force Digital Object Properties – Basic Tab
Timed Force Digital Object Properties – Parameters Tab
Timed Force Multistate Object Properties – Basic Tab
Timed Force Multistate Object Properties – Parameters Tab
Timed Force Multistate Object Properties – State
Configuration Tab
Create Hyperlink Wizard – Assign the URL Page
Select Object Dialog Box
Select Object and Property Dialog Box
Progress View
Status Bar
System Object Properties
System Control Panel Properties
Commit Page
Objects and Trends Dialog Box
53 Duplicate Dialog Box
Rename Dialog Box
Save Layout as Content Type Dialog Box
Manage Content Types Dialog Box
Select Content Type Dialog Box
Building Operation WorkStation Error
 53 WorkStation User Interface
53.1 Basic Functionality Icons in the System Tree Pane

53.1 Basic Functionality Icons in the System

Tree Pane
This section describes the Basic Functionality icons in the System Tree pane.
Icon Description

Server
Indicates an EcoStruxure BMS server. For
more information, see the EcoStruxure
BMS Server Overview topic on WebHelp.

System
Indicates the System folder in a server. For
more information, see the EcoStruxure
BMS Server Overview topic on WebHelp.

Servers
Indicates a folder for SmartX servers. For
more information, see the EcoStruxure
BMS Server Overview topic on WebHelp.

Folder
Indicates a folder.

Tasks
Indicates a Task that is used to run a Script
program or a Function Block program. For
more information, see the Tasks topic on
WebHelp.

Archive settings
Indicates Archive settings. For more
information, see section 57.1 “Archiving
Overview” on page 1699.

Search query
Indicates a saved search in the System
Tree pane and in the List View. For more
information, see section 59.1 “Search
Overview” on page 1755.

Control Panel
Indicates Control Panel. For more
information, see section 52.2 “Control
Panel” on page 1510.

04-30005-01-en, May 2019 System

1539
53 WorkStation User Interface
53.2 File Menu

53.2 File Menu

Use the File menu to log off from the system, import and export information,
print, and create new objects.

Figure: File menu

Table: File Menu

Command Description

New Click to open the New submenu where you

create new objects. For more information,
see section 53.3 “File Menu – New
Submenu” on page 1542.

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 again with
the same or another user account. For
more information, see section 26.8
“Building Operation WorkStation Window”
on page 503.

Change Password Click to open the Change Password dialog

box where you change your password. For
more information, see section 26.13
“Change Password Dialog Box” on page
513.

System 04-30005-01-en, May 2019

1540
 53 WorkStation User Interface
53.2 File Menu

Continued
Command Description

Import Click to open the Open dialog box where

you select a previously exported solution
that you want to import. After you select a
file, the Import dialog box displays.
The Import dialog box provides a summary
of information about the imported file and a
preview of the names and file structure of
the objects to be imported. For more
information, see the Import Dialog Box
topic on WebHelp.

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
the EcoStruxure Building Operation
software cannot export from the
EcoStruxure BMS server. Use this dialog
box to view multiple objects that the
system can and cannot export from the
EcoStruxure BMS server. For more
information, see the Export Preview Dialog
Box topic on WebHelp.

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 53.39 “General Information
Properties – Basic Tab” on page 1604.

Shortcut Properties Displays the Properties dialog box for the

currently selected shortcut.

Exit Click to quit WorkStation.

04-30005-01-en, May 2019 System

1541
53 WorkStation User Interface
53.3 File Menu – New Submenu

53.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 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
An alarm monitors a variable and alerts
you if the monitored variable matches the
configured alarm conditions. For more
information, see section 29.1 “Alarms
Overview” on page 577.

Assignment Click to open the Create Object wizard

where you create an assignment. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
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 31.29 “Automatic Assignments” on
page 738.

System 04-30005-01-en, May 2019

1542
 53 WorkStation User Interface
53.3 File Menu – New Submenu

Continued
Command Description

Application Click to open the Create Object wizard

where you create an application folder for
a hosted BACnet device. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.

b3 device Click to open the Create Object wizard

where you create a b3 device on the MSTP
network. For more information, see section
53.28 “Create Object Wizard – Naming the
Object Page” on page 1590.
b3 BACnet devices are a family of
intelligent, programmable, stand-alone
devices that provide Direct Digital Control
of air handlers and systems as well as
individual terminal units. For more
information, see the b3 BACnet Device
Controllers topic on WebHelp.

BACnet device Click to open the Create Object wizard

where you create a BACnet device that is
hosted by the local EcoStruxure BMS
server. For more information, see section
53.28 “Create Object Wizard – Naming the
Object Page” on page 1590.

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 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.
You use a BACnet loop to create a
feedback system without manually
creating or editing Script code. For more
information, see the BACnet Objects and
Properties topic on WebHelp.

BACnet network Click to open the Create Object wizard

where you create a BACnet network that is
not directly connected to the EcoStruxure
BMS server. For more information, see
section 53.28 “Create Object Wizard –
Naming the Object Page” on page 1590.
You use a BACnet network when you want
to host a device that is on a network that is
not directly connected to the EcoStruxure
BMS server. For more information, see the
BACnet Networks topic on WebHelp.

04-30005-01-en, May 2019 System

1543
53 WorkStation User Interface
53.3 File Menu – New Submenu

Continued
Command Description

BACnet notification Click to open the Create Object wizard

where you create a BACnet notification that
can be referenced by BACnet alarms and
objects configured for intrinsic alarming.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.
For more information, see the BACnet
Alarms topic on WebHelp.

BACnet program Click to open the Create Object wizard

where you create a BACnet program and
upload the properties of a BACnet
program from a BACnet device into the
EcoStruxure Building Operation database.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

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 53.28 “Create Object Wizard –
Naming the Object Page” on page 1590.
A BACnet trend log is a property monitor
for a specific object. When certain
conditions are reached, a log is produced
with the property value and a date/time
stamp. For more information, see the
BACnet Objects and Properties topic on
WebHelp.

BBMD Click to open the Create Object wizard

where you create a BBMD when you want
BACnet broadcast messages to be
communicated throughout an IP network.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.
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 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.
You create a BDT entry for to configure a
master table for a BBMD.

Change of Value Log Set Click to create a Change of Value Log Set
subfolder. For more information, see the
Log Sets topic on WebHelp.

System 04-30005-01-en, May 2019

1544
 53 WorkStation User Interface
53.3 File Menu – New Submenu

Continued
Command Description

Device Click to open the Create Object wizard

where you create a device. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.

Document Click to open the Create Object wizard

where you create a document. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
A document is a container in which you
can upload a file for use by the
EcoStruxure Building Operation software.
You can upload all types of files including
reports, forms, images, and video clips.
For more information, see section 62.1
“Documents Overview” on page 1801.

Extended trend log Click to open the Create Object wizard

where you create an extended trend log.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.
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 40.4 “Extended
Trend Logs” on page 1171.

Folder Click to open the Create Object wizard

where you create a folder. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.

Function Block Click to open the Create Object wizard

where you create a Function Block
program. For more information, see section
53.28 “Create Object Wizard – Naming the
Object Page” on page 1590.
For more information, see the Function
Block Editor Overview topic on WebHelp.

Global Values Click to create a new Sigma global values

device. For more information, see the
Global Values topic on WebHelp.

Graphic Click to open the Create Object wizard

where you create a graphic. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
The created graphic is empty and has to
be edited. For more information, see the
Graphics Editor topic on WebHelp.

04-30005-01-en, May 2019 System

1545
53 WorkStation User Interface
53.3 File Menu – New Submenu

Continued
Command Description

Graphics folder Click to create a Sigma graphics

subfolder.

Hyperlink Click to open the Create Object wizard

where you create a hyperlink. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
Hyperlinks are used to acces web pages
on the Internet. For more information, see
section 52.5 “Hyperlinks” on page 1514.

Interface Click to open the Create Object wizard

where you create an interface. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
The created interface can be a BACnet
interface, LonWorks interface, MicroNet
network, or Modbus interface/network.
For more information, see the BACnet
Interface topic on WebHelp.
For more information, see the LonWorks
Overview topic on WebHelp.
For more information, see the MicroNet
Network Protocols topic on WebHelp.
For more information, see the Modbus
Overview topic on WebHelp.
For more information, see the Web
Services Overview topic on WebHelp.

Interval Log Set Click to create an Interval Log Set

subfolder. For more information, see the
Log Sets topic on WebHelp.

IP network Click to open the Create Object wizard

where you create an IP network. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.

LonWorks Network Opens the Create Object wizard

wizard, where
you create a LonWorks network. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.

System 04-30005-01-en, May 2019

1546
 53 WorkStation User Interface
53.3 File Menu – New Submenu

Continued
Command Description

MicroNet Click to open the Create Object wizard,

where you create any one of three
MicroNet network types. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
MicroNet is a moderate-to-large scale
Building Management System. For more
information, see the MicroNet Network
Protocols topic on WebHelp.

MicroNet ARCNET Network Click to open the Create Object wizard,

where you create a MicroNet ARCNET
network. For more information, see section
53.28 “Create Object Wizard – Naming the
Object Page” on page 1590.
An ARCNET network contains ARCNET
variant MicroNet devices. For more
information, see the ARCNET Networks
topic on WebHelp.

MicroNet NCP Network Click to open the Create Object wizard,

where you create a MicroNet NCP network.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.
An NCP network is the Satchwell Native
Communications Protocol proprietary
network, containing NCP variant MicroNet
devices. For more information, see the
NCP Networks topic on WebHelp.

MicroNet SNP Network Click to open the Create Object wizard,

where you create a MicroNet SNP network.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.
An SNP network is the Satchwell SatchNet
Pro proprietary network, containing SNP
variant MicroNet devices. For more
information, see the SNP Networks topic on
WebHelp.

Modbus Device Click to open the Create Object wizard

where you create an external slave device
on a serial Modbus (master) network, or a
new serial device on a Modbus TCP
gateway. For more information, see section
53.28 “Create Object Wizard – Naming the
Object Page” on page 1590.
A Modbus device is any device that
conforms to the Modbus standard (for
example, a meter or a programmable logic
controller). For more information, see the
Modbus Devices topic on WebHelp.

04-30005-01-en, May 2019 System

1547
53 WorkStation User Interface
53.3 File Menu – New Submenu

Continued
Command Description

Modbus Points Click to open the Create Object wizard

where you create a Modbus point within an
external device. For more information, see
section 53.28 “Create Object Wizard –
Naming the Object Page” on page 1590.
A Modbus point is an analog, digital or
multistate input (or output) at a Modbus
device. For more information, see the Point
and Value Types topic on WebHelp.

Modbus TCP Device Click to open the Create Object wizard

where you create a Modbus TCP device.
For more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.
A Modbus TCP device is any Modbus
device on a Modbus TCP network. For
more information, see the Modbus Devices
topic on 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 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
A Modbus register group is a container
where Modbus registers can be polled as
a group by a Modbus polling device. For
more information, see the Modbus Register
Groups topic on WebHelp.

Modbus Value Click to open the Create Object wizard

where you create a Modbus value in a
Modbus interface. For more information,
see section 53.28 “Create Object Wizard –
Naming the Object Page” on page 1590.
A Modbus value is an analog, digital or
multistate input (or output) at a Modbus
interface. For more information, see the
Point and Value Types topic on WebHelp.

MSTP network Click to open the Create Object wizard

where you create an MS/TP Network for
BACnet devices or b3 devices. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
The EcoStruxure Building Operation
software supports BACnet IP networks and
MS/TP networks. For more information, see
the BACnet Networks topic on WebHelp.

System 04-30005-01-en, May 2019

1548
 53 WorkStation User Interface
53.3 File Menu – New Submenu

Continued
Command Description

Network Variable Click to open the Create Object wizard

where you create a network variable. For
more information, see section 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.

Notification Click to open the Create Object wizard

where you create a notification. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
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
emails or written to files outside the
EcoStruxure Building Operation software.
For more information, see section 34.1
“Notifications” on page 787.

Panel Click to open the Create Object wizard

where you create a panel. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
A panel can consist of one or several
panes and one work area with viewable
objects, for example graphics, trend
charts, reports, or another panel. For more
information, see section 24.16 “Panel
Components” on page 472.

Point Click to open the Create Object wizard

where you create a BACnet input or output
point. For more information, see section
53.28 “Create Object Wizard – Naming the
Object Page” on page 1590.
You can create BACnet points in an
EcoStruxure BMS server and in a hosted
BACnet device. For more information, see
the BACnet Objects and Properties topic
on WebHelp.

Program Click to open the Create Object wizard

where you create a program. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
For more information, see the Function
Block Editor Overview topic on WebHelp.
For more information, see the Script Editor
Program Creation topic on WebHelp.

04-30005-01-en, May 2019 System

1549
53 WorkStation User Interface
53.3 File Menu – New Submenu

Continued
Command Description

Report Click to open the Create Object wizard

where you create a report. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
Click to create a report. For more
information, see the WebReports Overview
topic on WebHelp.

Schedule Click to open the Create Object wizard

where you create a schedule. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
Schedules are used to determine when
essential events occur in a building
automation system. For more information,
see section 46.1 “Schedules Overview” on
page 1385.

Search Click to open the Create Object wizard

where you create a search. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
Search is used for searching for objects
and properties of objects in the
EcoStruxure Building Operation database.
For more information, see section 59.1
“Search Overview” on page 1755.

Segment Click to open the Create Object wizard

where you create a Sigma segment. For
more information, see the Sigma
Representation topic on WebHelp.

Server Click to open the Create Object wizard

where you create an EcoStruxure BMS
server. For more information, see section
53.28 “Create Object Wizard – Naming the
Object Page” on page 1590.

Shortcut Click to open the Create Object wizard

where you create a shortcut. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
A shortcut is a link to an EcoStruxure BMS
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 60.5 “Shortcut Creation” on page
1786.

System 04-30005-01-en, May 2019

1550
 53 WorkStation User Interface
53.3 File Menu – New Submenu

Continued
Command Description

User Account Click to open the Create Object wizard

where you create a user account. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
A user account uniquely identifies a user to
the system. For more information, see
section 19.3 “User Accounts and User
Account Groups” on page 357.

Domain Click to open the Create Object wizard

where you create a domain. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
A domain contains of user accounts, user
account groups, software permissions,
workspaces and one or several
EcoStruxure BMS servers. For more
information, see section 21.1 “Domains” on
page 391.

Text report Opens the Create Object wizard

wizard, where
you create a text report. For more
information, see the Creating a Text Report
topic on 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 53.28 “Create Object Wizard –
Naming the Object Page” on page 1590.
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 38.1 “Trends Overview” on page
1105.

Trend log Click to open the Create Object wizard

where you create a trend log. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
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 38.1 “Trends Overview” on page
1105.

04-30005-01-en, May 2019 System

1551
53 WorkStation User Interface
53.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 53.28
“Create Object Wizard – Naming the
Object Page” on page 1590.
A user account group can contain both
user accounts and other user account
groups. For more information, see section
19.3 “User Accounts and User Account
Groups” on page 357.

Utility Click to open the Create Object wizard

where you create a utility. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
The utilities Signal Gererator, Simple Math
Operator, and Timed Force are used
during system maintenance and testing.
For more information, see section 52.7
“Utilities” on page 1516.

Value Click to open the Create Object wizard

where you create a value. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.

View Click to open the Create Object wizard

where you create an Event View, Alarm
View, or Watch View. For more information,
see section 53.28 “Create Object Wizard –
Naming the Object Page” on page 1590.
Views are used to display information in a
easy way. For more information, see
section 29.1 “Alarms Overview” on page
577.

Workspace Click to open the Create Object wizard

where you create a workspace. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.
A workspace is a configured layout and
selection of components that display in
WorkStation. For more information, see
section 24.3 “Workspace Components and
Customization” on page 456.

System 04-30005-01-en, May 2019

1552
 53 WorkStation User Interface
53.4 Edit Menu

53.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
EcoStruxure BMS server root.

Paste special Pastes with the all external references

intact. For more information, see section
56.9 “ Copy, Paste, Duplicate, Move,
Rename, and Delete” on page 1672.

Duplicate Click to create a configurable number of

copies of an object. For more information,
see section 56.9 “ Copy, Paste, Duplicate,
Move, Rename, and Delete” on page 1672.

04-30005-01-en, May 2019 System

1553
53 WorkStation User Interface
53.4 Edit Menu

Continued
Command Description

Move Click to move an object to another location.

For more information, see section 56.9 “
Copy, Paste, Duplicate, Move, Rename,
and Delete” on page 1672.

Delete Click to open the Confirm delete dialog

box where you delete the selected object.
For more information, see section 53.37
“Confirm Delete Dialog Box” on page
1602.

Rename Click to rename the selected object.

Create shortcut Creates a new shortcut to a selected folder

or object into the same folder as the target.

System 04-30005-01-en, May 2019

1554
 53 WorkStation User Interface
53.5 Actions Menu

53.5 Actions Menu

Use the Actions menu to carry out commands for objects selected in the System
Tree pane or a List View.

Figure: Action menu when a Function Block program is selected.

Table: Actions Menu

Command Description

Actions Use the Actions submenu to create

manual archives on an Enterprise Server or
Enterprise Central. For more information,
see section 53.12 “Actions Menu – Actions
Submenu” on page 1572.

Activation Use the Activation submenu to enable,

disable, force transfer, or clear a trend log.
For more information, see section 53.6
“Actions Menu – Activation Submenu” on
page 1565.

Advanced Use the Advanced submenu to repair

references or communication after an
EcoStruxure BMS server has been offline.
For more information, see section 53.7
“Actions Menu – Advanced Submenu” on
page 1566.

Advanced commands Use the Advanced commands submenu to

execute commands for a device. For more
information, see section 53.8 “Actions
Menu – Advanced Commands Submenu”
on page 1567.

Alarm enable Click to enable the Sigma Alarm.

Alarm inhibit Click to inhibit the Sigma Alarm.

Alarm Refresh Transfers all alarms buffered in the Xenta

device to the server. For more information,
see the Alarms for Xenta LonWorks
Devices topic on WebHelp.

04-30005-01-en, May 2019 System

1555
53 WorkStation User Interface
53.5 Actions Menu

Continued
Command Description

b3 devices Use the b3 devices submenu to

automatically assign the node IDs and
initiate communication with devices on the
MS/TP network, or to update the firmware.
For more information, see the b3 BACnet
Device Properties – Advanced Tab topic
on WebHelp.

Backup Click to open the Backup Options dialog

box where you back up the selected
EcoStruxure BMS server. For more
information, see section 69.6 “Backup
Options Dialog Box” on page 1901.

Clear Log Click to clear the selected external

database logs. For more information, see
Operations on external databases

Clear Status Clears the diagnostic data for the device or

local node. For more information, see the
LonWorks Device Properties – Diagnostics
Tab topic on WebHelp.

Clear pending Click to clear the pending external

database logs. For more information, see
Operations on external databases

Cold start Restarts the device and clears the RAM

memory. For more information, see the
Xenta LonWorks Device Restart topic on
WebHelp.

Cold start device Cold starts a hosted BACnet device. For

more information, see the Device Cold
Start and Warm Start topic on WebHelp.

Commission Opens the Commission Device wizard,

where you download settings and
parameters to the device.
For more information, see the Neuron ID
and Commission Settings Page topic on
WebHelp.
For more information, see the Actions
Menu – Device Submenu topic on
WebHelp.

Create Reports From WebReports Click to restore the Reports folder in the
System Tree. For more information, see the
Reports in WorkStation and the
WebReports Web Site topic on WebHelp.

Data Import Click to import the MicroNet import file. For

more information, see the Data Import
topic on WebHelp.

System 04-30005-01-en, May 2019

1556
 53 WorkStation User Interface
53.5 Actions Menu

Continued
Command Description

Data import Click to import Sigma data from the Sigma

server PC. For more information, see the
Sigma Data Import topic on WebHelp.

Decommission Deactivates the device in the network.

Delete log Click to delete the selected external

database logs. For more information, see
Operations on external databases

Device Use the Device submenu where you

manage your devices. For more
information, see the Actions Menu – Device
Submenu topic on WebHelp.

Device communication control Controls the device communications for

BACnet devices and the BACnet Interface,
and is primarily used for diagnostic
purposes.
For more information, see the Device
Communication and Diagnostics topic on
WebHelp.

Disable log Click to disable the selected external

databases logs from synchronizing with
the TimescaleDB. For more information,
see Operations on external databases

Discover Devices Identifies the devices and objects on a

particular BACnet network, or an entire
BACnet internetwork. For more information,
see the BACnet Device Discovery topic on
WebHelp.

Download Downloads applications or BACnet

networks from the EcoStruxure Building
Operation server database. For more
information, see the EcoStruxure Web
Service Alarm Item topic on WebHelp.

Download device configuration Downloads the parameters from the

EcoStruxure BMS server database to the
device.

Edit Opens the object for editing in the

appropriate editor.

Edit Alarm Click to display the properties for a Sigma

Alarm.

Edit Alarm 1 Click to display the properties for Sigma

Alarm 1.

Edit Alarm 2 Click to display the properties for Sigma

Alarm 2.

04-30005-01-en, May 2019 System

1557
53 WorkStation User Interface
53.5 Actions Menu

Continued
Command Description

Edit Assignment Condition Click to open the Select conditions dialog

box, where you define when to send the
assignment. For more information, see
section 35.78 “Select Conditions Dialog
Box” on page 989.

Edit bindings Click to open the Edit Bindings dialog box.

For more information, see the Bindings
View topic on WebHelp.

Edit cooling linear Click to display the properties for a Sigma

linear cooling optimizer.

Edit cooling logarithmic Click to display the properties for a Sigma

logarithmic cooling optimizer.

Edit heating linear Click to display the properties for a Sigma

linear heating optimizer.

Edit heating logarithmic Click to display the properties for a Sigma

logarithmic heating optimizer.

Edit in spreadsheet Click to open Edit in spreadsheet where

you can quickly build and reuse a
database of I/O modules on the I/O bus.
For more information, see the Copying
from MS Excel to Spreadsheet View topic
on WebHelp.

Edit Notification Condition Click to open the Select conditions dialog

box, where you define when to send the
alarm notification. For more information,
see the Select Conditions Dialog Box –
Alarm Filter Properties topic on WebHelp.

Edit permissions Click to open the Edit Permissions dialog

box where you grant permissions or limit
the permissions users or user groups have
to a path. For more information, see
section 26.10 “Edit Permissions Dialog
Box” on page 506.

Edit secondary input Click to display the properties for a

secondary input to a Sigma Setpoint Adjust
object.

Edit schedule Click to display the schedule editor or

calendar editor (as relevant).

Edit standard Alarm View filter Click to open the Select conditions dialog
box, where you sort the information in the
Alarms pane or an Alarm View. For more
information, see the Select Conditions
Dialog Box – Alarm Filter Properties topic
on WebHelp.

System 04-30005-01-en, May 2019

1558
 53 WorkStation User Interface
53.5 Actions Menu

Continued
Command Description

Edit standard Event View filter Click to open the Select conditions dialog
box, where you sort the information in the
Events pane or an Event View. For more
information, see section 35.78 “Select
Conditions Dialog Box” on page 989.

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 the
Select Conditions Dialog Box – Alarm Filter
Properties topic on WebHelp.

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 37.3 “Event Styles
Dialog Box” on page 1091.

Edit time extension Click to display the properties for a Sigma

Time Extension.

Enable log Click to enable the selected external

databases logs to synchronizing with the
TimescaleDB. For more information, see
Operations on external databases

Host EWS Objects Click to host a remote EcoStruxure Web

Service object. For more information, see
the EcoStruxure Web Service Client topic
on WebHelp.

Hours cancel limit 1 Click to prevent the generation of the next

totalization alarm for Limit 1 (like
precancel, except that you cannot later
reinstate the generation of the next Limit 1
totalization alarm).

Hours cancel limit 2 Click to prevent the generation of the next

totalization alarm for Limit 2 (like
precancel, except that you cannot later
reinstate the generation of the next Limit 2
totalization alarm).

Hours cancel limit 3 Click to prevent the generation of the next

totalization alarm for Limit 3 (like
precancel, except that you cannot later
reinstate the generation of the next Limit 3
totalization alarm).

Hours precancel limit 1 Click to prevent the generation of the next

totalization alarm for Limit 1.

Hours precancel limit 2 Click to prevent the generation of the next

totalization alarm for Limit 2.

Hours precancel limit 3 Click to prevent the generation of the next

totalization alarm for Limit 3.

04-30005-01-en, May 2019 System

1559
53 WorkStation User Interface
53.5 Actions Menu

Continued
Command Description

Hours reinstate limit 1 Click to reverse the effects of clicking

Hours precancel limit 1.

Hours reinstate limit 2 Click to reverse the effects of clicking

Hours precancel limit 2.

Hours reinstate limit 3 Click to reverse the effects of clicking

Hours precancel limit 3.

IO wiring list Click to open the IO Wiring List dialog box

where you print an I/O wiring list for the I/O
bus that describes which I/O points are
associated with each I/O module. For more
information, see the Print I/O Wiring List
Dialog Box topic on WebHelp.

Launch VisiSat Click to start VisiSat. For more information,

see the VisiSat Programming topic on
WebHelp.

Learn BDT Table Click to open the Learn BDT Table dialog
box where you learn the BACnet Broadcast
Device Table from one BBMD to another
BBMD. For more information, see the
Learning a BBMD Configuration from one
BBMD to Another topic on WebHelp.

Learn LCM Learns the blocks in the LCM. For more

information, see the Learn LCM Blocks
topic on WebHelp.

LCM sync date time Sends the server's date and time to each
LCM device on the LCM network. For more
information, see the NETWORK 8000
LCMs topic on WebHelp.

Manage IO bus Click to open the I/O Module Management

Tool dialog box where you assign and
unassign logical I/O modules, correct the
position of a module type, or correct a
module mismatch. For more information,
see the I/O Module Management Tool
Dialog Box topic on WebHelp.

Manage Meter Click to open the Manage Meter dialog

box where you manage the settings of a
new meter. For more information, see
section 44.15 “Manage Replacement of
Meter Dialog Box” on page 1299.

MNL Use the MNL submenu to open WorkPlace

Tech Monitor, to monitor or perform a task
on an MNL LonWorks device. For more
information, see the Actions Menu – MNL
Submenu topic on WebHelp.

System 04-30005-01-en, May 2019

1560
 53 WorkStation User Interface
53.5 Actions Menu

Continued
Command Description

Modification Use the Modification submenu to modify a

trend log. For more information, see
section 53.9 “Actions Menu – Modification
Submenu” on page 1568.

Print IO module labels Click to open the Print IO Module Labels

dialog box where you print the placard of
the I/O module. For more information, see
the Print I/O Module Labels Dialog Box
topic on WebHelp.

Proxy Update Reads the configuration properties of the

block in the LCM. For more information,
see the NETWORK 8000 LCMs topic on
WebHelp.

Pulse start Click to generate a Digital Output pulse

lasting for the duration of the rising edge
setting in Sigma.

Pulse stop Click to generate a Digital Output pulse

lasting for the duration of the falling edge
setting in Sigma.

Refresh device identification Click to refresh the basic device

identification displayed in the properties of
a Modbus device. For more information,
see the Modbus Devices topic on
WebHelp.

Removed from Network Removes an offline device object for a

physical device that was previously
removed from the network.

Reset Resets the block in the LCM. For more

information, see the NETWORK 8000
LCMs topic on WebHelp.

Reset IO module Resets the I/O module with its old

configuration. For more information, see
the I/O Modules topic on WebHelp.

Restore Click to open the Restore Options dialog

box where you restore the selected server,
or upload the configurations properties of
an external BACnet device to a device
proxy.

Retrieve logged values Click to retrieve logged values from the

relevant Sigma controllers.

Revert to application value Click to use an NCI value from the device
application when downloading the device
configuration (NCI values) to an MNL
LonWorks device. For more information,
see the NCI Values topic on WebHelp.

04-30005-01-en, May 2019 System

1561
53 WorkStation User Interface
53.5 Actions Menu

Continued
Command Description

Save To Save the selected backup to another

location in the SmartX server database. For
more information, see section 69.14
“Backup Sets View” on page 1911.

Send log set Click to send the selected log set to the
relevant Sigma controller.

Send log sets Click to send all log sets to the relevant
Sigma controllers.

Send ServicePin Sends service pin for the local node, so

other devices can identify the local node
on the network. For more information, see
the Discovering a Xenta Device topic on
WebHelp.

Send time sync now Manually forces the server to send out time
synch notifications to all the configured
recipients. For more information, see the
Manually Triggering the Time Recipients
List of an EcoStruxure BMS Server topic on
WebHelp.

Sigma diagnostics Click to open the Sigma diagnostics

submenu, where you can retime a
controller, set a controller online, or select
diagnostics text reports. For more
information, see the Controller Diagnostics
topic on WebHelp.

Teach Sends a selected BBMD configuration to

all other BBMDs in the system. For more
information, see the Teaching a BBMD
Configuration to Other BBMDs topic on
WebHelp.

Temporary off Click to override a Sigma Time Schedule

object until the next scheduled ON time.

Temporary on Click to override a Sigma Time Schedule

object until the next scheduled OFF time.

Time sync Synchronizes the time between a hosted

device and the local server. For more
information, see the BACnet Device – Time
Synchronization Recipients Tab topic on
WebHelp.

Trigger notification Click to trigger the selected notification

and test that it is delivered correctly.

Update IO module firmware Click to open the Update IO Module

Firmware dialog box where you upgrade
the firmware for I/O modules. For more
information, see the Update I/O Module
Firmware Dialog Box topic on WebHelp.

System 04-30005-01-en, May 2019

1562
 53 WorkStation User Interface
53.5 Actions Menu

Continued
Command Description

Upload Uploads the application from the device to

the EcoStruxure Building Operation server
database.

Upload device configuration Uploads the parameters from the device to

the EcoStruxure Building Operation server
database.

Update Object list Updates the list of BACnet device objects.

Warm start Restarts a device without clearing the RAM

memory. For more information, see the
Xenta LonWorks Device Restart topic on
WebHelp.

Warm start device Restarts a BACnet hosted device without

clearing all configuration data, run-time
data, and the values of objects. For more
information, see the Device Cold Start and
Warm Start topic on WebHelp.

View Use the View menu to open a report, trend

chart, trend log list, or add a value to the
Watch pane. For more information, see
section 53.10 “Actions Menu – View
Submenu” on page 1569.

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 section 37.1 “Events Pane and Event
View” on page 1089.

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 section 37.1 “Events Pane and Event
View” on page 1089.

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 section 37.1 “Events Pane and Event
View” on page 1089.

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 section 37.1 “Events Pane and Event
View” on page 1089.

View History Click to open an Events pane where all

history events of an alarm are displayed.
For more information, see section 37.1
“Events Pane and Event View” on page
1089.

04-30005-01-en, May 2019 System

1563
53 WorkStation User Interface
53.5 Actions Menu

Continued
Command Description

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-30005-01-en, May 2019

1564
 53 WorkStation User Interface
53.6 Actions Menu – Activation Submenu

53.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-30005-01-en, May 2019 System

1565
53 WorkStation User Interface
53.7 Actions Menu – Advanced Submenu

53.7 Actions Menu – Advanced Submenu

Use the Advanced submenu to peform advanced operations, such as repairing
communications or references.

Figure: The Actions menu - Advanced submenu

Command Description

Add attachment Click to add an alarm attachment to one or

several alarms.

Clear Content Type Click to clear a content type applied on a

folder or container object. For more
information, see section 56.22 “Content
Types” on page 1686.

Copy attachments from Click to copy alarm attachments from one

alarm to one or several other alarms.

Detect Subnet/Node conflicts Click 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 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 56.9 “ Copy,
Paste, Duplicate, Move, Rename, and
Delete” on page 1672.

Repair server communication Click to repair server communication after

an EcoStruxure BMS server has been
offline. For more information, see the
Repairing EcoStruxure BMS Server
Communication topic on WebHelp.

Rebind Click to rebind a LonWorks network and

clear and recreate all LonWorks bindings.

Remove all attachments Click to remove all alarm attachments from

one or several alarms.

Select Content Type Click to select a content type that you want
to apply to a folder or container object. For
more information, see section 56.22
“Content Types” on page 1686.

System 04-30005-01-en, May 2019

1566
 53 WorkStation User Interface
53.8 Actions Menu – Advanced Commands Submenu

53.8 Actions Menu – Advanced Commands

Submenu
Use the Advanced Commands submenu to execute functions on the selected
LonWorks device or Xenta device.

Figure: Actions menu - Advanced commands submenu

Table: Advanced Commands Submenu

Command Description

Wink Click to generate a response from the

device, such as flashing the power LED.

Clear Status Click to clear the diagnostic data for the

device or local node. For more information,
see the LonWorks Device Properties –
Diagnostics Tab topic on WebHelp.

Warm Start Click to restart the device without clearing

the RAM memory. For more information,
see the Xenta LonWorks Device Restart
topic on WebHelp.

Cold Start Click to restart the device and clear the

RAM memory. For more information, see
the Xenta LonWorks Device Restart topic
on WebHelp.

Alarm Refresh Click to transfer all alarms buffered in the

physical Xenta device to the EcoStruxure
Building Operation database. For more
information, see the Alarms for Xenta
LonWorks Devices topic on WebHelp.

04-30005-01-en, May 2019 System

1567
53 WorkStation User Interface
53.9 Actions Menu – Modification Submenu

53.9 Actions Menu – Modification Submenu

Use the Modification submenu to manually add a trend log record or import
trend log data from an .XML file to a trend log.

Figure: The trend log Actions menu, Modification submenu

Table: Modification Submenu

Command Description

Add log record Click to open the Add trend log record
dialog box where you add values and
comments to a manual trend log. For more
information, see the Manually Adding a
Trend Log Record to a Trend Log topic on
WebHelp..

Import log data Click to open an .XML file and import the
log data to the selected trend log. For more
information, see the Importing Log Data to
a Trend Log topic on WebHelp..

System 04-30005-01-en, May 2019

1568
 53 WorkStation User Interface
53.10 Actions Menu – View Submenu

53.10 Actions Menu – View Submenu

Use the View submenu to display object related events, temporary trend charts,
or trend log lists.

Figure: Acations menu - View submenu

Table: Actions Menu – View Submenu

Command Description

Contingency log chart Click to display a Contingency Log chart

for a Sigma object. For more information,
see the Viewing a Contingency Log Chart
or List topic on WebHelp.

Contingency log list Click to display a Contingency Log list for a

Sigma object. For more information, see
the Viewing a Contingency Log Chart or
List topic on WebHelp.

Events Click to open an Events pane that displays

the events related to a specific object. For
more information, see section 37.1 “Events
Pane and Event View” on page 1089.

Events in this branch Click to open an Events pane that displays

all events for the selected branch, for
example, a folder. For more information,
see section 36.1 “How Events Work ” on
page 1063.

Trends Click to view related trend objects. For

more information, see section 53.76 “
Objects and Trends Dialog Box” on page
1645.

In Trend Chart Click to open a trend log as a temporary

trend chart. For more information, see
section 41.23 “Temporary Trend Charts”
on page 1224.

In Trend Log List Click to open a trend log as a temporary

trend log list. For more information, see
section 42.9 “Temporary Trend Log Lists”
on page 1254.

Report Click to open a report.

04-30005-01-en, May 2019 System

1569
53 WorkStation User Interface
53.10 Actions Menu – View Submenu

Continued
Command Description

Text Report Click to enable the selection of a Sigma

text report relating to the object selected.
For more information, see the Text Report
View topic on WebHelp.

In Watch pane Use the In Watch pane submenu to select

the property of the variable you want to
monitor. For more information, see section
53.11 “Actions Menu - View Submenu - In
Watch pane Submenu” on page 1571.

System 04-30005-01-en, May 2019

1570
 53 WorkStation User Interface
53.11 Actions Menu - View Submenu - In Watch pane Submenu

53.11 Actions Menu - View Submenu - In

Watch pane Submenu
Use the In Watch pane submenu to choose which property you want to monitor.

Figure: In Watch pane submenu

Command Description

Default properties Click to use the default property when you

monitor the variable.

Other Properties Click to open a dialog box where you

select the property of the variable you want
to monitor in the Watch pane.

04-30005-01-en, May 2019 System

1571
53 WorkStation User Interface
53.12 Actions Menu – Actions Submenu

53.12 Actions Menu – Actions Submenu

Use the Actions submenu to create manual archives from an Enterprise Server
or an Enterprise Central.

Figure: Actions Menu – Actions submenu

Table: Actions Menu – Actions Submenu

Command Description

Create archive(s) Creates a manual archive that is saved to a predefined path on

now the computer running WorkStation. For more information, see
section 58.1 “Archive Settings Manager Dialog Box” on page
1741.

System 04-30005-01-en, May 2019

1572
 53 WorkStation User Interface
53.13 Column Row Context Menu

53.13 Column Row Context Menu

Use the column row context menu to manage the presentation of information in
an Alarm, Event, or Watch pane or View or in the List View.

Figure: Column row context menu

Table: Column Row Context Menu

Command Description

Add/Remove columns Click to add or remove a column in a pane

or a View. For more information, see the
Add/Remove Columns Dialog Box topic on
WebHelp.

Auto fit to contents Click to see all, or as much as possible, of

the content displayed in each of the
columns. For more information, see section
29.14 “Fitting the Column Width to the
Contents” on page 591.

Group box Click to get a better overview of the

objects, for example, in a folder or a list.
For more information, see the Grouping
Objects topic on WebHelp.

04-30005-01-en, May 2019 System

1573
53 WorkStation User Interface
53.14 Drag and Drop Context Menu

53.14 Drag and Drop Context Menu

Use the drag and drop context menu to copy, move, or create shortcuts for
objects selected in the List View or in the System Tree pane, and to mass
create objects selected in the List View
View.

Figure: Drag and drop context menu

Table: Drag and Drop Context Menu

Command Description

Copy Click to copy the objects selected in the

List View to the selected folder or object in
the System Tree pane.

New Click to open the New submenu where you

create or mass create alarms or trends
based on the selected value objects. For
more information, see section 53.15 “Drag
and Drop Context Menu – New Submenu”
on page 1575.

Move Click to move the objects selected in the

List View to the selected folder or object in
the System Tree pane.

Create Shortcut Click to create a shortcut for the objects

selected in the List View to the selected
folder or object in the System Tree pane.

System 04-30005-01-en, May 2019

1574
 53 WorkStation User Interface
53.15 Drag and Drop Context Menu – New Submenu

53.15 Drag and Drop Context Menu – New

Submenu
Use the New submenu to create new alarms or trends. By default, the alarms or
trends are created in the same folder as the value they are based on.

Figure: New submenu

Table: New Submenu

Command Description

Alarm Select to open the Create Object wizard or

the Mass Create Object wizard where you
create one or several alarms. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.. For more information, see
section 45.12 “Mass Create Object
Wizard – Name Page” on page 1381.

Trend Select to open the Create Object wizard or

the Mass Create Object wizard where you
create one or several trends. For more
information, see section 53.28 “Create
Object Wizard – Naming the Object Page”
on page 1590.. For more information, see
section 45.12 “Mass Create Object
Wizard – Name Page” on page 1381.

04-30005-01-en, May 2019 System

1575
53 WorkStation User Interface
53.16 Watch Pane and Watch View

53.16 Watch Pane and Watch View

You can drag objects to the Watch pane or a Watch View to monitor their live
values and other properties, for example, to monitor the impact of a change you
are about to make in your system. Property changes are immediately displayed
in the Watch pane or Watch View. You can add and remove property columns in
the Watch pane or Watch View.
Dragging an object to the Watch pane or Watch View, you get different results
depending on whether you right-click and drag or left-click and drag:
• Right-click and drag the object to the Watch pane or Watch View. When you
choose this method, you can select the properties you want to monitor.
• Left-click and drag an object to the Watch pane or Watch View. When you
choose this method, the default property of the object is displayed.
The list of objects in the Watch pane is not saved when you log out of
WorkStation but you can save the lists of objects to the system and reopen it
from the System Tree. You can save the list of objects on the Watch View
toolbar. The saved Watch view is opened in the List View. You can right-click
any object in the Watch pane or a Watch View to view and edit the properties of
that object. The Properties dialog box displays the properties you have chosen
to monitor in the Watch pane or Watch View and also contains a link to the full
properties of the object.
You can right-click an object in the Watch pane or Watch View and view the
trends related to the object.

Figure: Watch Pane

System 04-30005-01-en, May 2019

1576
 53 WorkStation User Interface
53.17 Watch Pane and Watch View Toolbar

53.17 Watch Pane and Watch View Toolbar

Use the Watch pane and Watch View toolbar to manage the objects in the list.

Figure: Watch pane and Watch View toolbar

Table: Watch Pane Toolbar

Component Description

Remove from Watch Window

Click to remove a selected object from the
Watch pane.

Save current settings

Click to save the current list of objects.

Quick filter Enter a word or a character to filter on. For

more information, see section 52.4 “Quick
Filter ” on page 1512.

04-30005-01-en, May 2019 System

1577
53 WorkStation User Interface
53.18 Watch Select Property Dialog Box

53.18 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 52.4 “Quick
Filter ” on page 1512.

System 04-30005-01-en, May 2019

1578
 53 WorkStation User Interface
53.19 Add/Remove Columns Dialog Box (Watch)

53.19 Add/Remove Columns Dialog Box

(Watch)
Use the Add/Remove Columns dialog box to add or remove columns from the
Watch pane or a Watch View.

Figure: Add/Remove Columns dialog box

04-30005-01-en, May 2019 System

1579
53 WorkStation User Interface
53.20 Tools Menu

53.20 Tools Menu

Use the Tools menu to open Control Panel or make a number of user settings.

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, such as alarms,
domains, user accounts, backup and
archiving, and engineering. For more
information, see section 53.23 “Control
Panel Tab” on page 1583.

Language Click to open the Language submenu

where you select a different WorkStation
language. For more information, see
section 16.3 “Language Packages” on
page 295.

Measurement system Click to open the Measurement system

submenu where you select a different local
measurement system. For more
information, see section 16.8 “Units” on
page 300.

Database mode Click to configure WorkStation to run in

database mode so changes are saved to
the EcoStruxure BMS server database and
not sent to any physical devices. For more
information, see section 52.17 “Database
Mode” on page 1528.

Options Click to open the Options dialog box

where you manage some local user
settings. For more information, see section
53.22 “Options Dialog Box” on page 1582.

System 04-30005-01-en, May 2019

1580
 53 WorkStation User Interface
53.21 Tools Menu - Measurement System Submenu

53.21 Tools Menu - Measurement System

Submenu
Use the Measurement system submenu to set the local measurement system
preferences. For more information, see section 16.8 “Units” on page 300.

Figure: Measurement system submenu

Table: Measurement System Submenu

Command Description

As in Microsoft Windows Select to display the units in the system set

by the Regional Settings that are used on
the computer.For more information, see the
Regional Settings topic on WebHelp.

As configured in object Select to display the configured units of the

object. For more information, see section
16.8 “Units” on page 300.

International System of Units (Metric) Select to display the units as SI units. For
more information, see section 16.8 “Units”
on page 300..

United States Customary Units (US) Select to display the units as United States
Customary Units. For more information,
see section 16.8 “Units” on page 300.

04-30005-01-en, May 2019 System

1581
53 WorkStation User Interface
53.22 Options Dialog Box

53.22 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
objects when you navigate between objects. For
more information, see section 56.5 “Object
Tab Display” on page 1668.

Reset all user settings Click to reset your locally saved user
setting. For more information, see the
Customization topic on WebHelp.

System 04-30005-01-en, May 2019

1582
 53 WorkStation User Interface
53.23 Control Panel Tab

53.23 Control Panel Tab

Use the Control Panel tab to access some of the most used functions in the
EcoStruxure Building Operation software.

Figure: Control Panel

Table: Control Panel

Component Description

Action notes Click to open Action notes. For more

information, see section 32.7 “Action
Notes” on page 764.

Categories Cick to open Categories. For more

information, see section 31.12 “Alarm
Categories” on page 713.

Cause notes Click to open Cause notes. For more

information, see section 32.3 “Cause
Notes” on page 760.

04-30005-01-en, May 2019 System

1583
53 WorkStation User Interface
53.23 Control Panel Tab

Continued
Component Description

Checklists Click to open Checklists. For more

information, see section 32.11 “Checklists”
on page 768.

Decoration Click to open Alarm Decoration. For more

information, see section 33.1 “Alarm
Decoration” on page 775.

Styling Click to open Alarm Styles. For more

information, see section 35.45 “Alarm
Styles View” on page 946.

Backup rules Click to open Backup Rules. For more

information, see section 64.1 “Backup and
Restore Overview” on page 1817.

Backup sets Click to open Backup Sets. For more

information, see section 66.1 “Backup
Sets” on page 1843.

Backup and restore manager Click to open Backup and Restore

Manager. For more information, see
section 64.2 “Comparison of Backup and
Restore Methods ” on page 1819.

Archiving Click to open Archive Settings. For more

information, see section 57.1 “Archiving
Overview” on page 1699.

Interface manager Click to open Interface Manager. For more

information, see the Interface Manager for
BACnet – Basic Tab topic on WebHelp.

WorkPlace tech editor Click to open WorkPlace Tech Editor.For

more information, see the WorkPlace Tech
Editor topic on WebHelp.

Binding templates Click to open Binding Templates. For more

information, see the Binding Templates
topic on WebHelp.

Bindings diagnostics Click to open Bindings Diagnostics. For

more information, see the Bindings
Management topic on WebHelp.

System license information Click to open License Information. For

more information, see the License
Information topic on WebHelp.

LNS plug-in registration Click to open LNS Plug-in Registration. For

more information, see the LNS Plug-ins
topic on WebHelp.

WorkPlace tech editor Click to open WorkPlace Tech Editor. For

more information, see the WorkPlace Tech
Editor topic on WebHelp.

System 04-30005-01-en, May 2019

1584
 53 WorkStation User Interface
53.23 Control Panel Tab

Continued
Component Description

Resource Manager Click to open LON Resource Manager. For

more information, see the Resource
Manager topic on WebHelp.

Security settings Click to open Security Manager. For more

information, see the Security Settings –
Control Panel topic on WebHelp.

Certificates Click to open Certificates. For more

information, see the Certificates topic on
WebHelp.

Password policy Click to open Password Policy. For more

information, see the Password Policy topic
on WebHelp.

Connect agent settings Click to open Connect Agent Settings. For

more information, see section 28.1
“Connect Agent Settings - Basic Tab ” on
page 573.

Document policy Click to open Document Policy. For more

information, see section 62.3 “Document
Policy” on page 1803.

Cloud connectivity Click to open Cloud Connectivity Status

and Configuration. For more information,
see the Cloud Connectivity Tab topic on
WebHelp.

MP series devices Click to see the list of MP IP controllers

MP series firmware file management Click to see the list of series firmware files
for MP IP controllers

Domain
Domains Click to open Domains. For more
information, see section 21.1 “Domains” on
page 391.

Account management Click to open Account management. For

more information, see section 19.3 “User
Accounts and User Account Groups” on
page 357.

Relative path permissions Click to open Relative Path Permissions.

For more information, see section 22.13
“Relative Path Permissions” on page 421.

Type permissions Click to open Type Permissions. For more

information, see section 22.20 “Type
Permissions” on page 428.

EWS Server Configuration Click to open the EcoStruxure Web Service

server configuration. For more information,
see the EcoStruxure Web Service Server
topic on WebHelp.

04-30005-01-en, May 2019 System

1585
53 WorkStation User Interface
53.24 Progress View – Advanced

53.24 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 an EcoStruxure BMS server. You can also see
detailed information about what went wrong if the operation fails.

Figure: Advanced Progress view when an operation failed.

System 04-30005-01-en, May 2019

1586
 53 WorkStation User Interface
53.25 Progress View – Simple

53.25 Progress View – Simple

The Progress view displays information about time-consuming operations
between WorkStation and the EcoStruxure BMS server. You can also see
detailed information about what went wrong if the operation fails. 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.

04-30005-01-en, May 2019 System

1587
53 WorkStation User Interface
53.26 Operation Details Dialog Box

53.26 Operation Details Dialog Box

The Operating details dialog box displays more detailed information on what
went wrong during the operation.

Figure: Progress manager dialog box

Table: 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. For more information,
see section 53.27 “Error Details – Progress
View” on page 1589.

Copy to clipboard Click to copy the information to the

clipboard.

System 04-30005-01-en, May 2019

1588
 53 WorkStation User Interface
53.27 Error Details – Progress View

53.27 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-30005-01-en, May 2019 System

1589
53 WorkStation User Interface
53.28 Create Object Wizard – Naming the Object Page

53.28 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
56.1 “EcoStruxure Building Operation
Objects ” on page 1663.

Name Type the name of the object. For more

information, see section 56.2 “Object
Names” on page 1664.

Prefix Type a label that is added in front of the

object name. For more information, see
section 45.4 “Suffix and Prefix” on page
1370.

Suffix Type a label that is added after the object

name. For more information, see section
45.4 “Suffix and Prefix” on page 1370.

Path 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-30005-01-en, May 2019

1590
 53 WorkStation User Interface
53.28 Create Object Wizard – Naming the Object Page

Continued
Component Description

Description Type a description that explains what the

object is used for.

04-30005-01-en, May 2019 System

1591
53 WorkStation User Interface
53.29 Create Object Wizard – Create Server from a Backup Set Page

53.29 Create Object Wizard – Create Server

from a Backup Set Page
Use the Create Server from a Backup Set page to create a SmartX server from a
Backup Set.

Figure: Create a SmartX server from a backup set page

Table: Create Server from a Backup Set page

Property Description

File Enter the path to the location of the Backup

Set from which you want to create the
SmartX server.

System 04-30005-01-en, May 2019

1592
 53 WorkStation User Interface
53.30 List View

53.30 List View

Use the List View to view, manage, and mass edit objects in the EcoStruxure
Building Operation database.

Figure: List View

Table: List View

Number Description

Parent folder
Use Parent folder to move up in the
hierarchy to the folder containing the folder
or object currently displayed in the List
View. For more information, see section
53.31 “List View Toolbar” on page 1595.

Create folder
Use Create folder to create a new folder.
For more information, see section 56.2
“Object Names” on page 1664.

Quick filter
Enter a word to filter on. For more
information, see section 52.4 “Quick Filter ”
on page 1512..

04-30005-01-en, May 2019 System

1593
53 WorkStation User Interface
53.30 List View

Continued
Number Description

Column row
Use the column row to view the contents of
the List View and to open the column
heading menu. For more information, see
section 53.13 “Column Row Context Menu”
on page 1573.

Use the list to view the contents of the

selected folder or object in the List View.

Properties
Use Properties to view the properties of the
object you have selected in the List View.
For more information, see section 56.3
“Object Properties” on page 1665.

Use the list information to view the total

number of objects iand the selected
number of objects in the List View.

System 04-30005-01-en, May 2019

1594
 53 WorkStation User Interface
53.31 List View Toolbar

53.31 List View Toolbar

Use the List View toolbar to navigate in a list, create new folders, and manage
the contents of the list view.

Table: List View Toolbar

Button Description

Parent folder
Click to move up one folder.

Create Folder
Click to create a new folder.

Show abbreviated references

Click to show the last part of the reference.
For more information, see the Show
Abbreviated References topic on
WebHelp.

Favorites
Click to open the Favorites menu where
you select, add, and manage favorites. For
more information, see the Favorites Menu
topic on WebHelp.

Quick filter Enter a word or a character to filter on. For

more information, see section 52.4 “Quick
Filter ” on page 1512.

04-30005-01-en, May 2019 System

1595
53 WorkStation User Interface
53.32 List View Context Menu

53.32 List View Context Menu

Use the List View context menu to perform a number of operations on the
selected object or objects.

NOTICE
The List View context menu is context sensitive. This means that it displays the
commands available for the selected object or objects.

Figure: The commands that are always present on the List View context menu

Table: List View Context Menu Standard Commands

Command Description

New Click to open the New submenu where you

add new objects.

Import Click to import an object to the

EcoStruxure Building Operation database.

Export Click to export an object from the

EcoStruxure Building Operation database.

Advanced Click to open the Advanced submenu

where you select or clear content types or
find out which objects that are using the
selected content type. For more
information, see section 53.33 “List View
Context Menu - Advanced Submenu ” on
page 1598.

Cut Click to cut the selected object.

Copy Click to copy the selected object.

Paste Click to paste a cut or copied object.

System 04-30005-01-en, May 2019

1596
 53 WorkStation User Interface
53.32 List View Context Menu

Continued
Command Description

Paste as shortcut Click to paste the path to an object.

Paste special Click to paste special.

Duplicate Click to duplicate the selected object.

Move Click to select a different location for the

selected object.

Delete Click to delete the selected objects.

Rename Click to rename the selected object.

Create shortcut Click to create a shortcut to the selected

object.

List View settings Click to open the List View settings

submenu. For more information, see
section 53.34 “List View Context Menu -
List View Settings Submenu ” on page
1599.

04-30005-01-en, May 2019 System

1597
53 WorkStation User Interface
53.33 List View Context Menu - Advanced Submenu

53.33 List View Context Menu - Advanced

Submenu
Use the Advanced submenu to apply or clear a content type or to find other
instances of the selected object type.

Figure: Advanced submenu

Table: List View Context Menu - Advanced Submenu

Command Description

Select Content Type Click to select a content type that you want
to apply to a folder or container object. For
more information, see section 56.22
“Content Types” on page 1686.

Clear Content Type Click to clear a content type applied on a

folder or container object. For more
information, see section 56.22 “Content
Types” on page 1686.

Find instances of this type Click to find instances of the same object
type as the object you have selected in the
List View. For more information, see the
Finding all Instances of a Custom Type
topic on WebHelp.

System 04-30005-01-en, May 2019

1598
 53 WorkStation User Interface
53.34 List View Context Menu - List View Settings Submenu

53.34 List View Context Menu - List View

Settings Submenu
Use the List View Settings submenu to add, import, or export objects, manage
content types or change the way objects are displayed in the List View.

Figure: List View settings submenu

Table: List View Context Menu - List View Settings Submenu

Command Description

Add/Remove columns Click to open the Add/Remove columns

dialog box where you add or remove
columns to the List View. For more
information, see section 53.53
“Add/Remove Columns Dialog Box (List
View)” on page 1622.

Save layout as Content Type Click to open the Save layout as Content
Type dialog box where you save the
current container object layout as a
Content Type. For more information, see
section 53.79 “Save Layout as Content
Type Dialog Box” on page 1649.

Manage Content Types Click to open the Manage Content Types

dialog box where you rename or delete
Content Types. For more information, see
section 53.80 “Manage Content Types
Dialog Box” on page 1650.

04-30005-01-en, May 2019 System

1599
53 WorkStation User Interface
53.35 System Tree Pane

53.35 System Tree Pane

Use the System Tree Pane to view and manage the structure of the EcoStruxure
Building Operation database. In the System Tree pane you can view, create,
delete, copy, rename, and move objects.

Figure: System Tree pane

Table: System Tree Pane

Number Description

Show/Hide non-presentation objects

Toggle between showing and hiding non-
presentation objects, that is, objects
required when engineering the
EcoStruxure BMS.

Collapse all
Click to collapse the System Tree so that
only the EcoStruxure BMS server of the
EcoStruxure BMS is visible.

Click to customize how the System Tree

pane is displayed. For more information,
see the Customization topic on WebHelp.

Click to unpin the System Tree pane and

collapse it to the side.

System 04-30005-01-en, May 2019

1600
 53 WorkStation User Interface
53.36 System Tree Pane Toolbar

53.36 System Tree Pane Toolbar

Use the System Tree pane toolbar to filter objects in the System Tree pane.

Table: System Tree Toolbar

Button Description

Show/Hide non-presentation objects

Click to toggle between show and hide
non-presentaion objects.

Collapse All
Click to collapse the tree structure.

04-30005-01-en, May 2019 System

1601
53 WorkStation User Interface
53.37 Confirm Delete Dialog Box

53.37 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

Keep references ... Select to keep references in other objects

to the object you want to delete.

Path Displays the path to the objects that is

affected by the object you want to delete.

Copy to clipboard Click to copy the information about the

affected references to the clipboard.

Yes Click to delete the object.

No Click to close the dialog box without

deleting the object.

System 04-30005-01-en, May 2019

1602
 53 WorkStation User Interface
53.38 Rename Object Dialog Box

53.38 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.

04-30005-01-en, May 2019 System

1603
53 WorkStation User Interface
53.39 General Information Properties – Basic Tab

53.39 General Information Properties – Basic

Tab
Use the Basic tab to configure and view the General Information properties.

Figure: General Information properties – basic tab

Table: General Information 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-EcoStruxure

Building Management product, for
example a BACnet device.

Modified Displays the date and time when the object

was last modified.

System 04-30005-01-en, May 2019

1604
 53 WorkStation User Interface
53.39 General Information Properties – Basic Tab

Continued
Component Description

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.

Executed by Indicates the object is executed by a

BACnet device. An empty field indicates
the object is executed by a SmartX server
or Enterprise Server.

04-30005-01-en, May 2019 System

1605
53 WorkStation User Interface
53.40 References Tab

53.40 References Tab

Use the References tab to view and navigate to referred objects.

Figure: References tab

Table: References Tab

Property Description

References Displays the object's references to other

objects. Click on a reference to navigate to
the object the reference points to.

System 04-30005-01-en, May 2019

1606
 53 WorkStation User Interface
53.41 Tags Dialog Box

53.41 Tags Dialog Box

Use the Tags dialog box to tag your objects with type tags.

Figure: Tags dialog box

04-30005-01-en, May 2019 System

1607
53 WorkStation User Interface
53.42 Configure Dialog Box – Configuration Tab

53.42 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 16.8
“Units” on page 300.

Init value Displays the Init value.

Reference Displays the Reference.

Forceable Select to make the value forcible. For more

information, see the Forced Values topic
on WebHelp.

Retain level Select how to handle values for warm start,

cold start, system events, and system
activities. For more information, see
section 64.3 “Retain Level ” on page 1821.

System 04-30005-01-en, May 2019

1608
 53 WorkStation User Interface
53.42 Configure Dialog Box – Configuration Tab

Continued
Component Description

Null Select the Null checkbox, to remove any

value of a property. The Null checkbox is
available for all properties where the value
can be removed. For example, you can
remove references from trend logs using
the Null checkbox.

Values can be forced to a certain value. The true value from the system is
displayed in the Unforced value box.

04-30005-01-en, May 2019 System

1609
53 WorkStation User Interface
53.43 Configure Dialog Box – Operation Tab

53.43 Configure Dialog Box – Operation Tab

Use the Operation tab to select an object, 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 path of the object you want to

select or the value that you want to use to
override the value of the property.

Force Click Force to force a value. For more

information, see the Forced Values topic
on WebHelp.

Unforce Click to release the forced value. For more

information, see the Forced Values topic
on WebHelp.

System 04-30005-01-en, May 2019

1610
 53 WorkStation User Interface
53.44 Search Icons

53.44 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 59.1 “Search
Overview” on page 1755.

04-30005-01-en, May 2019 System

1611
53 WorkStation User Interface
53.45 Search View

53.45 Search View

Use the Search view to configure the search settings, view the search results,
and save searches.

Figure: Search

Table: Search View

Component Descriptions

Use the Search toolbar to save and clear

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 reference type and folder or

container object where you want to search.

Search for properties Select to search only for properties.

Include subserver Select to include SmartX subserver in your

search.

Stop if more than 1000 results Select to stop the search when the results
exceed 1000.

Forced values only Select to search for forced values that

were forced from within the EcoStruxure
BMS.

System 04-30005-01-en, May 2019

1612
 53 WorkStation User Interface
53.45 Search View

Continued
Component Descriptions

In device Click to search for forced values that were

forced from outside the EcoStruxure BMS,
for example, on the device.

Include types Enter the object types that you want to

include in the search.

Conditions Use Conditions to enter the search

conditions that you want to apply on the
object type properties.

04-30005-01-en, May 2019 System

1613
53 WorkStation User Interface
53.46 Search View Toolbar

53.46 Search View Toolbar

Use the Search view toolbar to save a search results or clear search criteria.

Table: Search View Toolbar

Button Description

Save search criteria

Click to save the search for future use.

Clear search criteria

Click to clear all settings in the Search
View.

Favorites
Click to open the Favorites menu where
you select, add, and manage favorites.
For more information, see the Favorites
Menu topic on WebHelp.

Quick filter Enter a word to filter on. For more

information, see section 52.4 “Quick Filter ”
on page 1512..

System 04-30005-01-en, May 2019

1614
 53 WorkStation User Interface
53.47 Search Toolbar

53.47 Search Toolbar

Use the Search basic toolbar to make a simple search on all objects.

Figure: Search basic toolbar

04-30005-01-en, May 2019 System

1615
53 WorkStation User Interface
53.48 Search View Context Menu

53.48 Search View Context Menu

Use the Search View context menu to perform a number of operations on the
selected object or objects.

NOTICE
The Search View context menu is context sensitive. This means that it displays
the commands available for the selected object or objects.

Figure: The commands that are always present on the Search View context menu

Table: Search View Context Menu Standard Commands

Command Description

Cut Click to cut the selected object.

Copy Click to copy the selected object.

Paste Click to paste a cut or copied object.

Paste as shortcut Click to paste the path to an object.

Paste special Click to paste special.

Duplicate Click to duplicate the selected object.

Move Click to select a different location for the

selected object.

Delete Click to delete the selected objects.

Rename Click to rename the selected object.

Create shortcut Click to create a shortcut to the selected

object.

List View settings Click to open the List View settings

submenu. For more information, see
section 53.34 “List View Context Menu -
List View Settings Submenu ” on page
1599.

System 04-30005-01-en, May 2019

1616
 53 WorkStation User Interface
53.49 Add/Remove Columns Dialog Box (Search)

53.49 Add/Remove Columns Dialog Box

(Search)
Use the Add/Remove Columns dialog box to add or remove columns to the
Search View.

NOTICE
The columns that are displayed in the list are the columns that are relevant for
the specific search result.

Figure: Add/Remove Columns dialog box default columns

Table: Add/Remove Columns Dialog Box Default Columns

Component Description

Description Select to display what the object or

property is used for.

Foreign address Select to display the address to a non-

EcoStruxure Building Management
product, for example a BACnet device.

Modified Select to display the date and time when

the object was last modified.

Name Select to display the name of the object or

property.

Note 1 Select to display a text that appears in a

graphic or search result.

04-30005-01-en, May 2019 System

1617
53 WorkStation User Interface
53.49 Add/Remove Columns Dialog Box (Search)

Continued
Component Description

Note 2 Select to display a text that appears in a

graphic or search result.

Path Select to display the path of the object.

Property binding Select to display the in-bound binding of

the object property.

Property retain level Select to display the retain level of the

object property.

Type Select to display the object type that

defines the properties of the object

Validation Select to display the value of the validation

property of the object.

Value transfer delta Select to display the transfer rate based on

a delta value.

Value transfer interval Select to display the configured transfer

interval for the value.

Value transfer rate Select to display how often a value transfer

takes place.

System 04-30005-01-en, May 2019

1618
 53 WorkStation User Interface
53.50 Select Folder Dialog Box

53.50 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.

04-30005-01-en, May 2019 System

1619
53 WorkStation User Interface
53.51 Select Types Dialog Box

53.51 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.

Remove type
Click to remove the selected object from to
the search.

Selected object types Displays the object types that are included
in the search.

Find type Type the name of the object type you want
to include.

System 04-30005-01-en, May 2019

1620
 53 WorkStation User Interface
53.52 Select Conditions Dialog Box

53.52 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.

04-30005-01-en, May 2019 System

1621
53 WorkStation User Interface
53.53 Add/Remove Columns Dialog Box (List View)

53.53 Add/Remove Columns Dialog Box (List

View)
Use the Add/Remove Columns dialog box to add or remove columns from the
view of objects, such as folders, in the System Tree pane. Depending on the
object you have selected in the System Tree pane, you get a different set of
column options.

Figure: Ad/Remove Columns dialog box

System 04-30005-01-en, May 2019

1622
 53 WorkStation User Interface
53.54 Analog Value Properties

53.54 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 Click to force a value. For more

information, see the Forced Values topic
on WebHelp.

04-30005-01-en, May 2019 System

1623
53 WorkStation User Interface
53.55 Digital Value Properties

53.55 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 Click to force a value. For more

information, see the Forced Values topic
on WebHelp.

System 04-30005-01-en, May 2019

1624
 53 WorkStation User Interface
53.56 Multistate Value Properties

53.56 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 Click to force a value. For more

information, see the Forced Values topic
on WebHelp.

04-30005-01-en, May 2019 System

1625
53 WorkStation User Interface
53.57 String Value Properties

53.57 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 Click to force a value. For more

information, see the Forced Values topic
on WebHelp.

System 04-30005-01-en, May 2019

1626
 53 WorkStation User Interface
53.58 Time Stamp Value Properties

53.58 Time Stamp Value Properties

Use the Time Stamp Value properties dialog box to view or configure a time
stamp value.

Figure: Time stamp value

Table: Time Stamp Value

Property Description

Value Enter a date and time

04-30005-01-en, May 2019 System

1627
53 WorkStation User Interface
53.59 Signal Generator Properties - Basic Tab

53.59 Signal Generator Properties - Basic Tab

Use the Signal Generator properties Basic tab to configure a sinus, square, or
saw tooth signal used for tests.

Figure: Signal generator dialog box

Component Description

Value Select the signal value and whether to

force or unforce the value.

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.

System 04-30005-01-en, May 2019

1628
 53 WorkStation User Interface
53.60 Simple Math Operator Properties - Basic Tab

53.60 Simple Math Operator Properties -

Basic Tab
Configure the Simple Math Operator properties Basic tab 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.

Value Displays the calculated value.

04-30005-01-en, May 2019 System

1629
53 WorkStation User Interface
53.61 Timed Force Analog Object Properties – Basic Tab

53.61 Timed Force Analog Object Properties –

Basic Tab
Use the Basic tab to configure and view the basic properties of the Timed Force
Analog object.

Figure: Timed Force Analog Object properties – basic tab

Table: Basic Tab

Component Description

Value Displays the value of the object's output.

Force type select Select the type of force time.

Force duration Select the duration of the force in minutes.

Force until Select the date and time at which the force
must end.

Input Displays the constant or reference value of

the input.

System 04-30005-01-en, May 2019

1630
 53 WorkStation User Interface
53.62 Timed Force Analog Object Properties – Parameters Tab

53.62 Timed Force Analog Object Properties –

Parameters Tab
Use the Parameters tab to view and edit the properties of the Timed Force
Analog object.

Figure: Timed Force Analog Object properties – parameters tab

Table: Parameters Tab

Component Description

Update time Select the frequency at which the input

value is sent to the output. This value also
establishes the frequency with which the
force is evaluated for ending.

Transfer rate Select the frequency at which the input is

updated from other objects or devices.

04-30005-01-en, May 2019 System

1631
53 WorkStation User Interface
53.63 Timed Force Digital Object Properties – Basic Tab

53.63 Timed Force Digital Object Properties –

Basic Tab
Use the Basic tab to configure and view the basic properties of the Timed Force
Digital object.

Figure: Timed Force Digital object properties – basic tab

Table: Basic Tab

Component Description

Value Displays the value of the object's output.

Force type select Select the type of force time.

Force duration Select the duration of the force in minutes.

Force until Select the date and time at which the force
must end.

Input Displays the constant or reference value of

the input.

System 04-30005-01-en, May 2019

1632
 53 WorkStation User Interface
53.64 Timed Force Digital Object Properties – Parameters Tab

53.64 Timed Force Digital Object Properties –

Parameters Tab
Use the Parameters tab to view and edit the properties of the Timed Force
Digital object.

Figure: Timed Force Digital object properties – parameters tab

Table: Parameters Tab

Component Description

Update time Select the frequency at which the input

value is sent to the output. This value also
establishes the frequency at which the
force is evaluated for ending.

Transfer rate Select the frequency at which the input is

updated from other objects or devices.

04-30005-01-en, May 2019 System

1633
53 WorkStation User Interface
53.65 Timed Force Multistate Object Properties – Basic Tab

53.65 Timed Force Multistate Object

Properties – Basic Tab
Use the Basic tab to configure and view the basic properties of the Timed Force
Multistate object.

Figure: Timed Force Multistate object properties – basic tab

Table: Basic Tab

Component Description

Value Displays the value of the object's output.

Force type select Select the type of force time.

Force duration Select the duration of the force in minutes.

Force until Select the date and time at which the force
must end.

Input Displays the constant or reference value of

the input.

System 04-30005-01-en, May 2019

1634
 53 WorkStation User Interface
53.66 Timed Force Multistate Object Properties – Parameters Tab

53.66 Timed Force Multistate Object

Properties – Parameters Tab
Use the Parameters tab to view and edit the properties of the Timed Force
Multistate object.

Figure: Timed Force Multistate object properties – parameters tab

Table: Parameters Tab

Component Description

Update time Select the frequency at which the input

value is sent to the output. This value also
establishes the frequency at which the
force is evaluated for ending.

Transfer rate Select the frequency at which the input is

updated from other objects or devices.

04-30005-01-en, May 2019 System

1635
53 WorkStation User Interface
53.67 Timed Force Multistate Object Properties – State Configuration Tab

53.67 Timed Force Multistate Object

Properties – State Configuration Tab
Use the State Configuration tab to configure the state properties of the Timed
Force Multistate object.

Figure: Timed Force Multistate object properties – State Configuration tab

Table: State Configuration Tab

Component Description

Number of states Enter the number of states to be used in

this object, up to a maximum of 256 states.

State Definitions Displays a list of the states created in the

Timed Force Multistate object, along with
the Label text string associated with each
state.

System 04-30005-01-en, May 2019

1636
 53 WorkStation User Interface
53.68 Create Hyperlink Wizard – Assign the URL Page

53.68 Create Hyperlink Wizard – Assign the

URL Page
Use the Assign the URL page to type the URL.

Figure: Assign the URL page

Table: Assign the URL Page

Component Description

URL Type the URL of the website including the

internet protocol http:// or https://.

04-30005-01-en, May 2019 System

1637
53 WorkStation User Interface
53.69 Select Object Dialog Box

53.69 Select Object Dialog Box

Use the Select Object dialog box to select objects.

Figure: Select object dialog box

Table: Select Object Dialog Box

Command Description

Lock path Select to lock the path and make it

absolute. For more information, see the
Reference Format topic on WebHelp.

Path Displays the path to the selected object.

System 04-30005-01-en, May 2019

1638
 53 WorkStation User Interface
53.70 Select Object and Property Dialog Box

53.70 Select Object and Property Dialog Box

Use the Select Object and Property dialog box to select an object and its
properties.

Figure: Select object and Property dialog box

Table: Select Object and Property Dialog Box

Component Description

Lock path Select to lock the path and make it

absolute. For more information, see the
Reference Format topic on WebHelp.

Path Displays the path to the selected object.

04-30005-01-en, May 2019 System

1639
53 WorkStation User Interface
53.71 Progress View

53.71 Progress View

The Progress view displays information about time-consuming operations
between WorkStation and the EcoStruxure BMS 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-30005-01-en, May 2019

1640
 53 WorkStation User Interface
53.72 Status Bar

53.72 Status Bar

Use the Status bar to view information on the following items:
• connectivity status
• security certificates
• which EcoStruxure BMS server the user is logged on to
• the name of the logged on user account
• which domain the user is logged on to
• whether or not database mode is active
• the current language
• the measurement system

Figure: Status bar

Component Description

Indicates that the security certificate is

valid.

Indicates that the security certificate

cannot be validated.

Connected to
Indicates that WorkStation is connected to
the EcoStruxure BMS server.

Trying to connect to
Indicates that WorkStation is disconnected
from the EcoStruxure BMS server and
trying to connect.

User account Displays the account you are currently

using.

Domain Displays the domain you are logged on to.

Database mode
Indicates that database mode is active. For
more information, see section 52.17
“Database Mode” on page 1528.

Current language Displays the current display language of

the system in the drop-down menu beside
the user account.

Measurement system Displays the selected measurement

system for the system in the drop-down
beside the user account.

04-30005-01-en, May 2019 System

1641
53 WorkStation User Interface
53.73 System Object Properties

53.73 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
53.39 “General Information Properties – Basic Tab” on page 1604.

Figure: System Object Properties

System 04-30005-01-en, May 2019

1642
 53 WorkStation User Interface
53.74 System Control Panel Properties

53.74 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 53.39 “General Information Properties – Basic Tab” on page 1604.

Figure: System Control Panel Properties

04-30005-01-en, May 2019 System

1643
53 WorkStation User Interface
53.75 Commit Page

53.75 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-30005-01-en, May 2019

1644
 53 WorkStation User Interface
53.76 Objects and Trends Dialog Box

53.76 Objects and Trends Dialog Box

Use the Objects and trends dialog box to view trend objects that are related to
one or several selected objects or object properties.

Figure: Objects and trends dialog box when you have selected only one object or property.

04-30005-01-en, May 2019 System

1645
53 WorkStation User Interface
53.76 Objects and Trends Dialog Box

Figure: Objects and trends dialog box when you have selected several objects, properties,
or graphic components or groups containing bound properties.

Table: Objects and Trends

Property Description

[Quick filter] Enter a word or a character to filter on. For

more information, see section 52.4 “Quick
Filter ” on page 1512.

Objects Lists the available objects, for example, the

bound properties of a graphic component.

Trends Lists the trends related to the selected

object or property

Path Displays the path of the object, property,

or trend selected in the list.

System 04-30005-01-en, May 2019

1646
 53 WorkStation User Interface
53.77 Duplicate Dialog Box

53.77 Duplicate Dialog Box

Use the Duplicate dialog box to create one or several copies of an object.

Figure: Duplicate dialog box

Table: Duplicate Dialog Box

Component Description

Number of duplicates Type the number of copies you want to

create.

Name Displays the name of the object to copy.

New name Type names you want the copies to get

when created.

04-30005-01-en, May 2019 System

1647
53 WorkStation User Interface
53.78 Rename Dialog Box

53.78 Rename Dialog Box

Use the Rename dialog box to mass rename objects in an EcoStruxure BMS.

Figure: Rename dialog box

Table: Rename Dialog Box

Component Description

Name Displays the current object name.

New name Type or paste a new name for an object.

System 04-30005-01-en, May 2019

1648
 53 WorkStation User Interface
53.79 Save Layout as Content Type Dialog Box

53.79 Save Layout as Content Type Dialog

Box
Use the Save Layout as Content Type dialog box to save the layout of a folder
or other container object.

Figure: Save Layout as Content Type dialog box

Table: Save Layout as Content Type Dialog Box

Component Description

Click to add a layout as a new content

type.

04-30005-01-en, May 2019 System

1649
53 WorkStation User Interface
53.80 Manage Content Types Dialog Box

53.80 Manage Content Types Dialog Box

Use the Manage Content Types dialog box to rename or delete a Content Type.

Figure: Manage Content Types dialog box

Table: Manage Content Types Dialog Box

Command Description

Click to edit the name of a Content Type.

Click to delete a Content Type from the

database.

System 04-30005-01-en, May 2019

1650
 53 WorkStation User Interface
53.81 Select Content Type Dialog Box

53.81 Select Content Type Dialog Box

Use the Select Content Type dialog box to select a content type to apply on the
selected folder or container object.

Figure: Select Content Type dialog box

Table: Select Content Type Dialog Box

Component Description

Content types Click to select the content type you want to

apply.

04-30005-01-en, May 2019 System

1651
53 WorkStation User Interface
53.82 Building Operation WorkStation Error

53.82 Building Operation WorkStation Error

Use the Building Operation WorkStation Error dialog box to send a file with
information about the cause of the crash to Schneider Electric.

Figure: Building Operation WorkStation Error

Table: Building Operation WorkStation Error

Component Description

More info Click to get more information on the cause

of the crash.

Copy to Clipboard Click to copy information about the cause

of the crash to the Windows clipboard.

Send report Click to send the crash report to Schneider

Electric.

Close program Click to close the program without sending

any crash report.

Continue Click to resume the program. This option is

only available when the program is able to
resume after a crash, which is not typically
the case.

System 04-30005-01-en, May 2019

1652
54 WebStation

introduction to this topic

Topics
Time and Date
Configuring Time and Date using WebStation
 54 WebStation
54.1 Time and Date

54.1 Time and Date

You can configure the time and date on your EcoStruxure BMS server devices
using WebStation. WebStation cannot be used to configure time and date on an
Enterprise Server.

04-30005-01-en, May 2019 System

1655
54 WebStation
54.2 Configuring Time and Date using WebStation

54.2 Configuring Time and Date using

WebStation
You configure time and date on the SmartX server so that it suits your needs.
For more information, see section 54.1 “Time and Date” on page 1655.

To configure time and date using WebStation

1. In WebStation, in the System tree pane, in the System folder, click Time
Settings
Settings.
2. In the List View, click Date and Time
Time.
3. Click Time
Time.
4. In the Use external NTP server box, select Enabled
Enabled.
5. In the NTP Server 1 box, type the address to the primary time server to
which the shadow SmartX server date and time object synchronizes its
clock.
6. In the NTP Server 2 box, type the address to the secondary time server to
which the shadow SmartX server date and time object synchronizes its
clock.
7. In the Lead object field, enter the object that acts as the lead for this object.
8. Type the ID of the authentication key for the primary time server.
9. Type the ID of the authentication key for the secondary time server.
10. Type the password for the primary time server.
11. Type the password for the secondary time server.
12. In the Date and Time box, enter the time if you are not using NTP server.
13. Click Save
Save.

System 04-30005-01-en, May 2019

1656
55 WebStation User Interface

introduction to this topic

Topics
Time and Date Editor in WebStation
 55 WebStation User Interface
55.1 Time and Date Editor in WebStation

55.1 Time and Date Editor in WebStation

Use the Time and Date editor to configure the network time server addresses or
configure time on EcoStruxure BMS servers.

Figure: Time and date editor

Table: Time and Date Editor

Property Description

Use external NTP server Select Enabled to define the primary and
secondary NTP server addresses for
connected shadow EcoStruxure BMS
server devices.

04-30005-01-en, May 2019 System

1659
55 WebStation User Interface
55.1 Time and Date Editor in WebStation

Continued
Property Description

NTP Server 1 Type the address to the primary time

server to which the shadow SmartX server
date and time object synchronizes its
clock.

NTP Server 2 Type the address to the secondary time

server to which the shadow SmartX
servers' date and time object synchronizes
its clock.

Lead object Enter the object that acts as the lead for
this object.

NTP Server 1 Key Id Type the ID of the authentication key for

the primary time server.

NTP Server 2 Key Id Type the ID of the authentication key for

the secondary time server.

NTP Server 1 Key Value Type the password for the primary time
server.

NTP Server 2 Key Value Type the password for the secondary time
server.

Authenticate Network Time Select if you want to use authenticated

Synchronization network time synchronizing.

Date and time Configure the date and time if you do not
want to use an external NTP server.

System 04-30005-01-en, May 2019

1660
56 EcoStruxure Building
Operation Objects

Topics
EcoStruxure Building Operation Objects
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
Creating a Folder
Copy, Paste, Duplicate, Move, Rename, and Delete
Copying a Folder or Object
Duplicating an Object
Renaming a Folder or Object
Deleting an Object
Adding and Removing Columns
Mass Edit
Mass Editing Objects
Mass Renaming Objects
Mass Renaming Objects Using Copy and Paste
56 Mass Changing Units
List View Features
Renaming in List View
Content Types
Creating a Content Type
Applying a Content Type
Renaming a Content Type
Clearing a Content Type
Deleting a Content Type
Content Type Synchronization
Synchronizing Content Types
Semantic Tagging
Tagging with Semantic Tags
 56 EcoStruxure Building Operation Objects
56.1 EcoStruxure Building Operation Objects

56.1 EcoStruxure Building Operation Objects

The EcoStruxure 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 permissions, 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.

56.1.1 Object Names

All objects in the EcoStruxure Building Operation database have to have a
name. The EcoStruxure Building Operation objects are case-sensitive and
differentiates between upper and lowercase characters.
For more information, see section 56.2 “Object Names” on page 1664.

56.1.2 Object Properties

Every object in the EcoStruxure Building Operation database has a number of
different properties. 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.
For more information, see section 56.3 “Object Properties” on page 1665.

56.1.3 Content Types

Content types are predefined layouts that you save to reuse for specific types of
folders or container objects.
For more information, see section 56.22 “Content Types” on page 1686.

56.1.4 List View Features

You use the List View to view, manage, and mass edit objects in the EcoStruxure
Building Operation database.
For more information, see section 56.20 “List View Features” on page 1684.

04-30005-01-en, May 2019 System

1663
56 EcoStruxure Building Operation Objects
56.2 Object Names

56.2 Object Names

All objects in the EcoStruxure Building Operation database have to have a
name. The EcoStruxure Building Operation objects are case-sensitive and
differentiates between upper and lowercase characters.
Two objects cannot have the same name 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 EcoStruxure
Building Operation software.
• /
• "
• ?
• *
• ~
• <
• >
• |
• White space is not allowed in the beginning or the end of an objects name.
• . (period) is not allowed in the beginning or the end 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 EcoStruxure Building Operation database.

56.2.1 Mass Edit

Use mass edit when you want to change several property values or rename
several objects at a time.
For more information, see section 56.15 “Mass Edit” on page 1679.

System 04-30005-01-en, May 2019

1664
 56 EcoStruxure Building Operation Objects
56.3 Object Properties

56.3 Object Properties

Every object in the EcoStruxure Building Operation database has a number of
different properties. 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.
There are three ways to access the properties of a selected object in
WorkStation:
• Properties tab
• Properties Dialog box
• Properties grid
All three methods displays the same properties.

Figure: The Properties tab for a trend log.

04-30005-01-en, May 2019 System

1665
56 EcoStruxure Building Operation Objects
56.3 Object Properties

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.
A common tab for all objects is the Basic properties tab that contains general
properties as type, name and description.

System 04-30005-01-en, May 2019

1666
 56 EcoStruxure Building Operation Objects
56.4 Opening an Object in a New Window

56.4 Opening an Object in a New Window

You open an object in a new window to be able to display two or more objects at
the same time.
For more information, see the Window Menu topic on WebHelp.

To open an object in a new window

1. In WorkStation, in the System Tree pane, right-click the object you want to
open in the new window, and then click Open in new window
window.

04-30005-01-en, May 2019 System

1667
56 EcoStruxure Building Operation Objects
56.5 Object Tab Display

56.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-30005-01-en, May 2019

1668
 56 EcoStruxure Building Operation Objects
56.6 Showing the Same Tab While Navigating Between Objects

56.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 56.6 “Showing the Same Tab While Navigating
Between Objects” on page 1669.

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-30005-01-en, May 2019 System

1669
56 EcoStruxure Building Operation Objects
56.7 Showing Non-Presentation Objects in the System Tree Pane

56.7 Showing Non-Presentation Objects in

the System Tree Pane
You use the Show/Hide non-presentation object filter 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 the System Tree Pane topic on WebHelp.

To show non-presentation objects in the System Tree pane

1. Click the Show/Hide non-presentation objects button .

System 04-30005-01-en, May 2019

1670
 56 EcoStruxure Building Operation Objects
56.8 Creating a Folder

56.8 Creating a Folder

You create folders to organize your EcoStruxure Building Operation database.
For more information, see the Xenta LonWorks Groups topic on WebHelp.

To create a folder
1. In WorkStation, in the System Tree pane, select the folder, EcoStruxure
BMS 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 Create Object wizard, 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.

04-30005-01-en, May 2019 System

1671
56 EcoStruxure Building Operation Objects
56.9 Copy, Paste, Duplicate, Move, Rename, and Delete

56.9 Copy, Paste, Duplicate, Move, Rename,

and Delete
You can copy, paste, duplicate, move, rename, and delete objects from the
EcoStruxure Building Operation database at any time. To help you identify the
object references that are affected when you delete an object, the EcoStruxure
Building Operation software displays a dialog box with information about
references.

Paste
Paste removes all external references that are relative but keeps absolute and
locked references.

Paste Special
Paste Special does the same thing as Paste but with the added benefit of
keeping all of the external references.

Duplicate
Duplicate creates the configured number of copies of a selected object in one
single operation. You can duplicate container objects, for example, folders with
complete structures. Duplicate allows you to rename the objects before
creating.

Move
Move does not affect the references. When you move an object, that object still
references the same objects it referenced before you moved it. Objects referring
to a moved object still refer to the same object after the move. Object cannot be
moved between EcoStruxure BMS servers however.

Rename
Objects that are referring to each other do not lose their references if you
change the name of an object. The EcoStruxure Building Operation software
automatically updates any references after you have renamed an object.

Delete
When deleting an object, you can select to keep the reference in other objects to
the object you want to delete. You can then add a new object with the same
name on the same location and all references are valid. This can be used if you,
for example want to replace an analog value with a digital value or a multistate
value.

Offline
If some of the objects are offline during a rename or delete, the system cannot
update the references. In this case, the system informs you of the references
that cannot be updated. You can still complete the procedure, but you have to
keep track of the reference that are not updated. You can repair the references
when the offline object is online again.

System 04-30005-01-en, May 2019

1672
 56 EcoStruxure Building Operation Objects
56.9 Copy, Paste, Duplicate, Move, Rename, and Delete

NOTICE
When changing the name of a folder or EcoStruxure BMS server, you also
have to reconfigure users and user groups path permissions to this
EcoStruxure BMS server or folder. For more information, see section 22.2
“Path Permissions” on page 409.

04-30005-01-en, May 2019 System

1673
56 EcoStruxure Building Operation Objects
56.10 Copying a Folder or Object

56.10 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.

System 04-30005-01-en, May 2019

1674
 56 EcoStruxure Building Operation Objects
56.11 Duplicating an Object

56.11 Duplicating an Object

You duplicate an object when you want to create several copies of an object in
one single operation, for example a folder.
For more information, see section 56.9 “ Copy, Paste, Duplicate, Move, Rename,
and Delete” on page 1672.

To duplicate an object
1. In WorkStation, in the System Tree pane or in the List View
View, select the
object you want to duplicate.
2. On the Edit menu, click Duplicate
Duplicate.
3. In the Number of duplicates box, enter the number of copies you want to
create.
4. Press ENTER.
5. In the New name column, click the name you want to change and type a
new name.
6. Click OK
OK.
The configured number copies of are created and named according to the
names in the list.

04-30005-01-en, May 2019 System

1675
56 EcoStruxure Building Operation Objects
56.12 Renaming a Folder or Object

56.12 Renaming a Folder or Object

You rename a folder or object to make the name more suitable to your needs.

NOTICE
When changing the name of a folder or EcoStruxure BMS server, you also
have to reconfigure users and user groups path permissions to this
EcoStruxure BMS server or folder. For more information, see section 22.2
“Path Permissions” on page 409.

NOTICE
You cannot change the name of a domain that is shared between EcoStruxure
BMS servers.

For more information, see section 56.9 “ Copy, Paste, Duplicate, Move, Rename,
and Delete” on page 1672.

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.

System 04-30005-01-en, May 2019

1676
 56 EcoStruxure Building Operation Objects
56.13 Deleting an Object

56.13 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 56.9 “ Copy, Paste, Duplicate, Move, Rename,
and Delete” on page 1672.

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. Select if you want to keep references in other object(s) to the object you
selected to delete.
4. Click Show references to see the affected references.
5. In the Confirm Delete dialog box, click Yes
Yes.

04-30005-01-en, May 2019 System

1677
56 EcoStruxure Building Operation Objects
56.14 Adding and Removing Columns

56.14 Adding and Removing Columns

You temporarily add or remove columns in a pane or View to get a better
overview of the properties.
For more information, see section 56.1 “EcoStruxure Building Operation
Objects ” on page 1663.

To add and remove columns

1. In WorkStation, in the pane or View, right-click the column heading and
then click Add/remove columns
columns.
2. In the Add/Remove dialog box, select the columns you want to add or clear
the columns you want to remove.
3. Click OK
OK.
When you log out from WorkStation, the pane or View returns to the default
columns.

System 04-30005-01-en, May 2019

1678
 56 EcoStruxure Building Operation Objects
56.15 Mass Edit

56.15 Mass Edit

Use mass edit when you want to change several property values or rename
several objects at a time.
You can change several property values at a time, for example, when you want
to change all setpoints from 22 to 20. For more information, see section 56.16
“Mass Editing Objects” on page 1680.

Figure: Multi editing

The objects do not need to be of the same type to be mass edited. However, the
properties you want to edit have to be of the same type.
You can mass rename all objects that are possible to move. For example, you
can rename alarms but not properties.
You can rename the objects one by one. You can also copy row-separated text
from a file, such as an MS Excel file, and paste it to rename several rows in one
single operation. When you paste, the copied text is pasted from the row you
have clicked and down in the list. If the copied text is longer than the number of
rows, pasting stops at the last row.
For more information, see section 56.17 “Mass Renaming Objects ” on page
1681.
For more information, see section 56.18 “Mass Renaming Objects Using Copy
and Paste ” on page 1682.
When you hover over the names in the Name column, the full path of the object
is displayed.
You can mass change the units of objects in a search result. For more
information, see section 56.19 “Mass Changing Units” on page 1683.

04-30005-01-en, May 2019 System

1679
56 EcoStruxure Building Operation Objects
56.16 Mass Editing Objects

56.16 Mass Editing Objects

You can edit more than one object at the same time to save time.
For more information, see section 56.15 “Mass Edit” on page 1679.

To mass edit objects

1. In WorkStation, in the List View
View, select the objects you want to edit.
2. In the List View
View, expand Properties
Properties.
3. In the Properties grid, edit the property you want to change for all selected
objects.

4. Click the Save button.

System 04-30005-01-en, May 2019

1680
 56 EcoStruxure Building Operation Objects
56.17 Mass Renaming Objects

56.17 Mass Renaming Objects

You mass rename objects to make renaming more efficient and consistent.
For more information, see section 56.15 “Mass Edit” on page 1679.

To mass rename objects

1. In WorkStation, select the container for the objects you want to rename or
perform a search.
2. In the List View or Search View
View, select the objects you want to rename.
3. On the Edit menu, click Rename
Rename.
4. In the Rename dialog box, in the New name column, select the object
name you want to change and type or paste the new name.
5. Click OK
OK.

04-30005-01-en, May 2019 System

1681
56 EcoStruxure Building Operation Objects
56.18 Mass Renaming Objects Using Copy and Paste

56.18 Mass Renaming Objects Using Copy

and Paste
You mass rename objects using copy and paste to copy the names from, for
example, a spreadsheet.
For more information, see section 56.15 “Mass Edit” on page 1679.

To mass rename objects using copy and paste

1. In WorkStation, select the container for the objects you want to rename or
perform a search.
2. In the List View or Search View
View, select the objects you want to rename.
3. On the Edit menu, click Rename
Rename.
4. In the Rename dialog box, click the row in the Name column from which
you want to start replacing the names.
5. Copy any row-separated text, for example, from MS Excel.
6. Press Ctrl
Ctrl+v
+v.
7. Click OK
OK.

System 04-30005-01-en, May 2019

1682
 56 EcoStruxure Building Operation Objects
56.19 Mass Changing Units

56.19 Mass Changing Units

You mass change units of the EcoStruxure Building Operations objects to save
time when configuring units.
For more information, see section 56.15 “Mass Edit” on page 1679.

To mass change units

1. In WorkStation, select the container for the objects whose units you want to
change.
2. In the Search View
View, type a common name or part of name of the objects
you want to search for.
3. Select the Search for properties box.
4. In the Property name box, enter the name of the property whose unit you
want to change.
5. In the search result list, select the objects whose units you want to change.
6. Right-click and then click Select unit
unit.
7. In the Select Unit dialog box, select the unit from the list and click Select
Select.
The unit properties of the objects are immediately changed in the database.

04-30005-01-en, May 2019 System

1683
56 EcoStruxure Building Operation Objects
56.20 List View Features

56.20 List View Features

You use the List View to view, manage, and mass edit objects in the EcoStruxure
Building Operation database.
You can use the List View to navigate. You can rename, edit descriptions and
values, copy, and paste objects in the List View. You can multi-select objects in
the List View for more efficient operations.
Using the Quick filter, you can easily filter objects in the list. For more
information, see section 52.4 “Quick Filter ” on page 1512.
The List View is displayed in the WorkStation work area.
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. In the List View, you can see the total number of items in the selected
object. A filter icon is displayed when a filter is active.
You can group and sort the objects in the List View. For more information, see
the Group and Sort Objects topic on WebHelp.ects
You can add or remove columns in the List View. For more information, see
section 56.14 “Adding and Removing Columns” on page 1678.Add/Remove
Columns Dialog Box
Personal settings can be saved as Favorites for folders and other container
objects displayed in the List View. For more information, see the Favorites topic
on WebHelp.
You can edit the layout of a folder or other container object in the List View and
save the layout for reuse as a content type. For more information, see section
56.22 “Content Types” on page 1686.
You can rename an object directly in the List View. For more information, see
section 56.21 “Renaming in List View” on page 1685.
You can mass rename objects from the List View. For more information, see
section 56.17 “Mass Renaming Objects ” on page 1681.

System 04-30005-01-en, May 2019

1684
 56 EcoStruxure Building Operation Objects
56.21 Renaming in List View

56.21 Renaming in List View

You rename an object in List View to give it a more descriptive name.
For more information, see section 56.20 “List View Features” on page 1684.

To rename in List View

1. In WorkStation, select the folder or other container object containing the
object you want to rename.
2. In the List View
View, slowly single-click the object you want to rename.
3. Type a new name for the object.
4. Continue renaming all the objects you want to rename.
5. On the File menu, click Save .

04-30005-01-en, May 2019 System

1685
56 EcoStruxure Building Operation Objects
56.22 Content Types

56.22 Content Types

Content types are predefined layouts that you save to reuse for specific types of
folders or container objects.
In an EcoStruxure BMS with an Enterprise Server and SmartX servers, you
create content types on the Enterprise Server. The content types are then
available for reuse on SmartX servers. In this case, you cannot create new
content types on the SmartX servers. In an EcoStruxure BMS with only one
SmartX server, you can create new content types on the SmartX server.
You can apply content types on folders and other container objects, such as
search, interfaces, and applications, provided you have the Write permission to
that folder or container object. You can revert your layout changes to factory
default.
The content type controls what is displayed when you open the folder or
container object in the List View. You use the List View to configure new content
types. In a content type you can save the following properties:
• the columns to include or exclude
• the column width
• the order in which the columns are displayed
• the content sort order
• the content group
For example, you want the Alarms folders to display the columns: Name,
Description, Upper limit, and Lower limit. You increase the width of the
Description column and then name and save the content type. When you create
an Alarms2 folder where you want the same layout and columns, you apply the
saved content type on the Alarms2 folder to get the same type of appearance.
Content types are saved in the Content Types folder in the System folder in the
EcoStruxure Building Operation database. Content types saved on an
Enterprise Server are propagated to SmartX servers in the EcoStruxure BMS.
When you save layout changes to a folder or container object as a content type,
the changes are only applied on that specific folder or container object and for
all users who view the folder or container object. Other folders or container
objects in the EcoStruxure BMS are not affected. If you edit the layout of a folder
or container object of a saved content type and save it under the existing
content type name, the existing content type is overwritten. In this case, the
layout of all folders or container objects of that content type are changed.
You can import and export content types. When you import or export a folder or
other container object with a specific content type, the reference to the content
type is included in the import or export file.
You can delete content types that you no longer need. When you delete a
content type, you delete the content type for all the folders or container objects
of that type. The layout of these folders or container objects is then reverted to
their factory default layouts.
If you have made personal changes to a folder or container object, you can save
the changes as a favorite. When you apply a favorite on a folder or container
object, the favorite configuration overrides the content type. For more
information, see the Favorites topic on WebHelp.

System 04-30005-01-en, May 2019

1686
 56 EcoStruxure Building Operation Objects
56.22 Content Types

56.22.1 Content Type Synchronization

When you have predefined content types that you want to use for specific types
of folders or container objects on an EcoStruxure BMS server, you can reuse the
content types on another EcoStruxure BMS server. You reuse the content types
by configuring a lead-shadow relationship on the shadow object.
For more information, see section 56.28 “Content Type Synchronization” on
page 1693.

04-30005-01-en, May 2019 System

1687
56 EcoStruxure Building Operation Objects
56.23 Creating a Content Type

56.23 Creating a Content Type

You create a content type to reuse predefined layouts for specific types of
folders or other container objects.
For more information, see section 56.22 “Content Types” on page 1686.

To create a content type

1. In WorkStation, in the System Tree pane, select the folder or container
object whose layout you want to use to create the content type.
2. In the List View
View, configure the layout:
• Add or remove columns
• Change the order in which the columns are displayed
• Change the column width
• Change the sort order
• Group objects
3. Right-click the List View work area.
4. Point to List View settings and then click Save layout as Content Type
Type.

5. In the Save Layout As Content Type dialog box, click the Add button .
6. Type a name for the content type.
7. Click OK
OK.
The content type is saved in the Content Types folder in the System folder and
is ready for reuse.

System 04-30005-01-en, May 2019

1688
 56 EcoStruxure Building Operation Objects
56.24 Applying a Content Type

56.24 Applying a Content Type

You apply a content type when you want to reuse predefined layouts for a
specific type of folder or other container object.
For more information, see section 56.22 “Content Types” on page 1686.

To apply a content type

1. In WorkStation, in the System Tree pane or List View
View, click the folder or
container object whose layout you want to change.

NOTICE
By selecting multiple folders, you can apply a content type to several
folders in one operation.

2. On the Actions menu, point to Advanced and then click Select Content
Type
Type.
3. In the Select Content Type dialog box, select the content type whose
layout you want to apply to the selected folder .
4. Click OK
OK.
The layout of the folder or container object is changed to that of the applied
content type.

04-30005-01-en, May 2019 System

1689
56 EcoStruxure Building Operation Objects
56.25 Renaming a Content Type

56.25 Renaming a Content Type

You rename a content type to give the predefined layout a more descriptive
name.
For more information, see section 56.22 “Content Types” on page 1686.

To rename a content type

1. In WorkStation, in the System Tree pane, select a folder or container object
of the content type you want to edit.
2. Right-click the List View work area.
3. Point to List View settings and then click Manage Content Types
Types.

4. In the Manage Content Types dialog box, click the Edit button .
5. Type a new name for the content type.
6. Click OK
OK.
The renamed content type is saved in the Content Types folder in the System
folder under its new name and is ready for reuse.

System 04-30005-01-en, May 2019

1690
 56 EcoStruxure Building Operation Objects
56.26 Clearing a Content Type

56.26 Clearing a Content Type

You clear a content type to revert content type layout changes made to a
specific folder or other container object.
For more information, see section 56.22 “Content Types” on page 1686.

To clear a content type

1. In WorkStation, in the System Tree pane, click the folder or container
object whose layout you want to revert.
2. On the Actions menu, point to Advanced and then click Clear Content
Type
Type.
3. Click OK
OK.
The layout changes applied from the content type are immediately reverted and
the factory default layout of the folder or container object is displayed. The
content type is not removed.

04-30005-01-en, May 2019 System

1691
56 EcoStruxure Building Operation Objects
56.27 Deleting a Content Type

56.27 Deleting a Content Type

You delete a content type from the database when you no longer need the
predefined layout for a specific type of folder or other container object.
For more information, see section 56.22 “Content Types” on page 1686.

To delete a content type

1. In WorkStation, in the System Tree pane, select a folder or container
object.
2. Right-click the List View work area.
3. Point to List View settings and then click Manage Content Types
Types.
4. In the Manage Content Types dialog box, select the content type you want
to delete.

5. Click the Remove button .

6. Select another content type in the dialog box.
7. Click OK
OK.
The content type is deleted from the Content Types folder in the System folder.

System 04-30005-01-en, May 2019

1692
 56 EcoStruxure Building Operation Objects
56.28 Content Type Synchronization

56.28 Content Type Synchronization

When you have predefined content types that you want to use for specific types
of folders or container objects on an EcoStruxure BMS server, you can reuse the
content types on another EcoStruxure BMS server. You reuse the content types
by configuring a lead-shadow relationship on the shadow object.
Lead-shadow relationship means that properties of the lead object are
propagated to the shadow object.
Content types saved on an Enterprise Central are not automatically propagated
to folders or container objects on Enterprise Servers in the EcoStruxure BMS.
Content types saved on an Enterprise Server are automatically propagated to
folders or container objects on SmartX servers in the EcoStruxure BMS.
When you have configured a lead-shadow relationship, the shadow object
becomes read-only.
When logged on to a top-tier EcoStruxure BMS server, you can disconnect a
synchronized folder or container object on a lower-tier EcoStruxure BMS server
from content type on the top-tier EcoStruxure BMS server. The folder or
container object then becomes writeable. When you have disconnected, the
current configuration of the folder or container object is retained.

04-30005-01-en, May 2019 System

1693
56 EcoStruxure Building Operation Objects
56.29 Synchronizing Content Types

56.29 Synchronizing Content Types

You synchronize content types to reuse the content types on a parent
EcoStruxure BMS server.

NOTICE
Export content types from the child Ecostructure BMS server (Enterprise
Server or Automation Server) and import them to the parent server (Enterprise
Central or Enterprise Server) before you synchronize them. During
synchronization, all the content types are erased from the child server.

To synchronize content types

1. Make sure that you have exported content types from the child server and
imported them to the parent server.
2. In WorkStation, in the System Tree pane, expand the System folder for the
server that is to be synchronize with its parent.
3. Select Content Types
Types.
4. On the Actions menu, point to Advanced and then click Synchronize with
parent server
server.
5. Click Yes
Yes.

System 04-30005-01-en, May 2019

1694
 56 EcoStruxure Building Operation Objects
56.30 Semantic Tagging

56.30 Semantic Tagging

Semantic tagging enables standard applications to tag their objects with type
tags, according to the Brick standard.
Brick standard is included in the installation of the EcoStruxure BMS software
version 3.0. Brick is an ontology and can handle other relations as location and
equipment.
The purpose of the first release of semantic tagging in EcoStruxure BMS version
3.0 is to tag Standard applications. For more information, see section 56.31
“Tagging with Semantic Tags” on page 1696.

04-30005-01-en, May 2019 System

1695
56 EcoStruxure Building Operation Objects
56.31 Tagging with Semantic Tags

56.31 Tagging with Semantic Tags

Semantic tagging enables standard applications to tag their objects with type
tags, according to the Brick standard.
For more information, see section 56.30 “Semantic Tagging” on page 1695.

To tag with semantic tags

1. In WorkStation
WorkStation, in the System Tree pane, select the object that you want to
tag.
2. On the File menu, select Properties
Properties.
3. In the Properties dialog box, select Semantics tab.
4. Click Edit tags
tags.
5. In the Tag dialog box, select the tag for your object.
6. Click OK
OK.

System 04-30005-01-en, May 2019

1696
57 Archive

Topics
Archiving Overview
Archiving EcoStruxure BMS Server Compatibility
Enabling the Archiving Function and Defining the Archive
Folder
Archive Formats and Storage
Manual and Scheduled Archiving
Manually Creating an Archive
Creating a Scheduled Archive
Removing Extended Trend Logs from the Archive
Removing Events from the Archive
Archive Folders, Files, and Names
Archive Log Contents
Event and Alarm Enumerations
System Alarm ID Enumerations
System Event ID Enumerations
Trend Log Enumerations
 57 Archive
57.1 Archiving Overview

57.1 Archiving Overview

Archiving is the process of preserving historical data, which is comprised of
selected events and extended trend logs. For example, some facilities are
required to maintain archives to comply with government regulations. Another
example is in secure facilities where they must maintain records of who logged
in or who changed setpoints. Archiving is not a backup function because
archive data cannot be imported back into the system.
Archiving is a function of an Enterprise Server or an Enterprise Central.
Therefore, you cannot archive data on a standalone SmartX server. However,
you can archive trend logs and extended trend logs created on a SmartX server
that are monitored by extended trend logs created on an Enterprise Server or an
Enterprise Central.

Figure: Archiving overview

NOTICE
The Enterprise Server Windows service and Enterprise Central Windows
service run under the System account of the local computer or a custom
account where the Enterprise Server or Enterprise Central is installed. If you
plan to save the archive files to a network drive, make sure that the System
acccount or the custom account is given write access to this drive to ensure
that the archive process can validate the path and then save the files to that
location.

04-30005-01-en, May 2019 System

1699
57 Archive
57.1 Archiving Overview

57.1.1 Archive Log Files

The system archives historical data into two types of log files:
• Event logs: All the selected alarm, user activity, and system events are
archived into one file.

• Extended trend logs: The system archives data collected from selected
extended trend logs created on the Enterprise Server.

57.1.2 Archiving Formats and Storage

You generate an archive by selecting either a CSV or XML format. You can store
the archive in Enterprise Server, Enterprise Central, or define a different location.
For more information, see section 57.4 “Archive Formats and Storage” on page
1704.

57.1.3 Archive Folders, Files, and Names

The archving process creates uniquely named folders to identify the type of
archive (manual or scheduled) and the date on which the archive was
performed. Each folder includes the log files that were archived on that date.
For more information, see section 57.10 “Archive Folders, Files, and Names” on
page 1710.

57.1.4 Archiving Server Compatibility

You can configure archiving on an Enterprise Server or an Enterprise Central.
For more information, see section 57.2 “Archiving EcoStruxure BMS Server
Compatibility” on page 1702.

System 04-30005-01-en, May 2019

1700
 57 Archive
57.1 Archiving Overview

57.1.5 System Alarms for Archiving

There are several default system alarms for archiving.
For more information, see section 30.28 “System Alarm ID List” on page 681.

57.1.6 Manual and Scheduled Archiving

You can archive data as needed using manual methods or at predefined
intervals using a schedule.
For more information, see section 57.5 “Manual and Scheduled Archiving” on
page 1705.

04-30005-01-en, May 2019 System

1701
57 Archive
57.2 Archiving EcoStruxure BMS Server Compatibility

57.2 Archiving EcoStruxure BMS Server

Compatibility
You can configure archiving on an Enterprise Server or an Enterprise Central.
The following table lists the EcoStruxure BMS servers that support archiving
capabilities.

Table: Archiving and EcoStruxure BMS Server Compatibility Matrix

Server Runtime Description
Archiving?

Enterprise Yes You can configure and manage archiving on an

Server Enterprise Server.

Enterprise Yes You can configure and manage archiving on an

Central Enterprise Central.

SmartX server No You cannot configure or initiate archiving on a

SmartX server. The system only archives data from
trend logs or extended trend logs on SmartX
servers that are monitored by extended trend logs
on the Enterprise Server.

System 04-30005-01-en, May 2019

1702
 57 Archive
57.3 Enabling the Archiving Function and Defining the Archive Folder

57.3 Enabling the Archiving Function and

Defining the Archive Folder
Prior to generating an archive, you activate the archiving function and define a
path to a directory on the computer running Enterprise Server, Enterprise
Central, or another location where you want to store the archives.
For more information, see section 57.1 “Archiving Overview” on page 1699.

To enable the archiving function and define the archive folder

1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central you want to configure.
2. Click the Control Panel tab.
3. Click Archiving.
4. In the Archive Settings Manager dialog box, select Enabled
Enabled.
5. In the Path box, type the path to the directory where you plan to store the
archive files.
6. Click Validate to confirm that the path is valid on the system.

A check mark displays if the system successfully validates the path.

7. On the File menu, click Save
Save.
You designate a different archive directory by typing a new location in the Path
box and then validating the path again.

04-30005-01-en, May 2019 System

1703
57 Archive
57.4 Archive Formats and Storage

57.4 Archive Formats and Storage

You generate an archive by selecting either a CSV or XML format. You can store
the archive in Enterprise Server, Enterprise Central, or define a different location.

Table: Comparison of Archiving Formats

Method Description

CSV Comma Separated Values is a standard text file that stores spreadsheet
or database information in a simple table format. Each record is on a
separate line and each field within that record is separated by a delimiter,
such as a comma.

XML Extensible Markup Language is a markup language that defines a set of

rules for formatting documents. Primarily, XML is used to structure,
transport, and store data rather than to display data.

57.4.1 Archive Storage and Validation

You define a path to store the archives on your file system.
The preferred path is to the Archives folder in the Enterprise Server or Enterprise
Central:
• Enterprise Server: ..\ProgramData\Schneider Electric EcoStruxure\Building
Operation <version>\Enterprise Server\db
• Enterprise Central: ..\ProgramData\Schneider Electric EcoStruxure\Building
Operation <version>\Enterprise Central\db
You can use another location, such as a network drive or external memory
device. To ensure that the new location is valid, you can prompt the system to
validate the path. For more information, see section 57.3 “Enabling the Archiving
Function and Defining the Archive Folder” on page 1703.

System 04-30005-01-en, May 2019

1704
 57 Archive
57.5 Manual and Scheduled Archiving

57.5 Manual and Scheduled Archiving

You can archive data as needed using manual methods or at predefined
intervals using a schedule.

Table: Comparison of Archiving Methods

Method Benefits

Manual Performed on an as-needed basis, for example, prior to upgrading an

Enterprise Server or Enterprise Central. When a Manual Archive is
created, the temporary archive data is not deleted.

Scheduled Automatically generated by the system at regularly scheduled

intervals. When a Scheduled Archive completes, the temporary
archive data is deleted.

Scheduled archiving is an automated way of preserving historical data. For

convenience, the system provides a default digital schedule, which is bound to
the Archive Manager. You can modify, but not delete, this Archive schedule. For
more information, see section 57.1 “Archiving Overview” on page 1699.

04-30005-01-en, May 2019 System

1705
57 Archive
57.6 Manually Creating an Archive

57.6 Manually Creating an Archive

You create an archive manually to preserve the historical data on an Enterprise
Server or an Enterprise Central on an as-needed basis, such as before a system
upgrade.
For more information, see section 57.5 “Manual and Scheduled Archiving” on
page 1705.

To manually create an archive

1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central you want to configure.
2. Click the Control Panel tab.
3. Click Archiving.
4. In the Archive Settings Manager dialog box, click Enabled
Enabled.
5. Select the events that you want to include in the archive:
• Alarm Events
Events: Select to include high priority or off-normal events
(providing the alarms are pre-configured and active on the system).
• User Events
Events: Select to include user-initiated events, such as value
overrides or configuration changes.
• System Events
Events: Select to include device-initiated events, such as time
stamps.

6. Click the Add extended trend logs button .

7. In the Add Extended Trend Logs dialog box, in the Include column, select
the extended trend logs you want to include in the archive.
8. Click OK
OK.
9. In the Archive Settings Manager dialog box, in the Output Type box, select
the format you want to use for the archive.
10. In the Path box, type the path to an existing folder or server where you
want to store the archive files.
11. Click Validate to confirm that the path is valid on the system.
12. On the File menu, click Save
Save.
13. Click Archive Now
Now.
The archive is saved to the specified path.

System 04-30005-01-en, May 2019

1706
 57 Archive
57.7 Creating a Scheduled Archive

57.7 Creating a Scheduled Archive

You configure the Archive settings and schedule on the Enterprise Server or
Enterprise Central to automate the archiving process.
For more information, see section 57.5 “Manual and Scheduled Archiving” on
page 1705.

To create a scheduled archive

1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central you want to configure.
2. Click the Control Panel tab.
3. Click Archiving.
4. Under Archive Settings
Settings, click Enabled
Enabled.
5. Select the events that you want to include in the archive:
• Alarm Events
Events: Select to include high priority or off-normal events
(providing the alarms are pre-configured and active on the system).
• User Events
Events: Select to include user-initiated events, such as value
overrides or configuration changes.
• System Events
Events: Select to include device-initiated events, such as time
stamps.

6. Click the Add extended trend logs button to add extended trend logs
to the archive.
7. In the Add Extended Trend Logs dialog box, in the Include column, select
the extended trend logs and click OK
OK.
8. Under Archive Schedule
Schedule, click Schedule to create recurring exception and
calendar events.
9. In the Output Type box, select the format you want to use for the archive:
• CSV
CSV: This output generates data separated by a delimiter.
• XML
XML: This output generates data using a standard internet protocol.
10. In the Path box, type the path to an existing archive directory where you
want to store the archive files.
11. Click Validate to confirm that the path is valid on the system.

A check mark displays if the system successfully validates the path.

12. On the File menu, click Save
Save.

04-30005-01-en, May 2019 System

1707
57 Archive
57.8 Removing Extended Trend Logs from the Archive

57.8 Removing Extended Trend Logs from

the Archive
You remove extended trend logs that you do not want to include in the archive.
For more information, see section 57.1 “Archiving Overview” on page 1699.

To remove extended trend logs from the archive

1. In WorkStation, in the System Tree pane, select the Enterprise Server you
want to configure.
2. Click the Control Panel tab.
3. Click Archiving
Archiving.
4. Select the extended trend logs that you want to remove from the archive

and click the Remove selected extended trend logs button .

5. On the File menu, click Save
Save.

System 04-30005-01-en, May 2019

1708
 57 Archive
57.9 Removing Events from the Archive

57.9 Removing Events from the Archive

You remove events that you do not want to include in the archive, such as User
Events.
For more information, see section 57.1 “Archiving Overview” on page 1699.

To remove events from the archive

1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central you want to configure.
2. Click the Control Panel tab.
3. Click Archiving.
4. Clear the events that you want to remove from the archive.

5. Click the Save button .

04-30005-01-en, May 2019 System

1709
57 Archive
57.10 Archive Folders, Files, and Names

57.10 Archive Folders, Files, and Names

As part of the archive process, the system creates uniquely named archive files
and folders that identify the type of archive (manual or scheduled) and the date
on which the archive was performed.

Figure: Archives folder on Enterprise Server

By default, these folders are located in the Archives directory where the
Enterprise Server or Enterprise Central are installed. However, you can change
the directory to another valid location.

57.10.1 Archive Folder Names

During the archive process, the system creates a new folder in the path
specified in the Archive Settings Manager. The system generates and then
places the CSV or XML files within this folder. To prevent accidental overwriting,
the system uses the Method_date.file extension format, which makes the folder
name unique. For example, if you manually generate an archive on April 11,
2012, the system creates a folder named Manual_Archive20120411
(yyyymmdd). If you generate an archive the following day, the system creates a
new folder with the new date.

57.10.2 Archive System Resource Files

When archiving is enabled, the system creates resource files that collect the
data from the selected extended trend logs prior to archiving. The system
names the files using random hexadecimal characters, such as a2d9e877, and
then places them in the path specified in the Archive Settings Manager. These
files should not be deleted.

System 04-30005-01-en, May 2019

1710
 57 Archive
57.10 Archive Folders, Files, and Names

57.10.3 File Names for Extended Trend Log Archives

The system names extended trend log archive files using the
Method_(Address)_date.file extension format. If you generate a manual archive
in CSV format for extended trend logs on on July 8, 2012, the system names the
file, Manual_Archive_(Server_1_<Extended_Trend_Log name>)_2012-07-
01_2012-07-08.csv.

57.10.4 File Names for Events Log Archives

The system names the event log archives using the
Method_(EventLog)_date.file extension format. If you manually generate an
archive on April 11, 2012 for the Alarm, User, and System events, the system
names the archive file
Manual_Archive_(Server_1_System_Events_EventLog_EventRecords)_2012-04-
02_2012-04-11.csv.

57.10.5 Unique Archive File Names

If you generate more than one archive file on the same date, the system
appends a number to the end of each similarly named archive to ensure that the
files are not overwritten. For example, if you manually generate an archive
named Manual_(Server_1_System_Events_EventLog_EventRecords)_2012-04-
02_2012-04-11.csv and immediately generate another identical archive, the
system names the second archive,
Manual_(Server_1_System_Events_EventLog_EventRecords)_2012-04-
02_2012-04-11_1.csv. Using the appended number (_1), the system creates a
unique name for the second archive with the same method on the same date.

57.10.6 Archive Log Contents

You use a structured database editor to view archive information in rows and
columns, which may contain text strings, paths, identities, or enumeration
values.
For more information, see section 57.11 “ Archive Log Contents” on page 1712.

04-30005-01-en, May 2019 System

1711
57 Archive
57.11 Archive Log Contents

57.11 Archive Log Contents

You use a structured database editor to view archive information in rows and
columns, which may contain text strings, paths, identities, or enumeration
values.

Figure: Archive data displayed in a spreadsheet editor

NOTICE
The time stamps for each record in the archive file reflect the UTC rather than
local machine time.

57.11.1 Columns and Descriptions

The following table provides an overview of an archive file. The number and type
of columns that display varies with the log that is viewed. For example, trend
logs have a different set of column headers than event logs due to the data
content.

Table: Archive Files – Column and Descriptions

Column Description

AcknowledgeTime Displays the time and date when the alarm was
acknowledged.

AlarmState Displays the present alarm state.

AlarmText Displays the alarm message that was added to the

alarm.

AssignedState Displays the assigned state the alarm had.

AssignedToDomain Displays the domain to which the user or group was

assigned.

AssignedToName Displays the name of the user or group to which an

alarm was assigned.

AssignedToUniqueUserId Displays the unique ID of the user or group to which an

alarm was assigned.

System 04-30005-01-en, May 2019

1712
 57 Archive
57.11 Archive Log Contents

Continued
Column Description

BACnetEventType Displays the BACnet event that occurred within a

BACnet network.

BasicEvaluationState Displays the basic evaluation state of an alarm.

Category Displays the name of a category.

Command Displays the executed command.

Comment Displays the comment that was added to an alarm.

ControlDescr Displays the descriptive information about the I/NET

operator.

ControlSource Displays the initials of the controlling I/NET operator.

Count Displays the number of times the alarm has toggled

between the alarm and reset state.

CWSId Displays the ID of the EcoStruxure Web Service (EWS)

object.

CWSSourceId Displays the ID of the EWS source object.

CWSSourceName Displays the name and path of the EWS source object.

Description Displays a brief summary of the major features or

characteristics.

DeviceName Displays the name of an I/NET device that generated the

event.

DisabledCause Displays the reason why the alarm was disabled, such
as a shunt variable.

DomainName Displays the domain to which a user belongs.

EndTime Displays the time when the old meter was replaced.

EndValue Displays the value the old meter had when it was
replaced.

EvaluationState Displays the present evaluation state of the alarm, such

as Upper limit alarm.

Event Displays an event that occurred within the network.

EventGUID Displays the unique identity of the event.

FirstName Displays the first name of the individual whose key/card

was used at the I/NET door point.

ForcedValue Displays the forced value events.

GroupName Displays the name of the cause note or action note

group the user edited.

04-30005-01-en, May 2019 System

1713
57 Archive
57.11 Archive Log Contents

Continued
Column Description

Hidden Displays the visible status of an object, such as False.

InetAddr Displays the system address of the point, or station

address of the host or controller that generated the
event.

IndivNdx Displays the number of the individual whose key/card

was used at the I/NET door point.

InetEventTypeId Displays the IDs of the I/NET event types generated by

the system.

ItemName Displays the name of the check list, cause note, or

action note group the user edited.

LastName Displays the last name of the individual whose key/card

was used at the I/NET door point.

LinkName Displays the name assigned to the link of the device

from which the event originated.

LogType Displays the type of the trend log that has been edited.

MaxValue Displays the last value of the new meter before roll-over.

MessageText Displays the text of an I/NET action or dispatch

message. (Optional)

MeterConstant Displays the constant of the meter in a meter trend log.

MinValue Displays the first value of the new meter after roll-over.

MonitoredValue Displays the path of the monitored variable.

MonitoredValueType Displays the type of monitored value that triggers an

alarm, such as Forced.

MonitoredVariable Displays the path of the monitored variable.

Note Displays the text entered into the Note 1 property.

OriginalSeqNo Displays the RefSeqNo collected from a trend log. This

number is only written on an extended trend log
containing records that were changed on the connected
trend log.

OriginatedGUID Displays the unique identity of the source.

PreviousAlarmState Displays the previous alarm state.

Priority Displays the current priority of the alarm.

RefSeqNo Displays the unique sequence number of a record that

has been edited.

SEQNO Displays the sequence number of the record.

System 04-30005-01-en, May 2019

1714
 57 Archive
57.11 Archive Log Contents

Continued
Column Description

ServerOffline Displays the online/offline status of an EcoStruxure BMS

server.

Source Displays the name and path of the source object.

SourceServer Displays the name and path of the source object.

StationName Displays the name assigned to the controller from which

the event originated.

StartTime Displays the time when the new meter was installed.

StartValue Displays the value of the new meter when it was

installed.

Status Displays the status of the trend log.

SystemAlarmId Displays the alarm ID generated by the system.

SystemEventId Displays the event ID generated by the system.

TenantNdx Displays the tenant number of the individual whose

key/card was used at the I/NET door point.

TextField Displays the information entered into the Text property.

TimeStamp Displays the date and time when the record was
generated.

TriggeredTimestamp Displays the time and date an alarm went from normal
state to alarm state.

TYPE Displays the object type that defines the properties of

the object.

UniqueAlarmId Displays the unique alarm ID of an alarm.

UniqueUserId Displays the unique identity number of a user.

Unit Displays the selected unit of a value, such as °F

(Fahrenheit).

User Displays the user who generated the event.

UserName Displays the name of the user who generated the event.

Value Displays the value of a record.

ValueAfter Displays the value of an object after it was changed.

ValueBefore Displays the value of an object before it was changed.

Zone Displays the I/NET security zone number associated

with a security event.

04-30005-01-en, May 2019 System

1715
57 Archive
57.11 Archive Log Contents

57.11.2 Event and Alarm Enumerations

An enumeration is a range of values representing a specific command or event.
For more information, see section 57.12 “Event and Alarm Enumerations” on
page 1717.

57.11.3 Trend Log Enumerations

An enumeration is a range of values representing a specific command or event.
Trend log properties use two enumeration values: Events and Status.
For more information, see section 57.15 “Trend Log Enumerations” on page
1737.

System 04-30005-01-en, May 2019

1716
 57 Archive
57.12 Event and Alarm Enumerations

57.12 Event and Alarm Enumerations

An enumeration is a range of values representing a specific command or event.
The following tables list the enumeration values for the supported alarm and
event properties.

57.12.1 Alarm State

The table lists the enumeration values for Alarm State.

Table: Alarm State

Enumeration value Enumeration definition

0 Normal

1 Alarm

2 Acknowledged

3 Reset

4 Disabled

5 Fault

57.12.2 Assigned State

The table lists the enumeration values for Alarm State.

Table: Assigned State

Enumeration value Enumeration definition

0 Unassigned

1 Assigned

2 Accepted

57.12.3 BACnet Alarm Type

The table lists the enumeration values for BACnet Alarm Type.

Table: BACnet Alarm Type

Enumeration Value Enumeration definition

0 Change of bitstring

1 Change of state

04-30005-01-en, May 2019 System

1717
57 Archive
57.12 Event and Alarm Enumerations

Continued
Enumeration Value Enumeration definition

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

57.12.4 Basic Evaluation State

The table lists the enumeration values for Basic Evaluation State.

Table: Basic Evaluation State

Enumeration value Enumeration definition

0 False

1 True

57.12.5 Disabled Cause

The table lists the enumeration values for Disabled Cause.

Table: Disabled Cause

Enumeration value Enumeration definition

1 Shunt variable

2 User

4 System

57.12.6 Evaluation State

The table lists the enumeration values for Evaluation State.

System 04-30005-01-en, May 2019

1718
 57 Archive
57.12 Event and Alarm Enumerations

Table: Evaluation State

Enumeration value Enumeration definition

0 Normal

1 Off-normal alarm

2 Upper limit alarm

3 Lower limit alarm

4 Life safety alarm

5 Faulty alarm

57.12.7 Hidden
The table lists the enumeration values for Hidden.

Table: Hidden
Enumeration value Enumeration definition

0 False

1 True

57.12.8 Previous Alarm State

The table lists the enumeration values for Previous Alarm State.

Table: Previous Alarm State

Enumeration value Enumeration definition

0 Normal

1 Alarm

2 Acknowledged

3 Reset

4 Disabled

5 Fault

57.12.9 System Alarm ID

The table lists the enumeration values for System Alarm ID. For more
information, see section 57.13 “System Alarm ID Enumerations” on page 1721.

04-30005-01-en, May 2019 System

1719
57 Archive
57.12 Event and Alarm Enumerations

57.12.10 System Event ID

The table lists the enumeration values for System Event ID. For more information,
see section 57.14 “System Event ID Enumerations” on page 1730.

System 04-30005-01-en, May 2019

1720
 57 Archive
57.13 System Alarm ID Enumerations

57.13 System Alarm ID Enumerations

An enumeration is a range of values representing a specific command or event.
The table lists the enumeration values for System Alarm ID. For more
information, see section 57.12 “Event and Alarm Enumerations” on page 1717.

Table: System Alarm ID

Enumeration value Enumeration definition

0 EcoStruxure BMS server restarted

1 IO module offline

2 EcoStruxure BMS server offline

4 E-mail service failed to connect to SMTP server

5 E-mail service failed to login to SMTP server

6 System cold start

7 System warm start

8 System factory reset

9 Device offline

a Signal alarm

b Cannot verify lead object status

c Duplicate of local network

d Duplicate network identifier

e Duplicate device identifier

f Invalid device identifier

10 Duplicate device address

11 Duplicate device name

12 Defective protocol implementation

13 BACnet did not start

14 Failed to create object

15 Failed to initialize references

16 Database update failed

17 A log sample was missed

18 A log data transfer was missed

04-30005-01-en, May 2019 System

1721
57 Archive
57.13 System Alarm ID Enumerations

Continued
Enumeration value Enumeration definition

19 File I/O error

1a EcoStruxure BMS server configuration error

1b Network offline

1c IP connection offline

1d Signal event

1e New application program

1f Parser failed

20 Unit is locked

21 Unit is unlocked

22 Logging started

23 Logging stopped

24 Log stopped because it is full

25 Log full

26 Not enough RAM memory for log

27 Too many log definitions

28 Error in log definition

29 Not enough flash memory for log

2a Log variable error

2b No valid Blueprint File

2c Unhandled buffer ready notification

2d Alarm signal trigger buffer full

2e Bad lead object reference

2f Bad lead object type

30 Shadow update failed

31 Unable to access lead object

32 Incorrect lead object back-reference

33 Unable to access shadow object

34 Server not restarted Backup in process

System 04-30005-01-en, May 2019

1722
 57 Archive
57.13 System Alarm ID Enumerations

Continued
Enumeration value Enumeration definition

25 Server not restarted Restore in process

36 Server not restarted Other

37 Failure retrieving backup set from remote server

38 Failure restoring server database

39 Failure backing up server database

3a E-mail service fail to send message

3b E-mail service configuration error

3c Port offline

3d Wrong alarm unit

3e BACnet server failure

3f Sigma system schedule executed

40 Subnet offline

41 Invalid device address

64 Invalid archive path

65 Archive path must be set to enable archiving

66 Archive directory does not exist! Retrying in 5 minutes!

67 Archive directory does not exist!

68 Can not enable archiving

69 Invalid archiving format

6a Archiving is not enabled

6b IO error when generating archive

6c IO error when writing to archive temporary

6d IO error, cannot write to archive directory!

6e IO error, cannot write to archive directory! Retrying in 5 minutes!

6f IO error, not enough space left in the archive directory!

70 IO error, not enough space left in the archive directory! Retrying in

5 minutes!

73 Archiving failed because of an ongoing operation

74 Archiving canceled due to configuration change

04-30005-01-en, May 2019 System

1723
57 Archive
57.13 System Alarm ID Enumerations

Continued
Enumeration value Enumeration definition

100 Communication failed

101 Communication failed Configuration error

102 Communication failed Unexpected Server fullpath

103 Communication failed Unexpected Server type

104 Communication failed Authentication error

105 Communication failed Authorization error

106 Communication failed Domain is not available

107 Communication failed Hostname is invalid

108 Communication failed Version Mismatch

200 Task 1 CPU limit reached, disabling real time priority

201 Task 2 CPU limit reached, disabling real time priority

211 Email service no sender email address

212 Email service no recipient email address

213 Email service no sender and recipient email address

214 Task period extended

215 No file name set

216 Module type mismatch

217 Serial port in use

1f40 NETWORK 8000 message

1f41 NW8 Unrecognized command

1f42 NW8 Command failure

1f43 NW8 Leaves network event

1f44 NW8 Joins network event

1f45 NW8 ASD message

1f46 NW8 Leaves/joins network

1f4a NW8 Database initialized

1f4b NW8 ROM failure

1f4c NW8 RAM failure

System 04-30005-01-en, May 2019

1724
 57 Archive
57.13 System Alarm ID Enumerations

Continued
Enumeration value Enumeration definition

1f4d NW8 Freeze error

1f4e NW8 Database modified

1f4f NW8 Device warm reset

1f50 NW8 Device cold reset

1f51 NW8 AS1 diagnostic

1f52 NW8 AT1 diagnostic

1f53 NW8 AT2 diagnostic

1f54 NW8 UI diagnostic

1f55 NW8 UI1 diagnostic

1f56 NW8 UI2 diagnostic

1f57 NW8 UI3 diagnostic

1f58 NW8 UI4 diagnostic

1f59 NW8 UI5 diagnostic

1f5a NW8 UI6 diagnostic

1f5b NW8 UI7 diagnostic

1f5c NW8 UI8 diagnostic

1f5e NW8 Relay failure

1f5f NW8 Relay failure 01

1f60 NW8 Relay failure 02

1f61 NW8 Relay failure 03

1f62 NW8 Relay failure 04

1f63 NW8 Relay failure 05

1f64 NW8 Relay failure 06

1f65 NW8 Relay failure 07

1f66 NW8 Relay failure 08

1f67 NW8 Relay failure 09

1f68 NW8 Relay failure 10

1f69 NW8 Relay failure 11

04-30005-01-en, May 2019 System

1725
57 Archive
57.13 System Alarm ID Enumerations

Continued
Enumeration value Enumeration definition

1f6a NW8 Relay failure 12

1f6b NW8 Relay failure 13

1f6c NW8 Relay failure 14

1f6d NW8 Relay failure 15

1f6e NW8 Relay failure 16

1f6f NW8 Relay failure 17

1f70 NW8 Relay failure 18

1f71 NW8 Relay failure 19

1f72 NW8 Relay failure 20

1f73 NW8 Relay failure 21

1f74 NW8 Relay failure 22

1f75 NW8 Relay failure 23

1f76 NW8 Relay failure 24

1f77 NW8 Relay failure 25

1f78 NW8 Relay failure 26

1f79 NW8 Relay failure 27

1f7a NW8 Relay failure 28

1f7b NW8 Relay failure 29

1f7c NW8 Relay failure 30

1f7d NW8 Relay failure 31

1f7e NW8 Relay failure 32

1f7f NW8 Relay failure 33

1f80 NW8 Relay failure 34

1f81 NW8 Relay failure 35

1f82 NW8 Relay failure 36

1f83 NW8 Relay failure 37

1f84 NW8 Relay failure 38

1f85 NW8 Relay failure 39

System 04-30005-01-en, May 2019

1726
 57 Archive
57.13 System Alarm ID Enumerations

Continued
Enumeration value Enumeration definition

1f86 NW8 Relay failure 40

1f87 NW8 Relay failure 41

1f88 NW8 Relay failure 42

1f89 NW8 Relay failure 43

1f8a NW8 Relay failure 44

1f8b NW8 Relay failure 45

1f8c NW8 Relay failure 46

1f8d NW8 Relay failure 47

1f8e NW8 Relay failure 48

1f90 NW8 Setpoint out of range

1f91 NW8 Duct temperature out of range

1f92 NW8 Zone temperature out of range

1f93 NW8 Device reset

1f94 NW8 Configuration error

1f95 NW8 Damper range error

1f96 NW8 Pressure error

1f97 NW8 EEprom memory error

1f98 NW8 Application modified

1f99 NW8 Missing changeover input

1f9a NW8 EEprom checksum error

1f9b NW8 Sensor input failure

1f9c NW8 System fault 32

1f9d NW8 No U-Link communication

1f9e NW8 Application error 1

1f9f NW8 Application error 2

1fa0 NW8 Application error 4

1fa1 NW8 Application error 16

1fa4 NW8 Press sensor

04-30005-01-en, May 2019 System

1727
57 Archive
57.13 System Alarm ID Enumerations

Continued
Enumeration value Enumeration definition

1fa5 NW8 Duct temperature

1fa6 NW8 Minimum flow potentiometer

1fa7 NW8 Maximum flow potentiometer

1fa8 NW8 Hot water potentiometer

1fa9 NW8 Induction auxilary potentiometer

1faa NW8 Space setpoint

1fab NW8 Space temperature

1faf NW8 Sensor failure GCS 01

1fc3 NW8 Sensor failure GCS 02

1fd7 NW8 Sensor failure GCS 03

1feb NW8 Sensor failure GCS 04

1fff NW8 Sensor failure GCS 05

2013 NW8 Sensor failure GCS 06

2027 NW8 Sensor failure GCS 07

203b NW8 Sensor failure GCS 08

204f NW8 Sensor failure GCS 09

2063 NW8 Sensor failure GCS 10

2077 NW8 Sensor failure GCS 21

208b NW8 Sensor failure GCS 22

209f NW8 Sensor failure GCS 23

20b3 NW8 Sensor failure GCS 24

20c7 NW8 Sensor failure GCS 25

20db NW8 Sensor failure GCS 26

20ef NW8 Sensor failure GCS 27

2103 NW8 Sensor failure GCS 28

2117 NW8 Sensor failure GCS 29

212b NW8 Sensor failure GCS 30

213f NW8 Sensor failure GCS 31

System 04-30005-01-en, May 2019

1728
 57 Archive
57.13 System Alarm ID Enumerations

Continued
Enumeration value Enumeration definition

2150 NW8 Sensor failure end

2151 NW8 Leaves LCM network event

2152 NW8 Joins LCM network event

2153 NW8 Leaves/joins LCM network

2197 NETWORK 8000 message end

2198 CWS Method Error

2199 CWS Value Poll failed

219a CWS Alarm Poll failed

219b CWS Browse failed

219c CWS GetObject failed

219d CWS GetHistory failed

219e See gap after 0x200

04-30005-01-en, May 2019 System

1729
57 Archive
57.14 System Event ID Enumerations

57.14 System Event ID Enumerations

An enumeration is a range of values representing a specific command or event.
The table lists the enumeration values for System Event ID. For more information,
see section 57.12 “Event and Alarm Enumerations” on page 1717.

Table: System Event ID

Enumeration value Enumeration definition

0 EcoStruxure BMS server initialized

1 EcoStruxure BMS server shutdown

2 User logged on

3 User logged off

4 Log on failed - account disabled

5 Log on failed - authentication

6 Log on failed - domain not found

7 Log on failed - domain controller unavailable

8 Log on failed - domain controller unavailable

9 Log on failed - no permissions

a Password changed

b Property changed

c Command executed

d IO module offline

e IO module online

f Object created

10 Object deleted

11 Objects imported

12 Objects deployed

13 Object moved

14 Object renamed

15 File notification sent

16 Email sent successfully

17 Object changed

System 04-30005-01-en, May 2019

1730
 57 Archive
57.14 System Event ID Enumerations

Continued
Enumeration value Enumeration definition

18 Log on failed - user not associated with a group

19 EcoStruxure BMS server database backed up

1a EcoStruxure BMS server database restored

1b Signal event

1c Forced value

1d New forced value

1e Unforce value

1f Log on failed - version mismatch

1f40 NETWORK 8000 message

1f41 NW8 Unrecognized command

1f42 NW8 Command failure

1f43 NW8 Leaves network event

1f44 NW8 Joins network event

1f45 NW8 ASD message

1f46 NW8 Leaves/joins network

1f4a NW8 Database initialized

1f4b NW8 ROM failure

1f4c NW8 RAM failure

1f4d NW8 Freeze error

1f4e NW8 Database modified

1f4f NW8 Device warm reset

1f50 NW8 Device cold reset

1f51 NW8 AS1 diagnostic

1f52 NW8 AT1 diagnostic

1f53 NW8 AT2 diagnostic

1f54 NW8 UI diagnostic

1f55 NW8 UI1 diagnostic

1f56 NW8 UI2 diagnostic

04-30005-01-en, May 2019 System

1731
57 Archive
57.14 System Event ID Enumerations

Continued
Enumeration value Enumeration definition

1f57 NW8 UI3 diagnostic

1f58 NW8 UI4 diagnostic

1f59 NW8 UI5 diagnostic

1f5a NW8 UI6 diagnostic

1f5b NW8 UI7 diagnostic

1f5c NW8 UI8 diagnostic

1f5e NW8 Relay failure

1f5f NW8 Relay failure 01

1f60 NW8 Relay failure 02

1f61 NW8 Relay failure 03

1f62 NW8 Relay failure 04

1f63 NW8 Relay failure 05

1f64 NW8 Relay failure 06

1f65 NW8 Relay failure 07

1f66 NW8 Relay failure 08

1f67 NW8 Relay failure 09

1f68 NW8 Relay failure 10

1f69 NW8 Relay failure 11

1f6a NW8 Relay failure 12

1f6b NW8 Relay failure 13

1f6c NW8 Relay failure 14

1f6d NW8 Relay failure 15

1f6e NW8 Relay failure 16

1f6f NW8 Relay failure 17

1f70 NW8 Relay failure 18

1f71 NW8 Relay failure 19

1f72 NW8 Relay failure 20

1f73 NW8 Relay failure 21

System 04-30005-01-en, May 2019

1732
 57 Archive
57.14 System Event ID Enumerations

Continued
Enumeration value Enumeration definition

1f74 NW8 Relay failure 22

1f75 NW8 Relay failure 23

1f76 NW8 Relay failure 24

1f77 NW8 Relay failure 25

1f78 NW8 Relay failure 26

1f79 NW8 Relay failure 27

1f7a NW8 Relay failure 28

1f7b NW8 Relay failure 29

1f7c NW8 Relay failure 30

1f7d NW8 Relay failure 31

1f7e NW8 Relay failure 32

1f7f NW8 Relay failure 33

1f80 NW8 Relay failure 34

1f81 NW8 Relay failure 35

1f82 NW8 Relay failure 36

1f83 NW8 Relay failure 37

1f84 NW8 Relay failure 38

1f85 NW8 Relay failure 39

1f86 NW8 Relay failure 40

1f87 NW8 Relay failure 41

1f88 NW8 Relay failure 42

1f89 NW8 Relay failure 43

1f8a NW8 Relay failure 44

1f8b NW8 Relay failure 45

1f8c NW8 Relay failure 46

1f8d NW8 Relay failure 47

1f8e NW8 Relay failure 48

1f90 NW8 Setpoint out of range

04-30005-01-en, May 2019 System

1733
57 Archive
57.14 System Event ID Enumerations

Continued
Enumeration value Enumeration definition

1f91 NW8 Duct temperature out of range

1f92 NW8 Zone temperature out of range

1f93 NW8 Device reset

1f94 NW8 Configuration error

1f95 NW8 Damper range error

1f96 NW8 Pressure error

1f97 NW8 EEprom memory error

1f98 NW8 Application modified

1f99 NW8 Missing changeover input

1f9a NW8 EEprom checksum error

1f9b NW8 Sensor input failure

1f9c NW8 System fault 32

1f9d NW8 No U-Link communication

1f9e NW8 Application error 1

1f9f NW8 Application error 2

1fa0 NW8 Application error 4

1fa1 NW8 Application error 16

1fa4 NW8 Press sensor

1fa5 NW8 Duct temperature

1fa6 NW8 Minimum flow potentiometer

1fa7 NW8 Maximum flow potentiometer

1fa8 NW8 Hot water potentiometer

1fa9 NW8 Induction auxilary potentiometer

1fab NW8 Space temperature

1faf NW8 Sensor failure GCS 01

1fc3 NW8 Sensor failure GCS 02

1fd7 NW8 Sensor failure GCS 03

1feb NW8 Sensor failure GCS 04

System 04-30005-01-en, May 2019

1734
 57 Archive
57.14 System Event ID Enumerations

Continued
Enumeration value Enumeration definition

1fff NW8 Sensor failure GCS 05

2013 NW8 Sensor failure GCS 06

2027 NW8 Sensor failure GCS 07

203b NW8 Sensor failure GCS 08

204f NW8 Sensor failure GCS 09

2063 NW8 Sensor failure GCS 10

2077 NW8 Sensor failure GCS 21

208b NW8 Sensor failure GCS 22

209f NW8 Sensor failure GCS 23

20b3 NW8 Sensor failure GCS 24

20c7 NW8 Sensor failure GCS 25

20db NW8 Sensor failure GCS 26

20ef NW8 Sensor failure GCS 27

2103 NW8 Sensor failure GCS 28

2117 NW8 Sensor failure GCS 29

212b NW8 Sensor failure GCS 30

213f NW8 Sensor failure GCS 31

2150 NW8 Sensor failure end

2151 NW8 Leaves LCM network event

2152 NW8 Joins LCM network event

2153 NW8 Leaves/joins LCM network

2197 NETWORK 8000 message end

2198 Trying to send email

219a Failed to send email

219b Deploy started

219c Deploy succeeded

219d Deploy failed

219e Learn started

04-30005-01-en, May 2019 System

1735
57 Archive
57.14 System Event ID Enumerations

Continued
Enumeration value Enumeration definition

219f Learn succeeded

21a0 Learn failed

21a1 EcoStruxure BMS server deployed

21a2 Deploy command queued

21a3 Learn command queued

21a4 Rebuild change-tracking data command queued

21a5 Rebuild change-tracking data started

2329 Modbus Incompatible to the group

232a Modbus User poll interval selected

232b Modbus Calculated poll interval selected

232c Modbus Group factorized

232d Modbus Group re-factorized

232e Modbus Illegal function code

232f Modbus Illegal data address

2330 Modbus Illegal data value

System 04-30005-01-en, May 2019

1736
 57 Archive
57.15 Trend Log Enumerations

57.15 Trend Log Enumerations

An enumeration is a range of values representing 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

13 Log database restored

14 Log reset by extended log

Table: Status
Enumeration value Enumeration definition

0 None

1 Offline

2 Forced

4 Invalid

8 Override

16 In alarm

32 Fault

04-30005-01-en, May 2019 System

1737
57 Archive
57.15 Trend Log Enumerations

Continued
Enumeration value Enumeration definition

64 Out of service

System 04-30005-01-en, May 2019

1738
58 Archive User Interface

Topics
Archive Settings Manager Dialog Box
Add Extended Trend Logs Dialog Box
Archiving Settings Properties – Basic Tab
Archiving Settings Properties – Content Tab
Archive Icons in the System Tree
Event Archive File
Trend Log Archive File
 58 Archive User Interface
58.1 Archive Settings Manager Dialog Box

58.1 Archive Settings Manager Dialog Box

Use the Archive Settings Manager to archive events, trend logs, and extended
trend logs on the Enterprise Server or Enterprise Central.

Figure: Archive Settings Manager dialog box

Table: Archive Settings Manager Dialog Box

Number Description

Enabled Select to activate the archiving function on the Enterprise Server or

Enterprise Central. For more information, see section 57.3 “Enabling the
Archiving Function and Defining the Archive Folder” on page 1703.

Disabled Select to disable the archiving function on the Enterprise Server or Enterprise
Central.

Archive Click to archive the selected historical data immediately. For more
Now information, see section 57.6 “Manually Creating an Archive” on page 1706.

Alarm Select to include Alarm events in the archive.

Events

User Select to include User events in the archive.

Events

System Select to include System events in the archive.

Events

04-30005-01-en, May 2019 System

1741
58 Archive User Interface
58.1 Archive Settings Manager Dialog Box

Continued
Number Description

Click to add an extended trend log to the list.

Click to delete an extended trend log from the list.

Extende Select the logs that you want to include in the archive.
d Trend
Log

Archive Click Schedule to configure a schedule for archiving. For more information,
Schedul see section 57.5 “Manual and Scheduled Archiving” on page 1705.
e

Output Select an output type for the archive. For more information, see section 57.4
Type “Archive Formats and Storage” on page 1704.

Path Type the path to the location where you want store the archive files. For more
information, see section 57.3 “Enabling the Archiving Function and Defining
the Archive Folder” on page 1703.

Validate
Click to validate that the path is valid. A green checkmark displays if the
system successfully validates the path.

System 04-30005-01-en, May 2019

1742
 58 Archive User Interface
58.2 Add Extended Trend Logs Dialog Box

58.2 Add Extended Trend Logs Dialog Box

Use the Add Extended Trend Logs dialog box to include logs in an archive. The
system only lists the logs on the Enterprise Server or Enterprise Central that are
not included the archive.

Figure: Add Extended Trend Logs dialog box

Table: Add Extended Trend Logs Dialog Box

Component Description

Click to include all the listed extended trend logs in the archive
operation.

Click to exclude all the extended trend logs selected for the archive
operation.

Include Select the extended trend logs that you want to include in the archive.

Extended Displays the name and the location of the extended trend log on the
Trend Log Enterprise Server or Enterprise Central.

04-30005-01-en, May 2019 System

1743
58 Archive User Interface
58.3 Archiving Settings Properties – Basic Tab

58.3 Archiving Settings Properties – Basic

Tab
Use the Basic tab to enable the archiving function, set delay, and select the
format of the archive file.

Figure: Archive Settings Basic properties tab

Table: Archive Settings Basic Tab

Component Description

Enabled Select True to activate the archiving

function.

Path Type the path to the location where you

want to create your archive.

IsValidPath Select True to indicate the objects have

passed the validation.

Output format Select the output format of the archive. For

more information, see section 57.4
“Archive Formats and Storage” on page
1704.

System 04-30005-01-en, May 2019

1744
 58 Archive User Interface
58.4 Archiving Settings Properties – Content Tab

58.4 Archiving Settings Properties – Content

Tab
Use the Content tab to add events and trend logs to the archive.

Figure: Archive Settings Content tab

Table: Archive Settings Basic Properties Tab

Component Description

Alarm Select True to include Alarm events in the

archive.

User Select True to include User events in the

archive.

System Select True to include System events in the

archive.

Logs Displays the logs you have selected to be

archived.

Click to add a new trend log to the archive.

04-30005-01-en, May 2019 System

1745
58 Archive User Interface
58.4 Archiving Settings Properties – Content Tab

Continued
Component Description

Click to change the trend log to be

archived.

Click to remove a trend log from the

archive.

System 04-30005-01-en, May 2019

1746
 58 Archive User Interface
58.5 Archive Icons in the System Tree

58.5 Archive Icons in the System Tree

Use the Archive icons to view information related to the archiving function.
For more information, see section 57.1 “Archiving Overview” on page 1699.

Table: Archive Icons

Icon Description

Indicates Archive Settings.

Indicates the Archive schedule. For more information, see section 51.1
“Schedule Editor – Basic View” on page 1469.

04-30005-01-en, May 2019 System

1747
58 Archive User Interface
58.6 Event Archive File

58.6 Event Archive File

Use the Event Archive to view all events that have passed during the running
time of the EcoStruxure BMS server.

Figure: Event archive file

Table: Event Archive File

Column Description

TYPE Displays the object type that defines the

properties of the object.

SEQNO Displays the trend or 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 57.12 “Event and Alarm
Enumerations” on page 1717.

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.

System 04-30005-01-en, May 2019

1748
 58 Archive User Interface
58.6 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 57.12 “Event
and Alarm Enumerations” on page 1717.

MonitoredVariable Displays the path of the monitored variable

PreviousAlarmState Displays the previous alarm state. For

more information, see section 57.12 “Event
and Alarm Enumerations” on page 1717.

AlarmState Displays the present state of the alarm. For

more information, see section 57.12 “Event
and Alarm Enumerations” on page 1717.

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
57.12 “Event and Alarm Enumerations” on
page 1717.

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 57.12 “Event and
Alarm Enumerations” on page 1717.

Hidden Displays False if the object is shown. For

more information, see section 57.12 “Event
and Alarm Enumerations” on page 1717.

Category Displays the category name of the alarm.

DisabledCause Displays the cause of the disabled alarm.

For more information, see section 57.12
“Event and Alarm Enumerations” on page
1717.

ServerOffline Displays the online status of the

EcoStruxure BMS server. For more
information, see section 57.12 “Event and
Alarm Enumerations” on page 1717.

04-30005-01-en, May 2019 System

1749
58 Archive User Interface
58.6 Event Archive File

Continued
Column Description

UniqueAlarmId Displays the unique identity of the alarm.

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 57.12 “Event and
Alarm Enumerations” on page 1717.

SystemAlarmId Displays the alarm ID generated by the

system when an alarm is triggered. For
more information, see section 57.12 “Event
and Alarm Enumerations” on page 1717.

Comment Displays the comment that has been

added to an alarm.

System 04-30005-01-en, May 2019

1750
 58 Archive User Interface
58.7 Trend Log Archive File

58.7 Trend Log Archive File

Use the Trend Log Archive to view the history of a trend log.

Figure: Trend log archive file

Table: Trend Log Archive File

Column Description

TYPE Displays the object type that defines the

properties of the object.

SEQNO Displays the trend or event sequence

number.

TimeStamp Displays the date and time when a record

or event was generated.

RefSeqNo Displays a reference to another record by

sequence number, used by edits and
comments.

OriginalSeqNo Displays the original sequence number

from the original log stored by the
extended 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 57.15 “Trend Log
Enumerations” on page 1737.

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.

04-30005-01-en, May 2019 System

1751
58 Archive User Interface
58.7 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 57.15 “Trend
Log Enumerations” on page 1737.

System 04-30005-01-en, May 2019

1752
59 Search

Topics
Search Overview
Simple Search
Searching for Objects Using Simple Search
Saving a Search
Search
Properties Conditions Search
Searching for Objects or Properties
Displaying Property Bindings in a Search Result
Displaying the Retain Level in a Search Result
Displaying Value Transfer Settings in a Search Result
Setpoint Search Example
Non-Validated Programs Search Example
Searching for Forced Values
 59 Search
59.1 Search Overview

59.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
search. A search can be done on, for example, conditions or objects types. A
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"displays search results spelled
both "fan" and "Fan".

59.1.1 Simple Search

Use Simple Search to search for object names.
Use the Search view to search for names of properties. For more information,
see section 59.7 “Searching for Objects or Properties” on page 1767.
For more information, see section 59.2 “Simple Search” on page 1757.

59.1.2 Search
You use search to find objects and properties in the EcoStruxure Building
Operation database.
For more information, see section 59.5 “Search ” on page 1761.

59.1.3 Saved Search

Frequently used searches including the settings can be saved and reused.
A saved search is displayed in the System Tree pane and the List View. To
perform the search, open the saved search from the System Tree pane or List
View. The search results are displayed in the work area (with collapsed search
criteria area).
A saved search can be changed, renamed, and deleted.

NOTICE
• When you save a search, only the setting for the search is saved. The search
result is never saved.

59.1.4 Relative or Locked Search Path

If you want to reuse your saved search object in similar folder structures, you
can enter a relative search path in your saved search object. You can reuse a
saved search object by using export and import or copy and paste special.
If you have configured your search object with a relative reference, the search
result is performed on a path relative to the location of the saved search object.

04-30005-01-en, May 2019 System

1755
59 Search
59.1 Search Overview

If you have configured your search object with a locked reference, the search is
performed on the specific folder or container object even if the folder or
container object is renamed or moved. By default, search paths are locked.

Table: Locked and Unlocked References

Path reference syntax Description

~ Locked reference
Searches in the configured folder or
container object

../.. Relative reference

Searches in a path relative to where the
search object is saved. For example,
entering '../../' in the folder path means that
the search is performed two levels up from
where the search object is saved.

System 04-30005-01-en, May 2019

1756
 59 Search
59.2 Simple Search

59.2 Simple Search

Use Simple Search to search for object names.
Use the Search view to search for names of properties. For more information,
see section 59.7 “Searching for Objects or Properties” on page 1767.

Figure: Simple search toolbar and search result list

59.2.1 Wildcard Search

When searching, you use wildcards to substitute characters or combinations of
characters.
Search supports three wildcards:
• Asterisk (*) represents any combination of characters including white
space. * must be used if the text string you search for contains white space.
For example, if you want to search for object names as "temperature
setpoint" or "setpoint office" make sure that you use "*" in the end or in the
beginning of the word "setpoint".
• Question mark (?) represents any single character.
• Square brackets “[]” search for all characters that stands inside the
brackets.
For example, if you want to find all objects and properties containing the word
“Temperature”, you start the search with an asterisk so that the search includes
all hits on objects like “Outside Air Temperature” where the asterisk represents
the words before "Temperature", in this case, “Outside Air”. You also have to end
the search text with an asterisk to include objects like “Temperature Alarm”
where the asterisk represents the word after "Temperature", in this case “Alarm”.
If you search on [a,b]*, you find all objects that begins with an a or a b.
You can also search on objects that start with numbers using square brackets.
For example, a search on [0-9]* finds all objects that starts with a number. A
search on [1,2,3]* finds all objects that starts with 1, 2, or 3.

04-30005-01-en, May 2019 System

1757
59 Search
59.2 Simple Search

NOTICE
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 (*).

59.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 Properties
Properties, you can also open
the properties for all objects in the list. For more information, see the List View
topic on WebHelp.

System 04-30005-01-en, May 2019

1758
 59 Search
59.3 Searching for Objects Using Simple Search

59.3 Searching for Objects Using Simple

Search
You use Simple search to search for an object by its name.
For more information, see section 59.1 “Search Overview” on page 1755.

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-30005-01-en, May 2019 System

1759
59 Search
59.4 Saving a Search

59.4 Saving a Search

You save a search so you can reuse it later.
For more information, see section 59.1 “Search Overview” on page 1755.

To save a search
1. In WorkStation, in the search box, enter the search criterion.
2. In the In folder box, enter the reference type and the folder or container
object in which you want to perform the search:
• ~ searches in the specific folder or container object
• ../.. searches one level up from where the Search object is saved

3. On the Search toolbar, click the Save search criteria button .

4. Select the path where you want to save the Search object.
5. In the Name box, type a name for the Search object.
6. Click Save
Save.

System 04-30005-01-en, May 2019

1760
 59 Search
59.5 Search

59.5 Search
You use search to find objects and properties in the EcoStruxure Building
Operation database.
You can search only for objects or only for object properties in one search
operation. You can exclude irrelevant search results by defining which types to
search for and by setting up conditions for which objects or properties you want
to include in the search.

NOTICE
By default you search for objects. You change settings to search for
properties. For more information, see section 59.7 “Searching for Objects or
Properties” on page 1767.

59.5.1 Wildcard Search

When searching, you use wildcards to substitute characters or combinations of
characters.
Search supports three wildcards:
• Asterisk (*) represents any combination of characters including white
space. * must be used if the text string you search for contains white space.
For example, if you want to search for object names as "temperature
setpoint" or "setpoint office" make sure that you use "*" in the end or in the
beginning of the word "setpoint".
• Question mark (?) represents any single character.
• Square brackets “[]” search for all characters that stands inside the
brackets.
For example, if you want to find all objects and properties containing the word
“Temperature”, you start the search with an asterisk so that the search includes
all hits on objects like “Outside Air Temperature” where the asterisk represents
the words before "Temperature", in this case, “Outside Air”. You also have to end
the search text with an asterisk to include objects like “Temperature Alarm”
where the asterisk represents the word after "Temperature", in this case “Alarm”.
If you search on [a,b]*, you find all objects that begins with an a or a b.
You can also search on objects that start with numbers using square brackets.
For example, a search on [0-9]* finds all objects that starts with a number. A
search on [1,2,3]* finds all objects that starts with 1, 2, or 3.

NOTICE
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 (*).

For more information, see section 36.12 “Filter Condition Wildcards ” on page
1081.

04-30005-01-en, May 2019 System

1761
59 Search
59.5 Search

When searching in a multi-server system, you can include sub servers in the
search. If any sub server is offline, you get an indication at the bottom of the
search result list. The indication displays the number of offline sub servers of the
total number of sub servers. The message also contains a link to the Servers
folder. By clicking the link, you can find out exactly which server has gone
offline.

59.5.2 Forced Values Search

By default, searching for forced values looks for values that were forced from
within the EcoStruxure BMS, that is in the database.
You can also search for forced values in the SmartX servers. In this case, search
looks for values that were forced from outside the EcoStruxure Building
Operation software, for example, on the device.
Values that were forced from outside the EcoStruxure BMS do not always show
up when searching the database. When you search In device
device, each device is
thoroughly searched. This may take several minutes to complete.
For more information, see section 59.13 “Searching for Forced Values” on page
1777.

59.5.3 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".
By right-clicking and dragging an object from the System Tree pane to the
Include types box, you can choose the specific object type or the object type of
any object higher in the inheritance hierarchy.

59.5.4 Properties Conditions Search

You can search for object properties and exclude irrelevant search results by
defining which property types to search for and by setting up conditions for
which properties you want to include in the search.
For more information, see section 59.6 “Properties Conditions Search” on page
1764.

59.5.5 Setpoint Search Example

You want to search for all setpoints , that are over 22, in all offices. You know that
all setpoints are marked “setpoint” in some way, such as “office setpoint”,
“setpoint office”, and “temperature setpoint”. When the search is done, you want
to save the search so that you can use it again without making all settings for
objects and conditions.

System 04-30005-01-en, May 2019

1762
 59 Search
59.5 Search

For more information, see section 59.11 “Setpoint Search Example” on page
1771.

59.5.6 Non-Validated Programs Search Example

You want to find the programs that are not validated in your system. So you
search for all programs that have validation set to None or Failed.
For more information, see section 59.12 “Non-Validated Programs Search
Example” on page 1774.

59.5.7 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 Properties
Properties, you can also open
the properties for all objects in the list. For more information, see the List View
topic on WebHelp.

04-30005-01-en, May 2019 System

1763
59 Search
59.6 Properties Conditions Search

59.6 Properties Conditions Search

You can search for object properties and exclude irrelevant search results by
defining which property types to search for and by setting up conditions for
which properties you want to include in the search.
If you have defined the property type you want to search for, you get
suggestions to help you find the localized name of the property.

Figure: The Select Conditions dialog box when no object type is selected in the Include
types dialog box.

If you choose to include one or more object types in the search, you can select a
condition from the common properties for these object types. If no object type is
included in the search, you can select conditions from the general properties for
all object types.
If you include only one object in the search you can choose between all the
properties for that object type. For example, if you choose Alarm you can select
from all alarm properties in the Selection dialog box.
For example, to search for disabled alarms, you select alarm object type and
then select alarm state in the property list.

Figure: The properties available in the Select Conditions dialog box when alarm is
selected in the Include types dialog box.

The conditions format varies depending on property type.

System 04-30005-01-en, May 2019

1764
 59 Search
59.6 Properties Conditions Search

When a property is included in the search result, you can navigate to the object
it belongs to from the Search View.
If your search result includes a property you want to monitor, you can drag the
property from the Search View to the Watch pane.

Combining condition groups

You can combine condition groups to better suit your search. The different
conditions groups can be combined in any way using "and" and "or".
For example, we want to find all analog values that contain "Setpoint" or
"setpoint" in their object names or descriptions. The objects we want to find have
a values over 20 or have been modified after 2013-02-25 00:00:00.
A search on these criteria looks like this:

Figure: You can combine different search criteria in conditions groups to further refine your
search.

04-30005-01-en, May 2019 System

1765
59 Search
59.6 Properties Conditions Search

NOTICE
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".

System 04-30005-01-en, May 2019

1766
 59 Search
59.7 Searching for Objects or Properties

59.7 Searching for Objects or Properties

You use this procedure to find objects or properties in the database.
For more information, see section 59.1 “Search Overview” on page 1755.

To search for objects or properties

1. In WorkStation, on the WorkStation Toolbar menu, click the Search button

.
2. In the Search view, in the text box, type the name of the object you want to
search for.
3. In the In folder box, enter the folder where you want to start the search.
4. Select Search for properties to only search for properties.
5. Select Include subservers to include EcoStruxure BMS subserver devices
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, enter the object types to include in the search.
8. In the Select Types dialog box, 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, enter the conditions to include in the search.

12. In the Select Conditions dialog box, click the Add condition button to
add a search condition.
13. Click OK
OK.

14. Click the Search button .

Search results are displayed in the Search result area.

04-30005-01-en, May 2019 System

1767
59 Search
59.8 Displaying Property Bindings in a Search Result

59.8 Displaying Property Bindings in a

Search Result
You display property bindings in a search result when you want to check that
you have bound correctly.

NOTICE
You use search to display in-bound properties.

To display property bindings in a search result

1. In WorkStation, on the WorkStation Toolbar, click the Search button .

2. In the Search view, in the Object name box, enter the name of the object to
search for.
3. In the In folder box, enter the path to the folder or container object you want
to search.
4. Select Search for properties
properties.
5. Enter a property name.
6. In the Include types box, enter the type you want to search for if you want
to narrow the search to specific object types.

7. Click the Search icon .

8. In the search result List View, right-click the column heading row and then
click Add/Remove columns
columns.
9. In the Add/Remove Columns dialog box, select Property binding
binding.
10. Click OK
OK.

System 04-30005-01-en, May 2019

1768
 59 Search
59.9 Displaying the Retain Level in a Search Result

59.9 Displaying the Retain Level in a Search

Result
You display the retain level in a search result when you want to check that you
have configured the retain level of a device correctly.

To display the retain level in a search result

1. In WorkStation, on the WorkStation Toolbar, click the Search button .

2. In Search view, in the Object name box, enter the name of the object to
search for.
3. In the In folder box, enter the path to the folder or container object you want
to search.
4. Select Search for properties
properties.
5. Enter a property name.
6. In the Include types box, enter the type you want to search for if you want
to narrow the search to specific object types.

7. Click the Search icon .

8. In the search result List View, right-click the column heading row and then
click Add/Remove columns
columns.
9. In the Add/Remove Columns dialog box, select Property retain level
level.
10. Click OK
OK.

04-30005-01-en, May 2019 System

1769
59 Search
59.10 Displaying Value Transfer Settings in a Search Result

59.10 Displaying Value Transfer Settings in a

Search Result
You display value transfer settings in a search result when you want to
reconfigure the value transfer settings to optimize the system load.
For more information, see the Value Transfer Settings topic on WebHelp.
For more information, see the Search topic on WebHelp.

To display value transfer settings in a search result

1. In WorkStation, on the WorkStation Toolbar, click the Search button .

2. In the Search View
View, enter the name of the object to search for.
3. In the In folder box, enter the path to the folder or container object you want
to search.
4. Select Search for properties
properties.
5. Enter a property name.
6. In the Include types box, enter the type you want to search for if you want
to narrow the search to specific object types.

7. Click the Search icon .

8. In the search result List View, right-click the column heading row and then
click Add/Remove columns
columns.
9. In the Add/Remove Columns dialog box, select the value transfer setting
you want to display:
• Value transfer delta
• Value transfer interval
• Value transfer rate
10. Click OK
OK.

System 04-30005-01-en, May 2019

1770
 59 Search
59.11 Setpoint Search Example

59.11 Setpoint Search Example

You want to search for all setpoints , that are over 22, in all offices. You know that
all setpoints are marked “setpoint” in some way, such as “office setpoint”,
“setpoint office”, and “temperature setpoint”. When the search is done, you want
to save the search so that you can use it again without making all settings for
objects and conditions.
In the search field enter *setpoint*, this includes all objects containing “setpoint”.
If you enter only the word setpoint, without the asterisks (*) you do not find
objects named “office setpoint” or “setpoint_office_1”.
You only want to search in University X, not in University Y, therefore you limit the
search to University X. To do this you browse to University X in the In folder box.

Figure: The Search View when you want to search for the word setpoint in all objects in
University X

To avoid all other hits, for example graphics with links that are named “setpoint”
you should filter on the object type Point. This is done in the Select Types dialog
box.

04-30005-01-en, May 2019 System

1771
59 Search
59.11 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 named
“setpoints” in any way. To filter out only the setpoints with a value of 22 or more
we should set up a condition using the Select Conditions dialog box. We set the
value to be greater than or equal to 22.

Figure: The Select Conditions dialog box when value is set to be greater than or equal to
22

When all search criteria are set, we perform the search. The result is presented
in the Search result list.

System 04-30005-01-en, May 2019

1772
 59 Search
59.11 Setpoint Search Example

Figure: Search result and search criteria

To be able to use the search once again without going through all the settings
once again we save the search with the name “Setpoints over 22”.

Figure: The saved search "Setpoints over 22" in the System Tree pane

04-30005-01-en, May 2019 System

1773
59 Search
59.12 Non-Validated Programs Search Example

59.12 Non-Validated Programs Search

Example
You want to find the programs that are not validated in your system. So you
search for all programs that have validation set to None or Failed.
You only want to search in University X, so you right-click University X and then
click Search. You want to find all programs that are not validated regardless of
their names. The Search box cannot be empty and you want to find all programs
regardless of their names so you should enter an asterisk (*).

Figure: Search View when you have entered an asterisk (*) that finds all objects in
University X

To narrow your search so that only Script or Function Block programs are found,
you should add Function Block Program and Script Program in the Select Types
dialog box.

System 04-30005-01-en, May 2019

1774
 59 Search
59.12 Non-Validated Programs Search Example

Figure: Select Types dialog box when all object types of the categories Function Block
Program and Script Program are 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: Validation conditions None and Failed selected in the Select Conditions dialog box

Then we perform the search.

04-30005-01-en, May 2019 System

1775
59 Search
59.12 Non-Validated Programs Search Example

Figure: Search result for all programs in University X that are not validated successfully

To be able to use the search again without going through all the settings once
more we save the search with the name “Non-Validated Program Search”.

System 04-30005-01-en, May 2019

1776
 59 Search
59.13 Searching for Forced Values

59.13 Searching for Forced Values

You search for forced values to determine if the system runs normally and to
reset forced values. Manually overridden I/O points are not included in the
search result.
For more information, see the Forced Values topic on WebHelp.

To search for forced values

1. In WorkStation, on the Toolbar, click the Search button .

2. In the Search view, in the text box, type your search.

NOTICE
To search for all forced values, type '*'.

3. In the In folder box, enter the folder where you want to start the search.
4. Select Include subservers to include SmartX subservers in the search.

NOTICE
Only subservers running EcoStruxure Building Operation BMS version
1.5 or higher are included in the search.

5. Select Stop if more than 1000 results to limit the search to 1,000 results.
6. Select Forced values only to search for forced values that were forced
from within the EcoStruxure BMS.
7. Select In device to include values forced from outside the EcoStruxure
BMS in the search. For example, values forced on the device.
8. In the Select Types dialog box, in the Include types box, select object
types to include in your search.

9. Click the Add type button .

10. Click OK
OK.
11. In the Select Conditions box, enter the search conditions that have to be
met before a search result is displayed.

12. Click the Add condition button and select the condition you want to
use for the search.
13. Click OK
OK.

14. Click the Search button .

The forced values in the EcoStruxure BMS are displayed.

04-30005-01-en, May 2019 System

1777
60 Shortcuts

Topics
Shortcuts Overview
Shortcut Functionality
Shortcut Targets
User Access to Shortcuts and Targets
Shortcut Creation
Shortcut Presentation
Viewing Shortcuts
Viewing Shortcut Properties
Creating a Shortcut
Configuring the Target of a Shortcut
 60 Shortcuts
60.1 Shortcuts Overview

60.1 Shortcuts Overview

In the EcoStruxure Building Operation software, you can create shortcuts to
objects in the System Tree pane. A shortcut is a link to a target EcoStruxure BMS
server, folder, or other object and is simply a pointer to an object which acts as if
it is that object.

NOTICE
• For the purposes of this discussion, examples of objects in the System Tree
pane are EcoStruxure BMS 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 EcoStruxure
BMS server or folder complete with its internal objects.
You can create shortcuts in any EcoStruxure BMS 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).

60.1.1 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.
For more information, see section 60.2 “Shortcut Functionality” on page 1783.

60.1.2 Shortcut Targets

When you have created a shortcut in a folder or on an EcoStruxure BMS 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.
For more information, see section 60.3 “Shortcut Targets” on page 1784.

60.1.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.

04-30005-01-en, May 2019 System

1781
60 Shortcuts
60.1 Shortcuts Overview

For more information, see section 60.4 “User Access to Shortcuts and Targets”
on page 1785.

60.1.4 Shortcut Creation

You can create a shortcut to an EcoStruxure BMS server, folder or object
anywhere in the System Tree pane.
For more information, see section 60.5 “Shortcut Creation” on page 1786.

60.1.5 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 an EcoStruxure BMS server or a folder as a target is a presentation object
and is always displayed in the System Tree.
For more information, see section 60.6 “Shortcut Presentation” on page 1788.

System 04-30005-01-en, May 2019

1782
 60 Shortcuts
60.2 Shortcut Functionality

60.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

04-30005-01-en, May 2019 System

1783
60 Shortcuts
60.3 Shortcut Targets

60.3 Shortcut Targets

When you have created a shortcut in a folder or on an EcoStruxure BMS 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 60.10 “Configuring the Target of a Shortcut”
on page 1792.

System 04-30005-01-en, May 2019

1784
 60 Shortcuts
60.4 User Access to Shortcuts and Targets

60.4 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-30005-01-en, May 2019 System

1785
60 Shortcuts
60.5 Shortcut Creation

60.5 Shortcut Creation

You can create a shortcut to an EcoStruxure BMS 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 EcoStruxure BMS 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

EcoStrux Yes Yes No Yes Yes Yes Yes

ure BMS
Server

Folder Yes Yes Yes Yes Yes Yes Yes

Point No No Yes Yes Yes Yes Yes

Graphic No No Yes Yes Yes Yes Yes

60.5.1 Shortcuts in EcoStruxure BMS Servers and

Folders
You can create shortcuts in the root of an EcoStruxure BMS server or in an
existing folder. A shortcut can reference objects in other EcoStruxure BMS
servers. The menu commands applicable to the creation of shortcuts for
EcoStruxure BMS 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.

System 04-30005-01-en, May 2019

1786
 60 Shortcuts
60.5 Shortcut Creation

60.5.2 Shortcuts to Objects and Points

You can create shortcuts to objects or points (for example, a graphic or an
analog value) within an EcoStruxure BMS 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-30005-01-en, May 2019 System

1787
60 Shortcuts
60.6 Shortcut Presentation

60.6 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 an EcoStruxure BMS server or a folder as a target is a presentation object
and is always displayed in the System Tree.
When a shortcut is created in an EcoStruxure BMS 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 61.3 “Shortcut Properties –
Basic Tab” on page 1797.
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-30005-01-en, May 2019

1788
 60 Shortcuts
60.7 Viewing Shortcuts

60.7 Viewing Shortcuts

You view shortcuts to objects in the System Tree pane when you want to see
non-presentation objects, for example Script or Function Block programs. By
default, non-presentation objects are hidden in the System Tree pane.
For more information, see section 60.6 “Shortcut Presentation” on page 1788.

To view shortcuts to objects

1. In the System Tree pane, click the Show/Hide non-presentation objects

button .
You can now view the properties of the shortcut(s).

04-30005-01-en, May 2019 System

1789
60 Shortcuts
60.8 Viewing Shortcut Properties

60.8 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 60.3 “Shortcut Targets” on page 1784.

To view the properties of a shortcut

1. In the System Tree pane, right-click the shortcut and then click Shortcut
Properties
Properties.

NOTICE
• You cannot view the properties of a shortcut by selecting the Properties
command. You must select the Shortcut Properties command.

System 04-30005-01-en, May 2019

1790
 60 Shortcuts
60.9 Creating a Shortcut

60.9 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 60.5 “Shortcut Creation” on page 1786.

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 EcoStruxure BMS server or folder
where you want the shortcut.
3. Click Create Shortcut
Shortcut.

04-30005-01-en, May 2019 System

1791
60 Shortcuts
60.10 Configuring the Target of a Shortcut

60.10 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 60.3 “Shortcut Targets” on page 1784.

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. In the Target box, enter the path of the target object.
4. Click OK
OK.

System 04-30005-01-en, May 2019

1792
61 Shortcuts User Interface

Topics
Shortcuts Icon
Create Shortcut Wizard – Shortcut Target Page
Shortcut Properties – Basic Tab
 61 Shortcuts User Interface
61.1 Shortcuts Icon

61.1 Shortcuts Icon

This section describes the icon in WorkStation that relates to shortcuts.

Table: Shortcuts Icon in WorkStation

Icon Description

Overlay Shortcut icon

Indicates a shortcut to an object in the
System Tree.

04-30005-01-en, May 2019 System

1795
61 Shortcuts User Interface
61.2 Create Shortcut Wizard – Shortcut Target Page

61.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-30005-01-en, May 2019

1796
 61 Shortcuts User Interface
61.3 Shortcut Properties – Basic Tab

61.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 EcoStruxure

BMS server, folder, or object.

04-30005-01-en, May 2019 System

1797
62 Documents

Topics
Documents Overview
Creating a Document
Document Policy
Adding a File Extension to the Permitted File Extensions List
Editing a File Extension on the Permitted File Extensions
List
Removing a File Extension from the Permitted File
Extensions List
 62 Documents
62.1 Documents Overview

62.1 Documents Overview

A Document is a container in which you can upload (import) a file for use in the
EcoStruxure Building Operation software. You can upload all types of files,
including reports, forms, images, and video clips.
When you open a Document,the EcoStruxure Building Operation software starts
the installed editor or viewer associated with the file type. For example, you can
open, edit, and save documents associated with Microsoft Word. For more
information, see the Opening a Document topic on WebHelp.

NOTICE
You can upload any file type, including .doc, .jpg, .pdf, or .txt, without size
restrictions. However, importing files larger than 17 MB to a SmartX server can
result in an Insufficient Memory error.

Document creation
You can quickly create a Document by dragging a file from Windows Explorer to
WorkStation. You can also create a Document by using the Wizard. For more
information, see section 62.2 “Creating a Document” on page 1802.

Document attachment to other objects

After a Document is created and saved, you can attach the Document to another
EcoStruxure 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
the Configuring Attachments of an Alarm topic on WebHelp.
However, a Document is a separate entity so you cannot attach the Document
directly to another object. Instead, you make an attachment from an EcoStruxure
Building Operation object to the Document.

NOTICE
When you log off or are automatically logged off, any unsaved changes in the
document are not saved in the database. Make sure that you save changes in
open documents frequently.

Document Policy
You can increase the security in your system by configuring the document
policy. The document policy controls which file types a user can open, save,
and import.
For more information, see section 62.3 “Document Policy” on page 1803.

04-30005-01-en, May 2019 System

1801
62 Documents
62.2 Creating a Document

62.2 Creating a Document

You create a document so that you can view, edit, and store files in WorkStation.
You can also attach documents to other EcoStruxure Building Operation
objects, such as alarms.
For more information, see section 62.1 “Documents Overview” on page 1801.

To create a document
1. In Windows Explorer, select the file you want to import to WorkStation.
2. In WorkStation, drag the file to the EcoStruxure BMS server or folder where
you want to create a document.

System 04-30005-01-en, May 2019

1802
 62 Documents
62.3 Document Policy

62.3 Document Policy

You can increase the security in your system by configuring the document
policy. The document policy controls which file types a user can open, save,
and import.
You configure the document policy by determining the permitted file extensions
for the EcoStruxure BMS. A user cannot open, save, or import files with file
extensions that are not on the list. A user can save a file without any file
extension.
A user who browses the system to create or edit a document object can only see
files with permitted file extensions and files without any file extension.
By default, the list of permitted file extensions contains the following file
extensions:
• avi
• dfx
• doc
• docx
• dwg
• gif
• htm
• html
• jpg
• mp4
• mpg
• odt
• pdf
• png
• rtf
• txt
• xls
• xlsx
The permitted file extensions list configuration on an Enterprise Server is
distributed to all SmartX servers in the EcoStruxure BMS.
You can add file extensions to, and delete file extensions from, the permitted file
extensions list. If you have configured the list, it is preserved when you upgrade
the EcoStruxure BMS.
If a file extension is not on the permitted file extensions list and a user performs a
restore operation, the operation succeeds and the document object is restored,
but it is no longer possible to open the document file. If the document file
extension is added to the permitted file extensions list, it is possible to open and
save the restored document file.
If you upgrade an older EcoStruxure BMS without a document policy, the
upgraded system gets the default document policy.

04-30005-01-en, May 2019 System

1803
62 Documents
62.4 Adding a File Extension to the Permitted File Extensions List

62.4 Adding a File Extension to the Permitted

File Extensions List
You add a file extension to the Permitted File Extensions list so that EcoStruxure
Building Operation users can open, save, and import files with that file
extension.
For more information, see section 62.3 “Document Policy” on page 1803.

To add a file extension to the Permitted File Extensions list

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Under Security and communication
communication, click Document Policy
Policy.

4. In the Document Policy view, click the Add file extension button .
5. In the Add File Extension dialog box, in the File extension box, type the file
extension you want to add to the list and then click OK
OK.

NOTICE
Do not use a period '.' in the file extension. For example, type 'pdf' rather
than '.pdf'.

6. Click the Save button .

An EcoStruxure Building Operation user can open, save, or import files with the
added file extension.

System 04-30005-01-en, May 2019

1804
 62 Documents
62.5 Editing a File Extension on the Permitted File Extensions List

62.5 Editing a File Extension on the Permitted

File Extensions List
You edit a file extension on the Permitted File Extensions list to make it possible
for users in the EcoStruxure Building Operation software to open, save, and
import files with a certain extension.
For more information, see section 62.3 “Document Policy” on page 1803.

To edit file extensions on the Permitted File Extensions list

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Under Security and Communication
Communication, click Document Policy
Policy.
4. On the Permitted File Extensions list, select the file extension you want to
edit.

5. In the Document Policy view, click the Edit file extension button .
6. In the Edit File Extension dialog box, in the File extension box, edit the file
extension and then click OK
OK.

NOTICE
Do not use a period '.' in the file extension. For example, type 'pdf' rather
than '.pdf'.

7. Click the Save button .

04-30005-01-en, May 2019 System

1805
62 Documents
62.6 Removing a File Extension from the Permitted File Extensions List

62.6 Removing a File Extension from the

Permitted File Extensions List
You remove a file extension from the Permitted File Extensions list to increase
the security of your EcoStruxure BMS by preventing users from opening, saving,
and importing files with a certain file extension.
For more information, see section 62.3 “Document Policy” on page 1803.

To remove a file extension from the Permitted File Extensions

list
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Under Security and communication
communication, click Document Policy
Policy.
4. On the Permitted File Extensions list, select the file extension you want to
remove.

5. Click the Remove file extension button .

6. Click the Save button .

A user in the EcoStruxure BMS can no longer open, save, or import a file with
extension that you deleted from the Permitted File Extensions list.

System 04-30005-01-en, May 2019

1806
63 Documents User Interface

Topics
Document Properties – Basic Tab
New Document Wizard – Import Document Page
Document Policy View
Document Policy Toolbar
Add File Extension Dialog Box
Edit File Extension Dialog Box
 63 Documents User Interface
63.1 Document Properties – Basic Tab

63.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-30005-01-en, May 2019 System

1809
63 Documents User Interface
63.2 New Document Wizard – Import Document Page

63.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-30005-01-en, May 2019

1810
 63 Documents User Interface
63.3 Document Policy View

63.3 Document Policy View

Use the Document Policy View to edit the Permitted File Extensions list.

Figure: Document Policy view

Table: Document Policy View

Number Description

Document Policy Toolbar

Use the Document Policy Toolbar to edit
the contents of the Permitted File
Extensions list. For more information, see
section 63.4 “Document Policy Toolbar” on
page 1812.

Permitted File Extensions

Use the Permitted File Extensions list to
select file extensions you want to edit or
delete. For more information, see section
62.3 “Document Policy” on page 1803.

04-30005-01-en, May 2019 System

1811
63 Documents User Interface
63.4 Document Policy Toolbar

63.4 Document Policy Toolbar

Use the Document Policy toolbar to edit the Permitted File Extensions list.

Table: Document Policy Toolbar

Button Description

Add file extension

Click to open the Add File Extension
dialog box where you add file extensions
to the Permitted File Extensions list. For
more information, see section 63.5 “Add
File Extension Dialog Box” on page 1813.

Edit file extension

Click to open the Edit File Extension
dialog box where you edit a file extension
on the Permitted File Extensions list. For
more information, see section 63.6 “Edit
File Extension Dialog Box” on page 1814.

Remove file extension

Click to remove a selected file extension
from the Permitted File Extensions list.

System 04-30005-01-en, May 2019

1812
 63 Documents User Interface
63.5 Add File Extension Dialog Box

63.5 Add File Extension Dialog Box

Use the Add File Extension dialog box to add a file extension to the Permitted
File Extensions list.

Figure: Add File Extension dialog box

Table: Add File Extension Dialog Box

Component Description

File extension Type the file extension you want to add to

the Permitted File Extensions list. For more
information, see section 62.3 “Document
Policy” on page 1803.

04-30005-01-en, May 2019 System

1813
63 Documents User Interface
63.6 Edit File Extension Dialog Box

63.6 Edit File Extension Dialog Box

Use the Edit File Extension dialog box to edit a file extension on the Permitted
File Extensions list.

Figure: Edit File Extension dialog box

Table: Edit File Extension Dialog Box

Component Description

File extension Type to edit the file extension. For more

information, see section 62.3 “Document
Policy” on page 1803.

System 04-30005-01-en, May 2019

1814
64 Backup and Restore

Topics
Backup and Restore Overview
Comparison of Backup and Restore Methods
Retain Level
Configuring the Retain Level
 64 Backup and Restore
64.1 Backup and Restore Overview

64.1 Backup and Restore Overview

You backup your EcoStruxure BMS server data so that it can be restored after
damage or loss due to hardware or software failures, security threats, or
application testing.
The EcoStruxure Building Operation software provides backup and restore
capabilities that preserve both configuration and historical data on an as-
needed or periodic basis.

64.1.1 Backup
Backup is the process of copying and storing data so that the copy can be used
to restore data if a loss occurs. You can also use a backup to revert to an older
version. In the EcoStruxure BMS, you can perform backups on an all
EcoStruxure BMS servers and their devices. EcoStruxure BMS server backups
should take place during non-business hours.
For more information, see section 65.1 “Backup” on page 1827.

64.1.2 Restore
Restore is the process of restoring data to an original or former state. Using
Restore, you can revert to a previous snapshot of the EcoStruxure BMS server
data despite any configuration changes made since the last backup. In the
EcoStruxure BMS, Restore is a manual process designed to avoid the
accidental overwriting of current EcoStruxure BMS server data.
For more information, see section 68.1 “Restore” on page 1877.

64.1.3 BACnet Backup and Restore

BACnet Backup uses a binary file format to back up an entire device.
Specifically, BACnet Backups comprise the entire contents of the selected
device, such as associated objects, properties, bindings, historical data, and
related proprietary configuration data.
For more information, see the BACnet Backup and Restore topic on WebHelp.

64.1.4 Archiving Overview

Archiving is the process of preserving historical data, which is comprised of
selected events and extended trend logs. For example, some facilities are
required to maintain archives to comply with government regulations. Another
example is in secure facilities where they must maintain records of who logged
in or who changed setpoints. Archiving is not a backup function because
archive data cannot be imported back into the system.
For more information, see section 57.1 “Archiving Overview” on page 1699.

04-30005-01-en, May 2019 System

1817
64 Backup and Restore
64.1 Backup and Restore Overview

64.1.5 Comparison of Backup and Restore

Methods
There are two Backup and Restore methods:
• EcoStruxure Building Operation Backup and Restore
• BACnet Backup and Restore
You can select the backup and restore method that suits your EcoStruxure BMS
server data storage and retrieval requirements.
For more information, see section 64.2 “Comparison of Backup and Restore
Methods ” on page 1819.

64.1.6 Retain Level

In the EcoStruxure BMS servers, variable values are primarily stored in flash
memory in order to have their values survive power fail and server shutdown.
However, values that are often collected are only stored in the SDRAM memory.
This is done to protect the flash memory in the SmartX server.
For more information, see section 64.3 “Retain Level ” on page 1821.

System 04-30005-01-en, May 2019

1818
 64 Backup and Restore
64.2 Comparison of Backup and Restore Methods

64.2 Comparison of Backup and Restore

Methods
There are two Backup and Restore methods:
• EcoStruxure Building Operation Backup and Restore
• BACnet Backup and Restore
You can select the backup and restore method that suits your EcoStruxure BMS
server data storage and retrieval requirements.
The following table contrasts the EcoStruxure Building Operation and BACnet
backup and restore methods.

Table: Comparison of EcoStruxure Building Operation and BACnet Backup and

Restore
Method Purpose Description

EcoStruxure Building Backs up configuration data Use this method to back up

Operation Backup and historical data EcoStruxure BMS servers
that can include data from
b3, LonWorks, Network
8000, I/NET, MicroNet, and
Modbus devices.
The b3 devices are
automatically backed up
whenever an EcoStruxure
BMS server is backed up.
Therefore, b3 devices do
not need backing up using
the BACnet Backup
method.

BACnet Backup Backs up configuration data Use this method to backup

primarily:
• External devices
• Routers
BACnet Backup and
Restore can also backup
and restore b3 devices that
are connected to either a
b3CX controller or external
router. However, BACnet
backup and restore cannot
backup b3 devices when
the devices are connected
to a SmartX server that
functions as a router. For
more information, see the
BACnet Backup and
Restore topic on WebHelp.

EcoStruxure Building Restores an EcoStruxure Use this method to restore

Operation Restore BMS server using EcoStruxure BMS servers
configuration data and that can include data from
historical data contained in b3, LonWorks, Network
a backup set 8000, I/NET, MicroNet, and
Modbus devices.

04-30005-01-en, May 2019 System

1819
64 Backup and Restore
64.2 Comparison of Backup and Restore Methods

Continued
Method Purpose Description

BACnet Restore Restores a device using Use this method to backup

configuration data primarily:
contained in a backup set
(no historical data) • External devices
• Routers

NOTICE
To restore archived data, use the Archiving feature rather than Restore
method. See For more information, see section 57.1 “Archiving Overview” on
page 1699.

System 04-30005-01-en, May 2019

1820
 64 Backup and Restore
64.3 Retain Level

64.3 Retain Level

In the EcoStruxure BMS servers, variable values are primarily stored in flash
memory in order to have their values survive power fail and server shutdown.
However, values that are often collected are only stored in the SDRAM memory.
This is done to protect the flash memory in the SmartX server.
Variables have a retain level that controls if the value of the variable is retained
after a restart of the server. There are three retain levels. The following table lists
the retain levels and whether a variable is retained after cold start, warm start, or
power failure.

Table: Retain Levels

Retain level Cold start Warm start Power failure

No

Warm start x x

Cold start x x x

In addition, the retain level also defines if and when a variable value is saved in
the configuration database. A new value of a variable can either be configured
by a user or by an application, for example Function Block or Script.
User written variable values with warm start retained and cold start retained
levels are stored in the database. These variable values are part of a backup
and restore of the database.
Application written variable values with cold start retained levels are stored in
the database during certain activities, such as backup and export.

Table: Retain Levels for Certain Events and Activities

System Events and Retain level: No Retain level: Cold Retain level: Warm
Activities start start

Cold start command Default value a Variable retains last Variable retains last
value configured by value configured by
a user. a user.
Values configured Values configured
by an application by an application
are retained. are lost.

Warm start Default value a Variable retains last Variable retains last
command value configured by value configured by
a user. a user.
Values configured Values configured
by an application by an application
are retained. are retained.

Exporting & Default value a Variable retains last Variable retains last
Importing value configured by value configured by
a user. a user.
Values configured Values configured
by an application by an application
are retained. are lost.

04-30005-01-en, May 2019 System

1821
64 Backup and Restore
64.3 Retain Level

Continued
System Events and Retain level: No Retain level: Cold Retain level: Warm
Activities start start

Viewing Variable in Shows the last value Shows the last value Shows the last value
EcoStruxure configured by a user configured by a user configured by a user
Building Operation or application. or application. or application.
user interface

Backup & Restore Default value a Variable retains last Variable retains last
value configured by value configured by
a user. a user.
Values configured Values configured
by an application by an application
are retained. are lost.

Power loss and Default value a Variable retains last Variable retains last
restore value configured by value configured by
a user. a user.
Values configured Values configured
by an application by an application
are retained. are retained.

Upgrade Default value a Variable retains last Variable retains last

value configured by value configured by
a user. a user.
Values configured Values configured
by an application by an application
are retained. are lost.

a) Default value is the value the variable gets when it is created.

Function Block
Function block objects have there own backup function. The backup function in
Function Block overrides the retain level in EcoStruxure BMS. For more
information, see the Edit Block Dialog Box topic on WebHelp.

System 04-30005-01-en, May 2019

1822
 64 Backup and Restore
64.4 Configuring the Retain Level

64.4 Configuring the Retain Level

Configure the retain level to control what happen to values when different
system events occurs.
For more information, see section 64.3 “Retain Level ” on page 1821.

To configure the retain level

1. In WorkStation, in the System Tree pane, click the value.

2. Click the Configure button .

3. Select Retain level
level.

4. In the Retain level box, select the retain level.

04-30005-01-en, May 2019 System

1823
65 Backups

Topics
Backup
Types of Data
Backup Status
Checking the Backup Status of an EcoStruxure BMS Server
Manual Backups
Mass Backup
Backing Up EcoStruxure BMS Servers Manually
System Backup
Local Backup and Restore of EcoStruxure BMS Servers
Remote Backup and Restore of SmartX Servers
 65 Backups
65.1 Backup

65.1 Backup
Backup is the process of copying and storing data so that the copy can be used
to restore data if a loss occurs. You can also use a backup to revert to an older
version. In the EcoStruxure BMS, you can perform backups on an all
EcoStruxure BMS servers and their devices. EcoStruxure BMS server backups
should take place during non-business hours.
Using WorkStation, you can back up data to the local drive of each installed
EcoStruxure BMS server. The EcoStruxure Building Operation software stores
the files by date in a predefined directory location on the server to which
WorkStation is connected. For more information, see section 66.1 “Backup Sets”
on page 1843.

65.1.1 Types of Data

The EcoStruxure Building Operation backup function enables you to back up
different types of data.
For more information, see section 65.2 “Types of Data” on page 1829.

65.1.2 Backup Sets

Backup sets are compressed backup files used for restoring data. The
EcoStruxure Building Operation software stores the local backup set for an
Enterprise Server or SmartX servers in the Local folder within the Backup sets
folder.
For more information, see section 66.1 “Backup Sets” on page 1843.

65.1.3 Scheduled Backups

A scheduled backup is an automated way to back up data on an EcoStruxure
BMS server. You can back up EcoStruxure BMS servers individually using each
EcoStruxure BMS server’s local backup rule. You can also use backup rules to
synchronize the backups of all the EcoStruxure BMS servers on your network.
For more information, see section 67.1 “Scheduled Backups” on page 1863.

65.1.4 Manual Backups

Manual Backup is a non-automated process of copying and storing data on a
selected EcoStruxure BMS server. You can use this option to create backups on
an as-needed basis. You can also manually restore the data at any time.
For more information, see section 65.5 “Manual Backups” on page 1832.

04-30005-01-en, May 2019 System

1827
65 Backups
65.1 Backup

65.1.5 Mass Backup

Mass backup is a method of performing a manual, simultaneous backup of all
the EcoStruxure BMS servers in the network, which is useful for capturing data at
a critical point, such as prior to an upgrade. You can choose which EcoStruxure
BMS servers you want to back up along with the type of data for each.
For more information, see section 65.6 “Mass Backup” on page 1834.

65.1.6 System Backup

Before upgrading the system, it is strongly recommended that you archive the
historical data and back up the EcoStruxure BMS servers to preserve the current
data and configurations. If you plan to upgrade WebReports, be sure to back up
the Reports database in SQL Server.
For more information, see section 65.8 “System Backup” on page 1836.

65.1.7 Backup Status

Backup Status displays the statuses of an EcoStruxure BMS server: Ready,
Backing up, or Backup succeeded.
For more information, see section 65.3 “Backup Status” on page 1830.

System 04-30005-01-en, May 2019

1828
 65 Backups
65.2 Types of Data

65.2 Types of Data

The EcoStruxure Building Operation backup function enables you to back up
different types of data.
The EcoStruxure Building Operation backup function provides two backup
options:
• Configuration only
only: This option makes a back up the configuration
database and and is useful for new installations. Configuration data
includes points, values, alarm objects, trend objects, programs, graphics,
and custom object type data.
The Configuration only option also includes the configuration properties of
variables, such as Unit. Depending on the retain level of the variable, some
configuration properties like Value are also included in a backup. For more
information, see section 64.3 “Retain Level ” on page 1821.
• All data
data: This option makes a back up of the configuration database and the
historical data. Historical data is trend logs and event logs. The option All
data is useful for existing systems,

NOTICE
Depending on the type of data, the system locks changes to the database
while a backup is in progress in different ways. For configuration changes, the
EcoStruxure Building Operation software queues up the changes until the
backup completes. For historical data changes, the EcoBuilding Operation
buffers the data based on the limits of the buffer size.

Impact on Configuration Values and Variables

When you back up an EcoStruxure BMS server specifying either Configuration
only or All data, the EcoStruxure Building Operation back up includes all the
configuration values that are specified for the EcoStruxure BMS server’s objects.
If you restore the EcoStruxure BMS server back up, the configuration values are
restored, which can overwrite any changes made since the last backup. For
more information, see section 64.3 “Retain Level ” on page 1821.

Backup Strategy
When deciding on the frequency of EcoStruxure BMS server backups, you
should take into account the potential cost of recreating any historical or
configuration data that can change since the last backup. For example, you can
perform an All data backup back up a SmartX server weekly if multiple operators
use their WorkStations frequently. As a precaution, you can perform a
Configuration only backup before installing a new application or modifying the
current configuration.

04-30005-01-en, May 2019 System

1829
65 Backups
65.3 Backup Status

65.3 Backup Status

Backup Status displays the statuses of an EcoStruxure BMS server: Ready,
Backing up, or Backup succeeded.
If a backup does not succeed, the system displays a default alarm informing you
of the backup or EcoStruxure BMS server issue. For more information, see the
Backup and Restore Alarms topic on WebHelp.

System 04-30005-01-en, May 2019

1830
 65 Backups
65.4 Checking the Backup Status of an EcoStruxure BMS Server

65.4 Checking the Backup Status of an

EcoStruxure BMS Server
You check the backup status of an EcoStruxure BMS server to view its backup
status and note the date and time of the last backup.
For more information, see section 65.3 “Backup Status” on page 1830.

To check the backup status of an EcoStruxure BMS server

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Backup and Restore Manager
Manager.
4. View the EcoStruxure BMS server backup status or date and time of the last
successful backup.

04-30005-01-en, May 2019 System

1831
65 Backups
65.5 Manual Backups

65.5 Manual Backups

Manual Backup is a non-automated process of copying and storing data on a
selected EcoStruxure BMS server. You can use this option to create backups on
an as-needed basis. You can also manually restore the data at any time.
You log on to one of the following EcoStruxure BMS servers to initiate a manual
backup:
• SmartX server or Enterprise Server to perform a local backup. For more
information, see section 65.9 “Local Backup and Restore of EcoStruxure
BMS Servers” on page 1838.
• Enterprise Server to perform a remote backup of any SmartX servers that
are created under the Enterprise Server. For more information, see section
65.10 “Remote Backup and Restore of SmartX Servers” on page 1839.
• Enterprise Central to perform a remote backup of any Enterprise Servers
that are created under the Enterprise Central. For more information, see
section 65.9 “Local Backup and Restore of EcoStruxure BMS Servers” on
page 1838.

65.5.1 Backup Set Naming

For manual backups, the system initially names the backup set by combining
the EcoStruxure BMS server name with the localized date and time of the
machine running WorkStation. For scheduled backups, however, the system
combines the EcoStruxure BMS server name with the UTC time in the backup
set name rather than the local time.

NOTICE
The system also retains the UTC time of manually generated backups. To view
the UTC time rather than the localized time for a manual backup set, select the
Backup date property from the column selector of the Backup Sets List view.
For more information, see the Columns topic on WebHelp.

If you log on to the Enterprise Server in WorkStation to create a backup of the

SmartX server, the system automatically checks for identical backup set names.
If a name is found in the AS Archives folder, the system warns of a potential
duplication by highlighting the Backup set name prefix box or the Backup set
name suffix box in solid red. If you do not change the prefix or suffix, the system
displays a red box around the backup set in the Backup set name column to
indicate that there is an existing name. If you still do not change the name, the
system automatically appends an extended time stamp to prevent the
accidental overwriting. For more information, see the Duplicate Backup Set
Names in Multi-server Systems topic on WebHelp.

65.5.2 Local Backup and Restore of EcoStruxure

BMS Servers
In WorkStation, you can log on to an EcoStruxure BMS server directly to perform
manual backup and restore tasks.

System 04-30005-01-en, May 2019

1832
 65 Backups
65.5 Manual Backups

For more information, see section 65.9 “Local Backup and Restore of
EcoStruxure BMS Servers” on page 1838.

65.5.3 Remote Backup and Restore of SmartX

Servers
When you log on to an Enterprise Server, you can perform remote backups of
any SmartX server in the system. Whenever a backup occurs on the SmartX
server, the system overwrites the locally stored file on the SmartX server with the
new backup file. The Enterprise Server then retrieves and stores this backup file
in a separate directory on the computer that runs the Enterprise Server.
For more information, see section 65.10 “Remote Backup and Restore of SmartX
Servers” on page 1839.

04-30005-01-en, May 2019 System

1833
65 Backups
65.6 Mass Backup

65.6 Mass Backup

Mass backup is a method of performing a manual, simultaneous backup of all
the EcoStruxure BMS servers in the network, which is useful for capturing data at
a critical point, such as prior to an upgrade. You can choose which EcoStruxure
BMS servers you want to back up along with the type of data for each.
In smaller installations, a server group may include an Enterprise Server and one
or more SmartX servers. In larger installations, multiple server groups may
include an Enterprise Server with a distinct set of SmartX servers.
In an EcoStruxure BMS that has an Enterprise Central with attached Enterprise
Servers, you can do a mass backup of all the Enterprise Servers.

Figure: Mass backup of an Enterprise Server and SmartX servers

You log on to the Enterprise Server to create a mass backup. For more
information, see section 69.6 “Backup Options Dialog Box” on page 1901.

System 04-30005-01-en, May 2019

1834
 65 Backups
65.7 Backing Up EcoStruxure BMS Servers Manually

65.7 Backing Up EcoStruxure BMS Servers

Manually
You back up multiple EcoStruxure BMS servers manually to copy and store data
that is frequently updated.
For more information, see section 65.5 “Manual Backups” on page 1832.

To back up EcoStruxure BMS servers manually

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server.
2. On the Actions menu, click Backup
Backup.
3. In the Backup Options dialog box, in the Backup set name prefix box, type
some text at the beginning of the file name that helps identify the backup
set.
4. In the Backup set name suffix box, type some text at the end of the file
name that helps identify the backup set.
5. In the Include column, select the EcoStruxure BMS servers that you want to

include in the backup, or click the Select All button to include all the
listed EcoStruxure BMS servers in the backup.
6. In the Backup content column, select the type of data you want to back up
for each EcoStruxure BMS server:
• Select Configuration only to back up the configuration database and
custom object type data.
• Select All data to back up the configuration, historical data, and
custom object type data.
7. In the Backup set description column, type a brief description up to 255
characters to help identify the content of each backup.

8. Click the Synchronize Description button to add the same backup set
description entered for one EcoStruxure BMS server to all the other backup
sets.

9. Click the Synchronize Content button to add the same content type
chosen for one EcoStruxure BMS server to all the other backup sets.

10. Click the Synchronize All button to add both the backup set
description and the content type chosen for one EcoStruxure BMS server to
all the other backup sets.
11. Click Backup
Backup.
12. In the Backup Status dialog box, verify that the backups succeeded and
click Close
Close.

04-30005-01-en, May 2019 System

1835
65 Backups
65.8 System Backup

65.8 System Backup

Before upgrading the system, it is strongly recommended that you archive the
historical data and back up the EcoStruxure BMS servers to preserve the current
data and configurations. If you plan to upgrade WebReports, be sure to back up
the Reports database in SQL Server.
The following diagram describes the recommended steps for archiving and
backing up a multi-server system running EcoStruxure Building Operation
software.

Figure: System archive and backup process overview

Table: System Archive and Backup Process Overview

Step Procedure Description

1 Archive system data Perform a manual archive of the system

historical data in the Enterprise Server or
Enterprise Central. (Archiving is not on
SmartX servers.) For more information, see
section 57.6 “Manually Creating an Archive”
on page 1706.

2 Back up current EcoStruxure Create an All data backup for the Enterprise
BMS servers Central, Enterprise Server, and each SmartX
server. The backups do not need to follow
any particular order. For more information,
see section 65.7 “Backing Up EcoStruxure
BMS Servers Manually” on page 1835.

3 Save backup sets to an external Save the Enterprise Central, Enterprise

location Server, and SmartX server backup sets (.xbk)
to a safe location on a file system that is
external to the Entrerprise Central or
Enterprise Server. For more information, see
section 66.3 “Backup Set Storage and
Protection” on page 1847.

System 04-30005-01-en, May 2019

1836
 65 Backups
65.8 System Backup

Continued
Step Procedure Description

4 Back up current Reports For systems that include a Reports Server,

database back up the WebReports database. For more
information, see the Backing Up the
WebReports Database topic on WebHelp.
You can also back up the Reports database
folder to another location on the file system
(not the default source location in the
C:\Program Files\ directory).

04-30005-01-en, May 2019 System

1837
65 Backups
65.9 Local Backup and Restore of EcoStruxure BMS Servers

65.9 Local Backup and Restore of

EcoStruxure BMS Servers
In WorkStation, you can log on to an EcoStruxure BMS server directly to perform
manual backup and restore tasks.

65.9.1 Local Backup and Restore of a Standalone

SmartX Server
In WorkStation, you can log on to a SmartX server to perform a manual backup
of the SmartX server data.
If you have multiple standalone SmartX servers, the Backup and Restore
processes on one SmartX server remain self-contained and, therefore, separate
from any another SmartX server on the network.
In a stand-alone system only one backup set is stored on the SmartX server. If
you import a backup set, the system overwrites the locally stored file with the
imported file. Therefore, you only see one backup file in the Restore Options
dialog box when you log on to a SmartX server.

65.9.2 Local Backup and Restore of an Enterprise

Server
In WorkStation, you can log on to an Enterprise Server to perform a manual
backup of the Enterprise Server data. If you have multiple Enterprise Servers,
the Backup and Restore processes on one Enterprise Server remain self-
contained and, therefore, separate from any another Enterprise Server on the
network.

65.9.3 Local Backup and Restore of an Enterprise

Central
In WorkStation, you can log on to an Enterprise Central to perform a manual
backup of the Enterprise Central data. The Backup and Restore processes on
Enterprise Central are self-contained.

System 04-30005-01-en, May 2019

1838
 65 Backups
65.10 Remote Backup and Restore of SmartX Servers

65.10 Remote Backup and Restore of SmartX

Servers
When you log on to an Enterprise Server, you can perform remote backups of
any SmartX server in the system. Whenever a backup occurs on the SmartX
server, the system overwrites the locally stored file on the SmartX server with the
new backup file. The Enterprise Server then retrieves and stores this backup file
in a separate directory on the computer that runs the Enterprise Server.
When you want to restore a SmartX server, the system displays only the valid
SmartX server backup files that are stored on the Enterprise Server.
In the event that the backup file on the SmartX server is damaged or lost, or not
the one you want to use, you can select a valid backup file to restore the SmartX
server. The restore operation overwrites the locally stored SmartX server backup
file located on the SmartX server with the selected backup file. For more
information, see section 68.4 “Restoring a SmartX Server from the Enterprise
Server” on page 1881.

04-30005-01-en, May 2019 System

1839
66 Backup Sets

Topics
Backup Sets
Location of Backup Sets
Backup Set Storage and Protection
Locating the Local Backup Path on the Enterprise Server or
Enterprise Central
Saving an Enterprise Server or Enterprise Central Backup
Set to Another Location
Saving a SmartX Server Backup Set to Another Location
Copying a Backup Set to the Enterprise Server or Enterprise
Central Local Directory
Backup Set Import from WorkStation
Importing a Backup Set to an Enterprise Server or Enterprise
Central
Importing a Backup Set to SmartX Server
Automatic Purge of Backup Sets
Configuring Purge Settings on an Enterprise Server
Configuring Purge Settings on an Enterprise Central
Deleting a Backup Set from an Enterprise Server or
Enterprise Central
 66 Backup Sets
66.1 Backup Sets

66.1 Backup Sets

Backup sets are compressed backup files used for restoring data. The
EcoStruxure Building Operation software stores the local backup set for an
Enterprise Server or SmartX servers in the Local folder within the Backup sets
folder.

66.1.1 Backup Sets Location

Backup sets are stored in different locations for stand-alone systems and multi-
server systems.
For more information, see section 66.2 “Location of Backup Sets” on page 1845.

66.1.2 Backup Sets and Server Name

The EcoStruxure Building Operation software associates each backup set with a
particular EcoStruxure BMS server name. Therefore, you should not rename an
EcoStruxure BMS server unless absolutely necessary. If you do rename an
EcoStruxure BMS server, the previous backup sets do not display in the Restore
Options dialog box. You can view all the backup sets that are stored locally on
an Enterprise Server. For more information, see section 66.4 “Locating the Local
Backup Path on the Enterprise Server or Enterprise Central” on page 1849.

NOTICE
Going forward, you must create new backups for the renamed EcoStruxure
BMS server.

66.1.3 Backup Set Storage and Protection

EcoStruxure BMS servers store backup sets in their local directories. By design,
the average user may not easily locate these backup directories using a
Windows-based file system. For convenience, you can save backup sets stored
on EcoStruxure BMS servers to WorkStation. After saving the backup set, you
can also copy the file to another backup storage location.
For more information, see section 66.3 “Backup Set Storage and Protection” on
page 1847.

66.1.4 Backup Set Import from WorkStation

You import a backup set from WorkStation to replace a lost or incomplete
backup set, or to add a backup set to a new EcoStruxure BMS server.
For more information, see section 66.8 “Backup Set Import from WorkStation” on
page 1853.

04-30005-01-en, May 2019 System

1843
66 Backup Sets
66.1 Backup Sets

66.1.5 Automatic Purge of Backup Sets

An Enterprise Server stores multiple local and remote backup sets. As a result,
these sets can consume much needed space on the Enterprise Server. To
resolve this problem, you can configure the Enterprise Server to remove
outdated backup sets.
For more information, see section 66.11 “Automatic Purge of Backup Sets” on
page 1857.

System 04-30005-01-en, May 2019

1844
 66 Backup Sets
66.2 Location of Backup Sets

66.2 Location of Backup Sets

Backup sets are stored in different locations for stand-alone systems and multi-
server systems.

66.2.1 Multi Server System

In a multi-server system with an Enterprise Server and one or more SmartX
servers, the backup sets are stored on the computer that runs the Enterprise
server. The SmartX server also store its own backup set.
In a multi-server system with an Enterprise Central and one or more attached
Enterprise Servers, the backup sets for the Enterprise Central are stored on the
computer running the Enterprise Central. The backup sets for the attached
Enterprise Servers are stored on the computers running the Enterprise Servers.
Using WorkStation, you can copy the backup set to a location other than the
EcoStruxure BMS server.
For more information, see section 66.7 “Copying a Backup Set to the Enterprise
Server or Enterprise Central Local Directory” on page 1852.
In the Backup sets folder of the installation directory, two directories are created:
• AS Archives
Archives: Lists separate subfolders that reflect the name of each
SmartX server. Each subfolder contains the backup files for that SmartX
server.
• Local
Local: Lists all the local backup files for the Enterprise Server and
Enterprise Central.

Figure: Location of backup sets

66.2.2 Stand-alone System

In a stand-alone system the backup set is saved in the Smart Struxure server
device. Using WorkStation, you can save the backup set to a location other than
the SmartX server.
For more information, see section 66.6 “Saving a SmartX Server Backup Set to
Another Location” on page 1851.

04-30005-01-en, May 2019 System

1845
66 Backup Sets
66.2 Location of Backup Sets

The SmartX server stores only one backup set at a time, so each new backup
operation overwrites the previous backup set.

System 04-30005-01-en, May 2019

1846
 66 Backup Sets
66.3 Backup Set Storage and Protection

66.3 Backup Set Storage and Protection

EcoStruxure BMS servers store backup sets in their local directories. By design,
the average user may not easily locate these backup directories using a
Windows-based file system. For convenience, you can save backup sets stored
on EcoStruxure BMS servers to WorkStation. After saving the backup set, you
can also copy the file to another backup storage location.
Saving a backup set to a storage location is a two-step process: saving the
backup set and then relocating the file to another location. First, you save the
backup set to WorkStation. Second, you copy the backup set from WorkStation
to another storage location on your network, such as a USB drive.

Figure: Copy backup set from a SmartX server to a network drive

Uniquely Named Storage Directory

To save time, you can create a uniquely named directory in which to store your
saved backup sets for a particular EcoStruxure BMS server. This unique folder
name can help you identify a particular Enterprise Server or SmartX server
backup set, such as AS-1 Final Configuration Backup. Using this method, you
can easily locate the backup set on your network.

Backup Set Renaming

Scheduled backup sets have a unique file name and extension based on the
date stamp and server name. However, you can rename the backup set, if
necessary. For more information, see section 67.1 “Scheduled Backups” on
page 1863.

04-30005-01-en, May 2019 System

1847
66 Backup Sets
66.3 Backup Set Storage and Protection

Backup Set Removal

You can remove backups sets in two ways:
• Manually: You can delete backups sets using a browser. For more
information, see section 66.14 “Deleting a Backup Set from an Enterprise
Server or Enterprise Central” on page 1860.
• Periodically: You can configure the system to remove backup sets on a
regular basis. For more information, see section 66.11 “Automatic Purge of
Backup Sets” on page 1857.

System 04-30005-01-en, May 2019

1848
 66 Backup Sets
66.4 Locating the Local Backup Path on the Enterprise Server or Enterprise Central

66.4 Locating the Local Backup Path on the

Enterprise Server or Enterprise Central
You locate the local backup folder on the Enterprise Server or Enterprise Central
to view the stored backup sets. The system displays the valid backup sets
stored in this folder in the Restore Options dialog box.
For more information, see section 66.3 “Backup Set Storage and Protection” on
page 1847.

To locate a local backup path on the Enterprise Server or

Enterprise Central
1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central you want to configure.
2. Click the Control Panel tab.
3. Click Backup and restore manager
manager.
4. In the Backup sets path box, view the local backup path on the Enterprise
server.

04-30005-01-en, May 2019 System

1849
66 Backup Sets
66.5 Saving an Enterprise Server or Enterprise Central Backup Set to Another Location

66.5 Saving an Enterprise Server or

Enterprise Central Backup Set to
Another Location
You save a backup set from an Enterprise Server or Enterprise Central to
another location, for example, a network drive or a USB memory.
For more information, see section 66.3 “Backup Set Storage and Protection” on
page 1847.

To save an Enterprise Server or Enterprise Central backup set

to another location
1. On the Tools menu, select Control Panel
Panel.
2. On the Control Panel toolbar, select the Enterprise Server or Enterprise
Central.
3. Click Backup Sets
Sets.
4. In the List View
View, open the Local folder.
5. Select the Enterprise Server backup set that you want to save to a different
location.
6. On the Actions menu, click Save to
to.
7. In the Save As dialog box, enter a storage location and click Save
Save.
8. Click Close
Close.

System 04-30005-01-en, May 2019

1850
 66 Backup Sets
66.6 Saving a SmartX Server Backup Set to Another Location

66.6 Saving a SmartX Server Backup Set to

Another Location
You save a backup set from a SmartX server to another location so you can store
the backup set on, for example, a network drive or a USB memory.

To save a SmartX server backup set to another location

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel toolbar, select the EcoStruxure BMS server.
3. Click Backup Sets
Sets.
4. In the List View
View, open the Local folder for a SmartX server or the AS
Archives folder for an Enterprise Server.
5. If connected to the Enterprise Server, open the SmartX server folder that
contains the backup set.
6. Select the backup set that you want to save to a different location.
7. On the Actions menu, click Save To
To.
8. In the Save As dialog box, enter a storage location and click Save
Save.
9. Click Close
Close.

04-30005-01-en, May 2019 System

1851
66 Backup Sets
66.7 Copying a Backup Set to the Enterprise Server or Enterprise Central Local Directory

66.7 Copying a Backup Set to the Enterprise

Server or Enterprise Central Local
Directory
You copy a backup set to the Local (db_backup) folder to restore the targeted
Enterprise Server or Enterprise Central.
For more information, see section 66.3 “Backup Set Storage and Protection” on
page 1847.

To copy a backup set to the Enterprise Server or Enterprise

Central local directory
1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central you want to configure.
2. Click the Control Panel tab.
3. Click Backup and Restore Manager
Manager.
4. In the Backup sets path box, copy the entire backup sets path of the
Enterprise Server or Enterprise Central.
5. Open a browser, such as Windows Explorer.
6. In the browser Address box, paste the backup sets path and press Enter
Enter.
7. In the db_backup folder, open the LocalBackup folder.
8. Right click the backup set that you want to copy and click Copy
Copy.
9. Navigate to the db_backup folder of the Enterprise Server that you want to
restore.
10. Paste the backup set into the LocalBackup folder of the targeted
Enterprise Server.

NOTICE
If the LocalBackup folder does not appear within the db_backup folder,
you can create one using the exact name, LocalBackup
LocalBackup.

You can now restore the Enterprise Server or Enterprise Central using this
backup set. For more information, see section 68.3 “Restoring the EcoStruxure
BMS Server” on page 1880.

System 04-30005-01-en, May 2019

1852
 66 Backup Sets
66.8 Backup Set Import from WorkStation

66.8 Backup Set Import from WorkStation

You import a backup set from WorkStation to replace a lost or incomplete
backup set, or to add a backup set to a new EcoStruxure BMS server. The
EcoStruxure Building Operation software stores a local backup set for an
Enterprise Server or SmartX servers under the Local folder in the Backup Sets
folder. However, the system handles the storage of backup sets based on the
type of EcoStruxure BMS server. For example, a SmartX server stores only one
backup set at a time. Therefore, the system overwrites the previous backup file
with the latest file. If there is no file present, the EcoStruxure Building Operation
software adds the backup set to the Local folder.
In a multi-server system with an Enterprise server and SmartX servers, the
Enterprise Server retrieves and stores the latest backup set for each SmartX
server in a separate directory in the Backup Sets folder. In addition, the system
can store several backup sets for each SmartX server as well as multiple backup
sets for the Enterprise Server.
In a multi-server system with an Enterprise Central, the Enterprise Central does
not retrieve and store the backup set for each Enterprise Server on the computer
that runs the Enterprise Central. When you restore an Enterprise Server from an
Enterprise Central, you use the backup sets that are stored on the computers
running the Enterprise Servers.

NOTICE
When you back up the Enterprise Servers from an Enterprise Central, the
SmartX servers that are attached to the Enterprise Servers are not backed up.
To make a backup of Smart X server you start by backing up the Smart X
servers using the Enterprise Servers. When that is done, you back up all the
Enterprise Servers using the Enterprise Central.

Figure: Import backup set from WorkStation to a SmartX servers or Enterprise Server

04-30005-01-en, May 2019 System

1853
66 Backup Sets
66.8 Backup Set Import from WorkStation

Importing is a three-step process: logging onto the EcoStruxure BMS server,

importing the file, and then restoring the EcoStruxure BMS server. First, you log
onto an EcoStruxure BMS server in WorkStation. You then import the selected
backup set from a network storage area. Finally, you restore the EcoStruxure
BMS server.
You can only restore an EcoStruxure BMS server using a backup set that was
created with the same software version on the same EcoStruxure BMS server
(including service pack). To help identify the usable backup sets, the system
displays the compatible files in black text and the incompatible files in red text. If
you select an incompatible backup set to restore an EcoStruxure BMS server, no
backup set displays after importing.

System 04-30005-01-en, May 2019

1854
 66 Backup Sets
66.9 Importing a Backup Set to an Enterprise Server or Enterprise Central

66.9 Importing a Backup Set to an Enterprise

Server or Enterprise Central
You import a backup set from a network storage location to restore an Enterprise
Server or Enterprise Central, or to replace a lost or damaged backup set.
For more information, see section 66.8 “Backup Set Import from WorkStation” on
page 1853.

To import a backup set to an Enterprise Server or Enterprise

Central
1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central.
2. On the Actions menu, click Restore
Restore.
3. In the Restore Options dialog box, click Import Backup Set
Set.
4. Select a backup set that is stored on a file system and click Open
Open.
5. Click Yes if you want to replace an existing backup set.
6. Click Close
Close.
You can now restore the Enterprise Server or Enterprise Central with the
imported backup set.

04-30005-01-en, May 2019 System

1855
66 Backup Sets
66.10 Importing a Backup Set to SmartX Server

66.10 Importing a Backup Set to SmartX

Server
You import a backup set from a network storage location to restore a
replacement SmartX server, or to replace a lost or damaged backup set.
For more information, see section 66.8 “Backup Set Import from WorkStation” on
page 1853.

To import a backup set to SmartX server

1. Log on to the SmartX server to which you want to import a backup set.
2. In WorkStation, in the System Tree pane, select the SmartX server.
3. On the Actions menu, click Restore
Restore.
4. In the Restore Options dialog box, click Import Backup Set
Set.
5. In the Confirm Replace dialog box, click OK
OK.
6. Select a valid backup set that is stored on a file system and click Open
Open.
7. Click Close
Close.
You can now restore the SmartX server with the imported backup set.

System 04-30005-01-en, May 2019

1856
 66 Backup Sets
66.11 Automatic Purge of Backup Sets

66.11 Automatic Purge of Backup Sets

An Enterprise Server or Enterprise Central stores multiple local and remote
backup sets. These sets can consume much needed space on the computer
running the Enterprise Server or Enterprise Central. To resolve this problem, you
can configure the Enterprise Server or Enterprise Central to remove outdated
backup sets.
You configure purge settings on an Enterprise Server, rather than SmartX
servers. For more information, see section 69.4 “Backup and Restore Manager
on the Enterprise Server” on page 1898.
In a multi-server system with an Enterprise Central, you configure the purge
settings on both the Enterprise Central and the Enterprise Servers.

Purge Configuration on an Enterprise Server or an Enterprise

Central
You can set the maximum number of local and remote backups that you want to
store at a given time on the Enterprise Server or the Enterprise Central. The
system compares two values:
• the maximum number that you configured for the Enterprise Server or the
Enterprise Central
• the date stamp on each stored backup
Whenever a new backup is created, the most recent backup set replaces the
most outdated backup set. In other words, the system adds a file and then
deletes the oldest file to maintain the maximum number that you configured for
the Enterprise server or the Enterprise Central.

Local and Remote Purge Settings

You can manage automatic purging on an Enterprise Server or an Enterprise
Central by configuring a maximum number of files to store. There are two purge
settings:
• Local setting for the Enterprise Central or Enterprise Server: The local
setting, Number of local backup sets to store
store, manages the backups
stored on an Enterprise Central or Enterprise Server.
• Global setting for SmartX servers: The global setting, Number of AS backup
sets to store
store, manages all the backups stored on the SmartX servers. You
cannot configure each SmartX server separately because the global setting
affects all the SmartX servers created under the Enterprise Server.
You can vary the number of local and remote backup sets that you store. For
example, you can configure the system to store a maximum of five local backup
sets for the Enterprise Server and two remote backup sets for each SmartX
server.

Enable/Disable Automatic Purging

By default, the EcoStruxure Building Operation software enables automatic
purging for both local (Enterprise Server and Enterprise Central) and remote
(SmartX servers) backup sets. However, you can disable this feature to ensure
that all manual and scheduled backup sets are automatically stored on the
Enterprise Server or Enterprise Central. For more information, see section 69.4
“Backup and Restore Manager on the Enterprise Server” on page 1898.

04-30005-01-en, May 2019 System

1857
66 Backup Sets
66.12 Configuring Purge Settings on an Enterprise Server

66.12 Configuring Purge Settings on an

Enterprise Server
You purge outdated backup sets to help reduce the resource constraints on an
Enterprise Server. You cannot configure these settings on a SmartX server.
For more information, see section 66.11 “Automatic Purge of Backup Sets” on
page 1857.

To configure purge settings on an Enterprise Server

1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central you want to configure.
2. Click the Control Panel tab.
3. In the Backup and archiving area, click Backup and restore manager
manager.
4. In the Number of Automation Server backup sets to store box, enter the
maximum number of backups that the Enterprise Server can store for each
SmartX server.
5. In the Number of local backup sets to store box, enter the maximum
number of backup sets that the system can store for the Enterprise Server.
6. On the File menu, click Save
Save.

System 04-30005-01-en, May 2019

1858
 66 Backup Sets
66.13 Configuring Purge Settings on an Enterprise Central

66.13 Configuring Purge Settings on an

Enterprise Central
You purge outdated backup sets to help reduce the resource constraints on an
Enterprise Central.
For more information, see section 66.11 “Automatic Purge of Backup Sets” on
page 1857.

To configure purge settings on an Enterprise Central

1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel toolbar, select the Enterprise Central.
3. In the Backup and archiving area, click Backup and Restore Manager
Manager.
4. In the Number of local backup sets to store box, enter the maximum
number of backups that the Enterprise Central can store.

5. Click the Save button .

04-30005-01-en, May 2019 System

1859
66 Backup Sets
66.14 Deleting a Backup Set from an Enterprise Server or Enterprise Central

66.14 Deleting a Backup Set from an

Enterprise Server or Enterprise Central
You delete a backup set from the db_backup folder of the Enterprise Server or
Enterprise Central when you no longer need the backup set.
For more information, see section 66.1 “Backup Sets” on page 1843.

To delete a backup set from the Enterprise Server or

Enterprise Central
1. In WorkStation, in the System Tree pane, select the Enterprise Server or
Enterprise Central you want to configure.
2. Click the Control Panel tab.
3. Click Backup and Restore Manager
Manager.
4. In the Backup and Restore Manager
Manager, in the Backup sets path box, copy
the entire backup sets path of the Enterprise Server.
5. Open a browser, such as Windows Explorer.
6. In the browser Address box, paste the backup sets path and press Enter
Enter.
7. In the db_backup folder, open the ASArchives or LocalBackup folder.
8. Right-click on the backup set that you want to delete and click Delete
Delete.
9. Click Yes to remove the backup set.

System 04-30005-01-en, May 2019

1860
67 Scheduled Backups

Topics
Scheduled Backups
Backup Rules
Creating a Backup Rule
Editing a Backup Rule
Deleting a Backup Rule
Removing a Lead Rule from a Backup Rule
Backup Schedules
Editing a Backup Schedule
Synchronized Backups
Synchronizing EcoStruxure BMS Server Backups on a
Network
 67 Scheduled Backups
67.1 Scheduled Backups

67.1 Scheduled Backups

A scheduled backup is an automated way to back up data on an EcoStruxure
BMS server. You can back up EcoStruxure BMS servers individually using each
EcoStruxure BMS server’s local backup rule. You can also use backup rules to
synchronize the backups of all the EcoStruxure BMS servers on your network.
As part of the scheduled backup process, EcoStruxure Building Operation
software automatically generates unique file names and extensions based on
the UTC date stamp and version number. However, you can change the file
name after the automatic backup is completed. You can also enter a unique file
name when you back up an EcoStruxure BMS server manually. For more
information, see section 65.5 “Manual Backups” on page 1832.

Figure: Backup on an Enterprise Server

67.1.1 Backup Rules

The EcoStruxure Building Operation scheduled backups are managed by
backup rules, which are conditions that govern behavior. Similar to a scheduled
task, a backup rule performs a backup on an EcoStruxure BMS server using
three pieces of data: when the backup occurs, what type of data will be backed
up, and a comment describing the purpose of the backup.

04-30005-01-en, May 2019 System

1863
67 Scheduled Backups
67.1 Scheduled Backups

For more information, see section 67.2 “Backup Rules” on page 1865.

67.1.2 Backup Schedules

The EcoStruxure Building Operation database includes a digital schedule that is
combined with a default backup rule. Using this schedule and rule, the system
automatically backs up all data on an EcoStruxure BMS server every Sunday at
01:00. You can change the schedule settings for this backup rule, but you
cannot delete the schedule and select another.
For more information, see section 67.7 “Backup Schedules” on page 1870.

67.1.3 Synchronized Backups

A synchronized backup is a method of performing a recurring, simultaneous
backup of a selected number of EcoStruxure BMS servers. You can use a lead
and shadow relationship to automate all the EcoStruxure BMS server backups
on your network. Using this method, you configure and manage one lead
backup rule on one EcoStruxure BMS server, which other backup rules can
reference.
For more information, see section 67.9 “Synchronized Backups” on page 1872.

System 04-30005-01-en, May 2019

1864
 67 Scheduled Backups
67.2 Backup Rules

67.2 Backup Rules

The EcoStruxure Building Operation scheduled backups are managed by
backup rules, which are conditions that govern behavior. Similar to a scheduled
task, a backup rule performs a backup on an EcoStruxure BMS server using
three pieces of data: when the backup occurs, what type of data will be backed
up, and a comment describing the purpose of the backup.
The EcoStruxure Building Operation software automatically backs up all data on
an EcoStruxure BMS server every Sunday at 01:00. However, you can change
the backup rule settings. For example, you can change the type of data you
want to back up.
You can create your own backup rules to complete different tasks on different
EcoStruxure BMS servers. For example, you can create a backup rule that
backs up all data on the Enterprise Server twice a day rather than once a week
based on the default setting. In addition, you can set up another backup rule for
one EcoStruxure BMS server, which acts as the lead, to manage a recurring
backup for a group of EcoStruxure BMS servers. For more information, see
section 69.9 “Backup Rules View” on page 1905.

04-30005-01-en, May 2019 System

1865
67 Scheduled Backups
67.3 Creating a Backup Rule

67.3 Creating a Backup Rule

You create a backup rule on an EcoStruxure BMS server to schedule periodic
backups. You can also set up this backup rule to follow a shadow schedule that
references a lead schedule managed on another EcoStruxure BMS server.
For more information, see section 67.2 “Backup Rules” on page 1865.

To create a backup rule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Backup rules
rules.

4. In the Backup rules, click the Add backup rule button .

5. In the Create Object wizard, in the Name box, type a name for the backup
rule.
6. In the Description box, type a description for the backup rule and click
Next
Next.
7. In the Configure Backup Rule page, in the Backup set description box,
type a comment up to 255 characters to help identify the content of the
backup.
8. In the Backup content box, select the type of data you want to back up:
• Select Configuration only to back up the configuration database and
custom object type data. For example, use this option to restore data
to a replaced server with the same name in the system.
• Select All data to back up the configuration, historical, and custom
object type data. For example, use this option to preserve the
configuration and historical data for a specified date and time.
9. In the Lead rule box, enter a backup rule that references a lead schedule
managed on another EcoStruxure BMS server.
10. In the Enabled box, select Yes to enable the backup rule.
11. Click Create
Create.

System 04-30005-01-en, May 2019

1866
 67 Scheduled Backups
67.4 Editing a Backup Rule

67.4 Editing a Backup Rule

You edit a backup rule on an EcoStruxure BMS server to change the type of data
that you want to back up. You can also set up this backup rule to follow a
shadow schedule that references a lead schedule managed on another
EcoStruxure BMS server.
For more information, see section 67.2 “Backup Rules” on page 1865.

To edit a backup rule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Backup rules
rules.
4. In the Backup rules view, select a backup rule and then click the Edit

backup rule button .

5. In the Backup rule dialog box, in the Backup set description box, type or
modify the backup comment.
6. In the Backup content box, change the type of data you want to back up:
• Select Configuration only to back up the configuration database and
custom object type data. For example, use this option to restore data
to a replaced EcoStruxure BMS server with the same name in the
system.
• Select All data to back up the configuration, historical, and custom
object type data. For example, use this option to preserve the
configuration and historical data for a specified date and time.
7. In the Lead rule box, enter a backup rule that references a lead schedule
managed on another EcoStruxure BMS server.
8. In the Enabled box, select Yes to enable the backup rule.
9. Click OK
OK.
10. On the File menu, click Save
Save.

04-30005-01-en, May 2019 System

1867
67 Scheduled Backups
67.5 Deleting a Backup Rule

67.5 Deleting a Backup Rule

You delete a backup rule to remove the rule from the EcoStruxure BMS server.
For more information, see section 67.2 “Backup Rules” on page 1865.

To delete a backup rule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Backup Rules
Rules.
4. In the Backup rules view, select the backup rule and then click the

Remove backup rule button .

5. Click Yes to delete the backup rule from the EcoStruxure BMS server.
6. On the File menu, click Save
Save.

System 04-30005-01-en, May 2019

1868
 67 Scheduled Backups
67.6 Removing a Lead Rule from a Backup Rule

67.6 Removing a Lead Rule from a Backup

Rule
You remove the lead and shadow relationship from an EcoStruxure BMS server
by deleting the lead rule reference.
For more information, see section 67.2 “Backup Rules” on page 1865.

To remove a lead rule from a backup rule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. In the Backup and Archiving area, click Backup rules
rules.
4. In the Backup rules view, select the backup rule and click the Edit backup

rule button .
5. In the Backup Rule dialog box, in the Lead rule box, delete the lead
backup rule, which removes the lead and shadow relationship for the
selected EcoStruxure BMS server.
6. Click OK
OK.
7. On the File menu, click Save
Save.

04-30005-01-en, May 2019 System

1869
67 Scheduled Backups
67.7 Backup Schedules

67.7 Backup Schedules

The EcoStruxure Building Operation database includes a digital schedule that is
combined with a default backup rule. Using this schedule and rule, the system
automatically backs up all data on an EcoStruxure BMS server every Sunday at
01:00. You can change the schedule settings for this backup rule, but you
cannot delete the schedule and select another.

NOTICE
If the automatically scheduled backup occurs during a Daylight Savings Time
transition, the backup will not occur. To prevent loss of data, change the
scheduled backup to a time that does not conflict with your region's Daylight
Savings Time transition.

Figure: Backup on a standalone SmartX server

You can create a custom backup rule and then modify its schedule. For
example, you can create a backup rule that backs up all data on a SmartX
server daily at 02:00. For more information, see section 69.9 “Backup Rules
View” on page 1905.

System 04-30005-01-en, May 2019

1870
 67 Scheduled Backups
67.8 Editing a Backup Schedule

67.8 Editing a Backup Schedule

You edit a backup schedule, which is combined with a backup rule, to change
the frequency of the backup.
For more information, see section 67.7 “Backup Schedules” on page 1870.

To edit a backup schedule

1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Backup rules
rules.
4. In the Backup Rules view, in the Schedule column, click the schedule that
you want to modify.

5. Revise the schedule and then click the Save button .

04-30005-01-en, May 2019 System

1871
67 Scheduled Backups
67.9 Synchronized Backups

67.9 Synchronized Backups

A synchronized backup is a method of performing a recurring, simultaneous
backup of a selected number of EcoStruxure BMS servers. You can use a lead
and shadow relationship to automate all the EcoStruxure BMS server backups
on your network. Using this method, you configure and manage one lead
backup rule on one EcoStruxure BMS server, which other backup rules can
reference.

Figure: Synchronized recurring backup – Lead/Shadow method

The system synchronizes all the shadow rules with the lead backup rule, and all
the shadow schedules with the lead schedule. For more information, see section
67.10 “Synchronizing EcoStruxure BMS Server Backups on a Network” on page
1873.

System 04-30005-01-en, May 2019

1872
 67 Scheduled Backups
67.10 Synchronizing EcoStruxure BMS Server Backups on a Network

67.10 Synchronizing EcoStruxure BMS Server

Backups on a Network
You synchronize all EcoStruxure BMS server backups to increase efficiency by
centralizing the automated backup management on a single EcoStruxure BMS
server, rather than across multiple EcoStruxure BMS servers.
For more information, see section 67.9 “Synchronized Backups” on page 1872.

To synchronize EcoStruxure BMS server backups on a

network
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Backup Rules
Rules.
4. In the Lead rule column, enter a backup rule that you want to use as the
lead rule for one or more EcoStruxure BMS servers in the list.

NOTICE
When you select a lead rule, the backup rule on an EcoStruxure BMS
server becomes a shadow of the lead rule.

5. Click the Save button .

04-30005-01-en, May 2019 System

1873
68 Restore

Topics
Restore
Restored Data
Restoring the EcoStruxure BMS Server
Restoring a SmartX Server from the Enterprise Server
Restoring an Enterprise Server from the Enterprise Central
SmartX Server Replacement Using Restore
SmartX Server Replacement Using Restore Workflow
Duplicate SmartX Server from a Backup Set
Duplicating a SmartX Server Using Restore
 68 Restore
68.1 Restore

68.1 Restore
Restore is the process of restoring data to an original or former state. Using
Restore, you can revert to a previous snapshot of the EcoStruxure BMS server
data despite any configuration changes made since the last backup. In the
EcoStruxure BMS, Restore is a manual process designed to avoid the
accidental overwriting of current EcoStruxure BMS server data.

68.1.1 Restored Data

Depending on what is contained in the backup file, you can restore different
types of data.
• Configuration only
only: the EcoStruxure Building Operation software restores
the configuration database and custom object type data. Any existing
historical data is lost when you select this option.
• All data
data: the EcoStruxure Building Operation software restores the
configuration, historical, and custom object types data.
For more information, see section 68.2 “Restored Data” on page 1878.

68.1.2 SmartX Server Replacement Using Restore

Backup and Restore assures that SmartX server data can be restored to a
replacement SmartX server in the event of hardware failure, or to the same
SmartX server in the event of data loss. As a precaution, you back up your
SmartX servers regularly so that you can use the most current backup to restore
the SmartX server data to a replacement SmartX server. You also configure the
new SmartX server to match the name and the network settings of the replaced
SmartX server so the system can identify this SmartX server when online.
For more information, see section 68.6 “SmartX Server Replacement Using
Restore” on page 1883.

68.1.3 Duplicate SmartX Server Using Restore

You can use the Restore function to re-use the configuration data from a backup
set in a new standalone SmartX server. Rather than manually configuring your
preferred SmartX server configuration, you can save time and configure the
standalone SmartX server from a backup set.
The backup set used can originate from a SmartX server that is or has been part
of a multi-server configuration.
For more information, see section 68.8 “Duplicate SmartX Server from a Backup
Set” on page 1887.

04-30005-01-en, May 2019 System

1877
68 Restore
68.2 Restored Data

68.2 Restored Data

Depending on what is contained in the backup file, you can restore different
types of data.
• Configuration only
only: the EcoStruxure Building Operation software restores
the configuration database and custom object type data. Any existing
historical data is lost when you select this option.
• All data
data: the EcoStruxure Building Operation software restores the
configuration, historical, and custom object types data.

Table: Types of Data and Content

Types of Data Content

Historical Includes Trend logs and Event logs stored on the EcoStruxure
BMS server.

Configuration Includes points, values, alarm objects, trend objects, programs,

graphics, and custom object type data stored on the EcoStruxure
BMS server.
Includes the configuration properties of variables, such as Unit.
Depending on the retain level of the variable; some configuration
properties like Value are also restored.

The EcoStruxure BMS server name is part of the restore data. Therefore, if you
rename the EcoStruxure BMS server after a backup, a restore process will revert
back to the previous EcoStruxure BMS server name.

Impact on Configuration Values and Variables

When you back up the EcoStruxure BMS server specifying either Configuration
only or All data, Building Operation includes all the configuration values that are
specified for the EcoStruxure BMS server’s objects. If you restore the
EcoStruxure BMS server, Building Operation restores these configuration
values, which can overwrite any changes made since the last backup.
Building Operation does not include most variable settings in a backup.
Consequently, Building Operation cannot restore these variable settings.
However, the system does back up the cold-start retained variables.

Restore from the SmartX server

When you restore the SmartX server locally, the system retrieves the current
master backup set for that SmartX server. However, you cannot select a
particular backup set because the SmartX server stores only one backup set at
a time.

Restore from an Enterprise Server

Unlike the SmartX server, the Enterprise Server can store multiple local and non-
local backup sets. When you restore the Enterprise Server, you can select a
local backup set from a list of files to restore the Enterprise Server. In multiple
server sites, the Enterprise Server manages all the SmartX servers in its group.
In this configuration, the non-local backup sets are stored in separate folders for
each SmartX server.

System 04-30005-01-en, May 2019

1878
 68 Restore
68.2 Restored Data

When you restore the SmartX server from the Enterprise Server, you can select a
particular backup set from a list of files that are stored for that SmartX server.
This restore method provides greater flexibility. For more information, see
section 68.4 “Restoring a SmartX Server from the Enterprise Server” on page
1881.

Restore from an Enterprise Central

The Enterprise Central can store multiple local and non-local backup sets. When
you restore the Enterprise Central, you can select a local backup set from a list
of files to restore the Enterprise Central.

Restore status
The EcoStruxure BMS server properties indicate if a restore was performed:
• Enterprise Server. For more information, see the Enterprise Server
Properties – Basic Tab topic on WebHelp.
• SmartX server. For more information, see the SmartX Server Properties –
Basic Tab topic on WebHelp.

04-30005-01-en, May 2019 System

1879
68 Restore
68.3 Restoring the EcoStruxure BMS Server

68.3 Restoring the EcoStruxure BMS Server

You restore the EcoStruxure BMS server to revert back to a previous snapshot of
the EcoStruxure BMS server data.
For more information, see section 68.1 “Restore” on page 1877.

NOTICE
If your system includes the Reports Server and the Enterprise Server or
Enterprise Central, stop the Reporting Agent service on the Reports Server
first to prevent report generation during a restore of the Enterprise Server or
Enterprise Central. For more information, see the Stopping the Reporting
Agent Windows Service topic on WebHelp.

To restore the EcoStruxure BMS server

1. Stop the Reporting Agent service on the Reports Server. For more
information, see the Stopping the Reporting Agent Windows Service topic
on WebHelp.
2. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server that you want to restore.
3. On the Actions menu, click Restore
Restore.

NOTICE
Take manual control of any output points that could potentially damage
equipment before restoring the EcoStruxure BMS server. If you cannot
disconnect the physical outputs, restore the EcoStruxure BMS server
using a trusted restore file that will turn off/on the outputs predictably and
safely.

4. In the Restore Options dialog box, in the Available restore points list,
select a backup set in black text, which indicates that the backup set is
compatible with the current version of the EcoStruxure BMS server.
5. Select the type of data you want to restore:
• Select Configuration only to restore only configuration and custom
object types' data.
• Select All data to restore the configuration, historical, and custom
object types data.
6. Click Restore
Restore.
7. Click Yes
Yes.
8. Click Close
Close.
If your system includes the Reports Server, the Reporting Agent Windows
service restarts automatically.

System 04-30005-01-en, May 2019

1880
 68 Restore
68.4 Restoring a SmartX Server from the Enterprise Server

68.4 Restoring a SmartX Server from the

Enterprise Server
You log on to an Enterprise Server to restore a SmartX server.
For more information, see section 68.1 “Restore” on page 1877.

To restore a SmartX server from the Enterprise Server

1. In WorkStation, in the System Tree pane, select the SmartX server that you
want to restore.
2. On the Actions menu, click Restore
Restore.

NOTICE
Take manual control of any output points that could potentially damage
equipment before restoring the SmartX server. If you cannot disconnect
the physical outputs, restore the SmartX server using a trusted restore file
that will turn off/on the outputs predictably and safely.

3. In the Restore Options dialog box, in the Available restore points list,
select a backup set in black text, which indicates that the backup set is
compatible with the current version of the SmartX server.
4. Select the type of data you want to restore:
• Select Configuration only to back up only configuration and custom
object types data.
• Select All data (Configuration and Historical) to back up the
configuration, historical, and custom object types data.
5. Click Restore
Restore.
6. Click Yes
Yes.
7. Click Close
Close.

NOTICE
After a restore, WorkStation may display several SmartX server events in
the Events pane that occurred while the restore was taking place.
However, these events are not part of the restored log data.

04-30005-01-en, May 2019 System

1881
68 Restore
68.5 Restoring an Enterprise Server from the Enterprise Central

68.5 Restoring an Enterprise Server from the

Enterprise Central
You log on to an Enterprise Central to restore an Enterprise Server.
For more information, see section 68.1 “Restore” on page 1877.

Restoring an Enterprise Server from the Enterprise Central

1. In WorkStation, in the System Tree pane, select the Enterprise Server that
you want to restore.
2. On the Actions menu, click Restore
Restore.
3. In the Restore Options dialog box, in the Available restore points list,
select a backup set in black text, which indicates that the backup set is
compatible with the current version of the Enterprise Server.
4. Select the type of data you want to restore:
• Select Configuration only to back up only configuration and custom
object types data.
• Select All data (Configuration and Historical) to back up the
configuration, historical, and custom object types data.
5. Click Restore
Restore.
6. Click Yes
Yes.
7. Click Close
Close.

System 04-30005-01-en, May 2019

1882
 68 Restore
68.6 SmartX Server Replacement Using Restore

68.6 SmartX Server Replacement Using

Restore
Backup and Restore assures that SmartX server data can be restored to a
replacement SmartX server in the event of hardware failure, or to the same
SmartX server in the event of data loss. As a precaution, you back up your
SmartX servers regularly so that you can use the most current backup to restore
the SmartX server data to a replacement SmartX server. You also configure the
new SmartX server to match the name and the network settings of the replaced
SmartX server so the system can identify this SmartX server when online.

Supported cases of SmartX server replacements

The following cases of SmartX server replacements are supported using restore:
• Replacing a SmartX server with a SmartX server of the same SmartX server
type
• Replacing Automation Server with a SmartX AS-P server
To replace Automation Server with a SmartX AS-P server, you first need to install
the server software on the new SmartX AS-P server before you can restore the
configuration data and historical data from the replaced Automation Server. For
more information, see the Uploading and Upgrading a SmartX Server topic on
WebHelp.

NOTICE
If you replace an Automation Server with a SmartX AS-P server, consider the
difference in RS-485 bias voltage between the two servers to avoid decreased
performance and reliability of the RS-485 network. For more information, see
the RS-485 Communications topic on WebHelp.

NOTICE
You can reuse an Automation Server terminal base (TB-AS-W1) for a SmartX
AS-P server module by removing the terminal block at the top of the terminal
base.

SmartX server names

Typically, SmartX servers and WorkStations can acquire different identifiers and
user-assigned names. For example, SmartX server has a network identifier, AS-
000E00, which is used internally but is difficult to remember. For convenience,
you can also assign a descriptive SmartX server name, such as Main Lobby-AS,
to locate this SmartX server in Building Operation. You may encounter these two
names during configuration.

Network Device Protocols

If your network uses static IP addresses or DNS server names, you need to
apply a valid IP address or fully qualified domain name to a replacement SmartX
server. Specifically, you use the static IP address or fully qualified domain name
to locate the new SmartX server on the network. To reconfigure the default
TCP/IP settings on the new SmartX server to match those of the replaced SmartX
servers, you use the Automation Server Web Configuration utility.

04-30005-01-en, May 2019 System

1883
68 Restore
68.6 SmartX Server Replacement Using Restore

If your network uses DHCP, a new SmartX server can automatically acquire
TCP/IP configuration information from a DHCP server. When acquired, you use
the fully qualified domain name rather than the IP address to locate the new
SmartX server on the network. By default, DHCP is turned off on SmartX servers.
To enable this and other network settings on the new SmartX server, you use the
Device Administrator. For more information, see the SmartX Server
Administration topic on WebHelp.

NOTICE
• Make sure that you have a valid SmartX server backup set before performing
a restore. A backup set can contain either configuration data only, or both
configuration and historical data.

Standalone SmartX server site

In a single SmartX server site, you log onto the SmartX server in WorkStation to
manage Backup and Restore operations. In this scenario, you need to have a
valid backup set to restore the SmartX server in case the hardware fails or data
is lost.
The SmartX server only stores one backup set at a time. Therefore, you should
create a backup set when the SmartX server is functioning properly and then
store this backup set in different location. You save and store a backup set on
your WorkStation PC or network drive. You then can import this backup set to the
SmartX server.

Multi-server Site
In a multi-server site, you can log onto an Enterprise Server in WorkStation to
manage backup and restore operations for all the SmartX servers in the group.
Unlike the SmartX server, which only stores one backup set at a time, the
Enterprise Server can store multiple backup sets for each SmartX server. From
the AS Archives folder, you can select a stored backup set that was created
when the SmartX server was functioning properly.
To store a backup set in another location, you save a selected backup set to a
folder on your WorkStation PC or network drive. You then log onto the new
SmartX server to import this backup set to the local directory. If you do not log
off from the Enterprise Server, the system uses the most current backup set
stored on the Enterprise Server hard drive instead of the newly imported file on
the SmartX server. Therefore, be sure to log onto the SmartX server before
restoring the SmartX server in WorkStation. For more information, see section
66.6 “Saving a SmartX Server Backup Set to Another Location” on page 1851.

68.6.1 SmartX Server Replacement Using Restore

Workflow
Use the workflow to duplicate the SmartX server from a backup set.
For more information, see section 68.7 “SmartX Server Replacement Using
Restore Workflow” on page 1885.

System 04-30005-01-en, May 2019

1884
 68 Restore
68.7 SmartX Server Replacement Using Restore Workflow

68.7 SmartX Server Replacement Using

Restore Workflow
Use the workflow to duplicate the SmartX server from a backup set.

Figure: Duplicate SmartX server using restore flowchart

Copy SmartX server Backup Set to WorkStation

Save the most current backup set of the SmartX server that you want to replace
to WorkStation.
For more information, see section 66.6 “Saving a SmartX Server Backup Set to
Another Location” on page 1851.

Add new SmartX server to network and configure communication

settings
Add the new SmartX server to the network and configure the IP address.
For more information, see the Configuring a SmartX Server to Use DHCP topic
on WebHelp.
For more information, see the Configuring the SmartX Server IP Address topic on
WebHelp.

Log on to SmartX server using WorkStation

For more information, see the Logging on to WorkStation as an EcoStruxure
Building Operation User topic on WebHelp.

04-30005-01-en, May 2019 System

1885
68 Restore
68.7 SmartX Server Replacement Using Restore Workflow

Import backup set

Import the backup set to the new SmartX server.
For more information, see section 66.10 “Importing a Backup Set to SmartX
Server” on page 1856.

Restore new SmartX server using the imported Backup Set

Restore the new SmartX server using the imported backup set.
For more information, see section 68.3 “Restoring the EcoStruxure BMS Server”
on page 1880.

NOTICE
If the SmartX server does not go online, you can manually recreate the SmartX
server or restore the connections between the Enterprise Server and the
SmartX server. For more information, see the SmartX Server Remains Offline
After Restore topic on WebHelp.

The Restore process automatically renames the SmartX server and specifies the
objects and properties that the SmartX server uses to reestablish links and go
online.

System 04-30005-01-en, May 2019

1886
 68 Restore
68.8 Duplicate SmartX Server from a Backup Set

68.8 Duplicate SmartX Server from a Backup

Set
You can use the Restore function to re-use the configuration data from a backup
set in a new standalone SmartX server. Rather than manually configuring your
preferred SmartX server configuration, you can save time and configure the
standalone SmartX server from a backup set.
The backup set used can originate from a SmartX server that is or has been part
of a multi-server configuration.
To store a backup set in another location, you save a selected backup set to a
folder on your WorkStation PC or network drive.
For more information, see section 66.1 “Backup Sets” on page 1843.

Protocol Compatibility
The restore function to re-use configuration data from a backup set is supported
for all protocols supported by EcoStruxure Building Operation software, except
for BACnet and b3 BACnet.

LonWorks Devices Neuron IDs deleted on duplicated SmartX server

The LonWorks devices connected to the SmartX server are not the same as the
LonWorks devices that are to be connected to the duplicate. When you create a
duplicate from a SmartX server, all Neuron IDs in the duplicate are deleted. This
is also a way to avoid network conflicts.
After you created the duplicate, you add new Neuron IDs to the duplicate. You
then commission all LonWorks devices on the new SmartX server.
For more information, see the LonWorks Device Workflows topic on WebHelp.

Password deleted on duplicated EcoStruxure BMS device

When you duplicate a SmartX device from a backup set all passwords are
deleted on the duplicate for security reasons. The only exception is the default
admin password. The administrator is forced to change the password at the first
logon at the duplicate. All users must be given new passwords by the
administrator.

Multi-server Site
To create a new SmartX server in a multi-server configuration, using a locally
stored backup set, you need to make the backup set available for restore on the
multi-server system. You add a new SmartX server to the Enterprise Server and
select the backup set in the Create Object Wizard.
For more information, see the Creating a SmartX Server from a Backup Set topic
on WebHelp.

Standalone SmartX Server Site

You use a locally stored backup set to duplicate another SmartX server
configuration in a standalone SmartX server. You then import the backup set to a
client and restore to the new standalone SmartX server.
For more information, see section 68.9 “Duplicating a SmartX Server Using
Restore ” on page 1890.

04-30005-01-en, May 2019 System

1887
68 Restore
68.8 Duplicate SmartX Server from a Backup Set

68.8.1 Duplicate SmartX Server from a Backup Set

Workflow
Use the following workflow to duplicate a SmartX server from a backup set.

Figure: Duplicate SmartX server using restore flowchart

Backup a SmartX server

Backup a SmartX server that has the configuration you want to use in the new
standalone SmartX server.
For more information, see section 65.7 “Backing Up EcoStruxure BMS Servers
Manually” on page 1835.

Copy backup set to local directory

Copy the backup set to a local directory.
For more information, see section 66.6 “Saving a SmartX Server Backup Set to
Another Location” on page 1851.

Log on to standalone SmartX server

Log on to a new standalone SmartX server.
For more information, see the Logging on to WorkStation as an EcoStruxure
Building Operation User topic on WebHelp.

Import backup set

Import the backup set.

System 04-30005-01-en, May 2019

1888
 68 Restore
68.8 Duplicate SmartX Server from a Backup Set

For more information, see section 66.10 “Importing a Backup Set to SmartX
Server” on page 1856.

Restore SmartX server using Restore configuration with new IDs

Use the Restore configuration with new IDs function to duplicate the
configuration data from the imported backup set in the new standalone SmartX
server. The communication settings from the backup set are not duplicated.
For more information, see section 68.9 “Duplicating a SmartX Server Using
Restore ” on page 1890.

NOTICE
When you restore a standalone SmartX server, you are logged off and need to
log on manually after the restore is complete.

04-30005-01-en, May 2019 System

1889
68 Restore
68.9 Duplicating a SmartX Server Using Restore

68.9 Duplicating a SmartX Server Using

Restore
You duplicate an EcoStruxure BMS server from a backup set using Restore
when you want to reuse configuration data from a backup set in a standalone
SmartX server.

NOTICE
The locally stored backup set and the SmartX server need to have the same
password.

For more information, see section 68.8 “Duplicate SmartX Server from a Backup
Set” on page 1887.

To duplicate a SmartX server using restore

1. In WorkStation, in the System Tree pane, select the server where you want
to duplicate configuration data from a backup set.
2. On the Actions menu, click Restore
Restore.
3. In the Restore Options dialog box, in the Available restore points list,
select the backup set.
4. Select Restore configuration with new IDs checkbox to re-use the
configuration data from the backup set in a new standalone SmartX server.
5. Click Restore
Restore.
6. Click Yes
Yes.
7. Click Close
Close.

System 04-30005-01-en, May 2019

1890
69 Backup and Restore User
Interface

Topics
Backup and Restore Manager Properties (Enterprise
Central) – Basic Tab
Backup and Restore Manager Properties (Enterprise
Server) – Basic Tab
Backup and Restore Manager Properties (SmartX
Servers) – Basic Tab
Backup and Restore Manager on the Enterprise Server
Backup and Restore Manager on a SmartX Server
Backup Options Dialog Box
Create Object Wizard – Configure Backup Rule Page
Backup Rule Properties – Basic Tab
Backup Rules View
Backup Rules Toolbar
Backup Rules List
Digital Schedule Properties – Basic Tab
Backup Set Properties – Basic Tab
Backup Sets View
Backup Status Dialog Box
Control Panel – Backup and Archiving
69 Backup Rule Dialog Box
Backup and Restore System Tree Icons
Restore Options Dialog Box
Restore Status Dialog Box
Backup and Restore Folder Properties
 69 Backup and Restore User Interface
69.1 Backup and Restore Manager Properties (Enterprise Central) – Basic Tab

69.1 Backup and Restore Manager

Properties (Enterprise Central) – Basic
Tab
Use the Basic tab to view the current backup and restore status of an Enterprise
Central. In addition, you can set the maximum number of local and remote
backup sets to store so the system can purge the outdated files.

Figure: Backup and Restore Manager properties for the Enteprise Central

Table: Backup and Restore Manager Properties (Enterprise Central) – Basic Tab
Component Description

Backup folder Displays the storage location of the

backup set.

Backup and restore status Displays the current status, such as

backing up.

Last backup Displays the date and time of the last

successful backup.

Purge local backup sets Select Yes to enable automatic purging of

local Enterprise Central backup files at the
next backup.

04-30005-01-en, May 2019 System

1893
69 Backup and Restore User Interface
69.1 Backup and Restore Manager Properties (Enterprise Central) – Basic Tab

Continued
Component Description

Number of local backup sets to store Enter the maximum number of backup sets
that the system can store for the Enterprise
Central.

System 04-30005-01-en, May 2019

1894
 69 Backup and Restore User Interface
69.2 Backup and Restore Manager Properties (Enterprise Server) – Basic Tab

69.2 Backup and Restore Manager

Properties (Enterprise Server) – Basic
Tab
Use the Basic tab to view the current backup and restore status of an Enterprise
Server. In addition, you can set the maximum number of local and remote
backup sets to store so the system can purge the outdated files.

Figure: Backup and Restore Manager properties for the Enteprise Server

Table: Backup and Restore Manager Properties (Enterprise Server) – Basic Tab
Component Description

Backup folder Displays the storage location of the

backup set.

Backup and restore status Displays the current status, such as

backing up.

Last backup Displays the date and time of the last

successful backup.

Purge AS backup sets Select Yes to enable automatic purging of

remote SmartX server backup files at the
next backup.

04-30005-01-en, May 2019 System

1895
69 Backup and Restore User Interface
69.2 Backup and Restore Manager Properties (Enterprise Server) – Basic Tab

Continued
Component Description

Purge local backup sets Select Yes to enable automatic purging of

local Enterprise Server backup files at the
next backup.

Number of remote AS backup sets to Enter the maximum number of backup sets
store that the system can store for each SmartX
server.

Number of local backup sets to store Enter the maximum number of backup sets
that the system can store for the Enterprise
Server.

System 04-30005-01-en, May 2019

1896
 69 Backup and Restore User Interface
69.3 Backup and Restore Manager Properties (SmartX Servers) – Basic Tab

69.3 Backup and Restore Manager

Properties (SmartX Servers) – Basic Tab
Use the Basic tab to view the current backup and restore status of a SmartX
server.

Figure: Backup and Restore Manager for the SmartX server

Table: Backup and Restore Manager Properties (SmartX Servers) – Basic Tab
Component Description

Backup and restore Displays the current status, such as backing up.
status

Last backup Displays the date and time of the last successful backup.

Backup folder Displays the storage location of the backup set.

04-30005-01-en, May 2019 System

1897
69 Backup and Restore User Interface
69.4 Backup and Restore Manager on the Enterprise Server

69.4 Backup and Restore Manager on the

Enterprise Server
Use the Backup and Restore Manager to supervise the backup settings in the
EcoStruxure Building Operation software. You can also open this view in any
EcoStruxure BMS server to view current and past backup information.

Figure: Backup and Restore Manager on the Enterprise Server

Table: Backup and Restore Manager

Component Description

Status Displays the current backup status, such

as backing up.

Last backup Displays the date and time of the last

successful backup.

Backup sets path Displays the path to where the Enterprise

Server stores all EcoStruxure BMS server
backups.

Enable Automation Server purge Select to enable the Enterprise Server to

purge the oldest backup of the SmartX
server automatically when a new backup
for that SmartX server is stored.

Number of Automation Server backup sets Enter the maximum number of backups
to store that the Enterprise Server can store for
each SmartX server.

Enable purge of local backup sets Select to enable the Enterprise Server to
purge the oldest backup automatically
when a new backup is stored.

System 04-30005-01-en, May 2019

1898
 69 Backup and Restore User Interface
69.4 Backup and Restore Manager on the Enterprise Server

Continued
Component Description

Number of local backup sets to store Enter the maximum number of backups
that the system can store for the Enterprise
Server.

04-30005-01-en, May 2019 System

1899
69 Backup and Restore User Interface
69.5 Backup and Restore Manager on a SmartX Server

69.5 Backup and Restore Manager on a

SmartX Server
Use the Backup and Restore Manager to view the backup status of a SmartX
server.

Figure: Backup and Restore Manager on a SmartX server

Table: Backup and Restore Manager on a SmartX server

Component Description

Status Displays the current status, such as backing up.

Last backup Displays the date and time of the last successful backup.

System 04-30005-01-en, May 2019

1900
 69 Backup and Restore User Interface
69.6 Backup Options Dialog Box

69.6 Backup Options Dialog Box

Use the Backup Options dialog box to select the EcoStruxure BMS server and
the type of data that you want to back up. You can also enter a unique file name
for the backup set.

Figure: Backup Options dialog box

Table: Backup Options Dialog Box

Property Description

Backup set name prefix Type the text that you want to add to the
beginning of the file name to help identify
the backup set.

Backup set name suffix Type the text that you want to add to the
end of the file name to help identify the
backup set.

Click to include all the listed EcoStruxure

BMS servers in the backup operation. You
can also manually include or exclude an
EcoStruxure BMS server using the Include
check box.

Click to exclude all the EcoStruxure BMS

servers selected for the backup operation.

Click to add the same backup set

description entered for one EcoStruxure
BMS server to all the other backup sets,
such as Final Configuration.

04-30005-01-en, May 2019 System

1901
69 Backup and Restore User Interface
69.6 Backup Options Dialog Box

Continued
Property Description

Click to add the same content type chosen

for one EcoStruxure BMS server to all the
other backup sets, such as Configuration
only.

Click to add both the backup set

desciption and content type chosen for
one EcoStruxure BMS server to all the
other backup sets, such as Final
Configuration and Configuration only.

Server name Displays the name of the EcoStruxure BMS

server.

Include Select the EcoStruxure BMS servers that

you want to include in the backup.

Backup set name Displays the name of the backup set that
you entered.

Backup content Select the type of data that you want to

back up for the EcoStruxure BMS server:
• All data
data: Backs up both the historical
and configuration databases, which
are useful for existing systems. This
combined data option protects the
configuration, historical data, and
custom object type data for a
specified date and time.
• Configuration only
only: Backs up the
configuration database and custom
object type data, which are useful for
new installations. This data option
protects the configuration data for a
specified date and time.

Backup set description Type a backup comment up to 255

characters that helps identify the type,
content, or purpose of the scheduled
backup.

System 04-30005-01-en, May 2019

1902
 69 Backup and Restore User Interface
69.7 Create Object Wizard – Configure Backup Rule Page

69.7 Create Object Wizard – Configure

Backup Rule Page
Use the Configure Backup Rule page to define the type of data that you want to
back up and configure a lead rule.

Figure: Configure Backup Rule page

Table: Configure Backup Rules Page

Property Description

Name Displays the name of the backup rule.

Backup set Type a description up to 255 characters that helps to identify the
description type and contents of the scheduled backup.

Backup content Select the type of data that you want to back up.

Lead rule Enter a backup rule that can act as a lead backup rule.

Enabled Select Yes to enable the backup rule.

04-30005-01-en, May 2019 System

1903
69 Backup and Restore User Interface
69.8 Backup Rule Properties – Basic Tab

69.8 Backup Rule Properties – Basic Tab

Use the Basic tab to view the properties of the backup rule that you create. You
can also add a description to help identify the purpose of the backup rule.

Figure: Basic tab

Table: Basic Tab

Component Description

Backup content Select the type of data that you want to back up.

Backup set description Type a description up to 255 characters that helps to

identify the type and contents of the scheduled backup.

Enabled Select Yes to enable the backup rule.

Lead rule Enter a backup rule that can act as a lead backup rule.

System 04-30005-01-en, May 2019

1904
 69 Backup and Restore User Interface
69.9 Backup Rules View

69.9 Backup Rules View

Use the Backup rules view to add, edit, or remove backup rules. You can also
modify the backup schedule associated with the backup rule. In addition, you
can select a backup rule that can act as a lead rule.

Figure: Backup rules view

Table: Backup Rules View

Number Description

Use the Backup Rules toolbar to create, edit, or remove

backup sets. For more information, see section 69.10 “Backup
Rules Toolbar” on page 1906.

Use the Backup Rules list to modify backup schedules or set

up lead rules. For more information, see section 69.11
“Backup Rules List” on page 1907.

04-30005-01-en, May 2019 System

1905
69 Backup and Restore User Interface
69.10 Backup Rules Toolbar

69.10 Backup Rules Toolbar

Use the Backup rules toolbar to add, edit, or remove backup rules.
Button Description

Add backup rule

Click to open the Create Object wizard where you create a backup
rule. For more information, see section 67.3 “Creating a Backup Rule”
on page 1866.

Edit backup rule

Click to open the Backup rule dialog box where you modify a backup
rule. For more information, see section 67.4 “Editing a Backup Rule”
on page 1867.

Remove backup rule

Click to delete a backup rule. For more information, see section 67.5
“Deleting a Backup Rule” on page 1868.

System 04-30005-01-en, May 2019

1906
 69 Backup and Restore User Interface
69.11 Backup Rules List

69.11 Backup Rules List

Use the Backup rules list to select a lead rule or modify a backup schedule for a
backup rule.

Figure: Backup rules list view

Table: Backup Rules List View

Component Description

Name Displays the name of the backup rule.

Path Displays the location of the backup rule on the EcoStruxure BMS
server.

Lead rule Enter a backup rule that can act as a lead backup rule.

Schedule Click to open the Schedule Editor where you modify the backup
schedule contained in the backup rule. For more information, see
section 49.6 “Editing a Weekly Event” on page 1427.

04-30005-01-en, May 2019 System

1907
69 Backup and Restore User Interface
69.12 Digital Schedule Properties – Basic Tab

69.12 Digital Schedule Properties – Basic Tab

Use the Basic tab to view the schedule status information and to configure the
schedule.

Figure: Digital Schedule properties – Basic tab

Table: Digital Schedule Properties – Basic Tab

Component Description

Value Select the value associated with the event.

Previous transition Displays the date and time the value most recently changed.
time

Time since previous Displays the amount of time in minutes that has elapsed since
transition the value last changed, rounded to the next minute.

Next transition Displays what the Value property will be when it next changes.
valuea

Next transition timea Displays the date and time the value will change.

Time to next Displays the amount of time in minutes before the value
transitiona changes.

System 04-30005-01-en, May 2019

1908
 69 Backup and Restore User Interface
69.12 Digital Schedule Properties – Basic Tab

Continued
Component Description

Following transition Displays the subsequent value following the next transition
valuea value.

Following transition Displays the subsequent date and time following the next
timea transition time.

Time to following Displays the amount of time in minutes before the value changes
transitiona to the following transition value.

Remove past events Select True to enable the system to delete events older than 72
hours.

Effective period Enter the range of time a schedule is in service.

Default value Select the value of the schedule when there are no events in
effect.

Lead object Select a lead schedule to reference.

a) The schedule only looks 8 days into the future to obtain this value. If there is no transition in the
next 8 days, the maximum date and time will be displayed.

04-30005-01-en, May 2019 System

1909
69 Backup and Restore User Interface
69.13 Backup Set Properties – Basic Tab

69.13 Backup Set Properties – Basic Tab

Use the Basic tab to view a read-only summary of the current backup set
information.

Figure: Basic tab

Table: Basic Tab

Component Description

Server revision Displays the software version of the

EcoStruxure BMS server at the time the
backup took place.

Backup date Displays the date and time of the backup

set.

Backup content Select the type of data that you want to

back up.

Server type Displays the type of EcoStruxure BMS

server that can be restored using this
backup set.

System 04-30005-01-en, May 2019

1910
 69 Backup and Restore User Interface
69.14 Backup Sets View

69.14 Backup Sets View

Use the Backup sets view to browse a list of backup sets on an EcoStruxure
BMS server.

Figure: Backup Sets view

Table: Backup Sets View

Number Description

Use the List View toolbar to navigate in a list. For more

information, see section 53.31 “List View Toolbar” on page
1595.

Use the AS Archives folder to view the backup sets that

belong to SmartX servers.

Use the Local folder to view the backup sets that belong to an
Enterprise Server.

Use the Properties tab to to view the properties of a selected

object in a list.

04-30005-01-en, May 2019 System

1911
69 Backup and Restore User Interface
69.15 Backup Status Dialog Box

69.15 Backup Status Dialog Box

The Backup Status dialog box displays the progress and status of a manual
backup. Once the backup starts, the process cannot be stopped but you can
close this informational dialog box at any time.

Figure: Backup Status dialog box

Table: Backup Status Dialog Box

Component Description

Name Displays the name of the object.

Status Displays the current backup status.

Progress Displays the progress of the backup.

NOTICE
The Backup Status dialog box does not appear during a scheduled backup.
However, you can open the Backup and Restore Manager from the Control
Panel on the Tools menu to view the current status of a scheduled backup.

System 04-30005-01-en, May 2019

1912
 69 Backup and Restore User Interface
69.16 Control Panel – Backup and Archiving

69.16 Control Panel – Backup and Archiving

Use the Backup and Archiving options on the Control Panel to create new
backup rules, diagnose backup or restore issues, and view the current status of
an EcoStruxure BMS server.

Figure: Control Panel – Backup and archiving

Table: Control Panel – Backup and Archiving

Component Description

Backup Rules Click to open the Backup Rules view where you manage
backup rules. You can also modify the backup schedule
associated with the backup rule. For more information, see
section 69.9 “Backup Rules View” on page 1905.

Backup Sets Click to open the Backup Sets view where you manage
backup sets. For more information, see section 69.14
“Backup Sets View” on page 1911.

Backup and Restore Click to open the Backup and Restore Manager where you
Manager view current backup and restore statuses and configure
Purge settings for an Enterprise Server. For more
information, see section 69.4 “Backup and Restore
Manager on the Enterprise Server” on page 1898.

Archiving Click to open the Archive Settings where you enable the
archiving function, set delay, and select the format of the
archive file. For more information, see section 58.3
“Archiving Settings Properties – Basic Tab” on page 1744.

04-30005-01-en, May 2019 System

1913
69 Backup and Restore User Interface
69.17 Backup Rule Dialog Box

69.17 Backup Rule Dialog Box

Use the Backup Rule dialog box to change the type of data contained in the
backup. You can also add a comment to identify the content or purpose of the
backup. In addition, you can enable or disable the backup rule.

Figure: Backup Rule dialog box

Table: Backup Rule Dialog Box

Component Description

Name Displays the name of the backup rule.

Backup set description Type a description up to 255 characters that helps to

identify the type and contents of the scheduled backup.

Backup content Select the type of data that you want to back up.

Lead rule Enter a backup rule that can act as a lead backup rule.

Enabled Select Yes to enable the backup rule.

System 04-30005-01-en, May 2019

1914
 69 Backup and Restore User Interface
69.18 Backup and Restore System Tree Icons

69.18 Backup and Restore System Tree Icons

The following table describes the Backup and Restore icons in the System Tree.

Table: Backup and Restore System Tree Icons

Icon Description

Backup
Indicates one of the following backup and restore objects:
• Backup rule. For more information, see section 65.1 “Backup” on
page 1827.
• Backup and Restore Manager. For more information, see section
69.4 “Backup and Restore Manager on the Enterprise Server” on
page 1898.

Backup schedule
Indicates a backup schedule. For more information, see section 67.7
“Backup Schedules” on page 1870.

04-30005-01-en, May 2019 System

1915
69 Backup and Restore User Interface
69.19 Restore Options Dialog Box

69.19 Restore Options Dialog Box

Use the Restore Options dialog box to select a backup set and the type of data
that you want to restore. You can also import a backup set from a network
storage location and restore the EcoStruxure BMS server, or duplicate an
EcoStruxure BMS server from a backup set using Restore when you want to
reuse configuration data from a backup set in a standalone SmartX server.

Figure: Restore Options dialog box

Table: Restore Options Dialog Box

Component Description

Name Displays the name of the backup set for the selected EcoStruxure
BMS server.

Created on Displays the date the backup set was created.

Description Displays a description of the backup set.

Configuration only Select to restore only the configuration data and custom object
type data. No historical data is restored.

All Data Select to restore the historical data, configuration data, and custom
(Configuration object type data.
and Historical)

Import Backup Set Click to import the backup set to an EcoStruxure BMS server. In a
multi-server configuration, you can import both SmartX server and
Enterprise Server backup sets to the Enterprise Server.

System 04-30005-01-en, May 2019

1916
 69 Backup and Restore User Interface
69.19 Restore Options Dialog Box

Continued
Component Description

Restore Select to duplicate the configuration data from the imported

configuration with backup set in the new standalone SmartX server. The
new IDs communication settings from the backup set will not be duplicated.
For more information, see section 68.8 “Duplicate SmartX Server
from a Backup Set” on page 1887.

04-30005-01-en, May 2019 System

1917
69 Backup and Restore User Interface
69.20 Restore Status Dialog Box

69.20 Restore Status Dialog Box

The Restore Status dialog box displays the progress and status of a restore.
Once the restore starts, the process cannot be stopped but you can close this
informational dialog box at any time.

Figure: Restore Status dialog box

System 04-30005-01-en, May 2019

1918
 69 Backup and Restore User Interface
69.21 Backup and Restore Folder Properties

69.21 Backup and Restore Folder Properties

Use the Backup and Restore Folder Properties view or dialog box to configure
and view the general properties.

Figure: Basic tab

04-30005-01-en, May 2019 System

1919
Schneider Electric
www.schneider-electric.com/buildings

© 2019 Schneider Electric. All rights reserved.

04-30005-01-en
May 2019