User manual

Embedded version

User manual is available by installing Capella:

Help > Help Content > Capella Guide.

Online version

This is the online version of the User Manual. It includes latest updates and may not fit with your installed version of Capella.

As this version is the embedded version displayed in an online environment, some links may be broken. You can probably search for the related mediawiki page using the search bar at the top of window looking for the displayed name of the link in this repository.

• Capella Guide
  • Release Notes
    • What's new
    • API changes
      • Capella 6.x to 7.x
        • Major changes
          • Migration to Eclipse 2023-03
          • Version major increased
          • Diagram capabilities
          • Semantic Browser
          • Migration
        • Raw API changes from 6.1.0 to 7.0.1
      • Capella 5.x to 6.x
        • Major changes
          • Migration to Eclipse 2021-06
          • Version major increased
          • JDK upgraded
          • Capella compatibility with Java 11
          • Image management
          • Rotative SVG images in diagrams
          • Semantic Browser
          • No backward compatibility
        • Raw API changes from 5.2.0 to 6.0.0
        • Raw API changes from 6.0.0 to 6.1.0
      • Capella 1.4.x to 5.x
        • Major changes
          • Migration to Eclipse 2020-06
          • Version major increased
          • Model file extension has changed
          • A JDK is now embedded
          • Pattern functionality removal
          • Capella is now compatible with Java 11
          • No backward compatibility
        • Raw API changes from 1.4.0 to 5.0.0
        • Raw API changes from 5.0.0 to 5.1.0
        • Raw API changes from 5.1.0 to 5.2.0
      • Capella 1.3.x to 1.4.x
        • Major changes
          • Migration from Eclipse Oxygen to Eclipse 2019-06
          • Project Explorer
          • New implementation for filtered trees
          • Clarification of CapellaAdapterHelper
          • Deprecation of org.polarsys.capella.common.ui.services
          • Refinement plug-ins have been removed; Projection plug-ins have been refactored
          • Changes for API users concerning the M2 modifications to make actors become generic components
          • Fusion Capella cross referencer and Sirius cross referencer
          • Replacement of some API classes/methods
          • Define basic activities for commands, diagram tools and activity explorer
          • No backward compatibility with Capella 1.4.0
          • Commandline arguments have been modified to be more consistent
        • Raw API changes from 1.3.1 to 1.4.0
        • Raw API changes from 1.4.0 to 1.4.1
        • Raw API changes from 1.4.1 to 1.4.2
      • Capella 1.2.x to 1.3.x
        • Major changes
          • Usage of Representations Descriptors instead of Representations
          • AQL instead of Acceleo2
          • Property tabs identifiers
          • Extensible Menus have been updated
            • Migrated menus
          • Menu visibility
          • Property Tester
        • Raw API changes from 1.2.0 to 1.3.0
        • Raw API changes from 1.3.0 to 1.3.1
      • Capella 1.1.x to 1.2.x
      • Capella 1.0.x to 1.1.x
    • Metamodel changes
      • Capella 6.x to 7.x
      • Capella 5.x to 6.x
      • Capella 1.4.x to 5.x
      • Capella 1.3.x to 1.4.x
      • Capella 1.2.x to 1.3.x
      • Capella 1.1.x to 1.2.x
      • Capella 1.0.x to 1.1.x
      • Capella 0.8.x to 1.0.x
    • Known issues
    • Dependency versions
  • User Manual
    • User Interface
      • Installation Guide
        • Prerequisites
          • Java Runtime Environment
        • Installation from previous version
        • Windows and Linux
        • Mac
        • Configuration and Extensibility
          • Update Sites
            • Command line update site installation
          • Dropins
          • Verification
          • Configuration strategies
            • Strategy 1: Single user installation
            • Strategy 2: Shared installation
            • Strategy 3: Several contexts with a shared installation
            • Recommendations for setting up multi-users configurations
        • Previous releases installation
        • Embed additional sample models
        • Post-installation steps
          • Migration of models
          • Additional Documentation References
          • Addon User Guide
        • Restrictions and Troubleshooting
          • Windows - Folder Long Path limitation
          • Windows - Missing libraries
          • Workaround to open the Help Content when there is problem with the browser
        • Uninstallation
          • Addon
            • Viewpoint
            • Update Sites
            • Dropins
          • Capella
      • Overview
        • Introduction to Capella
          • Overview
          • System and Software Architecture Definition in a Tool
          • A Methodological Guide in a Tool
        • Capella Ecosystem
          • Capella Tool Suite
      • Workbench Basics
        • Capella Workbench Concepts
          • Resources
          • Projects
          • Workspaces
          • Perspectives
          • Views
          • Editors
        • Understanding the Differences Between Models, Projects and Workspaces
          • Capella Model
          • Capella Project
          • Eclipse Workspace
        • Capella Configurability and Validation Profiles
          • Principles
          • Workspace Preferences
            • Setting Workspace Preferences
            • Importing/Exporting Workspace Preferences from workbench
              • Exporting Workspace Preferences
              • Exporting Validation Preferences
              • Importing Workspace Preferences
              • Example of export/import mechanism
              • Initializing Workspace Preferences with launch arguments (-EPF)
              • Example of initialization with -EPF
          • Capella Project specific preferences
          • Capella Configuration Project
            • Creating Capella Configuration Project
            • Referencing Capella Configuration Project
          • Validation Profiles
            • Creating Validation Profiles
            • Using Validation Profiles
        • Managing images
      • First steps with Capella
        • Starting Capella
        • How to Create a New Capella Project?
        • How to Import an Existing Project in a Workspace?
        • How to Copy or Export a Capella Project?
          • Copying a Project
          • Exporting a Capella Project
        • How to Migrate Capella Project
          • Special attention to image used in the project
            • How to properly migrate images
          • Project migration in command line
        • How to Detach Viewpoints from Capella Project?
          • The Viewpoints are Available and Installed in the Source Version
          • The viewpoints are not available and installed in the source version
        • How to rename a Capella Project?
        • How to import/create a Capella Project Example?
      • User Interface
        • Capella Perspective Overview
        • Workbench Manipulation - Tips and Tricks
          • Rearranging Parts
          • Maximizing and Minimizing Parts
          • View Manipulations
          • Perspective Manipulation
        • Activity Explorer
        • Project Explorer
          • Opening, Visualizing and Closing a Model
          • Appearance
          • Customizing the Content of the Project Explorer
          • Commands of the Contextual Menu
          • Synchronization with other Views
          • Search Field
        • Capella Diagram Editor
          • Introduction
          • Diagram Palettes
          • Diagram Toolbar
          • Diagram Element Toolbar
          • Matrixes
        • Capella Properties View
          • Introduction
          • Capella Section (Semantic Properties)
          • Description Section
          • Extensions Section
          • Management Section
        • Semantic Browser
          • View
          • Display Options
          • Actions
        • Information View
          • Categorization
          • Deleting Elements
          • Filters
          • Export
        • Status Line
        • Outline View
        • Change Recorder View
        • Fast Linker View
          • Introduction
          • How to Put a Model Element in the Fast Linker?
          • Link Creation Procedure
          • Additional Features
          • Multiple Selection
        • Transfer View
        • Mass Editing and Visualization
          • Introduction
          • Adding Elements
      • Diagram Management
        • Diagram Concepts
          • Common Diagram Properties
          • Diagram Refreshing Strategies
          • Blank and Contextual Diagrams, Contextual Diagram Elements
            • Blank Diagrams
            • Contextual Diagrams
            • Contextual Diagram Elements
          • Layout Management
            • Pin / Unpin Diagram Elements
            • Layout All - Layout Selection
            • Layout Children
            • Layout Connected Ports
        • Typology of Capella Diagrams
          • Class Diagrams
          • Mode State Diagrams
          • Breakdown Diagrams
          • Dataflow Diagrams
          • Architecture Diagrams
          • Interface Diagrams
          • Scenarios
        • Advanced Management of Diagrams
          • Synchronized and Unsynchronized Diagrams
          • Removing Hidden Elements from Diagrams
          • Example
        • Diagram Business Copy-Paste
          • Example of Logical Architecture Diagram
          • Example: Component External Interfaces Diagram
        • Creation of Functional Chains and Physical Paths
          • Functional Chains and Operational Processes
          • Physical Paths
          • Icon and label for overlapped Physical Paths/Functional Chains
        • Allocating Functions on Components
          • Allocating Leaves Functions
          • Insert/ Remove Allocated Functions
            • Represent Allocated Functions on parent Components
            • Represent parent Functions allocation
        • Computed Links
          • Computed Links between Parent Components
            • Computed Component Exchanges
            • Computed Physical Links
          • Computed Links between Parent Modes And States
            • Computed Transitions
      • Modelling Wizards and Accelerators
        • Modeling Accelerators
          • Component and Functional Exchanges
            • Illustration
          • Physical Links and Component Exchanges
            • Illustration
          • Exchange Item Propagation to Ports
            • Illustration
          • Port Realization According to Realizations Between Functional Exchanges
            • Illustration
          • Port Realization According to Realizations Between Component Exchanges
            • Illustration
          • Interface Generation from Allocated Functions
            • Illustration
        • Contextual Allocations
          • Example: Allocation of Activities and Functions to Entities, Actors, Components
        • Wizards
          • Generic Traceability Wizard
          • Logical Component Breakdown Decomposition Wizard
            • Use case
          • Sequence Message Creation Wizard for Interface Scenario
            • Use case context
            • Reuse mode
            • Create mode
          • Function Port and Exchange Item Allocation Wizard
            • Principles
            • Source Engineering Phase (SEP)
            • Target Engineering Phase (TEP)
            • Features
            • Validation Rules and Resolutions
        • Categories Management
          • Example: Creating a Component Exchange Category from a Selection of Component Exchanges
          • Example: Updating a Physical Link Category from a Selection of Physical Links
      • Model Analysis
        • Model Validation
          • Topology of Validation Rules
            • Structural conformance to core model
            • Integrity
            • Quality
            • Design
          • Usage and Validation Scopes
          • Validation Results
          • Example of Quick Fix
        • Impact Analysis
        • Metrics Computation
        • Progress Monitoring
          • Steps for Creating Project-Specific Progress Status
          • Setting Progress Status on Elements
            • Propagate Progress Status to all Capella Elements
            • Propagate Progress Status to Sub Representations
          • Clear Progress Status on Elements
          • Visualization of Progress Monitoring Information
        • Model Queries
          • Interpreter View
          • AQL Queries
            • Basic Model Queries
            • Diagram Queries
            • Searching Strings
            • Model Navigation Examples
            • Metrics
            • Advanced Queries
      • Search and Replace
        • Basic Search & Replace
          • Overview
          • Search Options
            • Model Element Scope
            • Find Pattern
            • Search Scope
            • Search and Replace Operations
          • Search Result
          • Replace Text Pattern
      • Tips and Tricks
        • Tab-Bar Actions Glossary
        • Element Selection
          • Automatic cursor selection of diagram elements
          • Connectors selection
          • Select only elements of container with ALT
        • Diagram Accelerators
          • Contextualize your diagram to selected model elements
          • Elements of Interest
          • Diagram accelerators
          • Initialize diagram
        • Unsynchronize Your Diagram
        • Layout Management
          • Diagram Cloning
          • Diagram template
          • Layout mode
          • Layout/style capella copy/paste (semantic)
          • Straighten to top
          • Layout actions
        • Diagram Exploration
          • Find an element in a diagram
          • Diagram outline
          • Scroll in a large diagram
          • Selection menu in diagram
          • Generic connection creation tool
          • Organize diagrams in Project Explorer by packages
            • By drag and drop
            • Via package tag
          • Visibility Mode - new Sirius layer to manage hidden graphical elements
          • Note as graphical link toward other diagram
          • Refresh many representations at once
          • 10. Title Blocks
        • Manage Routing Style
          • Via preferences
          • Via menus
          • Via right click on diagram
        • Other Layout Facilities
          • Elements alignment
          • Elements distribution
          • Layout commands to set edges with connected ports vertical or horizontal
          • Multi selection for graphical move of ports+exchanges
          • Snap back labels on edge selection
          • Display link between an edge and its label
          • Copy Paste Of Notes
          • Add vertical blank space on sequence diagrams
        • Element Size Management
          • Duplicate size
          • Autosize
        • Element Characteristics Management
          • Anchor on inner element border
          • Hide/modify container borders
          • Hide container icon
          • Hide/modify container label
          • Change label appearance
          • Hiding elements
          • Reveal hidden elements
          • Delete element from diagram/model
        • Diagram Editor View Management
          • Reset origin
          • Zoom on diagram
        • Diagram Elements Placement
          • Display the grid
          • Snap to grid
          • Snap to shapes
        • Diagram Export and Printing
          • Export as image
          • Batch image export
          • Print area preview
        • Other Shortcut Keys
          • Search
          • Tools
          • Resizing elements
          • Moving elements
        • Navigation Menu
        • Mass Editing and Visualization
        • Filtering of Capella capabilities
        • Description Section
        • Diagram Element Color Management
    • Command Line Support
      • Overview
      • Command Line Application Examples
        • Model Validation
        • Export as ZIP (Deprecated, use the parameter -exportZip instead)
        • Migration
        • Refresh Representations
        • Remove Hidden Elements from Representations
        • Export Representations as Images
      • Migration and Post-Migration script example
    • Filtering Capella capabilities
      • Deactivating Capella capabilities via the Capabilities preference page
      • Sharing the Capella capabilities configuration with other users
    • Fragment management
      • Why splitting Models into Fragments?
      • Available Elements
      • The Fragmentation Command
      • Creation of a Default Representation Fragmentation
      • Unfragmentation Command
    • Iterative Transitions
      • Concepts
        • Overview
        • What is Done During an Iterative Transformation?
        • More About Iterative Transformation
          • The Tranformation Engine
          • Automated Changes Detection
        • Update
      • Transitions Between Engineering Phases
        • Overview
        • Transition Entry Points
          • Data Transition
          • Exchange Item Transition
          • State Machine Transition
          • Interface Transition
          • Operational Activity Transition
          • Operational Entity Transition
          • Operational Capability Transition
          • Functional Transition
          • Actor Transition
          • System to Logical System Transition
          • LC / LA to PC / PA Transition
            • Breakdown Strategy
            • Leaf Strategy
          • Port Transition
      • Examples of Iterative Transitions Between Engineering Phases
        • Basics (Containment and Property Changes)
          • Overview
          • Performing the First Transition
          • Adding an Element in the Source
          • Removing an Element in the Source
          • Removing an Element in the Target
          • Renaming an Element in the Source
          • Moving an Element in the Source
        • Advanced (Linked Elements i.e. Out of Containment)
          • Overview
          • Performing the First Transition
    • Model Diff/Merge
    • Preferences
      • Sirius
        • Diagram Preferences
      • Capella
        • Appearance
        • General
        • Delete
        • Diagram
          • Process/Chain/Path Display
          • Title Block
        • Model
        • Model Change Recorder
        • Model Validation
        • Project Explorer
        • Refinement
        • SCM
        • Transfer Viewer
        • Transitions/Generation
        • Commands & User Profiles
          • Capella Commands Preferences
          • Capella User Profiles Management
        • Usage Monitoring
      • Activity Explorer
    • Properties
      • Operational Analysis
      • Operational Activity
      • Entity / Operational Actor
      • Operational Process
      • Interaction
      • Operational Capability
      • Constraint
      • Functional Exchange
      • Function Output Port
      • Functional Chain
      • Scenario Reference
      • Mode
      • System / Actor
      • System Capability
      • Mission
      • Logical Architecture
      • Logical Component / Actor
      • Logical Function
      • Physical Architecture
      • Physical Component / Actor
      • Physical Function
      • Physical Link
      • Physical Path
      • Physical Port
      • Configuration Item (COTS / CS / HW / Interface / ND / PrimeItem / System)
      • Title Block
    • Replicable Elements and Libraries
      • Replicable Elements
        • Introduction
          • Definitions
          • Examples
        • Basic REC-RPL Use Case
          • Creation of a REC
          • Instantiation of a REC
          • Copy-Paste Layout
        • Updates Between REC and RPL
          • Update of a REC from its SOURCE
            • Add/remove suffix on elements of the REC
          • Update of a RPL from its REC
          • Update of a REC from its RPL
        • Deletion of RPL
          • Delete RPL and Related Model Elements
          • Delete RPL and Preserve Related Model Elements
        • Validation of RPL
          • Compliancy of RPL
        • REC-RPL Advanced Features
          • Management of Composition of REC-RPL
          • Promotion of a REC to a Library
        • Re/updateconnections
          • Update Connections
      • Libraries
        • Introduction
          • Concepts
        • Basic Use Case
          • Creation of a Library
          • Referencing a Library
          • Using Library Elements from a Project
        • Usage with Replicable Elements
          • Concepts
        • Usage Restrictions
          • Libraries Usage Restriction
          • Nominal Case vs Downgraded Case
        • Advanced Operations
          • Unreference a Library
    • Task and application lifecycle management
    • Version Control with GIT
      • Introduction
        • Introduction to Git
          • Clone an existing Git repository
          • Commit / check out and push / fetch
          • Working with several people
        • Introduction to eGit
          • Git Repositories
          • Git Staging
          • History
          • Capella Project Explorer
        • Capella GIT integration
      • Tutorials
        • Basic Tutorial
          • Git perspective
          • Creating Repositories
          • Clone a Git repository
          • Share a Capella model on Git and commit a first version
          • Retrieve model from a Git repository
          • Perform a new commit, retrieve history, compare versions
          • Retrieve a new version
          • Merge conflicts
        • Advanced Tutorial
          • Create a tag
          • Resolve Conflicts
          • Fragmented Model
          • Model with libraries
      • Limitations / Known Issues
    • Viewpoints
      • Introduction
      • Activation
      • Migration
  • Developer Manual
    • Introduction
    • Development environment
    • Capella Studio
      • Viewpoint Development
    • Tutorials
    • Reference
  • Diagrams
    • Common Diagram Tools
    • Activity Scenario
    • Capability Realization Blank
    • Capability Realization Refinement [DEPRECATED]
    • Class Diagram Blank
    • Exchange Scenario
    • Interface Scenario
    • Configuration Items Breakdown
    • Contextual Capability
    • Contextual Capability Realization Involvement
    • Contextual Component Detailed Interfaces
    • Contextual Component External Interfaces
    • Contextual Component Internal Interfaces
    • Contextual Mission
    • Contextual Operational Capability
    • Contextual System Actors
    • EPBS Architecture Blank
    • Functional Chain Description
    • Functional Scenario
    • Interface Diagram
    • Interfaces Diagram Blank
    • Logical Architecture Blank
    • Logical Component Breakdown
    • Logical Data Flow Blank
    • Logical Function Breakdown
    • Missions Blank
    • Missions Capabilities Blank
    • Modes & States [DEPRECATED]
    • Mode State Machine
    • Operational Activity Breakdown
    • Operational Activity Interaction Blank
    • Operational Capabilities Blank
    • Operational Entity Blank
    • Operational Entity Breakdown
    • Operational Interaction Scenario
    • Operational Process Description
    • Operational Role Blank
    • Package Dependencies
    • Physical Architecture Blank
    • Physical Component Breakdown
    • Physical Data Flow Blank
    • Physical Function Breakdown
    • Physical Path Description
    • System Architecture Blank
    • System Data Flow Blank
    • System Function Breakdown
  • Validation Rules
    • Design
      • Completeness
      • Consistency
        • Consistency
        • Compliance
      • Coverage
      • Well-formedness
        • Capabilities
        • Components
        • Data
        • Dataflows
        • Interfaces
        • Scenarios
        • State Machines
        • Use Cases
    • Integrity
    • Quality
    • Transition
      • Consistency
        • Components
        • Dataflows
        • Interfaces
        • Scenarios
        • State Machines
      • Justification
        • Generic
        • System Analysis
        • Logical Architecture
        • Physical Architecture
        • EPBS
  • Glossary
    • ACTOR (SYSTEM, LOGICAL, PHYSICAL)
    • COLLECTION VALUE
    • COLLECTION
    • COMBINED FRAGMENT
    • COMMUNICATION LINK
    • COMMUNICATION MEAN
    • COMPLEX VALUE
    • COMPONENT EXCHANGE
    • COMPONENT PORT
    • COMPONENT (GENERIC)
    • CONFIGURATION ITEM
    • ASSOCIATION (ASSOCIATION, AGGREGATION, COMPOSITION)
    • CONSTRAINT
    • DECISION
    • END PRODUCT BREAKDOWN STRUCTURE
    • ENUMERATION LITERAL
    • ENUMERATION PROPERTY LITERAL
    • ENUMERATION PROPERTY TYPE
    • ENUMERATION
    • EVENT
    • EXCHANGE CATEGORY
    • EXCHANGE ITEM ELEMENT
    • BEHAVIORAL PHYSICAL COMPONENT
    • EXCHANGE ITEM
    • FINAL STATE
    • FLOW
    • FORK FUNCTION
    • FORK PSEUDO STATE
    • FUNCTION PORT
    • FUNCTION (GENERIC)
    • FUNCTIONAL CHAIN
    • FUNCTIONAL EXCHANGE
    • IN FLOW PORT
    • BINARY EXPRESSION
    • IN-OUT FLOW PORT
    • INITIAL PSEUDO STATE
    • FUNCTION INPUT PORT
    • INTERATION USE (REFERENCE)
    • INTERATION (OPERATIONAL EXCHANGE)
    • INTERFACE
    • JOIN FUNCTION
    • JOIN PSEUDO STATE
    • LITERAL (NUMERIC, STRING, BOOLEAN, ENUMERATION)
    • LOGICAL ARCHITECTURE
    • BOOLEAN TYPE
    • LOGICAL COMPONENT
    • LOGICAL FUNCTION
    • Merge Function
    • MISSION
    • MODE
    • NODE PHYSICAL COMPONENT
    • NUMERIC TYPE
    • OPERATION
    • OPERATIONAL ACTIVITY
    • OPERATIONAL ACTOR
    • CAPABILITY REALIZATION
    • OPERATIONAL ANALYSIS
    • OPERATIONAL ENTITY
    • OPERATIONAL PROCESS
    • OUT FLOW PORT
    • OUTPUT FUNCTION PORT
    • PART
    • PHYSICAL ARCHITECTURE
    • PHYSICAL PORT
    • PHYSICAL LINK
    • PHYSICAL PATH
    • CAPABILITY (OPERATIONAL AND SYSTEM)
    • PHYSICAL FUNCTION
    • PHYSICAL QUANTITY
    • PROPERTY VALUE GROUP
    • PROPERTY VALUE
    • PROPERTY
    • REFERENCE (NUMERIC, STRING, EXPRESSION, ENUMERATION, BOOLEAN, COMPLEX VALUE)
    • REGION
    • ROLE
    • SCENARIO
    • CHOICE PSEUDO STATE
    • SEQUENCE MESSAGE
    • SHARED DATA
    • STANDARD PORT
    • STATE MACHINE
    • STATE
    • STRING TYPE
    • SUB SYSTEM
    • SUPER SYSTEM
    • SYSTEM ANALYSIS
    • SYSTEM FUNCTION
    • CLASS
    • SYSTEM (OF INTEREST)
    • TERMINATE PSEUDO STATE
    • TRANSITION
    • UNARY EXPRESSION
    • UNION
    • UNION
    • UNIT
    • VALUE PART
  • Thematic Highlights
    • Focus on constraints and opaque expressions
    • Focus on state machines
    • Functional Analysis to Interface Engineering
    • Performance Recommandations
    • Interfaces and Data Modeling in Capella
      • Introduction
      • Basic Constructs
      • Advanced Constructs
      • Methodological Recommendation
      • Appendix
    • Enhancements of the implementation of Actors