Create shared model to host common properties for Q Semantic models

[TorstenHirsch]

Description

This PR is to create a shared model to encapsulate common entities and properties in the varios Catena-X Q semantic models.

Initial version of this model will be 1.0.0.

Closes #794

MS2 Criteria

(to be filled out by PR reviewer)

• the model validates with the SAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar samm-cli.jar aspect <path-to-aspect-model> validate ). The SAMM CLI is available here and in GitHub
• use Camel-Case (e.g., "MyModelElement" or "TimeDifferenceGmtId", when in doubt follow https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)
• the identifiers for all model elements start with a capital letter except for properties
• the identifier for properties starts with a small letter
• all model elements at least contain the fields "preferred name" and "description" in English language. The description must be comprehensible. It is not required to write full sentences but style should be consistent over the whole model
• Property and the referenced Characteristic should not have the same name
• the versioning in the URN follows semantic versioning, where minor version bumps are backwards compatible and major version bumps are not backwards compatible.
• use abbreviations only when necessary and if these are sufficiently common
• avoid redundant prefixes in property names (consider adding properties to an enclosing Entity or even adapt the namespace of the model elements, e.g., instead of having two properties DismantlerId and DismantlerName use an Entity Dismantler with the properties name and id or use a URN like io.catenax.dismantler:0.0.1)
• fields preferredName and description are not the same
• preferredName should be human readable and follow normal orthography (e.g., no camel case but normal word separation)
• name of aspect is singular except if it only has one property which is a Collection, List or Set. In theses cases, the aspect name is plural.
• units are referenced from the SAMM unit catalog whenever possible
• use constraints to make known constraints from the use case explicit in the aspect model
• when relying on external standards, they are referenced through a "see" element
• all properties with an simple type have an example value
• metadata.json exists with status "release"
• generated json schema validates against example json payload
• file RELEASE_NOTES.md exists and contains entries for proposed model changes
• all contributors to this model are mentioned in copyright header of model file

MS3 Criteria

(to be filled out by semantic modeling team before merge to main-branch)

• All required reviewers have approved this PR (see reviewers section)
• The new aspect (version) will be implemented by at least one data provider
• The new aspect (version) will be consumed by at least one data consumer
• There exists valid test data
• In case of a new (incompatible) major version to an existing version, a migration strategy has been developed
• The model has at least version '1.0.0'
• If a previous model exists, model deprecation has been checked for previous model
• The release date in the Release Note is set to the date of the MS3 approval

[TorstenHirsch]

Still in draft

[TorstenHirsch]

@JulianSchererZF

[jSchuetz88]

@TorstenHirsch Could you change the name of this PR into

[New Model] io.catenax.shared.quality_core/1.0.0/QualityCore.ttl

[TorstenHirsch]

@jSchuetz88 Please review the file

[TorstenHirsch]

@JulianSchererZF Hi Julian, this is the first working version of the shared model file.

[jSchuetz88]

@JulianSchererZF Hi Julian, this is the first working version of the shared model file.

Hi @TorstenHirsch, sorry I overlooked the update that this PR is now ready. I will check it in the course of the week.

[TorstenHirsch]

Hi Johann, I will update the core modell today anyhow -> please check this new version instead of the old one. Thank you. BG Torsten Mit freundlichen Grüßen / Best regards Torsten Hirsch BD/MSA-IPM7 Mobil +49 162 3972185 ​ From: Johann Schütz ***@***.***> Sent: Monday, February 24, 2025 4:10 PM To: eclipse-tractusx/sldt-semantic-models ***@***.***> Cc: Hirsch Torsten (BD/MSA-IPM7 BD/MSA-MQE-Sq4) ***@***.***>; Mention ***@***.***> Subject: Re: [eclipse-tractusx/sldt-semantic-models] Create shared model to host common properties for Q Semantic models (PR #803) @JulianSchererZF<https://github.com/JulianSchererZF> Hi Julian, this is the first working version of the shared model file. Hi @TorstenHirsch<https://github.com/TorstenHirsch>, sorry I overlooked the update that this PR is now ready. I will check it in the course of the week. — Reply to this email directly, view it on GitHub<#803 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AYLP65ICS6LDFUAWCM22VFT2RMY3BAVCNFSM6AAAAABTADMO56VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNZYG4ZTANJZG4>. You are receiving this because you were mentioned.Message ID: ***@***.******@***.***>> [jSchuetz88]jSchuetz88 left a comment (eclipse-tractusx/sldt-semantic-models#803)<#803 (comment)> @JulianSchererZF<https://github.com/JulianSchererZF> Hi Julian, this is the first working version of the shared model file. Hi @TorstenHirsch<https://github.com/TorstenHirsch>, sorry I overlooked the update that this PR is now ready. I will check it in the course of the week. — Reply to this email directly, view it on GitHub<#803 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AYLP65ICS6LDFUAWCM22VFT2RMY3BAVCNFSM6AAAAABTADMO56VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNZYG4ZTANJZG4>. You are receiving this because you were mentioned.Message ID: ***@***.******@***.***>>

[TorstenHirsch]

Hello @jSchuetz88 @JulianSchererZF I updated the model to the latest version -> please check and review. May be we can have a meeting to discuss the results.

[jSchuetz88]

@TorstenHirsch Sorry about the long wait. Overall this model looks good to me. Technically, all MS II criteria are passed. The model as well as the payload validates successfully.

I have two only remarks before approval.

There is the :plantCatenaXId which seems to be the BPNS of the plant. But there are also :catenaXPartId, :catenaXVehicleId, :catenaXQualityTaskId which are a UUID. For me, the usage of "CatenaXIds" as a prefix seem to be more confusing on the semantic level of the terminology and less helpful as multiple aspect models currently use the property and prefix in different ways. Is this prefix mandatory? For example, why not "plantBPNS"?