Syndeia 3.3 (Plugin for Rhapsody)
Tutorial Exercise 17.1
Creating a SysML – TM4J Reference Connection

Revision Date: July 17, 2020

Objectives

The new learning objective of this exercise is to create reference connections between a SysML element and a TM4J (Test Management for JIRA) element.

Preparation

This exercise assumes the student has

• Anchor
  _Hlk45777270 _Hlk45777270

  Anchor
  _Hlk45869967 _Hlk45869967

  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.

The user can. It is generally advisable to carry out these exercises in a non-production repository, a "sandbox", set up for training and practice purposes.
We will use the provided Rhapsody project Syndeia_JIRA_TM4J_Mapping_Tutorial.rpy. For this demonstration, you may use any JIRA repository you have available with the ability to create and edit TM4J elements of types Test Case, Test Cycle and Test Plan.
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.+))$

Background – TM4J (Test Management for JIRA)

TM4J is a test management solution integrated into the JIRA user interface. The generic schema is shown in Figure 1.

• A Test Case describes a specific test procedure.
• A Test Cycle contains a set of Test Cases.
• A Test Plan tracks the overall test program for a particular release or milestone. It contains one or more Test Cycles.
• Any of these elements can be linked to a JIRA Issue.

Exercise

1. Open the SysML project Syndeia_JIRA_TM4J_Mapping_Tutorial.rpy (or your own), right-click the top-level package, and launch the Syndeia dashboard (Figure 2).
2. If Syndeia connections are set to store in the SysML model, the dashboard will open immediately. If they are stored in Syndeia Cloud (see Exercise 1.1), choose or create a project for the exercise.

   Image Added

   Anchor _Ref481833169 _Ref481833169 Figure 2 Launching Syndeia dashboard

   
   
3. To connect to JIRA, right-click the JIRA category under Repositories in the Repository Manager tab and select Add… (Figure 3), then enter a name, your own JIRA URL and credentials, and click OK (Figure 4).

   Image Added	Image Added
   Anchor _Ref481833397 _Ref481833397 Figure 3 Adding a JIRA network connection	Anchor _Ref481833414 _Ref481833414 Figure 4 Entering JIRA repository info

4. Your repository should load and expand to show projects and issues, as in Figure 5.

   Image Added

   Anchor _Ref481833841 _Ref481833841 Figure 5 Viewing JIRA repository contents in Repository Manager tab

5. To create a reference connection between a SysML element and a TM4J Test Case, go to the Connection Manager tab on the Syndeia dashboard, as in Figure 6.
   1. Expand the SysML model in the left pane to show the Test Case 01 block.
   2. Select Reference under Connection Type in the middle pane.
   3. Expand the Issues folder in the right pane to show the Test Case to be connected, for example, SYNDT-T3.
   4. Drag and drop Test Case 01 from the left pane on top of an issue (e.g. SYNDT-T1) in the right pane to connect them.

1. 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 7).

1. The reference connections can be used in a number of ways by Syndeia. Close the Syndeia dashboard. To open a TM4J test case directly from Rhapsody, right-click on Test Case 01 in the model view browser and select Syndeia → Open Connected Artifacts. Check one and the JIRA issue will be opened in the default web browser (see Figure 8). Note: your JIRA interface may appear different depending on your configuration settings.

1. The reference connection may also be used to detect changes across the connection. To demonstrate,
   1. Make a change in the Test Case in the JIRA web interface, e.g. set Priority to High, and save the change
   2. Reopen the Syndeia dashboard. Go to the Connection Browser, expand to find the connection to Test Case 01, right-click and select Compare Source & Target (Figure 9).

1. 1. The Comparison Result tab (Figure 10) shows a newer version of the TM4J element is available. The reference connection can be updated by right-clicking on the red row and selecting either Sync Source to Target or Sync Target to Source.