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

[Model Update]: SingleLevelBomAsBuilt 3.0.0 #637

Merged
merged 20 commits into from
Feb 28, 2024
Merged

[Model Update]: SingleLevelBomAsBuilt 3.0.0 #637

merged 20 commits into from
Feb 28, 2024

Conversation

johannsvarela
Copy link
Contributor

@johannsvarela johannsvarela commented Feb 9, 2024 •
edited by agg3fe
Loading

Description

Based on continuous development of the Industry Core, the ability to run down the data chain for PartInstance twins was implemented so that the relationship described by the SingleLevelBomAsBuilt model meets the requirements of the data chain template.

Closes #630

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

github-actions bot commented Feb 9, 2024

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 9, 2024

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl

Input model is valid

@johannsvarela
Copy link
Contributor Author

modeling_team

@johannsvarela
Copy link
Contributor Author

FYI @jacewski-bosch @BenediktMuellerIML @jonbckr

agg3fe
agg3fe reviewed Feb 14, 2024
View reviewed changes
io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl Outdated
samm:description "Describes the quantity in which the child item is assembled in the given parent item by providing a quantity value and the measurement unit in which the quantity is measured."@en;
samm:dataType :Quantity.

:Quantity a samm:Entity;
Copy link
Contributor

Choose a reason for hiding this comment

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

preferredName missing

agg3fe
agg3fe reviewed Feb 14, 2024
View reviewed changes
io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl Outdated
samm:description "The Catena X ID of the child item that was installed in the parent item."@en;
samm:characteristic ext-uuid:UuidV4Trait.

:QuantityCharacteristic a samm-c:Quantifiable;
Copy link
Contributor

Choose a reason for hiding this comment

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

preferredName missing

agg3fe
agg3fe reviewed Feb 14, 2024
View reviewed changes
io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl Outdated
samm:description "Expresses wether the part is built-in or wether it is one of several options. If the value is false, it can be assumend this exact item is built-in. If the value is true, it is unknown wether this or an alternative item is built-in.\nThis is the case when, e.g. the same item is supplied by two suppliers, the item is only tracked by a customer part ID during assembly. Thus, these items can not be differentiated from each other.\n\n"@en;
samm:characteristic samm-c:Boolean.

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

want to rename this property or is it correct?
Also, in preferred name it is written 'Catena-X Parent ID'. please correct.

agg3fe
agg3fe reviewed Feb 14, 2024
View reviewed changes
io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl Outdated

:hasAlternatives a samm:Property;
samm:preferredName "Has Alternatives"@en;
samm:description "Expresses wether the part is built-in or wether it is one of several options. If the value is false, it can be assumend this exact item is built-in. If the value is true, it is unknown wether this or an alternative item is built-in.\nThis is the case when, e.g. the same item is supplied by two suppliers, the item is only tracked by a customer part ID during assembly. Thus, these items can not be differentiated from each other.\n\n"@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 wether and assumend

agg3fe
agg3fe requested changes Feb 14, 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.

please check my comments

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl

Input model is valid

agg3fe
agg3fe reviewed Feb 15, 2024
View reviewed changes
io.catenax.single_level_bom_as_built/RELEASE_NOTES.md Outdated
@@ -1,6 +1,17 @@
# Changelog
All notable changes to this model will be documented in this file.

## [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 correct release notes also accordingly.

Copy link
Contributor

Choose a reason for hiding this comment

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

@johannsvarela please check this before MS3

agg3fe
agg3fe approved these changes Feb 16, 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 the MS2_Approved Checklist "MS2 Valid Model" is approved. label Feb 16, 2024
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl

Input model is valid

1 similar comment
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl

Syntax error in line 109, column 132: Illegal escape sequence value: . (0x2E)

  104:    samm:dataType xsd:string.
  105: 
  106: :DateTimeRegularExpression a samm-c:RegularExpressionConstraint;
  107:    samm:preferredName "Date Time Regular Expression"@en;
  108:    samm:description "Regular Expression to enable UTC and Timezone formats and the possibility to exclude time information."@en;
->109:    samm:value "^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?)?$".

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl

Syntax error in line 109, column 132: Illegal escape sequence value: . (0x2E)

  104:    samm:dataType xsd:string.
  105: 
  106: :DateTimeRegularExpression a samm-c:RegularExpressionConstraint;
  107:    samm:preferredName "Date Time Regular Expression"@en;
  108:    samm:description "Regular Expression to enable UTC and Timezone formats and the possibility to exclude time information."@en;
->109:    samm:value "^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?)?$".

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.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
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.single_level_bom_as_built/3.0.0/SingleLevelBomAsBuilt.ttl

Input model is valid

@agg3fe
Copy link
Contributor

agg3fe commented Feb 27, 2024

@johannsvarela @tom-rm-meyer-ISST let me know when all four models are ready to merge after changes.

@johannsvarela
Copy link
Contributor Author

@agg3fe Changes on the quantity characteristic were made as @tom-rm-meyer-ISST recommended. Therefore we can merge this PR!

FYI @BenediktMuellerIML @jacewski-bosch

@agg3fe agg3fe merged commit 6728e21 into eclipse-tractusx:main Feb 28, 2024
4 checks passed
@johannsvarela johannsvarela deleted the update_single_level_bom_as_built_3.0.0 branch July 17, 2024 06:47
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]: SingleLevelBomAsBuilt 3.0.0
2 participants
@johannsvarela @agg3fe