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

Feature 162 model update cx 0040 parts analyses #170

Merged
merged 9 commits into from
Jul 6, 2023
Merged

Feature 162 model update cx 0040 parts analyses #170

merged 9 commits into from
Jul 6, 2023

Conversation

TorstenHirsch
Copy link
Contributor

@TorstenHirsch TorstenHirsch commented May 15, 2023 •
edited by bs-jokri
Loading

Description

Model updated according issue #162
Changes:

[2.0.0] - 2023-05-09

Added

  • property manufacturerAnalysisID: ID of internal system from manufacturer
  • property customerAnalysisID: ID of internal system from customer
  • property anonymizedVin to match PartsAnalyses data with Vehilce.ProductDescription data
  • additionalInformation: a key/value list to add additional data

Changed

  • catenaXIdentifier renamed to catenaXPartId: To emphasize that this is a CX part ID (not CX vehicle ID)
  • customerPartIdentifier renamed to customerPartNumber: to avoid confusion because this property is not unique
  • manufacturerPartIdentifier renamed to manufacturerPartNumber: to avoid confusion because this property is not unique
  • nameAtManufacturer to manufacturerPartName: All properties from manufacturer have no the prefix manufacturer for better readability

Closes #

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 "name" and "description" in English language.
  • no duplicate names or preferredNames within an Aspect (e.g. a 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"
  • 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'

TorstenHirsch and others added 2 commits May 15, 2023 11:07
@TorstenHirsch
First version of 2.0.0
74a6c71 
Additional properties -> see readme.md file
Changes of properties -> see readme.md file
@TorstenHirsch
Merge branch 'eclipse-tractusx:main' into feature-162--Model-Update-C…
5a2ae5f 
…X-0040-PartsAnalyses
@TorstenHirsch
Copy link
Contributor Author

@bs-jokri Please find the attached pull request for the model update

@TorstenHirsch
Update metadata.json
35aafbb 
for PartsAnalyses:1.0.0:
metadata.json keep it on released
@TorstenHirsch
Update metadata.json
a44c2e7 
typo fixed
@TorstenHirsch
Copy link
Contributor Author

@bs-jokri
I changed the meatada for the old version to release again -> so no change in the file content. But it is still in the PR (simply saying: I don't get it out)

@TorstenHirsch
Update PartsAnalyses.ttl
c85681b 
added license information
@bs-jokri bs-jokri added the MS2_Approved Checklist "MS2 Valid Model" is approved. label May 17, 2023
catroest
catroest reviewed Jun 19, 2023
View reviewed changes
io.catenax.parts_analyses/2.0.0/metadata.json Outdated
@@ -0,0 +1 @@
{ "status" : "released"}
Copy link
Contributor

Choose a reason for hiding this comment

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

"release"

io.catenax.parts_analyses/RELEASE_NOTES.md Outdated
@@ -2,6 +2,22 @@
All notable changes to this model will be documented in this file.

## [Unreleased]
- Version 1.0.0 is now set to deprecated: Some important attributes were missing. Use version 2.0.0 instead

## [2.0.0] - 2023-05-09
Copy link
Contributor

Choose a reason for hiding this comment

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

not up to date, if released 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.

@bs-jokri Please recheck model - should be ok

@catroest
Copy link
Contributor

change "Model updated according issue #162" to "Closes #162" so the issue will be closed after the merge

@TorstenHirsch
Model and metadata finalized for CX release 3.2
dc34002 
metadata.json change released to release
Model:
- Change in property order
- introducing uniqueID characteristic
- Additional information: key/vale now as list
@github-actions
Copy link

Validation Report for io.catenax.parts_analyses/2.0.0/PartsAnalyses.ttl

Validation failed:

@github-actions
Copy link

Validation Report for io.catenax.parts_analyses/2.0.0/PartsAnalyses.ttl

Validation failed:

@TorstenHirsch
Copy link
Contributor Author

#modeling_team

@bs-jokri
Copy link
Contributor

Before release:
Characteristics Keys and Values should have description and prefered name

@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 Jun 26, 2023
@TorstenHirsch
Update PartsAnalyses.ttl
ac17f09 
preferred name and  description added for values and keys c-list
@github-actions
Copy link

Validation Report for io.catenax.parts_analyses/2.0.0/PartsAnalyses.ttl

Validation failed:

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

LGTM now

io.catenax.parts_analyses/1.0.0/metadata.json Outdated
{ "status" : "deprecated"}
Copy link
Contributor

Choose a reason for hiding this comment

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

can we do the deprecation in a separate PR? It is hard to handle both changes in on PR (issue linking, MS-Stages etc)

io.catenax.parts_analyses/2.0.0/PartsAnalyses.ttl
@@ -0,0 +1,152 @@
@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.

the SemanticHub cannot handle SAMM models os far so we need to stick to BAMM 2.0.0 for now. Could you store as BAMM 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.

from discussion we will stick to SAMM

@github-actions
Copy link

github-actions bot commented Jul 6, 2023

Validation Report for io.catenax.parts_analyses/2.0.0/PartsAnalyses.ttl

Validation failed:

@bs-jokri bs-jokri merged commit 7ac2012 into eclipse-tractusx:main Jul 6, 2023
3 checks passed
@TorstenHirsch TorstenHirsch deleted the feature-162--Model-Update-CX-0040-PartsAnalyses branch November 10, 2023 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@catroest catroest catroest left review comments

@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.
3 participants
@TorstenHirsch @catroest @bs-jokri