Managing user notifications

This guide explains how to set up and manage notifications in Adverity.

Introduction

Set up notifications so that Adverity alerts you or other users about what happens in your workspaces and datastreams. Notifications are divided into several topics. For more information, see Notification topics.

You can only set up notifications for workspaces where you have Notifications Administrator privileges. For more information, see Managing user permissions.

Setting up notifications

Prerequisites

Before you complete the procedure in this guide, perform the following actions, if required:

• Before setting up Slack notifications, on the Slack website, set up a Slack Webhook.

• Before setting up Microsoft Teams notifications, on the Microsoft website, set up a Microsoft Teams internal Webhook.

Procedure

To set up notifications, follow these steps:

1. In the platform navigation menu, click Administration.

2. In the secondary menu, in the Notifications section, choose the type of notification you want to set up: Email, Slack, or Microsoft Teams.

3. In the top right corner, click + Create subscription.

4. In the User field, select the user who should receive the notifications.

5. Enter the required information for the user. The information you need to provide here depends on the notification type:

   • For email notifications, in the Email field, enter the user's email address.

   • For Slack or Microsoft Teams notifications, in the Webhook URL field, enter the webhook URL. To test the webhook URL, click Open next to this field.

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

7. In the Topics field, select the topics for which you want to receive notifications. For more information, see Notification topics.

8. Select the Enabled checkbox to turn the notification on. If you need to turn the notification off later, deselect this checkbox.

9. (Optional) Select the Notify about empty extracts checkbox to receive a notification when Adverity fetches a data extract without any data.

10. (Optional) For the Daily import status topic, select the time (UTC) at which you want Adverity to send these notifications.

11. In the Workspaces field, select the workspaces for which you want to receive notifications. If you leave this field empty, you will receive notifications for all workspaces that you have access to.

12. In the Datastreams field, select the datastreams for which you want to receive notifications. You can only select datastreams that belong to the workspaces you select in the Workspaces field. If you leave this field empty, you will receive notifications for all datastreams in these workspaces.

13. Click Save.

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 secondary menu, click the type of notification you want to edit: Email, Slack, or Microsoft Teams.

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

4. Edit the notifications.

5. Click Save.

Cancelling notifications

To cancel notifications that you do not want to receive any more, follow these steps:

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

2. In the secondary menu, click the type of notification you want to delete: 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, in the drop-down menu for the selected users, click Delete selected subscriptions.

As a result, the selected users will no longer receive the selected type of notifications.

Notification topics

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

Datastreams and enrichments

Select this topic to be notified about datastream and enrichment errors and warnings.

• Errors:

  • Anything that prevents the datastream API query from completing, and stops data from being collected.

  • Script errors during the enrichment stage of the task, including errors that occur while setting up the script.

  More comprehensive error reports can be created using an enrichment script with a mailto instruction and a sub-table. For more information on configuring this custom scriptenrichment, see Using custom script enrichments and our guide to the mailto instruction.

• Warnings:

  • Incorrect datastream settings, such as not selecting any accounts for which to collect data.

  • Large amounts of data in a datastream, which may cause the fetch to take a long time.

  • Automatic adjustments to your datastream settings, e.g., if a date range is changed automatically to meet the connector requirements.

  • Fields that are not supported or not found in a specific datastream or report type.

(Optional) Select the Exclude warnings for datastream and enrichment issues checkbox to only receive notifications about errors. You will not receive notifications about warnings.

Unify Location Data enrichment

Select this topic to be notified if an error occurs when using the Unify Location Data enrichment to transform your data.

Import errors

Select this topic to be notified about the following issues when loading data into a destination, Adverity Data Storage 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 status

Select this topic to receive a daily import notification. The daily import notification contains a summary of your daily import statistics from all active datastreams in your Adverity instance.

When selecting this topic, set the time at which you want to send the notifications (UTC time zone).

Match & Map enrichment

Select this topic to be notified if the Match & Map enrichment detects any new values in your data. These values will automatically be added to the current values.

Mapping

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

• A list of 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

Select this topic to be notified about the following authentication updates and issues:

• The successful authorization of a new user.

• The re-authorization of existing users.

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

• Any datastream authorization tokens that have expired.

Performance outliers

Select this topic to receive notifications if a task takes longer than usual. This notifies you of any performance outliers, as described in the Performance outliers section of our guide to the Performance Manager.

Data Mapping

Select this topic to be notified about any changes to the Data Mapping in the workspaces and datastreams you select.

Smart Naming Convention

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

• An error message when there are problems with the data that prevent it from splitting into columns, including:

  • 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.