CDQ Configuration for SAP Master Data Governance, Cloud Edition

Overview

This tutorial explains how to configure CDQ Cloud Services to be used in SAP Master Data Governance, Cloud Edition (“MDG” in the following). SAP provides integrated connectivity to CDQ Cloud Services in the Cloud Edition of MDG. If a customer enters a CDQ API Key into MDG configuration, MDG provides CDQ-specific features, e.g., business partner lookup via CDQ Reference Data API.

IMPORTANT

This tutorial is not about how to use such features in MDG but about mandatory and optional configuration on CDQ side to enable the features in MDG.

CDQ Cloud Services comprise APIs and web applications (apps). MDG integration is realized on API level. Apps can be used to configure the services, e.g., to activate certain features, to enable certain data sources, or to manage key mappings for legal forms, identifiers, etc.

IMPORTANT

Most relevant configuration is linked to API keys. With an API key a customer can authenticate and indirectly select a certain configuration which is linked to the used key. Both API keys and related configurations can be managed by apps.

info

Please check here for a description of the configuration inside SAP in order to complete the setup of CDQ-services inside MDG.

Prerequisites

  • Check your CDQ apps account.

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.

Step 1. Create an organization

The top-level concept for managing access to CDQ Cloud Services is an organization. An organization represents a customer who have a contract to use CDQ Cloud Services. In CDQ Apps, organizations can be managed by “Global Organization Management” app.

  1. Select the Global Organization Management app from apps list

img_5.png

attention

If you do not have access to Global Organization Management app, just issue a ticket via CDQ Support to create a new organization.

  1. Click “Create organization”.

img_6.png

  1. Enter a name for the new organization and choose a CDQ product package with the available CDQ-user roles.

The assigned user roles are the maximum to be assignable to users from this organization. At the end, this is dependent from the services the customer has licensed with CDQ.

img_7.png

info

Please find more information on user roles here.

Step 2. Create a workspace

A workspace is an isolated tenant within an organizational entity. Workspaces can inherit certain resources from the organizational parent like e.g., user. Workspaces fulfill various use cases like enabling collaboration among user within a get-clean project, managing integrations of CDQ services with customized configurations, managing dedicated monitoring services like weekly jobs with customized configurations or establishment of environments to test services. Workspace Data Model: The data model of workspaces has following structure.

info

More information about CDQ workspaces can be found here.

  1. Browse down to „Global Settings“.

img_9.png

  1. Click „Create Workspace“.

img_8.png

  1. Enter a speaking name for your workspace that tells you what this is all about, e.g. „prod _ mdg _ cloud“ or „dev _ mdg _ cloud“. You do not need to create a mirror yet.

img_10.png

Step 3. Create an API key

To connect to the CDQ services, you will need an API key to be set up inside the new organization. The key generation can be found inside the utility apps. API keys are a central element inside the CDQ-environment:

  • They store what sources to use for your requests
  • They store how these sources are configured
  • They determine the priority of sources

If connecting to multiple target systems, you may need to set up multiple API keys for different purposes in your organization. SAP MDG, cloud edition needs only one API key. If you plan to connect to different system landscapes, e.g. MDG cloud and an external CRM system, we recommend one API key per system.

  1. Navigate to “API Key Management”.

img_11.png

  1. Go to "Create New API Key" and give it a speaking name that describes the purpose of the key. For example, if you have a production- and a development environment, the name of the key should clearly distinguish the two.

img_13.png

  1. Store the new credentials in a safe place

img_14.png

Please store all three of these credentials safely. It will never be displayed again in the CDQ-Apps and new credentials will need to be issued if they are lost. There are three different credentials given in this screen:

  • The Client ID. This can be considered as a user name.
  • The Client Secret. It can be considered as the password.
  • The API Key. It combines the Client ID and the Client-Secret in a single phrase.
info

Please also refer to the SAP MDG, could edition documentation for further information.

Depending on your target application, you will either be asked for the Client ID and the Password or for the API key. In SAP MDG Cloud Edition, you will need to set a communication arrangement using the Client ID and the Client Secret.

  1. Select „User Name and Password” as Authentication Method.
  2. Use your “CDQ Client ID” from your credentials above for the “User Name” field inside SAP.
  3. Use your “CDQ Client Secret” from your credentials above for the “Password” field inside SAP.

img_16.png

Step 4. Activate external data sources

You can switch on and off different data sources in the „Data Source Management“ inside the „Global settings“.

info

The available sources are documented here.

  1. Navigate to „Global Settings“.

img.png

  1. Navigate to „Data Source Management“. By default, all data sources are disabled. Switch them by navigating to the gear button on the right:

img_1.png

  1. Activate the source by setting moving the slider (1) to active. Repeat these steps for each source needed.

img_2.png

  1. Terms of use: Some data sources may require an opt-in to their terms of use. The slider (1) will cannot be activated until agreeing with the terms. A click onto the information-icon takes you to the terms of the given data source. After confirming by checking the terms-of-use-checkbox, the slider will be able to be activated.

img_3.png

  1. If the given source needs special credentials, configure them by clicking the „show / hide credentials“ button.

img_4.png

  1. Enter your credentials from the external source here to activate the source.

Step 5. Configure business partner lookup service

To have pre-defined settings when using the “Business Partner Lookup“ via API, in the “Business Partner Lookup Configurator” configurations can be created and maintained.

  1. Create a new configuration and give it a speaking name that describes the purpose of the configuration.

img_5.png

  1. Afterwards the below described attributes can be defined.

img_6.png

  • Data Sources: The data source(s) to which the configuration shall apply can be selected or left blank. Left blank means that all data sources are used.
  • Matching Threshold: Specifies above what matching score the candidates are shown as result. The recommended value to start with is 0,6.
  • Maximum Candidates Volume: Defines how many candidates are shown maximum as result. Per default it´s set to 50. The maximum setting is 50.
    info

    Please also refer to the SAP MDG, cloud edition documentation.

  • Features On: The features switched on in the lookup can be selected. The administration here oversteers settings on API key level. It´s optional to select features, else the settings of the API key are taken.
  • Features Off: The features switched off in the lookup can be selected. The administration here oversteers settings on API key level. It´s optional to select features, else the settings of the API key are taken.
info

In “Data Sources” the desired data sources are selected. But for some “premium” data sources, like D&B, additionally feature(s) has to be activated for “safety” reason. Those data sources are costly, and user should explicitly indicate that he/she really wants to use this data source.

  1. Optionally following features can be turned "on" or "off"
Feature Feature Description
Activate Datasource Cdq Pool Add results from CDQ Data Sharing Community Data Pool to the lookup results.
Activate Datasource Googleplaces Add results from Google Places to the lookup results.
Activate Datasource Storages Add results from organizational data mirrors to the lookup results.
Activate Datasource Dnb Add results from DNB to the lookup results. Works only when in organization setting the dnb credentials are provided or when X-DNB-USER and X-DNB-PASSWORD is set.
Activate Datasource Nlbr Add results from the Netherland Company Register NL.BR to the lookup results. Works only when in organization setting the NL.BR credentials are provided.
Activate Datasource Zefix Add results from the Swiss Business Partner register Zefix.
Activate Datasource Bvd Add results from the commercial data source Bureau van Dijk (bvd). Works only when in organization setting the bvd credentials are provided.
Curate Request Curate Lookup results with data curation. Hint: Active by default.
Matching Score Calculation Calculate matching score. Hint: Active by default.
Show Debug Info Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.
Show Formatted Address Formats addresses using data curation procedure.
Show Goldenrecord Standard Calculate golden record for given request. It selects the best candidate and enriches it with information f.e. identifier.
Show Goldenrecord Quick Calculate golden record for given request. It only selects the best candidate.
Goldenrecord Inline Include golden record in values array in response. Ensure to activate this setting.
Show Incomplete Candidates Do not filter out search results without complete address data.
Show Registered Individuals Show individual personas registered in company registers.
Show Subscription Metadata Provide information whether current user is subscribed to given business partner, and overall subscription count.
Activate Identifier Only Match Executes lookup based only on identifier. Company names and addresses will not affect results.
Activate Data Source BZST Add results from BZST to the lookup results.
Force External Call Call external service even when results from data mirrors are available.
info

“Features On/Off”: Feature could be swichted off and on in parallel, but “OFF” has higher priority. Selecting the same feature both in ON and OFF section, it will be turned off.

  1. Once the Business Partner Lookup Configuration is done, it has to be assigned to the respective API key in the API Key Management. In the dropdown “Lookup Configuration” the created configuration can be selected. The Lookup Configuration is optional and the lookup works also without assigned configuration.

img_7.png

info

The Validation- and Curation functions are covered in CDQ Could Apps only. This is not part of the SAP connector yet.


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