Team for Capella Client installation

1. Requirements

1.1. Recommended system requirements

For successful installation of Team for Capella Client, your computer must meet the following requirements:

  • 2 GHz processor

  • 3 GB for (for big models, 4GB RAM)

  • System requirements:

    • Microsoft Windows 10/11 64 bits

      • no known issues with Windows 7/8

    • Microsoft Windows Server 2022/2025 64 bits

      • no known issues Windows Server 2008/2012/2016/2019

  • Compatibility with Java Runtime Environment 17 (Eclipse Adoptium Open JDK 17.0.17+10 is provided by SMW)

  • Virus scanner should not be activated on Capella models files:
    *.aird, *.capella, *.airdfragment, *.capellafragment and *.afm.

2. Installation Procedure

2.1. Team for Capella Client installation procedure

2.1.1. Default client installation

You may take your Team For Capella client as it has been installed during the server installation. In that case, you need to make an archive of the capella folder and distribute it to users. Remember to include the samples folder if you want to ship the example model.

For Windows and Linux, it possible to follow the server installation procedure without the server nor Jenkins deployment and keep only the capella folder in the end.

Before archiving the Capella client that will be deployed on others computers, don’t forget to remove the workspace used for the installation from the recent workspaces list (Window > Preferences > General > Startup and Shutdown > Workspaces).

It is also possible to manually install Team for Capella but note that the installation with the tools/installTeamForCapellaInSMW.bat is recommended.

2.1.2. Scripted client installation

It possible to use the installation script and target your SMW installation. It is similar to run the server server installation procedure without the server nor Jenkins deployment and keep only the capella folder in the end.

Preparation steps:

  1. Download and extract the archive TeamForCapella-7.0.1_202601_SMW-2512_ClientInstaller_Windows.zip in a given directory. It contains a TeamForCapella directory with 2 sub-folders and 1 file:

    • tools: contains some scripts, properties files and pre-configured jobs to configure a Jenkins as scheduler

    • updateSite: the Team For Capella update site for the client

    • license.html

    • It is also possible to use the server bundle TeamForCapella-7.1.0_202601_SMW-2512-win32.win32.x86_64.zip and keep only the elements listed in the preceding bullet points.

  2. Download SMW 2512

Client Installation

  1. Install SMW bundle (please refer to the SMW installation requirements).

  2. Move license.html and the tools`and `updateSite folders next to the capella folder of your SMW 2512 installation directory.

  3. Resulting structure of your SMW folder:

    • capella

    • samples

    • tools

    • updateSite

    • license.html

  4. Navigate to the tools folder and execute installTeamForCapellaInSMW.bat.

    • The installation script will install the Team for Capella features in SMW, update the splash screen and update some properties in SMW.ini and config.ini.

    • It is configured by default to retrieve the Team For Capella update site in the folder: ..\updateSite

2.1.3. Manual client installation

To manually install Team for Capella client in a SMW bundle, please follow the next steps:

  1. Download and install SMW 2512

  2. Download and extract the archive TeamForCapella-7.0.1_202601_SMW-2512_ClientInstaller_Windows and keep only the updateSite and tools folders or TeamForCapella-7.0.1_202601_SMW-2512-win32.win32.x86_64.zip.

  3. Launch SMW (SMW.exe)

  4. Click Menu Help/Install New Software… , add the archive file in the updateSite folder and select features in the Team for Capella category:

    • Team for Capella

    • User Interface to request a License

    • Other features from Team for Capella and Team for Capella – Administration categories are optional and not installed by the installation script.

  5. Then you need to do the additional tasks performed by the installation script:

    • change the splashscreen:

      • replace the value of osgi.splashPath by platform\:/base/plugins/com.thalesgroup.mde.melody.collab.ui in capella\configuration\config.ini

    • copy the license.html file from tools to capella folder

    • avoid performance impact of CDO internal tracing:

      • add -Dorg.eclipse.net4j.util.om.trace.disable=true at the end of the -vmargs section in capella\SMW.ini

    • avoid third parties components logging noise

      • add -Dlogback.configurationFile=configuration/logback.xml at the end of the -vmargs section in capella\SMW.ini

      • copy the logback.xml file from tools/resources/client_rootfiles to capella/configuration folder

    • add possibility to override default repository connection information:

      • add -pluginCustomization
        pluginCustomization.ini
        before the -vmargs section in capella\SMW.ini

      • copy the pluginCustomization.ini file from tools/resources/client_rootfiles to capella folder

    • add the license.html in capella folder, copied from tools\license.

  6. Add the license server configuration key as described in Client configuration. If you have installed Team for Capella in a Capella bundle already completed with some add-ons, remember to check if they provide a “CDO Feature” for Team for Capella compatibility.

Steps 4 and 5 are done by the installation script.

2.1.4. Extensions installation

If meta-model extensions or add-ons are needed, use one of the following ways to install them:

  • Use the Help > Install New Software… wizard if the extension are provided as update sites

  • Otherwise if they are provided as dropins

    • Either unzip/copy their binary files in the folder TeamForCapella\capella\dropins

    • Or:

      • Unzip/copy them in any folder (it can be a shared folder between this server installation and client installations)

      • Modify the configuration file TeamForCapella\capella\SMW.ini by adding the following parameter, after -vmargs :

        -Dorg.eclipse.equinox.p2.reconciler.dropins.directory=<ExtensionFolder>

Exactly the same extensions have to be installed on all clients including the server-side client. Installation of a new version of an addon may require a migration, see Capella Addon migration.

2.2. Team for Capella Client configuration

For the complete client configuration documentation, refer to the chapter User Guide > Client Configuration > Preferences

  1. Launch SMW (Team for Capella is installed in it),

  2. Optional: clean the user’s Secure Storage (it contains the save Login/Password, if “Remember Me” option was used): Go to menu Window > Preferences > General > Security > Secure Storage,

    1. Open the Contents tab,

    2. Select [Default Secure Storage],

    3. Click on Delete,

    4. Upon request, restart the Team for Capella client.

  3. Go to the menu Window > Preferences > Sirius > Team collaboration

    1. Set the server location with the hostname or the IP address of the Team for Capella Server (localhost if the server is setup on the same machine),

    2. Click on Apply

2.3. Verification installation procedure

  1. Create a new project > Right click in the Capella Explorer > New > Capella Project

    1. Call it Test for example > Finish

  2. Export the project to the remote repository

    1. Right click on the project > Export > Team for Capella > Export model to remote repository>Next,

    2. (Optional) Expand Connection Information if the deployed repository with default parameters

    3. Click on Test Connection : image

    4. Provide the user name and password (by default: user1/user1, user2/user2, user3/user3, admin/admin).

    5. Click on Finish.

  3. Connect to the remote project previously exported,

    1. Right click in the Capella Explorer > New > Capella Connected Project

    2. Test Connection,

    3. Select sthe Shared project from the list: image

    4. Click on Finish,

  4. You should now be able to work on the project on the remote repository. image