Desigo™ CC

Engineering Manual Version 2.1

A6V10376170_en_a_21 Siemens Industry, Inc.

2015-07-28 Building Technologies
 Copyright Notice

Copyright Notice
Notice
Document information is subject to change without notice by Siemens Industry, Inc.
Companies, names, and various data used in examples are fictitious unless otherwise
noted. No part of this document may be reproduced or transmitted in any form or by
any means, electronic or mechanical, for any purpose, without the express written
permission of Siemens Industry, Inc.
All software described in this document is furnished under a license agreement and
may be used or copied only in accordance with license terms.
For further information, contact your nearest Siemens Industry, Inc. representative.
© Siemens Industry, Inc. 2015

To the Reader
Your feedback is important to us. If you have comments about this manual, please
submit them to: [email protected]

Credits
Desigo, Desigo CC, Cerberus DMS, APOGEE, XLS FireFinder, and Sinteso are
registered trademarks of Siemens Industry, Inc.
Other product or company names mentioned herein may be the trademarks of their
respective owners.
Edition: 2015-07-28
Document ID: A6V10376170_en_a_21

2
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Table of Contents

About This Document ..................................................................................................... 13

Document Revision History ............................................................................................... 17
Notice for Fire Norms Compatibility .............................................................................. 18
1 Introduction ...................................................................................................... 21
1.1 Engineering ........................................................................................................ 21
1.1.1 Configuration Workflow ....................................................................... 22
1.1.2 Operating and Engineering Mode ....................................................... 23
1.1.3 Engineering License ........................................................................... 25
1.1.4 Engineering Access Rights ................................................................. 27
2 System Architecture ........................................................................................ 28
2.1 Hardware Category and System Limits.............................................................. 29
2.1.1 Adjusting the Hardware Category ....................................................... 32
2.2 Stations............................................................................................................... 33
2.2.1 User Interface Variants ....................................................................... 35
2.2.2 Station Configuration Workspace ....................................................... 42
2.2.3 Configuring the Stations...................................................................... 45
2.2.4 Configuring a Client in Closed Mode .................................................. 54
2.3 Hard Disk Drive Monitoring ................................................................................ 57
2.3.1 Monitoring the Disk Status for the Server ........................................... 58
2.3.2 Monitoring the Disk Space for the Server ........................................... 59
2.3.3 Monitoring the Disk Status for a Client or a FEP ................................ 60
2.3.4 Deleting a Hard Disk Monitoring Object.............................................. 61
2.4 Server Printers ................................................................................................... 62
2.4.1 Configuring Server Printers ................................................................ 63
2.5 WMI UPS ............................................................................................................ 66
2.5.1 General Settings ................................................................................. 66
2.5.2 Properties ............................................................................................ 67
2.5.3 Configuring the WMI UPS ................................................................... 67
3 User Administration ......................................................................................... 72
3.1 Security Concept ................................................................................................ 72
3.1.1 Default User Groups ........................................................................... 73
3.1.2 User Groups ........................................................................................ 74
3.1.3 Access Rights ..................................................................................... 75
3.2 User Administration Workspace ......................................................................... 76
3.2.1 Toolbar ................................................................................................ 78
3.2.2 Scope Rights ....................................................................................... 79
3.2.3 Configuring User Groups .................................................................... 81
3.2.4 Checking Sessions ............................................................................. 90

3
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 3.3 Creating Users.................................................................................................... 90
3.3.1 Toolbar ................................................................................................ 92
3.3.2 Configuring Users ............................................................................... 93
3.4 Application Rights ............................................................................................. 100
3.4.1 Addressbook ..................................................................................... 101
3.4.2 Assisted Treatment ........................................................................... 101
3.4.3 Automatic Event Treatment .............................................................. 102
3.4.4 BACnet Configuration ....................................................................... 102
3.4.5 Device ............................................................................................... 103
3.4.6 Document Configuration and Document Viewer............................... 104
3.4.7 Driver .................................................................................................105
3.4.8 Graphics Editor ................................................................................. 105
3.4.9 Graphics Library Editor .....................................................................105
3.4.10 Graphics Viewer ................................................................................ 106
3.4.11 Icons ..................................................................................................106
3.4.12 Import Rules ...................................................................................... 106
3.4.13 Importer ............................................................................................. 106
3.4.14 Journaling.......................................................................................... 107
3.4.15 Library ............................................................................................... 108
3.4.16 License .............................................................................................. 108
3.4.17 Localization ....................................................................................... 108
3.4.18 Log Viewer ........................................................................................ 109
3.4.19 Macro ................................................................................................ 110
3.4.20 Network ............................................................................................. 110
3.4.21 Object Configurator ........................................................................... 110
3.4.22 Operating Procedure ......................................................................... 111
3.4.23 Reactions .......................................................................................... 111
3.4.24 Remote Notification ........................................................................... 112
3.4.25 Reporting........................................................................................... 113
3.4.26 Schedules ......................................................................................... 114
3.4.27 Scopes .............................................................................................. 114
3.4.28 Security ............................................................................................. 115
3.4.29 Sessions ............................................................................................ 115
3.4.30 System Management ........................................................................ 115
3.4.31 Trends ............................................................................................... 117
3.4.32 Users .................................................................................................117
3.4.33 View Builder and View Configurator ................................................. 118
4 Views ............................................................................................................... 119
4.1 Views Concepts ................................................................................................ 119
4.2 Views Configuration Workspace ...................................................................... 123
4.3 View Builder Workspace .................................................................................. 124
4.4 Configuring the Views....................................................................................... 127
4.4.1 Configuring the Logical View ............................................................ 128

4
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 4.4.2 Configuring the Physical View .......................................................... 129
4.4.3 Configuring a User-defined View ...................................................... 131
4.4.4 Modifying a View ............................................................................... 133
4.4.5 Linking Individual Objects to a View ................................................. 134
4.4.6 Linking Subtrees to a View ............................................................... 134
4.4.7 Linking a Graphic to the Root Node of a View .................................. 135
4.4.8 Renaming an Object in a View ......................................................... 136
4.4.9 Excluding Objects or Subtrees in a View .......................................... 137
4.4.10 Purging Aggregators ......................................................................... 137
4.4.11 Restricting Access to a View ............................................................ 137
4.4.12 Deleting a View ................................................................................. 138
5 Object Configurator ....................................................................................... 139
5.1 Overview of Object Configurator ...................................................................... 139
5.2 Working with Object Configurator .................................................................... 142
5.2.1 Toolbar .............................................................................................. 142
5.2.2 Main .................................................................................................. 143
5.2.3 Properties .......................................................................................... 145
5.2.4 Details ............................................................................................... 145
5.2.5 Alarm Configuration .......................................................................... 149
5.3 Configuring Objects .......................................................................................... 151
5.3.1 Editing/Translating an Object Description......................................... 151
5.3.2 Editing Alias Name............................................................................ 152
5.3.3 Temporarily Taking a Sensor Out of Scan........................................ 152
5.3.4 Logging Data Values......................................................................... 153
5.3.5 Logging Events ................................................................................. 155
5.3.6 Prioritizing Related Items .................................................................. 156
5.3.7 Text Catalog Navigation.................................................................... 157
5.3.8 Changing Object Classification ......................................................... 157
5.3.9 Assigning a Function to a Data Point................................................ 159
5.3.10 Navigating Easily by Function or Object Model ................................ 159
5.3.11 Management System Alarm Workflow.............................................. 160
6 BACnet ............................................................................................................ 169
6.1 BACnet Driver .................................................................................................. 169
6.1.1 Adding a BACnet Driver .................................................................... 170
6.1.2 Configuring Basic Driver Settings ..................................................... 171
6.1.3 Configuring BACstack ....................................................................... 172
6.1.4 Configuring Threads ......................................................................... 174
6.1.5 Configuring Auto Discovery .............................................................. 175
6.1.6 Configuring Driver Devices ............................................................... 176
6.1.7 Configuring Time Synchronization .................................................... 177
6.1.8 Starting and Stopping a BACnet Driver ............................................ 177
6.1.9 Deleting the BACnet Driver ............................................................... 178

5
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 6.2 BACnet Network ............................................................................................... 178
6.2.1 Adding a BACnet Network ................................................................ 179
6.2.2 Assigning a Driver to the BACnet Network ....................................... 179
6.2.3 Handling Auto Discovery ...................................................................179
6.2.4 Configuring Hierarchies Mapping...................................................... 182
6.2.5 Configuring Block Commands Behavior ........................................... 183
6.2.6 Creating Global Objects Folder Mapping .......................................... 185
6.2.7 Deleting a BACnet Network .............................................................. 187
6.3 BACnet Devices ............................................................................................... 188
6.3.1 Importing BACnet Devices ................................................................ 188
6.3.2 Viewing Device Info........................................................................... 189
6.3.3 Configuring COV and Polling Info ..................................................... 189
6.3.4 Configuring Timing and Status Info................................................... 190
6.3.5 Configuring Backup/Restore Information .......................................... 191
6.3.6 Configuring Other Settings ................................................................ 191
6.3.7 Configuring Multiple Devices Simultaneously ...................................192
6.3.8 Deleting a BACnet Device ................................................................ 192
6.4 BACnet Editor ...................................................................................................193
6.4.1 Overview of BACnet Editor ............................................................... 193
6.4.2 BACnet Editor Workspace ................................................................ 198
6.4.3 Working with BACnet Editor .............................................................. 212
7 Field Data Import ............................................................................................ 215
7.1 Import Workspace ............................................................................................ 216
7.2 Defining Hierarchies Mapping .......................................................................... 218
7.3 Importing Field Data ......................................................................................... 219
8 Scopes ............................................................................................................. 221
8.1 Overview of Scopes.......................................................................................... 221
8.1.1 Scopes Rights and Security .............................................................. 227
8.2 Scopes Workflow .............................................................................................. 228
8.3 Scopes Workspace........................................................................................... 228
8.3.1 Scopes Toolbar ................................................................................. 228
8.3.2 Scope Rules ...................................................................................... 229
8.3.3 Scope Exceptions ............................................................................. 231
8.4 Configuring a Scope Definition ......................................................................... 233
8.4.1 Creating a New Scope Folder ........................................................... 233
8.4.2 Creating a New Scope Definition ...................................................... 234
8.4.3 Configuring a Scope Rule .................................................................234
8.4.4 Configuring a Scope Exception......................................................... 237
8.4.5 Modifying a Scope Definition ............................................................ 238
8.4.6 Creating a New Scope Definition from an Existing One ................... 239
8.4.7 Deleting a Scope Definition or a Scope Folder .................................240
9 Journaling ....................................................................................................... 241

6
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 9.1 Overview of Journaling ..................................................................................... 241
9.2 Journaling Workflow ......................................................................................... 242
9.3 Journaling Workspace ...................................................................................... 242
9.3.1 Journaling Printers ............................................................................ 242
9.3.2 Journaling Configurator..................................................................... 244
9.4 Journaling Template Concepts ........................................................................ 249
9.5 Journaling Printer Concepts ............................................................................. 251
9.6 UL/ULC Compliance for Journaling Template and Line Printer ....................... 252
9.6.1 Journaling Template Specifications .................................................. 252
9.6.2 Journaling Line Printer Specifications............................................... 253
9.7 Configuring a Journaling Printer-Template Map .............................................. 254
9.7.1 Mapping a Journaling Template to the Journaling Printer ................ 254
9.7.2 Adding a New Printer-Template Entry .............................................. 255
9.7.3 Modifying a Printer-Template Entry .................................................. 255
9.7.4 Removing a Printer-Template Entry ................................................. 256
9.8 Configuring a Journaling Definition .................................................................. 256
9.8.1 Creating a New Journaling Definition ............................................... 257
9.8.2 Assigning a Journaling Printer to a Journaling Definition ................. 257
9.8.3 Adding a New Journaling Filter Row................................................. 258
9.8.4 Configuring a Scope in a Journaling Filter ........................................ 258
9.8.5 Modifying a Scope in a Journaling Filter ........................................... 259
9.8.6 Resetting the Scope in a Journaling Filter ........................................ 260
9.8.7 Configuring an Events Filter ............................................................. 260
9.8.8 Configuring an Actions Filter ............................................................. 261
9.8.9 Configuring a Values and States Filter ............................................. 261
9.8.10 Removing a Journaling Filter Row .................................................... 262
9.8.11 Modifying a Journaling Definition ...................................................... 262
9.8.12 Creating a New Journaling Definition from an Existing One............. 263
9.8.13 Deleting a Journaling Definition ........................................................ 264
9.9 Printing Journaling Events Manually ................................................................ 264
9.10 Journaling Events Logged in the History DB ................................................... 264
9.11 Creating a User-defined Journaling Template ................................................. 265
9.12 Configuring a Journaling Template .................................................................. 265
9.12.1 Page Setup Parameters.................................................................... 266
9.12.2 Printable Columns............................................................................. 273
9.12.3 Applying Configured Parameters ...................................................... 277
10 Macros ............................................................................................................. 278
10.1 Overview of Macros.......................................................................................... 278
10.1.1 Backup Macros ................................................................................. 279
10.1.2 Block Command Macros ................................................................... 280
10.2 Macros Configuration Workspace .................................................................... 280
10.3 Configuring Macros .......................................................................................... 282
10.3.1 Setting up the Macros Folders Structure .......................................... 282

7
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 10.3.2 Creating a Macro............................................................................... 283
10.3.3 Modifying a Macro ............................................................................. 284
10.3.4 Deleting Macros or Folders ............................................................... 285
10.3.5 Creating Global Block Command Macros for Multiple Networks ...... 285
11 Reactions ........................................................................................................ 287
11.1 Overview of Reactions...................................................................................... 287
11.2 Configuring the Reactions ................................................................................ 289
11.2.1 Setting up the Reactions Folders Structure ...................................... 290
11.2.2 Creating a New Reaction ..................................................................290
11.2.3 Creating a Reaction from an Existing One ....................................... 293
11.2.4 Modifying a Reaction......................................................................... 293
11.2.5 Deleting Reactions or Folders........................................................... 294
12 Triggers and Filters ........................................................................................ 295
12.1 Time and Organization Mode ........................................................................... 295
12.1.1 Specifying Time and Organization Mode Conditions ........................ 297
12.2 Events ............................................................................................................... 298
12.2.1 Specifying Event Conditions ............................................................. 299
12.3 Values and States ............................................................................................ 301
12.3.1 Specifying Values and States Conditions ......................................... 302
13 Organization Modes ....................................................................................... 304
13.1 Manually Setting an Organization Mode .......................................................... 305
13.2 Scheduling an Organization Mode ...................................................................306
13.3 Setting an Organization Mode as the Output of a Reaction ............................. 307
13.4 Creating a New Organization Mode .................................................................307
13.5 Creating an Organization Mode from an Existing One.....................................308
13.6 Modifying an Organization Mode...................................................................... 309
13.7 Deleting an Organization Mode ........................................................................ 310
14 Remote Notifications...................................................................................... 311
14.1 Remote Notifications Configuration Workflow .................................................. 312
14.2 Email Configuration Workspace ....................................................................... 314
14.2.1 SMTP Protocol .................................................................................. 315
14.2.2 POP3 Protocol .................................................................................. 316
14.2.3 IMAP Protocol ................................................................................... 317
14.2.4 Test Email Connection ...................................................................... 318
14.3 Configuring the Email Service .......................................................................... 319
14.3.1 Configuring the SMTP Protocol ........................................................ 319
14.3.2 Configuring the POP3 Protocol ......................................................... 320
14.3.3 Configuring the IMAP Protocol.......................................................... 321
14.3.4 Testing the EMail Connection ........................................................... 322
14.3.5 Deleting the Email Service ................................................................ 322
14.4 SMS Configuration Workspace ........................................................................ 323
14.4.1 SMS GSM Provider ........................................................................... 324

8
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 14.4.2 SMS Email Provider .......................................................................... 325
14.4.3 Test SMS Connection ....................................................................... 325
14.5 Configuring the SMS Service ........................................................................... 326
14.5.1 Configuring the SMS GSM Provider ................................................. 327
14.5.2 Configuring the SMS E-Mail Provider ............................................... 328
14.5.3 Testing the SMS Connection ............................................................ 329
14.5.4 Deleting the SMS Service ................................................................. 329
14.6 Pager Configuration Workspace ...................................................................... 330
14.6.1 TAP Protocol and Providers ............................................................. 331
14.6.2 ESPA Protocol .................................................................................. 332
14.6.3 Test Pager Connection ..................................................................... 334
14.7 Configuring the Paging Service ........................................................................ 334
14.7.1 Configuring TAP Protocol and Provider ............................................ 335
14.7.2 Configuring ESPA Protocol ............................................................... 336
14.7.3 Testing the Pager Connection .......................................................... 337
14.7.4 Deleting the Pager Device ................................................................ 338
14.8 Remote Notifications Workspace ..................................................................... 338
14.8.1 General Settings ............................................................................... 339
14.8.2 Recipients ......................................................................................... 340
14.8.3 Message Tailoring............................................................................. 343
14.8.4 Triggers ............................................................................................. 344
14.9 Configuring Remote Notifications ..................................................................... 344
14.9.1 Configuring a Remote Notification .................................................... 344
14.9.2 Creating a Remote Notification from an Existing One ...................... 346
14.9.3 Enabling or Disabling a Remote Notification .................................... 347
14.9.4 Modifying a Remote Notification ....................................................... 348
14.9.5 Deleting a Remote Notification ......................................................... 349
14.10 Troubleshooting the Email Server .................................................................... 349
14.11 Troubleshooting the TAP Pager Modem .......................................................... 350
14.12 Troubleshooting Remote Notification Services ................................................ 350
15 Operating Procedures.................................................................................... 351
15.1 Operating Procedures List................................................................................ 352
15.2 Operating Procedures Workspace ................................................................... 353
15.2.1 General Settings ............................................................................... 355
15.2.2 Filters ................................................................................................ 356
15.2.3 Steps ................................................................................................. 357
15.3 Procedure Step Workspace ............................................................................. 358
15.3.1 General Settings ............................................................................... 360
15.3.2 Additional Settings ............................................................................ 361
15.3.3 Reno Step: Recipients and Message Tailoring ................................ 369
15.4 Configuring Operating Procedures................................................................... 370
15.4.1 Setting up the Operating Procedures Folders Structure................... 370
15.4.2 Adding a New Operating Procedure ................................................. 370

9
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 15.4.3 Adding Steps to an Operating Procedure ......................................... 371
15.4.4 Configuring an Operating Procedure ................................................ 372
15.4.5 Configuring an Operating Procedure Step ........................................ 373
15.4.6 Configuring Additional Settings for an Alarm Printout Step .............. 374
15.4.7 Configuring Additional Settings for a Document Step....................... 375
15.4.8 Configuring Additional Settings for a Graphic Step .......................... 376
15.4.9 Configuring a Reno Step ...................................................................377
15.4.10 Configuring Additional Settings for a Report Step ............................ 379
15.4.11 Configuring Additional Settings for a Treatment Form Step ............. 380
15.4.12 Enabling or Disabling an Operating Procedure ................................ 381
15.4.13 Modifying the Priority of Operating Procedures ................................ 382
15.4.14 Adjusting the Execution Order of Steps in a Procedure ................... 382
15.4.15 Deleting Operating Procedures, Folders, or Steps ........................... 383
16 Event Settings.................................................................................................384
16.1 Event Settings Workspace ............................................................................... 385
16.1.1 General Settings ............................................................................... 386
16.1.2 Filters ................................................................................................ 387
16.1.3 Event Settings Properties and Commands ....................................... 388
16.2 Setting Up Automated Alarm Handling............................................................. 388
16.2.1 Configuring an Automated Alarm Handling Rule .............................. 389
16.2.2 Enabling or Disabling an Automated Alarm Handling Rule .............. 390
16.2.3 Modifying an Automated Alarm Handling Rule .................................391
16.2.4 Deleting an Automated Alarm Handling Rule ...................................391
17 Documents ...................................................................................................... 392
17.1 Documents Configuration Workflow .................................................................393
17.2 Configuring Documents .................................................................................... 393
17.2.1 Storing Document Files in the Project Path ...................................... 393
17.2.2 Setting up the Documents Folders Structure ....................................394
17.2.3 Configuring a Document Object ........................................................ 394
17.2.4 Deleting a Document Object or Folder.............................................. 395
18 Troubleshooting ............................................................................................. 396
18.1 Overview of Trace Viewer ................................................................................ 396
18.1.1 Using the Trace Viewer .....................................................................396
18.2 Troubleshooting BACnet Driver........................................................................ 397
18.2.1 Overview of Debug Flags Used to Trace BACnet Problems ............ 397
18.2.2 Using Debug Flags to Trace BACnet Problems ............................... 398
18.3 Troubleshooting Backup and Restore .............................................................. 398
18.3.1 Data Lock During Backup Activities .................................................. 398
18.4 Troubleshooting Printout Problems ..................................................................399
18.4.1 Line Printer does not Print a Desired Language ............................... 399
18.4.2 Error Codes and their Meaning in Journaling ...................................400
Index .......................................................................................................................... 401

10
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 11
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 About This Document
Document Revision History

About This Document

Purpose
This manual is designed to assist users in configuring and commissioning the Desigo
CC.

Scope
This document applies to Desigo CC Version 2.1.

Target Audience
Field Engineers provide the basic installation of devices and systems for a specific
customer at the customer site. They have the training appropriate to their function and
to the products, devices, and systems to be installed. They are also familiar with the
applied operating system(s) and the related network environment. Field engineers are
responsible for infrastructure troubleshooting (for example, hardware, communication,
network, and so on).
Project Engineers are responsible for planning and configuring a customer project.
They provide the parameterization of products, devices, and systems and are
responsible for general system troubleshooting. They have the training appropriate to
their function and to the products, devices, and systems to be configured. They are
familiar with the applied operating system(s) and the related network environment.

13
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 About This Document
Document Revision History

Liability Disclaimer
We have checked the contents of this manual for agreement with the hardware and
software described. Since deviations cannot be precluded entirely, we cannot
guarantee full agreement. However, the data in this manual are reviewed regularly and
any necessary corrections included in subsequent editions. Suggestions for
improvement are welcome.

Product Security Disclaimer

Siemens products and solutions provide IT-specific security functions to ensure the
secure operation of building comfort, fire safety, security management and physical
security systems. The security functions on these products and solutions are important
components of a comprehensive security concept.
However, it is necessary to implement and maintain a comprehensive, state-of-the-art
security concept that is customized to individual security needs. Such a security
concept may result in additional site-specific preventive action to ensure that the
building comfort, fire safety, security management or physical security systems for your
site are operated in a secure manner. These measures may include, but are not limited
to, separating networks, physically protecting system components, user awareness
programs, in-depth security, and so on.
For additional information on building technology security and our offerings, contact
your Siemens sales or project department. We strongly recommend signing up for our
security advisories, which provide information on the latest security threats, patches
and other mitigation measures.
http://www.siemens.com/innovation/en/technology-focus/siemens-cert/cert-security-
advisories.htm

14
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 About This Document
Document Revision History

Document Conventions
The following table lists conventions to help you use this document in a quick and
efficient manner.

Convention Examples
Numbered Lists (1, 2, 3…) indicate a 1. Turn OFF power to the field panel.
procedure with sequential steps. 2. Turn ON power to the field panel.
3. Open the panel.
One-step procedures are indicated by a bullet  Expand the Event List.
point.
Conditions that you must complete or must be ⊳ The report you want to print is open.
met before beginning a procedure are
designated with a ⊳. 1. Click Print .
Intermediate results (what will happen ⇨ The Print dialog box displays.
following the execution of a procedure step),
2. Select the printer and click Print.
are designated with an indented ⇨.
⇨ The print confirmation displays.
Results, after completing a procedure, are
designated with a ⇨.
Bold font indicates something you should type Type F for field panels.
or select, or when a dialog box or window is Click OK to save changes and close the dialog
specified. box.
The Create a New Project dialog box displays.
Menu paths in procedures are indicated in Select File > Text, Copy > Group, which
bold. means from the File menu, select Text, Copy
and then Group.
File paths containing placeholders display the [installation drive:]\[installation
placeholders in italics enclosed in square folder]\[project]\...
brackets.
Error and system messages are displayed in The message Report Definition
Courier New font. successfully renamed displays in the
status bar.
Italics are used to emphasize new or important The reaction processor continuously executes
terms. a user-defined set of instructions called the
control program.
This symbol signifies a Note. Notes provide
additional information or helpful hints.

Cross references to other information in For more information on creating flowcharts,

printed material are indicated with an arrow see Flowcharts [→ 92].
and the page number, enclosed in brackets:
[→ 92]

Getting Help
For more information about the Desigo CC products, contact your local sales
representative.

15
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 About This Document
Document Revision History

Safety Messages According ANSI Z535.6

The following examples show the ANSI standard safety messages used in this
document to draw the reader’s attention to important information.
ANSI distinguishes between personal injury safety messages and property damage
warning messages.
The personal injury safety messages have safety alert symbols and the following alert
level labels: DANGER!, WARNING!, CAUTION!
The label for property damage messages is: NOTICE.

Examples:

NOTICE

Property Damage Warning Message

Equipment damage or loss of data may occur if you do not follow a procedure or
instruction as specified.

CAUTION

Caution Safety Message

Minor or moderate injury may occur if you do not follow a procedure or instruction as
specified.

WARNING

Warning Safety Message

Personal injury or property damage may occur if you do not follow a procedure as
specified.

DANGER

Danger Safety Message

Electric shock, death, or severe property damage may occur if you do not perform a
procedure as specified.

16
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 About This Document
Document Revision History

Document Revision History

Document Identification
The document ID is structured as follows:
ID_Language(COUNTRY)_ModificationIndex_ProductVersionIndex
Example: A6Vnnnnnnnn_en_a_02

Document Revision History.

Modification Index Edition Date Brief Description
c
b
a 2015-07-28 Market Release Edition

17
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Notice for Fire Norms Compatibility

Notice for Fire Norms Compatibility

NOTICE TO USERS, INSTALLERS, AUTHORITIES HAVING JURISDICTION, AND
OTHER INVOLVED PARTIES
This product incorporates field-programmable software. In order for the product to
comply with the requirements in the Standard for Control Units and Accessories for
Fire Alarm Systems, UL 864/ULC S527, certain programming features or options
must be limited to specific values or not used at all as indicated in the following
tables.

NOTICE TO USERS, INSTALLERS, AUTHORITIES HAVING JURISDICTION, AND

OTHER INVOLVED PARTIES
This product is not UL-listed for Security applications.

Client Profiles
Station Type Client Profile Permitted in UL Possible Settings Settings Permitted
864/ULC in UL 864/ULC
S527? (Y/N) S527
UL 864/ULC S527- A Client Profile Yes - FS_UL - FS_UL
compliant fire (and the - FS_ULC - FS_ULC
station running on associated - TBS_UL - TBS_UL
a UL 864/ULC Scheme) defines - TBS_ULC - TBS_ULC
S527-approved Summary Bar - BA_NA
computer lamps, Event - BA_NA_timeout
List, Event Detail - KIOSK
Bar, and event
treatment aspect
and behavior.

Event Disciplines Allowed in UL 864-/ULC S527-related Client Profiles

Client Profiles Disciplines Permitted in UL Possible Settings Settings Permitted in
864/ULC S527? UL 864/ULC S527
(Y/N)
FS_UL - Building Automation No - Disciplines - Disciplines not
FS_ULC - Building available available
(fire only) Infrastructure - Disciplines not
- Energy available
Management
- Remote Notification
Messages
TBS_UL - Building Automation No - Disciplines - Disciplines available
TBS_ULC - Building available on non-fire stations
Infrastructure - Disciplines
- Energy available on non-
Management fire stations
- Disciplines not
available

18
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Notice for Fire Norms Compatibility

Block Commands Programming

Block Command NFPA 72 Permitted in UL Possible Settings Settings Permitted
Configuration 864/ULC in UL 864/ULC
S527? (Y/N) S527
Block acknowledge Local Highrise Yes - Enabled - Enabled
- Not Enabled
Local Campus No - Enabled - Not Enabled
- Not Enabled
Proprietary No - Enabled - Not Enabled
- Not Enabled

Hard Disk Device Supervision

Function Permitted in Possible Settings Settings Permitted in UL
UL 864/ULC S527? (Y/N) 864/ULC S527
Hard disk on Yes, if supervised - Supervised hard - Supervised hard disk
system stations disk drive (configured drive (configured as a
(Server, Client, as a station device) station device)
and FEP - Non-supervised
stations) hard disk drive (not
configured as a
workstation device

Mass Notification Functionality

Function Permitted in Possible Settings Settings Permitted in UL
UL 864/ULC S527? (Y/N) 864/ULC S527
Mass Notification No - Installed - MNS EM must be
Extension Module - Not installed installed on a separate
workstation with a
dedicated client profile
(FEP) and dedicated
display. MNS events must
not be displayed on the
same monitor where Fire
events are displayed

Remote Notification (RENO) Functionality

Function Permitted in Possible Settings Settings Permitted in UL
UL 2572? (Y/N) 2572
Remote No - Used - Remote Notification
Notification - Not used (RENO) Messages shall
(RENO) not be used for UL 2572
Messages Distributed Recipient
Mass Notification
Applications

19
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Notice for Fire Norms Compatibility

Mass Notification Devices

Function Permitted in Possible Settings Settings Permitted in UL
UL 864/ULC S527? (Y/N) 864/ULC S527
Wireless/Mobile No - Used - Not used
Devices in Mass - Not used
Notification
applications or
similar

20
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Introduction
Engineering
1

1 Introduction
This is a guide to the configuration procedures for the Desigo Control Center (Desigo
CC) management system. It presents the basic set of field-programmable options to
customize the product for a specific customer site.
For complete information about configuring a Desigo CC installation, use this manual
in conjunction with the Graphics Editor Manual and with manuals of any other
extension modules (Fire Protection, Video Surveillance, Building Automation guides)
that are relevant to the installation.
Note that this manual does not cover certain advanced configuration topics concerning
the Desigo CC libraries, which can also be applied to multiple projects or used for
country-wide customizations.
Readers who are not familiar with the Desigo CC user interface—and specifically with
the System Manager application—will find useful to refer to the introduction sections of
the Desigo CC User Guide.

NOTE:
In this manual the term management system or system refers to the Desigo CC
software. The term station (or client station) means a computer from which a user
interacts with the management system. A large management-system installation will
typically have several client stations (multi-user configuration).

1.1 Engineering
Engineering is a feature of Desigo CC that enables an authorized technician to
configure the management-system software for a particular building-control site (that
is, to configure a site project).
The configuration is done from within the Desigo CC client application, using the same
System Manager interface that is used for the day to day running of the building control
site. If you have the appropriate permissions (see engineering access rights [➙ 27]), a
button lets you switch System Manager from its normal Operating mode to a special
Engineering mode [➙ 23] used for configuring the system.
To fully configure a site project you may also require a special Engineering license
[➙ 25], which temporarily removes all limits on the number of field points, and other
restrictions that would otherwise apply to the software’s functionality.

21
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Introduction
1 Engineering

1.1.1 Configuration Workflow

This general workflow describes the steps required to set up a Desigo CC system. The
steps are listed in the recommended order in which you should carry them out.

Prerequisites
 The Desigo CC software and libraries have been installed (refer to the Installation
Manual A6V10376166) on the Desigo CC Server station, and on any other Client
and FEP stations.
 You created and started a Desigo CC project using the System Management
Console (refer to the System Management Console online help A6V10381671).
 You have access to Engineering mode [➙ 23] (appropriate user group access
rights [➙ 27]).
Note that advanced library management is not part of the standard configuration
workflow and is discussed in the separate Library Management Guide (A6V10380499).

Get Started
 Start the Desigo CC client application (you can do this from any station on which
the software is installed) and switch System Manager to Engineering mode [➙ 23].
 (Optional) For some configuration tasks you will also require a special Engineering
license. If this is the case, switch over to the Engineering license [➙ 25].
 Check that the default system size and system limits [➙ 29] are sufficient for the
customer’s building control site. If they are not, adjust them to match the size of the
installation.
 If necessary, check the license features (see User Guide, A6V10376160).

Configure the Management System

 Configure the central hardware (stations, printers, and so on) of the management
system (see System Architecture [➙ 28]).
 Define the list of Users and User groups (see User Administration [➙ 72]) and
configure their access rights.
 Create the required site Views (see Views [➙ 119]).
 If necessary, customize specific data point instances (see Object Configurator
[➙ 139]).
 Configure the communication Drivers and add the required Field Networks for the
hardware subsystems installed on the building-control site. Refer to the relevant
integration guides.
 Import [➙ 215] the field unit databases, thus populating the views with data points.
Refer to the relevant integration guides.
 Configure system security: define system Scopes (see Scopes [➙ 221]).
 Configure the Journaling printout (see Journaling [➙ 241]).
 Create Macros to group command actions (see Macros [➙ 278]).
 Create Reactions to automate control actions (see Reactions [➙ 287]).
 Configure the Remote Notifications (see Remote Notifications [➙ 311]).
 Configure Operating Procedures for use in Assisted Treatment (see Operating
Procedures [➙ 351]).
 Configure Event Settings for use in automated alarm handling (see Event Settings
[➙ 384]).
 Create Documents (see Documents [➙ 392]).

22
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Introduction
Engineering
1

 Create Graphics using the Graphics Editor (see Graphics Editor manual,
A6V10380503).
 Define Calendars and Scheduler activities (see User Guide, A6V10376160).
 Create Report definitions (see User Guide, A6V10376160).
 Create Trend definitions (see User Guide, A6V10376160).
 Backup your project.

1.1.2 Operating and Engineering Mode

When you log onto Desigo CC, System Manager starts in Operating mode. This is the
mode typically used by operators during the day-to-day running of the building control
system, to monitor and control the site. Configuring the system instead requires
switching over to Engineering mode. (You can only do this if you have the appropriate
user permissions [➙ 27]).

System Manager - Operating

If you have the appropriate permission, the Primary pane of System Manager displays
an button that you can use to switch to Engineering mode.

23
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Introduction
1 Engineering

System Manager - Engineering

In Engineering mode, System Manager appears in a different color, and the Primary
pane presents all the tools for configuring the site project, including import/export
capabilities. You can click the button to switch the system back to
Operating mode and check whether the configurations you made work correctly.

NOTE:
Do not confuse Operating/Engineering mode (which applies to System Manager as a
whole) with Operate/Edit mode (which instead applies to certain applications running
inside the System Manager panes).

Edit/Operate Mode
Most of the system’s configuration takes place in Engineering mode. However, some
System Manager applications (such as graphics, documents, and so forth) have
settings that can be changed in Operating mode In these cases, an operator (with
appropriate access rights) can switch the application from Operate mode to Edit
mode to make and save changes, without having to leave Operating mode.

You can also take advantage of this feature during a configuration workflow. For
example, if you finished configuring a project and only need to make a change in an
application that has an Operate/Edit button available, you can just switch to Edit mode
within the application, rather than switching the entire System Manager to
Engineering mode.

24
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Introduction
Engineering
1

1.1.3 Engineering License

The Engineering license is a special license used by authorized technicians for the
configuration of a site project. It enables the system to temporarily operate (for 48
hours at a time) without any limits on the number of field points, or any other
restrictions that would ordinarily apply to the software’s functionality.

Switch over to the Engineering License

When the Engineering license is installed, you can initiate a 48-hour session by
plugging in the dongle associated with the license: The system switches over to the
Engineering license, and this is visually indicated in blue text on the Summary bar:
 A countdown timer shows how much time is left in the current 48-hour session.
When this countdown expires, you must wait one hour before you can switch over
to the Engineering license again.
 The Engineering license expiration date (after which it can no longer be used at all)
is also shown. The color of this text changes when the date is less than 30 days
away.

You can double-click on the blue Engineering Session text in the Summary bar to
display all the details of the Engineering license. The Assigned and Required columns
will show Unlimited for the license features.

Switch away from the Engineering License

When the 48-hour Engineering license countdown expires (or when you unplug the
dongle), Desigo CC switches over to one of the following license modes:
 Normal mode (Desigo CC fully functional), if a valid and sufficient license is
installed.
 Courtesy mode (Desigo CC can operate for 30 days), if a valid license is found, but
it is not sufficient to cover all field points (or if there have been excessive sabotage
attempts).
 Demo mode (Desigo CC can operate for 30 minutes only), if no valid license is
found.
You can still perform configuration tasks in these modes—but without the unlimited
license features provided by the Engineering license.

25
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Introduction
1 Engineering

NOTE:
In Normal and Courtesy mode you can freely switch between Operating and
Engineering mode. However, in Demo mode you can only switch from Engineering to
Operating mode (once you are in Operating mode you cannot switch back to
Engineering mode).

For more details about the license features and other license modes, see the User
Guide A6V10376160.
For more details about the license features and other license modes, see Licensing.

Switch back to the Engineering License

After the system has been shut down or running in another license mode for at least
one hour, you can switch back to the Engineering license again (for another 48 hours).
To do this unplug the dongle, wait a while for the license check, and plug in the dongle
again or restart the project (restarting all the services).

NOTE:
If the system is running in Courtesy Mode because the sabotage limit was reached, it
will not switch over to the Engineering license when the dongle is plugged in.

License Properties in the Operation Tab

Property Description
License mode Desigo CC current mode.
Sabotage attempts Number of sabotage attempts.
Time remaining in this Residual time in the current Demo Mode or Engineering-license
session session.
 When the 30-minute Demo time expires the project will be
stopped and the operator will be forced to log off.
 When the 48-hour Engineering license time expires, the system
will switch back to its previous license mode.
Time remaining in Residual time in Courtesy Mode, during which it is possible to
Courtesy Mode temporarily work with the project until a valid and sufficient license is
installed again.
Total operating time Duration counter that indicates how long Desigo CC has been
with valid license continuously working with a valid and sufficient license (that is, in
Normal mode).
Engineering license will How many days until the Engineering License expires.
expire in

26
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Introduction
Engineering
1

1.1.4 Engineering Access Rights

Your ability to access Engineering mode [➙ 23] depends on the System Management
application rights [➙ 115] set for your user group under Security.

NOTE:
The application rights can only be changed in Engineering mode. So if you do not
have Engineering rights, these can only be enabled for you by another user who
already has Engineering rights. After this happens, the Operating/Engineering button
will display in System Manager.

Changing Engineering Mode Rights

If you have … And Engineering Mode A message will inform you about these
Rights are toggled while changes…
you are working in …
Engineering rights Operating mode The Engineering/Operating mode button will
no longer be visible in System Manager.
No Engineering rights Operating mode The Engineering/Operating mode button will
become visible in System Manager.
Engineering rights Engineering mode You will be able to continue working in this
mode. The first time you switch to Operating
mode, the Engineering/Operating mode
button will no longer be visible in System
Manager.

27
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Engineering

2 System Architecture
Components of the Desigo CC software
The Desigo CC management system has a client-server architecture, in which a server
handles all interactions with the field networks and devices (such as fire panels, and so
forth) installed on the site, while the client is instead the user-facing application that
operators interact with.
A Desigo CC installation has only one server, but it can have multiple clients, running
on different computers. This allows multiple operators to manage and supervise the
same site.
The Desigo CC client application can be accessed in different ways:
 Installed Client (a fully fledged application installed on a computer)
 Web Client (a web application that runs inside a browser)
 Windows App Client (a light client downloaded and installed from a browser)

Stations of a Desigo CC installation

The computers running these various components of Desigo CC are referred to as
stations. In the Management View of System Browser, you can configure [➙ 42] the
following types of station objects:
 Main Server (required): The computer that runs the Desigo CC server. There can
only be one Main Server station. The Desigo CC client application is also always
installed on the Main Server station. This means that a minimal installation of
Desigo CC (standalone configuration) requires only the Main Server station.
 Client (optional): A separate computer running the Desigo CC client application.
There can be multiple client stations. (The client application is installed on all the
computers).
 FEP (optional): A computer running the FEP component of Desigo CC. There can
be multiple FEP stations. The Desigo CC client application is also installed on the
FEP station.
 Web Server (optional): A separate computer running the optional IIS web server
component. (Note that the IIS web server can be installed on the Main Server
station, in which case a separate Web Server station is not needed).
 Web Client (optional): A computer used to access the Desigo CC client as a web
application running inside a browser.
For more information about the stations see Stations [➙ 33].
The following sections provide information on how to configure the various stations
(Main Server, Client, FEP, Web Server, Web Client) of a Desigo CC installation, as
well as printers and devices such as UPS units and hard disks. For detailed
information about discipline-specific hardware, refer to the documentation of the
corresponding extension modules.

28
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Hardware Category and System Limits
2

2.1 Hardware Category and System Limits

Desigo CC deployments are classified as Class A, Class B, Class C, or Class D
systems depending on the hardware requirements (for example, CPU, memory, use for
clients, use for FEPs, and so forth) and the scale of the building control site (number of
field devices and subsystems, and so forth).

NOTE:
The System Description document (A6V10399117) details the criteria for determining
whether an installation is Class A, Class B, Class C, or Class D, and the hardware
requirements for each.

The Desigo CC software has a corresponding Hardware Category parameter that it

uses to define system limits (the maximum number of System-Browser-tree objects
that a project can have). The Hardware Category can be set to:
 HW Cat A = maximum 25000 objects
 HW Cat B = maximum 50000 objects
 HW Cat C = maximum 100000 objects
 HW Cat D = maximum 150000 objects
Desigo CC then monitors how close a project is operating to those system limits, and:
 Generates an alarm if the maximum permitted number of objects is exceeded.
 Prevents you from performing imports that would exceed the system limits.
 Warns you when you are approaching the system limits.
This avoids instability that may arise from overloading the management-system
hardware.
By default, the hardware category is set to HW Cat A, but you can adjust [➙ 32] this
value to HW Cat B, HW Cat C, or HW Cat D to match the actual hardware category of
the installation you are configuring.

View Hardware Class and System Limits

When you select the Main Server object in System Browser, the Operation and
Extended Operation tabs in the Contextual pane display the various properties and
commands of the Main Server object, which also include those relating to the hardware
category and system limits.

29
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Hardware Category and System Limits

System Limits Properties and Commands

In particular, here you can:

 View the number of objects that have so far been configured in the system
(Objects), and see how this value compares to the system limits (System Objects
Limit).
 Check the System Load, which indicates whether the number of configured objects
is below, close to, or above the system limits (Normal/Warning/Alarm).
 See the currently configured Hardware Category (HW Cat A, HW Cat B, HW Cat
C, or HW Cat D) and the System Objects Limit (maximum permitted objects) for
that category of the installation.
Details of these properties are provided below.

Objects
The total number of objects currently configured in the system. This value is
automatically checked and updated every 60 seconds.

System Objects Limit

The System Objects Limit property indicates the system limits: that is, the maximum
number of objects the project can have. Its value is determined by the Hardware
Category.

Hardware Category System Objects Limit

HW Cat A (default) 25000
HW Cat B 50000
HW Cat C 100000
HW Cat D 150000

30
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Hardware Category and System Limits
2

NOTE:
If the system limits are too limited and a project requires a larger number of objects,
contact Customer Support to increase the value of System Objects Limit.
A significant increase in the number of objects may require a hardware upgrade.
Contact Customer Support for assistance.

System Load
Indicates the loading of the system with respect to the system limits. In particular:
 If the number of objects is below both the system limits and the safety threshold,
the System Load property displays in the Extended Operation tab only, and
indicates Normal.
NOTE: In case of import operations, if the system limits and the safety threshold
are not exceeded, the import operation is carried out.
 If the number of objects is between the system limits and the safety threshold, the
System Load property displays in the Operation and Extended Operation tabs, and
indicates Warning.
NOTE: In case of an import operation, if that would exceed the safety threshold, a
warning message informs you how close you will come to the limit (for example,
95%) and you can choose whether or not to proceed.
 If the system limits are exceeded (for example, because of objects auto-discovery),
the System Load property displays in the Operation and Extended Operation tabs,
and indicates Alarm. Also, an alarm occurs in the system.
NOTE: In case of an import operation that would exceed the system limits, an error
message displays to inform you that the import operation will not start.

All Properties, Drivers Properties, and Alarm Properties

For further reference, the following properties are also available in the Extended
Operation tab only:
 All Properties: Total number of the properties available in the project.
 Drivers Properties: Total number of properties handled by the drivers.
 Alarm Properties: Total number of properties that can generate alarms.

Hardware Category
The Hardware Category property determines the system limits (maximum permitted
objects) and should be set [➙ 32] to match the actual hardware category (HW Cat A,
HW Cat B, HW Cat C, or HW Cat D) of the installation, as specified in the System
Description document (A6V10399117).

Notification Threshold
The safety threshold with respect to the system limits (namely, 90%).

31
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Hardware Category and System Limits

2.1.1 Adjusting the Hardware Category

The Hardware Category is the parameter that determines the system limits (maximum
number of objects) of a Desigo CC project. For more details, see Hardware Category
and System Limits [➙ 29].
By default the Hardware Category is set to HW Cat A (25000 objects), but you should
adjust it to match the actual hardware category of the installation you are configuring.
The System Description document (A6V10399117) details the criteria that determine
whether an installation is Class A, Class B, Class C, or Class D.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server.
3. In the Extended Operation tab of the Contextual pane, do the following:
a. From the drop-down list corresponding to the Hardware Category property select
a value different from the default (HW Cat B, HW Cat C or HW Cat D).
b. Click Apply.
 In the Extended Operation (or Operation) tab, the System Objects Limit value
reflects the system size selected (50000 objects for HW Cat B, 100000 objects for
HW Cat C, or 150000 objects for HW Cat D).

32
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Stations
2

2.2 Stations
The following describes the types of station (computers) you can configure and the
relevant installation features.

Station Types
The system comprises the following types of stations.

Station Description Notes

Server1) The computer that runs the Desigo CC Only one server (Main Server) is available with
server. It hosts all the data of the the installation.
installation (the project databases) and Under the Main Server, you can also manage the
connects to the field networks and configuration of:
subsystems of the building-control site.
(The Desigo CC client application is also  Hard disk drive [➙ 57]
installed on the Server station, so that this  Peripherals (server printer [➙ 62] and WMI
computer can function as a standalone UPS [➙ 66])
management station).  Remote notification services (mail, SMS, and
pager devices are already available with the
installation).
For more information, see Remote
Notifications [➙ 311].
 OPC DA Server
The OPC DA Server is discussed in the OPC
Server Manual A6V10381665.
Web Server A separate computer hosting an IIS web You can add only one Web Server. No other
server component, which enables the configuration is required.
functioning of Web clients and Windows
App clients. (Note that where the IIS web
server component can also be installed on
the Main Server station, in which case you
don’t need to configure a separate Web
Server station).
FEP1) A computer that is used for load-balancing The number of FEP stations you can add
(Front-end the network-based processing for a depends on system limits.
Processor) system. A FEP also provides the Under a FEP station, you can also manage the
connection between building-level devices configuration of:
(such as field panels) and the Desigo CC
server.  Client hard disk drive [➙ 57]
 WMI UPS [➙ 66]
 The Drivers [➙ 46] folder
Client A computer on which the Desigo CC client The number of client stations you can add
application is installed. depends on system limits.
Under a client station, you can also manage the
configuration of:
 Client hard disk drive [➙ 57]
 WMI UPS [➙ 66]
 The Drivers [➙ 45] folder
Web Client A computer that accesses the Desigo CC Only one default web client (anonymous web
client as a web application running inside a client) is available with the installation and you
web browser. Not all of the Desigo CC cannot delete it.
applications and features are available If necessary, you can configure additional
with a Web Client. identified web clients that require a host name
and a certificate.

33
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Stations

1) A time watchdog checks for any attempt to manually modify date and time (backward or forward) on
the server or FEP stations. In such cases, an entry is logged in the activity log of the History DB.
System synchronization affected by changes of UTC time, time zone, or daylight savings time will
not be logged in the History DB.

Client Options
Depending on the type of installation, the Desigo CC client application can be
accessed in different ways.

Client Option Description Usage Scenario Notes/Limitations

Installed Client Desigo CC is installed on The user is a company  Server installation allows complete
a server computer, or insider who operates access to system resources.
client/FEP computer that Desigo CC from a station  Closed Mode [➙ 54] is available
connects to the server. (server or client, or FEP).
 The following features are not
available for client/FEP installation:
– Import/export/upgrade of
libraries (including Object
Models and SiB-X import rules)
– Text localization import/export
Web Client Desigo CC runs in The user operates The following features are not available:
Microsoft Internet Desigo CC using  Closed Mode [➙ 54]
Explorer, and allows Internet.
access to local  Auto logoff (because of user
Fire and life safety inactivity)
resources only. The user functionality is view-only,
launches it on demand the user does not have  Multiple monitor support
from the web browser. control over it.  Operator switchover
The first time the user
 Request/transfer of Fire panel
accesses the Web
ownership
Client, they are required
to install the application  Recovery of the windows in case of
certificate. crash
 Import/export/upgrade of libraries
(including Object Models and SiB-X
import rules)
 Text localization import/export
Windows App Desigo CC looks like the The user is a mobile Each time the user launches Desigo CC
Client standard system insider, that is, someone as Windows App Client, a search for
software, but it allows who is a company system updates is performed. If a new
access to local insider and operates, in version of the system is available on the
resources only. It is most cases, using the Web Server, the user can choose to
downloaded on demand intranet and only update it or continue to use the previous
from the Web Server occasionally using the version.
each time the user Internet. The following features are not available:
launches it as Windows Fire and life safety
App Client, and installed  Closed Mode [➙ 54]
functionality is view-only,
directly using Microsoft the user does not have  Request/transfer of Fire panel
Internet Explorer. The control over it. ownership
user accesses the  Import/export/upgrade of libraries
system without being (including Object Models and SiB-X
required administrative import rules)
privileges or the need to
 Text localization import/export
install the application
certificate.

34
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Stations
2

2.2.1 User Interface Variants

User Interface Flexibility Mechanisms
The user interface of client stations can vary significantly depending on the following
main configuration options:
 Client Profiles, which define the screen layout and the interface behavior for event
(or alarm) handling
 Event Schemas, which define the appearance of events (icon, text, color, sound)

Client Profiles
A number of Client Profiles [➙ 37] are available that provide user interface variants to
suit multiple application solutions and geographical regions. Client Profiles define the
appearance and behavior of the Summary bar, Event List and other user interface
elements involved in handling alarms.
You can select a specific Client Profile for each client station. Alternatively, for greater
flexibility, you can omit the Client Profile setting on a station and instead configure a
specific Client Profile for each user who will work on that station.

Event Schemas
The system provides multiple Event Schemas to comply with specific requirements
concerning how alarms must be displayed. Only one Event Schema can be set and it
applies system-wide to all client stations.
Event Schemas consist of two sections: Category Mapping and Event Mapping.
 Category Mapping defines the Categories used to classify events and specifies
their names and colors.
– Categories typically correspond to the lamps of the Summary bar.
– Categories include Status, High, Medium, Life Safety, and so on.
 Event Mapping contains the applicable set of Alarm Classes and, for each of those,
specifies its Discipline, Category, and alarm Sound.
– Discipline defines the event's alarm icon.
– Category defines the event's text and color.
– Sound defines the audio file used to enunciate the event.
In practice, the Event Mapping list defines the characteristics of event types
applied in the system.
The global set of Alarms Classes is defined in a separate list. Each Alarms Class is
individually identified by a name and a short description. Alarm Classes are used to
uniquely identify the abnormal conditions across multiple and technically different
sources, and then harmonize their management when applied in Event Schemas.
 Alarm Classes include Access Denied, Door Alarm, Ground Fault, and so on.
Event Schemas associate the dozens of Alarm Classes to the small number of
Categories. In this way, it is possible to assign a Door Alarm to the High event Lamp,
or Ground Fault to Status, for example. Using the Event Mapping, the respective
events will have the appropriate icon, text, color, and sound.

NOTE:
Event Schemas and Alarms Classes are part of the system Libraries and not covered
in this manual. Libraries are only accessible to authorized specialists. For more
information, refer to the Library Management Guide (A6V10380499).

35
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Stations

Consistency between Client Profiles and Event Schemas

Client Profiles and Event Schemas can be selected separately with no apparent
constraints on their combination. However, to obtain a valid and compliant
configuration, the selected Client Profile and Event Schema must meet certain
consistency criteria. For more information, refer to Client Profiles [➙ 37].
In the System Management Console (SMC), you can restore a template project, which
provides a pre-defined configuration that includes the valid Event Schema for your
geographical region. The use of default projects helps avoid inconsistency problems
concerning Client Profiles and Event Schemas.
For more information, refer to the System Management Console Manual
(A6V10381671) or to the SMC online help.

36
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Stations
2

2.2.1.1 Client Profiles

The Client Profile is a configuration that can be applied to an individual user or station.
The selected Client Profile determines the appearance and behavior of the Summary
bar, Event List, and other system functions involved in handling alarms.

Client Profiles: BA_NA/BA_NA_timeout and KIOSK

Client Profile Name BA_NA BA_NA_timeout KIOSK
Summary bar Starts expanded. No Summary bar
The operator can collapse it.
Summary bar lamps Life Safety No lamps
(event indicators) High
Medium
Low
Fault
Status
Audio alert The operator can temporarily mute the No audio alert
audio alert or permanently disable it. When
it is muted, the sound is automatically re-
activated after 24 hours.
Event Detail bar Starts hidden. Not available
The operator can show/hide it on demand
from the Summary bar.
Contains one event only.
Event List availability, Starts hidden. Not available
background, and behavior The operator can:
 Show/hide Event List on demand from
the Summary bar.
 Resize the columns, change the
position of the columns, customize
how the columns display, and restore
default columns layout.
 Tag/untag events.
The following columns may also be
available: Name, Alias, Description [View],
and Location [View].
The background color is white. When the
operator selects an event, its background
color changes (to match the event
category color) and alarm-handling
commands become available.
Size of alarm-handling Small Not available
commands
Default event sorting  Unprocessed before unreset events Not available
 Unreset before acknowledged events
 Category
 Most recent event on top
The operator can also change default
event sorting.

37
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Stations

Event grouping Events belonging to the same source and Not available
category display grouped under a parent
event (recurring events).
The operator can display any recurrences
for those events by clicking the Counter
field in the event descriptor..
Out of filter The operator can activate/deactivate the Not available
ability to remove any applied filter when a
new event occurs that does not match the
event filter criteria.
Start Fast Treatment Click on an event button or event Not available
descriptor.
Start Double-click on an event button. Not available
Investigative/Assisted
Treatment

Client Profiles: FS_UL/FS_ULC and TBS_UL/TBS_ULC

Profile Name FS_UL FS_ULC TBS_UL TBS_ULC
Summary bar Starts expanded.
The operator cannot collapse it.
Summary bar lamps Life Safety Fire Alarm Life Safety Fire Alarm
(event Indicators) Security (not Emergency Security (not Emergency
used) Supervisory used) Supervisory
Supervisory Building Supervisory Building Safety
Trouble Safety Trouble Trouble
Fault Trouble High High
Status Fault Medium Medium
Status Low Low
Fault Fault
Status Status
Audio alert The operator can temporarily mute the audio alert. The sound is
automatically re-activated after 24 hours.
Event Detail bar Starts visible.
The operator cannot hide it.
Contains up to two events.
Event List availability, Starts collapsed to an Event Starts hidden.
background, and behavior bar on the left side of the The operator can:
screen, and is always visible.
 Show/hide Event List on
The operator can: demand from the Summary bar.
 Expand/collapse Event  Resize the columns, change the
List. position of the columns,
 Resize its columns. customize how the columns
display, and restore default
columns layout.
The following columns can also be
available: Name, Alias, Description
[View], and Location [View].
The operator cannot tag/untag events.

38
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Stations
2

The background color of each event in the list matches its event
category color. When the operator selects an event, its background
becomes of a darker shade, and any alarm-handling commands
display (if available).
Size of alarm-handling Large Small
commands
Default event sorting  Unprocessed before unreset events
 Unreset before acknowledged events
 Category
 IN events before OUT events
 Oldest event on top
The operator cannot change default event sorting.
Event grouping Not available. Events belonging to the same source and category
display as separate events in Event List.
Out of filter The operator can activate/deactivate the ability to remove any
applied filter when a new event occurs that does not match the
event filter criteria.
Start Fast Treatment Click on an event descriptor.
Start Click on an event button.
Investigative/Assisted
Treatment

In a project, the selected Client Profile must match the Event Schema [➙ 35]. Applying
a wrong Client Profile or Event Schema may result in system inconsistencies. Please
consider the following:
 For a consistent configuration, select the appropriate Event Schema first (note that
the Event Schema applies across the entire system) and then set a compatible
Client Profile, according to the following table.

Event Schema Compatible Client Project Templates Project Type / Region

Profiles
EN BA_EN Template_BA_EN Building Automation /
KIOSK Europe

FS_EN Template_Fire_EU Fire Project / Europe

(EN)
TBS_EN Template_TBS_EU Total Building Solution
KIOSK / Europe (EN)

DE FS_EN Template_Fire_DE Fire Project / Germany

(DIN)
UL BA_NA Template_BA_NA Building Automation /
BA_NA_timeout North America
KIOSK
FS_UL Template_Fire_UL Fire Project / North
America (UL 864)
TBS_UL Template_TBS_UL Total Building Solution
/ North America (UL
864)
ULC FS_ULC Template_Fire_ULC Fire Project / Canada
(ULC S527)

39
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Stations

TBS_ULC Template_TBS_ULC Total Building Solution

/ Canada (ULC S527)

2.2.1.2 Special Profile Setup: KIOSK Client Profile

The KIOSK Client Profile is a special profile that forces an installed client station to
operate with limited capability and no alarm handling. A graphic automatically displays
upon client startup to provide users with a graphical view.

NOTICE

You cannot use the KIOSK mode on web clients and windows app clients.

To properly setup a client with KIOSK Client Profile, apply the following guidelines:
 You have a running BA_NA installation.
 You have configured a client station to become a KIOSK station.
1. Using the separate SMC (System Management Console) application, create a
project starting from BA_NA template project.
– For more information about SMC, refer to the SMC online help.
2. Log on using an administration user account with configuration rights.
3. Create the KIOSK graphic.
You can configure a single graphic, possibly including multiple layers with dynamic
cycling effects, or create multiple graphics and include navigational links that allow
users a limited interaction with the system. Make sure that the only links users can
select on the KIOSK graphics are other KIOSK graphics, and provide links back to
a starting (home) page to prevent users from getting lost.
– For more information about creating graphics, refer to the Graphic Editor
Manual (A6V10380503).
4. Create a user-defined view (the KIOSK view) with all the graphics you want to
display in the KIOSK.
– For more information about creating a user-defined view, refer to Configuring a
User-defined View [➙ 131].
5. Associate the top node of the KIOSK view with the KIOSK home graphic. This
automatically occurs if you drop the top node of the KIOSK view on the KIOSK
home graphic.
– For more information about linking graphics to the view, refer to Linking a
Graphic to the Root Node of a View [➙ 135].
6. Create a new KIOSK user group with read-only permissions, and then a new user,
and associate the BA_NA profile to the user. It is recommended that you only allow
read access to the KIOSK user group.
– For more information about configuring user groups and new users, refer to
Configuring User Groups [➙ 81] and Configuring Users [➙ 93].
7. On the KIOSK client, log off and then log on again with the new user credentials.

40
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Stations
2

8. Navigate to the top node of the KIOSK view, and then log off.
NOTE: To exit from an installed client in KIOSK mode, use Task Manager to stop
the Application Framework. Then log on to the system using the administration
user to return to the normal client.
 The system will remember the last selected view, so the next time the KIOSK
user logs on, it will start at the KIOSK home graphic of which the top node of
KIOSK view is associated with.
9. Log on again using an administrator user account with configuration capability.
Navigate to the KIOSK user and associate the KIOSK client profile to the KIOSK
user.
Then, save the KIOSK user and log off.
10. Log on as KIOSK user and test the KIOSK client.
Adjust the configuration as necessary.
11. If Closed mode is required, go to the workstation configuration and select the
Closed mode option.
Make sure to associate the KIOSK Client Profile to the Closed-mode user (Default
User).
For more information about Closed mode, refer to Configuring a Client in Closed
Mode [➙ 54].

41
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Stations

2.2.2 Station Configuration Workspace

When you select a station object in System Browser (Main Server, Client, FEP, Web
Server, or Web Client), you can configure its settings in the System Management tab.

Main Server Settings

Client Settings

FEP Settings

Web Server Settings

42
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Stations
2

Default Web Client Settings

Identified Web Client Settings

System Management Toolbar

Icon Name Description
Add a new object The devices you can add depend on the station object
selected:
 Main Server
– Hard Disk Drive
– Server Printer
– WMI UPS
– OPC Server DA
The remote notification devices [➙ 312] are not
available from the drop-down menu because they
are included in the project by default.
The OPC Server DA is discussed in the OPC Server
Manual A6V10381665.
 Client\FEP\Web Server\Default Web Client and Web
Client:
– Client Hard Disk Drive
– WMI UPS
– Drivers folder
Save the Changes Saves any changes.

Delete Object Deletes the current object.

This icon is not available for the Main Server.

43
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Stations

System Management Fields

Item Description
Host name Label indicating the station address. You can either enter a host name
or select it from the network (Browse) or obtain the host name of the
current station (Current Station). This setting is required.
The host name for the Main Server is set during system installation
(field is read-only).
This setting is not available for the Default Web Client.
Type Indicates the type of station: Server, Client, FEP, Anonymous web
client (Default Web Client), Web Client, or Web Server.
This setting is available only when configuring a new client (Client, Web
Server, or Web Client). Once you save your configuration, you cannot
change this setting.
Client profile Specify the Client Profile associated to the current station.
For more details, see Client Profiles [➙ 37].
Control station Specify whether or not (Yes/No) the current station is able to control
Fire panels. Default is No.
This setting is not available for Web Clients.
For more details, see Enabling Control Station [➙ 51].
Closed mode Specify whether or not (Yes/No) the current station will work in Closed
mode. Default is No.
This setting is not available for Web Clients.
For more details, see Configuring a Client in Closed Mode [➙ 54].
Notes Enter any additional information. This field is optional and limited to 255
characters.
Certificate This setting is required and available only for the Identified Web Client.
It allows for providing secure web access with a client certificate. You
can select a certificate from a store location (Select certificate) or you
can remove the current certificate (Clear selection) and select another
certificate.

Technical Notes
 The Client Hard Disk Drive is a ULC requirement for monitoring system integrity in
ULC S527-approved computers (for more details, see the Fire Integration Guides).
 In the United States, fire-only station(s) must be set to Client Profile FS_UL.
 In Canada, fire-only station(s) must be set to Client Profile FS_ULC.
 Control station is a mandatory setting for UL 864-/ULC S527-compliant fire
management system running on a UL 864-/ULC S527-approved computer.

44
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Stations
2

2.2.3 Configuring the Stations

The following procedures describe how to configure the different types of stations
[➙ 33] of the management system.

2.2.3.1 Configuring the Server

The Desigo CC server comes configured with the installation. You can optionally
modify some of its settings.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server.
 The configuration user interface [➙ 42] displays in the Primary pane.
3. Specify the Client Profile [➙ 50].
4. (Optional) Enter any additional information in the Notes field.

5. In the System Management toolbar, click Save the changes .

 The System Manager status bar indicates that the data has been successfully
saved.

2.2.3.2 Configuring a Client Station

The Clients folder comes with the installation. Here you have to add and configure any
client stations (Installed Clients) required in the management system.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Management System > Clients.
 Object Configurator displays in the Primary pane.
3. In the Object Configurator toolbar, click New Object and select New Station.

4. In the Create New Object dialog box, do the following:

a. Type the Name and Description.
b. Click OK.
 The new node appears in System Browser.
5. In the Primary pane, click the System Management tab.
 The configuration user interface [➙ 42] displays in the tab area.
6. Specify the Host name in one of the following ways:
– Manually enter the computer host name.
– Click Browse. Then in the Browse for computer network dialog box select a
host name from the network.
– Click Current Station to obtain the host name of the current computer.
7. From the Type drop-down list, select Client.

45
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Stations

8. Specify the Client Profile [➙ 50].

9. (Optional) Enter any additional information in the Notes field.

10. In the System Management toolbar, click Save the changes .

 In the Extended Operation tab of the Contextual pane, the Configuration
parameter indicates Enabled. To disable the client station, see Enabling and
Disabling Clients [➙ 51].

Adding the Drivers Folder to a Client

Before you can add any specific drivers (if available), you must first add a Drivers
folder under each client station.
 System Manager is in Engineering mode.
 You are configuring a client station and System Management displays in the
Primary pane.

1. In the System Management toolbar, click New Object , and select New Drivers
Folder.

2. In the Create New Object dialog box, do the following:

a. Enter the Name and Description.
b. Click OK.
 The new folder object appears in System Browser.

2.2.3.3 Configuring a FEP Station

The FEP folder comes with the installation. Here you have to add and configure any
FEP stations required in the management system.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Management System> FEPs.
 Object Configurator displays in the Primary pane.
3. In the Object Configurator toolbar, click New Object and select New FEP.

4. In the Create New Object dialog box, do the following:

a) Enter the Name and Description.
b) Click OK.
 The new node appears in System Browser.
5. In the Primary pane, click the System Management tab.
 The configuration user interface [➙ 42] displays in the tab area.
6. Specify the Host name in one of the following ways:
– Manually enter the computer host name.
– Click Browse. Then in the Browse for computer network dialog box select a
host name from the network.
– Click Current Station to obtain the host name of the current computer.
7. Specify the Client Profile [➙ 50].

46
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Stations
2

8. (Optional) Enter any additional information in the Notes field.

9. In the System Management toolbar, click Save the changes .

 The System Manager status bar indicates that the data has been successfully
saved.

Adding the Drivers Folder to a FEP

Before you can add any drivers, you must first add a Drivers folder under each FEP
station.
 System Manager is in Engineering mode.
 You are configuring a FEP station and System Management displays in the
Primary pane.

1. In the System Management toolbar, click New Object , and select New Drivers
Folder.

2. In the Create New Object dialog box, do the following:

a. Enter the Name and Description.
b. Click OK.
 The new folder object appears in System Browser.

2.2.3.4 Configuring the Web Server

Generally, the IIS web server component (required to support Web Clients and
Windows App Clients) can be installed on the same computer as the Desigo CC
Server.
However, if the IIS web server is installed on a different computer from the Desigo CC
Server, you must configure the Web Server station (under the Clients folder) as
follows.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Management System > Clients.
 Object Configurator displays in the Primary pane.
3. In the Object Configurator toolbar, click New Object and select New Station.

4. In the Create New Object dialog box, do the following:

a. Type the Name and Description.
b. Click OK.
 The new object appears in System Browser.
5. In the Primary pane, click the System Management tab.
 The configuration user interface [➙ 42] displays in the tab area.
6. Specify the Host name in one of the following ways:
– Manually enter the computer host name.
– Click Browse. Then in the Browse for computer network dialog box select a
host name from the network.
– Click Current Station to obtain the host name of the current computer.

47
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Stations

7. From the Type drop-down list, select Web server.

8. Specify the Client Profile [➙ 50].
9. (Optional) Enter any additional information in the Notes field.

10. In the System Management toolbar, click Save the changes .

 In the Extended Operation tab of the Contextual pane, the Configuration parameter
indicates Disabled. To enable the Web Server, see Enabling and Disabling Clients
[➙ 51].

2.2.3.5 Configuring the Default Web Client

The Default Web Client is an anonymous web client that has no host name and result
in using Internet services anonymously. The Default Web Client object comes with the
installation and can be used as an individual Web Client when secure web access
does not require host name and a client certificate to run Desigo CC as a Web Client
or as a Windows App Client. You can optionally configure some of its settings.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Management System > Clients > Default Web Client.
 The configuration user interface [➙ 42] displays in the Primary pane.
3. Specify the Client Profile [➙ 50].
4. (Optional) Enter any additional information in the Notes field.

5. In the System Management toolbar, click Save the changes .

 In the Extended Operation tab of the Contextual pane, the Configuration parameter
indicates Disabled. To enable the Default Web Client, see Enabling and Disabling
Clients [➙ 51].

2.2.3.6 Configuring an Identified Web Client

An identified web client is characterized by a host name and a certificate. The identified
web client objects do not come with the installation. You must add and configure them
when secure web access requires a host name and a client certificate to run Desigo
CC as a Web Client or as a Windows App Client.
 System Manager is in Engineering mode.
 You have imported the certificate for the identified web client.
NOTE: The certificate must have been acquired (a commercial SSL certificate) or
created and then imported using the System Management Console (SMC). To
manage non-commercial certificates, we recommend to carefully follow the
instructions provided in the Security Configurations and Typical Deployments
manual (A6V10534530) and in the SMC manual (A6V10381671), and use
meaningful names to identify the certificates.
1. In System Browser, select Management View.
2. Select Project > Management System > Clients.
 Object Configurator displays in the Primary pane.

48
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Stations
2

3. In the Object Configurator toolbar, click New Object and select New Station.

4. In the Create New Object dialog box, do the following:

a. Type the Name and Description.
b. Click OK.
 The new node appears in System Browser. The configuration user interface
[➙ 42] displays in the Primary pane.
5. Specify the Host name in one of the following ways:
– Manually enter the computer host name.
– Click Browse. Then in the Browse for computer network dialog box select a
host name from the network.
– Click Current Station to obtain the host name of the current computer.
6. From the Type drop-down list, select Web client.
7. Click Select Certificate.
 The Select Certificate dialog box displays, and shows the certificate store.
8. In the Select Certificate dialog box, locate and select the certificate for the
Identified Web Client.
NOTE: The Store Location selection, at the top of the dialog box, can be User or
Local machine, depending on whether the certificate was imported for a single user
or for all users of the Identified Web Client. The dialog box also includes various
certificate store tabs. Typically, you can find the correct certificate in the Personal
or in the Trusted Root Certification Authorities tab, depending on the security
infrastructure in place.
Proceed as follows:
a. From the Store Location drop-down list, select the appropriate item (User
certificates or Local machine certificates).
b. Select the appropriate certificate store tab (Personal, Trusted Root Certification
Authorities, Trusted Publisher, Third-Party Root Certification Authorities,
Intermediate Certification Authorities, or Untrusted Publisher).
c. In the selected certificate store, select the appropriate certificate.
d. Click OK.
 The selected certificate appears in the Certificate field. To clear a certificate
and pick a new one, click Clear selection and repeat the previous sub-steps.
9. Specify the Client Profile [➙ 50].
10. (Optional) Enter any additional information in the Notes field.

11. In the System Management toolbar, click Save the changes .

 In the Extended Operation tab of the Contextual pane, the Configuration
parameter indicates Enabled. To disable the Identified Web Client, see
Enabling and Disabling Clients [➙ 51].
12. Complete the configuration by creating the authenticated web client group [➙ 83].

49
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Stations

NOTICE

Self-signed certificates are supported to allow local deployments without the

overhead of obtaining commercial certificates. When using self-signed certificates,
the owner of the Desigo CC system is responsible for maintaining their validity status,
and for manually adding them to and removing them from the list of trusted
certificates.

Self-signed certificates must only be used in accordance with local IT regulations

(several CIO organizations do not allow them, and network scans will identify them).
Importing of commercial certificates follows the same procedures.

2.2.3.7 Setting the Client Profile

Client Profiles [➙ 37] determine the appearance and behavior of the alarm handling
features.
After installation or project restore, Desigo CC starts with the DEFAULT profile
associated to the user.
NOTICE! DEFAULT is a generic Client Profile always available and intended only for
configuration use (the user interface allows more space on the screen for the
configuration applications.) To prevent system inconsistencies, remember to specify
the appropriate Client Profile at the station or user level.
 If you do not specify the Client Profile for a station, the Client Profile associated
with the current user will be dynamically applied to the station.
 If you specify the Client Profile for both the station and user, the Client Profile
associated with the station will be applied to the user.
 System Manager is in Engineering mode.
 You want to specify the Client Profile for a station.
 You are configuring the Main Server, Client, FEP, Web Server, or Web Client and
System Management displays in the Primary pane.
1. From the Client Profile drop-down list, select the appropriate setting.
In particular:
– UL 864-compliant fire stations only: select FS_UL or TBS_UL.
– ULC S527-compliant fire stations only: select FS_ULC or TBS_ULC
NOTE: Client Profile and project event schema must always match. For more
details, see User Interface Variants [➙ 35].
2. In the System Management toolbar, click Save the changes .

3. The System Manager status bar indicates that the data has been successfully
saved.

Technical Notes
 The Client Profiles available for the configuration depend on the installation or on
the restored project template.
 If you modify the Client Profile for a client running in the system, when you save the
changes, a message box informs you that this setting has been changed and the
changes will be applied at the next work session.

50
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Stations
2

 To activate auto logoff when the user has been inactive for a certain amount of
time, you must select the appropriate Client Profile with the following naming
convention: [Client Profile]_timeout.

2.2.3.8 Enabling Control Station

NOTICE! This setting is mandatory for UL 864-/ULC S527-compliant fire management
system running on a UL 864-/ULC S527-approved computer.
Control Station is a special setting that you can configure only for an Installed Client.
 By default Control Station is set to No meaning that the station cannot manage Fire
commands, and the operator can view (but not issue) Fire commands. When
setting No, to properly configure the station, remember to disable the Command
Groups within the relevant scope (for example, Fire).
 Setting Yes means that the station can manage Fire commands, and the operator
can issue Fire commands. To properly configure the control station, you must also
create a Fire scope, and enable the Command Groups.
 System Manager is in Engineering mode.
 You want to enable Control Station for a UL 864-compliant or ULC S527-compliant
fire station.
1. In System Browser, select Management View.
2. Depending on the fire station to configure, select one of the following:
– Project > Management System > Servers > Main Server
– Project > Management System > Clients > [Client/Web Server]
– Project > Management System > FEPs > [FEP]
 The configuration user interface [➙ 42] displays in the Primary pane.
3. From the Control station drop-down list, select Yes.

4. In the System Management toolbar, click Save the changes .

 The station can manage Fire commands, and the operator can issue Fire
commands.

2.2.3.9 Enabling and Disabling Clients

This is a special feature available only for Installed Clients, Web Server, and Web
Clients.
When a client is enabled, logging on to Desigo CC from that station is allowed.
When a client is disabled, logging on to Desigo CC from that station is denied.
Desigo CC server and FEP stations are enabled by default and cannot be disabled.
For the other station types, by default:
 Default Web Client is enabled
 When creating a new station object:
– Installed Clients and identified Web Clients are enabled
– Web Server is disabled
You can change this default setting from the Extended Operation tab of the Contextual
pane.

51
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Stations

Disabling a Client
 System Manager is in Engineering mode.
 For security reasons you want to deny logon to Desigo CC for a station by
modifying the default setting for an Installed Client or a Web Client, or by restoring
the default setting for the Web Server.
1. In System Browser, select Management View.
2. Select Project > Management System > Clients.
3. Select the station to disable.
4. In the Contextual pane, click the Extended Operation tab.
 The Operational Status property indicates Enabled.
5. Click Disable.
 The Operational Status property becomes Disabled, meaning that logon to Desigo
CC from that station is denied.

Enabling a Client
 System Manager is in Engineering mode.
 You want to allow logging on to Desigo CC by restoring the default setting for an
Installed Client or a Web Client or by modifying the default setting for the Web
Server.
1. In System Browser, select Management View.
2. Select Project > Management System > Clients.
3. Select the station to enable.
4. In the Contextual pane, click the Extended Operation tab.
 The Operational Status property indicates Disabled.
5. Click Enable.
 The Operational Status property becomes Enabled, meaning that logon to Desigo
CC from that station is allowed.

52
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Stations
2

2.2.3.10 Deleting a Station

NOTICE! You cannot delete the Main Server or the Default Web Client.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Depending on the object you want to delete, select one of the following:
– Project > Management System > Clients > [Client/Web Server/Web Client]
– Project > Management System > FEPs > [FEP]
 The configuration user interface [➙ 42] displays in the Primary pane.
3. In the System Management toolbar, click Delete object .
 A confirmation message box asks if you want to delete the selected object.
4. Click Yes to confirm the operation.
 The selected object is removed from System Browser.

53
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Stations

2.2.4 Configuring a Client in Closed Mode

Closed mode is a special setting that you can configure only for an Installed Client. In
Closed mode, the station is dedicated to running the Desigo CC client application, and
the user cannot shut down Desigo CC or access the operating system functions.
Specifically:
 When in Closed mode, the Desigo CC client application runs with the
GMSDefaultUser logged on, and operators can only access Desigo CC according
to the Default Users group permissions. The Windows Task Manager, Windows
Taskbar, and desktop icons are unavailable.
 In Closed mode, when the client station boots up the GMSDefaultUser is
automatically logged on into Windows.
NOTE: the GMSDefaultUser password is entered during the SMC project creation.
A user account is automatically created in both Windows and Desigo CC with that
password. In case of password changes in the Windows user, make sure to always
have the same password configured in SMC.
 Operators cannot shut down the station or log off from the current closed-mode
session. An authorized user can, however, take over the station using the Operator
Switchover menu command, to logon and gain access to more system functions.
At that point, a logoff command will automatically re-enable the GMSDefaultUser
session.
 We recommend not to enable the Closed mode on the station where the Main
Server is installed. Use the Closed mode on client stations of client/server
architectures.
 Setting a station to Closed mode prevents operators from restarting the GMS client
application and applying system configuration changes that require a restart.

NOTICE

GMSDefaultUser Special Settings

1) GMSDefaultUser is Windows user that must have full access rights to the
[installation drive:]\[installation folder]\[project] folder on the server (for example
C:\GMSProjects\MyProject).
Using Windows Explorer, you can enable such access in the security properties of the
project folder.
For more information about folder security, refer to Windows documentation.
2) If you use a secure client/server connection, GMSDefaultUser must be included in
the list of Host Certificate Users of the project.
Using SMC, you can configure such list in the Security expander of the project
settings.
For more information about SMC security, refer to the System Management Console
Manual (A6V10381671) or to the SMC online help.

In Closed mode, the following shortcut keys are also disabled:

 CTRL+SHIFT+ESC
 Windows key+Pause/Break
 Windows key+R
 Windows key+L
 Windows key+F
 Windows key+CTRL+F
 Windows key+D

54
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Stations
2

 Windows key+U
 Windows key+F1
 Windows key+E
 SHIFT+DEL
 ALT+TAB
 ALT+ENTER

NOTE:
Even though the CTRL+ALT+DEL shortcut key is enabled, the system disables all the
buttons in the Windows Security window except Cancel.

2.2.4.1 Enabling Closed Mode

 System Manager is in Engineering mode.
 You want to enable the Closed mode setting for a station.
1. In System Browser, select Management View.
2. Select Project > Management System > Clients.
3. Select the station to set in Closed mode.
 System Management displays in the Primary pane.
4. From the Closed mode drop-down list, select Yes.

5. In the System Management toolbar, click Save the changes .

 The operator can run the Desigo CC client in Closed mode [➙ 54].

Station is Switched to Closed Mode when Desigo CC is Not Running

In this scenario, as soon as the operator starts Desigo CC a message box displays to
inform of the switch to Closed mode.
 In the message box, click Do Now.
 Desigo CC starts in Closed mode. Default User is automatically logged on.

Station is Switched to Closed Mode when Desigo CC is Already

Running
In this scenario, a message box displays to inform the operator using that station of the
switch to Closed mode.
 In the message box, click Do Now.
 Desigo CC closes and restarts in Closed mode. Default User is automatically
logged on.

55
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Stations

2.2.4.2 Disabling Closed Mode

 System Manager is in Engineering mode.
 You want to disable the Closed mode setting for a station.
1. In System Browser, select Management View.
2. Select Project > Management System > Clients.
3. Select the station in Closed mode.
 System Management displays in the Primary pane.
4. From the Closed mode drop-down list, select No.

5. In the System Management toolbar, click Save the changes .

 Closed mode is disabled for the selected station. The Windows default user is
logged off and the Windows logon screen displays. The operator using that station
can log on to the Windows operating system and then launch the Desigo CC client
with appropriate access to system resources.

2.2.4.3 Closed Mode Troubleshooting Guidelines

In case of problems on a station in Closed mode, to unlock the system, you can:
1. Contact Customer Support to get detailed information about the Windows registry
settings that force the Closed mode.
2. Power on the computer in Closed mode.
3. Start Windows in Safe Mode by pressing F8 (Windows 7) or SHIFT+F8 (Windows
8.1) and selecting the Safe Mode.
NOTE: Depending on the specific BIOS and configuration settings of the computer,
the F8/SHIFT+F8 procedure may not work. In such cases, you can only access the
computer over the network or reboot from a Windows System Recovery device
(DVD or Memory Stick).
4. Access Windows using an Administrator account.
5. Use Regedit to modify the registry and remove the Closed mode settings as
instructed by Customer Support.

56
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Hard Disk Drive Monitoring
2

2.3 Hard Disk Drive Monitoring

You can configure Desigo CC to automatically monitor the hard disk of a server, client,
or FEP station [➙ 33].
To do this, you first create a hard disk drive object under the station that you want to
monitor, and then specify what drive (for example C:, D:, or E: ) you want the object to
monitor.
You can monitor:
 (On any station) The status of the hard drive, so that a management station alarm
occurs if it is faulty. Status monitoring is automatically enabled when you create the
hard disk drive object.
 (Only on the server station) The disk capacity of the hard drive, so that a
management station alarm occurs when the amount of disk space is insufficient.
This needs to be manually configured after you create the hard disk drive object.
NOTICE! When you restore a project template, an object for monitoring the hard disk
drive of the server station is automatically created (set by default to monitor drive C:).
You can later edit its default settings. For other stations, you must manually create the
object.

Workflow
To set up status monitoring of a hard disk drive, do one of the following:
 Configure a hard disk drive object under the server station [➙ 58].
 Configure a hard disk drive object under a FEP or client station [➙ 60].
To set up monitoring of disk capacity (you can only do this on the server station):
 If you haven’t already done so, configure a hard disk drive object under the server
station [➙ 58].
 Enable and configure disk space monitoring [➙ 59].

Hard Disk Drive Configuration

When you are working in Engineering mode and select a hard disk drive (or a client
hard disk drive) object in System Browser, the System Management tab displays in the
Primary pane.
From here you can:
 Specify the drive letter that this object should monitor and save ( ).

 Delete [➙ 61] the hard disk drive object ( ).

57
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Hard Disk Drive Monitoring

2.3.1 Monitoring the Disk Status for the Server

To monitor the status of the hard disk of the Desigo CC server you only need to
configure the hard disk drive object under the server. A management station alarm will
occur when the monitored disk drive is faulty (or if the object is improperly configured
for example, with an invalid or unspecified drive letter).
NOTICE! When you restore a project template, a hard disk drive object is automatically
configured to monitor the status of drive C: under the Main Server). If this default
setting is correct, you can skip the following procedure. Otherwise, you can modify the
default configuration (for example, selecting a different drive letter)
 System Manager is in Engineering mode.
 You previously configured the Desigo CC server [➙ 45].
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server.
3. If a hard disk drive object already exists and you want to edit its settings, select the
hard disk drive object under Main Server and skip to step 7. Otherwise, to add and
configure a new hard disk drive object, continue from step 4 below.
4. In the Primary pane, click the System Management tab.
 The stations configuration workspace [➙ 42] displays in the Primary pane.
5. In the System Management toolbar, click Add a new object , and select New
Hard Disk Drive.

6. In the Create New Object dialog box, do the following:

a) Type the Name and Description for the hard disk drive.
b) Click OK.
 The new hard disk drive object appears in System Browser. The System
Management hard disk drive configuration workspace [➙ 57] displays in the
Primary pane. Because no drive letter has been specified yet, in the Operation
tab of the Contextual pane, the Device Status is Faulty. Consequently, a
management station alarm occurs within the system.
7. In the System Management tab, from the Select disk drive drop-down list, select
the drive letter that you want this object to monitor (For example, C:).

8. To save the changes, in the System Management toolbar, click Save .

 If the configuration is correct, after a few seconds the Device Status becomes
Normal and disk space values (Disk free space, Disk total space, and Disk used
space) display in the Operation tab of the Contextual pane. Consequently, the
management station alarm is automatically cleared from the system.

58
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Hard Disk Drive Monitoring
2

2.3.2 Monitoring the Disk Space for the Server

To monitor the hard disk space on the Desigo CC server, you must first configure
[➙ 58] a hard disk drive object under Main Server, and make sure it points the drive
letter (for example C: ) that you want to monitor. Doing this automatically enables the
status monitoring of the specified drive. Then you can also set up disk capacity
monitoring by specifying which event(s) will occur when the disk capacity falls below
certain limits.
 System Manager is in Engineering mode.
 You previously configured a hard disk drive object under the Project >
Management System > Servers > Main Server.
1. In System Browser, select Project > Management System > Servers > Main
Server.
2. Under Main Server, select the hard disk drive object.
3. In the Primary pane, click the Object Configurator tab.
 Object Configurator displays in the Primary pane.
4. Open the Properties expander, and select the Status.DiskfreeSpace property.
5. Open the Alarm Configuration expander, and do the following:
– Select the Valid check box.
– Select the Management Station radio button.
– From the Alarm kind drop-down list, select Continuous.
– Define the Alarm Class as follows:
a) From the Alarm Class field, select the alarm category.
b) In the Limiting Value fields, select the relational operator > and then enter
the limit value (in MB).
c) In the Event Text field, enter the description for the alarm.
For example, Low disk. Contact admin to free up disk space on the station.
6. Select the Alarm config. activated option.
7. (Optional) To log entries in the system Activity log for any changes pertaining to
disk capacity, in the Properties expander, select the AL check box for the
Status.DiskfreeSpace property.
NOTE: Use this settings with caution, because it might result in a considerable
amount of logged data.

8. To save the changes, in the Object Configurator toolbar, click Save .

 When the free space on the disk falls below the values specified in Limiting Value,
the configured management station alarm will occur in the system.

Technical Notes
 When restoring a project template, Limiting Value is automatically set to 1 GB
(1000 MB). We recommend the same setting when manually configuring this value.
 When you upgrade a previous version of the project to a newer version, remember
to check the alarm configuration settings for disk space monitoring. If disk space
monitoring is not configured, you must manually configure it (follow the above
procedure).

59
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Hard Disk Drive Monitoring

2.3.3 Monitoring the Disk Status for a Client or a FEP

To monitor the status of a hard disk drive on a client or FEP station, you only need to
configure a client hard disk drive object under the station. A management station alarm
will occur when the monitored disk drive is faulty, or when the object is improperly
configured (for example, drive letter invalid or not specified).
 System Manager is in Engineering mode.
 You previously configured a client [➙ 45] or a FEP [➙ 46] station.
1. In System Browser, select Management View.
2. Depending on where you want to add the disk, select one of the following:
– Project > Management System > Clients > [Client]
– Project > Management System > FEPs > [FEP]
3. In the Primary pane, click the System Management tab.
 The stations configuration workspace [➙ 42] displays in the Primary pane.
4. In the System Management toolbar, click Add a new object , and select New
Client Hard Disk Drive.

5. In the Create New Object dialog box, do the following:

a) Type the Name and Description for the hard disk drive.
b) Click OK.
 The new hard disk drive object appears in System Browser. The System
Management hard disk drive configuration workspace [➙ 57] displays in the
Primary pane. Because no drive letter has been specified yet, in the Operation
tab of the Contextual pane, the Device Status is Faulty. Consequently, a
management station alarm occurs within the system.
6. From the Select disk drive drop-down, select the drive letter that corresponds to
the hard disk that you want to monitor.

7. To save the changes, in the System Management toolbar, click Save .

 If the configuration is correct, after a few seconds the Device Status becomes
Normal in the Operation tab of the Contextual pane. Consequently, the
management station alarm is automatically cleared from the system.

60
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Hard Disk Drive Monitoring
2

2.3.4 Deleting a Hard Disk Monitoring Object

 System Manager is in Engineering mode.
 A hard disk drive object is available in System Browser.
1. Depending what you want to delete, in the Management View of System Browser
select one of the following:
– Project > Management System > Servers > Main Server
– Project > Management System > Clients > [Client]
– Project > Management System > FEPs > [FEP]
2. Select the hard disk drive object you want to remove.
3. In the Primary pane, click the System Management tab.
 The hard disk drive configuration workspace [➙ 57] displays in the Primary
pane.
4. In the System Management toolbar, click Delete .
 A confirmation message box asks if you want to delete the selected item.
5. Click Yes to confirm the operation.
 The selected object is removed from System Browser.

61
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Server Printers

2.4 Server Printers

The server printer is one of the peripherals that you can configure add under theDesigo
CC server.

Server Printer Configuration

When you are working in Engineering mode and select a server printer object in
System Browser, the System Management tab displays in the Primary pane.
You can:
 Configure [➙ 63] the printer settings and save ( )

 Delete [➙ 65] the server printer ( )

Server Printer Fields

Field Description
Printer name Select the printer.
This field is required. The list contains all non-virtual printers directly
connected to the Server.
Printer type Select the printer type (Line printer or Page printer).
Default is Line printer.
Journaling printer Define whether or not the current local printer must be also used a
journaling printer.
Default value is No.
Notes Edit any additional information.
This field is optional and limited to 255 characters.

62
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Server Printers
2

2.4.1 Configuring Server Printers

The following procedures describe how to configure server printers.

2.4.1.1 Adding a Server Printer

 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server.
3. In the Primary pane, click the System Management tab.
 The server printer configuration workspace [➙ 62] displays in the Primary
pane.
4. In the System Management toolbar, click Add a new object , and select New
Server Printer.

5. In the Create New Object dialog box, do the following:

a. Type the Name and Description for the server printer.
b. Click OK.
 The new server printer object appears in System Browser.

2.4.1.2 Setting a Server Printer

 System Manager is in Engineering mode.
 You previously added [➙ 63] a server printer object in System Browser.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server.
3. Under the Main Server, select the server printer object you want to configure.
4. In the Primary pane, click the System Management tab.
 The server printer configuration workspace [➙ 62] displays in the Primary
pane.
5. Select the Printer name.
6. If necessary, change the Printer type default setting.
7. If the current printer is a journaling printer, change Journaling printer value to Yes.
8. (Optional) Enter your remarks in the Notes field.

9. To save the changes, in the System Management toolbar, click Save .

 The System Manager status bar indicates that data was successfully saved.

Configuration Tips
 UL 864 compliant systems require specific settings. For more information see
UL/ULC Compliance for Journaling Template and Line Printer [➙ 252].

63
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 Server Printers

 An error message displays if the required data is missing or invalid. Once you’ve
entered the required data, you can complete the printer configuration.
 If you are configuring a server printer from a station that is not the server, when you
select the printer name the Server parameters dialog box displays. Enter
Domain\Username and Password, and then click OK.

2.4.1.3 Setting the Journaling Printer in Windows 7

In order to allow the Journaling printer to work properly, you must set its properties in
Windows 7 as follows:
1. Click the Windows Start button, and select Devices and Printers.
2. In the Devices and Printers dialog box, right-click the printer used as journaling
printer, and select Printer properties.
3. In the [Printer] Properties dialog box, click the Security tab.
4. Click Add.
5. Enter the object SYSTEM.
6. Click OK.
 SYSTEM appears among the Groups or user names.
7. Select SYSTEM.
8. In the Permission for SYSTEM, allow the following options:
– Print
– Manage this printer
– Manage documents
9. Click OK.

64
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
Server Printers
2

2.4.1.4 Deleting a Server Printer

 System Manager is in Engineering mode.
 A server printer object is available in System Browser.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server.
3. Select the server printer object you want to remove.
4. In the Primary pane, click the System Management tab.
 The server printer configuration workspace [➙ 62] displays in the Primary
pane.
5. In the System Management toolbar, click Delete the current object .
 A confirmation message box asks if you want to delete the selected item.
6. Click Yes to confirm the operation.
 The selected object is removed from System Browser.

65
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 WMI UPS

2.5 WMI UPS

The WMI UPS is a peripheral that you can configure under the Desigo CC stations
(server, client, or FEP) and retrieve the status information of a UPS using the Windows
Management Instrumentation (WMI) service.

WMI UPS Configuration

When you are working in Engineering mode and select a WMI UPS object in System
Browser, the System Management tab displays in the Primary pane.
You can:
 Configure the WMI UPS settings and save.

 Make a copy of the configuration and save it with a different name ( ).

 Import ( ) WMI UPS data from a configuration file (XML).

 Export ( ) WMI UPS data to a configuration file (XML) for later reuse.

 Delete the WMI UPS ( ).

2.5.1 General Settings

The General Settings expander lets you configure [➙ 68] the following settings:
 Class name
 Device ID
 Vendor and type
 Version
You can also enter comments or remarks in the Notes field.

66
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
WMI UPS
2

2.5.2 Properties
The Properties expander lists all the properties of the WMI UPS device. For each
property in the list, you can configure [➙ 68] the following settings:
 Property name (name of the property)
 Matching values (whether or not a property has a matching value, and the related
value)

2.5.3 Configuring the WMI UPS

The following procedures describe how to configure the WMI UPS.

Configuration Workflow
 Add [➙ 67] the WMI UPS object under the wanted station (server, client, or FEP).
 Configure [➙ 68] the WMI UPS and save the configuration. Or import [➙ 70] a
configuration file (XML). Or start from an existing configuration to create a new
[➙ 69] WMI UPS.
 Export [➙ 70] the configuration data of the WMI UPS for later use in other systems
or projects.
 If a WMI UPS is no longer required, delete [➙ 71] the WMI UPS object.

2.5.3.1 Adding a WMI UPS

 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Depending on the station where you want to add the WMI UPS device, select one
of the following:
– Project > Management System > Servers > Main Server
– Project > Management System > Clients > [Client station]
– Project > Management System > FEPs > [FEP station]
3. In the Primary pane, click the System Management tab.
 The stations configuration workspace [➙ 42] displays in the Primary pane.

67
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 WMI UPS

4. In the System Management toolbar, click Add a new object , and select New
WMI UPS.

5. In the Create New Object dialog box, do the following:

a. Type the Name and Description.
b. Click OK.
 The new WMI UPS object appears in System Browser.

2.5.3.2 Setting a WMI UPS

Once you add a WMI UPS object to the project, you can either import [➙ 70] a
configuration file (XML) or manually edit its configuration.
 System Manager is in Engineering mode.
 You previously added [➙ 67] the WMI UPS object in System Browser.
1. In System Browser, select Management View.
2. Depending on the station where the WMI UPS object is located, select one of the
following:
– Project > Management System > Servers > Main Server
– Project > Management System > Clients > [Client station]
– Project > Management System > FEPs > [FEP station]
3. Select the WMI UPS object.
4. In the Primary pane, click the System Management tab.
 The WMI UPS configuration workspace [➙ 66] displays in the Primary pane.
5. Open the General Settings expander [➙ 66], and configure the following settings:
– Class name
Indicates the class of information provided by the WMI UPS device. This data
is used in the device export name.
– Device ID
Indicates the identifier of the WMI UPS device.
– Vendor and type
Indicates the device vendor and device type. This data is used in the device
export name.
– Version
Indicates the version of the WMI UPS device. This data is used in the device
export name.
– (Optional) Enter your remarks in the Notes field.
– Click Save.
6. Open the Properties expander [➙ 67].
7. For each property in the list:
– Select it and configure the Property name.
– (Optional) Select the Matching values option, and enter the appropriate
numeric value.

68
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
WMI UPS
2

– Click Save.
To save the current configuration as a new WMI UPS (that is, re-using this
configuration to create another WMI UPS), see Creating a WMI UPS from an Existing
One [➙ 69].
To export the current configuration for later use, see Exporting the Configuration of a
WMI UPS [➙ 70].

2.5.3.3 Creating a WMI UPS from an Existing One

You can make a copy of the configuration of a WMI UPS device by opening it and
saving it with a different name.
Also, instead of configuring a WMI UPS from scratch, you can start from an existing
configuration, make changes to it, and then save it as a new WMI UPS.
 System Manager is in Engineering mode.
 At least one WMI UPS object is available in System Browser.
1. In System Browser, select Management View.
2. Depending on the station where the WMI UPS object is located, select one of the
following:
– Project > Management System > Servers > Main Server
– Project > Management System > Clients > [Client station]
– Project > Management System > FEPs > [FEP station]
3. Select the WMI UPS that corresponds to the configuration you want to re-use.
4. In the Primary pane, click the System Management tab.
 The WMI UPS configuration workspace [➙ 66] displays in the Primary pane.
5. If necessary, make changes to the WMI UPS settings.

6. To save the settings into a new WMI UPS object, in the System Management
toolbar, click Save As .

7. In the Save Object As dialog box, do the following:

a. Select the location in the tree (under Management System > Main Server,
Management System > Clients, or Management System > FEPs) where you want
to save this WMI UPS object.
b. Enter the Name and Description of the WMI UPS.
c. Click OK.
 The new WMI UPS device object appears in System Browser and is fully
configured.
To export the current configuration for later use, see Exporting the Configuration of a
WMI UPS [➙ 70].

69
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
2 WMI UPS

2.5.3.4 Exporting the Configuration of a WMI UPS

Once you add [➙ 67] and configure [➙ 68] a WMI UPS in the project, you can export
its configuration.
 System Manager is in Engineering mode.
 You want to export the configuration data of a WMI UPS for later reuse.
1. In System Browser, select Management View.
2. Depending on the station where the WMI UPS is located, select one of the
following:
– Project > Management System > Servers > Main Server
– Project > Management System > Clients > [Client station]
– Project > Management System > FEPs > [FEP station]
3. Select the WMI UPS object that corresponds with the configuration you want to
export.
4. In the Primary pane, click the System Management tab.
 The WMI UPS configuration workspace [➙ 66] displays in the Primary pane.
5. To export the configuration, in the System Management toolbar, click Export .
 The configuration data is exported in an XML file which is saved in the
GMSProjects/[Project]/devices folder.

Tips for Exporting the Settings

 During export, an error message informs you if the General Settings are not
properly configured or the Properties configuration is missing. Another message
informs you if a file having the same name already exists, and asks if you want to
overwrite the existing file. Click Yes to overwrite it.
 The naming convention for the exported file is the following:
[class name].[Vendor And Type].[Version].[Device Type].

2.5.3.5 Importing the Configuration of a WMI UPS

Once you add a WMI UPS device to the project, instead of manually editing [➙ 68] its
configuration you can import data from an XML file, which is created by the system
when you export [➙ 70] a WMI UPS device.
 System Manager is in Engineering mode.
 You previously added [➙ 67] the WMI UPS object in System Browser. Or you want
to update the configuration of a WMI UPS by importing data.
 An XML file containing WMI UPS configuration data is available in the following
project folder: C:\GMSProjects/[Project]\devices.
1. In System Browser, select Management View.
2. Depending on the station where the WMI UPS is located, select one of the
following:
– Project > Management System > Servers > Main Server

70
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 System Architecture
WMI UPS
2

– Project > Management System > Clients > [Client station]

– Project > Management System > FEPs > [FEP station]
3. Select the WMI UPS object you want to configure.
4. In the Primary pane, click the System Management tab.
 The WMI UPS configuration workspace [➙ 66] displays in the Primary pane.
5. To import the configuration, in the System Management toolbar, click Import .

6. In Select device to import dialog box, select the XML file that corresponds to the
appropriate device version. Then, click Import.

Technical Notes
 If the device being imported is the same as the one used for creating the
configuration file, the configuration data is copied from file to device/property.
 If the properties names do not match, the Combines the properties dialog box
displays and asks you to match the properties in the file with the device properties.
Select the correct matching, and click Import.

2.5.3.6 Deleting a WMI UPS

If a WMI UPS is no longer required and you want to remove it, proceed as follows:
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Depending on the station where the WMI UPS to remove is located, select one of
the following:
– Project > Management System > Servers > Main Server
– Project > Management System > Clients > [Client station]
– Project > Management System > FEPs > [FEP station]
3. Select the WMI UPS object you want to delete.
4. In the Primary pane, click the System Management tab.
 The WMI UPS configuration workspace [➙ 66] displays in the Primary pane.
5. In the System Management toolbar, click Delete .
 A confirmation message box asks if you want to delete the selected item.
6. Click Yes to confirm the operation.
 The object is removed from System Browser.

71
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Security Concept

3 User Administration
This section discusses setting the display and operation rights for the individual user
groups and users. The main criteria for issuing user rights are:
 Which discipline (Fire, ventilation, safety, and so on) belongs to the work
environment.
 Which duties (Engineering, service, monitoring, and so on) must be executed.
 Which building or section is the work executed.
Desigo CC permits limiting user rights, for example, users can only see and operate
their room.

NOTE:
In Desigo CC some user groups are predefined and can be modified and extended by
project.

Logon and Access Rights

Four factors essentially determine logon and access rights in Desigo CC:
 The system must know the user
 The user must be assigned a user group
 The user must the appropriate application rights
 The user must have the appropriate scope rights
The user can log into Desigo CC if these conditions are met. The user may be able to
execute the corresponding Desigo CC functions, depending on the assigned rights.

NOTE:
The user must log in as DefaultAdmin the first time Desigo CC is started. The
DefaultAdmin password is set while System Management Console creates the
project.

3.1 Security Concept

Describes the behavior in Desigo CC for:
 Default user groups (see Default User Groups [➙ 73])
– Fallback policy
– Default administrator
– Default user
 User groups (see User Groups [➙ 74])
 Access rights (see Access Rights [➙ 75])
– Full
– Restricted

72
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Security Concept
3

3.1.1 Default User Groups

The following user groups are already available for a new project:
 FallbackPolicy
– Users belong to the FallbackPolicy until assigned to a user group. Unassigned
users are not displayed in Configured Users or in User Members.
– You can change settings and rights as needed.
– The FallbackPolicy cannot be deleted.
 DefaultAdmins
– The DefaultAdmin user has full access rights to the system by default. As a
result, do not take rights away until you have defined your own administrator
with full rights.
– You cannot delete the DefaultAdmins user groups and the DefaultAdmin user.
– You cannot add new users to this user group.
 DefaultUsers
– You cannot delete the DefaultUsers user group and the DefaultUser user.
– Users cannot be added or deleted.
– The DefaultUser is always active when the management station is in Closed
mode (Windows authentication).

NOTE:
● Passwords for DefaultAdmin are defined for the first time during project creation by
System Management Console.
● The password can be changed in:
- System Management Console
- Desigo CC > System Settings > Users > User Configuration > Change Password
(by any administrator who has the right to configure users) or by the DefaultAdmin
using the Operator > Change password menu in the upper right of the Summary bar.
● The password at the time of the last save applies when restoring a project. This is
true as well if another password is defined during installation (for example, at the
customer).

NOTE:
We recommend assigning all rights to a user group Supervisor for project
administration. The appropriate project administrators can be added and managed in
this group.

73
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Security Concept

3.1.2 User Groups

Using different user groups allows you to control user access rights for a project. User
rights are granted in a group depending on activity or experience of individual users.
The rights can be limited to:
 Applications
 Disciplines
– Disciplines configured directly within the user group
– Assigned using Scopes [➙ 221]
The table below shows an example of different user group accesses to applications
and disciplines.

Example User Groups

User Group Default Application Rights Property Groups
Group
Show Configure R (Read) W (Write)
FallbackPolicy Yes - - - -
DefaultAdmin Yes All All All All
DefaultUser Yes - - - -
OPCGroup Yes - - - -
Supervisor No All All All All
Group 1 No A+B+C A+B 1+2+3 1+2+3
Group 2 No A+B A 2+3 3
Group 3 No C - 3 -

Explanation based on user group 2:

 Application: A user of user group 2 can display and configure application A as
needed (for example, modify objects). This user can only display application B, but
not configure it. Application C is not accessible (does not display) to all users of this
user group.
 Property Groups: A user of user group 2 can read and write discipline 3 in either
application A or B (for example change a data point). This user can only read
discipline 2, but not write to it. Discipline 1 is not accessible (no read/write) to all
users of this user group.

74
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Security Concept
3

3.1.3 Access Rights

 Full access rights
Access rights to an object in Desigo CC depend on various factors. You do not need to
define Scopes if you want to assign full access rights to a user group. To operate and
monitor, you must assign write rights for the property group and enable the command
group. The following diagram illustrates full access rights:

User View of Structured BACnet Objects (full access)

Plant Aggregate Function Property 1 Property 2
Ventilation East Supply air fan 2-speed Present value Status flag
Ventilation East Pump 1-speed Present value Status flag
Ventilation East Supply air Expositions Present value Status flag
temperature.
Ventilation - Basement Pump 1-speed Present value Status flag
Heating West Pump 1-speed Present value Status flag
Fire Zone A Manual Present value Status flag

 Restricted access rights

The following example illustrates how to define the operation of a property, for
example, present value for a single-speed pump. The display of the object is very
limited. You can have a more open view of the objects using a wildcard in normal
projects. The following illustrates restricted access rights:

75
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 User Administration Workspace

You can detail the view of an object by using Scopes, Scope filter, and user rights.
However, to operate and monitor, you must assign write rights for the status in the
property group and enable the standard command group.

Restricted User View of Structured BACnet Objects

Plant Aggregate Function Property 1 Property 2
Ventilation East Pump 1-speed Present value
Heating West Pump 1-speed Present value

Member of Multiple User Groups

A user can be a member of multiple groups. Whether or not it makes sense to assign a
user to more than one group depends on how the customer defines the groups. Users
belonging to more than one group have all the rights provided by each of the groups.
You can create one group each with complete rights if you have three different kinds of
operators. In this scenario it does not make sense to add a user to more than one
group.
However, you can also define more detailed groups with each group possessing the
rights for specified tasks in certain areas.
For example: A customer has a number of buildings with operators spread out among
the buildings; each with full access to the local building, but restricted access to other
buildings. You can define different operator groups for each building and assign the
operator to building-specific groups with the appropriate rights. Users typically belong
to more than one detailed group.
Smaller systems typically apply the former approach; larger and more distributed
systems may prefer to take the latter approach.

3.2 User Administration Workspace

In the Security tab, you can:

76
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
User Administration Workspace
3

 Create a new user group

 Assign a user to a user group
 Assign scopes to the user group
 Define the application rights

Security Dialog

Name Description
1 Toolbar Displays the icons for operations such as Add, Delete, Save, and so on.
2 Groups Lists all default groups and created user and management station
groups.
3 Type Displays assignment based on settings under Item 5.
4 Group Configuration expander Displays the user group settings and list of members.
5 Group type Defines whether it is a user group or management station group.
6 Group information Shows advanced information on the related group.
7 User Members Lists all members belonging to this group. Does not display a user
under the FallbackPolicy (see Default User Groups [➙ 73])
8 Configured Users expander Lists possible candidates that can be added to the selected group.
Does not display a user under the FallbackPolicy (see Default User
Groups [➙ 73])
9 Scopes Rights expander Defines the Scope rights [➙ 221] assigned to this group. It is displayed
in if rights are configured for a scope that no longer exists. Such a
scope right gets ignored in runtime authorization.
10 Application Rights expander Defines the applications and functions [➙ 100] (toolbar display)
displayed, or that can be operated for the user or management system.

77
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 User Administration Workspace

3.2.1 Toolbar
User Groups Toolbar
Icon Name Description
Add Creates a new user group.
Delete Deletes the selected user group.
Save Saves the user group.

Save As Saves the user group under a new name.

Tool Area Switches configured users on and off.

78
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
User Administration Workspace
3

3.2.2 Scope Rights

Scopes (see Scopes [➙ 221]) are used in various applications such as Journaling,
RENO, and macros, to define display and operation. In Security, scopes are used to
configure access rights for a group. You can assign several scopes to a group, which
allows you to configure different rights on a scope for different filter settings (for
example, Discipline, Subdiscipline, Object Type and Object Subtype).

Name Description
1 Scope List of assigned Scope definition.
2 Operand for disciplines *, = or ≠
and subdisciplines. *Full access to all objects.
=Only objects that match the selection.
≠All objects do not correspond to the selection.
3 Discipline List of available disciplines.
4 Subdiscipline List of available subdisciplines.
5 Operand for type and *, = or ≠
subtype.
6 Object Type List of available types.
7 Object Subtype List of available subtypes.
8 Property Groups Define property operation and display. Enable Configuration, Diagnostics, Status and
Ownership as per user level.
‒= No view of objects.
R= Read only.
W= Read and write rights.
9 Command Groups Defines for the Contextual pane Operation or Extended Operation tabs, if a button is
accessible. Enable Standard, Advanced, Event, and Ownership as per user level.
10 Create In the selected application, new objects (for example, folder, network) can be created in
System Browser and saved. While saving, an error message displays if you have insufficient
rights. NOTE: Application rights Show and Configure must be selected to perform creation.

11 Delete In the selected application, available objects (for example, folder, network) can be deleted
in System Browser and saved. While deleting, an error message displays if you have
insufficient rights. NOTE: Application rights Show and Configure must be selected to perform
deletion.

12 Visible Always active and cannot be changed. All data points matching the scope filter are visible.

79
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 User Administration Workspace

User Group and Management Station Group

Object visibility and rights can be set using a user group scope and management
station group scope:
 User group scopes act as OR (see Creating a New User Group [➙ 82]).

Rights Scope 1 Rights Scope 2 Rights Scope 3 Rights for Scopes

Yes OR No OR No = 1
Yes OR Yes OR No = 1+2
No OR Yes OR Yes = 2+3
Yes OR Yes OR Yes = 1+2+3

 User group scopes and management station group scopes act as AND (see
Creating a New Management Station Group [➙ 82]).

User Group Management Visibility on the

Scope Station Group Management
Scope Station
Scope Definition 1 Yes AND No = No
Scope Definition 2 Yes AND Yes = Yes
Scope Definition 3 No AND Yes = No

NOTE:
A management station automatically has full access rights to all objects for a project if
the station is not assigned to a management station group.

NOTICE

No More Access Rights to the Project

Be careful. If scope rights and application rights are not correctly assigned, you may
revoke all rights for the operation. In this case, you must restore the last project
backup.
There is a risk of data loss since the last project backup!

80
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
User Administration Workspace
3

3.2.3 Configuring User Groups

The following workflow displays the steps to create a user group, as well as
management station user group.

User group

Create new user group

Management station type

Select group type

User type Station Anonymous Web client

Type

Identified Web client

Assign identified Web Assign default Web

Assign users Assign stations
clients client

Reduced rights Scope definition

Scope rights

Full rights

Assign scope
Assign reduced scope Assign full scope Assign reduced scope
definitions and reduced
rights rights rights
scope rights

Assign reduced
Assign applications rights
application rights

Defined user group

81
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 User Administration Workspace

3.2.3.1 Creating a New User Group

 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings > Security.
 The Security tab displays.
3. Click Add .

4. Type a unique name for the group.

5. In the Group Configuration expander, select Group type, and then select User.
6. Type a description for the new user group in the Text field.

7. Click Save .
 A new user group is created.
Next steps:
1. Assign user (see Assigning Users to a User Group [➙ 85]).
2. Assign scope rights (see Assigning Full Scope Rights [➙ 86], Assigning Reduced
Scope Rights [➙ 86], Assigning Pre-defined Scope Definitions [➙ 88]).
3. Assign application rights (see Assigning Application Rights for Applications [➙ 89]).

NOTE:
The name for user groups and management stations groups must be unique
throughout the system.

3.2.3.2 Creating a New Management Station Group

 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings > Security.
 The Security tab displays.
3. Click Add .

4. Enter a name for the management station group in the Groups field.
NOTE: The group name for user groups and management stations must be unique
throughout the system.
5. Select the Group Configuration expander, Group type, and then select the option
Management Station.
6. Enter a description for the new management station user group in the Group
information field.
7. In the Scope Rights expander, enter the scope rights (Assigning Full Scope Rights
[➙ 86] or Assigning Reduced Scope Rights [➙ 86]).

82
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
User Administration Workspace
3

8. In the Application Rights expander, select the application rights (Assigning

Application Rights for Applications [➙ 89]).
9. Select the Configured Management Stations expander, and then select a Client
and assign it to the Management Station Members.

10. Click Save .

 A new management station group is created.

NOTICE

No More Access to the Project

You will no longer be able to work on the assigned management station if you have
not previously assigned scope rights and application rights to the management station
group. A restore of a project backup is required in this case!

3.2.3.3 Creating Station Group for Identified Web Clients

NOTICE

To Many User Rights for Anonymous Web Client

To ensure an anonymous Web client [➙ 84] does not have more rights than an
identified Web client, the user rights of the anonymous Web client must be limited.
Reason: If the Web client is disabled or if the Web certificate is no longer valid, the
fallback user for the anonymous Web client is used for login.

 System Manager is in Engineering mode.

 One or more identified Web clients [➙ 48] are created.
1. In System Browser, select Management View.
2. Select Project > System Settings > Security.
 The Security tab displays.
3. Click Add .

4. Enter a name for the new group in the Groups field.

NOTE: The group name for user groups and management stations must be unique
throughout the system.
5. In the Group Configuration expander, select Group type, and then select the option
Management Station.
6. Enter a description for the group in the Group information field.
7. In the Scope Rights expander, enter the scope rights (Assigning Full Scope Rights
[➙ 86] or Assigning Reduced Scope Rights [➙ 86]).
8. In the Application Rights expander, select the application rights (Assigning
Application Rights for Applications [➙ 89]).

83
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 User Administration Workspace

9. Select the Configured Management Stations expander, and then select a identified
Web client and assign it to the Management Station Members.
NOTE: The enabled check box is for display only. It shows whether or not a station
is currently enabled. Enabling/disabling a station is done by selecting the station in
System Browser and executing the corresponding command in the Extended
Operation tab.

10. Click Save .

 A new authenticated Web client management station group is created.

3.2.3.4 Creating Station Group for Anonymous Web Client

An anonymous Web client is already available in the system Project > Management
System > Clients > Default Web Client. The Default Web Client is not automatically
assigned to a management station group.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings > Security.
 The Security tab displays.
3. Click Add .

4. Enter a name Anonymous Web client for the new group in the Groups field.
NOTE: The group name for user groups and management stations must be unique
throughout the system.
5. In the Group Configuration expander, select Group type, and then select the option
Management Station.
6. Enter a description Anonymous Web client for the group in the Group information
field.
7. In the Scope Rights expander, enter the scope rights (Assigning Reduced Scope
Rights [➙ 86]).
NOTE: Do not define full access rights for the anonymous Web Client.
8. In the Application Rights expander, select the application rights (Assigning
Application Rights for Applications [➙ 89]).
NOTE: Do not define full Application Rights for the anonymous Web Client.
9. Select the Configured Management Stations expander, and then select a Web
Client and assign it to the Management Station Members.
NOTE: The enabled check box is for display only. It shows whether or not a station
is currently enabled. Enabling/disabling a station is done by selecting the station in
System Browser and executing the corresponding command in the Extended
Operation tab.

10. Click Save .

 A anonymous Web client management station group is created.

84
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
User Administration Workspace
3

3.2.3.5 Assigning Users to a User Group

 System Manager in Engineering mode.
 Create a new user group or expand an existing one.
1. Select the user group.
2. Select a user (or multiple users) from the user list in the Configured Users
expander.
3. Drag-and-drop your selection to the User Members list.
 The user is moved from Configured Users list to the Users Members list.
4. Click Save .
 The user is assigned to the user group and enabled.

NOTE:
A user can belong to multiple user groups [➙ 75]. In this case, the rights are treated
as OR.

NOTE:
Assigning user groups to users is the same as assigning users to user groups. As a
consequence, it does not matter where the assignment is made.

3.2.3.6 Assigning Clients to a Management Station Group

 System Manager is in Engineering mode.
 You have created a new management station group or want to expand an existing
one.
1. Select Project > System Settings > Security.
2. Select the user group for the management station.
3. Select a client (or multiple clients) from the client list in the Configured
Management Stations expander.
4. Drag-and-drop it to the Management Station Members list.
 The client is moved from Configured Management Stations list to the
Management Station Members list.
5. Click Save .
 The client is assigned to the Management Station Group and enabled. A client can
be assigned to multiple Management Station Groups. In this case, the rights are
treated as OR.

85
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 User Administration Workspace

3.2.3.7 Assigning Full Scope Rights

 System Manager is in Engineering mode.
 A user group is selected.
1. In the Scope Rights expander, select the Scope column.

2. Click Add .
 Scope entry ALL is created.
3. Configure the scope entry as follows for the user group to have all rights:
– Discipline: * ALL
– Subdiscipline : * ALL
– Object Type : * ALL
– Object Subtype: * ALL
– Property Groups: Status = W, Configuration = W, Diagnostic = W
– Select Command Groups, Create, Delete and Vis check boxes.
4. Click Save .
 A user group is defined with all rights.

Displays Scope Rights with Full Access

3.2.3.8 Assigning Reduced Scope Rights

NOTICE

Scope Rights not Updated

After you change or assign Scope rights to a user group, you must stop and restart
the client application for the new Scope rights to take effect.
If you are working in Closed mode, contact the system administrator to change the
settings from another station. The client application cannot be shut down on a client
station that is running in Closed mode.

 System Manager is in Engineering mode.

 A user group is selected.
1. In the Scope Rights expander, select the Scope column.

2. Click Add .
 Scope entry ALL is created.
3. Configure the scope entry as follows for a user group with restricted rights:

86
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
User Administration Workspace
3

– Discipline: Select an option.

– Subdiscipline : Select an option.
– Object Type : Select an option.
– Object Subtype: Select an option.
– Property Groups: Status = -/R or W, Configuration = -/R or W, Diagnostic = -/R
or W.
– (Optional) Select the Command Groups, Create and Delete check boxes.
4. Repeat Steps 2 and 3 to add another scope entry.

5. Click Save .
 A user group is defined with restricted rights.

Displays Scope Rights with Restricted Access

NOTE:
The filters for discipline and object type impact every data point for a project. You can
set up an object filter in the Object Configurator for each, individual data point. The
image below shows an individually configured data point independent of the restricted
scope rights.

1. In System Browser, select Management View.

2. In System Browser, select [My Project] > Field Networks > [BACnet network 1] >
Hardware > [device] > [data point].
3. Define the object filter in the Object Configurator. Select the Main expander and
then Classification settings.

87
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 User Administration Workspace

3.2.3.9 Assigning Pre-defined Scope Definitions

 System Manager is in Engineering mode.
 A user group is selected.
 You have created a Scope definition (see Scopes [➙ 221]).
1. In System Browser, select the Manual navigation check box.
2. Select Project > System Settings > Scope > [your scope definition].
3. Drag-and-drop the selected scope definition to the Scope Rights expander.
 Only the objects or applications that were created in the scope definition
display.
4. Configure the scope entry as follows for a user group with restricted rights:
– Discipline: Select an option.
– Subdiscipline : Select an option.
– Object Type : Select an option.
– Object Subtype: Select an option.
– Property Groups: Status = -/R or W, Configuration = -/R or W, Diagnostic = -/R
or W.
– (Optional) Select the Command Groups, Create and Delete check boxes.
5. Repeat Steps 3 and 4 for another scope entry.

6. Click Save .
 A user group is created using scope definitions with restricted rights.

Displays Pre-defined Scope Rights

88
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
User Administration Workspace
3

3.2.3.10 Assigning Application Rights for Applications

 System Manager is in Engineering mode.
1. Select Project > System Settings > Security.
2. Select the appropriate user group.
3. Select the Application Rights expander.

4. Click the Splitter button to hide the Operation/Related Items pane.

5. Select the check box for the corresponding applications to be enabled for this user
group.
6. Select or clear the required functions.
NOTE: See the table in Assigning Application Rights [➙ 100] in Applications.
7. Repeat Step 5 for all applications.

8. Click Save .

NOTE:
When you change the application rights for a user group, the changes take effect
immediately, even if those users are currently logged on and using the system.

Display States
Check box key:
 The subordinate folders have active and inactive states.

 State active (True)

 State inactive (False).

3.2.3.11 Removing a User from a User Group

 System Manager is in Engineering mode.
1. Select Project > System Settings > Security.
2. Select the appropriate user group.
3. In the Group Configuration expander, select User Members list, and then select the
appropriate user.
4. Click Remove button or press [Delete] key.
 The user is removed from the User Members list and added to the Configured
Users list.
5. Click Save .

89
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Creating Users

3.2.3.12 Copying a User Group

 System Manager is in Engineering mode.
1. Select Project > System Settings > Security.
2. Select the user group to copy.

3. Click Save As .

4. Enter a new name for the user group.

5. Click Save .
 The new user group, with the same rights as the original user group, is saved.

3.2.4 Checking Sessions

 System Manager is in Engineering or Operating mode.
1. In System Browser, select Management View.
2. Select Project > System Settings > Users.
3. Click the Sessions tab.
 All active sessions with User Name, Station Name, Profile Name, Logon Time,
and Session State display.
4. (Optional) Select a session and click Terminate to close an active session.

Active Sessions Display

3.3 Creating Users

In the Users tab, you can:
 Create a new local or Windows user
 Change user account type
 Modify or delete existing users
 Assign user group to a user

90
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Creating Users
3

Dialog Users

Name Description
1 Toolbar Displays the icons for operations such as Add, Delete, Save, and so on.
2 Users Lists all the defined users with access to Desigo CC. A user name is used to log on to
Desigo CC.
3 Enabled When selected, a user can operate Desigo CC (default setting). Disabled users cannot log
on to Desigo CC.
4 Group membership Displays the user group assignment to a user.
5 Configured groups Displays user groups that can be assigned a user.
6 New password Enter a new user password. Desigo CC has no password policy.
(local user only)
7 Confirm new password Confirm the new password.
(local user only)
8 Apply Saves a new password immediately. The Apply button applies only to a changed password,
(local user only) and is available only if the confirmation matches the password
NOTE: A password is not saved with Save.
9 Allow logon attempts Allows you to specify how many times a user can attempt to log on to Desigo CC.
10 Attempts allowed The number entered determines the number of wrong logons that are available to a user. A
user is locked from logging on to Desigo CC for 5 minutes when the number of attempts is
exceeded.
11 Deny Logoff When selected, a user cannot exit the management station.
12 Language Defines the language displayed in the user dialog boxes for Desigo CC.

91
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Creating Users

13 Client Profile Defines display of Desigo CC applications on the management station (affecting Summary
Bar lamps, Event List, Event Detail Bar, and so on). For more information, see Client Profile
section.
14 Full Name Descriptive user name, displayed in the Summary bar.
15 Comment Additional information to describe a user, for example, office number.

Client Profile
Various profiles are available for the individual disciplines or applications. The list of
available client profiles depends on the specific installation. For detailed information,
refer to the Station Configuration Workspace [➙ 42] section.

NOTE 1:
The following user activities are recorded in Desigo CC
● Creating or deleting a user
● Changing a password
● Changing a user (without detail information on the change).
NOTE 2:
The user DefaultAdmin is assigned to the DefaultAdmins user group, and DefaultUser
user is assigned to the DefaultUsers group. Neither can be deleted. Ensure that you
remember the password at a later date. Desigo CC does not provide a backdoor for
forgotten passwords.

3.3.1 Toolbar
User toolbar
Icon Name Description
Add Creates a new user.
Delete Deletes the selected user.

Save Saves the users.

Save As Saves the user under a new name.

Edit Changes the user account type from local user to Windows user or vice
versa.
Tool Area Switches Configured Groups on and off.

92
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Creating Users
3

3.3.2 Configuring Users

The following workflows shows the general steps for creating user. For more
information, see the detailed workflows in the following chapters (see diagram).

User group exists

Create new user

Windows Local
User type

Create Windows
Create local user
user

Assign user group Change password

Define user properties

Enabling user

User defined

 System Manager is in Engineering mode.

 You have created one or several user groups under folder Desigo CC > System
Settings > Security (see Configuring User Groups [➙ 81]).
1. In System Browser, select Management View.
2. Select Project > System Settings > Users.
 The Users tab displays.
3. Click Add .

4. Create one of the following users:

– Local user: define the user name and password and click OK.
– Windows user: select the domain and user and click OK.
5. Click Save .

93
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Creating Users

6. Select one or more user groups and drag-and-drop them to the User Configuration
list.
NOTE: User groups must be created in advance.
7. Define the User Configuration, User Settings, and User Information.
8. Select the Enabled check box for the corresponding user.

9. Click Save .
 The user is defined.

NOTE:
For security reasons, it is recommended that you do not use a local Windows user in
a multiple management station topology. Instead, use a Windows domain user or a
local Desigo CC user. Use a local Windows user for a single management station
topology only.

3.3.2.1 Creating a New Local User

 System Manager is in Engineering mode.
 You have created one or several user groups under the folder Desigo CC >
System Settings > Security (see Configuring User Groups [➙ 81]).
1. In System Browser, select Management View.
2. Select Project > System Settings > Users.
 The Users tab displays.
3. Click Add .
 The New User dialog box displays.
4. Select the User type option Desigo CC.
5. Type a unique user name in the User name field.
6. Type a password in the Password field.
7. Confirm the password in the Confirm password field.
8. Click OK.

9. Click Save .
 The user is created, but not configured.
Next steps:
1. Assign a user group (see Assigning a User Group to a User [➙ 96]).
2. Define user properties (see Defining User Properties [➙ 96]).
3. Define a password (see Changing a Password [➙ 97]).
4. Enable a user (see Enabling a User [➙ 97]).

94
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Creating Users
3

3.3.2.2 Creating a New Windows User

This section describes how to define a Windows user account to log on to Desigo CC

Windows Logon

 System Manager is in Engineering mode.

 You have created one or several user groups under the folder Desigo CC >
System Settings > Security (see Configuring User Groups [➙ 81]).
1. In System Browser, select Management View.
2. Select Project > System Settings > Users.
 The Users tab displays.
3. Click Add .

4. Select the User type option Windows and click Browse.

 The Select User dialog box displays.
5. Click the Other Domains tab.
6. In the Select Domain section, select your desired domain.
7. In the Enter username or user account section, type the domain user name and
click Check Name.
 The list of available users displays.
8. Select the desired name and click OK.
NOTE:
If the user already exists, the name displays in red.
9. Click OK.

10. Click Save .

 The user is created, but not configured.
Next steps:
1. Assign a user group (see Assigning a User Group to a User [➙ 96]).
2. Define user properties (see Defining User Properties [➙ 96]).
3. Enable a user (see Enabling a User [➙ 97]).

95
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Creating Users

3.3.2.3 Creating a New Local Windows User

NOTE:
For security reasons, we recommend not using a local Windows user in a multiple
management station topology. Instead, use a Windows domain user or a local Desigo
CC user. Use local Windows user for a single management station topology only.

3.3.2.4 Assigning a User Group to a User

 System Manager is in Engineering mode.
 You have created your own user group (default user groups do not display).
 You have created a new user or want to change an existing user.
1. Select Project > System Settings > Users.
 The Users tab displays.
2. Select a user.
3. Select the Configured Groups expander, and select the appropriate user group
from the User Group list.
4. Drag-and-drop the user group to the User Configuration list.
 The user is moved from Configured Groups list to the Group Membership list.
5. Repeat Steps 1 through 3 for additional user groups that you want to assign to the
user.

6. Click Save .
 The user group is assigned to the user.

NOTE:
Assigning user groups to users is the same as assigning users to user groups. As a
consequence, it does not matter where the assignment is made.

3.3.2.5 Defining User Properties

 System Manager is in Engineering mode.
 You have created a new user or want to change an existing one.
1. Select Project > System Settings > Users.
 The Users tab displays.
2. Select a user.
3. Select the User Configuration expander.
– Select the Deny logoff check box if the user is not permitted to shut down.

96
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Creating Users
3

– Select the Attempts allowed check box and define the maximum number of
Desigo CC log on attempts. The user is locked from logging on to Desigo CC
for 5 minutes when the number of attempts is exceeded.
4. Select the User Settings expander.
– Under Language, select the appropriate language.
– Under Client profile, select the corresponding user profile to layout Desigo CC.
NOTE: The correct schema for your region is assigned to the project. the
schema contains the mapping of categories, events and colors for the
representation of the alarm summary bar.
5. Select the User Information expander.
– Enter an expanded user description in the entry Full name field. This text
displays as the user name on the Summary bar.
– Enter an expanded description, for example office number, and so on in the
Comment field.
6. Click Save .

3.3.2.6 Changing a Password

 It is a local user.
 System Manager is in Engineering mode.
1. Select Project > System Settings > Users.
 The Users tab displays.
2. Select a user.
3. Select the Change Password expander and enter a new password in the New
password field.
4. Confirm the new password in the Confirm new password field.
 Apply is enabled if the password matches.
5. Click Apply. The password is not saved with !
 The new password is now saved.

3.3.2.7 Enabling a User

 System Manager is in Engineering mode.
1. Select Project > System Settings > Users.
 The Users tab displays.
2. Select a user.
3. Select Enabled for the corresponding user.

4. Click Save .
 The user is enabled and can logon to Desigo CC.

97
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Creating Users

NOTE:
You can lock a user at any time with the appropriate user rights. Clear the Enabled
check box.

3.3.2.8 Modifying Users

 System Manager is in Engineering mode.
1. Select Project > System Settings > Users.
 The Users tab displays.
2. Select a user.
3. Change the desired settings for the user.

4. Click Save .
 The user is modified.

3.3.2.9 Changing User Account Type

An existing local user can be changed to a Windows user (or vice versa). The existing
user settings are retained.
 System Manager is in Engineering mode.
1. Select Project > System Settings > Users.
 The Users tab displays.
2. Select a user.

3. Click Edit .

4. Select one of the following user types:

– Desigo CC: see Creating a New Local User [➙ 94]
– Windows: see Creating a New Windows User [➙ 95]
5. Click OK.

6. Click Save .
 The user account is changed and can logon with the new account to Desigo CC.

98
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Creating Users
3

3.3.2.10 Sorting Users

 System Manager is in Engineering mode.
1. Select Project > System Settings > Users.
 The Users tab displays.
2. Click the Users column header.
 Users are sorted alphabetically from A-Z.
3. (Optional) Click the Users column header again.
 Users are now sorted alphabetically from Z-A.

3.3.2.11 Removing a User Group

 System Manager is in Engineering mode.
1. Select Project > System Settings > Users.
 The Users tab displays.
2. Select a user.
3. In the User Configuration expander, highlight the appropriate user group.
4. Click Remove button or press [Delete] key.

5. Click Save .
 The user no longer has any rights from the unassigned user group.

3.3.2.12 Deleting Users

 System Manager is in Engineering mode.
1. Select Project > System Settings > Users.
 The Users tab displays.
2. Select a user.

3. Click Delete or press [Delete] key.

 The user is deleted and can no longer logon.

99
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Application Rights

3.4 Application Rights

Application rights define which system applications users can access, and what
operations they can perform (for example, only view, edit and save changes to existing
objects, create new objects) within each one. Application rights can also be used to
enable/disable users' access to Engineering mode, and to other features such as
Assisted Treatment.
Application rights are assigned to user groups, not to individuals. To view them, in the
Management View of System Browser, select Project > System Settings > Security.
Then, in the Security tab in the Primary pane, select a user group under Groups, and
expand the Application Rights expander to see the Application Rights for that group.
The applications appear in a list. Each application has check boxes for setting its
Application Rights. Note that the application rights set here will apply to both Operating
and Engineering mode.
The most important application rights include:
Show: This gives users read-only access to the application. If the Show check box is
deselected, the application will not even display.
Configure: This enables users to edit data and save changes within the application. If
Configure is deselected, toolbar buttons such as Save, Save As..., New, Delete, and
Edit will be unavailable. NOTE: if the application in question creates or deletes objects
in System Browser tree, users must also have the appropriate Create/Delete scope
rights for their changes to take effect.
Toggle Engineering Mode: This enables users to access Engineering mode. If the
Toggle Engineering mode right is deselected, the button for switching to Engineering
mode will no longer display.
Other application rights include: Export, Import, and Execute.
Application Rights intersect with the Scope Rights that enable users to Create or
Delete system objects. The Configure application right makes toolbar icons such as
New, Save, Save As.., Delete available for the user to click. However, if the
corresponding action creates or deletes objects in System Browser tree, it will not
complete successfully if the user lacks the necessary scope rights.
For example:
If a user has Configure application rights for Macros, toolbar buttons (for example, to
create a new macro folder, to save changes to an existing macro, or to delete a macro)
will be available. However, if this user lacks the Create scope right, the system will not
the user complete the action of creating a new macro folder, because this involves
creating a new system object. On the other hand, the user can complete the action of
saving changes to an existing macro, because this does not create a new system
object. Similarly, to complete the action of deleting an existing macro the user must
have the Delete scope right.
(Conversely, iif the user has Create/Delete scope rights but lacks the Configure
application right the user will not be able to initiate any action because the toolbar
buttons will be unavailable).
The following sections describe the specific application rights that you can set for each
system application, and how they interact with the Create/Delete scope rights.

100
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Application Rights
3

NOTE:
The actual list of application rights in the system may include additional items from
the installed extension modules. To get information about such additional application
rights, refer to the documentation for the specific extension modules.
Application rights are disabled by default in applications installed with an extension
module. This also applies to the DefaultAdmin user. Therefore, after installing an
extension module you must manually enable the corresponding application rights.

The following general rules apply to application rights:

 When you change the application rights for a user group, the changes take effect
immediately, even if those users are currently logged on and using the system.
 Do not use setting ALL if the scope is handled differently for each application.
 Restricted Scope Rights must be assigned to the individual application.

3.4.1 Addressbook
Address book rights define the access permission for configuring the address book.

Addressbook Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing data. ✔ ✘ n/a n/a

 Import the address book. ✔ ✔ n/a n/a

 Add new contacts to the address book.
 Modify existing data and save the changes.
 Delete individual contacts or clear the address book.

3.4.2 Assisted Treatment

Assisted Treatment rights define the access permission to Assisted Treatment alarm
handling feature.

Assisted Treatment Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application (Assisted Treatment window). ✔ n/a n/a n/a
If not set, Investigative Treatment window is available
instead.
NOTE: Executing assisted treatment steps depends
on the rights assigned to the specific applications
involved in the assisted treatment procedures.

101
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Application Rights

3.4.3 Automatic Event Treatment

Automatic event treatment rights define the access permission for configuring
automated alarm handling rules.

Automatic Event Treatment Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing data. ✔ ✘ ✘ ✘

 Modify existing data and save the changes. ✔ ✔ ✘ ✘

 Create a new automated alarm handling rule. ✔ ✔ ✔ ✘

 Create an automated alarm handling rule from
existing configuration.

 Delete any automated alarm handling rules. ✔ ✔ ✘ ✔

3.4.4 BACnet Configuration

BACnet Configuration rights define the access permission for configuring BACnet
devices on a BACnet network.

BACnet Configuration Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application (BACnet Devices or BACnet ✔ ✘ n/a ✘
Editor) and view existing data.

 Modify existing data and save the changes. ✔ ✔ n/a ✘

 Delete any BACnet devices. ✔ ✔ n/a ✔

NOTE: Importing BACnet devices depends on the Importer rights [➙ 106].

102
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Application Rights
3

3.4.5 Device
Device rights define the access permission for the System Management application to
configure:
 Under the stations:
– WMI UPS
– Comark monitor card
 SNMP network devices. In particular,
– SNMP UPS
– SNMP Scalance
 SNMP properties to monitor the SNMP network.

Device Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing data. ✔ ✘ ✘ ✘

 Modify existing data and save the changes. ✔ ✔ ✘ ✘

 Import the configuration.
 Export the existing configuration.

 Create these objects from existing configuration. ✔ ✔ ✔ ✘

 Delete any of these objects. ✔ ✔ ✘ ✔

NOTE: Manually adding the following objects depends on the System Management
rights [➙ 115]: WMI UPS, SNMP network devices, and SNMP properties.
Manually adding the Comark monitor card depends on the Object Configurator [➙ 110]
rights.

103
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Application Rights

3.4.6 Document Configuration and Document Viewer

For Documents, two types of access permission are available:
 Document Configuration
 Document Viewer
Document Configuration rights define the access rights for configuring documents.

Document Configuration Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing data. ✔ ✘ ✘ ✘

 Modify existing data and save the changes. ✔ ✔ ✘ ✘

 Create a new document folder. ✔ ✔ ✔ ✘

 Create a new document object.
 Create a document object from existing configuration.

 Delete any document folder or document object. ✔ ✔ ✘ ✔

Document Viewer Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing documents. ✔ n/a n/a n/a
 Execute the Document Viewer step in Assisted
Treatment.

104
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Application Rights
3

3.4.7 Driver
Driver rights define the access permission for configuring the drivers.

Driver Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing data. ✔ ✘ ✘ ✘

 If applicable, modify existing data and save the ✔ ✔ ✘ ✘

changes.

 Add a new driver. ✔ ✔ ✔ ✘

 Delete any driver. ✔ ✔ ✘ ✔

NOTE: Creating driver objects also depends on the Object Configurator [➙ 110] rights.

3.4.8 Graphics Editor

Graphics Editor application rights define the permissions for creating, modifying, and
deleting graphic objects such as project graphics, Symbols, and Graphic Templates.

Graphic Editor Application Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the Graphic Editor ✔ ✔ ✔ ✔

 Create new and save existing graphics ✘ ✔ ✘ ✔

 Delete graphics and graphic folders ✘ ✔ ✔ ✔

 Edit and save changes to a graphic. ✘ ✔ ✔ ✔

3.4.9 Graphics Library Editor

Graphics Library Editor application rights define the permissions for viewing Symbols
and Graphic Templates libraries, and modifying or configuring them.

Graphic Library Editor Application Rights Application Rights Scope Rights

Action Show Config. Create Delete
 View the Symbols and Template Graphic libraries. ✔ ✔ ✔ ✔
 Copy References from Symbols and Template
Graphics.

 Create new and save existing Symbols and Template ✘ ✔ ✔ ✘

Graphics.
 Edit and save changes to Symbols and Template
Graphics.

 Delete Symbols and Template Graphics. ✘ ✘ ✘ ✔

105
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Application Rights

3.4.10 Graphics Viewer

The access rights for the Graphic Viewer application define the user’s ability to display
a graphic, Symbol, a Graphic Template in the Graphic Viewer and in the Graphic Editor
Runtime mode.

Graphic Viewer Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and display a graphic, ✔ n/a n/a n/a
Symbol, or Graphic Template.
 Execute the Graphic Viewer step in Assisted
Treatment.

3.4.11 Icons
Icons rights define the access permission for configuring any icons library.

Icons Rights Application Rights Scope Rights

Action Show Config. Import Create Delete
 Access the application and view existing data. ✔ ✘ ✘ n/a n/a

 Delete icons and save the changes. ✔ ✔ ✘ n/a n/a

 Import icons. ✔ ✔ ✔ n/a n/a

NOTE: Adding and deleting icons library objects depends on Library rights [➙ 108].

3.4.12 Import Rules

Import Rules rights define the access permission for configuring the import rules.

Import Rules Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing data. ✔ ✘ n/a n/a

 Modify existing data and save the changes. ✔ ✔ n/a n/a

 Customize import rules.

NOTE: Adding and deleting Import Rules library objects depends on Library rights
[➙ 108].

3.4.13 Importer
Importer rights define the access permission for performing the import operation.

Importer Rights Application Rights Scope Rights

Action Show Config. Execute Create Delete
 Access the application and perform field data n/a n/a ✔ n/a n/a
import.

106
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Application Rights
3

3.4.14 Journaling
For Journaling, two types of access permission are available:
 Journaling Printers
 Journaling Configuration
Journaling Printers application rights define the access rights for configuring journaling
printers.

Journaling Printers Rights Application Rights Scope Rights

Action Show Config. Create Delete
 View an existing printer template mapping. ✔ ✘ ✘ ✘

 Add a new printer template mapping entry and save ✔ ✔ ✘ ✘

it.
 Modify an existing printer template mapping entry
and save it.
 Remove an existing printer template mapping entry.

Journaling Configurator application and scope rights define the access rights for
configuring the journaling configurator.

Journaling Configurator Rights Application Rights Scope Rights

Action Show Config. Create Delete
 View an existing journaling definition. ✔ ✘ ✘ ✘

 Modify an existing journaling definition and save the ✔ ✔ ✘ ✘

changes.

 Create, configure, and save a new journaling ✔ ✔ ✔ ✘

definition.
 Create a new journaling definition from an existing
journaling definition using the Save As icon.

 Delete a journaling definition. ✔ ✔ ✘ ✔

107
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Application Rights

3.4.15 Library
Library rights define the access permission for the Library Configurator to configure
libraries.

Library Rights Application Rights Scope Rights

Action Show Config. Import Export Create Delete
 Access the application and view existing ✔ ✘ ✘ ✘ ✘ ✘
data.

 Modify existing data and save the changes. ✔ ✔ ✘ ✘ ✘ ✘

 Customize libraries.

 Import libraries. ✔ ✔ ✔ ✘ ✘ ✘

 Export existing libraries. ✔ ✔ ✔ ✔ ✘ ✘

 Create a new library object. ✔ ✔ ✔ ✔ ✔ ✘

 Create a new library block.

 Delete any library folders, library objects, or ✔ ✔ ✔ ✔ ✘ ✔

library blocks.

3.4.16 License
License rights define the access permission for displaying license data.

License Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view data. ✔ n/a n/a n/a

3.4.17 Localization
Localization rights define the access rights for handling the texts to localize.

Localization Rights Application Rights Scope Rights

Action Show Config. Import Create Delete
 Access the application and view existing data. ✔ n/a ✘ n/a n/a

 Import localized texts. ✔ n/a ✔ n/a n/a

108
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Application Rights
3

3.4.18 Log Viewer

Log Viewer application and scope rights define the access rights for configuring Log
Viewer.

Log Viewer Rights Application Rights Scope Rights

Action Show Config. Create Delete
 View log data in the Log Viewer by selecting the log ✔ ✘ ✘ ✘
viewer root folder, or a log view subfolder, or a log
view definition.
 Configure the displayed log data by applying filters,
sorting the data, selecting, removing, reordering, and
resizing columns.
 Refresh the displayed data.
 Modify an existing log view definition.
 Export a log view definition.
 Stop the execution of a log view.

 Modify an existing log view definition and save any ✔ ✔ ✘ ✘

changes.

 Create a new log folder. ✔ ✔ ✔ ✘

 Save the configured log view as a log view definition.
 Create a new log view definition from an existing log
view definition using the Save As icon.
 Save a log view definition as default.
 Import a log view definition.
 Save a log view definition as a report.

 Delete a log view definition. ✔ ✔ ✘ ✔

 Delete a log view folder.

109
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Application Rights

3.4.19 Macro
Macro rights define the access permission for configuring macros.

Macro Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing data. ✔ ✘ ✘ ✘

 Modify existing data and save the changes. ✔ ✔ ✘ ✘

 Create a new macro folder. ✔ ✔ ✔ ✘

 Create a new macro.
 Create a macro from existing configuration.

 Delete any macro folder or macro. ✔ ✔ ✘ ✔

3.4.20 Network
Network rights define the access permission for configuring networks.

Network Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing data. ✔ ✘ ✘ ✘

 Modify existing data and save the changes. ✔ ✔ ✘ ✘

 Add a new network. ✔ ✔ ✔ ✘

 Delete any network. ✔ ✔ ✘ ✔

NOTE: Adding network objects also depends on the Object Configurator [➙ 110]
rights.

3.4.21 Object Configurator

Object Configurator rights define the access permission for objects.

Object Configurator Rights Application Rights Scope Rights

Action Show Config. Create Delete
 For display purposes only. ✔ ✘ ✘ ✘

 Modify existing data and save the changes. ✔ ✔ ✘ ✘

 Create new folders in System Browser. ✔ ✔ ✔ ✘

 Create new objects in System Browser.

 Delete folders in System Browser. ✔ ✔ ✘ ✔

 Delete objects in System Browser.

110
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Application Rights
3

3.4.22 Operating Procedure

Operating Procedure rights define the access rights for configuring the operating
procedures for assisted treatment.

Operating Procedure Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing data. ✔ ✘ ✘ ✘

 Modify existing data and save the changes. ✔ ✔ ✘ ✘

 Add a new operating procedure folder, operating ✔ ✔ ✔ ✘

procedure template, or step.
 Create an operating procedure template from existing
configuration.

 Delete any operating procedure folders, operating ✔ ✔ ✘ ✔

procedures, or procedure steps.

3.4.23 Reactions
Reactions rights define the access rights for configuring the reactions.

Reactions Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing data. ✔ ✘ ✘ ✘

 Modify existing data and save the changes. ✔ ✔ ✘ ✘

 Add a new reactions folder. ✔ ✔ ✔ ✘

 Create a new reaction.
NOTE: Creating an Output Macro in the context of a
reaction requires Macro rights [➙ 110].
 Create a reaction from existing configuration.

 Delete any reactions folder or reaction. ✔ ✔ ✘ ✔

111
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Application Rights

3.4.24 Remote Notification

Remote Notification rights define the access permission for configuring the remote
notification devices and procedures, and managing notification messages (whether or
not they are triggered by alarms) at runtime.

Remote Notification Rights Application Rights Scope Rights

Action Show Config. Execute Create Delete
 Access the application and view existing data. ✔ ✘ ✘ ✘ ✘

 Configure and test remote notification devices. ✔ ✔ ✘ ✘ ✘

 Modify existing data and save the changes.

 Start and stop a remote notification. ✔ ✘ ✔ ✘ ✘

 Stop an escalation.
 Clear a remote notification.
 Execute the Reno step in Assisted Treatment.

 Create a new remote notification. ✔ ✔ ✘ ✔ ✘

 Create a remote notification from existing
configuration.

 Delete e-mail, SMS, and pager remote notification ✔ ✔ ✘ ✘ ✔

services.
 Delete remote notifications.

112
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Application Rights
3

3.4.25 Reporting
Reports application and scope rights define the access rights for configuring different
types of reports.

Reports Rights Application Rights Scope Rights

Action Show Config. Create Delete
 View a report definition. ✔ ✘ ✘ ✘
 Modify any existing report definition(s).
 Run the report definition using the Run icon, Run As
icon, and Execute command button.
 Stop a report execution
 Export a report definition
 Print a report.
 Create and view a report as a PDF
 Create and view a report as an Excel
 Execute standard reports from the Related Items tab.
 Execute the alarm printout, report, and treatment
form steps in Assisted Treatment.

 Modify existing report definition and save any ✔ ✔ ✘ ✘

changes.
 Create a new report from the Related Items tab.

 Create a new report folder. ✔ ✔ ✔ ✘

 Create and configure a new report definition.
 Save a report definition
 Create a new report definition from an existing report
definition using the Save As icon.
 Save a report definition as a default template.
 Create, configure, and save a new report from the
Related Items tab.
 Import a report definition.

 Delete an existing report. ✔ ✔ ✘ ✔

 Delete a report folder.

113
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Application Rights

3.4.26 Schedules
Schedules application and scope rights define the access rights for setting up and
configuring schedules on management stations or on field panels at your facility.

Scheduler Rights Application Rights Scope Rights

Action Show Config. Create Delete
 View daily and weekly schedules. ✔ ✘ ✘ ✘
 View schedule details.
 Toggle between graphical view and table view.
 Export a schedule.
 Print a schedule.

 Modify any existing schedules. ✔ ✔ ✘ ✘

 Create calendars and associate them with schedules.
 Create schedule entries from the weekly or daily
view.
 Control BACnet command tables with schedules.
 Copy current settings from one schedule to another.

 Create a new schedule. ✔ ✔ ✔ ✘

 Create exceptions to schedules.
 Create a new schedule from an existing schedule
using the Save As icon.

 Delete a calendar. ✔ ✔ ✘ ✔
 Delete any existing schedules.

3.4.27 Scopes
Scopes application and scope rights define the access rights for configuring scopes.

Scopes Rights Application Rights Scope Rights

Action Show Config. Create Delete
 View the configured data in an existing scope ✔ ✘ ✘ ✘
definition(s).

 Modify any existing scope definition(s) and save any ✔ ✔ ✘ ✘

changes.

 Create a new scope folder. ✔ ✔ ✔ ✘

 Create, configure, and save a new scope definition.
 Create a new scope definition from an existing scope
definition using the Save As icon.

 Delete a scope definition. ✔ ✔ ✘ ✔

 Delete a scope folder.

114
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Application Rights
3

3.4.28 Security
Security application rights define the permissions for configuring the security of a user
group.

Security Rights Application Rights Scope Rights

Action Show Config. Create Delete
 View the Security rights. ✔ ✘ ✘ ✘

 Create a new user group. ✔ ✔ ✘ ✘

 Modify, copy and delete a user group.

 The Create option in Scope Rights has not influence ✔ ✔ n/a

on performing this function

 The Delete option in Scope Rights has not influence ✔ ✔ n/a

on performing this function

3.4.29 Sessions
Sessions application rights define the permissions for configuring Sessions.

Sessions Rights Application Rights Scope Rights

Action Show Config. Create Delete
 For display purposes only. ✔ ✘ ✘ ✘

 The controls are available and the users can ✔ ✔ ✘ ✘

terminate a session.

 The Create option has not influence on performing ✔ ✔ n/a

this function.

 The Delete option has not influence on performing ✔ ✔ n/a

this function.

3.4.30 System Management

System Management rights define the access permission for the application to
configure:
 Stations, peripherals, and internal devices. In particular,
– Under Desigo CC server,
- Add and configure the hard disk drive or server printer.
- Add the OPC DA Server.
- Add a WMI UPS. Configuring this object requires Device rights [➙ 103].
– Under an Installed Client or a FEP station:
- Create the Drivers folder.
- Add and configure the hard disk drive.
- Add a WMI UPS. Configuring this object requires Device rights [➙ 103].
 Under an SNMP Network, add and configure:
– SNMP-capable devices such as, printer, UPS, switch, or a custom SNMP
device.
Configuring the UPS, switch, or custom device objects requires Device rights
[➙ 103].
– Individual properties for an SNMP device
Configuring these objects requires Device rights [➙ 103].

115
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Application Rights

 Visibility of Engineering/Operating button in System Manager.

WARNING

IMPORTANT:
You can configure the Toggle Engineering Mode rights to grant or deny access to
Engineering mode for a user group. Be careful not to deny these rights for the user
group that you belong to. If you deselect the Toggle Engineering Mode check box for
your user group, the next time you switch back to Operating mode the
Operating/Engineering button will no longer display. At that point, you can no longer
go back and re-enable your Engineering rights.

System Management Rights Application Rights Scope Rights

Action Show Config. Toggle Create Delete
Engin.
Mode
 Access the application and view existing data. ✔ ✘ ✘ ✘ ✘

 Modify existing data and save the changes. ✔ ✔ ✘ ✘ ✘

 Switch System Manager between Engineering ✔ ✔ ✔ ✘ ✘

and Operating mode.

 Add or create station/SNMP network objects. ✔ ✔ ✔ ✔ ✘

 Delete any station/SNMP network objects. ✔ ✔ ✔ ✘ ✔

NOTE:
If you change the application rights for a user group, the changes will take effect
immediately, even if those users are currently logged on and using the system.

116
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
Application Rights
3

3.4.31 Trends
Trend application and scope rights define the access rights for configuring the Trends.

Trend Rights Application Rights Scope Rights

Action Show Config. Create Delete
 View a Trend View definition. ✔ ✘ ✘ ✘
 Modify any existing Trend View definition(s).
 Run and stop the Trend View definition using the Run
or Stop icon.
 Toggle between graphical view and table view.
 Compare a Trend View definition.
 Export a Trend View definition.
 Print a Trend View definition.
 Save changed background information as a user
default.

 Modify existing data and save any changes. ✔ ✔ ✘ ✘

 Add new data points to existing Trend View
definition.
 Delete an existing data point on the Trend View
definition.
 Create a Trendlog or Trendlog multiple object in the
BACnet device.
 Delete a Trendlog or Trendlog multiple object in the
BACnet device.

 Create a new Trend folder. ✔ ✔ ✔ ✘

 Create a new Trend View definition.
 Create a new Trend View definition from an existing
Trend View definition using the Save As icon.

 Delete a Trend folder. ✔ ✔ ✘ ✔

 Delete any existing Trend View definition.

3.4.32 Users
Users application rights define the permissions for configuring users.

Users Rights Application Rights Scope Rights

Action Show Config. Create Delete
 For display purposes only. ✔ ✘ ✘ ✘

 Create a new user. ✔ ✔ ✘ ✘

 Modify, copy and delete a user.

 The Create option in Scope Rights has not influence ✔ ✔ n/a

on performing this function.

 The Delete option in Scope Rights has not influence ✔ ✔ n/a

on performing this function.

117
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 User Administration
3 Application Rights

3.4.33 View Builder and View Configurator

For configuring site views, two types of access permission are available:
 View Builder
 View Configurator
View Builder rights define the access permission for building site views.

View Builder Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing data. ✔ ✘ ✘ ✘

 Modify existing data and save the changes. ✔ ✔ ✘ ✘

 Purge aggregators.
 Update Physical View, Logical View, and User-
Defined views with soft links.

 Create a new aggregator in a view. ✔ ✔ ✔ ✘

 Delete any aggregator in a view. ✔ ✔ ✘ ✔

View Configurator rights define the access permission for configuring site views.

View Configurator Rights Application Rights Scope Rights

Action Show Config. Create Delete
 Access the application and view existing data. ✔ ✘ ✘ ✘

 Modify existing data and save the changes. ✔ ✔ ✘ ✘

 Create a new view. ✔ ✔ ✔ ✘

 Delete any views. ✔ ✔ ✘ ✔

118
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
Views Concepts
4

4 Views
Views are presented in System Browser and provide different representation of the
system. The operator selects a view, and the corresponding hierarchy of objects
displays as a tree for navigational purposes.
Authorized technicians can create and customize these navigation structures to allow
operators to browse the system in Operating mode by following the most suitable
operating workflows.
This section provides a general overview of Desigo CC views and describes the
configuration workflows and procedures.

4.1 Views Concepts

Desigo CC supports several views that offer different ways to look at the system:
 Management View
 Application View
 Physical View
 Logical View
 User-Defined View
Management View and Application View are available in System Browser. All other
views become available only when they are configured.
The images in this section are provided as examples. More items may be present in
System Browser depending on the specific installation.

119
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
4 Views Concepts

Management View
The Management View is predefined and includes all the objects pertaining to its
overall management such as: representation of the field site, the computer networking,
and other site project settings. Basically, it provides a depiction centered on the site
installation and allows navigation through the hierarchical structure of the project tree.
Authorized technicians typically use this view to set up the site project.

Management View Structure

The Project root includes the following levels:
 Field Networks, for handling the field
networks configuration and field data
import/creation
 Management System, for handling the
physical computers within the system:
– Clients, comprising all the client
computers and their respective
devices. It also includes any relevant
driver (if avaiable).
– Front-end Processors (FEP),
comprising all the FEP computers and
their respective devices. It also
includes any relevant driver.
– Servers, comprising Desigo CC
server (Main Server), and its
respective devices, along with the
drivers, History Database, licenses,
and reporting features.
 System Settings, including the following
features:
– Client Settings
– Conversion Tools
– Journaling
– Libraries
– Operating Procedures
– Organization Modes
– Related Items Templates
– Scopes
– Security
– Users
– Views

120
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
Views Concepts
4

Application View
The Application View is predefined and includes all the objects pertaining to the system
at the application-centric level, such as graphics, reports, and so on. Basically, it
provides a depiction centered on special system components that authorized
technicians typically use to configure specific items needed in the site project.

Application View
The Applications root includes the following levels:
 Address Book
 Documents
 Graphics
 Logics (Macros and Reactions)
 Remote Notifications
 Reports
 Schedules
 Trends

Logical View
The Logical View is not predefined and, if required, authorized technicians can create it
to represent the subsystems logical structure, such as, area, section, zone, sensor.
Operators typically use this view to locate where any issue or alarm occurred.

Example of Logical View

121
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
4 Views Concepts

Physical View
The Physical View is not predefined and, if required, authorized technicians can create
it to represent the subsystems physical structure, that is the control unit hardware,
such as board, line, and sensor. Operators typically use this view to track and
troubleshoot hardware-related issues at management level and/or the subsystem level.

Example of Physical View

User-Defined Views
The User-defined Views are not predefined. They are site-specific structures that
authorized technicians can tailor to suit specific customer requirements. One of the
most common use cases is the Geographical View, which allows the operators to
navigate and manage the system according to the physical layout of the location they
are familiar with. These views include nodes belonging to the management level and
representing geographical entities (such as Buildings, Floors, Rooms, and so on); they
can also include several devices (of different disciplines) all represented in the location
where they are actually installed.

Example of User-Defined View

122
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
Views Configuration Workspace
4

4.2 Views Configuration Workspace

When you select the Views root in System Browser, the Views configuration
workspace displays in the Views tab of the Primary pane. You can add a new view
object to create [➙ 127] a new root for each view required in the project. When you
select any newly created view object, the same configuration workspace enables you
to modify its settings, but only to a certain extent.

Views Toolbar
Icon Name Description
Save the changes Saves any changes.

Delete the current Removes the current object.

object

Views Fields
Item Description
View description Specify the name for the view root node as it displays: under the Views
root and in the System Browser drop-down list. You can modify the text
in this field.
Clicking the Flag icon displays a field in the different languages
available in the system.

Type Select the view type (Logical, Physical, or User-Defined).

With the exception of User-Defined views, once a view type has been
configured, it is removed from the list. Once you created a view, this
field is no longer available for a editing.
Root node Specify the view root description that displays in System Browser when
description
a user selects the current view, and then selects Show Description. By
default, when you click in this field, the same text contained in the View
description field displays. Clicking the Flag icon displays a field in
the different languages available in the system. Once you created a
view, this field is no longer available for a editing.

Root node name Specify the view root name that displays in System Browser when a
user selects the current view, and then selects Show Name. Once you
created a view, this field is no longer available for a editing.
Enable propagation Specify whether or not the state of the objects is propagated from the
child nodes to the parent nodes in the view.
Notes (Optional) Enter your comments or remarks. You can use a maximum
of 255 characters.

123
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
4 View Builder Workspace

4.3 View Builder Workspace

View Builder is the Views workspace for building the views that displays in the Views
tab of the Primary pane. It contains the tree structure of whatever part of a tree view
selected in System Browser:
 If you selected the view root (for example, Project), the entire tree view displays.
 If you selected an aggregator (for example, Campus), the structure related to that
nested level displays.
Here you can configure [➙ 127] the structure of a view by linking objects from System
Browser and saving the changes ( ). Use the aggregators to group and organize
linked objects into nested levels, or purge [➙ 137] ( ) empty aggregators.

The preview area displays a preview of the tree view structure you are creating. Here
you can manage the aggregators that compose the hierarchical structure of the view
and specify the objects/subtrees you want to link from System Browser (drag-and-
drop). The level where the object is being dropped is highlighted when you place the
cursor over it. The mouse cursor changes depending on the operation you are
performing (that is, invalid move, move, or copy).
Depending on the view type, you may have one or both the following options for
specifying the behavior of the view structure.

Link Children
This option lets you activate a recursive link. The recursive link means that when you
configure or modify a view (drag-and-drop an object from System Browser onto that
view), all the child nodes belonging to this level are also automatically added along
with it.

124
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
View Builder Workspace
4

Create Soft Link

A soft link is a symbolic link that contains a reference to a target object. This option—
available only for the Physical View, Logical View, or User-Defined views—lets you
automatically select the Link children option and activate the update of the view that
you are configuring. This means that when you configure the Physical View, Logical
View, or User-Defined, select the Create soft link option, and then click Update View
( ), the view that you are configuring is automatically updated with any changes
present in the target objects:
 Descriptions are updated (nodes in the tree structure are renamed)
 New elements are automatically linked to the structure. The related soft link is
visually indicated in the tree structure in green. The path of the source target is
available in a tooltip when you move the cursor over a soft link in the tree structure.
 Any targets moved or deleted display as broken links. The related broken soft link
is visually indicated in the tree structure in red.

Example of Soft Link

Aggregators
Depending on the type of view, you can add different types of nested levels
(aggregators):

View Type Type of Aggregators

Management View Aggregator
Application View Aggregator
Logical Aggregator
Physical Aggregator
User-Defined  Root: Campus, Building, Floor, Room, Aggregator
 Campus: Building, Floor, Room, Aggregator
 Building: Floor, Room, Aggregator
 Floor: Room, Aggregator
 Room: Aggregator
 Aggregator: Aggregator

125
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
4 View Builder Workspace

Views Buttons, Contextual Menu, and Keyboard Shortcuts

You can build the views structures in many ways, using the buttons, the contextual
menu, or shortcut keys. Depending on the Object Model, not all the functions may be
available to you.

Button Contextual Menu Keyboard shortcut Description

Item
Add Aggregator Add - Add nested levels to help to customize and
better organize the elements of the view
Aggregator structure.
You can only add aggregators under the
View root or under other aggregators. You
cannot add aggregators under objects linked
from System Browser.
Remove Remove DEL Remove the selected aggregator from the
view.
Rename Rename F2 Display the Rename Node dialog box to
rename [➙ 136] the element selected in a
view.
Cut CTRL+X Remove an object from a location and place
Cut it in a buffer.
Copy CTRL+C Copy an object to the clipboard.
Copy

Paste CTRL+V Paste an object (from buffer or clipboard) to

Paste another location.

You can also rearrange the structure of the nested levels (aggregators) by selecting
the nested levels using CTRL+click or SHIFT+click and moving them to the desired
position in the preview. Or you can move the nested levels using cut, copy and paste
actions.

126
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
Configuring the Views
4

4.4 Configuring the Views

The Management View and Application View come with installation and do not require
any changes. There are certain limitations when modifying [➙ 133] these structures.

Configuring the Physical View, Logical View, and User-Defined Views

The Physical View, Logical View, and User-defined views must be created and
customized for each specific site.

Example of Views

Logical View Workflow

To create a view that includes only logical objects, you must configure the Logical View
[➙ 119]:
1. Add [➙ 128] the Logical View under the Views root in System Browser.
The logical structure for this view is automatically created based on the hierarchies
mapping [➙ 218] defined during the devices import.
2. If necessary, modify the logical structure [➙ 133] or restrict access [➙ 137] to this
view for a specific group of users.

Physical View Workflow

To create a view that includes only physical objects, you must configure the Physical
View [➙ 119]:
1. Add [➙ 129] the Physical View under the Views root in System Browser.
The physical structure for this view is automatically created based on the
hierarchies mapping [➙ 218] defined during the devices import.
2. If necessary, modify the physical structure [➙ 133] or restrict access [➙ 137] to this
view for a specific group of users.

127
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
4 Configuring the Views

User-Defined View Workflow

To create a view, for example, that includes only a custom set of objects that the
operators are allowed to navigate (such as, a specific site floor or building of the
facility), you should configure a User-defined View:
1. Add [➙ 131] a User-defined view under the Views root in System Browser.
2. Compose the structure of the view by defining its levels (add the aggregators) and
linking any required element.
3. If necessary, modify the user-defined structure [➙ 133] or restrict access [➙ 137]
to this view for a specific group of users.

Technical Notes
 While saving the changes, a message box warns you that you cannot save this
view if you left a required field blank, entered invalid values, or specified a View
name that already exists.
 After you create a view node, you cannot change the Type and Root node name.

4.4.1 Configuring the Logical View

There are two ways to configure the Logical View: manually (like a user-defined view
[➙ 131]) or by setting the hierarchies mapping based on which the Logical View is
automatically created during the device import under a field network. The following
procedure describes the last method only.
NOTICE! You can add only one Logical View.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings > Views.
 The workspace [➙ 123] for editing the view settings displays in the Views tab
of the Primary pane.
3. Enter the following parameters (see Views Configuration Workspace [➙ 123] for an
explanation of these parameters):
– View description
– Type: Logical View
– Root node description
– Root node name
– Enable propagation
– (Optional) Notes
4. To save the changes, in the Views toolbar, click Save .
 The new object appears in System Browser. The Logical View becomes
available in the System Browser drop-down list.
5. Follow the procedure described in Defining Hierarchies Mapping [➙ 218]. Then
import [➙ 219] the devices under the selected field network.
 The logical view structure is automatically built during the import according to
the specified hierarchies mapping.

128
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
Configuring the Views
4

6. If necessary, in System Browser select the Logical View, expand its structure and,
using the View Builder (see View Builder Workspace [➙ 124]), modify [➙ 133] it as
required.

Updating the Logical View

Any changes you make to the configuration of target objects in views are not
automatically reflected in the Logical View. This means that you must manually update
this view; these changes will display as soft links in the tree structure in the View
Builder preview area (see View Builder Workspace [➙ 124]).
1. In System Browser, select Logical View.
 The workspace [➙ 124] for building the view displays in the Views tab of
Primary pane.
2. Select the Create soft link option (see View Builder Workspace [➙ 124] for an
explanation of this parameter).
 A message box asks you to confirm the operation.
3. Click Yes.
 The Link all children option is automatically selected.
4. In the Views toolbar, click Update View .
 A message box asks you to confirm the operation.
5. Click Yes.
 When the update is complete, the tree structure is collapsed in the preview
area.
6. In the preview area, expand the tree structure.
 Any soft links relevant to new elements linked to the tree structure display in
green, while broken links display in red.
7. To remove broken links and get rid of the warning message, select the soft links in
red and click Remove.

4.4.2 Configuring the Physical View

There are two ways to configure the Physical View: manually (like a user-defined view
[➙ 131]) or by setting the hierarchies mapping based on which the Physical View is
automatically created during the device import under a field network. The following
procedure describes the last method only.
NOTICE! You can only add one Physical View.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings > Views.
 The workspace [➙ 123] for editing the view settings displays in the Views tab
of the Primary pane.
3. Enter the following parameters (see Views Configuration Workspace [➙ 123] for an
explanation of these parameters):
– View description
– Type: Physical View

129
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
4 Configuring the Views

– Root node description

– Root node name
– Enable propagation
– (Optional) Notes
4. To save the changes, in the Views toolbar, click Save .
 The new object appears in System Browser. The Physical View becomes
available in the System Browser drop-down list.
5. Follow the procedure described in Defining Hierarchies Mapping [➙ 218]. Then
import [➙ 219] the devices under the selected field network.
 The physical view structure is automatically built during the import according to
the specified hierarchies mapping.
6. If necessary, in System Browser select the Physical View, expand its structure and,
using the View Builder (see View Builder Workspace [➙ 124]), modify [➙ 133] it as
required.

Updating the Physical View

Any changes you make to the configuration of target objects in views are not
automatically reflected in the Physical View. This means that you must manually
update this view; these changes will display as soft links in the tree structure in the
View Builder preview area (see View Builder Workspace [➙ 124]).
1. In System Browser, select Physical View.
 The workspace [➙ 124] for building the view displays in the Primary pane.
2. Select the Create soft link option (see View Builder Workspace [➙ 124] for an
explanation of this parameter).
 A message box asks you to confirm the operation.
3. Click Yes.
 The Link All Children option is automatically selected.
 In the Views toolbar, click Update View .
 A message box asks you to confirm the operation.
4. Click Yes.
 When the update is complete, the tree structure is collapsed in the preview
area.
5. In the preview area, expand the tree structure.
 Any soft links relevant to new elements linked to the tree structure display in
green, while broken links display in red.
6. To remove broken links and get rid of the warning message, select the soft links in
red and click Remove.

130
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
Configuring the Views
4

4.4.3 Configuring a User-defined View

A User-defined view lets you define the site-specific structure in a top-down fashion:
starting with the largest item in the view (for example, a campus or a building), and
then moving down to insert components in these large structures (for example,
buildings into the campus, floors into buildings, sections into floors, and rooms into
sections). If necessary, use a generic aggregator, at any point, to create additional
structure(s).
When the structure is ready, connect the logical part by linking a logical subtree to a
room (or to a generic point). The resulting tree will provide operators with an easier
way to navigate through the familiar structures of a building down to the individual
elements. For example, a fire zone can be linked to a room or an entire fire section can
be linked to a generic point, representing a building floor. In the link, you can decide to
connect individual physical or logical objects (such as, the fire zone point) or an entire
subtree.
Depending on the event definitions, alarms may be presented with a maximum level of
detail (for example a sensor’s warning). Or they can also be applied to a higher view
level (for example, sections, floors, building, and so on), and show a general category
(for example, fire). This is due to the system propagation characteristics.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings > Views.
 The workspace [➙ 123] for editing the view settings displays in the Views tab
of the Primary pane.
3. Enter the following parameters (see Views Configuration Workspace [➙ 123] for an
explanation of these parameters):
– View description
– Type: User-Defined View
– Root node description
– Root node name
– Enable propagation
– (Optional) Notes
4. To save the changes, Ii the Views toolbar, click Save .
 The new object appears in System Browser. The User-defined view becomes
available in the System Browser drop-down list.
5. In System Browser, select the new user-defined view. Then select the main view
node.
 The workspace [➙ 124] for building the view displays in the Views tab of
Primary pane.
6. In the Views tab, build up the custom structure as follows:
a. Select the level (root or sublevel) where you want to add an aggregator.
b. Click Add Aggregator, and select the appropriate aggregator (Campus, Building,
Floor, Room, or Aggregator). The available aggregators depend on the level
selected.
c. In the Create New Object dialog box, enter the Name and Description. Then
click OK.

131
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
4 Configuring the Views

d. Repeat step c to add all the required aggregators (nested levels) in order to
obtain the wanted tree structure.
7. Link any required logical/physical elements (individual objects [➙ 134] or subtrees
[➙ 134]) to the different levels (aggregators) in the tree structure.
8. If necessary, modify [➙ 133] the structure.

9. To save the changes, in the Views toolbar, click Save .

 The System Manager status bar indicates that the data has been successfully
saved.

Updating a User-defined View

Any changes you make to the configuration of target objects in views are not
automatically reflected in a User-defined view. This means that you must manually
update this view; these changes will display as soft links in the tree structure in the
View Builder preview area (see View Builder Workspace [➙ 124]).
1. In System Browser, select the user-defined view to update.
 The workspace [➙ 124] for building the view displays in the Views tab of
Primary pane.
2. Select the Create soft link option (see View Builder Workspace [➙ 124] for an
explanation of this parameter).
 A message box asks you to confirm the operation.
3. Click Yes.
 The Link all children option is automatically selected.
 In the Views toolbar, click Update View .
 A message box asks you to confirm the operation.
4. Click Yes.
 When the update is complete, the tree structure is collapsed in the preview
area.
5. In the preview area, expand the tree structure.
 Any soft links relevant to new elements linked to the tree structure display in
green, while broken links display in red.
6. To remove broken links and get rid of the warning message, select the soft links in
red and click Remove.

132
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
Configuring the Views
4

4.4.4 Modifying a View

Modifying the Management View and the Application View
Basically, you can only perform the following tasks for the Management View or
Application View:
 Add/remove aggregators and relevant linked objects
 Rename [➙ 136] objects
 Purge [➙ 137] aggregators
Other allowed actions on the elements in these views depend on the Object Model.

Modifying the Physical View, Logical View, or User-Defined Views

 System Manager is in Engineering mode.
 You previously created the Physical View, Logical View, or a User-defined view.

1. To modify the settings of a view, proceed as follows:

a. In System Browser, select Management View.
b. Select Project > System Settings > Views.
c. Under Views, select the object that corresponds to view you want to modify.
d. In the Views tab of the Primary pane, modify one or more of the view settings
(see Views Configuration Workspace [➙ 123] for details).
e. To save the changes, in the Views toolbar, click Save .
 If you changed the View description, the description of the node in System
Browser is updated, as well as the name of the view in the System Browser
drop-down list.
2. To modify the structure of a view, proceed as follows:
a. in the System Browser drop-down list, select the view you want to modify.
b. In the Views tab of the Primary pane, expand the view structure. Then carry out
one or more of the following tasks (see View Builder Workspace [➙ 124] for
details):
– Add new aggregators to create a new level:
a. Select the level (root or sublevel) where you want to add an aggregator.
b. Click Add Aggregator.
c. In the Create New Object dialog box, enter the Name and Description. Then
click OK.
– Link the logical/physical elements (individual objects [➙ 134] or subtrees
[➙ 134]) to the different levels (aggregators) in the tree structure.
– Rename [➙ 136] the objects in a view as appropriate to represent a level or an
element.
– Rearrange the view structure (drag-and-drop or cut/copy/paste nodes).
– Exclude [➙ 137] unwanted objects or subtrees from the view.
– Purge [➙ 137] aggregators.
– To save the changes, in the Views toolbar, click Save .

133
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
4 Configuring the Views

4.4.5 Linking Individual Objects to a View

 System Manager is in Engineering mode.
 You are modifying or creating the Logical View [➙ 128], Physical View [➙ 129], or
a User-defined View [➙ 131], and you want to link individual elements.
 The view you want to work with is selected in System Browser and the workspace
[➙ 124] for building the view displays in the Views tab of Primary pane.
1. In the Views tab, expand the tree view to identify the level where you want to add
an individual element.
2. To link an individual object from the view currently selected in System Browser,
drag-and-drop the appropriate object (for example, a panel) into the appropriate
level in the tree structure from System Browser.
3. To link an individual object from another view available in the System Browser
drop-down list, do the following:
a. In System Browser, select the Manual Navigation option to freeze the Primary
pane.
b. Select the view that contains the object you want to link.
c. Drag-and-drop the desired object (for example, a panel) from System Browser
onto the appropriate level in the tree structure.

4. Once you have linked all the required objects, to save the changes, in the Views
toolbar, click Save .
 The System Manager status bar indicates that the data was successfully saved.

4.4.6 Linking Subtrees to a View

 System Manager is in Engineering mode.
 You are modifying or building the Logical View [➙ 128], Physical View [➙ 129], or
a User-defined View [➙ 131], and you want to link a subtree (for example, a
network and its devices).
 The view you want to work with is selected in System Browser and the workspace
[➙ 124] for building the view displays in the Views tab of Primary pane.
1. In the Views tab, expand the tree view to identify the level where you want to add
the subtree.
2. To link a subtree from the view currently selected in System Browser, drag-and-
drop the appropriate subtree from System Browser onto the appropriate level in the
tree structure.
3. To link a subtree from another view available in the System Browser drop-down
list, do the following:
a. In System Browser, select the Manual Navigation option to freeze the Primary
pane.
b. Select the view containing the subtree you want to link.
c. Drag-and-drop the subtree from System Browser onto the appropriate level in
the tree structure.
4. Select the Link All Children option.

134
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
Configuring the Views
4

 A warning message box asks you to confirm the operation.

5. Click Yes.
NOTE: If you click Yes, the message box displays only once during your work
session. If you click No, the operation is aborted, and the message box will appear
again the next time you try to copy the entire node structure.
 A wait cursor displays while a large structure is being copied.
6. Once you have linked all the required subtrees, to save the changes, in the View
toolbar, click Save .
 The System Manager status bar indicates that the data was successfully saved.

4.4.7 Linking a Graphic to the Root Node of a View

You can link a graphic to the root node of a View, so that it displays whenever you
select the root node of the View.
 System Manager is in Engineering mode.
 In System Browser, select the Application View.
 Locate the Graphics folder, and open the Graphics Editor in Engineering mode.
1. Open the graphic you want associated with the root node of the view.
2. In System Browser, select the desired view.
3. Click the root node of the view and drag-and-drop it on the graphic.

 The Icon displays on the graphic.

4. (Optional) If you do not want the icon to display on the graphic, select the icon
on the graphic, and then locate the SymbolInstance Properties view > Layout and
then clear the Visible check box.
5. From the Graphics Editor toolbar, click to save the graphic.

6. In System Browser, navigate to the view you associated with the graphic, and then
click on the root node.
 The graphic displays in the Primary pane anytime you click on the root node and
you are in Operating mode.

NOTE:
For more information about linking graphics and graphics‘ subsections (Vieweports)
to a node, see the Graphics Editor Manual (A6V10380503).

135
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
4 Configuring the Views

4.4.8 Renaming an Object in a View

Regardless of the object in System Browser or the level in the structure in a view, you
can use the View Builder or the Object Configurator to change the object description.
 System Manager is in Engineering mode.
 You want to rename an object in System Browser.
 From the System Browser drop-down list, select the desired view and do one of the
following:

– To change the description for an object from the View Builder, proceed as
follows:
a. In System Browser, select the view root node.
b. In the Primary pane, click the Views tab.
c. In the workspace [➙ 124] for building the view, expand the tree view, select
the level that corresponds with the element you want to rename and click
Rename or right-click the node and select Rename , or press F2.
d. In the Rename Node dialog box, click the Flag icon and modify the text in
the different languages available in the system. Then click OK.

– To change the description for an object from the Object Configurator, proceed
as follows:
a. In the System Browser tree, locate and select the node that corresponds
with the object you want to rename.
b. In the Primary pane, click the Object Configurator tab.
c. In the Main expander, click the Flag icon in the Description field. Then
modify the text in the different languages available in the system.
d. in the Object Configurator toolbar, click Save .

136
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
Configuring the Views
4

4.4.9 Excluding Objects or Subtrees in a View

When excluding elements from views, consider the following:
 For all the views, you cannot remove the root level using the Remove button. To
learn how to remove a view from the system, see Deleting a View [➙ 138].
 In the Management View and Application View, you can only remove aggregators.
 In the Logical View, Physical View, and User-Defined views, you can remove
aggregators and the links to objects belonging to the Management View and
Application View.
 System Manager is in Engineering mode.
 You are modifying the structure of a view and you want to remove a single object
or a subtree.
1. In System Browser, select the desired view. Then select the view root level.
 The workspace [➙ 124] for building the view displays in the Views tab of
Primary pane.
2. In the Views tab, expand the tree view, select the level that corresponds with the
element you want to remove from the tree structure and click Remove, or right-click
and then click Remove , or press DEL.
 The element is removed from the tree structure.
3. To save the changes, in the Views toolbar, click Save .
 The System Manager status bar indicates that the data was successfully saved.

4.4.10 Purging Aggregators

When a field device is deleted under a field network, the corresponding aggregator is
not removed from the views. To clean up the view of any empty aggregator do the
following:
 System Manager is in Engineering mode.
 You previously deleted one or more devices under a network and you want to
clean up the view of any empty aggregators.
1. In System Browser, select the view.
 The workspace [➙ 124] for building the view displays in the Views tab of
Primary pane.
2. Select the main view level.

3. In the Views toolbar, click Purge Aggregators .

 Any empty aggregators are removed from the selected view structure.
4. To save the changes, in the Views toolbar, click Save .
 The System Manager status bar indicates that the data was successfully saved.

4.4.11 Restricting Access to a View

By default, System Browser views are available to all the users configured for a
project. To restrict the access to a view only to a specific group of users, you must

137
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Views
4 Configuring the Views

create a scope rule for the view to restrict and link it to the scope rights of the wanted
user group.
 System Manager is in Engineering mode.
 You previously configured user groups and users for the project.
1. In System Browser, select Management View.
2. Select Project > System Settings > Scopes.
 Scopes displays in the Primary pane.
3. In System Browser, select the view to restrict and drag-and-drop its root onto the
Scope Rules area.
 The hierarchical path of the linked object appears as a scope rule in an Include
row.
4. To save the changes, in the Scopes toolbar, click Save .

5. In System Browser, select Security.

 Security displays in the Primary pane.
6. In the Groups area, select the user group that will have access to the view defined
in the scope rule.
 The configuration workspace refreshes and displays the configuration for the
selected group of users.
7. In System Browser, drag-and-drop the scope rule created for the view onto the
Scope Rights area, and define the rights.
8. If necessary, adjust the user group configuration.

9. To save the changes, in the Security toolbar, click Save .

 The view configured in the scope rule is only available for the users belonging to
the user group defined for the scope rights.

4.4.12 Deleting a View

NOTICE! You cannot delete the Management View or the Application View.
 You want to delete the Physical View, Logical View, or a User-defined view.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings > Views.
3. Select the view object you want to delete.
 The workspace [➙ 123] for editing the view settings displays in the Views tab
of the Primary pane.
4. In the Views toolbar, click Delete .
 A confirmation message box asks if you want to delete the selected item.
5. Click Yes to confirm the operation.
 The object is removed from the System Browser tree and the corresponding view is
no longer available in the System Browser drop-down list.

138
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Overview of Object Configurator
5

5 Object Configurator
The Object Configurator adapts all objects (instances) in Engineering mode that
display in System Browser. Typical changes include:
 Edit/translate object description
 Adapt object classification for alarm forwarding (remote notification), security (user
groups), and search criteria
 Temporary place object to Out of scan for servicing
 Assign Function
 Set up alarm monitoring on the management station
 Configure logging of events (Activity Log), for example, jammed paper in the printer
 Configure logging of process data (Value Log), for example, room temperature
 Prioritize navigation of graphics pages (related items)
 Adjust data range for slider operation in the Operation or Extended Operation tab.

NOTE:
Only properly trained personnel can make changes to the instances. Improper
changes may result in situation where alarms are no longer forwarded under certain
circumstances.

5.1 Overview of Object Configurator

Concept
The following illustration provides an overview of the concept between Object Model,
Function and instances with the associated editors.
Ob
j ec
tC
on
fig
ur a

Instance
to r

Supply air temperature

Mo

Mo
de

de
ls

ls
&

&
Fu

Fu
nc

nc
tio

tio

Function Object Model

ns

ns

Temperature Analog Input

Platform data base

Data Inheritance
You receive detailed information on an object when selected in the Object
Configurator. You may be able to edit attributes depending on the object type. The
colored check box indicates the data source used. Data is inherited according to the
following priority rule:

139
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Overview of Object Configurator

Data point Object Configurator

Priority
High Valid on instance
SiB-X import
Auto-Discovery
No

Valid on Function Function editor

No

Valid on Object Model Object Model editor

No

Not valid
Low

The following illustration shows the validity of the information:

 If the Valid flag for the instance is checked (grey check mark); this information
has a higher priority than one from the function or Object Model.

 If the Valid flag is cleared, the information is inherited from the Function (green
check mark) or the Object Model (blue check mark) and evaluated.

Data validity for a data point instance:

140
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Overview of Object Configurator
5

Data validity at valid is explained in the table below.

Inheritance Rules for Object Model, Function, and Object

Icon Color Description
White No value is inherited.
Grey The project instance value is inherited.
Green The Function inherits the value.
Blue The Object Model inherits the value.
Question mark with The value is undefined until the instance is saved.
a yellow
background.

While you change inheritance properties, you cannot disable an inheritance. As a

result, the state changes from to or when editing. This display for the
inheritance function is used for the Main, Properties, Details, and Alarm Configuration
expander.

141
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Working with Object Configurator

5.2 Working with Object Configurator

The Object Configurator permits specific modifications to an object instance.

Section Description
1 Object Configurator Tab to switch to Object Configurator to process project
instances.
2 Main expander Basic settings for the corresponding Object Model.
3 Operating mode Toggle button to switch between Operating and Engineering
mode.
4 Toolbar Toolbar for Object Models, Functions, and Object Configurator.
5 Properties expander Displays all properties for the corresponding object.
6 Related items Displays of where the object is used.
7 Details expander Displays detailed configuration of value attributes, as well as
status.
8 Alarm Configuration Alarm configuration of individual object properties.
expander

5.2.1 Toolbar
Toolbar
Deletes the current object.

Saves the currently opened object.

Saves the currently opened object under a new name.

142
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Working with Object Configurator
5

5.2.2 Main
In the Main expander, you can:
 Edit the description of object names
 Define an alias name
 Assign a new Function
 Temporarily take the object out of scan
 Edit object assignment to electrical and mechanical installation

Name Description
1 Description Describes the data point name. You can edit and translate the data
[➙ 151] point.
2 Alias [➙ 152] An alternative description for the data point name, available for user-
defined information. Do not use the following characters: * , ? , @.
3 Function Displays the associated Function.
[➙ 159]
4 All Selected: Displays all Functions in the system.
Cleared: Displays only the Function assigned to the Object Model in
the Function Mapper.
5 Valid Displays, based on the color code, the source used for inheriting the
information.
6 Discipline Category of the discipline (for example, Life Safety).
[➙ 157]
7 Subdiscipline Description of an object (for example, Fire Detection for Life Safety
[➙ 157] discipline).
8 Out of scan Select this check box if you want the data point to be temporarily taken
[➙ 152] out of scan.
9 Object model Displays the associated Object Model.
10 Type [➙ 157] Category of the corresponding type (for example, Zone).
11 Subtype Description of object (for example, Zone 1 for type Zone).
[➙ 157]

143
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Working with Object Configurator

Valid
Inheritance Rules for Object Model, Function, and Object
Icon Color Description
White No value is inherited.
Grey The project instance value is inherited.
Green The Function inherits the value.
Blue The Object Model inherits the value.
Question mark with The value is undefined until the instance is saved.
a yellow
background.

While you change inheritance properties, you cannot disable an inheritance. As a

result, the state changes from to or when editing. This display for the
inheritance function is used for the Main, Properties, Details, and Alarm Configuration
expander.

Alias (User Designation)

As an alternative to describing the data point name, you can enter a freely definable
text as user designation. In System Manager, you can search for Aliases (filter search),
and the Alias displays in the Textual Viewer and in the tooltips. It can display in Event
List, remote notification messages, Journaling templates, Trend legends and so on.

Discipline, Subdiscipline, Type, Subtype

Use predefined information to define where the corresponding Function is used.

NOTE:
Entries for Discipline, Subdiscipline, Type and Subtype have a direct influence on
alarm forwarding, scopes, and search criteria in Desigo CC.

Out of Scan
You can temporarily take a data point out of service using the Out of scan function.
This makes sense when you need to service a sensor or sensor group. No alarm is
triggered as long as the function is selected.

144
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Working with Object Configurator
5

5.2.3 Properties
In the Properties expander, you can:
 Enable the properties for the log database, and for the history database

Property Description
1 Property All properties that belong to the data point are displayed as defined in
the Function.
2 FS A field system alarm is defined when the check box is selected.
3 MS A Management System alarm is defined when the check box is
selected.
4 VL Object is logged in the Value Log database for a change of value.
5 AL Object is logged in the Activity Log database for a change of value.

NOTE:
A grayed-out check box for a property cannot be selected. The FS and MS columns
only display if an alarm is defined for this property.

Value Log (VL)

When selected, a change in status for the data point property is entered in the Value
Log database.

NOTE:
History logs should not be released for all properties. Otherwise, depending on the
project size, it can result in a large amount of data released to the database.

Activity Log for Events (AL)

When selected, a change in status for the data point property is entered in the Activity
Log database.

Alarm Configuration Field System (FS)

When selected, displays whether an alarm configuration is defined in the field system.
The check box is read-only.

Alarm Configuration Management Station (MS)

When selected, displays whether a Management System is defined in the Alarm
expander. The check box is read-only.

5.2.4 Details
In the Details expander, you can:

145
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Working with Object Configurator

 Edit the Data Point Type

 Edit the property descriptive text
 Edit attribute properties

Name Description
1 Type Defines the data point type in Desigo CC. The attributes are reset if
you change the type. All configurations are lost.
2 Descriptor Describes the property.
3 Valid [➙ 144] The settings are inherited as presets for the Function and instances
when checked (see Presetting Behavior).
4 …… Optional entry fields by data type (see Value Attributes Group Box).
5 Unit text group List of available text groups.
6 Unit Selection list for a unit from the selected text group.

Value Attributes Group Box

The selected data point type determines the entry fields available for this type. See the
following:
 Boolean

 Real

146
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Working with Object Configurator
5

 Date Time

 BitString

 Enumeration

 UInteger

 Application Specific

147
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Working with Object Configurator

The following tables describe possible items available depending on the selected data
point type.

Field Definition
Allow Date Entering date and time is possible.
Time
Allow Entering wildcards *, ? is possible.
Wildcards
First Bit Defines the first bit. For example, 0=Off.
Descriptor Describes the corresponding property.
Last Bit Defines the first bit. For example, 4 =Automatic.
Min Defines the low limit for the slider range in Operation tab.
Max Defines the high limit for the slider range in Operation tab.
Text Group Associated text group based on data types.
Type Data type cannot be edited.
Resolution Resolution value.
Unit Describes the physical unit for the property.

NOTE:
Text groups can be edited or added in the Management View under System Settings
> Libraries > [Discipline] > [System name] > Texts.
Double-clicking the Unit text group field and clicking the Texts Group Editor tab
displays the corresponding text group.

148
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Working with Object Configurator
5

5.2.5 Alarm Configuration

In the Alarm Configuration expander, you can:
 Edit a field system alarm
 Create, edit, or delete a Management System alarm

Name Description
1 Valid [➙ 144] Displays, based on the color code, the source used for inheriting
the information (see Presetting Behavior).
2 None Defines no alarm functionality for this data point property.
3 Field system Defines the alarm configuration for the field system.
4 Management Defines the alarm functionality on the Management System.
System
5 Alarm kind  Discrete: When the alarm value is located within a defined
range (for example,: between 100 and 200) or a set of
predefined values (for example, 10, 20, 30).
 Continuous: When the entire value range is monitored for
limits (for example,: = 50, = 75, or >= 199).
6 New Opens an input mask for defining the alarm condition in a row.
Multiple alarm conditions can be defined.
7 Delete Deletes the highlighted alarm condition.
8 Clear Deletes all alarm conditions from the alarm table, (except the
entries for Normal and Alarm).

Entry Mask for Management System Alarm

Name Description
1 Alarm Class Defines the alarm class to be enabled for an event.
2 Operand Defines the condition (operand) for reporting the event.

149
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Configuring Objects

3 Value Range Defines the value for which an event is reported.

4 Event Text Displays the alarm text for incoming event.
5 Normal Text Displays the alarm text for outgoing event.
6 Alarm config. When the check box is selected, the alarm is set to active.
activted

Supported Operands
Operand Meaning Example
|| Or

!| | Nor

.. In the range of two values

!.. Not in the range of two values

> Greater than

< Less than

>= Greater than or equal to

<= Less than or equal to

Fault indication
 The first value must be less than the second value. A valid value must be less than
or equal to 30.

 The value sequence is not ascending. A valid value must be less than 50.

150
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Configuring Objects
5

5.3 Configuring Objects

The Object Configurator individually parameterizes all objects that are displayed in the
System Browser. Be aware that changes you make may require you to re-check
alarming response.

5.3.1 Editing/Translating an Object Description

 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Field Networks > BACnet Network 1 > Hardware > Device > Local
ID > [Data point].
NOTE: The folder path may vary by subsystem.
3. Click the Object Configurator tab.
4. In the Main expander, select the Descriptor field.
5. Click the flag symbol.
 The text dialog box opens.
6. Select the language and type as needed text for each language.
7. Click OK.

8. Click Save .

151
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Configuring Objects

5.3.2 Editing Alias Name

 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Field Networks > BACnet Network 1 > Hardware > Device > Local
ID > [Data point].
NOTE: The folder path may vary by subsystem.
3. Click the Object Configurator tab.
4. In the Main expander, select the Alias field.
5. Type a new or modify the existing alias name.

6. Click Save .

5.3.3 Temporarily Taking a Sensor Out of Scan

Communications can be interrupted temporarily with this function if information from
the subsystem is not forwarded to the Management System.

Out of Scan Concept

NOTICE

The Interrupt Communication

Function cancels communications between the device and the Management System.
The alarm functionality is not impacted. For example, the fire detection system. In this
case, an incoming alarm is still forwarded to the fire department. You must take the
fire detector out of commission in the Operation dialog box if you want to prevent
alarm forwarding to the fire department.
Select the fire detector and then the property under Operation tab. Click Exclude to
turn off an Area, Zone, or fire detector on the panel.

 System Manager is in Engineering mode.

1. In System Browser, select Management View.

152
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Configuring Objects
5

2. Select Project > Field Networks > BACnet Network 1 > Hardware > Device > Local
ID > [Data point].
NOTE: The folder path may vary by subsystem.
3. Click the Object Configurator tab.
4. In the Main expander, select the Out of scan check box.

5. Click Save .

Out of Scan Check Box

5.3.4 Logging Data Values

You want to permanently log history data point value and display and evaluate at a
later date as needed.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Field Networks > BACnet Network 1 > Hardware > Device > Local
ID > [Data point].
NOTE: The folder path may vary by subsystem.
3. Click the Object Configurator tab.
4. In the Properties expander, select the corresponding property (for example,
Present_Value) and select the VL check box.
NOTE: The value is entered in the database for each change of state.

5. Click Save .

153
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Configuring Objects

NOTE 1:
If you want to record a property for all instances, select the VL check box for the
corresponding Object Model. Double-click Object Model to go to the selected instance
for the Object Model.
For example: Project > System Settings > Libraries > BA > Specific Devices >
BACnet > Object Model.
NOTE 2:
The VL check box is already selected if you have already used it to log history data
point values.
NOTE 3:
When the VL check box is cleared, the values can no longer be logged for history
data point values.

154
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Configuring Objects
5

5.3.5 Logging Events

For example, you want to log a paper jam on a printer.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server > Local Printer.
NOTE: The path may vary by object.
3. Click the Object Configurator tab.
4. In the Properties expander, select the corresponding property (for example,
status.PaperJammed) and select the AL check box.
NOTE: The value is entered in the database for each change of state.

5. Click Save .

NOTE 1:
If you want to record a property for all instances, select the AL check box for the
corresponding Object Model. Double-click in the Main expander, and then double-
click Object Model to go to the Object Model.
For example: Project > System Settings > Libraries > Global (HQ) > Base > Object
Model > Server Station.
NOTE 2:
You must use the Log Viewer or activity log report to display data recorded in the
Activity Log database.

155
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Configuring Objects

5.3.6 Prioritizing Related Items

Related Items can influence the priority of the page to open first if a data point
references multiple graphics, documents, reports, or trends. With several groups,
prioritizing only works within the group.
The following description refers to prioritizing graphics pages.

 System Manager is in Engineering mode.

 A data point is referenced on multiple graphic pages.
1. In System Browser, select Management View.
2. Select Project > Field Networks > BACnet Network 1 > Hardware > Device > Local
ID > [Data point].
NOTE: The folder path may vary by subsystem.
 The data point is selected and the graphics pages are displayed in the Related
Items expander.
3. Click the Object Configurator tab.

4. In the Related Items expander, highlight the graphics page you want to open first.

5. Drag-and-drop the graphics page to the top of the list.

6. Click Save .
 The graphics page defined at the top of the list opens.

NOTE:
The order must be set for each data point, if multiple data points are referenced on
the graphics page.

156
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Configuring Objects
5

5.3.7 Text Catalog Navigation

Each object is assigned to a text catalog with the corresponding texts. Check the text
catalog for the text contents to ensure that proper information is displayed when the
state of a data point changes.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Field Networks > BACnet Network 1 > Hardware > Device > Local
ID > [Data point].
NOTE: The folder path may vary by subsystem.
3. Click the Object Configurator tab.
4. In the Properties expander, select the property (for example, Present_Value).
5. In the Details expander, double-click Unit text group.
 The corresponding text group is selected in System Browser.
6. Click the Text Group Editor tab.
 The entries for the selected text group display.

5.3.8 Changing Object Classification

 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Field Networks > BACnet Network 1 > Hardware > Device > Local
ID > [Data point].
NOTE: The folder path may vary by subsystem.
3. Click the Object Configurator tab.
4. In the Main expander, select the Classification group box and change the following
entries:
– 1 = Discipline
– 2 = Subdiscipline
– 3 = Type
– 4 = Subtype
5. Select the Valid check box in the Classification group field.
NOTE: The check box may not be green or blue.
6. Click Save .
The figure below illustrates the Object Configuration entry,as well as the corresponding
applications that evaluate the information.

157
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Configuring Objects

Object Configurator

NOTICE

Alarm Not Forwarded

Changes to an object assignment can have a direct impact on future alarms. After
each change, check the alarm functionality of alarm.

158
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Configuring Objects
5

5.3.9 Assigning a Function to a Data Point

If during data import a Function cannot be assigned automatically, you must first
assign it individually to the data points. This normally is the case when you integrate a
third-party product.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Hardware > Main Server >
[Data point].
NOTE: The folder path may vary by subsystem.
3. Click the Object Configurator tab.
4. Select the Main expander.
5. In the Function list, select the corresponding Function (for example, for an analog
input for temperature measurement = SensorAirTemperature). Check box All
means:
Cleared: Displays only the Function assigned to the Object Model in the Function
Mapper.
Selected: Displays all Functions in the system.
 The data point in the system behaves according to the selected Function (for
example, you selected a supply air sensor by drag-and-drop in the graphic).
6. Click Save .
 The Operation tab now displays only the properties according to the selected
Function configuration.

5.3.10 Navigating Easily by Function or Object Model

To process instances, it is helpful to be able to easily locate the corresponding
Function or Object Model in System Browser.

Navigation to OM or Function

 System Manager is in Engineering mode.

 You opened the corresponding instance in Object Configurator.
1. Under Main expander, select the General field.
2. Double-click the Function or Object model descripiton.

159
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Configuring Objects

3. Click the Models & Functions tab.

 The corresponding Function or Object Model is selected and displays in System
Browser.

5.3.11 Management System Alarm Workflow

The topology displays how an alarm defined on the Management System responds in
the system. Web Clients and Management System response is the same for alarm
display.

Topology with Management System Alarm

Workflow and Alarm Response

Description
_ Network
… Alarm direction
1 The user creates an alarm configuration on an object instance (for example room temperature).
2 The edited alarm configuration is saved on the server. NOTE: The alarm configuration is not
automatically written to the automation station.
3 The field device triggers a change of value and creates an alarm.
4 The edited value is evaluated on the automation station.
5 The new value is sent to the server.
6 The server monitors the value and converts it to an alarm based on the alarm configuration.
7 Alarm information is transmitted via TCP/IP to Web Clients and Management System.
8 The corresponding alarm information in the appropriate priority class displays in the corresponding
event lamp.
9 A user not corresponding to the appropriate alarm information in Scopes cannot display the alarms.

160
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Configuring Objects
5

Alarm Types
Desigo CC supports two different types of alarms for a Management System alarm:
 Discrete alarm (for example, an alarm range of 68 through 86 or a listing, such as
70, 80, 90).

 Continuous alarm (for example, alarm range <=68 or >=87).

Alarm Display in the Summary Bar

 Discrete alarm
Only one alarm state is displayed as active in a discrete alarm configuration.
Processing for a discrete alarm occurs based on the alarm configuration from bottom
to top. The first event category to meet this operation is displayed (no additional
checks for other correct conditions).

 Continuous alarm
Multiple alarm states can be displayed as active for continuous alarm configuration.
Processing is always through the entire alarm configuration for a continuous alarm.
Multiple operations valid for the same event category are also displayed in the event
lamp counter.

161
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Configuring Objects

Versus Discrete Alarm and Continuous Alarm

NOTE:
Management System alarms do not have quality attributes. Therefore, no alarm bells
display for an alarm in the Trend View.

5.3.11.1 Creating a Discrete Alarm

You want to set up an alarm that monitors a value or range. For example, 68 ‒ 86 is
the normal value range; values that are greater or less than that range will trigger an
alarm).
 You have the appropriate user rights to create an alarm.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Field Networks > BACnet Network 1 > Hardware > Device > Local
ID > [Data point].
NOTE: The folder path may vary by subsystem.
3. Click the Object Configurator tab.
4. In the Properties expander, select the appropriate property (for example,
Present_Value).

162
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Configuring Objects
5

5. In the Alarm Configuration expander, select the Valid check box to display
activation in grey.

6. Select the Management System option.

7. In the Alarm kind drop-down list select Discrete.
8. Click New to define a new alarm class.

9. Define the corresponding conditions for each alarm class:

a. Select the Alarm Class.
b. In the Value Range column, select the operand.
c. In the Value Range column, select the value(s).
For example, the range 100 through 200 and 200 through 300. Entering 100
through 199 and 200 through 299 creates a gap in monitoring from 199.001 to
199.999.
d. Enter the necessary information in the Event Text field and Normal Text field.

e. Select the Alarm config. activated check box.

10. Click Save .

NOTE:
The limit values are only monitored when the following conditions are met:
- In the Alarm Configuration expander, the Alarm config. activated check box is
selected.
- In the Main expander, the Out of scan check box is deselected.
- The entries are saved.

Supported Operands
Operand Meaning Example
|| Or

163
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Configuring Objects

!| | Nor

.. In the range of two values

!.. Not in the range of two values

Fault indication
 The first value must be less than the second value. A valid value must be less than
or equal to 30.

5.3.11.2 Creating a Continuous Alarm

You want to set up an alarm that monitors a value (for example, > 87).
 You have the appropriate user rights to create an alarm.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > Field Networks > BACnet Network 1 > Hardware > Device > Local
ID > [Data point].
NOTE: The folder path may vary by subsystem.
3. Click the Object Configurator tab.
4. In the Properties expander, select the appropriate property (for example,
Present_Value).

5. In the Alarm Configuration expander, select the Valid check box to display
activation in grey.

6. Select the Management System option.

164
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Configuring Objects
5

7. In the Alarm kind drop-down list, select Continuous.

8. Click New to define a new alarm class.

9. Define the corresponding conditions for each alarm class:

a. Select the Alarm Class.
b. In the Limiting Value column, select the operand.
c. In the Limiting Value column, select the value.
d. Enter as needed the value in the Upper Hysteresis and/or Lower Hysteresis
columns. Entering a hysteresis prevents the triggering of an alarm each time there
is a slight variation.
e. Enter the necessary information in the Event Text field and Normal Text field.

f. Select the Alarm config. activated check box.

10. Click Save .

NOTE:
The limit values are only monitored when the following conditions are met:
- In the Alarm Configuration expander, the Alarm config. activated check box is
selected.
- In the Main expander, the Out of scan check box is deselected.
- The entries are saved.

Supported Operands
Operand Meaning Example
> Greater than

< Less than

165
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Configuring Objects

>= Greater than or equal to

<= Less than or equal to

Fault indication
 The value sequence is not ascending. A valid value must be less than 50.

5.3.11.3 Example of: Door and Window Monitoring

You can easily monitor a door by selecting the door contact input (Present_Value) in
System Browser. Define the open state of the doors. For example, a !|| ACTIVE. A
message is sent if the doors are opened.

NOTE:
The operands || or !|| depends on the contact function (normally open, normally
closed).

5.3.11.4 Example of: Simple Temperature Monitoring

You can easily create a simple temperature monitor by selecting the temperature
sensor (Present _Value) in System Browser. Define the desired comfort temperature
range. For example, !.. 68 to 77. The corresponding message is sent out if the value is
breached or exceeded.

166
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
Configuring Objects
5

5.3.11.5 Example of: Advanced Temperature Monitoring

You can easily create an advanced temperature monitor by selecting the temperature
sensor (Present_Value) in System Browser. Define a corresponding message for each
temperature limit. The corresponding message is sent out when the set values are
reached. Use the Hysteresis columns to avoid triggering additional messages for slight
temperature deviations.

NOTE:
You can define only one Normal Range. First create the corresponding number of
alarm classes and then select the corresponding position for Normal Range.

167
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Object Configurator
5 Configuring Objects

5.3.11.6 Example of: Level Monitoring

You can easily create a level monitor by selecting the level sensor (Present_Value) in
System Browser. Define a corresponding message for each level. The corresponding
message is sent out when the set values are reached. In this case, the value for 125,
150 or 200 must be precisely changed to send out a message.

168
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Driver
6

6 BACnet
Configuring the BACnet driver, network, and devices depends on the installed
modules. The following sections provide configuration workflows and basic procedures.
For more details about certain settings and procedures that may be relevant for your
installation, refer to the documentation for the specific subsystems.
Before starting the configuration tasks, check the following prerequisites:
 System Manager is in Engineering mode.
 In System Browser, Management View is selected.

General Workflow
1. Create, configure, and start BACnet driver [➙ 169].
2. Create and configure BACnet network [➙ 178].
3. Acquire and manage BACnet devices [➙ 188] data.

6.1 BACnet Driver

By default, Desigo CC project has no BACnet [➙ 169] Driver defined.

BACnet Driver Workspace

General Configuration Workflow

1. Add [➙ 170] the BACnet Driver object.
2. Configure [➙ 171] the BACnet Driver.
3. Start [➙ 177] the BACnet Driver.
4. Configure the BACnet Stack Protocol Service (BACstack) [➙ 172].

Extended Configuration
 Time Synchronization [➙ 177]
 Threads [➙ 174]
 Driver devices [➙ 176]
 Auto-discovery [➙ 175]

Other Actions
 Deleting [➙ 178] the BACnet Driver.

169
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Driver

Technical Notes
 When you select the driver object in the System Browser tree, the Extended
Operation tab of the Contextual pane shows its Manager Status:
– Stopped: The driver (or the simulator) is not running. You can start the driver
(or simulator).
– Configuration Mode: The simulator started and is running properly. You can
stop it.
– Started: The driver started is running properly. You can stop it.
– Failed: The driver (or the simulator) started but there is no connection to the
Server or FEP station (for example, a station cannot be reached or is
disconnected). You can stop the driver (or simulator) and then try to start it
again.
 After you start the simulator, you can continue configuring the network (for
example, importing devices, and so on). To start the driver you must first stop the
simulator.
 When the Manager Status is Failed, you cannot make changes to the configuration
(for example, import operations are not allowed).
 It is not possible to stop the driver (or the simulator) during import operations (if
available).
 If the driver is not properly configured and you try to start it (or simulator), the
Manager Status becomes Failed, and an alarm is generated for each network
using this driver (the networks status becomes Not Reachable).
 If the device hosting the driver is disconnected, the Manager Status becomes
Failed, and an alarm is generated (the device state becomes Not Reachable).

6.1.1 Adding a BACnet Driver

1. Depending on where BACnet Driver is required (Desigo CC server or FEP station),
select one of the following in System Browser:
– Project > Management System > Servers > Main Server
– Project > Management System > FEPs > [FEP station]
2. Select the Drivers folder.
 Object Configurator displays in the Primary pane.
3. In the Object Configurator tab, click New Object , and select New BACnet
Driver.

4. In the Create New Object dialog box, enter the Description and then click OK.
 The BACnet Driver object appears in System Browser but is not running.

170
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Driver
6

6.1.2 Configuring Basic Driver Settings

1. Open the Settings expander and set the following parameters in the Management
Station section:
– Network Number: The number of the BACnet Virtual Network in which the
driver resides (default is 9999).
– Instance Number: The BACnet Device Identifier to assign to the driver as a
BACnet client (default is 9998).
2. In the BACnet toolbar, click Save .
Other settings:
 Management station name. BACnet device name for the management station.
 Default alarm class. Default classification of alarm type, such as Alarm, Life Safety,
Maintenance, Status, etc. Used for status messages.
 Registered process IDs. Number that allows the BACnet Driver to route alarms.
Default Process IDs of 0 and 600 are provided—where 0 means you can accept a
broadcast by default, and 600 means that APOGEE alarms can be routed. Consult
vendors you are integrating to obtain their process IDs.
 Acting as Supervised Fire Client. Used for fire panels that support client
supervision.

171
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Driver

6.1.3 Configuring BACstack

The BACstack parameters allow defining the network types and port properties for the
BACnet Driver.
1. In the BT BACnet Stack Gateway Port Table, click Add and select one of the
following::
– To add a Physical Port, select BACnet/IP or Ethernet. In the Port Properties
expander, set the Network Number where your management station is
connected (typically =1, unless in conflict with the Network Number of the
Virtual Port) and select the hardware adapter in the Adapter drop-down list.
(For IP address and UDP Port setting of BACnet/IP, see the following
guidelines.)
NOTE: To select the network adapter you must start the BACnet Driver in full
mode [➙ 177]. If you are configuring off-line, you need to postpone this step.
– To add a Virtual Port, select Virtual.
NOTE: Any subsequent change in the Network Number field of the Settings
expander is automatically reflected in the Network Number field of the Virtual
Port.
2. (Optional) Configure the Physical Port as BBMD or Foreign Device.

3. In the BACnet toolbar, click Save .

If you create more than one BACnet Driver, the drivers can be assigned to the same
Network Interface Card (NIC) or to different NICs. To avoid configuration conflicts,
apply the following guidelines to the Physical Port configuration:
 The Network Number of each Physical Port must be unique and must be different
from the Network Number of the Virtual Port.
 The IP Address and UDP Port (default is 47808) of each Physical Port must be
unique. This means that the Physical Ports must have a different IP address or a
different UDP port. For instance, if two drivers are assigned to the same NIC, you
can use the value 47809 for the UDP port of the Physical Port of the second driver.

Other Port Properties

 Port > Attached. Allows you to specify that the router port is attached and
accessible to other devices on the BACnet network.

Technical Notes
 If you click the Save icon, but you have not yet defined a virtual network, the
system adds one automatically—provided there is a valid network number defined
in the Settings expander.
 You cannot add more than one virtual network to your system. Once a virtual
network is added, the Add drop-down list shows the Virtual type as disabled. The
Network Number in the Port Properties expander also becomes disabled.

172
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Driver
6

BBMD and Foreign Device

Port Properties > BBMD
Item Description
BACnet broadcast Allows you to set up this management station as a BBMD. BBMDs
management device can only be set up on BACnet/IP Networks.
NOTE: When you select the BACnet broadcast management device
check box, the Foreign Device Table check box in the Foreign Device
tab is disabled.
Two-Hop Forwarding Allows you to send directed unicasts to another BBMD. Two-hop
forwarding allows messages blocked by IP routers to be sent to
another BBMD, which in turn re-transmits the message to the IP
subnet.
Add Allows you to add IP addresses, UDP ports, and subnet mask
numbers to the Broadcast Distribution Table for other BBMDs that
you want the management station to communicate with.
Remove Allows you to remove IP addresses, UDP ports, and subnet mask
numbers from the Broadcast Distribution Table.
Foreign Device Table Allows you to enable the BBMD to handle foreign device registration.
The Max FDT Entries field allows you to change entries in the Max
foreign device table. Default is 16.
NAT Global Address Allows you to enable the BBMD for Network Address Translation
(NAT) compatibility. Once enabled, you can add the IP address and
UDP port for NAT support.

Port Properties > Foreign Device

Field Description
Foreign Device Allows you to set up a management station to function as a foreign
device if it needs to communicate as a single BACnet device on a
different IP subnet but not route messages between them, or, if it
does not have a fixed IP address.
Foreign devices can communicate directly with any other BACnet
device on the network, but must register with a BBMD to receive
broadcasts from BACnet devices on other IP subnets.
If the BBMD check box in the BBMD tab is selected, you must
deselect it to be able to select the Foreign Device check box.
IP Address Allows you to enter the IP address of the remote BBMD that the
foreign device will register with.
UDP Port Allows you to change the default UDP port number, 47808.
Time to live (in sec.) Allows you to change the default Time to live number, 1800 seconds.

173
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Driver

6.1.4 Configuring Threads

The Threads expander presents the default threads settings for the BACnet Driver.
The system is configured with optimal settings, so Siemens recommends that you
modify these only if instructed by Field Support.
 You have contacted Field Support, and a Siemens representative has instructed
you to change settings for threads.
1. Open the Threads expander, and modify the default values, as instructed by Field
Support:
– Polling threads (Default is 10)
– Pinging threads (Default is 15)
– Alarm threads (Default is 5)
– Backup threads (Default is 3)
– Trend threads (Default is 5)
– Request threads (Default is 2)
2. In the BACnet toolbar, click Save .

174
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Driver
6

6.1.5 Configuring Auto Discovery

The auto discovery feature allows for mapping description and objects for the BACnet
Driver.
1. Open the Auto Discovery expander.
2. Open the Description Mapping Configuration expander, and specify any description
mapping:
– To configure a new description mapping:
– a. Click Add to create a new row.
b. Enter Vendor ID and Property ID for CNS Description.
NOTE: The Property ID is the reference that tells the auto discovery which
property to search looking for a match.
– To remove a description mapping, select it, and then click Remove.
3. Open the Object Mapping Configuration expander, and specify the data point types
to use for instances of discovered devices and data objects.
– To define a new object mapping:
a. Click Add to create a new row.
b. Enter Vendor ID, Type, Property ID, Library, Match String, and Object Model.
– To sort the mapped objects, select a row and click Up or Down.
NOTE: The order in which you arrange an object mapping is important, as
discovery will take the object model from the first row that matches.
– To remove an object mapping, select it, and click Remove.
4. In the BACnet toolbar, click Save .

Match String Special Characters

Character Checks that the BACnet property string…
None Exactly matches the value.
* Contains the match value.
^ Begins with the match value.
$ Ends with the match value.
@ If no match value is found, use this value as default.
% Use the type family of the parent device.

175
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Driver

6.1.6 Configuring Driver Devices

The Driver Devices expander shows BACnet devices attached to your system, their
device IDs and network numbers, and whether or not the devices are cloaked.
Cloaking hides BACnet devices in System Browser and elsewhere in the system, and it
prevents auto discovery [➙ 179] from constantly re-adding hidden devices to a BACnet
network.
To work with cloaking:
1. Open the Driver Devices expander, and select the option Is a Cloaked Device that
corresponds to the devices you want to hide (delete).
 A confirmation message box asks if you want to delete the selected item.
2. Click Yes.

3. In the BACnet toolbar, click Save .

4. (Optional) Click Refresh to update the cloaked device name to a generic

description.
To clear the list, proceed as follows:
1. Clear the option Is a Cloaked Device for each device.

2. In the BACnet toolbar, click Save .

3. Click Refresh.
 The system removes the cloaked devices from the list.

176
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Driver
6

6.1.7 Configuring Time Synchronization

The Time Synchronization feature allows synchronizing time between panels and the
management station.
1. Open the Time Synchronization expander, and configure the following:
– Time sync interval. Set the panel synchronization delay in minutes. Default is
1440 (24 hours).
– Align intervals. Select the check box to start the periodic time synchronization
on the hour.
– Interval offset (minutes). This value indicates the amount of time between the
time sync interval and the actual time sync.
2. In the BACnet toolbar, click Save .

6.1.8 Starting and Stopping a BACnet Driver

1. Expand the System Browser tree and select the BACnet Driver in the Management
System structure.
2. In the Extended Operation tab of the Contextual pane, check the status of the
Manager Status property, which can be:
– Started, if the BACnet Driver is currently active.
– Stopped, if the BACnet Driver is not currently active.
3. Depending on the current status, you can click:
– Start, to fully activate the BACnet Driver.
– Start Conf… (Start Configuration Mode), to activate the BACnet Driver without
activating any real connection to the field, for instance if you need to support
offline configuration activity.
– Stop, to stop the BACnet Driver.

Starting and Stopping the BACnet Driver

177
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Network

6.1.9 Deleting the BACnet Driver

To delete the BACnet Driver, you must first delete any BACnet network linked to the
BACnet Driver. See Section Deleting a BACnet Network [➙ 187].
1. Select Project > Field Networks.
2. Depending on where the BACnet Driver you want to delete is located, select one of
the following:
– Project > Management System > Servers > Main Server
– Project > Management System > FEPs > [FEP station]
3. Under Drivers, select the BACnet Driver you want to delete.

4. In the BACnet toolbar, click Delete .

 A confirmation message box asks if you want to delete the selected item.
5. Click Yes to confirm the operation.
 The object is removed from System Browser.

6.2 BACnet Network

By default, Desigo CC project has no BACnet [➙ 169] network defined. The network is
where BACnet devices [➙ 188] are imported.

BACnet Network Workspace

General Configuration Workflow

1. Add [➙ 179] the BACnet Network object.
2. Assign [➙ 179] a BACnet Driver to the BACnet Network.

Extended Configuration
 Auto Discovery [➙ 179]
 Hierarchies Mapping [➙ 182]
 Block Commands Behavior [➙ 183]
 Global Objects Folder Mapping [➙ 185]

Other Actions
 Deleting [➙ 187] a BACnet network.

178
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Network
6

6.2.1 Adding a BACnet Network

1. In System Browser, select Project > Field Networks.
 Object Configurator displays in the Primary pane.
2. In the Object Configurator tab, click New Object , and select New BACnet
Network.

3. In the Create New Object dialog box, enter the Name and the Description. Then
click OK.
 The new object appears in System Browser.

6.2.2 Assigning a Driver to the BACnet Network

 The BACnet network is selected in System Browser.
1. Open the Network Settings expander.
2. In the Monitored by driver drop-down list, select the driver.

3. In the BACnet toolbar, click Save .

Assigning a Driver to the BACnet Network

6.2.3 Handling Auto Discovery

Auto discovery is a Desigo CC feature that discovers and imports devices already on
the network.

NOTE:
The auto discovery feature is not available on all supported BACnet units.
Specifically, the following control panels can currently support BACnet auto discovery:
- APOGEE
- Desigo PX
- Third-party BACnet Units
There may also be specific limitations in its application. For more information on using
auto discovery, refer to the Integration Guides for the specific subsystems.

Before working with this feature, use the BACnet Browser [➙ 180] to check that
devices are online and communicating on the BACnet network.
Once you confirm that your devices are functioning properly, set the auto discovery
filters [➙ 180], which determine the devices you import and how they are managed.
Once you save the filter settings, Desigo CC imports your devices and objects, and
they become accessible in System Browser.

179
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Network

6.2.3.1 Checking for Devices on the Network

If you want to check the devices on the network you must use the BACnet Browser
tool. For more information, refer to the BACnet Object Browser online help.
1. Click Start > All Programs > Desigo CC > Tools > BACnet Browser.
2. Verify that the devices you want the system to discover appear in BACnet
Browser’s left pane.
NOTE: If your devices do not display in the BACnet Browser, they will not display
in Desigo CC. If this is the case, use your field panel documentation to troubleshoot
your BACnet configuration, your physical network setup, or both.

6.2.3.2 Setting Auto Discovery Filters

 You have already checked for devices [➙ 180] on the network.
 The BACnet network is selected in System Browser.
1. Open the Auto Discovery expander, and specify the following settings:
– Select the Enable device discovery option.
– Clear the Cloak discovered devices option.
NOTE: For the next three settings, you can enable any combination of the
three to accommodate your preferences.
– To enable the discovery of all the devices on one network, select the Use
network filter option. Then enter the network number in the Network number
filter field.
– To enable the discovery of all the devices within a range, select the Use
instance Filter option. Then enter your range numbers in the Beginning
instance and Ending instance fields.
– To enable the discovery of all the devices on the network from one vendor,
select the Use vendor filter option. Then enter the vendor ID number in the
Vendor ID field.
2. To enable the possibility to add objects to the device’s database after discovery,
select the Enable object creation option.
3. To enable the possibility to delete objects from the device’s database after
discovery, select the Enable object deletion option.
4. Select the Enable function discovery option if you want auto discovery to control
the application of functions to objects at the time of discovery and creation with the
Desigo CC system. The system determines the function from the name of the
BACnet object.

5. In the BACnet toolbar, click Save .

180
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Network
6

Technical Notes
 When function discovery is enabled, the point name is used to select and apply a
system function to each particular BACnet object at the time of discovery and
creation within the system. Functions provide more context and meaning to
particular objects. For example, BLDG1.OAT would be mapped to a temperature
function because of a match to OAT (Outside Air Temperature). This may change
the object’s default icon, graphic, discipline, and so on. These matching rules are
fixed for every site. You cannot configure them since they are based on the naming
rules built into the APOGEE Design Tool.

6.2.3.3 Confirming Device Discovery

 You have already configured a BACnet network and started the Auto Discovery
process.
1. From System Browser, select Management View.
2. Select the BACnet network you are working on.
3. Click the Extended Operation tab, and start monitoring the Discovery Progress
property that displays.
NOTE: You should monitor the discovery progress because, depending on the
number of devices you are attempting to discover, it may take several minutes
(small database) to over an hour (large database) for the system to discover the
devices and display them in System Browser. If you do not see activity in the
Extended Operation tab or in the BACnet network in System Browser, make sure
that the expected devices and objects are displayed in the BACnet Browser. Also
make sure your auto discovery filter settings coincide with the devices you are
trying to discover.

181
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Network

6.2.4 Configuring Hierarchies Mapping

 The BACnet network is selected in System Browser.
1. Open the Hierarchies Mapping expander, and define the destination in the system
views of the data structures (hierarchies).
 The suggested field indicates the correct view root to link for each specific
hierarchy.
2. To assign a hierarchy to a destination view:
a. In System Browser, select the required view.
b. Drag-and-drop the view root element to the suggested field.

3. In the BACnet toolbar, click Save .

 The hierarchies settings that you configured are activated and applied during field
data import.

182
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Network
6

6.2.5 Configuring Block Commands Behavior

The configuration of block commands automatically generates block command macros
[➙ 280] for any fire network where this behavior is enabled.
 The BACnet network is selected in System Browser.
1. Open the Block Commands Behavior expander, and specify the scope of
acknowledge, reset, and silence/unsilence commands in the System Manager and
Event List.
See Table Block Commands Programming and System Behavior for reference.

2. In the BACnet toolbar, click Save .

Block Commands Programming and System Behavior

Block Command Possible Settings Desigo CC Behavior
In System Manager In Event List
Acknowledge block Enabled The Acknowledge command The Acknowledge command applies to
applies to the control panel of the all control panels in the network.
selected data point.
Not Enabled The Acknowledge command is not The Acknowledge command applies to
available. the selected event.
Reset block Enabled The Reset command applies to the The Reset command applies to all
control panel of the selected data control panels in the network.
point.
Not Enabled The Reset command is not The Reset command applies to the
available. control panel of the selected event.
Block silence/unsilence Enabled The Silence/Unsilence command The Silence/Unsilence command
applies to the control panel of the applies to all control panels in the
selected data point. network.
Not Enabled The Silence/Unsilence command is The Silence/Unsilence command
not available. applies to the control panel of the
selected event.

183
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Network

Technical Notes
 Block Commands configuration applies to the entire Desigo CC network and is
automatically imported from the SiB-X file to match the local configuration of the
control panels. If you import multiple SiB-X files in the same Desigo CC network,
the last import procedure sets the Block Commands mode for the entire system. To
prevent inconsistent behavior between local (panel level) and remote (station level)
commands, make sure that the Block Commands configuration is identical for all
control panels of the same Desigo CC network.
 The system executes Block Commands using macros that are specifically
designed for this purpose. A set of pre-defined macros (one for each network) is
automatically provided with the following names:
– BLOCK_ACK_<NETWORK_NAME>
– BLOCK_RESET_<NETWORK_NAME>
– BLOCK_SILENCE_<NETWORK_NAME>
– BLOCK_UNSILENCE_<NETWORK_NAME>
Where:
<NETWORK_NAME> indicates the affected Desigo CCnetwork (the network
node Name and not Description is used). When a Block Command is enabled,
a corresponding macro is created in the macro list to apply the command on
the selected network.
 You can import multiple systems (SiB-X files) in the same or in separate Desigo
CC networks. If you import multiple systems in the same network node, the Block
Commands macros apply to all of them. However, in architectures with multiple
networks, if you want global Block Commands, you must manually create multi-
network macros. You can do that by creating a new set of global macros with the
following names:
- BLOCK_ACK
- BLOCK_RESET
- BLOCK_SILENCE
- BLOCK_UNSILENCE
Each of these macros should launch the network-based macros for the
corresponding command functions (for example, the global ACK macro will launch
all the network ACK macros). While you must configure the global, multi-network
macros manually, they are automatically recognized and can replace the single
network macros to perform the alarm-handling commands.
 While the Block Commands may operate on multiple panels and networks, the
Security and Scope settings must enable operators to command all panels and
networks involved in their fire alarm handling.
In particular, if a customized Scope is defined for the fire system, this Scope must
include, from the Management View, all fire panels and networks affected by the
Block Commands macros.

184
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Network
6

6.2.6 Creating Global Objects Folder Mapping

The folder path to the global objects is mapped in the Global Objects Folder Mapping
expander. Each defined network can be mapped to a global object folder.

NOTE:
Mapping is needed only if the corresponding subsystem supports global objects.

Global Objects Folder Mapping

Item Description
Global objects folder Drag-and-drop the corresponding object folder to the text field.
Remove Removes the existing object folder reference.

Global objects are objects that exist in identical form on different process devices:
Replicated objects. Global objects are needed for as an example:
 Alarm distribution
 Global calendars
 User profiles
 Life check
The management station positions all objects marked as global in the configured
folder. As a rule, a subsystem-specific manager automatically identifies such global
objects. This manager is installed together with an extension module.

Purpose of Global Objects in Desigo PX

Every automation station contains all the data necessary for stand-alone operation,
including, for example, date and time, calendar function blocks and Notification Class
function blocks. The system functions of individual automation stations, therefore, do
not depend on any central server. To avoid the need to update each automation station
individually when adjustable parameters are modified, the system supports global
objects for centralized operation.
The system and/or program view are based on the automation station, i.e. each object
(block, BACnet data object) belongs to a specific automation station. This form of
representation is adequate for most elements of a physical plant, for example the
supply air temperature or the set point of a ventilation system. However, certain data
objects need to be visible (in identical form) in some or all the automation stations of a
site. These are referred to as global objects.

Global Objects
Global objects are data objects which exist simultaneously on each automation station
at the automation level.

NOTE:
Global objects are always global within a given site. There is no strategy for
maintaining global objects over more than one site.

Local Objects
Local objects (for example local calendar) are individual, unique objects which exist
only once on a particular automation station in the system.

185
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Network

Role Distribution within the System

Desigo PX data is synchronized from the primary server to the related backup server,
and works independent of the connected management station.

Network

Global Global Global

objects objects objects

Primary Server Backup Server Backup Server

Primary Server and Backup Server

Role Distribution within the System

Function Primary Server Backup Server
Server function One automation station of a site The other automation stations of a site
operates as the primary server. It is must be backup servers.
important to ensure that only one
primary server exists at any one
time on a site.
Life check The primary server monitors the The backup servers monitor the
backup servers and the third-party primary server of the site.
BACnet devices of a site.
Time The primary server synchronizes The primary server synchronizes the
synchronization the time of the backup servers and time of the backup severs.
the third-party BACnet devices of
the site.
Start-up No coordinated start-up. No coordinated start-up.
Replication The primary server replicates the The primary server of the site
global objects and properties replicates the global objects in the
(device object) for the backup backup servers. A backup server
servers of a site. accepts modifications of global
objects only from the primary server.

Mapping the global object folder is required only if the related subsystem supports
global objects. Mapping requires two steps:
1. Creating an object folder.
2. Mapping an object folder.

NOTE:
Detailed information on global object behavior is available in the related subsystem
documentation.

186
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Network
6

6.2.6.1 Creating Global Objects Folder

 The System Manager is in Engineering mode.
1. In System Browser, select Logical View.
2. Select the Views tab.
3. Select the object hierarchy where you want to create the global object folder.
4. Click Add Aggregator and select Aggregator.
5. In the Create New Object dialog box, type a:
– Names: GlobalObjects
– Description: Global Objects
6. Click OK.

7. Click Save .

6.2.6.2 Mapping Global Objects Folder

 The System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Desigo CC > Field Networks > [Network name].
3. Select the BACnet tab.
4. Expand Global Objects Folder Mapping.
5. In System Browser, select Logical View.
6. Select Logical View > [Network name] > [Global Objects folder].
7. Select Global Objects folder (press and hold the left mouse button) and drag-and-
drop the object folder information to the Global objects folder text box of the Global
Objects Folder Mapping expander.
NOTE: When you click the Global Objects Folder, the Views tab is changed and no
mapping is possible.

8. Click Save .

6.2.7 Deleting a BACnet Network

 For example, you want to remove a BACnet driver but first you have to remove the
BACnet network linked to it.
1. Select > Project > Field Networks.
2. Select the BACnet network linked to the driver to remove.
NOTE: If you don’t know which networks are linked to the BACnet driver, you can
select each network and view the assigned driver in the BACnet tab.
3. Click the BACnet tab.

4. In the BACnet toolbar, click Delete .

187
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Devices

 A confirmation message displays asking if you want to remove the selected

item.
5. Click Yes to confirm the operation.
 The object is removed from System Browser.

6.3 BACnet Devices

While configuring a Desigo CC project, BACnet [➙ 169] devices are imported under
the BACnet network [➙ 178].
The position of the device in the hierarchy may vary according to the imported system.

BACnet Device Workspace

General Configuration Workflow

1. Import [➙ 188] BACnet devices.
Information about the devices are available in the Device Info expander [➙ 189].
2. Specify BACnet device timing and communication settings in the Timing and status
info expander [➙ 190].

Extended Configuration
 COV and Polling Info expander [➙ 189]
 Backup/Restore Information expander [➙ 191]
 Other Settings expander [➙ 191]

Other Actions
 Deleting [➙ 187] a BACnet device.

6.3.1 Importing BACnet Devices

Before you import BACnet devices, verify that the BACnet network is available in the
project and associated to a driver.
For general information about the import operation, see Field Data Import [➙ 215].
For import detailed procedures, refer to the documentation of the specific subsystems.

188
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Devices
6

6.3.2 Viewing Device Info

The Device Info expander displays the BACnet device data extracted from the
configuration file during the import phase.

 Device instance: Indicates the device instance number.

 Device name: Indicates the name of the device.
 Network number: 16-bit number that identifies the devices that reside on particular
network segment. For example, a BACnet network is spread over two IP network
segments, and devices on one segment belong to BACnet network 1, while
devices on the other segment belong to BACnet network 2. This number is useful
for routing BACnet messages and can also be used as a filter for BACnet
discovery.
 Profile name: Optional property of a BACnet device. It provides information about
the device or the application it is running.
 Remote: Indicates whether or not this device is on the same BACnet network
number relevant to the system client.
 MAC address: Indicates the hardware address of a device connected to a network.

6.3.3 Configuring COV and Polling Info

The COV and Polling Info expander contains the suggested values for data reporting.
Data reporting is done in two ways:
 Change of Status (COV) service. The BACnet Driver sends the BACnet device a
subscription request. The BACnet device accepts the subscription, and sends the
BACnet driver notifications when changes occur. The BACnet Driver must renew
the subscription request at intervals.
 Polling. The BACnet Driver polls the BACnet device at intervals to check for
changes.
If the COV service is not supported by the BACnet device or does not work due to
network problems, polling is used instead.

NOTE:
Usually, default values are optimal. You may consider changing the default values if
high network traffic is a concern.

 COV resubscribe rate: Indicates the time interval (in seconds) at which the driver
renews the COV subscription.
 Polling rate: Indicates the time interval (in seconds) at which the driver polls objects
(if COV is not supported).

189
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Devices

 Large properties polling rate: Indicates the time interval (in seconds) at which the
driver polls properties with large data values, for example the object list (if COV is
not supported).
 Links polling rate: Indicates the time interval (in seconds) at which the driver polls
properties that reference other objects, to update the BACnet links provider (if COV
is not supported).

6.3.4 Configuring Timing and Status Info

The Timing and Status Info expander allows you to configure the BACnet device timing
and communication settings.

Timing settings
Events received from the subsystem and displayed on the management stations are
time-stamped by the subsystem. The clock of the subsystem must be aligned with the
clock on the management station(s) to avoid inconsistencies.
1. Open the Timing and Status Info expander.
2. In the Time sync type drop-down list, select a value:
– None (synchronization disabled, default value). This option prevents the
management station from synchronizing the subsystem. If clocks diverge, this
results in inconsistent timestamps being displayed.
– Local Time. Local computer time is used to synchronize the device.
– UTC. UTC time is used to synchronize the device.
3. (Optional) If you selected the UTC time synchronization, check the subsystem
documentation about the UTC offset field.
4. The UTC offset value is automatically acquired from some subsystems. In such a
case, you can correct the UTC offset value off-line in the subsystem tool, and then
restart or reconnect the subsystem, and check the new value acquired.

Driver ping settings

 Device ping rate. The rate, in seconds, at which the driver pings the device (default
is 10).
 Allowed failed pings. The number of failed pings before the driver declares the
device as failed (default is 1).

Application Protocol Data Unit (APDU)

 APDU timeout. The APDU timeout, in seconds (default is 5).
 APDU retries. The APDU number of attempts to establish communication after a
timeout (default is 1).
 Use auto APDU timeout. Select the check box to activate the Auto APDU timeout:
the Auto APDU timeout is doubled until a response is received.
 Auto APDU timeout. The Auto APDU timeout, in seconds (default is 5).

Master/Slave Token Passing protocol (MSTP)

 MSTP Ping Rate. Ping rate, in seconds, for the Master/Slave Token Passing
protocol (default is 60).

190
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Devices
6

6.3.5 Configuring Backup/Restore Information

The Backup/Restore Information expander displays the BACnet device backup/restore
settings.
You can modify these default settings. See the following for reference.

 Enable automatic backups and restores: Indicates whether or not the device
backup is enabled. Default is disabled.
 Backup rate (sec.): Indicates the rate (in seconds) at which the device is backed
up. Default is 86400 seconds.
 Backup reinitialization delay: Indicates the backup reinitialize delay (in seconds).
Default is 5 seconds.
 Restore reinitialization delay: Indicates the restore reinitialize delay (in seconds).
Default is 5 seconds.
 Backups to keep: Indicates the number of backups to keep. Default is 2 backups.
 Reinitialize password and Confirm password: Enter and confirm the password to
allow each device to reinitialize itself.

6.3.6 Configuring Other Settings

The Other Settings expander displays additional BACnet device settings.
You can modify these default settings. See the following for reference.

 Max trend reads per collection: Indicates the maximum number of trend records to
read for a collection.
 Automatic alarm registration: Indicates whether or not the BACnet Driver is
configured as receiver of the alarm notifications in all the notification class objects.
Default is enabled.
 Force trend collection: Indicates whether or not the trend collection is forced by
position for third-party devices. Default is disabled.
 Use only read property: Indicates whether or not the ReadProperty service only is
used for third-party devices that do not support the ReadPropertyMultiple service.
Default is disabled.
 Use get alarm summary: Indicates whether or not the GetAlarmSummary service is
used for third-party devices that do not correctly support the GetEventInfo service.
Default is disabled.
 Trouble events (for fire system only): Indicates whether or not Event List displays
both incoming and outgoing Trouble events. This value is imported from the
configuration file of the fire system's panels. Default is disabled.
 Supervisory events (for fire system only): Indicates whether or not Event List
displays both incoming and outgoing Supervisory events. This value is imported
from the configuration file of the fire system's panels.

191
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Devices

6.3.7 Configuring Multiple Devices Simultaneously

When you select multiple BACnet devices in System Browser, you can configure them
at the same time if you want the same settings (including passwords) throughout the
devices.
Affected expanders in the BACnet tab include the following:
 COV and Polling Info
 Timing and Status Info
 Backup/Restore Information
 Other Settings

Device Info Expander

The Device Info expander is the exception since some of the information in it is unique
to each device. However, when you select multiple devices, the information in the
Device Info expander changes automatically, as shown in the following screen shot:

Notice that the Device instance field changes to read Mulitple Devices Selected. This
means that you have two or more devices selected for editing. The remaining fields
contain asterisks, plus they are gray.

What an Asterisk Means

An asterisk indicates that the values in a field differ among the selected devices. Fields
with asterisks will be either gray or white. Gray shading indicates that the fields are
unavailable for editing. White shading indicates that the fields are available for editing.
If you edit a field that is white and contains an asterisk, the change will affect all
selected devices.

Example
One device has a Polling rate of 30, and another device has a Polling rate of 60. If you
change the rate to 90, then both devices will be changed to 90. If you later change your
mind about the rates, you can select each device independently, and then enter unique
rates.

6.3.8 Deleting a BACnet Device

1. In System Browser, select Project > Field Networks > BACnet Network >
Hardware.
2. Select the device you want to delete.
3. Click the BACnet tab.

4. In the BACnet toolbar, click Delete .

 A confirmation message displays asking if you want to remove the selected
item.
5. Click Yes to confirm the operation.
 The object is removed from System Browser.

192
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Editor
6

6.4 BACnet Editor

6.4.1 Overview of BACnet Editor

The BACnet Object Editor allows you to browse, edit, and delete a wide range of
BACnet objects in a Desigo CC system. It also allows you to create new notification
class and event enrollment objects. BACnet objects are accessed in the System
Browser through the Management View (Field Networks > BACnet Network) or a user
defined view.

NOTE:
You must have Engineering mode access rights to use these features.

6.4.1.1 BACnet Object Creation

The BACnet Object Editor supports many standard BACnet object types and their
associated properties. In the BACnet Object Editor, you can create event enrollment
and notification class objects. For other BACnet objects, you can use Scheduler for
creating schedules, command, and calendar objects, and the Trends application to
create trend logs and trend log multiple objects. All other objects are created outside
Desigo CC and imported by one of two methods:
 The object is created in the network device and automatically imported with the
BACnet Auto-Discovery [➙ 179] feature.
 The object is created with the APOGEE Commissioning Tools and imported using
the SiB-X Import [➙ 219] application.

Default Properties
BACnet objects imported into the Desigo CC system have properties not coming from
the system set to common default values and settings, and in many cases no further
action is needed other than to specify specific values such as a setpoint, high and low
alarm limits, and so on. Likewise, new event enrollment and notification class objects
are created with common defaults.
In the following example, the fields in the Definitions section are defaulted to common
settings for a new event enrollment object:

193
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Editor

Event Enrollment Object Property Defaults

By default, the Reference Property and Event Type fields are filtered and provide only
the most common options for an event enrollment object. However, by clicking the All
check box, an advanced user can select from an unfiltered list of properties.

6.4.1.2 BACnet Alarming

Two methods of BACnet alarming are available: intrinsic and event enrollment
(algorithmic change reporting).

Intrinsic Alarming
Intrinsic alarming is relatively simple. The object is defined as alarmable and
configured with a few basic user supplied alarm criteria. Not all BACnet objects support
intrinsic alarming.

BACnet Objects Supported by BACnet Object Editor.

Object Intrinsic Alarming1 Object Intrinsic
Alarming1
Accumulator Yes Integer Value Yes
Alert Enrollment Yes Large Analog Yes
Analog Input Yes Life Safety Point Yes
Analog Output Yes Life Safety Zone Yes
Analog Value Yes Load Control Yes
Binary Input Yes Loop Yes
Binary Output Yes Multistate Input Yes
Binary Value Yes Multistate Output Yes
Bit String Value Yes Multistate Value Yes
Calendar No Network Security No
Character String Yes Notification Class No
Command No Notification Forwarder No
Date Pattern Value No Octet String Value No

194
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Editor
6

Date Time Pattern No Positive Integer Yes

Date Value No Program No
Device No Pulse Converter Yes
Event Enrollment No Schedule No
Event Log Yes Structured View No
File No Time Value No
Global Group Yes TrendLog Yes
Group No TrendLog Multiple Yes

Event Enrollment (Algorithmic Change Reporting)

Event enrollment is an enhanced alarming feature more flexible and powerful than
intrinsic alarming. It employs an event enrollment object (stored separately from the
BACnet object being monitored) which can be combined with a notification class object
to provide multiple messages to multiple locations (devices).
BACnet objects can have one or more event enrollment objects associated with them.
However, an event enrollment object can only be associated with one BACnet object.
Algorithmic change reporting uses an event enrollment object, which references
another source object, to generate alarm or event notifications. A property of the
referenced object is applied to a standard algorithm (event type) to determine if there
should be a change report. Occurrences of change are then reported to destinations
based on a notification class object. For example, changes to the value of a referenced
object can trigger event notifications to be sent to multiple management stations.
The following event type algorithms are specified in the BACnet standard:

BACnet Event Type Algorithms.

Event Type Parameters Description
CHANGE_OF_BITSTRING  Time Delay Occurs when the value of the referenced
 Bitmask property becomes equal to one of the values
contained in the List_Of_Bitstring_Values. This
 Bitstring Values event type generates a TO-OFFNORMAL
transition and is cleared when the value of the
referenced property is no longer equal to one of
the value contained in the
List_Of_Bitstring_Values.
CHANGE_OF_STATE  Time Delay Occurs when the value of the referenced
 Property State Type property becomes equal to one of the values
contained in the List_Of_Value, and this value
 Values remains equal for Time_Delay seconds. The
type of event may only be applied to properties
that have discrete or enumerated value,
including Boolean. This event type generates a
TO-OFFNORMAL transition.
CHANGE_OF_VALUE  Time Delay Occurs when the absolute value of a
 Property Increment referenced property changes by an amount
equal to or greater than the
 Bitstring Values Referenced_Property_Increment, and this
condition remains for Time_Delay seconds.
This event type generates TO-NORMAL
transitions.

195
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Editor

COMMAND_FAILURE  Time Delay Occurs if the values of the referenced property

 Feedback Property Reference and the Feedback_Property_Reference
disagree for a time period greater than the
Time_Delay parameter. It may be used to verify
that a process change has occurred after
writing to a property. The type of event only
applies to properties that take on discrete
value. This event type generates a TO-
OFFNORMAL transition.
FLOATING_LIMIT  Time Delay Occurs if the referenced property leaves a
 Low Diff Limit range of values determined by the current value
of the Set_Reference, High_Diff_Limit,
 High Diff Limit Low_Diff_Limit, and Deadband. This type of
 Deadband event generates a TO-NORMAL transition.
 Setpoint Reference
OUT_OF_RANGE  Time Delay Occurs if the referenced property leaves a
 Low Limit range of values defined by the High_Limit and
Low_Limit parameters and remains there for
 High Limit Time_Delay seconds. If the transition is to a
 Deadband value above the High_Limit or below the
Low_Limit, the object generates a TO-
OFFNORMAL transition.
BUFFER_READY  Notification Threshold Occurs when a number of records specified by
the Notification_Threshold have been entered
into the log since the start of operation or the
previous notification, whichever is most recent.
This type of event generates a TO-NORMAL
transition.
UNSIGNED_RANGE  Time Delay Occurs if the referenced property leaves the
 Low Limit range of values from Low_Limit through
High_Limit parameters and remains there for
 High Limit Time_Delay seconds. This type of event
generates a TO-NORMAL transition.
CHANGE_OF_LIFE_SAFETY  Time Delay Occurs when the value of the referenced
 Mode Property Reference property becomes equal to any of the values in
the List_Of_Life_Safety_Alarm_Values and
 Life Safety Alarm Values remains within the set of values in the list for
 Alarm Values Time_Delay seconds. This type of event
generates a TO_OFFNORMAL transition.
DOUBLE_OUT_OF_RANGE  Current State Detects whether the monitored value exceeds a
 Monitored Value range defined by a high limit and a low limit.
Each of these limits may be enabled or
 Status Flags disabled. If disabled, the normal range has no
 Low Limit lower limit or no higher limit respectively. In
 High Limit order to reduce jitter of the resulting event
state, a deadband is applied when the value is
 Deadband
in the process of returning to the normal range.
 Limit Enable
 Time Delay
 Time Delay Normal

196
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Editor
6

CHANGE_OF_CHARACTERSTRI  Current State Detects whether the monitored value matches a

NG  Monitored Value character string that is listed as an alarm value.
Alarm values are of type
 Status Flags BACnetOptionalCharacterString, and may also
 Alarm Values be NULL or an empty character string. A
 Time Delay "match" of the monitored value with an alarm
value is defined as follows:
 Time Delay Normal
(a) If the alarm value string is NULL, then it is
not considered a match.
(b) If the alarm value string is empty (of zero
length), then it is considered a match if and only
if the monitored value is also an empty string.
(c) If the alarm value string is not empty, then it
is considered a match if the alarm value string
appears in any position within the monitored
value string. For character-matching purposes,
character case shall be significant,and so a
match must be an exact match character by
character.

For more information about BACnet algorithmic change reporting, see Section 13.3 of
the ANSI/ASHRAE Standard 135-2008 (or later) and the documentation provided by
the manufacturer of the BACnet device (field panel) providing the algorithmic change
reporting.

Copying Alarms to Other Objects

The Copy All feature allows you to copy the intrinsic alarm and the associated event
enrollment objects of a selected object to one or more target objects. This process
creates new event enrollment objects for each target object, and overwrites the
intrinsic alarm properties of the target objects with the intrinsic alarm properties of the
selected object.
You can begin a copy procedure and then work with any other management station
features, since the Copy All feature runs in the background. This includes starting a
second alarm copy operation.

6.4.1.3 Notification Class Object

A notification class object is required for both types of BACnet alarming. It directs
alarm or event notifications to specific recipients (devices or management stations).
This object also defines which alarm and event notifications a device can receive, the
priorities of the event-notification messages, and whether acknowledgments are
required.

Notification Class Priority Ranges.

Message Group Priority Range Network Priority
Life Safety 00 – 31 Life Safety Message
Property Safety 32 – 63 Life Safety Message
Supervisory 64 – 95 Critical Equipment Message
Trouble 96 – 127 Critical Equipment Message
Miscellaneous Higher Priority Alarm 128 - 191 Urgent Message
and Events
Miscellaneous Lower Priority Alarm 192 – 255 Normal Message
and Events

197
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Editor

The Copy All feature overwrites the intrinsic alarm information of the target objects. If
the notification class object in the source object does not exist in the target object, then
a notification class object is created.

6.4.2 BACnet Editor Workspace

BACnet Object Editor (Intrinsic Alarm Selected).

When selecting a BACnet object in the System Browser, the BACnet Object Editor
displays the following sections in the Primary pane (the sections displayed will vary
based on the selected object):
 Main (Object Properties) [➙ 206]: The object’s primary properties.
 Alarming (Intrinsic Alarming) [➙ 203]: If Alarm Level 1 (Intrinsic alarming) is
selected, you can edit the object’s intrinsic alarming properties. Not all BACnet
objects support intrinsic alarming.
 Alarming (Event Enrollment) [➙ 200]: Each object can have one or more event
enrollment objects associated with it. However, each event enrollment object can
only be associated with one BACnet object.
 Copy Alarms [➙ 204]: Use this feature to copy the alarms from a selected (source)
object to one or more target objects. This process creates new event enrollment
objects for each target object, and overwrites the target object’s intrinsic alarm
properties with the properties of the selected object.
 Recipient List (Notification Class) [➙ 208]: The properties for a Notification Class
object. (This section is not shown in the screen above.)
 Life Safety Memberships [➙ 205]: This view displays the memberships of the
object selected in the System Browser.
 Structured View Subordinate List [➙ 210]: This view provides a container to hold
references to subordinate objects, which may include other Structured View
objects.

198
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Editor
6

 Trended Properties [➙ 211]: Displays the properties that a Trend Log or Trend Log
Multiple collects.
 Start/Stop (Trend Logs) [➙ 209]: Use this section to specify starting and ending
dates for trend log collection.
 Property [➙ 207]: By default, any additional BACnet properties not displayed in any
other sections of the BACnet Object Editor displayin this section.
The following icons are available, depending on the type of object selected:

Application Toolbar.
Icon Name Description
Create New BACnet Select a device or an existing notification class object and
Object click this button to create a new notification class object.
Applies only to Notification Class [➙ 208] objects.
Save Saves any changes made to the notification class object.
Applies only to Notification class objects.
Save As Select an existing notification class object and click this
button to create a new object. You will be prompted to
specify a name and description for the new notification class
object. Its fields will be populated with default values. Applies
only to Notification class objects.
Delete Delete the object selected in the System Browser. If an
event enrollment object is selected, a message displays
notifying you that deleting the event enrollment object also
deletes its referenced BACnet object and other event
enrollment objects associated with the referenced object.

Copy All Copy all the event enrollment objects and/or the intrinsic
alarm associated with the selected BACnet object to one or
more BACnet objects. This creates new event enrollment
objects for each target object, and overwrites the intrinsic
alarm properties of the target objects with the intrinsic alarm
properties of the selected object.

199
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Editor

6.4.2.1 Alarming (Event Enrollment)

The fields that display in the Alarming section can vary depending on what you select
in System Manager; a point that is referenced by one or more event enrollment
objects, or an object that is an event enrollment object.

For points referenced by one or more event enrollment objects, the following fields are
displayed when an event enrollment object is selected in the Alarming section:

Field/Button Description
New Click this button to create an event enrollment object. The new object
displays in the list with the default name EE_#_ monitored object ID
where:
 EE indicates an event enrollment object.
 # automatically increments by one (1) with every newly created
event enrollment object.
 monitored object ID is the Desigo CC system ID.
You can edit this name in the BACnet Name field of the Advanced
section.
Delete Deletes the selected event enrollment object.
Definitions These fields calculate when an alarm should be issued. The fields
default to the most common selections for the event enrollment object’s
associated object.
BACnet Name The BACnet name that is unique within the device. The Desigo CC
object name displays in the System Browser, and is edited in the Object
Configurator.

200
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Editor
6

BACnet Description The object’s BACnet description.

Reference Property The property of the associated object which is applied to a standard
algorithm (selected in the Event Type field) to determine if a change
report (alarm) should be generated.
Event Type The algorithm used with the property selected in Reference Property
field. See Event Enrollment (Algorithmic Change Reporting) [➙ 195] for
more information. If desired, you can edit the Event Type regardless of
whether the event enrollment object already exists at the device.
Device Name The Desigo CC name of the device where the event enrollment object
resides.
Destination Specify the destination (notification class) of the alarm from the drop-
(Notification Class) down field.
Event Parameter Displays the parameters for the selected event type. When a BACnet
object is required for the parameter, you can drag and drop the object
from the System Browser to the BACnet Name field.
Fault Parameters For any BACnet device that supports it, this allows an event enrollment
object to generate a fault event, instead of OffNormal, based on
specified parameters.
Advanced
Object Type The BACnet object type.
Instance Number The number which uniquely identifies the object within the device.
Check the Auto-Assign box when creating a new event enrollment
object to have the system assign this number.
Profile Name The object’s profile, which defines the set of properties, behavior,
and/or requirements for a proprietary object, or for proprietary
extensions to a standard object.
Notify Type  Alarm: Enables alarm notification. Alarm and event types are
treated the same.
 Event: For integration with third-party management stations that
can then define alarms for BACnet objects, or configure alarms for
life safety events.
Event Enable Specify the types of alarm events:
 To-OffNormal: Sends a notification when the object value goes into
an alarm state.
 To-Fault: Sends a notification when the object value goes into a
fault state (failed, etc.).
 To-Normal: Sends a notification when the object value returns to
normal from another state.
Send Saves any changes you have made.
Cancel Discards any changes you have made.

When an event enrollment object is selected, the fields displayed are identical to the
points referenced by one or more event enrollments, except for the following
differences:
 The Main expander displays the event enrollment object’s information, not the
information of the point that the event enrollment object is monitoring.
 The Definitions and Advanced expanders in the Alarming expander do not
duplicate information already displayed in the Main expander.
 The alarm list that normally displays on the left of Alarming expander is replaced by
the Monitored Object expander.

201
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Editor

Field/Button Description
Monitored Object To change the monitored object, drag the BACnet object from the
System Browser to this section. The BACnet name and Device name
for the object displays in the list. If you drag a new object into this
section, the monitored object reference is replaced, and the Event
Parameter information in the Definitions expander is replaced with the
default type for the new object.
NOTE: You cannot drag an event enrollment object or multiple
instances of the same object into this section.
Goto Ref Object Use this button to navigate directly to the referenced point.

202
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Editor
6

6.4.2.2 Alarming (Intrinsic Alarming)

If the BACnet object supports intrinsic alarming, then Alarm Level 1 (Intrinsic Alarming)
displays. Select it to edit the object’s intrinsic alarming properties.

Field/Button Description
New+ A BACnet object only has one intrinsic alarm. Clicking the New button
lets you create a new event enrollment object. Since you cannot delete
an intrinsic alarm, the Delete button is unavailable.
Definitions This section displays the alarm properties. The fields displayed will vary
depending on the BACnet object type selected in the System Browser.
Advanced
Destination Specify the destination (notification class) of the alarm.
Notify Type  Alarm: Enables alarm notification. Alarm and event types are
treated the same.
 Event: For integration with third-party management stations that
can then can define alarms for BACnet objects, or configure alarms
for life safety events.
Event enable Specify the types of alarm events:
 To Off Normal: Sends a notification when the object value goes into
an alarm state.
 To Fault: Sends a notification when the object value goes into a
fault state (failed, etc.).
 To Normal: Sends a notification when the object value returns to
normal from another state.
Send Saves any changes you have made.
Cancel Discards any changes you have made.

203
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Editor

6.4.2.3 Copy Alarms

This section displays when you click the Copy All button on the Application toolbar
[➙ 198]. It allows you to copy the event enrollment objects and the intrinsic alarm
properties associated with a BACnet object (source object) to one or more BACnet
objects (target objects). This process creates new event enrollment objects for each
target object, and overwrites the target object’s intrinsic alarm properties with the
properties of the selected object.
This feature has two tabs: Targets and Activity.

Targets Tab
This tab displays by default. this tab lets you build the list of objects you want to copy
the alarms to. You build the list by dragging and dropping the objects from the System
Browser. This tab also lets you initiate the copy operation.

Field/Button Description
Drag acceptable Select the objects in the System Browser you wish to copy alarming
(similar type) BACnet information to and drag them to this window.
object(s) from system
browser to the area
below
Name The Desigo CC object name.
Progress Indicates the progress of the copy operation.
Copy Copies the event enrollment objects and the intrinsic alarm properties to
the listed objects. The copy operation creates new event enrollment
objects for each target object, and overwrites the intrinsic alarm
properties of the target object with those of the copied object.
Cancel Copy Cancels the copy operation currently in progress.
Remove Select one or more objects in the list to remove them.
Close Closes the Copy All list.

Activity Log
This tab provides status information of the latest copy procedure. This feature runs in
the background, so you can begin a procedure and then work with other management
station applications. The results of all copy operations display until the client
management station is closed or the user logs off. Therefore, no archive of the copy
operations is saved.

204
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Editor
6

Field/Button Description
Name The Desigo CC object name.
Status Displays the results of the copy operation for the listed object. Click the
Status link to expand the entry (expanded entry shown in the example
above). Click the Close button, immediately below it, to collapse the
entry.
Remove Select one or more objects in the list to remove them.
Close Closes the Copy All list.

6.4.2.4 Life Safety Memberships

This read-only section displays the memberships of the object selected in the System
Browser.

Column Description
Name The selected object’s memberships:
 Member of: The life safety zone(s) the object belongs to.
 Zone Members: This field only displays if a life safety zone object is
selected. It displays the life safety objects that are members of the
selected life safety zone object.
Device The name of the device where the object resides.

205
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Editor

6.4.2.5 Main (Object Properties)

This section displays the common properties for the BACnet object selected in the
System Browser. If a notification class object has been selected then only the BACnet
Name, BACnet Description and Device Name fields display. If an event enrollment
object is selected in the System Browser, then the properties for the object associated
with the event enrollment object display.

Field/Button Description
BACnet name The name that is unique within the device. The Desigo CC object name
is displayed in the System Browser, and is edited in the Object
Configurator. You can only edit this field for a new object.
BACnet description The BACnet object’s description.
Type The BACnet object type.
Device name The Desigo CC name of the device where the object resides.
Instance number The number which uniquely identifies the object within the device.
Profile name The object’s profile, which defines the set of properties, behavior,
and/or requirements for a proprietary object, or for proprietary
extensions to a standard object.
Send Saves any changes you have made. For a notification class object, you
must save the changes using the Save button on the toolbar.
Cancel Discards any changes you have made.

206
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Editor
6

6.4.2.6 Property

The Property section shows, by default, any additional BACnet properties not
displayed in any other sections of this application. Properties that you can update have
visible fields and buttons.
For detailed information regarding BACnet object properties, see ANSI/ASHRAE
Standard 135-2008 (or later).

207
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Editor

6.4.2.7 Recipient List (Notification Class)

Field/Button Description
Recipient List This section defines the notification class object’s recipient list (the list
of devices or management stations receiving object alarms). Click New
or select an existing destination to display the Destination and
Advanced Notification sections. Use these sections to specify a device.
To remove a destination from the list, select the destination and click
Delete.
Destination
Destination type Specify the device using one of the options from this drop down list.
Additional fields may be displayed depending on your selection:
 Device: Select the device from the Device name list.
 MAC Address: Enter the device information in the MAC Address
and Network fields.
 Global Broadcast: Messages are broadcast to all devices on all
networks.
 Local Broadcast: Messages are broadcast to all devices on the
network where the device resides.
Advanced Notification
Valid Days and Time Use these check boxes and fields to specify the days and time period
Period when the device can receive notifications. Check the All day check box
to receive notifications 24 hours a day.
Transitions Specify the transition states the device can receive:
 To-OffNormal: check this box to receive notifications when the
object value goes into an alarm state.
 To-Fault: check this box to receive notifications when the object
value goes into a fault state (failed, etc.).
 To-Normal: check this box to receive notifications when the object
value returns to normal from another state.

208
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Editor
6

Recipient process Identifies an application process inside a BACnet device.

Issue confirmed Check this box if the device sending the alarm requires a response from
notifications the device receiving the alarm.
OK Click this button to save the changes made to the device and continue
editing the notification class object. You can create a new device or edit
an existing device, or edit the object’s Advanced fields.
NOTE: To save all changes made to the Recipient List and Advanced
sections, you must click the Save button on the Application Toolbar
[➙ 198].
Cancel Click this button to cancel any changes you have made.
Advanced
Instance number The number which uniquely identifies the object within the device.
Check the Auto-Assign box when creating a new notification class
object to have the system assign this number.
Profile name The object’s profile, which defines the set of properties, behavior,
and/or requirements for a proprietary object, or for proprietary
extensions to a standard object.
Acknowledgement Specify the types of alarm events which require acknowledgement:
required  To Off Normal: When the object value goes into an alarm state.
 To Fault: When the object value goes into a fault state (failed, etc.).
 To Normal: When the object value returns to normal from another
state.
Priority Assign a priority level [➙ 197] to each alarm event.

6.4.2.8 Start/Stop (Trend Logs)

In the Trend Start and Trend Stop sections, the date strings initially display as they are
defined in the device. If wildcards are present in any of the values, Wildcarded
displays above the date string and the Date and Time fields are hidden.

209
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Editor

NOTE:
In order to save any date or time changes that you make, you cannot combine
wildcards with your entries. You can have either complete date and time values or all
wildcards, but not a combination of both.

Field/Button Description
Trend Start, Use the Trend Start and Trend Stop sections to specify starting and ending
Trend Stop dates for trend log collection. Check the Specify box to display the Date and
Time fields.
Specify/Specified If wildcards are present in the start or stop times, the Specify box is unchecked
and the Date and Time fields are hidden. When you check Specify, its name
changes to Specified and the Date and Time fields display. The default Trend
Start time is the current date and time, and the default Trend Stop time is 24
hours from the current date and time.
NOTE: Unchecking the Specified box replaces the date and time with all
wildcards (*).
Date Allows you to select the start or stop date.
Time Allows you to select the start or stop time.
Send Saves any changes you have made.
Cancel Discards any changes you have made.

6.4.2.9 Structured View Subordinate List

The Structured View object provides a container to hold references to subordinate

objects, which may include other Structured View objects. This allows multilevel
hierarchies to be created, which can convey a structure or organization such as a
geographical distribution or application organization.
Subordinate objects may reside in the same device as the Structured View object or in
other devices on the network. You build a structured view subordinate list by dragging
the objects from the System Browser to this section.

Field/Button Description
Name Name of the object included in this list.
Device The device where the object resides.
Type The BACnet object type.
Annotation text Optional text that can be entered to describe the list member.
Remove Select one or more objects in the list and click this button to remove it.
Send Click this button to save any changes you have made.

210
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Editor
6

Cancel Click this button to discard any changes you have made.

6.4.2.10 Trended Properties

This section displays the properties that a Trend Log or Trend Log Multiple collects.
While only one property displays for Trend Logs, a Trend Log Multiple can have any
number of trended properties.
When you drag-and-drop single or multiple objects into this section, the default
property of the object displays in the Property field. To specify a different property for
collection, click and select it from the drop-down menu.
With Trend Log Multiple, you can add the same object more than once to collect
different properties. For example, you can add Analog Input 1 twice, specifying Present
Value in the first instance and Status Flags in the second.

Field/Button Description
Name The object’s name.
Device The device’s name.
Property Lists all available properties for the object.
Remove Select one or more objects in the list and click this button to remove
them.
Send Click this button to save any changes you have made.
Cancel Click this button to discard any changes you have made.

211
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Editor

6.4.3 Working with BACnet Editor

NOTE:
You must have Engineering mode access rights to use these features.

6.4.3.1 Editing a BACnet Object

1. In the System Browser, select the object whose properties you wish to edit.
 The BACnet Object Editor [➙ 198] displays in the Primary pane.
2. In the Main section, edit the primary BACnet properties [➙ 206].
3. In the Alarming section, edit the object’s intrinsic alarming [➙ 203] or create and
edit event enrollment objects [➙ 200]. The latter is an enhanced alarming feature
that is more flexible and powerful than intrinsic alarming
 The Property section displays additional BACnet properties [➙ 207] not shown in
any of the other sections of the BACnet Object Editor.

6.4.3.2 Specifying Alarming for a BACnet Object

Two methods of alarming are available for BACnet objects: intrinsic and event
enrollment (algorithmic change reporting).

NOTE:
You can also copy the intrinsic alarm properties and event enrollment objects from a
BACnet object to one or more target objects. See Copying BACnet Alarms to Other
Objects [➙ 213] for more information.

 To specify alarming for a BACnet object, at least one notification class object must
already exist in the system.
1. In the System Browser, select the BACnet object for which you wish to specify
alarming, and edit the appropriate sections in the Alarming section of the BACnet
Object Editor.
2. If the object supports intrinsic alarming, then Alarm Level 1 (Intrinsic Alarming) is
listed in the Alarming list. Select this item and edit any fields [➙ 203] in the
Definitions and Advanced sections as appropriate.

NOTE: You cannot delete the intrinsic alarm from a BACnet object. The Delete
button only deletes event enrollment objects.
3. Click the New button in the Alarming section to create an event enrollment object.
4. In the Alarming list, select the event enrollment object and edit any fields [➙ 200] in
the Definitions and Advanced sections as appropriate.
5. Click Send to save any changes.

212
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
BACnet Editor
6

6.4.3.3 Copying BACnet Alarms to Other Objects

You can copy all the event enrollment objects and the intrinsic alarm properties
associated with a BACnet object to one or more BACnet objects. This process creates
new event enrollment objects for each target object, based on the properties of the
copied objects (any existing event enrollment objects remain). It also overwrites the
intrinsic alarm properties of the target object with the intrinsic alarm properties of the
selected object.
Since this process works in the background, you can start a copy procedure and then
continue to work with other management station features.
1. In the System Browser, select the BACnet source object whose alarms you wish to
copy, then check the Manual Navigation box.

2. Click Copy All to display the Copy All list box in the Alarming section.

3. Select the target BACnet objects you wish to copy the alarms to, then drag and
drop them to the Copy All list on the Targets tab.
4. Use the buttons of the Copy Alarms section [➙ 204] to edit this list and to start or
cancel the copy procedure.
5. Click the Activity Log tab to view the results of the latest copy procedure.
 New event enrollment objects with the properties of the copied objects are created
for each object selected in Step 3. The intrinsic alarm properties of the target
objects are overwritten with the alarm properties of the selected object.

NOTE:
If the notification class object specified in the source object does not exist in the target
object, then a new notification class object is created.

213
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 BACnet
6 BACnet Editor

6.4.3.4 Creating/Editing a Notification Class Object

At least one notification class object must exist in the system to specify alarming for
BACnet objects.
1. In the System Browser select an existing notification class object or a device.

2. To create a new notification class object, click New In the BACnet Object
Editor pane. Alternately, to create a new notification class object based on an
existing object, click Save As.

3. Edit the selected notification class object in the BACnet Object Editor [➙ 198].
4. In the Main section you edit primary BACnet properties [➙ 206].
5. The Recipient List section allows you to define the list of devices [➙ 208] receiving
BACnet alarms. You can specify multiple devices for the notification class object.
6. In the Advanced section you edit additional object and alarm properties for the
object.

7. To save your changes click Save.

NOTE: Clicking OK in the Advanced Notification section only temporarily saves
data for the device selected in the Recipient List. To save all changes made to the
notification object you must click the Save button on the Application toolbar.

6.4.3.5 Deleting a BACnet Object

1. In the System Browser, select the BACnet object you wish to delete.

2. Click Delete on the BACnet Object Editor [➙ 198] Application toolbar.

NOTICE

Because an event enrollment object can only exist in conjunction with another
BACnet object, using the Delete button for an event enrollment object selected in the
System Browser will also delete its referenced object, plus any other event enrollment
objects associated with the referenced object.
To delete a single event enrollment object you must delete it using the Delete button
in the Alarming section of the referenced BACnet object.

214
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Field Data Import
BACnet Editor
7

7 Field Data Import

You have two choices for importing devices into a management system.

File Import
With this method, you export the field panel databases from the Commissioning Tool
(for example, using the SiB-X Export Tool), and then import the databases using the
management system’s import [➙ 219] tool. You may want to use this method for new
or existing jobs, where all of your work—creating graphics, setting up the networks,
and so on —is done prior to arriving at the job site (offline commissioning). You must
use this method for all the subsystems that do not support the auto discovery feature.

Auto Discovery
With this method, you use the management system’s Auto Discovery [➙ 179] feature
to set filters and detect your devices on the network, which then display in System
Browser. You may want to use this method only for new or existing jobs, where the
auto discovery feature is supported and field panels are already installed and online
(online commissioning).

Supported File Formats

The management system supports the following formats for the import:
 XML (SiB-X files)
 CSV
 SIBX
 EXP
 XLSX
 S1X
 ZIP
 CFG

215
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Field Data Import
7 Import Workspace

7.1 Import Workspace

Depending on the installed extension modules, you can import configuration files (for
example, SiB-X XML files) of specific devices into the management system.

Example of Field Data Import

You will be able to select one or more configuration files, select the items to import,
and carry out the import operation.

Import Fields
Item Description
Browse Display the Open dialog box, and select a file to import.
The path of the selected file appears in the field.
Analysis Log Open a log about pre-import operations. The file is parsed to check for
errors or unsupported objects before import.
A message box informs you of any warning/errors, and suggests you
view the log.
This button is available after selecting a file to import.
Import Log Open a log about file reading operations. In particular, this log contains
the time for the operations, the name of the processed files, and
warnings/errors (if any).
A message box informs you of any warning/errors, and suggests you
view the log.
This button is available only when the file processing is completed.
Source Items Preview all the objects available for a selected file, identified by the
following:
 ID
 Name
 Instances

216
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Field Data Import
Import Workspace
7

Items to Import Preview all the objects selected for the import, identified by the
following:
 ID
 Name
 Instances
 State, (status of the import such as, in progress, imported, or failed)
By default, this section is empty. Move the items from Source Items to
Items to Import or vice versa by double-clicking the single item, or using
the buttons (these buttons provide tooltips suggesting the action to
take).
Search Apply a filter to the content of the corresponding list (Source Items or
Items to Import).
Delete the text in this field to remove the filter.
Delete unselected Specify whether or not, during the import, you want to remove from the
items from the views Views any items that are not present in the file to import. You can use
this option, for example, when there is some pre-existing data in the
system for that view, but you don’t want to retain it. If selected, any
items relevant to the objects are also deleted (text groups included).
NOTE: This option is not available when importing Object Models.
Import Start the import.
This button is available only if the Items to Import preview is not empty.
Cancel Abort the import.
This button is available only during the import.

When the import operation completes, the Import dialog box displays a summary of the
import information.

BACnet - Device Import Completed

For details about the import procedures that may be relevant for your installation,
please refer to the documentation for the specific subsystems.

217
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Field Data Import
7 Defining Hierarchies Mapping

7.2 Defining Hierarchies Mapping

When available, the Hierarchies Mapping expander allows you to define in which
System Browser view hierarchies of objects will be imported that is, where they will be
automatically built according to the management, logical, or physical level. By default,
every hierarchy is assigned to the Management View only. For the Physical View or
Logical View, you must assign the view root level.
 The network where field data will be imported is selected in System Browser.
1. In the Primary pane, click the Import tab.
2. Open the Hierarchies Mapping expander.
Here you must define the destination in the system views of the data structures
(hierarchies contained in the configuration file). The suggested field indicates the
correct view root to link for each specific hierarchy.
3. To assign each hierarchy to a destination view, proceed as follows:
– Select the option Manual Navigation, to freeze the Primary pane.
– In System Browser, select the view (Physical View or Logical View).
– Drag-and-drop the view root element from System Browser, to the suggested
field.
 The hierarchies settings configured are activated and will be applied during field
data import.

Technical Notes
 By default, after you extract data from one or more files, the expander displays the
hierarchies for the selected file(s) and any indications - based on the import rules -
about the System Browser view root to link for each hierarchy.
 The hierarchies mapping is saved only when the import starts. If you modify the
mapping without starting the import, any change is lost.
 Once the import is complete you cannot change this mapping unless you delete
the root of the Physical View or Logical View in System Browser. This results in
clearing the view in the hierarchies mapping that can be edited again.

218
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Field Data Import
Importing Field Data
7

7.3 Importing Field Data

Depending on the installed modules, Desigo CC can handle the import of data relating
to certain devices. The following provides the general workflow for importing field data
and general remarks about the import operation.

General Workflow
1. Select the configuration file to import.
2. Define the hierarchies mapping [➙ 218] (when required).
3. Select the items and import data.
For detailed import procedures, refer to the documentation for the specific subsystems.

Technical Notes
Selecting the File to Import
 When you browse and select a file to import, its format is validated. If the file is
correct, the item list displays in the Source Items preview; otherwise, a message
asks you to select another file.
 If you change your selection in System Browser after having selected a file to
import, a warning message tells you that doing so will clear the current Source
Items preview, and asks if you want to proceed.
- Click Yes to go ahead with changing the selection. The Source Items preview will
be lost.
- Click No to cancel the selection change. The system ignores the last selection
you made in System Browser, and the existing Source Items preview is retained.
 Once you select a SiB-X file (for example, for a BACnet network) remember to map
the hierarchies [➙ 218] before proceeding with the import.
 When performing a SiB-X import under a network (for example, a BACnet
network), you can also select multiple files. The import operation results in all the
devices for the selected files being imported.
 When selecting multiple files, if they contain devices having the same ID, a
message informs you that only the device contained in the last file will be imported.
Selecting the Items to Import
 When choosing the items to import you may want to filter the source items list by
typing some search-matching characters in the Search field. Once you filter items,
to remove the applied filer, delete the text.
 You can transfer items from the Source Items list to the Items to Import list in one
of the following ways:
– One-by-one: Double-click (or select) an item and click .

– Multiple transfer: select the items and click .

 You can move items back from the Items to Import list to the Source Items list, in
one of the following ways:
– One-by-one: Double-click (or select) an item and click .

– Multiple transfer: select the items and click .

Importing Data
 Before the import, verify that the import rules are available for the library of the
concerned product family, create any views required in the project, and specify the
hierarchies mapping [➙ 218] for the selected configuration file.

219
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Field Data Import
7 Importing Field Data

 When you click the Import button, you may get a warning or error if the number of
source items selected for import will cause the system to approach or exceed the
system limits (maximum permitted number of objects). See Hardware Category
and System Limits [➙ 29] for more details.
NOTE: For the current version of Desigo CC, this feature is available only for the
SiB-X import and OPC import.
– If the import would exceed the system limits, an error message displays and
the import operation will not start. Check the system limits [➙ 29], reduce the
number of source items, and try again.
– If the import would cause the system to approach the system limits, a warning
message displays and asks you whether or not you want to continue. Click Yes
to proceed with the import. Click No to abort the operation.
 During the import, when uploading a SiB-X formatted configuration file, if a new
object is detected it is automatically imported under the corresponding family or
device.
 During the import, the Primary pane refreshes to display the Import in progress
page where you can check the import state; click Cancel to abort the operation.
 When importing a SiB-X file, as the operation proceeds, the imported hierarchies
and the corresponding devices appear under the assigned views.
 If you change your selection in System Browser while an import is in progress, a
message box warns you about the ongoing operation and asks you what to do.
- Click Yes to abort the import.
- Click No to continue with the import.
- Click Cancel to cancel the selection change. The system ignores the last
selection you made in System Browser.
 When the import completes successfully, the Import dialog box displays its
outcome (such as, New instances created/Instances modified/Failed
instances/Deleted instances/import completed in [min/sec]). The imported items
appear in System Browser as instances of the selected family/device.
Re-importing Data
 The re-import either partially or completely re-imports existing data in order to
update it (matching the configuration file data). This may imply adding, modifying,
or deleting data stored in the database.

220
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
Overview of Scopes
8

8 Scopes
Scopes are used to expose or conceal groups of objects. They are employed by
several applications in the Desigo CCsystem, including Security Groups, Journaling,
RENO, Macros, and so on to program the conditions to, in part:
 access parts of the system
 define a trigger
 execute a process
The following provides a description of the Desigo CC Scopes configuration and the
corresponding configuration procedures.

8.1 Overview of Scopes

A scope is a collection of system objects. These objects are referenced by trees,
subtrees, and nodes in the System Browser. An object can be referenced by multiple
nodes in different views or within the same view. The contents of a scope are not
determined when creating or saving a scope, but at run time when the scope is used or
applied.
Scopes are used by several applications in Desigo CC such as Security Groups,
Journaling, RENO, Macros and so on. You can configure a scope to define the objects
that can be included or excluded from it. This configuration can be saved as a Scope
Definition. When a scope is assigned to a user group and users from the group logon
to the system, the configurations defined in the scope definition are applicable to all the
users in the group. Accordingly, the users may or may not be able to see the objects
when they logon to the system.
A Scope Definition is made up of Scope Rules and/or Scope Exceptions that include or
exclude node(s) and subtrees from the views in the System Browser.

Examples of Scope Definitions

Some examples of Scope Definitions are:
 Include all objects of Libraries from the Management View (Scope Rule Include)
 Exclude all objects of Libraries from the Management View that belong to Fire and
Video (Scope Rule Exclude)
 Exclude all objects Libraries from the Management View but include only
Fire_Detection_HQ_1 (Scope Exception Include)
 Exclude Building2.DeliveryRamp.Gate1 from the User-defined View (Scope
Exception Exclude(node only))
 Exclude all objects of Panel1 from the Physical View (Scope Exception Exclude
(subtree))
In a Scope Definition, a Scope Exception has precedence over a Scope Rule while
displaying the configured system objects. Thus, the priority to display the system
objects for a user in the Desigo CC system is as follows:
 Scope Exceptions Exclude row
 Scope Exceptions Include row
 Scope Rules Exclude row (child of Include row)
 Scope Rules Include row
As scopes are tree based, the scope (i.e. the group of objects) can change in the
course of time without changing the Scope Definition.
A system object can be contained in one or more Scope Definition(s). The Scope
Definition, in turn, must be included in at least one scope right [➙ 79] for a user in a

221
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
8 Overview of Scopes

user group or a management station group configured in Security, in order to be visible

to the users of the Desigo CC system.
You can use Scopes to create [➙ 234], configure [➙ 234] and modify [➙ 238] the
Scope Definitions that are used in the Desigo CC system.

Scope Scenarios:
The following scenarios will help you to understand Scopes and also provide
information on the data displayed according to the applied configurations.

Scenario 1:
Scope Definition with only a Scope Rule Include row. No rows with Scope Rule
Excludes or any Scope Exceptions.
Consider a scenario, where you have a scope definition with only a scope rule include
row to include all objects of the Management View.

When the scope is applied at run time, the users from the group to which this scope
definition is assigned, will see the entire Management View.

222
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
Overview of Scopes
8

Scenario 2:
Scope Definition with Scope Rule Exclude row below the Scope Rule Include row
defined in Scenario 1.
In this scenario, two Scope Rule Exclude rows are added to exclude the details of
BACnet devices 2 and 3.

When the scope is applied at run time, the users from the group to which this scope
definition is assigned, will see the entire Management View, except the Device 2 and
Device 3 nodes and their child nodes.

Scenario 3:
Scope Definition with a Scope Rule Include row and a Scope Exception row.
In this scenario, we add a Scope Exception row to exclude the Field Networks node
and all the child nodes below it in the Management View.

When the scope is applied at run time, users from the group to which this scope
definition is assigned, will see the entire Management View, except the Field Networks
node and its child nodes.

223
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
8 Overview of Scopes

Scenario 4:
Scope Definition with a Scope Rule Include Row, Scope Rule Exclude Row, and a
Scope Exception Exclude Row.
In this scenario, we add two Scope Rule Exclude rows to exclude the details of Fire
and Network libraries. Additionally, we also add a Scope Exception row to exclude the
complete Libraries node.

When the scope is applied at run time, the details of the entire Management View
except the Libraries node are visible to users from the group to which this definition is
assigned. This is because the Libraries node is added to the Scope Exception Exclude
row that has the highest priority in the scope definition.

224
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
Overview of Scopes
8

Scenario 5:
In this scenario, we create a Scope Definition that contains the same objects (For
example, BACnet Schedules) that are referenced in the Application and Logical Views.
This definition has a Scope Rule Include row to include all the objects of the
Application View, a Scope Rule Exclude row to exclude the BACnet Schedules node
and all its child nodes, and a second Scope Rule Include row that references the
BACnet Schedules object from the Logical View.

225
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
8 Overview of Scopes

When this definition is assigned to a user group, then all the users of this group will see
the entire Application View including the BACnet Schedules node and all of its child
nodes. This is because even if the BACnet Schedules node is excluded in the Scope
Rule that is referenced from the Application View, the node is included in the second
Scope Rule Include row that is referenced from the Logical View.

Output - Appplication View Output - Logical View

226
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
Overview of Scopes
8

8.1.1 Scopes Rights and Security

By assigning scope rights in Security, you can incorporate user group or management
station group level scope rights for a user or station of Desigo CC. You assign scope
rights to Scope Definitions.
The following are the rules for assigning scope rights for a Scope Definition:
 Only the system objects that are configured in the Scope Definition(s) (not
excluded) are available to the logged-in user in the System Browser tree.
 If a parent system object is not included in one of the Scope Definitions assigned to
the group, then none of its children are visible in the System Browser tree. They
are visible only in applications such as graphics, trends, or reports, if the user has
access to such objects.
 To exclude a system object for a user, user group, or management station group, it
should not be included in the Scope Rule/Exception Include row of the Scope
Definition.
 If more than one Scope Definition is assigned to a user, then to exclude an object it
should be excluded from all the Scope Definitions.
 An object in the Scope Rule/Exception path is as an unknown object, if it meets
any of the following criteria:
– Deleted
– Moved to another location in the System Browser tree
– Deleted and created again at the same location in the tree
– Not in the scope of the logged-in user
 An unknown object, present in the path of a Scope Rule/Exception Include/Exclude
row, makes the path invalid and is indicated in red.

NOTE:
You must include the Hierarchy tree root node of the selected view as one of the
Include rows in Scope Rules/Exceptions of a Scope Definition to view its child nodes.

WARNING

Modifying the Scope Rights associated with a User Group requires stopping and
restarting the client to activate the modifications. Since in Closed mode it is not
possible to exit the client, if you’re working on a management station in Closed mode,
please contact your system administrator to change the management station settings
so you can stop and restart.

227
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
8 Scopes Workflow

8.2 Scopes Workflow

The following describes the Scopes workflow in the Primary pane.
During an engineering session, in System Browser, create a new Scope Definition
[➙ 234].
Next, you need to configure a Scope Definition by configuring Scope Rules [➙ 234]
and/or configuring Scope Exceptions [➙ 237].
Finally, you save the Scope Definition [➙ 238].
The Scope Definition thus configured and saved appears under the Scopes root node
or the configured folder under the Scopes root node.
To apply the Scope Definition, you need to drag-and-drop it onto the following:
 Applications where a group of objects needs to be configured
 User or management station groups to allow a user to view only the system objects
that were configured in the Scope Definition

8.3 Scopes Workspace

Scopes contains the following main sections:
 Scopes Toolbar [➙ 228]
 Scope Rules [➙ 229]
 Scope Exceptions [➙ 231]

8.3.1 Scopes Toolbar

The Scopes toolbar contains the following icons:

Scopes Toolbar
Icon Name Allows you to...
New Open a submenu where you can choose to: Create a New Scope
Definition and Create New Scope Folder.
Create a New Create a new Scope Definition.
Scope
Definition
Create New Create a new scope folder.
Scope Folder
Save Save the configuration of the currently selected Scope Definition or
save a newly created and configured Scope Definition.
NOTE: This command is dimmed until you modify the current
Scope Definition.
Save As Save a copy of the currently selected Scope Definition or create a
new Scope Definition based on the current selection.
Delete the Remove the current Scope Definition or scope folder and delete its
Current Object entire configuration from the System Browser tree.
NOTE: Deletion of the Scopes root folder is not allowed.
Remove All Remove all invalid (indicated by red) entries at once.
Invalid Entries

228
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
Scopes Workspace
8

8.3.2 Scope Rules

You create a scope rule using hierarchical nodes and their subtrees in Views
(Management/Application/Logical/Physical/User-defined).
You can define a Scope Rule by means of Scope Rule Include node(s) and/or Scope
Rule Exclude node(s). Scope Rule Exclude nodes can only be children of Scope Rule
Include node(s), (Scope Rule Exclude nodes are a subtree of a Scope Rule Include
node). A scope rule can only add more objects to a scope. It cannot remove objects
from a scope that were added by another rule of the scope definition.
Scope rules allow you to configure [➙ 234] Scope Rule Include and its Exclude
node(s) in a Scope Definition.
From the Management View in System Browser, when you select Scopes, from the
Scopes tab you can configure scope rules as follows:

Scope Rules Section

Scope Rules Section Fields

Item Description
Scopes1) Indicates the full path of the node (system object) dragged-and-dropped.
Scope Rule Specifies inclusion of a node and its entire subtree in a Scope Rule.
Include
Scope Rule Specifies exclusion of specific nodes and their subtrees from the Scope Rule
Exclude2) Include node.
Add Include Adds an empty Scope Rule Include row.
NOTE: The empty Scope Rule Include rows are discarded while creating a
copy [➙ 239] (Save As) or saving [➙ 238] a Scope Definition.
Add Exclude Adds an empty Scope Rule Exclude row as a child of the selected Scope Rule
Include row.
NOTE: The empty Scope Rule Exclude rows are discarded while creating a
copy [➙ 239] (Save As) or saving [➙ 238] a Scope Definition.
Remove Row Deletes the selected row.
NOTE: If the selected Include row has children (Exclude rows), they are also
deleted.

1) An asterisk (*) Indicates that the dragged-and-dropped node from System Browser is a subtree.
2) The Scope Rule Exclude node is always a child of a Scope Rule Include node.

229
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
8 Scopes Workspace

Behavior of a Dragged-and-Dropped Object onto Scope Rules

The following table shows the behavior of a dragged-and-dropped system object onto
Scope Rules.

Scope Rules
System Object is dropped into System Behavior
A blank space within Scope Rules Adds a new Include Row along with the
hierarchical path of the dropped system object.
An existing empty Scope Rule Include row Adds the hierarchical path of the system object
in the empty Scope Rule Include row.
An existing empty Scope Rule Exclude row Adds the hierarchical path of the system object
in the empty Scope Rule Exclude row.
A configured Scope Rule Include row A message displays and asks you what to do:
- Replace: Overwrites the current content of
the row.
- Add Include: Adds a new include row as a
sibling.
- Add Exclude: Adds a new exclude row as a
child. This option is available only when you
drop a child node from the subtree of the
existing Include row.
- Cancel Operation: Cancels the operation.
A configured Scope Rule Exclude row A message displays and asks you what to do:
- Replace: Overwrites the current content of
the row.
- Add Exclude: Adds a new exclude as a
sibling.
- Cancel Operation: Cancels the operation.

230
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
Scopes Workspace
8

8.3.3 Scope Exceptions

Scope Exceptions allow you to configure [➙ 237] Scope Exceptions Include and/or
Exclude node(s) in a Scope Definition. They have precedence over Scope Rules.
Scope Exceptions can add a single object to a scope, exclude a single object from a
scope, or exclude all objects referenced by a subtree from a scope.
You can create a Scope Exception by using hierarchical nodes and/or node subtrees in
views (Management/Application/Logical/Physical/User-defined). A Scope Exception is
defined by means of Include Exception node and/or Exclude Exception node.
You can define a Scope Exception for an object to be included in or a node/object
subtree to be excluded from a Scope Definition.
From the Management View in System Browser, when you select Scopes, from the
Scopes tab you can configure Scope Exceptions as follows:

Scope Exceptions Section

Scope Exceptions Section Fields

Item Description
Scopes1) Indicates the full path of the node (system object) dragged-and-dropped.
Scope Specifies inclusion of a node in a Scope Exception.
Exception
Include node
Scope Specifies exclusion of specific node or subtree in a Scope Exception.
Exception
Exclude node2)
Add Include Adds a scope Exception Include row.
Add Exclude Adds a Scope Exception Exclude row.
Remove Row Deletes the selected row.

1) An asterisk (*) Indicates that the dragged-and-dropped node from System Browser is a subtree.
2) A Scope Exclude Exception node can be a node or a subtree from a hierarchy of a selected view.

231
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
8 Scopes Workspace

Behavior of the Dragged-and Dropped-Object onto Scope Exceptions

The following table shows the behavior of a dragging-and-dropping a system object
onto the Scope Exceptions section.

Scope Exceptions
Place of Drop of a System Object System Behavior
Blank space within the Scope Exceptions A message displays and asks you what to do:
- Add Include: Adds an Include row (at the end
of existing Include/Exclude rows, if any) having
the hierarchical path only of the system object
dropped.
- Add Exclude:(Node only): Adds an Exclude
row at the end (at the end of existing
Include/Exclude rows, if any) having the
hierarchical path only of the system object
dragged-and-dropped.
- Add Exclude (Subtree): Adds an Exclude row
at the end (at the end of existing
Include/Exclude rows, if any) having the
hierarchical path of the entire subtree of the
node dragged-and-dropped.
- Cancel Operation: Cancels the operation.
An existing empty Scope Exception Include Adds the hierarchical path of the system object
row in the empty Scope Exception Include row.
An existing empty Scope Exception Exclude Adds the hierarchical path of the system object
row in the empty Scope Exception Exclude row.
A configured Scope Exception Include/Exclude A message displays and asks you what to do:
row - Replace: Overwrites the current content of
the row.
- Add Include: Adds an Include row on the top
of dropped Include/Exclude row having the
hierarchical path only of the system object
dragged-and-dropped.
- Add Exclude (Node Only): Adds an Exclude
row on the top of dropped Include/Exclude row
having the hierarchical path only of the system
object dragged-and-dropped.
- Add Exclude (Subtree): Adds an Exclude row
on the top of dropped Include/Exclude row
having the hierarchical path of the entire
subtree of the node dragged-and-dropped.
- Cancel Operation: Cancels the operation.

232
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
Configuring a Scope Definition
8

8.4 Configuring a Scope Definition

The following procedures describe how to configure a Scope Rule and/or a Scope
Exception in a Scope Definition.

NOTE:
To perform configuration tasks, check that System Manager is in Engineering mode
[➙ 23].

 Creating a New Scope Folder [➙ 233]

 Creating a New Scope Definition [➙ 234]
 Configuring a Scope Rule [➙ 234]
 Configuring a Scope Exception [➙ 237]
 Modifying a Scope Definition [➙ 238]
 Creating a New Scope Definition from an Existing One [➙ 239]
 Deleting a Scope Definition or a Scope Folder [➙ 240]

8.4.1 Creating a New Scope Folder

Organize Scope Definitions by creating one or more Scopes folders.
1. In System Browser, select Management View.
2. Select Project > System Settings.
3. Select the Scopes root folder in the System Browser tree.
 Scopes displays in the Primary pane.
4. In the Scopes toolbar, click New .
5. In the context menu that displays, click Create New Scope Folder .
 The Create New Object dialog box appears with the Child Type selected as
Scopes Folder.
6. Enter a name in Name field, and a description in the Description field.
NOTE 1: Flag allows you to display and modify the text for all languages
configured in the system.
NOTE 2: Entering a description is mandatory. Provide a unique folder name,
otherwise a message box displays asking you to provide this.

7. Click OK to confirm (or Cancel to abort).

 If confirmed, the new scope folder is saved and displays under the Scopes root
node in the System Browser tree.

233
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
8 Configuring a Scope Definition

8.4.2 Creating a New Scope Definition

Since you can’t move Scope Definitions into folders after creating them, you need to
create and organize your folders [➙ 233] first.
1. In System Browser, select Management View.
2. Select Project > System Settings.
3. Select the Scopes root node or any scope folder under the Scopes root node.
4. Click the Scopes tab, if not yet selected.
 Scopes displays in the Primary pane.
5. Configure the Scope Rules [➙ 234] or Scope Exceptions [➙ 237].

6. In the Scopes toolbar, click Save or Save As .

 A Save Object As dialog box displays.
7. In the Save Object As dialog box, do the following:
– Select the location (the Scopes root folder or a subfolder) where you want to
save the new Scope Definition.
– Enter a name in the Name field, and a description in the Description field.
– Click OK.
 A new Scope Definition appears under the selected scope folder in the System
Browser tree of the Management view.

NOTE:
If you try to exit the configuration without saving the changes, the unsaved data
message box displays.

8.4.3 Configuring a Scope Rule

1. In System Browser, select Management View.
2. Select Project > System Settings > Scopes.
3. Click the Scopes tab, if not yet selected.
 Scopes displays in the Primary pane.
4. Click Add Include [➙ 235] or Add Exclude [➙ 235] in the Scope Rules section.
NOTE: The very first row you add in Scope Rules is always an Include row. So, if
this is the very first time you are adding a row in the Scope Rules section, only the
Add Include button is enabled.
 An empty Include/Exclude row is added in Scope Rules.
NOTE: An Exclude row is always added as a child of an Include row in Scope
Rules.
5. Select a system object from the System Browser tree and drag-and-drop onto the
empty Scope Rule Include/Exclude row.
 A hierarchical path of the dragged-and-dropped system object is added to the
Scope Rule Include/Exclude row.

234
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
Configuring a Scope Definition
8

6. In the Scopes toolbar, click Save As [➙ 239] /Save [➙ 238] .

NOTE:
You can also configure a Scope Rule directly by adding a new Scope Rule Include
[➙ 236]/Exclude [➙ 236] row via drag and drop.

8.4.3.1 Adding an Empty Include Row in Scope Rules

1. In System Browser, select Management View.
2. Select Project > System Settings.
3. Select the Scopes root node.
4. Click the Scopes tab, if not yet selected.
 Scopes displays in the Primary pane.
5. Below the Scope Rules section, click Add Include.
NOTE: The very first row you add in Scope Rules (either by clicking the Add
Include button or by drag-and-drop [➙ 236]) is always an Include row.
 An empty Include row is added in the Scope Rules section.
NOTE: If no existing Include row is selected, the new empty Include row is added
as a sibling at the end of the existing rows.
If an existing Include row is selected, the new empty Include row is added before
the selected Include row.

8.4.3.2 Adding an Empty Exclude Row in Scope Rules

 At least one Include row is added in Scope Rules.
1. In System Browser, select Management View.
2. Select Project > System Settings.
3. Select the Scopes root node.
4. Click the Scopes tab, if not yet selected.
 Scopes displays in the Primary pane.
5. In Scopes, do one of the following:
– Select an Include row for which you want to add an Exclude row as a child.
NOTE: In Scope Rules, an Exclude row is always a child of an Include row.
– Select an existing Exclude row for which you want to add an Exclude row as a
sibling.
6. Below the Scope Rules section, click Add Exclude.
 An empty Exclude row is added based on your selection.
NOTE: When the existing Include row is selected, the new empty Exclude row is
added as a child at the end of all existing Exclude rows.
When an existing Include row is selected, the new empty Exclude row is added as
a sibling before the selected existing Exclude row.

235
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
8 Configuring a Scope Definition

8.4.3.3 Adding a New Scope Rule Include Row Using Drag-and-Drop

1. In System Browser, select Management View.
2. Select Project > System Settings > Scopes.
3. Select the Scopes root node.
4. Click the Scopes tab, if not yet selected.
 Scopes displays in the Primary pane.
5. Drag a system object from the System Browser tree and drop onto one of the
following:
– An empty Scope Rules row.
 A new Include row is added as a sibling at the end of all existing Include rows
in the Scope Rules section having the hierarchical path of the system object
dragged-and-dropped.
– An existing Scope Rule Include row.
– Then in the message box that displays, select Add Include.
 A new Include row is added as a sibling before the existing Include row(s)
having the hierarchical path of the system object dragged-and-dropped.

8.4.3.4 Adding a Scope Rule Exclude Row Using Drag-and-Drop

 At least one Include row is available in Scope Rules.
1. In System Browser, select Management View.
2. Select Project > System Settings > Scopes.
3. Select the Scopes root node.
4. Click the Scopes tab, if not yet selected.
 Scopes displays in the Primary pane.
5. Drag a system object from the System Browser tree and drop onto one of the
following:
– An existing Scope Rule Exclude row.
– An existing Scope Rule Include row having the dragged system object as one
of the children in the included subtree.
 A message appears and asks you what to do.
6. Select Add Exclude.
 A new Exclude row is added as a sibling of the Exclude row, onto which you
dropped the object, having the hierarchical path of the system object dragged-and-
dropped.

236
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
Configuring a Scope Definition
8

8.4.4 Configuring a Scope Exception

1. In System Browser, select Management View.
2. Select Project > System Settings > Scopes.
3. Click the Scopes tab, if not yet selected.
 Scopes displays in the Primary pane.
4. Click Add Include or Add Exclude [➙ 237] in the Scope Exceptions section.
 An empty Include/Exclude row is added in Scope Exceptions.
5. Select a system object from the System Browser tree and drag-and-drop onto an
empty Scope Exceptions Include/Exclude row.
 A hierarchical path of the dragged-and-dropped system object is added to the
dropped the Scope Exceptions Include/Exclude row.
6. In the Scopes toolbar, click Save As [➙ 239] /Save [➙ 238] .

NOTE:
You can also configure a Scope Exception directly by adding a new Scope Exception
Include/Exclude row via drag-and-drop [➙ 238].

8.4.4.1 Adding an Empty Include/Exclude Row in Scope Exceptions

1. In System Browser, select Management View.
2. Select Project > System Settings.
3. Select the Scopes root node.
4. Click the Scopes tab, if not yet selected.
 Scopes displays in the Primary pane.
5. Below the Scope Exceptions section, click Add Include or Add Exclude.
 An empty Include/Exclude row is added in the Scope Exceptions section.
NOTE: The newly added Include/Exclude row is added before an existing
Include/Exclude row in the Scope Exceptions section.

237
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
8 Configuring a Scope Definition

8.4.4.2 Adding a New Scope Exception Include/Exclude Row via

Drag-and-Drop
1. In System Browser, select Management View.
2. Select Project > System Settings > Scopes.
3. Click the Scopes tab, if not yet selected.
 Scopes displays in the Primary pane.
4. Drag a system object from the System Browser tree and drop onto one of the
following:
– The blank Scope Exceptions section.
– An existing Scope Exception Include row.
– An existing Scope Exception Exclude row.
 A message displays and asks what to do.
5. Select Add Include or Add Exclude (node only) or Add Exclude (subtree).
 In the Scope Exceptions section, a new Include row having the hierarchical path of
the system object is added if you selected Add Include, or a path only for the
selected object is added if you selected Add Exclude row (node only), or a path for
the entire subtree (indicated by *) is added, if you selected Add Exclude row
(subtree).

8.4.5 Modifying a Scope Definition

 A Scope Definition is available in System Browser.
1. In System Browser, select Management View.
2. Select Project > System Settings > Scopes.
3. Select the Scope Definition you want to modify.
 Scopes displays in the Primary pane.
4. To replace a row, do the following:
– Drag and drop a system object from the System Browser tree onto a row in
Scope Rules or Scope Exceptions that you want to replace.
 A message displays.
– Select Replace.
 The new row appears having the hierarchical path of the system object
dragged-and-dropped.
5. To remove a row, do the following:
– Select a row from the Scope Rules/Scope Exceptions section that you want to
delete.
– Click Remove Row.
 The selected row is deleted.
NOTE: By clicking Remove Row, you can also delete an invalid row (shown in
red) containing an unknown object.

238
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
Configuring a Scope Definition
8

6. To remove all invalid rows, do the following:

– From the Scopes toolbar, click Remove All Invalid Entries .

NOTE: Remove All Invalid Entries is enabled only when there is at least
one invalid entry in the selected Scope Definition.
 All the invalid entries are removed at once from the Scopes Rules/Exceptions
section of the selected Scope Definition.
7. In the Scopes toolbar, click Save .
 A confirmation message appears.
8. Click Yes.
 The configuration changes are saved in the selected Scope Definition.

NOTE:
You need to reboot the management stations (in Closed/Semi-open mode), if you
modify a Scope Rights configuration (for an existing/new Scope Definition) associated
with a User Group to enable these changes.

NOTE:
If you try to exit the configuration without saving the changes, the unsaved data
message box displays.

8.4.6 Creating a New Scope Definition from an Existing One

 At least one Scope Definition exits under the Scopes root node in the System
Browser tree and you want to make a copy of it, or you have edited an existing
Scope Definition and you want to save it as a new definition.
1. In System Browser, select Management View.
2. Select Project > System Settings > Scopes.
3. Select the Scope Definition.
4. Click the Scopes tab, if not yet selected.
 Scopes displays in the Primary pane.
5. (Optional) Make the necessary changes in the Scope Rules and/or Scope
Exceptions configuration.

6. In the Scopes toolbar, click Save As .

7. A Save Object As dialog box appears.

8. In the Save Object As dialog box, do the following:
– Select the location (Scopes root folder or a subfolder) where you want to save
the new Scope Definition.
– Enter a name in the Name field, and a description in the Description field.
NOTE 1: Flag allows you to display and modify the text for all languages

239
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Scopes
8 Configuring a Scope Definition

configured in the system.

NOTE 2: Entering the description is mandatory. Provide a unique Scope
Definition name, otherwise a message displays asking you to provide this.
– Click OK to confirm (or Cancel to abort).
– If confirmed, the new Scope Definition appears under the selected scopes
folder in the System Browser tree.

NOTE:
If you try to exit the configuration without saving the changes, the unsaved data
message box displays.

8.4.7 Deleting a Scope Definition or a Scope Folder

 At least one Scope Definition or a scope folder is available under the Scopes root
folder.
1. In System Browser, select Management View.
2. Select Project > System Settings > Scopes.
3. Select the Scope definition or scope folder you want to delete.
4. Click the Scopes tab, if not yet selected.
 Scopes displays in the Primary pane.
5. In the Scopes toolbar, click Delete the Current Object .
 A confirmation message appears.
6. Click Yes to confirm (or Cancel to abort) the operation.
 The selected Scope Definition or scope folder is removed from the System Browser
tree.

NOTE 1:
Deleting a scopes folder deletes all its children, if any.
NOTE 2:
You cannot delete the main Scopes root folder from the System Browser tree.

240
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Overview of Journaling
9

9 Journaling
The system uses Journaling to print events, including event-related information such
as changes of state, and user/system activities such as commands sent, system errors
that occurred, and so on. See Error Codes and their Meaning [➙ 400] for information
on error codes and their meaning in Journaling.
Exactly what is printed, when, and on which printer is configurable. The following
provides a description of Desigo CC Journaling configuration and the corresponding
configuration procedures.

9.1 Overview of Journaling

Whenever any of the following occurs, the details can be printed through Journaling:
 Generation of an event
 Action by user/system
 Change of Value (COV)/Change of State (COS) in the field
When the Journaling manager receives a notification that something has occurred
(Event, Action, COV/COS), it compares the incoming fields of information with any filter
criteria. If the filtering criteria are met, the information is routed to the designated
printer.
The system uses a template –the default, or the UL, or user-defined, or Template with
extended size for Event Occurrence Time, or Alias With Extended Occurance Time –
to format the print outputs of events and event-related system activity. You map this
template to a pre-defined server printer for Journaling (line or page).
The system can support multiple Journaling printer-template mappings and Journaling
Definitions.
You need to define the contents of the printed outputs, optionally setting up one or
more filters to narrow the scope of what is printed, and then associate the Journaling
Definition to a Journaling printer.
Journaling can print in following ways:
 Automatic (Default): On a line printer, Journaling printing starts automatically
whenever a qualified Journaling event is ready for printing and the printer
configured for the selected Journaling Definition is available for printing. In case of
a page printer, whenever the number of qualified events reaches the limit
configured in the template file, they are directed as a batch of qualified events for
printing.
 Manual: You can manually start Journaling printing, if a Journaling Definition is
configured for a page printer.
For supervision of Journaling printers, the Journaling manager depends on the System
Manager to provide the printer availability status.
In case of a page printer, while shutting down, the Journaling manager sends the
events present in the Journaling cache to the printer configured in the Journaling
Definition provided the printer is available. Events waiting for printing, in case of printer
unavailability, are lost.

NOTE:
Software printers are not supported by Journaling printing.

241
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Journaling Workflow

9.2 Journaling Workflow

The following describes the Journaling workflow in the Primary and Contextual panes.

Primary Pane
During an engineering session, in System Browser, create a server printer and
configure the server printer as a Journaling printer [➙ 63].
Next, in System Browser, map a Journaling template [➙ 254] to the configured printer
and save the printer-template mapping.
Then create a new Journaling Definition [➙ 257], and configure it by including filters
such as Events [➙ 260], Actions [➙ 261], and Values and States [➙ 261]).
Finally, configure the Journaling printer [➙ 257] to print the qualified Journaling events.

Contextual Pane – Extended Operation Tab

You can print on a page printer from the Extended Operation tab of the Contextual
pane.

9.3 Journaling Workspace

Journaling contains the following main tabs:
 Journaling Printers [➙ 242]
 Journaling Configurator [➙ 244]

9.3.1 Journaling Printers

Journaling Printers allows you to configure a Journaling printer for a Journaling
Definition. It comprises two areas: the printer-template mapping section and the toolbar
[➙ 244].

NOTE:
It is recommended that you configure dedicated Journaling printer(s). Journaling
printers cannot be shared with printers serving other functions like Reports, Event
List, and so on.

Printer-Template Mapping Section

In the Journaling Printers tab, when you select Management View in System Browser,
the printer-template mapping section allows you to map a Journaling template to a
Journaling printer.

242
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Journaling Workspace
9

PrinterTemplate Mapping

Printer-Template Mapping Section Fields

Item Description
Printer Displays the list of all the printers configured as Journaling printers at
Project > Management System > Servers > Main Server.
Template Displays the list of all the title attribute values of the
EventPrinterTemplate root tag for:
 Default Template file DefaultJournalingTemplate.xml located in:
[installation drive:]\[installation folder]\[project]\profiles.
 UL Template file JournalingTemplate_UL.xml located in the folder:
[installation drive:]\[installation
folder]\[project]\profiles\JournalingUserTemplates.
 User-defined template(s) files located in:
[installation drive:]\[installation
folder]\[project]\profiles\JournalingUserTemplates.
 Template with extended size for Event Occurrence Time file
OccurrenceTime_TwoInches_Template.xml located in the folder:
[installation drive:]\[installation
folder]\[project]\profiles\JournalingUserTemplates.
 Alias With Extended Occurance Time file
Alias_with_extended_Event_Occurance_Time.xml located in the
folder:
[installation drive:]\[installation
folder]\[project]\profiles\JournalingUserTemplates.
Add Adds a new printer-template mapping entry.
Remove Deletes the selected printer-template mapping entry.
Apply Updates the content changes for the Journaling template file.

243
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Journaling Workspace

NOTE 1:
If you don’t specify any template in the Template drop-down list, the system uses the
default template for printing.
NOTE 2:
To avoid duplicate template entries in the Template combo box, specify
- a unique value for the title attribute of the EventPrinterTemplate root tag in the
Journaling template (Default, UL, and User-defined) file and
- a unique file name for a template located in:
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.

9.3.1.1 Journaling Printers Toolbar

The Journaling Printers toolbar contains the following icons:

Journaling Printers Toolbar

Icon Name Description
New Journaling Create a new Journaling Definition [➙ 257].
Definition
Save Printer - Save a printer-template mapping entry.
Template Map

9.3.2 Journaling Configurator

When you select Management View in the System Browser, the Journaling
Configurator tab allows you to configure a Journaling Definition to print qualified
Journaling events. It comprises two areas: the Journaling Configurator section that
includes configuring a printer, filters, and the toolbar [➙ 245].

Journaling Definition Configuration Section

Journaling Configurator

A Journaling Definition is an area in JournalingConfigurator, where you can design the

contents of a Journaling object for printing qualified Journaling events. A Journaling
Definition is characterized by its name. You can create multiple Journaling Definitions.

244
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Journaling Workspace
9

On selecting a Journaling Definition in System Browser, the associated configuration is

displayed in Journaling Configurator.

General Settings
The General Settings expander allows you to edit the general data of a Journaling
Definition.

General Settings Fields

Field Description
Comment Add a description or note for the new Journaling Definition
configuration.
NOTE: The Flag icon allows you to display and modify the text for
all languages configured in the system.

Printer Select a printer for printing the selected Journaling Definition.

Filters
The Filters expander consists of three types of Journaling filters: Events [➙ 246],
Actions [➙ 247] and Values and States [➙ 248]. The filters allow you to configure a list
of criteria that a Journaling event must satisfy in order to qualify for printing.

9.3.2.1 Journaling Configurator Toolbar

Journaling Configurator toolbar contains the following icons:

Journaling Configurator Toolbar

Icon Name Description
New Journaling Create a new Journaling Definition. [➙ 257]
Definition
Save Save the Journaling Definition. [➙ 262]

Save As Create a new Journaling Definition [➙ 263] from an existing one.

Delete Remove the selected Journaling Definition [➙ 264].

245
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Journaling Workspace

9.3.2.2 Events Filter

The Events expander allows you to configure events filtering criteria for a Journaling
event.

Events Filter

Events Filter Fields

Field Description
Scope List of assigned Scope Definitions.
Operand = Only selected filter value
≠ All values except selected filter value
Category List of all available event categories.
Discipline List of all available disciplines.
Sub-discipline List of all available sub-disciplines.
Type List of available types.
Sub-type List of available subtypes.

NOTE 1:
You can indicate if each value (except Scope) is equal to or different from the
selected criteria.
NOTE 2:
Setting the Scope to All starts the Journaling printing, if the other trigger criteria are
satisfied, regardless of the scope configuration.
Setting the Scope to a value other than All (a specific scope) results in the Journaling
printing for the Events, Actions, COS/COV from the selected scope if they satisfy
other filter criteria.

246
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Journaling Workspace
9

9.3.2.3 Actions Filter

The Actions expander allows you to configure the actions filter criteria for a Journaling
event.

Actions Filter

Actions Filter Fields

Field Description
Scope List of assigned Scope Definitions.
Operand = Only selected filter value
≠ All values except selected filter value
Action List of all available system/user actions.
Discipline List of all available disciplines.
Sub-discipline List of all available sub-disciplines.
Type List of available types.
Sub-type List of available sub-types.

247
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Journaling Workspace

9.3.2.4 Values and States Filter

The Values and States expander allows you to configure the Values and States filter
criteria for a Journaling event.

Values and States Filter

Values and States Filter Fields

Field Description
Scope List of the assigned Scope Definitions.
Operand = Only selected filter value
≠ All values except selected filter value
Property List of all available properties. This displays the property name in the
format: <language specific name of the property [language independent
name of the property] >
NOTE: The object model property names are displayed in the logged-in
users’ language.
Discipline List of all available disciplines.
Sub-discipline List of all available sub-disciplines.
Type List of available types.
Sub-type List of available sub-types.

248
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Journaling Template Concepts
9

9.4 Journaling Template Concepts

The Journaling template provides the format for printing Journaling events in a
structured manner. You can either use the Default Template or the UL Template, or the
Template with extended size for Event Occurrence Time, or Alias With Extended
Occurance Time. Additionally, you can modify the Default Template and configure your
own template (user-defined) for printing Journaling events.

Default Template
 The Default Template is a file named DefaultJournalingTemplate.xml located at:
[installation drive:]\[installation folder]\[project]\profiles.
A file named JournalingTemplateSchema.xsd present in the same folder acts as
the schema for the construction of the Journaling templates.
 At every Journaling manager startup, the Default Template is checked for its
validity.
 The Default Template contains the following configurable printing components:
– The Name specified in the title attribute in the root tag. This displays in the
Template drop-down list of the Printer-Template mapping section of Journaling
Printers.
– Paper types, sizes in inches, and orientation [➙ 266]
– Page header
– Page footer
– Field definitions
– Event field sequence
– Column delimiter [➙ 273]
– Message (event) delimiter [➙ 273]
– Message limit (number of events to be printed batch on page printer) [➙ 273]
– Font name and size for event details printing (page printer only) [➙ 268]
– Font name and font size for header and footer (page printer only) [➙ 268]
– Width, alignment, of every printing field (page printer only) [➙ 273]
– Sequence of every printing field [➙ 273]
– Columns (event information) to be printed [➙ 273]
- Event Occurrence Time
- Current State
- Text Associated
- Transition Time
- Event Source
- Category
- Event Source Path
- Activity Error Message
– Language code for printer enumerated values
– Printing presentation style of object names of event source
– Printing presentation style for path of event source

UL Template
The UL Template is a file named JournalingTemplate_UL.xml located in the folder:
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
The UL Template has an optimized layout and contains the following four columns:
 Transition Time

249
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Journaling Template Concepts

 Current State
 Event Source
 Event Source Path
Due to fewer columns, as compared to the fields in the Default Template, and no
separator line, the event log printout is printed on two lines. Thus the UL Template
generates a faster printout due to the condensed template layout.

User-defined Template
 You can define your own template for printing the qualified Journaling events. You
should save user-defined templates at:
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
 User-defined templates must adhere to the rules specified in the
JournalingTemplateSchema.xsd present at:
[installation drive:]\[installation folder]\[project]\profiles.
 You can modify an existing user-defined template.
 The system uses the Default Template file for printing if a user-defined template
mapped to a Journaling printer is invalid.
 Each time you map a printer-template entry containing a user-defined template and
save it, the user-defined template file is checked for validity. If it contains any
schematic/syntactic XML errors, the respective error message is shown in the Log
viewer and the Default Template file is used for printing. There is no need to restart
the Journaling manager for the changes to take effect.

Template with extended size for Event Occurrence Time

 The Template with extended size for Event Occurrence Time is a file named
OccurrenceTime_TwoInches_Template.xml located in the folder
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
 By using this template, the width of the Event Occurrence Time column is
increased in the Journaling printout.

Alias With Extended Occurance Time

 The Alias With Extended Occurance Time is a file named
Alias_with_extended_Event_Occurance_Time.xml located in the folder
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
 By using this template, you can print the alias of an object in the Journaling
Printout. Alias is specified at the object level. However, when an event source is a
property, the alias associated with its object gets printed. So alias of an object is
applicable to all its properties.

NOTE:
To avoid unnecessary form feeds caused by the journaling printer/template, you must
do one of the following:
- In the printer’s default settings, set the page length for the tractor greater than or
equal to the height of the page type configured in the selected journaling template.
For example, if the paper type is set as A4 (height = 11.7 inches) in the selected
template, you must set the paper length of the tractor to greater than or equal to 11.7
inches.
- Change the paper type in the journaling template to a paper length less than the
page length for the tractor in the printer’s default settings. For example, if the height of
the paper is 11 inches, then you need to set the paper type having length less than or
equal to 11 inches.

250
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Journaling Printer Concepts
9

9.5 Journaling Printer Concepts

A Journaling printer is a server printer used for printing qualified Journaling events.
You can configure line and/or page Journaling printers.
It is recommended that you configure dedicated Journaling printer(s). That is,
Journaling printers should not be used for other types of printouts such as the Event
List, Reports, and so on.
The following guidelines apply to Journaling printers:
 You can map a Journaling template to multiple Journaling printers. However each
Journaling printer can be mapped to only one Journaling template.
 In a Journaling template for a page printer, you can configure the number of events
(NumberOfMessages) to be printed on a single page. The qualified events
accumulate in the event buffer queue until the Journaling cache reaches this
message limit. When the configured limit is reached, the events in the event buffer
queue are printed on the configured page printer.
 A separate event buffer queue known as Journaling cache is maintained for each
page printer. Events are directed to a printer only if the message limit as defined in
the corresponding Journaling template file is reached.
 If a configured page printer is not available, the qualified event is buffered in the
event buffer queue available for that printer.
– The buffer limit for each printer is defined in the EventBufferSize component of
the config file located at
[installation drive:]\[installation folder]\[project].
– When buffered events reach the configured limit, the most recent event enters
the queue and the oldest event is removed. The Log viewer shows the relevant
message for this change (loss of oldest event) and is also logged in the History
DB. This continues for all successive qualified events until the printer becomes
available.
 When a printer (that was unavailable) becomes available, all events in the event
buffer queue begin to print. If a configured page printer is available but events are
not printing, a message is logged in the History DB.
 You can print events in the Journaling buffer manually (for which a page printer has
been configured) from the Extended Operation tab of the Contextual pane.
 On a line printer, qualified events are printed one after the other, and the formatting
parameters specified in the Journaling template such as font name, font size and
so on are not applicable.
 You can print multiple lines of text for any field using a line printer.
 Date/time references in events are printed with respect to the time zone and the
regional settings set on the server machine.
 You can edit the printer associated with a Journaling Definition at runtime.
 You can only view a printer object and Scope Definition required in the Journaling
configuration when one or both of the following are true:
– You have a scope right for that object and/or
– The printer or Scope Definition is already present in the saved configuration.
 Journaling printer objects or Scope Definitions that become unavailable (for
example, if they are deleted) are indicated in red and are referred to as unknown
object.
Similarly, if any entry from the filter fields becomes unavailable, it is indicated in red
and is referred to as unknown entry.
NOTE: You cannot save a configuration containing unknown objects/entries.
 A Scope Definition can be used in the Journaling configuration only if they are
available in System Browser.

251
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 UL/ULC Compliance for Journaling Template and Line Printer

 You can print only in those languages that are supported by the journaling printer.
In order to print in a desired language using the line printer, you must ensure that
the line printer firmware supports the character set for the language in which you
want to print and the system locale should be set to the desired language. See
Line Printer does not Print a Desired Language [➙ 399] for details.
 In order to print umlaut characters using a line printer, you must select the
character table which supports these characters in the line printer's default
settings. For example, if you want to print umlaut characters, that are available in
the German language character set using the Epson LQ-2090 line printer, you
must select the ISO Latin 1 character table from the printer's default settings.

9.6 UL/ULC Compliance for Journaling Template and Line

Printer
UL 864/ULC S527-compliant fire systems must provide a journaling line printer that
meets the related performance requirements of printing 50 event-related registrations
in 90 seconds.
You must modify your printer’s default settings and select a pre-defined UL/ULC
journaling template to ensure the printer meets the UL 864/ULC S527 requirements.

NOTE:
The printer settings shown in the following specification sections refer to the line
printer model EPSON LQ-2090.

9.6.1 Journaling Template Specifications

The UL Template is a file named JournalingTemplate_UL.xml located at:
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
You should use the UL template along with the line printer settings to ensure the
required performance (50 Alarm-related events printed in 90 seconds). As the UL
template has a reduced number of fields as compared those in the Default template
and no separator line, the event log printout is condensed into two lines. Thus the UL
template generates a faster printout due to the condensed template layout.
The following table provides configurations specifications for a journaling UL Template:

Configuration Setting for a Journaling UL Template.

Program Feature Permitted in UL Possible Settings Settings Permitted in
864/ULC S527? UL 864/ULC S527
(Y/N)
Journaling Template Yes Instead of Settings, The Default Template
select one of the [➙ 249] contains many
following templates: columns while the UL
 Default Journaling Journaling Template
Template (standard contains an optimized
layout) layout with only four
columns:
 UL Journaling
Template (optimized  Transition Time
layout) Current State
Event Source
Event Source Path
 No separator line

252
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
UL/ULC Compliance for Journaling Template and Line Printer
9

9.6.2 Journaling Line Printer Specifications

To print the journaling data of 50 Alarm-related events in 90 seconds (for UL 864
requirements), you may need modify the default and control panel settings for the
configured journaling line printer (server printer). The line printer model EPSON LQ-
2090 was tested and the default settings and control panel settings were modified to
be UL 864 compliant as follows:

Journaling Line Printer Specifications.

<Program feature> Permitted in UL Possible Settings Settings Permitted in UL
864/ULC S527 ? (Y/N) 864/ULC S527
Line Printer Settings Yes Configurable settings: Default settings mode:
 Default settings mode  Page length for front
 Control panel tractor: 12 inch
 Page length for rear tractor:
12 inch
 Skip over perforation: Off
 Auto tear off: Off
 Auto line feed: On
 Print Direction: Bi–D
 Software: ESC/P 2
 0 slash: 0
 I/F mode: Auto
 Auto I/F wait time: 10
seconds
 Parallel I/F bidirectional
mode: On
 Packet mode: Auto
 Auto CR (IBM PPDS): Off
 A.G.M (IBM PPDS): Off
 Character table: PC 437
 International character set
for Italic table: Italic U.S.A.
 Font: Roman T
 Manual Feed wait time: 1.5
seconds
 Buzzer: On
 Roll paper: Off
 Low-noise mode: Off
Settings permitted in the line
printer’s control panel:
 Font select: HSD
 Pitch select: 10cpi

253
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Configuring a Journaling Printer-Template Map

CAUTION

Ensure that you have set the values for all available parameters for the line printer
model that you have configured for the journaling printer. Failing to do so may result
in the printer not satisfying the UL requirement.
To change your printer’s default settings, refer to the product-specific documentation.

9.7 Configuring a Journaling Printer-Template Map

Journaling Printer-Template configuration section allows you to map a Journaling
template to a Journaling printer.
You can use the Default Template, the UL Template, or create your own template
[➙ 265] (user-defined) for printing qualified Journaling events.
You can also configure journaling template parameters [➙ 265] by specifying the page
setup and printable column details.
See also
 Adding a new Server Printer [➙ 63]
 Configuring a Server Printer as the Journaling Printer [➙ 63]
 Mapping a Journaling Template to the Journaling Printer [➙ 254]
 Adding a New Printer-Template Entry [➙ 255]
 Modifying a Printer-Template Entry [➙ 255]
 Removing a Printer-Template Entry [➙ 256]

9.7.1 Mapping a Journaling Template to the Journaling Printer

 At least one server printer is configured as a Journaling printer at Management
Station > Management System > Servers > Main Server.
1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Click the Journaling Printers tab, if not yet selected.
 Journaling Printers displays in the Primary pane.
4. Select a printer from the Printer drop-down list.
NOTE: By default None (in red) is selected indicating you need to select a printer.
Only printers configured as journaling printers appear in this drop-down list.
5. (Optional) Select a template from the Template drop-down list.
NOTE: By default None is selected in the Template drop-down list. Specifying
None uses the Default Template for printing.

 The Save icon becomes available.

6. In the Journaling Printers toolbar, click the Save Printer-Template Map icon .
NOTE: Any change in the Printer or Template drop-down list enables the Save
Printer-Template Map icon .
 The Journaling template is mapped to the Journaling printer.

254
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Configuring a Journaling Printer-Template Map
9

NOTE 1:
Each Journaling printer can have only one dedicated journaling template. You cannot
assign more than one Journaling template to a Journaling printer. A message
displays and you cannot save the changes.
NOTE 2:
Assigning a Journaling template to a Journaling printer is not mandatory, but it is
recommended.
NOTE 3:
Selecting a printer in the Printer drop-down list is mandatory. If you try to save a
printer-template mapping without selecting a printer, a message appears and the
changes are not saved.

9.7.2 Adding a New Printer-Template Entry

 You are successfully logged into Desigo CC client and System Manager is in
Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Click the Journaling Printers tab, if not yet selected.
 Journaling Printers displays in the Primary pane.
4. In the printer-template mapping section, click Add.
 The new printer-template entry is added.
NOTE: By default, one printer-template entry is always present.

NOTE:
After you have added a new printer-template entry, you need to map a template to a
printer [➙ 254].

9.7.3 Modifying a Printer-Template Entry

 You have at least one printer-template mapping saved. The journaling template
used in this mapping is a created and saved by you at the path
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
 You have made changes in your (user-defined) template file.
1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Click the Journaling Printers tab, if not yet selected.
 Journaling Printers displays with the existing printer-template mapping(s).
4. Select the printer-template mapping to which you want to update the changes.
5. Click Apply.
 The changes are updated in the configured user-defined template.

255
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Configuring a Journaling Definition

NOTE 1:
You can edit the Default Template by opening it in any editor such as Notepad, Visual
Studio and so on, but it is not recommended.
NOTE 2:
You can create a new template from scratch ensuring that it adheres to the rules
given in the schema JournalingTemplateSchema.xsd.

9.7.4 Removing a Printer-Template Entry

 At least one printer template entry exists in the printer-template mapping section of
Journaling Printers.
1. From the System Browser views drop-down list, select Management View.
2. Select Project > System Settings > Journaling.
3. Click the Journaling Printers tab, if not yet selected.
 Journaling Printers is displays in the Primary pane.
4. Select the printer-template entry you want to delete.
5. Click Remove.
NOTE: You can select multiple entries to delete using the SHIFT or CTRL key.
 A message box displays.
6. Click Yes to delete the selected entry(ies).
 The selected printer-template entry is deleted.

9.8 Configuring a Journaling Definition

A Journaling Definition allows you to configure filters, and a Journaling printer.

NOTE:
To perform configuration tasks, check that System Manager is in Engineering mode
[➙ 23].

 Creating a New Journaling Definition [➙ 257]

 Assigning a Journaling Printer to a Journaling Definition [➙ 257]
 Adding a New Journaling Filter Row [➙ 258]
 Configuring a Scope in a Journaling Filter [➙ 258]
 Modifying a Scope in a Journaling Filter [➙ 259]
 Resetting the Scope in a Journaling Filter [➙ 260]
 Configuring an Events Filter [➙ 260]
 Configuring an Actions Filter [➙ 261]
 Configuring a Values and States Filter [➙ 261]
 Removing a Journaling Filter Row [➙ 262]
 Modifying a Journaling Definition [➙ 262]
 Creating a New Journaling Definition from an Existing One [➙ 263]
 Deleting a Journaling Definition [➙ 264]

256
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Configuring a Journaling Definition
9

9.8.1 Creating a New Journaling Definition

1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Click the Journaling Printers tab, if not yet selected.
 Journaling Printers displays in the Primary pane.
4. In the Journaling Printers toolbar, click New Journaling Definition .
 A Create New Object dialog box appears with the Child Type configured as
Journaling Definition.
5. Enter a name in the Name field, and a description in the Description field.

– Click Flag to display and modify the text for all languages configured in the
system.
NOTE: Entering the description is mandatory. Provide a unique name,
otherwise a message box displays asking you to provide this.

6. Click OK to confirm (or Cancel to abort).

 If confirmed, the new Journaling Definition is saved and displays under the
Journaling root node in the System Browser tree.
NOTE: You have to create the very first Journaling Definition only from Journaling
Printers.

9.8.2 Assigning a Journaling Printer to a Journaling Definition

 You have created a journaling definition [➙ 257].
 You have mapped a journaling template to a journaling printer [➙ 254] in
Journaling Printers.
1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Select the Journaling Definition for which you want to assign a Journaling printer.
 Journaling Configurator and Object Configurator displays in the Primary pane.
4. Click the Journaling Configurator tab, if not yet selected.
 Journaling Configurator displays in the Primary pane.
5. From the Printer drop-down list, select a Journaling Printer.
6. (Optional) Add a comment in the comment field.
NOTE: This is a multilingual text area for providing details of the Journaling
Definition configuration.

7. In the Journaling Configurator toolbar, click the Save icon .

257
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Configuring a Journaling Definition

NOTE 1:
Only printers that are mapped with Journaling templates appear in the list of printers.
NOTE 2:
The printer defined for a Journaling Definition becomes invalid and the Printer drop-
down list shows Unknown Object when:
- the printer-template entry in Journaling Printers is deleted or
- the Journaling flag of a printer is changed to No.

NOTE 3:
You cannot save a Journaling Definition having Unknown Objects in the Printer drop-
down list.

9.8.3 Adding a New Journaling Filter Row

 You need to add a journaling filter row so you can set filter criteria.
1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Select the Journaling Definition to which you want to add a new filter row.
4. Click the Journaling Configurator tab, if not yet selected.
 Journaling Configurator displays in the Primary pane.
5. Select the Filters expander. Then, select one of the filter types: Events, Actions,
Values and States expander.
6. Click Add.
 A new filter row appears with all the filter criteria set to All (default value).
7. In the Journaling Configurator toolbar, select the Save icon .

9.8.4 Configuring a Scope in a Journaling Filter

 You have created a Journaling Definition [➙ 257] and want to configure a Scope
filter.
1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Select the Journaling Definition to which you want to add a new filter row.
4. Click the Journaling Configurator tab, if not yet selected.
 Journaling Configurator displays in the Primary pane.
5. Select the Filters expander. Then, select one of the filter types: Events, Actions,
Values and States expander.
6. Select Project > System Settings > Scopes.
7. Drag and drop a Scope Definition to a Scope placeholder or an existing scope of
one of the filter-types.
 If you dropped the Scope Definition to an empty Scope field, a new filter row
appears with all the filtering criteria set to All by default, except for the Scope

258
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Configuring a Journaling Definition
9

filter that has the filtering criteria set to the dragged and dropped Scope
Definition.
 If you dropped the Scope Definition to an existing Scope, a message box
displays and asks what to do. Select the option to Add a new filter row, to add a
new row. The new filter row appears with all the criteria set to All by default,
except for the Scope filter that has the filtering criteria set to the dragged and
dropped Scope Definition.
8. In the Journaling Configurator toolbar, click the Save icon .

NOTE:
Whenever you add a new filter row via drag and drop, the new filter row has the
Scope criteria set as the dragged and dropped Scope Definition. However, when you
add a new filter row by clicking the Add button, the new row has the Scope filtering
criteria set to All.

9.8.5 Modifying a Scope in a Journaling Filter

1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Select the Journaling Definition for which you want to modify a Scope.
4. Click the Journaling Configurator tab, if not yet selected.
 Journaling Configurator displays in the Primary pane.
5. Select the Filters expander. Then, select one of the filter types: Events, Actions,
Values and States expander.
6. Select Management Station > System Settings > Scopes.
7. Drag and drop a Scope Definition to an existing Scope of one of the filter-types.
 A message box displays and asks what to do.
8. Select the option Replace the existing scope.
 The new scope appears replacing the existing one in the selected filter row.
9. In the Journaling Configurator toolbar, click the Save icon .

NOTE:
If you try to exit the configuration without saving the changes, the unsaved data
message box displays.

259
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Configuring a Journaling Definition

9.8.6 Resetting the Scope in a Journaling Filter

 You configured a Scope [➙ 259] in a Journaling filter.
1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Select the Journaling Definition.
4. Click the Journaling Configurator tab, if not yet selected.
 Journaling Configurator displays in the Primary pane.
5. Select the Filters expander. Then, select one of the filter types: Events, Actions,
Values and States expander to locate the Scope you want to reset.
6. Right-click on the configured scope and select Set Scope to All.
 The Scope is reset to All.
7. In the Journaling Configurator toolbar, click the Save icon .

9.8.7 Configuring an Events Filter

 You have selected a Journaling Definition in System Browser and Journaling
Configurator displays in the Primary pane.
 You have added a new Journaling filter row [➙ 258] in the Events expander.
1. Select the Filters expander. Then open the Events expander and select the
appropriate value for the following criteria:
– Category
– Discipline
– Subdiscipline
– Type
– Subtype
NOTE: If you configure all the field values as All then every event meeting the
Events filter type is qualified for printing. Otherwise an event is qualified based
on the criteria that you have set in the filtering fields.
2. In the Journaling Configurator toolbar, click the Save icon .

NOTE 1:
You must indicate whether each value (except Scope) is equal to or not equal to the
selected criteria.
NOTE 2:
Setting the Scope to All starts the journaling printing, if the other trigger criteria are
satisfied, regardless of the scope configuration.
Setting the Scope to a value different from All (a specific scope) will result in the
journaling printing for the Events, Actions, COS/COV from the selected scope if they
satisfy other filter criteria.

260
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Configuring a Journaling Definition
9

9.8.8 Configuring an Actions Filter

1. You have selected a Journaling Definition in System Browser and Journaling
Configurator displays in the Primary pane.
2. You have added a new Journaling filter row [➙ 258] in the Actions expander.
3. Select the Filters expander. Then open the Actions expander and select the
appropriate value for the following criteria:
– Action
– Discipline
– Subdiscipline
– Type
– Subtype
NOTE: If you configure all the field values as All then every event meeting the
Actions filter type is qualified for printing. Otherwise an event is qualified based
on the criteria that you have set in the filtering fields.
4. In the Journaling Configurator toolbar, click the Save icon .

NOTE 1:
You must indicate whether each value (except Scope) is equal to or not equal to the
selected criteria.
NOTE 2:
Setting the Scope to All starts the journaling printing, if the other trigger criteria are
satisfied, regardless of the scope configuration.
Setting the Scope to a value different from All (a specific scope) will result in the
Journaling printing for the Events, Actions, COS/COV from the selected scope if they
satisfy other filter criteria.

9.8.9 Configuring a Values and States Filter

 You have selected a Journaling Definition in System Browser and the Journaling
Configurator is displayed in the Primary pane.
 You have added a new Journaling filter row [➙ 258] in the Values and States
expander.
1. Open the Values and States expander.
2. From the Property drop-down list, select Set Property.
NOTE: The default option is All.
3. To set a Property, do the following:
– Select an Object Model from the Set Property Dialog box.
NOTE: The default option is All.
– Select a Property from the list of Properties that appear for the selected Object
Model.
NOTE: The list of properties display according to the selected Object Model. If
All is selected in the Object Model drop-down list, then the properties for all the
object models are listed in the Properties drop-down list.
 The selected property is displayed in the Property drop-down list.

261
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Configuring a Journaling Definition

4. Select the appropriate value for the following criteria:

– Discipline
– Subdiscipline
– Type
– Subtype
NOTE: It is not recommended to configure all the field values as All, as every
event meeting the Values and States filter type is then qualified for printing,
increasing the number of printouts. Otherwise an event is qualified based on
the criteria that you have set in the filtering fields.
5. In the Journaling Configurator toolbar, click the Save icon .

NOTE 1:
You must indicate whether each value (except Scope) is equal to or not equal to the
selected criteria.
NOTE 2:
Setting the Scope to All starts the journaling printing, if the other trigger criteria are
satisfied, regardless of the scope configuration.

NOTE 3:
Setting the Scope to a value different from All (a specific scope) will result in the
Journaling printing for the Events, Actions, COV/COS from the selected scope if they
satisfy other filter criteria.

9.8.10 Removing a Journaling Filter Row

 At least one filter row is available in the selected filter of the Journaling Definition.
1. From the Filters expander, select the filter row that you want to remove.
2. Click Delete.
 A dialog box asks you to confirm when removing a filter row.
3. Click Yes to confirm.
 The selected filter row is removed from the list of available filter rows in the
selected filter.
4. In the Journaling Configurator toolbar, click the Save icon .

9.8.11 Modifying a Journaling Definition

1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Select the appropriate Journaling Definition.
4. Click the Journaling Configurator tab, if not yet selected.
 Journaling Configurator displays in the Primary pane.
5. Make the necessary changes in the selected Journaling Definition.

 The Save icon becomes available.

262
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Configuring a Journaling Definition
9

6. In the Journaling Configurator toolbar, click the Save icon .

NOTE: A message appears if you have not changed the default value for at least
one filter.

7. Click Yes to confirm.

 The configuration changes are saved in the selected Journaling Definition.

NOTE:
If you try to exit the configuration without saving the changes, the unsaved data
message box displays.

9.8.12 Creating a New Journaling Definition from an Existing One

 At least one Journaling Definition exists and you want to make a copy of it, or you
have edited an existing Journaling Definition and you want to save it as a new
definition.
1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Select the Journaling Definition.
4. Click the Journaling Configurator tab, if not yet selected.
 Journaling Configurator displays.
5. Click the Save As icon .
 The Save As dialog box displays.
6. Select the Journaling root folder.

7. For the Journaling Definition, enter a name in the Name field, and a description in
the Description field.
NOTE 1: The Flag icon allows you to display and modify the text for all
languages configured in the system.
NOTE 2: Entering the description is mandatory. Provide a unique Journaling
Definition name, otherwise a message box displays asking you to provide this.

8. Click OK to confirm (or Cancel to abort).

 If confirmed, a new Journaling Definition appears under the Journaling root folder
in the System Browser tree.

263
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Printing Journaling Events Manually

9.8.13 Deleting a Journaling Definition

 At least one Journaling Definition is available under the Journaling root folder.
1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Select the Journaling Definition that you want to delete.
4. Click the Journaling Configurator tab, if not yet selected.
 Journaling Configurator displays in the Primary pane.
5. In the Journaling Configurator toolbar, click the Delete icon .
 A confirmation message appears.
6. Click Yes.
 The selected Journaling Definition is deleted from the System Browser tree.

9.9 Printing Journaling Events Manually

 You have configured a page printer as a Journaling printer, mapped it to a
Journaling template, and then configured it in a Journaling Definition.
 Some buffered events ready for printing are available in the Journaling cache.
1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Select the Journaling Definition for which buffered events exists in the Journaling
cache.
4. If necessary, fully expand the Contextual pane > Extended Operation tab to the
right.
5. Click Flush.
 The events present in the Journaling cache are directed to the configured page
printer for printing.
NOTE: The Extended Operation tab displays a response to this command in the
form of a success or failure message.

9.10 Journaling Events Logged in the History DB

An entry is logged in the History DB when the following events occur:
 Creation, modification, or deletion of a Journaling printer configuration
 Buffer overflow
 Problem with the Journaling components
 Failure in subscription to the data points of Actions, Alarms, and/or COV during the
startup of the Journaling manager

264
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Creating a User-defined Journaling Template
9

9.11 Creating a User-defined Journaling Template

 A file named DefaultJournalingTemplate.xml is available in the folder [installation
drive:]\[installation folder]\[project]\profiles.
 The folder JournalingUserTemplates is available at the path
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
 To create a User-defined Template, do one of the following:
– Copy the Default Template and paste it into the folder
[installation drive:]\[installation
folder]\[project]\profiles\JournalingUserTemplates. Open and make the
necessary changes, rename, and save with a unique name in the
JournalingUserTemplates folder.
– Open the Default Template using an editor such as Notepad, Visual Studio, or
other and make the necessary changes, rename, and save with a unique name
in the JournalingUserTemplates folder.
– Using an editor such as Notepad or Visual Studio, create a new file adhering to
the schema JournalingTemplateSchema.xsd present in
[installation drive:]\[installation folder]\[project]\profiles. You can then save with
a unique name in the JournalingUserTemplates folder.
See also
Journaling Template Concepts [➙ 249] for the list of Journaling Template components
that you can modify.

9.12 Configuring a Journaling Template

This section provides instructions and examples to configure journaling template
parameters by specifying the page setup and printable column details.
For the default template, you need to configure the parameters in the
DefaultJournalingTemplate.xml file in the folder [installation drive:]\[installation
folder]\[project]\profiles.
For the UL template, you need to configure the parameters in the
JournalingTemplate_UL.xml file in the folder [installation drive:]\[installation
folder]\[project]\profiles\JournalingUserTemplates.

NOTE:
Each template that you configure is related to an individual project.

265
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Configuring a Journaling Template

9.12.1 Page Setup Parameters

You can configure page setup parameters such as paper types, size, margins,
orientation, fonts, headers and footers, and message delimiters. However you cannot
configure the alignment for headers and footers.

9.12.1.1 Configuring Paper Types

 Default Template: a file named DefaultJournalingTemplate.xml is available in the
folder [installation drive:]\[installation folder]\[project]\profiles.
 UL Template: a file named JournalingTemplate_UL.xml is available in the folder
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
1. Open the Default or UL template using an editor such as Notepad or Visual Studio.
2. Navigate to the <PaperDetails> section.
3. Enter the paper type within the <PaperType> tag. For example,
<PaperType>A4</PaperType>.
 The paper type is configured.

Paper Details

266
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Configuring a Journaling Template
9

9.12.1.2 Configuring Margins and Paper Orientation

 Default Template: a file named DefaultJournalingTemplate.xml is available in the
folder [installation drive:]\[installation folder]\[project]\profiles.
 UL Template: a file named JournalingTemplate_UL.xml is available in the folder
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
1. Open the Default or UL template using an editor such as Notepad or Visual Studio.
2. Navigate to the <PaperDetails> section.
3. Enter the values for top, bottom, left, and right margins within the <TopMargin>,
<BottomMargin>, <LeftMargin>, and <RightMargin> tags. In the following code
snippet, the top and bottom margins are set to 0.5 inches and left and right margins
to 0.25 inches.
4. Enter 0 for portrait or 1 for landscape within the <PaperOrientation> tag. For
example, <PaperOrientation>0</PaperOrientation>.

Margins and Orientation

267
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Configuring a Journaling Template

9.12.1.3 Configuring Fonts

You can specify the font name and size for the template as well as for the header and
footer sections.
 Default Template: a file named DefaultJournalingTemplate.xml is available in the
folder [installation drive:]\[installation folder]\[project]\profiles.
 UL Template: a file named JournalingTemplate_UL.xml is available in the folder
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
1. Open the Default or UL template using an editor such as Notepad or Visual Studio.
2. Navigate to the <PaperDetails> section.
3. To set the font name and size for the template: enter the font name and size within
the <FontName> and <FontSize> tags.
4. To set the font name and size for the header and footer: enter the font name and
size within the <HeaderFooterFontName> and <HeaderFooterFontSize> tags.
 The specified font is configured for the template as well as the header and footer
sections.

Fonts

NOTE: For printing Asian characters using a page printer, you must select TrueType
fonts which support Asian characters, for example, Arial Unicode MS.
You can also specify the format (bold, italics, or underline) of the printable text
according to the type of generated event (Alarm, Action, or COV) in the
<CategorySettings> tag. For example, if you want a bold font with no italics and
underline format for all Alarm type events, perform the following steps:
1. Open the Default or UL template using an editor such as Notepad or Visual Studio.
2. Navigate to the <Alarm> tag in the <CategorySettings> section.
3. In <FontAttributes>, specify 1 for the Bold attribute, and 0 for Italics and Underline
attributes.
 All events of type Alarm are printed with a bold format.

268
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Configuring a Journaling Template
9

Category Settings

9.12.1.4 Configuring Page Headers

You can configure page headers using the <PageHeader> tag.
 Default Template: a file named DefaultJournalingTemplate.xml is available in the
folder [installation drive:]\[installation folder]\[project]\profiles.
 UL Template: a file named JournalingTemplate_UL.xml is available in the folder
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
1. Open the Default or UL template using an editor such as Notepad or Visual Studio.
2. Navigate to the <PageHeader> section.
3. Enter a value for the top header margin within the <HeaderMargin> tag. This value
is in inches.
4. Specify the text to be displayed in the left header column by entering the value
within the <Text> tag in the <HeaderColumn_Left> tag.
5. Specify the formatting options (Bold, Italics, Underline) for the text by entering
either 0 (normal text) or 1 (formatted text) within the <Bold>, <Italics>, or
<Underline> tags in the <HeaderColumn_Left> tag.
6. Repeat Steps 2 through 5 to set the text and their corresponding formatting options
for the center and right header columns using the <HeaderColumn_Center> and
<HeaderColumn_Right> tags respectively.

269
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Configuring a Journaling Template

Page Header

270
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Configuring a Journaling Template
9

9.12.1.5 Configuring Page Footers

You can configure the page footers using the <PageFooter> tag.
 Default Template: a file named DefaultJournalingTemplate.xml is available in the
folder [installation drive:]\[installation folder]\[project]\profiles.
 UL Template: a file named JournalingTemplate_UL.xml is available in the folder
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
1. Open the Default or UL template using an editor such as Notepad or Visual Studio.
2. Navigate to the <PageFooter> section.
3. Enter a value, in inches, for the footer margin within the <FooterMargin> tag.
4. Specify the text to be displayed in the left footer column by entering the value
within the <Text> tag in the <FooterColumn_Left> tag.
5. Specify the formatting options (Bold, Italics, Underline) for the text by entering
either 0 (normal text) or 1 (formatted text) within the <Bold>, <Italics>, or
<Underline> tags in the <FooterColumn_Left> tag.
6. Repeat Steps 2 through 5 to set the text and their corresponding formatting options
for the center and right footer columns using the <FooterColumn_Center> and
<FooterColumn_Right> tags respectively.

271
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Configuring a Journaling Template

Page Footer

272
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Configuring a Journaling Template
9

9.12.1.6 Customizing Messages

 Default Template: a file named DefaultJournalingTemplate.xml is available in the
folder [installation drive:]\[installation folder]\[project]\profiles.
 UL Template: a file named JournalingTemplate_UL.xml is available in the folder
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
1. Open the Default or UL template using an editor such as Notepad or Visual Studio.
2. Navigate to the <PaperDetails> section.
3. Enter the value for the total number of messages to print in the
<NumberOfMessages> tag. You can also specify the delimiters for separating the
columns and messages by entering the respective characters within the
<PropertyDelimiter> and <MessageDelimiter> tags.

Message Delimiters

9.12.1.7 Configuring Language Settings

You can specify the language in which you want to print the localized equivalent text
defined in the textgroups by entering the language id in the <LanguageId> tag. For
example, if you want the text to print in French, perform the following steps:
 Default Template: a file named DefaultJournalingTemplate.xml is available in the
folder [installation drive:]\[installation folder]\[project]\profiles.
 UL Template: a file named JournalingTemplate_UL.xml is available in the folder
[installation drive:]\[installation folder]\[project]\profiles\JournalingUserTemplates.
1. Open the Default or UL template using an editor such as Notepad or Visual Studio.
2. Navigate to the <LanguageId> tag and enter fr_CA.utf8 within the opening and
closing tags.

LanguageId

9.12.2 Printable Columns

You can configure each printable column using the <PrintColumn> tag in the
<ColumnsForPrinting> tag. Each attribute in <PrintColumn> enables you to provide
information such as the column name, content, index, alignment, and width.

273
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Configuring a Journaling Template

Print Column Example

In the preceding code snippet, Event Occurrence Time is the name of a printable
column and is represented by the <ColumnHeaderText> tag. The information to be
displayed is specified within the <AlarmColumnId>, <ActionColumnId>, or
<COVColumnId> tags.
The column index, alignment, and width are specified through the <ColumnIndex>,
<Alignment>, and <Width> tags respectively. The Event Occurrence Time column is
configured to have a column index value as 1 which indicates that this is the first
column, is left aligned, and is 1.5 inches wide.

History Field_Alarm Example

Depending on the type of event (Alarm, Action, or COV), the information corresponding
to the <LogDPEName> tag in the <HistoryField> tag displays. In the History
Field_Alarm example, if an event of type Alarm occurs, and you have specified 1001 in
<AlarmColumnId>, then the alertTime displays.

History Field_Action Example

274
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Configuring a Journaling Template
9

If an Action type event occurs, and you have specified 2007 in <ActionColumnId>, then
the SourceTime displays.

History Field_COV Example

If a COV type event occurs, and the value in <COVColumnId> is 3002, then the time at
which the change of value occurred displays.
You can also specify the format in which the object name and its source path are
printed by entering a value corresponding to the format within the
<ObjectNameColumnOption> and <ObjectPathColumnOption> tags. The following two
code snippets provide the formats for the object name and source path.

ObjectNameColumnOption Example

ObjectPathColumnOption Example

In the ObjectPathColumnOption example, the object source path prints along with the
Common Naming System (CNS) display name. If you enter 1 as the value, the object
source path prints along with the CNS name.
CNS defines how objects are displayed in System Browser. CNS Name is the name of
the object and CNS Display Name is the object description.
Depending on the type of event generated, the following information can be printed.

275
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
9 Configuring a Journaling Template

Fields for Event Types.

Alarm Action COV
Alert Time User Name Value
Alert Counter WorkStation Timestamp
Alert State SourceDpName Name of DP (SourceDP)
Alert Transition Time Action SourceDP Path
Alert Source DPE Message Alias
Alert Category Status
Alert EventId SourceTime
Alert Went Message LogType
Alert Mode Value
Alert Event Cause Message PreviousValue
Alert User SourceDpName2
Alert Value Action Source Path
Alert Event Message Action Source Path2
Alert Went Alias
Alert Gone
Alert Source Path
Alert Observer
Alert Observer Path
Alias

NOTE: If the journaling printout does not contain information from any of the fields that
are listed in the Fields for Event Types table, then you must explicitly add a
<PrintColumn> section for each of those fields. However, the information related to the
AlarmColumnId, ActionColumnId, and COVColumnId for such fields is present in the
template in the <HistoryFields> section.

276
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Journaling
Configuring a Journaling Template
9

9.12.3 Applying Configured Parameters

In order to apply the configured parameters of the default, UL, and user-defined
templates to journaling printouts, you need to perform the following activities:

Default Template
 You have made changes in the DefaultJournalingTemplate.xml file available in the
folder [installation drive:]\[installation folder]\[project]\profiles.
 Restart the journaling manager.
 The changes configured in the default template are reflected in the journaling
printouts.

UL and User-defined Templates

 You have made changes in the JournalingTemplate_UL.xml file available in the
folder [installation drive:]\[installation
folder]\[project]\profiles\JournalingUserTemplates or the user-defined template file
available in the folder [installation drive:]\[installation
folder]\[project]\profiles\JournalingUserTemplates.
1. In System Browser, select Management View.
2. Select Project > System Settings > Journaling.
3. Click the Journaling Printers tab, if not yet selected.
 Journaling Printers displays with the existing printer-template mapping(s).
4. Select the printer-template mapping to which you want to update the changes.
5. Click Apply.
 The changes configured in the UL or user-defined template are reflected in the
journaling printouts.

277
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Macros
10 Overview of Macros

10 Macros

10.1 Overview of Macros

Macros allow users to send a sequence of commands to specified devices with a
single action. A macro consists of a set of instructions, each with a configurable
scope/target, property and command, optionally filtered by object discipline/sub-
discipline, and type/sub-type.

System Macros
The system has some predefined special-purpose macros, which are located in
dedicated subfolders. The exact number of system macros is configuration-dependent.
System macros include:
 Backup Macros [➙ 279]
 Block Command Macros [➙ 280]

Macro Configuration
You configure macros in a guided environment where you define each instruction
individually, along with an optional delay before it is carried out.
Once you create a macro, it is automatically enabled and available for execution.
In Operating mode, the instructions of macros work much like any other command that
can be launched from any interface component such as the Operation/Extended
Operation tabs, graphics, and so on.
In the System Browser tree, you can create macro nodes under the Macros root folder.
Creating subfolders is highly recommended to organize the macro nodes.

Example of a Macro in System Browser

278
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Macros
Overview of Macros
10

10.1.1 Backup Macros

These special macros are predefined in the project, and located in a dedicated
subfolder in the Application View of System Browser (path: Applications > Logics >
Macros > Backups). These macros create backup copies of Desigo CC data. You can
use them in conjunction with scheduled tasks to make backups of both history and
online databases at pre-planned intervals.

279
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Macros
10 Macros Configuration Workspace

10.1.2 Block Command Macros

These are macros that broadcast fire alarm handling commands -- such as
acknowledge, reset, and silence/unsilence -- to multiple devices on a given network at
the same time. The Block command macros apply to a specific fire network -- such as
BACnet (SAFEDLINK) or XNET. The system creates them automatically for a network
when you enable block commands [➙ 183] for that network, and they generally do not
need to be manually configured. However, if you want to define global block command
macros (addressed to multiple fire networks) you may need to manually configure
them. For a detailed procedure on this activity, see Creating Global Block Command
Macros for Multiple Networks [➙ 285].

10.2 Macros Configuration Workspace

When you are in Engineering mode and select a macro object in System Browser, the
macros configuration workspace displays in the Macro tab of the Primary pane.
The Macro tab presents the macro instructions (one or more) with their details
organized into columns as follows:
 Scope/Target
 Property
 Command
 Discipline/Sub-discipline
 Type/Sub-type
 Initial Delay
You can rearrange the columns by dragging and dropping the headers to a different
position on the left or right.
Each instruction occupies one row. You can add new rows by dragging a new
scope/target node from System Browser. Clicking a row to select and highlight the
corresponding instruction.
You can change the order of the instructions with the Move Up and Move Down
buttons. Use the Delete button to delete the selected row.

280
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Macros
Macros Configuration Workspace
10

Macro Editing Tab in Engineering Mode

Macro Toolbar
Icon Name Description
Save the Changes Saves any changes.
This icon is not available when you select the Macros root
folder, and is dimmed when creating a new macro.
Save as Create a new macro.
The new macro is saved under the Macros root folder.
Delete Object Deletes the current object.
This icon is dimmed when selecting the Macros root folder.

Scope/Target
The scope (set of target objects) or single target object affected by the instruction. A
new row is automatically created when you drag an object (a scope or a target object)
from System Browser to the empty area below the last-configured row. You can also
modify this field by dragging a new object and dropping it onto an existing instruction
row, whose previous scope/target gets replaced. The target object of an instruction can
be another macro. Recursive loops are detected and not allowed.

Property
The property affected by the instruction. You select it from a drop-down list that
includes all the properties that have an associated command. The drop-down list will
also include Undefined if the Object Model has a command that was configured with an
Alias.

Command
The command you want the instruction to execute. You select it from a drop-down list
that generally includes just the command. However, if the property is Undefined, the
drop-down list will include all the commands that have an Alias. More specifically, it will
include only the commands configured as Generic Display in the Object Model.)
Some commands have a Value field where you can specify a parameter for the
command. Whether you can select or enter a value depends on the type of command.
Note that if the property is of GmsBitString type, the value you can enter can be
numeric only (either integer or real; please check in the Operation or Extended
Operation tab the number of bits allowed). Instead of a specific value, you can also
specify object properties in this field. Once you link an object or a property, this field
may be blank or contain a value, depending on the parameters compatibility:

281
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Macros
10 Configuring Macros

 The name of the object is automatically selected if the target and the value have
this parameter in common (for example, Description).
 If the name is not compatible, the default property of the object model is
automatically selected, if compatible.
 If the default property is not compatible, the first compatible property is selected.
 If no parameter is compatible, the field is blank.
If the selected target object was another macro, you can specify a command that
enables, disables, executes, or aborts that macro.

Discipline/Sub-discipline
You can filter the instruction scope by discipline/sub-discipline (for example,
Fire/Detection). The command will be applied to the object(s) within the scope/target
that match the specified discipline/sub-discipline.

Type/Sub-type
You can filter the instruction scope by type/sub-type (for example, Detector/Automatic).
The command will be applied to the object(s) within the scope/target that match the
specified type/subtype.

Initial Delay
You can specify a time delay (in seconds, 0 to 9999) before the command is executed.
Note that, during this delay, the macro can be aborted by a user command.

10.3 Configuring Macros

The following procedures describe how to configure macros.

Configuration Workflow
1. (Optional) Set up [➙ 282] the folder structure for storing macros.
2. Create [➙ 283] a new macro and save the configuration. Or start from an existing
configuration [➙ 284] to create a new macro.
3. Other actions:
– Adjust [➙ 284] the configuration of existing macros.
– Create global block command macros [➙ 285] for fire systems including
multiple networks.
– Delete [➙ 285] macros or folders.
To learn how to enable/disable or execute/abort a macro, see the relevant sections in
the User Guide A6V10376160.

10.3.1 Setting up the Macros Folders Structure

You can save all your macros directly in the main Macros folder. Alternatively, you can
create subfolders under the main Macros folder to better organize the macros.
 System Manager is in Engineering mode.
 You are authorized to configure macros.
 You want to add one or more subfolders under the main Macros folder.
1. In System Browser, select Application View.
2. Select Applications > Logics > Macros.

282
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Macros
Configuring Macros
10

 The Macro workspace [➙ 280] displays in the Primary pane.

3. In the Macro toolbar, click Add New and select New Macro Folder.

4. In the Create New Object dialog box, do the following:

a. Enter the Name and Description.
b. Click OK.
 The new macro folder appears in System Browser.
5. Repeat steps 3-4 for all the subfolders folder required.
6. To add a nested subfolder, select a [macro subfolder] under the main Macros
folder, and repeat steps 3-4.

10.3.2 Creating a Macro

You can create a new macro directly in the main Macros folder, or in one of the
subfolders under it. For how to create subfolders see Setting up the Macros Folders
Structure [➙ 282].
 System Manager is in Engineering mode.
 You are authorized to configure macros.
1. In System Browser, select Application View.
2. Select Applications > Logics.
3. Select the main Macros folder or a subfolder under it.
This is where the new macro will be stored.
 The Macro workspace [➙ 280] displays in the Primary pane. Here you can
define one or more rows corresponding to the sequence of instructions that will
be executed.
4. To add a new row, drop (link) a scope (set of objects) or a single object from
System Browser.
 The Scope/Target field is automatically set based on the linked objects. This
defines the target object(s) that will be affected by this instruction.
5. Select one of the Properties in the drop-down list. This defines the property of the
target object(s) that you want to control with this instruction.
6. Select one of the Commands in the drop-down list. This defines the command that
will be issued to the selected target property (for example, Change[Write], Reset,
or Disable).
If necessary, define any additional parameters for the selected command.
– If the command requires a Value, do one of the following:
- To specify a static (constant) value, enter it directly (for example, type in a
number) or select it (for example, from a drop-down list or date picker).
- To set the value equal to an object’s property, drag-and-drop (link) an object
onto the Value field from System Browser. If necessary, use the drop-down list
to select a different property from the one that was automatically selected.
Alternatively, you can link a specific property from the Operation tab, or link the
event source from Event List (or from the Event Detail bar).
7. If necessary, filter the target object(s) that will be affected by the instruction based
on:

283
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Macros
10 Configuring Macros

– Discipline/Sub-discipline
– Type/Sub-type
8. (Optional) Define the Initial Delay in seconds before the command is executed.
9. Repeat steps 3 to 7 to add more instructions (rows) to the macro.
10. To change the order of the instructions in the list, select a row and click the Move
Up or Move Down buttons. To delete an instruction, select its row and click Delete.
These same commands are also available in the right-click menu for each row.

11. To save the macro, in the Macro toolbar, click Save as .

12. In the Save Object As dialog box, do the following:

a. Select the location in the tree (under Applications > Logics> Macros).where you
want to save this macro
b. Type the Name and Description of the macro.
c. Click OK.
 The new macro appears in System Browser, and it is enabled by default (you can
enable/disable it from the Contextual pane).

10.3.3 Modifying a Macro

 System Manager is in Engineering mode.
 You are authorized to configure macros.
 You want to edit or change an existing macro.
1. In System Browser, select Application View.
2. Select Applications > Logics > Macros.
 The Macro workspace [➙ 280] displays in the Primary pane.
3. In System Browser, under the main Macros folder, or in a subfolder under it, select
the macro you want to modify.
4. To change the order of the instructions in the list, select a row and click the Move
Up or Move Down buttons. To delete an instruction, select its row and click Delete.
These same commands are also available in the right-click menu for each row.
5. To change an individual instruction, drag-and-drop the new scope/target onto the
existing row.
6. If necessary, do one or more of the following. See the creating a macro procedure
[➙ 283] for details on how to configure these fields:
– Modify the Property in the drop-down list.
– Modify the Command in the drop-down list. For the selected command, if
necessary, modify also any additional parameter.
– Modify the Discipline/Sub-discipline to restrict the targets within the scope.
– Modify the Type/Sub-type to restrict the targets within the scope.
– Modify the Initial Delay in seconds before executing the command.
7. Modify any other instructions (rows) you want to change in the same way.
8. In the Macro toolbar, do one of the following:

284
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Macros
Configuring Macros
10

– To save the configuration changes in the current macro, click Save .

– To save the configuration changes in a new macro, click Save As .

Then, in the Save Object As dialog box:
a. Select the location in the tree (under Applications > Logics> Macros) where
you want to save this macro.
b. Type the Name and Description of the macro.
c. Click OK.

10.3.4 Deleting Macros or Folders

This procedure describes how to remove macro folders or individual macros.
NOTICE! You cannot delete the main Macros folder.
 System Manager is in Engineering mode.
 You are authorized to configure macros.
1. In System Browser, select Application View.
2. Select Applications > Logics > Macros.
 The Macro workspace [➙ 280] displays in the Primary pane.
3. In System Browser, under the main Macros folder, or in a subfolder under it, select
the object you want to delete (subfolder or macro).

4. In the Macro toolbar, click Delete .

 A confirmation message box asks if you want to delete the selected item.
5. Click Yes to confirm the operation (or No to abort).
 The object is removed from System Browser.

CAUTION

Be careful not to delete system macros related to functions such as Backup or Block
Commands.

10.3.5 Creating Global Block Command Macros for Multiple

Networks
The following procedure applies when configuring a system with multiple fire protection
networks that you want to control with global bock commands. The networks in
question must have block commands enabled [➙ 183] for at least one of the alarm-
handling commands: Acknowledge, Reset, Silence, Unsilence. For details on handling
block command macros on single network, see Block Command Macros [➙ 280].
 System Manager is in Engineering mode.
 You are authorized to configure macros.
1. In System Browser, select Application View.
2. Select Applications > Logics > Macros.

285
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Macros
10 Configuring Macros

 The Macros workspace [➙ 280] displays in the Primary pane.

3. In System Browser, select the main Macros folder or a subfolder under it (for
example, Block Command Macros). This is where the new block command macros
will be stored. For how to create a macro subfolder, see Setting up the Macros
Folders Structure [➙ 282].
4. In the Macro tab you can create a separate instruction (row) for each network that
you want to include. Each instruction will send the same block command (for
example, BLOCK_ACK), but to a different network:
a. in System Browser, select the Block Commands macro (for example,
BLOCK_ACK_BACnetNetwork_1).
b. Drag-and-drop the selection into the Macro tab.
c. Repeat this step for the other networks you want to add.

5. To save the configuration changes in a new macro, in the Macro toolbar, click Save
as .

6. In the Save Object As dialog box, do the following:

a. Select the location in the tree (under Applications > Logics> Macros).where you
want to save this macro
b. Type the Name of the macro, which must be one of the following:
- BLOCK_ACK, to create a global acknowledge macro.
- BLOCK_RESET, to create a global reset macro.
- BLOCK_SILENCE, to create a global silence macro.
- BLOCK_UNSILENCE, to create a global unsilence macro.
NOTE: The macro name you enter must exactly match one of these four options.
Otherwise the system will not recognize it as a valid global block macro, and will
instead execute the predefined macros applied to a single network.
c. Type the Description of the macro which can be the same as its Name or any
other customized text.
d. Click OK.
 If confirmed, the global block command macro is saved.
7. Repeat the entire procedure to create additional global block command macros for
the other alarm-handling commands (acknowledge, reset, silence, and unsilence).

NOTE:
The enable/disable block commands settings should be consistent across all the
networks involved, for example BACnet (FS20) and XNET.

286
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Reactions
Overview of Reactions
11

11 Reactions

11.1 Overview of Reactions

The system can be configured to automatically execute one or more commands when
certain conditions occur on the site. To do this, you define a set of input triggers and
associate them with an output macro (a set of instructions). When the specified trigger
conditions occur, the associated macro starts. The trigger-macro link is called reaction.
For example, in TBS architectures (TBS, or Total Building Solutions, combine danger
management with building automation), a reaction may be configured to control a fire
door or a ventilation system when a fire alarm occurs. To set up a reaction you define a
set of input triggers and a list of output instructions (similar to a macro [➙ 278]).

Input Triggers of a Reaction

As the input of the reaction, you can configure different types of triggers defining when,
in what circumstances, and for what combination of field conditions (events, or
changes in value/state) a reaction will execute:
 Time and Organization Mode [➙ 295]: defines a set of time-dependent
preconditions for the reaction (for example, only if it is a weekend, and the building
is unoccupied).
 Events [➙ 298]: defines the event or combination of events (for example, a fire
alarm in a critical area) that will trigger the reaction.
 Values and States [➙ 301]: defines the combination of field conditions (for
example, AnalogOutput in out-of-service state) that will trigger the reaction.
You can also configure the Boolean logic between the triggers:
 Time&Organization Mode AND Events AND Values & States: all three triggers
must asserted (true) for the reaction to start.
 Time&Organization Mode AND (Events OR Values&States): the
Time&Organization Mode trigger, and at least one of the other two triggers, must
be asserted (true) for the reaction to start.

Outputs of a Reaction
Output Action: As the output of the reaction, you configure a set of instructions (a
macro [➙ 278]) defining the sequence of commands you want to execute when the
reaction is triggered. You can include as many control actions as required in the list.
For each instruction, you can configure the scope/target object(s), property and
command, optionally filtered by object discipline/sub-discipline, and type/sub-type.
Note that you can also configure an instruction to invoke an external macro [➙ 278],
rather than directly executing a command.
Output Else Action: You can also optionally configure a set of instructions (a macro
[➙ 278]) defining the alternative sequence of commands (else actions) you want to
execute when the reaction is not triggered.
Since the system propagates property states up and commands down, you can also
select a point that includes other points, such as a geographical area or zone, as the
target of a trigger condition or macro instruction.

Configuring Reactions
You configure reactions in a guided environment where you define the individual
conditions that make up each input trigger, and the individual instructions that make up
its output macro. You can also optionally specify a delay before each instruction is
executed.

287
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Reactions
11 Overview of Reactions

Once you create a reaction, it is automatically enabled and available for execution.
In the System Browser tree, you can create reaction nodes in the Reactions folder.
You can also create subfolders to better organize the reaction nodes.

Reaction License and Access Rights

 Reactions are covered by license. Check that the required licenses are available in
the system, otherwise you may not be able to configure reactions. The basic
reactions license only lets you use Time and Organization Mode triggers. The
extended reactions license lets you use all three kinds of triggers. Depending on
what licenses are installed, one of the following situations may occur:
– There is no reactions license installed. You cannot configure or add reactions.
You can view the reactions already configured in the system but you cannot
edit them, and they will not function in Operating mode. Any reactions already
configured in the system are disabled and you cannot enable them.
– Only the basic reactions license is installed. If an existing reaction has only a
Time and Organization Modes trigger defined, you can view and delete the
reaction, edit its Time and Organization Mode trigger only, and enable/disable
the reaction. You can also add a new reaction but you can only configure its
Time and Organization Modes triggers. You can view the reactions already
configured in the system that have Events triggers and Values and States
triggers defined, but you cannot edit, delete, or enable/disable them.
– Both the basic and complementary reactions licenses are installed. You can
view, edit, delete, and enable/disable any reaction.
 Even when the license is installed, the availability of reactions depends on your
user group rights. If you don’t have appropriate application rights [➙ 111] you may
be able to view but not configure reactions, or you may not have access to this
feature at all.

288
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Reactions
Configuring the Reactions
11

11.2 Configuring the Reactions

The following procedures describe how to configure reactions.

Configuration Workflow
1. (Optional) Set up [➙ 290] the folder structure for storing reactions.
2. Create [➙ 290] a new reaction and save the configuration. or start from an existing
configuration [➙ 293] to create a new reaction.
3. Other actions:
– Adjust [➙ 293] the configuration of existing reactions.
– Delete [➙ 294] reactions or folders.
To learn how to enable/disable a reaction, see the relevant section in the User Guide
A6V10376160.

Technical Notes
 To be able to save a reaction, you must configure at least one input trigger and one
output instruction. Otherwise the system will not allow you to save.
 If you try to save a reaction whose configuration is invalid, a message box informs
you of what errors you need to correct, and where they are located. (For example,
in row 2 of the Values and States trigger).
 The reaction configuration is retroactive for unacknowledged alarms (that is, for
events whose status is Unprocessed). If you configure a reaction to be triggered by
a point that is already in alarm—and you have not yet acknowledged the event—
that reaction will be triggered as if the event had newly occurred. However the
reaction won’t be triggered retroactively by events that have already been
acknowledged. If you define a reaction to be triggered for a point that is already in
alarm—but you have already acknowledged that event—the reaction will not occur;
it will only be triggered if a new event of that type occurs in the system (only after
you configure the reaction). If a reaction only has Values and States triggers, its
configuration will always be retroactive.
 If the Desigo CC project is stopped, or if the reaction license(s) are lost for any
reason, the reaction will resume when the management system is restarted or
when the license(s) are re-installed.

289
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Reactions
11 Configuring the Reactions

11.2.1 Setting up the Reactions Folders Structure

You can save all your reactions directly in the main Reactions folder. Alternatively, you
can create subfolders under the main Reactions folder to better organize the reactions.
 System Manager is in Engineering mode.
 You want to add one or more subfolders under the main Reactions folder.
1. In System Browser, select Application View.
2. Select Applications > Logics > Reactions.
 The Reaction Editor workspace displays in the Primary pane.
3. In the Reaction Editor toolbar, click Add New and select New Reactions
Folder.

4. In the Create New Object dialog box, do the following:

a. Type the Name and Description.
b. Click OK.
 The new reaction folder appears in System Browser.
5. Repeat steps 3-4 for all the subfolders folder required.
6. To add a nested subfolder, select a [reaction subfolder] under the main Reactions
folder, and repeat steps 3-4.

11.2.2 Creating a New Reaction

You can create a new reaction directly in the main Reactions folder, or in one of the
subfolders under it. For how to create subfolders see Setting up the Reactions Folders
Structure [➙ 290].
To correctly create and enable a new reaction you must configure at least one Action
output instruction and one input trigger (Time and Organization Mode, Events, or
Values and States).
 System Manager is in Engineering mode.
1. In System Browser, select Application View.
2. Select Applications > Logics.
3. Select the main Reactions folder or a subfolder under it.
This is where the new reaction will be stored.
 The Reaction Editor workspace displays in the Primary pane.
4. Open the Output expander.
5. To configure the instruction(s) you want to execute when the reaction is triggered
(its combination of input triggers evaluates to true), open the Action expander. To
configure the instruction(s) you want to execute when the reaction is not triggered
(its combination of input triggers evaluates to false), open the Else Action
expander. (Configuring the Else Action is optional).
 The Action or Else Action expander opens. Here you can specify the output
instruction(s) you want to execute. Each instruction occupies one row. With
each instruction you can:

290
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Reactions
Configuring the Reactions
11

– Directly configure the command that you want to execute (on a specified
property of the selected scope/target objects).
– Invoke an existing macro already configured in the system, by linking a macro
from the Macros folder into the instruction row.
6. To add an instruction (row), drag-and-drop a scope (set of target objects) or a
single target object from System Browser. These are the objects to which you want
to send a command.
 The Scope/Target field is automatically set based on the linked object(s).
7. To remove an instruction, select its row and click Delete.
8. Configure each row (instruction) as follows:
a. Click on the row to select it.
b. In the Properties drop-down list, select which property of the selected target
object(s) you want to control. For example, High Limit or Time Delay. (The
available properties will depend on the target object(s) that you selected).
c. In the Command drop-down list, select the command you want to apply to the
selected property. For example, Change[Write]. (The available commands will
depend on the object property you selected).
d. Specify any parameters required by the selected command (such as the Value
to write, in the case of a Change command).
e. If necessary, filter which of the selected target object(s) will receive the
command based on:
- Discipline/Sub-discipline.
- Type/Sub-type.
9. If necessary, specify an Initial Delay in seconds before executing the command.
10. Repeat steps 5 and 7 for all the output instructions you want to configure.
11. To change the order of the instructions, select a row and click Move up or Move
down.
NOTE: Once you configure the output instructions, you have the option of also
saving them as a separate macro in the Macros folder. For details about this, see
Saving the Output as Separate Macro [➙ 292].
12. Open the Triggers expander, and from the drop-down list, select the appropriate
logical operator (AND or OR).
13. Specify the Time and Organization Mode trigger [➙ 297].
14. Specify the Events trigger [➙ 299].
15. Specify the Values and States trigger [➙ 302].
 NOTE: You must configure at least one trigger for the reaction to function. If
you don’t configure any triggers, you can still save the reaction but it will be
disabled.
16. (Optional) Open the General Settings expander, and enter your remarks in the
Notes field.

17. To save the reaction, in the Reaction Editor toolbar, click Save Object as .

18. In the Save Object As dialog box, do the following:

a. Select the location in the tree (under Applications > Logics> Reactions) where
you want to save this reaction.

291
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Reactions
11 Configuring the Reactions

b. Enter the Name and Description of the reaction.

c. Click OK.
19. The new reaction appears in System Browser, and it is enabled by default (you can
enable/disable it from the Contextual pane).

Technical Notes
 An error message displays if you try to save a reaction that doesn’t have at least
one output instruction configured in the Action expander.
 If the Command field of an instruction is empty (you didn’t select any command),
the instruction will be invalid and you won’t be able to save.
 If you try to save a reaction for which you did not configure any triggers, a warning
message informs you that the reaction can be saved, but will not be enabled.
– Click Yes if you want to save the reaction anyway (its Operational Status will be
Disabled for invalid configuration).
– Click No to go back and configure at least one trigger, so that the reaction can
be saved and enabled for execution.

11.2.2.1 Saving the Output as Separate Macro

 You have configured [➙ 290] a reaction and want to convert its output instructions
(Action or Else Action) into a separate macro.
1. In the Output expander, depending on which output instructions you want to
convert, open the Action or Else Action expander.
2. Depending on whether you are in the Action or Else Action expander, in the
Reaction Editor toolbar, do one of the following:

– Click Save "Action" output as a new Macro .

– Click Save "Else Action" as output Macro

3. When a message asks if you want to replace the output instructions with a new
macro, click one of the following:
– Yes. The current output instructions will be saved as a new macro in the
Macros folder. And the current output will be changed so that it contains just
one instruction, invoking this newly created macro.
– No. The current output instructions will be saved as a new macro in the Macros
folder. However, the current reaction output will not be changed (the list of
instructions will not be replaced by a call to the newly created macro).
4. In the Save Object As dialog box, do the following:
a. Select the location in the tree (Applications > Logics > Macros > [Macro]).
b. Enter the Name and Description for the new macro.
c. Click OK.
 The output instructions are converted into a macro and saved in the Macros folder.
For more details about setting up macros, see Configuring Macros [➙ 282].

292
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Reactions
Configuring the Reactions
11

11.2.3 Creating a Reaction from an Existing One

You can make a copy of a reaction by opening it and saving it with a different name.
Also, instead of configuring a reaction from scratch, you can start from an existing
reaction, make changes to it, and then save it as a new reaction.
 System Manager is in Engineering mode.
 At least one reaction is available in System Browser.
1. In System Browser, select Application View.
2. Select Applications > Logics > Reactions.
 The Reaction Editor workspace displays in the Primary pane.
3. In System Browser, under the main Reactions folder, or in a subfolder under it,
select the reaction you want to use.
4. If necessary, make changes to the reaction settings (input triggers and output
actions/else actions [➙ 290]).

5. To save the settings into a new reaction, In the Reaction Editor toolbar, click Save
Object as .

6. In the Save Object As dialog box, do the following:

a. Select the location in the tree (under Applications > Logics> Reactions).
b. Type the Name and Description of the reaction.
c. Click OK.
 The new reaction appears in System Browser, and it is enabled by default (you can
enable/disable it from the Contextual pane).

11.2.4 Modifying a Reaction

 System Manager is in Engineering mode.
 You want to edit or change an existing reaction.
1. In System Browser, select Application View.
2. Select Applications > Logics > Reactions.
 Reaction Editor workspace displays in the Primary pane.
3. In System Browser, under the main Reactions folder, or in a subfolder under it,
select the reaction you want to modify.
4. If necessary, do one or more of the following:
– Open the General Settings expander, and modify any remarks.
– Open the Triggers expander to modify the input triggers of the reaction. See
Creating a New Reaction [➙ 290] for details about how to configure the
triggers.
– Open the Output expander to make changes to the output instructions. See
Creating a New Reaction [➙ 290] for details about how to configure the outputs
of the reaction.
NOTE: You cannot directly modify the Scope/Target of a command. To do so,

293
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Reactions
11 Configuring the Reactions

delete the entire instruction row and drag-and-drop a new scope/target to

create a new instruction.
5. In the Reaction Editor toolbar, do one of the following:

– To save the configuration changes in the current reaction, click Save .

– To save the configuration changes in a new reaction, click Save As .

Then, in the Save Object As dialog box, do the following:
a. Select the location in the tree (under Applications > Logics> Reactions)
where you want to save this reaction.
b. Enter the Name and Description of the reaction.
c. Click OK.

11.2.5 Deleting Reactions or Folders

This procedure describes how to remove reaction folders or individual reactions.
NOTICE! You cannot delete the main Reactions folder.
 System Manager is in Engineering mode.
1. In System Browser, select Application View.
2. Select Applications > Logics > Reactions.
 The Reaction Editor workspace displays in the Primary pane.
3. In System Browser, under the main Reactions folder, or in a subfolder under it,
select the object you want to delete (subfolder or reaction).

4. In the Reaction Editor toolbar, click Delete object .

 A confirmation message box asks if you want to delete the selected item.
5. Click Yes to confirm the operation.
 The object is removed from System Browser.

294
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Triggers and Filters
Time and Organization Mode
12

12 Triggers and Filters

The management system uses triggers (in some cases called filters) to configure:
 When (Time and Organization Mode [➙ 295])
 For what kinds of alarms (Events [➙ 298])
 In what field situations (Values and States [➙ 301])
a certain action or function should happen.
For example, you can set up triggers to specify for what alarms a remote notification
should be sent out, or to specify when and for what alarms a certain guided procedure
(or individual procedure step) should be made available to the operator.
Triggers/filters are always configured as part of the set-up of some other function.
Specifically, you may need to set up triggers/filters when configuring the following:

Function Triggers/Filters that can be configured

Automated alarm handling [➙ 387] Time and Organization Mode,
Events
Journaling [➙ 244] Events,
Values and States
For more details on Journaling and the
configuration of its filters, see Journaling
[➙ 241].
Operating procedures [➙ 356] and procedure Time and Organization Mode,
steps [➙ 368] for Assisted Treatment Events
Remote notifications [➙ 344] Events
Reactions Time and Organization Mode,
Events,
Values and States

12.1 Time and Organization Mode

The Time and Organization Mode expander lets you specify one or more time-
dependent condition(s) [➙ 297]. Each condition occupies one row and at least one row
must be true (OR logic between rows) to assert the Time and Organization Mode
trigger/filter.

Time and Organization Mode Conditions

Use the Add button to add new rows. Click a row to select and highlight it. Click Delete
to remove the selected row.
Within each row, you define what criteria (From/To date, Time, Effective days,
Organization Mode) will make that row true.

295
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Triggers and Filters
12 Time and Organization Mode

All the criteria you specify on a row must be met for that row to be true (AND logic
between columns).

From date/To date

Lets you specify a date range by entering a start and end date. Selecting the Any
check box disables date selection. If you set:
 From date = Any: then any date before the specified To date is valid.
 To date = Any: then any date after the specified From date is valid.
 Both From date and To date = Any: then any date is valid.
A date is considered valid only if the weekday it falls on is also selected in Effective
days. (The system will not accept a row with From date later than To date.)

NOTE:
From date is automatically set to the current date in the following situations:
- When you select Monthly from the Recurrence drop-down list of Effective Days, and
then set any combination of values for this type of recurrence.
- When you select Weekly from the Recurrence drop-down list of Effective Days, and
then configure Every with a value greater than 1 (one week).

Time
To set a specific time of day, enter a value in Set Start Time and deselect Set End
Time.
To set a time range, enter values for both Set Start Time and Set End Time.
Select Begin of day to set the start time to 12:00:00 AM (midnight). (Set Start Time
selection becomes unavailable).
Select End of day to set the end time to 11:59:59 PM (one second to midnight).(Set
End Time selection becomes unavailable).
To make any time of day valid, select both Begin of day and End of day.

NOTE:
The way the time displays (24-hour clock or 12-hour clock) depends on the language
set for the user in the User Settings expander in the Users application.

Effective days
Here you can specify Weekly or Monthly recurrence patterns. Specifically, you can:
 Specify individual days of the week, the entire week (All), work week from Monday
to Friday (WW), or weekends (WE) Saturday and Sunday, and the recurrence of
this pattern (for example, once a week or every two weeks, and so on).
 Specify certain dates in the month (such as the first or the 14th day of the month)
and the recurrence of this pattern (for example, the first day of the month every 3
months, or the last Monday of the month every 6 months).
An error message displays in case of invalid configuration (days or months not
selected). (The system will not accept a row with no effective days).

Organization Mode
Organization Modes are labels that can be configured—or dynamically toggled by the
management system—to reflect the operational status or schedule of the building
control site.

296
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Triggers and Filters
Time and Organization Mode
12

You can use the different Organization Modes as the input triggers/filters for reactions
[➙ 287], automated alarm handling [➙ 384], or guided alarm handling [➙ 351]
procedures.
You can select from one of the following predefined Organization Modes:
 Day/Night
 Open/Closed
 On/Off
 Operational Status (in operation, in maintenance)
 Occupied/Unoccupied
You can also select multiple organization modes from the list (for example, Night and
Unoccupied). In this case they will be combined with an OR logic (only one of them
needs to be true, to make the Organization Mode column true).
If necessary, you can create new Organization Modes for specific needs or automate
Organization Modes. For details on the configuration of organization modes, see
Organization Modes [➙ 304].

12.1.1 Specifying Time and Organization Mode Conditions

In the Time and Organization Mode expander you can specify date ranges (From
date/To date), time intervals or specific times (Time), days of the week or month with
recurrence patterns (effective days), and any organization mode for the site (such as
Closed, Occupied, and so forth). This enables you to automate (trigger or filter) certain
functions based on when these time-related conditions occur. See Time and
Organization Mode [➙ 295] for more details.
 You want to configure the time and organization mode trigger/filter for one of the
following: automated handling of an alarm [➙ 388], an operating procedure
[➙ 372], an operating procedure step [➙ 370], or a reaction [➙ 289].
1. Open the Time and Organization Mode expander.
 In this expander, you can define one or more rows corresponding with the
time/organization mode trigger conditions.
2. Click Add to a add a new row.
To remove a row, select it and click Delete.
3. For each row, specify one or more of the following criteria (see Time and
Organization Mode [➙ 295] for more information about how to configure these
values):
– From date
– To date
– Time
– Effective days
– Organization Mode
4. In the toolbar, click Save .
NOTE: Depending on where you are configuring the Time and Organization Mode
expander (for example, for an operating procedure, for a reaction, and so forth),
you may have to configure other expanders before you can save.
When you save, a message box informs you if the Time and Organization Mode

297
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Triggers and Filters
12 Events

configuration is invalid (for example, Date from later than Date to or Start time later
than End time, or no option selected for Effective days).

12.2 Events
The Events expander lets you specify the trigger one or more event condition(s)
[➙ 299] related to alarms/events. Each condition occupies one row, and in some cases
a radio button lets you specify whether all of them (AND logic between rows) or only
one (OR logic between rows) must be true to assert the Events trigger/filter. If this
radio button is absent, there is always an OR logic between the rows (at least one row
must be true to assert the trigger/filter).

Events Conditions

Each row defines a condition. Within each row, you can define what criteria
(Scope/Target, Category, Discipline/Sub-discipline, Type/Sub-type, In/Out) an event
must match to make that condition true. All the criteria you specify on a row must be
met for that condition to be true (AND logic between columns).
To specify a condition, use the Add button to create a new row with an empty
Scope/Target field and the rest of the fields set to All. Or drag a scope/target node from
System Browser. Then define the other criteria the event must match (using the equals
and not equals operators) for that condition to be true.
Click a row to select and highlight it. Use the Delete button to remove the currently
selected row.

Scope/Target
The scope (set of target objects) or single target object affected by the event. A new
row is automatically created when you drag a scope or target object from System
Browser to the empty area below the last-configured row. You can also modify this field
by dragging-and-dropping a new object onto an existing row.
The row will be true for events affecting the specified scope/target object(s) that also
match any other criteria specified in the row.

Category
The category of the event (for example, Emergency or Fault). The available categories
are configuration-dependent. You can use the equals (=) or not equals (≠) operators to
specify whether you want to include or exclude that category. For example you can
specify Category = Emergency, or Category ≠ Fault.
The row will be true for events affecting the specified scope/target object(s) that also
match the specified category criterion.

298
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Triggers and Filters
Events
12

Discipline/Sub-discipline, and Type/Sub-type

You can further filter for events that either match (=) or do not match (≠) a
discipline/sub-discipline (for example, Fire/Detection). And for events that either match
(=) or do not match (≠) a type/sub-type (for example, Detector/Smoke).

In/Out

NOTE:
The In/Out setting is available only if prescribed by regulations.

In means the start of an event (the event source enters the off-normal state).
Out means the end of an event (the event source is back to normal).
When this setting is available, you can filter the events based on their In/Out value as
follows:
 In: only events where the source goes into the off-normal state (IN events display
in Event List)
 Out: only events where the source is back to normal (OUT events display in Event
List).
 In/Out: both In and Out events (IN and OUT events display in Event List, IN before
OUT, active before inactive).

12.2.1 Specifying Event Conditions

In the Events expander you can specify a set of conditions related to the alarms
(events) that occur in the system. This enables you to automate (trigger or filter) certain
functions based on the types of alarms that occur. See Events [➙ 298] for more
information.
 You want to configure the event conditions for one of the following: an automated
handling of an alarm [➙ 388], an operating procedure [➙ 372], an operating
procedure step [➙ 370], a reaction [➙ 289], or a remote notification [➙ 344].
1. Open the Events expander.
 In this expander, you can define one or more rows. Each row corresponds to a
separate event condition, and you can also set whether only one or all the rows
need to be true to assert the Events trigger/filter. If this radio button is absent,
there is always an OR logic between the rows (at least one row must be true to
assert the trigger/filter).
2. To add a new event condition (row), do one of the following:
– Click Add.
 A new row is created with an empty Scope/Target field and the rest of the fields
set to All.
– Drag-and-drop (link) one or more scope nodes or object nodes from System
Browser to the empty area underneath the last-configured row.
 A new row is created with the Scope/Target field automatically set based on
the linked object(s).
– NOTE: You can drag-and-drop a multiple selection from System Browser
provided all the selected objects belong to the same type (such as the same
Object Model; for example, they are all Binary Input).
3. To remove a row, select it and click Delete.
4. Click on a row to select it.

299
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Triggers and Filters
12 Events

5. To set or change the Scope/Target field of the row, drag-and drop (link) one or
more scope nodes or object nodes from System Browser.
 A popup menu displays where you can select one of the following:
– Add new elements: The linked object(s) are added to the Scope/Target field. If
the Scope/Target field was already populated, the new object(s) will be
appended to the existing ones.
– Replace Existing Filter: The linked object(s) will replace the existing ones in the
Scope/Target field.
– Add New Filter: Creates a new row with the linked object(s) added to the
Scope/Target field of the new row, and all the other fields set to All.
– Cancel Operation: Does nothing.
– NOTE: If the Scope/Target field contains multiple objects, you can click the
drop-down list to view them, and you can click the x next to an object to remove
it. You can also use the search box to filter the objects in the drop-down list.
Note that the search box does not accept wildcards.
You can clear a Scope/Target field by right-clicking on it and selecting Set
Scope to All in the popup menu.
6. If necessary, use the equals (=) or not equals (≠) operators to filter by:
– The Category of the event (for example, Emergency or Fault).
– The Discipline/Sub-discipline of the event.
– The Type/Sub-type of the event.
– If applicable, specify the In/Out value.
7. Repeat steps 4-7 for all the rows.
8. If you configured multiple conditions (rows), specify one of the following options (if
available):
– At least one row must be true (only one row needs to be true to assert the
Events trigger/filter).
– All rows must be true (all the specified rows must be true to assert the Events
trigger).
9. In the toolbar, click Save .
NOTE: Depending on where you are configuring the Events expander (for
example, for an operating procedure, for a reaction, and so forth), you may have to
configure other expanders before you can save.

300
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Triggers and Filters
Values and States
12

12.3 Values and States

The Values and States expander lets you specify one or more conditions related to
changes in state/value (Change of State/Change of Value condition(s) [➙ 302])
occurring in the building control site. Each condition occupies one row, and you can
specify whether all of them (AND logic between rows) or only one (OR logic between
rows) has to be true to assert the Values and States trigger.

Reactions-Triggers-Values and States

Within each condition (row), you specify a Target object and what Property of that
object you want to monitor. Then you specify what Value (or Value Range) of the
monitored property will make the condition true.
To specify a condition, use the Add button to create a new empty row, or link a target
node from System Browser (any point you link is labeled with its name and Object
Model). Click a row to select and highlight it. Use the Delete button to remove the
currently selected row.

Target
The target object that you want to monitor. A new row is automatically created when
you drag one or more objects from System Browser to the empty area beneath the
last-configured row. You can also modify this field by dragging a new object and
dropping it onto an existing row whose previous target gets replaced.

Property
The property of the target object whose value or state you want to monitor. You select
the property from a drop-down list that includes all those properties available for the
selected target object.

Value Range
The state(s), value, or range of values for the selected target property that will make
the condition (row) true. You can specify this directly, or by comparison with some
other object property:
 To specify it directly, select a relational operator (for example, =, <>, <=, ‘is in’ and
so forth) from the drop-down list of those available for the selected target property.
Then, depending on the type of property, you either directly enter a value (or pair of
values) or select a state (or pair of states) from a drop-down list. For example:
Analog Output 2 [Present Value] = 50°F, or Binary Input 1 [Event State] = Off
Normal.
 You can also compare the selected target property against a property of some
other object (or against another property of the same object). For example: Analog
Output 2 [Present Value] > Analog Input 1 [Present Value]. To do this, select a
relational operator as above. Then, instead of directly specifying a value or state
drag-and-drop a comparison object into the Value Range field, and select the
desired property of that object from the drop-down list. (You can also directly drag-
and-drop the comparison property from the Operation tab, or drag-and-drop an
event source from Event List or the Event Detail bar).

301
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Triggers and Filters
12 Values and States

NOTE: Whether the Value Range field is empty or displays a value depends on the
compatibility between the target and comparison objects. The name of the object is
automatically selected if the target and comparison objects have this in common
(for example, Description); if the name is not compatible, the default property of the
object model is automatically selected, if compatible; if the default property is not
compatible, the first compatible property is selected; if no property is compatible
the field is empty.

12.3.1 Specifying Values and States Conditions

In the Values and States expander you can specify a set of conditions related to
changes in state/value that occur in the system. Each condition (row) compares a
target object property either to static value(s)/states(s) or to another object property.
This enables you to automate (trigger) certain functions based on the types of
state/value conditions that occur. See Values and States [➙ 301] for more information.
 You are configuring a reaction [➙ 289] and you want to configure the values and
states conditions.
1. Open the Values and States expander.
 In this expander, you can configure one or more rows, each corresponding to a
separate condition for the values and states trigger. A row is true if the outcome
of its comparison is true.
2. To add a new row, do one of the following:
– Click the Add button.
 A new row is created with the Target field set to No targets selected, the
Property field set to No property selected, and the Value Range field empty.
– Drag-and-drop a target object from System Browser (or an object property from
the Operation tab, or an event source from Event List or the Event Detail bar)
into the empty area underneath the last-configured row.
 A new row is created with the Target and Property fields set based on the
linked object or property.
– NOTE: You can drag-and-drop a multiple selection from System Browser
provided all the selected objects belong to the same type (such as the same
Object Model; for example, they are all Binary Input).
You cannot link scope nodes to the Target field.
3. To remove a row select it and click Delete.
4. To configure a condition (row), select it.
5. Specify the target object that you want to monitor.
– Drag one or more target objects from System Browser and drop them into the
Target field.
 A popup menu displays where you can select one of the following:
– Add new elements: The linked object(s) are added to the Target field. If the
Target field was already populated, the new object(s) will be appended to the
existing ones.
– Replace Existing Filter: The linked object(s) will replace the existing ones in the
Target field.
– Add New Filter: Creates a new row with the linked object(s) added to the
Target field of the new row.

302
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Triggers and Filters
Values and States
12

– Cancel Operation: Does nothing.

– NOTE: If the Target field contains multiple objects, you can click the drop-down
list to view them, and you can click the x next to an object to remove it. You can
also use the search box to filter the objects in the drop-down list. Note that the
search box does not accept wildcards.
6. Specify the property of the target object that you want to monitor.
– In the Property drop-down list, select the property of the target object that you
want to compare.
(You can also directly drag-and-drop a property from the Operation tab, into the
Property field. This will directly set both the Target and Property fields.)
7. Select the relational operator.
– From the drop-down list to the right of the Property field, select the relational
operator (=, <>, is in, is out, <=, and so forth) that you want to use for the
comparison. (Use is in and is out to specify a range).
8. Specify what to compare the target object‘s property with. You can do this in the
following ways:
– To compare the target property with a static value/state: In the Value Range
fields, specify the value/state or range of values/states that will make the row
true. Depending on the target property, you may have to directly enter a value
(such as a number) or select it from a drop-down list.
– To dynamically compare the target property with another object property, drag
a comparison object from System Browser (or an event source from an event
descriptor) and drop it onto the Value Range field. Then, if necessary, select
the desired property of the object from the Value Range drop-down list.
(You can also directly drag-and-drop a property from the Operation tab into the
Value Range field.)
9. Repeat steps 4-8 above for each row.
10. If you configured multiple conditions (rows), specify one of the following options:
– At least one row must be true (only one row needs to be true to assert the
Values and States trigger/filter).
– All rows must be true (all the specified rows must be true to assert the Values
and States trigger).
11. In the toolbar, click Save .
NOTE: Depending on where you are configuring the Values and States expander
(such as, for a reaction), you may have to configure other expanders before you
can save.
If any field is in a row is empty (you haven’t selected a value), the configuration is
invalid and you won’t be able to save the reaction.

303
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Organization Modes
13 Values and States

13 Organization Modes
Organization Modes are system objects that can reflect the operational status or
schedule of the building control site. They are located in a dedicated folder under
System Settings in the Management View of System Browser.

The system comes with some predefined Organization Modes: Day and Night,
Occupancy Status (occupied/unoccupied), On and Off, Open and Close, Operational
Status (in operation, in maintenance).
You can also create [➙ 307] new ones, and modify [➙ 309] or delete [➙ 310] existing
Organization Modes.

Organization Modes are Used as Inputs for Automated Functions

You can use Organization Modes as inputs that trigger other functions of the
management system, such as, reactions [➙ 287], automated handling of alarms
[➙ 384], operating procedure [➙ 351], or graphic animations (refer to the Graphics
Editor (A6V10380503)).
For example, you might want a certain operating procedure (with evacuation
instructions) to start only when the building control site is Occupied. Or you might want
a certain automated reaction to be triggered only if the site is Open.

Organization Modes can be Set Manually or by Automated Logic

You can manually [➙ 305] set the value of Organization Modes from the Operation tab
of the Contextual pane. For example, you could select the Day and Night Organization
Mode in System Browser and then manually toggle its value between Day and Night.
More typically, however, you will configure an automated logic to set the values of
Organization Modes based on time (using the schedule functions [➙ 306]) or system
conditions (using the reaction functions [➙ 307]).

304
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Organization Modes
Manually Setting an Organization Mode
13

Workflow – Using Existing Organization Modes

 You want to use an existing organization mode as the input trigger for an
automated function (such as a reaction [➙ 287], operating procedure [➙ 351], or
automated handling of alarms [➙ 384]).
 Configure an automated logic that automatically sets (toggles) that Organization
Mode. Do one of the following.
– Define a management station schedule [➙ 306] that sets the Organization
Mode depending on the date and time.
– Configure a reaction that sets the Organization Mode as the output of a
reaction [➙ 307].
NOTE: You can also manually [➙ 305] set the Organization Mode at any time.

Workflow – Creating or Modifying Organization Modes

 You want to modify one of the existing Organization Modes (for example, to
change its name or labels), create an entirely new Organization Mode, or delete an
existing Organization Mode.
 To create a new Organization Mode, do one of the following:
– Create a new Organization Mode from scratch [➙ 307].
– Create a new Organization Mode by starting from an existing one [➙ 308].
 To modify an existing Organization Mode: Modifying an Organization Mode [➙ 309]
 To delete an existing Organization Mode: Deleting an Organization Mode [➙ 310]

13.1 Manually Setting an Organization Mode

You can manually change the value of an Organization Mode [➙ 304].
 You want to change the value of an existing Organization Mode. For example,
change the Day and Night Organization Mode from Day to Night.
1. In System Browser, select Management View.
2. Select Project > System Settings > Organization Modes.
3. Under Organization Modes, select the Organization Mode you want to modify (for
example, Day and Night).
 The Operation tab of the Contextual pane displays a specific label (for
example, Day) for the Value parameter.
4. From the drop-down list, select a different value (for example, Night). Then click
Set.
 The Value parameter is saved with the new setting.

Organization Mode Value

305
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Organization Modes
13 Scheduling an Organization Mode

13.2 Scheduling an Organization Mode

You can configure a repeating weekly schedule that automatically sets the value of an
Organization Mode [➙ 304] at preset times during each day of the week.
For more information, see the Scheduler section in the User Guide (A6V10376160 ).
 System Manager is in Engineering mode.
1. In System Browser, select Application View.
2. Select Applications > Schedules.
 The Schedule workspace displays in the Primary pane.
3. In the Schedule toolbar, click Add New , and select New Management Station
Schedule. This sets the new schedule to be stored under the Workstation
Schedules in System Browser.

4. To configure the schedule output, do the following:

a. In the Schedule workspace, click the Outputs tab.
b. Select Management View. The select Project > System Settings > Organization
Modes.
c. Drag-and-drop the desired Organization Mode (for example, Day and Night) onto
the Outputs area.
d. Click the Schedule Entries tab and, in the expanders under Output values, set
the Organization Mode values that correspond to Inactive and Active. For example,
Active=Day and Inactive=Night.
 Now you can configure a weekly schedule where you specify, for each day of
the week, what times of day correspond to Inactive, and what times of day
correspond to Active. (Initially, each day is set entirely to Inactive).
5. To configure the Active/Inactive times for a day of the week, do the following:
a. In the Schedule workspace, click the Schedule Entries tab.
b. In the weekly calendar view on the right, click inside the day you want to
configure (for example, Monday). Initially, the entire day is set to Inactive.
c. To create a schedule entry (time range) within the day, right-click inside the day
and select Add Weekly Entry. Drag the edges of the entry to adjust its start and
end times. Then, in the Schedule workspace, set whether you want this time range
to be Active or Inactive.
d. Repeat substep b. for all the time ranges you want to create inside this day.
6. Repeat Step 5 for each day of the week that you want to schedule.
 The schedule that you create in this way will repeat on a weekly basis. For
example, the time ranges you set for the Thursday will repeat every Thursday,
and so forth.
7. To customize the weekly repetition of the schedule, click the Setup tab. Here you
can specify a start date and/or an end date for the schedule.

8. In the Schedule toolbar, click Save .

9. In the Save Object As dialog box, enter the Name and Description. Then click OK.
 The new management station schedule object appears under Workstation
Schedules in System Browser. On each day of the week, it will automatically set
the Organization Mode based on the Active/Inactive times scheduled for that day.

306
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Organization Modes
Setting an Organization Mode as the Output of a Reaction
13

13.3 Setting an Organization Mode as the Output of a

Reaction
You can automatically set the value of an Organization Mode [➙ 304] as the output of
a reaction [➙ 287].
 System Manager is in Engineering mode.
1. In System Browser, select Application View.
2. Select Applications > Logics > Reactions.
 Reaction Editor workspace displays in the Primary pane.
3. Open the Triggers expander to set the input triggers of the reaction that will drive
the logic of the Organization Mode. See Creating a New Reaction [➙ 290] for
details about how to configure the triggers.
4. Open the Output expander to configure the output instructions:
– Drag-and-drop an Organization Mode from System Browser onto the
Scope/Target field of the Action and Else Action expanders and set the Value.
5. To save the reaction, in the Reaction Editor toolbar, click Save Object as .

6. In the Save Object As dialog box, do the following:

a. Select the location in the tree (under Applications > Logics> Reactions) where
you want to save this reaction.
b. Enter the Name and Description of the reaction.
c. Click OK.
 The new reaction appears in System Browser, and it is enabled by default (you can
enable/disable it from the Contextual pane).

13.4 Creating a New Organization Mode

To create a new Organization Mode [➙ 304] you first create the Organization Mode
object, then you create a custom text group in the libraries, and finally you set this text
group for the Organization Mode.
For details on libraries customization, see the relevant section in the Library
Management Guide (A6V10380499).
 System Manager is in Engineering mode.
 You are authorized to handle libraries for a specific customization level (Project,
Region, or Zone).
 At least one customized library is available for that level.
1. In System Browser, select Management View.
2. Select Project > System Settings > Organization Modes.
 The Object Configurator workspace displays in the Primary pane.
3. In the Object Configurator toolbar, click Add New , and select New
Organization Mode.

4. In the Create New Object dialog box, enter the Name and Description. Then click
OK.
 The new Organization Mode object appears in System Browser.

307
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Organization Modes
13 Creating an Organization Mode from an Existing One

5. Under Libraries, locate the customized library and select the Texts folder under it.
6. In the Primary pane, click the Text Group Editor tab.

7. Configure the text group entries as follows:

a. In the toolbar, click Add new row .
b. In the new row, add a Value and a descriptive text for en-US and any other
supported language.
c. Click OK.
8. In the toolbar, click Save .

9. In the Save Object As dialog box, enter the Object Name, Name, and Description.
Then click OK.
NOTE: It is important to follow specific syntax rules when saving a Text Group:
- The Object name and Name must have the following prefix: TxG_.
- The prefix can be followed by a label that indicates the Organization Mode type.
 The new text group object appears in System Browser.
10. Exit and restart the Desigo CC client application. In this way the new text group
becomes available in the Text group drop-down list in the Object Configurator.
11. In System Browser, select the Organization Mode object to configure.
 The Object Configurator workspace displays in the Primary pane.
12. In the Properties expander, select the Value property.
13. In the Details expander, from the Text group drop-down list, select the new text
group to use for the Organization Mode.

14. In the toolbar, click Save .

 The new Organization Mode is fully configured. You can now manually change
[➙ 305] its value from the Contextual pane or configure a schedule [➙ 306] or
reaction [➙ 307] that changes its value automatically.
This new Organization Mode is also available in the areas where it can be used as
an input (such as, in the Organization Mode drop-down list of the Time and
Organization Mode [➙ 295] trigger/filter).

13.5 Creating an Organization Mode from an Existing One

You can make a copy of an Organization Mode [➙ 304] by opening it and saving it with
a different name.
Also, instead of configuring a new Organization Mode from scratch, you can start from
an existing Organization Mode, make changes to it, and then save it as a new
Organization Mode.
 System Manager is in Engineering mode.
 At least one Organization Mode is available in System Browser.
1. In System Browser, select Management View.
2. Select Project > System Settings > Organization Modes.
3. Under Organization Modes, select the Organization Mode you want to use.
 The Object Configurator workspace displays in the Primary pane.

308
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Organization Modes
Modifying an Organization Mode
13

4. If necessary, make changes [➙ 309] to the Organization Mode settings.

5. To save the settings into a new Organization Mode, In the toolbar, click Save
Object as .

6. In the Save Object As dialog box, do the following:

a. Select the location in the tree (under Project > System Settings > Organization
Modes) where you want to save this Organization Mode.
b. Type the Name and Description of the Organization Mode.
c. Click OK.
 The new Organization Mode is fully configured. You can now manually change
[➙ 305] its value from the Contextual pane or configure a schedule [➙ 306] or
reaction [➙ 307] that changes its value automatically.
This new Organization Mode is also available in the areas where it can be used as
an input (such as, in the Organization Mode drop-down list of the Time and
Organization Mode [➙ 295] trigger/filter).

13.6 Modifying an Organization Mode

 System Manager is in Engineering mode.
 You want to edit or change an existing Organization Mode [➙ 304].
1. In System Browser, select Management View.
2. Select Project > System Settings > Organization Modes.
3. Under Organization Modes, select the Organization Mode you want to modify.
 The Object Configurator workspace displays in the Primary pane.
 In the Properties expander, select the Value property.
4. In the Details expander, from the Text group drop-down list, select a different text
group to use for the Organization Mode.
5. In the toolbar, do one of the following:

– To save the configuration changes in the current Organization Mode, click

Save .

– To save the configuration changes in a new Organization Mode, click Save As

.
Then, in the Save Object As dialog box, do the following:
a. Select the location in the tree (under Project > System Settings >
Organization Modes) where you want to save this Organization Mode.
b. Enter the Name and Description of the Organization Mode.
c. Click OK.

309
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Organization Modes
13 Deleting an Organization Mode

13.7 Deleting an Organization Mode

NOTICE! You cannot delete the Organization Modes folder.
 System Manager is in Engineering mode.
 You want to delete an Organization Mode [➙ 310].
1. In System Browser, select Management View.
2. Select Project > System Settings > Organization Modes.
3. Under Organization Modes, select the Organization Mode you want to delete.
 The Object Configurator workspace displays in the Primary pane.
4. In the toolbar, click Delete object .
 A confirmation message box asks if you want to delete the selected item.
5. Click Yes to confirm the operation.
 The object is removed from System Browser.

310
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Deleting an Organization Mode
14

14 Remote Notifications
The management system has the capability to manage remote notification (RENO)
messages—delivered, for example, using email, SMS or pagers—to one or more
groups of contacts (recipients).

“Alarm-Based” and “New” Remote Notifications

Remote notifications can be of two types:
 Alarm-based remote notifications: Messages preconfigured to be sent out by the
system when certain alarms occur in the building control site. You can create
multiple alarm-based notifications and assign a priority to them, so that if an event
occurs that triggers multiple remote notifications, the one with the highest priority
will run. You configure alarm-based notifications in the Primary pane, by selecting a
remote notification node in System Browser.
– Alarm-based notifications can only be set up in Engineering mode, and the
methods for doing this are described in this chapter.
 New remote notifications: Messages composed and sent on the initiative of the
operator. These operator-issued notifications are not tied to any triggering event,
and you can compose and send them from the Secondary pane, after selecting a
remote notification related-item (in the Related Items pane).
– New remote notifications can be composed in both Engineering and Operating
modes. For more information, see Editing, Sending, and Handling a New
Remote Notification section in the User Guide (A6V10376160).

First-Level Recipients of a Remote Notification

Remote notification messages can be addressed to one or more recipient groups (for
example, supervisors, operators, or system administrators), selected from the system
Address Book. A remote notification message addressed to a group will be sent out to
all the individual contacts who are members of that group.
You can view and configure individual recipients (contacts) and the recipient groups to
which they belong in the Address Book application.
For more information, see the Address Book section in the User Guide
(A6V10376160).

Escalation Recipients of a Remote Notification

Once a notification is sent, one or more individual recipients in the group can respond
to acknowledge the message. You can also define a set of escalation recipients for a
group, that specifies further contacts (individual people) to use in case sending to the
main group members fails (for example, because not enough people respond).

Methods of Sending a Remote Notification

The management system can send out remote notifications using email, SMS, or
alphanumeric or numeric pagers (provided the corresponding service/protocol has
been configured). When you set up a remote notification message, you can tailor it to
be sent by one or more of these methods—depending on what are the preferred and
fallback devices of the recipients.
For each recipient, the Address Book stores a list of the different devices (email
address(es), mobile phone number(s), pager number) that can be used to contact that
person. Among these, one is set as the preferred device, and another is (optionally) set
as the fallback device. For more information, see the Address Book section in the User
Guide (A6V10376160).

311
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Remote Notifications Configuration Workflow

Inability to Send a Notification Message

When the management system sends a remote notification message to an individual
recipient, it tries the person’s preferred device first, and if that fails it tries the fallback
device (if one is available). Note that the preferred and fallback devices can both use
the same service, (for example, preferred device = email address and fallback device =
another email address) or they can use different services (for example, preferred
device = and email address, and fallback device = an SMS number).
The management system may be unable to send the notification message if:
 The management system does not have the appropriate services configured and
enabled to communicate with that recipient. For example, the recipient has
preferred device=an email address and fallback device=a pager number, but the
management system only has the SMS service configured.
 A fault occurs in the service(s) that the management system needs to use to
communicate with that recipient. For example, if a recipient has preferred
device=an email address and fallback device=another email address, but the
management system is unable to connect to the mail server.

Outcome of a Remote Notification

When the management system succeeds in sending the notification message to an
individual recipient, then it may or may not expect a reply from that recipient. This
depends on how you configured the notification.
A remote notification is addressed to one or more recipient groups. For each recipient
group, you can:
 Optionally specify how many members of that group must respond for that group to
be considered successfully notified. If you leave this threshold value at zero the
system will not look for replies, and will consider the group successfully notified
provided all of the messages are successfully sent.
 Optionally specify some escalation recipients (additional individual contacts that the
system will try if not enough people in the first-level recipient group respond).

14.1 Remote Notifications Configuration Workflow

This section provides the high-level workflow for configuring remote notifications. See
Remote Notifications [➙ 311] for a general overview of how remote notifications work.

Configure Remote Notification Services (SMS, email, pager)

For the management system to be able to send remote notification messages and
receive responses, you must first configure one or more services (email, SMS, pager)
that the system can use to send and receive messages.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Do one or more of the following:
– Select Project > Management System > Servers > Main Server > Mail to
configure and test the email connection [➙ 319].
– Select Project > Management System > Servers > Main Server > SMS to
configure and test the SMS (text message) connection [➙ 326].
– Select Project > Management System > Servers > Main Server > Pager to
configure and test the pager connection [➙ 334].

312
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Remote Notifications Configuration Workflow
14

NOTE:
You can test the service connections by entering email addresses, phone numbers,
or pager numbers on the fly. However, when you later configure an actual remote
notification, you will need to have recipients configured in the system Address Book.

Configure Recipients and Groups in the Address Book

Remote notifications are addressed to sets of recipients selected from the system
Address Book. Therefore, before you can configure a remote notification, there must
be at least one valid recipient group in the Address Book.
 System Manager is in Operating mode or in Engineering mode.
1. In System Browser, select Application View.
2. Select Applications > Address Book.
 The Address Book workspace displays in the Primary pane. Here you can view
and edit the recipients and groups configured in the system. For each recipient,
you can also set the preferred and fallback devices (for example, email addresses,
SMS numbers, and so on) that the system will use to send remote notifications to
that person. For more information see the Address Book section the User Guide
(A6V10376160).

NOTE:
To successfully send a notification to a recipient, the system must have the
appropriate services (SMS, email, or pager) configured and enabled to match the
recipient’s device(s).

Configure an Alarm-Based Remote Notification

You can configure alarm-based remote notifications that will be sent out by the system
when certain alarms occur in the building control site.
 System Manager is in Engineering mode.
1. In System Browser, select Application View.
2. Do one of the following:
– To create a new remote notification, select Applications > Remote Notifications.
– To edit an existing remote notification, select Applications > Remote
Notifications > [remote notification node].
 The Reno Configurator tab displays in the Primary pane. This contains
expanders where you can view and configure:
– General Settings (these include the priority of the remote notification, a check
box for enabling or disabling it, and other settings that govern the behavior of
the notification)
– Recipients (the groups of recipients to whom the notification will be sent, plus
any escalation rules and additional escalation recipients)
– Message Tailoring (the content of the notification message itself, and the
services—email, SMS, pager—that will be used to send it)
– Triggers (what alarms will cause the system to send out the notification)

313
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Email Configuration Workspace

See Remote Notifications Workspace [➙ 338] for details about how to configure the
alarm-based remote notification.

Configure a New Remote Notification

You can also directly compose and send a remote notification that is not triggered by
any alarm.
 System Manager is in Engineering mode or in Operating mode.
 In the Related Items tab of the Contextual pane, select the New Remote
Notification link.
 The New Remote Notification workspace displays in the Secondary pane. Here
you can compose the message, select the method(s) you want to use to send it,
and select recipient groups (and escalation recipients) from the Address Book.
Then you can directly click the toolbar icon to send the notification message.

14.2 Email Configuration Workspace

To enable the management system to send remote notifications, and receive
responses, by email, you must configure the email service settings.
In the Management View of System Browser, select Project > Management System >
Servers > Main Server > Mail to display the RENO Configurator tab in the Primary
pane. Here, you can configure the email account and server settings that the system
will use for incoming and outgoing mail:
 Outgoing email server: Simple Mail Transfer Protocol (SMTP [➙ 315])
 Incoming email server: Post Office Protocol version 3 (POP3 [➙ 316]) or Internet
Message Access Protocol (IMAP [➙ 317])
These protocols support the following types of encryption connection to secure the
communication:
 Secure Sockets Layer (SSL) that uses a secure channel.
 Transport Layer Security (TLS) that uses an unsecured channel first and then
secures the communication.
The encryption protocol to configure depends on the capabilities of the email server.
To reduce the risk of server downtime, it is recommended to use an intranet email
server.

NOTE:
Contact the system administrator for information about incoming/outgoing email
server settings.

After configuring the protocols, you can also execute tests on the connection [➙ 318]
to the email service.

314
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Email Configuration Workspace
14

14.2.1 SMTP Protocol

The SMTP Protocol expander lets you configure the settings [➙ 319] of the mail server
(SMTP) for outgoing messages.

SMTP Protocol Fields

Item Description
Enabled Select this option to enable the email service using the SMTP protocol.
Domain name Enter the Client domain name at the server.
SMTP host name Enter the IP address of the mail server (SMTP) for outgoing messages.
You can get this information from your network administrator or Internet
Service Provider.
Security Type Security protocol when connecting to the SMTP server. Values can be
one of the following: None (unencrypted communication, clear text),
SSL, or TLS.
Port Connection port to the SMTP Server. Values can be 1 through 65335.
Sender name Enter the email address from which the emails will be sent.
This must be in a valid name format. For example,
[email protected].
Password If the email server requires authentication, enter the password for the
specified account. For security, the actual characters do not appear in
this space. Instead, each character is represented by an asterisk (*).
Confirm password Reenter the password to confirm it.
Notes Enter any additional information. For example, the account name to be
used for outgoing message. Uppercase and lowercase letters,
numbers, and spaces are allowed.

315
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Email Configuration Workspace

14.2.2 POP3 Protocol

The POP3 Protocol expander lets you configure the settings [➙ 320] of the mail server
(POP3) for incoming messages.

POP3 Protocol Fields

Item Description
Enabled Select this option to enable the email service using the POP3 protocol.
POP3 host name Enter the IP address of the mail server (POP3) for incoming messages.
You can get this information from your network administrator or Internet
Service Provider.
Security Type Security protocol when connecting to the POP3 server. Values can be
one of the following: None (unencrypted communication, clear text),
SSL, or TLS.
Port Connection port to the POP3 Server. Values can be 1 through 65335.
Recipient Enter the email account at POP3 Server.
Password If the email server requires authentication, enter the password for the
specified account. For security, the actual characters do not appear in
this space. Instead, each character is represented by an asterisk (*).
Confirm password Reenter the password to confirm it.
Notes Enter any additional information. For example, the account name to be
used for incoming message. Uppercase and lowercase letters,
numbers, and spaces are allowed.

316
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Email Configuration Workspace
14

14.2.3 IMAP Protocol

The IMAP Protocol expander lets you configure the settings [➙ 321] of the mail server
(IMAP) for incoming messages.

IMAP Protocol Fields

Item Description
Enabled Select this option to enable the email service using the IMAP protocol.
IMAP host name Enter the name (or IP address) of the mail server (IMAP) for incoming
messages. You can get this information from your network
administrator or Internet Service Provider.
Port Connection port to the IMAP Server. Values can be 1 through 65335.
Security Type Security protocol when connecting to the IMAP server. Values can be
one of the following: None (unencrypted communication, clear text),
SSL, or TLS.
Recipient Enter the email account at IMAP Server.
Password If the email server requires authentication, enter the password for the
specified account. For security, the actual characters do not appear in
this space. Instead, each character is represented by an asterisk (*).
Confirm password Reenter the password to confirm it.
Notes Enter any additional information. For example, the account name to be
used for incoming message. Uppercase and lowercase letters,
numbers, and spaces are allowed.

317
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Email Configuration Workspace

14.2.4 Test Email Connection

After you configure email, you can use the Test E-Mail Connection expander to test
[➙ 322] the outgoing email connection.

NOTE:
The incoming email connections are automatically and continuously checked by the
system’s diagnostics.

Test E-Mail Connection Fields

Item Description
Address Enter an email address or select one of the available email addresses.
Subject Enter the email subject.
This field is limited to 50 characters.
Message body Enter the email message.
This field is limited to 250 characters.
Send Send the email message.
Clear Clear all fields.
Sending result Once you have sent an email, this displays the outcome (OK, failed,
and so on).

318
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Configuring the Email Service
14

14.3 Configuring the Email Service

The following procedures describe how to configure the management system to send
and receive remote notifications by email.

Technical Notes
 Always make sure that all the necessary email protocols are enabled (Enabled
check box selected). If an email protocol is disabled (Enabled check box
deselected), the system will not alert you with any specific error message.
 If no incoming email protocol (POP3 or IMAP) is enabled, the system will be unable
to receive email responses from recipients. However, it may still be able to receive
responses via other services that have been configured (for example, the system
may send email with the SMTP protocol and receive replies to the GSM modem via
SMS).
 The management system’s diagnostics will automatically detect if there is a
problem communicating with the incoming email servers (POP3 or IMAP4), or if
one of those protocols is incorrectly configured, and generate an event to notify
you of the fact. On the other hand, to check the outgoing (SMTP) email connection
you must run the connection test.

14.3.1 Configuring the SMTP Protocol

 System Manager is in Engineering mode.
 The Mail object (email service) is available in System Browser.
 You want to configure the mail server service to use the SMTP [➙ 314] protocol for
outgoing messages.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server > Mail.
3. Click the RENO Configurator tab.
 The RENO Configurator workspace displays in the Primary pane.
4. Open the SMTP Protocol expander.
 The corresponding configuration workspace [➙ 315] displays.
5. Select Enabled.
NOTE: If you don't enable this protocol (that is, if you deselect the check box), the
management system will not be able to send remote notifications by email.
6. Specify the following settings:
– Domain name
– SMTP host name (SMTP server name as specified by the provider)
– Port
– Security Type
– Sender name (email address of the account)
– Notes (for example, email account name required to log into the SMTP server
of the provider).

319
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Configuring the Email Service

7. If the email server requires authentication, enter the email account Password
required to log into the SMTP server of the provider and Confirm password.
NOTE: Contact the network administrator for information about server
authentication.

8. In the RENO Configurator toolbar, click Save .

 The System Manager status bar indicates that the data was successfully saved.

14.3.2 Configuring the POP3 Protocol

 System Manager is in Engineering mode.
 The Mail object (email service) is available in System Browser.
 You want to configure the mail server service to use the POP3 [➙ 314] protocol for
incoming messages.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server > Mail.
3. Click the RENO Configurator tab.
 The RENO Configurator workspace displays in the Primary pane.
4. Open the POP3 Protocol expander.
5. The corresponding configuration workspace [➙ 316] displays.
6. Select Enabled.
NOTE: If you don't enable this protocol (check box deselected), the management
system will not be able to receive email from the mail server using this protocol.
This does not have any effect on dispatching messages, since this protocol is used
only for the incoming messages.
7. Specify the following settings:
– POP3 host name (POP3 server name as specified by the provider)
– Port
– Security Type
– Recipient (email address of the account used by the management system for
remote notifications)
– Notes (for example, email account name required to log into the POP3 server
of the provider)
8. If the email server requires authentication, enter the email account Password
required to log into the SMTP server of the provider and Confirm password.
NOTE: Contact the network administrator for information about server
authentication.

9. In the RENO Configurator toolbar, click Save .

 The System Manager status bar indicates that the data was successfully saved.

320
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Configuring the Email Service
14

14.3.3 Configuring the IMAP Protocol

 System Manager is in Engineering mode.
 The Mail object (email service) is available in System Browser.
 You want to configure the mail server service to use the IMAP [➙ 314] protocol for
incoming messages.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server > Mail.
3. Click the RENO Configurator tab.
 The RENO Configurator workspace displays in the Primary pane.
4. Open the IMAP Protocol expander.
 The corresponding configuration workspace [➙ 317] displays.
5. Select Enabled.
NOTE: If you don't enable this protocol (check box deselected), the management
system will not be able to receive email messages from the mail server using this
protocol. However, this does not have any effect on dispatching messages, since
this protocol is used only for the incoming messages.
6. Specify the following settings:
– IMAP host name (IMAP server name as specified by the provider)
– Port
– Security Type
– Recipient (email address of the account used by the management system for
remote notifications)
– Notes (for example, email account name required to log into the IMAP server of
the provider)
7. If the email server requires authentication, enter the Password and Confirm
password.
NOTE: Contact the system administrator for information about server
authentication.

8. In the RENO Configurator toolbar, click Save .

 The System Manager status bar indicates that the data was successfully saved.

321
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Configuring the Email Service

14.3.4 Testing the EMail Connection

 System Manager is in Engineering mode.
 You have already configured outgoing (SMTP [➙ 319]) and incoming (POP3
[➙ 320] or IMAP [➙ 321]) email protocols.
 The RENO Configurator workspace displays in the Primary pane.
1. Open the Test E-Mail Connection expander.
 The corresponding workspace [➙ 318] displays.
2. Select or enter a valid email Address.
3. Enter the Subject and Message body.
4. Click Send.
5. Check the outcome.
6. When the test is complete, click Clear.

Technical Notes
 A message box informs you if you didn’t enter all the data or if the email address is
invalid.
 You can send one test message at a time. When the outcome of sending one
message displays, the Send button becomes available again.

14.3.5 Deleting the Email Service

 System Manager is in Engineering mode.
 The project does not require the email service and you want to remove it.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server > Mail.
3. Click the RENO Configurator tab.
 The RENO Configurator workspace displays in the Primary pane.
4. In the RENO Configurator toolbar, click Delete .
 A confirmation message displays asking if you want to remove the selected
item.
5. Click Yes to confirm the operation.
 The object is removed from System Browser.
NOTE: If you have removed the Mail object, select Main Server > System
Management to add it back to the project.

322
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
SMS Configuration Workspace
14

14.4 SMS Configuration Workspace

SMS (Short Message Service) is the transmission of short text messages to and from a
device. Once a message is sent, a Short Message Service Center (SMSC) receives it.
The SMSC then forwards the message to the appropriate receiving device. SMS
messages don’t require the receiving device to be active and within range – messages
can be held for a number of days until the device is active/within range. SMS
messages can be sent to devices from Web sites, or from one device to another.
The management system can dispatch remote notifications as SMS text messages to
any device equipped to receive SMS messages.
In the Management View of System Browser, select Project > Management System >
Servers > Main Server > SMS) to display the RENO Configurator tab in the Primary
pane. Here, you can configure the SMS service handled by:
 GSM provider [➙ 324] (incoming and outgoing SMS)

NOTE:
Refer to the documentation for the GSM modem to set the parameters.

 Email-to-SMS provider [➙ 325] (outgoing SMS)

NOTE:
Contact the network administrator for information about email server settings.

After configuring the SMS provider, you can also execute tests on the connection
[➙ 325] to the SMS service.

323
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 SMS Configuration Workspace

14.4.1 SMS GSM Provider

The SMS GSM Provider expander lets you configure the settings [➙ 327] of the GSM
service provider for both incoming and outgoing SMS messages.

SMS GSM Provider Fields

Item Description
Enabled Select this option to enable the SMS service using the GSM provider.
SIM PIN code Enter the same number set as the PIN on the SIM card being used.
This field is limited to 8 digits.
Device attached to Select a COM port number (COM1, COM2, COM3, COM4, COM5,
COM COM6, COM7, COM8, COM9, COM10).
Bits per second Select a value (300, 600, 1200, 2400, 4800, 9600, 19200, 38400,
56700, 115200, 230400, 460800, 921600).
Data bits Select a value (5, 6, 7, 8).
Parity Select a value (Even, Odd, None, Mark, Space).
Stop bits Select a value (1, 1.5, 2).
Flow control Select a value (Hardware, Xon or Xoff, None). Default is Hardware.

324
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
SMS Configuration Workspace
14

14.4.2 SMS Email Provider

The SMS E-Mail Provider expander lets you configure the settings [➙ 328] of an
Email-to-SMS provider. The management system sends remote notifications to this
provider by email, and the provider in turn converts them into outgoing SMS
messages.

SMS E-Mail Provider Fields

Item Description
Enabled Select this option to enable the SMS service using the Email-to-SMS
provider.
Domain name Enter the domain of the service provider. The management system will
send the remote notification by email to this domain.
Subject prefix Enter the syntax used by the provider. This is typically a fixed string (for
example, “mittentesms” or “smssender”) that the provider requires in
the email subject line.

14.4.3 Test SMS Connection

After you configure an SMS provider (GSM, or Email-to-SMS), you can use the Test
SMS Connection expander to test [➙ 329] whether the system can send SMS
messages.

Test SMS Connection Fields

Item Description
Phone number Enter a phone number or select one of the available phone numbers. This
field is limited to 50 digits.
Message Enter the SMS message body. This field is limited to 160 characters.
Provider Displays one of the following values:
 None: GSM and Email-to-SMS providers are both disabled.
 GSM: only the GSM provider is enabled, or both the GSM and Email-to-
SMS providers are enabled.
 E-Mail: only the Email-to-SMS provider is enabled.
Send Send the SMS.
Clear Clear all fields.
Sending result Once you’ve sent the SMS, this displays the outcome (OK, failed, and so on).

325
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Configuring the SMS Service

14.5 Configuring the SMS Service

The following procedures describe how to configure the management system to send
and receive remote notifications by SMS.

Technical Notes
 If you want the management system to send out SMS notifications, check that at
least one SMS provider (GSM, or Email-to-SMS) is enabled (Enabled check box
selected). If no SMS provider is enabled (Enabled check box deselected), the
system will not alert you with any specific error message.
 If both the GSM and Email-to-SMS providers are properly configured and enabled,
the system will only try sending SMS notifications using the GSM modem. If this
fails, it will not try the Email-to-SMS provider, but will instead try sending the
notification to the recipients’ fallback device, if any.
 The management system’s diagnostics will automatically detect if there is a
problem with the GSM or Email-To-SMS protocol (such as, invalid configuration,
GSM modem disconnected, and so on), and generate an alarm to notify you of the
fact.
 Some special characters are not supported by GSM 7-bit basic character set of
protocol GSM 03.38. See the following table for reference.

Unsupported Character Transformed as

€ E
^ Λ
{ (
} )
[ (
] )
@ Ø
| !
~ -
\ /
Ξ X
ç Ç
° ¤

326
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Configuring the SMS Service
14

14.5.1 Configuring the SMS GSM Provider

 System Manager is in Engineering mode.
 The SMS object (SMS service) is available in System Browser.
 You want to configure the SMS service to use the GSM provider [➙ 324] for
incoming and outgoing messages.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server > SMS.
3. Click the RENO Configurator tab.
 The RENO Configurator workspace displays in the Primary pane.
4. Open the SMS GSM Provider expander.
 The corresponding configuration workspace [➙ 324] displays.
5. Select Enabled.
NOTE: If you don't enable this option (check box deselected), the management
system will not be able to send remote notifications or receive replies as SMS
messages using the GSM modem.
6. Refer to the documentation of the GSM modem to modify the default physical line
settings:
– Device attached to COM
– Data bits
– Stop bits
– Bits per second
– Parity
– Flow control
7. Enter the SIM PIN code.

8. In the RENO Configurator toolbar, click Save .

 The System Manager status bar indicates that the data was successfully saved.

327
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Configuring the SMS Service

14.5.2 Configuring the SMS E-Mail Provider

This setting enables the management system to send SMS remote notifications by
email to an Email-to-SMS provider, which in turn sends them out as SMS messages.
Before proceeding to configure the email-to-SMS provider, make sure you have
already configured the SMTP protocol [➙ 319] for the email service.
 System Manager is in Engineering mode.
 The SMS object (SMS service) is available in System Browser.
 You want to configure the SMS service to use the Email-to-SMS provider [➙ 323]
for outgoing messages.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server > SMS.
3. Click the RENO Configurator tab.
 The RENO Configurator workspace displays in the Primary pane.
4. Open the SMS E-Mail Provider expander.
 The corresponding configuration workspace [➙ 325] displays.
5. Select Enabled.
NOTE: If you don't enable this provider (check box deselected), the management
system will not be able to send remote notifications via the Email-to-SMS provider.
6. Specify the following settings:
– Domain name
– Subject prefix
7. In the RENO Configurator toolbar, click Save .
NOTE: While saving, a message box informs you if the domain name is missing or
invalid.
 The System Manager status bar indicates that the data was successfully saved.

Technical Notes
 If the provider supports concatenated SMS messages, the ACK code is included in
the first 160 characters (and not at the end of the message).

328
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Configuring the SMS Service
14

14.5.3 Testing the SMS Connection

 System Manager is in Engineering mode.
 You have already configured an SMS provider (GSM [➙ 327] or Email-to-SMS
[➙ 328]).
 The RENO Configurator workspace displays in the Primary Pane.
1. Open the Test SMS Connection expander.
 The corresponding workspace [➙ 325] displays.
2. Select or enter a valid Phone number.
3. Enter the Message.
4. Click Send.
5. Check the outcome.
6. When the test is complete, click Clear.

Technical Notes
 A message box informs you if you didn’t enter all the data or if the phone number is
invalid.
 You can send one test message at a time. When the outcome of sending one
message displays, the Send button becomes available again.

14.5.4 Deleting the SMS Service

 System Manager is in Engineering mode.
 The project does not require the SMS service and you want to remove it.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server > SMS.
3. Click the RENO Configurator tab.
 The RENO Configurator workspace displays in the Primary pane.
4. In the RENO Configurator toolbar, click Delete .
 A confirmation message displays asking if you want to remove the selected
item.
5. Click Yes to confirm the operation.
 The object is removed from System Browser.
NOTE: If you have removed the SMS object, select Main Server > System
Management to add it back to the project.

329
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Pager Configuration Workspace

14.6 Pager Configuration Workspace

A pager is a dedicated radio frequency device that allows the pager user to receive
messages broadcast on a specific frequency over a special network of radio-based
stations.
When Remote Notifications calls a pager, a paging terminal answers the incoming call.
To submit requests to a pager service as a numeric or alphanumeric message, remote
notifications use one of the following protocols:
 Telelocator Alphanumeric Protocol (TAP)
 European Selective Pager Association protocol (ESPA 4.4.4)
Messages can be as simple as few digits (in the case of numeric pagers) or as
complex as a text message that is a hundred characters long (in the case of
alphanumeric pagers). The paging terminal then queues the message, encodes it, and
passes it along to the transmitter network.
The transmitter network can have many zones, or paging areas, either in the same
city, or across the country. In the case of nationwide paging, satellite links are
commonly used to connect all the zones together. The transmitter then sends the
signal out, which is received by the particular pager that is supposed to get the
message.

NOTE:
Generally, paging equipments (transmitter and receiver) that use ESPA 4.4.4 are
compliant with ISO/IEC 646 character set. Anyway, national variants or proprietary
standards for international use may affect the conversion of some special characters.

To enable the management system to dispatch pager messages, you must configure
the paging service settings.
In the Management View of System Browser, select Project > Management System >
Servers > Main Server > Pager) to display the RENO Configurator tab in the Primary
pane. Here, you can configure the paging service handled by one of the following
protocols:
 TAP [➙ 331] (service providers included)
 ESPA 4.4.4 [➙ 332]
After configuring the protocol, you can also execute tests on the connection [➙ 334] to
the paging service.

WARNING

NOTE:
An expander for each protocol is present in the configuration user interface, but you
can configure only one protocol (TAP or ESPA 4.4.4). Verify the type of protocol to
configure for the site. Also, refer to the documentation for the pager to set the protocol
parameters.

330
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Pager Configuration Workspace
14

14.6.1 TAP Protocol and Providers

The TAP Protocol expander lets you configure the settings [➙ 335] of the paging
service using TAP [➙ 330] protocol. You must configure both the protocol settings and
the providers for dispatching the pager messages.

TAP Protocol Fields

Item Description
Enabled Select this option to enable the paging service using the TAP protocol.
If selected, the ESPA protocol is automatically disabled.
Device name Enter the name of the paging service from which the messages will be
sent.
This value must be unique, and the field is limited to 50 characters.
Bits per second Select a value (300, 600, 1200, 2400, 4800, 9600, 19200, 38400,
56700, 115200, 230400, 460800, 921600). Default is 115200.
Parity Select a value (Even, Odd, None, Mark, Space). Default is Even.
Data bits Select a value (5, 6, 7, 8). Default is 7.
Stop bits Select a value (1, 1.5, 2). Default is 1.5.
Max message list Select the maximum size for the message list.
size Valid range is 1 through 80. Default is 40.
Message list sending Select the number of dispatching retries.
retries Valid range is 1 through 99. Default is 3.
Recipient message Select the minimum waiting time in seconds before dispatching new
delay messages to a recipient, once the max number of messages for a
recipient has been reached.
Valid range is 20 through 300. Default is 20.
Max messages for Select the maximum number of messages for a recipient in a message
recipient list.
Valid range is 1 through 50. Default is 20.
Message list sending Select the maximum time interval for the message list delivery in
timeout seconds.
Valid range is 10 through 1000. Default is 120.
Max message length Select the maximum length for the message. Default is 120.

331
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Pager Configuration Workspace

Providers - Details Expander

Item Description
Enabled Select this option to enable a provider for the TAP protocol.
Name Enter the name of the service provider.
This parameter must be unique. The field is limited to 50 characters.
Comma not allowed.
Number Enter the phone number of the service provider from which the
messages will be sent
Valid range is 0 through 9 and plus (+). This field is limited to 50 digits.
Comma not allowed.
Password If the provider requires an authentication, enter the password for the
specified paging service. For security, the actual characters do not
appear in this space. Instead, each character is represented by an
asterisk (*).
Confirm password Reenter the password to confirm it.
Add Add a new provider.
Remove Remove the selected provider from the list.
Apply Save the changes for the selected provider.

14.6.2 ESPA Protocol

The ESPA Protocol expander lets you configure the settings [➙ 336] of the paging
service using ESPA 4.4.4 [➙ 330] protocol.

332
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Pager Configuration Workspace
14

ESPA Protocol Fields

Item Description
Enabled Select this option to enable the paging service using the ESPA protocol.
If selected, the TAP protocol is automatically disabled.
Bits per second Select a value (300, 600, 1200, 2400, 4800, 9600, 19200, 38400).
Default is 9600.
Data bits Select a value (5, 6, 7, 8).
Default is 8.
Parity Select a value (Even, Odd, None, Mark, Space).
Default is None.
Stop bits Select a value (1, 1.5, 2).
Default is 1.
COM Number Select the COM port: number.
Default is COM1.
Poll Timer Select a value.
Valid range is 0-120 msec. Default is 60 msec.
Beep Coding Select a value (0, 1, 2, 3, 4, 5, 6, 7, 8, 9).
Default is 1.
Priority Select a value (Alarm or High).
Default is Alarm.
Transmission retries Select a value (1, 2, 3, 4, 5, 6, 7, 8, 9).
Default is 3.
Call Type Select a value:
 Standard
 Reset (to cancel previous messages)
 Speech (to generate a voice message)
Default is Standard.
Max length Select the maximum length for the message.
Default is 120 characters. Maximum is 128 characters.
New line support Select this option to enable the new line support.
Default is deselected.
Ack from transmitter Select this option to expect an acknowledgement from the transmitter
unit.
Display width Select the number of characters per line.
Default is 12 characters. Maximum is 99 characters.
Reply from receiver Select this option to expect a reply message from the receiver device.

333
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Configuring the Paging Service

14.6.3 Test Pager Connection

After you configure the pager protocol, you can use the Test Pager Connection
expander to test [➙ 337] whether the system can send pager messages.

Test Pager Connection Fields

Item Description
Provider name Select one of the available providers.
This field is enabled only for the TAP protocol.
Recipient Number Enter or select the pager number.
This field is limited to 50 digits.
Message text Enter the pager message.
This field is limited to 160 characters.
Send Send the message.
Clear Clear all fields.
Sending result Once you’ve sent one or more messages, this displays the outcome
(OK, failed, and so on).

14.7 Configuring the Paging Service

The following procedures describe how to configure the management system to send
pager messages.

Technical Notes
 Make sure the pager protocol (TAP or ESPA 4.4.4) is enabled if you want the
management system to send out remote notifications to pagers. If the pager
protocol is disabled (Enabled check box deselected), the management system will
not alert you of the fact with any specific alarm or error message.
 The management system’s diagnostics automatically detect if any problem occurs
with the functioning or configuration of the pager protocol (for example, if the
protocol is incorrectly configured, or if it is correctly configured but the paging
equipment is disconnected), and generates an event to notify you of the fact.

334
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Configuring the Paging Service
14

14.7.1 Configuring TAP Protocol and Provider

 System Manager is in Engineering mode.
 The Pager object (paging service) is available in System Browser.
 You want to configure the paging service to use the TAP [➙ 330] protocol for
dispatching pager messages.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server > Pager.
3. Click the RENO Configurator tab.
 The RENO Configurator workspace displays in the Primary pane.
4. Open the TAP Protocol expander.
 The corresponding configuration workspace [➙ 331] displays.
5. Select the Enabled check box.
NOTE: If you don't enable this option (check box deselected), the management
system will not be able to send remote notifications as paging messages using the
paging equipment connected to the serial port.
 The Enabled check box in the ESPA Protocol expander and the Providers field
in the Test Pager Connection expander are automatically disabled.
6. Enter the Device name.
7. Refer to the documentation of the paging equipment to modify the Protocol and
Format settings:
– Bits per second
– Parity
– Data bits
– Stop bits
– Max message list size
– Message list sending retries
– Recipient message delay
– Max messages for recipient
– Message list sending timeout
– Max message length
8. In the RENO Configurator toolbar, click Save .

9. Open the Providers expander.

10. Click Add to add a new row to the providers list.
11. In the Details expander, select the Enabled check box.
NOTE: To disable a provider, select it and in Details deselect Enabled. If you don’t
enable the provider (check box deselected), the management system will not be
able to send remote notifications as paging messages using the paging equipment
connected to the serial port.
12. Enter the Name and Number.

335
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Configuring the Paging Service

13. If the provider requires authentication, enter the Password and Confirm password.
NOTE: Contact the network administrator for information about provider
authentication.
14. Click Apply.
 The provider is added to the list.
15. Repeat the previous steps for all the providers you need to add.
16. (Optional) To modify the settings of a provider, select it and modify its settings.
NOTE: If you modified the name of a provider and at least one recipient is using
the updated provider, a message box asks if you want to modify this name for the
recipient. Click Yes to update this data.
17. (Optional) To remove a provider, select it and click Remove.
NOTE: If at least one recipient is using this provider, a message box informs you
that this provider is in use and the operation is aborted.

Technical Notes
 A message box informs you in case the provider name you have chosen already
exists or password and confirm password values do not match.

14.7.2 Configuring ESPA Protocol

 System Manager is in Engineering mode.
 The Pager object (paging service) is available in System Browser.
 You want to configure the paging service to use the ESPA 4.4.4 [➙ 332]protocol
for dispatching pager messages.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server > Pager.
3. Click the RENO Configurator tab.
 The RENO Configurator workspace displays in the Primary pane.
4. Open the ESPA Protocol expander.
 The corresponding configuration workspace [➙ 332] displays.
5. Select the Enabled check box.
NOTE: If you don't enable this option (check box deselected), the management
system will not be able to dispatch paging messages to the configured recipients
using the paging equipment connected to the serial port.
 The Enabled check box in the TAP Protocol expander is automatically
disabled.
6. Refer to the device operation instructions to appropriately configure the pager
device:
– Bits per second
– Parity
– COM Number
– Data bits
– Stop bits

336
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Configuring the Paging Service
14

– Poll timer
– Beep Coding
– Priority
– Transmission retries
– Call Type
– Max length
– New line support
– Ack form transmitter
– Display width
7. In the RENO Configurator toolbar, click Save .
 The System Manager status bar indicates that the data was successfully saved.

Technical Note
 If multiple Desigo CC installations need to share and use the same paging
equipment, the paging settings must be the same for each Desigo CC server.

14.7.3 Testing the Pager Connection

 System Manager is in Engineering mode.
 You have already configured a pager protocol (TAP [➙ 335] or ESPA 4.4.4
[➙ 336]).
 The RENO Configurator workspace displays in the Primary pane.
1. Open the Test Pager Connection expander.
 The corresponding user interface [➙ 334] displays.
2. TAP protocol only: Select a provider from the Provider name drop-down list.
3. Select or enter a valid Recipient number.
4. Enter the Message text.
5. Click Send.
6. Check the outcome.
7. When the test is complete, click Clear.

Technical Notes
 A message box informs you if you didn’t enter all the data or if the recipient number
is invalid.
 You can send one test message at a time. When the outcome of sending one
message displays, the Send button becomes available again.

337
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Remote Notifications Workspace

14.7.4 Deleting the Pager Device

 System Manager is in Engineering mode.
 The project does not require the paging service and you want to remove it.
1. In System Browser, select Management View.
2. Select Project > Management System > Servers > Main Server > Pager.
3. Click the RENO Configurator tab.
 The RENO Configurator workspace displays in the Primary pane.
4. In the RENO Configurator toolbar, click Delete .
 A confirmation message displays asking if you want to remove the selected
item.
5. Click Yes to confirm the operation.
 The object is removed from System Browser.
NOTE: If you have removed the Pager object, select Main Server > System
Management to add it back to the project.

14.8 Remote Notifications Workspace

Once you have set up the required services (SMS, pager, email), you can create
[➙ 344] a remote notification, or edit an existing one. To do this, in the Application
View of System Browser, select Applications > Remote Notification. This opens the
RENO Configurator interface, where you can define the following:
 General Settings [➙ 339]
 Recipients [➙ 340]
 Message Tailoring [➙ 343]
 Triggers [➙ 344]

RENO Configurator Toolbar

Icon Name Description
Save Save any changes.
configuration This icon is dimmed when you select the Remote Notifications
folder.
It is also dimmed when you select an existing remote notification
but you have not yet made any changes to its configuration.
Save template Create a new remote notification object.
as When you select the Remote Notifications folder, this icon creates
a new remote notification object.
When you select an existing remote notification, it creates a new
remote notification from an existing one.
The new remote notification is saved in the Remote Notifications
folder.
Delete template Deletes the current remote notification object.
This icon is dimmed when you select the Remote Notifications
folder, and is also not available in Operating mode.

338
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Remote Notifications Workspace
14

14.8.1 General Settings

The General Settings expander lets you edit the general details of a remote
notification.

Active
This check box lets you enable/disable [➙ 347] the remote notification. The check box
is selected by default (notification enabled). When a remote notification is active, its
status (visible in the Operation tab of the Contextual pane) is enabled. This means the
remote notification will be dispatched when its configured trigger conditions occur. If
you deselect the Active check box for a remote notification, its status becomes
disabled, and an event is generated to indicate that it is now inactive. This event is
automatically cleared from the system when you enable the remote notification again.
You can later enable/disable a remote notification from the Operation tab of the
Contextual pane. See Enabling a Remote Notification and Disabling a Remote
Notification in the User Guide (A6V10376160).

Priority
This setting lets you specify the priority of the remote notification (the lower the
number, the higher the priority). Valid range is 1 through 999. In situations where
multiple remote notifications are triggered at the same time, this parameter determines
which one will be sent. (The system does not allow you to assign the same priority to
two notifications).

Starting mode
This setting lets you specify how a remote notification is sent:
 Manual: when a remote notification is triggered, the system prompts the operator,
who must manually confirm before the remote notification is dispatched.
 Automatic: the system will automatically dispatch the remote notification when it is
triggered, either immediately or (if configured) after a time-delay expires.

Delay
This setting (available only for the starting mode: automatic) lets you specify the time-
delay (in seconds) that the system will wait before sending out an automatic remote
notification. The valid range is 0 through 3600 seconds: this value can be set in
multiples of 30 seconds.

Multiple starting
This setting specifies whether or not (Yes/No) the remote notification is repeated if the
same event source triggers it again (recurring alarm).
 Yes: The remote notification will be sent again, even if the preceding one is still
being sent out.
 No: The remote notification will be sent again only if the previous one is complete.

339
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Remote Notifications Workspace

Can be stopped
This setting specifies whether or not (Yes/No) the operator can stop a remote
notification.
 Yes: The operator can stop a manual or a time-delayed automatic remote
notification.
 No: The operator cannot stop the remote notification (whether manual or
automatic).

Stop on alarm ending

This setting specifies whether or not (Yes/No) the remote notification stops when the
alarm has been fully handled (that is, when the event disappears from Event List).

Points state
This setting specifies for what point states the notification starts.
 All: the remote notification starts for all alarms, regardless of their point state.
 Genuine: the remote notification starts only for alarms generated by points in the
genuine state.
 Maintenance: the remote notification starts only for alarms generated by points in
the maintenance state.

14.8.2 Recipients
The Recipients expander lets you configure groups of recipients and remote
notification escalation rules.

Recipient/Members
In the Recipients expander, the Recipient column lists the group or groups to which the
message is addressed, while the Members column shows the number of individual
recipients in each group. You can add and remove groups from this section by linking

340
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Remote Notifications Workspace
14

them from the Address Book, but at least one group is required. You cannot add
individual people as recipients here.

Escalation Rules
In the Recipients expander, the Escalation Rules section on the top right lets you
specify, for each recipient group, when that group can be considered successfully
notified, and what escalation actions to take if sending to that group fails. Specifically,
you can set a response timeout for the group and a threshold defining how many (or
what percentage) of the group’s members must have replied within that time. Then you
can also specify a list of escalation recipients, to whom the message should be sent if
the group does not reach its response threshold within the timeout.

Escalation Rules Fields

Item Description
Threshold Specifies how many (or what percentage) of the people in a recipient
group need to reply for the system to consider that group successfully
notified.
Default is 0. The range of values available depends on the units you
select:
 If you set the threshold as a percentage, the valid range is 0 to
100%.
 If you set the threshold as number of people, the valid range is 0 to
the total number of members in the group.
Timeout Specifies the amount of time (in seconds), the system waits for the
members of a group to respond.
Default is 30. Range is 0 through 3600 seconds: This value can be set
in multiples of 30 seconds; if you enter a value that is not a multiple of
30, the number is automatically rounded up or down.
Escalation threshold Specifies how many (or what percentage) of the people in the
escalation list need to reply for the escalation to be considered
successful.
Default is 0. The range of values available depends on the units you
select:
 If you set the escalation threshold as a percentage, the valid range
is 0 to 100%.
 If you set the escalation threshold as the number of people, the
valid range is between 0 and the total number of contacts in the
escalation list.
Escalation Recipient/ For each group, you can also specify a list of escalation recipients, to
Groups/Timeout be used if the group doesn’t reach its response threshold within the
timeout.
You do this by linking escalation recipients from the Address Book to
the escalation list area. The columns specify the recipient’s name, the
group(s) to which that person belongs, and the timeout for receiving a
reply from that person.
This field is optional; you can add and remove individual escalation
recipients.

Address Book
In the Recipients expander, the Address Book section on the bottom right displays the
available contacts from which you can select the recipients of a remote notification. To
select the first-level recipient groups of a remote notification, Link (drag-and-drop)
groups from the Address Book to the Recipient/Members area on the left. (Note that

341
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Remote Notifications Workspace

first-level recipients can only be groups, and not individual contacts). To select the
escalation recipients of a remote notification you instead link (drag-and-drop) individual
contacts from the Address Book to the Escalation Recipient area on the top right.

Address Book Fields

Item Description
Filter Select whether you want to view the Groups or individual People
available in the system’s Address Book to link to the Recipient (only
groups) or Escalation (individual contacts) lists.
Search by Text search field to quickly find the contacts you want among the listed
group(s)/recipients.
Recipient/Groups or Depending on whether you set the Filter to People or Groups, shows
Group/Members either the list of individual contacts or the list of groups available in the
Address Book.
Groups are listed showing the name of the group (Group), and the
contacts (Members) belonging to that group.
Recipients are listed showing the person’s name (Recipient), the name
of the group(s) to which that person belongs (Group), and their
Preferred Device and Fallback Device.

342
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Remote Notifications Workspace
14

14.8.3 Message Tailoring

The Message Tailoring expander lets you compose the remote notification message.
The fields you can complete depend on the type of notification (email, SMS, or pager)
that you select in the Device drop-down list.
You are required to compose the notification message at least for the email device,
and you can optionally compose it for the SMS and/or pager devices as well. You must
compose the notification message at least in the default language of the system, and
you can optionally compose it in other languages as well (if available). (If you only
compose the message in the default language, that text will be used for other
languages as well).

Message Tailoring Fields

Item Description
Language Specify the language in which you want to compose the message.
You must compose the message at least in the default language of the
management system.
Device Specify the type of remote notification method (email, SMS, or pager) to
use. You must compose the message at least for the E-Mail device,
and you can optionally compose it for the other devices as well.
Subject/Body Specify any message tags by dragging-and-dropping from the list on
the right. You can also directly enter text, including in between the tags,
and change the order of the tags (copy/cut/paste/drag-and-drop).
The Subject field is available only for the E-Mail device, and in that case
it is required.
Message Tags Lists the available tags that you can insert when composing the
message:
 Date/Time Limited/Complete
 Recipient short name/full name
 Event Category
 Event Location Limited/Complete
 Event Source Limited/Complete
 Event Cause Limited/Complete
 Event Intervention Text
 Event Source Alias (that is, the private standard name of an object
instance, used by the customer to reference the technical
equipment of building facilities).

343
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Configuring Remote Notifications

14.8.4 Triggers
The Triggers expander lets you configure what alarms or events will cause the remote
notification to start. For information about how to configure this see:
 Events [➙ 298]

14.9 Configuring Remote Notifications

The following procedures describe how to configure remote notifications.

Configuration Workflow
 Configure [➙ 344] a remote notification by specifying its general settings,
recipients, message tailoring, and alarm triggers.
 If you have already configured a remote notification, instead of starting from
scratch, you can start from an existing remote notification [➙ 346].
 If needed, customize the configuration by modifying [➙ 348] the settings,
enabling/disabling [➙ 347], or deleting [➙ 349] remote notifications.

Technical Notes
 To avoid an invalid or inconsistent configuration, before setting up remote
notifications, check that the scope you want to use contains the objects needed for
remote notifications, namely: at least one service (email, SMS, or pager), the
Address Book, and remote notifications.
 If you don’t activate a remote notification (Active check box deselected), you can
save the remote notification, but it will be not enabled during normal operation.
 If you leave the subject empty for an email message, a message box informs you
that this data is missing and you cannot save.
 The SMS length is limited to 480 characters (divided into three messages). Longer
text messages will be cut off.
 Since the pager protocols do not support replies (ACK code not present in the
pager message), do not configure the group threshold for a remote notification
based only on pager dispatch (otherwise the remote notification will fail).

14.9.1 Configuring a Remote Notification

You can create a new remote notification only in the Remote Notifications folder.
 System Manager is in Engineering mode.
 You previously configured the required remote notification service and recipients
[➙ 312].
1. In System Browser, select Application View.
2. Select Applications > Remote Notifications.
3. In the Primary pane, click the RENO Configurator tab.
 The RENO Configurator interface [➙ 338] displays.
4. Open the General Settings expander [➙ 339], and specify the following parameters
(for details about these parameters see General Settings [➙ 339]):

344
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Configuring Remote Notifications
14

– Active. Selecting this check box means the remote notification is enabled (that
is, it will start when it is triggered). Deselect this check box if you want to
configure a remote notification but without using it yet.
– Priority
– Starting mode (manual=the operator will be prompted to initiate the remote
notification; automatic=the remote notification will start without operator
intervention)
– Delay (optional waiting time between when a remote notification is triggered
and when it actually starts)
– Multiple starting (whether the remote notification is repeated in case of
recurring events)
NOTE: If you set this value to Yes, a new remote notification is created each
time the same event source returns off-normal even when a preceding remote
notification has not yet finished.
– Can be stopped
– Stop on alarm ending
– Points state
5. Open the Recipients expander [➙ 340], then open the Address Book section inside
that expander.
6. To choose the first-level recipient group(s) for the message, do the following:
a. In the Address Book area, filter by Groups, and use the search field if needed to
find the groups you want.
b. Drag-and-drop the group(s) you want to add from the Address Book area to the
Recipient/Members list on the left.
c. Select Groups, and filter the address book to narrow your search.
7. For each recipient group, you can optionally define escalation rules.
To define the escalation rules for a recipient group, do the following:
a. Select the group in the Recipient/Members list on the left.
b. In the Escalation Rules area on the top right, enter a Timeout and a response
Threshold for that group. This sets the number or percentage of group members
that need to reply within the specified time for that first-level group to be considered
successfully notified.
c. To specify additional escalation recipients, to whom the message will be sent if
the group doesn’t reach its threshold:
– In the Address Book, filter by People, and use the search field if needed to
narrow down your choices.
– Drag-and-drop the individual recipient(s) you want to add from the Address
Book to the Escalation Recipient/Group/Timeout list.
– Alongside each escalation recipient, set the Timeout within which that person
must reply (default is 30 seconds).
– Specify the Escalation Threshold, defining how many (or what percentage of)
the contacts in the escalation list have to reply for the group’s escalation to be
considered successful.
8. To compose the notification message, open the Message Tailoring expander, and
do the following:
a. Select the Language.

345
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Configuring Remote Notifications

b. Select the Device. This is the method (email, pager, or SMS) that will be used to
send the message. It should be chosen to match the preferred/fallback devices
used by the intended recipients.
NOTE: When you select a device, also make sure that the corresponding service
[➙ 312] is configured and enabled on the management system.
c. Drag-and-drop any automatic tag(s) you want to use from the Message Tags list
into the Subject (only for the E-Mail device) and Body fields. Optionally, enter any
additional text.
d. If you want to send the message using more than one method (for example, you
want to be able to notify recipients by both email and SMS), repeat steps b and c
above for each communication method you want to use.
9. To configure the alarms (events) that will trigger the remote notification, open the
Triggers expander. Then open the Events expander [➙ 298] and specify the
alarms (events) [➙ 299] that will trigger the remote notification.

10. To save the remote notification, In the RENO Configurator toolbar, click Save
templates as .

11. In the Save Object As dialog box, do the following:

a. Select the location in the tree (under Applications > Remote Notifications) where
you want to save this remote notification.
b. Type the Name and Description of the remote notification.
c. Click OK.
 The new remote notification object appears in System Browser. If you selected the
Active check box, it is also enabled (you can also enable/disable it from the
Contextual pane).
NOTE: An error message displays if you try to save an email remote notification
message and the email subject line is missing.

14.9.2 Creating a Remote Notification from an Existing One

You can make a copy of a remote notification by opening it and saving it with a
different name.
Also, instead of configuring a remote notification from scratch, you can start from an
existing remote notification, make changes to it, and then save it as a new remote
notification.
 System Manager is in Engineering mode.
 At least remote notification is available in System Browser.
1. In System Browser, select Application View.
2. Select Applications > Remote Notifications.
3. Under Remote Notifications, select the remote notification you want to use.
4. In the Primary pane, click the RENO Configurator tab.
 The RENO Configurator interface [➙ 338] displays.
5. (Optional) Modify one or more of the following settings (for details about these
settings see Remote Notifications Workspace [➙ 338]):
– General Settings
– Recipients

346
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Configuring Remote Notifications
14

– Message Tailoring
– Triggers
6. To save the settings into a new remote notification object, in the RENO
Configurator toolbar, click Save templates as .

7. In the Save Object As dialog box, do the following:

a. Select the location in the tree (under Applications > Remote Notifications).
b. Type the Name and Description of the remote notification.
c. Click OK.
 The new remote notification object appears in System Browser. If you selected the
Active check box, it is also enabled (you can also enable/disable it from the
Contextual pane).

14.9.3 Enabling or Disabling a Remote Notification

When you first create a remote notification the Active check box (in the General
Settings expander of RENO Configurator) is selected by default. Active means the
remote notification is enabled and will be dispatched when its trigger conditions occur.
You can disable a remote notification by deselecting the Active check box.
You can also check whether a notification is enabled or disabled in the Operation tab
of the Contextual pane.
The following procedures detail how to enable or disable a remote notification from the
RENO Configurator interface.
(For instructions on how to enable or disable a remote notification from the Operation
tab, see the relevant sections in the User Guide A6V10376160.)

Enabling a Remote Notification

 System Manager is in Engineering mode.
 A remote notification is currently inactive (its status in the Contextual pane is
Disabled), and you want to enable it.
1. In System Browser, select Application View.
2. Select Applications > Remote Notifications.
3. Under Remote Notifications, select the remote notification you want to enable.
 The RENO Configurator interface [➙ 338] displays in the Primary pane.
4. Open the General Settings expander [➙ 339], and select the Active check box.

5. To save the changes, in the RENO Configurator toolbar, click Save .

 In the Operation tab of the Contextual pane, the status of the current remote
notification changes to Enabled.

Disabling a Remote Notification

Disabling a remote notification prevents it from being dispatched by any operators or
stations, while still retaining the remote notification within the system. For example, you
might do this for remote notifications that are not yet complete or ready to be put into
general use.
 System Manager is in Engineering mode.

347
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Configuring Remote Notifications

 A remote notification is currently active (its status in the Contextual pane is

Enabled), and you want to disable it.
1. In System Browser, select Application View.
2. Select Applications > Remote Notifications.
3. Under Remote Notifications, select the remote notification you want to disable.
 The RENO Configurator interface [➙ 338] displays in the Primary pane.
4. Open the General Settings expander [➙ 339], and deselect the Active check box.

5. To save the changes, in the RENO Configurator toolbar, click Save .

 In the Operation tab of the Contextual pane, the status of the current remote
notification changes to Disabled.

NOTE:
When you disable a remote notification, the management system generates an event.
This event is automatically cleared when you re-enable the remote notification.

14.9.4 Modifying a Remote Notification

 System Manager is in Engineering mode.
 You want to edit or change an existing remote notification.
1. In System Browser, select Application View.
2. Select Applications > Remote Notifications.
3. Under Remote Notifications, select the remote notification you want to modify.
4. In the Primary pane, click the RENO Configurator tab.
 The RENO Configurator interface [➙ 338] displays.
5. Modify one or more of the following settings (for details about these settings see
Remote Notifications Workspace [➙ 338]):
– General Settings
– Recipients
– Message Tailoring
– Triggers
6. To save the changes, in the RENO Configurator toolbar, click Save .

348
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
Troubleshooting the Email Server
14

14.9.5 Deleting a Remote Notification

NOTICE! You cannot delete the main Remote Notifications folder.
 System Manager is in Engineering mode.
 One or more remote notifications exist in the project.
1. In System Browser, select Application View.
2. Select Applications > Remote Notifications.
3. Under Remote Notifications, select the remote notification you want to delete.
4. In the Primary pane, click the RENO Configurator tab.
 The RENO Configurator interface [➙ 338] displays.
5. In the RENO Configurator toolbar, click Delete .
 A confirmation message box asks if you want to delete the selected item.
6. Click Yes to confirm the operation.
 The object is removed from System Browser.

14.10 Troubleshooting the Email Server

Microsoft Email Accounts
You can set up the management system to send/receive remote notifications by email
using a Microsoft email account such as Outlook, Hotmail, Live, and so forth.
1. Sign in to the Microsoft email account that the management system will use to
send/receive notifications by email.
2. Click the Options icon, and then click Options.
3. Under Managing Your Account, click Connect devices and apps with POP.
4. Under POP, make sure Enable is selected.
5. Select Do what the device or app says … to allow devices and apps to delete
messages from the inbox.
6. Click Save.
Note that the Microsoft email server provider has the following limitations:
 IMAP protocol is not supported
 Pings to POP every 10 seconds are not accepted.
 Continuously sending too many outgoing email remote notification messages may
cause the email account to be deactivated. If this happens, you must contact the
email provider to have the account activated again.

Gmail
You can set up the management system to send/receive remote notifications using a
Gmail email account. See the following procedure to properly configure Gmail as the
email server provider.
1. Sign in to the Gmail account that the management system will use to send remote
notifications by email.

349
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Remote Notifications
14 Troubleshooting the TAP Pager Modem

2. Click the Settings icon, and then click the Settings option.
3. In the General tab, select the following option:
– Conversation view off
NOTE: Conversation view on is not supported.
4. Click the Forwarding and POP/IMAP tab, and select the following option:
– When messages are accessed with POP delete Gmails's copy
NOTE: For the remote notifications to work properly, email messages must be
deleted from the Gmail server after they have been retrieved via POP.

14.11 Troubleshooting the TAP Pager Modem

If the TAP pager modem drivers are installed after installing Desigo CC, the TAP
device will not work until the Desigo CC server is rebooted.
 To solve the issue, exit Desigo CC and reboot the server.

14.12 Troubleshooting Remote Notification Services

Connection problems may occur when using an RS232/COM-to-IP converter to share
a GSM modem or pager among multiple Desigo CC management systems.
For correct operation:
1. If available, verify that the following options are disabled:
– Connect at system startup
– Delay close of tcp connection
– Restore dropped connections
2. Enable the following option:
– Close TCP connection when COM port is closed
If this solution does not work, to solve the issue, reboot the converter and restart its
service.

350
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Troubleshooting Remote Notification Services
15

15 Operating Procedures
An operating procedure consists of a sequence of steps or actions that can be
automatically executed by the system or manually performed by an operator in the
context of Assisted Treatment. Operating procedures execute during Assisted
Treatment to provide operators with step-by-step instructions for handling certain
alarms.

Assisted Treatment
Assisted Treatment is the name of a guided alarm-handling feature provided by Desigo
CC. When an alarm occurs for which Assisted Treatment is available, the operator can
open a dedicated Assisted Treatment window that gives a step-by-step procedure to
follow:
 The Assisted Treatment window shows the sequence of steps (for example,
viewing a document or graphic, sending a remote notification, or filling out a report)
that the operator has to perform to properly handle that alarm.
 At each step, the system automatically opens and displays whatever resource or
tool (for example, an instruction document, a floor plan graphic, or a report
template) the operator needs to perform that step.
 Certain steps (such as sending notifications) may also be automatically executed
by the system if it is configured to do so.
The sequence of steps for the Assisted Treatment of an alarm is called an operating
procedure. For Assisted Treatment to be available, an operating procedure needs to
have been previously configured for that type of alarm.

Operating Procedures
To make Assisted Treatment available for a certain type of alarm, you must configure
an operating procedure for it. You do this in the Operating Procedures workspace
[➙ 353]. When you configure an operating procedure, you have to specify its:
 Filters: These define when (for example, at weekends, or when the building is
occupied) and for what alarms (for example, fire alarms, or alarms in a certain
zone) you want the procedure to be invoked.
 Steps: The sequence of assisted alarm-handling actions presented to the operator
when the procedure is triggered. The steps in such a procedure can include:
– Document (For example, view a PDF document with evacuation instructions).
– Graphic (For example, view a floor plan graphic of the building floor where the
alarm occurred).
– Remote Notification (Send out, for example, email or SMS messages to alert
previously specified recipients of the situation)
– Alarm Printout (For example, print out the event information including a floor
plan graphic of the building floor where the alarm occurred)
– Treatment Form (Fill out an alarm report with operator's remarks or comments)
– Report (For example, print out an event detail log, activity log, or event log)

Operating Procedure License and Access Rights

 Assisted Treatment is covered by a license. Check that the Assisted Treatment
option license is installed in the system (in the Management View of System
Browser, at the following path: Project > Management System > Servers > Main
Server > Licenses); otherwise you won’t be able to configure operating procedures.
If the license is installed but later expires or is lost for any reason, existing
procedures will continue to work in Operating mode. However, you won’t be able to
modify the existing procedures or configure new ones.

351
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Operating Procedures List

 Even if the Assisted Treatment license is installed, your ability to access operating
procedures also depends on the Application Rights [➙ 111] configured for your
user group. If you don’t have appropriate rights you may be able to view but not
configure operating procedures, or you may not have access to this function at all.
Note that if you have the application rights to configure operating procedures, you
will also be able to configure all types of procedure steps, even if you do not have
the application rights for the corresponding application (for example, you will be
able to configure a remote notification step even if you do not otherwise have
access rights to the remote notification application).
 Configuring an operating procedure is a prerequisite for the Assisted Treatment
feature to work. If no operating procedure is defined for a particular alarm, the
operator will not be able to handle it with the aid of Assisted Treatment. However,
the other alarm-handling methods provided by the system (Fast Treatment and
Investigative Treatment) will remain available.
 Your ability to access Assisted Treatment also depends on the Application Rights
[➙ 101] configured for your user group. If you don’t have appropriate rights, you
cannot initiate Assisted Treatment.

15.1 Operating Procedures List

In the Management View of System Browser, select System Settings > Operating
Procedures (or one of the subfolders under it) to view a list of all the operating
procedures located in that folder. The list displays in the Primary pane, and shows the
name, priority and operational status (enabled/disabled) of each procedure.
NOTE: When you select a folder you will see a list of all the operating procedures
located directly in that folder, as well as those located in any of its subfolders.
Therefore, if you want to see all the operating procedures, select the main Operating
Procedures folder.
From the operating procedures list in the Primary pane, you can:
 Add ( ) operating procedures and subfolders to the current folder.

 Modify the priority of an operating procedure, or change its operational status (that
is, enable or disable it), and save ( ) the changes.
NOTE: If you try to give an operating procedure the same priority as another
procedure, the system rejects the change.
Only if you are located in a subfolder of the main Operating Procedures folder, you can
also:
 Delete ( ) the current folder (and all its operating procedure templates)

Operating Procedures List

352
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Operating Procedures Workspace
15

Priority
Value indicating the priority (precedence) of the operating procedure (0 denotes the
highest priority). If an alarm occurs that triggers (matches the filters of) more than one
procedure, the one with the highest priority (lowest number) gets executed. The priority
is defined when the procedure is created. You can later modify it in the General
Settings expander [➙ 355] of the operating procedure, or directly from this list [➙ 352]
by entering a new value or using the Move Up/Move Down buttons. (The system won’t
allow you to give two procedures the same priority.)

Operational Status
Indicates whether the procedure is enabled (check box selected) or disabled. If a
procedure is enabled, it will start when its filter conditions are met.
A procedure is automatically enabled when you create it. You can later enable/disable
[➙ 381] the procedure from this list, and also from the Operation tab [➙ 353] in the
Contextual pane.

15.2 Operating Procedures Workspace

In the Management View of System Browser, when you select an operating procedure
(under the main Operating Procedures folder or one of its subfolders), the Primary
pane displays a workspace where you can configure the settings, filters and steps for
that procedure.

Operating Procedure Workspace

Operating Procedures Workspace Toolbar

Icon Name Description
Add a new object Add new operating procedure steps (Document Viewer
Alarm Printout, Graphics, Reno, Report, Treatment form).
Save the Changes Save the changes made.

Save Object as Save the changes made with a different name.

Delete Object Delete the operating procedure.

Operating Procedure Properties and Commands

The Operation tab in the Contextual pane shows the most important properties of the
currently selected procedure (its priority, and whether it is enabled/disabled), and
provides buttons to enable or disable it.

353
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Operating Procedures Workspace

Operating Procedure - Operation Tab

Operation Tab - Properties and Commands of a Procedure

Property Description
Operational Status Indicates whether the procedure is currently:
 Enabled: The operating procedure will execute if its filter conditions
are met. The Disable command is available.
 Disabled: The operating procedure will not execute, even if its filter
conditions are met. The Enable command is available.
Priority Number indicating the priority (importance) of the operating procedure
(for example, 0 higher and 4 lower).

The Extended Operation tab provides the following additional information about the
currently selected operating procedure.

Extended Operation Tab - Properties of a Procedure

Property Description
Summary status Alarm propagation status.
Force manual close  Yes: When the procedure is complete the operator will have to
manually close the event (send a close command).
 No: The event will close itself (autoclose) when the procedure is
complete.
Keep primary event In case of a recurring event (the same alarm occurring multiple times),
whether or not (Yes/No) the operator is prevented from closing the
original event that first triggered the operating procedure until any other
linked events have been closed.
It happens after See On new occurrence below.
Step execution type How the steps of this procedure will be executed:
 Free: steps can be executed in any order
 Sequential: mandatory steps will be executed in a specific
sequential order, while optional steps can be executed in any order.

354
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Operating Procedures Workspace
15

On New occurrence Specifies what happens if the triggering alarm occurs again (recurring
event):
 Link existing procedure: The currently executing instance of the
procedure will be used to handle the recurring event, and any steps
already executed will not be reset.
 Link existing procedure and reset steps: The currently executing
instance of the procedure will be used to handle the recurring
event, but any steps already executed will be reset. This means
that the operator will have to start the procedure from the
beginning. If the It happens after property is set, it indicates the
time interval that must elapse between two successive recurring
events. If a repeat event happens after that time, the procedure
steps will be reset.
 Create new procedure: A separate instance of the procedure will be
started to handle the recurring event. If the It happens after
property is set, it indicates the time interval that must elapse
between two adjacent recurring events. If a recurring event
happens after that time, a new procedure will be started to handle
the recurring event. If instead the recurring event happens before
this time has elapsed, the currently executing procedure will be
used to handle the alarm.

15.2.1 General Settings

The General Settings expander lets you to configure the general parameters of an
operating procedure.

Operating Procedure - General Settings Expander

General Settings Fields

Item Description
Priority Value indicating the priority (precedence) of the operating procedure (0
denotes the highest priority). If an alarm occurs that triggers (matches
the filters of) more than one procedure, the one with the highest priority
(lowest number) gets executed.
The priority is defined when the procedure is created. You can later
modify it in this General Settings expander, or from the operating
procedures list. (The system won’t allow you to give two procedures the
same priority.)
Steps Execution Type Specify whether the procedure steps have to be executed in order:
 Free: The steps can be executed in any order
 Sequential: The mandatory steps will be executed in a specific
sequential order, while optional steps can be executed in any order.

355
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Operating Procedures Workspace

On new occurrence/If Specifies what happens if the triggering alarm occurs again (recurring
happens after event) :
 Link existing procedure: The currently executing instance of the
procedure will be used to handle the recurring event, and any steps
already executed will not be reset.
 Link existing procedure and reset steps: The currently executing
instance of the procedure will be used to handle the recurring
event, but any steps already executed will be reset. This means
that the operator will have to start the procedure from the
beginning. With this option you can also set a time interval (default:
300 seconds) that must elapse between two successive recurring
events. If a recurring event happens after that time, the procedure
steps will be reset.
 Create new procedure: A separate instance of the procedure will be
started to handle the recurring event. With this option you can also
set a time interval (default: 300 seconds) that must elapse between
two successive recurring events. If a recurring event happens after
that time, a new procedure will be started to handle the recurring
event. If instead the recurring event happens before this time has
elapsed, the currently executing procedure will be used to handle
the alarm.
Force manual close If you select Yes, when the operating procedure is complete the
operator will have to manually close the event (send a close command).
If you select No, the event will close itself (autoclose) when the
procedure is complete. By default, No is set.
Keep primary event In case of a recurring event (the same alarm occurring multiple times),
select Yes to prevent the operator from closing the original event that
first triggered the operating procedure until any other linked events
have been closed. By default, No is set.
If you configure Force Manual Close = No and Keep primary event =
Yes, the system will automatically close the event that originally
triggered the operating procedure only when all its linked events have
been handled and automatically closed.
Notes Text field for your entering comments or remarks.

15.2.2 Filters
In the Filters expander you can configure when and for what alarms this operating
procedure will be triggered. Specifically, you can define the following filters:
 Time and Organization Mode [➙ 295]: time-related conditions such as date ranges,
times, days of the week, or facility occupancy status.
 Events [➙ 298]: the type of alarm or combination of alarms.
There is an AND logic between the two filters. That is, if you specify a Time and
Organization Mode filter as well as an Events filter, the operating procedure will be
triggered only when the specified alarms occur at the specified times. If an alarm
occurs that triggers more than one operating procedure, the one with the highest
priority will start in Assisted Treatment.

Operating Procedure – Filters Expander

356
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Operating Procedures Workspace
15

15.2.3 Steps
The Steps expander displays the list of steps in the operating procedure. From here
you can modify the execution order of the existing steps in the procedure and some
aspects of how they will execute.

Operating Procedure – Steps Expander

Operating Procedure - Steps Expander Fields

Item Description
Name Name of the operating procedure step.
Execution Order Number indicating the step’s position in the procedure, and hence its
execution order. By default, steps are numbered based on the order in
which you add them to the procedure. You can change their execution
order by moving steps up or down in the list.
Execution Mode How the step will be executed:
 Manual: The operator must execute the step manually.
 Automatic on creation: The step will be automatically executed as
soon as an event that triggers the procedure occurs in the system.
 Automatic on first treatment: The step will be automatically
executed as soon as the operator starts handling the event that
triggers the procedure.
The Execution Mode field is not available for all steps types.
Specifically:
 Available: Alarm Printout, Reno, and Report steps
 Not available: Document, Graphics, and Treatment Form steps,
which can only be manual.
Repeatable Whether or not the step can be repeated (that is, whether it can be
done more than once during the same procedure). The check box
shows the current setting, which you can also change from here.
Mandatory Whether the step is required or can be skipped. The check box shows
the current setting, which you can also change from here.

357
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Procedure Step Workspace

15.3 Procedure Step Workspace

In System Browser Management View, select a procedure step (under an operating
procedure node) to display the workspace for configuring that step.

Operating Procedure– Step Configuration Example

You can configure:

 For each step in a procedure, its general settings [➙ 360]. These include its
execution order and mode, and whether the step is mandatory and repeatable.
 For all steps except Reno, additional settings [➙ 361] which vary depending on the
type of step, and consist in associating one or more resources with the current
procedure step and—if available—specifying filters to select which resources to
display along with the step during Assisted Treatment.
 Only Reno steps, recipients and message tailoring [➙ 369].

Procedure Step Toolbar

Icon Name Description
Save the Changes Save the changes made.

Save Object as Save the changes made with a different name.

Delete Object Delete the procedure step.

358
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Procedure Step Workspace
15

Procedure Step Properties and Commands

When you select an operating procedure step in System Browser, the Operation tab in
the Contextual pane shows the current properties of that procedure step and provides
commands (where available) for changing them.

Operating Procedure Step – Example of Operation Tab

Operation Tab - Procedure Step Properties and Commands

Property Description
Execution Mode How the step will be executed:
 Manual
 Automatic on creation (as soon as the event triggering the
procedure occurs)
 Automatic on first treatment (as soon as the operator starts
handling the triggering event)
This setting is available for the Alarm Printout, Reno and Report steps.
(The other steps are always manual). You can set the execution mode
from here, from the General Settings expander [➙ 360] for the step,
and from the Steps expander [➙ 357] for the operating procedure.
Mandatory Whether or not the step is required (True or False). False means it can
be skipped.
Repeatable Whether or not the step can be done more than once during the
procedure (True or False).

359
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Procedure Step Workspace

15.3.1 General Settings

When you select an operating procedure step in System Browser, a workspace for
configuring that step displays in the Primary pane. This workspace includes a General
Settings expander, where you can configure the general parameters the procedure
step.

Operating Procedure Step - General Settings

Operating Procedure Step – General Settings Fields

Item Description
Execution Order Number indicating the step’s position in the procedure, and hence its
execution order. Steps are initially numbered based on the order in
which you add them to the procedure.
You cannot change this setting here: you can only change a step’s
execution order from the Steps expander [➙ 357] of the operating
procedure.
Execution Mode How the step will be executed:
 Manual: The operator must execute the step manually.
 Automatic on creation: The step will be automatically executed as
soon as an event that triggers the procedure occurs in the system.
 Automatic on first treatment: The step will be automatically
executed as soon as the operator starts handling the event that
triggers the procedure.
The Execution Mode field is not available for all step types. Specifically:
 Available: Alarm Printout, Reno, and Report steps
 Not available: Document, Graphics, and Treatment Form steps,
which can only be manual.
When the Execution Mode is available, you can also change it from the
Steps expander [➙ 357] of the operating procedure, or from the
Operation tab [➙ 358] when the procedure step is selected.
Repeatable Whether or not the step can be performed multiple times during the
same procedure. When this check box is deselected, the step cannot
be executed again once the operator marks it as executed. Default is
deselected.
You can also change this setting from the Steps expander [➙ 357] of
the operating procedure.
Mandatory Whether the step is required or optional. Mandatory means the step
must be executed to complete the procedure and close the event.
Default is deselected.
You can also change this setting from the Steps expander [➙ 357] of
the operating procedure.
Notes Text field for your entering comments or remarks, in the different
languages available in the system .

360
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Procedure Step Workspace
15

15.3.2 Additional Settings

When you select an operating procedure step in System Browser, a workspace for
configuring that step displays in the Primary pane. Depending on the type of step, this
workspace may include an Additional Settings expander, where you can configure links
to resources [➙ 373] (such as documents, floor plans, or reports) that you want to
display along with that procedure step during Assisted Treatment.

Operating Procedure Step – Additional Settings

The types of resources you can link will depend on the type of procedure step:
 Alarm printout step [➙ 363]: event printout report template object
 Document step [➙ 364]: document object
 Graphic step [➙ 365]: graphic object
 Report step [➙ 366]: event detail log, activity log, or event log report template
object
 Treatment form step [➙ 367]: alarm report template object
Depending on the type of step, you may have one or both the following options for
specifying what resources you want to link.

Get Link From Related Items

This option lets you to automatically link the first related item available for the point in
alarm that triggered the operating procedure: this is the resource that will be displayed
along with the step during Assisted Treatment.

Fixed links
This option lets you manually link one or more resources that you want to display along
with this procedure step during Assisted Treatment. You can link one or more objects
by dragging and dropping the corresponding nodes from System Browser onto the
Links area. You can change the order of the links with the Move Up and Move Down
buttons. Use the Remove button to remove the selected link.
For each linked resource you can also set up filters (Time and Organization Mode
[➙ 295] and Events [➙ 298]) that specify when and for what alarms that particular
resource should be displayed with this step during Assisted Treatment. Configuring
filters lets you conditionally display a linked resource. If the filter conditions are not met
for any of the linked resources, the procedure step will be executed displaying a
related item (if available) otherwise without displaying any resource.

361
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Procedure Step Workspace

Clicking a link displays the Filters that you can configure for it.

NOTE:
Do not confuse these filters, which select what resource displays during an individual
step, with the filters that determine whether the entire operating procedure is
triggered.

Configuration Tips
 If you try to save an incomplete configuration (for example, the list of fixed links is
empty because you didn't link any resources), an error message displays and you
cannot save.
 If you don't set an events filter for the first fixed link in the list, in Operating mode
this fixed link will be used for all types of alarms.
 If you set an events filter for the first fixed link in the list, but not for any of the other
ones, in Operating mode the system will behave as follows:
– If the alarm matches the events filter of the first fixed link, this fixed link will be
used.
– If the alarm does not match the events filter of the first fixed link, the second
fixed link will always be used instead.
 If you set all the fixed links with at least one events filter, but the alarm that occurs
does not match any of them, the system automatically takes the first related item
available for the point in alarm that triggered the operating procedure.

362
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Procedure Step Workspace
15

15.3.2.1 Alarm Printout Step: Additional Settings

When you select an alarm printout step in System Browser, a workspace for
configuring that step displays in the Primary pane. This workspace includes an
Additional Settings expander, where you can configure links to resources [➙ 374]
(such as an event printout template object) that you want to display along with that
procedure step during Assisted Treatment.

Alarm Printout Step – Additional Settings

You have only the Fixed Links option available for specifying what resources you want
to link.

Fixed links
This option lets you manually link one or more resources that you want to display along
with this procedure step during Assisted Treatment. You can link one or more objects
by dragging and dropping the corresponding nodes from System Browser onto the
Links area. You can change the order of the links with the Move Up and Move Down
buttons. Use the Remove button to remove the selected link.
For each linked resource you can also set up filters (Time and Organization Mode
[➙ 295] and Events [➙ 298]) that specify when and for what alarms that particular
resource should be displayed with this step during Assisted Treatment. Configuring
filters lets you conditionally display a linked resource. If the filter conditions are not met
for any of the linked resources, the procedure step will be executed displaying a
related item (if available) otherwise without displaying any resource.
Clicking a link displays the Filters that you can configure for it.

363
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Procedure Step Workspace

15.3.2.2 Document Step: Additional Settings

When you select a document step in System Browser, a workspace for configuring that
step displays in the Primary pane. This workspace includes an Additional Settings
expander, where you can configure links to resources [➙ 375] (such as a document
object) that you want to display along with that procedure step during Assisted
Treatment.

Document Step – Additional Settings

You have both the following options for specifying what resources you want to link.

Get Link From Related Items

This option lets you to automatically link the first related item available for the point in
alarm that triggered the operating procedure: this is the resource that will be displayed
along with the step during Assisted Treatment.

Fixed links
This option lets you manually link one or more resources that you want to display along
with this procedure step during Assisted Treatment. You can link one or more objects
by dragging and dropping the corresponding nodes from System Browser onto the
Links area. You can change the order of the links with the Move Up and Move Down
buttons. Use the Remove button to remove the selected link.
For each linked resource you can also set up filters (Time and Organization Mode
[➙ 295] and Events [➙ 298]) that specify when and for what alarms that particular
resource should be displayed with this step during Assisted Treatment. Configuring
filters lets you conditionally display a linked resource. If the filter conditions are not met
for any of the linked resources, the procedure step will be executed displaying a
related item (if available) otherwise without displaying any resource.
Clicking a link displays the Filters that you can configure for it.

364
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Procedure Step Workspace
15

15.3.2.3 Graphic Step: Additional Settings

When you select a graphic step in System Browser, a workspace for configuring that
step displays in the Primary pane. This workspace includes an Additional Settings
expander, where you can configure links to resources [➙ 376] (such as a graphic
object) that you want to display along with that procedure step during Assisted
Treatment.

Graphic Step – Additional Settings

You have both the following options for specifying what resources you want to link.

Get Link From Related Items

This option lets you to automatically link the first related item available for the point in
alarm that triggered the operating procedure: this is the resource that will be displayed
along with the step during Assisted Treatment.

Fixed links
This option lets you manually link one or more resources that you want to display along
with this procedure step during Assisted Treatment. You can link one or more objects
by dragging and dropping the corresponding nodes from System Browser onto the
Links area. You can change the order of the links with the Move Up and Move Down
buttons. Use the Remove button to remove the selected link.
For each linked resource you can also set up filters (Time and Organization Mode
[➙ 295] and Events [➙ 298]) that specify when and for what alarms that particular
resource should be displayed with this step during Assisted Treatment. Configuring
filters lets you conditionally display a linked resource. If the filter conditions are not met
for any of the linked resources, the procedure step will be executed displaying a
related item (if available) otherwise without displaying any resource.
Clicking a link displays the Filters that you can configure for it.

365
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Procedure Step Workspace

15.3.2.4 Report Step: Additional Settings

When you select a report step in System Browser, a workspace for configuring that
step displays in the Primary pane. This workspace includes an Additional Settings
expander, where you can configure links to resources [➙ 379] (such as an event detail
log, activity log, or event log) that you want to display along with that procedure step
during Assisted Treatment.

Report Step – Additional Settings

You have only the Fixed Links option available for specifying what resources you want
to link.

Fixed links
This option lets you manually link one or more resources that you want to display along
with this procedure step during Assisted Treatment. You can link one or more objects
by dragging and dropping the corresponding nodes from System Browser onto the
Links area. You can change the order of the links with the Move Up and Move Down
buttons. Use the Remove button to remove the selected link.
For each linked resource you can also set up filters (Time and Organization Mode
[➙ 295] and Events [➙ 298]) that specify when and for what alarms that particular
resource should be displayed with this step during Assisted Treatment. Configuring
filters lets you conditionally display a linked resource. If the filter conditions are not met
for any of the linked resources, the procedure step will be executed displaying a
related item (if available) otherwise without displaying any resource.
Clicking a link displays the Filters that you can configure for it.

366
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Procedure Step Workspace
15

15.3.2.5 Treatment Form Step: Additional Settings

When you select a treatment form step in System Browser, a workspace for
configuring that step displays in the Primary pane. This workspace includes an
Additional Settings expander, where you can configure links to resources [➙ 380]
(such as an alarm report template) that you want to display along with that procedure
step during Assisted Treatment.

Treatment Form Step – Additional Settings

You have only the Fixed Links option available for specifying what resources you want
to link.

Fixed links
This option lets you manually link one or more resources that you want to display along
with this procedure step during Assisted Treatment. You can link one or more objects
by dragging and dropping the corresponding nodes from System Browser onto the
Links area. You can change the order of the links with the Move Up and Move Down
buttons. Use the Remove button to remove the selected link.
For each linked resource you can also set up filters (Time and Organization Mode
[➙ 295] and Events [➙ 298]) that specify when and for what alarms that particular
resource should be displayed with this step during Assisted Treatment. Configuring
filters lets you conditionally display a linked resource. If the filter conditions are not met
for any of the linked resources, the procedure step will be executed displaying a
related item (if available) otherwise without displaying any resource.
Clicking a link displays the Filters that you can configure for it.

367
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Procedure Step Workspace

15.3.2.6 Filters
The Filters expander—available for all the steps except the Reno step—lets you
configure when and for what alarms a resource linked to a procedure step should be
displayed along with that step. For example, you can configure a procedure that is
triggered by 3 types of alarms, and then use this filter here to differentiate what
document displays in a document step, depending on the alarm. You can configure the
following two types of filters:
 Time and Organization Mode [➙ 295]: time-related conditions such as date ranges,
times, days of the week, or facility occupancy status.
 Events [➙ 298]: the type of alarm or combination of alarms.
There is an AND logic between the two filters. That is, if you specify a Time and
Organization Mode filter as well as an Events filter, the linked resources will display
along with that step only when the specified alarms occur at the specified times.
This Filters expander is dimmed if no link is available or selected.

Step – Filters

368
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Procedure Step Workspace
15

15.3.3 Reno Step: Recipients and Message Tailoring

When you select a Reno step in System Browser, a workspace for configuring that
step displays in the Primary pane. This workspace includes the Recipients and
Message Tailoring expanders, where you can configure [➙ 377] the recipients and the
message of a remote notification you want to send with that procedure step during
Assisted Treatment.
The configuration settings area is the same as Recipients [➙ 340] and Message
Tailoring [➙ 343] for remote notifications.

Reno Step – Recipients and Message Tailoring Settings

369
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Configuring Operating Procedures

15.4 Configuring Operating Procedures

The following sections describe how to configure operating procedures.

Configuration Workflow
1. (Optional) Set up [➙ 370] the folder structure for storing operating procedures.
2. Add [➙ 370] a new operating procedure, then add steps [➙ 371] to the operating
procedure.
3. Configure [➙ 372] the operating procedure.
4. Configure [➙ 373] the operating procedure steps.
5. Other actions:
– Enable/disable [➙ 381] an operating procedure.
– Modify [➙ 382] the priority of operating procedures.
– Adjust [➙ 382] the execution order of steps in a procedure.
– Delete [➙ 383] an operating procedure, folder, or procedure step.

15.4.1 Setting up the Operating Procedures Folders Structure

You can save all your operating procedures directly in the main Operating Procedures
folder. Alternatively, you can create subfolders under the main Operating Procedures
folder to better organize the operating procedures.
 System Manager is in Engineering mode.
 You want to add one or more subfolders under the main Operating Procedures
folder.
1. In System Browser, select Management View.
2. Select Project > System Settings> Operating Procedures.
 The Operating Procedures workspace [➙ 352] displays in the Primary pane.
3. In the Operating Procedures toolbar, click Add New and select New Operating
Procedure Folder.

4. In the Create New Object dialog box, do the following:

a. Type the Name and Description.
b. Click OK.
 The new operating procedure folder appears in System Browser.
5. Repeat steps 3-4 for all the subfolders folder required.
6. To add a nested subfolder, select an operating procedure subfolder under the main
Operating Procedures folder, and repeat steps 3-4.

15.4.2 Adding a New Operating Procedure

You can create a new operating procedure directly in the main Operating Procedures
folder, or in one of the subfolders under it. For how to create subfolders see Setting up
the Operating Procedures Folders Structure [➙ 370].
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings.

370
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Configuring Operating Procedures
15

3. Select the main Operating Procedures folder (or a subfolder under it).
This is where the new operating procedure will be stored.
 The Operating Procedures workspace [➙ 352] displays in the Primary pane,
showing a list of all the operating procedures located under the selected folder.
4. In the Operating Procedures toolbar, click Add New and select New Operating
Procedure Template.
Note that a template is actually an operating procedure.

5. In the Create New Object dialog box, do the following:

a. Type the Name and Description.
b. Click OK.
 The new operating procedure appears in System Browser, and it is enabled by
default (you can enable/disable [➙ 381] it from the Contextual pane). You can now
proceed to:
 Add steps [➙ 371] to the procedure.
 Configure the procedure [➙ 372].
 Configure the procedure steps [➙ 373].

15.4.3 Adding Steps to an Operating Procedure

 System Manager is in Engineering mode.
 At least one operating procedure is available in System Browser.
1. In System Browser, select Management View.
2. Select Project > System Settings > Operating Procedures.
 The Operating Procedures list [➙ 352] displays in the Primary pane.
3. In System Browser, select the main Operating Procedures folder, or in a subfolder
under it. Then select the operating procedure to which you want to add steps.
 The Operating Procedures workspace [➙ 353] displays in the Primary pane.
4. In the Operating Procedures toolbar, click Add New and select one of the
following, depending on the type of step you want to add:
– New Step Alarm Printout
– New Step Document Viewer
– New Step Graphics
– New Step Reno
– New Step Report
– New Step Treatment Form
5. In the Create New Object dialog box, do the following:
a. Type the Name and Description.
b. Click OK.
 The new operating procedure step appears under the operating procedure in
System Browser. To configure the step, see Configuring an Operating
Procedure Step [➙ 373].

371
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Configuring Operating Procedures

6. Repeat the steps 3-4 for all the other steps you want to add to the operating
procedure.

15.4.4 Configuring an Operating Procedure

After you add a new operating procedure [➙ 370] and add some steps [➙ 371] to it,
you can configure the general settings, filters, and steps of the procedure. You can
also modify the configuration of an existing operating procedure.
 System Manager is in Engineering mode.
 At least one operating procedure (with some steps) is available in System Browser.
1. In System Browser, select Management View.
2. Select Project > System Settings> Operating Procedures or a subfolder under it.
 The Operating Procedures list [➙ 352] displays in the Primary pane.
3. In System Browser, select the operating procedure that you want to configure.
 The Operating Procedures workspace [➙ 353] displays in the Primary pane.
4. To configure the general behavior of the operating procedure, open the General
Settings expander [➙ 355] and, if necessary, modify its parameters (see General
Settings [➙ 355] for an explanation of these parameters):
– Priority
– Step Execution Type
– On new occurrence/If happens after
– Force Manual Close
– Keep primary event
– (Optional) Notes
5. To configure when and for what alarms the operating procedure should start, open
the Filters expander [➙ 356]. Then do the following:
– Open the Time and Organization Mode expander and specify when [➙ 297]
(for example, dates, times of day, when the building is occupied, at weekends)
you want the operating procedure to run.
– Open the Events expander and specify for what alarms [➙ 299] you want the
operating procedure to run.
– NOTE: There is an AND logic between the Time and Organization Mode and
Events filters. That is, both filters must be true for the operating procedure to
run.
If an alarm occurs that matches the Filters of more than one operating
procedure, the one with the higher priority (lower number) will run.
6. To configure the general behavior of the existing procedure steps, open the Steps
expander [➙ 357]. From here you can do the following:
– Change the Execution Order of the steps in the procedure by selecting steps in
the list and clicking Move Up or Move Down. (By default steps are listed and
will execute in the order that you added them).
– Modify the Execution Mode, Repeatable and Mandatory settings of each step
(see Steps [➙ 357] for an explanation of these parameters).

372
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Configuring Operating Procedures
15

7. In the Operating Procedures toolbar, do one of the following:

– Click Save , to save the configuration changes in the current operating

procedure.

– Click Save as , to save the configuration changes in a new operating

procedure.
Then, in the Save Object As dialog box:
a. Select the location in the tree (under System Settings > Operating
Procedures) where you want to save this operating procedure.
b. Type the Name and Description of the operating procedure.
c. Click OK.

15.4.5 Configuring an Operating Procedure Step

After you add a new step [➙ 371] to an operating procedure, you need to configure
that step. You can also modify the configuration of an existing procedure step.
 System Manager is in Engineering mode.
 A step is available under an operating procedure, and you want to configure it or
change its configuration.
1. In System Browser, select Management View.
2. Select Project > System Settings> Operating Procedures.
 The Operating Procedures list [➙ 352] displays in the Primary pane.
3. In System Browser, select the main Operating Procedures folder, or in a subfolder
under it. Then select the operating procedure and then select the procedure step
that you want to configure.
 The Operating Procedures workspace [➙ 358] displays in the Primary pane.
Depending on the type of step, this workspace will include one or more of these
expanders:
- General Settings (all steps)
- Additional Settings (all steps except Reno)
- Recipients and Message Tailoring (only Reno steps)
4. Open the General Settings expander [➙ 360] and configure the following
properties as required (see General Settings [➙ 360] for an explanation of these
step properties):
– Execution Mode (if available)
– Mandatory
– Repeatable
– (Optional) Edit Notes. Click the flag icon to display a field for each language
available in the system; edit the text for each language and click OK.

5. If the Additional Settings expander [➙ 361] is present, you can configure links to
resources that you want to display along with that procedure step (see Additional
Settings [➙ 361] for an explanation of how this works). Follow the specific
instructions for the type of step:

373
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Configuring Operating Procedures

– Configuring Additional Settings for an Alarm Printout Step [➙ 374]

– Configuring Additional Settings for a Document Step [➙ 375]
– Configuring Additional Settings for a Graphic Step [➙ 376]
– Configuring Additional Settings for a Report Step [➙ 379]
– Configuring Additional Settings for a Treatment Form Step [➙ 380]
6. If the Recipients and Message Tailoring expanders [➙ 369] are present (only for a
Reno step), follow the specific procedure (Configuring a Reno Step [➙ 377]) to
configure the remote notification.
7. In the Operating Procedures toolbar, do one of the following:

– Click Save , to save the configuration changes in the current procedure

step.

– Click Save as , to save the configuration changes in a new procedure step.

Then, in the Save Object As dialog box:
a. Select the location in the tree (under System Settings > Operating
Procedures) where you want to save this procedure step.
b. Type the Name and Description of the procedure step.
c. Click OK.

15.4.6 Configuring Additional Settings for an Alarm Printout Step

 System Manager is in Engineering mode.
 An Alarm Printout step [➙ 363] is available under an operating procedure.
 One or more event printout report templates are available in the Templates folder,
under the main Reports folder in the Application View of System Browser.
1. In System Browser, select the Alarm Printout step.
 The Operating Procedures workspace [➙ 358] displays in the Primary pane.
2. Open the Additional Settings expander [➙ 363].
 Fixed Links is the only available option and is selected by default.
3. To manually link resources, do the following:
– In System Browser, select Application View.
– Select Applications > Reports > Templates.
– Drag event printout report templates from the Templates folder and drop them
onto the Links area in the Primary pane.
4. To configure when and for what alarms the linked resources should display, from
the Links area, select the links and open the Filters expander [➙ 368]. Then do the
following:
– Open the Time and Organization Mode expander [➙ 295] and specify when
[➙ 297] (for example, dates, times of day, when the building is occupied, at
weekends) you want the resource to display.

374
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Configuring Operating Procedures
15

– Open the Events expander [➙ 298] and specify for what alarms [➙ 299] you
want the resource to display.
5. To configure the general behavior of the linked resources, from the Links area you
can do the following:
– Change the priority of the links in the step by selecting links in the list and
clicking Move Up or Move Down. (By default links are listed in the order that
you added them).
– Delete unwanted links in the step by selecting links in the list and clicking
Remove.
6. In the Operating Procedures toolbar, do one of the following:

– Click Save , to save the configuration changes in the current procedure

step.

– Click Save as , to save the configuration changes in a new procedure step.

Then, in the Save Object As dialog box:
a. Select the location in the tree (under System Settings > Operating
Procedures) where you want to save this procedure step.
b. Type the Name and Description of the procedure step.
c. Click OK.

15.4.7 Configuring Additional Settings for a Document Step

 System Manager is in Engineering mode.
 A Document step [➙ 364] is available under an operating procedure.
 One or more documents (document files or HTML pages) or document-related
items are available in the main Documents folder (or in a subfolder under it) in the
Application View of System Browser.
1. In System Browser, select the Document step.
 The Operating Procedures workspace [➙ 358] displays in the Primary pane.
2. Open the Additional Settings expander [➙ 364].
3. To configure the first document-related item available for the point that when in
alarm will trigger the operating procedure, select the Get link from related items
option. Then skip the next steps and go to the last step.
4. To manually link resources, do the following:
– Select the Fixed Links option.
– In System Browser, select Application View.
– Select Application > Documents.
– Drag documents from the Documents folder (or a subfolder under it) and drop
them onto the Links area in the Primary pane.
5. To configure when and for what alarms the linked resources should display, from
the Links area, select the links and open the Filters expander [➙ 368]. Then do the
following:

375
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Configuring Operating Procedures

– Open the Time and Organization Mode expander [➙ 295] and specify when
[➙ 297] (for example, dates, times of day, when the building is occupied, at
weekends) you want the resource to display.
– Open the Events expander [➙ 298] and specify for what alarms [➙ 299] you
want the resource to display.
6. To configure the general behavior of the linked resources, from the Links area you
can do the following:
– Change the priority of the links in the step by selecting links in the list and
clicking Move Up or Move Down. (By default links are listed in the order that
you added them).
– Delete unwanted links in the step by selecting links in the list and clicking
Remove.
7. In the Operating Procedures toolbar, do one of the following:

– Click Save , to save the configuration changes in the current procedure

step.

– Click Save as , to save the configuration changes in a new procedure step.

Then, in the Save Object As dialog box:
a. Select the location in the tree (under System Settings > Operating
Procedures) where you want to save this procedure step.
b. Type the Name and Description of the procedure step.
c. Click OK.

15.4.8 Configuring Additional Settings for a Graphic Step

 System Manager is in Engineering mode.
 A Graphic step [➙ 365] is available under an operating procedure.
 One or more graphic objects or graphic-related items are available in the main
Graphics folder (or in a subfolder under it) in the Application View of System
Browser.
1. In System Browser, select the Graphic step.
 The Operating Procedures workspace [➙ 358] displays in the Primary pane.
2. Open the Additional Settings expander [➙ 365].
3. To configure the first graphic-related item available for the point that when in alarm
will trigger the operating procedure, select the Get link from related items option.
Then skip the next steps and go to the last step.
4. To manually link resources, do the following:
– Select the Fixed Links option.
– In System Browser, select Application View.
– Select Application > Graphics.
– Drag graphics from the Graphics folder (or a subfolder under it) and drop them
onto the Links area in the Primary pane.

376
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Configuring Operating Procedures
15

5. To configure when and for what alarms the linked resources should display, from
the Links area, select the links and open the Filters expander [➙ 368]. Then do the
following:
– Open the Time and Organization Mode expander [➙ 295] and specify when
[➙ 297] (for example, dates, times of day, when the building is occupied, at
weekends) you want the resource to display.
– Open the Events expander [➙ 298] and specify for what alarms [➙ 299] you
want the resource to display.
6. To configure the general behavior of the linked resources, from the Links area you
can do the following:
– Change the priority of the links in the step by selecting links in the list and
clicking Move Up or Move Down. (By default links are listed in the order that
you added them).
– Delete unwanted links in the step by selecting links in the list and clicking
Remove.
7. In the Operating Procedures toolbar, do one of the following:

– Click Save , to save the configuration changes in the current procedure

step.

– Click Save as , to save the configuration changes in a new procedure step.

Then, in the Save Object As dialog box:
a. Select the location in the tree (under System Settings > Operating
Procedures) where you want to save this procedure step.
b. Type the Name and Description of the procedure step.
c. Click OK.

15.4.9 Configuring a Reno Step

 System Manager is in Engineering mode.
 A Reno step [➙ 369] is available under an operating procedure.
1. Open the Recipients expander [➙ 340], then open the Address Book section inside
that expander.
2. To choose the first-level recipient group(s) of the message, do the following:
a. In the Address Book area, filter by Groups, and use the search field if needed to
find the groups you want.
b. Drag-and-drop the group(s) you want to add from the Address Book area to the
Recipient/Members list on the left.
c. Select Groups, and filter the address book to narrow your search.
3. For each recipient group, you can optionally define escalation rules.
To define the escalation rules for a recipient group, do the following:
a. Select the group in the Recipient/Members list on the left.
b. In the Escalation Rules area on the top right, enter a Timeout and a response
Threshold for that group. This sets the number or percentage of group members
that need to reply within the specified time for that first-level group to be considered

377
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Configuring Operating Procedures

successfully notified.
c. To specify additional escalation recipients, to whom the message will be sent if
the group doesn’t reach its threshold:
– In the Address Book, filter by People, and use the search field if needed to
narrow down your choices.
– Drag-and-drop the individual recipient(s) you want to add from the Address
Book to the Escalation Recipient/Group/Timeout list.
– Alongside each escalation recipient, set the Timeout within which that person
must reply (default is 30 seconds).
– Specify the Escalation Threshold, defining how many (or what percentage of)
contacts in the escalation list have to reply for the group’s escalation to be
considered successful.
4. To compose the notification message, open the Message Tailoring expander, and
do the following:
a. Select the Language.
b. Select the Device. This is the method (email, pager, or SMS) that will be used to
send the message. It should be chosen to match the preferred/fallback devices
used by the intended recipients.
NOTE: When you select a device, also make sure that the corresponding service
[➙ 312] is configured and enabled on the management system.
c. Drag-and-drop any automatic tag(s) you want to use from the Message Tags list
into the Subject (only for the E-Mail device) and Body fields. Optionally, enter any
additional text.
d. If you want to send the message using more than one method (for example, you
want to be able to notify recipients by both email and SMS), repeat steps b and c
above for each communication method you want to use.
5. In the Operating Procedures toolbar, do one of the following:

– Click Save , to save the configuration changes in the current procedure

step.

– Click Save as , to save the configuration changes in a new procedure step.

Then, in the Save Object As dialog box:
a. Select the location in the tree (under System Settings > Operating
Procedures) where you want to save this procedure step.
b. Type the Name and Description of the procedure step.
c. Click OK.

378
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Configuring Operating Procedures
15

15.4.10 Configuring Additional Settings for a Report Step

 System Manager is in Engineering mode.
 A Report step [➙ 366] is available under an operating procedure.
 One or more report templates are available in the Templates folder, under the main
Reports folder in the Application View of System Browser.
1. In System Browser, select the Report step.
 The Operating Procedures workspace [➙ 358] displays in the Primary pane.
2. Open In the Additional Settings expander [➙ 366].
 Fixed Links is the only available option and is selected by default.
3. To manually link resources, do the following:
– In System Browser, select Application View.
– Select Applications > Reports > Templates.
– Drag report templates (for example, event detail log, activity log, and event log)
from the Reports folder and drop them onto the Links area in the Primary pane.
4. To configure when and for what alarms the linked resources should display, from
the Links area, select the links and open the Filters expander [➙ 368]. Then do the
following:
– Open the Time and Organization Mode expander [➙ 295] and specify when
[➙ 297] (for example, dates, times of day, when the building is occupied, at
weekends) you want the resource to display.
– Open the Events expander [➙ 298] and specify for what alarms [➙ 299] you
want the resource to display.
5. To configure the general behavior of the linked resources, from the Links area you
can do the following:
– Change the priority of the links in the step by selecting links in the list and
clicking Move Up or Move Down. (By default links are listed in the order that
you added them).
– Delete unwanted links in the step by selecting links in the list and clicking
Remove.
6. In the Operating Procedures toolbar, do one of the following:

– Click Save , to save the configuration changes in the current procedure

step.

– Click Save as , to save the configuration changes in a new procedure step.

Then, in the Save Object As dialog box:
a. Select the location in the tree (under System Settings > Operating
Procedures) where you want to save this procedure step.
b. Type the Name and Description of the procedure step.
c. Click OK.

379
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Configuring Operating Procedures

15.4.11 Configuring Additional Settings for a Treatment Form Step

 System Manager is in Engineering mode.
 A Treatment Form step [➙ 367] is available under an operating procedure.
 One or more alarm report templates are available in the Templates folder, under
the main Reports folder in the Application View of System Browser.
1. In System Browser, select the Treatment Form step.
 The Operating Procedures workspace [➙ 358] displays in the Primary pane.
2. Open the Additional Settings expander [➙ 367].
 Fixed Links is the only available option and is selected by default.
3. To manually link resources, do the following:
– In System Browser, select Application View.
– Select Applications > Reports > Templates.
– Drag alarm report templates from the Templates folder and drop them onto the
Links area in the Primary pane.
4. To configure when and for what alarms the linked resources should display, from
the Links area, select the links and open the Filters expander [➙ 368]. Then do the
following:
– Open the Time and Organization Mode expander [➙ 295] and specify when
[➙ 297] (for example, dates, times of day, when the building is occupied, at
weekends) you want the resource to display.
– Open the Events expander [➙ 298] and specify for what alarms [➙ 299] you
want the resource to display.
5. To configure the general behavior of the linked resources, from the Links area you
can do the following:
– Change the priority of the links in the step by selecting links in the list and
clicking Move Up or Move Down. (By default links are listed in the order that
you added them).
– Delete unwanted links in the step by selecting links in the list and clicking
Remove.
6. In the Operating Procedures toolbar, do one of the following:

– Click Save , to save the configuration changes in the current procedure

step.

– Click Save as , to save the configuration changes in a new procedure step.

Then, in the Save Object As dialog box:
a. Select the location in the tree (under System Settings > Operating
Procedures) where you want to save this procedure step.
b. Type the Name and Description of the procedure step.
c. Click OK.

380
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Configuring Operating Procedures
15

15.4.12 Enabling or Disabling an Operating Procedure

When you create an operating procedure, it is automatically enabled by default. This
means it will execute if an alarm occurs that meets its filter conditions. You can
enable/disable operating procedures from the Operation tab of the Contextual pane
(method 1). You can also enable/disable operating procedures from the procedure list
in the Primary pane (method 2).

NOTE:
When you disable an operating procedure, the management system generates an
event. This event is automatically cleared when you re-enable the operating
procedure.

Method 1 – Enabling/Disabling a Procedure from the Contextual Pane

 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings> Operating Procedures.
3. In the main Operating Procedures folder, or in a subfolder under it, select the
operating procedure that you want to enable or disable.
 The Operational Status (enabled/disabled) of the procedure displays in the
Operation tab of the Contextual pane.
4. In the Operation tab of the Contextual pane, click the Enable or Disable button.
 The Operational Status (enabled/disabled) of the procedure in the Contextual pane
updates accordingly.

Method 2 – Enabling/Disabling a Procedure from the Procedure List

 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings> Operating Procedures.
 The Operating Procedures list [➙ 352] displays in the Primary pane.
3. In the Primary pane, select the operating procedure that you want to enable or
disable, and do one of the following:
– To enable the operating procedure, select the Operational Status check box.
– To disable the operating procedure, deselect the Operational Status check box.
4. To save the changes, in the Operating Procedures toolbar, click Save .

381
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
15 Configuring Operating Procedures

15.4.13 Modifying the Priority of Operating Procedures

When an alarm occurs in the system, it may match the filter conditions of more than
one operating procedure. However, only one procedure at a time can execute in
Assisted Treatment, so in this situation the one with the highest priority will run. After
you have added and configured some operating procedures, you can quickly check
and adjust their relative priorities from the operating procedures list.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings> Operating Procedures.
 The Operating Procedures list [➙ 352] displays in the Primary pane.
3. Select an operating procedure in the list and do one of the following:
– Click Priority and enter a new value. (Zero is the highest priority. The system
won’t allow you to give the same priority to two procedures).
– Click Move Up or Move Down.
4. To save the changes, in the Operating Procedures toolbar, click Save .

15.4.14 Adjusting the Execution Order of Steps in a Procedure

After you configure an operating procedure with some steps, you can quickly adjust the
order of the existing steps, and some aspects of how they execute, from the Steps
expander [➙ 357] of the operating procedure.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings> Operating Procedures.
3. In the main Operating Procedures folder, or in a subfolder under it, select the
operating procedure whose steps you want to adjust.
4. In the Primary pane, open the Steps expander [➙ 357]. From here you can do the
following:
– Change the Execution Order of the steps in the procedure by selecting steps in
the list and clicking Move Up or Move Down. (By default steps are listed and
will execute in the order that you added them).
– Modify the Execution Mode, Repeatable and Mandatory settings of each step.
See Steps [➙ 357] for an explanation of these parameters.
5. To save the changes, in the Operating Procedures toolbar, click Save .

382
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Operating Procedures
Configuring Operating Procedures
15

15.4.15 Deleting Operating Procedures, Folders, or Steps

This procedure describes how to remove operating procedure folders, individual
operating procedures, or procedures steps.
NOTICE! You cannot delete the main Operating Procedures folder.
 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings> Operating Procedures.
 The Operating Procedures list [➙ 352] displays in the Primary pane.
3. In System Browser, under the main Operating Procedures folder, or in a subfolder
under it, select the object you want to delete (subfolder, operating procedure, or
procedure step).

4. In the Operating Procedures toolbar, click Delete object .

 A confirmation message box asks if you want to delete the selected item.
5. Click Yes to confirm the operation.
 The object is removed from System Browser.

383
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Event Settings
16 Configuring Operating Procedures

16 Event Settings
An event (or alarm) is a situation in the building control system that the operator either
needs to be aware of, or needs to respond to. Examples of alarms include: fire zone
alarm, intrusion sensor tripped, device failure, or camera loss of signal in some
specified part of the building.
In the Desigo CC client application, the operator's main starting point for monitoring,
viewing, and handling alarms is the Event List window. (However, the Summary bar,
Event Detail bar, and Event bar can also alert the operator to alarms.)
From Event List, the operator can directly send commands to handle the alarm (Fast
Treatment) or invoke a dedicated alarm-handling window (Assisted Treatment or
Investigative Treatment) for extra support.
Alarms are broadly grouped by building-control discipline (for example: Fire, Energy
Management, Building Automation), and by category (for example: Emergency, Fault).
Each discipline has an associated graphic icon, and each category has an associated
color indicating its severity. Categories typically correspond to the event lamps in the
Summary bar.

Manual Alarm Handling

When a new alarm comes in (that is, a new event displays in Event List), the operator
must handle it by sending a sequence of alarm-handling commands. A typical
sequence an operator performs to manually handle an alarm is:
1. Open Event List (if it is not already open).
2. Select the alarm (by clicking on its event descriptor). The operator also has the
option of invoking Investigative Treatment or (if available) Assisted Treatment to
facilitate handling the alarm.
3. Send the Acknowledge command.
4. Wait until the Reset command becomes available (this happens when the problem
is resolved and the event source is back to normal).
5. Send the Reset command.
6. (In some cases) Send the Close command. (When the alarm is closed, it means it
can be cleared from Event List).
The operator can also suspend (deselect) an alarm--to temporarily stop handling it--by
re-clicking its descriptor, or by clicking on some other alarm in the list. This might be
necessary in a situation where another, more important, alarm comes in. (If an alarm is
already fully handled (closed), then deselecting it clears it from Event List.

Automated Alarm Handling

In some situations (such as on unmanned Desigo CC stations, or with unskilled
operators) it can be useful to configure some of these steps so that they happen
automatically for certain alarms. For example, you might want to:
 Configure the Event List window so that it opens automatically, with the new
incoming alarm already selected.
 Automatically invoke Assisted or Investigative Treatment without the operator
having to do so manually.
 When the event is closed, automatically close the Assisted Treatment or
Investigative Treatment window, or automatically deselect the event so that it can
be cleared from Event List.

384
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Event Settings
Event Settings Workspace
16

To accomplish this, you can configure Desigo CC to partially automate the handling of
certain types of alarms. You do this by defining an automated alarm handling rule (in
the Management View of System Browser, under Project>System Settings>Client
Settings>Event Settings) that specifies:
 General Settings: What types of automated alarm-handling actions you want the
system to take.
 Filters: When (Time and Organization Mode) and for what kinds of alarms (Events)
you want the automated alarm handling to happen.
You can define multiple automated alarm handling rules, and assign them priorities to
determine which one should run in case of a conflict (an alarm that matches the filters
of two or more rules).
You can also specify whether the automated rule should apply throughout the
management system, or only to certain groups of users or stations.
Automated alarm handling is especially useful in the following scenarios:
 Unmanned clients (display stations, such as embedded monitors on the walls of
hospitals or airports) where Desigo CC normally displays a graphic, so that in case
of emergency it can automatically display the relevant alarm with its most important
details (typically, a floor plan graphic and live video). Unmanned clients do not
provide any alarm-handling function.
 Unskilled operators: In case of immediate threat to life or health (for example, a
Fire Life Safety event), automatically displaying a floor plan graphic (or video feed)
of the area where the alarm occurred enables even unskilled personnel to
understand and react to an emergency situation on the site. In this scenario, too,
Desigo CC automatically displays the relevant event with its most important details,
without requiring those operators to send any alarm-handling commands.

16.1 Event Settings Workspace

When you select Event Settings (under Client Settings in the Management View of
System Browser), a workspace opens in the Primary pane where you can configure a
new automated alarm handling rule. See Event Settings [➙ 384] for an overview of
automated alarm handling. You can also select an existing automated alarm-handling
rule to view or change its configuration.
Here you can specify:
 General Settings defining what types of automated alarm-handling actions you
want the system to take.
 Filters defining when (Time and Organization Mode) and for what kinds of alarms
(Events) you want this automated rule to apply.

Event Settings Toolbar

Icon Name Description
Save the Changes Saves any changes to the current automated alarm handling
rule.
Save Object as Save the configuration as a new automated alarm handling
rule.
Delete Object Deletes the current object.

385
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Event Settings
16 Event Settings Workspace

16.1.1 General Settings

The General Settings expander lets you set up the alarm-handling actions that you
want to automate.

Event Settings - General Settings

General Settings Fields

Item Description
Priority If an alarm occurs that matches the filter of more than one automated
rule, the priority (where 0 is the highest and increasing numbers denote
decreasing priority) determines which rule will run. You cannot assign
the same priority to two rules.
On new event The automated alarm handling actions the system will execute when an
alarm occurs that matches the filters of this rule:
 Do nothing: The operator must manually initiate handling of the
alarm.
 Open Event List: The Event List window opens automatically.
 Start Fast Treatment: The Event List window opens automatically,
with the alarm already selected.
 Start Investigative Treatment: The Investigative Treatment window
for the alarm opens automatically.
 Start Assisted Treatment: If available (that is, if an operating
procedure was configured), the Assisted Treatment window for the
alarm opens automatically only on the first management station
that handles the alarm. Instead, the Investigative Treatment
window opens automatically on the other management stations
configured for the automated alarm-handling rule.
On new higher During automated handling of an alarm, what happens if a new alarm
priority event comes in that matches a higher-priority rule.
 Do nothing: Alarm handling of the current event will continue.
 Switch to the new event: Alarm handling of the current event is
automatically suspended, and alarm handling of the new higher-
priority event automatically starts.
 Ask the user whether to switch: a message box asks the operator
whether to continue handling the current alarm or start handling the
new higher-priority alarm instead.

386
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Event Settings
Event Settings Workspace
16

Close treatment when When the system automatically closes alarm handling (Fast Treatment,
Assisted Treatment, or Investigative Treatment).
 Source returns to normal state: alarm handling automatically closes
when the event source is back to Quiet.
 Upon user request: the operator manually closes alarm handling
that was automatically started.
 Event is acknowledged: alarm handling automatically closes as
soon as the event is acknowledged.
 Event is reset: alarm handling automatically closes as soon as the
event is reset.
 Event is closed: alarm handling automatically closes as soon as the
event is closed.
 After a timeout: alarm handling automatically closes after a specific
interval of time (default 300 seconds). Selecting this option
activates the field where you can enter the timeout. In runtime, the
counter will start only when the event appears in Event List.
Group and station This automated alarm-handling rule will apply only to the groups of
filters users and/or stations (server, client, or FEP) selected here.
Select the Groups or Stations radio button to display a list of the
corresponding items on the left. Then move items to the Selected Items
list or vice versa by double-clicking them, or by using the arrow buttons.
If you don't set any Group and Station filters, the current alarm handling
rule will apply throughout the management system, to all user groups
and stations.
If you select multiple groups of users/stations, an OR logic will be
followed. That is, the current rule will apply to all the selected groups in
the list.
NOTE: Group and station filters do not have any effect on which
automated rule should run as this depends on the filters defined in the
Filters expander [➙ 387].

16.1.2 Filters
The Filters expander lets you configure when and for what alarms this automated
alarm-handling rule should run.
Specifically, you can define the following filters:
 Time and Organization Mode [➙ 295]: time-related conditions such as date ranges,
times, days of the week, or facility occupancy status.
 Events [➙ 298]: the type of alarm or combination of alarms.
There is an AND logic between the two filters. That is, if you specify a Time and
Organization Mode filter as well as an Events filter, the automated rule will run only
when the specified alarms occur at the specified times. If an alarm occurs that matches
the Filters of more than one rule, the one with the higher priority (lower number) will
run.

Event Settings – Filters Expander

387
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Event Settings
16 Setting Up Automated Alarm Handling

16.1.3 Event Settings Properties and Commands

When you select an automated alarm-handling rule under Event Settings, the
Operation tab in the Contextual pane shows the properties of the selected rule
(whether it is enabled or disabled, and its priority) and provides commands for enabling
or disabling it:
 Enabled: This automated alarm-handling rule will run if an event matching its filters
occurs.
The Disable command is available.
 Disabled: This automated alarm-handling will not run, even if a matching event
occurs.
The Enable command is available.

Event Settings Template - Operation Tab

An automated alarm-handling rule is automatically enabled when you create it. You
can later enable/disable [➙ 390] the alarm-handling rule from the Operation tab in the
Contextual pane.
When you click the Extended Operation tab, the alarm propagation status and other
properties display. For details about the following properties see General Settings
[➙ 386]:
 On New Event
 On New Higher Priority Event
 Close Treatment When
 Timeout

16.2 Setting Up Automated Alarm Handling

The following procedures describe how to set up automated alarm handling rules.

Configuration Workflow
1. Configure [➙ 389] an automatic alarm handling rule.
2. Activate [➙ 390] the rule.
3. If needed, adjust [➙ 391] the configuration of existing rules, disable [➙ 390] an
active rule, or delete [➙ 391] unwanted rules.

388
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Event Settings
Setting Up Automated Alarm Handling
16

16.2.1 Configuring an Automated Alarm Handling Rule

 System Manager is in Engineering mode.
1. In System Browser, select Management View.
2. Select Project > System Settings> Client Settings > Event Settings.
 The Event Settings interface [➙ 385] displays in the Primary pane.
3. In the General Settings expander, modify the default general parameters to set up
what alarm-handling actions you want to automate. See General Settings [➙ 386]
for an explanation of these parameters.
4. To configure when and for what alarms the rule should apply, open the Filters
expander. Then do the following:
– Open the Time and Organization Mode expander [➙ 295] and specify when
[➙ 297] (for example, dates, times of day, when the building is occupied, at
weekends) you want the automated rule to apply.
– Open the Events expander [➙ 298] and specify for what alarms [➙ 299] you
want the automated rule to apply.
– NOTE: There is an AND logic between the Time and Organization Mode and
Events filters. That is, both filters must be true for the automated rule to run.
If an alarm occurs that matches the Filters of more than one rule, the one with
the higher priority (lower number) will run.
5. In the Event Settings toolbar, do one of the following:

– Click Save , to save the configuration changes in the current automated

rule.

– Click Save as , to save the configuration changes in a new automated rule.

Then, in the Save Object As dialog box:
a. Select the location in the tree (under Client Settings > Event Settings) where
you want to save this automated rule.
b. Type the Name and Description of the automated rule.
c. Click OK.
 The new automated alarm handling rule appears in System Browser, and it is
enabled by default (you can enable/disable [➙ 390] it from the Contextual pane).

389
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Event Settings
16 Setting Up Automated Alarm Handling

16.2.2 Enabling or Disabling an Automated Alarm Handling Rule

Automated alarm handling rules are enabled by default when you create them. This
means they will run alarms occur that meets their filter conditions. If a rule is disabled,
then automated handling of alarms that match its filters will not start.
You can enable/disable operating procedures from the Operation tab of the Contextual
pane.

Enabling an Automated Alarm Handling Rule

 An automated alarm handling rule is currently inactive (its status in the Contextual
pane is Disabled), and you want to enable it.
1. In System Browser, select Management View.
2. Select Project > System Settings> Client Settings > Event Settings.
3. Under Event Settings, select the rule you want to enable.
4. To enable the rule, in the Operation tab [➙ 388] of the Contextual pane, click
Enable.
 The status of the current rule changes to Enabled.

Disabling an Automated Alarm Handling Rule

Disabling an automated alarm handling rule prevents it from being run, while still
retaining the rule within the system. For example, you might do this for rules that are
not yet complete or ready to be put into general use.
To disable an automated alarm handling rule, proceed as follows:
 The automated alarm handling rule is currently active (its status in the Contextual
pane is Enabled), and you want to disable it.
1. In System Browser, select Management View.
2. Select Project > System Settings> Client Settings > Event Settings.
3. Under Event Settings, select the rule you want to disable.
4. To disable the rule, in the Operation tab [➙ 388] of the Contextual pane, click
Disable.
 The status of the current rule changes to Disabled.

390
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Event Settings
Setting Up Automated Alarm Handling
16

16.2.3 Modifying an Automated Alarm Handling Rule

 System Manager is in Engineering mode.
 You want to edit or change an existing automated alarm handling rule.
1. In System Browser, select Management View.
2. Select Project > System Settings> Client Settings > Event Settings.
3. Under Event Settings, select the rule you want to modify.
4. In the Primary pane, click the Event Settings tab.
 The Event Settings interface [➙ 385] displays in the Primary pane.
5. If necessary, do one or more of the following:
– Open the General Settings expander [➙ 386], and modify its settings (for
details about these settings see General Settings [➙ 386]).
– Open the Filters expander [➙ 387] to modify when [➙ 297] and for what alarms
[➙ 299] this automated alarm-handling rule should run.
6. In the Event Settings toolbar, do one of the following:

– Click Save , to save the configuration changes in the current rule.

– Click Save As , to save the configuration changes in a new rule,.

Then, in the Save Object As dialog box, do the following:
a. Select the location in the tree (under Client Settings > Event Settings) where
you want to save this rule.
b. Enter the Name and Description of the rule.
c. Click OK.

16.2.4 Deleting an Automated Alarm Handling Rule

NOTICE! You cannot delete the main Event Settings folder.
 System Manager is in Engineering mode.
 One or more automated alarm handling rules exist in the project.
1. In System Browser, select Management View.
2. Select Project > System Settings> Client Settings > Event Settings.
3. Under Event Settings, select the rule you want to delete.
 The Event Settings interface [➙ 385] displays in the Primary pane.
4. In the Event Settings toolbar, click Delete object .
 A confirmation message box asks if you want to delete the selected item.
5. Click Yes to confirm the operation.
 The object is removed from System Browser.

391
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Documents
17 Setting Up Automated Alarm Handling

17 Documents
The management system lets you configure a set of reference documents that the
operator can consult.
These documents can be files (PDF, RTF, TXT. Note that Microsoft DOC and DOCX
formats are not supported) or web links (URLs of HTML pages). They will typically
contain instructions, procedures, or other information relevant to the operation of the
building-control site.
To configure a reference document set you must first manually copy the desired files
into the following path on the Desigo CC server station:
…\\GMSProjects\[Project]\documents.
(NOTE: You must do this in the Windows file system of the computer, not from inside
Desigo CC).
In the Application View of System Browser, under Applications > Documents you can
create documents (document objects) and associate them with copied files on the
Desigo CC server, or with web links. The documents created in this way can then be
viewed (in read-only mode) by:
 Selecting a document node in System Browser (the document displays in the
Primary pane).
 Selecting a document link in Related Items (the document displays in the
Secondary pane).
 Executing a document step in Assisted Treatment.

Make a Document Appear in Related Items

A document will appear as a Related Item of a system object if it is linked (associated)
to that object. To create such links manually, select a document and drag-and-drop
system objects into its Manually Linked field.
(In the graphics application, you can also place a document symbol in a graphic and
then use the coverage area feature to create Related Items links automatically. These
links display in the Automatically Assigned field in the documents application. For more
information about the coverage area, see the Graphics Editor manual A6V10380503 ).

Manage Document Objects

You can manipulate document objects as follows:
 Store document files in the project path.
 Create document folders.
 Configure document objects.
 Delete document objects and folders.
The specific tasks you can perform will depend on the application rights [➙ 104]
configured for your user group.

NOTE:
When you are working in Engineering mode and select a Document object or folder in
the Application View of System Browser, the Documents workspace opens in the
Primary pane, automatically set to Edit mode . From here, you can work with
documents as described in the relevant workflow in the User Guide (A6V10376160 ).

392
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Documents
Documents Configuration Workflow
17

17.1 Documents Configuration Workflow

1. Before you can create document objects in the management system, you must first
prepare any files (PDF, RTF, or TXT) you plan to use and store them in the
…\\GMSProjects\[Project]\documents path on the Desigo CC server station
[➙ 393].
2. (Optional). If you want to organize your document objects into different folders, set
up [➙ 394] the folder structure for storing documents under the main Documents
folder.
3. Create a new document object and configure its settings [➙ 394]. (The settings
specify the file or web link associated with that document object, and the linked
system objects for which this document will be a related item.)
Repeat this step for all the document objects you need to create.
4. (Optional). If necessary, delete [➙ 395] an individual document object, delete
[➙ 395] a document folder (and all the document objects inside it) [➙ 337], or edit
the settings [➙ 394] of an existing document object.

17.2 Configuring Documents

The following procedures describe Documents configuration tasks.
 See the relevant sections in the User Guide (A6V10376160) for more information
about the following configuration tasks: creating a new document from an existing
one, modifying/deleting an existing document, creating/modifying a document
related item, and zoom in/out or print a PDF file.
 See the relevant section in the Graphics Editor manual (A6V10380503 ) to
associate system objects to a document using the coverage area tool.

17.2.1 Storing Document Files in the Project Path

 You have prepared the files (PDF, TXT, RTF) that you want to use in the
Documents application.
1. Browse the file system on the Desigo CC server station, and locate the documents
folder at the following path:
…\\GMSProjects\[Project]\documents
2. Copy the files you want to use into this folder.

NOTE:
The files you store here will be accessible only in read-only mode in the Documents
application. That is, they cannot be edited from within Desigo CC.
If you want to modify their content, you must edit them using the appropriate separate
applications (such as a text editor, a PDF creator, and so on) and save them again
into this folder.

393
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Documents
17 Configuring Documents

17.2.2 Setting up the Documents Folders Structure

You can save all your documents directly in the main Documents folder. Alternatively,
you can create subfolders under the main Documents folder to better organize the
documents.
 System Manager is in Engineering mode.
 You want to add one or more subfolders under the main Documents folder.
1. In System Browser, select Application View.
2. Select Applications > Documents.
 The Documents workspace displays in the Primary pane.
3. In the Documents toolbar, click Add New .

4. In the Create New Object dialog box, enter the Name and Description and click
OK.
 The new document folder appears in System Browser.
5. Repeat steps 3-4 for all the subfolders folder required.
6. To add a nested subfolder, select a document subfolder under the main
Documents folder, and repeat steps 3-4.

17.2.3 Configuring a Document Object

 You previously stored [➙ 393] a set of document files in the appropriate project
folder.
 System Manager is in Engineering mode.
1. In System Browser, select Application View.
2. Do one of the following:
– To create and configure a new document object, select Applications >
Documents (or any subfolder under it).
– To configure an existing document object, select any document object under
Documents (or under one of its document subfolders).
 The Documents workspace displays in the Primary pane.
3. In the Document settings configuration box, enter the web link or select the file that
you want to associate with the document object. Do one of the following:
– Choose the Web URL option and enter an HTML page URL. The document
object will be associated with this web link.
– Choose the Select a file option, and select one of the available files from the
list. The document object will be associated with this file.
4. Click Preview.
 The selected document displays in the preview area.
5. Drag-and-drop any object(s) you want to associate with this document from any of
the System Browser views to the Manually assigned field. (To remove any linked
objects, select them and click Delete).
NOTE: If you need to select an object from a view that is different from Application

394
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Documents
Configuring Documents
17

View, remember to first select the Manual Navigation check box in System Browser
to freeze the Primary pane.
6. In the Documents toolbar, do one of the following:

– To save the settings to the existing document object, click Save .

– To save the settings into a new document object, click Save as .

Then, in the Save Object As dialog box:
a. Select the location in the tree (under Applications > Documents) where you
want to save this document.
b. Type the Name and Description of the document.
c. Click OK.
 The new document object displays in System Browser.
To view the document as it will appear to the operator, do the following:
 In the Documents toolbar, click Operate .
 The Documents workspace switches to Operate mode.

 To go back to configuring the settings of the document object, click Edit .

17.2.4 Deleting a Document Object or Folder

NOTICE! You cannot delete the main Documents folder, under Applications.
 At least one document object is available in System Browser.
 System Manager is in Engineering mode.
1. In System Browser, select Application View.
2. Under Applications > Document., select the document folder or document object
that you want to remove.
 The Documents workspace displays in the Primary pane.
3. In the Documents toolbar, click Delete .
 A confirmation message displays asking if you want to remove the selected
item.
4. Click Yes to confirm the operation.
 The object is removed from System Browser. If you deleted a document folder, any
document objects contained inside it are also removed.

395
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Troubleshooting
18 Overview of Trace Viewer

18 Troubleshooting

18.1 Overview of Trace Viewer

To help resolve technical issues, Desigo CC comes with a troubleshooting tool called
Trace Viewer that you can use to track various problems such as authorization or
licensing errors, BACnet timeouts, alarm manager issues, general communication
errors, and other system problems.
By default, the Trace Viewer logs activity in a log file stored in the C:\GMSProjects\
[customer-created folder name during installation]\Log folder. You can also create your
own log file and specify that system activity be logged to it instead. Trace Viewer
consists of two tabs.

Settings Tab
The Settings tab allows you to select the type of activity you want to track, such as
error messages, warnings, informational messages, or debug traces. In the Modules
section of this tab, you select the system components that you want to trace. If you are
receiving error messages in your system, and you’re not sure which module to select
for tracing, contact your Technical Support representative for additional help.

Traces Tab
The Traces tab displays system activity based upon your selections in the Settings tab.
This information is stored in the log file, which you can send using email to Technical
Support so that they can help you troubleshoot the problem(s).

How to Use Trace Viewer

For step-by-step instructions on using the Trace Viewer, see Using the Trace Viewer
[➙ 396].

18.1.1 Using the Trace Viewer

1. Select Start > All Programs > Desigo CC > Tools > Desigo CC Trace Viewer.
2. In the Settings tab, Prios section, check the WARNING, INFO, and DEBUG check
boxes.
3. In the Miscellaneous section, check the Show native PVSS traces check box.
4. Click the Disabled button.
5. Unless you have a custom log file that you want to use, accept the default scan file
(log file), PVSS_II.log.
6. In the Modules section, select the components you want to troubleshoot, and then
click Enable.
7. Click the Traces – PVSS_II.log tab.
 Depending on your module selections, you may see traces immediately in the
Trace Viewer. For other modules, such as the Scheduler, you may need to
select the schedule object in System Browser that is producing errors before
the Trace Viewer starts logging data about it.
8. Navigate to the location of the log file—C:\GMSProjects\ [customer-created folder
name during installation].

396
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Troubleshooting
Troubleshooting BACnet Driver
18

9. Copy the file, and then send it using email to Technical Support so that they can
help you troubleshoot the problem(s).

18.2 Troubleshooting BACnet Driver

Setting debug levels on the BACnet Driver can be very useful in collecting traces for
resolution of issues in collaboration with field support.

18.2.1 Overview of Debug Flags Used to Trace BACnet Problems

Occasionally, problems can develop related to BACnet, and in these cases, you can
use the following debug flags on the BACnet driver to help trace the issue. The traces
will help you and technical support come to a quicker resolution.
The debug flags are case-sensitive, and you can combine as many as you like to
provide specific traces.
For example, you can trace one flag: -dbg Alarm
Or, you can specify two or more: -dbg Alarm -dbg COV -dbg Trend
Notice that the example with multiple trace flags requires a space between each entry.

Debug Flag Description

-dbg Alarm Shows all incoming alarms and all outgoing
alarm ACKs.
-dbg COV Shows all incoming COVs and COV
registrations and polling.
-dbg File Shows activity of BACnet backup and restore.
-dbg Trend Shows trend collection information.
-dbg Ping Shows pinging of all devices in 10-second
intervals and shows device failures and
returns.
-dbg Istyle Shows outgoing Istyle commands from bubble
and clients.
-dbg Service Shows sending of dpSets/ dpGets and some
communication between Discovery.
-dbg 2 Shows PVSS driver framework debugs.
-dbg 10 Shows active COV subscriptions every 1
minute.
-dbg 11 Shows active alarm list every 1 minute.
-dbg 25 Shows all BACnet service communication
(RPM, RP, WP, etc.).
-dbg 26 Shows most of –dbg 25 items, plus some
developer bugs.
-dbg 27 Shows some performance counters.

For the procedure to use the debug flags, see Using Debug Flags to Trace BACnet
Problems [➙ 398].

397
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Troubleshooting
18 Troubleshooting Backup and Restore

18.2.2 Using Debug Flags to Trace BACnet Problems

1. Select Start > All Programs > Siemens Automation > Runtime System > WinCC
OA Vx.yy > WinCC OA Console.
2. Right-click GMS BACnet Driver.
3. Select Activate debug-flag(s).
4. Enter the desired debug parameter from Overview of Debug Flags Used to Trace
BACnet Problems [➙ 397].
5. Click OK.
 The trace information displays in the Log Viewer.

18.3 Troubleshooting Backup and Restore

18.3.1 Data Lock During Backup Activities

Desigo CC can prevent concurrent configuration activities that may result in
inconsistent project data. If you are performing activities such as:
 Object creation and deletion
 Modifications to existing configuration data
 Import (libraries, devices, and so on)
while a backup is in progress, a warning message informs you that the operation you
want to do cannot be executed because data is locked by another process.
 Wait until the backup process is completed and try again.
If you try to backup data during the import, the system will continue to launch the
backup process until it succeeds.

398
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Troubleshooting
Troubleshooting Printout Problems
18

18.4 Troubleshooting Printout Problems

18.4.1 Line Printer does not Print a Desired Language

The following are two causes due to which the line printer does not print in a desired
language:
 Line printer firmware does not support the character set for the language you want
to print.
 System locale is not set to the desired language.
You must ensure the following:
 The line printer firmware supports the character set for the language you want to
print. For example, if you want to print in Chinese, ensure that the line printer has
the character set that supports Chinese characters and select it. To verify if the line
printer supports the character set for the language, you must print the default
settings of the line printer as they contain all the character sets supported by the
line printer.
 The system locale is set to the desired language. To perform this, complete the
following steps:
1. From the Windows Start menu, select Control Panel > Region and Language.
– The Region and Language dialog box displays.
2. From the Administrative tab, click Change system locale.

– The Region and Language Settings dialog box displays.

3. From the Current system locale drop down, select the desired language, for
example, Chinese (Simplified, PRC).
– A message for restarting the computer displays.

399
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Troubleshooting
18 Troubleshooting Printout Problems

4. Restart the computer to apply the changed settings.

 The system locale is set to the desired language, in this case Chinese.

18.4.2 Error Codes and their Meaning in Journaling

Code Meaning
0 Command executed successfully
1 Configured printer is not a page printer
2 Printer has no cached events for Journaling
3 Printer is not available for printing
4 Printer name is invalid or printer does not exist
5 Printer template is invalid
6 Journaling object not found to execute command
7 No Printer is configured with Journaling object
9 Unknown error

400
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
 Index

Index
A R
Alarms Classes, 35 remote notifications
email service, 314
C email service connection test, 314
Client Profiles, 35 pager connection test, 330
pager device, 330
D pager protocol, ESPA 4.4.4, 330
Driver
pager, protocol, TAP, 330
Full and configuration mode, 177
paging service, 330
E remote notifications configuration, 311
Event Schemas, 35 SMS service, 323
SMS service connection test, 323
F
field panel database S
migration paths, 215 station type
FEP, 33
I Server, 33
import Web Server, 33
SiB-X file import (BACnet), 215 system limits
hardware category, 29
L
license U
engineering license, 21 UL 864
Journaling Line Printer, 63, 253
M Journaling Template, 252
migration paths, 215
Auto-Discovery, 215 V
SiB-X Export, 215 views
Applications View, 121
N Logical View, 121
networks
Management View, 120
BACnet devices, 188
Physical View, 122
P User-defined Views, 122
Page Setup Parameters
W
Configuring Fonts, 268
workstation type
Configuring Language Settings, 273
Client, 33
Configuring Margins and Paper Orientation, 267
Web Client, 33
Configuring Page Footers, 271
Configuring Page Headers, 269
Configuring Paper Types, 266
Customizing Messages, 273
Physical Port
Guidelines on configuring more Drivers, 172

401
Siemens Industry, Inc. Engineering Manual Version 2.1 A6V10376170_en_a_21
Building Technologies 2015-07-28
Issued by © Siemens Industry, Inc., 2015
Siemens Industry, Inc. Technical specifications and availability subject to change without notice.
Building Technologies Division
1000 Deerfield Pkwy
Buffalo Grove IL 60089
Tel. +1 847-215-1000

Document ID A6V10376170_en_a_21 A5Q00053868

Edition 2015-07-28