Capella M2Doc tutorial In-Flight Entertainment System (IFE) example

Table of Content

M2Doc is a generic technology to generate MS Word(tm) documents. Generation is driven by templates that navigate through a source model and transform model elements into a well formated document.

This tutorial explains how to install and launch two templates written for Capella models:

  • LA: Logical specification of a system
  • SA: Whole specification of a system

For this tutorial, we use In-Flight Entertainment System (IFE) as a sample model.

The way these documents are generated can be adapted by changing the templates. New documents can also be generated by creating brand new templates.

Browse M2Doc website for a complete features overview or the support page to get help in creating M2Doc templates.

Note: M2Doc 1.1.0 and above are compatible with Team for Capella. You can test the generation by sharing the IFE example project provided in the extensions. Then edit the .genconf file to reference the shared SystemEngineering model element. You might need to open the Capella session first by double clicking the .aird file.

Installation

First you need to download Capella. It can be downloaded from this download page.

Once your download is finished, extract the downloaded archive and run the eclipe executable in the eclipse sub folder. You are now ready for the last step of the installation. You will need to add a new update site:

Installation Capella 1.3.x

  • https://s3-eu-west-1.amazonaws.com/obeo-networkaggregation-releases/capella-extensions/1.3.1/full zip
  • https://s3-eu-west-1.amazonaws.com/obeo-networkaggregation-releases/capella-extensions/1.3.0/full zip

Installation Capella 1.2.x

  • https://s3-eu-west-1.amazonaws.com/obeo-networkaggregation-releases/capella-extensions/1.2.1/full zip

Installation Capella 1.1.x

  • http://obeo-networkaggregation-releases.s3-website-eu-west-1.amazonaws.com/capella-extensions/1.1.0/full zip

This update site contains M2Doc and the Capella integration. Select the following feature:

The feature to install.

Deploying the In-Flight Entertainment System (IFE) example

After restarting Capella, you can deploye the In-Flight Entertainment System (IFE) example in your workspace with the following steps:

Use the New > Other menu.

The new menu.

The select the Capella - M2Doc > Capella IFE example with M2Doc templates project.

The new project wizard page 1.

Click the next button.

The new project wizard page 2.

Click the finish button and you should see the following project in your workspace.

The IFE project content.

Templates

You can run templates by using the corresponding .genconf file at the root of the project, to do so use the .genconf file as shown here. Templates are located in the template sub folder of the project.

If you want to go further in template editing you should have a look at the M2Doc documentation.

In the following you will find a description of each templates.

LA Complete

This template allows the generation of a logical specification of the content of the system. It starts by a description of the hierarchy of logical components, with, for each, its allocated functions and provided/required interfaces. Then the function decomposition is presented including functional exchanges. At the end, a reference of data structures is generated. You can have a look at the LA template and the generated LA document.

SA Complete

This template allows the generation of a document concerning the whole specification of a system. Starting from mission and capabilities of the system, the template presents the context of the system, its state machines and communicating actors, and functional specifications. At the end a reference of data structures is generated.You can have a look at the SA template and the generated SA document.