Skip to content
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

[New Model]: Mandatory Dismantling #634

Merged
merged 9 commits into from
Mar 12, 2024
Merged

[New Model]: Mandatory Dismantling #634

merged 9 commits into from
Mar 12, 2024

Conversation

tanweersalah
Copy link
Contributor

@tanweersalah tanweersalah commented Feb 9, 2024 •
edited by agg3fe
Loading

Description

With the Mandatory Dismantling data model, we want to mark the components in the vehicle with the notice for mandatory dismantling. This PR represents the Aspect Model "MandatoryDismantling".

Issue - #493
-->

Closes #493

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

@tanweersalah tanweersalah changed the title Feature mandatory dismantling [New Model]: Mandatory Dismantling Feb 9, 2024
@catroest
Copy link
Contributor

catroest commented Feb 9, 2024

General questions: why is "substance of concern" on the highest level? Why is it not referenced by each item? How is it connected with the pollutant?

@agg3fe
Copy link
Contributor

agg3fe commented Feb 12, 2024

please remove gen folder from files added to PR. @tanweersalah

@tanweersalah
Copy link
Contributor Author

removed @agg3fe

@tanweersalah tanweersalah marked this pull request as draft February 13, 2024 09:51
@agg3fe
Copy link
Contributor

agg3fe commented Feb 14, 2024

@tanweersalah is this PR ready for review?

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl

Input model is valid

@tanweersalah
Copy link
Contributor Author

@agg3fe , we are working on a few changes, will update you once it is ready

@tanweersalah tanweersalah marked this pull request as ready for review February 29, 2024 11:24
@tanweersalah
Copy link
Contributor Author

@agg3fe please review, Thanks

@tanweersalah
Copy link
Contributor Author

General questions: why is "substance of concern" on the highest level? Why is it not referenced by each item? How is it connected with the pollutant?

@catroest we have "substance of concern" on the highest level because we want to capture pollutant details if it is found irrespective of the location.

agg3fe
agg3fe reviewed Feb 29, 2024
View reviewed changes
io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl Outdated
@@ -0,0 +1,994 @@
#######################################################################
# Copyright (c) 2023, 2024 SAP SE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only 2024 required

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

agg3fe
agg3fe reviewed Feb 29, 2024
View reviewed changes
io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl Outdated
samm:description "information on the different components available in the asset"@en ;
samm:characteristic :ComponentCharacteristic .

:time a samm:Property ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Property and the referenced Characteristic should not have the same name

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

agg3fe
agg3fe reviewed Feb 29, 2024
View reviewed changes
io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl Outdated
samm:exampleValue "Diesel" .

:itemDetail a samm:Property ;
samm:preferredName "ItemDetail"@en ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preferredName should be human readable and follow normal orthography (e.g., no camel case but normal word separation).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

agg3fe
agg3fe reviewed Feb 29, 2024
View reviewed changes
io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl Outdated
samm:properties ( :weight :requiredTool :permanentMagnet ) .

:itemType a samm:Property ;
samm:preferredName "itemType"@en ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preferredName should be human readable and follow normal orthography (e.g., no camel case but normal word separation).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

catroest
catroest reviewed Feb 29, 2024
View reviewed changes
io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl Outdated
samm:description "Describes a Property which contains a number."@en ;
samm:dataType xsd:integer .

:WeightCharacteristic a samm-c:Measurement ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest you look into the shared quantity model. It describes for example weight values, (where you can also choose the unit)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated, please have a look.

agg3fe
agg3fe requested changes Feb 29, 2024
View reviewed changes
Copy link
Contributor

@agg3fe agg3fe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please check all the comments

@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 4, 2024

Validation Report for io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl

Input model is valid

agg3fe
agg3fe approved these changes Mar 4, 2024
View reviewed changes
Copy link
Contributor

@agg3fe agg3fe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@agg3fe agg3fe added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Mar 4, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 4, 2024

Validation Report for io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl

Input model is valid

catroest
catroest reviewed Mar 4, 2024
View reviewed changes
Copy link
Contributor

@catroest catroest left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some missing descriptions and one clarification.
One general remark: you could combine date and time in one property and use the characterisitc with the type DateTime. (If you do not have reasons to explicitly separate them)

io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl Outdated
samm:preferredName "Time Characteristic"@en ;
samm:dataType xsd:time .

:DateCharacteristic a samm-c:Quantifiable ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing description

io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl Show resolved Hide resolved
io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl Outdated
samm:description "The characteristics of the Component."@en ;
samm:dataType :ComponentEntity .

:TimeCharacteristic a samm-c:Quantifiable ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing description

io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl Outdated
samm:characteristic samm-c:Text ;
samm:exampleValue "WBA41DU060S228332" .

:bbpNumberDismantler a samm:Property ;
Copy link
Contributor

@catroest catroest Mar 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this a typo and you mean bpNumberDismantler = bpnDismantler? What is bbp?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's a typo. bpNumber Dismantler mean bpnDismantler

@agg3fe
Copy link
Contributor

agg3fe commented Mar 6, 2024

@tanweersalah could you please check the above comments.

@agg3fe agg3fe removed the MS2_Approved Checklist "MS2 Valid Model" is approved. label Mar 6, 2024
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl

Input model is valid

@tanweersalah
Copy link
Contributor Author

@catroest
We have two different properties with only date and only time, that's the only reason I have date and time as separate.
I don't know which way would be better.
please let me know if using dateTime for both would be better. If yes, then I will update it to dateTime.

@tanweersalah tanweersalah requested a review from catroest March 11, 2024 13:29
agg3fe
agg3fe reviewed Mar 11, 2024
View reviewed changes
io.catenax.mandatory_dismantling/RELEASE_NOTES.md Outdated
# Changelog
All notable changes to this model will be documented in this file.

## [1.0.0] - 2024-03-04
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please change the date to 11th march.

@agg3fe agg3fe added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Mar 11, 2024
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.mandatory_dismantling/1.0.0/MandatoryDismantling.ttl

Input model is valid

@tanweersalah
Copy link
Contributor Author

@agg3fe , Combined the date time and updated the Release date, can you please review and provide the MS3 Approval.

@agg3fe agg3fe added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label Mar 12, 2024
@agg3fe agg3fe merged commit 52403cd into eclipse-tractusx:main Mar 12, 2024
4 checks passed
@jSchuetz88 jSchuetz88 mentioned this pull request Dec 10, 2024
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agg3fe agg3fe agg3fe approved these changes

@janinemuegge janinemuegge janinemuegge left review comments

@catroest catroest Awaiting requested review from catroest

Assignees
No one assigned
Labels
MS2_Approved Checklist "MS2 Valid Model" is approved. MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[New Model]: Mandatory Dismantling
4 participants
@tanweersalah @catroest @agg3fe @janinemuegge