Skip to content

Commit

Permalink
Merge branch 'main' into updates/release-news
Browse files Browse the repository at this point in the history
  • Loading branch information
Siegfriedk authored Dec 8, 2023
2 parents 4c695d0 + b77d581 commit 8caee10
Show file tree
Hide file tree
Showing 502 changed files with 44,146 additions and 139 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ For the process described in the KIT Quality, data exchange between the particip

### **Asset File type**

It is recommended to create and transfer the files in the types csv, parquet, json or xls
It is recommended to create and transfer the files in the type parquet. Only attachments for the Quality task (Quality Task Attachment) should be created in ZIP format.

### **Asset Transfers**
### **Asset Transfers via EDC**

File transfer can be done via EDC S3 plane or alternatively REST http.
File transfer is recommended to be done via EDC S3 plane, The transfer via EDC http data plane is not recommended due to the big data size.

### **Asset consumption**

Expand Down
30 changes: 20 additions & 10 deletions docs-kits/kits/Quality-Kit/page_adoption-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ In sum this KIT enables quality management to substantially **increase speed** i

With the Quality KIT, we support the Catena-X customer journey for our adopters and solutions providers.

![quality kit customer journey diagram](@site/static/img/quality-kit_customer-journey-min.png)
![quality kit customer journey diagram](@site/static/img/quality.kit_customer-Journey-1_1.jpg)

## Business Value

Expand Down Expand Up @@ -98,7 +98,7 @@ The affected component continues to be monitored regularly. After a few months,

The image below shows user feedback, challenges, results and benefits of the new data-based way of working using the example of the Early Warning & Root Cause Analysis process steps.

![quality kit example of benefits chart](@site/static/img/quality-kit_example-benefit-min.png)
![quality kit example of benefits chart](@site/static/img/quality-kit_example-benefit-1_1.png)

**Conclusion:**

Expand All @@ -116,7 +116,7 @@ Overview about how Quality Management is improved by Catena-X

For more technical details take a look at the video in the [Operation View](/docs-kits/kits/Quality-Kit/page_software-operation-view.md)

Data driven Quality Management with Catena-X - Statements from the consortial partners
Data driven Quality Management with Catena-X - [Statements from the consortial partners](http://youtube.com/watch?v=T-Xh_LzXXbg)

<iframe width="100%" height="350" src="https://www.youtube.com/embed/T-Xh_LzXXbg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

Expand Down Expand Up @@ -381,7 +381,7 @@ Github Link to semantic data model: [CX-00040 Parts Analyses](https://github.com

### Business Logic

![quality kit business logic diagram](@site/static/img/quality-kit_business-logic-min.png)
![quality kit business logic diagram](@site/static/img/quality-kit_business-logic-1_1.png)

The prerequisite for faster faster problem solving is the earliest possible detection of a problem (early warning) and the fastest possible understanding of the error chain and cause (root cause analysis). Early Warning in general has to be realized at all relevant points along the value chain.

Expand All @@ -393,7 +393,7 @@ If a problem is detected by early warning in the field or in production, a data-

### Architecture Overview

![independant architecture r3_2 chart](@site/static/img/quality-kit_general_app-independant_architecture-R3_2-min.jpg)
![independant architecture r2312 chart](@site/static/img/quality-kit_general_app-independant_archicture-R2312.jpg)

The tier-1 receives data on vehicle master data, existing claims and DTCs. Once the data is received, the Tier-1 supplier is analyzing the data in order to detect patterns based on which DTCs and claims can be explained. The data is shared and consumed as assets via the companies' EDC while the authorization is managed via the the shared services of the consortia.

Expand All @@ -417,7 +417,7 @@ The tier-1 receives data on vehicle master data, existing claims and DTCs. Once

To realize the **Business Logic** described in the Quality Kit

![quality kit business process diagram](@site/static/img/quality-kit_business-process-min.png)
![quality kit business process diagram](@site/static/img/quality-kit_business-logic-1_1.png)

all steps of the **Business Process** (described in the [Development View](https://confluence.catena-x.net/display/BDPQ/WORK+IN+PROGRESS+-+Quality+KIT+-+Development+View)), like data provisioning and consuming by the involved partner companies, are realized in compliance with the [Catena-X Data Governance Framework](https://catena-x.net/en/catena-x-introduce-implement/governance-framework-for-data-space-operations). Under this link you can find the latest version of the framework regulations as download. The documents are seperated in the following levels:

Expand All @@ -426,7 +426,7 @@ all steps of the **Business Process** (described in the [Development View](https
<!-- BROKEN LINK............... -->
**Data Space Level**: 10 Golden Rules of Catena-X

**Use Case Level**: Quality Management specific policy as MS Word download (not released yet): <a target="_blank" href={ require("/office/20230710_Catena-X_UseCasePolicy_Quality_3.0_EN.docx").default } download>20230710_Catena-X_UseCasePolicy_Quality_3.0_EN.docx</a>
**Use Case Level**: Quality Management specific policy as download: <a target="_blank" href={ require("/office/20230710_Catena-X_UseCasePolicy_Quality_3.0_EN.docx").default } download>20230710_Catena-X_UseCasePolicy_Quality_3.0_EN.docx</a>

**Data Offering** and **Usage Level** are defined by bi-lateral aligned policies and contracts between the cooperating partner companies. Content is currently in definition.

Expand All @@ -446,8 +446,18 @@ Our relevant standards can be downloaded from the official [Catena-X Standard Li

- [CX - 0041 Semantic Model Manufactured Parts Quality Information](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Live_Quality_Loops/CX_-_0041_Semantic_Model_Manufactured_Parts_Quality_Information_v_1.0.1.pdf)

- [CX - 0071 - Triangle Quality Early Warning Field and Root Cause (to be updated when published)](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0071-TriangleQualityEarlyWarningFieldandRootCause-v1.0.0.pdf)
- [CX - 0071 Triangle Quality Early Warning Field and Root Cause)](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0071-TriangleQualityEarlyWarningFieldandRootCause-v1.0.0.pdf)

<!-- - [CX - 0041 Semantic Model Manufactured Parts Quality Information](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/PLM_Quality_Use_Case_Live_Quality_Loops/CX_-_0041_Semantic_Model_Manufactured_Parts_Quality_Information_v_1.0.1.pdf)
- [CX - 0091 Aspect Model Fleet Vehicles](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0091-AspectModelFleetVehicles-v.1.0.0.pdf)

- [CX - 0071 - Triangle Quality Early Warning Field and Root Cause (to be updated when published)](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0071-TriangleQualityEarlyWarningFieldandRootCause-v1.0.0.pdf) -->
- [CX - 0092 Aspect Model Quality Task Attachment](https://catena-x.net/de/standard-library#top)

## Notice
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG
- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH
- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2023,2023 SAP SE
- SPDX-FileCopyrightText: 2023,2023 Siemens AG
- SPDX-FileCopyrightText: 2023,2023 Volkswagen AG
28 changes: 28 additions & 0 deletions docs-kits/kits/Quality-Kit/page_changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,34 @@ sidebar_position: 1

### Quality KIT

## [1.1.0] - 2023-11-23

### Added

- ./.

### Changed

#### Adaption view
General

- Update picture "Customer Journey"
- Update cosmetics to all pictures
- Document Use Case Framework Quality v1 added
- Update list of related standards
- License notice added

Area Tutorials
- Video "Data driven Quality Management with Catena-X - Statements from the consortial partners" now provided as link only

#### Development view
- Updated Asset Transfer recommendation

### Removed

- ./.


## [0.1.0] - 2023-08-18

### Added
Expand Down
1 change: 1 addition & 0 deletions docs-kits_versioned_docs/version-23.12/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Introduction
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
---
id: Adoption View Health Indicator Kit
title: Adoption View
description: 'Health Indicator Kit'
sidebar_position: 2
---

<!--
TODO: Fix missing image
![Health Indicator kit banner](@site/static/img/doc-hi_header-minified.png)
-->

### Health Indicator Kit
<!--
Adoption View of the Kit.
-->

## Vision & Mission

### Vision

Health monitoring of products and components is highly attractive. It offers significant added value for OEMs and suppliers and is already often part of the product range or product inquiry.

The Behaviour *Health Indicator* Kit (BT HI Kit) efficiently supports the planning, design, construction, use and operation of product-related services for health monitoring as part of quality management.

Based on the calculation of health indicators, the performance and condition of products and components in the field can be continuously monitored, recorded and transmitted along the supply chain. During the usage phase, abnormalities, possible defects or failures are reliably and identified early on, so that measures can be taken in good time.

### Mission

The Behaviour *Health Indicator* Kit (BT HI Kit) comes with the necessary Catena-X standards for health indicators and HI statements. Interoperable solutions are created on their basis. The Kit includes tools for easy implementation of component-specific health indicators and for their determination based on dynamic input data. All components are easily adaptable to specific applications and simplify the journey to the finished service.

### Customer Journey

With the *Health Indicator* Kit, we support the Catena-X customer journey for our adopters and solutions providers.

## Business Value

Through the standardized specifications described in the BT HI Kit – for example the semantic models and APIs – OEMs and TIER-X as data and service provider can reduce investment and implementation costs. Catena-X infrastructure and technology offers easy scalability regarding vehicle components and supply chain.

## Use Case

- OEM, TIER-X: During the usage phase, health indicators provide a continuous and comprehensive view of the condition of products in the field. Abnormalities, possible defects or failures can be detected reliably and early on. This provides the time advantage to initiate countermeasures in good time.
During development phase, health indicators can be used to bring more mature products into series production.

- Tier-X: The overall product range becomes more attractive in the offer phase, when the definition of health indicators as a product-related service is included.

- Workshops: In case of failure analysis and repair, workshops benefit from an extended range of data on vehicle condition and its components. In return, service providers can standardize and facilitate access to the OEM.

### Status Quo

Within company boundaries, the calculation of health indicators based on internally available data and models is already state of the art. However, across company boundaries, there are only individual, complex and not generally available options for component-specific transfer or monitoring of health indicators.

### Today’s challenge

For successful implementation, the following challenges must be addressed:
- the correct allocation of health indicators to the respective component
- recording and providing the necessary input variables
- easy to interpret results
- secure data transfer along the supply chain
- easy scalability across company boundaries


### Benefits

**OEMs and big suppliers** benefit from an increase in quality and shorter response times to anomalies in the field. The decisive hub is created by the standardized provision of health indicators across company boundaries — always in compliance with IP and data protection.

## Logic & Schema


### Building Block View
The architecture image describes the interaction between the HI Service and the Knowledge Agent components.

![Building Block Architecture Overview](images/BT_HI_KIT_Building_Block_Architecture_Overview_V1.png)

### HI Components
|Subsystem| Description |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|HI Application| This component is the app that is hosted at the Consumer/Data Provider. The data provider can select multiple vehicle identifier numbers (VIN) and gets back calculated HI values. |
|Loading Data | A data source at the Data Provider that provides the loading data and other vehicle data that are needed for the HI calculation. <BR/> It can be accessed by the knowledge agent via data bindings. |
|HI Service| A HI calculation service at the Service Provider. It accepts input data from the Data Provider, calculates the HI value and returns it. |

### Knowledge Agent components
|Subsystem| Description |
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|Matchmaking Agent| This component supports SparQL to traverse the federated data space as a large data structure. It interacts with the EDC. <UL><LI>The provider's Matchmaking Agent will be activated by its EDC. Therefore, the EDC must offer a Graph Asset (variant of ordinary data assets in the Catena-X EDC standard).</LI><LI> The consumer's Matchmaking Agent interacts with its EDC to negotiate and perform the transfer of Sub-Skills to other dataspace participants.</LI></UL> The Matchmaking Agents are matching the (sub)graphs and negotiate appropriated graph assets with the partner EDCs. |
|Binding Agent| The Binding Agent is a restricted version of the Matchmaking Agent (subset of OWL/SparQL, e.g., without federation) which is just focused on translating Sub-Skills of a particular business domain (Bill-Of-Material, Chemical Materials, Production Sites, etc.) into proper SQL- or REST based backend system calls. <BR/> Implementation details: For data bindings, OnTop is used. For service bindings, RDF4J is used. |
|Ontology| The ontology is a formal representation of knowledge that captures concepts, relationships, and properties. It allows a shared understanding and reasoning about the respective domain. <BR/> It must be hosted in a way that all participants can access it. Currently, the ontology is hosted at GitHub. |
|Skill/Sub-Skill| The Skill describes, what to do (which data have to be connected, transferred and so on). |

### Catena-X Core Services (except Knowledge Agent components)
|Subsystem|Description|
|---------|-----------|
|Eclipse Dataspace Components (EDC)|The Connector of the Eclipse Dataspace Components provides a framework for sovereign, inter-organizational data exchange. It implements the International Data Spaces standard (IDS) as well as relevant protocols associated with GAIA-X. The connector is designed in an extensible way in order to support alternative protocols and integrate in various ecosystems.|




## Business Process


![Business Process Overview](images/BT_HI_KIT_Business_Process_Overview_V1.png)

|Role|Description|
|---------|-----------|
|User @ OEM|Wants to continuously monitor the status of several vehicle's component.|
|OEM|Needs to collect or generate load/input data for the HI calculation from vehicle or backend.|
|Supplier|Acts here as a service provider and uses the input data to estimate HI values and send it back to OEM.|


## Access and Usage Policies
To enable data sovereignty, access and usage policies are important to protect the data assets of a data provider in the EDC, described in the following.

### Access Policies
To decide which company has access to the data assets, access policy should be used. It is maybe possible to skip access policies, but this will made all data assets public available in the Catena-X network and is not recommended. Therefore, every asset should be protected and only be made available for specific companies, identified through their business partner number (BPN). In the near future, other access policies will be introduced like a company role and attribute based policy. Further details can be found in this page of the [EDC](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/business-partner-validation).

### Usage policies
Use case specific credentials exist and will be mandatory. Their documentation will be available after SSI release.
A Behaviour Twin "Use Case Rahmenbedingung" which covers the business process of the app will be available after SSI release.
This Rahmenbedingung document can be referenced in the usage policies, and therefore limit Data & Service access to Behaviour Twin participants.


<!-- !Mandatory! -->
<!-- ## Semantic Models & Standards -->
## Standards

Our relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library).

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2022,2023 Allgemeine Deutsche Automobil-Club (ADAC) e.V
- SPDX-FileCopyrightText: 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
- SPDX-FileCopyrightText: 2022,2023 ZF Friedrichshafen AG
- SPDX-FileCopyrightText: 2022,2023 Contributors to the Eclipse Foundation
<!-- - Source URL: https://github.com/eclipse-tractusx/XXXXX -->
Loading

0 comments on commit 8caee10

Please sign in to comment.