Data Enrichment Workflow

Enrichment Configuration

Enrichment Configuration is the process where we create a lookup with the keys and values along with their corresponding data stored in it. Typically, this is the first step in the enrichment process.

The steps to perform enrichment configuration are as follows:

Creating Enrichment Table

1. The Data Enrichment page can be accessed from the platform left navigation menu by navigating to Data Ingestion > Data Enrichment.
   
   
   
   
2. The landing page after selecting the Data Enrichment tab will look like the following where all the existing enrichment tables will be displayed.
   
   
   
   On the Enrichment page, you can find the following details for your existing enrichment tables:
   • Name: The name of the enrichment table. It is clickable to view the enrichment table details.
   • Description: A brief description of the table’s purpose or content.
   • Created By: The user who originally created the table.
   • Created At: The date and time when the table was initially created.
   • Modified By: The user who made the most recent modifications to the table.
   • Modified At: The date and time of the last modification.The landing page after selecting the Data Enrichment tab will look like the following where all the existing enrichment tables will be displayed.
   • Actions: This section provides the following options specific to the enrichment table:
     • Edit: It allows you to modify the enrichment table’s settings and details.
     • Delete: To remove the enrichment table.
     • Enrichment Configuration Details: To view/ modify the data contained within the table.
3. In addition to the table details, the Enrichment page offers several useful features:
   
   • Search: Use the search function to quickly locate specific enrichment tables in the list.
   • Filters: Apply filters to refine the displayed list of enrichment tables according to your preferences.
   • Import & Export Buttons: The user interface includes dedicated buttons to facilitate the import and export of enrichment data, making it easy to manage your data effectively.
   • Add and Delete Buttons: These buttons enable you to add new enrichment tables to your system or delete existing ones as needed, giving you full control over your enrichment data.
4. Click on the + icon to add the Enrichment Table. It will redirect to the following landing page where details of enrichment tables are to be mentioned.
   
   
   
   

Adding Keys

To add Keys to Enrichment Table, click on the + icon in the Keys section and fill the respective information related to the Keys. The following information is required for adding the Keys:

1. Label: Name to be used to identify this field.
2. Field Name: Field name in the data stream corresponding to this field. Eg: In the case of server health information – the sender IP address and the host will be the field name.
3. Type: Type of Field
   • Enum
     • Options: List of allowed values for this field. For adding multiple items please use comma-separated values.
   • IP Address
   • Numeric
     • Minimum Value: Minimum value allowed for this key field.
     • Maximum Value: Maximum value allowed for this key field.
   • String
     • Constraint: Allowed characters for this field. Any regular expression format can be used here.
4. Help: Description of this field.

💡Note: Multi-key enrichment is supported in vuSmartMaps™. When both the keys are matched, the enrichment of key-value pairs holds valid.

Adding Values

To add Values in the Enrichment Table, click on the + icon in the Values section and fill in the respective information related to the Values. The following information is required for adding the Values:

1. Label: Name to be used to identify this field.
2. Field Name: Field name in the data stream corresponding to this field. Eg: In the case of server health information – the sender IP address, the host will be the field name.
3. Type: Type of Field
   • Enum
   • IP Address
   • Numeric
   • String
4. Constraint: This field defines the allowed characters for this field.
5. Help Text: Optional Description of this field.
6. Required (Yes/No): Select Yes to make this field mandatory.
7. Uppercase (Yes/No): Select Yes to make this field as uppercase. This will be disabled, by default.

💡Note: You can edit the Keys and Values information using the Edit icon under the Actions column. However, please keep in mind that you cannot change the “Type” and “Field Name” parameters during editing. Additionally, “Required” and “Uppercase” settings remain unchangeable as well.

For the geolocation use case, the following entries may be done for Keys and values. After adding the required fields, the enrichment table page will look like the following:

After clicking on the Save button, it shall create the enrichment table and the same will be displayed in the list of saved enrichment tables.

Updating Data in Enrichment Table

The next step after creating the table is to add the data. There are 2 methods to add the data to the created tables:

1. Manually
2. Upload from the Spreadsheet

Manually

All the corresponding data associated with keys and values may be added manually by the following steps:

1. Open the Enrichment table created by clicking on the Enrichment Configuration Details icon.
   
   
   
2. Click on the + icon (Add Item).
   
   
   
   
3. This shall open up a screen like the following where you may enter all the relevant details with individual data one by one. Click on Save to update the data.
   
   
   
4. After adding all the details, the enrichment table will look like the following:
   
   

Upload from the Spreadsheet

In practical situations, there will be a large set of data to be updated in the lookup table. In such cases, it is a simple approach to create a spreadsheet and import the same.

For this, the first step is to prepare a spreadsheet with all the keys and values and their corresponding data set.

The sample spreadsheet for the geolocation use case will look like the following:

💡Note: The following points should be noted for the spreadsheet:

1. The Sheet Name should be the same as the enrichment table name.
2. ‘The maximum size of the excel sheet allowed is 5 MB.
3. Based on the content in the ‘action’ field, data will be updated in the tables. It has 3 variables: upsert (to add the document); delete (to delete the document); and no action (when no action is to be performed).

To update the data from this spreadsheet to the enrichment table, navigate to the homepage of the data enrichment. You will find the Import button in the top right corner.

Click on the Import Button shall open up the following option to upload the excel file.

You may upload the spreadsheet with this dialog box. Click on the Import button will update the enrichment table. After this step, the enrichment table will look as in the following image:

Overall, in the above section, you learned how to configure the enrichment table and add the corresponding data to it.

💡Note: In a fresh setup, where there is no enrichment table added, the sample file will also be blank. It is recommended that users create an enrichment before downloading the sample import file.