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

[NEW model] early warning notification by Andreas & Timothy patch 1 #484

Merged
merged 17 commits into from
Feb 27, 2024

Conversation

Timothy-Ra
Copy link
Contributor

@Timothy-Ra Timothy-Ra commented Nov 27, 2023

Description

The new model enables the notification function about findings from joint field monitoring between two participants of the supply chain. This functionality is part of the early warning feature from the use case quality.

Closes #421

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

New model for early warning notification added
This file contains the new aspect structure for the early warning notification aspect.
@agg3fe
Copy link
Contributor

agg3fe commented Nov 27, 2023

@Timothy-Ra Did you create any Github issue for this Pull Request? If not, then please first create an issue here.After that we go for approval process.

@Timothy-Ra Timothy-Ra changed the title NEW model early warning notification by Andreas & Timothy patch 1 [NEW model] early warning notification by Andreas & Timothy patch 1 Dec 11, 2023
@@ -0,0 +1,38 @@
{
Copy link
Contributor

Choose a reason for hiding this comment

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

This file should only contain { "status" : "release"} . please delete the content of this file.

@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:org.eclipse.examples:1.0.0#> .
Copy link
Contributor

@agg3fe agg3fe Jan 18, 2024

Choose a reason for hiding this comment

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

please replace the org.eclipse.examples with io.catenax.early_warning_notification


:QualityAppFilter a samm:Entity ;
samm:preferredName "Affected Population FIlter"@en ;
samm:description "A set of filters and/or a list definieng the affected population"@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 definieng

:populationFilter a samm:Property ;
samm:preferredName "Population Filter"@en ;
samm:description "Filters on the common early warning data set to specify a population"@en ;
samm:characteristic :PopulationFilterCharateristic .
Copy link
Contributor

Choose a reason for hiding this comment

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

typo Charateristic


:uniqueIdentifiers a samm:Property ;
samm:preferredName "listOfSerialNumbers"@en ;
samm:description "List of unique identifiers to explicitly specifiy parts or vehicles exhibiting the issue described in the property \"anomalyDescription\""@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 specifiy

samm:characteristic :UniqueIdentifiersCharacteristic .

:PopulationFilterCharateristic a samm-c:List ;
samm:preferredName "Population Filter Charateristic"@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 Charateristic


:ValuesCharacteristic a samm-c:List ;
samm:preferredName "Values Characteristic"@en ;
samm:description "Caracteristic for the list of values"@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 Caracteristic


:qualityAppFilter a samm:Property ;
samm:preferredName "Quality App Filter"@en ;
samm:description "A filter to define the population of affected parts in a C-atnea-X quality app"@en ;
Copy link
Contributor

Choose a reason for hiding this comment

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

is C-atnea-X right?

samm:characteristic :PopulationFilterCharateristic .

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

Choose a reason for hiding this comment

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

preferredName should be plain english and not camel case.

:catenaXId a samm:Property ;
samm:preferredName "Catena-X ID"@en ;
samm:description "A unique identifier for a part or a vehicle. The identifier relates to a Catena-X digital twin"@en ;
samm:characteristic samm-c:Text ;
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

@Timothy-Ra please check this also.

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

accoridng to aspect model stuart
changed urn from example to specific io.catenax.early_warning_notification
accoring to feedback from aspect model stuart
@Timothy-Ra
Copy link
Contributor Author

Please check my comments

@agg3fe we changed the model according to your remarks and made some changes due to new infos on our side. Please check once again. Thank you :)

@@ -0,0 +1,158 @@
#######################################################################
# Copyright (c) 2022 Robert Bosch GmbH
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 year to 2024

@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
@prefix : <urn:samm:io.catenax.early_warning_notification:1.0.0#> .
@prefix ext-header: <urn:samm:io.catenax.shared.message_header:1.0.0#> .
Copy link
Contributor

@agg3fe agg3fe Jan 31, 2024

Choose a reason for hiding this comment

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

you can consider reference to new message header 2.0.0 as new version is released now. You might need to update your branch with main branch.

@agg3fe
Copy link
Contributor

agg3fe commented Jan 31, 2024

@Timothy-Ra please check my comments

Copy link

Validation Report for io.catenax.early_warning_notification/1.0.0/EarlyWarningNotification.ttl

Input model is valid

update accoring to updated notification header
@Timothy-Ra
Copy link
Contributor Author

@Timothy-Ra please check my comments

@andreas-hutter and I updated according to your comments and some last minute changes from our side.

@agg3fe please validade

samm:characteristic samm-c:Text ;
samm:exampleValue "3747429FGH382923974682" .

:catenaXId a samm:Property ;
Copy link
Contributor

@agg3fe agg3fe Feb 16, 2024

Choose a reason for hiding this comment

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

if this is a unique catenaXId, you can make use of shared aspect model Uuid.
example: https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.asset_tracker_links/2.0.0/AssetTrackerLinks.ttl#L38
please update your PR with main branch and use Uuid2.0.0 version instead of 1.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.

no, it´s not a catenaXId.

The VAN is the anomynized VIN (vehicle identification number). Which is the identifier for each individual car. You find it in the botton right corner of the wind shield of each car. Each OEM may uses another hash algorithm so that we musn´t define any further semantic limitations.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okay, i misunderstood, I changed it

Copy link

Validation Report for io.catenax.early_warning_notification/1.0.0/EarlyWarningNotification.ttl

Input model is valid

updated Catena-X ID reference
@Timothy-Ra Timothy-Ra requested a review from agg3fe February 22, 2024 10:19
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.early_warning_notification/1.0.0/EarlyWarningNotification.ttl

Syntax error in line 125, column 24: Undefined prefix: ext-uuid

  120:    samm:exampleValue "3747429FGH382923974682" .
  121: 
  122: :catenaXId a samm:Property ;
  123:    samm:preferredName "Catena-X ID"@en ;
  124:    samm:description "A unique identifier for a part or a vehicle. The identifier relates to a Catena-X digital twin"@en ;
->125:    samm:characteristic ext-uuid:UuidV4Trait ;
  126:    samm:exampleValue "urn:uuid:ed85f17e-29dd-473c-9cb8-d7ad1dc44d2f" .
  127: 
  128: :serialPartNumber a samm:Property ;
  129:    samm:preferredName "Serial Part Number"@en ;
  130:    samm:description "A unique serial number for a produced part"@en ;

@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
@prefix : <urn:samm:io.catenax.early_warning_notification:1.0.0#> .
@prefix ext-header: <urn:samm:io.catenax.shared.message_header: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.

you did not add the dependency for uuid here

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 add dependency

@Timothy-Ra Timothy-Ra requested a review from agg3fe February 23, 2024 13:53
@agg3fe
Copy link
Contributor

agg3fe commented Feb 23, 2024

Hi @Timothy-Ra, As I suggested above. please add the dependency which is missing. your model is invalid right now.

Added the requested reference to <urn:samm:io.catenax.shared.uuid:2.0.0>

Deleted 3 properties that were actually not needed.
@andreas-hutter
Copy link
Contributor

I have added the dependecy as requested (and removed 3 no longer needed properties). Can you please check the model validity again ?

Copy link

Validation Report for io.catenax.early_warning_notification/1.0.0/EarlyWarningNotification.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 Feb 26, 2024
@agg3fe
Copy link
Contributor

agg3fe commented Feb 26, 2024

@Timothy-Ra please check eclipsefdn/eca step https://api.eclipse.org/git/eca/status/gh/eclipse-tractusx/sldt-semantic-models/484.
It is giving error.

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

[Unreleased]
[1.0.0] - 2023-12-11
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 it to today's date if you need MS3 today.

Copy link

Validation Report for io.catenax.early_warning_notification/1.0.0/EarlyWarningNotification.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 Feb 26, 2024
Converted notificationID characteristic to ext-uuid.
Deleted unused dependency on share notification header.
Sorry, I had a copy paste error before.
Copy link

Validation Report for io.catenax.early_warning_notification/1.0.0/EarlyWarningNotification.ttl

Input model is valid

@agg3fe agg3fe merged commit 7af981a into eclipse-tractusx:main Feb 27, 2024
4 checks passed
@Timothy-Ra
Copy link
Contributor Author

thanks so much @agg3fe and @andreas-hutter for the great cooperation and that we finished that model :)

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.

[New Model]: early warning notification
3 participants