Configure notification rules from analyses
- Last UpdatedJan 21, 2025
- 5 minute read
- PI System
- PI Server 2018
- PI Server
If you have already configured analyses to detect anomalies in your PI AF asset data, or you wish to configure such analyses, follow this procedure to configure notification rules on configured analyses.
Note: For information on software and system requirements, see Software requirements for notifications. If you want to configure notification rules to trigger on event frames from sources like event frame interfaces or custom applications, see Configure notification rules for user-defined event frames. For information on creating an event frame generation analysis, see Learn about event frame generation analyses.
-
Select the existing event frame generation analysis for which you want to create a notification rule.
-
Click Create a new notification rule for the selected analysis.
You see the Notifications Rules tab highlighted, as well as the options to configure a notification rule with the default name "Notification Rule".
-
Edit the created notification rule.
Provide one or more of the specified criteria; some of your criteria may be pre-selected from your analysis. The notification rule is triggered when all criteria are satisfied. You may change the name of the notification rule from the default, add a suitable description, and select a suitable category.
Selecting a category aids in organizing and searching for your notification rules.
-
Click View/Edit Trigger
The Trigger Criteria pane allows you to configure either of these trigger criteria modes: Analysis or Event Frame Search. Make sure that the Analysis criteria mode is selected.
-
Configure options in the Trigger Criteria pane.
-
You see the details of the selected analysis such as the event frame template name, the start and end triggers, and so on.
-
You can configure a new analysis of type Event Frame Generation or SQC. When you choose to create a new analysis with either the default or a custom name, you see the same analysis creation window as from the Analyses tab of PI System Explorer.
-
For more information, see Learn about trigger criteria in notification rules.
-
-
Configure options in the Options pane.
-
Optional. Resend Interval. Select the time interval at which PI Notifications Service will send additional alerts if the event frame matching the notification rule is not acknowledged or closed. For more information, see Understand resend interval in notification rules.
-
Optional. Non-repetition Interval. Select the time interval for which PI Notifications Service will not send similar alerts associated with the same notification rule. For more information, see Understand non-repetition interval in notification rules.
-
Event Frame Can Be Acknowledged. This option is automatically selected if the event frame template has been configured for acknowledgment.
-
Optional. Options based on multiple start triggers. If you have configured multiple start triggers for your analysis, choose between the options of being notified (a) when the current trigger severity is higher than any trigger severity encountered so far, (b) when the current trigger severity is higher than the previous trigger severity, or (c) every time a trigger condition is true, regardless of its relative severity to other previous triggers.
-
-
Optional. To configure the email format, click Manage Formats in the Subscriptions pane.
You see the Message and Content panes. By default, the notifications feature uses the Global Default Email format for each subscriber. For more information, see Delivery formats in notification rules.
Note: If the Content pane has a message indicating that your selected format is "read-only", you must first add a new format before you can customize it.
-
Optional. To create a custom delivery email format, copy the default Global Default Email format by clicking on the copy icon
in the Message pane. Alternatively, you can create a new delivery format by clicking the new delivery
format icon
.
The default format includes basic notification information such as the notification rule name, trigger time and event frame start time, as well as system information such as system and database names. To add more information to your custom format, drag and drop information from the Content pane to the Message pane.
Tip: A hyperlink indicates that an event frame template is selected; you may add the attributes defined below the event frame template to the content of your email notification by dragging and dropping the attributes from the Content pane to the Message pane.
You can designate your custom format as the default by clicking the Is Default box in the Message pane.
-
Click View/edit subscriptions in the Subscriptions pane.
You can search for contacts using Contacts Search in the Contacts pane. To add a subscriber, drag and drop a specific contact from the Contacts pane to the Subscriptions pane. Make sure to select your customized email format if you have created one, or pick the Global Default Email format. For more information, see Understand subscriptions in notification rules.
-
Optional. Configure escalation teams.
You can configure members of escalation teams from the Contacts plug-in on PI System Explorer, as described in Manage contacts. The escalation team contacts or groups will be notified one by one at the end of time segments specified in Escalation period. You can also control the frequency of the escalation notification.
Note: Escalations are triggered on event frame templates that can be acknowledged. Open the Library plug-in on PI System Explorer, select your event frame template and verify that the Event Frame Can Be Acknowledged check box is selected.
-
Check in the notification rule.
When the event of interest occurs, an email will be sent to the subscriber's mailbox. The email shows the event frame that triggered the notification rule with customized details that you have configured.
To manage your notification rules, use the Management plug-in on PI System Explorer. See Understand how to manage notification rules.