Skip to main content
Jump to: navigation, search

Difference between revisions of "Capella/Installation Guide"

m (Capella Installation)
m
Line 1: Line 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''')
 
* <code>Fixed</code> font is applied to expressions and texts of ASCII (<code>C:\My documents\Path</code>)
 
* ''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 =
 
= Capella Installation =
 
[https://github.com/eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.mediawiki#table-of-contents]
 
[https://github.com/eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.mediawiki#table-of-contents]
  
== Installing extensions==
+
== Installing extensions ==
  
 
Viewpoints and addons can be found on [https://www.polarsys.org/capella/addons.html Capella addons page].
 
Viewpoints and addons can be found on [https://www.polarsys.org/capella/addons.html Capella addons page].
  
 
To install these extensions, please follow this [https://github.com/eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.mediawiki#Configuration_and_Extensibility].
 
To install these extensions, please follow this [https://github.com/eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.mediawiki#Configuration_and_Extensibility].
 
= 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 [https://polarsys.org/wiki/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 =
 
= Migration of an Existing Project =
 
+
[https://github.com/eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.5.%20How%20to%20migrate%20Capella%20projects.mediawiki]
== Overview ==
+
 
+
What is performed in a global project migration?
+
 
+
# The tool locates all .melodymodeller files at the root of the Eclipse project and migrate them (including all fragments located in the /fragment folder)
+
# The tool locates all .aird files at the root of the Eclipse project and migrate them (including all fragments located in the /fragment folder)
+
# The tool locates all .pattern files at the root of the Eclipse project and migrate them
+
# 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:
+
 
+
{| border="1" cellpadding="15" cellspacing="0" style="border-collapse:collapse;"
+
|<code>
+
CAPELLA_HOME\eclipse.exe  -clean -vmargs -Xms768m -Xmx768m -XX:PermSize=256m -XX:MaxPermSize=256m -XX:+CMSPermGenSweepingEnabled -XX:+CMSClassUnloadingEnabled
+
</code>
+
|}
+
 
+
Or in some cases:
+
 
+
{| border="1" cellpadding="15" cellspacing="0" style="border-collapse:collapse;"
+
|<code>
+
CAPELLA_HOME\eclipse.exe  -clean -vmargs  -Xms128m -Xmx1550m -XX:MaxPermSize=100M -XX:+CMSPermGenSweepingEnabled -XX:+CMSClassUnloadingEnabled
+
</code>
+
|}
+
 
+
== Procedure while using Libraries ==
+
'''Follow below procedure if migration is required for Capella project referencing library project'''
+
 
+
<u>Consider an example as below:</u>
+
* MelodyProject01 -> (reference) LibraryProjectSub01 & LibraryProjectSub02
+
* LibraryProjectSub01  ->(reference) LibraryProjectSuper01 & LibraryProjectSuper02
+
 
+
<u>Migration Procedure of above projects: </u>
+
Migrate Projects in following sequence:
+
# LibraryProjectSuper01
+
# LibraryProjectSuper02
+
# LibraryProjectSub01
+
# LibraryProjectSub02
+
# MelodyProject01
+
 
+
== Launch the Migration ==
+
 
+
<u>Note:</u> 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.
+
 
+
<u>Notes:</u>
+
* 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.
+
 
+
 
+
[[Image: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.
+
 
+
 
+
[[Image:Capella_0.8.3_migration_result.png]]
+
 
+
 
+
<u>Reminder:</u>
+
* 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 =
+
 
+
== "Refresh all Representations" Command ==
+
 
+
Open model session, right click on aird file and select contextual menu "Refresh all Representations":
+
 
+
 
+
[[Image:Capella_0.8.3_refresh_representations.png]]
+
 
+
 
+
[[Image:Capella_0.8.3_refresh_update.png]]
+
 
+
 
+
[[Image:Capella_0.8.3_refresh_job.png]]
+
 
+
 
+
Some diagrams are updated with semantic Capella updates:
+
 
+
 
+
[[Image: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
+
 
+
<u>Note:</u> It is possible to check the current version of a model, right clicking on the .melodymodeller file.
+
  
 
= Uninstallation Procedure =
 
= Uninstallation Procedure =
 
+
[https://github.com/eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.ui.doc/html/Installation Guide/How to install Capella and Addons.mediawiki]
To uninstall Capella:  
+
* Check there is no useful remaining workspace in Capella installation directory
+
* Remove the Capella installation directory
+

Revision as of 08:33, 4 February 2021

Capella Installation

[1]

Installing extensions

Viewpoints and addons can be found on Capella addons page.

To install these extensions, please follow this [2].

Migration of an Existing Project

[3]

Uninstallation Procedure

Guide/How to install Capella and Addons.mediawiki

Back to the top