[Model Update]: essIncident #572

[birgitZF]

update changes to essIncident data model acc. to industry core

Description

[3.0.0] - 2024-02-19

Changed

• updated version of model
• update reference to shared aspect address
• update BPN-L/S/A and refer to shared model
• update IDs and refer to shared Uuidv4Characteristic
• delete product number
• adjust copyright info

Closes #572

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.essincident/3.0.0/EssIncident.ttl

Input model is valid

[github-actions]

Validation Report for io.catenax.essincident/3.0.0/EssIncident.ttl

Input model is valid

[agg3fe]

you can make use of shared aspect uuid here and dont need to define your own trait for uuidv4.
https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.shared.uuid/2.0.0/Uuid.ttl#L35

[agg3fe]

please check my comment

[birgitZF]

please check update, I added reference to UUID-characteristic

[github-actions]

Validation Report for io.catenax.essincident/3.0.0/EssIncident.ttl

Input model is valid

[agg3fe]

If you want you can directly link trait instead of Characteristic. It will add the usage of constraint automatically at the same time.
example https://github.com/eclipse-tractusx/sldt-semantic-models/pull/600/files#diff-1c4db0c94a76620747c6f8dcc2656113dcb1aac2a932d9b964e6a514a4bb8824R43

[birgitZF]

I linked shared trait (symbol T in aspect modeler) with my Property (symbol P in aspect modeler) and then tried to link the shared trait (symbol T in aspect modeler) with my Characteristic (symbol C in aspect modeler). Received error message "cannot connect external reference".
I could not open the model example itemstock 2.0.0 you linked above. Can you advise?

[agg3fe]

just add this as a characteristic in all three properties.
samm:characteristic ext-uuid:UuidV4Trait;
Let me know if you still face problem.

[birgitZF]

sorry, I was ill thius week so I could not get back to you earlier. That was exactly what I did in the latest version of the model (link the characteristic to the properties), but I am not sure if this is what you expected when you asked to add the trait to the properties.
it looks like this: see screenshot

Let me know if this is not what you meant. Thanks

[agg3fe]

Actually you are still linking the Uuidv4Characteristic to your property. You need to attach the UuidV4Trait from Uuid shared model to your property directly. After that it would look like this:

Let me know if you don't find it, then I will push the commit from my side.

[birgitZF]

Thanks for the hint, got it now and committed the changes with referencec to trait.
Nevertheless the coding still shows @Prefix ext-uuid: urn:samm:io.catenax.shared.uuid:2.0.0# .

[agg3fe]

@birgitZF please let me know if you need any further help on this.

[github-actions]

Validation Report for io.catenax.essincident/3.0.0/EssIncident.ttl

Input model is valid

[agg3fe]

LGTM

[github-actions]

Validation Report for io.catenax.essincident/3.0.0/EssIncident.ttl

Input model is valid