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

[New Model ] Get Production Tracking Aspect Model #555

Merged
merged 7 commits into from
Feb 6, 2024
Merged

[New Model ] Get Production Tracking Aspect Model #555

merged 7 commits into from
Feb 6, 2024

Conversation

FlorianDue
Copy link
Contributor

@FlorianDue FlorianDue commented Jan 24, 2024 •
edited by agg3fe
Loading

Description

New aspect model for the production tracking request within the SopfloorInformationService
-->

Closes #546

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

agg3fe
agg3fe reviewed Jan 25, 2024
View reviewed changes
io.catenax.shopfloor_information.get_production_tracking/1.0.0/GetProductionTrackingData.ttl Outdated
@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.productionTrackingRequest: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.

please correct namespace

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you fo your feedback!

Namespace name is corrected

@FlorianDue FlorianDue changed the title Get Production Tracking Aspect Model [New Model ] Get Production Tracking Aspect Model Jan 25, 2024
agg3fe
agg3fe reviewed Jan 26, 2024
View reviewed changes
io.catenax.shopfloor_information.get_production_tracking/1.0.0/GetProductionTrackingData.ttl Outdated
samm-c:values ("processStep" "capability").

:ProcessStepIdentifierCharacteristic a samm-c:List;
samm:preferredName "ProcessStepIdentifierCharacteristic"@en;
Copy link
Contributor

Choose a reason for hiding this comment

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

description missing

agg3fe
agg3fe reviewed Jan 26, 2024
View reviewed changes
io.catenax.shopfloor_information.get_production_tracking/1.0.0/GetProductionTrackingData.ttl Outdated
samm:description "Aspect to request product specific data from modular production"@en.

: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.

customerId should not be in camel case. it should be in plain English.

agg3fe
agg3fe reviewed Jan 26, 2024
View reviewed changes
io.catenax.shopfloor_information.get_production_tracking/1.0.0/GetProductionTrackingData.ttl Outdated
samm:characteristic ext-number:BpnlTrait.

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

@agg3fe agg3fe Jan 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

please correct preferredName here and all below

agg3fe
agg3fe requested changes Jan 26, 2024
View reviewed changes
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
agg3fe reviewed Feb 1, 2024
View reviewed changes
io.catenax.shopfloor_information.get_production_tracking/1.0.0/GetProductionTrackingData.ttl Outdated
@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
@prefix : <urn:samm:io.catenax.shopfloor_information.get_production_tracking:1.0.0#>.
@prefix ext-header2: <urn:samm:io.catenax.shared.message_header:2.0.0#>.
@prefix ext-number: <urn:samm:io.catenax.shared.business_partner_number: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.

please consider using business_partner_number 2.0.0 shared model here instead of 1.0.0

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 1, 2024

Validation Report for io.catenax.shopfloor_information.get_production_tracking/1.0.0/GetProductionTrackingData.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 5, 2024

Validation Report for io.catenax.shopfloor_information.get_production_tracking/1.0.0/GetProductionTracking.ttl

Validation failed:

agg3fe
agg3fe reviewed Feb 5, 2024
View reviewed changes
io.catenax.shopfloor_information.get_production_tracking/1.0.0/GetProductionTracking.ttl Outdated
@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
@prefix : <urn:samm:io.catenax.shopfloor_information.get_production_tracking:1.0.0#>.
@prefix ext-header2: <urn:samm:io.catenax.shared.message_header:2.0.0#>.
@prefix ext-number: <urn:samm:io.catenax.shared.business_partner_number: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.

business_partner_number 2.0.0 should be used.

agg3fe
agg3fe reviewed Feb 5, 2024
View reviewed changes
io.catenax.shopfloor_information.get_production_tracking/1.0.0/GetProductionTracking.ttl Outdated
samm:exampleValue "12345TestBoP.org".

: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.

remove camel case from customerId

agg3fe
agg3fe reviewed Feb 5, 2024
View reviewed changes
io.catenax.shopfloor_information.get_production_tracking/RELEASE_NOTES.md Outdated

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

## [1.0.0] 29.01.2024
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 Author

Choose a reason for hiding this comment

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

corrections are made. Just as an addition information. Both modesl, this and #556 use the serial_part model version 3.0.0, which is not merged yet.

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 5, 2024

Validation Report for io.catenax.shopfloor_information.get_production_tracking/1.0.0/GetProductionTracking.ttl

Validation failed:

agg3fe
agg3fe reviewed Feb 5, 2024
View reviewed changes
io.catenax.shopfloor_information.get_production_tracking/1.0.0/GetProductionTracking.ttl Outdated
@@ -0,0 +1,178 @@
##########################################################################################
# Copyright (c) 2023-2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IOSB & Fraunhofer IWU & Fraunhofer IPA)
Copy link
Contributor

Choose a reason for hiding this comment

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

please also change the year to 2024 only.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

update is pushed, thank you for the review!

agg3fe
agg3fe approved these changes Feb 5, 2024
View reviewed changes
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 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 labels Feb 5, 2024
@agg3fe agg3fe merged commit b3182dc into eclipse-tractusx:main Feb 6, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agg3fe agg3fe agg3fe 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]: GetProductionTrackingData
2 participants
@FlorianDue @agg3fe