New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: add guidance on quality assets #567

Merged

carslen merged 6 commits into eclipse-tractusx:main from arnoweiss:docs/quality-assets

Jan 23, 2024

Contributor

arnoweiss commented Dec 14, 2023 •

edited

Description

The Quality Use-Case requires a disambiguous detailed definition of the assets.

Todos:

Completion of the four asset types in the kit
addition of the quality assets in the taxonomy
explanation of the two remaining s3-dataadress-properties
Decision on additional properties

The following properties were discussed before but left out.

Property	Example	Description
`creationDate`	`<someDatetimeInSpecifiedFormat>`	The idea is that an updated dataset should be registered new. Whether this is the correct update pattern remains to be discussed
`originator`/`publisher`	`<someBpn>`	This should be clear from the connector that serves the data and is explicitly stated in the catalog-response
`keywords`	`quality, OemName`	Introducing search criteria makes sense in general but should be done via well-defined properties instead of a generic one.
`curatorOrganizationName`	`<someString>`	EDC Properties are not primarily aimed at humans but rather algorithms processing them and this should thus be left out. Also, it's redundant to the BPN.
`usecase`	`QUALITY_opco-int_1023`	Landscape is known from runtime context and as a filter criterion the dct:type property should be used.

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

DEPENDENCIES are up-to-date. Dash license tool. Committers can open IP issues for restricted libs.
Copyright and license header are present on all affected files

arnoweiss added 2 commits

December 14, 2023 22:01


          add guidance on quality assets

25e3c21


          add explanation of s3 authentication

d84935b

markuskeidl reviewed

View reviewed changes

docs-kits/kits/Quality-Kit/Software Development View/page_software-development-view.md Show resolved Hide resolved

markuskeidl reviewed

View reviewed changes

docs-kits/kits/Quality-Kit/Software Development View/page_software-development-view.md Show resolved Hide resolved

Contributor

markuskeidl commented Dec 15, 2023

Quality currently has 7 (8) relevant aspect models / asset types, see https://eclipse-tractusx.github.io/docs-kits/kits/Quality-Kit/Adoption%20View%20Quality%20Kit#semantic-models

Quality Task, Vehicles (inlcudes Product Description), Claim Data, Diagnostic Data, Manufacturerd Parts Quality Information, Party Analyses, and Quality Task Attachement.

markuskeidl reviewed

View reviewed changes

docs-kits/kits/Quality-Kit/Software Development View/page_software-development-view.md Show resolved Hide resolved

arnoweiss added 2 commits

December 20, 2023 09:39


          add dct:conformsTo, dcat:keyword

ac074d5


          remove dcat:keyword and clarify dct:type property

b402cdd

arnoweiss mentioned this pull request

add quality asset catenax-ng/product-ontology#40

Merged

arnoweiss marked this pull request as ready for review

January 17, 2024 16:58

arnoweiss requested review from markuskeidl, ClaudiaKilian and SebastianBezold and removed request for markuskeidl

January 17, 2024 16:58

markuskeidl reviewed

View reviewed changes

docs-kits/kits/Quality-Kit/Software Development View/page_software-development-view.md Outdated Show resolved Hide resolved


          correct bug in quality-kit

67ed26b

markuskeidl reviewed

View reviewed changes

docs-kits/kits/Quality-Kit/Software Development View/page_software-development-view.md Outdated

+              | `https://purl.org/dc/terms/conformsTo`             | `{"@id":"<urnOfTheCorrespondingAspectModel>"}`                   | This property is QM-specific. It holds the exact aspect-model-URN that defines the schema of the presented dataset including its version. The version in here refers to the data model's version while the EDC-property `cx-common:version` defines the version of the underlying API serving the data.                                                                                                                         |
+              | `http://www.w3.org/ns/dcat#qualifiedRelation`      | `{"dct:isPartOf": {"@id": "<idOfTheCorrespondingQualityTask>"}}` | This property is QM-specific. All Asset types defined in this Kit must include this property as it links the data behind an asset with the correct QualityTask. Note that the id of the QualityTask must be used, not the id of the EDC-Asset shielding said QualityTask.                                                                                                                                                       |
+              | `https://w3id.org/edc/v0.0.1/ns/type`              | `AmazonS3`                                                       | This property signifies the EDC dataplane that the QM data will be transferred over. The expectation that this would be signaled via the dcat:DataSet-dcat:distribution property of the catalog currently isn't implemented in the EDC. Thus the data must be replicated here and is presented via the same property that the consumer-side `transferprocesses` API uses for this same signal.                                  |
+              | `https://w3id.org/catenax/ontology/common#version` | `"1.0"`                                                          | CX-0018 recommends to use cx-common:version to signify the API's version. Since QM has a tight connection between the API and the datamodel, this value could describe the version of the CX-API-standard for the Quality use-case. Creation is currently in progress as CX-0123 v1.0.0.                                                                                                                                        |

Contributor

markuskeidl Jan 22, 2024

Version is fine, but I think we need to make sure that the Quality KIT clearly states what versions are included in the current release and which versions should be use. As of now, this information is missing, I think.

Contributor Author

arnoweiss Jan 22, 2024

cx-common:version is the version of CX-0123.
CX-0123 will likely link to CX-0018 v2.1.0.
CX-0018 demands DSP 0.8.

I don't see any trouble here. Should I explain the logical reason above in the Kit?

Contributor

markuskeidl Jan 23, 2024

Ok, understood and fine for me.

markuskeidl reviewed

View reviewed changes

docs-kits/kits/Quality-Kit/Software Development View/page_software-development-view.md Outdated Show resolved Hide resolved

markuskeidl reviewed

View reviewed changes

docs-kits/kits/Quality-Kit/Software Development View/page_software-development-view.md Show resolved Hide resolved

markuskeidl suggested changes

View reviewed changes

Contributor

markuskeidl left a comment

See my inline comments


          integrate review comments

a6981e5

arnoweiss requested a review from markuskeidl

January 22, 2024 14:54

markuskeidl approved these changes

View reviewed changes

docs-kits/kits/Quality-Kit/Software Development View/page_software-development-view.md Outdated

+              | `https://purl.org/dc/terms/conformsTo`             | `{"@id":"<urnOfTheCorrespondingAspectModel>"}`                   | This property is QM-specific. It holds the exact aspect-model-URN that defines the schema of the presented dataset including its version. The version in here refers to the data model's version while the EDC-property `cx-common:version` defines the version of the underlying API serving the data.                                                                                                                         |
+              | `http://www.w3.org/ns/dcat#qualifiedRelation`      | `{"dct:isPartOf": {"@id": "<idOfTheCorrespondingQualityTask>"}}` | This property is QM-specific. All Asset types defined in this Kit must include this property as it links the data behind an asset with the correct QualityTask. Note that the id of the QualityTask must be used, not the id of the EDC-Asset shielding said QualityTask.                                                                                                                                                       |
+              | `https://w3id.org/edc/v0.0.1/ns/type`              | `AmazonS3`                                                       | This property signifies the EDC dataplane that the QM data will be transferred over. The expectation that this would be signaled via the dcat:DataSet-dcat:distribution property of the catalog currently isn't implemented in the EDC. Thus the data must be replicated here and is presented via the same property that the consumer-side `transferprocesses` API uses for this same signal.                                  |
+              | `https://w3id.org/catenax/ontology/common#version` | `"1.0"`                                                          | CX-0018 recommends to use cx-common:version to signify the API's version. Since QM has a tight connection between the API and the datamodel, this value could describe the version of the CX-API-standard for the Quality use-case. Creation is currently in progress as CX-0123 v1.0.0.                                                                                                                                        |

Contributor

markuskeidl Jan 23, 2024

Ok, understood and fine for me.

SebastianBezold approved these changes

View reviewed changes

Contributor

SebastianBezold left a comment

Looks good to me.
You could think of putting dcat:Datasets and properties like in single backticks.
This is already done in the tables, but not in plain text.
Might make it easier to read. Still good without it though!

carslen approved these changes

View reviewed changes

Contributor

carslen left a comment

LGTM

carslen merged commit 204cfdd into eclipse-tractusx:main

4 checks passed

Contributor

ClaudiaKilian commented Jan 23, 2024

Looks very good , thank you both.
Flattening rules are in preparation for the next KIT version

This was referenced Mar 15, 2024

[Snyk] Upgrade docusaurus-plugin-openapi-docs from 1.5.1 to 1.7.3 #759

Closed

[Snyk] Upgrade docusaurus-theme-openapi-docs from 1.5.1 to 1.7.3 #760

Closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment