Skip to main content

Jama Connect Interchange Help

Create a single-project Excel Functions integration

This procedure explains how to create a "single project" integration, which establishes rules for syncing items between one Jama Connect project and one Excel Functions project. To configure an integration that syncs items for multiple Jama Connect projects, see Create a multi-project Excel Functions integration.

Note

Before beginning these steps, be sure to configure your Excel template. See Create and link your Excel template.

The process consists of these steps:

Step

Details

1. Complete the Jama Connect Integration wizard to configure an Excel Functions integration.

Create a "single project" integration, which establishes rules for syncing items begtween one Jama Connect project and your Excel template.

Note

To configure an integration that syncs items for multiple Jama Connect projects, see Create a multi-project Excel Functions integration.

2. Create field mapping groups.

Use field mapping groups to map fields in Jama Connect to cells in the Excel template. Create a separate field mapping group for each Jama item type that will be integrated with the template.

You can create multiple field mapping groups to map different Jama Connect sets to the same Excel template. Each field mapping group must apply to the same Jama Connect project and Excel template.

Two types of field mapping groups are:

  • Items in the Jama Connect Project Explorer Tree

  • Test runs and test cases

3. Map relationships and item of Type associations.

Map relationships and associations if your Excel Functions template includes references to upstream or downstream items, or to the value in an Item of Type field.

  1. Create a single-project Excel Functions Integration.

    1. In the Jama Connect Interchange header bar, select Integrations, then select Add integration to open the Jama Connect Integration wizard.

      JCI_Add_Intecgration_button.png

    2. Complete each page of the wizard, then select Next.

      Integration Type — Select the integration type:

      The Integration Type page of the Jama Connect Integration Wizard includes one setting, Select Integration Type, where you select a type from the drop-down list.

      • Select Integration Type — From the drop-down list, select Jama Connect to Excel Functions, then select Single Project.

        Note

        To configure an integration that syncs items for multiple Excel projects, see Create a multi-project Excel Functions integration.

      Connectors — Choose the connectors you want to integrate:

      The Connectors page of the Jama Connect Integration Wizard includes two settings, Select Jama Connect Connector and Excel Template Location, where you use the drop-down lists to make your selection.

      • Select Jama Connect Connector — Select the Jama Connect connector that you want to integrate. This is the same connector you created in Link your Jama Connect instance (Excel Functions).

      • Excel Template Location (Jama ID) — Enter the Jama Connect item project ID where the Excel template is attached. For example, PROJ-SET-0001.

      Select Projects — Choose the Jama Connect project:

      JCI_wizard_select_single_project1.png

      • Select Jama Project — Choose the project you want to integrate.

      Name and configure the integration:

      The Confirm page of the Jama Connect Integration Wizard displays the setting and options, Name and Frequency, and a Submit button.

      • Name — Enter a descriptive name for the integration.

      • Frequency — Select the frequency with which you want the integration to run (15 or 30 seconds is recommended).

    3. Select Submit to complete the wizard.

    The integration is saved in a disabled state.

  2. Create field mapping groups:

    1. On the Integrations page, select the link for the integration you just created.

      The Integrations page displays a search string and a 2-column table (Type and Name), with Excel Risk Calculations highlighted.

    2. Select the Field Mappings tab.

      The Field mappings tab is highlighted on the Jama to Excel Functions integration page.

    3. For each field mapping group you add, select Add new field mapping group.

      The Add new field mapping group button is highlighted at the bottom of the integration's Field mappings tab.

    4. On the page that opens, select Explorer, then select Next.

      On the Add a new Field Mapping Group page, the Explorer option is selected and highlighted.

    5. Complete these fields, then select Create.

      • Name — Enter a descrptive name for the field mapping group.

      • Jama Location Selector — Select the Jama Connect sets or folders you want to sync. All selected sets must use the same item type (for example, User Stories or Defects).

        The Add a new Field Mapping Group page includes a Name field and two columns, Location Selector and Selected Locations, where you select sets/folders you want to sync.

    6. Using the drop-down lists, map the fields and cells to one another. Add a separate row for each field/cell combination, as shown in this example.

      The drop-down lists in each row let you map fields and cells between Jama Connect and Excel.

      These fields are available in each row:

      • Select Field — Choose the field in Jama Connect that is being mapped to Excel.

      • Directionality — Choose whether data is written from Jama Connect to Excel (→) or from Excel to Jama Connect (←).

      • Select Sheet — Choose the sheet in the Excel template where the cell is located.

      • Input Cell — Enter the cell location in the Excel template. For example, G5.

    7. Organize your mappings in this order:

      • List the fields written from Jama Connect to Excel (input fields).

      • List the fields written from Excel back to Jama Connect after the function runs (output fields).

      Typically, output fields are read-only in Jama Connect to prevent users from updating them manually. If you mark a field as read-only in Jama Connect, you must also select Allow API Overwrite in the field settings to allow the integration service to write the updated Excel value to the item.

      The Edit field window includes fields for label, infotip, and unique name, as well as three options, two of which are selected.

    8. Select Save Changes.

  3. Map relationships and Item of Type associations:

    1. On the Field Mappings page below the field mappings for the base item, select Add new associated mapping group.

      The drop-down lists in each row of the Field Mappings page let you map fields and cells between Jama Connect and Excel; the Add new associated mapping group option is highlighted.

    2. On the page that opens, make these selections.

      • Select association type — Choose whether the items you wan to map are:

        Upstream from the base items

        Downstream from the base items

        Selected in an Item of Type field on the base items

      • Select option — Choose the item of type of the associated item.

        The page includes a group item type setting and drop-down lists for selecting upstream/downstream and item type.

    3. Select Create.

      A new section is added for mapping fields in the associated items.

    4. Add more field mapping rows as needed.

      The drop-down lists in each row of the Field Mappings page let you map fields and cells between Jama Connect and Excel.

    5. Select Save Changes.

In this section: