Capella 2024.1 Virtual Features
Guide

Copyright © Maplesoft, a division of Waterloo Maple Inc.
2024

Capella 2024.1 Virtual Features Guide

ContentsPreface ........................................................................................................ vii
1 Introduction ................................................................................................. 1
1.1 Scope and Purpose of this Document .......................................................... 1
1.2 Perquisite Knowledge .............................................................................. 1
1.3 Motivation for Using MapleMBSE Virtual Features ...................................... 1
1.4 Importing the MapleMBSE Ecore .............................................................. 2
1.5 General Syntax for the MapleMBSE Virtual Features .................................... 22 Relations ..................................................................................................... 5
2.1 abstractTraceTargetElement ...................................................................... 5
Description ............................................................................................ 5Syntax .................................................................................................. 5
Using the abstractTraceTargetElement Virtual Feature ................................... 5Example ................................................................................................ 6
2.2 referencingElements ................................................................................ 7
Description ............................................................................................ 7Syntax .................................................................................................. 7Using the referencingElements Virtual Feature ............................................. 7Example ................................................................................................ 72.3 capellaIncomingRelation .......................................................................... 7Description ............................................................................................ 7Syntax .................................................................................................. 8Using the capellaIncomingRelation Virtual Feature ....................................... 8Example ................................................................................................ 82.4 capellaOutgoingRelation .......................................................................... 8Description ............................................................................................ 8Syntax .................................................................................................. 9Using the capellaOutgoingRelation Virtual Feature ....................................... 9Example ................................................................................................ 93 Recursion .................................................................................................. 113.1 recursiveElements ................................................................................. 11Description .......................................................................................... 11Syntax ................................................................................................ 11
Using the recursiveElements Virtual Feature ............................................... 11Example .............................................................................................. 12Index .......................................................................................................... 15iii

iv • Contents

List of Figures
Figure 2.1: abstractTraceTargetElement Example .................................................. 6Figure 3.1: recursiveElements Example ............................................................. 12v

vi • List of Figures

Preface
MapleMBSE Overview
MapleMBSE™ gives an intuitive, spreadsheet based user interface for entering detailed
system design definitions, which include structures, behaviors, requirements, and parametricconstraints.

Related Products
MapleMBSE 2024 requires the following products.
• Microsoft® Excel® 2010 Service Pack 2, Excel 2016 or Excel 2019.
• Oracle® Java® SE Runtime Environment 8.
Note: MapleMBSE looks for a Java Runtime Environment in the following order:
1) If you use the -vm option specified in OSGiBridge.init (not specified by default),
MapleMBSE will use it.
2) If your environment has a system JRE ( meaning either: JREs specifed by the environment
variables JRE_HOME and JAVA_HOME in this order, or a JRE specified by the Windows
Registry (created by JRE installer) ), MapleMBSE will use it.
3) The JRE installed in the MapleMBSE installation directory.
If you are using IBM® Rational® Rhapsody® with MapleMBSE, the following versions
are supported:• Rational Rhapsody Version 8.1.5, 8.3 and 8.4• Teamwork CloudTM server 19.0 SP4 or 2021.x
If you are using Eclipse CapellaTM with MapleMBSE, the following version is supported:• 5.1.0 or 5.2.0
If you are using EclipseTM,the following version is supported:• 2020-3
Note that the architecture of the supported non-server products is 64-bit.

vii

viii • Preface

Related Resources
ResourceDescription
System requirements and installation instructions forMapleMBSE Installation MapleMBSE. The MapleMBSE Installation Guide is available
Guidein the Install.html file located either on your MapleMBSE
installation DVD or the folder where you installed MapleMBSE.
MapleMBSE Applications Applications in this directory provide a hands on demonstrationof how to edit and construct models using MapleMBSE. They,
along with an accompanying guide, are located in the Applicationsubdirectory of your MapleMBSE installation.
MapleMBSE Configuration This guide provides detailed instructions on working withGuide
configuration files and the configuration file language.
MapleMBSE User Guide Instructions for using MapleMBSE software. The MapleMBSE
User Guide is available in the folder where you installed
MapleMBSE.
Frequently Asked
You can find MapleMBSE FAQs here:Questions
https://faq.maplesoft.com
Release Notes
The release notes contain information about new features, known
issues and release history from previous versions. You can findthe release notes in your MapleMBSE installation directory.

For additional resources, visit http://www.maplesoft.com/site_resources.

Getting Help
To request customer support or technical support, visit http://www.maplesoft.com/support.

Customer Feedback
Maplesoft welcomes your feedback. For comments related to the MapleMBSE productdocumentation, contact doc@maplesoft.com.

1 Introduction
1.1 Scope and Purpose of this Document
The purpose of the MapleMBSE Virtual Features Guide is to describe MapleMBSE virtualfeatures and explain how to use them.
The intended audience for this document are users who are familiar with UML, Capellaecore and Model-based Systems Engineering concepts and who intend to create their own
MapleMBSE configuration files.

1.2 Perquisite Knowledge
To fully understand the information presented in this document the reader should be familiar with the following concepts:• Basic understanding of Capella and UML ecore to know the Classifiers, attributes andreferences. A correct mse configuration file has within each qualifier a concrete UML
eClassifiers and each dimension should be accessed using a non-derived StructuralFeaturedefined in the UML.ecore or a virtual one inside this guide.
• MapleMBSE Configuration Language elements (especially dimension and qualifiers,
and the syntax for importing the MapleMBSE ecore). For more information on theMapleMBSE Configuration language, see the MapleMBSE Configuration Guide.

1.3 Motivation for Using MapleMBSE Virtual Features
Capella manages different architectural level and updates the models consistently maintaining
the model complexity and traceability between the elements. Maintaining the same using
MapleMBSE requires users to enter various information that might not be required or relevantwhen working with Capella directly.
An end user, defined as a user who will be updating model information using theMapleMBSE spreadsheet interface but likely will not be involved in creating or editing
configuration files, who is interested in taking advantage of the modeling capabilities ofARCADIA, should not need to know its complexities. MapleMBSE helps to hide thiscomplexity
from the end user, through virtual features. They are called virtual features because, although
they extend the capabilities of native Capella Ecore, they themselves are not part of Capella
Ecore.
With the right choice of labels within an Excel template and a well-designed configura-1

2 • 1 Introductiontion(.mse) file that implements MapleMBSE virtual features, an end user can enter a couple
of inputs in a spreadsheet and create Capella Elements and linking them, or Ports and othercombinations of elements

1.4 Importing the MapleMBSE Ecore
Loading MapleMBSE virtual features is analogous to the way you would load UML
Structural Features using UML Ecore. The corresponding MapleMBSE Configuration
Languageuses import-ecore.
The general syntax isimport-ecore "URI"
For example, to specify the Capella ecore:"http://www.polarsys.org/capella/core/modeller/5.0.0""http://www.polarsys.org/capella/core/ctx/5.0.0""http://www.polarsys.org/capella/core/la/5.0.0""http://www.polarsys.org/capella/core/cs/5.0.0""http://www.polarsys.org/capella/core/information/5.0.0""http://www.polarsys.org/capella/core/core/5.0.0""http://www.polarsys.org/capella/core/oa/5.0.0""http://www.polarsys.org/capella/core/fa/5.0.0""http://www.polarsys.org/capella/core/pa/5.0.0"
To specify the MapleMBSE ecore:"http://maplembse.maplesoft.com/common/1.0""http://maplembse.maplesoft.com/capella/1.0"
You must create an alias for the ecore using the syntax:
import-ecore "URI" as Alias
For example, to specify an alias for the MapleMBSE ecore:
import-ecore "http://maplembse.maplesoft.com/capella/1.0" asmse
This allows you to use the short form, mse, instead of the whole syntax.

1.5 General Syntax for the MapleMBSE Virtual Features
The general syntax for the virtual features is[./]?alias::virtualfeature
The first character can be a dot, a forward slash, or a blank. There is no strict rule of thumbfor this. For specific syntax, see the Syntax subsection for each virtual feature.
alias - This is the alias for the ecore importvirtualfeature - This is the virtual feature name you want to use. For example, abstractTraceTargetElement.

1.5 General Syntax for the MapleMBSE Virtual Features • 3

4 • 1 Introduction

2 Relations
This section contains all other virtual features that do not create elements but offer a better
alternative to access and map model information.

2.1 abstractTraceTargetElement
Description
An abstractTraceTargetElement is used between two model elements to represent
a relationship where the owner of the element is the source and the target element is givenby the user.

SyntaxThe general syntax for using the abstractTraceTargetElement virtual feature is as follows:/mse:: abstractTraceTargetElement
This virtual feature is used while querying a model element that has to be assigned as target
to the relation that is being created and is used in a dimension where the relation is being
querried.

Using the abstractTraceTargetElement Virtual Feature
In general, the following steps outline how to use abstractTraceTargetElement:
1. It should be used when a relationship with sourceElement and targetElement is queried.
2. When querying the model element with mse:: abstractTraceTargetElement, the reference
decomposition should be to a target element. The element in the previous dim is assigned
as source.

56 • 2 Relations

ExampleFigure 2.1: abstractTraceTargetElement Example

2.2 referencingElements • 7

2.2 referencingElements
Description
It is only possible to query elements from an owned relation to the target elements. Thisvirtual feature can query the opposite reference of a relation such as Component Exchange,Functional Exchange etc.,. Using this feature you can create queries to get to the source ofa relation from the target element. The types of Capellarelations supported by this feature are information flows, requirement trace and activity
edges. This feature can be used to only query the elements from the model adding newelements with relations are not supported.

Syntaxalias::referencingElements

Using the referencingElements Virtual Feature
1. Referencing elements should be used only when querying the opposite references forelements linked with relations.
2. It is necessary to add the Classifier in the query for referencing elements to filter basedon the element type should be displayed

Example2.3 capellaIncomingRelation
Description
Adding new Capella relations between elements requires users to provide both the source
and target of the relations. Even though this is desirable in some cases most Capella relations
have the owner as the source element. The capellaIncomingRelation virtual feature will bealways assigned the owner of the relation to be the source. With this feature the user is not
required to add redundant information about the source when adding new relations.8 • 2 Relations

Syntax.alias::capellaIncomingRelation

Using the capellaIncomingRelation Virtual Feature
1. This feature has to be used with the CapellaIncomingRelation dimension as shown inexample.
2. Add reference-query and reference decomposition to add/edit the relations.

Example2.4 capellaOutgoingRelation
Description
Adding new Capella relations between elements requires users to provide, both the source
and target of the relations. Even though this is desirable in some cases, most Capella relations

2.4 capellaOutgoingRelation • 9have the owner as the source element. The capellaOutgoingRelation virtual feature will bealways assigned the owner of the relation to be the source. With this feature the user is not
required to add redundant information about the source when adding new relations.

Syntax.alias::capellaOutgoingRelation

Using the capellaOutgoingRelation Virtual Feature
1. This feature has to be used with the CapellaOutgoingRelation dimension as shown inexample.
2. Add reference-query and reference decomposition to add/edit the relations.

Example10 • 2 Relations

3 Recursion
This section contains all other virtual features that do not create elements but offer a better
alternative to access and map model information.

3.1 recursiveElements
Description
The recursiveElements virtual feature works as a chained data source, traversing all
sub elements recursively under the owner data source or QPE and then filters out elements
matching the qualifier and filter.
Note: This virtual feature is read-only in the sense new elements cannot be added, but useful
to set and remove references.

SyntaxThe general syntax for using the recursiveElements virtual feature is as follows:/mse:: recursiveElements

Using the recursiveElements Virtual Feature
In general, the following steps outline how to use recursiveElements:
1. It should be used when a flat list of all the sub-elements from a top-level element or Architecture should be displayed. Example to list all System Functions from System Architecture level or from Root System Function.
2. When querying the model element with mse:: recursiveElements it can beused at the data-source Level or inside a dim.
3. When using recursiveElements specify the type of element to be displayed in the Qualifier. For example, /mse::recursiveElements[la::LogicalFunction]

1112 • 3 Recursion

ExampleFigure 3.1: recursiveElements Example

3.1 recursiveElements • 13

14 • 3 Recursion

IndexRrecursion, 11
recursiveElements, 13
description, 11
syntax, 11
relations, 5absractTraceTargetElement, 5
abstractTraceTargetElement
description, 5
syntax, 5
using, 5, 11
referencingElements, 715

16 • Index