Installation in a Team for Capella Context

This paragraph provides additional details that are relevant when Publication For Capella needs to be installed and used together with Team for Capella.

1. Conventions

Publication For Capella is distributed as a set of 3 files:

  • A zip archive perseus-server-application-<version>.zip of the server binaries, documentation, and helper scripts.

  • An update site fr.obeo.perseus.client.updatesite-<version>.zip of the Contributor Client that can be installed in Capella (any version 6.0 or below).

  • An update site fr.obeo.perseus.client.updatesite61-<version>.zip of the Contributor Client that can be installed in Capella (6.1 and above).

2. Installing or Upgrading Publication For Capella

The zip archive of the server should be extracted in a folder that will be designated as <Publication For Capella>/. It contains a folder TeamForCapella/ with the following structure:

  • <Publication For Capella>/

    • (…​)

    • TeamForCapella/

      • tools/

        • install_p4c.bash - To install the Publication For Capella client under Linux, in Capella versions 6.0 or below.

        • install_p4c.bat - To install the Publication For Capella client under Windows, in Capella versions 6.0 or below.

        • install_p4c_capella61.bash - To install the Publication For Capella client under Linux, in Capella 6.1 and above.

        • install_p4c_capella61.bat - To install the Publication For Capella client under Windows, in Capella 6.1 and above.

When Publication For Capella is used in a Team for Capella environment, the Contributor Client must be installed not only in each end user’s Capella instance, but also in the Capella instance that is deployed on the Team for Capella server.

Assuming Team For Capella is installed in a folder <TeamForCapella>/, here are the steps to install the Contributor Client on the Team For Capella server:

  • Copy the script from folder <Publication For Capella>/TeamForCapella/tools/ to folder <TeamForCapella>/tools/.

  • Copy the Publication For Capella zipped update site fr.obeo.perseus.client.updatesite-<version>.zip (or fr.obeo.perseus.client.updatesite61-<version>.zip) to folder <TeamForCapella>/updateSite/.

  • Run the script install_p4c.bat or install_p4c.bash depending on the OS being used (bat under Windows, bash otherwise) and the target Capella version (install_p4c_capella61.bash / install_p4c_capella61.bat for Capella 6.1 and above).

The script output should look like this (the version numbers and other details will differ though):

 (...)
 +-------------------------------------------------------+
 + Uninstall previous Publication for Capella if present +
 +-------------------------------------------------------+
 (...)
 Operation completed in 4329 ms.
 ---------------------
 Uninstall successful. (or 'Uninstall returned code 13, this is expected in many cases so proceeding anyway.')
 ---------------------
 +-------------------------------------+
 + Install new Publication for Capella +
 +-------------------------------------+
 (...)
 Operation completed in 3918 ms.
 -------------------
 Install successful.
 -------------------

The script is able to upgrade the version of Publication For Capella if it was already installed.

3. Migrating Team for Capella Repositories

In most cases, it is necessary to migrate the Team for Capella repositories.

The reason for that is that each Team for Capella repository is tied to a specific set of meta-models being used for the Capella models authored within this repository. Consequently, whenever the upgrade of Publication For Capella requires a meta-model change, then the Team for Capella repositories must be migrated.

The following steps are required:

  • Import locally all the Capella project shared in Team for Capella, within a Capella with the Publication For Capella Contributor Client installed, in the most recent version.

  • Open each Capella project in this Capella instance, which will automatically migrate the Publication For Capella data, then save and close each of them.

  • Stop the Team for Capella server.

  • Make a back-up of the internal databases of each Team for Capella repository (folder server/db-auditing for static repositories, folder server/dynamic/xxx/_database for dynamic repositories).

  • Delete the internal databases of each Team for Capella repository.

  • Restart the Team for Capella server.

  • Re-export each project to T4C (but only after it has been opened locally at least once).