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.

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

[Model Update] Digital Product Passport 2.0.0 #283

Merged
merged 20 commits into from
Sep 4, 2023

Conversation

catroest
Copy link
Contributor

@catroest catroest commented Aug 21, 2023

Description

Release 23.12/Version 2.0: This data model is based on the proposed Ecodesign Regulation ("Proposal for a REGULATION OF THE EUROPEAN PARLIAMENT AND OF THE COUNCIL establishing a framework for setting ecodesign requirements for sustainable products and repealing Directive 2009/125/EC" ESPR from March 30th, 2022 with some additional data points which can be found in the adopted Amendments from July 12th 2023 (Amendments adopted by the European Parliament on 12 July 2023 on the proposal for a regulation of the European Parliament and of the Council establishing a framework for setting eco-design requirements for sustainable products and repealing Directive 2009/125/EC).

Closes #260

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 21, 2023

Modeling_Team

@catroest
Copy link
Contributor Author

@bs-jokri please check this:
image

@catroest
Copy link
Contributor Author

@bs-jokri ready for review

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.

Hi, I found some smaller things, which you might fix. also there is a problem with the sam:curie validation, which I am currently investigating

- structure for concentration changed
- changed optional attributes
- changed some inputs to: either not applicable or a mandatory input
@catroest catroest requested a review from bs-jokri August 24, 2023 16:10
@catroest
Copy link
Contributor Author

@bs-jokri payload is valid against the schema. Checked without cli (because it can't generate the files).

curie to string
see links added
id and name for material to list
@catroest catroest requested a review from bs-jokri August 25, 2023 13:18
@catroest
Copy link
Contributor Author

catroest commented Aug 25, 2023

Hi, I found some smaller things, which you might fix. also there is a problem with the sam:curie validation, which I am currently investigating

@bs-jokri
image
Should be fixed, aber it is not working for me:
image

@bs-jokri
Copy link
Contributor

Hi, I found some smaller things, which you might fix. also there is a problem with the sam:curie validation, which I am currently investigating

@bs-jokri image Should be fixed, aber it is not working for me: image

@catroest exactly, what I was experiencing. So I would opt for replacing curie with string

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.

we need to resolve the datetime example payload issue first

@catroest
Copy link
Contributor Author

Hi, I found some smaller things, which you might fix. also there is a problem with the sam:curie validation, which I am currently investigating

@bs-jokri image Should be fixed, aber it is not working for me: image

@catroest exactly, what I was experiencing. So I would opt for replacing curie with string

yes I did do so, but I thought it was fixed in this version as mentioned in the release notes

@catroest catroest requested a review from bs-jokri August 28, 2023 12:03
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.

LGTM

@bs-jokri bs-jokri added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Aug 28, 2023
@bs-jokri
Copy link
Contributor

MS3 approval will be given and model will be released. However, the PCF model and the Environmental Footprint Characteristic need to be harmonized. Follow up discussions with PCF use case need to initiated. @catroest

@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 Aug 28, 2023
@bs-jokri
Copy link
Contributor

@catroest i See still activities on this PR. Do you ping me, when I can merge?

@bs-jokri bs-jokri merged commit cb6126e into eclipse-tractusx:main Sep 4, 2023
@catroest catroest deleted the ProductPass_2.0.0 branch September 12, 2023 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

[Model Update]: Digital Product Passport 2.0.0
2 participants