Skip to content

[New model] CBAM (draft)#953

Draft
jSchuetz88 wants to merge 3 commits intoeclipse-tractusx:mainfrom
jSchuetz88:new-model/cbam
Draft

[New model] CBAM (draft)#953
jSchuetz88 wants to merge 3 commits intoeclipse-tractusx:mainfrom
jSchuetz88:new-model/cbam

Conversation

@jSchuetz88
Copy link
Copy Markdown
Member

@jSchuetz88 jSchuetz88 commented Mar 2, 2026

Description

This PR adda a new CBAM model.

Notes:

  • This PR currently is in draft state on purpose to enable discussions and reviews based on the current state. The model is not finalized yet.
  • The model for AttestationOfConformance is added only temporarily. As pcf:9.0.0 uses exactly the same properties and characteristics this will be separated and published as a shared model.

Closes #874

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)
  • payload names and property identifiers must not contain two consecutive underscores ('__') at any position (e.g. my__model is not allowed)
  • 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
  • all external / imported models have the state "release"
  • 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

@jSchuetz88 jSchuetz88 self-assigned this Mar 2, 2026
@jSchuetz88 jSchuetz88 marked this pull request as draft March 2, 2026 21:18
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]: CBAM Data Model

1 participant