# How to generate reports in the Data Clinic?

## Overview

**Use Case**

This use case describes the recommended use of CDQ Cloud Services for generating reports in Data Clinic cloud app.

**Learning Goals**

In this tutorial, the user will focus on the following:

- Activating data sources that can be searched
- Creating a configuration for the Augmentation Monitor
- Creating the Augmentation Monitor
- Creating a configuration for the Data Quality Profiling Monitor
- Creating the Data Quality Profiling (Validation) Monitor
- Generating reports in the Data Clinic app


Remember
This tutorial is based on local data and specific naming. The presented results will be different from yours.

## Step 1: Login

To set up the Augmentation Monitoring, you have to log in to the [CDQ Cloud Apps](https://apps.cdq.com/).

![](/assets/image01login.4e448e048eed3968a0dd2ddf2c89ae53dbf7c83fb043c6d594d6b908d92eeb54.c941f44b.png)

Click on Sign In and enter your username and password.

![](/assets/image02login.317613ec01be15708944edd41eadff3017d2bc0433579ddb7efb8ffc608feee3.c941f44b.png)

## Step 2: Activating Data Source

CDQ is integrated with a variety of data sources, ranging from business and tax registers to commercial data providers
such as D&B or Moody's. For a comprehensive list of all available data sources, please refer to a list of [Data Sources](https://meta.cdq.com/Data_sources).

Before these data sources can be used in CDQ products, they must be explicitly activated. This activation is a one-time
process for the entire organization, and once completed, the activated data sources can be used across all workspaces.

1. Navigate to the Global Settings,


![](/assets/img001.2dfab1e363c354b2e695f7654a19511d61dd0b04b82cdf7c1f5e9163318eeb38.b5a9c026.png)

Here is a list of all supported data sources. You can filter the data sources by country of origin, name, and activation
status.

1. Click on the **Settings** icon activated required data source,


![](/assets/img002.d5135282de2ea984560fd9a011748fd73fc10653436a71cea08013b1f4f45b04.b5a9c026.png)

Some data sources may require authentication. Depending on the authentication mechanisms of the data source, you will
need to enter your credentials, tokens, or API keys.

1. Modify the settings:
  * Provide the necessary credentials (if needed),
  * Activate a data source using the activation toggle,
  * Click the **Save credentials** button,


![](/assets/img003.97241d36fbcd742544ce51e19b94afbcfddac8fe536d52f4809d2c6491810c2e.b5a9c026.png)

Data sources are not unlimited and are subject to quotas. The organization level quota can be controlled by CDQ or your
organization itself (if you authenticate with your credentials, e.g., D&B).

Additionally, quotas can be assigned to each workspace. This helps to regulate the use of data sources and prevents
unintentional and expensive downloads of data from commercial providers such as D&B.

![](/assets/img004.ea10752bb3514ae5a39d6a9da77b2a6a378c1982bd3ef1d93383c04bf226c5a7.b5a9c026.png)

## Step 3: Creating an Augmentation Configuration

The Business Partners monitoring required setting up a configuration:

1. Sellect **Augmentation Configurator** cloud app,


![](/assets/img005.c24fb794733879de52de433abef0ccdabc0cdd156ee736958acaa8f903b40ce1.b5a9c026.png)

1. Click the **Create new configuration** button:
  * Name the new configuration,
  * Click the **Create** button,


![](/assets/img007.53563c9b39dc16197ceec827d8d7a74a3c4203a6a4a1a48a70cd08daacde92d3.b5a9c026.png)

1. Check the Augmentation Configurator table if every configuration has a unique number assigned
2. Select the newly created configuration for the edition,


Note that you can only select data sources that you have activated globally for your organization. See [Step 2](#step-2-activating-data-source).

![](/assets/img02.4786a0f91974a6b21cc33caaf891fbcb64666ede545eaab3ae4e5b77067da3d4.c42d26a4.png)
7. Scroll down to activate **Reference Data Sources** section,

![](/assets/img008.fea12a44145429d574e67a3550a04f1e88c9df3d36c1651d22504474471701ac.b5a9c026.png)

1. Select data sources for *Lookup* to define which sources should be used for augmentation,


![](/assets/img009.c11e029f11265ce9fbfd7a3762ef041b030fb3dab619ab9cf32f5769846927b9.b5a9c026.png)

* Use the Lookup checkbox to choose all data sources displayed on the page


![](/assets/img0010.711a8e2d52dbf170628592229b2fcc488d46221a96fb9fbf45e6f0005b56dbf9.b5a9c026.png)

* Use *All Lookup options on all pages* checkbox to choose all available data sources (all pages)


Using these checkboxes can activate commercial (paid) data sources. Make sure only required data sources are activated.

1. Go to the **Curation settings** tab
2. Choose reuired profile based on the table below for Curation Profile.


![](/assets/img0011.7092d6a3190ca310185e605d25d72531e506b02c0ee433d2f34953bc29724bcc.b5a9c026.png)

1. Click the "Save configuration" button


### Curation Profiles

A list of all curation profiles and features is described here: [Curation API profiles](https://meta.cdq.com/Category:API_profile)

| Report Name | Report Description | Monitor type | Requirements |
|  --- | --- | --- | --- |
| Data Defects | The report outlines all errors found within the dataset, presented line by line with brief violation messages, helping businesses identify critical issues in Business Partner Data. | Data Quality Profiling | **Global settings**: Activated Reference Data Sources.  **Validation configuration**: Choose `EU_VAT_QUALIFICATION` or `WORDLWIDE_IDENTIFIER_QUALIFICATION` - or add to `STANDARD` profile qualification feature.  **Monitor turned on** |
| Defective Records | The report provides Business Partners with their validation status and the number of rules violated per each record. | Data Quality Profiling | **Global settings**: Activated Reference Data Sources.  **Validation configuration**: Default or custom rules for required countries. **Profile**: `STANDARD`/`ADDRESS`.  **Monitor turned on** |
| Identifier Qualification | For a given Business Partner, the qualification is made for name, address, and identifier, whether they are really associated with this identifier. | Data Quality Profiling | **Global settings**: Activated Reference Data Sources.  **Validation configuration**: Choose `EU_VAT_QUALIFICATION` or `WORDLWIDE_IDENTIFIER_QUALIFICATION` - or add to `STANDARD` profile qualification feature.  **Monitor turned on** |
| Identifier Qualification Per Decision | For a given Business Partners attribute, the company's name and address are checked, whether they are really associated with this identifier. | Data Quality Profiling | **Global settings**: Activated Reference Data Sources.  **Validation configuration**: Choose `EU_VAT_QUALIFICATION` or `WORDLWIDE_IDENTIFIER_QUALIFICATION` - or add to `STANDARD` profile qualification feature.  **Monitor turned on** |
| Update Report | The report outlines all individual updates for a given Business Partners attribute made according to changes in the reference source. | Augmentation | **Global Settings**: Activated Reference Data Sources.  **Augmentation configuration**: Activated Reference Data Sources for update monitoring, Business Partner from mirror subscribed.  **Monitor turned on** |
| Natural Person Screening | For a given Business Partner in-depth analysis of natural person screening is made as well as politically exposed person identification results. | Augmentation | **Global Settings**: Activated Reference Data Sources.  **Augmentation configuration**: Activated Reference Data Sources for lookup.  **Curation Profile**: `NATURAL_PERSON_SCREENING` or added FeatureOn: Enrich Categories.  **Monitor turned on** |
| Address Curation | Report that offers insights into the results of address cleansing activities (standardization, enrichment, cleansing, translation, and geo-coding of addresses). | Augmentation | **Global Settings**: Activated Reference Data Sources.  **Augmentation configuration**: Activated Reference Data Sources for lookup.  **Curation Profile**: Address_Only or added Curation featuresOn from this [list](https://meta.cdq.com/API/Data_Curation_API/Profile/ADDRESS_ONLY).  **Monitor turned on** |
| Legal Entity | Report that provides full information about BP found in reference data sources inc. status, registered name, legal form, legal address, and tax identifiers. | Augmentation | **Global Settings**: Activated Reference Data Sources.  **Augmentation configuration**: Activated Reference Data Sources for lookup.  **Curation Profile**: Business Partner Only or added Curation featuresOn from this [list](https://meta.cdq.com/API/Data_Curation_API/Profile/BUSINESS_PARTNER_ONLY).  **Monitor turned on** |
| Data Mirror Dump | Provide simplified information about Business Partners in the mirror + raw record. | Not required | **Business Partner** uploaded and correctly mapped in the Data Mirror. |
| Subscription Report | Return information if Business Partners were linked with reference data sources. | Augmentation | **Global Settings**: Activated Reference Data Sources.  **Augmentation configuration**: Activated Reference Data Sources for updates monitoring.  **Monitor turned on** |
| Overlap Report | Provides a list of 10 first lookup results for each Business Partner based on input data. | Augmentation | **Global Settings**: Activated Reference Data Sources.  **Augmentation configuration**: Activated Reference Data Sources for lookup.  **Curation featuresOn**: `PERSIST_LOOKUP_RESULTS`, suggested.  **Curation Profile**: Golden Record or Standard.  **Monitor turned on** |


## Step 4: Augmetation Monitor

Create an Augmentation Monitor and activate it using the previously created configuration:

1. Go to the *Data Clinic* cloud app,


![](/assets/img0028.0d7435603b232e17d8f199555b0c4f4d44e6b5070307361ff475739290266e26.b5a9c026.png)

1. Click the *Add New Data Monitor* button,


![](/assets/img0012.1aafd9a828ab5decc138e234870657c2d080ad86e8e689b1ce879af858268473.b5a9c026.png)

1. Configure new monitor:
  * Select Data Sources for which the monitor should be turned on,
  * Select Augmentation for Monitor Type,
  * Choose just created augmentation configuration,
  * Select Validity span (optional),


Thanks to Validity Span setup, the Business Process will be refreshed if no reevaluation trigger occurs within the
selected period.

![](/assets/img0013.0709d769b4d01f8207a087545cf4f09f4f8276db18d9f1afc93c74f23a78ebe3.b5a9c026.png)

1. Click *Create New Data Monitor* button to save
2. Wait until the job for the new monitor is finished


![](/assets/img0014.6e946a5d23c826f22039a24eca9670c77cf3daa338a1ba82ccde6af415b75482.b5a9c026.png)

## Step 5: Data Validation (Quality Profiling) Configuration

Create a configuration for the Data Quality Rules Engine used for monitoring:

1. Select Data Validation Configurator cloud app,


![](/assets/img0030.7f678d461bd8c79745a3b131dc93504482fe023f5d4ebb5052e3e2fe5a722701.b5a9c026.png)

1. Select the **Create** button,


![](/assets/img0029.03e8661825953b4fdf547be8e20ea9a3b9af2ee431a0f9b6cbabd503729d606f.b5a9c026.png)

1. Create new configuration:
  * Provide a name for the configuration,
  * Click the **Create** button,


![](/assets/img0015.d7cb89f7071453b0affb2c3b4a1b21c1b81e57aec295e8dcee35e9b353c5f7bf.b5a9c026.png)

1. Check the **Data Validation Configuration** table below,


Each configuration has a unique number assigned.

1. Select the newly created configuration for an edition and scroll down,


![](/assets/img0016.184aeaa01f0e245041ee743210b7c43a5f586f36d7b52410b89af9adba833143.b5a9c026.png)

1. Edit the parameters in the "Details of Standard configuration" section:
  * Select **Validation Profile** from the list based on report requirements,
  * Set the **Rule Status** to `Release`,


![](/assets/img0017.f60fcacf97bf256b3b521b7db1d6040b93aa95f8b182fc283bb1958b63612fb8.b5a9c026.png)

1. Use "Data Quality Rules" section to limit the validation results (optional):
  * Select the country,
  * Set the **Rule Status** to `Release`,


![](/assets/img0018.405641b0810b054929d7bc5c1632b385263996e8144c611d32f2a9a6bb1c24df.b5a9c026.png)

![](/assets/img0019.1fc06114ab737c7f038e34cd1a94619b79c0c56f56e540217c2e39cd859ae374.b5a9c026.png)

It's possible to modify the criticality of selected rules, customize violation messages, or disable rule execution.

![](/assets/img0020.11d948587c0d7cfc902363371455fb3794654f1e25a21ba3df4145f90727157d.b5a9c026.png)

1. Click the "Save changes" button.


## Step 6: Data Quality Profiling Monitor

Create a Data Quality Profiling Monitor and activate it using the configuration that was previously created:

1. Go to the *Data Clinic* cloud app


![](/assets/img0028.0d7435603b232e17d8f199555b0c4f4d44e6b5070307361ff475739290266e26.b5a9c026.png)

1. Click the *Add New Data Monitor* button
2. Configure new monitor
  * Select Data Sources for which the monitor should be turned On
  * Select `Data Quality Profiling` for Monitor Type
  * Choose just created validation configuration
  * Select Validity span (optional)


Thanks to Validity Span setup, the Business Process will be refreshed if no reevaluation trigger occurs within the
selected period.

![](/assets/img0021.519ea4d43f237ac05fa460b830135089d26a16b31e7a6d26b78913d7d747e0a6.b5a9c026.png)

1. Click *Create New Data Monitor* button to save
2. Wait until the job for the new monitor is finished


![](/assets/img0022.294e319eac4abd212809771a151d530ae4f9dd918959a499f9d91f672de1c4fb.b5a9c026.png)

## Step 7: Generate the report

1. To generate the report, go to the *Reports* tab of the Data Clinic cloud app,


![](/assets/img0023.9edb4be805cdda53ac5d89ada02ef9957e513c0505e11b451121a29e5aa7fa94.b5a9c026.png)

1. Click the *Generate new report* button,
2. Configure the report:
  * Provide Report title,
  * Choose *Natural Person Screening Report* for a report type,
  * Select data sources (the same as for Data Monitor in case of reports based on Data Quality Profiling or Augmentation Monitors),
  * Create a report only for specific countries, if needed,
  * Choose a file format (optional)


![](/assets/img0024.15c8f1ea5ee0bc7102ddf72ba102d7ef46521f9a0ed4154d21389658f9504d8b.b5a9c026.png)

1. Click the „Generate” button to start a job with the report creation
2. Wait until the job is finished


![](/assets/img0025.5978fbf48ac1690aac344fe5ca334b0e82341e534cd418d5d55bbf5aa08e97ef.b5a9c026.png)

1. Download the report;


![](/assets/img0026.0239a1ecd1025f6aa87bec800e987fd276b1e6855257909a754c2af4c39c672f.b5a9c026.png)

1. Open the report to see the results:


![](/assets/img0027.15157c513fd8aa51bfd5e388c29908fb13eaa1e147337527f2eee998114242a4.b5a9c026.png)

CONGRATULATIONS
You have generated the Data Quality report.

## Your opinion matters!

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