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

Update manufactured_parts_quality_information -> update of shared shared BPNS trait #628

Merged
merged 4 commits into from
Feb 21, 2024
Merged

Update manufactured_parts_quality_information -> update of shared shared BPNS trait #628

merged 4 commits into from
Feb 21, 2024

Conversation

TorstenHirsch
Copy link
Contributor

@TorstenHirsch TorstenHirsch commented Feb 6, 2024 •
edited by agg3fe
Loading

Description

[2.1.0]

Added

  • property added parentSerialNumber

Changed

  • reference to shared aspect model for BPNS was changed to latest version

Removed

Closes #626

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

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 6, 2024

Validation Report for io.catenax.manufactured_parts_quality_information/2.1.0/ManufacturedPartsQualityInformation.ttl

Input model is valid

@TorstenHirsch
Copy link
Contributor Author

@agg3fe Could you check the model? Thank you
modelling_team

@TorstenHirsch TorstenHirsch changed the title Update manufactured_parts_quality_information -> update of shared shared.business_partner_number to latest version Update manufactured_parts_quality_information -> update of shared shared BPNS trait Feb 6, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 8, 2024

Validation Report for io.catenax.manufactured_parts_quality_information/2.1.0/ManufacturedPartsQualityInformation.ttl

Input model is valid

agg3fe
agg3fe approved these changes Feb 8, 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 the MS2_Approved Checklist "MS2 Valid Model" is approved. label Feb 8, 2024
@TorstenHirsch
Copy link
Contributor Author

Hi @agg3fe I'm on vacation next week. I ask today, who from CX use case quality could proxy me on Monday's meeting. Change of model was discussed and agreed by CX quality use case team.
Change has no effect of the test data - I checked the already existing test data with changed model.

In case I find nobody could you bring this to MS3 next week?

@agg3fe
Copy link
Contributor

agg3fe commented Feb 9, 2024

Hi @agg3fe I'm on vacation next week. I ask today, who from CX use case quality could proxy me on Monday's meeting. Change of model was discussed and agreed by CX quality use case team. Change has no effect of the test data - I checked the already existing test data with changed model.

In case I find nobody could you bring this to MS3 next week?

Ok, I can do that.

agg3fe
agg3fe reviewed Feb 12, 2024
View reviewed changes
io.catenax.manufactured_parts_quality_information/2.1.0/ManufacturedPartsQualityInformation.ttl
samm:characteristic samm-c:Text ;
samm:exampleValue "12345" .

:parentSerialNumber a samm:Property ;
Copy link
Contributor

Choose a reason for hiding this comment

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

property naming changes required:
customerPartInstanceId or
parentPartInstanceId

Copy link
Contributor

Choose a reason for hiding this comment

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

As this model is used in a not Industry Core related use case, we decided to leave this as is for now. In a future version this should be resolved, which will, be guardrailed by a yet to define MS2 requirement. (#642 )

agg3fe
agg3fe reviewed Feb 12, 2024
View reviewed changes
io.catenax.manufactured_parts_quality_information/2.1.0/ManufacturedPartsQualityInformation.ttl
samm:characteristic :PositiveNumber ;
samm:exampleValue "1"^^xsd:positiveInteger .

:parentPartNumber a samm:Property ;
Copy link
Contributor

Choose a reason for hiding this comment

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

PartId or customerPartId

Copy link
Contributor

Choose a reason for hiding this comment

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

@jacewski-bosch

Copy link
Contributor

Choose a reason for hiding this comment

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

As this model is used in a not Industry Core related use case, we decided to leave this as is for now. In a future version this should be resolved, which will, be guardrailed by a yet to define MS2 requirement. (#642 )

Copy link
Contributor

Choose a reason for hiding this comment

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

@agg3fe proceed with MS3 approval in next meeting

@agg3fe agg3fe added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label Feb 19, 2024
@agg3fe
Update RELEASE_NOTES.md
d392009 
Changed date to MS3 date
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.manufactured_parts_quality_information/2.1.0/ManufacturedPartsQualityInformation.ttl

Input model is valid

@agg3fe agg3fe merged commit 1e73705 into eclipse-tractusx:main Feb 21, 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

@JulianSchererZF JulianSchererZF JulianSchererZF left review comments

@jacewski-bosch jacewski-bosch jacewski-bosch 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.

[Model Update]: Update Fleet.Vehicles -> update of shared shared.business_partner_number to latest version
4 participants
@TorstenHirsch @agg3fe @jacewski-bosch @JulianSchererZF