Alarms

This interface is located under General in the Project Profile.

Alarms are a mechanism designed to notify project users when an anomaly is detected in the operating environment. An alarm observes the selected tag(s) and returns a boolean state based on the user-defined tag status conditions.

While similar in setup and functionality to Tag Watchers, alarms are different in that they:

are non-personal. Any alarm configured under a project will be visible to all users with category-specific access;
have multiple possible states;
are strictly project-specific and not capable of cross-project tag evaluation;
are logged and statistically processed.

Two UI tabs represent different subinterfaces:

ALARMS
Contains tools for the management of alarms per se;
CATEGORIES
Contains tools for the management of alarm categories.

This article focuses on the former; for the latter, see Categories.

Similarly to Tags or Pages, alarms are arranged into a tree-like hierarchy that opens at the root level, further branching into folders and/or individual alarms. The alarms interface consists of two primary areas:

Header Toolbar

Provides the following tools:

Export alarms
See Export alarms
Import alarms (root location only)
See Import alarms
Create alarm
Opens the Alarm Editor with default parameters.
Create new folder
Opens the folder creation dialog.

Breadcrumbs path to the current location is found beside the header toolbar and can be used to navigate up the tree of alarms.

List of Entities

Lists folders and alarms, in that order, further sorted alphabetically. Filter field above the list provides basic search functionality.

Bulk actions

Global selector
Checkbox; selects/deselects all items at the current location;
Count
If none is selected, counts all folders and/or alarms at the current location; if any entity is selected, counts selection only. Alarms are referred to as files in the counter.

Select at least one entity to reveal the available bulk actions:

DELETE ^adminRequires administrator privileges under the project; contact EnergyMachines support for details.
Deletes the selected item(s); confirmation required.
MOVE ^adminRequires administrator privileges under the project; contact EnergyMachines support for details.
Lists possible alternative locations for the selected item(s); select a location and press OK to move the item(s) there.
COPY ALARMS IDS
Copies an array of alarm names and IDs, semicolon-separated, for the entire selection:
```
['alarmName;alarmID', 'anotherAlarmName;anotherAlarmID']
```
Alarm IDs can be used, for instance, in API calls.

Item panes

An item pane represents each entity (folder or alarm) and contains the following elements:

Checkbox
If checked, selects the item for Bulk actions.
Entity type
Represented as an icon; alarm icons are color-coded to indicate the alarm status.
Name
Non-custom name of the entity.
Content summary (folders only)
Non-recursiveDoes not take into account the content of subfolders. count of subfolders and/or alarms located in the folder.
Last detected (alarms only)
Date and time of when the alarm was triggered last time.

in the item pane opens its context menu with the following options:

Move, Delete
See Bulk actions.
Rename
Changes the entity’s name.
Custom Name (folders only)
Sets the custom name of the target folder.
Copy alarm id
Copies the ID of the target alarm as a string, e.g., for use in API calls.

Click on a folder pane to reveal its contents; click on an alarm pane to open it in view mode. Alarm viewer has the following tools in the header toolbar:

Delete ^adminRequires administrator privileges under the project; contact EnergyMachines support for details.
Deletes the alarm (confirmation required).
Edit ^adminRequires administrator privileges under the project; contact EnergyMachines support for details.
Opens the alarm in the Alarm Editor.

The alarm viewer also shows the color-coded status indicator beside the name.

Related Interfaces

This article describes an interface that can be used to configure alarms but not to interact with them otherwise. Interactions are available via the Status and Actions Panel at the following locations, which also present statistics and real-time overviews:

HMI for alarms within a specific project;
Portal for alarms across all projects where the user has appropriate access.

Note as well that only alarms created or imported by the project’s user(s) are listed as described above. The related interfaces, however, may also contain system-generated alarms covered in Special Categories.

Contents