Creating Alarm Notification Templates - viewLinc 5.1

Vaisala viewLinc Enterprise Server version 5.1 User Guide

Document code
M212315EN
Revision
C
Language
English
Product
viewLinc 5.1
Content type
Product description
Product description > Features
Reference information
Document type
User guide

Manage Alarm Templates

An alarm notification template defines who should be notified in the event of a threshold, device, or system alarm. You can set up an email, SMS, a local visual notification (command), voice call, or an escalation path using a combination of notification types, recipients, and delivery times.

Command notifications do not initiate for system alarms.

The content generated for alarm notifications is provided in over 40 default email/SMS/voice templates. Message content can also be customized to send specific information to select groups.

  1. In Alarm Templates, select the Alarm Notifications tab.
  2. Select Add > Add Alarm Notification Template. To copy settings, select an existing template, then select Add > Copy Selected Alarm Notification Template.
    Permissions
    Select the groups authorized to modify or apply this template to Locations.
    Description
    (optional) Provide more details about the alarm notification template.
  3. In the Notification Escalation Path area, select Add to choose an alarm notification format.
  4. To create an email or SMS notification, complete the fields in the Email Notification Settings pane:
    Name
    Type a unique name for each notification. You may want to indicate whether it is an initial or followup notification, or identify the group it goes to.
    Notification delay
    Specify a delay in hours and/or minutes from when an alarm is triggered and you want an alarm notification message sent. Alarm activation delays can also be added to threshold alarms.
    If you set a time delay before a notification message is sent, ensure the combined threshold alarm activation delay and alarm notification delay meets your alarm notification requirements.
    Send to
    Select a user or select a group containing all the users you want notified. All users in the group will receive an alarm notification message (the content varies based on the type of alarm).
    Send recurring notifications
    Turn this option on to send the a repeat notification at set intervals while the alarm condition exists, or after a specific number of notification messages are sent.
    When the alarm is acknowledged
    Specify whether to stop or continue sending notifications after an alarm is acknowledged, and whether to send an acknowledgement notification message and/or an alarm off notification message.
  5. To create a voice notification, complete the fields in the Voice Notification Settings pane:
    Name
    Type a unique name for this notification. You may want to indicate whether it is an initial or followup notification, or identify the users it goes to.
    Notification delay
    Specify a delay in hours and/or minutes from when an alarm is triggered and you want an alarm notification message sent. Alarm activation delays can also be added to threshold alarms.
    If you set a time delay before a notification message is sent, ensure the combined threshold alarm activation delay and alarm notification delay meets your alarm notification requirements.
    Call order list
    To add recipients to a call list, select Edit call list. Select a group which contains the user(s) you want to add, then select users in the order you want them called (you can reset the order with the Order arrows (right column). You can choose more groups to select additional users. Save the list.
    Only users with mobile phone numbers assigned in viewLinc display on the list.
    Send recurring notifications
    Turn this option on to send a repeat voice call at set intervals (every 15 minutes to 24 hours) while the alarm condition exists, or after all call tree notifications are sent. Each user who receives a call has the option to acknowledge the notification and stop the call tree or, if the system preference for voice acknowledgement is not enabled, to confirm receipt of the call, or to verify that the alarm is no longer active (all options require the user to have a mobile phone number and PIN recognized in viewLinc.
    When the alarm is acknowledged
    Specify whether to stop or continue calling recipients after an alarm is acknowledged, and whether to send an acknowledgement notification message and/or an alarm off notification message.
  6. To create a command notification, complete the following fields in the Command Notification Settings window:
    Name
    Type a unique name to describe the command.
    Notification delay
    Specify a delay in hours and/or minutes from when an alarm is triggered and you want the command to run. Alarm activation delays can also be added to threshold alarms.
    If you set a time delay before a command runs, ensure the combined threshold alarm activation delay and command run delay meets your alarm notification requirements.
    Main command to run
    Type the first command you want to run when an alarm is triggered. Additional commands can be set to run in the recurring command area. Here is an example of a Python script specific to a digital relay I/O device. Different parameters apply to different commands or scripts:
    C:\Program Files\Vaisala\viewLinc\python\pythonā€¯ -m viewLinc.scripts.SwitchBbRelay [COM port number]
    Run recurring commands
    Choose to send the same or different command at repeating intervals while the condition still exists; specify whether you want the commands to stop running after the alarm is acknowledged, or after a specific number of commands are run.
    When the alarm is acknowledged
    Choose to continue or block recurring commands.
    Run command when alarm acknowledged/when alarm turns off
    Choose a different command to run when an alarm is acknowledged or when the alarm turns off.
  7. Select Save. You can now apply this alarm notification template to one or more Locations (Sites Manager > Manage), or assign it for use with system alarms (System Preferences > System Alarms).