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

Feat/issue 781 fixed PR #784

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

LuisRickert
Copy link
Contributor

@LuisRickert LuisRickert commented Oct 15, 2024

Description

-->
This PR introduces a data model for special characteristics measurements. The initial model was presented with this issue #781. An example can be found below:

{
  "localIdentifiers": [
    {
      "value": "SN12345678",
      "key": "partInstanceId"
    }
  ],
  "customerPartID": "BPN0000000",
  "bpnlProperty": "BPNL0123456789ZZ",
  "revisionIndex": "01",
  "measurementType": "eOMtThyhVNLWUZNRcBaQKxI",
  "characteristicID": "S1",
  "results": [
    {}
  ]
}

This data model should be included in future into the Traceability KIT CX-0125

This PR replaces the old PR-783 since it has generated artifacts in it.

Closes #781

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.specialCharacteristics.measurement/1.0.0/Measurement.ttl

Semantic violations were found:

> :Uuid :
  ---> Error at line 27 column 5
   | 
27 |      samm:properties (:uuidV4Property ) ; ( ) ; ( :bpnaProperty ) ; . . ; ; . a  ; .
   |      ^^^^^^^^^^^^^^^ Property samm:properties is used 2 times on :Uuid, but may only be used 1 time.
   | 

  ---> Error at line 27 column 5
   | 
27 |      samm:properties (:uuidV4Property ) ; ( ) ; ( :bpnaProperty ) ; . . ; ; . a  ; .
   |      ^^^^^^^^^^^^^^^ Property samm:properties is used 2 times on :Uuid, but may only be used 1 time.
   | 

@LuisRickert
Copy link
Contributor Author

Validation Report for io.catenax.specialCharacteristics.measurement/1.0.0/Measurement.ttl

Semantic violations were found:

> :Uuid :
  ---> Error at line 27 column 5
   | 
27 |      samm:properties (:uuidV4Property ) ; ( ) ; ( :bpnaProperty ) ; . . ; ; . a  ; .
   |      ^^^^^^^^^^^^^^^ Property samm:properties is used 2 times on :Uuid, but may only be used 1 time.
   | 

  ---> Error at line 27 column 5
   | 
27 |      samm:properties (:uuidV4Property ) ; ( ) ; ( :bpnaProperty ) ; . . ; ; . a  ; .
   |      ^^^^^^^^^^^^^^^ Property samm:properties is used 2 times on :Uuid, but may only be used 1 time.
   | 

It appears that this is caused by the data model Serial Part. If the validation is run locally on the SerialPart the same error is returned.

@LuisRickert LuisRickert self-assigned this Oct 15, 2024
Copy link

Validation Report for io.catenax.specialCharacteristics.measurement/1.0.0/Measurement.ttl

Semantic violations were found:

> :Uuid :
  ---> Error at line 27 column 5
   | 
27 |      samm:properties (:uuidV4Property ) ; ( ) ; ( :bpnaProperty ) ; . . ; ; . a  ; .
   |      ^^^^^^^^^^^^^^^ Property samm:properties is used 2 times on :Uuid, but may only be used 1 time.
   | 

  ---> Error at line 27 column 5
   | 
27 |      samm:properties (:uuidV4Property ) ; ( ) ; ( :bpnaProperty ) ; . . ; ; . a  ; .
   |      ^^^^^^^^^^^^^^^ Property samm:properties is used 2 times on :Uuid, but may only be used 1 time.
   | 

Copy link

Validation Report for io.catenax.specialCharacteristics.measurement/1.0.0/Measurement.ttl

Semantic violations were found:

> :Uuid :
  ---> Error at line 27 column 5
   | 
27 |      samm:properties (:uuidV4Property ) ; ( ) ; ( :bpnaProperty ) ; . . ; ; . a  ; .
   |      ^^^^^^^^^^^^^^^ Property samm:properties is used 2 times on :Uuid, but may only be used 1 time.
   | 

  ---> Error at line 27 column 5
   | 
27 |      samm:properties (:uuidV4Property ) ; ( ) ; ( :bpnaProperty ) ; . . ; ; . a  ; .
   |      ^^^^^^^^^^^^^^^ Property samm:properties is used 2 times on :Uuid, but may only be used 1 time.
   | 

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[New Model]: Special Characteristics Measurement
1 participant