Capella adapter - User manual

Table of Contents

  1. Foreword
  2. General
  3. Getting Started
  4. Mode Selection and Control
  5. Normal Operations
  6. Supported Elements
  7. How to use the adapter
    1. Normal Termination
    2. Error Conditions
    3. Recover Runs
    4. Contextual menu
    5. Start the adapter
    6. Login tutorial

Foreword

This guide is to explain step by step the process to transfer values or objects from Capella to COMET.

Before continuing further, please be aware of the limits of the adapter and of the troubleshooting page in the event an error should happen during the process.

General

To install or update the adapter, follow these simple steps:

  • In a running instance of Capella go to the “Help” menu and choose “Install new software”.
  • Drag and drop the downloaded zip file to the dialog you have just open in Capella.
  • The adapter should now be listed as available to install, if not try by unchecking the “Show items by category” checkbox.
  • Select the adapter and press next to proceed to the installation.- After the installation is complete Capella will invite you to restart Capella to complete the installation.

To update an existing installation of the plugin, follow the exact same steps.

Getting Started

From the main window pressed the COMET® button and connect to a e-TM-10-25 model from the panel that just opened. Once this is done, you should be able to browse the ElementDefinition tree as well as the RequirementsSpecification tree. You can then now open a Capella model.

Mode Selection and Control

From the impact panel of the adapter plugin, it is possible to:

  • To switch transfer direction
  • To preview the net change
  • To visualize trees from both models
  • To create/load a mapping configuration

From the main panel of the adapter plugin, it is possible to:

  • To refresh the E-TM-10-25 session
  • To Connect/Disconnect from the E-TM-10-25 session
  • From the ribbon button, it is possible to:
  • To show/hide the hub panels
  • To display the local exchange history

Security wise, login to a E-TM-10-25 source can be done with your COMET® login/password which your model administrator can also provide.

Normal Operations

The Capella adapter lets you transfer elements in one or the other direction. When configuring a mapping from Capella to the Hub, you can define or redefine the target 10-25 element definition of each selected element from any Capella browser. But also redefine mapping by specifying element by element a different target element. The previous operations register themselves in a process where once you have defined what element to transfer to what element of destination, you have the possibility to preview the impact on the target model, but also to filter those impact view based on a selection from the source model. Then you can transfer your mapped values to their configured destination. When you choose to transfer, the mapped elements are then transferred to the configured target model. If among the mapped elements any relationship were mapped, the relationships that connect selected element will also be transferred at the same time. In the case anything goes wrong at this stage, you can cancel, and the adapter will delete every configured mapping in the state of pending to transfer. Then the adapter will reload and re-apply the current mapping configuration.

Supported Elements

See this page for more information on supported elements.

How to use the adapter

Normal Termination

After all transfer are complete the tree views are refreshed showing Parameters and Variables with their new value. From the main window terminating the program is simple in the way that any connection to the hub is closed by the program automatically.

Error Conditions

In the case of the Hub session cease to live, for example if the server is not responding, or the connection dropped, the attempted transfers will fail, and you will see a notification in the status bar.

Recover Runs

If the E-TM-10-25 server is not responding, you will notice it when attempting transfer in this direction or if you try to refresh the session. You might want to reconnect to the COMET® server the way you connect the first time. If there is any pending transfer to E-TM-10-25, you can attempt them, but you will most likely have to cancel the transfer is any error are raised.

In the case where a transfer fails, the defined mapping is lost if the mapped elements have never been transferred. After transferring some mapped elements and if no mapping configuration were loaded or created before. It is still possible to save the mapping by means of creating a new mapping configuration and letting the adapter add the mapped element to the configuration. It also possible to create a new mapping configuration to clear the current mapped elements.

The use of the adapter is separated in 3 main steps: Login to a Comet model, map elements from a domain to another (eg. Capella to Comet), and transfer.

Contextual menu

In the adapter every button and dropdown control have a tooltip. That means if you mouse over any of these some text will pop up with details on the overed control.

Start the adapter

  1. Start Capella, the adapter is already installed on the software.

  2. Open a model.

  3. Click on the Comet logo

Login tutorial

  1. Opening of the panels can be done by pressing the button with the COMET icon in the tool bar. The button itself is a dropdown one, where you can choose to open or close either the Impact View or the Hub Browser.

    1. In the hub browser, connect to the hub by pressing the “Connect” button.

    2. Connect by selecting the correct server address, and inputting with your usual credentials on Comet. Contact your Assistant System Engineer to know these informations.

Table of contents