Configure notification rules for user-defined event frames
- Last UpdatedJan 21, 2025
- 4 minute read
- PI System
- PI Server 2024 R2
- PI Server
For information on software and system requirements, see Software requirements for the notification feature.
Note: If you have already configured an analysis on your PI AF asset, or wish to create new analyses to generate the event frames, use the procedure Configure notification rules from analyses.
Use this procedure if you want to configure notification rules to trigger on event frames from sources like event frame interfaces or custom applications.
-
In the PI System Explorer navigator, click Elements and select the element for which you want to define the notification rule.
-
Select the Notification Rules tab.
-
Click Create a new notification rule.
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.
-
In the Trigger pane, click on the hyperlink Please configure trigger criteria for this Notification Rule.
The Trigger Criteria pane allows you to configure either of these trigger criteria modes: Analysis or Event Frame Search.
-
Select the Event Frame Search trigger criteria mode.
-
Configure options in the Trigger Criteria pane.
You can select the event frame template from the drop-down list, and add conditions using any of the attribute templates for the event frame template.
-
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.
-
Optional. Non-repetition Interval. Select the time interval for which PI Notifications Service will not send similar alerts associated with the same notification rule.
Note: Verify that the event frame template has the Event Frame Can Be Acknowledged check box selected.
-
-
Optional. To configure the email format, click Manage format in the Subscriptions pane.
The Message and Content panes open. By default, notifications uses the Global Default email format for each subscriber.
Note: If the Content pane has a message indicating that your selected format for a subscriber 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 subscription 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.
-
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.
-
Check in the notification rule.
When the event of interest is generated, an email is sent to the subscriber's mailbox. The email shows the event frame that triggered the notification rule with the 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.