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] PCF: Update for compatibility with specification WBCSD v2 and PCF Rulebook v2 #182

Merged
merged 8 commits into from
Jun 14, 2023
Merged

[Model-Update] PCF: Update for compatibility with specification WBCSD v2 and PCF Rulebook v2 #182

merged 8 commits into from
Jun 14, 2023

Conversation

SMaierTSI
Copy link
Contributor

@SMaierTSI SMaierTSI commented May 24, 2023

Description

Implementation of necessary adaptations in order to ensure compatibility of the PCF data model with the current specifications of WBCSD (World Business Council for Sustainable Development) and the PCF Rulebook.

-->

Closes #165

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 BAMM 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 "name" and "description" in English language.
  • no duplicate names or preferredNames within an Aspect (e.g. a 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"
  • 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'

@bs-jokri
Copy link
Contributor

@SMaierTSI you might check this issue as it describes how to reference units from the unit catalog in an enum. Maybe this could be applied in your case as well.
eclipse-esmf/esmf-sdk#303

…tibility with the Catena-X PCF Rulebook V2 and the WBCSD (World Business Council for Sustainable Development) specification V2.
@SMaierTSI
Copy link
Contributor Author

@bs-jokri modifications have been implemented as discussed, please check latest version with regards to MS2.

@SMaierTSI
Copy link
Contributor Author

modeling_team

@SMaierTSI
Copy link
Contributor Author

@bs-jokri just commited an updated version with some (minor) changes after review with our implementation team experts. Please check the latest version with regards to MS2.

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.

Added some remarks. Check if they apply

io.catenax.pcf/4.0.0/Pcf.ttl Outdated Show resolved Hide resolved
io.catenax.pcf/4.0.0/Pcf.ttl Outdated Show resolved Hide resolved
io.catenax.pcf/4.0.0/Pcf.ttl Outdated Show resolved Hide resolved
io.catenax.pcf/4.0.0/Pcf.ttl Outdated Show resolved Hide resolved
io.catenax.pcf/4.0.0/Pcf.ttl Outdated Show resolved Hide resolved
io.catenax.pcf/4.0.0/Pcf.ttl Outdated Show resolved Hide resolved
io.catenax.pcf/4.0.0/Pcf.ttl Outdated Show resolved Hide resolved
io.catenax.pcf/4.0.0/Pcf.ttl Outdated Show resolved Hide resolved
io.catenax.pcf/4.0.0/Pcf.ttl Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Jun 9, 2023

Validation Report for io.catenax.pcf/4.0.0/Pcf.ttl

Validation failed:

@SMaierTSI SMaierTSI requested a review from bs-jokri June 12, 2023 11:27
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 Jun 12, 2023
@github-actions
Copy link

Validation Report for io.catenax.pcf/4.0.0/Pcf.ttl

Input model is valid

@bs-jokri
Copy link
Contributor

pCfIncludingBiogenetic -> C lowercase
2023 contributors to the eclipse foundation -> 2022, 2023 Contributors to the Eclipse Foundation

@github-actions
Copy link

Validation Report for io.catenax.pcf/4.0.0/Pcf.ttl

Input model is valid

@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 Jun 12, 2023
@github-actions
Copy link

Validation Report for io.catenax.pcf/4.0.0/Pcf.ttl

Input model is valid

@bs-jokri bs-jokri merged commit d02f1f7 into eclipse-tractusx:main Jun 14, 2023
@SMaierTSI SMaierTSI deleted the feature/165-Model-Update-Pcf branch June 30, 2023 08:42
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]: PCF
2 participants