Exercise 7.4 - Jama - SysML Compare & Sync

Owned by Debesh Roy Chowdhury
Last updated: Dec 09, 2024 by Manas Bajaj
6 min read

Objectives

The new learning objectives of this exercise are to compare connected requirements models in Jama and Cameo/MagicDraw (via default mappings) and to synchronize changes that have arisen.  These changes will be demonstrated by both adding and removing requirements in SysML / Jama, comparing, and synchronizing to Jama / SysML.

This tutorial will consist of 2 parts.

  • Part 1: Sync SysML to Jama

    • Add requirement in SysML, compare result, and sync to Jama

    • Delete requirement in SysML, compare result, and sync to Jama

  • Part 2: Sync Jama to SysML

    • Add requirement in Jama, compare result, and sync to SysML

    • Delete requirement in Jama, compare result, and sync to SysML

Preparation

This exercise assumes the student has:

  • Cameo System Modeler 19.0 (or MagicDraw with SysML plug-in) or later installed correctly on his or her machine with a valid license for use, and

  • Syndeia 3.6 or later installed as a plugin for Cameo/MagicDraw with a valid license for use

  • Jama repository (server) that can be connected over the network from the Syndeia Repository Manager

The user can try out this capability in a sandbox Jama repository or project to ensure that their installation is working fine before using on a production repository / project.

Exercise

Part 1 - Add/delete requirement in SysML and sync to Jama

  1. This exercise assumes the user has completed either Exercise 7.2 or 7.3 and created a set of linked requirements between the SysML model Syndeia_Jama_Mapping_Tutorial.mdzip (get it here - SysML Models, Profiles and Mappings) and their Jama repository.

  2. In the Connection Browser tab on the Syndeia dashboard, select the Regulatory Requirements connection created in either exercise. Right-click and compare across that connection before any changes have been made to see that all is in sync (Figure 1).

Figure 1 - Connection Browser tab, Syndeia dashboard, comparing across connection

  1. The Comparison Result tab will open and the results should appear similar to Figure 2.

figure2.jpg
Figure 2 - Initial comparison result

  1. Modify the Regulatory Requirements text field in Cameo and add a sub-requirement, Structural Requirements, as shown in Figure 3.

  1. Compare across the same connection as in Step 2 and display the comparison results (Figure 4). Syndeia shows that the new Structural Requirement in SysML is not present in Jama, and the text of the Regulatory Requirements is different.

  1. Return to the Connection Browser, click Refresh to show the new child requirement, right-click the Regulatory Requirements connection and select Sync Source -> Target (Figure 5).

  1. Repeat the comparison as in Step 2 and check that the Comparison Result shows all green, as in Figure 6. You can see the new ‘Structural Requirement’ has been added underneath Regulatory Requirements in Jama.

  1. Check the same requirement in Jama through its web interface to see the modified requirement text and sub-requirement (Figure 7).

  1. Now, return to Cameo and in the containment tree delete a child requirement underneath Regulatory Requirements as shown in Figure 8.

  1. Repeat the Comparison Result step for the Regulatory Requirements Connection.  The deleted Requirement should be flagged in Red as shown in Figure 9.

  1. In the Connection Browser of Syndeia, Right-click and select ‘Sync Source to Target’ for the connection as shown in Figure 10.

  1. After Syndeia is finished syncing, check that the Requirement no longer shows in Jama Connect as shown in Figure 11.

Part 2 - Add/delete requirement in Jama and sync to SysML

  1. In Jama, modify the text of ‘Regulatory Requirements’ and add a new Requirement underneath it as shown in Figure 12 and 13.

  1. From the Syndeia Dashboard, trigger a Comparison of the Regulatory Requirements connection once again.  The changes should be shown in Red as seen in Figure 14.

  1. From the Connection Browser tab, right click the connection and select ‘Sync Target to Source’ as shown in Figure 15.

  1. Return to Cameo/Magicdraw and verify that the new changes have been made in the containment tree and properties shown in Figure 16.

  1. From Jama Connect, delete the 'Interface Requirement' underneath Regulatory Requirements as shown in Figure 17.

  1. From the Syndeia dashboard, compare the Regulatory Requirements connection again and check that the deleted requirement appears in red as shown in Figure 18.

  1. Now from the Connection Browser, right click on the connection and select ‘Sync Target to Source’ as shown in Figure 19.

  1. Check in Cameo that the Requirement has been removed from the Containment Tree as shown in Figure 20.

  1. Compare the connection from Syndeia one last time to check that everything is showing green.