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]: Week Based Capacity Group 24.05 changes #590

Merged
merged 18 commits into from
Mar 12, 2024
Merged

[Model Update]: Week Based Capacity Group 24.05 changes #590

merged 18 commits into from
Mar 12, 2024

Conversation

nhaenis
Copy link
Contributor

@nhaenis nhaenis commented Feb 1, 2024

Description

Changes on aspect model for DCM standard 24.05. Changes see RELEASE_NOTES.txt

Closes #565

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

@nhaenis
Copy link
Contributor Author

nhaenis commented Feb 1, 2024

@agg3fe updated external reference versions to 2.0.0

Copy link

github-actions bot commented Feb 1, 2024

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

Copy link

github-actions bot commented Feb 2, 2024

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

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 fix one comment

Copy link

github-actions bot commented Feb 5, 2024

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

Copy link

github-actions bot commented Feb 5, 2024

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

All notable changes to this model will be documented in this file.

## [3.0.0] - 2024-02-xx
Copy link
Contributor

Choose a reason for hiding this comment

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

you can change the date to 5th Feb if you want MS3 today.

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 Feb 5, 2024
@nhaenis
Copy link
Contributor Author

nhaenis commented Feb 5, 2024

@agg3fe we have an open story where the property names of the SubHorizons entity could still be updated to make them more descriptive - i think we won't start the MS3 until next week

Copy link

github-actions bot commented Feb 5, 2024

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

Copy link

github-actions bot commented Feb 5, 2024

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

@nhaenis
Copy link
Contributor Author

nhaenis commented Feb 9, 2024

@dominikoeh i've heard that you're adding another extension of demand volatility to the aspect model. Will you please build on this latest PR here?

Copy link

github-actions bot commented Feb 9, 2024

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

Copy link

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

Copy link

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

Copy link

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

Copy link

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

Copy link

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

@nhaenis
Copy link
Contributor Author

nhaenis commented Feb 29, 2024

@agg3fe PR ready for MS approval - the properties/entities under demandVolatilityParameters has been adjusted since your LGTM

Copy link

github-actions bot commented Mar 6, 2024

Validation Report for io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl

Input model is valid

@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 11, 2024
@agg3fe agg3fe merged commit f9ccc89 into eclipse-tractusx:main Mar 12, 2024
4 checks passed
@nhaenis nhaenis deleted the model_update_week_based_capacity_group_pi12 branch March 18, 2024 13:52
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]: Week Based Capacity Group: Adjustment PI 12
2 participants