Using standard enrichments
Introduction
-
What are standard enrichments and what can they do?
-
Standard enrichments provide a user-friendly interface that you can use to tell Adverity how to transform your data. You can use standard enrichments to add new columns to your data extracts, translate text, standardize location data, and much more.
-
How do I use standard enrichments?
-
Create an enrichment as described in this guide. Next, assign your enrichment to a datastream. After the enrichment is assigned to a datastream, every time you fetch data using the datastream, the collected data is transformed according to the instructions in the enrichment.
-
Who can use an enrichment that I create?
-
An enrichment is available to all users with access to the workspace where the enrichment was created. However, the enrichment will only affect datastreams to which it is assigned.
-
What standard enrichments are available?
-
The available standard enrichments are:
-
What other enrichment types are there in Adverity?
-
Adverity also offers custom script enrichments. These give you the freedom to transform your data according to your needs using a wide range of custom script instructions. For more information, see Using custom script enrichments.
Creating an enrichment
The process of creating an enrichment is made up of the following steps:
-
Type: Choose the type of enrichment you want to create.
-
Assignments: Choose the datastreams to which you want to apply the enrichment.
-
Instructions: Configure the enrichment so that it transforms your data according to your needs.
-
Name: Give your enrichment a name so it is easily identifiable.
The Type, Assignments and Name steps are the same for all enrichment types. The settings you need to configure in the Instructions step are different for each enrichment type.
Prerequisites
Depending on the enrichment type, you have to perform additional actions before you can create the enrichment. You will always need to create a datastream, fetch data and apply Data Mapping before creating an enrichment. The prerequisites for each enrichment type are listed in our individual enrichment guides.
Creating an enrichment
To get started creating an enrichment, follow these steps:
-
Go to the Enrichments page.
-
In the top right corner, click + Create enrichment.
-
In the Type step, click the type of enrichment that you want to create.
This guide only explains how to create standard enrichments. To create a custom script enrichment, see Using custom script enrichments.
-
In the Assignments step, select the datastreams to which you want to assign this enrichment:
-
To assign the enrichment to one or more specific datastreams, select Individual datastreams and then select your chosen datastreams from the drop-down menu.
-
To assign the enrichment to all datastreams that fetch data from one or more specific data sources, select Datastream types and then select your chosen data sources from the drop down menu.
(Optional) To exclude any datastreams that fetch data from your chosen data source, select the individual datastreams to exclude from the Do not assign to these individual datastreams drop-down menu.
-
-
Click Next.
-
In the Instructions step, configure the settings for the enrichment as described in the corresponding guide:
To preview your enrichment at this step, click the Table preview tab. Here, you can see how your current enrichment instructions will transform the data you have previously collected using this datastream.
If the preview shows that the enrichment is not working in the way you want it to, click the Instructions tab to adjust the enrichment settings.
Repeat these steps until the preview shows that the enrichment will have the effect you want.
For more information about the preview, see Previewing enrichments.
-
Click Next.
-
In the Name step, enter a name for your enrichment.
-
Click Create.
As a result, you have created an enrichment and assigned it to your chosen datastreams. From now on, every time you fetch data using these datastreams, the data extract will be transformed according to the instructions in your enrichment.
You can also assign your enrichments to a datastream from the datastream overview as well as manage the order in which the enrichments are applied.
Editing an enrichment
You can edit an enrichment after it has been created. To do so, follow these steps:
-
Go to the Enrichments page.
-
Click the enrichment you want to edit. You will automatically be taken to the Instructions page of the enrichment overview.
-
Make any required changes to your enrichment in the Instructions tab. To see how your changes will affect how the enrichment transforms your data, click the Table preview tab.
-
Click Save.
As a result, you have edited your enrichment. From now on, when you fetch data using a datastream to which this enrichment is assigned, your data will be transformed according to the new instructions.