Merge pull request #1064 from johannsvarela/docs-kits/trace-special-c…

…haracteristics-release-24.12

[Traceability KIT 24.12] Special Characteristics

docs-kits/kits/Industry Core Kit/Software Development View/part_aspect-model-overview.mdx

@@ -32,6 +32,3 @@ The following section shows an overview of all aspect models that are currently
 | | JustInSequencePart | 3.0.0 | | Industry Core | CX-0127 Industry Core: Part Instance v2.0.0 |
 | | SingleLevelBomAsBuilt | 3.0.0 | | Industry Core | CX-0127 Industry Core: Part Instance v2.0.0 |
 | | SingleLevelUsageAsBuilt | 3.0.0 | | Industry Core | CX-0127 Industry Core: Part Instance v2.0.0 |
-| | TractionBatteryCode | 2.0.0 | | Traceability |  CX-0125 Traceability Use Case v2.0.0 |
-| | SoftwareInformation | 1.0.0 | | Traceability | N/A |
-| | CertificateSigningRequests | 1.0.0 | | Traceability | N/A |

docs-kits/kits/Industry Core Kit/page_changelog.mdx

@@ -29,6 +29,15 @@ import Notice from './part_notice.mdx'
 
 All notable changes to this Kit will be documented in this file.
 
+## [1.3.0] - 2024-12-01
+
+Compatible for **release 24.08**.
+
+### Removed
+- **Development View:**
+  - **Aspect Models:**
+    - Removed the listed Traceability aspect models in the overview (were moved to the Traceability KIT)
+
 ## [1.2.0] - 2024-10-22
 
 Compatible for **release 24.08**.

docs-kits/kits/Traceability Kit/Software Development View/part_aspect-models.mdx

@@ -26,6 +26,16 @@ Aspect models are mostly easy to create by transforming a company's internal dat
 
 <AspectModelOverview components={props.components} />
 
+
+The following section shows an overview of all aspect models of the Traceability Use Case that can be attached to part instance twins.
+
+| Digital Twin Type | Aspect Model | Mandatory Version | Optional Versions | KIT | Standard |
+| :-- | :-- | :-- | :-- | :-- | :-- |
+| PartInstance | TractionBatteryCode | 2.0.0 | | Traceability |  CX-0125 Traceability Use Case v2.0.0 |
+| | SoftwareInformation | 1.0.0 | | Traceability | N/A |
+| | CertificateSigningRequests | 1.0.0 | | Traceability | N/A |
+| | SpecialCharacteristics | 1.0.0 | | Traceability | N/A |
+
 ### TractionBatteryCode
 
 The aspect provides the information of the Traction battery code of a battery cell, a battery module or a battery pack according to the chinese standard GB/T 34014-2017. Furthermore, it provides the traction battery codes for the assembled sub parts of the component, e.g.  Traction battery code of a battery module plus all the traction battery codes of the assembled battery cells of this battery module.
@@ -154,3 +164,91 @@ Aspect model in GitHub:
     ]
 }
 ```
+
+### SpecialCharacteristicMeasurement
+Special Characteristics are measureable and these measurements are of interest for a consumer who defined these characteristics. The proposal is a data model "result" which represents a measurement related to a specific measurement and product. A measurement result is identified by the identification of a characteristic and the product. 
+
+Aspect model in GitHub:
+- Version 1.0.0: https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.special_characteristics.measurement/1.0.0
+
+#### Example: Submodel `SpecialCharacteristicMeasurement`
+
+```json
+{
+  "localIdentifiers": [
+    {
+      "value": "SN12345678",
+      "key": "partInstanceId"
+    },
+    {
+      "value": "SN12345678",
+      "key": "manufactuererId"
+    }
+  ],
+  "customerPartId": "PRT-12345",
+  "revisionIndex": "01",
+  "measurementType": "simple",
+  "characteristicId": "S1",
+  "results": [ ]
+}
+```
+#### Recommended Pattern (Key Value Pair)
+Due to the amount of different characteristics we opted not to require a specific format for the measurement objects contained in the **"results": [ ]** object list. We rather provide a set of format we recommend to use. These recommendations depend on the most common characteristics and their requirements for the results. 
+
+##### Simple Measurements
+We consider for characteristics a simple measurement if it just requires to measure a single value. For example the thickness of a rolled steel plate. We designed the measurement object to be able to represent any measurement where it is required to measure a value with a unit. 
+
+**Data model**
+| Attribute | Plausability | Type | Example |
+| :-- | :-- | :-- | :-- | 
+| value | mandatory | string | -2.9426523E38 | 
+| unit | mandatory | string | -eOMtThyhVNLWUZNRcBaQKxI |
+| measurementTimeStamp | mandatory | timestamp | 2024-10-01 |
+
+**Example: Submodel Simple Measurements**
+```json
+{
+  "measurement" : {
+    "value" : -2.9426523E38,
+    "unit" : "eOMtThyhVNLWUZNRcBaQKxI"
+  },
+  "measurementTimestamp" : "2024-10-01"
+}
+```
+
+##### Qualitative Measurements
+We consider a qualitative measurement a measurement where a value has to be extracted and a read Qualitity has to be determined. An example would be the serial number which has to be etched onto the product. The result of the etching has to be of a certain quality where this quality is measured by some metric. 
+
+**Data model**
+| Attribute | Plausability | Type | Example |
+| :-- | :-- | :-- | :-- | 
+| extractedValue | mandatory | string | eOMtThyhVNLWUZNRcBaQKxI |
+| readQuality | mandatory | string | 5 | 
+| measurementTimeStamp | mandatory | timestamp | 2024-10-01 |
+
+**Example: Submodel Qualitative Measurements**
+```json
+{
+  "extractedValue" : "eOMtThyhVNLWUZNRcBaQKxI",
+  "readQuality" : 5,
+  "measurementTimestamp" : "2024-10-01"
+}
+```
+
+##### Functional Measurements
+Functional Measurements are for characteristics where the result just confirms that the function is at it is expected.
+
+**Data model**
+| Attribute | Plausability | Type | Example |
+| :-- | :-- | :-- | :-- | 
+| value | mandatory | boolean | true | 
+| measurementTimeStamp | mandatory | timestamp | 2024-10-01 |
+
+**Example**
+```json
+{
+  "value" : true,
+  "measurementTimestamp" : "2024-10-01"
+}
+```
+

docs-kits/kits/Traceability Kit/page_business_view.mdx

@@ -81,6 +81,41 @@ The following figure illustrates, how quality investigations and alerts througho
 
 ![Quality Notifications](assets/quality_notifications.png)
 
+### Special Characteristics
+Special characteristics are product or process characteristics that may have an impact on safety or regulatory compliance, fit, function, performance or further processing of the product.
+
+Special Characteristics are:
+
+- suitable for communicating, product quality and securing in the supply chain.
+- Characteristics that require increased care in order to avoid production issues and ensure the quality of the products.
+- defined and recorded with the supplier during development.
+
+Special Characteristics are divided into three categories:
+
+- Legal / relevant to legislation / homologation,
+- Safety
+- Function
+
+> :raised_hand: All products with safety or legal relevant properties, markings or functions are traceability and compliance relevant. Special Characteristics are also mentioned on VDA organization. More details can be found on [VDA home page](https://www.vda.de/de).
+
+Data on the Special Characteristics are collected within the supply chain, but not systematically forwarded to the OEM. The aim is to improve data exchange and consistency for special characteristics.
+
+- Data collection and provision for critical components
+- Data collection for a limited period of time, when required, in the event of quality problems or as part of industrialization.
+
+The exchange between supplier and OEM is currently done on single data exchange with special data format accepted by the partners. That means every data exchange has its single implementation. The more interfaces there are, the more difficult it becomes to manage and operate.
+
+Catena-X is to be used for data exchange within the supply chain. Since traceability must be ensured for special characteristics, it is advisable to supplement the Catena-X Use Cases Industry Core and Traceability with an additional functionality (additional aspect model) for the special characteristics. The special characteristics will be directly linked to the digital twin.
+
+#### Processual Approach
+The target vision aims to enable an end-to-end (E2E) data exchange of special characteristics via Catena-X in three main steps:
+
+- **Requesting Special Characteristics:** The customer should have the capability to request special characteristics from the supplier.
+- **Exchanging Specification Data:** The exchange of specification data for special characteristics should be possible at the part type level.
+- **Consuming Measured Data:** The customer should be able to consume the measured data (special characteristics) provided by the manufacturer.
+
+In this development phase, both the consumer and the provider are responsible for defining a format for requesting and exchanging information on the specifications of the special characteristics. The consumption of the measurement results is based on the expansion of the digital twin to include the aspect of special characteristics as defined in the [Development View](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#specialcharacteristics).
+
 ### Benefits for OEM, SME and Solution Provider
 #### OEM
 For OEM and large automotive suppliers, the traceability solution from Catena-X enables companies to identify products affected by a defect faster and more precisely and thus avoiding general and inaccurate recalls.
@@ -103,7 +138,6 @@ With the Traceability KIT, we support the Catena-X customer journey for our adop
 
 ![Customer Journey](assets/traceability_customer-journey.png)
 
-
 ## Further Explanations
 
 ### Example - Industry Problem

docs-kits/kits/Traceability Kit/page_changelog.mdx

@@ -30,6 +30,20 @@ import Notice from './part_notice.mdx'
 
 All notable changes to this Kit will be documented in this file.
 
+## [6.0.0] - 2024-12-01
+
+Compatible for **release 24.12**.
+
+### Added
+- **Business View:**
+    - **Special Characteristics:**
+        - Added new section to introduce the special characteristics in general
+- **Development View | Data Provider:**
+    - **Aspect Models:**
+        - Added the new SpecialCharacteristics model to the aspect model overview
+    - **Special Characteristics:**
+        - Added a new section to describe and reference the aspect model for special characteristics including JSON examples
+
 ## [5.1.1] - 2024-08-18
 
 ### Changed