Alerts enable you to receive notifications on changes or special business cases in your data.
Alerts can be used in two business cases:
- To monitor the system (operational)
- To indicate a business change
When you define an alert, you will receive an email containing a set of reports whenever a condition you define applies, according to the schedule you specify.
The email graphically displays the report charts and provides an attached CSV file containing the raw data of the reports.
Defining an alert
To define a new alert:
- From the main menu, choose Project – Alerts. This shows a list of all previously defined alerts in the project. From here you can also update and delete existing alerts.
- Click the Add + button at the top right corner.
- Define your alert:
- Name: Give your alert a name – it will be included in the email subject and body.
- CQL: add a CQL query that will trigger the alert. The query must return a single numeric value. For example, the default query returns the number of events received during the previous day:
WHERE date_range (yesterday)
- Condition: define a limit value for the query response, above/below which an alert will be sent. For example, the default condition will send an alert if the query returns a result of less than 1, i.e. if no events were received during the previous day.
Notice that the alert will refer to null values as 0.
- Check Condition: you can check the query and condition by clicking Check Condition – the query response and trigger result will be shown (if the query is valid).
- Frequency: specify the schedule for checking/sending the alert:
- Daily: specify the hour at which the report should be sent (UTC)
- Weekly: specify the day of the week and hour at which the report should be sent (UTC)
- Monthly: specify the day of the month and hour at which the report should be sent (UTC)
- CRON Expression: see www.cronmaker.com for a description of CRON expression syntax.
- Recipients List: select one or more CoolaData users and/or enter any email address (can also add emails not registered to CoolaData). Add your own email as a recipient to get a copy of the alert when it is sent.
- Text: you can add a rich HTML text to the email body. This is not mandatory.
- Reports to include: Select one or more reports from the project to include in the email body. This is not mandatory.
- Click Save.
- Run Now: Once saved, you can also run the alert manually by clicking Run Now – if the condition is triggered, the alert email will be sent to the list of recipients you defined.
Another way to define alerts is to use CoolaData’s alert builder. To access the builder, first select the ‘Alerts’ tab in your settings menu.
After selecting the ‘Alerts’ tab you will be transferred to the alert list, where your different alerts will be concentrated. On the top right-hand corner of the list you can find the following menu, from which you can access the alert builder:
The alert builder is comprised of two sections:
The top section defines the alert’s trigger settings. You may use your existing KPIs, in addition to condition of your choice to choose the alert’s trigger. In this example the alert will be triggered if the user count has increased by 10% compared to the previous day. The button ‘Check Condition’ runs a test in which the trigger is checked, when pressed message will appear next to it detailing whether the condition is met at the time of the manual check.
The bottom section defines the alert’s running settings. If the condition set in the top section is met, an alert will be sent out via email. This section allows you to define the sent alert’s settings, as well as it’s checking frequency. Recipients, text and email attached reports are also defined in this section. In this example the test will run daily, and if it’s conditions are met an alert will be sent to ‘firstname.lastname@example.org’, with the text ‘User count increased by 10%’. In this case there will be no added report, but you may choose to add any of your predefined reports to the alert message.
If you are interested in viewing the CQL code components of your query, you may select the ‘Options’ tab on the top right-hand corner of your screen, under which you will find the ‘Show CQL’ option.
After naming and defining your alert you will be able to save it. Once saved an alert will run a trigger check according to the selected frequency. You may also select the ‘Manual’ frequency in order to save an alert without running it on a scheduled time.
To see when an alert was last run or sent, select History from the list item menu.
Here you can also see which reports were sent and the number of recipients. Click each row to see more details.