# Tutorial: How to monitor Business Partner updates?

## Overview

**Use case**

Customer and vendor data quality decreases, even if the data is not touched, e.g., due to address changes, M&A, or insolvencies. Keeping the data up to date manually is a complex and high effort on a global scale. Commercial registers and other reference data sources have to be monitored continuously, and for countries without reliable reference data, data has to be researched business partner by business partner. The CDQ Business Partner Update Monitoring takes over the effort of manual update screening. Business Partner Updates are automatically collected and made available in an easy-to-analyze and integratable way.

|  |
|  --- |
| ![](/assets/mbpu_overview.42c5358ca448f7d6c455c7848d17931f93d19ed7756fb32588ffcea4aa487702.b946f968.png) |
| *Use Case: Situation, Approach and Results* |


A complete use case description is available on the [Wiki](https://meta.cdq.com/Use_case/Monitor_Business_Partner_Updates).

**Learning Goals**

|  |
|  --- |
| ![](/assets/mbpu_process.a5ed64d783c31cc33e60442be061b1bfa2949f35decb257f59cc11df8dd47793.b946f968.png) |
| *Common Process* |


In this tutorial, the user will be focused on:

- Creating augmentation configuration using the [Augmentation Configurator](https://apps.cdq.com/dashboard/augmentation-configurator) cloud app,
- Creating data monitor based on prepared configuration using the [Data Clinic](https://apps.cdq.com/dashboard/data-clinic) cloud app,
- Analysing subscriptions in the [Collaboration & Subscription Configuration](https://apps.cdq.com/dashboard/collaboration) app and generating **Subscription Report** in the [Data Clinic](https://apps.cdq.com/dashboard/data-clinic) cloud app,
- Analysing results in the [Business Partner Update Browser](https://apps.cdq.com/dashboard/business-partner-update-browser) cloud app and the Generation Update report in the [Data Clinic](https://apps.cdq.com/dashboard/data-clinic) cloud app.


The following tutorial describes a *happy path* based on a common use case. Depending on your particular business
requirements, the steps may be different and/or need to be customized.

## Prerequisites

**Login**

Log into the CDQ [Cloud Apps](https://apps.cdq.com)

Authorization
If you have no access to the CDQ Cloud App, ask your internal point of contact to create a CDQ dedicated account.
Account detail will be sent by email.

**Data Mirror**

For tutorial purposes, the `CDQ Demo` Workspace with the dedicated data mirror will be used. Use your organization
workspace to recreate the happy *path*.

|  |
|  --- |
| ![](/assets/mbpu_pre1.7ba5918617cd1685c3d0779d608d2fccebff18ac5e0a673c7b1dee689f769907.b946f968.png) |
| *List of available workspaces* |


In case of no access to the `CDQ_DEMO` Data Mirror, use your own. Get more information about Data Mirror Setup and
Synchronization [here](https://meta.cdq.com/Use_case/Data_Mirror_Setup_and_Synchronization).

## Step1: Augmetation Configurator

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

1. Go to the Augmentation Configurator cloud app,


![](/assets/mbpu-img001.6e8d69d055498697ad4e5832326fb42a9bef6a14fc9d7a5f938becfd2faae090.b946f968.png)

1. Create a new configuration:


* Click the **Create new configuration** button,
* Name the new configuration,
* Click the **Create** button,


![](/assets/mbpu-img002.6d470c9cac2db52064ddb70779cb4e5e7451c2642768b14c43622b48224510bf.b946f968.png)

1. Check the **Augmentation Configurator** table below. Each configuration is assigned a unique number,
2. Select the newly created configuration for the edition,


![](/assets/mbpu-img003.17b6836e61fc3883f33c92c0e76ec7d609696c0b4c1a94f6096e34fe2aa033ee.b946f968.png)

1. Scroll down to activate **Reference Data Sources**,


![](/assets/mbpu-img004.3f660edd223c12f6b250a20fc366cc184fffd186a98c89aadae5ccebd66a2c79.b946f968.png)

1. Choose data sources for the **Lookup** to specify which sources should be used for augmentation:


* Use the **Update monitoring** checkbox from the table header to choose all data sources displayed on the page,
* Use the **All Update Monitoring options on all pages** checkbox below the table to choose all available data sources,


![](/assets/mbpu-img005.3dcf300875bbd5309146c574843b840847caca6b3c7e236fc1d645309b0c0d25.b946f968.png)

1. Go to the **Curation settings** tab,


![](/assets/mbpu-img008.158af9ab5d086592e57b58412273a9edeb5bdf0739e5cd0e99fd6ed081664946.b946f968.png)

1. If configuration was created only for an update montoring set:


* Curation Profile: `FEATURE_OFF`


![](/assets/mbpu-img009.aa10bddae5f2d2acc045997b51b990002ffecf845602fb888547f27370d691d7.b946f968.png)

To read more about profiles visit this [wiki page](https://meta.cdq.com/Category:API_profile).

1. Click the **Save configuration** button.


![](/assets/mbpu-img0010.3a48259e89370bb46fd40f019ac59963483910198570a8c42d38d6bb50a1139c.b946f968.png)

## Step 2: Augmetation Monitor

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

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


![](/assets/mbpu-img0011.0d7435603b232e17d8f199555b0c4f4d44e6b5070307361ff475739290266e26.b946f968.png)

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


![](/assets/mbpu-img0012.f10bc171dffa0d76d8d9b0ccaa56ae272ef9af4c784eb558ea5a9754c6e724a1.b946f968.png)

1. Configure the new monitor:
  - Select **Data Sources** for which the monitor should be turned on,
  - Select **Augmentation** for the Monitor Type,
  - Select the newly created augmentation configuration,
  - Click the **Create New Data Monitor** button to save,


![](/assets/mbpu-img0013.b73644574713131469688fdb961dc868b91b19f34418523d1bc81a043b81888b.b946f968.png)

## Step 3: Check the subscription

The subscription mechanism enables the selection of Business Partners to be monitored for updates. The linkage between
Business Partners from the mirror and reference data sources is established using identifiers based on the linkage strategy.

Without these identifiers, creating a connection and initiating monitoring is not possible.

1. Browse the subscriptions:
  * Go to the **Collaboration & Subscription Configuration** app,
  * Select the **Subscriptions** tab and set filter options,


All Business Partners are selected for subscription by default.

![](/assets/mbpu-img0018.b34cc14caf87f7bef50f13a5e5f1728eb66dec062bbf800c5b1a9e834a44925c.b946f968.png)

1. Go to the Data Clinic App and click the **Generate new report** button,


![](/assets/mbpu-img0011.0d7435603b232e17d8f199555b0c4f4d44e6b5070307361ff475739290266e26.b946f968.png)

The subscription report allows checking which Business Partners are subscribed for update monitoring in the `xlsx` report.

1. Configure the report:
  * Provide the report title,
  * Select the **Subscriptions Report** for a report type,
  * Select a data sources (the same as for Data Monitor),
  * Select countries (optional),
  * Choose a file format,
  * Click the **Generate** button to start the job with the report creation.


![](/assets/mbpu-img0014.27b1f727ee85da116b97379976e0b77c0dbfdadaa4a39c5c773852022c546cc2.b946f968.png)

1. Wait until the job is finished,


![](/assets/mbpu-img0015.5978fbf48ac1690aac344fe5ca334b0e82341e534cd418d5d55bbf5aa08e97ef.b946f968.png)

1. Download the report,


![](/assets/mbpu-img0016.0239a1ecd1025f6aa87bec800e987fd276b1e6855257909a754c2af4c39c672f.b946f968.png)

1. Review your report:
  * If a CDQ ID is present in the raw data for a specific data source, it indicates that the linkage has been created,
  * If certain business partners do not have any linkage, it is worthwhile to enhance identifiers based on the augmentation of lookup results.


![](/assets/mbpu-img0017.49986d08ec9b5c46b042cd077ba71be8cf5651b3e9562f6c3e04d5103ff8a2eb.b946f968.png)

The subscription report was generated successfully.

## Step 4: Read updates

To read relation updates:

1. Go to the **Business Partner Update Browser** app,
2. Use the **New Model** tab,
3. In the **Updates** tab set filter parameters:
  * Data Source: `CDQ_DEMO`
  * Set the date: `4h Aug. 2024`


ALIGN PARAMETERS
Remember that the presented parameters are dedicated to the `CDQ_DEMO` data source. Set parameters align with the available
data set.

![](/assets/rm-img0024.0cec3a850d09c8a3d24a42e3f31d6298bcf43ad3131b94a767530d3abd822205.db4cd86a.png)

There are two types of classification filters:

* `summaryClassification`: This filter provides Business Partners with a summary classification, which is determined by the highest classificationlevel among all Business Partner concepts.
* `conceptClassification`: This filter indicates the classification of a Business Partner's specific concept (e.g., name, street, legal form).


Filtration by tag and `conceptClassification` works in pairs and identifies Business Partners where, for example, the `LOCAL_NAME`
was `MODIFIED` and this change was classified as `MAJOR`. When filtering by tag and `summaryClassification`, the endpoint
returns all Business Partners where the specified tags were added to the summary and the general summary classification is,
for example, `IDENTIFIER_ADDED`, + the highest classification for all updates =`MINOR`.  Additional filtering options include
country, provenance, and external `IDs`

The returned list contains full Business Partner from the specific reference data source (`VIES`, `CH_UIDR`, `FR_RC`, etc.)
in comparison to Business Partners from the mirror.

By default, only the latest version of the BP is presented. To see all versions of the BP available in the last 3 months,
mark the checkbox:

![](/assets/rm-img0025.ca656ebfac7074ecf31274508e5a39edc5dea1d7a7dab130ffa474d9ff629b4f.db4cd86a.png)

details
summary
Click to use Old Model, previous version of the app.

To read relation updates:

1. Go to the **Business Partner Update Browser** app,
2. Click on the **Old Model** tab
3. In the **Updates** tab set filter parameters:
**Concepts**: `Business Partner Relation`


![](/assets/rm-img0019.b75ea1a0bd9f3dfe63290511b202c8315475e810fd1c5302d82431c39bd4e7bd.db4cd86a.png)

1. Select **View** to see details of updates for the selected **Business Partner**.


![](/assets/rm-img0020.dac4807c1d86bc81765337b913a574f1d1c17ff5758f6eaa1f1d1a264b52b833.db4cd86a.png)

## Your opinion matters!

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