Custom Alerts
- Parker Hutcheson (Deactivated)
Custom Alerts are available in your Dashboard, and allow you to be alerted via text or email when a specified issue occurs. There are a number of settings available to you that can be modified depending on your needs.
It is currently necessary to have your email configured to send alerts, this is likely to be changed in a future update.
Table of Contents
Motivation
Once you have configured your company within the platform and started utilizing it's various features, you may find that something is not operating the way you intended. There are other ways to monitor such as the Tiles in our Analysis and Reports. However, we've primarily built this around making it easy and convenient to be alerted with issues when importing or exporting files.
As a result, you can set up Custom Alerts, which will let you know if for whatever reason there is an issue with your configuration.
Custom Alert Screen
Navigating to your Custom Alerts, and then editing or creating an alert will present you with the following screen:
1. Your alert name
2. The issue that will cause you to receive an alert, see the Issue Types section of this article for more information
3. Your alert settings, see the Alert Settings section of this article for more information
4. Your alert actions, see the Alert Settings section of this article for more information
5. The ability to discard the changes that you have made to this alert
6. The ability to save your alert, assuming you have made changes
Alert Settings
There are a number of configuration options available to you when creating a Custom Alert. The settings that are available are based on the issue you have chosen to be alerted for.
The following settings are available regardless of the issue type:
Setting | Description |
|---|---|
Name | The display name of this alert in your Custom Alerts screen |
Issue | See the Issue Types section of this article |
Issue Threshold | See the Issue Threshold section of this article |
Action | Select a checkbox for sending an email, text message, or both You are restricted to one email address and one text message per alert |
The way the monitoring period will work depends on your issue type, because sometimes the monitoring period depends on an event not occurring, whereas other types will depend on an event occurring.
This table will highlight what type of monitoring period will be available for the corresponding issue type:
Issue Type | Monitoring Period Type |
|---|---|
Exports not completed during expected time | |
Customer records fail to insert / update | |
Batch file(s) not processed during expected range |
Issue Types
When creating a Custom Alert from your Dashboard, there are preconfigured issues that are available to you. As with the rest of our platform, we are constantly working to improve this, and more issues will be added in the future.
The available issues that can trigger your alert are listed in this table:
Issue | Description |
|---|---|
Exports not completed during expected time | This will trigger if your exports are not created within the monitoring period |
Customer records fail to insert / update | This will trigger if your customer records fail to be updated in system |
Batch file(s) not processed during expected range | This will trigger if your import file(s) do not arrive, or the file(s) that did arrive fail to process successfully |
Issue Threshold
Once you have selected your issue type, you will be presented with a setting called the Issue threshold. The effect that this threshold has depends on the type of issue that you have selected. This table explains how the threshold affects the correlating issue, where x is the value of your issue threshold:
Issue Type | Issue Threshold Effect |
|---|---|
Exports not completed during expected time | If less than |
Customer records fail to insert / update | If equal to or more than |
Batch file(s) not processed during expected range | If less than |
Monitoring Period
Sometimes this will be referred to as a "static" monitoring period, because, unlike a rolling monitoring period, this monitors a specific period of time. It is used when you are checking for particular events that you expected to occur but did not, and therefore want to receive an alert.
An alert will only ever fire once per monitoring period, and it will fire at the end of the monitoring period. This is because the platform is checking for your issue at the end of the monitoring period. If an alert is triggered, it will reset on the next monitoring period.
You can also select what days of the week that the alert will be active. The days of the week should not be confused with the actual monitoring period. Instead, think of it as the days your alert is active.
As an example, for an alert that is active on Monday and Tuesday, if the alert triggers on Monday, it can also trigger on Tuesday. The monitoring period is just the time of day and does not start on Monday and end on Tuesday.
Rolling Monitoring Period
A rolling monitoring period is for the types of issues that will be immediately triggered, such as if 10 customers fail to update within a 30-minute window. This is a continuous monitoring period, meaning that time is not divided into "chunks" the same way that a "static" monitoring period is.
If an alert is triggered, your issue count will be reset, and monitoring will resume.
You can select a monitoring period of any number of minutes, hours, days, or weeks.
For issues that use a rolling monitoring period, you can also limit the number of alerts that you receive to once per minute, hour, day, or week.
Required Roles
Role | Capability |
|---|---|
All roles | Receive Alerts |
Monitor and Alert User | All capabilities in this article |
System Administrator | All capabilities in this article |