Alarms

maiLink uses alarms to help users identify problems with devices in the field. Alarms are set by workflows, and once set, can be see in different places in the user interface.

You team can define different alarms for different purposes. An example might be the following set of four alarms:

Alarm Purpose
Error 1000 Pump pressure has exceeded 500 psi.
Error 1013 Pump pressure has exceeded 600 psi.
Error 2107 Filters need cleaning (insufficient airflow).
Warning 2107 Filters need cleaning (excessive hours in use).

Note: Alarms span workflows, meaning that multiple workflows can set the same alarm.
Note: Alarms can also span models, although maiData discourages that.

  • Caution: It is strongly recommended that you do not create alarms for use on multiple models.
  • Caution: A future release will include further information in the definition of an alarm that will make sharing alarms across models undesireable.

Alarms

Displaying Alarms

Alarms are displayed to users in several places:

  1. Click on the Devices selection in the maiLink UI top bar.
    • Any device (row) with an Alarm icon (🔔) has alarms that are currently set.
    • The number of alarms is shown with that icon.
  2. Navigate to a Devices > Device page.
    • In the lefthand menu the Alarms side tab selection may show an Alarm icon (🔔).
    • It will be displayed if any alarms are set for this device.
    • The number of alarms currently set is shown with that icon.
  3. Navigate to a Devices > Device > Alarms page.
    • The table indicates a history of all the alarms that have been set.
    • Active alarms are shown with the Alarm icon (🔔).
    • The number of alarms since the first alarm, or since the alarms were last cleared is also shown.

Defining Alarms

Alarms are a simple concept. Each has a name and a description. To create Alarms:

  1. Navigate to Settings (⚙).
  2. Select Alarm Definitions on the lefthand tabs.
  3. Click on Create Alarm to add a new alarm. Make sure the name of the alarm is unique.

Setting and Clearing Alarms

Setting Alarms

Alarms are set by workflows. Within a workflow you can add a Set an Alarm workflow step. You will be asked to select the name of the Alarm that you want to set from the list of Alarm Definitions. When the workflow is triggered, when it reaches the Set an Alarm step

  1. Navigate to Settings (⚙).
  2. Select Alarm Definitions on the lefthand tabs.
  3. Click on Create Alarm to add a new alarm. Make sure the name of the alarm is unique.

Clearing Alarms

Clearing alarms is the way that service technicians can indicate that resolution has been acheived. This is not a substitute for your standard service processes for documentation, but it does let clean up the user interface for the next service shift.

  1. Navigate to Devices > Device > Alarms.
  2. On a row with active alarms, click the Clear button.

Resetting Alarms

Resetting alarms may seem a little odd, but it is meant for the situation where perhaps something was not resolved as well as once thought, so the service technician wants to flag it for the next team.

  1. Navigate to Devices > Device > Alarms.
  2. On a row with cleared alarms, click the Reset button.