Capella/Installation Guide

From Wiki
Jump to: navigation, search

Log of Changes


Log of Changes
Revision Date Modification
001 2015/11/03 Initial version.
Capella 0.8.3
002 2016/01/04 Updated for
Capella 1.0.0
003 2016/02/19 Updated for
Capella 1.0.1


Scope

Typographic and Notation Rules

To improve legibility, some text elements are identified by specific typographic rules in according to their tutorial purpose.

  • Emphasis font is applied to emphasize words which designs controls (Click on Cancel)
  • Fixed font is applied to expressions and texts of ASCII (C:\My documents\Path)
  • Terminology font is applied on expressions referenced in Terminology table.

Identification

This document is applicable to Capella 1.0.0.

Document Overview

This document is intended for persons in charge of installing Capella. It describes the installation, configuration and uninstallation of Capella.

Capella Installation

Prerequisites Needed for Install

For successful installation of Capella, your computer must meet the following recommended:

  • System requirements: X86 computer running Windows
  • An unzip utility such as WinZip or equivalent
  • 2 GHz processor
  • 2 Go RAM
  • 10 GB of available hard disk space

Capella requires Java Runtime Environment version 1.7 update or later installed in the computer: recommended version is jre-7u60-windows-i586.exe or later.

Note: For Capella 64bit Version, recommended version is jre-7u60-windows-x64.exe or later.

Capella Installation Procedure

Before starting installation, target location of Capella must be cleaned:

  1. Previous Capella version must be correctly uninstalled (See related section)
  2. All manual patches/extensions must be removed


  • First, download Capella according to your system configuration:


Capella 0.8.3 download.png


  • Extract the archive file in a given directory using a compression software of your choice

Note:: Capella is based on Eclipse: folder hierarchy and namespace of Capella and Eclipse plugins are quite long. Because of Windows folder path restriction, avoid entering a too long installation location. In case the path is too long, the extraction will raise an error, the location shall be deleted and extraction done again.

Verification Installation Procedure

Starting Capella

Capella installation is complete if the archive extraction finished without errors.

  • Go to installation directory and check the capella directory contains two folders:
    • eclipse: the Capella modeling workbench
    • samples: the In-Flight Entertainment sample model
  • Open the capella/eclipse directory and check the tree looks like this:


Capella 0.8.3 extracted.png


  • Edit the eclipse.ini file and change line -Dosgi.requiredJavaVersion=1.6 by 1.7 to ensure the use of Java 7:


Capella 0.8.3 eclipse ini osgi.png

  • Run eclipse.exe to start Capella
  • Capella should start with below splash screen.


Note: In case Capella does not start, edit the eclipse.ini file again and add a line:

After:

-showsplash

org.polarsys.capella.core.platform.sirius.ui.perspective

skip a line and add:

-vm

<ABSOLUTE_PATH_TO_JAVA.EXE> (JRE/JDK 32 or 64-bits according to the version of Capella)


At start up, Capella splash screen is displayed and shows launched version:


Capella 0.8.3 splash.png


The following welcome view appears when a new workspace is selected. New users can use this view to easily start with Capella, or close this view to get Capella Perspective based on eclipse standard perspective.


Capella 0.8.3 welcome.png

Perspective Views

Capella Perspective shall appear with below views (refer below image):

  • Capella Project Explorer
  • Fast Linker
  • Properties
  • Information
  • Semantic Browser


Capella 0.8.3 perspective.png


Note: In case Capella Perspective is not started or closed by User, it can be reopened: select the menu Window/Open Perspective/Other.../Capella":


Capella 0.8.3 open perspective.png


Check Version and Build ID

Go to Capella Advance "Help/About Capella" and check that the version release number is the one installed (Build ID is also displayed):


Capella 0.8.3 about.png


Capella 0.8.3 about build.png


Help/About Capella to check JRE

Go to Capella menu "Help/About Capella" then "Installation Details" then "Configuration Tab" and check that JRE path is correctly selected:


Capella 0.8.3 jre.png


The required version of Java 1.7 is at least 1.7_60, not a lower version to avoid problems in scenarios for instance or with diagram edge connection.

External Viewpoints Management

Capella enforces the presence of all external Viewpoints used by a project to avoid probable data loss. It is mandatory to install all these Viewpoints in Capella in order to migrate or to open a project.

If these Viewpoints are not available or installed in the Capella target version, a preparation of the project is needed before the migration/opening will be possible.

A specific tooling is dedicated to this preparation, please read related documentation at Kitalpha wiki (Detachment): this tooling is packaged in Kitalpha directly, which means by default available in Capella. Moreover files must be writable, so that detach can update and backup successfully

Migration of an Existing Project

Overview

What is performed in a global project migration?

  1. The tool locates all .melodymodeller files at the root of the Eclipse project and migrate them (including all fragments located in the /fragment folder)
  2. The tool locates all .aird files at the root of the Eclipse project and migrate them (including all fragments located in the /fragment folder)
  3. The tool locates all .pattern files at the root of the Eclipse project and migrate them
  4. The tool perform a Sirius Migration on all aird files (including fragments)

Note for External Viewpoints

In case your model deals with external Viewpoints, please read previous section "External Viewpoints management".

Prerequisites

  • All the open sessions (aird) of the workspace must be closed.
  • When working with ClearCase or SVN, all project files must be previously checked-out
  • Apply Viewpoint Refresh preferences ( Enable Do refresh on representation opening and Automatic Refresh )
  • All used extensions must be installed (e.g.: Basic Variability, etc.)

Recommendations

It is highly recommended to baseline in source control the whole Capella Projects/artefacts/links (or a make a full backup of the files), before running migration process.

Configuration

For optimized memory management, especially with medium to large size models,

  • It is better to perform the migration right after a fresh start of Capella
  • It is better to restart Capella after the migration has completed

Enough disk space is required to launch Capella migration because of backup files and Eclipse configuration files. In case of migration failure, please check disk free space.

With big models, it might be necessary to increase the RAM allocated to Capella . To do so, create a Windows shortcut towards eclipse.exe in the Capella installation folder. Open the shortcut properties, and replace the target field by the following:

CAPELLA_HOME\eclipse.exe -clean -vmargs -Xms768m -Xmx768m -XX:PermSize=256m -XX:MaxPermSize=256m -XX:+CMSPermGenSweepingEnabled -XX:+CMSClassUnloadingEnabled

Or in some cases:

CAPELLA_HOME\eclipse.exe -clean -vmargs -Xms128m -Xmx1550m -XX:MaxPermSize=100M -XX:+CMSPermGenSweepingEnabled -XX:+CMSClassUnloadingEnabled

Procedure while using Libraries

Follow below procedure if migration is required for Capella project referencing library project

Consider an example as below:

  • MelodyProject01 -> (reference) LibraryProjectSub01 & LibraryProjectSub02
  • LibraryProjectSub01 ->(reference) LibraryProjectSuper01 & LibraryProjectSuper02

Migration Procedure of above projects: Migrate Projects in following sequence:

  1. LibraryProjectSuper01
  2. LibraryProjectSuper02
  3. LibraryProjectSub01
  4. LibraryProjectSub02
  5. MelodyProject01

Launch the Migration

Note: Project Migration has been enhanced: "Refresh all Representations" and "Fix filters on all Representations" are not required for migration process. However, they are still available to repair / re-synchronize diagrams in the project life.

Capella project migration is run globally. To do so, use the contextual menu available on the Eclipse project containing the model.

A reminder asks to manually make a versioned copy (baseline) of the model before running migration. Capella creates backup files before performing migration to go back in case of migration problems, even if models are not managed in source control. Please check the option Backup models before the migration.

A dialog shows the progress. The model may be opened automatically several times by the migration.

Notes:

  • Migration process has been enhanced for more performances.
  • Do not try to interfere here, even though it takes a moment before the UI shows a dialog.


Capella 0.8.3 migration job.png


The result is the following. The ".old" files can be deleted if everything went ok.

Open the model as usual to check everything is fine.


Capella 0.8.3 migration result.png


Reminder:

  • For big models, it is recommended to close Capella and restart it if necessary
  • It is recommended to check-in, then baseline, all files closing Capella and restarting it before starting working.

Optional Commands

"Fix Custom Features" Command

In contruction...

"Refresh all Representations" Command

Open model session, right click on aird file and select contextual menu "Refresh all Representations":


Capella 0.8.3 refresh representations.png


Capella 0.8.3 refresh update.png


Capella 0.8.3 refresh job.png


Some diagrams are updated with semantic Capella updates:


Capella 0.8.3 refresh sbrowser.png


Save the model.

"Fix Filters on all Representations" Command

In contruction...

Additional Information

Capella version Vi ensures project migration for a model done on version V(i-1) (or V(i-j) in case of no modification made on metamodel and diagram analysis specification).

So, before installing latest Capella version Vi, all project shall be migrated in each intermediate version.

For instance, in case new delivered release is V1.1, for a project made previously with Capella V0.8.3, end user shall:

  • First, install Capella intermediate version V1.0 for instance and run migration process to migrate project from V0.8.3 towards V1.0
  • Then, install latest release (i.e. V1.1) and run migration process to migrate project from V1.0 towards V1.1

Note: It is possible to check the current version of a model, right clicking on the .melodymodeller file.

Uninstallation Procedure

To uninstall Capella:

  • Check there is no useful remaining workspace in Capella installation directory
  • Remove the Capella installation directory