Contents
Strategic Partner Links
Sepasoft - MES Modules
Cirrus Link - MQTT Modules
Resources
Knowledge Base Articles
Inductive University
Forum
IA Support
SDK Documentation
SDK Examples
Sepasoft - MES Modules
Cirrus Link - MQTT Modules
Knowledge Base Articles
Inductive University
Forum
IA Support
SDK Documentation
SDK Examples
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 2 Next »
Ignition has a built-in script that it uses when it sends out an alarm notification via Email, SMS, and Voice. There is a different script for each notification type. Each notification type has it's own relevant properties for configuration, although, some features are common to all profile types that you will soon discover.
The following modules can be found on the Ignition Downloads page.
Refer to each alarm notification profile below for how to create and modify a profile.
You can configure and customize scripts for Email, SMS and Voice in two locations; in the Alarm Configuration section of the Tag Editor, and in the Notification Block of the alarm pipeline.
Every Notification Block in a pipeline has to have a message to send out. Here you have all the alarm properties to select from to build and test your script. You can specify your Contacts, and enable Consolidation all from the same screen.
The Alarm Configuration has fields to override the message sent from a Pipeline's Notification Block. This is particularly useful if your alarm has a dynamic Pipeline or is being sent to multiple Pipelines. If you're creating your alarm notification for the first time, make sure to specify a Pipeline for the alarm to use.
The alarm's Custom Message property takes precedence over any Notification Block in a pipeline.
There are two methods of sending out alarm notifications: one notification per alarm, and notification consolidation (i.e., multiple alarms in a single Email or SMS). By default, alarm notifications are sent out one message for each alarm.
If you want to use Consolidation, you can use the default Consolidated Message script or create a custom script using the alarm properties. Consolidation is enabled in the Notification Block. When enabled, multiple alarm events are sent together in one message.
Each alarm notification type has a default message script. The Email and SMS default message script is found in the Notification Block shown below. For Voice, the default call script is located in the Voice Notification Profile.
At {eventTime|hh:mm:ss}, alarm "{name}" at "{displayPath}" transitioned to {eventState}
You can override the default message script on a per alarm basis by simply creating a Custom Message script.
Custom Message always takes precedence over the default message
All alarm notification types allow you to define a custom message. If a custom message is created, it will be used instead of the default message in the script.
The following sections describe how to use the default message scripts, build your own custom message scripts, and send out alarm notifications for Email, SMS, and Voice.
Email notifications are the most common method of sending alarm notifications.
Create your Custom Message. You can use static text, bring in tag values and special alarm properties. You can even bind a particular property to an expression to concatenate a string that using other values that are in the system. This example displays the alarm name, state, and time in hours, minutes, and seconds.
The "{name}" alarm became {eventState} at {eventTime|hh:mm:ss} with a value of "{Value}"
Notice that when you select any fields in the Alarm Configuration, the Description Area at the bottom of the window displays details about the property's behavior.
When complete, press Save.
In the Pipeline Notification Block, go to the Contacts tab, and select the On-Call Roster that you want to send alarm notifications too.
If Consolidation is required, enable Consolidation and edit the Delay and Frequency settings. For more information on the Delay and Frequency settings, refer to Consolidation.
SMS works the same way as Email except for a few subtle differences.
Another way to customize the default SMS alarm notification is to build your custom message in the Pipeline Notification Block.
The Voice Notification Module lets you deliver alarm notifications to users via telephone.
Voice calls are delivered through any SIP compatible phone system. No dedicated hardware is required. Using a hosted service like Skype is the quickest way to implement the Voice Notification Module. For more information on how to configure any SIP compatible phone system, refer to the Voice Notification Profile.
The voice message played to the the user during the phone call is defined in the call script which is located in the Voice Notification Profile. The voice message is built off a message template that can reference properties in the alarm. Be aware that the voice message is shared across all voice notification profiles. If you define a custom message, it will be used instead of the default message in the call script.
The default call message template is shown below.
The Voice Notification system is primarily accessed through the Notification Block. The only settings you can configure in the Alarm Configuration section is the Custom Message, and the Alarm Pipeline which defines what state you want to trigger the alarm. All Voice settings that you need to configure are in the Notification Block.