Setting up notifications

Last modified by Erik Bakker on 2024/02/21 22:29

In this microlearning, we will focus on how you can set up your notification setting to ensure the proper people will receive notifications in case an alert is triggered. Properly setting your notifications ensures that the right people are notified in case something goes wrong. Therefore they can take direct action if needed.

Should you have any questions, please contact academy@emagiz.com.

1. Prerequisites

  • Basic knowledge of the eMagiz platform

2. Key concepts

This microlearning centers around setting up notifications.
With notifications, we mean: Emails that notify specific persons when a certain alert is triggered

  • Both eMagiz users as external actors can receive alerts
  • When combining tags in the notification setting a notification will only be triggered when both alerts are triggered simultaneously
  • There is an option called congestion control that will limit the number of emails on the same object

3. Setting up Notifications

In previous microlearnings, we discussed setting up the tags and triggers that form the basis of our alerting system. In this microlearning, we will focus on how you can set up your notification setting to ensure the proper people will receive notifications in case an alert is triggered. Properly setting your notifications ensures that the right people are notified in case something goes wrong. Therefore they can take direct action if needed.

  • Both eMagiz users as external actors can receive alerts
  • When combining tags in the notification setting a notification will only be triggered when both alerts are triggered simultaneously
  • There is an option called congestion control that will limit the number of emails on the same object

To configure the notification settings we navigate to Manage -> Alerting. In here we have a menu item called Notification settings

intermediate-alerting-linking-setting-up-notifications--menu-item.png

When selecting this menu item you will see an overview of all notification settings. Note that eMagiz will automatically generate notification settings for the standard alerts.

intermediate-alerting-linking-setting-up-notifications--notification-settings-overview.png

You can add a new notification setting by pressing the New button. You can edit a notification setting by selecting one and pressing Edit. You can delete a notification setting by selecting one and pressing Delete. When you add a new notification setting you will the following.

intermediate-alerting-linking-setting-up-notifications--notification-settings-new.png

Here we first need to select for which tag(s) this notification will apply. Furthermore, we have to specify which eMagiz (and external users) need to be notified. Having done so will result in something like this.

intermediate-alerting-linking-setting-up-notifications--notification-settings-new-partly-filled-in.png

On the second tab, you could use the message content. However mostly this is not relevant as the defaults are fine. On the third tab, you need to determine whether you want to activate congestion control. Congestion control means that when several similar alerts are triggered eMagiz will at some point (based on the number you provide) stop sending separate emails and will group them in one notification to you. This setting is very handy for alerts that check generic parts of eMagiz (i.e. queues, runtimes, logging) but less ideal when it comes to error messages for example. In this case, we will leave the congestion control on.

intermediate-alerting-linking-setting-up-notifications--notification-settings-new-filled-in.png

When you are happy you can activate your notification setting by selecting True for the setting called Enable setting. After you have done so you can press Save and you have correctly configured your notifications.

intermediate-alerting-linking-setting-up-notifications--notification-settings-enable-setting.png

4. Key takeaways

  • Both eMagiz users as external actors can receive alerts
  • When combining tags in the notification setting a notification will only be triggered when both alerts are triggered simultaneously
  • There is an option called congestion control that will limit the number of emails on the same object

5. Suggested Additional Readings

If you are interested in this topic and want more information on it please read the help text provided by eMagiz.