[New Model]: QualityMessage 1.0.0

[johannsvarela]

Description

Notifications are - in contrast to classical data offers - a way to push data from a sender to a receiver. This model describes the message for quality investigations and alerts. It contains standardized attributes for message content common across most use cases in CatenaX. It belongs to the same group of aspects as the MessageHeader Aspect Model: io.catenax.shared.message_header

The bugfix (#476) of the shared Message Header aspect model must be done before this PR can be continued!

Closes #305 and replaces #311

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

[github-actions]

Validation Report for io.catenax.quality_message/1.0.0/QualityMessage.ttl

Input model is valid

[agg3fe]

@johannsvarela is this going to be common/shared between other models also? If yes, then please change the package structure to io.catenax.shared.--, like for shared message header model.

[johannsvarela]

modeling_team

[johannsvarela]

FYI @jonbckr @BenediktMuellerIML @jacewski-bosch

[agg3fe]

@johannsvarela is this going to be common/shared between other models also? If yes, then please change the package structure to io.catenax.shared.--, like for shared message header model.

This is not shared.

[github-actions]

Validation Report for io.catenax.quality_message/1.0.0/QualityMessage.ttl

Input model is valid

[github-actions]

Validation Report for io.catenax.quality_message/1.0.0/QualityMessage.ttl

Input model is valid

[agg3fe]

LGTM

[agg3fe]

@johannsvarela could you please update your branch with main branch. As your code does not include message header 2.0.0, so it is failing.

[github-actions]

Validation Report for io.catenax.quality_message/1.0.0/QualityMessage.ttl

Input model is valid

[johannsvarela]

@agg3fe Done! :)

[agg3fe]

@agg3fe Done! :)

Thanks. assigned MS2 again. Let's do MS3 together in next meeting.

[catroest]

2023-2024

[catroest]

2.1.0

[catroest]

date

[johannsvarela]

@agg3fe @catroest No required anymore, therefore this PR will be closed by myself! :)