CX-0077 Data Quality Dashboard v1.2.2

ABSTRACT

The Data Quality Dashboard (DQD) has to rely on a set of clearly defined quality rules which is the basis of the Golden Record Process and secures the syntactical and logical correctness of mission-critical business partner data attributes. To secure global consistency the DQD rule relies on defined ISO norms as defined in this document – see Standardization Document CX-0076 Version 1.1.0, Golden Record EndtoEnd Requirements Standard. DQD has to capture at least 112 countries based on ISO 3166-1. DQD has to validate BP data records in the Inbound and Outbound Persistence of the related Catena-X (CX) Member who licensed DQD. Each DQD rule has to validate the syntactical correctness of defined mandatory, regulatory required and optional BP data record attributes related to the specific regulations by the country authorized institutions. DQD furthermore has to rely on the following Standards: ISO 3166-1, ISO 20275, ISO 01-140-10, ISO 8601, ISO/IEC 8859-1.

DQD has to visualize the outcome of the data quality rules via a dashboard. The DQD dashboard design relies on the Catena-X style guide. See details under:

• Library: https://www.npmjs.com/package/@catena-x/portal-shared-components
• Docu: https://eclipse-tractusx.github.io/portal-shared-components/
• NPM package: https://www.npmjs.com/package/@catena-x/portal-shared-components/v/2.1.2
• Storybook: https://eclipse-tractusx.github.io/portal-shared-components/

DQD uses the Gate APIAPI An API is a way for two or more computer programs to communicate with each other. CX-0074_v3.0.0 and the Pool APIAPI An API is a way for two or more computer programs to communicate with each other. CX-0012_v4.0.0 based on the CX-0018 Data Space Connectivity 3.0.0 for pulling BP data records. DQD is a client/ server cloud application which contains a Web Client and a Cloud Server Application.

DQD has to contain a user and authorization management capability aligned with the CX Portal and Marketplace user management. DQD intends to support the EDC AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. function capability and has to be available in English and German language.

FOR WHOM IS THE STANDARD DESIGNED

The standard enables software and service companies to develop business partner master data quality dashboard applications including accessibility of external 3rd party data sources.

COMPARISON WITH THE PREVIOUS VERSION OF THE STANDARD

Version	Publishing Date	Author	Description of Change
1.1.0		SR	Added chapter 3 for DQD APIAPI An API is a way for two or more computer programs to communicate with each other..
1.2.0	2024-03-13	SR	Corrected 2.3.3 - country list, Added chapter 3.5 Data Types and 3.6 Data Attributes, Added chapter 3.7 for data sovereignty as additional requirement.
1.2.1	2024-09-04	SR	Moved DQD Dashboard Style Guide Reference from Normative Section to Non-Normative Section

1 INTRODUCTION

1.1 AUDIENCE & SCOPE

This section is non-normative

This standard is relevant for the following audience:

• Catena-X certified Operational Companies acting as:
  • Core Service Provider

This document is focusing on the functionality of the Data Quality Dashboard (DQD) as a screening and monitoring tool of CX Member business partner data in the Inbound Persistence based on the following capabilities:

1. Data Profiling which is based on the analysis and evaluation of data content versus the CX business partner standards defined in CX-0076 Golden Record EndtoEnd Requirements Standard Version 1.1.0
2. Visualization of BP data quality via a dashboard
3. Evaluation of the data quality results including recommendations for syntactical or logical error handling

DQD has to be a Value Added Services (VAS) application for Data Provider and Consumer to monitor the data quality via a dashboard of BP data records in the Inbound Persistence.

DQD rules have to be focused on the analysis of BP data record quality on a syntactical or content basis if possible. DQD does not focus on validating semantical correctness or data enrichment services. Those services are part of the Golden Record Process.

The description of the Golden Record EndtoEnd Requirements Standard, the Gate APIAPI An API is a way for two or more computer programs to communicate with each other. and the Pool APIAPI An API is a way for two or more computer programs to communicate with each other. are stored in the standard library of Catena-X: https://catena-x.net/de/standard-library.

1.2 CONTEXT AND ARCHITECTURE FIT

This section is non-normative

The Data Quality Dashboard has to be a screening tool of the record process, rules, methodology and allocation of the BPNBPN A BPN is the unique identifier of a partner within Catena-X. ID (Business Partner Number Identification) for Legal, Site and Address data records. DQD has to focus its validation and monitoring capabilities on all mandatory, regulatory required and optional business mission critical BP data record attributes to enable the CX Member to validate any impact on logistical, financially or communication relevant processes between the CX Member and his business partner. Furthermore, this transparency has to support the CX Member by improving his business partner related due diligence processes. The Data Quality Dashboard has to contain the capability to store the outcome of DQD results for at least 3 years and has to enable the definition of CX member specific data quality KPIs (Key Performance Indicator) and mapping against actual quality results. DQD has to contain tiles which visualize the results with filter functions by time, region, country, BPNBPN A BPN is the unique identifier of a partner within Catena-X. ID type, BP Roles, DQD status and business partner role. ~~

1.3 CONFORMANCE AND PROOF OF CONFORMITY

This section is non-normative

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The keywords MAY, MUST, MUST NOT, OPTIONAL, RECOMMENDED, REQUIRED, SHOULD and SHOULD NOT in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

All participants and their solutions will need to prove, that they are conform with the Catena-X standards. To validate that the standards are applied correctly, Catena-X employs Conformity Assessment Bodies (CABs).

To prove conformity with this standard providing a self-audited, stated and signed document that the syntax of the number is established is needed.

1.4 EXAMPLES

Intentionally left blank

1.5 TERMINOLOGY

This section is normative

The main DQD rule methodologies are described below:

Legal Form

The DQD rules for legal form have to validate the correct usage of legal forms by the country list defined under Point 2.2. The rules have to rely on ISO 20275 (valid legal forms) in combination with ISO 3166-1 (valid country codes). The rules have to be based on the transliterated version and transliterated abbreviations of legal forms based on ISO 01-140-10.

The DQD rules have to contain the capability to identify variations in the representation of legal forms by applying appropriate technologies to identify synonymous terms. By missing terms via the ISO standards DQD has to complement the legal forms especially abbreviations as needed.

Legal Name

The DQD rules have to identify the correct Legal Name of a Legal Entity. This includes the capability to identify synonymous terms and abbreviations and convert them into the correct Legal Name as registered via authorized country registry.

Tax Identification

The DQD rules for tax identification have to be capable of validating the following Tax IDsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use. by defined country and subregion:

• Company Tax ID
• VAT ID
• Tax Jurisdiction Code

The DQD rules for the Company Tax Identification have to validate the correct syntactical structure of the Company Tax ID defined by the related authorized country tax departments. Additionally, to the Company Tax ID, DQD rules have to validate the syntactical correctness of the VAT ID by country.

In selected countries a Tax Jurisdiction Code is required. The DQD rules have to validate the syntactical correctness by country.

Address

The DQD rules have to incorporate all specific country rules at a minimum as defined by the country list under Point 2.2 This includes the correctness of country, city by country, postal codes and optional the geographical coordinates based on ISO 6709 and WGS84 (World Geodetic System 1984).

Relations

The DQD rules have to validate the correctness of relations between the Legal, Site and Address entities as defined by the BP data model.

Identifier

To provide defined quality results of the DQD rules, they have to leverage publicly available BP Identifier to cross-check the correctness of BP data record attributes.

2 MAIN CONTENT

This section is normative

DQD has to contain the following dashboard-based functionalities:

Visualization of Inbound Persistence BP data records by defined DQD rule results:

1. Filter capabilities of BP data results by time, country, DQD status, BP role, DQD rule.
2. DQD rule statistics
3. BP data record statistics
4. Dashboard setting capabilities

• NPM package: https://www.npmjs.com/package/@catena-x/portal-shared-components/v/2.1.2
• Storybook: https://eclipse-tractusx.github.io/portal-shared-components/

The Data Quality Dashboard (DQD) MUST perform the validation of a BP data record which was uploaded into the CX Member Inbound Persistence. The DQD rule set and visualization of business partner data MUST be based at a minimum on the standards defined in CX-0010 Version 2.0.0 Business Partner Number, CX-0074 Version 3.0.0 Business Partner Gate APIAPI An API is a way for two or more computer programs to communicate with each other., CX-0012 Business Partner Pool APIAPI An API is a way for two or more computer programs to communicate with each other. Version 4.0.0 include CX-0076 Version 1.1.0 Golden Record EndtoEnd Requirements Standard current versions or higher.

2.1 Preconditions and Dependencies

To run the DQD with the BPDM, Gate APIAPI An API is a way for two or more computer programs to communicate with each other. and Pool APIAPI An API is a way for two or more computer programs to communicate with each other. SHOULD be set up: https://github.com/eclipse-tractusx/bpdm/blob/main/README.md

2.2 DQD Specifications

The DQD rule set MUST use the following BP data record attributes as defined in CX-0074 Version 3.0.0 or higher:

1. Legal Entity which contains the following attributes
   1. External ID
   2. BPNLBPNL The unique identifier of a legal entity of a partner within Catena-X (e.g., a company)., BPNSBPNS The unique identifier of a partner site within Catena-X (e.g., a specific factory)., BPNA
   3. Legal Name Parts
   4. Legal Form
   5. Classifications
   6. Legal Address
   7. Created at
   8. Updated at
2. Legal Entity Identifier
   1. Value
   2. Type
   3. Issuing Body
3. Site
4. Address
5. Identifier Type

2.3 DQD usage of Norms

The DQD rule set MUST us the following ISO Norms:

2.3.1 ISO Norm 20275

The DQD rule set MUST use the content of the ISO 20275 to validate the correctness of legal names in long form and/or abbreviation in a transliterated form.

ISO 20275: Code-Liste für Rechtsträgerformen - GLEIF-Blogbeiträge - Newsroom & Medien – GLEIF

2.3.2 ISO Norm 3166-1

The DQD rule set** MUST use the ISO 3166-1 related codes for at least 116 countries as listed below:

2.3.3 Country List based on ISO 3166-1

AD	CL	GE	IS	MC	PL	TJ
AE	CN	GH	IT	MD	PT	TM
AL	CO	GI	JM	ME	PY	TN
AM	CR	GP	JP	MK	QA	TR
AR	CU	GR	KE	MT	RO	TT
AT	CY	GT	KG	MX	RS	TW
AU	CZ	HK	MY	RU	UA
AZ	DE	HN	KR	NA	SA	UK
BA	DK	HR	KW	NI	SE	US
BE	DZ	HT	KZ	NL	SG	UY
BG	EC	HU	LB	NO	SI	UZ
BO	EE	ID	LK	NZ	SK	VA
BR	EG	IE	LT	PA	SM	VE
BY	ES	IL	LU	PE	SN	VN
CA	FI	IN	LV	PH	SV	XK
CH	FR	IR	MA	PK	TH	ZA
						ZW

ISO - ISO 3166 — Country Codes

2.4 DQD usage of External Data Sources

The DQD rule set might use defined external data sources supporting the rule set as needed in validating the correctness of CX Member business partner data records or providing recommendation of data enrichments. The use of external data sources is dependent on the respective CX member as a user of DQD ensuring the provision of corresponding licenses through the respective APIAPI An API is a way for two or more computer programs to communicate with each other.. Otherwise, DQD will only provide the results of the data quality screening for business partners in syntactic form.

1. Commercial Register by defined countries based on ISO 3166-1 country list as defined in Chapter 2.3
2. VAT ID provided by the European Tax Authorities or local tax authorities based on ISO 3166-1 country list as defined in Chapter 2.3
3. Postal Code by country authorities
4. Legal Name and Legal Form owned by local authorities and based on ISO 20275 standard in long form and short form in transliterated version
5. Address details based on local authorities related to the country list based on 3166-2 as defined in Chapter 2.3
6. GEO data based on WGS84 standard
7. Subregion Code based on ISO 3166-2 standard

2.5 DQD Results

The DQD rule set MUST provide for each BP data record a quality result based on a data field syntax check in the DQD Dashboard and in a DQD Logfile.

2.6 DQD Dashboard

The DQD Dashboard MUST provide the capabilities:

1. Visualization of Business Partner Data records as defined by the Golden Record Process based on the CX-0076.
2. DQD provides visibility by defined user roles. They are mapped to the CX Portal user roles defined via the App Provider function.
3. DQD contains the visibility of BP data by user role and user based filter functions. The BP data can get filtered by:
   1. Year, quarter or month
   2. Country or Region as defined by ISO 3166-1 and ISO 3166-2
   3. By BP type as customerCustomer In the context of OSim, the receiver of produced goods from a supplier. or supplierSupplier In the context of OSim, the producer of goods.
   4. By BP data record type BPNLBPNL The unique identifier of a legal entity of a partner within Catena-X (e.g., a company)., BPNSBPNS The unique identifier of a partner site within Catena-X (e.g., a specific factory). or BPNA as defined via CX-0010 Standard.
4. Visualization of Data Quality Screening results based on DQD KPIs and related achievements in percentage. This function enables the setting of BP data quality KPIs by CX Member
5. DQD contains a dark and light version option
6. DQD is available in German and English language
7. DQD contains a help function
8. DQD contains the capability to change layout and view setting by user
9. DQD contains an admin screen which enables user specific settings like layout and view settings, KPI target and threshold settings

3.0 DQD APIAPI An API is a way for two or more computer programs to communicate with each other.

3.1 DQD Data Model

The DQD Data Model as defined in the Annex chapter contains all BP and DQD dashboard attributes needed to perform the DQD screening. The general length of a data attribute is 255 bytes.

3.2 APIAPI An API is a way for two or more computer programs to communicate with each other. Endpoints and Resources

The resources MUST use the well-known HTTPHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. request methods for CRU(D) operations:

• POST MUST be used for create requests
• PUT MUST be used for update requests
• GET MUST be used for read requests

POST MAY also be used for read requests, if input is not given by parameters but rather by an HTTPHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. body to bypass maximum URL length. PUT MAY also be used for upsert requests (create or update) if this is required. A state (active / inactive) at each entity MUST be used for a soft delete, so that the request method DELETE SHALL NOT be used. Other HTTPHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. request methods SHALL NOT be used, including PATCH.

Uploading and downloading data to/from the DQD APIAPI An API is a way for two or more computer programs to communicate with each other. MUST follow a staging concept with two stages, so that consumers of the DQD APIAPI An API is a way for two or more computer programs to communicate with each other. can compare what they have uploaded into the input stage against what kind of DQD rule results and status code was provided for each business partner data in the output stage. The following controllers MUST distinguish between an input and an output stage.

The DQD architecture describes in which intercommunication the DQD APIAPI An API is a way for two or more computer programs to communicate with each other. is used.

3.3 Data Quality Controller

The data quality controller MUST allow to create, update, or read (search / return) business partner data records related to an External Identifier or BPNBPN A BPN is the unique identifier of a partner within Catena-X. ID in the input and output stage. It MUST have the following resources:

Business partner Data Controller Resources	Description
PUT/apiAPI An API is a way for two or more computer programs to communicate with each other./dqd/input/business partner data	Creates or updates shareholder data and 3rd party data related to business partner data record in the DQD database.
GET/apiAPI An API is a way for two or more computer programs to communicate with each other./dqd/output/DQD Screening Results	Returns DQD quality rule status codes from the DQD changelog by different search parameters
GET/apiAPI An API is a way for two or more computer programs to communicate with each other./dqd/output/DQD Statistics	Returns DQD quality statistics by different search parameters from the DQD changelog.

3.4. Data Quality Sharing State Controller

The sharing state controller MUST allow to create, update, or read sharing state entries related to business partner data record DQD rule status codes.  The sharing state controller MUST have the following resources:

Sharing State Resources	Description
GET/apiAPI An API is a way for two or more computer programs to communicate with each other./dqd/sharing-state	Returns sharing states of business partner data filtered by legal name, legal form, External Identifier, BPNBPN A BPN is the unique identifier of a partner within Catena-X. ID and type, country and status code
PUT/apiAPI An API is a way for two or more computer programs to communicate with each other./dqd/sharing-state	Creates or updates a sharing state of a business partner data record

3.5 AVAILABLE DATA TYPES

The APIAPI An API is a way for two or more computer programs to communicate with each other. MUST use JSON as the payload format transported via HTTPHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes.. Other formats can be added. These are then, however, OPTIONAL.

3.6 DATA ASSETAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. STRUCTURE

The following data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. MUST be registered at the Core Service Provider so that the Sharing Member can negotiate an APIAPI An API is a way for two or more computer programs to communicate with each other. usage contract with the Core Service Provider and access its dedicated BPDM Gate (hosted by the Core Service Provider) through these data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer.:

Name	Type	Version	Description
UploadAccessSharingMemberDataforDQD	DQD	1.0	Grants the Sharing Member full access to the DQD Admin function, DQD database and DQD changelog. This contains create / update DQD admin settings by Sharing Member role by DQD function, activating and deactivating the usage of external data sources via defined APIsAPI An API is a way for two or more computer programs to communicate with each other. and license keys.
UploadAccess3rdpartyDataforDQD	DQD	1.0	Grants the Sharing Member full access to upload 3rd party data for DQD rule execution
ReadAccessDQDOutputForSharingMember	DQD	1.0	Grants the Sharing Member read access of the DQD changelog.

The OAuth2 client permissions MUST be configured to solely allow access to the APIAPI An API is a way for two or more computer programs to communicate with each other. resources defined in the corresponding assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer., checking HTTPHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. method (read vs. full access), path, query parameters and body of the HTTPHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. request.

3.7 POLICY CONSTRAINTS FOR DATA EXCHANGE

In alignment with our commitment to data sovereignty, a specific framework governing the utilization of data within the Catena-X use cases has been outlined. As part of this data sovereignty framework, conventions for access policies, for usage policies and for the constraints contained in the policies have been specified in standard 'CX-0152 Policy Constraints for Data Exchange'. This standard document CX-0152 MUST be followed when providing services or apps for data sharing/consuming and when sharing or consuming data in the Catena-X ecosystem. What conventions are relevant for what roles named in 1.1 AUDIENCE & SCOPE is specified in the CX-0152 standard document as well. CX-0152 can be found in the standard library.

3.8 ERROR HANDLING

The following httpHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. response codes MUST be defined for all resources:  

• 200 – OK  
• 400 – Bad Request
• 401 – Unauthorized
• 403 – Forbidden
• 404 – Not Found  
• 500 – Internal Server Error

HTTPHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. Status Code Registry MUST be adhered to in the implementation for the decision on when to use which error code: https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

4 REFERENCES

4.1 NORMATIVE REFERENCES

Business Partner Pool API

Business Partner Gate API

ISO 3166-1 for referencing on country codes ISO 3166-2 for referencing on sub-region codes ISO 20275 for referencing on global valid legal forms ISO 6709 and World Geodetic Sytstem 1984 (WGS84) for referencing on Geo Data ISO 01-140-10 for transliteration of non-latin characters in to latin characters ISO 8601 for referencing to the international standard of the date format ISO/IEC 8859-1 for referencing to the International standard of the Multinational Character Set

4.2 NON-NORMATIVE REFERENCES

This section is non-normative

• BPDM Catena-X Website
• Catena-X IP Regulations
• Catena-X Standards Library

4.3 REFERENCE IMPLEMENTATIONS

This section is non-normative

Intentionally left blank.

ANNEXES

DQD Data Model

DQ Dashboard Data Model - Field name	Description	Type
Actual DQ KPI Percentage	The tile shows the actual data quality KPI of the sharing member in the persistence. The KPI takes the following DQ issues into account: ERRORS	Percentage
BP Type	BP type represents the BP types: SupplierSupplier In the context of OSim, the producer of goods., One Time SupplierSupplier In the context of OSim, the producer of goods., CustomerCustomer In the context of OSim, the receiver of produced goods from a supplier., One Time SupplierSupplier In the context of OSim, the producer of goods., Business Partner as defined in the CX BP Data Model	Enum
BPNBPN A BPN is the unique identifier of a partner within Catena-X. Issuing	A number which contains the CX Member BP data records which received a valid and unique BPNBPN A BPN is the unique identifier of a partner within Catena-X. ID	Numeric
Business Partner Classification	The term contains the BP classification Legal, Site and Address	Enum
Country	Country represents the countries based on ISO 3166-1	Alphanumeric
DQ KPI over Time Period	The chart shows the Target DQ KPI and the Actual DQ KPI values per month over the filtered time period as a line chart	Numeric
DQ Rules	Contain the total number of rules used to perform the screening process of business partner data	Numeric
DQ Status	DQ Status contains an array with all DQ status codes and reference to the appropriate DQ rules	Alphanumeric
DQ Target KPI CX Member Percentage	The tile shows the target data quality KPI of the sharing member in the persistence. The KPI can be defined by each sharing member individually (based on their own goals).	Percentage
Month	Defines a specific month	Alphanumeric
Number of Data Records	Contains the total number of BP master data in the CX Member Inbound Persistence, in the CX BP Pool and the number of overlapping BP data records	Numeric
PostalAddress.Country.CountryCode	Data field represents the country code as defined by ISO 3166-1	Alphanumeric
PostalAddress.Country.Name	Country name represents the name based on ISO 3166-1	Alphanumeric
Region	Region contains selected countries and subregions based on ISO 3166-1 and 3166-2 by the CX Member	String Array
Subregion	Subregions represents all subregions or dependent states based on ISO 3166-2	Alphanumeric
Time period	The tile shows the time period for which the data records should be displayed and uses the data fields Year and Month.	Numeric
Total DQ Error Percentage	The tile shows the percentage value of all DQ errors of all BP data records of the sharing member in the persistence.	Percentage
Total DQ Errors	The tile shows the total number of DQ errors of all BP data records of the sharing member in the persistence.	Numeric
Total DQ Warning Percentage	The tile shows the percentage value of all DQ errors of all BP data records of the sharing member in the persistence.	Percentage
Total DQ Warnings	The tile shows the total number of DQ errors of all BP data records of the sharing member in the persistence.	Numeric
Year	Defines the selected year or duration of up to 3 years in the past	Numeric

FIGURES

This section is non-normative

Intentionally left blank.

TABLES

This section is non-normative

Intentionally left blank.

Legal

Copyright © 2025 Catena-X Automotive Network e.V. All rights reserved. For more information, please visit here.