How to
Creating a Notification Report Template
You create a notification report template to get a notification report when an alarm or a variable triggers a notification.
You can configure notification reports to include important information on the EcoStruxure BMS. Notification reports are distributed when a notification is triggered.
The notification report content is configured in a notification report template that can be used and reused in notifications.
You define the content of a notification report by configuring the following information:
Alarms
Events
Groups
Multi Log list
Properties
Trend Log records
Users
Watch View properties
And also Search results
The notification reports can be generated in text format, XLSX format and also in PDF format.
The maximum number of trend, multi-trend log list, event and alarm records is 5000.
The notification report template text can consist of any printable characters, blank spaces, line feeds, and substitution codes. For more information, see Text Formatting .
A substitution code for notifications has the form @([property]) where [property] is replaced by one of the alarm properties. For example, you configure a write to file notification that is sent when an alarm is triggered. For notification text, you write "The room became too hot at @(TriggeredTimestamp)". If the alarm is triggered at the time 2015-02-12 13:51:36, the notification file will contain the text: "The room became too hot at 2015-02-12 13:51:36."
The notification report template in XLSX consists of XML translation of substitution codes. For more information, see XML Notation for Substitution Codes in XLSX Report Template .
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.
Alarms substitution codes represent the information you want to display when a notification report is triggered. The information is dynamically filled in from the alarms that are included in the notification report.
For more information, see Alarms Substitution Codes .
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 .
Groups substitution codes represent the information you want to display when a notification report is triggered. The information is dynamically filled in from the groups that are included in the notification report.
For more information, see Groups Substitution Codes .
Multi Log list substitution codes represent the information you want to display when a notification report is triggered. The information is dynamically filled in from the multi log list that are included in the notification report.
For more information, see Multi Log List Substitution Codes .
Properties and Watch View Properties Substitution Codes
Properties and watch view properties 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 view properties data that are included in the notification report.
For more information, see Properties and Watch View Properties Substitution Codes .
Trend Log Records Substitution Codes
Trend log records substitution codes represent the information you want to display when a notification report is triggered. The information is dynamically filled in from the trend log records.
For more information, see Trend Log Records Substitution Codes .
Users substitution codes represent the information you want to display when a notification report is triggered. The information is dynamically filled in from the users that are included in the notification report.
For more information, see Users 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 EcoStruxure BMS, we have created Building A and Building B with a number of identical rooms. Building A has three rooms: Room 1, Room 2, and Room 3. Building B has three rooms: Room 1, Room 2, and Room 3. Each room has a value and a trend log that logs the room temperature. Each room also has a value and a trend log that logs the 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 EcoStruxure BMS, we have created Building A and Building B with a number of identical rooms. We have also created a folder for the repeption area in Building A. In the Reception folder, we have created an analog value and a trend log that logs the temperature in the reception area. The value is connected to an alarm. A notification report that contains the log data is to be displayed in a web browser when a user manually triggers the notification.
For more information, see Notification Report Example 2 .
In WorkStation, in the System Tree pane, select the folder or EcoStruxure BMS server where you want to create the notification report template.
On the File menu, point to New and then click Notification .
In the Create Object wizard, in the object type list, click Notification Report Template .
In the Name box, type a name for the notification report template.
In the Description box, type a description for the notification report template.
Click Next .
In the Configure Notification Report Template page, click the Add button
to add a data type to the notification report template.action_zoom_plus_stroke 
To add the Events data type, select Events and complete the following steps:
In the Name box, type a name for the report data type template.
In the Description box, type a description for the report data type.
Click Next .
Select the Add relative source box to add a relative source to the filter.
In the Relative to box, enter the object with the relation to the notification report template that you want to use as a template for where notification reports are generated.
In the Relative source box, add the object in relation to the 'Relative to' property.
In the Source preview box, view how the source appears in the notification report text.
Click the Add button
to add a condition for when the event is written to the notification report.action_zoom_plus_stroke
In the Add/Remove Conditions dialog box, select the conditions that have to be met before the event is written to the notification report.
In the Template box, enter the text or substitution codes you want to use in the notification report.
From the list of available substitution codes, add the substitution codes you want to use in the notification or notification report to the Template box.
In the Template delimiter box, enter the delimiter you want to use to separate the event records in the notification report.
In the Preview box, view how the events appear in the notification report text.
In the Substitute missing data with box, enter the text or characters to replace missing data.
In the Number of events box, enter the maximum number of events to add to the notification report.
Click Create .
Note:You can use substitution codes, blank spaces, blank rows, and all printable characters in the notification text.
To add the Properties data type, select Properties and complete the following steps:
In the Name box, type a name for the report data type template.
In the Description box, type a description for the report data type.
Click Next .
Click the Add button
to add a property to the notification report template.action_zoom_plus_stroke
In the Select Object and Properties dialog box, select the object and properties that you want to use in the notification report template.
In the Property template box, enter the text or substitution codes you want to use in the notification report.
From the list of available substitution codes, add the substitution codes you want to use in the notification or notification report to the Property template box.
In the Property delimiter box, enter the delimiter you want to use to separate the properties in the notification report.
In the Preview box, view how the properties values appear in the notification report text.
In the Substitute missing data with box, enter the text or characters to replace missing data.
Click Create .
Note:You can use substitution codes, blank spaces, blank rows, and all printable characters in the notification text.
In the Configure Notification Report Template page, click the Add button
to add a data type to the notification report template.action_zoom_plus_stroke
To add the relative properties data type, select Relative Properties and complete the following steps:
In the Name box, type a name for the report data type template.
In the Description box, type a description for the report data type.
Click Next .
In the Relative to box, enter the object with the relation to the notification report template that you want to use as a template for where notification reports are generated.
Click the Add button
to add properties to the notification report template.action_zoom_plus_stroke
In the Select Object and Properties dialog box, select the object and properties that you want to use in the notification report template.
In the Property template box, enter the text or substitution codes you want to use in the notification report.
From the list of available substitution codes, add the substitution codes you want to use in the notification or notification report to the Property template box.
In the Property delimiter box, enter the delimiter you want to use to separate the properties in the notification report.
In the Preview box, view how the properties appear in the notification report text.
In the Substitute missing data with box, enter the text or characters to replace missing data.
Click Create .
Important:If you have more than one relative data type in the same notification report, you can only have one relative reference point for all of the relative data types.
Note:You can use substitution codes, blank spaces, blank rows, and all printable characters in the notification text.
In the Configure Notification Report Template page, click the Add button
to add a data type to the notification report template.action_zoom_plus_stroke
To add the relative search data type, select Relative Search and complete the following steps:
In the Name box, type a name for the report data type template.
In the Description box, type a description for the report data type.
Click Next .
In the Relative to box, enter the object with the relation to the notification report template that you want to use as a template for where notification reports are generated.
In the Relative search path box, enter the search query in relation to the 'Relative to' property.
In the Template box, enter the text or substitution codes you want to use in the notification report.
From the list of available substitution codes, add the substitution codes you want to use in the notification or notification report to the Template box.
In the Template delimiter box, enter the delimiter you want to use to separate the search results in the notification report.
In the Preview box, view how the relative search results appear in the notification report text.
In the Substitute missing data with box, enter the text or characters to replace missing data.
Click Create .
Important:If you have more than one relative data type in the same notification report, you can only have one relative reference point for all of the relative data types.
Note:You can use substitution codes, blank spaces, blank rows, and all printable characters in the notification text.
In the Configure Notification Report Template page, click the Add button
to add a data type to the notification report template.action_zoom_plus_stroke
To add the relative trend log data type, select Relative Trend Log and complete the following steps:
In the Name box, type a name for the report data type template.
In the Description box, type a description for the report data type.
Click Next .
In the Relative to box, enter the object with the relation to the notification report template that you want to use as a template for where notification reports are generated.
In the Relative log path box, add the trend log in relation to the 'Relative to' property.
In the Record template box, enter the text or substitution codes you want to use in the notification report.
From the list of available substitution codes, add the substitution codes you want to use in the notification or notification report to the Record template box.
In the Record delimiter box, enter the delimiter you want to use to separate the trend log records in the notification report.
In the Preview box, view how the trend log records appear in the notification report text.
In the Substitute missing data with box, enter the text or characters to replace missing data.
Click Create .
Important:If you have more than one relative data type in the same notification report, you can only have one relative reference point for all of the relative data types.
Note:You can use substitution codes, blank spaces, blank rows, and all printable characters in the notification text.
In the Configure Notification Report Template page, click the Add button
to add a data type to the notification report template.action_zoom_plus_stroke
To add the Relative Watch View data type, select Relative Watch View and complete the following steps:
In the Name box, type a name for the report data type template.
In the Description box, type a description for the report data type.
Click Next .
In the Relative to box, enter the object with the relation to the notification report template that you want to use as a template for where notification reports are generated.
In the Relative Watch View path box, enter the Watch View in relation to the 'Relative to' property.
In the Template box, enter the text or substitution codes you want to use in the notification report.
From the list of available substitution codes, add the substitution codes you want to use in the notification or notification report to the Template box.
In the Template delimiter box, enter the delimiter you want to use to separate the Watch View properties in the notification report.
In the Preview box, view how the Watch View properties appear in the notification report text.
In the Substitute missing data with box, enter the text or characters to replace missing data.
Click Create .
Important:If you have more than one relative data type in the same notification report, you can only have one relative reference point for all of the relative data types.
Note:You can use substitution codes, blank spaces, blank rows, and all printable characters in the notification text.
In the Configures Notification Report Template page, click the Add button
to add a data type to the notification report template.action_zoom_plus_stroke
To add the search data type, select Search and complete the following steps:
In the Name box, type a name for the report data type template.
In the Description box, type a description for the report data type.
Click Next .
In the Name box, type a name for the Search data type group.
In the Search query box, enter the path to the saved search query whose result you want to use in the notification or notification report.
In the Template box, enter the text or substitution codes you want to use in the notification report.
From the list of available substitution codes, add the substitution codes you want to use in the notification or notification report to the Template box.
In the Template delimiter box, enter the delimiter you want to use to separate the search results in the notification report.
In the Preview box, view how the search results appear in the notification report text.
In the Substitute missing data with box, enter the text or characters to replace missing data.
Click Create .
Note:You can use substitution codes, blank spaces, blank rows, and all printable characters in the notification text.
In the Configure Notification Report Templat e page, click the Add button
to add a data type to the notification report template.action_zoom_plus_stroke
To add the trend log data type, select Trend Log and complete the following steps:
In the Name box, type a name for the report data type template.
In the Description box, type a description for the report data type.
Click Next .
In the Log reference box, add the path to the trend log you want to use in the notification report.
In the Record template box, enter the text or substitution codes you want to use in the notification report.
From the list of available substitution codes, add the substitution codes you want to use in the notification or notification report to the Record template box.
In the Record delimiter box, enter the delimiter you want to use to separate the trend log records in the notification report.
In the Preview box, view how the trend log records appear in the notification report text.
In the Substitute missing data with box, enter the text or characters to replace missing data.
In the Number of records box, enter the maximum number of trend log records you want to display in the notification report.
Click Create .
Note:You can use substitution codes, blank spaces, blank rows, and all printable characters in the notification text.
In the Configure Notification Report Template page, in the Add button
to add a data type to the notification report template.action_zoom_plus_stroke
To add the Watch View data type, select Watch View and complete the following steps:
In the Name box, type a name for the report data type template.
In the Description box, type a description for the report data type.
Click Next .
In the Watch View box, enter the path to the saved Watch View whose properties you want to use in the notification or notification report.
In the Template box, enter the text or substitution codes you want to use in the notification report.
From the list of available substitution codes, add the substitution codes you want to use in the notification or notification report to the Template box.
In the Template delimiter box, enter the delimiter you want to use to separate the Watch View properties in the notification report.
In the Preview box, view how the Watch View properties appear in the notification report text.
In the Substitute missing data with box, enter the text or characters to replace missing data.
Click Create .
Note:You can use substitution codes, blank spaces, blank rows, and all printable characters in the notification text.
In the Report text box, enter the report text you want to display in the notification report.
From the list of available substitution codes, drag the substitution codes you want to use in the notification report text to the Report text box.
Click Create .
You can use the notification report template in a notification.
Notification Reports
Select Object and Property Dialog Box
Quick Filter
Events Substitution Codes
Properties and Watch View Properties Substitution Codes
Trend Log Records Substitution Codes
Text Formatting
Date and Time Formatting
Notification Report Example 1
Notification Report Example 2
Configuring a Notification Report Template
Notifications
SmartX Server Sends Empty Email Notification