Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Prior to SMartServer 3.5, the alarms and events widget was called alarms.

You can manage alarm notifications in the SmartServer through the CMS Alarms and Events widget as described in Setting up Alarm Email Notifications 1479652You can also set up alarm notifications to be sent as emails.  To send an alarm email notifications from the SmartServer, you must 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 alarms 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 criteria is met, you may receive multiple emails for any alarm type.

Note
Note: Alarms are only supported for scalar datapoints; datapoints with multi-fields are not supported. If alarming is needed for multi-field datapoints (e.g., SNVT_switch), then consider using a SmartServer internal app.

The Alarms and Events widget displays the time, device name, and the UID for each discovered alarm condition. It also provides the ability to editcreate, copy, edit, and remove delete alarm definitions as described in this section

This section includes of the following tasks:

...

To create an alarm definition and set email notifications, perform the following steps:

  1. Open the Alarms and Events widget. Click the Expand button ().

    Image RemovedImage Added

  2. Click the Action Alarm Definitions button (Image RemovedImage Added) and select the Alarm Definitions action
    Image Removed

    The Alarm Definitions view appears.
    Image Removed
    Image Added

  3. Click the Action Create Alarm Definition button (Image Removed) and select the Create Alarm Definition action.
    Image RemovedImage Added) .

    The Create Add Alarm Definition view appears.
    Image Removed
    Image Added

  4. Enter the alarm definition information.

    Enter
    • Name
    • Description
    • Alarm Type – options include (this list is dynamic and can grow as additional alarm conditions are defined):
      • CMS Error
      • CMS Warning
      • Cleared Alarms
      • Created Device
      • Created Device Type
      • Deleted Device Type
      • Deleted Events
      • Deleted Logged Data
      • Device Not Communicating
      • Type MismatchExport 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 Changes
      • Power Cycling
      • Provisioning Failure
      • SmartServer IAP
      • Succesfull Logon
      • Type Mismatch
      • Unknown TypeFirmware Update Failed
      • Unsuccessful LogonUser Account Changes
    • Description – optional alarm definition description
    • Scope – Group (for multiple device) or Device Target
      Image Removed
    Click NEXT.
    The notification list view appears.
    Image Removed
    • (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.
    Image Removed

    • Image Added

  5. Click SAVE.

    The new alarm definition is added to the list of Alarm Definitions view appears.
    Image Removed
    Image Added

  6. Click BACK to return to the Alarms and Events widget view.

Editing Alarm Definitions

...

Creating an Alarm Definition from a Copy

To create an alarm definition from a copy of an existing alarm definition, perform the following steps:

  1. Open the Alarms and Events widget. Click the Expand button ().

    Image RemovedImage Added

  2. Click the Action Alarm Definitions button (Image Removed) and select the Alarm Definitions actionImage Added)
    Image Removed

    The Alarm Definitions view appears.
    Image Removed
    Image Added

  3. Click the Edit Action button (Image RemovedImage Added) for the alarm definition that you want to editcopy and select the Copy action.
    A view that allows you to edit the selected alarm definition

    Image Added


    The Add Alarm Definition view appears.
    Image Removed
    Image Added

  4. Edit the alarm definition information as needed.

    Edit
    • Name
    • Description
    • Alarm Type – options include (this list this list is dynamic and can grow as additional alarm conditions are defined):
      • CMS Error
      • CMS Warning
      • Cleared Alarms
      • Created Device
      • Created Device Type
      • Deleted Device Type
      • Deleted Events
      • Deleted Logged Data
      • Device Not Communicating
      • Export Process Completed
      • Type MismatchExport 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 Changes
      • Power Cycling
      • Provisioning Failure
      • SmartServer IAP
      • Succesfull Logon
      • Type Mismatch
      • Unknown TypeFirmware Update Failed
      • Unsuccessful LogonUser Account Changes
    • Description – optional alarm definition description
    • Scope – Group (for multiple device) or Device Target
      Image Removed
    Click NEXT.
    • (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.
    Image Removed

    • Image Added

  5. Click SAVE  to confirm to save the alarm definition changes.

    The Alarm Definitions view appears.
    Image Removed
    Image Added

  6. Click BACK to return to the Alarms and Events widget view.

...

Editing Alarm Definitions

To copy edit an existing alarm definition, perform the following steps:

  1. Open the Alarms and Events widget. Click the Expand button ().

    Image RemovedImage Added

  2. Click the
  3. Action
  4. Alarm Definitions button (
  5. Image Removed) and select the Alarm Definitions action
  6. Image Added).
  7. Image Removed

  8. The Alarm Definitions view appears.
  9. Image Removed

  10.  Image Added

  11. Click the
  12. Copy
  13. Action button (
  14. Image Removed
  15. Image Added) for the alarm definition that you want to
  16. copy
  17. edit and select the Edit action.

    Image Added

    The
  18. Create
  19. Add Alarm Definition view appears.
  20. Image Removed

  21. Image Added

  22. Edit the alarm definition as needed.

    Enter
    • NameDescription
    • Alarm Type – options include (this list this list is dynamic and can grow as additional alarm conditions are defined):
      • CMS Error
      • CMS Warning
      • Cleared Alarms
      • Created Device
      • Created Device Type
      • Deleted Device Type
      • Deleted Events
      • Deleted Logged Data
      • Device Not Communicating
      • Export Process Completed
      • Export Process Started
      • Firmware UpdateType
      • MismatchFirmware Update Failed
      • Import Process Completed
      • Import Process Started
      • Initiated Discovery
      • Logoff
      • MQTT Configuration Not Updated
      • Modified Device
      • Modified Device Type
      • Password Not Updated
      • Permission Changes
      • Power Cycling
      • Provisioning Failure
      • SmartServer IAP
      • Succesfull Logon
      • Type Mismatch
      • Unknown TypeFirmware Update Failed
      • Unsuccessful LogonUser Account Changes
    • Description – optional alarm definition description
    • Scope – Group (for multiple device) or Device Target
    Click NEXT.
    • (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
    • use a comma
    a
    • 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.
    Image Removed

    • Image Added

  23. Click SAVEto  to save the alarm definition that was created from a copy to the list.
    Image Removed.

    The Alarm Definitions view appears.

    Image Added

  24. Click BACK to return to the Alarms and Events widget view.

...

  1. Open the Alarms and Events widget. Click the Expand button ().

    Image RemovedImage Added

  2. Click the Action Alarm Definitions button (Image Removed) and select the Alarm Definitions actionImage Added)
    Image Removed

    The Alarm Definitions view appears.
    Image Removed
    Image Added

  3. Click the Delete Action button (Image RemovedImage Added) for the alarm definition that you want to remove.edit and select the Delete action.

    Image Added


    A confirmation dialog box appears.
    Image Removed
    Image Added

  4. Click OK to remove the selected alarm definition.
    Image Removed
    The Alarm Definitions view appears.

    Image Added

  5. Click BACK to return to the Alarms and Events widget view.

...