Connection Generator for TM4J/Zephyr Scale

Follow the general instructions below to create connections (inter-model relations) between existing elements in SysML and TM4J / Zephyr Scale using your own custom Syndeia mappings. For brevity, the acronym ZS is used for Zephyr Scale, and ZS key is used to indicate keys for a ZS Test Case, Test Cycle, or Test Plan in these instructions.

1. To prepare, apply the stereotype(s) you are using for your custom mapping in SysML to each element you wish to connect (e.g. requirements), and populate a stereotype tag or attribute with a ZS key. In the example shown below, the <Intercax_Artifact> stereotype is applied to 4 blocks, and for each, the id tag is populated with the key of a ZS test case.

   

   

2. Launch the Syndeia Dashboard by right-clicking a package (or any element) and selecting Syndeia > Dashboard. Connect to your Jira repository and ensure you have a SysML-TM4J custom mapping with attributes that maps the ZS key to the SysML stereotype tag or attribute used above.
   

   

3. Launch the Connection Generator utility by right-clicking a package (or any element) and selecting Syndeia > Utils > Connection Generator. If you do not see it launch immediately, check behind the MagicDraw window.
   

   

4. Select the match criteria for Source as follows (see example Connection Generator window below):

   1. Repository = Active SysML Repository

   2. Project = Root-level Model element in the active MagicDraw project

   3. Scope = Package which contains all of the elements you wish to connect

   4. Recursive = Select this option if you want to connect elements recursively under the Scope (package), or keep it unselected if you want to only connect elements immediately under the Scope (package)

   5. Base Type = SysML type of the elements to connect e.g. Block

   6. Additional Type = Additional custom stereotypes that are applied to the base type. These custom stereotypes will have tags populated with ZS keys.
      

      

5. Select the match criteria for Target as follows (see example in Connection Generator window below):

   1. Repository = Jira repository

   2. Project = Jira project which contains the ZS artifacts (Test Case, Test Cycle, Test Run) to be connected

   3. Base Type = Type of ZS artifact (Test Case, Test Cycle, Test Run) to be connected. This corresponds to the Target Artifact Type in your custom mapping.
      

      

6. Under Attribute Filters click the [+] button and select the criteria:

   1. Source Attribute Definition = Tag or attribute of the SysML element which contains the matching ZS key

   2. Target Attribute Definition = key (ZS key)
      

      

7. Click the Find Matches button, and Syndeia will take a moment to search and return all matches found based on the above criteria.

   

8. Select the rows of each pair you wish to create connections between and select the desired mapping from the dropdown. Alternatively, click the Select All button to select all matches.
   

   

9. Click the Generate Connections button, after which Syndeia should create the connections and show a successful message once it is done:

   

10. You should be able to now locate the newly generated connections in the Connection Browser or Connection Search tabs. If you are using Syndeia Cloud, the connections are generated on Syndeia Cloud and available via the Syndeia Cloud Web Dashboard and REST API.

    

    

11. You should also now be able to compare and sync differences across the new connections.