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

Update: QualityTaks to 2.0.0 #515

Merged
merged 14 commits into from
Jan 23, 2024
Merged

Update: QualityTaks to 2.0.0 #515

merged 14 commits into from
Jan 23, 2024

Conversation

TorstenHirsch
Copy link
Contributor

@TorstenHirsch TorstenHirsch commented Dec 20, 2023 •
edited by agg3fe
Loading

Description

Converting the model to SAMM.

Added

  • integration of the shared BPNL trait
  • integration of shared e-Mail trait

Changed

  • changed all properties to optional except one unique identifier per entity
  • change property cxbpn cxBusinessPartnerNumber

Removed

Closes #416

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

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTask.ttl

Input model is valid

@TorstenHirsch
RC1
1c1fbd2 
Creation of first draft of qTask semantic model 2.0.0
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTask.ttl

Input model is valid

@TorstenHirsch
Update after QAX review
f419edf 
Adaptions in the model that came up during the QAX review session
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTask.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTasks.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTasks.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTasks.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTask.ttl

Input model is valid

@TorstenHirsch
Copy link
Contributor Author

modelling_team

@TorstenHirsch
Copy link
Contributor Author

@agg3fe

agg3fe
agg3fe reviewed Jan 18, 2024
View reviewed changes
io.catenax.quality_task/2.0.0/QualityTask.ttl Outdated

:name a samm:Property ;
samm:preferredName "Company name"@en ;
samm:description "Name of the comapny"@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 comapny

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

agg3fe
agg3fe reviewed Jan 18, 2024
View reviewed changes
io.catenax.quality_task/2.0.0/QualityTask.ttl Outdated

:recordStatus a samm:Property ;
samm:preferredName "Record status"@en ;
samm:description "The record operation enunumeration can be used to realize delta update concept.\nDelta updateupdate concept means:\n- You transfer an initial load of data\n- After the first week only the delta to the initial load is transferred\n\n\nThe record status describes whether this record is:\n- new=>This record is transferred the first time\n- update=> Some properties of this record have changed compared to a previous transfer\n- delete=> This record was transferred in the initial load or in a previous delta update, but is not \nused any more and therefore it should be deleted on data consumer side\n- same=> This record was transferred in the initial load or in a previous delta update"@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 enunumeration , updateupdate , \nused

Copy link
Contributor

Choose a reason for hiding this comment

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

@TorstenHirsch looks like this one is skipped.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

agg3fe
agg3fe reviewed Jan 18, 2024
View reviewed changes
io.catenax.quality_task/2.0.0/QualityTask.ttl Outdated

:MetaCharacteristic a samm:Characteristic ;
samm:preferredName "MetaCharacteristic"@en ;
samm:description "Chracteristic for the meta information."@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 Chracteristic

@agg3fe
Copy link
Contributor

agg3fe commented Jan 18, 2024

@TorstenHirsch we have one clause: '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.'
In your case, I think. you have only one property in other models also, right? then We can keep the model name as plural and don't need to make it singular.
For this model, for now we can keep it like this or if you want you can revert it to plural name if you want.

@TorstenHirsch
Fixing all issues from review
d5078c1 
Dear @agg3fe I hope I have fixed all your findings.
modelling_team
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTask.ttl

Input model is valid

@TorstenHirsch
Copy link
Contributor Author

@TorstenHirsch we have one clause: '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.' In your case, I think. you have only one property in other models also, right? then We can keep the model name as plural and don't need to make it singular. For this model, for now we can keep it like this or if you want you can revert it to plural name if you want.

@agg3fe Let's keep the model name qualityTask - if possible

@TorstenHirsch
Update QualityTask.ttl
c44e2a1 
Fixe updateupdate typo
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTask.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTask.ttl

Input model is valid

agg3fe
agg3fe reviewed Jan 19, 2024
View reviewed changes
io.catenax.quality_task/2.0.0/QualityTask.ttl Outdated

:recordStatus a samm:Property ;
samm:preferredName "Record status"@en ;
samm:description "The record operation enunumeration can be used to realize delta update concept.\nDelta update concept means:\n- You transfer an initial load of data\n- After the first week only the delta to the initial load is transferred\n\n\nThe record status describes whether this record is:\n- new=>This record is transferred the first time\n- update=> Some properties of this record have changed compared to a previous transfer\n- delete=> This record was transferred in the initial load or in a previous delta update, but is not \nused any more and therefore it should be deleted on data consumer side\n- same=> This record was transferred in the initial load or in a previous delta update"@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 fix typo enunumeration. should be enumeration.

@agg3fe
Copy link
Contributor

agg3fe commented Jan 19, 2024

@TorstenHirsch please fix one typo, then we are good for MS2.

@TorstenHirsch
Copy link
Contributor Author

TorstenHirsch commented Jan 22, 2024 •
edited
Loading

@TorstenHirsch please fix one typo, then we are good for MS2.

Done - let's go for MS2 :-)
@agg2fe
modelling_team

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTask.ttl

Input model is valid

agg3fe
agg3fe approved these changes Jan 22, 2024
View reviewed changes
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 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 labels Jan 22, 2024
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTask.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.quality_task/2.0.0/QualityTask.ttl

Input model is valid

@agg3fe agg3fe merged commit a619e5e into eclipse-tractusx:main Jan 23, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agg3fe agg3fe agg3fe 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.

[Model Update]: bamm:io.catenax.quality_task:1.0.0 to 2.0.0 with SAMM
2 participants
@TorstenHirsch @agg3fe