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]: RecyclingStrategyCertificate 3.0.0 #644

Merged

Conversation

tanweersalah
Copy link
Contributor

@tanweersalah tanweersalah commented Feb 13, 2024

Description

add attributes: revocation Date

change UUid from version 1to version 2
change BPN from version 1 to version 2

Issue : #624

-->

Closes #624

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

@tanweersalah
Copy link
Contributor Author

@agg3fe Can you please check the PR.

@tanweersalah tanweersalah changed the title [Model Update]: RecyclingStrategyCertificate 3.0 [Model Update]: RecyclingStrategyCertificate 3.0.0 Feb 13, 2024
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

Validation Report for io.catenax.shared.recycling_strategy_certificate/3.0.0/RecyclingStrategyCertificate.ttl

Input model is valid

@tanweersalah tanweersalah requested a review from agg3fe February 15, 2024 10:01
Copy link

Validation Report for io.catenax.shared.recycling_strategy_certificate/3.0.0/RecyclingStrategyCertificate.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

Copy link

Validation Report for io.catenax.shared.recycling_strategy_certificate/3.0.0/RecyclingStrategyCertificate.ttl

Input model is valid

@agg3fe agg3fe added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Feb 15, 2024
@@ -3,6 +3,15 @@ All notable changes to this model will be documented in this file.

## [Unreleased]

## [3.0.0] - 2024-02-13
Copy link
Contributor

Choose a reason for hiding this comment

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

please change to 19th


### Added
- new features: Revocation Date

## [2.0.0] - 2023-11-07
### Added
- Upgarde from BAMM model to SAMM model
Copy link
Contributor

Choose a reason for hiding this comment

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

please fix typo Upgarde

:revocationDate a samm:Property ;
samm:preferredName "Revocation Date"@en ;
samm:description "The date when the certificate is revoked by the issuer. This only happens in exceptional cases when an asset has been marked as reused by error or any other error is made in the issuance of the certificate. Certificates may be revoked up to 7 working days after they have been issued."@en ;
samm:characteristic :Timestamp ;
Copy link
Contributor

Choose a reason for hiding this comment

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

characteristic should be Date?

@agg3fe
Copy link
Contributor

agg3fe commented Feb 19, 2024

Discussion required for open points.
date charactersristic
vin and oe number mandatory?
@jacewski-bosch

@tanweersalah tanweersalah requested a review from agg3fe February 23, 2024 00:05
Copy link

Validation Report for io.catenax.shared.recycling_strategy_certificate/3.0.0/RecyclingStrategyCertificate.ttl

Input model is valid

@@ -3,9 +3,18 @@ All notable changes to this model will be documented in this file.

## [Unreleased]

## [3.0.0] - 2024-02-19
Copy link
Contributor

Choose a reason for hiding this comment

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

please change the date to 26th

@agg3fe
Copy link
Contributor

agg3fe commented Feb 26, 2024

@tanweersalah further discussion required for vin, oe number

@chemspoon
Copy link

chemspoon commented Feb 27, 2024

VIN and oe number are mandatory. Parts from VIN with oe number need to be identified securely

@tanweersalah tanweersalah requested a review from agg3fe February 27, 2024 17:47
@tanweersalah
Copy link
Contributor Author

Changed OE Number to manufacturerPartId from aspect "part_type_information"
Changed VIN to localIdentifiers from aspect "serial_part"

@tanweersalah
Copy link
Contributor Author

@catroest please review the last commit, is this what you meant?

@agg3fe
Copy link
Contributor

agg3fe commented Feb 28, 2024

@tanweersalah further discussion required for vin, oe number

@jacewski-bosch Could you please check if this is what intended from your point of view.

@catroest
Copy link
Contributor

catroest commented Feb 28, 2024

I would propose something like in the picture. The serial number you want to link here is NOT the serial number of the connected twin/part of the certificate, but the vehicle. I would propose to define the property yourself, in order to state exactly this.
The OE-number I am not sure...
image

@tanweersalah
Copy link
Contributor Author

tanweersalah commented Feb 28, 2024

I would propose something like in the picture. The serial number you want to link here is NOT the serial number of the connected twin/part of the certificate, but the vehicle. I would propose to define the property yourself, in order to state exactly this. The OE-number I am not sure... image

the local identifier is a list of Keyvalue pair, but if i do as you proposed it will limit it to have only VIN.

the other certificates which uses this shared aspect i.e reuse, remanufacturing , refurbishing certificate etc we need to have partInstanceId for them , If we keep it without the parent property VIN we can use this localindentifier without defining again in other certificates for capturing partInstanceId.

@catroest
Copy link
Contributor

catroest commented Feb 28, 2024

Yes but how does the data provider know what to provide here? If you just directly link to "localIdentifiers" the closest which can be interpreted, would be the serial id of the certificate itself. Thats why I propose to link on the level of the characteristic, then you can describe the property as a vin. You still have the key-value pair.

@jacewski-bosch
Copy link
Contributor

@tanweersalah @catroest @agg3fe we have a meeting in the afternoon where we hope to clarify this.
We'll summarize the reasoning here.

@agg3fe agg3fe removed the MS2_Approved Checklist "MS2 Valid Model" is approved. label Feb 28, 2024
@tanweersalah
Copy link
Contributor Author

@agg3fe updated the model as discussed. Please review. Thanks.

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 29, 2024
@@ -3,9 +3,27 @@ All notable changes to this model will be documented in this file.

## [Unreleased]

## [3.0.0] - 2024-02-28
Copy link
Contributor

Choose a reason for hiding this comment

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

Now you can change the date to 4th March if you want MS3 in next meeting on Monday

Copy link

Validation Report for io.catenax.shared.recycling_strategy_certificate/3.0.0/RecyclingStrategyCertificate.ttl

Input model is valid

Copy link

github-actions bot commented Mar 4, 2024

Validation Report for io.catenax.shared.recycling_strategy_certificate/3.0.0/RecyclingStrategyCertificate.ttl

Input model is valid

@agg3fe agg3fe added the MS3_Approved Checklist "MS3 Release Model" is approved. The associated pull request can be merged to the "main-br label Mar 4, 2024
@agg3fe agg3fe merged commit 92e7a00 into eclipse-tractusx:main Mar 5, 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]: RecyclingStrategyCertificate 3.0
5 participants