Documentation PI Nexus+ Documentation

PI Nexus+ / Reference

Notifications Reference

This reference lists every email PI Nexus+ sends, its settings and defaults, and how delivery, retries and sites work. The Administration Guide chapter Notifications links here.

Overview

This reference lists every email PI Nexus+ sends, its settings and defaults, and how delivery, retries and sites work. The Administration Guide chapter Notifications links here.

Email types

An email is sent only when delivery is enabled, its rule is on under Delivery Rules, and the recipient has the email type ticked.

Recipient email typeDelivery rule (Delivery Rules)Subject starts withSent when
Manual scan completionManual scan completionPI Nexus+ <scope> <outcome>A manual, Run now or scheduled scan ends with a ticked outcome. One email per request, also for an AF request with several databases
Health issue changesOperational health: New issues, Severity escalations, Recoveries after an alertPI Nexus+ health alert / health recoveryAn issue at or above Minimum severity opens, escalates, or recovers after an alert
Automatic monitoring failuresAutomatic monitoring failures (under Operational health)PI Nexus+ automatic monitoring needs attentionAutomatic work for a target failed after its retries
PI Interface runtimePI Interface runtimePI Nexus+ interface alert / escalation / recoveryA PI Interface's runtime state changes to a ticked state, or recovers
PI Adapter runtimePI Adapter runtimePI Nexus+ adapter alert / recoveryA PI Adapter Collector's runtime state changes to a ticked state, or recovers
Host monitoringHost monitoringPI Nexus+ host alert / host recovery; PI Nexus+ scanner service is not running / is running againSee Host Monitoring Reference
Host monitoring escalationsHost monitoring (Escalation)PI Nexus+ host escalationSee Host Monitoring Reference
Recalculation suggestionsAnalysis recalculation: New recalculation suggestionsPI Nexus+ new recalculation suggestion(s)New analysis recalculation suggestions, grouped every 5 minutes
Auto TuneAuto Tune: Recommendations ready for review, Retry exhausted or restore-safety failurePI Nexus+ Auto Tune recommendations ready / needs attentionAn Auto Tune batch has recommendations, or needs attention
(no type)Connection tabPI Nexus+ email notification testSend test, to the address entered

Opened, escalated and recovered PI Adapter issues are also included in the health issue emails.

Default settings

SettingDefault
Email deliveryPaused
Port25
Use SSL/TLSOn
Manual scan completionSucceeded, Failed, Canceled on; Skipped off
Operational health EnableOff
Its New issues, Severity escalations, Recoveries after an alert, Automatic monitoring failuresOn
Minimum severity (health and host)Warnings and errors
PI Interface runtime EnableOff; once on: Error, Unknown visibility, Recovery after an alert on, Warning off
PI Adapter runtime EnableOff; once on, all four choices off until ticked
Host monitoringOff (see Host Monitoring Reference)
Auto Tune choicesOff
New recalculation suggestionsOff
Issues CSV, Changes CSVOff
Issue severitiesError,Warning
Max CSV size (MB)5 (1 to 25)
New recipientEnabled; All sites; every email type except Host monitoring escalations

Behaviour of each email

EmailRule
Scan completionAutomatic and configuration scans never send one. Completed with errors uses the Failed box. CSV attachments are cut to the recipient's sites
Health issuesThe first completed scan after the rule is switched on sets a quiet baseline: existing issues are not mailed. Suppressed issues are not mailed
Automatic monitoring failuresOne email per work item that stopped retrying; up to 3 delivery attempts, 5 minutes apart
Runtime alerts (PI Interfaces, PI Adapters)A degraded state must last 2 minutes before it is mailed. Suppressed runtime issues are left out. An open alert is not repeated at the same severity; an escalation (Unknown, then Warning, then Error) sends one more email if the new severity is ticked. A drop to a lower severity waits for the recovery email. A recipient that received an alert also receives its recovery
Recalculation suggestionsOnly suggestions created after the rule was switched on; older ones are not replayed. The email does not start a recalculation. Times are in the scanner server's local time

Delivery and retries

SituationBehaviour
Any failed sendRetried on the email's own short schedule: health issues after 5 and 5 minutes; runtime alerts after 1, 5 and 15 minutes
Mail server unreachable, timeout, or a 4xx replyRetried after that with growing waits of at most 30 minutes, for up to 24 hours from the change
5xx reply, invalid address or messageNot retried beyond the short schedule
Server rejects some recipientsThe others receive the message and are not sent it again; the rejected addresses are reported until they accept a later message
Send timeout100 seconds
FailuresReported as active notification failures in Admin > Support > Readiness

Sites

Recipient scopeReceives
All sitesEvery item, including items whose site is unknown, and all Auto Tune emails
Selected sitesOnly items of those sites, with counts recalculated; nothing when no item concerns them. Scan-completion emails only when the scan touched one of its sites

Recipients with the same scope share one message; recipients with different scopes never see each other's addresses. If delivery fails for one group, only that group is retried. A recipient whose last site is deleted is disabled with the reason shown, and cannot be enabled again until All sites or Selected sites is chosen.

Who can do what

ActionRole
Everything under Admin > NotificationsAdmin