Capella/Extensions/Installation Guide

From Wiki
Jump to: navigation, search

Log of Changes


Log of Changes
Revision Date Modification
001 2015/02/19 Initial version of the document.


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.

Document Overview

This document is intended for persons in charge of installing extensions for Capella such as addons and viewpoints. It describes the installation and configuration of thereof.

Installation Procedures

Prerequisites Needed for Install

For successful installation of extensions, 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

The extensions for Capella requires the installation of the following software:

  • Capella : For Capella installation, please refer to this guide.

Note: In order to ensure the compatibility of an extension with a given version of Capella, please check the addons or viewpoints page.

Addons

Installation procedure is the same for all addons.

As Dropin

To manually install your addon:

  • Download the addon as a dropin
  • Extract the contents of the downloaded archive into <CAPELLA_INSTALLATION_DIR>/eclipse/dropins directory

Check the extraction process has finished without error.

  • Start Capella

As Update Site

  • Download the addon as an update site
  • Start Capella
  • Open Help using the menu toolbar
  • Select Install New Software
  • A wizard is displayed
  • Click on Add button
  • Click on Archive... button
  • Select the downloaded addon archive and press OK
  • Give it a name and press OK
  • Click on Select All button then Next
  • Agree and click on Finish
  • Restart when prompted

Verification

The following procedure for verifying the well installation of addons makes the hypothesis that Capella is well installed and fully functional i.e. that all the Capella installation verification procedure has been run with success.

Plugins Verification

  • Start Capella
  • Open Help using the menu toolbar
  • Select About Capella
  • Select Installation Details
  • Select Plugins tab
  • Scroll down the list

Check that the plugins that correspond to the addon are displayed.

Usage Verification

Viewpoints

Installation Procedure

Viewpoints for Capella are released as dropins. The installation procedure for viewpoints is thus the same for all viewpoints.

  • Download a viewpoint on Capella website
  • Extract the contents of the downloaded archive into <CAPELLA_INSTALLATION_DIR>/eclipse/dropins directory
  • Start Capella
  • Open the Viewpoint Manager view using Window menu then Show View and Other...
  • Select Viewpoint Manager in Kitalpha directory and press OK
  • The Viewpoint Manager view is displayed

The viewpoints available in the platform are listed in this view.

  • If using Capella version < 1.0.x
    • Right-click on the name of a viewpoint and select Start in order to start the viewpoint
  • If using Capella version > 1.0.x
    • Select any model element (diagram element, element in the project explorer) related to your project
    • Right-click on the name of a viewpoint and select Reference in order to start the viewpoint

Basic Mass Viewpoint

Plugins Verification

  • Open Help using the menu toolbar
  • Select About Capella
  • Select Installation Details
  • Select Plugins tab
  • Scroll down the list

Check that Mass viewpoint plugins are listed.

Usage Verification

  • Open the Viewpoint Manager view
  • Right-click on the mass label in the Name column and select Start in order to start the viewpoint
  • Create a Capella project using File menu then New and Capella Project
  • In the project overview, select the Physical Architecture
  • Expand Allocate Physical Functions to Physical Components
  • Create a Physical Architecture Blank [PAB] diagram
  • Click on the Layer button in the toolbar of the diagram
  • Select mass in the drop-down menu to activate the layer

Check that in the palette, a new set of entries named mass has appeared and contains one tool.

  • Click on the mass tool in the palette and click anywhere in the diagram

Check that a mass orange box is displayed and named Current: 0 - Max: 0

  • Click on the mass element in the diagram and open the Properties view
  • Select Basic Mass field
  • Change the value to 30 for example and press ENTER

Check that the mass element in the diagram has become red

  • Change the max value to 30 and press ENTER

Check that the mass element in the diagram has become dark orange

  • Change the max value to 50 and press ENTER

Check that the mass element in the diagram has retreived its initial color.

  • Create a Physical Component in the diagram
  • Create a mass element on this component
  • Replay the previous test

Basic Price Viewpoint

Verification procedure is the same as for Mass viewpoint.

  • Consider Price instead of Mass for plugins,
  • Consider Price instead of Mass for the viewpoint name in the Viewpoints Manager view, in the Layer of the diagram, and in the palette Tools.

Price concept applies to the same model elements as for Mass.

Basic Performance Viewpoint

Verification procedure is the same as for Mass viewpoint.

  • Consider Performance instead of Mass for plugins,
  • Consider Performance instead of Mass for the viewpoint name in the Viewpoints Manager view, in the Layer of the diagram, and in the palette Tools.

Performance concept applies to the same model elements as for Mass.