Q.10. Alerts

In previous sections, you learned how to create reports, charts, and maps (let's call them objects), and how to publish them in dashboards. This section describes how to add and manage alerts in objects, how to watch alerts in dashboards and how to monitor alerts automatically.

An alert is a range of some indicator (for example, profits/losses, sales, up-time, etc) you want or do not want the indicator to reach. If the indicator's value reaches into the alert range (in other words: if an alert was triggered), you will be instantly informed about that, so you can fix issues in a timely manner. More detailed information about alerts can be found in Section 11.1 - What is an Alert.

First of all, you have to create the alert. That means that you have to select which indicator you want to watch and what values are critical for you. Each object (report, chart, or map) can have its own alerts.

Q.10.1. Alerts in Charts

In Section Q.4.3.2 - Control Areas, you learned how to add a control area into a chart. That is all you have to know to add alerts into charts – just open a chart in Chart Designer and add one or more control areas into it. Basically, you can think of a control area as an alert in a chart.

Launch EDAB Organizer (as described in Section 2.1.1 - Starting the Organizer), expand Examples/Dashboards/Alerts Components and double-click on the Sales By Employee Chart.

Click to view larger image

Sales By Employee Chart Location

The Enter Dialog will show up. You do not have to change any parameter values, so just click OK to continue. You should be able to see a chart now. You may notice that at least one control area has been already added into the chart. The existing control area represents minimal sales limit – no employee should sell less than the limit. We will add another alert that will indicate that employee's personal sales are not optimal, although they are not critically low.

Open the Insert menu and choose the Control Area option. Control Area Options dialog has appeared.

[Note]Note

You may have noticed that the Control Area Options dialog contains two control areas, but you can see only one control area in the chart. That is because one control area (No sales, to be specific) is so small that it cannot be seen on current axis scale. This does not affect the alert in any way, it will still work as if the control area was visible.

To add a new control area, click the Insert button. Now, it is time to set up our new alert. The first option is called Label. The Label is set to New Range by default. Delete the default label and set it to Not Optimal instead.

Now we will set up the alert range. Set the Value Axis Starting Scale to 20000 and the Value Axis Ending Scale to 40000.

To include the control area in the legend, choose the Show Label In Legend option.

Control Area Options

[Note]Note

Complete description of this dialog can be found in Section 4.1.4.6.3 - Adding Control Areas

Click OK to close the dialog. As you can see, our new alert was created successfully. Now click the OK button again to go back to the Chart Designer. The new control area has appeared in the chart. It is highlighted by a random color. To change the color, click on the new area and then choose an indicative color (for example, light red) from the Color panel on the right side of the window. Save the chart and close the Chart Designer.

Click to view larger image

Sales By Employee Chart

Q.10.2. Alerts in Maps

In the Section Q.8 - SVG Maps, you created a SVG map with thresholds. This means that you have also created a map with alerts because thresholds are equivalent to alerts in maps.

Let's add a threshold into an existing SVG map. Open EDAB main page and click on the SVG Maps link. Click on the Open Map icon on the toolbar. Expand Examples/Dashboards/Alerts Components nodes in the Open Map tree-list, select the Sales By State map and click the OK button. Click Submit to use default parameter values. To manage thresholds, click on the Set Thresholds icon. To add a new threshold (alert), click on the Add Threshold icon. In the Enter threshold value dialog, type 60000 and click OK. As new thresholds are added, some legend labels are not right. The legend labels are important for alerts because they also double as alert names. Set the 40000 – 60000 legend to $40,000 - $60,000. Now set the > 60000 legend label to More than $60,000. Click on the > 60000 color field. Select Color dialog should show up. Choose an appropriate color (for example, green) and click OK.

Now, the Set Thresholds dialog should look like this:

Set Thresholds Dialog

If it does, click OK to confirm the changes. The map has been changed since you added the threshold. Click on the Save icon and click OK to save the changes. Click icon in the top-right corner of the window to go back to the EDAB main page.

Q.10.3. Alerts in Dashboards

In previous paragraphs, you added alerts into few objects. Now we want to make use of those alerts. There are two ways to utilize alerts – alert watching and alert monitoring. This paragraph describes how to set up alert watching. Alert watching is set up in dashboards. The basic principle is quite easy: insert some objects (reports, charts or maps) into a dashboard and pick the alerts you want to watch.

Log on to the EDAB main page and launch Dashboard Builder. Click Open icon. Expand Examples/Dashboards nodes, select Alerts Dashboard dashboard, and click Ok. All dashboard objects have Set Alert icons in their header bars. That means that all dashboard objects have some alerts that can be watched.

Locate the Sales By Employee Chart chart and click on its Set Alert icon. The following dialog should appear.

Sales By Employee - Watched Alerts

There is the list of all alerts that you saw in Section Q.10.1 - Alerts in Charts. One alert is set to be watched.

The list also includes the Not optimal alert you created previously. Check the Not optimal checkbox and uncheck the No sales check-box.

Click Ok to close the dialog and then click on the Preview icon in the main menu. Notice that the chart's border is not flashing. That means that the Not optimal alert was not triggered. Now locate following panel:

Parameter Panel

Change the Quarter parameter to Q2. The border started flashing, because the alert was triggered with current parameters. In other words: at least one Sales By Employee Chart chart bar ends in the Not optimal control area.

You may also notice that the Sales Overview Report header is flashing. That is because the report contains a watched alert which is triggered. You cannot see the report until you click on its tab header, but you can tell that an alert is triggered in the report.

Please note that alert highlighting, blinking and alert messages are visible only in Preview of the Dashboard Builder.

Q.10.3.1. Sound alerts and alert messages

Border flashing is not the only way to alert you. You can also set alert messages and sound alerts. Close the Preview window and click again on the Set Alert icon for the Sales By Employee Chart. For our watched Not Optimal alert, check Sound and enter any message into Alert Message textbox. Click on OK and use Preview button to preview the dashboard.

Trigger the alert by changing the Quarter to Q2 in the Parameter Panel and an alert message with your entered text will appear and you will also hear a beep sound. To mute the sound, click on the Mute icon in upper right corner of the chart. Please note that each template has its own Mute button. To close the alert message, simply click on OK button.

Triggered alert message

For more information about alerts, please refer to Section 11.3 - Alert types.

Q.10.4. Alert Monitoring

Another way of using alerts is alert monitoring. Unlike alert watching, alert monitoring checks alerts even when there is no dashboard running.

Lets set up a new alert monitoring job. Log on to the EDAB main page and click the Organizer button. Expand Examples/Dashboards/Alerts Components nodes and select the Sales By Employee Chart file.

Click to view larger image

Sales By Employee Chart Location

Select Set Alert Monitoring from the Schedule/Archive menu. The following dialog should show up:

Click to view larger image

Setup Alert Monitoring Dialog

Click the Add button. Expand Examples/Dashboards/Alerts Components nodes, select the Sales By Product Report report and click OK.On the Set Alert Monitoring dialog select Low sales and Low revenue alerts. Type Low sales into the Display Name field. The dialog should look like this now:

Click to view larger image

Setup Alert Monitoring Dialog

If it does, click Next.

You should be on the Set Timing tab now. By default, the alerts would be checked just once, few minutes after configuring it. Select the At a regular time interval option. Set Time Interval dialog should show up. Default time interval is 1 minute, which is fine for us, so just click OK to confirm it. Uncheck the Run Indefinitely checkbox and click the change button right next to it. Set the end time one hour to the future (so you do not have to delete the job manually after you are done with this QuickStart chapter) and click Ok. The dialog should look like this:

Click to view larger image

Set timing

Click Next. Click Add to add new parameter set to the Sales By Employee Chart chart. Click OK to use default parameters. Click on the Sales By Product Report tab header, click Add and OK again and then click Next. The next step is configuring delivery options. This requires further knowledge and we will skip this step right now. If you are interested in setting delivery options, see Section 11.4.3.1 - Create/Edit monitoring dialog. Click Next. The following dialog should appear allowing you to check your settings before saving the alert monitoring job. Click Confirm to save the alert monitoring job.

Alert Monitoring Summary

You should be back in Organizer now. Click on the Schedule/Archive pull-down option in the main Organizer menu and select View Alert Monitoring Tasks option. The following dialog should open:

Click to view larger image

Alert Monitoring Tasks Dialog

The Low sales task should be on the list. Check the Last check time value. If no check was performed until now, it will show N/A. You can either wait for next automatic check (look at the Next check time if you want to know when that's going to happen) and then click Refresh. You can also select the Low sales task and click Run Now and then click Yes.

After the task was checked, click Refresh. You should be able to see the results.

Click to view larger image

Alert Monitoring Tasks Dialog

The Last check result indicator is red. That means that at least one alert was triggered during last check. Also notice that the Last triggered time is now the same as Last check time.

Select the Low sales task and click Edit. Select the Sales By Product Report and then click the Remove button. Click Done and then click Confirm to save the changes.

Wait for the automatic check or click Run Now again. Click Refresh.

Click to view larger image

Alert Monitoring Tasks Dialog

Now, the Last check result indicator is green. That means that no alert was triggered during last check.

[Note]Note

Please, keep in mind that this is just a quick guide which should guide you through basic steps of configuring alert monitoring. In reality, data in the database would be changing constantly; therefore, you would not have to change alert monitoring job properties in order to trigger/not trigger an alert.