Events in Canary are conditioned-based, monitoring live data as it flows into the Historian. Whenever a certain condition is met (Start Trigger) for a certain amount of time (Minimum Duration) an event is created. Upon creation, an email notification can be sent out to alert users of the occurrence providing the Canary system is configured to do so (See Configuring the Canary System to Send Email Alerts). The event does not end until either the Start Trigger is false or a configured End Trigger condition is true.

Similar to calculations, events can be backfilled to find historical events. Email notificatons are not triggered to send during this process.

By default, Canary stores its events in a local SQLite database; however, it can be configured to store them in an external Microsoft SQL database. See Storing Events in an External SQL Database.

Configuration

1. Open the Canary Admin client and navigate to the 'Calcs & Events' tile.
2. Click the 'ADD' button.
3. Type in a 'Name' for the event.
4. Optional - If the event is to be asset-based, select an 'Asset Path' and a corresponding 'Asset Type'.
5. Set a 'Backfill' datetime to find historical events when the event is started.
6. Create an expression which will serve as the Start Trigger for the event. For example,

   

7. Select 'Is Event Start Trigger' or 'Is Event Start and End Trigger' from the 'Event' drop-down menu.
   • Is Event Start Trigger - the event starts when the defined expression is True and stops when the expression is False. In the example above, the event would not stop until the value was less than or equal to 50.
   • Is Event Start and End Trigger - the event starts and stops whenever the defined expression is True. In the example above, each value coming in that is greater than 50 would stop and start a new event.
8. Optional - Set a 'Min Duration' for the amount of time that must pass before the defined expression is considered to be an event. In the example above, the value must be greater than 50 for at least 5 minutes before the event is triggered.
9. Optional - Specify the user(s) to be alerted when the event is triggered using the 'Notify Email' field. Multiple email addresses are separated using a comma or semicolon.
10. Optional - Click the 'EDIT EMAIL' button if wishing to format the email notification that is sent when the event occurs. The event can also be configured to send an email notification when the event concludes using this menu.
11. Optional - Add an additional expression to specify an 'Is Event End Trigger' (used in conjunction with 'Is Event Start Trigger'). If no such expression is created, the event will end when the start trigger is False. In the example below, the event starts when the value exceeds 50 for at least 5 minutes, but does not end until it drops below 45.

    

12. Optional - Add any additional expressions to the event to include event properties.
    • Select 'Is Event Property' from the drop-down menu.
    • Specify a variable name for the property.
    • Create a property expression. If using an aggregate function, 'EventDuration' must be used for the interval.

    

13. Click 'APPLY' then 'CLOSE' in the top-right corner.
14. Click the "Play" button to start the event. Current and historical events can be viewed by selecting the "Bell" icon.