Setting up notifications

This guide explains how to set up notifications.

Introduction

Set up notifications so that Adverity alerts you or other users about what happens in your workspaces and datastreams.

There are three types of notifications:

  • Notification - Adverity notifies you that something has completed successfully.

  • Error - Adverity notifies you that something has gone wrong. For example, you are notified of an error if something has prevented data from being transferred to a destination. A datastream does not work until an error is fixed.

  • Warning - Adverity notifies you when something is not performing at its optimum and requires your attention. For example, you are sent a warning if data has been transferred to a destination, but a non-fatal error occurred during the process that may compromise the quality of the data extract.

Notifications, errors, and warnings are divided into seven topics. For more information, see Topics and notifications.

You can set up notifications for workspaces where you have Notifications Administrator privileges.

Prerequisites

Before you complete the procedure in this guide, perform all of the following actions:

  • You have Notifications Administrator privileges for at least one workspace.

Setting up email notifications

To set up email notifications for a user, follow these steps:

  1. In the platform navigation menu, click Administration.

  2. In the left navigation panel, click E-Mail .

  3. In the top right corner, click + Add new email subscription.

  4. In the User field, select the user.

  5. In the Email field, enter the email address of the user.

  6. In Topics, select the actions that trigger the notifications. For a list of the notifications, warnings and errors associated with each of the topics, see Topics and notifications.

  7. (Optional) Configure the additional settings such as workspace filters.

  8. Click Save.

Setting up Slack notifications

Prerequisites

Before you complete the procedure in this guide, perform all of the following actions:

Procedure

To set up Slack notifications for a user, follow these steps:

  1. In the platform navigation menu, click Administration.

  2. In the left navigation panel, click Slack .

  3. In the top right corner, click + Add new Slack subscription.

  4. In the User field, select the user.

  5. In the Webhook url field, enter the Slack Webhook URL. To test the Slack Webhook URL, click Open next to the field.

  6. (Optional) In the Channel field, select the Slack channel where Adverity sends the notifications. If you leave this field empty, Adverity sends the notifications to the default Slack channel.

  7. In Topics, select the actions that trigger the notifications. For a list of the notifications, warnings and errors associated with each of the topics, see Topics and notifications.

  8. (Optional) Configure the additional settings such as workspace filters.

  9. Click Save.

Setting up Microsoft Teams notifications

Prerequisites

Before you complete the procedure in this guide, perform all of the following actions:

Procedure

To set up Microsoft Teams notifications for a user, follow these steps:

  1. In the platform navigation menu, click Administration.

  2. In the left navigation panel, click MicrosoftTeams.

  3. In the top right corner, click + Add new Microsoft Teams subscription.

  4. In the User field, select the user.

  5. In the Webhook url field, enter the Microsoft Teams Webhook URL. To test the Microsoft Teams Webhook URL, click Open next to the field.

  6. In Topics, select the actions that trigger the notifications. For a list of the notifications, warnings and errors associated with each of the topics, see Topics and notifications.

  7. (Optional) Configure the additional settings such as workspace filters.

  8. Click Save.

Additional settings for notifications

To configure additional settings for notifications, use the following fields:

Enabled

Select the Enabled checkbox to turn the notification on. To turn the notification off, clear the Enabled checkbox.

Notify about empty extracts

Select the Notify about empty extracts checkbox to send a notification after fetching a data extract without any data.

Workspaces

Select the workspaces whose actions trigger the notification. If you leave this field empty, an action in any of the workspaces triggers the notification.

Datastreams

Select the datastreams whose actions trigger the notification. This drop-down field contains a list of datastreams that belong to the workspaces you select in the Workspace field. If you leave this field empty, an action in any of the datastreams triggers the notification.

Editing notifications

To edit notifications, follow these steps:

  1. Select the workspace you work with in Adverity and then, in the platform navigation menu, click Administration.

  2. In the left navigation panel, click the type of notification (Email, Slack or Microsoft Teams).

  3. Click the user for whom you want to edit notifications.

  4. Edit the notifications.

  5. Click Save.

Removing notifications

To remove notifications, follow these steps:

  1. Select the workspace you work with in Adverity and then, in the platform navigation menu, click Administration.

  2. In the left navigation panel, click the type of notification (Email, Slack or Microsoft Teams).

  3. Select the checkboxes of the users for whom you want to remove notifications.

  4. In the top left corner of the page, click the drop-down menu.

  5. Click one of the following options:

    • Delete selected email subscriptions.

    • Delete selected slack subscriptions.

    • Delete selected teams subscriptions.

As a result, the selected users will no longer receive notifications from the selected subscription.

Topics and notifications

Notifications, errors, and warnings are divided into seven topics. Each of the seven topics has several notifications, errors, and warnings associated with them. These are as follows:

datastream and enrichment - Notifications, warnings and errors

Select this topic to be notified about the following data collection issues:

  • An error message is sent if anything prevents the datastream API query from completing. This will stop data from being collected also.

  • An error message is sent if there is a script error during the enrichment process of the data collection. This includes error notifications configured during the script set up.

  • More comprehensive error reports can be created using an enrichment script with a mailto instruction and a sub-table. For more information on enrichment scripts, see Using custom scripts.

Import - Notifications, warnings and errors

Select this topic to be notified about the following issues when transferring data to a destination or file storage:

  • Errors regarding the unique key or unique index.

  • Alerts that the number of allowed characters is exceeded.

  • Alerts that the primary key is not unique (or the primary key too long, this applies to MySQL only).

  • Errors raised when applying a mapping table to a data extract.

Daily Import Status - Notifications

Select this topic to receive daily import notifications. These import notifications occur once per day at 10:00am CET. The daily import notifications contains a summary your daily import statistics from all active datastreams in your Adverity instance.

Mapping - Notifications

Select this topic to receive mapping notifications. These notifications inform you of all the successful new entries created by mapping tables. The mapping notifications include:

  • A list the new field entries.

  • The datastream and data extract to which the new entries have been added.

  • The workspace that contains the datastream with the new entries.

Authentication - Notifications, warnings and errors

Select this topic to receive authentication notifications that include:

  • The successful authorization of a new user.

  • The re-authorization of existing users.

This topic also notifies you of the following errors and warnings:

  • A change or expiry of a datastream's authorization credentials.

  • Any datastream authorization tokens that have expired.

Smart Naming Convention - Errors and warnings

Select this topic to be notified about the following Smart Naming Convention issues:

  • An error message when there are violations in the data that prevent splitting into columns. These violations include:

    • No delimiters are present in the data extract rows.

    • Too many empty columns are detected (Adverity's limit is 9).

  • A warning that a value does not comply with the setup rules. For example, the rules are looking for a number but the value is a string.

  • A warning that a mandatory column needed for Smart Naming Convention is empty.

workspace Mapping - Errors

Select this topic to be notified about the following workspace mapping issues:

  • Explore & Present workspace mapping tables cannot be created. One cause for this error is workspace mapping table already exists with the same name.

  • Missing entries in the workspace mapping table.