×
Skip to main content Link Search Menu Expand Document (external link) Right Arrow

Contents

Categories

This is a subinterface under Alarms.

Categories are user-defined groups of alarms with three primary uses:

Each alarm’s category is individually specified in its metadata by selecting it from the corresponding dropdown list; at least one category must be created by the user before an alarm could be categorized. Each alarm can only belong to one category.

Category Management

Categories are managed via a subinterface located at the root of Alarms under a separate tab. Structured similarly to the main interface, it has largely the same elements:

Header Toolbar

Contains a single tool:

  • Create alarms category  Create alarms category
    Creates a new alarm category. Since categories only have one parameter (the name), there is no editing interface.

Categories cannot be created outside this interface; the Alarm Editor only allows to choose from preliminarily defined categories.

List of Categories

Lists all categories alphabetically; unlike alarms, categories cannot be placed in folders. Filter field above the list provides basic search functionality.

Categories have bulk actions that can be applied to one or more selected items:

  • Global selector
    Checkbox; selects/deselects all categories;
  • Count
    If none is selected, counts all categories, referred to as files; if any category is selected, counts the selection only.

Select at least one category 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.
  • MANAGE PERMISSIONS adminRequires administrator privileges under the project; contact EnergyMachines support for details.
    Opens the permission management dialog; changes, if saved, apply to all selected categories.

The list also contains reserved categories covered below.

Each listed category is shown as a panel with the following elements:

  • Checkbox
    If checked, selects the category for bulk actions, see above.
  • Category name
    Non-custom name of the entity.

in the pane opens the context menu for the category, with the following options:

  • Manage Permissions adminRequires administrator privileges under the project; contact EnergyMachines support for details.
    Opens the permission management dialog; changes, if saved, apply to this category only.
  • Show alarms in this category
    Shows the list of alarms for which this category has been set in the metadata; does not list system-generated alarms.
  • Delete adminRequires administrator privileges under the project; contact EnergyMachines support for details.
    Deletes the category (confirmation required).

Deleting a category moves its alarms to No category but does not affect them otherwise.

Click on a category to reveal another toolbar:

  • Delete  Delete adminRequires administrator privileges under the project; contact EnergyMachines support for details.
    Deletes the category (confirmation required).
  • Edit  Edit adminRequires administrator privileges under the project; contact EnergyMachines support for details.
    Opens an interface for renaming the category; categories do not have any other parameters.

Special Categories

Four alarm categories are present by default:

No category

Pre-selected default in the metadata; contains all alarms for which the user has not selected another category. Alarms from other categories can be moved back to No category in the Alarm Editor.

Systems

Intended for system-generated alerts:

Cause or event Label
Server connection loss Name of the project
CPU overload CPU overloaded
Server run out of disk space Disk out of space
Failed to write history History writing error
Device connection error Name of the affected device

Alarms in these categories are visible in all related interfaces, including the SAP, where they are labeled as shown in the table above. However, they do not appear under user-configured alarms or on the category’s list. This provision does not apply to alarms created or imported by the project’s users, if this category is set in the metadata.

External & Notified

Exist by default and can be safely deleted or used as any user-defined category.

Category Permissions

Requires administrator privileges under the project; contact EnergyMachines support for details.

Collapsible lists of all users and user groups with access to the project, with a Filter field atop for convenience.

For each user and user group, provides three checkboxes for different permission levels.

  • Visible
    Check to allow the user (group) to see the alarms under this category in the HMI and on the Portal, including status and statistics.
  • Acknowledge
    Check to allow the user (group) to acknowledge the alarms under this category.
  • Without comments
    By default, alarm acknowledgment requires leaving a comment; check to allow the user (group) to acknowledge the alarms under this category without leaving a comment.

The permissions are listed above hierarchically, i.e., each subsequent permission requires all preceding permissions.