Skip to content

Commit

Permalink
Merge pull request #1145 from eclipse-tractusx/fix/issue-1135
Browse files Browse the repository at this point in the history
docs(trace): fix broken tables (#1135)
  • Loading branch information
mhellmeier authored Feb 7, 2025
2 parents af90a5c + d1d817e commit 7c2c4df
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 24 deletions.
8 changes: 4 additions & 4 deletions DEPENDENCIES
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ npm/npmjs/-/ieee754/1.2.1, BSD-3-Clause, approved, clearlydefined
npm/npmjs/-/ignore/5.2.4, MIT, approved, #5907
npm/npmjs/-/image-size/1.0.2, MIT, approved, clearlydefined
npm/npmjs/-/immer/9.0.17, MIT, approved, #7037
npm/npmjs/-/import-fresh/3.3.0, MIT, approved, clearlydefined
npm/npmjs/-/import-fresh/3.3.0, MIT, approved, #19299
npm/npmjs/-/import-lazy/2.1.0, MIT, approved, clearlydefined
npm/npmjs/-/imurmurhash/0.1.4, MIT, approved, clearlydefined
npm/npmjs/-/indent-string/4.0.0, MIT, approved, clearlydefined
Expand Down Expand Up @@ -911,10 +911,10 @@ npm/npmjs/-/typescript/4.9.4, Apache-2.0 AND (CC-BY-4.0 AND LicenseRef-scancode-
npm/npmjs/-/ua-parser-js/0.7.32, MIT, approved, #18507
npm/npmjs/-/uc.micro/1.0.6, MIT, approved, #1022
npm/npmjs/-/unherit/1.1.3, MIT, approved, clearlydefined
npm/npmjs/-/unicode-canonical-property-names-ecmascript/2.0.0, MIT, approved, clearlydefined
npm/npmjs/-/unicode-canonical-property-names-ecmascript/2.0.0, MIT, approved, #19200
npm/npmjs/-/unicode-match-property-ecmascript/2.0.0, MIT, approved, clearlydefined
npm/npmjs/-/unicode-match-property-value-ecmascript/2.1.0, MIT, approved, #4991
npm/npmjs/-/unicode-property-aliases-ecmascript/2.1.0, MIT, approved, clearlydefined
npm/npmjs/-/unicode-property-aliases-ecmascript/2.1.0, MIT AND Unicode-3.0, approved, #19201
npm/npmjs/-/unified/10.1.2, MIT, approved, clearlydefined
npm/npmjs/-/unified/9.2.0, MIT, approved, clearlydefined
npm/npmjs/-/unified/9.2.2, MIT, approved, clearlydefined
Expand Down Expand Up @@ -1280,7 +1280,7 @@ npm/npmjs/@types/ms/0.7.31, MIT, approved, #10811
npm/npmjs/@types/node/14.18.36, MIT, approved, #4611
npm/npmjs/@types/node/17.0.45, MIT, approved, clearlydefined
npm/npmjs/@types/node/18.11.18, MIT, approved, #5746
npm/npmjs/@types/parse-json/4.0.0, MIT, approved, clearlydefined
npm/npmjs/@types/parse-json/4.0.0, MIT, approved, #19219
npm/npmjs/@types/parse5/5.0.3, MIT, approved, clearlydefined
npm/npmjs/@types/parse5/6.0.3, MIT, approved, clearlydefined
npm/npmjs/@types/prop-types/15.7.5, MIT, approved, #16176
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Aspect model in GitHub:
```

### SoftwareInformation
The software information aspect model contains the essential information of all software components that have been implemented or flashed in an instantiated part (e.g. serialized part).
The software information aspect model contains the essential information of all software components that have been implemented or flashed in an instantiated part (e.g. serialized part).

Aspect model in GitHub:
- Version 1.0.0: https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.software_information/1.0.0
Expand Down Expand Up @@ -166,7 +166,7 @@ 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.
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
Expand All @@ -193,19 +193,19 @@ Aspect model in GitHub:
}
```
#### 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.
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.
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**
##### Data model
| Attribute | Plausability | Type | Example |
| :-- | :-- | :-- | :-- |
| value | mandatory | string | -2.9426523E38 |
| :-- | :-- | :-- | :-- |
| value | mandatory | string | -2.9426523E38 |
| unit | mandatory | string | -eOMtThyhVNLWUZNRcBaQKxI |
| measurementTimeStamp | mandatory | timestamp | 2024-10-01 |

**Example: Submodel Simple Measurements**
##### Example: Submodel Simple Measurements
```json
{
"measurement" : {
Expand All @@ -217,16 +217,16 @@ We consider for characteristics a simple measurement if it just requires to meas
```

##### 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.
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**
##### Data model
| Attribute | Plausability | Type | Example |
| :-- | :-- | :-- | :-- |
| :-- | :-- | :-- | :-- |
| extractedValue | mandatory | string | eOMtThyhVNLWUZNRcBaQKxI |
| readQuality | mandatory | string | 5 |
| readQuality | mandatory | string | 5 |
| measurementTimeStamp | mandatory | timestamp | 2024-10-01 |

**Example: Submodel Qualitative Measurements**
##### Example: Submodel Qualitative Measurements
```json
{
"extractedValue" : "eOMtThyhVNLWUZNRcBaQKxI",
Expand All @@ -238,17 +238,16 @@ We consider a qualitative measurement a measurement where a value has to be extr
##### Functional Measurements
Functional Measurements are for characteristics where the result just confirms that the function is at it is expected.

**Data model**
##### Data model
| Attribute | Plausability | Type | Example |
| :-- | :-- | :-- | :-- |
| value | mandatory | boolean | true |
| :-- | :-- | :-- | :-- |
| value | mandatory | boolean | true |
| measurementTimeStamp | mandatory | timestamp | 2024-10-01 |

**Example**
##### Example
```json
{
"value" : true,
"measurementTimestamp" : "2024-10-01"
}
```

10 changes: 8 additions & 2 deletions docs-kits/kits/Traceability Kit/page_changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ import Notice from './part_notice.mdx'

All notable changes to this Kit will be documented in this file.

## [6.0.1] - 2025-02-07

Compatible for **release 24.12**.

- Fix broken tables

## [6.0.0] - 2024-12-01

Compatible for **release 24.12**.
Expand Down Expand Up @@ -58,7 +64,7 @@ Compatible for **release 24.12**.
- **Development View:**
- **App Provider:**
- **Block Notifications:**
- Added new sub-sections to describe the Block Notifications state model and the new Block Notification API specification
- Added new sub-sections to describe the Block Notifications state model and the new Block Notification API specification
- **Asset Creation:**
- Added two lines for the typizations 'ReceiveBlockNotification' and 'UpdateBlockNotification' of the new block notifications
- **Policy Creation:**
Expand All @@ -72,7 +78,7 @@ Compatible for **release 24.12**.
### Changed
- **Architecture View:**
- **Build Block View:**
- Updated the Traceability architecture picture with new description regarding Block Notifications
- Updated the Traceability architecture picture with new description regarding Block Notifications
- **Runtime View:**
- Adapted / restructured the remarks text block to be applicable for quality- and the new block notifications
- **Development View:**
Expand Down

0 comments on commit 7c2c4df

Please sign in to comment.