Email template file

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

The email template file controls the items that appear in the subject and body of emails. The RealTime_EmailAlarmingTemplate.json file resides in the following directory: %DNAInstallRoot%\RealTime\config\Settings

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.

Note: If you need to change any of these values, they can be overridden by copying or creating a new RealTime_EmailAlarmingTemplate.json settings file to the %DNADataRoot%/Realtime/config/Settings data directory and changing the values in the new file.

The contents of the file are as follows:

{

"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

},

"LongAlarmingSubjectTemplate": {

Station": 0,

Alarm Severity": 2,

Point Name": 1,

Point Description": 0,

Alarm Message": 0,

Adhoc Message": 0,

Alarm Time": 0,

Alarm Host": 0

},

"LongAlarmingBodyTemplate": {

Alarm Host": 1,

Short Host Name": 0,

Alarm Time": 2,

DB Name": 3,

Point Name": 4,

Point Description": 5,

RTU": 6,

Alarm Message": 7,

Station": 0,

Alarm Severity": 0,

Adhoc Message": 0

},

"MediumAlarmingSubjectTemplate": {

Station": 0,

Alarm Severity": 2,

Point Name": 1,

Point Description": 0,

Alarm Message": 0,

Adhoc Message": 0,

Alarm Time": 0,

Alarm Host": 0

},

"MediumAlarmingBodyTemplate": {

Alarm Host": 0,

Short Host Name": 1,

Alarm Time": 2,

DB Name": 3,

Point Name": 4,

Point Description": 0,

RTU": 0,

Alarm Message": 5,

Station": 0,

Alarm Severity": 0,

Adhoc Message": 0

},

"ShortAlarmingSubjectTemplate": {

Station": 0,

Alarm Severity": 2,

Point Name": 1,

Point Description": 0,

Alarm Message": 0,

Adhoc Message": 0,

Alarm Time": 0,

Alarm Host": 0

},

"ShortAlarmingBodyTemplate": {

Alarm Host": 0,

Short Host Name": 1,

Alarm Time": 2,

DB Name": 0,

Point Name": 3,

Point Description": 0,

RTU": 0,

Alarm Message": 4,

Station": 0,

Alarm Severity": 0,

Adhoc Message": 0

}

}

}

As indicated in the file, the first object section contains the items that appear in the subject of the email, while the second object section contains the items that appear in the body of the email.

The numbered values appearing in each line are used to either turn off a value or indicate the order in which a value appears in the subject/body of the email. For example, in the first object section above:

• Station has a value of 0, meaning it will not appear in the subject line of the email.

• Point Name has a value 1, and so will appear in the subject line before Alarm Severity (which has a value of 2).

• Point Description, Alarm Message, Adhoc Message, Alarm Time, and Alarm Host will not appear in the subject line, as they all have a value of 0.

Administrators can modify the RealTime_EmailAlarmingTemplate.json file as desired.