Skip to content

DanielSteffenReichert/sldt-semantic-models

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Aspect Models for Eclipse Tractus-X Semantic Layer (SLDT)

The repository contains the aspect models based on BAMM for the Tractus-X project for Catena-X.

Currently, we assume the usage of the version 2.0.6 of the BAMM-CLI.

Using the models

The models can locally be processed with the BAMM CLI. It allows you to generate different artifacts (diagrams, example payload, java class files) out of it.

Status of model

Each model has its life cycle and can thus have a different status. This information always corresponds to a specific version of the model. To indicate the state of the model version in Git, one creates a file with the name metadata.json and places it in the same directory as the corresponding model file. It is also possible to load the models into the Semantic Hub which has a corresponding state management. An example metadata.json looks like this:

{ "status" : "deprecate"} 

The following table lists the possible values for status and what they mean:

status status in Semantic Hub description
draft DRAFT This version of the model is under development and can change at any time.
release RELEASED The version of the model is considered as stable and any modifications to the model trigger a new release and subsequentially a new version.
deprecate DEPRECATED The version of the model has reached its end-of-life and should not be used anymore because it will be deleted later.

The metadata.json is only relevant for model files on the branch main. All other branches are development branches, and the models from these branches or forks are therefore implicitly in status "DRAFT".

How to contribute

We have a governance process for the joint development of new and updated models which we describe in more details under this link.

Summary of Governance Process

The governance process is triggered by a domain expert requesting a new model or model update. A modeling team then reviews the request to identify whether it is of interest for Catena-X and Tractus-X and whether there is not already another model which can solve the raised issue (indicating label MS1-Approved).

Once the request is accepted, a modeling expert and the requesting domain expert create a solution. The modeling expert then evaluates whether the new or updated model follows the modeling guidelines in Tractus-X (indicating label MS2-Approved). In the last step, the requesting use case and the modeling team approve that the resulting model fulfills the initial requirement and can be adopted (indicating label MS3-Approved). As a result, the content of the new model version cannot change, and adopters from use cases are safe to use the model.

We do this process for each version of a model. So there can be multiple versions of the model with different content in different phases of the model life-cycle.

If you plan to add another model or apply changes to existing ones please create a new issue and discuss your request with the modeling team. When requesting reviews and approvals for new model developments file a pull request.

About

sldt-semantic-models

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published