You are not logged in. Click here to log in.

codeBeamer ALM

Search In Project

Search inClear

Tags:  not added yet

codeBeamer connector for Enterprise Architect

Setup codeBeamer connection

Click on Extension menu on the main menu bar or the Project Browser's context menu, open the EA Connector for CodeBeamer menu item and click on the Connection Properties:




The main properties for the codeBeamer connection should be specified in the following screen:



  • CodeBeamer URL: base URL of the codeBeamer
  • User Name: codeBeamer user name
  • Password: codeBeamer password (the application will encrypt it)
If the store password option is checked the specified password stored in the local environment (using encryption), otherwise the user should specify the password before the first connection to the codeBeamer.

The properties can be validated using the Test Connection button. If the connection is successful the result should be:




If a problem occurred during the connection test an error should be shown:

Manage synchronization configurations

Click on Extension menu on the main menu bar or the Project Browser's context menu, open the EA Connector for CodeBeamer menu item and click on the Syncronization Configuration:




The opened dialog contains the list of the existing synchronization configurations:




Synchronization configurations can be updated, deleted and created on this screen by selecting a row and clicking on the buttons on the toolbar. (A configuration can be edited by double clicking on its row)

Properties of a synchronization configuration can be edited by the following dialog:



  • Configuration Name: simple name of the current configuration (it is mandatory and it must be unique)
  • Target Project: the target project can be specified here (it is only a filter for tracker/wiki selection)
  • CodeBeamer Type: the type of the codeBeamer item can be specified here. It can be work item, or wiki. If the work item is checked then a tracker should be selected from the combobox next to the work item radio button. If wiki is checked a wiki page should be selected from the combobox next to the wiki radio button.
  • Work Items mapped as: this is an additional option if the synchronization type is work item. An Enterprise Architect element type can be selected and the elements with this type will be used during the synchronization (like a packge). This feature can be disable selecting None option in the combobox.
  • Diagrams: if it is checked the package's diagrams will attached to the codeBeamer item during export.

Import from codeBeamer

The import view can be started using the Extension menu, EA Connector for CodeBeamer, Import menu item:



The Import root

An Enterprise Architect package or model can be selected in this dropdown. You can specify the entry point of the import process by select a value, which means the selected node will be the parent of the imported items, and the application computes modified and deleted items calculated from the selected package.



Synchronization configuration

Previously created synchronization configurations can be selected using this dropdown. The urrent state tree depends on this value, because this contains the parameters of the import process, so one configuration must be selected before the current state tree is refreshed.



Refresh Tree

The current state tree can be refreshed by clicking on this button.



Synchronizatoin configuration should be selected before the button pressed, othewise nothing happens in the current state tree.

Function icons

  • browser button: the browser component at the bottom can be hide or shown with this button.
  • log button: the application log dialog can be shown with this button (you can find more about log window in Log section)



Current state tree

The tree contains the current state of the synchronized Enterprise Architect items, and the new items which created in codeBeamer but not imported yet. There are four groups:

  • Identical: these elements are synchronized and not changed in codeBeamer after the last import
  • Deleted in codeBeamer: these elements are deleted in codeBeamer, but the Enterprise Architect still contains thise elements
  • New in codeBeamer: these elements are new in codeBeamer, not synchronized yet
  • Modified in codeBeamer: these element are synchronized and changed in codeBeamer after the last import



You can filter the tree items by the dropdown in the top right corner

Execution properties

This panel summarize what will happen if the execute button is clicked:

  • Project: the target project's name which containt the target tracker or wiki
  • Source: the source tracker or wiki name
  • New Items: how many new items will created if the import is executed
  • Modified Items: how many new items will modified if the import is executed
  • Deleted Items: how many new items will deleted if the import is executed



Execution Log

Basic informations about the currently executed import process can be found in this part.



Execution log entries can be found in application log as well.

Built-In Browser

The import view contains a built-in browser which can be use to open syncronized elements in codeBeamer. To open an item click on the item's node in the current state tree.



Example: Import work items from codeBeamer

A simple use case will be shown in this section: import all item from a Requirement tracker to Enterprise Architect, import the updates from codeBeamer, remove deleted item from Enterprise Architect.

The Requirement tracker in codeBeamer:



A new synchronization configuration should be created for this tracker in Enterprise Architect:



The import view should be opened using the Extension menu, EA Connector for CodeBeamer, Import menu item:



The following tab should be opened in the Enterprise Architect:



First of all the Enterprise Architect root package should be chosen (this package will be the root of the import, so modified, deleted, and new items calculated from this node):



Next the previously created synchronization configuration should be selected:



The tree which contains the modifications should be refreshed by the Refresh Tree button:



After the modifications loaded the requirements should be listed above the New in codeBeamer node:



All of the nodes should be selected inside the tree:



After all nodes are selected the Execute Import button should be pressed to execute the import process:



If everithing works fine the nodes in "New in codeBeamer" group should be moved to identical group in the tree, and new packages should be created in Enterprise Architect:



Now the work items and the Enterprise Architect packages are synchronized. If any item's name or description modified in codeBeamer side, it can be imported to the Enterprise Architect. For example.: modify the User Interface requirement's name to UI, and refresh the tree:



The modified requirement moved to the "Modified in codeBeamer" group. The modification can be applyed if the Execute import pressed after the node selected:



If an element (eg.: Preformance requirement) is deleted in codeBeamer, the current state will be the following after the tree is reloaded:



After the import the selected (Performance) element is removed from Enterprise Architect as well.

Export to codeBeamer

The export view can be started using the Extension menu, EA Connector for CodeBeamer, Export menu item:



The Export root

An Enterprise Architect package or model can be selected in this dropdown. You can specify the entry point of the export process by select a value, which means the selected node's children will be exported, and only the children element state will checked.



Synchronization configuration

Previously created synchronization configurations can be selected using this dropdown. The current state tree depends on this value, because this contains the parameters of the export process, so one configuration must be selected before the tree is refreshed (next section).



Refresh Tree

The current state tree can be refreshed by clicking on this button.



Synchronizatoin configuration should be selected before the button pressed, othewise nothing happens in the current state tree.

Function icons

  • browser button: the browser component at the bottom can be hide or shown with this button.
  • log button: the application log dialog can be shown with this button (you can find more about log window in Log section)



Current state tree

The tree contains the current state of the synchronized Enterprise Architect items, and the new items which created in Enterprise Architect but not exported yet. There are three groups:

  • Identical: these elements are synchronized and not changed in Enterprise Architect after the last export
  • New in EA: these elements are new in Enterprise Architect, not exported yet
  • Modified in EA: these element are synchronized and changed in Enterprise Architect after the last import



You can filter the tree items by the dropdown in the top right corner

Execution properties

This panel summarize what will happen if the execute button is clicked:

  • Project: the target project's name which containt the target tracker or wiki
  • Target: the target tracker or wiki name
  • New Items: how many new items will created if the export is executed
  • Modified Items: how many new items will modified if the export is executed
  • Deleted Items: not used



Execution Log

Basic informations about the currently executed export process can be found in this part.



Execution log entries can be found in application log as well.

Built-In Browser

The export view contains a built-in browser which can be use to open syncronized elements in codeBeamer. To open an item click on the item's node in the current state tree.



Direct Export

Enterprise Architect diagrams can be exported into a wiki or a work item desctiption using the Enterprise Architect wiki plugin.

You can execute the direct export from the Enterprise Architect Project Browser's context menu, if a diagram is selected (otherwise the menu is not enabled):



Direct Export can be executed from diagram editor tab's context menu as well:



The Direct Export view shown in a dialog:



There are two tabs in the dialog:

  • Export to Work Item: first the target project should be selected, then the target tracker. After the work items have been loaded the target work item should selected and the Execute Export button should be pressed:
  • Export to Wiki: first the target project should be selected, then the target wiki should be selected in the tree and the Execute Export button should be clicked:

Disconnect Items

This fuction allows you to remove your synchronization data (codeBeamer URL, codeBeamer Id, etc.) from your items in Enterprise Architect.

Click on the Extension menu on the main menu bar, open the EA Connector for CodeBeamer menu item and click on the Disconnect Items, to clear your Enterprise Architect project from all codeBeamer synchronization data:



To clear synchronization data from a specific package/element the Enterprise Architect Project Browser context menu should be used. Right click ont the package/element what you want to disconnect, select Extension menu, open the EA Connector for CodeBeamer menu item and click on the Disconnect Items. In this case the clearing executed on the selected package/element and their children.

License

License code

To use this plugin you will need this license code:

eyJsaWNlbnNlVGVybXMiOiJleUoxYzJWeVRtRnRaU0k2SWxSeWFXRnNJRlZ6WlhJaUxDSnNhV05s
Ym5ObFZIbHdaU0k2TVN3aVpXNWtSR0YwWlNJNklqSXdNVFl4TWpJekluMD0iLCJzaWduYXR1cmUi
OiJNQzBDRkFLa2dUdVQzTjMrZ2c0VGxDRlZaL01FdWh3VEFoVUFsSnVRMW5UOHc5OEU4c1QvYklF
KzZpclh3eUk9In0=

This license will be valid until 24 Dec 2016.

eyJsaWNlbnNlVGVybXMiOiJleUoxYzJWeVRtRnRaU0k2SWxSeWFXRnNJRlZ6WlhJaUxDSnNhV05s
Ym5ObFZIbHdaU0k2TVN3aVpXNWtSR0YwWlNJNklqSXdNVFl4TWpJekluMD0iLCJzaWduYXR1cmUi
OiJNQzBDRkFLa2dUdVQzTjMrZ2c0VGxDRlZaL01FdWh3VEFoVUFsSnVRMW5UOHc5OEU4c1QvYklF
KzZpclh3eUk9In0=

Install new license into Enterprise Architect

The current license can be checked and new license can be registered with this function.

To open the Manage License view click on the Extensions menu, open the EA Connector for codeBeamer menu item and click on the License menu item.

The view contains two sections:

  • Add new license: a new license can be registered using the license token textarea and the register button
  • Current License: contains information about the corrent license: the license type and expire date.


Log

The application log is shown in this view in a dialog, and the log level can be modified from this view. Additionally, the application log can be opened in a notepad from this view.

To open the Log view click on the Extensions menu, open the EA Connector for CodeBeamer menu item and click on the Log menu item.



The application log can be seen in the dialog:



To edit the log level select the required log level from the dropdown and press the save button:



The application log can be opened by external application (it depends on operating system, notepad by default on windows) using the open button:

About

To open the About dialog click on the Extensions menu, open the EA Connector for CodeBeamer menu item and click on the About menu item. It contains information about the current version of the application and license status. The help documentation and the support can be accessed from this dialog: