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

Step 1: Login

To set up the Augmentation Monitoring, you have to log in to the CDQ Cloud Apps.

Click on Sign In and enter your username and password.

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.

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,

2. Click on the Settings icon activated required data source,

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

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.

Step 3: Creating an Augmentation Configuration

The Business Partners monitoring required setting up a configuration:

1. Sellect Augmentation Configurator cloud app,

2. Click the Create new configuration button:
   • Name the new configuration,
   • Click the Create button,

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

7. Scroll down to activate Reference Data Sources section,

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

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

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

9. Go to the Curation settings tab
10. Choose reuired profile based on the table below for Curation Profile.

11. Click the "Save configuration" button

Curation Profiles

Step 4: Augmetation Monitor

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

1. Go to the Data Clinic cloud app,

2. Click the Add New Data Monitor button,

3. 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),

4. Click Create New Data Monitor button to save
5. Wait until the job for the new monitor is finished

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,

2. Select the Create button,

3. Create new configuration:
   • Provide a name for the configuration,
   • Click the Create button,

4. Check the Data Validation Configuration table below,

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

6. 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 ,

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

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

8. 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

2. Click the Add New Data Monitor button
3. 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)

4. Click Create New Data Monitor button to save
5. Wait until the job for the new monitor is finished

Step 7: Generate the report

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

2. Click the Generate new report button,
3. 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)

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

6. Download the report;

7. Open the report to see the results:

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