Applies to brains.app platform.
Users who can do this: All Users.
Note: Please refer to the How do I use an alert in brains.app? article for general information about alerts and their usage.
Alerts can be conveniently managed by users to ensure all important events are notified in time for operators to react, ensuring operations always perform optimally.
How to create a new alert?
To create a new alert:
Click on the alert icon in the top right-hand corner.
Click on View all to access the page listing alerts.
Click the Create Alert button.
Populate the fields in the dialogue.
Information about those fields is provided in the following sections
Click on Add alert.
The following sections describe how the dashboard associated with an alert drives its visibility and activation and deactivation rules.
How to edit or delete an alert?
To edit an alert, use the menu in the Action column and click on Edit alert:
The same menu can be used to delete an existing alert.
Visibility rules for alerts
The visibility of alerts is driven by the dashboard attached to them. When creating a new alert, only dashboards visible to the current user get displayed:
Shared dashboards, which are shared with all users in the current user role.
Personal dashboards, owned by this user.
Consequently, the newly created alert will automatically be available to the users in the current user role if a shared dashboard is selected, and only to the current user otherwise.
If a user decides to unshare a dashboard, they get a warning message informing them that doing so will also remove access to the alert from users. Once a dashboard is unshared, only the owner of this dashboard has access to the related alerts.
Deleting a dashboard used in alerts is not allowed, and results in a message instructing to first delete any related alert (or remap it to a different dashboard).
Conditions for alerts
Conditions for alerts can be of two formats:
Comparison between two metric values.
Comparison between a metric and a value.
To access the value of a metric, the syntax is similar to the one used in equation metrics:
For example, if:
464is the asset ID the thickener 411-TK-002
135corresponds to the Percent solids (underflow) metric
metric(135).asset(464) returns the value for the percent solids (underflow) for 411-TK-002.
Following operators can be used in conditions:
Examples of valid conditions:
Conditions are evaluated at the time resolution of the data stored in brains.app (minute). A condition evaluating to
true will turn an alert to ON, a condition evaluating to
false will turn an alert to OFF, within the rules of activation and deactivation times described in the following section.
Note: As alerts are live by definition, cumulative metrics and manual metrics with Interpolation set to None cannot be used in alert conditions.
Using more complex logic
Where more complex logic is desired, using a metric based on an equation is a way to do so. An example would be to create an equation metric to create a complex equation involving multiple metrics, operators and functions and returning 0 or 1 from this metric.
For example, an equation metric could be created with the following complex expression (please refer to How to create a custom equation?):
metric(258).asset(32).time(-7)*2/(2+metric(257).asset(32).time(-6)) > 5 ? 1 : 0
The condition for the alert would simply be what follows if this newly created metric has ID 765:
The following two articles can be used to know more about equation metrics:
Activation and deactivation rules for alerts
When creating or editing an alert, two numbers must be provided:
Activation time in minutes.
Deactivation time in minutes.
The activation time defines for how long the condition must be
true for the alert to change from the OFF status to the ON status.
The deactivation time defines for how long the condition must be
false for the alert to change from the ON status to the OFF status.
Note: Both of those times must be set to at least two minutes to account for possible delays in data retrieval and processing.
Enabling and disabling alerts
Alerts can be enabled or disabled by actioning the switch in the Enabled column of the table of alerts.
Once an alert has been disabled, its status turns to Disabled and it does not appear in notifications even if its condition is activated.