Syndeia 3.3 (Plugin for Rhapsody)
Tutorial Exercise 8.1
Creating a SysML – JIRA Reference Connection
|
47 Perimeter Ctr E, Suite 410 |
Revision Date: July 11, 2020
Objectives
The new learning objectives of this exercise are to create reference connections between SysML elements and JIRA issues.
Preparation
This exercise assumes the student has
- IBM Rational Rhapsody 8.2 installed correctly on his or her machine with a valid license for use, and
- Syndeia 3.3 installed as a plugin for Rhapsody with a valid license for use
- Syndeia JIRA interface, correctly installed with a valid license for user.
We will use the provided Rhapsody project Syndeia_JIRA_Mapping_Tutorial.rpy. The user can use any JIRA repository they have available with the ability to create and edit issues within a JIRA project. It is generally advisable to carry out these exercises in a non-production repository, a "sandbox", set up for training and practice purposes.
For this demonstration, we have use three sample issues labeled as SDB-1844, SDB-1845 and SDB-1846 within our Syndeia Demo Box project, but you may use any existing issues in your JIRA repository, instead.
Caution: Rhapsody has, by default, restrictions on the naming of SysML elements, which can create problems when Syndeia tries to create Rhapsody model elements that violate these restriction, e.g. beginning a SysML block name with a number. We recommend modifying any Rhapsody models you create to relax these restrictions. Modify the properties of the top-level package of the model under General::Model::NamesRegExp with the following string and save.
^(([a-zA-Z0-9_][a-zA-Z0-9_ ():-]*)|(operator.+))$
Exercise
- Open the SysML project Syndeia_JIRA_Mapping_Tutorial.rpy, right-click the top-level package, and launch the Syndeia dashboard (Figure 1). Select a Syndeia Cloud project, if needed.
Figure 1 Launching Syndeia dashboard
- To connect to JIRA, right-click the JIRA category under Repositories in the Repository Manager tab and select Add… (Figure 2), then enter a name, your own Jama URL and credentials, and click OK (Figure 3).
Figure 2 Adding a JIRA network connection
Figure 3 Entering JIRA repository info
- Your repository should load and expand to show projects and issues, as in Figure 4.
Figure 4 Viewing JIRA repository contents in Repository Manager tab
- To create a reference connection between a SysML element and a JIRA issue, go to the Connection Manager tab on the Syndeia dashboard, as in Figure 5.
- Load and expand the SysML model in the left pane to show the JIRA Test Block.
- Select Reference under Connection Type in the middle pane.
- Load the JIRA repository and expand the Issues folder in the right pane to show the issues to be connected.
- Drag and drop JIRA Test Block from the left pane on top of an issue in the right pane to connect them. Repeat to connect additional issues.
|
Figure 5 Syndeia Dashboard, Connection Manager tab |
- To see the reference connections that have been created, go to the Connection Search tab on the Syndeia dashboard and click the Get All button (see Figure 6)
|
Figure 6 Syndeia Dashboard, Connection Search tab |
- The reference connections can be used in a number of ways by Syndeia. Close the Syndeia dashboard. To open a JIRA issue directly from Rhapsody, right-click on JIRA Test Block in the containment browser and select Syndeia → Open Connected Artifacts. Because there are three connected issues, a small window with three check boxes appears. Check one of the JIRA issues will be opened in the default web browser (see Figure 7). Note: your JIRA interface may appear different depending on your configuration settings.
|
Figure 7 JIRA web interface |
- Alternatively, the reference connections may be used to display a summary of all the connected issues. Right-click on JIRA Test Block in the containment browser and select Syndeia → Summarize Connected Artifacts. A window similar to Figure 8 should appear.
|
Figure 8 JIRA Connected Issues Summary |