Configure the email template

Note: For information on overriding default configuration settings, refer to Modify configuration settings.

Follow this procedure to configure the standard appearance of the email message sent when specific alarm conditions occur.

To configure the email template

1. Log on as a computer Administrator. For example, <domain>\dnaInstaller.

2. In the %DNADataRoot%\RealTime\config\Settings directory, either create or open the Realtime_EmailAlarmingTemplate.json file.

3. In the following section of the file, configure the items that appear in the subject line of the email message, as well as the order of the items within the subject line:

   "EmailAlarmingSubjectTemplate": {

   "Station": 0,

   "Alarm Severity": 2,

   "Point Name": 1,

   "Point Description": 0,

   "Alarm Message": 0,

   "Adhoc Message": 0,

   "Alarm Time": 0,

   "Alarm Host": 0

   Note: Do not modify the "EmailAlarmingSubjectTemplate": line.

   The list of valid Value Names is as follows:

   • Station

   • Alarm Severity

   • Point Name

   • Point Description

   • Alarm Message

   • Adhoc Message

   • Alarm Time

   • Alarm Host

4. For any items that you do not want to include in the subject of the email, change its value to 0.

5. For each remaining item, enter the number indicating the order in which it appears in the subject line of the email message.

   For example, in the above extract, Point Name is set to appear first in the subject line of the email message.

6. In the following section of the file, configure the items that appear in the body of the email message, as well as the order of the items within the body:

   "EmailAlarmingBodyTemplate": {

   "Station": 1,

   "Alarm Severity": 2,

   "Point Name": 3,

   "Point Description": 4,

   "Alarm Message": 5,

   "Adhoc Message": 6,

   "Alarm Time": 7,

   "Alarm Host": 8,

   "RTU": 0,

   "DB Name": 0

   Note: Do not modify the "EmailAlarmingBodyTemplate": line.

7. For any item that you do not want to include in the body of the email, change its value to 0.

8. For each remaining item, enter the number indicating the order in which it appears in the body of the email message.

   For example, in the above extract, Alarm Time is set to appear in the seventh line of the email message.

9. All delimiters found in the text of an alarm message will be replaced by a blank character in the email message. When you are configuring the email template for a system whose decimal separator character is a comma (,), you may want to replace the value of LONG_FORMAT_BODY_DELIMITER, MEDIUM_FORMAT_BODY_DELIMITER, and SHORT_FORMAT_BODY_DELIMITER with a character different than a comma so that the values included in the text of the notification are properly formatted.

   Sample Template File:

   {

   "RealTime": {

   "LONG_FORMAT_BODY_DELIMITER": ",",

   "MEDIUM_FORMAT_BODY_DELIMITER": ",",

   "SHORT_FORMAT_BODY_DELIMITER": ",",

   "EmailAlarmingSubjectTemplate": {

   "Station": 0,

   "Alarm Severity": 2,

   "Point Name": 1,

   "Point Description": 0,

   "Alarm Message": 0,

   "Adhoc Message": 0,

   "Alarm Time": 0,

   "Alarm Host": 0

   },

   "EmailAlarmingBodyTemplate": {

   "Station": 1,

   "Alarm Severity": 2,

   "Point Name": 3,

   "Point Description": 4,

   "Alarm Message": 5,

   "Adhoc Message": 6,

   "Alarm Time": 7,

   "Alarm Host": 8,

   "RTU": 0,

   "DB Name": 0

   }

   }

10. Save the file.

11. Restart the following services:

    • RealTime

    • Common