Data exchange

From CDL
Jump to: navigation, search
Managed element
Last edit 22 June 2017 10:38:55
Support contact 
A member of the CDL Team who is responsible for a specific element of the CDL infrastructure.
Martin Ofner

This page describes the neccessary steps to setup the data exchange and collaboration from a technical perspective. Furthermore, a Java-based reference implementation of recommended routines aims to accelerate the development of customer-specific solutions and integrations

Ramp up

Ramp-up approach

The following steps are nessesary to setup both local and remote Endpoints for the data exchange.

No. Step Description
1 Align data model mapping
  • CDL member and CDL team jointly defines the data model mapping between local and remote databases.
  • The data model mapping is loaded into the CDL API and applied when the CDL member uses the CDL API.
2 Import initial data
  • CDL member selects and exports the data relevant for the data exchange
  • Typically the data is provided as CSV or XLS file
3 Manually provide and receive updates
  • CDL member selects and exports updates manually according to an agreed schedule (i.e. monthly, bi-monthly)
  • Typically the data is provided as CSV or XLS file
  • CDL member receives weekly notification emails about updates of other CDL member
  • Updates can be downloaded in the Review App as XLS file
4 Continously PUSH updates
  • Scripts need to be setup locally to push updates to the CDL automatically
5 Continously PULL updates
  • Scripts need to be setup locally to pull updates to the CDL automatically

Align data model mapping

Mapping file example

Linking local and remote data is based on the local LIFNR and remote CDLID.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DataModelMapping xmlns="http://www.corporate-data-league.ch/meta/DataModelMapping">

    <Mapping cdlAttribute="EXTERNAL_ID">
 	<CustomAttribute>LFA1.LIFNR</CustomAttribute>
    </Mapping>
    	
    <Mapping cdlAttribute="LOCAL_NAME">
	<CustomAttribute>LFA1.NAME1</CustomAttribute>
    </Mapping>
    
    <Mapping cdlAttribute="COUNTRY_SHORTNAME">
        <CustomAttribute>LAND1</CustomAttribute>
    </Mapping>
	<Mapping cdlAttribute="POST_CODE_VALUE">
        <CustomAttribute>PSTLZ</CustomAttribute>
    </Mapping>
	<Mapping cdlAttribute="LOCALITY_VALUE">
        <CustomAttribute>ORT01</CustomAttribute>
    </Mapping>
	<Mapping cdlAttribute="THOROUGHFARE_VALUE">
        <CustomAttribute>STRAS</CustomAttribute>
    </Mapping>

     <Mapping cdlAttribute="EU_VAT_ID_DE">
        <CustomAttribute>STCEG_CUSTOM</CustomAttribute>
    </Mapping>


    ...
</DataModelMapping>

BusinessPartner example (JSON)

{
   "cdlId" : "01mSBN4CDQ",
   "nameLocal" : "Demo AG",
   "cuntry" : {
     "value" : "Germany",
     "shortname" : "DE"
   }
   ..
}

CustomBusinessPartner example (JSON)

{
   "cdlId" : "01mSBN4CDQ",
   "fields" : [
     {
       "key" : "LFA1.LIFNR",
       "value" : "0000003451"
     },
     {
       "key" : "LFA1.NAME1",
       "value" : "Demo AG"
     },
     {
       "key" : "LFA1.LAND1",
       "value" : "DE"
     }
     ..
}

Manually provide and receive updates

Data export example

LIFNR KTOKK LAND1 LFA1.NAME1 NAME2 NAME3 NAME4 ORT01 ..
0000003451 YKRD DE Demo AG Musterstadt ..
.. .. .. .. .. .. .. .. ..

Push

The following table lists push user stories and scenarios for the CDL API. Web services of the API can be used to push data to the CDL Cloud data from the CDL Cloud.

User storyDescriptionStatus
Create new address on the basis of CDL recordsAs a data maintainer

I want to create new addresses on the basis of CDL records

So that my efforts to collect and verify mandatory data is reduced.
DRAFT
Create new businesspartner on the basis of CDL recordsAs a data maintainer

I want to create new business partners on the basis of CDL records

So that other companies can benefit from that.
DRAFT
Update address on the basis of CDL recordsAs a data maintainer

I want to verify address updates with the help of the CDL database

So that I have an additional source of trust.
DRAFT
Update business partner on the basis of CDL recordsAs a data maintainer

I want to verify business partner updates with the help of the CDL database

So that I have an additional source of trust.
DRAFT

Pull

The following table lists pull user stories and scenarios for the CDL API. Web services of the API can be used to pull data to the CDL Cloud data from the CDL Cloud.

User storyDescriptionStatus
Pull updatesAs a data maintainer

I want to be notified when there are business partner or address updates in the CDL

So that I can update my data and increase data quality.
DRAFT