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]: return request_v2.0.0 #483

Merged
merged 8 commits into from
Feb 7, 2024

Conversation

yuchengluo1
Copy link
Contributor

@yuchengluo1 yuchengluo1 commented Nov 26, 2023

Description

As mentioned in issue: #313.

-->

Closes #313

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

Copy link

Validation Report for io.catenax.return_request/2.0.0/ReturnRequest.ttl

Input model is valid

:quantity a samm:Property ;
samm:preferredName "quantity"@en ;
samm:description "The desired quantity of the on the marketplace offered product in SKU."@en ;
samm:characteristic :QuantityCharacteristic ;
Copy link
Contributor

Choose a reason for hiding this comment

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

for quantity, please check if you can make use of existing shared quantity model , then you don't need to define your own Characteristic. Example here

Copy link

Validation Report for io.catenax.return_request/2.0.0/ReturnRequest.ttl

Input model is valid

:startDate a samm:Property ;
samm:preferredName "start date"@en ;
samm:description "The first day of the period"@en ;
samm:characteristic samm-c:Timestamp ;
Copy link
Contributor

Choose a reason for hiding this comment

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

the value for characteristic should be DateTimestamp here instead of samm-c:Timestamp, else the example value is not correct.

:endDate a samm:Property ;
samm:preferredName "end date"@en ;
samm:description "The last day of the period."@en ;
samm:characteristic samm-c:Timestamp ;
Copy link
Contributor

Choose a reason for hiding this comment

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

here also, value should be DateTimestamp


:isRecall a samm:Property ;
samm:preferredName "is recall"@en ;
samm:description "Depicts if the manufacturer issued a recall (e.g. for security reasons). In concjunction with property needsReturn it can be expressed if the item has to be returned or can directly be destroyed."@en ;
Copy link
Contributor

Choose a reason for hiding this comment

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

typo concjunction

samm:exampleValue "PODBS39HZ7382HDG28" .

:Mileage a samm-c:Measurement ;
samm:preferredName "mileage"@en ;
Copy link
Contributor

Choose a reason for hiding this comment

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

please add description here

:mileage a samm:Property ;
samm:preferredName "mileage"@en ;
samm:description "Current mileage of the component"@en ;
samm:characteristic :Mileage ;
Copy link
Contributor

Choose a reason for hiding this comment

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

Property and the referenced Characteristic should not have the same name

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

Copy link

github-actions bot commented Dec 5, 2023

Validation Report for io.catenax.return_request/2.0.0/ReturnRequest.ttl

Input model is valid

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 18, 2024
Copy link

Validation Report for io.catenax.return_request/2.0.0/ReturnRequest.ttl

Input model is valid

@@ -0,0 +1,245 @@
#######################################################################
# Copyright (c) 2023 Bayerische Motoren Werke Aktiengesellschaft
Copy link
Contributor

Choose a reason for hiding this comment

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

2023-2024

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All of them will be changed to 2023-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.

2.1.0

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should all the version the eclipse-related prefix be changed to 2.1.0 or just necessary for this meta-model?
As far as I understand, for making this change I would have to also upgrade my Aspect-Model-Editor to a new version, otherwise I cannot open the model after the changeis done. Is it correct?

Copy link
Contributor

Choose a reason for hiding this comment

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

correct, all four have to reference 2.1.0 (which will automatically happen if you open and save it in the new version of the editor)
All updated/new models are 2.1.0

samm:description "The desired quantity of the on the marketplace offered product in SKU."@en ;
samm:characteristic ext-quantity:ItemQuantityCharacteristic .

:unitOfMeasure a samm:Property ;
Copy link
Contributor

@catroest catroest Jan 29, 2024

Choose a reason for hiding this comment

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

this is redundant, as quantity (the shared aspect) also refers to a value and unit. Therefore maybe adapt the description of the quantity property to corrctly describe what is following in the structure below.

samm:characteristic samm-c:Text ;
samm:exampleValue "8O8RKJZ7ER" .

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

use of serialPart (localIdentifiers)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is a simple change of naming sufficient? (serialNumber->localIdentifiers)

Copy link
Contributor

Choose a reason for hiding this comment

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

I mean the use of the aspect serial part. Best to open the serial part model seperatly to see the redundant fields which can be linked.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If the aspect serial part is used, then more shared aspects are linked in the model (shared.part_site_information_as_built, business_partner_number, etc.). This means that the prefix in these shared aspect involved also needs to be updated to eclipse 2.1.0 version. I will submit multiple PRs to apply for these changes. Is it ok?

Copy link
Contributor

Choose a reason for hiding this comment

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

These will be updated anyway to 2.1.0 due to recent changes (#557 #581 #571). You can include the current version already, but be aware to change the prefix to the higher version before the PR is merged.

samm:characteristic :DateTimestamp ;
samm:exampleValue "2030-09-30"^^xsd:date .

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

use of serialPart (e.g manufacturerPartId)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is a simple change of naming sufficient? (manufacturingPartID->manufacturerPartId)

Copy link
Contributor

Choose a reason for hiding this comment

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

I mean the use of the aspect serial part

io.catenax.return_request/2.0.0/ReturnRequest.ttl Outdated Show resolved Hide resolved
@catroest
Copy link
Contributor

catroest commented Jan 29, 2024

generally see requirements from the industry core @jonbckr

# Copyright (c) 2023 ZF Friedrichshafen AG
# Copyright (c) 2023 Circular Economy Solutions GmbH (C-ECO)
# Copyright (c) 2023 T-Systems International GmbH
# Copyright (c) 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
Copy link
Contributor

Choose a reason for hiding this comment

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

Contributers to Eclipse Foundation missing

@agg3fe
Copy link
Contributor

agg3fe commented Jan 30, 2024

@yuchengluo1 request you to resolve the comments given by Carolin.

@agg3fe agg3fe removed the MS2_Approved Checklist "MS2 Valid Model" is approved. label Jan 30, 2024
Copy link

Validation Report for io.catenax.return_request/2.0.0/ReturnRequest.ttl

Input model is valid

@yuchengluo1
Copy link
Contributor Author

All the requested adjustments are now fullfilled.

@catroest
Copy link
Contributor

Please look at the comments of the industry core here:
image
I think there are still some unresolved topics.
https://miro.com/app/board/uXjVMiC7vAc=/?moveToWidget=3458764571585802082&cot=14

@yuchengluo1
Copy link
Contributor Author

yuchengluo1 commented Jan 31, 2024

@catroest I cannot open the miro webpage since it requires a password.

@jonbckr
Copy link
Contributor

jonbckr commented Jan 31, 2024

@catroest I cannot open the miro webpage since it requires a password.

The PW is networkofnetwork :)

@yuchengluo1
Copy link
Contributor Author

@catroest 1 question regarding the property "productGroup": Is it ok to use this name and link it with ClassificationCharacteristic from shared aspect part_classification? Or I should partClassification property directly?

@catroest
Copy link
Contributor

@catroest 1 question regarding the property "productGroup": Is it ok to use this name and link it with ClassificationCharacteristic from shared aspect part_classification? Or I should partClassification property directly?

Both would be possible. If you link to the Characteristic you could describe you property yourself. Otherwise you take over the description of the partClassification property. As your descriptions are very similiar, I would suggest the "cleaner" version and link to the property, then you do not have to describe the property again.

@agg3fe
Copy link
Contributor

agg3fe commented Jan 31, 2024

@yuchengluo1 let me know when the model is ready for MS2 check again.

Copy link

Validation Report for io.catenax.return_request/2.0.0/ReturnRequest.ttl

Input model is valid

@yuchengluo1
Copy link
Contributor Author

You may check now, thanks.

@agg3fe agg3fe added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Jan 31, 2024
@prefix : <urn:samm:io.catenax.return_request:2.0.0#> .
@prefix ext-characteristic: <urn:samm:io.catenax.shared.address_characteristic:3.0.0#> .
@prefix ext-classification: <urn:samm:io.catenax.shared.part_classification:1.0.0#> .
@prefix ext-part: <urn:samm:io.catenax.serial_part: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 update the version to 3.0.0

Copy link
Contributor

@agg3fe agg3fe Feb 6, 2024

Choose a reason for hiding this comment

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

@yuchengluo1 please change version of serial_part to 3.0.0. you will first need to update your PR with main branch.

@prefix ext-characteristic: <urn:samm:io.catenax.shared.address_characteristic:3.0.0#> .
@prefix ext-classification: <urn:samm:io.catenax.shared.part_classification:1.0.0#> .
@prefix ext-part: <urn:samm:io.catenax.serial_part:2.0.0#> .
@prefix ext-quantity: <urn:samm:io.catenax.shared.quantity: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.

quantity 2.0.0

@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 5, 2024
Copy link

github-actions bot commented Feb 5, 2024

Validation Report for io.catenax.return_request/2.0.0/ReturnRequest.ttl

Input model is valid

@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.return_request:3.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.

Why you have changed return_request version to 3.0.0?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sorry, wrong touch

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 make commented changes before merge.

Copy link

github-actions bot commented Feb 7, 2024

Validation Report for io.catenax.return_request/2.0.0/ReturnRequest.ttl

Input model is valid

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 merged commit e8db526 into eclipse-tractusx:main Feb 7, 2024
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]: Return Request v2.0.0
4 participants