Page tree
Skip to end of metadata
Go to start of metadata

The Alarms tab is used to define alarms for the thing definition.

Alarms are used to define interesting events for a thing. Alarms are implemented as a state machine, where the events are defined as alarm states. For example: For a thing that represents a tank, defining an alarm for "low level". For a thing that represents an engine, defining an alarm for whether the engine is on or off.

Things can have multiple alarms.

Each alarm can have up to 99 states. Alarm states have a numeric alarm state value (assigned sequentially by the system), a text alarm state name, and a color (value) used when viewing the alarm on the thing's page in the Management Portal. Note that the numeric alarm state value can only be viewed in the thing definition, but will not appear until after the thing definition is saved.

Alarms can be graphed, since they have a state and timestamp component.

Selecting the + Alarm Definition link will display a New alarm definition section. Selecting the - Delete alarm definition link will delete the currently displayed alarm.

Enter or select the fields for the new alarm definition. The fields are:

Field
Description
KeyThe key for the alarm definition.
A key is an identifier that must be globally unique within the organization.
The valid characters for a key are letters, numbers, "_" (underscore), and "-" (hyphen).
NameThe name of the alarm definition that is displayed on Management Portal pages.
View security tagsEnter any number of tags to the alarm that control whether a user or application can view the alarm. The user or application must have a role that has the same view security tag associated with it in order to view an alarm with a view security tag associated with it.
Update security tagsEnter any number of tags to the attribute that control whether a user or application can update the alarm. The user or application must have a role that has the same update security tag associated with it in order to update an alarm with an update security tag associated with it.

Selecting the + New alarm state link will display a new set of fields for an alarm state. Selecting the - Delete alarm state link will delete that set of alarm state fields.

Enter or select the fields for the new alarm sate. The fields are:

FieldDescription
NameThe name of the alarm state.
ColorThe color selection for the alarm state. This can be entered as a hex color code or selected from a color picker.
Related topics

Publish Alarm

Alarm service



  • No labels