User Guide

ManualsBrandsSiemens ManualsBuilding automationDesigo CC MP 5.0 BACnet Server, BACnet Protocol Implementation Conformance Statement (PICS), Basic Documentation

A6V10415471_en_a_21

Building Technologies

2015-07-15

Desigo™ CC

User Guide Version 2.1

Summary of content (398 pages)

PAGE 1
Desigo™ CC User Guide Version 2.
PAGE 2
Copyright Notice Copyright Notice Notice Document information is subject to change without notice by Siemens Switzerland Ltd. 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 Switzerland Ltd.
PAGE 3
Table of Contents About this Document ...................................................................................................... 11 Document Revision History ............................................................................................... 15 1 Introduction....................................................................................................... 16 2 User Interface ...................................................................................................
PAGE 4
.3.1 Point Centered Mode .......................................................................... 49 4.3.2 Status and Commands Overview ....................................................... 50 4.3.3 Viewing Graphic Objects ..................................................................... 50 4.3.4 Viewing a Coverage Area ................................................................... 52 4.3.5 Zooming and Panning .........................................................................
PAGE 5
6.3.5 Handling a Manual Alarm-based Remote Notification ...................... 140 6.3.6 Editing, Sending, and Handling a New Remote Notification............. 141 6.3.7 Acknowledging Remote Notifications ............................................... 142 7 Scheduler ........................................................................................................ 143 7.1 Overview of Scheduler ..................................................................................... 143 7.
PAGE 6
8.5.16 8.6 8.7 8.8 8.6.1 Creating Offline Trendlog Object ...................................................... 202 8.6.2 Creating Offline Trendlog Multiple Object ......................................... 202 8.6.3 Upload Offline Trendlog Data Manually ............................................ 203 8.6.4 Automating Execution for Upload Trendlog Data ............................. 204 8.6.5 Assigning or Replacing a New Trendlog Reference ......................... 206 8.6.
PAGE 7
9.5 Creating a New Report Definition ..................................................................... 262 9.6 Managing Reports Folders ............................................................................... 263 9.7 Configuring a Report Definition ........................................................................ 263 9.7.1 Inserting a Table ............................................................................... 263 9.7.2 Inserting a Plot ....................................
PAGE 8
9.21.4 9.22 Working with Reports for Operating Procedures .............................. 299 Examples .......................................................................................................... 300 9.22.1 Objects Report .................................................................................. 301 9.22.2 Activities Report ................................................................................ 304 9.22.3 Event Details Report .............................................
PAGE 9
12.2.2 Disabling a Reaction ......................................................................... 355 13 Address Book ................................................................................................. 356 13.1 Address Book Workspace ................................................................................ 357 13.2 Working with the Address Book ....................................................................... 359 13.2.1 Importing Contacts to the Address Book ..........
PAGE 10
16.1 Project Backup ................................................................................................. 385 16.1.1 16.2 Manual Project Backup ..................................................................... 386 History Database .............................................................................................. 388 16.2.1 Backing up Data ................................................................................ 388 16.2.2 Automating Data Backup .....................
PAGE 11
About this Document Document Revision History About this Document Purpose This manual describes the features of the Desigo CC management station. It provides casual users with in-depth reference information for the different system features, including workflows, and is designed to support users in their daily siterelated monitoring and controlling activities. Scope This document applies to Desigo CC Version 2.1. Target Audience End-Users are the primary users of the system.
PAGE 12
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.
PAGE 13
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 procedure with sequential steps. 1. Turn OFF power to the field panel. 2. Turn ON power to the field panel. 3. Open the panel. One-step procedures are indicated by a bullet point.
PAGE 14
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.
PAGE 15
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 a 2015-07-15 Market Release Edition 15 Siemens Building Technologies User Guide Version 2.
PAGE 16
1 Introduction 1 Introduction The Desigo CC management station presents a single face to the customer for building automation, fire safety and security systems, or a combination thereof. Offering scalability of all configurations and allowing need-based expansion from small and medium to large and complex systems, Desigo CC provides customer and market-specific solutions. 16 Siemens Building Technologies User Guide Version 2.
PAGE 17
User Interface 2 2 User Interface The exact screen layout will vary depending on your particular system’s configuration, and you may not see all the components described. Item Name Description 1 Summary bar The main point of entry to all the functions of the software. Provides an overview of the events in the system.
PAGE 18
3 System Manager Navigation Bar 3 System Manager System Manager is a multi-pane window for navigating, monitoring, and controlling all the components and subsystems of your site. For example, you can inspect properties and states of objects, send commands, browse the architecture of the installation, consult floor plan graphics, and so on.
PAGE 19
System Manager Navigation Bar   3 any commands/actions available for that object. Related Items tab (middle): Provides links to additional resources (for example, reports or alarm-handling procedures) that are relevant to the selected object. If you click on a related item it opens by default in the Secondary pane. (You can also opt to direct Related Items to the Primary pane instead.) Detailed Log (right side): Lets you view a detailed history log about the selected object, and handle the log data.
PAGE 20
3 System Manager Navigation Bar The following sections describe the most common applications included in System Manager. 3.1 Navigation Bar The Navigation bar displays at the top of System Manager [➙ 18] and allows you to navigate the system without having to make selections in System Browser. It contains a set of icons, and a Breadcrumbs path that shows your current location as a series of links separated by arrows. The Back and Forward icons let you quickly return to recently-viewed selections.
PAGE 21
System Manager System Browser 3 following keyboard shortcuts: ALT + Left Arrow (Back) ALT + Right Arrow (Forward) CTRL + H (History).  The selected view displays in the Primary pane. 3.1.2 Setting the Favorite Location  The Navigation bar in System Manager is open. 1. If the Navigation bar is not open, in System Manager click the Open Navigation Bar icon . 2. In System Browser, select the node you want to use as your Favorite location. 3.
PAGE 22
3 System Manager System Browser subdisciplines. Clicking the Search button starts the search and displays the results of your filter selections. Search results for both the searching and filtering features are sorted by path, using grouping, and by the name within each group. For example, a search for objects located in the east wing of the 92nd floor in your building could produce results similar to the following: Willis Tower\Floor 92\East Wing\ EastWingTemp EastWingDailyTrend EastWingWeeklySchedule Eas
PAGE 23
System Manager System Browser 3 Making Object Selections System Browser offers you the following two methods for making objects the primary selection in System Manager:  Automatic Selection (default): For selecting a single-object, you click the object, and it then automatically becomes the new primary selection in System Manager. For selecting multiple objects, you press and hold the CTRL key or the SHIFT key while highlighting the objects.
PAGE 24
3 System Manager System Browser of both names and descriptions. The box consists of an editable field where you enter search strings, including wildcards. You can perform a search by name or description, depending on the setting of the Display mode. You start a search by entering text and then either pressing ENTER or clicking the Search icon. The matching results display in the list area. The dropdown arrow displays a list of your saved searches. 3.2.3 3.2.3.
PAGE 25
System Manager System Browser 3.2.3.2 3 Searching for Objects 1. In the Search list box, enter the name of the object you want to search for. You can use wildcarding when performing a search. 2. Click the Search icon 3.2.3.3 . Filtering Searches  You want to filter a search to limit the results that your search returns, and you have already entered text in the Search list box. 1. Click the Filter icon . 2.
PAGE 26
3 System Manager Textual Viewer 3.3 3.3.1 Textual Viewer Overview of Textual Viewer Textual Viewer displays the details for one or more objects in the building control system. For example, after you select one or more objects from System Browser, Textual Viewer displays their common properties in list form. Your selections can be either implicit or explicit. An implicit selection occurs when you click a parent object that has child objects associated with it.
PAGE 27
System Manager Textual Viewer 3 Item Description 1 Object Displays a list of objects in the system. A bolded object indicates a parent object, with associated children objects. 2 Title Bar Displays the name of the object with the primary selection. If you select multiple objects, the name of the first object you selected will display. If you select a parent object, you implicitly select the children objects belonging to the parent as well. In this case, the parent object displays in the title bar.
PAGE 28
3 System Manager Textual Viewer 3.3.2.1 3.3.3 3.3.3.1 Customize Columns Dialog Box Item Description 1 Available Columns Displays a list of columns not currently shown in Textual Viewer. 2 Movement Arrows Allow you to move columns to control whether they are hidden or shown. 3 Visible Columns Displays a list of columns that will show in Textual Viewer. 4 Selection Buttons Move up & Move down: Allow you to rearrange the order in which columns display.
PAGE 29
System Manager Operation/Extended Operation 3 3. To add columns to the Visible list, select one or more headings from the Available list, and then click the active arrow to move the headings. 4. Use the Move up and Move down buttons to arrange the order of the columns. 5. Click the OK button to accept the changes. 6. Click the Cancel button to cancel the changes. 3.3.3.
PAGE 30
3 System Manager Operation/Extended Operation           Acknowledge Change command priority Coldstart Enable/disable On/Off In service/Out of service Override/Release Reset value for equipment runtime Set a new point value Upload Display of Properties Properties display in one of two ways—automatically or manually. They display automatically when a property goes into an off-normal state, and they display manually when you select an object(s) in the system.
PAGE 31
System Manager Operation/Extended Operation 3 Priority Array, the system overwrites the present value with the newly commanded value. You can command or relinquish any priority level that you have access to, based on your user privileges. The following table shows the Command Priority Array: Priority Level 3.4.1.
PAGE 32
3 System Manager Operation/Extended Operation The following graphic shows that you have clicked the triangular icon. The system now displays two additional rows, which represent two selected objects of the same type. 3.4.1.5 Propagation Propagation means relaying Common Status information up the building control system's hierarchical tree. Information that is relayed up the hierarchy as a result of a change in the Common Status of an object is called status propagation.
PAGE 33
System Manager Operation/Extended Operation 3 Item Description 1 Property Name Displays the name of one or more properties associated with the selected object(s). If you select multiple objects of the same type in the system, the icon next to the property name indicates this with a triangular symbol in the lower righthand corner. Clicking this symbol expands the table row to show all of the selected objects of the same type that share this property.
PAGE 34
3 System Manager Operation/Extended Operation command. During the command, the Command Feedback area displays Command in Progress, along with information about how many objects have been commanded and how many will be commanded all together. After a command execution is complete, successful commands display Property Name successful. Failed commands display Command failed. 7 3.4.3 3.4.3.1 Send Button The Send button displays only for commands that require additional arguments.
PAGE 35
System Manager Related Items 3  The system displays the status of the command. 3.5 3.5.1 Related Items Overview of Related Items Related Items displays objects related to the currently selected object. Each related item is assigned a group name that represents the object's type—for example, graphics, trends, reports, or schedules. Navigation You can navigate to a view of each related item by clicking on the item.
PAGE 36
3 System Manager Related Items Maintenance of User Preferences Related Items stores the settings of the Group and Ungroup views and the Links and Icons views for each object that you interact with so that you do not need to continually adjust your settings as you navigate from one object to the next. Related Items Restrictions Be careful about deleting and then re-adding points in your system since this can break the links in Related Items.
PAGE 37
System Manager Recently Viewed 3.5.3 3.5.3.1 3 Working with Related Items Viewing a Related Item  You have selected an object with Related Items.  From Related Items, click the item you would like to view—for example, click a New Report, a Schedule, a PDF file, or a URL.  The management station opens the representation for the selected item in the Secondary Pane (or in the Primary pane if the Primary pane splitting is locked). 3.5.3.
PAGE 38
3 System Manager Recently Viewed 3.6 3.6.1 Recently Viewed Recently Viewed is a navigation aid housed in the Selection pane that lets you quickly return to a recently-visited view in the Primary pane. To access Recently Viewed, click its stacked tab at the bottom of the Selection pane. You will see a history of the 20 most recent views in the Primary pane, displayed as either thumbnails (snapshots) or links. Click on a thumbnail or link to jump back to that view in the Primary pane.
PAGE 39
System Manager Recently Viewed 3.6.2 3 Working With Recently Viewed The Recently Viewed [➙ 38] feature lets you return to a previously visited view in the Primary pane. 1. In the Selection pane, click the Recently Viewed tab.  Recently Viewed displays showing a history list of the recently visited views in the Primary pane. Click the Links/Thumbnails button to switch between displaying the recent items as snapshots or text links. 2.
PAGE 40
4 Graphics Overview of Graphics 4 Graphics 4.1 Overview of Graphics The Graphics application allows you to, view and command (Graphics Viewer), create (Graphics Editor), and store (Graphics Library Browser) large graphics representing equipment, floors, buildings, facilities, and entire campuses. These graphical representations can contain dynamic elements to represent devices or values you want to monitor or control.
PAGE 41
Graphics 4 Overview of Graphics Graphics Editor The Graphics Editor is the Graphics component that, with the appropriate security rights, allows you to create and modify simple and dynamic graphical representations of your devices, facility, campus, or equipment. The Graphics Editor also allows you to test and simulate your dynamic graphics before going online with them. Graphics, Symbols, and Graphic Templates are all created in the Graphics Editor.
PAGE 42
4 Graphics Overview of Graphics 4.1.3 Graphics Viewer: Operating and Engineering Mode The following table describes the Graphics Viewer behavior according to the Graphics window mode. Graphics Viewer window mode Graphics Viewer application behavior Operating   Engineering   4.1.4 The Graphics Viewer displays – In the Default tab of the Primary pane. – The Textual Viewer tab displays and is available in the Primary pane. Can create, open, and edit graphic files.
PAGE 43
Graphics Overview of Graphics 4.1.5 4 Graphics Editor - Operating and Engineering Mode The following table describes the Graphics behavior according to the Graphics window mode. NOTE : In addition to having a Graphics Editor license, you must also have Graphic Editor Application rights to create, edit, or delete a Symbol or Template Graphic. Graphic Editor level access is defined by the Security application.
PAGE 44
4 Graphics Overview of Graphics Graphics Library Browser If you have access rights for the Graphics Library Browser, you can navigate to and display Symbols and graphic templates in the Graphics Viewer, as well as the user’s ability to create and modify them in the Graphics Editor. Access 4.1.7 If Enabled Show You can view Symbols and Graphic Templates in the Graphics Viewer and the Graphics Editor.
PAGE 45
Graphics Navigation in Graphics 4.1.8 4 User Settings Overview Graphics Viewer The following user settings are automatically saved when you exit out of the Graphics Viewer.  The Auto zoom selection is maintained. Graphics Editor The Graphics Editor allows you to retain your user settings applied to layout, views, and values. Therefore, when you exit and re-enter the application, your settings do not change. User settings are stored in the user’s Windows Temp Folder, c:\Users\[username]\AppData\Local\
PAGE 46
4 Graphics Navigation in Graphics 2. To switch to Engineering mode in the Graphics Editor, click the button.  The Graphics Editor switches to and displays in the Graphics pane. The Object Configurator tab also displays. 3. To return to the Graphics Viewer from Engineering mode, click the Edit .  The Graphics Viewer displays in Engineering mode, in the Primary pane. To Access the Graphics Editor in Engineering Mode  You are in the Graphics Viewer in Engineering mode. 1.
PAGE 47
Graphics Navigation in Graphics 4 properties can be dragged over to the Graphics Editor or onto another application pane or view that accepts drag source. Drop Target All text or field boxes in the Graphics Editor are valid drop targets for the data point reference nodes. Generally, the data point references are dropped into the Expression field of the Evaluation Editor or used in the Animation Symbol for a substitution.
PAGE 48
4 Graphics Overview of Graphics Viewer 4.2.2.1 Drag-and-Drop Cursor Image You can drag any item displayed in the Symbol Browser , Graphics Viewer, and Contextual pan--including a search result—to the Graphics Editor, if you have the application and licensing right to the Graphics Editor. Objects in the Graphics Viewer are always a drag source, and the Graphics Editor is a drag source and drag-target. Both support selecting both single and multiple items.
PAGE 49
Graphics Overview of Graphics Viewer            4.3.
PAGE 50
4 Graphics Overview of Graphics Viewer Point Centered Mode button from the Graphics Viewer toolbar to center the point in the viewport. The feature is disabled by selecting the button again. While in Point Centered mode, you cannot pan the object. However, you can select any zoom factor without affecting centering in the viewport or you can select another Symbol to shift the focus to another object or Symbol. 4.3.
PAGE 51
Graphics Overview of Graphics Viewer 4 assigned a group name that represents the object's type, for example, graphics, trends, reports, or schedules. If you left-click a Symbol on a graphic or, the referenced object of the Symbol becomes the secondary selection, while the primary selection remains the same in System Browser. The following figure illustrates the primary selection in System Browser, Analog Output 1.
PAGE 52
4 Graphics Overview of Graphics Viewer When you select an object from System Browser that is associated with a graphic, the Graphics Viewer displays the representative graphic and the object’s associated Symbol on the graphic is selected. As a result, the Operations tab displays the object properties to correspond to the selection. Double-clicking a Symbol on a graphic makes the referenced object associated with the Symbol the primary selection in System Browser, and all workflows update accordingly 4.3.
PAGE 53
Graphics Overview of Graphics Viewer 4 the monitoring object. For example, if the monitoring object is a camera, the heading displays "Camera" in the Related Items tab. 4.3.5 4.3.6 Zooming and Panning The Graphics Viewer supports zooming and panning within the active graphic. Zooming allows you to magnify or reduce the graphic image, and panning allows you to move the graphic around on the canvas. In zooming mode, you can left-click and drag a rubberband rectangle around any area of the graphic.
PAGE 54
4 Graphics Overview of Graphics Viewer more than one related graphical item. Previous Related Item Allows you to scroll to and display the previous graphical Related Item associated with the selected datapoint in System Browser. Only enabled if the datapoint has more than one related graphical item. Zoom In (+20%) Allows you to zoom in by + 20% on the active graphic with each mouse click. Zoom Out (-20%) Allows you to zoom out by - 20% on the active graphic with each mouse click.
PAGE 55
Graphics Overview of Graphics Viewer 4 with a layer. 4.3.6.2 Show Status and Command Pane Allows you to enable or disable the Status and Command pane from displaying. Coverage Area Mode When this icon is enabled, it allows you to view the coverage areas on the graphic. When disabled, no coverage areas display on the graphic. Page Setup Displays the Page Setup view for the current graphic. Print Displays the Print dialog box to print the current graphic.
PAGE 56
4 Graphics Overview of Graphics Viewer Navigation View 4.3.6.3 Item Description 1 Selected Depth Displays the active depth. Use the drop-down menu to select from a list of available depths. 2 Filtering Allows you to select how to filter the layers associated with the selected depth. You can filter the layers by Discipline or by Layers. 3 Discipline Selection Displays the discipline used to filter the associated layers with. Use the drop-down menu to choose from a list of available disciplines.
PAGE 57
Graphics Overview of Graphics Viewer  4 Manually, when you move the pointer over an object on a graphic and then right-click it and select Show Status and Commands. Connection Point and Lines The Status and Command window is a floating view that displays over an object on the canvas, and can be moved around in the Graphic Viewer. The Status and Command window displays a connection line to its associated object(s) on the canvas.
PAGE 58
4 Graphics Overview of Graphics Viewer 4.3.6.4 Status and Command Window The Status and Commands window displays the following information about an object, its properties, and its status. Item Description 1 Icon Displays the icon associated with the property type. 2 Object Path and Object Name The path and the name of the object. 3 Property Name Displays the name of one or more properties associated with the object the selected object(s).
PAGE 59
Graphics Overview of Graphics Viewer 4 in the group. The Send button displays only for commands that require additional arguments. Clicking the Send button sends a command after you have entered all required arguments. Command Types: Multiple Option Selection: Visual display of associated properties. Each slot represents a property option. If a property is selected, it is shaded, see example above..
PAGE 60
4 Graphics Overview of Graphics Viewer When you move your cursor over an object or element on the active graphic, an associated tooltip displays. Item Description 1 Static Tooltip Descriptive text entered into the Tooltip property field that is associated with the General category in the Property Viewer. 2 Dynamic Tooltip Current tooltip text based on a tooltip evaluation, if any, and the current field values. Evaluations are created in the Evaluation Editor.
PAGE 61
Graphics Overview of Graphics Viewer 4  The system displays a list of the object’s properties, their current state, value, status, and all commands available to you for this object, based on your system privileges and the configuration settings for the object. 2. Complete the required fields and click on the associated command button that displays the command you want to execute.  Depending on the command type, the command is sent, updated, or acknowledged and the status displays. 3.
PAGE 62
4 Graphics Overview of Graphics Viewer 4.3.7.5 Commanding Off-Normal Properties  You have a graphic open in Graphics Viewer, and one or more objects have properties in an off-normal state. The system has displayed the objects and the icons of the properties that are in an off-normal state. You want to view or command these off-normal properties. 1. Navigate to the Status and Command window associated with the object you want to command. 2.
PAGE 63
Graphics Overview of Graphics Viewer – 4 Group – Point Centered Mode is enabled for point objects to display in the center of the pane or canvas.  A checkmark displays next to the selected mode and the Point Centered mode is set on the canvas. 4.3.7.8 Disabling Point Centered Mode  Point Centered Mode is enabled, and you want to disable it. 1. From the Graphics Viewer toolbar, click Point Centered Mode . 2. Select None.  Point Centered mode is disabled. 4.3.7.
PAGE 64
4 Graphics Overview of Graphics Viewer  The graphic is updated to display the depth and layers as selected. 4.3.7.11 Zooming in the Graphics Viewer A zoom factor of a graphic can be changed using one of the following methods from the Graphics Viewer toolbar:  You have a graphic open.  From the Graphics Viewer toolbar in the primary pane, you have the following zoom options available to you: – Click Default View100% to display the active graphic at 100% magnification.
PAGE 65
Graphics Overview of Graphics Viewer 4 Double-clicking another object on the graphic makes that object the new primary selection in the Graphics Viewer and System Browser, while the object remains the secondary selection in the Property Viewer. 4.3.7.
PAGE 66
4 Graphics Overview of Graphics Viewer 4.3.7.16 Deleting a Graphic Item You want to delete a graphic item, a graphic or a folder, from the Graphics folder. You can only delete an empty folder, you cannot delete a folder that contains any graphical objects.  You are in Engineering mode and the Graphics Editor is displayed. 1. In System Browser, select Application View. 2. Expand the Applications folder.  The list of available applications display. 3. Expand the Graphics folder. 4.
PAGE 67
Graphics Overview of Graphics Viewer 5. From the Graphics toolbar, click Save As  The Save As dialog box displays. 4 . 6. Do one of the following: 4.3.7.19 – Saving a Graphic - Select the Graphics folder where you want to save the graphic. In the Name field, type a name for your graphic and click Save. The graphic is saved to GMSProjects > [Name of Your Project] > Graphics folder or sub-folder you may have selected. The graphic is saved in both a .CCG and a .PNG file format.
PAGE 68
4 Graphics Overview of Graphics Viewer 4.3.8 4.3.8.1 Graphics Viewer Appendix You can use a set of keyboard and mouse button-wheel shortcuts to view the active graphic in the Graphics Viewer. Before applying any of the shortcuts to a graphic, be sure the appropriate graphic is active by clicking on it. Keyboard Shortcuts Below is a list of available keyboard shortcuts you can apply to the active graphic or one of its children.
PAGE 69
Graphics Overview of Graphics Viewer 4.3.8.2 4 Mouse Functions The following mouse functions are available in the active graphic once you have activated Zoom mode, either by clicking one of the zoom buttons on the toolbar or by pressing the Z-Key. Click... To … CTRL +MOUSE WHEEL Zoom in and out (+ or - 20%) LEFT MOUSE BUTTON Zoom in (+20%) RIGHT MOUSE BUTTON Zoom out (-20%) 69 Siemens Building Technologies User Guide Version 2.
PAGE 70
5 Alarm Management Overview of Graphics Viewer 5 Alarm Management Alarm management (also called alarm handling) refers to the various actions and steps that you take to respond when an alarm (also called an event) occurs in the building control system. Such actions may include, for example, acknowledging the alarm, investigating its cause, resetting the alarm once the problem has been resolved, and filling out a report form.
PAGE 71
Alarm Management Overview of Summary Bar 5.1 5.1.1 5 Overview of Summary Bar The Summary bar is located along the top of the system screen, and is your main point of entry to all the functions of the management system. On the left, it has a series of event lamps that provide an overview of the alarms in the system grouped by category.
PAGE 72
5 Alarm Management Overview of Summary Bar  Windows calendar when clicked. 6 Time Displays:  System time  Windows calendar when clicked. 7 Menu [➙ 75] Accesses other functions. 8 System integrity indicator Displays the status of the network connection to [➙ 76] the Desigo CC server. 9 Expand/collapse Summary Bar Expands/collapses [➙ 77] the Summary bar. Depending on the Client Profile [➙ 76], this icon may not be available to you.
PAGE 73
Alarm Management Overview of Summary Bar 5.1.1.1 5 Event Lamp The alarms that occur in the building-control system are grouped into categories [➙ 99], which are color-coded by severity. Each category typically corresponds to an event lamp that displays in the Summary bar. Each event lamp shows the total number of alarms for that category, and how many of those are unprocessed (not yet acknowledged by the operator). An event lamp will also flash if there are any unprocessed alarms in its category.
PAGE 74
5 Alarm Management Overview of Summary Bar NOTE: In Client Profiles where recurring events [➙ 124] are grouped under an event container, the event lamp stops flashing when there are no unprocessed events in the event container. Solid dark category color and not flashing. Filter by category activated. There are no unprocessed events for that category.
PAGE 75
Alarm Management Overview of Summary Bar 5 Muted You temporarily muted the audio alert. After 24 hours the system will automatically re-activate the sound (audio alert reminder). Disabled You disabled the audio alert. This means it is permanently silenced, and the system will not emit any sound when new alarms occur. Depending on the Client Profile [➙ 76], this function may not be available to you. Darkened Hovering effect on icon.
PAGE 76
5 Alarm Management Overview of Summary Bar NOTE: This menu item is available only when Desigo CC runs in Closed Mode. 5.1.1.4 System Integrity Indicator The system integrity indicator, located on the Summary bar, indicates the network connection and system status. Its color and animation reflect the connection status, as follows: System Integrity Status Appearance The icon is... Description Green and animated.
PAGE 77
Alarm Management Overview of Summary Bar        5.1.3 Life Safety High Medium Low Fault Information          5 Life Safety Danger High Medium Low Fault Exclusion Anomaly Information You can: – Collapse/expand [➙ 77] the Summary bar (Client Profile TBS_EN only). – Show/hide [➙ 78] the Event Detail bar. – Show/hide [➙ 88] Event List. – Mute/un-mute [➙ 78] the audio alert. When muted, after 24 hours, the system will automatically re-activate the sound..
PAGE 78
5 Alarm Management Overview of Summary Bar 5.1.3.2 Showing and Hiding the Event Detail Bar NOTICE! The following procedures apply only when working in Client Profiles BA_EN and TBS_EN.  The Event Detail bar is not visible, and the command to show it is available on the Summary bar.  In the Summary bar, click arrow .  The Event Detail bar displays below the Summary bar.  The Event Detail bar is visible, and the command to hide it is available on the Summary bar.
PAGE 79
Alarm Management Overview of Summary Bar 5.1.3.5 5 Disabling and Enabling the Audio Alert NOTICE! The following procedures apply only when working in Client Profile BA_EN.  One or more unprocessed events are present, and the system is emitting a sound.  You want to disable the audio alert.  In the Summary bar, right-click on Audio Alert .  The icon changes to disabled and the sound stops. If a new event occurs the system does not emit any audible notification.  The audio alert is disabled.
PAGE 80
5 Alarm Management Overview of Event Detail Bar 2. From the thumbnail preview of the active windows, select System Manager (2).  The System Manager (2) window is now in the foreground. NOTE: When Help is the active window it always stays in the foreground. 5.1.3.12 Ending Your Work Session In the Getting Started document (A6V10415475), see the following:  Exiting the System (if the menu on the Summary Bar contains Exit)  Logging Off in Closed Mode (if the menu on the Summary Bar contains Logoff) 5.
PAGE 81
Alarm Management Overview of Event List 5.2.1 5 Event Detail Bar and Client Profiles The Client Profile in use determines the appearance and behavior of the Event Detail bar. Client Profile FS_EN The Event Detail bar is not available. Client Profiles BA_EN and TBS_EN   5.3 5.3.1 The Event Detail bar is hidden. You can show/hide [➙ 78] it. It contains only one event, that corresponds to the first (most important) event in Event List.
PAGE 82
5 Alarm Management Overview of Event List 1 2 3 4 5 6 Event List Workspace Item Name Description 1 Summary bar [➙ 71] Provides an overview of the events in the system. 2 Event Detail bar [➙ 80] Highlights events that require immediate attention. 3 Title bar Depending on what you select, the title bar shows:  Event List, if no event is selected in the list.  Event location, if a single event is selected in the list.
PAGE 83
Alarm Management Overview of Event List  5 with an asterisk. Detailed Log [➙ 328]: Lets you view a detailed log of the currently selected event. A contextual menu becomes available when you right-click the Event List column headers, and provides you the following options:  Customize columns visibility [➙ 90]: Opens the Customize columns dialog box where you can select which columns you want to display in Event List.
PAGE 84
5 Alarm Management Overview of Event List bar corresponding to this category will also flash. Unprocessed Quiet Select the event or Acknowledge the event The event source is back to normal. Waiting for condition Active Select the event You acknowledged the event but no further action is yet possible, and the Reset command is not available. Ready to be Closed Active Reset the event You already selected the event, and the Reset command is available.
PAGE 85
Alarm Management Overview of Event List 5 Event Descriptor Workspace The exact appearance of the event descriptor depends on the Client Profile [➙ 87]. Event Details Column Description - Event button [➙ 83] that graphically summarizes each alarm. Cause Description of the event followed by the condition (either numeric value or descriptive text) that caused the event. For example, Temperature too high (39°C), Fault (INACTIVE), and so on.
PAGE 86
5 Alarm Management Overview of Event List  : Allows you to view [➙ 116] the intervention text, which indicates technical information about a field point. This information may or may not be available to you. Suggested action [➙ 103] Describes the next action the operator should take for an event. Date/Time Date and time when the event occurred. Location Indicates the entire path of the object in alarm in the current System Browser view.
PAGE 87
Alarm Management Overview of Event List 5.3.1.3 5 Customize Columns Dialog Box The Customize columns dialog box allows you to customize what columns appear in Event List, and change their order. Such changes also apply to the Event Detail bar and the Investigative/Assisted Treatment windows. Customize Columns Fields 5.3.2 Item Description Available columns Shows the list of all the available columns for Event List.
PAGE 88
5 Alarm Management Overview of Event List  – Category – Most recent event on top You can: – Expand/collapse [➙ 89] Event List. – Resize [➙ 89] the columns, change [➙ 89] the position of the columns, customize [➙ 90] how the columns display, and restore [➙ 90] default columns layout. – Tag/untag [➙ 114] events. – Check event source by Alias, Name, or Description [View] [➙ 116]. – Open/close [➙ 117] the Contextual pane. Client Profiles BA_EN and TBS_EN     5.3.3 5.3.3.1 Event List is hidden.
PAGE 89
Alarm Management Overview of Event List – In the Event List header, click Collapse Event List 5 .  Event List is hidden. 5.3.3.2 Expanding and Collapsing Event List NOTICE! The following procedures apply only when working in Client Profile FS_EN.  Event List is collapsed to an Event a bar on the left side of the screen, and you want to expand it.  Do one of the following: – In the Summary bar, click Open/close Event List . – In the Event List header, click Expand Event List .
PAGE 90
5 Alarm Management Overview of Event List 5.3.3.5 Customizing the Columns Display  You want to customize how the columns display in Event List. For example, add the Location column and remove the Cause column. 1. Right-click on the column headers of Event List, and select Customize columns.  The Customize columns dialog box displays. 2. In the Available columns configuration box, select the name of the column you want to add. 3. Do one of the following: – Double-click the selected column name.
PAGE 91
Alarm Management Overview of Event Filters 5.3.3.7 5 Changing Event Sorting NOTICE! The following procedure applies only when working in Client Profiles BA_EN and TBS_EN.  You want to change the default display of events in Event List. For example, you want to move Category to the top.  In the column headers of Event List, click on the Category column header.  Default event sorting changes according to the applied criteria.
PAGE 92
5 Alarm Management Overview of Event Filters Operation Tips     Before filtering events, be sure that alarm handling is suspended or not yet started. Generally, switching from one filter type to another causes the previous filter to be removed in order to apply the new one. The Filter by Tag is only type of filter that you can use in conjunction with another filter.
PAGE 93
Alarm Management Overview of Event Filters 5 to be closed, and Closed). 5.4.3 Filter By Source Status Activate a Simple filter [➙ 94] by source status (such as Active or Quiet). Filter by Tag [➙ 97] Activate/deactivate a filter by tag. Advanced Filter Open the Advanced Filter window, where you can create and activate [➙ 94], save [➙ 95], reuse [➙ 95], or delete [➙ 96] a custom filter. Advanced Filter Window The Advanced Filter allows you to create and apply a custom filter.
PAGE 94
5 Alarm Management Overview of Event Filters The system does not provide selected or predefined filter criteria. The filter options and Apply button become available only when you select one or more filter criteria. If you have already applied a custom filter to the Event List and then you reopen the Advanced Filter window, it contains the filter settings/criteria you applied. In this case, you can also save or modify the applied custom filter. 5.4.4 5.4.4.
PAGE 95
Alarm Management Overview of Event Filters – In the list boxes, select the attributes you want to use for your filter (for example, Event status = Unprocessed, Source status = Active). – In the Location and Source fields, enter an appropriate value. The location and source are limited to 100 alphanumeric characters. – Select one of the available Date and time criteria. – If available, select one of the Tag criteria. – Select one of the available Maintenance criteria. 5 4. Click Apply.
PAGE 96
5 Alarm Management Overview of Event Filters Tips for Reusing a Custom Filter   5.4.4.6 Reusing a saved custom filter is user profile-dependent. If an internal error occurs when applying a custom filter, a message box informs you that the system cannot apply the selected custom filter. Modifying a Custom Filter  The Advanced filter window is open.  The Saved filters [➙ 95] drop-down list contains at least one of your custom filters. 1. In Saved filters, select a custom filter.
PAGE 97
Alarm Management Overview of Event Filters 5.4.4.9 5 Filtering Tagged/Untagged Events  You have already tagged/untagged some events.  Event List displays all open events (both tagged and untagged), and you want to view only the tagged events or hide the tagged events displayed in Event List.
PAGE 98
5 Alarm Management Overview of Alarm Handling 5.4.4.12 Deactivating Auto Remove on New Events NOTICE! The following procedure applies only when working in Client Profiles BA_EN and TBS_EN.  You have activated the Auto Remove on New Events option and now you want to deactivate it so that any applied filter is not automatically removed when new events occur that do not satisfy the filter criteria. 1. In the Summary bar, click Filter . 2. From the Filter menu, deselect Auto Remove on New Events. 5.
PAGE 99
Alarm Management Overview of Alarm Handling  5 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.
PAGE 100
5 Alarm Management Overview of Alarm Handling 5.5.2 Exclusion Orange Events relating to manual operation that might cause operational risk. Anomaly Bright blue Events that are reminders of something that is not normal in the system, and the situation may have an impact on your decisions. Information Gray Events relating to remarkable information, status, or operation. Event Disciplines Each event belongs to a discipline.
PAGE 101
Alarm Management Overview of Alarm Handling 5 In Assisted Treatment, you acknowledged the event, but cannot reset it yet because you must first complete all the mandatory steps of the assisted procedure. In Fast/Investigative Treatment, you reset the event, and the source status is back in normal condition. You can clear the event. In Assisted Treatment, you closed the event and now you can clear it.
PAGE 102
5 Alarm Management Overview of Alarm Handling   No Reset (ACK only required)     No ACK, No Reset     Alarm handling not started yet (and no alarm-handling command sent yet) Event source back to Quiet Unprocessed Ready to be reset Wait for condition (due to mandatory steps) Ready to be closed Closed Alarm handling started (and at least one alarm-handling command sent) Event source back to Quiet Unprocessed Wait for condition Wait for condition (due to mandatory steps) Ready to be
PAGE 103
Alarm Management Overview of Alarm Handling  5.5.4 5.5.5 5.5.6 command sent) or not started yet (and no alarm-handling command sent yet) Event source back to Quiet 5 Ready to be closed Closed Source Status The Source Status column in the event descriptor indicates the status of the source. When the event status is... And the source status color in the event button is… Source status is... Unprocessed Waiting for condition The same as the event category.
PAGE 104
5 Alarm Management Overview of Alarm Handling   5.5.6.1 While handling events, your ability to acknowledge, reset and/or silence/unsilence an individual field point/panel (sending an individual command) or all the panels belonging to the same network (sending block commands) depends on configuration. If you try to send block commands while an event filter [➙ 91] is active, a message displays asking you to remove the filter. Deactivate the filter and send the (block) command.
PAGE 105
Alarm Management Overview of Alarm Handling 5 Command Availability    Acknowledge or Reset display depends on the current status of the event source. Start/Stop Remote Notifications commands display only if Remote Notification messages were configured for an event. Silence/Unsilence commands display only if they were configured for the field panels. Command Execution Dependency   5.5.
PAGE 106
5 Alarm Management Overview of Alarm Handling Contextual pane (7), change the default window layout, and icons for the standard window controls (minimize, restore, and so forth). 4 Event descriptor pane Contains the event button [➙ 83] and event details [➙ 84] related to the event that is currently being processed. The background color reflects the event category color, but in a darker shade. Alarm-handling commands [➙ 103] are also available.
PAGE 107
Alarm Management Overview of Alarm Handling 5 The event descriptor of the alarm being handled displays at the top of the Assisted Treatment window, and you can also directly send alarm-handling commands (that is, do Fast Treatment [➙ 117]) from there. The Assisted Treatment window displays in the work area just below the Summary bar and Event Detail bar.
PAGE 108
5 Alarm Management Overview of Alarm Handling background color reflects the event category color, but in a darker shade. Alarm-handling commands [➙ 103] are also available. A specific icon in the event button indicates that the event is being processed by Assisted Treatment. 5 Selection pane Contains the list of operating procedure steps [➙ 109] you must perform to process the event.
PAGE 109
Alarm Management Overview of Alarm Handling – – 5 On your user group rights. If you don’t have appropriate access permissions, you cannot initiate Assisted Treatment. On the system configuration (that is, on whether an assisted procedure has been configured for handling a particular type of alarm. If there is no such procedure configured, Investigative Treatment is available instead.
PAGE 110
5 Alarm Management Overview of Alarm Handling Steps Workspace Step Elements Item Description 1 Symbol that indicates a mandatory step. 2 Step identifier. This number may or may not correspond to the execution order. 3 Briefly describes the type step.
PAGE 111
Alarm Management Overview of Alarm Handling 5 Appearance and Behavior       5.5.8.2 Each step has the same color as the event's category. When you select a step, it expands and changes to a darker color to indicate that it is being executed. Once you complete a step and a graphic icon indicates the execution outcome of that step (successful or failed). You must execute the first mandatory step before the ensuing mandatory steps can be selected and executed.
PAGE 112
5 Alarm Management Overview of Alarm Handling Alarm Handling Tips    5.5.9.1 Before proceeding with alarm handling, you may want to apply a filter [➙ 91] to decrease the number of events displayed in Event List, or view the intervention text [➙ 116] of a specific event, or check the event source [➙ 115]. When dealing with multiple events in Event List, you may want to handle multiple events with one command [➙ 118].
PAGE 113
Alarm Management Overview of Alarm Handling 5.5.9.4 5 Suspending an Event  You may want to suspend an event, for example, because you have already selected it and you want to suspend alarm handling as there are other events waiting to be handled.  Click the event button [➙ 83] that corresponds to the event being handled.  The event is no longer handled.
PAGE 114
5 Alarm Management Overview of Alarm Handling  You have selected an event.  The command to unsilence the field panel is available in the event descriptor [➙ 84].  Click Unsilence .  The field panel is unsilenced. 5.5.9.7 Starting/Stopping Remote Notifications  You have selected an event.  The command to manually start remote notifications is available in the event descriptor [➙ 84].  Click Start Remote Notifications .  The remote notification is started.  You have selected an event.
PAGE 115
Alarm Management Overview of Alarm Handling  Click Tag 5 for all the events you want to untag.  The Tag icon disappears for all the untagged events. Tagging/Untagging Recurring Events     Tagging/untagging a parent event also affects its child recurrences. You can tag/untag an individual child recurrence. When you tag recurring events, the Hide tagged events filter applies. If a new recurring event is generated, you see the parent event again and it will display only the new recurrence.
PAGE 116
5 Alarm Management Overview of Alarm Handling Viewer displays details of the point in alarm and Operation/Extended Operation displays any properties and commands of the point in alarm.  If you are handling the alarm from the Assisted Treatment window, Operation/Extended Operation in the Contextual pane displays any properties and commands of the point in alarm. 5.5.9.
PAGE 117
Alarm Management Overview of Alarm Handling 5.5.9.13 5 Handling Events from the Event Detail Bar NOTICE! The following procedures apply only when working in Client Profiles BA_EN and TBS_EN. You can perform Fast Treatment, and start Investigative or Assisted Treatment from the Event Detail bar. Performing Fast Treatment 1. In the Event Detail bar [➙ 80], click the event button [➙ 83]. 2. Proceed as described in Using Fast Treatment [➙ 117]. Performing Investigative or Assisted Treatment 1.
PAGE 118
5 Alarm Management Overview of Alarm Handling – Silence/unsilence [➙ 113] a field panel. – Start/stop [➙ 114] remote notifications. 3. Once the cause of the alarm is gone, reset [➙ 112] the event. 4. Close [➙ 113] the event or suspend [➙ 113] it. 5.5.10.1 Handling Multiple Events with One Command You can handle multiple events simultaneously, regardless of the event category or discipline to which they belong.
PAGE 119
Alarm Management Overview of Alarm Handling – Silence/unsilence [➙ 113] the field panel. – Start/stop [➙ 114] remote notifications. 5 4. Once the cause of the alarm is gone, reset [➙ 112] the event. 5. Close [➙ 113] the event or suspend [➙ 113] it. Operation Tips   5.5.12 Investigative Treatment for an event is suspended if you start Investigative Treatment of another event.
PAGE 120
5 Alarm Management Overview of Alarm Handling  5.5.12.1 The Assisted Treatment window automatically closes when the event is fully handled, or when you suspend Assisted Treatment. Following the Assisted Procedure  The Assisted Treatment window [➙ 106] displays on the screen, with the steps of the procedure listed in the pane on the left. The available steps and the order in which they appear in the list may vary depending on configuration.
PAGE 121
Alarm Management Overview of Alarm Handling 5.5.12.2 5 Viewing a Document The Document step allows you view instructions or other important information contained in a file or a Web page.  The Assisted Treatment window [➙ 106] displays on the screen. 1. From the Steps list, select the document step text.  The related application displays in the Default tab of the Primary pane. 2. Read the file (document or web page) carefully and follow any instruction. 3.
PAGE 122
5 Alarm Management Overview of Alarm Handling  The Assisted Treatment window [➙ 106] displays on the screen. 1. From the Steps list, select the remote notification step text.  The related application displays in the Default tab of the Primary pane. 2. Depending on the remote notification type (automatic or manual) and commands availability click: – Start RENO procedure to manually start the remote notification or to send the remote notification again (either manual or automatic).
PAGE 123
Alarm Management Overview of Alarm Handling 5.5.12.4 5 Printing Event Details The Alarm Printout step allows you to print the details of an event. Depending on the execution mode, the event details are printed automatically or manually.  The Assisted Treatment window [➙ 106] displays on the screen. 1. From the Steps checklist, select the Alarm Printout text.  The configured report displays with the event related information in the Default tab of the Primary pane.
PAGE 124
5 Alarm Management Overview of Alarm Handling 5.5.12.6 Completing an Alarm-handling Form The Treatment Form step allows you to enter event related information in a report for operating procedures [➙ 220].  The Assisted Treatment window [➙ 106] displays on the screen. 1. From the Steps checklist, select the Treatment Form text.  The configured report displays with the event related information in the Default tab of the Primary pane.
PAGE 125
Alarm Management Overview of Alarm Handling 5 recurrence may be available, or one assisted procedure for the entire set of recurrences may be available. 5.5.13.1 Handling Recurring Events from Event List  In Event List, the Counter column for an event contains a number. This means that it is a recurring event [➙ 124] that includes some recurrences. 1. In Event List [➙ 84], click the counter for the event.
PAGE 126
5 Alarm Management Overview of Alarm Handling 5.5.13.2 Handling Recurring Events with All-in-One Action All-in-one action means that you can handle all the child recurrences under a parent event by simply selecting the parent event and sending the available alarmhandling commands. You can perform this procedure from the Event Detail bar, Event List, Investigative Treatment, and Assisted Treatment windows.
PAGE 127
Remote Notifications Overview of Alarm Handling 6 6 Remote Notifications The system has the capability to manage remote notification (RENO) messages whether they are configured in the system and triggered by alarms, or you need to send a new remote notification (instant message) to configured contacts (recipients). Alarm-based Remote Notifications If a point is in alarm, you can view the related remote notification message provided by configuration.
PAGE 128
6 Remote Notifications Remote Notification Messages Workspace 6.1 Remote Notification Messages Workspace The RENO Messages workspace is where you monitor and handle all types of remote notifications the remote notifications, whether they are alarm-based (preconfigured in the system) or new (operator-issued, including those sent from different stations).
PAGE 129
Remote Notifications Remote Notification Messages Workspace 6 Example of Alarm-based Remote Notifications Example of New Remote Notification Message from Secondary Pane 129 Siemens Building Technologies User Guide Version 2.
PAGE 130
6 Remote Notifications Remote Notification Messages Workspace Assisted Treatment – Example of Remote Notification Operating Procedure Step RENO Messages Toolbar Icon Name Description Alarm-based notifications New notifications Back to configuration - Available only from the Secondary pane. It lets you switch to Edit mode to compose and send a new (operator-issued) notification. Start RENO procedure Initiate a manual remote If available, it lets you send the notification.
PAGE 131
Remote Notifications Remote Notification Messages Workspace 6 This command is available when you select the original recipient group, and the escalation has not yet started. Clear manual procedure Visible but dimmed. Clears the selected message. This command is available once sending is completed or monitoring is stopped.
PAGE 132
6 Remote Notifications Remote Notification Messages Workspace     Source Date: date the alarm occurred Time: time the alarm occurred Alarm ID: event identifier (for example, Alarm ID 44) Point state: point state that triggered the notification (Genuine, or All, or Maintenance) Details about the source of the event that triggered the notification:  Source (for example, Analog Value 1)  Location  Discipline (for example, Building Automation)  Sub-discipline  Type (for example, Value)  Sub-type (f
PAGE 133
Remote Notifications Remote Notification Messages Workspace 6 Status Indicates the progress or outcome of a remote notification whether sent to an individual recipient or to a group as a whole:  Empty: the remote notification has not initiated yet.  Running: the remote notification has been initiated.  Pending: the message has been sent to the designated recipient(s) and the timeout for a response has not yet elapsed.  Acknowledged: the designated recipient(s) replied within the timeout.
PAGE 134
6 Remote Notifications New Remote Notification Workspace  possible to reach the groups thresholds. Other escalation groups are still pending. Running Sent Sent  No replies are required for a group and its recipients. Aborted Cancelled Acknowledged Timed out Cancelled    The operator has stopped the manual remote notification. The status of the recipients that replied does not change. The status of the recipients that did not reply within the timeout does not change.
PAGE 135
Remote Notifications New Remote Notification Workspace 6 New Remote Notification – Edit Mode New Remote Notification Toolbar. Icon Name Description Send this message Once you have composed the remote notification (recipients and message text) this lets you switch back to RENO Messages [➙ 128] to monitor the sending of your message. Clear all message data Clears all fields.
PAGE 136
6 Remote Notifications New Remote Notification Workspace 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%.
PAGE 137
Remote Notifications Working with Remote Notifications Recipient/Groups or Group/Members 6 Depending on whether you set the Filter to People or Groups, shows 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.
PAGE 138
6 Remote Notifications Working with Remote Notifications Selecting Remote Notifications 1. In System Browser, select Application View. 2. Select Applications > Remote Notifications.  RENO Messages displays in the Primary pane, and lists all the remote notifications available in the system (that is, all the preconfigured alarm-based notifications as well as any new remote notifications composed and sent by the operator). Selecting a Remote Notification 1. In System Browser, select Application View. 2.
PAGE 139
Remote Notifications Working with Remote Notifications 6.3.3 6 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.
PAGE 140
6 Remote Notifications Working with Remote Notifications  If the operation completes successfully, the remote notification status becomes Aborted and you cannot restart it; the status of pending recipients becomes Cancelled. – To stop the escalation for a group of a remote notification before it starts, under Recipients, select the group for which you want to stop the escalation, then click Stop RENO procedure escalation . You can only stop one escalation at a time.
PAGE 141
Remote Notifications Working with Remote Notifications escalation, then click Stop RENO procedure escalation 6 . You can only stop one escalation at a time. If there is more than one recipient group with an escalation list, to stop all escalations you must select each group in turn and repeat this step to disable its escalation.  The escalation for the selected group is now disabled. If the group does not reach its threshold of required responses, the escalation (if any) does not start.
PAGE 142
6 Remote Notifications Working with Remote Notifications – To send the remote notification again, click Start RENO procedure . – To stop monitoring the notification status, click Stop RENO procedure  If the operation completes successfully, the remote notification status becomes Aborted and you cannot restart it while the status of pending recipients becomes Cancelled. .
PAGE 143
Scheduler Overview of Scheduler 7 7 Scheduler 7.1 Overview of Scheduler You can set up schedules on management stations or on field panels at your facility. Calendars and time schedulers allow for creating and handling of switch programs for chronological control of specific plants and technical equipment.
PAGE 144
7 Scheduler Overview of Timeline Viewer Viewing Details in the Timeline Viewer By moving your cursor over an entry in the Viewer, you can view schedule details, but you cannot edit them. Double-clicking a schedule’s details, however, sends the selection to the Default tab in the Primary pane. You can then click the Default tab and edit the schedule. Color Indicators A gray interval indicates that nothing has been scheduled for that period, and the schedule is in its default mode of operation.
PAGE 145
Scheduler Overview of Timeline Viewer 7.2.2 7.2.2.1 7 Item Description 1 Time Range Scrollbar Allows you to control the date range of schedules. 2 Schedule Name Displays the name of the schedule with schedule details appearing on the row below it. 3 Schedule Details Hovering on an interval displays a tool tip with schedule details. Intervals also use color coding and hatch marks to provide basic information at a glance. Schedule details are view only.
PAGE 146
7 Scheduler Management Station Scheduling 7.2.2.3 Bringing the Current Day into View  Using the Time Range scrollbar, you have scrolled away from the current day and would like to return to it quickly.  From the Timeline toolbar, select Show Today . NOTE: Selecting the Show Today icon does not affect any preset time period you have chosen. 7.2.2.4 Changing the Preset Time Span 1. From the Timeline toolbar, click Preset time spans . 2. Select the time span you want to display in the viewer.
PAGE 147
Scheduler Management Station Scheduling 7.3.1 7.3.1.1 7 Management Station Calendars Calendars allow you to override scheduled switch commands. In this sense, you can consider calendars as exception schedules, consisting of dates only. When you create a calendar, you can choose specific dates (January 15), a date range (August 1 – 31), or a week and a day you want the exception to run (third week of the month, on Wednesday). All calendars are associated with a schedule.
PAGE 148
7 Scheduler Management Station Scheduling 7.3.1.2 Adding a Management Station Calendar 1. In System Browser, select Application View > Schedules > Management Station Calendars. 2. From the Scheduler toolbar, click Save . 3. Complete the Name and Description fields. 4. Click OK. 7.3.1.3 Modifying a Management Station Calendar 1. In System Browser, select Application View > Schedules > Management Station Calendars. 2. Open the calendar you want to update. 3.
PAGE 149
Scheduler Management Station Scheduling 7.3.2 7 Management Station Schedules Schedules consist of a name and description, a toolbar for working with the schedule, a date picker, several tabs (Schedule Entries, Outputs, Exceptions, and Setup), daily and weekly views, and schedule details. More about Views Even though you can schedule entries from the weekly view, the weekly view shows only the resulting schedule and not the details of the schedule.
PAGE 150
7 Scheduler Management Station Scheduling different name and description. Delete: Deletes the schedule from the system. 3 Tabs Displays four tabs: Schedule Entries, Outputs, Exceptions, and Setup. Schedule Entries: Displays a list of entries for the selected date and associated ON and OFF values. Outputs: Outputs are objects associated with the schedule. You can drag-and-drop objects to any tab to add them to the schedule. Dropping them on a tab other than the Outputs tab makes the Outputs tab active.
PAGE 151
Scheduler Management Station Scheduling 7.3.2.3 7 Copying a Management Station Schedule 1. In System Browser, select Application View > Schedules > Management Station Schedules. 2. Open the schedule you want to copy. 3. Click Save As . 4. Complete the Name and Description fields. 5. Click OK. 7.3.2.4 Deleting a Management Station Schedule 1. In System Browser, select Application View > Schedules > Management Station Schedules. 2. Open the schedule you want to delete. 3.
PAGE 152
7 Scheduler Management Station Scheduling 7.3.2.7 Deleting a Weekly Schedule Entry 1. In System Browser, select Application View > Schedules > Management Station Schedules. 2. Open the schedule with the weekly schedule entry you want to delete. 3. In the schedule area, click the weekly schedule that contains the entry you want to delete. Details display in the Schedule Entries tab. 4. In the Schedule Entries tab, locate the entry you want to delete and click Delete .
PAGE 153
Scheduler Management Station Scheduling 7 3. In the schedule area, right-click the exception you want to delete. NOTE: Exceptions are highlighted with a red bar on the left side of the entry. 4. Click Delete Exception. 5. Click Save 7.3.2.11 . Adding an Exception Entry 1. In System Browser, select Application View > Schedules > Management Station Schedules. 2. Open the schedule to which you want to add an exception entry. 3. Click the Exceptions tab. 4. In the Schedule entries section, click . 5.
PAGE 154
7 Scheduler Management Station Scheduling In Version 2 of the management station software, you cannot add, edit, or save time triggers. You can only view and delete existing time triggers. 7.3.3.1 7.3.3.2 Management Station Time Trigger Workspace Item Description 1 Activation Times Allows you to set the time you would like to run the macro, report, or trend listed in the Trigger Output section.
PAGE 155
Scheduler BACnet Scheduling 7.4 7.4.1 7.4.1.1 7 BACnet Scheduling You use BACnet scheduling to automatically command points at prescribed time intervals. You can create daily or weekly schedules for BACnet field panels. Each BACnet panel stores its own calendar and schedule objects, and a BACnet panel can store and run multiple calendars or schedules at the same time.
PAGE 156
7 Scheduler BACnet Scheduling  The system adds the schedule to the BACnet Schedules node in the Application view. 7.4.1.2 Adding a Data Point to the Schedule  You are in System Browser. 1. From the Views drop-down list, select Management View. 2. Navigate to the field panel that contains the data point you want the schedule to control. NOTE: For this example, a binary output has been selected with two states (OCC, UNOCC) to represent lighting for a building when it is occupied and unoccupied. 3.
PAGE 157
Scheduler BACnet Scheduling 7 5. Enter 6:00:00 PM, and change the Default check box to OFF. 6. Click Save .  The system saves the settings. 7.4.1.4 Creating a Holiday Calendar 1. From the Scheduler toolbar, click New . 2. Click New BACnet Calendar. 3. Click Save . 4. Complete the Name and Field device fields. NOTE: For this example, the calendar is named HolidayBreak. 5. Click OK.  The systems adds the calendar to the BACnet Calendars node in the Application view.
PAGE 158
7 Scheduler BACnet Scheduling 7.4.1.5 Adding a Calendar Entry 1. In the Calendar Entries section, click the New+ button. 2. Click Date range. 3. Complete the Start date and End date fields. 4. Click Save . NOTE: For this example, December 24 to December 31 is the holiday period when the lights will be turned off because the school building will be vacant.  The system saves the entries. 7.4.1.6 Creating an Exception 1.
PAGE 159
Scheduler BACnet Scheduling 7 7. Clear the Default check box. NOTE: Creating an entry with the default check box checked returns control to the weekly schedule. For example, you might want to override the schedule for one hour at 1 P.M., so you create an entry at 1 P.M. with the override value. Then, you create an entry at 2 P.M. with Default checked. Control will then return to the weekly schedule at 2 P.M. 8. Select OFF from the drop-down list. 9. Click Save .
PAGE 160
7 Scheduler BACnet Scheduling 7.4.2.1 7.4.2.2 BACnet Calendar Workspace Item Description 1 New+ Button Opens a new calendar entry. 2 Applied Schedules Displays a list of schedules referencing the calendar. Clicking a schedule in this section sends data about the object to either the Operation or Extended Operation tabs.
PAGE 161
Scheduler BACnet Scheduling 7.4.2.3 7 Modifying a BACnet Calendar 1. In System Browser, select Application View > Schedules > BACnetCalendars. 2. Open the calendar you want to update. 3. To modify start dates, end dates, or recurrence settings, select a calendar entry from the Calendar Entries section, and then select the settings you want.
PAGE 162
7 Scheduler BACnet Scheduling Default Date By default, every new schedule begins with the current date and never ends. Once a new schedule is opened, you can choose the start and end date for the schedule. Default State By default, the system automatically creates weekly schedule entries for the default state, which you can modify. The Release (NULL) check box allows you to bypass the established priority and return an object to its default value.
PAGE 163
Scheduler BACnet Scheduling 7 Save: Saves the schedule to the system. Save As: Allows you to save another instance of the schedule with a different name and description. Delete: Deletes the schedule from the system. 3 Tabs Displays four tabs: Schedule Entries, Outputs, Exceptions, and Setup. Schedule Entries: Displays a list of entries for the selected date. Outputs: Outputs are objects associated with the schedule. You can drag-and-drop objects to any tab to add them to the schedule.
PAGE 164
7 Scheduler BACnet Scheduling 7.4.3.2 Adding a BACnet Schedule 1. In System Browser, select Application View > Schedules > BACnetSchedules. 2. From the Setup tab, select the Default value and the Data type, and then complete the remaining fields. 3. Drag objects from the System Browser that you want associated with the schedule, and drop them into the Outputs tab. 4. Complete the resulting display of fields as needed. 5. From the Scheduler toolbar, click Save . 6. Complete the Name field. 7.
PAGE 165
Scheduler BACnet Scheduling 7.4.3.6 7 Modifying a Weekly Schedule Entry 1. In System Browser, select Application View > Schedules > BACnetSchedules. 2. Open the schedule you want to modify. 3. In the schedule area, click the weekly schedule you want to modify. NOTE: Weekly schedules are highlighted with a blue bar on the left side of the entry. 4. In the Schedule Entries tab, modify the Time and Value fields as needed. 5. Click Save 7.4.3.7 . Deleting a Weekly Schedule Entry 1.
PAGE 166
7 Scheduler BACnet Scheduling 5. Click Save 7.4.3.10 . Deleting an Exception 1. In System Browser, select Application View > Schedules > BACnetSchedules. 2. Open the schedule with the exception you want to delete. 3. In the schedule area, right-click the exception you want to delete. NOTE: Exceptions are highlighted with a red bar on the left side of the entry. 4. Click Delete Exception. 5. Click Save 7.4.3.11 . Adding an Exception Entry 1.
PAGE 167
Scheduler BACnet Scheduling 7.4.4 7.4.4.1 7 BACnet Commands Commands allow you to control BACnet objects related to your schedules. For example, you want to create a command that turns lights on and maintains room temperature at 72°F (22.22°C) when the room is occupied. When the room is unoccupied, the command would turn lights off and maintain the room temperature at 65°F (18.33°C).
PAGE 168
7 Scheduler BACnet Scheduling 7.4.4.2 Adding a Command 1. In System Browser, select Application View > Schedules > BACnetCommands. 2. From the Text Group drop-down list, select the text group you want associated with this command. 3. In the Command Table Action List, click the New+ button. 4. Highlight the text in the new action list, and rename it to suit your needs. 5. From System Browser, drag the object you want to the action list. 6. Complete the resulting fields. 7. Click Save . 8.
PAGE 169
Trends BACnet Scheduling 8 8 Trends A key functionality in a building automation and control system includes acquiring measured values from workflows and processes. This chapter includes all information required to operate and analyze trends (historical data acquisition). What is Trend? All available process data of a system can be recorded and applied to operational optimization.
PAGE 170
8 Trends Overview of Trend Application    Measured value trends based on intervals, or each time a value changes (change-of-value). Data types analog, digital, and multistate are supported. Create trendlog objects in the automation station. Restrictions   Maximum 10 GB database memory for SQL Server Express or 250 GB of database memory for SQL Server. Display 10 curves (max. recommended) within a Trend View. Restrictions: Version 2.1  8.1 No archive data can be generated.
PAGE 171
Trends What is Online/Offline Trend? 8.2 8 What is Online/Offline Trend? Online Trend Online trend records real-time values from your plant and displays them graphically in a Trend View. The data values are sent to the trend application upon each change of value. The measured values are temporary and can be stored for later queries continuously in the Trend database (online Trendlog object).
PAGE 172
8 Trends Trend Data Storage 8.3 Trend Data Storage Recorded trend data can be stored in three different locations:  Offline Trendlog Objects: Offline trend data is saved in the automation station.  Online Trendlog Objects: Contains the online trend data recorded and saved in the management station.  Archived Trend Database (not in version 2.0): Contains all recorded Trend data moved previously to the archive database.
PAGE 173
Trends Trend Data Storage 8 Change to Daylight Savings Time  Date/time data is saved in UTC format. Entries are in double for one hour when setting back to normal time. In this case, the curve is displayed using both values. When switching to daylight savings times, no value is displayed in this hour and the displayed line is straight between the two measured values.  A system message Anomaly is generated when changing times that must be acknowledged.
PAGE 174
8 Trends Working with Trends 8.4 8.4.1 Working with Trends Trends are divided into the following main elements:  Trend View  Comparative Trend View  Trend View properties  Configuration bar  Key  System Browser Name Description 1 System Browser Displays available Trendlog objects as well as created Trend Views. 2 Configuration Toolbar Displays buttons for the most common commands (new, save, print, zoom). 3 Compare view Allows you to compare measured values from the same Trend View.
PAGE 175
Trends Working with Trends 8.4.1.1 8 Chart You can define the following Chart properties:  Grid  Background color  Trend View title  Display quality attributes  Number of maximum series values in Trend View Menu Description Grid Hides/shows the grid for the Trend View or displays it with horizontal or vertical lines. Background Hides/shows the background color as well as pattern for Trend View. Allows you to define or select the background from a predefined set of colors.
PAGE 176
8 Trends Working with Trends is disabled. Title X Displays the title below the Trend View. Title Y Right Displays the title on the right side of the Trend View. Auto Scale: A minimum and maximum range must be defined if auto scale is disabled. NOTE: Automatic/manual scaling properties act on both main and comparative view. Automatic scaling is temporarily disabled when switching to zoom mode. General Each chart can display a left and right Y-axis independent of each other.
PAGE 177
Trends 8 Working with Trends Menu Description Line Properties Defines the appropriate property type, form and color, as well as the property for the series (see the Table Line Properties below). Visible Displays the trend curve if this check box is selected. Show Markers Defines the corresponding property type, and size, as well as the corresponding property for the series. The markers are only displayed in the trend curve if this check box is selected. The X-axis is always the time axis.
PAGE 178
8 Trends Working with Trends Description 8.4.2 1 Select from predefined colors. 2 Select with mouse. 3 Directly enter each color code. 4 Selected color. 5 Enter a color code. 6 Select pattern. 7 Select an existing color pattern on the screen. 8 Confirm changes. 9 Discard changes. Compare View You can link the same or another Trend View for data analysis that applies the same X-axis for the time range to both Trend Views.
PAGE 179
Trends Working with Trends 8 Item Description 1 Current Trend View. 2 Compare View. 3 Time bar with time displayed in the comparative view. 4 No offset. 5 Predefined offset buttons. 6 Freely definable offset range (range, unit). 7 1x forward or 1x back for the selected offset range. 8 Freely definable offset range in hours, days, weeks, years.
PAGE 180
8 Trends Working with Trends Item 1 8.4.3.1 Description Displays title of current Trend View. 2, 11 Displays and highlights the selected trend curve in Trend View. NOTE: To display a change of value on a binary value, an additional dotted zero line displays at State 1 or One. 3, 12 Displays unselected trend curves as collapsed curves. 4 Displays the time bar. The time bar can be dragged anywhere on the time axis.
PAGE 181
Trends Working with Trends 8 Use the time range scrollbar to set the appropriate data range for your analysis. Description 1, 6 2 3, 5 4 7, 8 Value range for all stored data. Context menu: First/last time range for current Trend View. Context menu: Time range for current Trend View. Tooltip: Repeat value. 9 Direct time selection for a freely definable time and date range. See section Direct Time Selection [➙ 181]. 10 Tooltip: Time and date of the oldest displayed data. 11, 13 8.4.3.
PAGE 182
8 Trends Working with Trends Absolute Time Range The absolute time range is suitable for displaying the data for a known time range. To display the Trend View, you can directly define the start and stop times using a calendar entry as well as the corresponding time entry. Start date End date Time period Data recording Current date Relative Time Range The relative time range is determined by a selectable time range (for example, 2 weeks) and depends on the current time.
PAGE 183
Trends Working with Trends 8 As of current date. Enddatum Time period Data recording Current date Recorded Time Range Select Full View to display the recorded data. Only the Trend View to the date of the last save is displayed when the current date does not match the date of the last save. Time period Data recording Current date 8.4.3.3 Context Menu 183 Siemens Building Technologies User Guide Version 2.
PAGE 184
8 Trends Working with Trends Context Menu 1 Menu Description Hide this column. Hides the selected column. Visible columns Shows/hides columns.  Trended Object Name  Trended Property Name  Trended Log Object Name  Alias  Unit  Value  Time  Date  Y-Axis Attachment  Remove  Visibility Context Menu 2 Menu Description Display Trended Object in Contextual Pane Displays object properties in Operation pane.
PAGE 185
Trends Working with Trends 8 Context Menu 5 Menu Description One minute, hour, day, week, month, or year. Full View Entire date range. Select Range… User-defined range. Context Menu 6 Menu Description First minute, hour, day, week, month, or year. Full View Entire date range. Select Range… User-defined range. 185 Siemens Building Technologies User Guide Version 2.
PAGE 186
8 Trends Working with Trends 8.4.4 Data Point Key The legend for the series contains information on the given data point in the Trend View. NOTE: Use the context menu to hide columns by pointing to the column (Hide Column) or show/hide individual columns (Visible Columns). Column order and width is adjustable with the exception of the first column (colors, cannot be adjusted, moved or hidden). That most recent value displays in the time bar.
PAGE 187
Trends Working with Trends 8 Reduced Display Displays a maximum of two values per interval. The interval is calculated based on the set sample rate for the Trend View (Trend Chart Properties).  1 interval = Max. displayed samples per series/2. – Example 1: 100/2 = 50 intervals – Example 2: 400/2 = 200 intervals A reduced display can also occur with just a few values. For example, when the values are recorded within a short interval. With the reduced display, minimum and maximum values always display.
PAGE 188
8 Trends Working with Trends 8.4.5 Toolbar You can perform some commands directly in Trend View using the Configuration bar. This allows you to optimally process the data in Trend View. Icon Function Description New Trend New Folder Opens a new Trend View. Creates a new folder. Delete Deletes the current Trend View. Save Saves the current Trend View. Save As Saves the Trend View under a new name. Save as user default Saves the Trend View definition as a new user default.
PAGE 189
Trends Working with Trends 8.4.6 8 System Browser All Trendlog objects or Trend View definitions display hierarchically in the System Browser in a tree structure. Click or drag-and-drop to temporarily view Trendlog objects in a Trend View or configure a specific object and save it in a Trend View. Offline Trend Lists all available offline Trendlog objects available in the automation station for a project. Online Trend Lists all available online Trendlog objects.
PAGE 190
8 Trends Working with Trends 8.4.7 Quality Attributes The Trend View can display a number of state attributes, referred to as quality attributes, along with the trend data. These enable you to identify problems with the data point being recorded, and assist with the diagnosis of plant conditions.
PAGE 191
Trends Working with Trends 8 Only the highest priority displays in the Trend View if several states are active. The priority sequence in the previous quality attributes table is read in descending order (highest to lowest priority). With the reduced display , not all quality attributes display. In order to display all quality attributes, limit the time period. NOTE: Quality attributes can only be evaluated if this function supports the corresponding subsystem.
PAGE 192
8 Trends Defining Trend Views 8.5 Defining Trend Views You need a Trend View definition to graphically record data. The Trend View definition includes all properties required for graphical display of the Trend View and the series. Measured value data belonging to the given series such as time/date, value or period are saved in the Trendlog object and can only be displayed in the Trend View definition. Steps The following illustration shows a general workflow to creating a Trendlog.
PAGE 193
Trends Defining Trend Views 8 1. In System Browser, select Application View. 2. Select Applications > Trends > Trend View Definitions. 3. Click New > New Trend . 4. In System Browser, select Management View. 5. Select Project > Field Networks > [Network Type] > Hardware > [Device]. 6. Select the corresponding data point (do not click the data point) and drag-androp the selected data point 7. Click Save to the Trend application. .
PAGE 194
8 Trends Defining Trend Views 8.5.2 Creating New Trend Folder 1. In System Browser, select Application View. 2. Select Trends > Trend View Definitions. 3. Click New > New Folder . 4. Type the appropriate information in the Name and Description fields. 5. Click OK.  A new folder is created under Trends > Trend View Definitions. NOTE: You can create additional sub-folders as needed.
PAGE 195
Trends Defining Trend Views 8 NOTE: Select the Manual navigation check box and the corresponding data points if you want to assign several data points to the Trend View at the same time. You can now assign them to the Trend View by dragging and dropping them. 8.5.4 Creating and Saving New Trend View 1. In System Browser, select Application View. 2. Select Applications > Trends. 3. Click New and then New Trend . 4.
PAGE 196
8 Trends Defining Trend Views 8.5.6 Defining Chart Properties  A Trend View is open. 1. Click Properties . 2. Click the Chart Properties tab (see Chart [➙ 175]). 3. In the Configure group box, do the following: – From the Grid drop-down list, select the corresponding background grid for the Trend View. – From the Background drop-down list, select the corresponding background color for the trend view or click More color to define a customized color. 4.
PAGE 197
Trends 8 Defining Trend Views 8.5.9 Defining Line Properties  A Trend View is open. 1. Select the series for editing from the legend for the Trend View. 2. Click Properties . 3. Click the Series Properties tab (see Series [➙ 176]). 4. Select Visible and enable it. 5. Select the appropriate type from the Series line type drop-down list. 6. Select the appropriate style from the Series line style drop-down list. 7. Select the appropriate color from the Series stroke color drop-down list. 8.
PAGE 198
8 Trends Defining Trend Views 4. Select the Show markers check box. – Select the corresponding type from the Marker style drop- down list. – Select the appropriate style from the Marker size drop-down list. 5. Click Save .  The edited properties are saved to the Trend database. NOTE: Be careful not to select too thick a line if you want to display markers. The marker disappears behind a thick line. 8.5.
PAGE 199
Trends Defining Trend Views 8 1. Select the series for editing from the legend for the Trend View. 2. Click Properties . 3. Click the Series Properties tab (see Series [➙ 176]). 4. Select the Show quality icons check box. 5. Click Save 6. Click Stop . .  Interventions or states that are not Normal display with the corresponding quality attribute. For example, (see also Quality Attributes [➙ 190]) NOTE 1: The quality attributes are hidden when you re-click Run and the trend series is updated.
PAGE 200
8 Trends Defining Trend Views – Click the Chart Properties tab (see Chart [➙ 175]) to change the background color. – Click the Series Properties tab (see Series [➙ 176]) to change the line color for a series. 3. Then select the appropriate series from the legend. 4. Select the drop-down list for colors. 5. Select one or the predefined colors or click More colors. 6.
PAGE 201
Trends 8 Offline Trendlog Objects 8.5.16 Deleting Trend View  A Trend View is open or a Trend View is selected via the System Browser. 1. Click Delete . 2. Click Yes to delete the Trend View.  The Trend View is permanently deleted from the Trend View Definitions folder. The Trendlog objects in the Trend View are not deleted. No recorded data is lost. 8.
PAGE 202
8 Trends Offline Trendlog Objects 8.6.1 Creating Offline Trendlog Object  The device supports the creating offline Trendlog objects without an engineering tool.  You are in System Browser, and Trend is closed. 1. In System Browser, select the corresponding data point. 2. Select Related Items tab and click New Trend.  The Secondary pane opens. 3. On the data point, right-click and select Create Trendlog Object in BACnet Device. 4.
PAGE 203
Trends Offline Trendlog Objects 8 – Select the device where you store the offline Trendlog multiple object. – Type the buffer size from 0‒500. The buffer space used per value is the same for all data formats. – Select the logging type: Polled: The data entry is polled periodically as per the settings in Logging interval, Align intervals, and Interval offset. Trigger: Triggered whenTrigger = On, a data entry is made for the data series. Empty: Default initiated by device.
PAGE 204
8 Trends Offline Trendlog Objects – In System Browser, select Trends > Offline Log Objects and then select the corresponding Trendlog object. 3. Click the Extended Operation tab. 4. Select Logging enabled property and click Collect.  Offline Trendlog data is uploaded to the management station. Trend View after Uploading the Data:   8.6.
PAGE 205
Trends Offline Trendlog Objects 8 11. Define the initial delay in the Initial Delay column (in seconds) for a cascade Trendlog data upload. NOTE: This cascade procedure avoids an overload of network traffic. 12. Click Save . 13. Creating a scheduler [➙ 204] as a next Step.  The macro is defined and the Trendlog objects are assigned. Macro for BACnet Backup and Restore Creating Scheduler 1. In System Browser, select Application View. 2. Select Applications > Logics > Reactions.
PAGE 206
8 Trends Offline Trendlog Objects 8.6.5 Assigning or Replacing a New Trendlog Reference A new object reference can be added to available offline trendlog objects as needed. In this case, the collected data must first be backed up (uploaded); only then can the new object reference be assigned. Data that is not uploaded in advance can no longer be restored after being assigned anew. This applies to trendlog and trendlog multiple objects.  You are in Engineering mode. 1.
PAGE 207
Trends Analyzing Trend Data 8.7 8 Analyzing Trend Data The collected measured values serve as an indicator for an analysis of your plant. It is important to be able to easily find the appropriate data as needed. Desigo CC provides you a number of tools including time range scrollbars, context menus with predefined times, absolute/related time entries or zoom functions. 1. In System Browser, select Application View. 2.
PAGE 208
8 Trends Analyzing Trend Data Repeat Functions   Click the time range scrollbar to the left or right of the time range slider. The time range slider moves in the corresponding direction per the time range defined in the time range slider. Click the left or right arrow on the time range scrollbar. The time range slider moves in the corresponding direction at a 1:10 ratio for the selected time range.
PAGE 209
Trends Analyzing Trend Data 8  The Select Date/Time dialog box closes and the Trend View displays the defined time range. 8.7.4 Selecting Relative Time Range from a Start Date You want to define a time window from a certain start date with a set time range. Start date Time period Data recording Current date  You are in an active Trend View. 1. Right-click the time range bar . 2. Click Select range.  The Select Date/Time window displays. 3.
PAGE 210
8 Trends Analyzing Trend Data  The Select Date/Time window displays. 3. From the Selection type drop-down list, select Relative. 4. In the Interval text field, enter a time range from 1 to X and select the corresponding time unit in the drop-down list. 5. From the Start/end time drop-down list, select Ending. 6. Click the displayed date and enter the desired stop date in the Calendar dialog box. – Select Month/Year with the – Click the appropriate Date. symbols. 7.
PAGE 211
Trends Analyzing Trend Data 8.7.7 8 Selecting Time Range from Predefined Time Ranges Select the visible time range based on predefined time ranges. Time range  You are in an active Trend View. 1. Move the mouse cursor to the time range slider (light grey area). 2. Right-click the time range slider.  Predefined time ranges display. 3. Select the desired time range.  The time range displays with the corresponding data period in the Trend View.
PAGE 212
8 Trends Analyzing Trend Data – Click one of the predefined offset buttons (for example, 1 hour). – Select your own range by selecting the dark button (for example, 3 hours) and select the time offset  Comparison view displays with the corresponding time offset and measured values. 8.7.9 . Using Mouse Zoom The zoom function allows you to select a time range in the currently selected Trend View (applies as well for the comparison view) by zooming in on the X-axis and Yaxis.
PAGE 213
Trends Analyzing Trend Data 8 NOTE 1: When you use Export in the table view, the exported data range depends on the time setting in the graphical view. NOTE 2: Interpolated values are not exported to an export file. NOTE 3: The priority displays in the table if a subsystem supports information on BACnet write priority (1-16). 8.7.11 Temporarily Highlighting Data Series During analysis, it is helpful to temporarily bring a certain series in the Trend View to improve the readability of the trend curve.
PAGE 214
8 Trends Exporting Trend Data 8.7.13 Removing Data Series from Trend View  You are in Trend View and multiple trend curves are displayed. 1. Select the series you want to hide in Legend. 2. Clear the check box in the Remove column.  The Remove Trend Series dialog box displays. 3. Select on the Stop trending this object on the Management System check box: Cleared: The selected series is deleted from Trend View. The Trendlog object is still available in the Online Log Objects folder.
PAGE 215
Trends Exporting Trend Data 3. (Optional) Click Table View 4. Click Export 8 . . NOTE: The export file can contain reduced data (highlighted in pink). Use reporting to export all data. 5. Type the target folder and a unique file name. 6. Click Save .  The export file is generated at the defined location. CSV File Format Description The Comma-Separated Values file format is a type of file where data is saved in tabular format. CSV export data is divided into two areas in Desigo CC.
PAGE 216
8 Trends Printing    When there is more than one data point information state, the states are separated by comma and space. In Excel, the cell is comma separated, regardless of the regional settings by the current user. In Excel, the end of the line is = CR, LF. NOTE 1: The data points unit is not exported in this version. NOTE 2: Individual lines are not synchronized That is the time stamps in each line normally differ between the various Trendlog objects.
PAGE 217
Trends Printing 8.9.1 8 Print Preview and Properties 1 2 3 4 5 6 8 7 9 Description 1 Toolbar. 2 Preview of print view. 3 Select printer. 4 Set margins in pixels. 5 Select paper size. 6 Select paper format (portrait or landscape). 7 Select Fit to page to display the selected area on a page. You can modify print options on the toolbar if Fit to page is cleared. 8 Closes the Print dialog box without printing. 217 Siemens Building Technologies User Guide Version 2.
PAGE 218
8 Trends Printing 9 8.9.2 Prints the document and closes the Print dialog box. Printing Trend View  A Trend View is open.  You must define the Print in color setting in advance if you want to print in color. 1. Select the time range to print using the time range scrollbar. The time range displayed on the screen is printed. 2. Click Print . 3. Select or clear the Fit to page check box. Select the corresponding option in the toolbar if Fit to page is not selected. 4.
PAGE 219
Reports Overview of Reports 9 9 Reports The main function of Reports is to collect data from the runtime system, and allow you to present this data in a customized manner. This chapter provides a description of the Desigo CC Reports configuration and the corresponding configuration procedures. 9.1 Overview of Reports A report is a formatted and organized presentation of data. The Reports application lets you configure and produce a variety of reports on the functioning of the building control system.
PAGE 220
9 Reports Overview of Reports Report Types Reports allow you to create different types of reports, including (but not limited to):  BACnet Event Information  BACnet Alarm Summary  BACnet Enrollment Summary  Objects  Active Events  Activities  Events  Event Details  Trends plot  Trends table  Graphics  All Logs 9.1.
PAGE 221
Reports Reports Workspace 9.2 9 Reports Workspace This section gives an overview of the Reports workspace. Reports Workspace Item Name Description 1 System Browser Displays all the saved Report Definitions in Application View > Applications > Reports. 2 Reports Toolbar [➙ 222] Contains icons for performing various actions in Reports. Reports Toolbar For Operating Procedures [ ➙ 223] Displays only when the report is executed for a selected event from Assisted Treatment.
PAGE 222
9 Reports Reports Workspace 9.2.1 Reports Toolbar The Reports toolbar contains icons that help you perform reporting operations quickly. This toolbar is present in both Edit mode and Run mode. Icon Name Description New Opens a sub-menu where you can select: New Report [➙ 262] and New Folder [➙ 263]. Delete Removes the current Report Definition [➙ 296] or Report folder and deletes its entire configuration from the System Browser tree.
PAGE 223
Reports Reports Workspace 9 in an Excel document is 1,048,575 (Excel limit). When the number of rows exceeds this limit, the Excel document splits into two. The process of the Excel creation for all the split Excel documents displays under the same Report snapshot in the Report Management Section. When successfully created, the Excel document displays in MS Excel in Reports. This command is available only in Run mode. Report Management [➙ 255] Shows or hides the Report Management section.
PAGE 224
9 Reports Reports Workspace NOTE: If you have not specified the report output configuration settings, the information is routed to the path specified in the location supervised folder in the System Browser: Management View > Management System > Servers > Main Server > Report Manager > Report Default Folder. 9.2.2 Reports Ribbon — Home Tab The Home tab is the main tab of the Reports ribbon.
PAGE 225
Reports Reports Workspace 9 Options Group Box The Options group box provides additional options available in the Home tab:  Show in Related Items check box While creating a Report Definition, enable this check box to create a standard report. When you select an object from System Browser, this standard report displays as a link in the Related Items.  Date/time in UTC format check box Selecting this check box, the date and time you type is represented in UTC format.
PAGE 226
9 Reports Reports Workspace   Active Events           Activities            - Main Value Columns specific to scheduling objects are: - Weekly schedule - Exceptions - Commanded objects - Effective  Period Columns specific to Related Items objects are: - Related Items - Related Items Type - Object Location [Application View] - Object Location [Current View] - Object Location [Management View] - Object Model - Object Name - Out of Scan - Referenced Objects - Trended Objects In
PAGE 227
Reports Reports Workspace Events  Attachment - DPEName 2 - Error - Object Designation [Application View] - Object Designation [Current View] - Object Designation [Management View] - Object Identifier [Internal - Object Location - Object Location [Application View] - Object Location [Current View] - Object Location [Management View] - Object Name - Object Property - Previous Quality - Quality - Subdiscipline - Subtype - Type - Unit case sensitive.
PAGE 228
9 Reports Reports Workspace Details columns displayed in the Parent table are: - Event Time - Event Category - Event Cause - Event ID - Object Description - Object Designation - additional columns - Alias [Object] - Alias [Observer] - Discipline - DPEObserver - Event Message Text - Event Mode  - Event Source - Event Value - Event Went - Object Designation [Application View] - Object Designation [Current View] - Object Designation [Management View] - Object Identifier [Internal - Object Location  - Obje
PAGE 229
Reports Reports Workspace    BACnet Alam Summary  Supports the following  additional columns - Alias [Device] - Device Designation - Device Designation [Application View] - Device Designation [Current View] - Device Designation [Management View] - Device Identifier [Internal] - Device Location - Device Location [Application View] - Device Location [Current View] - Device Location [Management View] - Device Name Supports only the Name (on devices only) and Row Filter.
PAGE 230
9 Reports Reports Workspace All Logs                  Event Category  Log Type Event ID Event Time Previous Value Event Message Text Quality Date/Time Record Type Event Cause Event State Previous Quality Source Description Action Source Property Value Unit Supports the following  additional columns - Action Details - Action Result  - Alert ID - Alias [Observer] - Alias [Source] - Attachment - Discipline  - Event Mode - Management Station - Observer Description - Observer Designatio
PAGE 231
Reports Reports Workspace 9.2.2.2 9 Select Columns You can add, remove, or reorder columns in a table using the Select Columns dialog box. Select Columns Dialog Box (Generic) - For All Tables Select Columns Dialog Box Select Columns Dialog Box Components Item Description Parent tab Allows you to add, remove, or reorder Parent columns in the table. Object Type Displays only for a Point table. It lists the object collection.
PAGE 232
9 Reports Reports Workspace NOTE: You can add, reorder, and delete child records using the Child tab. The tab becomes available when you insert the Event Details table. Select Columns Dialog Box - For Objects Table Select Columns_For Objects Table The following table provides information for Type Filter, Type and Available Columns particularly for the Objects table. The other components in the Select Columns dialog box are the same for all tables.
PAGE 233
Reports Reports Workspace 9 Column names with and without square brackets []. You may observe that some column names in the Available Columns list are enclosed within square brackets[], whereas some are not. This occurs for the following reasons:  In the Object Model, each property name has a property descriptor attribute.
PAGE 234
9 Reports Reports Workspace The following Keywords are supported by Reports: Content-specific Keyword List Content-specific Description Keyword Content Type Displays the name of the content provider – Alarm, Log, Reference, Objects, and Graphics. Name Filter Displays the Name filter(s) set for the content provider. Condition Filter Displays the condition filter expression set for a table. In case of Plot content, this keyword remains empty.
PAGE 235
Reports Reports Workspace 9.2.2.5 9 Report Duration Displays the time difference between Report Start and Report Stop. Report State Succeeded - Displays if the report execution succeeds. Cancelled - Displays if the report execution stops or fails. Report ErrorState Provides additional information about report execution. It is independent of the report state. Report ErrorState Message Displays the error description of report ErrorState.
PAGE 236
9 Reports Reports Workspace 9.2.2.6 Upload Adds a new Logo to the Available Logos List. NOTE: The Upload button remains unavailable until a valid path and file name is selected. Thumbnail Displays the thumbnail view of an image. Logo name Saves as Logo name. The Logo name must be unique. Delete Deletes selected logos. NOTE: The Delete button remains unavailable until a logo is selected. Close Closes the Manage Logo dialog box.
PAGE 237
Reports Reports Workspace 9 values every time you run the report. If the text group is deleted, a message indicating that the group is no longer available displays. Text Group Selection Control - Edit Mode Text Group Selection Control - Run Mode Comments Table The Comments table allows you to add [➙ 283], modify [➙ 283], and delete [➙ 283] comments in the Run mode. You can modify and delete your own comments by clicking Edit and Delete that are available in the Run mode.
PAGE 238
9 Reports Reports Workspace 9.2.3.1 Name Filter The Name Filter allows you to filter data based on the Name or Description of System Browser objects. You can apply a Name Filter to a table or plot. Name Filter Dialog Box Use the Name Filter dialog box to add [➙ 272], edit [➙ 272] and delete [➙ 273] Name Filter condition(s).The added Name Filter is also added to the Name Filter group box when the dialog box is closed.
PAGE 239
Reports Reports Workspace 9 NOTE: For a plot, you can set only one Name Filter at a time. Validate Checks whether the applied filter is valid or not. NOTE: Displays only for Trends Table, Trends Plot, and Graphics Plot. Accept Accepts the change made to a Name Filter. This button is unavailable until a change is made to an existing Name Filter. New Adds a new Name Filter to the Name Filter list.
PAGE 240
9 Reports Reports Workspace "System1.ManagementView:ManagementView.FieldNetworks.BAC1.Hardware .Dev2?.Local_IO.AO_1?". When you run the report, the details of all analog output devices with names starting from AO_11 through AO_19 that are present in devices Dev21 through Dev29 will display. The assumption here is that there are devices in your system having names Dev 21 through Dev 29 and there are Analog Output objects having names AO_11 through AO_19 in those devices.
PAGE 241
Reports Reports Workspace 9 Table Name Columns with possibility to display multiple values in a single cell Objects Related Items Type Related Items Activities Value Previous Value Quality Previous Quality Active Events Available Commands For more information, see In Operator [➙ 317]. Condition Filter Syntax When you are creating a condition filter, you must know the data type of the property for which you want to apply the filter.
PAGE 242
9 Reports Reports Workspace acceptable age, the filter is always applied on the latest data from the field system. If you specify 2 weeks, the age of the data with the cache is checked. If the data is older than 2 weeks it is obtained from the field system, else the data from the cache is used for filtering. This setting helps in the faster report generation. Condition Filter Dialog Box This dialog box allows you to specify the condition to filter the report data.
PAGE 243
Reports Reports Workspace 9 type. These are listed after the common columns and have a tree structure. When you click any such column, the tree expands and displays the attributes of the property. For example, if you click the expander of the Current_Priority property, its attributes such as Archive, Activity Log, Min, Max, Default, and so on display. NOTE: You may observe that some column names are enclosed within square brackets[], whereas some are not.
PAGE 244
9 Reports Reports Workspace Time Filter Dialog Box Time Filter Dialog Box Components Field Description Date time specification Shows LOCAL, when the Date/Time in UTC format check box on the Home tab is not selected. Select Column Displays only when an Events or All Logs table is selected in the Report Definition. The entries in the drop-down list depend on table selected.
PAGE 245
Reports Reports Workspace 9 period that you specify. For example, current 'x' hours, current 'x' months, current 'x' years, current 'x' weeks, current 'x' days, or current 'x' minutes. For example, if the current date and time on your machine is 10/07/2014 10.
PAGE 246
9 Reports Reports Workspace 9.2.4.1 Page Setup Group Box The Page Setup group box allows you to set the orientation, page size, and margin of the Report Definition. Page Setup Group Box Orientation The Orientation menu contains two submenus:  Portrait: long vertical edge  Landscape: long horizontal edge (default) Page Size The Page Size menu contains several pre-configured sizes including: A3, A4, A5, Letter, and so on. The default page size is A4.
PAGE 247
Reports Reports Workspace      9.2.4.4 9 Alignment refers to the placement of objects or layout elements on the report page. The different alignments are: Left, Center, and Right. Indentation allows you to set the distance between the report page margin and the actual placement of the element. Spacing allows you to set the space before and after the layout elements. Width allows you to adjust the width of a layout element (logo and plot only).
PAGE 248
9 Reports Reports Workspace 9.2.5 Reports Ribbon — Data Tab The Data tab allows you to specify the location from which the data is to be retrieved when you run the report. It also provides the option to define the Graphics filter. Data Tab The group boxes available in the Data tab are: Table Group Box The controls in the Table group box are enabled only when you select an Objects table in the Reports Workspace.
PAGE 249
Reports Reports Workspace 9.2.6 9 Reports Ribbon — Settings Tab The Settings tab allows you to configure the output format and destination for a Report Definition. Report Output Group Box The Report Output group box displays the configured entries for a Report Definition. Report Output Group Box The Report Output Definition [➙ 249] dialog box allows you to configure the settings. The configured Report Output Definitions are executed when the Report Definition runs automatically [➙ 282].
PAGE 250
9 Reports Reports Workspace Report Output Definition Dialog Box Components Field Description Report format Lists the different supported file formats. NOTE 1: According to the EMC requirement, the CSV report format is supported to export a Trends report in the CSV format. The EMC proxies have plug-ins that support converting data from CVS formats for import into EMC.
PAGE 251
Reports Reports Workspace 9.2.6.2 9 File You can save a Report Output Definition in supported formats to a file. You can configure [➙ 291], modify [➙ 291] and delete [➙ 292] reports using the Report Output Definition dialog box. Report Output Folders Configuration Dialog Box Before you save a file at a specific location in your local management station, you must configure the output folder paths in the Report Output Folders Configuration dialog box.
PAGE 252
9 Reports Reports Workspace 9.2.6.3 List of Folders for Report Output Displays list of configured output folders. On selecting a configured output folder, the Folder Alias, Folder Path, and Folder Description fields are populated. Change Modifies an existing output folder configuration in the list. Delete Deletes a selected entry from the list. This button remains unavailable until an output folder is selected in the List of Folders for Report Output.
PAGE 253
Reports Reports Workspace 9 E-mail Contacts E-Mail Contacts Dialog Box Components Field Description Contacts selection Shows the names of the configured contacts in the Address Book followed by their email address in brackets. This list is sorted alphabetically. NOTE: A recipient may have up to three different email addresses configured. Filter List Entries Allows you to type in a filter. For example, if you type the letter “A”, the recipient list displays all the contacts starting with letter A.
PAGE 254
9 Reports Reports Workspace contacts dialog box. The report is run by clicking the Execute button in the Extended Operation tab Report is routed to the valid email addresses configured in the report output definition. A recipient is deleted from the Address Book The list of email addresses in the Output Definition List in the Report Output Definition dialog box displays in red. On moving your mouse pointer over the text, the following tooltip message displays " One or more email addresses are invalid.
PAGE 255
Reports Reports Workspace 9 Report Output Definition Dialog Box for Printer NOTE 1: Currently only PDF report format is supported for printing. To print a PDF report format on a printer, you must configure a server printer. NOTE 2: The document to be printed depends on the sorting you applied to the columns of a table. 9.2.7 Report Management Section The Report Management section displays the Report execution status, PDF/XLS document creation status, and so on during Report execution.
PAGE 256
9 Reports Reports Workspace You can also delete the split document using the Delete button or all the documents by deleting the Report snapshot entry. The entry of each split document in a Report Management section is a child of the entry for the Report snapshot. Selecting any document entry, displays the document linked to that entry in the Reports. NOTE: This section does not display when the report is executed for a selected event from Assisted Treatment.
PAGE 257
Reports Reports Modes 9 NOTE 1: If you select a Trend View Definition/Graphic Definition in System Browser and click the New Report link/icon, then the Report Definition contains a trend plot/graphics plot with the Name Filter set to the selected Trend View Definition/Graphic Definition.
PAGE 258
9 Reports Reports Modes 9.3.1 Edit Mode When you create a new Report Definition, it opens in Edit mode (default mode). Edit Mode allows you to design the layout of a report, delete a report, and so on. You can also show/hide the Reports Ribbon using the Properties icon . Edit Mode NOTE: You can switch to Run mode by clicking the Run icon or Run As icon present in the Reports toolbar. 9.3.
PAGE 259
Reports Reports Modes 9 Run Mode NOTE 1: You can toggle to Edit mode by clicking Edit on the Reports toolbar. If you perform sorting in Run mode and then switch to Edit mode, the Select Edit Option dialog box displays asking whether you want to save or discard the changes you made in Run, or to create a new Report Definition based on the changes. NOTE 2: In Run mode, when you move the cursor over a table/plot, a tooltip displays the applicable filter and the number of records (only for tables).
PAGE 260
9 Reports Reports Workflow 9.4 Reports Workflow This section describes how to work with reports in the Primary, Secondary, and Contextual panes. NOTE: For Reports, you can perform the same activities in Operating and Engineering mode. 9.4.
PAGE 261
Reports Reports Workflow Item Name Description 1 Report Defintion Selection Location of Report Definition/Report folders in the Application View of System Browser. 2 Report Execution Reports toolbar containing Report Definition execution command icons: Run 9.4.2 9 or Run As . 3 Executed Report Display Location of executed Report Definition. NOTE: This displays in Run mode. 4 Report Management Status details of the executed or currently running Report Definition.
PAGE 262
9 Reports Creating a New Report Definition Definition. 5 9.4.3 Report Definition Properties Properties (Last Run, Summary Status, and Show in Related Items) displayed in the Extended Operation tab. Contextual Pane — Extended Operation Tab You can generate a selected report automatically by clicking the Execute in the Extended Operation tab of the Contextual command button pane. Contextual Pane - Extended Operation Item 9.
PAGE 263
Reports Managing Reports Folders 9.6 9 Managing Reports Folders Creating Reports folders in the System Browser help you to keep Report Definitions organized.  You want to create a new Reports folder and are in System Browser. 1. Select Application View > Applications. 2. Select the main Reports node or a reports folder in the System Browser tree.  Reports displays in the Primary pane. 3. In the Reports toolbar, click New . 4. From the context menu that displays, click New Folder .
PAGE 264
9 Reports Configuring a Report Definition drag-and-drop it in the Report Definition. The cursor shape changes and indicates the selected table name. – Right-click the Report Definition and select the table type from the Insert Table option. – Drag-and-drop the desired system object from the System Browser tree on the Report Definition. The Name Filter of the inserted table is set to the dropped system object.  The table is added to the Report Definition. By default, the table is left-aligned.
PAGE 265
Reports Configuring a Report Definition 4. Click Move Up or Move Down 9 to reorder the column. 5. Click OK.  The column in the table is arranged accordingly. 9.7.1.3 Removing a Column  You have added a table in a Report Definition.  The table must contain at least one column. 1. Select a table in the Report Definition. 2. Right-click the table and select Select Columns.  The Select Columns dialog box displays with the available columns of table. 3.
PAGE 266
9 Reports Configuring a Report Definition 2. Either right-click the table and select Delete, or press the DEL key.  A confirmation message displays. 3. Click Yes to confirm.  The table is deleted from the Report Definition. 9.7.2 Inserting a Plot  You have selected an existing Report Definition in System Browser > Reports or you have created a Report Definition and now want to configure it. 1. From the Reports ribbon, click the Home tab. 2.
PAGE 267
Reports Configuring a Report Definition – 9 In the Insert group box on the Home tab, select Blank from the Text group box, and drag-and-drop it either in the Report Definition or in the header/footer section. – Right-click the Report Definition or the header/footer section where you want to insert the text label, and then select the Insert Label option.  A blank label is inserted. It has the default text. 2. Type the desired text.  The text is entered. 9.7.3.
PAGE 268
9 Reports Configuring a Report Definition 9.7.4.1 Deleting a Keyword  You have inserted at least one label in the selected Report Definition. 1. Select the label that contains the keyword you want to delete. NOTE: To delete a keyword you must delete the label.  The border color changes to indicate that the label is selected. 2. Either right-click the label and select Delete, or press the DEL key.  A confirmation message displays. 3. Click Yes to confirm.  The selected label and keyword are deleted.
PAGE 269
Reports Configuring a Report Definition 9 [drive]:\GMSProjects\[project]\data\Reporting\Logos, where [Project] is the project you created using System Management Console on the Server. 9.7.5.2 Deleting Logos  You have inserted a logo [➙ 268] in a Report Definition. 1. Select the logo you want to delete. 2. Either right-click the logo and select Delete, or press the DEL key.  A confirmation message displays. 3. Click Yes to confirm.  The logo is deleted from the Report Definition.
PAGE 270
9 Reports Configuring a Report Definition – From the Insert group box on the Home tab, click the Form Controls group box, select the Custom Text Selection control and drag-and-drop it in the Report Definition or in the header/footer section. – Right-click the Report Definition or the header/footer section, where you want to insert the Custom Text Selection control, and then select Insert Custom Text Selection.  The Custom Text Selection control is added. 9.7.6.
PAGE 271
Reports Configuring a Report Definition 9.7.6.5 9 Deleting Entries from the Custom Text Selection Control  The Custom Text Selection control has one or more entries in it.  From the list of entries, click Delete corresponding to the text entry you want to delete.  The deleted entry no longer displays in the list. 9.7.6.6 Inserting the Text Group Selection Control 1. From the Reports ribbon, click the Home tab. 2.
PAGE 272
9 Reports Configuring a Report Definition 9.7.7 Applying a Name Filter  You have created a Report Definition and inserted a table or plot. 1. Select a table or plot in the Report Definition. 2. Do one of the following: – Click Dialog Launcher in the Name Filter group box. – Right-click the selected table/plot and select Name Filter from Filters. – Double-click inside the Name Filter group box.  The Name Filter dialog box displays. 3. Select the Name or Description. The default selection is Name.
PAGE 273
Reports Configuring a Report Definition 9 4. Click Accept.  The updated Name Filter displays in the Name Filter list. 5. Click OK.  The updated Name Filter displays in the Name Filter group box. 9.7.7.2 Deleting a Name Filter  You have already applied [➙ 272] a Name Filter to a table or plot. 1. In the Name Filter list, select the Name Filter(s) to be deleted. You can select multiple Name Filters by pressing the CTRL key. 2. Click Delete or press the DEL key.
PAGE 274
9 Reports Configuring a Report Definition  The filter expression is displayed in the Condition Filter group box. 9.7.8.1 Modifying a Condition Filter  One or more Condition Filter expressions are added to the Condition Filter group box. 1. Open the Condition Filter dialog box.  The Condition Filter expression displays in the Filter expression field. Clicking the filter expression displays the column, operator, and value in their respective lists. 2. Modify the Condition Filter expression as required.
PAGE 275
Reports Configuring a Report Definition 9.7.10 9 Applying a Row Filter  You have selected a table in a Report Definition for which you want to apply a row filter.  Select the Row filter check box and enter the desired number of rows to be displayed in the report output.  The configured number of rows are displayed for the table in Run mode. 9.7.11 Applying the Graphics Filter  You have added a graphics plot to the Report Definition. 1.
PAGE 276
9 Reports Configuring a Report Definition 9.7.12.3 Setting Page Margins 1. From the Reports ribbon, click the Layout tab.  The Page Setup group box displays. 2. In the Page Setup group box, click the Margin menu.  A list of preconfigured margins display such as Normal, Narrow, Moderate, Wide, and More Margins. You can specify the top, bottom, left and right margins of a page as well as the header and footer margins by selecting the More Margins option. 3. Select the margin of your choice.
PAGE 277
Reports Configuring a Report Definition 9.7.12.5 9 Enabling/Disabling Auto-scaling 1. From the Reports ribbon, click the Layout tab.  The Auto-scaling group box displays. 2. Select the Auto-scaling check box. By default, the Auto-scaling mechanism is enabled. 9.7.13 9.7.13.1 Formatting Report Elements You can format the report elements by:  Adjusting the position [➙ 277]  Customizing a font [➙ 278]  Applying color [➙ 278] Adjusting a Report Element Position 1.
PAGE 278
9 Reports Saving a Report Definition 9.7.13.2 Customizing a Font 1. Select a label or a table in a Report Definition. 2. From the Reports ribbon, click the Layout tab.  The Font group box displays. 3. Do one of the following to apply a font, font style, or font size. – Click the drop-down arrow in the Font group box. – Right-click the report element, and select Font.  The Font dialog box displays. 4. Select the font type, font size, and font style as desired. 5.
PAGE 279
Reports Creating a New Report Definition from an Existing One 9 NOTE: If you try to exit the configuration without saving the changes, the unsaved data message box displays. 9.9 Creating a New Report Definition from an Existing One  You have made modifications to an existing report definition and want to save it as a new Report Definition.  The modified Report Definition displays in the Primary pane. 1. In the Reports toolbar, click Save As .  The Save Object As dialog box displays. 2.
PAGE 280
9 Reports Generating a Report from a Report Definition  The Report Definition is saved as a default template. Tips    9.12 9.12.1 There can only be one default template. You can create a new one or use the one provided by the system. When you create a new template, the existing default template is overwritten. The new Report Definition is always based on the default template. The template may contain generic and content-specific keywords.
PAGE 281
Reports Generating a Report from a Report Definition – Run – Run as 9 to run the Report Definition according to your login language. to run the Report Definition according to the selected language. Localized data is retrieved and loaded in the cells of a table/plot in the report.  The report execution status displays in the Report Management section below the report definition. On successful report execution, the generated report displays in Run mode.
PAGE 282
9 Reports Printing Reports 9.12.3 Generating a Report Automatically  At least one Report Definition for which a Report Output Definition is configured and available under System Browser > Reports. 1. In System Browser, select Application View. 2. Expand the Reports node. 3. Select the Report Definition you want to execute.  The Report Definition displays in Edit mode. 4. Do one of the following: – From the Contextual pane, click the Extended Operation tab, and then click Execute.
PAGE 283
Reports Working with Reports in Run Mode 9.14 9.14.1 9 Working with Reports in Run Mode Adding comments to the Comments Table  The Report displays in the Run mode and has a Comments table.  Enter the comments in the Comments column and press ENTER. Press ALT + ENTER to add a new line.  The Creation date, User, and Management Station columns are automatically filled in with their respective read-only values. The icons Edit and Delete 9.14.2 display on the row.
PAGE 284
9 Reports Creating and Viewing a Report as a PDF or Excel Selecting Rows 9.15 Creating and Viewing a Report as a PDF or Excel After executing a Report Definition manually or automatically, you can view and save the report as a PDF or Excel (XLSX) document. This way you can share the PDF/Excel document with someone, or perform some calculations on the Excel document by applying Excel formulas.
PAGE 285
Reports Creating and Viewing a Report as a PDF or Excel 9 View as PDF NOTE 1: To view a PDF document, you must have a PDF Reader installed on your computer (which is installed with the system). NOTE 2: Reports do not support TrueType collections for PDF generation. To generate a PDF document for Asian languages, you must select TrueType fonts which support Asian characters in the Report Definition, for example, Arial Unicode MS.
PAGE 286
9 Reports Creating and Viewing a Report as a PDF or Excel In order to perform analysis on a specific set of columns in a table, you can add a PivotTable or chart to the generated Excel document and set this document as a template to the report definition having this table. When you run the report and generate the Excel document, information related to the columns you added to the PivotTable or chart displays in a separate worksheet.
PAGE 287
Reports Creating and Viewing a Report as a PDF or Excel 9 View as XLSX_PivotTable An Excel document can have a maximum of 1000 worksheets (0 through 999). Each sheet can have a maximum number of 10,48,575 rows. If all the 1000 worksheets are filled with data, then a new Excel file is created for the next set of records. NOTE: To view and save an Excel document, you must have Microsoft Office Excel 2007 or later installed. Microsoft Excel is not installed with the management system. 9.15.
PAGE 288
9 Reports Creating and Viewing a Report as a PDF or Excel NOTE 1: When a PDF document exceeds the page limit of 500 pages, it splits into two documents. The PDF creation progress for all the split PDF documents displays under the same Report snapshot in the Report Management section. NOTE 2: From the Report Management section, you can: - Click Stop to stop creating the PDF document and a consecutive PDF split document (if any). - Click Delete to delete each entry.
PAGE 289
Reports Creating and Viewing a Report as a PDF or Excel 9.15.2.2 9 Generating an Excel Document with a Template  You have created a report definition, run it, and it displays in the Run mode.  Microsoft Excel 2007 or later is installed on your system. 1. In the Reports toolbar, click Create and view Excel .  An Excel file is created and stored at the following temporary location on your machine [Drive]:\Users\[UserID]\AppData\Local\Temp\temp\GMS.
PAGE 290
9 Reports Routing Reports  The saved Excel document is a template that contains the PivotTable. 15. Select the Report Definition you created. 16. From the Extended Operation tab, specify the path of the template in the Excel Output Template field and click Set. By default, the Excel Output Template field does not display in the Extended Operation tab. In order to display this field, you must select the DL3 display level check box for the Template Path property in the Report Definition Object Model.
PAGE 291
Reports Routing Reports 9.16.1.1 9 Configuring a Report Output Folder 1. From the Reports ribbon, click the Settings tab. 2. Click Dialog Launcher for the Report Output group box.  The Report Output Definition dialog box displays. 3. Select File as the Destination Type and click Configure Folders that becomes available.  The Report Output Folders Configuration dialog box displays. 4. Type the Folder Alias (name). 5. Click Browse to select a destination folder.
PAGE 292
9 Reports Routing Reports 9.16.1.3 Deleting a Report Output Folder  At least one report output folder [➙ 291] is present in the List of Folders for Report Output in the Report Output Folders Configuration dialog box. 1. In the Report Output Folders Configuration dialog box, select an output folder from the List of Folders for Report Output. 2. Click Delete.  A message will prompt you to confirm your action, and the output folder entry is deleted from the List of Folders for Report Output. 9.16.2 9.
PAGE 293
Reports Routing Reports 9 9. Click OK.  Configured Report Output Definitions display in the Report Output group box. NOTE 1: When executed (using the Execute command button or macros and reactions), the file is created and saved at the configured destination with the name entered in the File Name field. NOTE 2: In a CSV file, numeric values display in an exponential format. 9.16.2.2 Email  You have configured the mail server or have verified it has been configured. 1.
PAGE 294
9 Reports Exporting a Report Definition 9.16.2.3 Printer  One or more local printers are configured in the System. 1. From the Reports ribbon, click the Settings tab. 2. From the Report Output group box, click Dialog Launcher  The Report Output Definition dialog box displays. . 3. Select PDF in the Report format list. NOTE: The destination type Printer is not available for XLS or CSV printing. 4. Select Printer in the Destination types list. 5. Select the required printer from Printer drop-down list.
PAGE 295
Reports Exporting a Report Definition 9.17 9 Exporting a Report Definition NOTE: You can export multiple Report Definitions or multiple folders; however, you cannot export a Report Definition and a folder at the same time.  You are in System Browser. 1. Select Reports > Report Definition(s) or folder(s) containing Report Definition(s). To select multiple Report Definitions or folders, hold the CTRL key. 2. In the Reports toolbar, click Export .  The Browse for Folder dialog box displays. 3.
PAGE 296
9 Reports Deleting a Report Definition – If you don’t select associated logo file(s) while importing, then the imported Report Definition displays a placeholder (No Parking symbol) in place of a logo. 4. Click Open.  On successful import, the selected Report Definition(s) are imported in the selected folder in the System Browser.
PAGE 297
Reports Aborting a Running Report Definition 9.20 9 Aborting a Running Report Definition  You are executing a Report Definition.  Do one of the following: – – In the Reports toolbar, click Stop . In the Report Management section, click Stop that becomes available in the Action column for a currently running Report Definition.  A report is populated with the data which is gathered before you stopped the report execution. NOTE: You can stop creating a PDF or XLS document in the same way. 9.21 9.
PAGE 298
9 Reports Reports References Columns in Table(s) Present in the Definition When you open or save a Report Definition, it is checked for the validity of the selected columns present in the table(s). If any of the columns in the Report Definition is invalid, an error message informing you the position of the erroneous table element or column name displays. You can run a report containing invalid columns; however, in the executed report, the invalid column will not contain any data.
PAGE 299
Reports Reports References   9.21.4 9 If objects are in scope for a user, but that user does not have read or read/write access to those object properties, then data related to these objects is not displayed to that user. (In context of Operating Procedure Steps) If the configured report definition is out of scope, then the report does not execute, and the message “Access Denied. Please contact System Administrator” displays in the status bar.
PAGE 300
9 Reports Examples configured table in the Run mode  project.  One of the element such as graphics has not received data from the service/graphic s engine. Create a graphics containing the object in event. PDF document generated for operating procedure does not display any data Data is not  available as per the filters  applied to the configured table. Graphics is not available for the object in event. Check and correct the applied filters. Create a graphics containing the object in event.
PAGE 301
Reports Examples 9 Events Report [➙ 313] Trends Plot [➙ 314] 9.22.1 Objects Report This section provides information on configuring the Objects report. Overview An Objects report contains an Objects table that displays the run time property values of system objects. To know the property values of any object such as present value, high limit, low limit and so on, you must configure an Objects report. Each object has a corresponding object model associated with it.
PAGE 302
9 Reports Examples Steps for Configuring an Objects Report for a Particular Object Type 1. Create a new report definition [➙ 262] with the objects table inserted.  The Objects table is inserted with the following default set of columns — Object Description, Object Designation, Function, Discipline, Type, Subtype, Main Value. 2. Right-click the table and select Select Columns. The Select Columns dialog box displays. 3. Enter the object type description in the Type Filter field.
PAGE 303
Reports Examples 9 7. Configure a name filter [➙ 272] for your report by dragging-and-dropping the required objects from the System Browser to the Objects table in the report definition. In order to get the desired results, you must assign the objects of type for which columns are configured in your report. For example, if you have selected columns for the BACnet Analog Output object, then you must assign Analog Output objects as name filter. NOTE: Your report is now ready with the basic configuration.
PAGE 304
9 Reports Examples f. Click Add. g. Click OK.  The Condition Filter is added to the table. NOTE: When you are creating a condition filter, the syntax of the property values depends on the data type of the property. For more information, see Condition Filter Syntax in Condition Filter [➙ 240]. 11. Run the report [➙ 280] to view the data.  If you have applied the condition filter, the details of all analog output objects with Current Priority set to 16 display.
PAGE 305
Reports Examples 9 Associated Object Description Associated Object Name Associated Object Designation Associated Object Location Associated Object Name (Internal) Alias [Associated Object] Alias [Object] Unit    When you are adding a condition filter to the Activities table, you cannot apply the OR operator between two filter expressions that are located on two different columns. For example, the expression 'Log Type' = "Reports" OR 'Action' = "Report Execution" is invalid.
PAGE 306
9 Reports Examples 3. From the System Browser, drag-and-drop the analog input object whose value you want monitored, to the Activities table. This object acts as the name filter [➙ 238]. 4. Right-click the Activities table, point to Filters and select Condition Filter. The Condition Filter dialog box displays. 5. Perform the following steps to apply the condition filter: a. Select Value from the Available Columns list. b. Select > from the Operators list. c. Enter 100 in the Values text field. d.
PAGE 307
Reports Examples 9 d. Click OK. 7. Run the report [➙ 280] to view the data.  The report displays the data for analog input object where value is greater than 100 in the last 24-hours. 8. Save the report definition [➙ 278] if the data matches your requirements.
PAGE 308
9 Reports Examples If a single name filter without any wild card characters is applied, then all records display. In this case, the Row Number column is empty.  If multiple name filters are applied, then the child table is restricted to the latest 1000 records. You can configure an Event Details report for the following:  Viewing event details of a particular event using Investigative Treatment [➙ 309].  Viewing event details of a particular event using Assisted Treatment [➙ 310].
PAGE 309
Reports Examples  9.22.3.1 9 operator, press SHIFT or CTRL, depending on whether you want to select values listed next to each other or away from each other, and then click Add. You cannot apply the NOT operator in the Condition Filter for an Event Details table. For example, NOT 'Discipline' = "Building Automation" is invalid. Viewing Event Details using Investigative Treatment  Ensure that operating procedure templates (if configured) are disabled.
PAGE 310
9 Reports Examples 9.22.3.2 Viewing Event Details using Assisted Treatment  You have created an Operating Procedure template in Operating Procedures in System Browser and have completed the required configuration steps. See the Operating Procedures help in the Engineering Manual A6V10415473 for creating and configuring an Operating Procedure template.  Ensure that the Operational Status property for the Operating Procedure template is set to Enabled.
PAGE 311
Reports Examples 9 information is routed to the path specified in the location supervised folder in the System Browser: Management View > Management System > Servers > Main Server > Report Manager > Report Default Folder. 9.22.3.3 Viewing Event Details for specific events using Reports 1. Create a new report definition [➙ 262] with the Event Details table inserted.
PAGE 312
9 Reports Examples 6. Specify the time period by adding the Time Filter to the report definition. Perform the following steps to add the Time filter. a. Right-click the Event Details table, point to Filters and select Time Filter. The Time Filter dialog box displays. b. Select Relative. c. Select either the Last or Current Period option, depending on the data requirement for the last 24 hour period or current 24 hour period. For more information regarding setting the time period, see Time Filter [➙ 243].
PAGE 313
Reports Examples 9.22.4 9 Events Report The following section provides information on the Events table and it's constraints. Overview The Events table provides information related to events. It provides information such as Event Time, Event State, Event Category, Event Cause, Event ID, Object Description, and Object Designation.
PAGE 314
9 Reports Examples  9.22.5 operator, press SHIFT or CTRL, depending on whether you want to select values listed next to each other or away from each other and then click Add. You cannot apply the NOT operator in the Condition Filter for an Events table. For example, NOT 'Discipline' = "Building Automation" is invalid. Trends Plot The following section provides information on a Trends Plot and its configuration.
PAGE 315
Reports Examples 9 4. Run the report [➙ 280] to view the data.  The report displays the graphical representation of the data for the current 10 hour period. 5. Save the report definition [➙ 278]. NOTE: You can enhance the report configuration at any time, in the future, by changing the name and time filters. 315 Siemens Building Technologies User Guide Version 2.
PAGE 316
9 Reports Examples 9.22.6 All Logs Report The following section provides information on the All Logs table and its constraints. Overview The All Logs table provides information on system activities and events.
PAGE 317
Reports Examples – – – – – – – – – – – – 9.22.7 9 Subtype Source Description Source Name Source Designation Source Location Source Designation [Application View] Source Designation [Current View] Source Designation [Management View] Source Location [Application View] Source Location [Current View] Source Location [Management View] Source Identifier [Internal] In Operator The following section provides an example of the In operator.
PAGE 318
9 Reports Examples 3. Click OK. 4. Run the report.  The generated report displays the data for only those objects that have a graphic linked to them. In case of the above scenario, the report displays the data for Analog Output 1 and Analog Output 2 as these are the only objects that have a graphic linked with them. 318 Siemens Building Technologies User Guide Version 2.
PAGE 319
Log Viewer Overview of Log Viewer 10 10 Log Viewer The main function of Log Viewer is to present you the historical data from activities and events for performing analysis. This chapter provides information on the Log Viewer workspace, workflow, creating and configuring a log view definition, and other activities. 10.
PAGE 320
10 Log Viewer Log Viewer Workspace Management Station Observer Description Observer Property Observer Designation Observer Location Observer Name Observer Identifier [Internal] Log Viewer is covered by a license. In order to access the Log Viewer application, you must ensure that the Log Viewer license is available in your system. 10.
PAGE 321
Log Viewer Log Viewer Workspace 5 10.2.1 Detailed Log Tab [➙ 328] 10 Displays information related to system activities and events. Log Viewer Toolbar The Log Viewer toolbar allows you to perform the following operations: Item Name Description New Folder [➙ 345] Creates a new folder below the Log Viewer root node. Save [➙ 343] Saves a newly created and configured log view definition or changes in the configuration of the currently selected log view definition.
PAGE 322
10 Log Viewer Log Viewer Workspace 10.2.2 Select Columns Dialog Box The Select Columns dialog box allows you to add, remove, or reorder columns in a log view. You can access this dialog box using any of the following methods:  Clicking the Select Column icon on the Log Viewer toolbar.  Clicking the Select Column icon from the toolbar in the Detailed Log tab.  Clicking the dropdown arrow on a column header and selecting the Select Column menu option.
PAGE 323
Log Viewer Log Viewer Workspace 10.2.3 10 Custom Filter A Custom Filter allows you to define a filter expression from which you can filter data according to your specific requirements.
PAGE 324
10 Log Viewer Log Viewer Workspace          Record Type Action Result Event Mode Event Category Event State Log Type Action Quality Previous Quality Custom Filter Syntax When you are creating a custom filter, you must know the data type of the column for which you want to apply the filter. The following examples should help you create custom filters without syntax errors. 1. If column displays text data, for example string or enumeration, then the value must be enclosed within double quotes.
PAGE 325
Log Viewer Log Viewer Workspace 10 must save the settings as a log view definition. Using the search filter, you can filter the data for the columns that are present in the log view. For more information see, Applying Search Filters on columns other than Date/Time [➙ 335] and Applying Search Filters on Date/Time Columns [➙ 336]. You can also apply a search filter if you need to filter the data for a column that is not present in the log view [➙ 341].
PAGE 326
10 Log Viewer Log Viewer Workspace can either select a value from the drop down list or enter a value in the text field. Add Filter Adds a new filter expression row with the Operator and Value fields to the Custom Filter dialog box. Remove Filter Removes the filter set on the particular column. NOTE: In order to enable the Remove Filter button, you must select the check box preceding the Operator and Value fields corresponding to the result filter expression to be deleted.
PAGE 327
Log Viewer Log Viewer Workspace 10 Time Filter Dialog Box Time Filter Dialog Box Components Item Description Result Filter Allows you to specify a result filter. Search Filter Allows you to specify a search filter. NOTE: The Search Filter tab does not display when the Time Filter dialog box is accessed from the Detailed Log tab in the Contextual Pane. Exact Allows you to filter data based on the exact date specified. Custom This option allows you to set the date and time as per your requirement.
PAGE 328
10 Log Viewer Log Viewer Workspace For example, if the current date and time on your machine is 10/07/2014 10.35 AM and you specify any of the following: 1 Hour in the Last option - The data for the 9:00 to 10:00 AM period is retrieved. 1 Hour in the Current Period option - The data for the 10:00 to 11:00 AM period is retrieved. 1 Month in the Last option - The data for the period June 01,2014 to July 01, 2014 is retrieved.
PAGE 329
Log Viewer Log Viewer Workspace 10 Applying Result Filters on Columns other than Date/Time [➙ 337]  Applying Result Filters on Date/Time Columns [➙ 339]  Selecting columns to be displayed [➙ 334]  Hiding columns [➙ 335]  Sorting Log Entries [➙ 343]  Reordering [➙ 335] and Resizing [➙ 335] Columns By default, the following information displays for activity and event type data in the Detailed Log tab.
PAGE 330
10 Log Viewer Log Viewer Workspace Detailed Log Tab Item 10.2.5 Name Description SaveAsDefault Saves the selected columns in the Detailed Log tab as a default template. Refresh Refreshes the data displayed in the Detailed Log tab. Stop Execution Stops the execution of the log view in the Detailed Log tab. Select Columns Displays the Select Columns dialog box that allows you to select the columns to display in the Detailed Log tab.
PAGE 331
Log Viewer Log Viewer Workspace 10 Search Filter Dialog Box Search Filter Dialog Box Components Item Description Available Columns1 Lists all the available columns from the Activities and Events log. Operators1 Lists all the operators associated with a specific column selected in Available Columns. Values1 Lists all the values associated with a specific column selected in the Available Columns list. You can also select multiple values by pressing CTRL or SHIFT and selecting multiple values.
PAGE 332
10 Log Viewer Log Viewer Workflow 10.3 10.3.1 Log Viewer Workflow This section describes the procedures for performing the following activities:  Accessing Log Viewer  Viewing Log Data Accessing Log Viewer from System Browser 1. In System Browser, select Application View. 2. Select Applications > Log Viewer.  Log Viewer displays in the Primary pane with the combined data from the activity log and event log. 10.3.
PAGE 333
Log Viewer Working with Log Viewer 10.4 10.4.1 10 Working with Log Viewer This section describes the activities you can perform using the Log Viewer. Creating a Log View Definition 1. In System Browser, select Application View. 2. Select Applications > Log Viewer.  Log Viewer displays in the Primary pane with the combined data from the activity log and event log. 3. Perform the required configuration [➙ 333] such as selecting columns, applying filters, sorting data, resizing column width and so on. 4.
PAGE 334
10 Log Viewer Working with Log Viewer 10.4.2.1 Defining the Log View Size You can define a size for the log view to display a specific number of records. 1. In System Browser, select Application View. 2. Select Applications and click the Log Viewer root node.  Log Viewer displays the data in the Primary pane. 3. Navigate to the Contextual pane and click the Extended Operation tab.  The number of records in the log view displays in View Size. By default, this value is set to 1000. 4.
PAGE 335
Log Viewer Working with Log Viewer 10.4.2.3 10 Hiding Columns Perform any of the following steps to hide columns:  Right-click the column that you want to hide, and select Hide Column.  Click the dropdown arrow on a column header of the column that you want to hide and select Hide Column. 10.4.2.4 Reordering Columns 1.
PAGE 336
10 Log Viewer Working with Log Viewer 3. Click the Search Filter tab. 4. Click the Add Filter button.  An empty row with the Operator and Value fields displays. 5. Specify the operator by selecting a value from the Operator drop down list. In order to specify the value, you must either select a value from the Value drop down list or type a value in the field. This depends on the type of column on which you want to apply the filter.  The filter expression displays in the Filter Expression field. 6.
PAGE 337
Log Viewer Working with Log Viewer 10.4.2.10 10 Modifying Search/Result Filters on Date/Time Columns  You have applied a search/result filter to a column displaying date time data. 1. Right-click the data value in the column pertaining to the filter to be modified and select Custom Filter.  The Time Filter dialog box displays. 2. Click the Search or Result Filter tab depending on the filter that you want to modify. 3. Modify the filter condition. 4. Click OK.
PAGE 338
10 Log Viewer Working with Log Viewer Selection Filter  Drag-and-Drop When you apply a Result Filter on a column, a filter icon displays in the column header indicating that a filter is applied on the column.  Custom Filter 1. Right-click the data value for which you want to apply the filter. 2. From the menu options, select Custom Filter.  The Custom Filter Dialog Box displays. 3. Click the Result Filter tab. 4. Click the Add Filter button.  An empty row with the Operator and Value fields displays.
PAGE 339
Log Viewer Working with Log Viewer 10 the System Browser. For this, ensure that the Manual navigation option in the System Browser is checked. The log view displays the entries corresponding to the object. In case of multiple selection, the data matching either of the selected objects displays. Tips: If you apply a result filter on a column with an existing result filter, the new filter condition replaces the older condition. 10.4.2.
PAGE 340
10 Log Viewer Working with Log Viewer Quick Filter Perform the following step to apply a quick filter:  Right-click the data entry corresponding to the date time value for which you want to apply the filter and select the Filter By. The log view refreshes and displays the entries corresponding to the selected date. NOTE: The last three filters applied on a column are listed as menu options that display when you right-click on a data value.
PAGE 341
Log Viewer Working with Log Viewer 10.4.2.17 10 Reverting to Saved Search Filters The Revert to Saved Search Filter function enables you to obtain the data provided by a previously defined search filter that is now being overwritten by a newly applied filter. For example, assume you apply a result filter on the log view to display all records of type Activity. The filter is moved to a Search filter in order to save it.
PAGE 342
10 Log Viewer Working with Log Viewer 3. Select the required operator and value from the respective lists. If values are not displayed for the selected column, type in the value. To apply parentheses, select a filter expression and click ( ). The parentheses are applied at the start and end of the filter expression. 4. Click Add.  The filter expression displays in the Filter Expression field. 5. Click OK.  The log view refreshes and the data that matches the search filter expression displays. 10.4.2.
PAGE 343
Log Viewer Working with Log Viewer 10.4.2.21 10 Sorting Log Entries  Perform any of the following steps to sort the data. By default, the displayed data is sorted on the basis of the latest date and time. – To sort a column data in the ascending order, click the column header. – To change the sort order to descending, click the column header twice.
PAGE 344
10 Log Viewer Working with Log Viewer 10.4.4 Creating a New Log View Definition from an Existing One  You have made modifications to an existing log view definition and want to save it as a new one. 1. In the Log Viewer toolbar click SaveAs .  The SaveObjectAs dialog box displays. 2. Follow Steps 2 through 5 in Saving a Log View Definition [➙ 343]. NOTE: You cannot save a result filter condition.
PAGE 345
Log Viewer Working with Log Viewer 10.4.7 10 Exporting a Log View Definition 1. In System Browser, select Application View. 2. Select Applications and expand the Log Viewer root node. 3. Select the log view definitions to be exported from the Log Viewer root node or select the folder with the log view definitions. 4. In the Log Viewer toolbar, click Export .  The Browse for Folder dialog box displays. 5. Browse for the desired location and click OK.
PAGE 346
10 Log Viewer Working with Log Viewer 3. In the Log Viewer toolbar, click New Folder .  The Create New Object dialog box displays with the child type set as Log View Folder. 4. Enter the folder Name and Description. Provide a unique folder name, otherwise a message box displays asking you to provide a unique name. A description is mandatory. a) Click Flag to display and modify the text for all languages configured in the system b) Click OK to confirm or Cancel to abort.
PAGE 347
Log Viewer Working with Log Viewer 10.4.12 10 Creating a Default Log View Template A default log view template enables you to create a customized template with a specific set of columns, their position, and size. The template also contains sorting applied to the column data. Any new log view definition is always based on the default template. 1. Configure the log view by selecting [➙ 334], reordering [➙ 335], or resizing [➙ 335] the columns. You can also apply sorting [➙ 343] on the displayed data. 2.
PAGE 348
11 Macros Macros Workspace 11 Macros Macros are predefined lists of instructions that enable you to send out a sequence of commands to specified devices with a single action. Some macros can be started manually by the operator, while others may be run automatically by the system as part of preconfigured schedules (for time-based functions) or automatic reactions. Macros are also used to issue multiple command actions.
PAGE 349
Macros Macros Workspace 11.1.1 11 Macro Properties and Control Commands The Operation tab in the Contextual pane provides status information and commands about the macro selected in System Browser. Macro control commands are available as buttons on the right-hand side of the Operation tab.
PAGE 350
11 Macros Working with Macros 11.2 Working with Macros To manually control a macro, search for the macro you want to work on (see Macros Workspace [➙ 348]), and then use one of the following workflows:  Enable [➙ 351] or disable [➙ 351] the macro.  Execute [➙ 352] the macro or abort [➙ 352] one that is already running. System Macros The system has some predefined special-purpose macros, which are located in dedicated subfolders. The exact number of system macros is configurationdependent.
PAGE 351
Macros Working with Macros 11.2.1 11 Enabling a Macro If a macro is not enabled by configuration, you need to enable it first before you can run it. The enabled status applies to all users of the system, so that enabling a macro means that all authorized users will be able to execute it. To enable a macro proceed as follows:  You are authorized to issue standard commands on the relevant project scope.
PAGE 352
11 Macros Working with Macros 11.2.3 Executing a Macro  You are authorized to issue standard commands on the relevant project scope.  The macro you intend to run is currently enabled. 1. In System Browser, select Application View. 2. Select Applications > Logics > Macros. 3. Expand the Macros node. Locate and select the macro you want to execute.  The macro control commands [➙ 349] display in the Contextual pane. 4. In the Operation tab, click Execute.  The macro starts executing. 11.2.
PAGE 353
Reactions Reactions Workspace 12 12 Reactions Reactions are automations programmed into the system, so that when a specific situation occurs on site, a command or series of commands --called a macro-- are automatically executed. This section describes how to work with reactions. 12.1 Reactions Workspace The reactions configured in the system are available in the Application View of System Browser, under the Reactions folder.
PAGE 354
12 Reactions Reactions Workspace 12.1.1 Reaction Properties and Control Commands The Operation tab in the Contextual pane provides status information about the reaction selected in System Browser, and commands for enabling or disabling it.
PAGE 355
Reactions Working with Reactions 12.2 12.2.1 12 Working with Reactions To manually control a reaction, search for the reaction you want to work on (see Reactions Workspace [➙ 353]), and then use the following workflow:  Enable [➙ 355] or disable [➙ 355] the reaction. Enabling a Reaction If a reaction is not enabled by configuration, you need to enable it first before the management system can execute it. Enabling a reaction means that it will be executed when its trigger conditions occur.
PAGE 356
13 Address Book Working with Reactions 13 Address Book The Desigo CC address book [➙ 357] contains a list of contacts (called recipients) which the system can use for sending out remote notifications [➙ 127], or for emailing reports [➙ 219]. You can view or interact with the address book by selecting the Address Book node, in the Application View of System Browser.
PAGE 357
Address Book Address Book Workspace 13 The following rules apply to populating the Address Book with the contacts data: Contacts Data in the Address Book. Field Description Full Name First Name, Middle Name, and Last Name with a space as separator. Full Name is limited to 50 alphanumeric characters. Preferred Device E-mail/SMS/pager. E-mail1 E-mail2 E-mail3 E-mail Address. E-mail is limited to 50 alphanumeric characters; if you exceed the limit, the field is left empty.
PAGE 358
13 Address Book Address Book Workspace Address Book Toolbar Icon Name Description Save recipient Save any changes. Add recipient Add [➙ 360] a new contact row in the address book. Remove recipient Delete [➙ 362] a contact. Remove all recipients Delete [➙ 362] all the contacts from the address book. Import address Browse to select a CSV file containing the contacts to import book [➙ 359] (previously exported from Microsoft Outlook 2003 or 2007).
PAGE 359
Address Book Working with the Address Book  13 Fallback Device Details Fields. 13.2 Item Description Full name Enter the contact full name. This value must be unique. Short name Enter the contact short name. Language Select the contact language. Default is en-US (English - United States). Groups Assign the contact to one or more groups of recipients. You can also add/update/remove groups.
PAGE 360
13 Address Book Working with the Address Book 5. Click OK to close the message box.  The imported contacts appear in the Address Book. WARNING NOTE: Only CSV files in English language are supported. If your language is not English, change this setting to English before proceeding with the file import. For more information about this procedure, see the following: Microsoft Office 2003: http://office.microsoft.com/en-gb/word-help/change-thedefault-language-setting-HP003088462.
PAGE 361
Address Book Working with the Address Book 13.2.3 13 Filtering the Address Book  The address book user interface [➙ 357] displays in the Primary pane.  Sample scenario: you want to quickly find a contact to modify the corresponding data.  Use the Search function by doing one of the following: – Enter the first letters of the contact name and click Search (or press ENTER). – From the Search drop-down list, and under Saved Searches select a group of recipients.
PAGE 362
13 Address Book Working with the Address Book 13.2.5 Deleting Contacts When deleting contacts you may either remove an individual contact or clear the entire address book.  The Address Book contains contact entries. 1. In System Browser, select Application View. 2. Select Applications > Address Book.  The address book user interface [➙ 357] displays in the Primary pane. 3. Do one of the following: – To remove an individual contact, select the contact you want to delete.
PAGE 363
Documents Documents Operating Workflows 14 14 Documents The management system lets the operator consult a set of reference documents configured in the system. 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.
PAGE 364
14 Documents Documents Operating Workflows 14.1 Documents Operating Workflows The following describes how to access and work with documents from the Primary and from the Secondary pane. Primary Pane In System Manager, from the Application View of System Browser, under Applications > Documents select one of the available document objects, which displays in the Primary pane. To manage the current document, switch to Edit .
PAGE 365
Documents Working with Documents 14 Documents in Primary Pane (Edit Mode) - Example of Document When you select a document, you can click the Edit mode icon in the toolbar to manipulate [➙ 364] document objects. 14.3 Working with Documents The following procedures describe Documents operating tasks. Technical Notes These notes apply to one or more of the following procedures.  An error message displays in the following situations: – The document you selected is not available.
PAGE 366
14 Documents Working with Documents By default, when you click in the Description field, the same text contained in the Name field displays. Click the Flag icon to display a field for each language available in the system; modify the text for each language and click OK. c. Click OK.  The new document object appears in System Browser. 7. To go back to normal operation, click Operate 14.3.2 .
PAGE 367
Documents Working with Documents 14 6. Repeat the previous step for all the objects you want to link with the document. NOTE: To remove the association between the current document and an object, select the object and click Remove. 7. To save the changes, in the Documents toolbar, click Save .  The System Manager status bar indicates that the data was successfully saved. 8. To go back normal operation, click Operate . To view the document related items, do the following: 1.
PAGE 368
14 Documents Working with Documents 14.3.5 Zooming In/out and Printing a PDF Document You can zoom in/out and print a PDF document.  A PDF document is available in the Documents folder in System Browser. 1. In System Browser, select Application View. 2. Select Applications > Documents (or any document folder). 3. Select the PDF document.  The PDF page displays in the Primary pane. The icons to zoom in/ out, and print a PDF document become available in the toolbar. 4.
PAGE 369
System-related Functions User Password Change 15 15 System-related Functions This section discusses miscellaneous system functions that deal with operator authentication, for example, changing a password or executing a switchover across two operator shifts, licensing, to display the available licenses, printing, to control the printing options, and so on. 15.1 15.1.1 User Password Change If you are logged on as Desigo CC user, you can change your password at any time from the system menu.
PAGE 370
15 System-related Functions Auto Logoff 3. Click Logon.  The current user is logged off from the system. The system splash screen informs you of the system initialization progress. When the system is initialized, it restarts with your user credentials. Technical Notes   If you provide invalid credentials, a message displays informing you to verify the credentials. If you provide the same credentials for the current and the new user, the Logon button stays inactive and you cannot logon.
PAGE 371
System-related Functions Multiple Monitor Management 15.4.1 15 Logging Off Default User and Logging On Operator In Closed mode, Desigo CC runs with the Default User logged on. To log on, you have to log off the Default User and then log on with your credentials: 1. In the Summary bar, select Menu > Logoff.  A message box informs you that Desigo CC will be closed and you will be logged on. 2. Click OK.  Default User is logged off. The initialization splash screen displays for a few seconds.
PAGE 372
15 System-related Functions Print Feature 15.5.1 Moving a System Window to a Second Monitor  Desigo CC is running as an Installed Client or Windows App Client on a computer connected to two monitors.  You want to move a window from the default monitor to the second monitor. For example, you want to move the System Manager window. 1. Click Restore Down in the window.  The window restores down, you can move it to another monitor, and the icon changes to Maximize . 2.
PAGE 373
System-related Functions Print Feature 15.6.2 15 Print Preview Dialog Box The Print Preview dialog box displays when you click Print in the Printouts selection dialog box, or when you print from an application. You can choose margins, orientation, scaling and color option, printer, paper, and print. Print Preview Toolbar1) Icon 1) Name Description Zoom in Provides a close-up view of the printout. Keep clicking it to continue zooming in. Zoom out Reduces the view of the printout.
PAGE 374
15 System-related Functions Print Feature 15.6.3 Printing from the Menu 1. In the Summary bar, select Menu > Print.  The Printouts selection dialog box displays. If you want to terminate the printout selection operation and exit this dialog box, click Abort. In this case, skip the next steps. 2. In the Printouts selection dialog box, do the following: – Clear the check boxes that correspond to the system application(s) printouts you don’t want to generate.
PAGE 375
System-related Functions Displaying System Information – 15 Select the Color option.(default is black and white). NOTE: The color option depends on the selected printer. If it appears dimmed and unselected, this means that the selected printer cannot print color. If it appears dimmed and selected, this means that the selected printer can print only color.
PAGE 376
15 System-related Functions Client Application Supervision     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. 15.9 Client Application Supervision Desigo CC is reliable and responsive thanks to a constant supervision of the client application.
PAGE 377
System-related Functions Licensing 15 View the License The license data is available in the Management View of System Browser at the following path: Project > Management System > Servers > Main Server > Licenses. You can also quickly automatically point to the Licenses node by clicking the license text (for example, Demo Mode, or Courtesy Mode) in the Summary bar.
PAGE 378
15 System-related Functions Licensing License Check On system startup, and at 5-minute intervals afterwards, the Desigo CC server carries out an automatic check on the installed license features and counts the:  Installed Clients, Web Clients, and Windows App Clients. If a Client disconnects from the server (because it is manually shut down, or owing to a malfunction), the count decreases.
PAGE 379
System-related Functions Licensing 15 Demo Mode Characteristics  When Demo Mode is active, this is visually indicated on the Summary bar in green, with a timer that shows how much time is left.  If you view the license data, the basic required license set will be highlighted in red. Assigned and Remaining will indicate 0.  If the basic required license set is detected before the 30-minute Demo Mode time expires, Desigo CC switches back to Normal Mode.
PAGE 380
15 System-related Functions Licensing       When Courtesy Mode is active, this is visually indicated on the Summary bar in red, with a countdown timer that shows how much time is left. If you check the licenses, any license features that are insufficient will be highlighted in red.
PAGE 381
System-related Functions Help System 15 with valid license continuously working with a valid and sufficient license (that is, in Normal mode). Engineering license will expire in How many days until the Engineering License expires.
PAGE 382
15 System-related Functions Help System Help Workspace Help Workspace Item Description Selection area Find the information you need by searching in one of the following ways:    15.11.1.1 By category in the Contents [➙ 382] tab. By subject in the Index [➙ 382] tab. By topic using a keyword in the Search [➙ 382] tab. Contents area View the information available when a topic is selected. Icons Lock/minimize/maximize/close Help.
PAGE 383
System-related Functions Help System 15.11.2 15 Working with Help The following procedures describe how to perform Help operating tasks. Tips for Working with Help    15.11.2.1 Online help is also available even without starting Desigo CC from the Windows Start menu (Start > All programs > [Company] > Desigo CC > User Documentation > [language specific]).
PAGE 384
15 System-related Functions Help System 3. Select the Get Partial Matches option. 4. Click List Topics.  The list of all the subjects containing that keyword displays in the selection area. 5. Select a topic.  The topic appears highlighted in the selection area. 6. Press ENTER.  The information related to the subject displays in the contents area of the Help page. 15.11.2.5 Searching by Keyword – Search Titles Only  The Help page displays on the screen. 1. Click the Search tab.
PAGE 385
Backup Project Backup 16 16 Backup Overview of Backup Backing up Desigo CC requires storage of independent parts and those can be saved on different servers or PC’s. Of course it’s recommended to save the backups of your project data to a different machine from where they originally reside. Basically there are two main parts to backup.
PAGE 386
16 Backup Project Backup  Manual (using the backup commands available in the Operation/Extended Operation tabs of the Contextual pane, see Backing Up Your Project [➙ 387]). Limitations   When the backup process starts, and until it completes, the DB is locked. You cannot create and/or delete objects, modify the existing configuration, or carry out any import operations. The system does not support more than one project on the same server. Useful Tips    16.1.
PAGE 387
Backup Project Backup 16 You can manually start the backup operation (click Start) or abort a backup in progress (click Cancel). Backup Timeout Indicates the maximum time allowed for a backup. Timeout range is 0-120 minutes, where 0 means no timeout. You can modify the timeout value, and click Apply to save the changes. Maximum number of stored backups Indicates the maximum number of stored backup allowed. Default is 100. You can modify the default value, and click Apply to save the changes.
PAGE 388
16 Backup History Database  Once the backup starts, click Cancel if you want to abort the operation. The backup status changes to Cancelling. When the abort operation completes, the backup status changes to Last Backup Cancelled. The directory created is removed from the Main Server. Technical Notes   16.2 If the backup timeout is exceeded, the backup is aborted and its status displays the error Last Backup Failed for Timeout Expiration.
PAGE 389
Backup History Database 16 NOTICE Not enough disk space available Insufficient storage capacity results in faulty data backup. Prior to starting a backup, check that at least 150 GB of available storage is available. Check whether sufficient storage capacity is available on the backup media.  Verify there are sufficient user rights to back up history data. 1. In System Browser, select Management View. 2. Select Project > Management System > Servers > Main Server > History Database > Backup. 3.
PAGE 390
16 Backup History Database 16.2.2 Automating Data Backup You can create an automated backup of historical data using the using the Macro and Reaction Editor functions.  The backup folder is available (see Backing up Data [➙ 388]). 1. In System Browser, select Application View. 2. Select Applications > Logics > Reactions. 3. Click the Reactions Editor tab. 4. Select Triggers > Time & Organization Mode expander and click Add. 5. Click anywhere on the row.
PAGE 391
Backup History Database 16.2.3 16 Automatically Deleting Data Entries By enabling the Delete Log Entries function, old historical information can be automatically deleted from the history database (for details, see System Management Console A6V10415491). History data deletion can be specified for each individual data group. NOTICE Deleting Historical data permanently deletes it; the historial data cannot be restored.
PAGE 392
16 Backup History Database – Delete schedule period defines the length of the time interval and Delete schedule period units defines the associated unit. NOTE: The greater the interval, the more data is saved during the maximum time span. – Maximal retention span defines the maximum length of the time period and Max retention span unit defines the associated unit.
PAGE 393
Backup History Database 16 group. Number of log entries Displays the current number of log entries for the applicable data group. Number of log entries 24 hour Displays the number of log entries that occurred for this data group over the past 24 hours. Last deleted log entries Displays the number of log entries that were deleted during the last automatic deletion for this data group (see document System Management Console A6V10415491).
PAGE 394
16 Backup History Database 16.2.6 Troubleshooting The following error messages from the history database may occur and are displayed in Desigo CC:  History Database is not operating.  You have sufficient rights to start the System Management Console. 1. Exit the Desigo CC program. 2. Start System Management Console . 3. Click Stop .  The database stops. 4. Check whether the corresponding History Database is linked to the project. 5. Click Start .  The database starts. 6.
PAGE 395
Backup History Database 16 Settings with Maximum Timeframe Only Settings by Number of Entries Only NOTE: When applying settings, remember that an emergency delete occurs at 90% of database capacity. Use the following table if the data volumes must be more precisely calculated. User Storage per Data Group and Lines Rows Data group KB per data entry Time Series 0.057 Activity log 0.37 Alarm Log 0.38 Incidents 0.21 395 Siemens Building Technologies User Guide Version 2.
PAGE 396
Appendix A: Client Profiles Extensions DMS_AT Extension Appendix A: Client Profiles Extensions 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. A basic set of Client Profiles is included with the Desigo CC platform software. For more information about these, see the relevant sections in Alarm Management [➙ 70].
PAGE 397
Appendix A: Client Profiles Extensions DMS_AT Extension Category (F_AT: Fire Alarm, Fire Fault, Fire Control, Fire Information, Fire Isolation; S_AT: Alarm, Fault, Information, and Isolation; FS_AT: Fire Alarm, Alarm, Fire Fault, Fault, Fire Control, Fire Information, Information, Fire Isolation, Isolation)  Oldest event on top The operator cannot change default event sorting.  Event grouping Events belonging to the same source and category display grouped under a parent event (recurring events).
PAGE 398
Issued by Siemens Switzerland Ltd Building Technologies Division International Headquarters Gubelstrasse 22 CH-6301 Zug Tel. +41 41-724 24 24 www.siemens.com/buildingtechnologies Document ID A6V10415471_en_a_21 Edition 2015-07-15 © Siemens Switzerland Ltd, 2015 Technical specifications and availability subject to change without notice.