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
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.
Panel | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Email, SMS and Voice scripts in Ignition are extremely easy to use and setup. Before you begin using alarm notifications and customizing message scripts, you need to have Email, SMS and Voice modules installed, alarm notification profiles created, and settings configured. It's best to run through these alarm notification requirements before setting up your custom scripts so you have a smooth implementation of alarm notifications. You only need to install the modules and the profiles that you plan to use.
|
Panel | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
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.
|
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 is using other values that are in the system. This example displays the alarm name, state, and time in hours, minutes, and seconds.
Code Block | ||||
---|---|---|---|---|
| ||||
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 OK.
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.
Delay - how long to wait after the first eligible alarm arrives.
Frequency - maximum frequency with which the profile can send alarms.
For more information on the Delay and Frequency settings, refer to Consolidation.
On_this_page |
---|
|
Scroll HTML Exporter Ignore | |||||||
---|---|---|---|---|---|---|---|
|
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. Use the following steps to access the default call message template and create your own voice call script.
Edit the voice message script and click Save Changes.
New_in | ||
---|---|---|
| ||
You can stop any of these Call Scripts from being read by removing all text in that field.
Image Modified
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.