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]: Software Information 1.0.0 #320

Merged
merged 20 commits into from
Apr 11, 2024
Merged

[New Model]: Software Information 1.0.0 #320

merged 20 commits into from
Apr 11, 2024

Conversation

johannsvarela
Copy link
Contributor

@johannsvarela johannsvarela commented Sep 27, 2023 •
edited by agg3fe
Loading

Description

An ECU and installed software components (versions) form a unit consisting of a hardware component (e.g. ECU) and software components for installation in a product (e.g. vehicle). While an ECU as a hardware component for example has a part number and a serial number, there are not always part numbers and serial numbers for each software component.

This leads to the fact that the creation of digital twins for software components is not useful. A mapping of a unit with an ECU part and its installed software components by means of a linkage of digital twins is therefore not possible.

For this reason, the software must be mapped and documented in a (new) separate aspect model so that it can be linked to the corresponding digital twin of the ECU.

Closes #314 (old/renamed branch #317)

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
Copy link

Validation Report for io.catenax.software_information/1.0.0/SoftwareInformation.ttl

Input model is valid

@johannsvarela
Copy link
Contributor Author

@bs-jokri @agg3fe would it be possible to review this PR to get the MS2 approval?

agg3fe
agg3fe requested changes Oct 2, 2023
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
Copy link

github-actions bot commented Oct 4, 2023

Validation Report for io.catenax.software_information/1.0.0/SoftwareInformation.ttl

Input model is valid

@github-actions
Copy link

github-actions bot commented Oct 4, 2023

Validation Report for io.catenax.software_information/1.0.0/SoftwareInformation.ttl

Input model is valid

@johannsvarela johannsvarela requested a review from agg3fe October 4, 2023 12:12
@johannsvarela
Copy link
Contributor Author

johannsvarela commented Oct 4, 2023 •
edited
Loading

please check my comments

@agg3fe @bs-jokri can you review my changes i have made? :)

agg3fe
agg3fe reviewed Oct 6, 2023
View reviewed changes
io.catenax.software_information/1.0.0/SoftwareInformation.ttl Outdated

:ValidityPeriodEntity a samm:Entity;
samm:preferredName "Validity Period Entity"@en;
samm:description "If a validity period only has a start that means that the period is valid from the start date without a (yet) defined enddate and vice versa."@en;
Copy link
Contributor

Choose a reason for hiding this comment

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

i think it should be 'end date' and not 'enddate'

@agg3fe
Copy link
Contributor

agg3fe commented Oct 6, 2023

@johannsvarela could you please resolve this small PR comment about typo, and then we should be good for MS2 approval.

@johannsvarela
Copy link
Contributor Author

@johannsvarela could you please resolve this small PR comment about typo, and then we should be good for MS2 approval.

@agg3fe done :)

@github-actions
Copy link

github-actions bot commented Oct 6, 2023

Validation Report for io.catenax.software_information/1.0.0/SoftwareInformation.ttl

Input model is valid

@agg3fe agg3fe added the MS2_Approved Checklist "MS2 Valid Model" is approved. label Oct 9, 2023
@agg3fe
Copy link
Contributor

agg3fe commented Oct 23, 2023

This model is on Hold for now and waiting for some further clarification.

@johannsvarela johannsvarela changed the title [New Model]: Software Information 1.0.0 [New Model]: Software Information 1.0.0 --> STILL ON GOING! Mar 18, 2024
@johannsvarela johannsvarela changed the title [New Model]: Software Information 1.0.0 --> STILL ON GOING! [New Model]: Software Information 1.0.0 Mar 27, 2024
@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.software_information/1.0.0/SoftwareInformation.ttl

Input model is valid

@johannsvarela
Copy link
Contributor Author

This model is on Hold for now and waiting for some further clarification.

@agg3fe Finally we can continue with the QG process to check and merge this aspect model! :-)

FYI @BenediktMuellerIML

agg3fe
agg3fe reviewed Apr 8, 2024
View reviewed changes
io.catenax.software_information/1.0.0/SoftwareInformation.ttl Outdated
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>.
@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
@prefix : <urn:samm:io.catenax.software_information:1.0.0#>.
@prefix ext-uuid: <urn:samm:io.catenax.shared.uuid:1.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.

Can you please uuid 2.0.0 version.
You might need to rebase your branch with main branch.

@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 8, 2024

Validation Report for io.catenax.software_information/1.0.0/SoftwareInformation.ttl

Input model is valid

1 similar comment
@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 8, 2024

Validation Report for io.catenax.software_information/1.0.0/SoftwareInformation.ttl

Input model is valid

@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 8, 2024

Validation Report for io.catenax.software_information/1.0.0/SoftwareInformation.ttl

Input model is valid

agg3fe
agg3fe reviewed Apr 8, 2024
View reviewed changes
io.catenax.software_information/1.0.0/SoftwareInformation.ttl Outdated
@@ -0,0 +1,101 @@
######################################################################
# Copyright (c) 2023 BASF SE
Copy link
Contributor

Choose a reason for hiding this comment

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

2024 required now

agg3fe
agg3fe reviewed Apr 8, 2024
View reviewed changes
io.catenax.software_information/1.0.0/SoftwareInformation.ttl Outdated

:SoftwareInformation a samm:Aspect;
samm:preferredName "Software Information"@en;
samm:description "The software information aspect model contains the essential information of all software components that have been implented or flashed in an instantiated part (e.g. serialized part). "@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 implented

@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 8, 2024

Validation Report for io.catenax.software_information/1.0.0/SoftwareInformation.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 Apr 8, 2024
agg3fe
agg3fe reviewed Apr 10, 2024
View reviewed changes
io.catenax.software_information/RELEASE_NOTES.md Outdated

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

## [1.0.0] 2023-10-02
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 date to 8 April.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@agg3fe Done! :)

@github-actions GitHub Actions
Copy link

Validation Report for io.catenax.software_information/1.0.0/SoftwareInformation.ttl

Input model is valid

@agg3fe agg3fe merged commit 88ac64e into eclipse-tractusx:main Apr 11, 2024
4 checks passed
@johannsvarela johannsvarela deleted the software_information_1.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.

[New Model]: Software Information 1.0.0
2 participants
@johannsvarela @agg3fe