How to
Configuring a Notification Report Template
You configure a notification report template to get a notification report when an alarm or a variable triggers a notification.
You can configure notification reports to include important information on the Building Operation system. Notification reports are distributed when a notification is triggered.
Notification report
The notification report content is configured in a notification report template that can be used and reused in notifications.
You define the contents of the notification report by configuring the following information:
Text adapted for the notification report
Events
Properties
Trend log records
Search results
Watch View properties
The notification report template text can consist of any printable characters, blank spaces, line feeds, and substitution codes.
You configure data type groups for the events, properties, search results, trend logs, and Watch View properties you want to include in the notification report template. The data type group names become substitution codes that you can add to the notification report template. A data type group can be, for example, a list of trend log values or properties.
You can use Quick filter to find a specific substitution code in a list of available substitution codes.
An auto-complete feature helps you complete the name of a substitution code when you start typing. You can add a substitution code to the notification report template text by dragging it from the list of substitution codes.
By default, when a notification report is triggered it attempts to retrieve all the values and log data for up to 5 seconds. The timeout property is configurable.
Absolute Path or Relative Path to the Objects Connected to the Trend Log or Property
You can configure events, properties, search, trend logs, or Watch Views to point to a specific object (absolute path) or to be relative to an object (relative path).
When used in an alarm triggered notification, a relative path is relevant only when there are several identical structures of objects, for example, folders representing room or a devices. The contents of the report depend on which alarm in the structure that triggered the notification.
When used in a variable triggered notification, you can configure the path the notification report is generated relative to.
If you have more than one Relative Trend Log or Relative Properties data type group in the same notification report, you can only have one relative reference point for them all.
Example:
A notification report template including a trend log with a relative path to an alarm is used, 'Room 1'. There are two more folders in the system with content identical to the contents of the 'Room 1' folder. When an alarm is triggered in 'Room 3', the trend log data related to the triggered alarm in 'Room 3' is presented in the notification report.
If you use an absolute path for the property, you can move or rename the property without any data loss when the notification report is generated.
If you use a relative path for the property and move or rename the property, you will lose data when the report is generated.
Notification report with a relative path to the objects connected to the trend log or property
Events Substitution Codes
Events substitution codes represent the information you want to display when a notification report is triggered. The information is dynamically filled in from the events that are included in the notification report.
For more information, see Events Substitution Codes .
Properties and Watch Substitution Codes
Properties and Watch substitution codes represent the information you want to display when a notification report is triggered. The information is dynamically filled in from the properties or Watch data that are included in the notification report.
For more information, see Properties and Watch Substitution Codes .
Trend Logs Substitution Codes
Events substitution codes represent the information you want to display when a notification report is triggered. The information is dynamically filled in from the events that are included in the notification report.
For more information, see Trend Logs Substitution Codes .
Date and Time Formatting
You can customize how date and time are presented in a notification text or a notification report text.
For more information, see Date and Time Formatting .
Text Formatting
You can customize the presentation of decimals, value types, width, and alignment in a notification text or a notification report text.
For more information, see Text Formatting .
Notification Report Example 1
In the example Building Operation system, we have created Building A and Building B with a number of identical rooms. Building A has three rooms: Room 1, Room 2, and Room 3. Building B has three rooms: Room 1, Room 2, and Room 3. Each room has a value and a trend log that logs the room temperature. Each room also has a value and a trend log that logs the CO 2 percentage in the air. The values are connected to alarms.
For more information, see Notification Report Example 1 .
Notification Report Example 2
In the example Building Operation system, we have created Building A and Building B with a number of identical rooms. We have also created a folder for the repeption area in Building A. In the Reception folder, we have created an analog value and a trend log that logs the temperature in the reception area. The value is connected to an alarm. A notification report that contains the log data is to be displayed in a web browser when a user manually triggers the notification.
For more information, see Notification Report Example 2 .
In WorkStation, in the System Tree pane, select the notification report template you want to configure.
In the Notification Report Template view, configure the properties:
Table: Notification Report Template Properties
Property
Description
Report data
Use Report data to add, edit, or remove data type groups to the notification report template.
action_zoom_plus_stroke 
Add
Click to add a report data type to the notification report template.
action_zoom_plus_stroke 
Edit
Click to edit the properties of the selected report data type.
action_zoom_plus_stroke 
Remove
Click to remove the selected report data type.
Report text
Enter text to include in the notification report template.
Timeout
Enter the number of seconds the notification attempts to fetch values from the Building Operation system before canceling.
Click the Save button
.action_zoom_plus_stroke 
You can use the notification report template in a notification.
Notification Reports
Creating a Notification Report Template
Notifications