Alarm Rules

Alarm rules live on the device profile. A solution already creates a profile, so edit that profile instead of creating a second one. The in-app Help Wizard (Account) is the setup order.

Alarm Rules Tab

• Add Rule
• Edit
• Delete

Table Columns

• Delete Alarm Rule?
• Delete Device Profile?

Rule Editor Sections

• Rule Details

Main Rule Fields

• Rule Name

Add an Alarm Rule

1. Open a device profile.
2. Open the Alarm Rules tab.
3. Click Add Rule.
4. Choose the source type and type the key. The list shows keys already stored. You can type a key before any reading of that key has been stored.
5. Add one or more severity stages.
6. Set the clear condition.
7. Create the rule.

Edit an Alarm Rule

1. Open a device profile.
2. Open the Alarm Rules tab.
3. Edit an existing rule.
4. Update rule settings, severity stages, or clear condition.
5. Save the rule.

Delete an Alarm Rule

1. Open a device profile.
2. Open the Alarm Rules tab.
3. Delete a rule.
4. Confirm the deletion.

Static or dynamic limit

A numeric value rule can use a fixed number, or one device attribute such as voltageLimit. The number must be finite and its absolute value must be at most 1e12. A larger number, or a value that is not a number, is refused and is not stored as 0.

• Static — each severity is a number typed on the rule.
• Dynamic — pick the attribute, then Percent or Offset. Each severity stores only that percent or offset. If voltageLimit is 280 and Critical is 98%, the alarm line is 274.4. Those severity numbers are calculated when a value arrives. They are not stored as extra attributes.

If the attribute is missing, the rule does not fire. The highest matching severity is the one alarm that shows.

These profile rules still run when a rule engine on the same profile also has an alarm node. Keep the profile rule for the plain threshold. Use the chain for a different condition.

Threshold or forecast

On a telemetry number, the rule asks what it watches.

• Threshold — the live value. This is the rule you already have. It opens when the reading crosses the limit, and it stays open while the reading is still across that line.
• Forecast — the stored trend. It opens while the line will reach the limit inside the horizon you set, and the live value is still on the safe side. Horizon is in hours. It needs at least two stored readings. It uses a straight line through those readings. It does not use the optional forecast sidecar.

A forecast rule clears on its own when any of these is true:

• the crossing moves further away than the horizon
• the trend turns back, so the line is no longer heading at the limit
• the live value crosses the limit

After the value has crossed, the forecast rule is quiet. It does not send a command. If you also want an alarm at the crossing, add a second rule on the same key and leave that one as Threshold. Both run. They are different conditions. Do not put the same limit in the rule engine as well, unless the chain is for a different action.

Forecast is only for a telemetry number. An attribute, a text value, a boolean, or a no-data rule stays a threshold or a no-data rule.

The alarm list tags a forecast alarm Forecast. Open it to read the hours and the horizon. The value column is the latest reading, not the limit.

When an alarm opens

Each severity, and the clear line, can wait before it acts.

• Simple — opens on the first reading that crosses the line.
• Duration — the value must stay over the line for the number of seconds you set.
• Repeating — the value must cross the line on several readings in a row.

Clear uses the same three choices. A clear line that sits away from the raise line stops a flicker from closing and opening a new alarm.

New stages start as Simple. A rule saved before these choices loads as Simple, or as Duration when it already had a hold time.

Configure Severity Stages

1. Open the alarm rule modal.
2. Add one or more severity stages.
3. Set severity, the open type (Simple, Duration, or Repeating), and the limit.
4. Set the clear type the same way.
5. Save the rule.

Source and Key Selection

Alarm rule key options depend on the selected source type and can load telemetry keys or attribute keys. Type a key when that list is empty. The rule watches the key you typed.

Severity Stage Requirement

An alarm rule must include at least one severity stage before it can be saved.

Empty States

• The alarm rules tab shows an empty state when no alarm rules exist.
• The alarm rule modal shows an empty state when no severity stages have been added yet.