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

Provide production forecast2 #259

Merged
merged 9 commits into from
Sep 25, 2023
Merged

Provide production forecast2 #259

merged 9 commits into from
Sep 25, 2023

Conversation

wehrstedt-jan
Copy link
Contributor

@wehrstedt-jan wehrstedt-jan commented Jul 13, 2023 •
edited by bs-jokri
Loading

Description

-->

Closes #230, #236

requires use of header #227

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 "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

@github-actions
Copy link

Validation Report for io.catenax.mp_standard_response/1.0.0/ProvideProductionForecast.ttl

Validation failed:

@github-actions
Copy link

Validation Report for io.catenax.mp_standard_response/1.0.0/ShopfloorInformationTypes.ttl

Validation failed:

@github-actions
Copy link

Validation Report for io.catenax.shopfloor_information.provide_production_forecast/1.0.0/ProvideProductionForecast.ttl

Validation failed:

bs-jokri
bs-jokri approved these changes Jul 14, 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.

Minor findings. Please consider before release.

io.catenax.shopfloor_information.provide_production_forecast/RELEASE_NOTES.md

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

## [1.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.

don't forget to add the date of ms3 approval as soon as it is available

...atenax.shopfloor_information.provide_production_forecast/1.0.0/ProvideProductionForecast.ttl Outdated
samm:characteristic :ForecastItemList .

:iterationNo a samm:Property ;
samm:preferredName "IterationNo"@en ;
Copy link
Contributor

Choose a reason for hiding this comment

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

adjust to normal orthography, maybe Iteration Number?

...atenax.shopfloor_information.provide_production_forecast/1.0.0/ProvideProductionForecast.ttl Outdated
samm:dataType :ForecastItem .

:ForecastItem a samm:Entity ;
samm:preferredName "ForecastItem"@en ;
Copy link
Contributor

Choose a reason for hiding this comment

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

Forecast Item

...atenax.shopfloor_information.provide_production_forecast/1.0.0/ProvideProductionForecast.ttl Outdated
samm:properties ( :positionId :productionForecast :precisionOfForecast :productionStatus [ samm:property :reasons4Delay; samm:optional true ] :returnCode :forecastDate ) .

:positionId a samm:Property ;
samm:preferredName "PositionId"@en ;
Copy link
Contributor

Choose a reason for hiding this comment

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

Position Id

...atenax.shopfloor_information.provide_production_forecast/1.0.0/ProvideProductionForecast.ttl Outdated
samm:exampleValue "itemPlanned" .

:reasons4Delay a samm:Property ;
samm:preferredName "Reasons 4 Delay"@en ;
Copy link
Contributor

Choose a reason for hiding this comment

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

Would this writing be the one the user sees? If so ok, if not adjust to maybe Reasons for Delay

...atenax.shopfloor_information.provide_production_forecast/1.0.0/ProvideProductionForecast.ttl Outdated
samm-c:values ( "itemReceived" "itemPlanned" "itemInProduction" "itemCompleted" "statusUndefined" ) .

:Reasons4DelayEnum a samm-c:Enumeration ;
samm:preferredName "Reasons 4 Delay Enum"@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 be consistent with the other reasons 4 delay element

@bs-jokri bs-jokri added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Jul 14, 2023
bs-jokri
bs-jokri reviewed Jul 14, 2023
View reviewed changes
...atenax.shopfloor_information.provide_production_forecast/1.0.0/ProvideProductionForecast.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.shopfloor_information.provide_production_forecast:1.0.0#> .
@prefix ext-header: <urn:samm:io.catenax.message_header:1.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.

it could be that the namespace is change to
io.catenax.shared.message_header:1.0.0

please adjust if this is the case

@bs-jokri
Copy link
Contributor

MS2 approval given with the condition that the model io.catenax.message_header:1.0.0 is released (otherwise model cannot validate)

@bosserf
Copy link

bosserf commented Jul 17, 2023

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) -> OK
The new aspect (version) will be implemented by at least one data provider -> OK
The new aspect (version) will be consumed by at least one data consumer -> OK
There exists valid test data -> OK
In case of a new (incompatible) major version to an existing version, a migration strategy has been developed -> doesn't apply
The model has at least version '1.0.0' -> OK
The release date in the Release Note is set to the date of the MS3 approval -> has to be done

@bosserf
Copy link

bosserf commented Jul 17, 2023

MS3: approval given with the condition that the model io.catenax.message_header:1.0.0 is released (otherwise model cannot validate)
otherwise approved by group

@dominikoeh
fix: message header prefix
e69bea2 
update message header prefix with shared namespace
@github-actions
Copy link

github-actions bot commented Aug 4, 2023

Validation Report for io.catenax.shopfloor_information.provide_production_forecast/1.0.0/ProvideProductionForecast.ttl

Validation failed:

@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 Sep 4, 2023
@github-actions
Copy link

github-actions bot commented Sep 4, 2023

Validation Report for io.catenax.shopfloor_information.provide_production_forecast/1.0.0/ProvideProductionForecast.ttl

Validation failed:

@bs-jokri bs-jokri merged commit 7ed462b into eclipse-tractusx:main Sep 25, 2023
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

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.

[New Model]: SIS Shopfloor Information Model: SISReturn
4 participants
@wehrstedt-jan @bs-jokri @bosserf @dominikoeh