- 11 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 on a deleted entry that no Monitor View uses

Add the Alarm Plugin entry Contoso: Ops e-mail of type Email options with its own recipients, animated walkthrough (7.12)
Animated walkthrough: a new entry with its own recipients, ready for Monitor Views to select. The steps are under Add an 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.12)
The Monitor Views panel shows how many Monitor Views use the entry (#2), each with Mapify and Mermaid icons; 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; shown on default entries 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.12)
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.

Recurrence

Alert recurrence is set on the Alarm Plugin entry only, never on the Monitor View. On the Recurrence sub-tab, tick Enable Recurrence and pick a Time Interval per state: OK, Warning, Error, Unavailable, and Connection Error. On an added entry, tick Override Recurrence options first; unticked, the entry follows the default entry.

A Monitor View only selects entries on its External notifications tab. The Monitoring Service keeps one timer per entry and Monitor View, so each Monitor View that selects the entry gets its own reminders while it stays in that state. The intervals come from Time Interval Configurations.

Set recurrence on the entry Contoso: Ops e-mail, Error every 15 minutes and Warning every hour, animated walkthrough (7.12)
Animated walkthrough: reminders while a Monitor View stays in Error or Warning.

New 7.12 After Save, the tab keeps the chosen intervals; earlier versions showed 0 Seconds until the page was reloaded.

Recurrence tab of the entry Contoso: Ops e-mail right after Save, with Error 15 Minutes and Warning 1 Hour still selected (7.12)
The saved intervals stay in the fields after Save.

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 (7.12)
    The "+ Add Alarm" button starts a new Alarm Plugin entry.
  2. Enter a meaningful Name and Description on the General tab, for example Contoso: Ops e-mail.
  3. On the Configuration tab, select the Alarm Plugin Type, for example Email options.
  4. Check Override … options on each tab that should differ from the default entry, and fill in its fields; on the Recipients tab, for example, Sender and Mail to.
  5. Click Save or Save and close (Cancel leaves without saving), then run an alarm test from the saved entry.
  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 of a live entry with Edit, Show in Mapify, Show in Mermaid, and Delete (7.12)
A live entry has no Permanently Delete; it appears once the entry is deleted.

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) The entry is deleted, you are an Administrator, and no Monitor View uses it

Edit

Action menu with Edit highlighted (7.12)
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.12)
Show in Mapify opens the interactive Mapify Rendering view; it needs a Mapify license.

Action menu with Show in Mermaid highlighted (7.12)
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, and you can restore it. A Monitor View that selected the entry keeps it, marked Deleted, until you remove it there.

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

Delete the entry Contoso: Temp alert and restore it from the list, animated walkthrough (7.12)
Animated walkthrough: a delete you can take back.

  1. Filter the list, open the Action menu of the entry, and choose Delete.
  2. Confirm with Yes. The message says Alarm Plugin Contoso: Temp alert is now deleted!
  3. Check Include deleted. The entry shows with a Deleted badge.
  4. Open its Action menu, choose Restore, and confirm with Yes. The entry is Available again.

Restore

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

Action menu of a deleted entry with Edit, Show in Mapify, Show in Mermaid, Restore, and Permanently Delete, Restore highlighted (7.12)
On a deleted entry, Restore replaces Delete.

Permanently Delete

Permanently Delete (hard delete) removes the entry for good and can't be undone. It needs an Administrator, and it is offered on a deleted entry only, in the list's Action menu and in the footer of the entry's edit page: delete the entry first, with Include deleted checked to see it.

Nodinite refuses it for the four default entries, for a live entry, and for a deleted entry that a Monitor View still selects; the list doesn't offer the action then. New 7.12 In the edit page footer, a live entry never shows Permanently Delete, and on a deleted entry the button is disabled, with a hint, while Monitor Views still use it (footer). Remove the entry from those Monitor Views first, with Edit in the entry's Monitor Views panel or on each Monitor View's External notifications tab. So no Monitor View loses an entry through Permanently Delete. The Log Audits record it as Hard Deleted an Alarm.

Delete the entry Contoso: Temp alert, then permanently delete it, animated walkthrough (7.12)
Animated walkthrough: Permanently Delete appears only once the entry is deleted.

  1. Open the Action menu of the entry, choose Delete, and confirm with Yes.
  2. Open its Action menu again and choose Permanently Delete.
  3. In Confirm intent to Delete Permanently, click Yes. The entry is gone, also with Include deleted checked.

Action menu of a deleted entry with Restore and Permanently Delete, Permanently Delete highlighted (7.12)
On a deleted entry that no Monitor View uses, Permanently Delete is enabled.

Control - Test Alarm Plugin

Test the entry from the Control card on the right of its edit page. A test needs no Monitor View: it sends the plugin a made-up alarm, with the settings currently in the form, saved or not.

  • Execute Alarm test – "Sends the plugin an Alarm with two Monitor Views: one OK (2 OK Resources) and one Error (an Error and a Warning Resource)"
  • 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.12)
The Monitoring Service runs the test at once.

Execute and Restore Alarm test on the entry Contoso: Ops e-mail, and both test mails in the dev stack's mail catcher, animated walkthrough (7.12)
Animated walkthrough: the test alert and the all-clear, recorded with the dev stack's mail catcher.

  1. Open the entry, here Contoso: Ops e-mail, and click Execute Alarm test.
  2. The result shows at the top of the page, for example Alarm execution was successful … E-mail distributed to e-mail address: …. New 7.12 It stays there after a Save; earlier versions cleared it with the save message.
    Alarm Test result for the entry Contoso: Ops e-mail at the top of the edit page: e-mail distributed, 4 Resources with changed state in 2 Monitor Views (7.12)
    The Alarm Test message names the address and counts the changed states per Monitor View.
  3. The test alert arrives with the subject prefix [TEST] -: one Monitor View in Error with an Error and a Warning Resource, one OK.
  4. Click Restore Alarm test. The second mail reports everything OK.

The test goes to the entry's test destination: the Test recipient of an E-mail entry, the Mail to list of an E-mail with options entry, the Test URL of a Webhook, or the Application Event Log on the Monitoring Service server for the Event Log Alarm Plugin. Test Resources carry no Custom Metadata; real alarms do. 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.12)
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.

New 7.12 The footer of an entry's edit page follows the entry's state:

  • A live entry shows Delete on the left, and Save, Save and close, and Close on the right. It has no Permanently Delete.
  • A deleted entry, opened with Include deleted checked, shows Restore and Permanently Delete instead of Delete, under the banner The Alarm Plugin is in the deleted state and is not operational. Permanently Delete is disabled, with a hint, while Monitor Views still use the entry.
Live entry Deleted entry
Edit page footer of the live entry Contoso: Temp alert with Delete, Save, Save and close, and Close (7.12) Edit page of the deleted entry Contoso: Temp alert with the deleted-state banner and Restore and Permanently Delete in the footer (7.12)
Delete, Save, Save and close, Close Restore and Permanently Delete replace Delete

Next Steps