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)

  • Microsoft Windows 10/11 64 bits

    • no known issues with Windows 7/8

  • Compatibility with Java Runtime Environment 17 (Eclipse Adoptium Open JDK 17.0.11 is provided by Capella)

  • 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/installTeamForCapellaInCapella.bat is recommended.

2.1.2. Manual client client installation

To manually install Team for Capella client in a Capella bundle (Windows/Linux/macOS), please follow the next steps:

  1. Extract the archive TeamForCapella-7.0.0-win32.win32.x86_64.zip and keep only the updateSite and tools folders.

  2. Download and unzip Capella 7.0.0 bundle (https://www.eclipse.org/capella/download.html)

  3. Launch Capella (capella.exe for Windows, capella for Linux, Capella for macOS)

  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 (Capella.app/Contents/Eclipse/configuration/config.ini for macOS)

    • 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\capella.ini (Capella.app/Contents/Eclipse/capella.ini for macOS)

    • avoid third parties components logging noise

      • add -Dlogback.configurationFile=configuration/logback.xml at the end of the -vmargs section in capella\capella.ini (Capella.app/Contents/Eclipse/capella.ini for macOS)

      • copy the logback.xml file from tools/resources/client_rootfiles to capella/configuration folder (Capella.app/Contents/Eclipse/configuration/ for macOS)

    • add possibility to override default repository connection information:

      • add -pluginCustomization
        pluginCustomization.ini
        before the -vmargs section in capella\capella.ini (Capella.app/Contents/Eclipse/capella.ini for macOS)

      • copy the pluginCustomization.ini file from tools/resources/client_rootfiles to capella folder (Capella.app/Contents/Eclipse/ for macOS)

    • 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.2. Team for Capella Client configuration

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

  1. Launch Team for Capella (capella/capella.exe),

  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