A template can be defined in the application's config.ini file to control the content of alarm messages. Separate templates can be defined for each of:
• Spoken alarms AlarmSpeechTemplate
• The alarm dialer AlarmDialerTemplate
• Emailed alarms AlarmEmailTemplate
• Paged alarm messages AlarmPagerTemplate
Format control strings take the form: AlarmSpeechTemplate = control string,
The control string can be a combination of words and the following replaceable parameters
|
Parameter |
Meaning |
|
%T |
Speak the time of the alarm |
|
%D |
Speak the date of the alarm |
|
%M |
Speak the alarm description |
|
%V |
Speak the alarm value (this is the value of the alarm trigger at the time that it triggered the alarm) |
|
%U |
Speak the units of the trigger tag. |
|
%P |
Speak the priority of the alarm (note that "High" might sound like a greeting) |
|
%O |
Speak the name of the operator logged on at the time the alarm was triggered. If none, "Logged off" will be used. |
|
%A |
Speak the area of the alarm tag. |
|
%W |
Pause for ¼ second. Has no effect on email or pager messages. |
|
%N |
New sentence for email and pager messages. |
Examples:
AlarmSpeechTemplate = %P alarm. %T, %M
Speaks (for example): "Critical alarm. 10:35 pm, Well level high"
AlarmSpeechTemplate = VTS %P alarm in %A %W %M has reached %V at %T.
"VTS critical alarm in zone one <pause> Holding tank level has reached eighty at eleven forty nine a. m.".
Additionally, there are two template configuration options to control the date and time formats used (if any). These are AlarmTemplateDateFmt and AlarmTemplateTimeFmt. Please refer to the following chapters of the Programmer's Guide for the information about using these options: AlarmTemplateDateFmt and AlarmTemplateTimeFmt.