- 8 minutes to read

Add or manage Alarm Plugins

Nodinite Alarm Plugins deliver automated, actionable alerts to your team. This guide explains Alarm Plugin entries, the concept introduced in Nodinite 7.2.0, and shows how to add, configure, test, delete, and restore them.

✅ One entry, many Monitor Views – Update an entry once; every Monitor View that selects it follows
✅ Default entry per plugin – Each of the four plugins ships with a default entry that holds the base settings
✅ Override only what differs – An added entry inherits every tab from the default entry until you check its Override box
✅ See where it's used – Every entry lists its Monitor Views and opens in Mapify or Mermaid Rendering
✅ Safe deletes – Delete is soft; Permanently Delete is possible only when no Monitor View uses the entry

Understanding Alarm Plugin Entries

Before Nodinite 7.2.0, each Monitor View could hold its own "specific configuration" of an Alarm Plugin, so changing a recipient in ten Monitor Views meant ten edits. Since 7.2.0, the settings live in Alarm Plugin entries, and a Monitor View only selects the entries it uses.

graph LR plugin["fa:fa-plug Alarm Plugin
Email with Options"] def["fa:fa-star Default entry
Email options"] entA["fa:fa-envelope Added entry
Production Support"] entB["fa:fa-envelope Added entry
After-Hours Escalation"] mv1["fa:fa-display Monitor View
Orders"] mv2["fa:fa-display Monitor View
Invoices"] mv3["fa:fa-display Monitor View
Payments"] plugin -->|"ships with"| def plugin -->|"type of"| entA plugin -->|"type of"| entB def -.->|"inherited tabs"| entA def -.->|"inherited tabs"| entB mv1 -->|"selects"| def mv2 -->|"selects"| entA mv3 -->|"selects"| entA mv3 -->|"selects"| entB style plugin fill:#2678BD,color:#fff style def fill:#3F827B,color:#fff style entA fill:#E47528,color:#fff style entB fill:#E47528,color:#fff style mv1 fill:#9E59BB,color:#fff style mv2 fill:#9E59BB,color:#fff style mv3 fill:#9E59BB,color:#fff

An Alarm Plugin (blue) ships with a default entry (teal). Added entries (orange) use the same plugin type and inherit every tab they don't override from the default entry. Monitor Views (purple) select one or more entries; the Payments Monitor View uses two.

Components

Component Role Can you change it?
Alarm Plugin (type) The code that delivers the alert: Email, Email options, Event Log, or Webhook. Nodinite 7 loads only these four; put any extra logic behind the HTTP Webhook ❌ No
Default entry One per plugin, named after it (Email, Email options, Event Log, Webhook). Holds the base settings that added entries inherit ✅ Settings, ❌ type
Added entry Created with Add Alarm, or by the 7.2.0 upgrade from a former Monitor View-specific configuration. Overrides selected tabs ✅ Settings and type (changing the type resets all settings)
Monitor View Selects the entries on its External notifications tab (how) ✅

Default Entry vs. Added Entry

Aspect Default entry Added entry
Alarm Plugin Type Fixed ("Can not be changed on default alarm plugins") Selectable; changing it resets all configuration settings
Configuration tabs All fields editable Each tab starts with an Override … options checkbox; unchecked, the tab inherits from the default entry
Used by Monitor Views ✅ When selected ✅ When selected

Example: Production Support Entry

Add an entry "Production Support" of type Email options that overrides only:

  • Recipients → support@contoso.com, oncall@contoso.com
  • SMTP options → smtp.contoso.com (different from the default entry)
  • Basic → subject [PRODUCTION ALERT] {Status} (see the subject variables)

The Monitoring state options and Recurrence tabs stay unchecked, so they follow the default entry. Select the entry in every production Monitor View.

Upgrading to 7.2.0

When you upgrade, every former Monitor View-specific configuration becomes its own added entry, built on the same plugin and selected by that Monitor View. Your alerts continue to work as before. Afterwards, you may have several identical entries (for example ten that all send to support@contoso.com); consolidate them into one shared entry, select it in those Monitor Views, and then delete the duplicates.

The Entry Edit Page

Open an entry from Administration → Settings → Alarm Plugins in the Nodinite Web Client (Alarm Plugins Overview) by clicking its name, or choose Edit in its Action menu.

Email options default entry with the General, Configuration, and Distributed Notifications tabs, Mapify and Mermaid buttons, Control panel, and Monitor Views panel (7.10)
The Monitor Views panel shows how many Monitor Views use the entry (#6); Edit adds or removes them, and a deleted Monitor View keeps its Deleted badge.

General Tab

Field Help text in the Web Client
Name Name of the Alarm Plugin (read-only on a default entry)
Description Description of the Alarm Plugin
Web Site An address where end-users can get additional information about the Alarm Plugin
Version Version of the Alarm Plugin (read-only)

The page also has:

  • Configuration tab – the Alarm Plugin Type and the plugin's sub-tabs (below)
  • Distributed Notifications tab – see Distributed Notifications
  • Mapify and Mermaid buttons – the same views as in the Action menu (below)
  • Control panel – alarm tests (below)
  • Monitor Views panel – the Monitor Views that use this entry, with Edit to change them

Configuration Tab and Override Checkboxes

The sub-tabs depend on the plugin type:

Plugin Sub-tabs (screen order) Details
Email Basic, Recipients, Monitoring state options, SMTP options, Recurrence E-mail
Email options Basic, Recipients, Monitoring state options, SMTP options, Recurrence E-mail with options
Event Log Basic, Monitoring state options, Recurrence Event Log Alarm Plugin
Webhook Basic, Monitoring state options, Authentication, Proxy, Recurrence HTTP Webhook

On an added entry, each sub-tab starts with an Override … options checkbox, for example Override Monitoring state options: "When checked, allows configuration of this section. When unchecked, inherits the options for this section from the default Email options plugin."

Added Email options entry for one Monitor View with Override Monitoring state options checked on the Monitoring state options tab (7.10)
Only this tab is overridden; the other tabs follow the default Email options entry. The entry has a Delete button because it isn't a default entry.

The Stylesheet is selected on the Basic tab; the Alarm Plugin Object page shows the data the stylesheet receives.

Add an Entry

  1. In the Alarm Plugins list, click + Add Alarm.
    Add Alarm button in the top-right corner of the Alarm Plugins list
    The "+ Add Alarm" button starts a new Alarm Plugin entry.
  2. Enter a meaningful Name and Description on the General tab, for example "Production Support Team".
  3. On the Configuration tab, select the Alarm Plugin Type.
  4. Check Override … options on each tab that should differ from the default entry, and fill in its fields.
  5. Click Save, then run an alarm test.
  6. Select the entry in each Monitor View that should use it (External notifications tab), or click Edit in the entry's Monitor Views panel.

The Action Menu

Every row in the Alarm Plugins list has an Action button.

Action menu with Edit, Show in Mapify, Show in Mermaid, Delete, and a disabled Permanently Delete with its hint (7.10)
"To delete an Alarm Plugin permanently, you must unassign all Monitor Views from it first."

Menu item What it does Available when
Edit Opens the entry edit page Always
Show in Mapify Opens the entry and its relations in Mapify Rendering Requires a Mapify license
Show in Mermaid Opens a static diagram of the entry's relations in Mermaid Rendering Always; no Mapify license needed
Delete Soft-deletes the entry The entry isn't deleted
Restore Restores a deleted entry The entry is deleted
Permanently Delete Removes the entry for good (hard delete) No Monitor View uses the entry

Edit

Action menu with Edit highlighted (7.10)
Clicking the entry name does the same.

Show in Mapify and Show in Mermaid

Both items show how the entry relates to the Monitor Views that use it.

Action menu with Show in Mapify highlighted (7.10)
Show in Mapify opens the interactive Mapify Rendering view; it needs a Mapify license.

Action menu with Show in Mermaid highlighted (7.10)
Show in Mermaid opens a static Mermaid Rendering diagram that you can export or print.

Delete

Delete is a soft delete: the entry is hidden from the list unless Include deleted is checked, Monitor Views can no longer select it, and you can restore it.

Action menu with Delete highlighted (7.10)
Delete is always available on an entry that isn't deleted.

Confirm with Yes, or click No to keep the entry.

Confirm intent to Delete dialog for the Alarm Plugin Email options for INT001 - Order Monitoring (7.10)
The dialog names the entry you are about to delete.

Success message: Alarm Plugin Email options for INT001 - Order Monitoring is now deleted (7.10)
The message confirms the soft delete.

Restore

Check Include deleted in the list (Show deleted records), open the Action menu of the deleted entry, and choose Restore.

Action menu of a deleted entry with Restore highlighted and Permanently Delete enabled (7.10)
On a deleted entry, Restore replaces Delete.

Confirm intent to Restore dialog for the Alarm Plugin Email options for INT001 - Order Monitoring (7.10)
Confirm to make the entry available to Monitor Views again.

Success message: Alarm Plugin Email options for INT001 - Order Monitoring is now restored (7.10)
The message confirms the restore.

Permanently Delete

Permanently Delete (hard delete) removes the entry for good and can't be undone. It is enabled only after every Monitor View has been removed from the entry: remove them with Edit in the entry's Monitor Views panel, or select another entry in each Monitor View.

Action menu with Permanently Delete enabled and highlighted for an entry that no Monitor View uses (7.10)
With no Monitor Views assigned, Permanently Delete is enabled.

Control - Test Alarm Plugin

Test the entry with its saved settings from the Control panel:

  • Execute Alarm test – "Sends an Alarm batch with status Error, Warning and 2 x OK to the plugin"
  • Restore Alarm test – "Sends an Alarm batch with status 4 x OK to the plugin"

Control panel with the Execute Alarm test and Restore Alarm test buttons and their help text (7.10)
The Monitoring Service sends the test with the settings currently saved for the entry.

The result appears in the entry's destination: the test recipient of an email plugin, the Test URL of a webhook, or the Application Event Log on the Monitoring Service server for the Event Log Alarm Plugin. If the test fails, the error message points to the cause; see the troubleshooting guides.

Save

Save, Save and close, and Close buttons at the bottom of a Web Client edit page (7.10)
The same three buttons appear on every Administration edit page.

  • Save – Saves the changes and stays on the page.
  • Save and close – Saves and returns to the list.
  • Close – Closes the page without saving.

Next Steps