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] Get production forecast 2.0.0 #553

Merged
merged 7 commits into from
Jan 31, 2024
Merged

[Model Update] Get production forecast 2.0.0 #553

merged 7 commits into from
Jan 31, 2024

Conversation

FlorianDue
Copy link
Contributor

@FlorianDue FlorianDue commented Jan 24, 2024

Description

Message Header and shopfloor_information_types are updated to version 2.0.0updated

-->

Closes #533

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

@FlorianDue FlorianDue changed the title Get production forecast 2.0.0 [Model Update] Get production forecast 2.0.0 Jan 24, 2024
#
# SPDX-License-Identifier: CC-BY-4.0
##########################################################################################
@prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.0.0#>.
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 to samm:meta-model:2.1.0

@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>.
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>.
@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
@prefix : <urn:samm:io.catenax.shopfloor_information.production_forecast_request:2.0.0#>.
Copy link
Contributor

Choose a reason for hiding this comment

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

namespace and the folder name should always be same. either please correct aspect namespace or folder name.
Also for v1.0.0, I noticed that the namespace was changed after publishing the aspect. this is not good. please correct that also if it is still in use.

@FlorianDue
Copy link
Contributor Author

Thank you for your feedback!

I just pushed the latest version and similar to the shopfloor_information_types, I set the samm metamodel to 2.1.0, removed the spaces at the end and set version 1.0.0 to deprecated.

Looking forward to your feedback!

samm:characteristic ext-types2:TimeValueCharacteristic.

:customerId a samm:Property;
samm:preferredName "customerId"@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)

samm:exampleValue "false"^^xsd:boolean.

:orderId a samm:Property;
samm:preferredName "orderId"@en;
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

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 my comments

@agg3fe
Copy link
Contributor

agg3fe commented Jan 26, 2024

@FlorianDue
since model conains reference to shopfloorinformationtypes, I would merge this model after the referenced model.

@FlorianDue
Copy link
Contributor Author

please check my comments
should be fixed

@FlorianDue
Copy link
Contributor Author

@FlorianDue since model conains reference to shopfloorinformationtypes, I would merge this model after the referenced model.
Thank you for your support!

That's fine. We would also like to get MS3 on Monday for these 3 models (#553 #554 and #551) Are there any steps that we have to do? For example create a new issue?

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 Jan 26, 2024
@agg3fe
Copy link
Contributor

agg3fe commented Jan 26, 2024

@FlorianDue since model conains reference to shopfloorinformationtypes, I would merge this model after the referenced model.
Thank you for your support!

That's fine. We would also like to get MS3 on Monday for these 3 models (#553 #554 and #551) Are there any steps that we have to do? For example create a new issue?

Nothing else is required. We are good for MS3 in next meeting. please make sure someone from your team is there in meeting on Monday to present the model.

@FlorianDue
Copy link
Contributor Author

Sure, ill be there. See you Monday and have a nice weekend!

@agg3fe agg3fe added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label Jan 29, 2024
@agg3fe agg3fe merged commit 9029833 into eclipse-tractusx:main Jan 31, 2024
3 of 4 checks passed
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]: Get Production Forecast
2 participants