Exercise 7.6 - Adding SysML-Jama Artifact Types

Objectives

The new learning objective of this exercise is to add additional Jama artifacts for creating new mappings for Data Map and Model Transform connections. These can be standard Jama element types or user-defined element types.

Preparation

This exercise assumes the student has

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

  • Syndeia 3.3 installed as a plugin for Cameo/MagicDraw with a valid license for use

  • Syndeia Jama interface, correctly installed with a valid license for user.

The user can use any Jama repository they have available with the ability to create and edit elements within a Jama project. It is generally advisable to carry out these exercises in a non-production repository, a "sandbox", set up for training and practice purposes. We recommend that the student view the videos 1.6, 1.7, and 1.8 in the Introduction Section of the Syndeia training materials before attempting this exercise. These videos provide important background on creating custom mappings. Hands-on tutorials omit much of the logic behind the actions in the interest of clarity and brevity. We will use the MagicDraw project Syndeia_Jama_Mapping_Tutorial.mdzip (get it here - ) provided with the tutorials for this exercise, which loads the profile Syndeia_Mapping_Tutorials_Profile.mdzip. We also use the syndeia34Tutorial.mappings file provided, which has been installed in the .syndeia folder and renamed as syndeia.mappings. Any Syndeia user can use or view the mapping specifications, but Syndeia requires a special license in addition to the regular Syndeia license in order to create, modify or delete mapping information. It is good practice to confine this duty to a very limited number of experienced users or system administrators, who will provide mappings for the general users.

Exercise

  1. Open the SysML project Syndeia_Jama_Mapping_Tutorial.mdzip (get it here - ), right-click the Jama_Mapping package, and launch the Syndeia dashboard.

  2. Go to the Mappings tab. The first task will be to make a new Jama artifact type available for mapping.

    1. Select Jama under Model Types in the left column.

    2. Initially, the window should appear similar to Figure 1, with three existing Jama artifact types and one Jama Relationship type already available.

      Figure 1 Syndeia dashboard, Mappings tab, showing available Jama artifact types

    3. Add new Jama artifact type.

      1. Right-click Model Types: Jama in left column and select Add Artifact Type.

      2. A new window appears, Add Jama Artifact Type

      3. Choose the correct Jama Repository, using the pull-down menu.

      4. Click the Get Jama Item Types button

      5. Use the pull-down menu under Item Types to view all the Jama artifact types Syndeia can find.

      6. Select Failure Mode, assuming your Jama repository includes this artifact type (if not, select another new Jama artifact type)

      7. ID, Type, Name and Description fields will be populated. Name and Description can be modified, if desired (Figure 2).

        Figure 2 Add Jama Artifact Type window

  3. Specify the Jama artifact attributes to be available for mapping

    1. Near the bottom of the window, click the Retrieve Jama Item Properties button.

    2. The table add attribute definitions… will be populated, as Figure 3.

      Figure 3  Add Jama Artifact Type window, completed

    3. Select the Failure Mode attributes you want to be available for mapping and click OK.

  4. The second task is to create another new mapping using the new Jama artifact type.

    1. Right-click SysML - Jama under Mapping Groups in the left column and select Add Mapping.

    2. Set Name to Block – Failure Mode (Attributes)

    3. Set Description to SysML Block – Jama Failure Mode with attributes

    4. Set Source Artifact Type to Block, using pull-down menu

    5. Set Target Artifact Type to Failure Mode, using pull-down menu

    6. Set Structure Level to NO_CHILDREN, using pull-down menu

    7. Set Include Attributes to Include Attributes, using pull-down menu

    8. Initially, the window should appear similar to Figure 4.

    9. To map the attributes between Block and Failure Mode, follow the process described in Exercise 7.6, Creating SysML-Jama Mappings.

      1. Add a Stereotype at the bottom of the window, e.g. <<Jama_FailureMode>> (review Special Note on SysML Stereotypes in Exercise 7.6).

      2. Create an Attribute Definitions Mappings table, pairing up attributes in Block/<<Jama_FailureMode >> and Failure Mode.

    10. Click Save Mapping at the bottom. The new mapping should appear in the list under the SysML – Jama mapping group in the left column and should be available in the Select Mapping Specification window when creating a Data Map or Model Transform connection.