Tutorial: How to share Business Partner updates?

Overview

Use case

Sequence of activities for sharing business partner data with the CDQ Community Data Pool and monitor updates and statistics.

Use Case: Situation, Approach and Results

Learning Goals

Common Process and involved APIs/Endpoints

In this tutorial, you will learn how:

1. Disclose data.
2. Manage subscriptions.
3. Generate the subscription report.
4. Get updates from the CDQ Community Data Pool.
5. Generate the update report based on CDQ Pool updates.

Prerequisites

Authorization

Before trying CDQ APIs, user must be authenticated:

1. Paste the API Key in the console's security bar into the X-API-KEY field.

2. After pasting the API Key, the green padlock will appear.

3. Check your API key for missing characters or extra space before trying.

No API Key?

1. Check how to get one on authentication page.
2. Follow the steps above.

Data Mirror

It is required that there is a data mirror available.

Step 1: Disclose Data

Mass data disclosure with Sharing Scope

To disclose range of Business Partners from selected county:

1. Use the Create Sharing Scope endpoint to send the below request.

2. Check the above example in the Try It Console now!
3. Set value of:
   • description to YOUR_DESCRIPTION
   • id to YOUR_DATASOURCE_ID
   • shortName to COUNTRY_CODE
4. Set the YOUR_STORAGE_ID in Parameters section.
5. Click on the Send button.

List Sharing Scopes

To check which countries are shared with Sharing Scopes:

1. Use the List Sharing Scopes endpoint to send the below request.

2. Check the above example in the Try It Console now!
3. Set the YOUR_STORAGE_ID in Parameters section.
4. Click on the Send button.

In response, the list of shared countries will be returned.

{
    "values":[
        {
            "id": "61e58c86255bc91f4da8d42b",
            "dataSources":[
                {
                    "id": "61a5d59b470c0332d08e609c",
                    "name": "CDQ_DEMO"
                }
            ],
            "countries":[
                    {
                        "shortName": "DE"
                    }
            ]
        },
        {
            "id": "61e58c866e2f9452f3ad1148",
            "dataSources":[
                {
                    "id": "61a5d59b470c0332d08e609c",
                    "name": "CDQ_DEMO"
                }
            ],
            "countries":[
                {
                    "shortName": "FR"
                }
            ]
        }
    ]
}

Single record disclosure

To disclose existing Business Partner:

1. Use the Upsert Business Partners endpoint to send the below request.

2. Check the above example in the Try It Console now!
3. Set value of:
   • dataSource to YOUR_DATASOURCE_ID
   • externalId to BP_EXTERNAL_ID
4. Fill record of a Business Partner based on right mapping.

5. Set the YOUR_STORAGE_ID in Parameters section.
6. Click on the Send button.

Results

Two types of results can be expected:

1. Existing record updated
2. Something went wrong
   • The response includes a message about the root of the issue

{
    "numberOfAccepted": 1,
    "numberOfInserts": 0,
    "numberOfUpdates": 1,
    "numberOfFailed": 0
}

{
    "numberOfInserts": 0,
    "numberOfUpdates": 0,
    "numberOfFailed": 1,
    "failures":
    [

        {
            "externalId": "BP_EXTERNAL_ID",
            "message": "Incorrect externalId value"
        }
    ]
}

Step 2: Browse Subscriptions

Browsing subscriptions allows seeing the list of Business Partners to be monitored for updates and ready for sharing.

Check Business Partners

Check already subscribed Business Partners:

1. Use the Read Business Partners endpoint to send the below request.

2. Check the above example in the Try It Console now!
3. Set value of:
   • storageId to YOUR_STORAGE_ID in a Parameters section
   • limit to 1000 or higher if you need more results
4. Click on the Send button.

In response, two important flags can be found:

• disclosed flag
• updateMonitoring flag

{
"id": "BUSINESS_PARTNER_ID",
"externalId": "BP_EXTERNAL_ID",
"disclosed": true,
"updateMonitoring": true

}

• "updateMonitoring": true indicates that particular Business Partner is subscribed for update monitoring.
• "disclosed": trueindicates that particular Business Partner data are available for sharing.

Enable/disable update monitoring

The updateMonitoring status can be changed if the update monitoring is no longer needed:

1. Use the Toggle Update Monitoring of Business Partners endpoint to send the below request.

2. Check the above example in the Try It Console now:
3. Set the Business Partner ID.

Step 3: Generate the subscription report

Subscription report request

To generate the subscription report:

1. Use the Build Business Partner Reports endpoint to send the below request.

2. Check the above example in the Try It Console now!
3. Select Generate Subscription Report example.
4. Set value of:
   • storageId to YOUR_STORAGE_ID
   • dataSource to YOUR_DATASOURCE_ID
5. Click on the Send button.

{
    "id": "YOUR_SUBSCRIPTION_REPORT_JOB_ID",
    "status": "SCHEDULED",
    "progress": 0
}

Poll the report status

To poll the report job status:

1. Use the Poll Business Partner Reports endpoint to send the below request.

2. Check the above example in the Try It Console now!
3. Set value of id to YOUR_SUBSCRIPTION_REPORT_JOB_ID in the Parameters section.
4. Click on the Send button.

{
    "summary": { },
    "id": "YOUR_SUBSCRIPTION_REPORT_JOB_ID",
    "status": "FINISHED",
    "progress": 100,
    "attachments":[
      {"url": "FILE_LINK/Review+Process+Business+Partner+Record+Statistics.html"},
      {"url": "FILE_LINK/Overlap+Rate+and+Record+Distribution.html"},
      {"url": "FILE_LINK/Subscription+Dashboard.zip"},
      {
          "url": "YOUR_REPORT_FILE_LINK/Subscription+Report+Collection.zip"
      },
      {"url": "FILE_LINK/Record+Distribution.html"    }
    ]
}

{
  "url": "job-files/4a1af653988a3bfc9e04854ebe5e630b/326704a3-4225-44ef-8c92-69718a0c884d/Subscription+Report+Collection.zip"
}

Download the report files

To download the report files:

1. Use the Request a file download endpoint to send the below request.

2. Check the above example in the Try It Console now!
3. Set value of url to YOUR_REPORT_FILE_LINK/Subscription+Report+Collection.zip.
4. Click on the Send button.

{
    "url": "YOUR_REPORT_FILE_LINK/Subscription+Report+Collection.zip",
    "downloadLink": "YOUR_DOWNLOAD_LINK",
    "downloadMethod": "GET"
}

5. Check the downloaded report.

List with Business Partners subscriptions and disclosure info

Step 4: Get updates from the CDQ Community Data Pool

To get updates from the CDQ Community Data Pool:

1. Use the Read Business Partner Updates endpoint to send the below request.

2. Check the above example in the Try It Console now!
3. Set value of:
   • storageId to YOUR_STORAGE_ID
   • affectedConcepts to NAME
   • affectedProperties to NAME_VALUE
   • provenanceTechnicalKeys to CDQ_POOL
   • from to a date not older than three months in the past. Example: yyyy-mm-ddT00:00.
4. Click on the Send button.

{
  "values": [
    {
        "businessPartnerId": "NjIxMDIyYTM4NGY5YmQwNWE4NGMwMzFm",
        "externalBusinessPartnerId": "CH-00001",
        "changeSets": [
          {
            "propertyChanges":[
              {
                "externalIds": [],
                "property": {},
                "newContent": "ANTEIS SA",
                "provenance": {},
                "changeType": "ADDED",
                "changeClassification": "MAJOR"
              }
            ],
          "provenances":[]
          }
        ],
        "provenances":[]
    }
  ]
}

{
  "values": [
    {
        "businessPartnerId": "621022a384f9bd05a84c031f",
        "externalBusinessPartnerId": "CH-00012",
        "changeSets": [
          {
            "propertyChanges":[
              {
                "externalIds": [],
                "property": {},
                "newContent": "Mibelle AG",
                "previousContent": "Mirabelle",
                "provenance": {},
                "changeType": "MODIFIED",
                "changeClassification": "MAJOR"
              }
            ],
          "provenances":[]
          }
        ],
        "provenances":[]
    }
  ]
}

Step 5: Generate the update report

All updates can be gathered and generated as a xlsx report.

Update report request

To generate the update report:

1. Use the Build Business Partner Reports endpoint to send the below request.

2. Check the above example in the Try It Console now!
3. Select the Generate Update Report example.
4. Set value of:
   • storageId to YOUR_STORAGE_ID
   • dataSource to YOUR_DATASOURCE_ID
   • from to a date not older than three months in the past
   • to a date with time stamp. Example: yyyy-mm-ddT00:00
5. Click on the Send button.

{
    "id": "YOUR_UPDATE_REPORT_JOB_ID",
    "status": "SCHEDULED",
    "progress": 0
}

Poll the report status

To poll the report job status:

1. Use the Poll Business Partner Reports endpoint to send the below request.

2. Check the above example in the Try It Console now!
3. Set value of id to YOUR_UPDATE_REPORT_JOB_ID in the Parameters section.
4. Clock on the Send button.

{
  "id": "915df183-811e-47a6-8a7e-01fe833f4aee",
  "status": "FINISHED",
  "progress": 100,
  "attachments": [
    {"url": "FILE_LINK/Count+of+Updates+per+Country.html"},
    {"url": "FILE_LINK/Count+of+Updates+per+Concept.html"},
    {"url": "FILE_LINK/Business+Partner+Updates+Dashboard.zip"},
    {
      "url": "YOUR_REPORT_FILE_LINK/BPU+Report+Collection.zip"
    }
  ]
}

{
      "url": "job-files/4a1af653988a3bfc9e04854ebw5e630b/915df183-811e-47a6-8a7e-01fe833f4aee/BPU+Report+Collection.zip"
}

Download the report files

To download the report files:

1. Use the Request a file download endpoint to send the below request.

2. Check the above example in the Try It Console now!
3. Set value of url to YOUR_REPORT_FILE_LINK/BPU+Report+Collection.zip.
4. Click on the Send button.

{
    "url": "YOUR_REPORT_FILE_LINK/BPU+Report+Collection.zip",
    "downloadLink": "YOUR_DOWNLOAD_LINK",
    "downloadMethod": "GET"
}

5. Check the downloaded report.

List of Business Partners' with possible changes

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