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]: Renamed Model: Secondary Material Content #285

Merged
merged 10 commits into from
Oct 6, 2023
Merged

[New Model]: Renamed Model: Secondary Material Content #285

merged 10 commits into from
Oct 6, 2023

Conversation

catroest
Copy link
Contributor

@catroest catroest commented Aug 23, 2023 •
edited by bs-jokri
Loading

Description

SMC Model includes new secondary characteristic attributes.
Renamed from Material for Recycling.

Closes #261

MS2 Criteria

(to be filled out by PR reviewer)

  • the model validates with the BAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar bamm-cli.jar -i <path-to-aspect-model> -v ). 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 BAMM 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'
  • The release date in the Release Note is set to the date of the MS3 approval

@catroest
Copy link
Contributor Author

catroest commented Aug 23, 2023 •
edited
Loading

@bs-jokri PR on behalf of Sabine and Johannes from SMC

@catroest
Copy link
Contributor Author

@bs-jokri I don't know if Sabine wrote to you already. But please check this model. This model was renamed from Material for Recycling to Secondary Material Content and changed.

bs-jokri
bs-jokri suggested changes Aug 30, 2023
View reviewed changes
Copy link
Contributor

@bs-jokri bs-jokri 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 my comments

io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl Outdated
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
@prefix : <urn:samm:io.catenax.secondary_material_content:1.0.0#> .
@prefix ext-part: <urn:samm:io.catenax.serial_part:1.0.1#> .
Copy link
Contributor

Choose a reason for hiding this comment

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

serialPart still relies on bamm meta model and needs to be updated before it can be used as a reference
https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.serial_part/1.0.1/SerialPart.ttl

Copy link
Contributor

Choose a reason for hiding this comment

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

PR #291 is created, which updates SerialPart to v200 Please update the reference to
urn:samm:io.catenax.serial_part:2.0.0# .
to use the updated model.

io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl Outdated

:SecondaryMaterialContent a samm:Aspect ;
samm:preferredName "Secondary Material Content"@en ;
samm:description "This model refers to a part containing one or more different material. It references the share on primary and secondary material and relevant details."@en ;
Copy link
Contributor

Choose a reason for hiding this comment

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

materials?

io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl Outdated
samm:events ( ) .

:secondaryMaterialContent a samm:Property ;
samm:preferredName "secondary Material Content"@en ;
Copy link
Contributor

Choose a reason for hiding this comment

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

Start uppercase (secondary -> Secondary)

io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl Outdated

:secondaryMaterialContent a samm:Property ;
samm:preferredName "secondary Material Content"@en ;
samm:description "List of relevant materials which are built in this part and details on the share of primary and secondary material."@en ;
Copy link
Contributor

Choose a reason for hiding this comment

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

material -> materials?

io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl Outdated
samm:characteristic :SecondaryMaterialContentMaterials .

:supplierID a samm:Property ;
samm:preferredName "supplier ID"@en ;
Copy link
Contributor

Choose a reason for hiding this comment

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

uppercase

io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl Outdated
:UnitReference a samm:Characteristic ;
samm:preferredName "Unit Reference"@en ;
samm:description "Describes a Property containing a reference to one of the units in the Unit Catalog."@en ;
samm:see <https://openmanufacturingplatform.github.io/sds-documentation/bamm-specification/v1.0.0/appendix/unitcatalog.html#unit-catalog-units> ;
Copy link
Contributor

Choose a reason for hiding this comment

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

replace by current reference
https://eclipse-esmf.github.io/samm-specification/2.0.0/appendix/unitcatalog.html

io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl Outdated

:AllowMassUnit a samm-c:RegularExpressionConstraint ;
samm:description "Only allow mass related Units"@en ;
samm:see <https://openmanufacturingplatform.github.io/sds-documentation/bamm-specification/v1.0.0/appendix/unitcatalog.html#unit-catalog-units> ;
Copy link
Contributor

Choose a reason for hiding this comment

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

same here, replace with updated url

io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl Outdated
samm:preferredName "percentage Of Material Weight"@en ;
samm:description "Share of the full material weight in percentage."@en ;
samm:characteristic :PercentageOfMaterialWeightTrait ;
samm:exampleValue "12"^^xsd:float .
Copy link
Contributor

Choose a reason for hiding this comment

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

to make it clear that it is a floating point value I would write 12.0

io.catenax.secondary_material_content/RELEASE_NOTES.md Outdated

## [Unreleased]

## [1.0.0] - 2023-08-28
Copy link
Contributor

Choose a reason for hiding this comment

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

replace with date of MS3 approval

@bs-jokri
Copy link
Contributor

The checks for MS2 where done with the updated model provided with PR #291

@github-actions
Copy link

Validation Report for io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl

Input model is valid

@github-actions
Copy link

github-actions bot commented Sep 6, 2023

Validation Report for io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl

Input model is valid

@github-actions
Copy link

Validation Report for io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl

Input model is valid

@catroest catroest requested a review from bs-jokri September 18, 2023 09:02
@bs-jokri bs-jokri requested a review from agg3fe September 19, 2023 07:23
@bs-jokri
Copy link
Contributor

@agg3fe will you have a look?

@bs-jokri
Copy link
Contributor

@catroest @johannsvarela there are still open review comments, who will resolve them? Otherwise we cannot assign MS2

@LuisRickert LuisRickert mentioned this pull request Sep 28, 2023
Closed
@github-actions
Copy link

Validation Report for io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl

Input model is valid

@github-actions
Copy link

github-actions bot commented Oct 2, 2023

Validation Report for io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl

Input model is valid

agg3fe
agg3fe approved these changes Oct 2, 2023
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 Oct 2, 2023
@github-actions
Copy link

github-actions bot commented Oct 4, 2023

Validation Report for io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl

Input model is valid

@catroest
Copy link
Contributor Author

catroest commented Oct 4, 2023

@bs-jokri eventually followed by a deprecation request of the old one

@bs-jokri
Copy link
Contributor

bs-jokri commented Oct 4, 2023

@bs-jokri eventually followed by a deprecation request of the old one

@catroest could you link the deprecation request here?

@bs-jokri
Copy link
Contributor

bs-jokri commented Oct 4, 2023

from discussion property orderNumber will be checked if it should be marked optional.

@bs-jokri bs-jokri added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label Oct 4, 2023
@github-actions
Copy link

github-actions bot commented Oct 5, 2023

Validation Report for io.catenax.secondary_material_content/1.0.0/SecondaryMaterialContent.ttl

Input model is valid

@catroest
Copy link
Contributor Author

catroest commented Oct 5, 2023

@bs-jokri ready to merge, order number is now optional

@bs-jokri bs-jokri merged commit 5e4d3d9 into eclipse-tractusx:main Oct 6, 2023
This was referenced Oct 9, 2023
Closed
Merged
@catroest
Copy link
Contributor Author

catroest commented Oct 9, 2023

#395 old one will be deprecated

@catroest catroest deleted the SMC branch November 10, 2023 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bs-jokri bs-jokri bs-jokri approved these changes

@agg3fe agg3fe agg3fe approved these changes

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.

[Model Update]: Material For Recycling
3 participants
@catroest @bs-jokri @agg3fe