Skip to content

rename relations for SysML compatibility #618

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

Open
RSingh1511 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

rename relations for SysML compatibility #618

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3283cae
rename relations for Codebeamer compatibility
RSingh1511 Mar 23, 2026
13ad294
remove out-of-scope gd_req and inline example changes
RSingh1511 Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions MODULE.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ bazel_dep(name = "score_tooling", version = "1.2.0")
bazel_dep(name = "score_docs_as_code", version = "3.0.1")
git_override(
module_name = "score_docs_as_code",
commit = "21640ab325b3aae147ba4e3e8b5e7ab89fc2e8f5",
remote = "https://github.com/etas-contrib/score_docs-as-code.git",
# TODO: revert to main once https://github.com/RSingh1511/docs-as-code/pull/new/rs/rename-relations-codebeamer is merged
Copy link
Copy Markdown
Contributor

@masc2023 masc2023 Apr 9, 2026

Choose a reason for hiding this comment

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

Thanks for contribution, but it seems your change request are due to special tool requirements. This is not in scope with our concept. We discussed that already with @aschemmel-tech Please get in contact

Copy link
Copy Markdown
Contributor

@aschemmel-tech aschemmel-tech Apr 9, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

My understanding was that we are fine if SysML 2.0 use of the terms is still the same:

In my understanding "derived" relationship for requirements is still part of SysML 2.0: see https://www.omg.org/spec/SysML/2.0/Language/PDF section "9.6 Requirement Derivation Domain Library" or Figure 70 description. "Refinement" seems not to be requirement specific.
Also see https://www.omg.org/spec/SysML/2.0/Transformation/PDF : 7.8.8.3.1 DeriveReqt_Mapping "A SysML::Requirements::DeriveReqt relationship is mapped to a SysML v2 DerivationConnections::Derivation model library element."

"Satisfy" relationship also still part of SysML 2.0: See e.g. 7.21.1 Requirements Overview: "A design solution must satisfy the requirement and all of its member requirements and constraints to be a valid solution." or 7.21.4 Satisfy Requirement Usages
Also see https://www.omg.org/spec/SysML/2.0/Transformation/PDF : 7.8.8.3.22 Satisfy_Mapping "A SysML::Requirements::Satisfy relationship is mapped to a SysML v2 SatisfyRequirementUsage."

It is not a special tool requirement, it is just how we have configured our tooling (codebeamer and trlc) by using requirement attributes which conform to UML 1.x

commit = "dcbf9c99f592159f49aa8231a053d673e9d2dcde",
remote = "https://github.com/RSingh1511/docs-as-code.git",
)
21 changes: 7 additions & 14 deletions process/folder_templates/features/feature_name/architecture/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ Requirements
.. needtable:: Overview of Feature Requirements
:style: table
:columns: title;id
:filter: search("feat_arch_sta__archdes$", "fulfils_back")
Copy link
Copy Markdown
Contributor

@RolandJentschETAS RolandJentschETAS Apr 10, 2026

Choose a reason for hiding this comment

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

You have to change also the process description and process requirements. Not only the links. For example in the meta model picture.

Copy link
Copy Markdown
Contributor

@masc2023 masc2023 Apr 10, 2026

Choose a reason for hiding this comment

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

@aschemmel-tech , is that part of your PR #621?

:filter: search("feat_arch_sta__archdes$", "satisfies_back")
:colwidths: 70,30


.. needtable:: Overview of Feature Requirements
:style: table
:columns: title;id
:filter: search("feat_arch_sta__archdes$", "fulfils_back")
:filter: search("feat_arch_sta__archdes$", "satisfies_back")
:colwidths: 70,30


Expand All @@ -80,24 +80,17 @@ The live feature architecture template snippets are maintained in the

.. code-block:: rst

.. feat:: Feature Name
:id: feat__feature_name
:security: YES
:safety: ASIL_B
:status: invalid
:includes: logic_arc_int__feature_name__interface_name1

General Feature Description

.. feat_arc_sta:: Feature Static View
:id: feat_arc_sta__feature_name__static_view
:security: YES
:safety: ASIL_B
:status: invalid
:fulfils: feat_req__feature_name__some_title
:satisfies: feat_req__feature_name__some_title
:includes: logic_arc_int__feature_name__interface_name1
:belongs_to: feat__feature_name

General Feature Description

.. needarch::
:scale: 50
:align: center
Expand All @@ -114,7 +107,7 @@ Dynamic Architecture
:security: YES
:safety: ASIL_B
:status: invalid
:fulfils: feat_req__feature_name__some_title
:satisfies: feat_req__feature_name__some_title
:belongs_to: feat__feature_name

Put here a sequence diagram
Expand All @@ -129,7 +122,7 @@ Logical Interfaces
:security: YES
:safety: ASIL_B
:status: invalid
:fulfils: feat_req__feature_name__some_title
:satisfies: feat_req__feature_name__some_title

General Interface Description

Expand Down
2 changes: 1 addition & 1 deletion process/folder_templates/features/feature_name/requirements/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Feature Requirements
:reqtype: Process
:security: NO
:safety: ASIL_B
:satisfies: stkh_req__requirements__template
:derived_from: stkh_req__requirements__template
:valid_from: v0.0.1
:valid_until: v1.0.1
:status: invalid
Expand Down
10 changes: 5 additions & 5 deletions ...folder_templates/modules/module_name/component_name/docs/architecture/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Requirements Linked to Component Architecture
.. needtable:: Overview of Component Requirements
:style: table
:columns: title;id
:filter: search("comp_arch_sta__archdes$", "fulfils_back")
:filter: search("comp_arch_sta__archdes$", "satisfies_back")
:colwidths: 70,30

Description
Expand Down Expand Up @@ -93,7 +93,7 @@ The live component architecture template is maintained in the
:status: invalid
:belongs_to: comp__component_name_template
:uses: logic_arc_int__feature_name__interface_name1
:fulfils: comp_req__component_name__some_title
:satisfies: comp_req__component_name__some_title

.. needarch::
:scale: 50
Expand All @@ -112,7 +112,7 @@ Dynamic Architecture
:safety: ASIL_B
:status: invalid
:belongs_to: comp__component_name_template
:fulfils: comp_req__component_name__some_title
:satisfies: comp_req__component_name__some_title

Put here a sequence diagram

Expand All @@ -126,7 +126,7 @@ Interfaces
:id: real_arc_int__<component>__<Title>
:security: <YES|NO>
:safety: <QM|ASIL_B>
:fulfils: <link to component requirement id>
:satisfies: <link to component requirement id>
:language: cpp

Internal Components
Expand All @@ -139,7 +139,7 @@ Internal Components
:status: invalid
:safety: ASIL_B
:security: YES
:fulfils: comp_req__component_name__some_title
:satisfies: comp_req__component_name__some_title
:belongs_to: comp__component_name_template

No architecture but detailed design
Expand Down
2 changes: 1 addition & 1 deletion ...folder_templates/modules/module_name/component_name/docs/requirements/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Component Requirements
:reqtype: Process
:security: YES
:safety: ASIL_B
:satisfies: feat_req__feature_name__some_title
:derived_from: feat_req__feature_name__some_title
:status: invalid
:belongs_to: comp__component_name_template

Expand Down
147 changes: 128 additions & 19 deletions process/process_areas/architecture_design/architecture_concept.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,22 @@ The feature architecture contain the following views:
Static View
-----------

The first viewpoint is named as *feature architecture*. It displays the SW Components within the SW modules (= dependable elements) which are required to realize the feature including their interactions. Also the *logical interfaces* and the interaction between the feature and the user are included in this view. On this architectural level the feature requirements shall be allocated. A full rendered example for the static architecture is maintained in the
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
The first viewpoint is named as *feature architecture*. It displays the SW Components within the SW modules (= dependable elements) which are required to realize the feature including their interactions. Also the *logical interfaces* and the interaction between the feature and the user are included in this view. On this architectural level the feature requirements shall be allocated. An example for the static architecture is shown here:
Copy link
Copy Markdown
Contributor

@masc2023 masc2023 Apr 9, 2026

Choose a reason for hiding this comment

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

As previous comment, we do not use directives from the development meta model in process description, examples are now in module_template

Copy link
Copy Markdown
Contributor

@aschemmel-tech aschemmel-tech Apr 9, 2026

Choose a reason for hiding this comment

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

currently there is no example in the module_template, but I agree we should leave this untouched because it is already how it should be in the future.


.. feat_arc_sta:: Feature 1 Architecture
:id: feat_arc_sta__example_feature__feature_1
:security: YES
:safety: QM
:status: valid
:includes: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2
:satisfies: feat_req__example_feature__archdes_example_req
:belongs_to: feat__example_feature

.. needarch::
:scale: 50
:align: center

{{ draw_feature(need(), needs) }}

In all views, the components which are marked as ASIL_B related are drawn with red borders.

Expand All @@ -150,8 +164,20 @@ See :ref:`uml_diagram_selection` in guideline for further information about the
Interface View
--------------

On the feature level only *logical interfaces* shall be displayed. This means that only logical names shall be provided for both the interface and the operations within. Those *logical interfaces* shall be connected to component interfaces on the module view. A rendered logical-interface example is maintained in the
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
On the feature level only *logical interfaces* shall be displayed. This means that only logical names shall be provided for both the interface and the operations within. Those *logical interfaces* shall be connected to component interfaces on the module view.

.. logic_arc_int:: Logical Interface 1
:id: logic_arc_int__example_feature__archcon_logical_interface_1
:security: YES
:safety: ASIL_B
:status: valid
:satisfies: feat_req__example_feature__archdes_example_req

.. needarch::
:scale: 50
:align: center

{{ draw_interface(need(), needs) }}

SW Module View
==============
Expand All @@ -171,8 +197,19 @@ Static View

The *component architecture* describes the implementation of the functionalities in a white-box view. It describes the internal structure of SW components and their decomposition. It provides a more detailed information concerning the respective interfaces of a component. If a SW component interacts with a different component it is also included via a *use* relationship in the diagram. An example of the *component architecture* is displayed here:

A full rendered component-architecture example is maintained in the
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
.. comp_arc_sta:: Component 1 Static View
:id: comp_arc_sta__example_feature__archdes_component_concept_1
:status: valid
:safety: ASIL_B
:security: NO
:satisfies: comp_req__example_feature__archex_example_req
:belongs_to: comp__component_example_1

.. needarch::
:scale: 50
:align: center

{{ draw_component(need(), needs) }}

The decomposition is optional and relies on the complexity of the component. Thus there is no graphic representation required for it.
In all views the components which are marked as ASIL_B related are drawn in red color.
Expand All @@ -197,8 +234,21 @@ Following scenarios should be included:
Interface View
--------------

The component interface view shows the actual interfaces of the component. Also links to their corresponding logical interfaces are displayed in this view. A rendered component-interface example is maintained in the
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
The component interface view shows the actual interfaces of the component. Also links to their corresponding logical interfaces are displayed in this view:

.. real_arc_int:: Component Interface 1
:id: real_arc_int__example_feature__archdes_component_interface_1
:status: valid
:safety: ASIL_B
:security: NO
:satisfies: comp_req__example_feature__archex_example_req
:language: cpp

.. needarch::
:scale: 50
:align: center

{{ draw_interface(need(), needs)}}

Platform View
=============
Expand Down Expand Up @@ -421,8 +471,29 @@ Here are some excerpts of UML diagrams made from the requirements of that file.
Feature Architecture
^^^^^^^^^^^^^^^^^^^^

The following section links to the rendered feature example that is now maintained in the
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
The following section is an example, how an `Feature <https://eclipse-score.github.io/score/main/features/index.html>`_ looks like and how the architecture of an Feature is described. Please note that components with an "ASIL_B" safety rating are highlighted with red borders in the diagram (e.g., "Component 1").

.. feat:: Feature Name
:id: feat__feature_name_example
:security: YES
:safety: ASIL_B
:status: invalid
:includes: logic_arc_int__example_feature__archex_logical_interface_1

.. feat_arc_sta:: Feature Static Architecture View - Rendered Example
:id: feat_arc_sta__example_feature__archdes_getstrt
:security: YES
:safety: QM
:status: valid
:includes: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2
:satisfies: feat_req__example_feature__archdes_example_req
:belongs_to: feat__example_feature

.. needarch::
:scale: 50
:align: center

{{ draw_feature(need(), needs) }}

.. code-block:: rst

Expand All @@ -440,7 +511,7 @@ The following section links to the rendered feature example that is now maintain
:safety: QM
:status: valid
:includes: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2
:fulfils: feat_req__example_feature__archdes_example_req
:satisfies: feat_req__example_feature__archdes_example_req
:belongs_to: feat__example_feature

.. needarch::
Expand All @@ -454,8 +525,19 @@ Component Architecture

The following section is an example, how an component looks like and how the detail design of an component is described. Please note that components with an "ASIL_B" safety rating are highlighted with red borders in the diagram (e.g., "Component 1").

The rendered component examples are maintained in the
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
.. comp_arc_sta:: Component Static View - Rendered Example
:id: comp_arc_sta__example_feature__component_getstrt
:status: valid
:safety: ASIL_B
:security: NO
:satisfies: comp_req__example_feature__archex_example_req
:belongs_to: comp__component_example_1

.. needarch::
:scale: 50
:align: center

{{ draw_component( need(), needs ) }}

.. code-block:: rst

Expand All @@ -464,7 +546,7 @@ The rendered component examples are maintained in the
:status: valid
:safety: ASIL_B
:security: NO
:fulfils: comp_req__example_feature__archex_example_req
:satisfies: comp_req__example_feature__archex_example_req
:belongs_to: comp__component_component_getstrt

.. needarch::
Expand Down Expand Up @@ -506,8 +588,20 @@ Besides storing the output it is also possible to display the generated PlantUML

Debug example for component architecture:

See the rendered debug example in the
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
.. comp_arc_sta:: Component Static View - Rendered Debug Example
:id: comp_arc_sta__example_feature__component_getstrt_debug
:status: valid
:safety: ASIL_B
:security: NO
:satisfies: comp_req__example_feature__archex_example_req
:belongs_to: comp__component_example_1

.. needarch::
:scale: 50
:align: center
:debug:

{{ draw_component( need(), needs ) }}

.. _manual_addition_uml:

Expand All @@ -525,7 +619,8 @@ To make *needuml* work we have to replace the *need()* call with a different fun
:status: valid
:safety: ASIL_B
:security: NO
:uses: logic_arc_int__example_feature__archcon_logical_interface_1
:uses: logic_arc_int__example_feature__archex_logical_interface_1
:satisfies: comp_req__example_feature__archex_example_req
:belongs_to: comp__component_component_manual_getstrt

.. needuml::
Expand All @@ -535,8 +630,22 @@ To make *needuml* work we have to replace the *need()* call with a different fun
}
CM -> LI1: EXTRA_LINKAGE_MANUALLY_ADDED

See the rendered manual-edit example in the
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
.. comp_arc_sta:: Component Architecture Static View - Rendered Example Manually Edited
:id: comp_arc_sta__example_feature__component_manual_getstrt
:status: valid
:safety: ASIL_B
:security: NO
:uses: logic_arc_int__example_feature__archex_logical_interface_1
:satisfies: comp_req__example_feature__archex_example_req
:belongs_to: comp__component_example_1

.. needarch::

{{ draw_component( needs.get('comp__component_example_1'), needs ) }}

component "Component Manual" as CM {
}
CM -> logic_arc_int__example_feature__archex_logical_interface_1: EXTRA_LINKAGE_MANUALLY_ADDED

You can add any layout or additional configuration you want before you call the *draw_xyz*.

Expand Down
Loading
Loading