-
Notifications
You must be signed in to change notification settings - Fork 85
/
How to install Capella and Addons.html
436 lines (436 loc) · 30.2 KB
/
How to install Capella and Addons.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>How to install Capella and Addons</title>
<link type="text/css" rel="stylesheet" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css"/>
</head>
<body>
<h1 id="Prerequisites">Prerequisites</h1>
<p>For a successful installation of Capella, your computer must meet the following recommended requirements:</p>
<ul>
<li> 64 bit computer with Windows, Linux or Mac Operating System. (Linux and Mac have not yet been field-proven tested).</li>
<li> An unzip software such as 7-Zip or equivalent</li>
<li> 2 GHz processor</li>
<li> 4 Go RAM</li>
<li> 15 GB of available hard disk space</li>
</ul>
<p>
<b>Note:</b> If you intend to install a previous Capella release, follow installation instructions below but please consult the
<a href="#Previous_releases_installation">Previous releases installation</a> as there are some slight differences on previous Capella releases
</p>
<h2 id="Java_Runtime_Environment">Java Runtime Environment</h2>
<p>Starting from Capella 6.0, a JDK
<a href="https://adoptium.net" target="_blank">Temurin (from adoptium.net)</a> is directly embedded in the product. Having an additional Java environment on your machine is no longer a requirement.
</p>
<p>
<b>Note:</b> This distribution is a production-ready open-source build without legal requirement to subscribe to a commercial support contract and distributed under GNU General Public License, version 2, with the Classpath Exception (see
<a href="https://adoptium.net/about/" target="_blank">https://adoptium.net/about/</a>)
</p>
<p>
<b>Note:</b> Notice that only the embedded JDK has been field-tested.
</p>
<p>If however you want to use a different JDK version, you need to modify the <code>capella.ini</code> file at 3 places. The first one is to add on two lines <code>-vm</code> and a reference to your JDK location. The second one is to modify <code>-Dosgi.requiredJavaVersion</code> argument to point to your JDK version. The third one is to adapt the <code>-Dpde.jreProfile=JavaSE-17</code> line either to match the version of your JDK. Please refer to the following
<a href="https://wiki.eclipse.org/Eclipse.ini" target="_blank">link</a> for more information and
<a href="https://github.com/eclipse/capella/wiki/Dependency%20versions" target="_blank">compatibility</a> page.
</p>
<p>
<b>Note:</b> If you decide to use a JRE instead of the embedded JDK, please note that some capabilities will be disabled (e.g. the Java development capability in Capella or some capabilities coming from add-ons)
</p>
<h1 id="Installation_from_previous_version">Installation from previous version</h1>
<p>Before starting the installation, the target location of Capella must be cleaned:</p>
<ul>
<li>The previous Capella version must be correctly uninstalled (See related
<a href="#Uninstallation">Uninstallation</a> section)
</li>
<li>All manual patches/extensions must be removed</li>
</ul>
<h1 id="Windows_and_Linux">Windows and Linux</h1>
<ol>
<li>Download Capella and extract it in a given directory.</li>
<li>Installation shall be complete as long as it is extracted successfully.</li>
</ol>
<p><i>
<b>Note:</b> See
<a href="#Restrictions_and_Troubleshooting">Restrictions and Troubleshooting</a> below. (Some installation issues can occurs. e.g. due to 'Folder Long Path limitation' or 'Missing libraries')</i>
</p>
<ul>
<li>The Capella folder should contain two folders:
<ul>
<li>capella: the Capella modeling workbench with the executable of Capella</li>
<li>samples: the sample models</li>
</ul>
</li>
</ul>
<h1 id="Mac">Mac</h1>
<p>Since Capella hasn't been installed from Apple Store, it might not be runnable directly once downloaded and you will have to follow some additional instructions to make it runnable.</p>
<ol>
<li>Depending on you Mac configuration you may need to double click on the downloaded archive to extract or it will have extracted automatically when the download completes.</li>
<li>Using Finder drag the Capella to your applications folder.</li>
<li>Launch Terminal from your Applications > Utilities or using a spotlight search (CMD + Space)</li>
<li>In Terminal window, type: <code>xattr -d com.apple.quarantine /Applications/Capella.app</code></li>
</ol>
<p><span id="Addons-Installation"/><span id="Addons_Installation"/><span id="Addons Installation"/></p>
<h1 id="Configuration_and_Extensibility">Configuration and Extensibility</h1>
<p>Capella is extensible with addons that can be installed onto Capella to enrich its functionalities.</p>
<p>Before installing an addon, you shall think about how the Capella installation will be used. A common question is whether the installation is supposed to support several users or not. If it's the case, a possible configuration is to share the same installation of Capella with several users using independently different set of addons. Another possible configuration is to allow users to work on several contexts where they share common set of addons and configuration. To set up these configurations, several strategies are described in the
<a href="#Configuration_strategies">Configuration strategies</a>.
</p>
<p>Addons are installable as "update sites" or as "dropins".</p>
<ul>
<li>A dropins is an unzippable offline packaging (it is just a zip of all necessary files for a specific Capella version)</li>
</ul>
<ul>
<li>An update site
<i>can</i> embed more information than dropins to ensure addon compatibility with a given Capella version, to prevent installation of a feature if not all necessary dependencies are installed, or can dynamically retrieve dependencies over Internet. It can be distributed as an archive, an URL per Capella version or with a fixed URL depending on addon provider. With a fixed URL, the URL will commonly provide all versions of the addon at the same time and its Capella who will decide which version has to be installed.
</li>
</ul>
<p><i>
<b>Note:</b> A dropins, or a zipped update site offers often a more simpler deployable packaging than update sites through URL in operational projects, which can requires offline installation, requires network proxies or simply has to let administrator decide which version and when an addon has to be updated.</i>
</p>
<p><i>
<b>Note:</b> In both cases, dropins or update sites, make sure that the addon/extension is compatible with your current version of Capella and Capella projects lifecycle. (even if update sites seem to provide some consistency for a Capella installation, a ProjectX may require a dedicated x.y.z version of addon, and administrators shall manage their own Compatibility map per projects, to prevent unexpected updates of a shared Capella installation)</i>
</p>
<p><i>Compatibility information is commonly provided by the addon provider or for open source addons, marked aside the download release information (ex:
<a href="https://github.com/eclipse/capella-requirements-vp/releases" target="_blank">Requirement addon</a>)</i>
</p>
<p><i>
<b>Note:</b> After installation, please see
<a href="#Post-installation_steps">Post-installation steps</a></i>
</p>
<p><span id="Update Sites"/></p>
<h2 id="Update_Sites">Update Sites</h2>
<p>While archives allow by definition the offline installation capability, accessing update-sites via URL may require access to the Internet. Behind a proxy you may face some issues and require specific configuration on Capella Preferences > General > Network connections.</p>
<p>To install an update site:</p>
<ul>
<li>Launch Capella (based on the expected configuration, see
<a href="#Configuration_strategies">Configuration strategies</a>)
</li>
<li>Open Help using the menu toolbar</li>
<li>Select Install New Software</li>
<li>A wizard is displayed</li>
<li>Click on Add button</li>
<li>Click on Archive if the update site is packaged as a ZIP, or set URL if you have an URL link then Press OK</li>
<li>Click on the expected features to be installed, then Next.
<ul>
<li>
<i>Sometimes update sites provide several functionalities for a same addon and you can choose not to install some functionalities to your Capella installation. For instance, a XHTML Docgen contribution may not be installed unless you already have installed the XHTML Generation addon, or a Collaborative Feature should not be installed because it will not work without Team for Capella. Not selecting all the features of an update site doesn't prevent main functionalities to be fully working as expected.</i>
</li>
</ul>
</li>
<li>Agree license agreement and click on Finish</li>
<li>Restart when prompted</li>
</ul>
<h3 id="Command_line_update_site_installation">Command line update site installation</h3>
<p>An update site can also be installed through command line. </p>
<p>
<b>Install a feature from an update site</b>
</p>
<p><code>capellac.exe -repository {repository} -installIU {featureName} -application org.eclipse.equinox.p2.director</code></p>
<p>(replace {xxx} by corresponding values without brackets)</p>
<p><code>{repository}</code> is one of the following format</p>
<ul>
<li><code>file://unzipped-updatesite-folder/</code></li>
<li><code>jar:file:/updatesite.zip!/</code></li>
<li><code>
<a href="https://update-site.url" target="_blank">https://update-site.url</a></code>
</li>
<li><code>jar:
<a href="https://update-site.url.zip!/" target="_blank">https://update-site.url.zip!/</a></code>
</li>
</ul>
<p><code>{featureName}</code> is the name of a feature (see below)</p>
<p>
<b>List all features of an update site</b>
</p>
<p><code>capellac.exe -application org.eclipse.equinox.p2.director -repository {repository} -list "Q:everything.select(x | x.properties ~= filter('(org.eclipse.equinox.p2.type.group=true)'))"</code></p>
<p>(See additional query definition for -list at
<a href="https://wiki.eclipse.org/Equinox/p2/Query_Language_for_p2" target="_blank">Query Language</a>)
</p>
<h2 id="Dropins">Dropins</h2>
<p>Dropins are self-contained addons.</p>
<ul>
<li>Download the addon as a dropin.</li>
<li>Extract the contents of the downloaded archive into the expected dropins folder (see
<a href="#Configuration_strategies">Configuration strategies</a>)
</li>
<li>Start once Capella with <code>-clean</code> command line parameter to ensure that installation is properly updated.</li>
</ul>
<p>Make sure that the installed addon as dropin has a valid structure. </p>
<p>The structure is similar to:</p>
<ul>
<li><code>addonName\eclipse\plugins\*</code></li>
<li><code>addonName\eclipse\features\*</code></li>
</ul>
<p><i>
<b>Note:</b> The structure of dropin is different from an update site, preventing an update site from being installed as dropin as is. (There is some additional files <code>artifacts.jar</code> and <code>content.jar</code> or the folder hierarchy is different)</i>
</p>
<h2 id="Verification">Verification</h2>
<p>The following procedure for verifying the successful installation of addons</p>
<ul>
<li>Open
<b>Help</b> >
<b>About Capella</b>
</li>
<li>Select
<b>Installation Details</b>, you shall see features related to the newly installed addon.
</li>
<li>Open
<b>Window</b> >
<b>Show View</b> >
<b> Others </b> >
<b>General</b> >
<b>Error Log</b> view and verify there is not any error message relating to the installed add-on.
</li>
</ul>
<p><span id="Configuration strategies"/>
<span id="Multiuser_installation"/></p>
<h2 id="Configuration_strategies">Configuration strategies</h2>
<p>Capella provides different strategies for supporting multi-user installs. Each strategy is deployed based on three important locations: </p>
<ul>
<li>
<b>The install area</b>: the place where Capella is installed.
</li>
<li>
<b>The configuration area</b>: the place where Capella stores runtime meta-data (such as the set of installed plugins).
</li>
<li>
<b>The instance area</b>: the place where users store data.
</li>
</ul>
<h3 id="Strategy_1:_Single_user_installation">Strategy 1: Single user installation</h3>
<p>Single installation. This is the most basic configuration.
An user can use Capella, install some addons, that will be installed in the
<b>configuration</b> folder of the Capella installation.
</p>
<p>
<img border="0" src="Images/single.png"/>
</p>
<p>
<b>Particularities</b>
</p>
<ul>
<li>User shall have write access in installation folder when Capella is used.</li>
<li>Not applicable if several users are intended to use the installation.</li>
</ul>
<p>
<b>Setup</b>
</p>
<ul>
<li>Enabled by default, nothing to do.</li>
<li>If you choose to install add-ons using update sites, install them as described in
<a href="#Update_Sites">Update Sites</a>.
</li>
<li>If you choose to install add-ons using dropins, install them on <code>dropins</code> folder of Capella installation or in another location by adding the <code>-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=path/to/dropins</code> (no quotes) at the end of the <code>capella.ini</code> file.</li>
</ul>
<h3 id="Strategy_2:_Shared_installation">Strategy 2: Shared installation</h3>
<p>Multi users with a shared installation. Users will share a same installation of Capella which can be provided to them with a predefined-set of addons.</p>
<p>
<img border="0" src="Images/multiuser-simple.png"/>
<img border="0" src="Images/multiuser.png"/>
</p>
<p>
<b>Setup</b>
</p>
<ul>
<li>In <code>capella.ini</code> file, add the argument <code>-Dosgi.configuration.area=@user.home/xxx/capella/configuration</code>. (each user shall have a dedicated folder)</li>
<li>An administrator can install addons in the main installation of Capella that will be available for all users.
<ul>
<li>Create a dedicated <code>admin.ini</code> file, having the same content than <code>capella.ini</code> without the previously add line <code>-Dosgi.configuration.area</code></li>
<li>Launch Capella referencing the <code>admin.ini</code> file by using <code>--launcher.ini admin.ini</code> command line parameter. </li>
<li>If you choose to install add-ons using update sites, install them as described in
<a href="#Update_Sites">Update Sites</a>, they will be installed in <code>capellaInstallation/(configuration|p2|plugins|features)</code>
</li>
<li>If you choose to install add-ons using dropins, install them on <code>dropins</code> folder of Capella installation or in another location by adding the <code>-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=path/to/folder</code> (path without quotes) at the end of the <code>capella.ini</code> and <code>admin.ini</code> files.</li>
</ul>
</li>
</ul>
<ul>
<li>Users can now use the setup properly. If afterwards, you want to install new addons to users, just run Capella with <code>admin.ini</code> and install them.</li>
</ul>
<p><span id="Strategy_4_Multilevel_shared_configuration"/></p>
<h3 id="Strategy_3:_Several_contexts_with_a_shared_installation">Strategy 3: Several contexts with a shared installation</h3>
<p>A same installation of Capella can be used for several contexts (several teams, several separated models, etc) where users share a different set of addons per context.
An user can also be part of / working on several contexts.</p>
<p>
<img border="0" src="Images/multicontext-simple.png"/>
</p>
<p>
<b>Setup</b>
</p>
<ul>
<li>The administrator can install a predefined list of addons in the installation of Capella. Just launch capella and install them, from update sites or in dropins folder.</li>
</ul>
<ul>
<li>For each context, an administrator will define a dedicated folder to store configuration for the given context.
<ul>
<li>Create a dedicated <code>contextX_admin.ini</code> with an added line: <code>-Dosgi.configuration.area=somewhere/contextX/capella/configuration</code>. This file will be used by administrators when installing a new add-on for the <code>contextX</code></li>
<li>Create another dedicated <code>contextX.ini</code> with added lines <code>-Dosgi.sharedConfiguration.area=somewhere/contextX/capella/configuration</code> and <code>-Dosgi.configuration.area=@user.home/xxx/contextX/capella/configuration</code>. This file, used by users, is referring to the configuration of the <code>contextX</code> with <code>osgi.sharedConfiguration.area</code></li>
</ul>
</li>
</ul>
<ul>
<li>An administrator can install addons that will be available only for a working context:
<ul>
<li>Launch Capella referencing the <code>contextX_admin.ini</code> file by using <code>--launcher.ini contextX_admin.ini</code> command line parameter.</li>
<li>If you choose to install add-ons using update sites, install them as described in
<a href="#Update_Sites">Update Sites</a>, they will be installed in <code>somewhere/contextX/capella/(configuration|p2|plugins|features)</code>
</li>
<li>If you choose to install add-ons using dropins, install them on <code>somewhere/contextX/capella/dropins</code> location.
<ul>
<li>In <code>contextX.ini</code>, add also <code>-Dorg.eclipse.equinox.p2.reconciler.dropins.directory=somewhere/contextX/capella/dropins</code> to refer to the dropin location.</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>For each users and its working contexts, create a shortcut to <code>capella.exe</code> with <code>--launcher.ini path/to/contextX.ini</code> command line parameter. The user will be able to launch Capella with the set of addons predefined for all its working contexts.</li>
</ul>
<ul>
<li>Users can now use the setup properly. If afterwards, you want to install new addons to all contexts, just run Capella and install them, for one particular context, run Capella with one of the <code>contextX_admin.ini</code>.</li>
</ul>
<p><span id="Recommendations for setting up multi-users configurations"/></p>
<h3 id="Recommendations_for_setting_up_multi-users_configurations">Recommendations for setting up multi-users configurations</h3>
<p>
<b>Ensure that addons are properly installed before users encounter installation errors</b>
</p>
<p>After updating the installation of Capella or addons</p>
<ul>
<li>Do not forget to restart the application as requested while installation of Update sites, or by adding the option <code>-clean</code> in command line parameter.</li>
</ul>
<ul>
<li>It is recommended to launch once all your users client by adding a <code>-clean</code> in command line argument to ensure that configurations are updated properly for each users then check Error Log messages. Do not forget to remove this <code>-clean</code> parameter after this test to avoid starting performance issues.</li>
</ul>
<ul>
<li>It is recommended to start the application once with <code>-checkConfiguration</code> to ensure that the cache is up to date with the respect to the contents of the installed bundles.</li>
</ul>
<ul>
<li>It is recommended to switch to a new workspace, some information might have been cached in it (Java version, etc...).</li>
</ul>
<p>
<b>One user can be part of several working contexts</b>
</p>
<p>When working with several contexts, it is important to avoid mixing configuration between contexts for both <code>-Dosgi.sharedConfiguration.area</code> and <code>-Dosgi.configuration.area</code>. Both path must contain a <code>contextX</code> information. Afterwards, if a user is part of a new <code>contextY</code>, administrator will just have to provide a new launcher with <code>--launcher.ini contextY.ini</code>. The configuration will be located in a dedicated <code>contextY</code> folder and will not be mixed up with previous contexts.</p>
<p>
<b>Parent folder of configuration shall be dedicated to Capella</b>
</p>
<ul>
<li>Addons will be installed in the parent folder of the configuration area. When setting up <code>-Dosgi.configuration.area</code> or <code>-Dosgi.sharedConfiguration.area</code>, it is important to have a parent folder dedicated to capella. (<code>@user.home/capella-configuration</code> is a bad choice as <code>@user.home</code> will be polluted with other folders, whereas setting up <code>-Dosgi.configuration.area=somewhere/capella/configuration</code> is recommended, as addons will be installed in <code>somewhere/capella/(configuration|p2|plugins|features)</code>.</li>
</ul>
<p>
<b>Users can install its own addons</b>
</p>
<p>It is important to keep in mind that with all the described configurations above, an user can install its own addons in its configuration area. This can be useful, but sometimes not an expected installation. This can't be prevented by setting up the configuration, but administrators can setup read-only permissions to some predefined folders such as <code>@user.home/xxx/capella/(p2|plugins|features|dropins)</code>.</p>
<p>
<img border="0" src="Images/multicontext.png"/>
</p>
<p>
<b>Dropins can be installed once and reused across installations/configurations</b>
</p>
<p>When installing a dropins, it is possible to install all the dropins in a dedicated folder containing all addons and setup a <code>file.link</code>, a file referencing a specific dropins folder through a <code>path=path/to/dropin/folder</code> line.</p>
<p>For instance, it is possible to have several Capella installation or several contexts referencing dropins installed in another location.</p>
<p>
<img border="0" src="Images/dropins_link.png"/>
</p>
<p><span id="Previous releases installation"/></p>
<h1 id="Previous_releases_installation">Previous releases installation</h1>
<p>For older Capella releases, Capella will require a Java Runtime Environment 64 bits 1.8 installed on the computer: the recommended version is <code>jre-8u121-windows-X64.exe</code> or later.</p>
<p>Some changes since then:</p>
<p>- Execution and configuration files are called <code>eclipse.exe</code> (resp. <code>eclipse.ini</code>) rather than <code>capella.exe</code> (resp. <code>capella.ini</code>)</p>
<p>- In case Capella does not start, edit the eclipse.ini file and add two new lines before <code>-vmargs</code>:</p>
<ul>
<li><code>-vm</code></li>
<li><code><ABSOLUTE_PATH_TO_JAVA.EXE></code> (JRE/JDK 32 or 64-bits according to the version of Capella)</li>
</ul>
<h1 id="Embed_additional_sample_models">Embed additional sample models</h1>
<p>You can configure Capella to embed additional sample models.</p>
<p>Sample models are located aside the Capella installation folder, in a <code>sample</code> folder. If you package some additional samples here, they will be available to your users using Import > Capella Example > Capella Project Example.</p>
<p><span id="Post-installation steps"/></p>
<h1 id="Post-installation_steps">Post-installation steps</h1>
<h2 id="Migration_of_models">Migration of models</h2>
<p>If upgrading from a previous version, please read the model migration guide, as your older models may not be compatible right away with this new version.</p>
<ul>
<li>
<a href="/wiki/../help/topic/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.5.%20How%20to%20migrate%20Capella%20projects.html" title="../help/topic/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.5.%20How%20to%20migrate%20Capella%20projects.html">How to migrate Capella projects</a> <span class="github-link">
<a href="/wiki/../First_steps_with_Capella/3.5._How_to_migrate_Capella_projects.mediawiki" title="../First steps with Capella/3.5. How to migrate Capella projects.mediawiki">(online documentation)</a></span>
</li>
</ul>
<ul>
<li>If some viewpoints are no longer useful, you can look at
<a href="/wiki/../help/topic/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.6.%20How%20to%20detach%20viewpoints.html" title="../help/topic/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.6.%20How%20to%20detach%20viewpoints.html">How to detach viewpoints</a> <span class="github-link">
<a href="/wiki/../First_steps_with_Capella/3.6._How_to_detach_viewpoints.mediawiki" title="../First steps with Capella/3.6. How to detach viewpoints.mediawiki">(online documentation)</a></span>
</li>
</ul>
<h2 id="Additional_Documentation_References">Additional Documentation References</h2>
<ul>
<li>
<a href="/wiki/../help/topic/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.1.%20Starting%20Capella.html" title="../help/topic/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.1.%20Starting%20Capella.html">Starting Capella</a> <span class="github-link">
<a href="/wiki/../First_steps_with_Capella/3.1._Starting_Capella.mediawiki" title="../First steps with Capella/3.1. Starting Capella.mediawiki">(online documentation)</a></span>
</li>
</ul>
<ul>
<li>
<a href="/wiki/../help/topic/org.polarsys.capella.viewpoint.doc/html/activation/activation.html" title="../help/topic/org.polarsys.capella.viewpoint.doc/html/activation/activation.html">Viewpoints activation</a> <span class="github-link">
<a href="/wiki/../../../org.polarsys.capella.viewpoint.doc/html/activation/activation.mediawiki" title="../../../org.polarsys.capella.viewpoint.doc/html/activation/activation.mediawiki">(online documentation)</a></span>
</li>
</ul>
<h2 id="Addon_User_Guide">Addon User Guide</h2>
<p>Please refer to the Addon User Guide, there is maybe an additional How to install guide or some post installation steps in it.</p>
<p><span id="Restrictions and Troubleshooting"/></p>
<h1 id="Restrictions_and_Troubleshooting">Restrictions and Troubleshooting</h1>
<h2 id="Windows_-_Folder_Long_Path_limitation">Windows - Folder Long Path limitation</h2>
<p>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 long installation location. </p>
<p>In case the path is too long, some files can not be opened by Capella and this will cause errors (for instance Description editor may not work). Since the extraction will raise an error you should delete the partially extracted files and re-extract it.</p>
<p><i>
<b><b>Note:</b></b> To avoid unexpected errors, path of the Capella directory to the capella folder is limited to
<b>115</b> characters (<code><CAPELLA_INSTALLATION_DIR>/capella</code>). (a "space" character is counted like three characters (%20)''').</i>
</p>
<h2 id="Windows_-_Missing_libraries">Windows - Missing libraries</h2>
<p>If launching Capella in Windows OS ends up with the following pop-up, it means that your OS misses some libraries to be compatible with JDK 14.</p>
<p>
<img border="0" src="Images/LaunchingPopup.png"/>
</p>
<p>The solution is to install this Microsoft's update according to your OS version:
<a href="https://support.microsoft.com/en-us/help/2999226/update-for-universal-c-runtime-in-windows" target="_blank">https://support.microsoft.com/en-us/help/2999226/update-for-universal-c-runtime-in-windows</a>
</p>
<h2 id="Workaround_to_open_the_Help_Content_when_there_is_problem_with_the_browser">Workaround to open the Help Content when there is problem with the browser</h2>
<p>Sometimes due to security policy, the web browser has problem on opening local host web pages. This is the case of the Help Content page when it is accessed via the <code>127.0.0.1</code> IP address. </p>
<p>Here are 2 possible workarounds to overcome this problem:</p>
<ul>
<li>In the URL, replace <code>127.0.0.1</code> by <code>localhost</code>.</li>
<li>Copy the URL and paste it in another web browser without restriction.</li>
</ul>
<h1 id="Uninstallation">Uninstallation</h1>
<h2 id="Addon">Addon</h2>
<p>When uninstalling an addon in a multi users configuration, please read
<a href="#Recommendations_for_setting_up_multi-users_configurations">Recommendations for setting up multi-users configurations</a> and ensure that all your users have been properly updated after uninstallation.
</p>
<h3 id="Viewpoint">Viewpoint</h3>
<p>Notice that you can uninstall a viewpoint on a Capella installation, but your models may still reference it and will require it to be opened.</p>
<p>If your model no longer need this part of modeling capability, you can consider to 'unreference' the viewpoint from your model.</p>
<p>See
<a href="/wiki/../help/topic/org.polarsys.kitalpha.ad.doc/html/usersguide/viewpointmanager.html#Unreference" title="../help/topic/org.polarsys.kitalpha.ad.doc/html/usersguide/viewpointmanager.html#Unreference">Kitalpha - Architecture Framework Technology Guide > Viewpoint Technology > User's Guide > Viewpoint Manager</a> <span class="github-link">
<a href="/wiki/https://github.com/eclipse/kitalpha/blob/master/architecture%20description/doc/plugins/org.polarsys.kitalpha.ad.doc/html/usersguide/viewpointmanager.mediawiki#Unreference" title="https://github.com/eclipse/kitalpha/blob/master/architecture%20description/doc/plugins/org.polarsys.kitalpha.ad.doc/html/usersguide/viewpointmanager.mediawiki#Unreference">(online documentation)</a></span>
</p>
<h3 id="Update_Sites_2">Update Sites</h3>
<p>To uninstall an update site:</p>
<ul>
<li>Open
<b>Help</b> >
<b>About Capella</b>
</li>
<li>Select
<b>Installation Details</b>, click on features to be deleted and on the Uninstall button.
</li>
</ul>
<h3 id="Dropins_2">Dropins</h3>
<p>A dropins can be uninstalled by deleting it from the folder <code>dropins</code></p>
<h2 id="Capella">Capella</h2>
<p>To uninstall Capella, just delete it from your system.</p>
<p>If your installation is used by several users, it is recommended to delete all folders defined in
<a href="#Configuration_strategies">Configuration strategies</a> to ensure that configurations are properly cleaned if you upgrade Capella.
</p>
<p><code>somewhere/contextX/capella</code> or <code>@user.home/xxx/capella/configuration</code></p>
</body>
</html>