capella2polarion

A tool to migrate Capella content to a Polarion project as work items and to manage Polarion Live-Documents.

Overview

capella2polarion offers several features to interact with Polarion and Capella models. Currently, the following features are available:

Synchronization of Model-Elements

Migrate any model element from a capellambse.MelodyModel to Polarion as a work item. Diagrams are taken from a diagram cache (pipeline artifact from a capella diagram cache) job run to Polarion as work items. The whole folder with the index.json and the SVGs is needed for the diagram synchronization.

With appropriate configuration of the service and on Polarion any model element can be migrated from a Capella model to a Polarion project. For an overview of all features related to the synchronization and supported Capella object types, have a look at the model synchronization documentation page.

Rendering of Live-Documents

The render_documents command in the CLI allows the rendering of Polarion Live-Documents in a dedicated documents space inside a Polarion project. This doesn’t need to be the sync project. These documents are generated via rendering Jinja2 templates, enabling them to be enriched by model data without requiring the data as a work item in Polarion.

There are two modes for rendering Live-Documents:

  • Full Authority Documents: C2P takes full control over the content, and

    any human-made changes to the document will be overwritten in the next rendering cycle. To make changes persistent, modifications to the Jinja2 templates are required.

  • Mixed Authority Documents: C2P takes control over marked sections of

    the document, allowing for collaboration where dedicated model-enhanced areas coexist with human-edited content.

Detailed information on the Live-Document rendering feature can be found in the render documents documentation page. For a guide on how this service is configured see the configuration page.

Note

Additional features will be documented here in the future as they are developed and integrated.

Features:

Configuration:

CI/CD Templates:

Roadmap:

API reference