How to Customize the Golden Record by prioritizing country-specific data sources?

Overview

The CDQ’s Business Partner Lookup service enables the creation of a Golden Record by following predefined rules for prioritizing data sources. However, customers now have the flexibility to override these standard settings based on country, allowing them to customize the Golden Record generation process to meet their specific needs. This feature is especially beneficial for accommodating local data sources or addressing specific requirements for different countries.

Customers can now define the prioritization of data sources for each country. If no country-specific settings are configured, the system defaults to the standard CDQ rules. This feature allows users to set a different primary, secondary, and other data source based on country-specific requirements.

Learning Goals

In this tutorial, you will learn how to:

  • Create an Augmentation Configuration,
  • Define country-specific settings for the Golden Record generation process,
  • Assign the Augmentation Configuration to the API Key,
  • Validate the Golden Record settings configuration.

Prerequisites

Example Scenario

A customer wants to customize the data sources for Germany (DE). They prefer to use LEI as the primary data source, with PEPPOL and AT.FON as secondary sources. Additionally, other sources like DE.RC, NO.RBE, and VIES are designated as data providers.

In the Augmentation Configuration, these settings are as follows:

Copy
Copied
{
  "goldenRecordSettings": {
    "dataSources": [
      {
        "countryScope": {
          "shortName": "DE"
        },
        "primaryDataSource": {
          "technicalKey": "LEI"
        },
        "secondaryDataSources": [
          {
            "technicalKey": "PEPPOL"
          },
          {
            "technicalKey": "AT.FON"
          }
        ],
        "otherDataSources": [
          {
            "technicalKey": "DE.RC"
          },
          {
            "technicalKey": "NO.RBE"
          },
          {
            "technicalKey": "VIES"
          }
        ]
      }
    ]
  }
}

For user convenience, these settings can be adjusted in the Augmentation Configuration app.

Login and API Key

Expand for more details

CDQ Account

Check your CDQ apps account.

  1. Log into the CDQ Cloud Apps

auth1

No account?

  1. If your organization is already a CDQ customer, ask your internal point of contact to create a CDQ dedicated account or request account . Account detail will be sent by email.
  2. If your organization is not yet a CDQ customer, please contact us to get started.

API Key

To create new API Key navigate to the API Key Management APP:

  1. Open the API Key Management APP .

image23

  1. Click on the Create New API Key button.
  2. Fill the API Key name and click on the Create Api Key button.
info

For details on how to create and set an API key see these instructions: Authentication

Step 1: Create an Augmentation Configuration

Create a new Augmentation Configuration in the Augmentation Configurator app:

  1. Navigate to the Augmentation Configurator app,
  2. Select the Create new configuration button,
  3. Add a name for the configuration,
  4. Select the See details button to open the configuration details.

grc img001

Step 2: Define Country-Specific Settings

Define the country-specific settings:

  1. In the Data source select tab, make sure that required data sources are selected in the Lookup column,
  2. Go to the Lookup settings tab,
  3. Set the SHOW_GOLDENRECORD_STANDARD feature in the Feature on field,

grc img002

  1. Go to Curation settings tab,
  2. Scroll down to the Golden Record Settings: Data Sources Prioritization section,
  3. Select a DE - Germany from a drop-down list,
  4. Set the Primary Data Source as LEI ,
  5. Add AT.FON and PEPPOL as a Secondary Data Source,
  6. Add NO.BRE and VIES as an Other Data Source,

grc img003

  1. Save configuration.

Data Source Prioritization:

Data source Description Usage Requirement
Primary Data Source This is the main source of truth, used as the foundation of the Golden Record. Exactly one Required
Secondary Data Sources These come into play when the primary data source doesn’t provide a full match. One or more Optional
Other Data Sources These are used only as a sources of data, but cannot be used as a Golden Record base. One or more Optional
info

Every country must have a unique configuration.

Step 3: Assign Augmentation Configuration to the API Key

The confuguration created previously must be assigned to the API Key:

  1. Go to the API Key Management app,
  2. Select the See details button to open the API Key details,
  3. In the Augmentation Configuration section, select the configuration you created in Step 1,

grc img004

  1. Save the changes.

Step 4: Validation

To make sure that the Golden Record settings configuration works as expected, follow these steps:

  1. Go to the First Time Right app,
  2. Select the Request Settings button,
  3. Choose the Augmentation Configuration you created in Step 1,

grc img005

  1. Save the changes,
  2. Enter the name of the business partner you want to Lookup ,
  3. Select the country,
  4. Click the Lookup button,
  5. Verify the Golden Record's origin in the results.

grc img006

success

New customization feature empowering customers to optimize the Golden Record generation process for their specific needs, ensuring that the most reliable and relevant data sources are used for each country.


Your opinion matters!

We are constantly working on providing an outstanding user experience with our products. Please share your opinion about this tutorial!

Mail our developer-portal team: developer-portal@cdq.com