CX-0123 Quality Use Case Standard v3.0.2
ABSTRACT
The Catena-X use case "Quality" provides the ability to detect quality issues the earliest possible to start root cause analyses and/or to enable an early warning feature for new quality topics. In subsequent steps, countermeasures can also be defined earlier and monitored. In sum, this reduces the number of vehicles affected by quality issues and increases the availability of the vehicle and built-in components. In its Version 3 the use case was enhanced by additional standard data models for warranty and 8D information. The Catena-X use case "Quality" is powered by Catena-X standard core components to share data from vehicle manufacturer(OEM) and component suppliersSupplier In the context of OSim, the producer of goods. based on data sharing agreements and usage policies.
FOR WHOM IS THE STANDARD DESIGNED
see section Audience & Scope
1 INTRODUCTION
The Catena-X use case "Quality" uses multiple data models to exchange data between vehicle manufacturer(OEM) and component supplierSupplier In the context of OSim, the producer of goods. (TIER 1) and also along the supply chain between TIER N and TIER N + 1. Each of these data models can be supplied independently. The QualityTask data model defines the root element for Catena-X-based quality work. It describes the quality task and why two companies want to work collaboratively on a quality topic. Additionally, the use case provides two data models to transfer warranty claim data and the respective response between partners. And finally a data model for any 8D information is provided.
1.1 AUDIENCE & SCOPE
This section is non-normative
The standard is relevant for the following roles within the scope of the Use Case "Quality"
- Data Provider/Consumer
- Business Application Provider
In scope:
- Data sharing between vehicle manufacturer(OEM) and component supplierSupplier In the context of OSim, the producer of goods. on TIER 1 to TIER N level
- Earliest possible detection of potential issues with products and vehicles in usage
- Understanding of the root cause of the detected issues to enable earliest possible counter measure implementation and monitoring the effectiveness
1.2 CONTEXT AND ARCHITECTURE FIT
This section is non-normative
For all participants of the Use Case "Quality" it is necessary to provide and consume the data in accordance to the standardized semantic data models in section 3 Aspect Models to ensure the defined interoperability requirement "free of choice application" to be able to use the established in-house tool set for analysis.
Catena-X use case "Quality" data flow: Data is exported from existing back-end systems and mapped to Catena-X aspect modelsAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing). - see list of relevant Catena-X aspect modelsAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing). for use case "Quality" in section 3 Aspect Models The so generated files are transferred between different Catena-X participants using a connector conformant to [CX-0018].
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 key words MAY, MUST, MUST NOT, OPTIONAL, RECOMMENDED, REQUIRED, SHOULD and SHOULD NOT in this document 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).
Since this Use Case Quality Standard describes a set of standards to be fulfilled, participants MUST fulfil all mentioned standards and the respective conformity assessment criteria in addition to the specific criteria mentioned in this document.
The specific criteria in this document describe the usage of the central tools as well as common tools described in the linked standardization documents and therefore compliance SHOULD BE checked with the tools provided for these components.
1.4 EXAMPLES
1.5 TERMINOLOGY
This section is non-normative
Business Partner Number (BPNBPN A BPN is the unique identifier of a partner within Catena-X.) : A BPNBPN A BPN is the unique identifier of a partner within Catena-X. is the unique identifier of a partner within Catena-x
Connector: Connector conformant to [CX-0018]
SAMM CLI tool
: A command line tool that allows the generation of different formats from a semantic modelling ttl file.
see https://eclipse-esmf.github.io/esmf-developer-guide/tooling-guide/samm-cli.html
Additional terminology used in this standard can be looked up in the glossary on the association homepage.
2 RELEVANT PARTS OF THE STANDARD FOR SPECIFIC USE CASES
This section is normative
2.1 "DATA SHARING RULES"
2.1.1 LIST OF STANDALONE STANDARDS
To participate in Data Provisioning for the "Quality Use Case", the following single standards MUST be fulfilled by all participants
- CX - 0018 Data Space Connectivity v3.0.0
2.1.2 DATA REQUIRED
In order to participate in the Catena-X use case "Quality" the following single standards MUST be fulfilled by all participants:
CX - 0018 Data space Connectivity v4.1.0
To transfer data properly, the following data models MUST be used by the data provider:
- io.catenax.quality_task v3.0.0
- io.catenax.fleet.diagnostic_data v.3.0.0
- io.catenax.fleet.claim_data v.3.0.0
- io.catenax.parts_analyses v.4.0.0
- io.catenax.manufactured_parts_quality_information v.3.0.0
- io.catenax.fleet.vehicles v.4.0.0
- io.catenax.quality_task_attachment v.3.0.0
- io.catenax.early_warning_notification:1.0.0
- io.catenax.failure_pattern:1.0.0
- io.catenax.report_8d v.1.0.0
- io.catenax.warranty_claim_request v.1.0.0
- io.catenax.warranty_claim_request_verification v.1.0.0
Each data model is described in detail under chapter 3.
For data transfer following scenarios are possible: vehicle manufacturer(OEM) to component manufacturer(TIER1 supplierSupplier In the context of OSim, the producer of goods.), component manufacturer(TIER1 supplierSupplier In the context of OSim, the producer of goods.) to vehicle manufacturer(OEM) or Tier n supplierSupplier In the context of OSim, the producer of goods. to Tier n+1 supplierSupplier In the context of OSim, the producer of goods..
If a Vehicle manufacturer or SupplierSupplier In the context of OSim, the producer of goods. is sending an early warning notification, this early warning notification MUST be compliant with the early warning notification APIAPI An API is a way for two or more computer programs to communicate with each other. described in Chapter 4 of this document.
The data provider defines the data content that will be provided. The data provider MUST provide properties that are flagged as mandatory in the data model.
Provided 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. are defined in data sharing agreements and/or data usage policies between data provider and data consumer.
A Business Application Provider MUST support at least 2 of the above-listed data models (minimum standard). A Business Application Provider SHOULD support the early warning notification APIAPI An API is a way for two or more computer programs to communicate with each other..
2.1.3 ADDITIONAL REQUIREMENTS
2.1.3.1 Transfer of data assets
The RECOMMENDED transfer method of 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. from data provider to data consumer depends on the used data model. In general, file-based data transfer or 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.-based data transfer are supported.
- io.catenax.quality_task v3.0.0: RECOMMENDED format Apache Parquet, file-based data transfer mode
- io.catenax.fleet.claim_data v.3.0.0: RECOMMENDED format Apache Parquet, file-based data transfer mode
- io.catenax.fleet.diagnostic_data v.3.0.0: RECOMMENDED format Apache Parquet, file-based data transfer mode
- io.catenax.fleet.vehicles v.4.0.0: RECOMMENDED format Apache Parquet, file-based data transfer mode
- io.catenax.manufactured_parts_quality_information v.3.0.0: RECOMMENDED format Apache Parquet, file-based data transfer mode
- io.catenax.parts_analyses v.4.0.0: RECOMMENDED format Apache Parquet, file-based data transfer mode
- io.catenax.quality_task_attachment v.3.0.0: RECOMMENDED format gzip, file-based data transfer mode
- io.catenax.warranty_claim_request v.1.0.0: RECOMMENDED format json, 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.-based data transfer mode
- io.catenax.warranty_claim_request_verification v.1.0.0: RECOMMENDED format json, 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.-based data transfer mode
- io.catenax.report_8d v.1.0.0: RECOMMENDED format json, 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.-based data transfer mode
2.1.3.2 Dataset Properties for file-based data assets
The following table shows a list of connector catalogue properties. As a data provider, I MUST provide these connector catalogue properties for file-based 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.. These properties are needed to allow a data consumer to filter for a specific 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. from the large number of 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. in the connector catalogue. In addition, these properties help to correctly use and interpret the file-based 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. on consumer side.
| Property | Value | Description |
|---|---|---|
| "@id" | "430f56d3-1234-1234-1234-abc123456789__io.catenax_fleet.claim_data__3.0.0.parquet" | Each catalogue entry needs a unique id. You can use a UUID v4 or a human readable id. RECOMMENDED human readable id follows the pattern <catenaXQualityTaskId>__<SemanticModel>__<model_version>.parquet. Separator are two underscores: __ |
"https://purl.org/dc/terms/conformsTo" | "@id": "urn:samm:io.catenax.fleet.claim_data:3.0.0" | This property is QM-specific and a MUST. It holds the aspect-model-URN(without # at the end) that defines used aspect modelAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing). and version. |
"https://purl.org/dc/terms/format" | "application/octet-stream;type=parquet-snappy" | This property is QM-specific and a MUST. It indicates the format of the 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.. Supported formats for file-based data transfer are "application/octet-stream;type=parquet-snappy", "application/octet-stream;type=gzip", "text/richtext;type=json". See https://www.iana.org/assignments/media-types-parameters/media-types-parameters.xhtml |
| "dcat:qualifiedRelation" | "{https://purl.org/dc/terms/isPartOf": {"@id": "430f56d3-1234-1234-1234-abc123456789"}} | This is QM-specific and a MUST. {"isPartOf": {"@id": "<corresponding catenaXQualityTaskId>"}}. Allows to filter for all file-based 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. that belong to one Catena-X Quality Task ID. |
2.1.3.3 Apache parquet format
At least Apache parquet format in version 2.10.0 or higher MUST be used (see https://parquet.apache.org/ ).
2.1.3.4 Type mapping from Eclipse semantic modelling framework data types(samm) to Apache Parquet data types
The following mappings MUST be used when using parquet format for Catena-X use case quality:
| samm data type | Apache Parquet data type |
|---|---|
| boolean | BOOLEAN: 1 bit boolean |
| float | FLOAT: IEEE 32-bit floating point values |
| double | DOUBLE: IEEE 64-bit floating point values |
| int | INT32: 32-bit signed int |
| long | INT64: 64-bit signed int |
| date | date as INT32 |
| timestamp | milliseconds as INT64 |
| string | BYTE_Array, strings must be UTF8 encoded |
2.1.3.5 Flattening from hierarchical Eclipse semantic modelling framework structure(samm) to flat Apache Parquet structure
Apache parquet is a tabular flat format. Catena-X semantic models are hierarchically structured. The hierarchical structure MUST be transferred into a flat table structure using following convention. To generate the table structure use following approach:
- use SAMM CLI tool to generate a json file out of ttl file
- use only the keys from the generated json file, and concatenate the root key with child key by using "_" as separator. Doing the same for one level done.
To fill in the values:
- If one samm entity has a list of child entities, use left join to duplicate the row of the parent entity for each child
- As json format only supports string and number type, it is a MUST to use above samm ttl type mapping when building tabular parquet structure.
- If properties are not available, use null
- In some rare cases mandatory properties might not be available on data provider side: Use in this case "n/a" for mandatory string properties. For mandatory date properties use null or 1970-01-01.
Example json:
{
"qualityTasks": [
{
"recordStatus": "new",
"creationDate": "2023-11-11",
"partName": "ABS",
"dataDeletion": "delete-data-after-closing",
"description": "Early Warning of vehicle model A with component ABS.",
"qualityTaskId": "430f56d3-1234-1234-1234-abc123456789",
"status": "new",
"title": "Early Warning A",
"companies": [
{
"bpnlProperty": "BPNL000000000123",
"name": "testCompanyA"
},
{
"bpnlProperty": "BPNL000000000124",
"name": "testCompanyB"
}
]
}
]
}
Resulting parquet table:
| qualityTasks_recordStatus | qualityTasks_creationDate | qualityTasks_partName | qualityTasks_dataDeletion | qualityTasks_description | qualityTasks_qualityTaskId | qualityTasks_status | qualityTasks_title | qualityTasks_companies_bpnlProperty | qualityTasks_companies_name |
|---|---|---|---|---|---|---|---|---|---|
| new | 2023-11-11 | ABS | delete-data-after-closing | Early Warning of vehicle model A with component ABS. | 430f56d3-1234-1234-1234-abc123456789 | new | Early Warning A | BPNL000000000123 | testCompanyA |
| new | 2023-11-11 | ABS | delete-data-after-closing | Early Warning of vehicle model A with component ABS. | 430f56d3-1234-1234-1234-abc123456789 | new | Early Warning A | BPNL000000000124 | testCompanyB |
2.1.4 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.
2.1.5 DIGITAL TWINS AND SPECIFIC ASSET IDs
3 ASPECT MODELS
3.1 ASPECT MODEL "QUALITY TASK"
3.1.1 INTRODUCTION
The "Quality Task" data model is the root element for Catena-X-based quality work. It is a model that can be created by vehicle manufacturer or supplierSupplier In the context of OSim, the producer of goods. and describes why data is exchanged over Catena-X network between two companies(purpose) and what should happen with transferred data after completion of this "Quality Task".
For data providers: Each "Quality Task" MUST have a unique qualityTaskId conformant to the semantic model.
3.1.2 SPECIFICATIONS ARTIFACTS
This aspect modelAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing). is written in SAMM 2.1.0 as a modelling language conformant to CX-0003.
Like all Catena-X data models, this model is available in a machine-readable format on GitHub repository sldt-semantic-models [https://github.com/eclipse-tractusx/sldt-semantic-models].
3.1.3 LICENSE
This Catena-X data model is made available under the terms of the Creative Commons Attribution 4.0 International (CC-BY-4.0) license, which is available at Creative Commons.
The license information is available inside the turtle file (*.ttl-file) on GitHub.
In case of doubt, GitHub overwrites the information for license, copyright and author from this document.
3.1.4 IDENTIFIER OF SEMANTIC MODEL
This semantic model "Quality Task" has the unique identifier qualityTaskId which is a UUID v4 identifier.
<urn:samm:io.catenax.quality_task:3.0.0#>
3.1.5 FORMATS OF SEMANTIC MODEL
Different formats can be generated through the turtle file (*.ttl-file) and the SAMM CLI tool.
3.1.5.1 RDF TURTLE
The rdf turtle file is the master for generating additional file formats and serializations. It can be found on github repository.
[https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.quality_task/3.0.0/QualityTask.ttl]
The open source command line tool of the Eclipse Semantic Modelling Framework is used for generation of other file formats like JSON Schema, aasx for Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin. Submodel Template or HTML documentation.
3.1.5.2 JSON SCHEMA
A JSON Schema can be generated from the RDF Turtle file. The JSON Schema defines the Value-Only payload of the Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin. for the APIAPI An API is a way for two or more computer programs to communicate with each other. operation "GetSubmodel". It can be found in the current version in the "gen" subfolder on the github repository.
[https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.quality_task/3.0.0/gen]
3.1.5.3 AASX
An AASX file can be generated from the RDF Turtle file. The AASX file defines one of the requested artifacts for a Submodel Template Specification.
3.2 ASPECT MODEL "FLEET DIAGNOSTIC DATA"
3.2.1 INTRODUCTION
The purpose of this section is the description of the "Fleet Diagnostic Data" semantic data model.
The "Fleet Diagnostic Data" semantic data model consists of a list of diagnostic sessions.. Each diagnostic session contains a vehicle diagnostic that was performed either in a repair shop or over-the-air.
The target is to provide diagnostic data that can be used for the purpose of early warning or root cause analysis.
The "Fleet Diagnostic Data" semantic data model is provided by a vehicle manufacturer.
Each "Fleet Diagnostic Data" MUST contain an unique sessionId and a unique anonymizedVIN conformant to the semantic model.
3.2.2 SPECIFICATIONS ARTIFACTS
This aspect modelAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing). is written in SAMM 2.1.0 as a modelling language conformant to CX-0003.
Like all Catena-X data models, this model is available in a machine-readable format on GitHub repository sldt-semantic-models [https://github.com/eclipse-tractusx/sldt-semantic-models].
3.2.3 LICENSE
This Catena-X data model is made available under the terms of the Creative Commons Attribution 4.0 International (CC-BY-4.0) license, which is available at Creative Commons.
The license information is available inside the turtle file (*.ttl-file) on GitHub.
In case of doubt, GitHub overwrites the information for license, copyright and author from this document.
3.2.4 IDENTIFIER OF SEMANTIC MODEL
The semantic model has the unique identifier
<urn:samm:io.catenax.fleet.diagnostic_data:3.0.0#>
3.2.5 FORMATS OF SEMANTIC MODEL
Different formats can be generated through the turtle file (*.ttl-file) and the SAMM CLI tool.