Setting up Alarm Email Notifications
- Nina Cardillo
Prior to SmartServer 3.5, the Alarms and Events widget was called the Alarms widget.
You can manage alarm notifications in the SmartServer using the CMS Alarms and Events widget as described in Managing Alarm Notifications. You can also set up alarm notifications to be sent as emails as described in this section.
To send an alarm email notification from the SmartServer, first set up an SMTP server that the SmartServer can use to send the email. See Configuring SMTP Settings section located in Configure Your SmartServer.
Once an alarm occurs, it will appear in the Alarms and Events widget for a specific target. To see another occurrence of an alarm type for a specific target, you must first clear the alarm. For example, a datapoint has up to four alarm types: Low Warning, Low Error, High Warning, and High Error. Only one entry for each alarm type will appear in the Alarms and Events widget for a specific datapoint; however, the same alarm type may appear for multiple datapoints. Since an email is sent each time an alarm criterion is met, you may receive multiple emails for any alarm type.
The Alarms and Events widget displays the time, device name, and the UID for each discovered alarm condition. It also provides the ability to create, copy, edit, and delete alarm definitions as described in this section.
This section includes of the following tasks:
Creating Alarm Definitions and Email Notifications
To create an alarm definition and set email notifications, perform the following steps:
Open the Alarms and Events widget. Click the Expand button (
).
Click the Alarm Definitions button (
).
The Alarm Definitions view appears.Click the Create Alarm Definition button (
) .
The Add Alarm Definition view appears.Enter the alarm definition information.
Name
Alarm Type – options include (this list is dynamic and can grow as additional alarm conditions are defined):
CMS Error
CMS Warning
Cleared Alarm
Created Device
Created Device Type
Deleted Device Type
Deleted Event
Deleted Logged Data
Device Not Communicating
Export Process Completed
Export Process Started
Firmware Update
Firmware Update Failed
Import Process Completed
Import Process Started
Initiated Discovery
Logoff
MQTT Configuration Not Updated
Modified Device
Modified Device Type
Password Not Updated
Permission Change
Power Cycle
Provisioning Failure
SmartServer IAP
Successful Logon
Type Mismatch
Unknown Type
Unsuccessful Logon
User Account Change
Description – optional alarm definition description
Scope – Group (for multiple device) or Device (for a single device)
Target – specific device(s), or check the Select All option for all devices
Notify List – allows you to set email notifications for alarms. Enter the user or email address where alarm notifications are to be sent (use a comma separator when entering multiple users or emails). If you are entering a user, the alarm notifications will be sent to the email address that is specified in the user settings.
Click SAVE.
The Alarm Definitions view appears.Click BACK to return to the Alarms and Events widget view.
Creating an Alarm Definition from a Copy
To create an alarm definition from a copy of an existing alarm definition, perform the following steps:
Open the Alarms and Events widget. Click the Expand button (
).
Click the Alarm Definitions button (
).
The Alarm Definitions view appears.Click the Action button (
) for the alarm definition that you want to copy and select the Copy action.
The Add Alarm Definition view appears.Edit the alarm definition information as needed.
Name
Alarm Type – options include (this list is dynamic and can grow as additional alarm conditions are defined):
CMS Error
CMS Warning
Cleared Alarm
Created Device
Created Device Type
Deleted Device Type
Deleted Event
Deleted Logged Data
Device Not Communicating
Export Process Completed
Export Process Started
Firmware Update
Firmware Update Failed
Import Process Completed
Import Process Started
Initiated Discovery
Logoff
MQTT Configuration Not Updated
Modified Device
Modified Device Type
Password Not Updated
Permission Change
Power Cycle
Provisioning Failure
SmartServer IAP
Successful Logon
Type Mismatch
Unknown Type
Unsuccessful Logon
User Account Change
Description – optional alarm definition description
Scope – Group (for multiple device) or Device (for a single device)
Target – specific device(s), or check the Select All option for all devices
Notify List – enter the user or email address where alarm notifications are to be sent (use a comma separator when entering multiple users or emails). If you are entering a user, the alarm notifications will be sent to the email address that is specified in the user settings.
Click SAVE to save the alarm definition.
The Alarm Definitions view appears.Click BACK to return to the Alarms and Events widget view.
Editing Alarm Definitions
To edit an existing alarm definition, perform the following steps:
Open the Alarms and Events widget. Click the Expand button (
).
Click the Alarm Definitions button (
The Alarm Definitions view appears.Click the Action button (
The Add Alarm Definition view appears.Edit the alarm definition as needed.
Name
Alarm Type – options include (this list is dynamic and can grow as additional alarm conditions are defined):
CMS Error
CMS Warning
Cleared Alarm
Created Device
Created Device Type
Deleted Device Type
Deleted Events
Deleted Logged Data
Device Not Communicating
Export Process Completed
Export Process Started
Firmware Update
Firmware Update Failed
Import Process Completed
Import Process Started
Initiated Discovery
Logoff
MQTT Configuration Not Updated
Modified Device
Modified Device Type
Password Not Updated
Permission Change
Power Cycle
Provisioning Failure
SmartServer IAP
Successful Logon
Type Mismatch
Unknown Type
Unsuccessful Logon
User Account Change
Description – optional alarm definition description
Scope – Group (for multiple device) or Device (for a single device)
Target – specific device(s), or check the Select All option for all devices
Notify List – enter the user or email address where alarm notifications are to be sent (use a comma separator when entering multiple users or emails). If you are entering a user, the alarm notifications will be sent to the email address that is specified in the user settings.
Click SAVE to save the alarm definition.
The Alarm Definitions view appears.Click BACK to return to the Alarms and Events widget view.
Removing Alarm Definitions
To remove an alarm definition, perform the following steps:
Open the Alarms and Events widget. Click the Expand button (
).
Click the Alarm Definitions button (
The Alarm Definitions view appears.Click the Action button (
A confirmation dialog box appears.Click OK to remove the selected alarm definition.
The Alarm Definitions view appears.Click BACK to return to the Alarms and Events widget view.