Enforcing naming conventions

This guide explains how to enforce naming conventions in your data.

Introduction

Use the Smart Naming Conventions feature to let Adverity detect your naming convention based on patterns in your data and enforce these conventions. Adverity monitors if data complies with the naming convention and notifies you about discrepancies.

Naming conventions are a set of rules that define how your data is presented, formatted, and structured. They specify the appropriate naming of the fields and values in the data set, and ensure your data is presented in a consistent and standardized manner. Use Smart Naming Conventions to enforce your naming convention and ensure the high quality of your data. For example, Smart Naming Conventions can automatically identify and flag missing data, and correct misaligned data sets.

Smart Naming Conventions identifies missing data and notifies you

Smart Naming Conventions corrects misaligned data sets

Smart Naming Conventions is a premium feature available upon request.

Concept

Enriching your data means transforming and tailoring the data according to your needs. An enrichment is a set of instructions that you specify for Adverity to transform your data.

When you create an enrichment, you add it to the list of available enrichments in the Workspace.

When you assign an enrichment to a Datastream, each time data is fetched for the Datastream, the data is transformed according to the enrichment. The enrichment only has an effect on Datastreams to which you assign the enrichment.

Prerequisites

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

  • Use consistent naming conventions in your data.

  • Use delimiters (special characters) in String values to separate pieces of information. For example, you use the delimiter | to separate pieces of information in the value EN | retail | lead.

  • Place similar pieces of information in the same position in String values. For example, if you have a column with values like EN | retail | lead and FR | retail | lead, the country code must be in the first place in other values of the column as well.

Procedure

To create a Smart Naming Conventions enrichment for a Datastream, follow these steps:

  1. Click the Enrich element and select the Workspace you work with in Connect, Enrich & Transfer.

  1. In the top right corner, click + Add.

  2. Click Smart Naming Conventions.

  3. (Optional) To assign the enrichment to individual Datastreams of your choice, follow these steps:

    1. In the Assign to section, select Individual Datastreams.

    2. In the drop-down menu, select the Datastreams to assign the enrichment to them.

  4. (Optional) To assign the enrichment to all existing and new Datastreams that belong to Datastream Types of your choice, follow these steps:

    1. In the Assign to section, select Datastreams Types.

    2. In the drop-down menu, select the Datastream Types to assign the enrichment to all Datastreams that belong to these types.

    3. (Optional) In the Do not assign to these individual Datastreams drop-down menu, select the individual Datastreams that belong to the Datastream Types that you have selected, but you do not want to assign the enrichment to them.

  1. Click Next.

  1. Select the source column for which you want to enforce naming conventions. You can only choose from columns which are mapped as dimensions with String data type. For more information on Schema Mapping, see Harmonizing data. For more information on the data types used in Adverity, see Data types used in data harmonization.

  1. Click Next.

  1. Deselect any values in the source column which are not consistent with your naming convention. Adverity only considers the selected values when it detects the rules of your naming convention.

  1. Click Next.

  1. Confirm that Adverity correctly detected the rules of your naming convention by checking the following fields:

    Delimiters Detected

    In this field, Adverity displays the detected delimiters. Delimiters are characters that Adverity uses to split the source column into several new columns. For example, if you specify the delimiter |, the value EN | retail | lead is broken up into the parts EN, retail, and lead. Adverity enters these values into the new created columns in your Data Extract.

    Enable the toggle for the delimiters that you want Adverity to use. You must enable at least one delimiter.

    For more information on supported delimiter characters, see Supported delimiter characters.

    For more information on the date formats you can use in the source column, see Supported date formats.

    Rules Detected

    In this field, Adverity displays the detected rules for each new column created based on the delimiters you specify. The rules explain what the values in each new column must look like. For example, when the split values are EN and 2021, the rules can be the following:

    • Column 1 can only contain upper case characters of length 2.

    • Column 2 can only contain numbers of 4 digits.

    Enable the toggle for the rules that you want Adverity to use.

    To edit the rules, click Edit. When you select Predefined values in the Data type field, you can define at most 1,000 values.

    Split Preview

    In this field, Adverity displays the new columns that will be added to your Data Extract when it applies the Smart Naming Conventions enrichment.

  1. Click Next.

  1. Provide names for the new columns that are added to your Data Extract. Specify names that are consistent with the other column names in the Data Extract.

  1. Click Next.

  1. An uncorrectable error occurs when the source column contains a value that cannot be interpreted in any way according to the naming convention. For example, when a value does not contain any of the delimiter characters.

    (Optional) To configure Adverity's behavior in case of an uncorrectable error, fill in the following fields.

    Send Email

    Select this checkbox to receive notifications about uncorrectable errors to the email address specified in the Datastream settings. Adverity always notifies you about uncorrectable errors in the Datastream's Overview page.

    Continue Processing

    Select this checkbox to continue the Smart Naming Conventions enrichment process even if an uncorrectable error occurs. To stop the enrichment process when an error occurs, clear this checkbox.

  1. Click Next.

  1. A correctable error occurs when the source column contains a value that is not fully consistent with the rules of the naming convention, but Adverity can correct this error. For example, when the source column contains an empty cell.

    (Optional) To configure Adverity's behavior in case of a correctable error, fill in the following fields.

    I want to be informed in the following cases

    Enable the toggle for the columns for which you want to receive notifications if a correctable error occurs.

    Send Email

    Select this checkbox to receive notifications about correctable errors to the email address specified in the Datastream settings.

    Raise warning

    Select this checkbox to display a notification about correctable errors in the Datastream's Overview page..

  1. Click Next.

  1. (Optional) In Enrichment name, rename the enrichment.

  1. Click Next.

  1. In the Summary page, check the details of the Smart Naming Conventions enrichment.

  2. Click Create +.

Adverity will apply the Smart Naming Conventions enrichment to all future Data Extracts you fetch with the Datastream. For more information, see Collecting and viewing data.

Supported delimiter characters

When specifying delimiters in a Smart Naming Conventions enrichment, you can use the following characters:

Character

Name

|

vertical bar

-

hyphen

,

comma

;

semicolon

~

tilde

_

underscore

/

slash

 

space

.

dot

+

plus sign

#

hash sign

$

dollar sign

ยง

section sign

Supported date formats

When setting up Smart Naming Conventions, you can use the following date formats in the source column:

  • %d/%m/%Y

  • %d-%m-%Y

  • %d_%m_%Y

  • %d.%m.%Y

  • %m/%d/%Y

  • %m-%d-%Y

  • %m_%d_%Y

  • %m.%d.%Y

  • %Y/%m/%d

  • %Y-%m-%d

  • %Y_%m_%d

  • %Y.%m.%d

Editing the rules of Smart Naming Conventions enrichment

After creating a Smart Naming Conventions enrichment, you can modify its rules.

To modify the rules in a Smart Naming Conventions enrichment, follow these steps:

  1. Click the Enrich element and select the Workspace you work with in Connect, Enrich & Transfer.

  1. Select the Smart Naming Conventions enrichment to edit.

  2. Select a rule and click to edit the rule.

  3. Edit the Smart Naming Conventions enrichment configuration.

  4. Click Apply.

You cannot change the source column and the delimiters used in the Smart Naming Conventions enrichment.