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

[New Model] QualityTaskAttachment 1.0.0 #221

Merged
merged 10 commits into from
Jul 14, 2023
Merged

[New Model] QualityTaskAttachment 1.0.0 #221

merged 10 commits into from
Jul 14, 2023

Conversation

JulianSchererZF
Copy link
Contributor

@JulianSchererZF JulianSchererZF commented Jul 4, 2023 •
edited by bs-jokri
Loading

Description

This new model allows the quality use case to provide a detailed description of files attached to a quality task and transferred in a ZIP folder.

-->

New Model Request Issue: 174

Closes #

MS2 Criteria

(to be filled out by PR reviewer)

  • the model validates with the BAMM SDS SDK in the version specified in the Readme.md of this repository by the time of the MS2 check (e.g., 'java -jar bamm-cli.jar -i <path-to-aspect-model> -v ). The BAMM 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 "name" and "description" in English language.
  • no duplicate names or preferredNames within an Aspect (e.g. a 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 BAMM 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"
  • 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'

@JulianSchererZF JulianSchererZF changed the title Julian scherer zf patch 1 [New Model] QualityTaskAttachment 1.0.0 Jul 4, 2023
@github-actions
Copy link

github-actions bot commented Jul 6, 2023

Validation Report for io.catenax.quality_task_attachment/1.0.0/QualityTaskAttachment.ttl

Validation failed:

bs-jokri
bs-jokri suggested changes Jul 6, 2023
View reviewed changes
Copy link
Contributor

@bs-jokri bs-jokri 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 comments

io.catenax.quality_task_attachment/1.0.0/QualityTaskAttachment.ttl Outdated
samm:description "A list of files within the ZIP-folder, which are needed for a specific quality task"@en ;
samm:characteristic :ListOfFiles .

:QualityAspectModel a samm-c:Enumeration ;
Copy link
Contributor

Choose a reason for hiding this comment

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

Isn't this more a type of QualityModels? So probably it makes sense to rename to
QualityModelTypes

io.catenax.quality_task_attachment/1.0.0/QualityTaskAttachment.ttl Outdated
samm:characteristic samm-c:Text ;
samm:exampleValue "BPN-811_2022_000001" .

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

As we have not explicitly modeled a parent child relationship it might be better to name to
relatedModelType?

io.catenax.quality_task_attachment/1.0.0/QualityTaskAttachment.ttl Show resolved Hide resolved
io.catenax.quality_task_attachment/1.0.0/QualityTaskAttachment.ttl Outdated
:filePath a samm:Property ;
samm:preferredName "File Path"@en ;
samm:description "Indicates where the file is located within the ZIP-folder"@en ;
samm:characteristic :Text ;
Copy link
Contributor

Choose a reason for hiding this comment

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

something went south here. Replace with samm-c:Text also remove characteristics definition.

io.catenax.quality_task_attachment/1.0.0/QualityTaskAttachment.ttl Outdated
samm:description "Describes the schema of the values contained in the file"@en ;
samm:dataType :SchemaDefinition .

:Text a samm:Characteristic ;
Copy link
Contributor

Choose a reason for hiding this comment

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

this one needs to be removed. Probably the editor copied that into the model

io.catenax.quality_task_attachment/1.0.0/QualityTaskAttachment.ttl Outdated
samm:description "The unit of the data contained in the column (used for numeric values)"@en ;
samm:characteristic samm-c:UnitReference ;
samm:exampleValue "degreeCelsiusPerHour" ;
samm:see <https://docs.bosch-semantic-stack.com/samm-specification/2.0.0/appendix/unitcatalog.html> .
Copy link
Contributor

Choose a reason for hiding this comment

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

replace with
https://eclipse-esmf.github.io/samm-specification/2.0.0/appendix/unitcatalog.html

@bs-jokri bs-jokri 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 Jul 6, 2023
@github-actions
Copy link

Validation Report for io.catenax.quality_task_attachment/1.0.0/QualityTaskAttachment.ttl

Validation failed:

@bs-jokri bs-jokri merged commit e6ded5c into eclipse-tractusx:main Jul 14, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bs-jokri bs-jokri bs-jokri requested 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.
2 participants
@JulianSchererZF @bs-jokri