Best Practice Synchronizing Test Cases and Results Between Jama Connect and Test Rail Using Planview Hub

The general flow for an ongoing sync between Jama Connect and TestRail is that Test Cases are created in Jama Connect, because a requirement needs to be verified. Then, the Test Cases flow to a Test Management tool, like Test Rail, so that they can be executed. Then Results are driven back into Jama Connect, creating a complete line of traceability for verification of the requirements.

Jama Connect and Test Rail Setup

Before beginning, ensure the following fields exist in your Jama Connect and TestRail configurations.

Fields for Sets and Test Cases in Jama Connect:

• External ID - Text Field
• External URL - Text Field

Fields for Test Results in Jama Connect:

• External ID - Test Field
• External URL - Text Field
• Test Run ID - Text Field
• Test Result - Text Field or a Single Select picklist matching the values in TestRail

Fields for Test Suites and Test Cases in TestRail

• Jama Connect ID - String
• Jama Connect URL - String

Organization of Test Cases

TestRail organizes Test Cases into Test Suites and Sections, much like Jama Connect organizes items into Sets and Folders. This allows us to create a direct mapping between the tools.

Planview Hub Setup

To integrate Jama Connect and TestRail, we will need to setup 2 integrations that will use a total of 8 Collections.

Models

A single Model can be used but best practice is to create a model for the Containers, a model for the Test Cases, and a model for the Test Results.

Container Model Fields

 Test Case Model Fields

Test Results Model Fields

Collections

Jama Connect Collections

• Jama Test Cases

  • Jama Test Case Field Mappings

    Jama Connect Field	Model Field
    Name	Summary
    Description	Description
    External ID	TestRail ID
    External URL	TestRail URL
    ID	Jama ID
    URL	Jama URL

  • Jama Test Step Mappings

    Jama Connect Field	Model Field
    Notes	Summary
    Action	Action
    Expected Result	Expected Result

  • Jama Test Case Relationship Mapping

    Jama Connect Relationship	Model Relationship
    Parent Artifact	Parents
    Set	Test Suite

• Jama Sets

  • Jama Set Field Mappings

    Jama Connect Field	Model Field
    Name	Summary
    Description	Description
    External ID	TestRail ID
    External URL	TestRail URL
    Set Key	Constant Value
    Child Item Type	Constant Value

    NOTE: The Set Key will be filled in for any Set created in Jama Connect by the Integration. The Constant assigned can be the default key for the item type or customized. The Child Item Type allows for the item type of the created Set to be identified.

• Jama Folders

  • Jama Folder Field Mappings

    Jama Connect Field	Model Field
    Name	Summary
    Description	Description

    NOTE: If more details is needed on the Folder Items, such as the TestRail ID, fields can be defined in Jama Connect for the folder item and added to the mapping.

  • Jama Folder Relationship Mappings

    Jama Connect Relationship	Model Relationship
    Parent Artifact	Parent
    Set	Key

• Jama Test Results

  • Jama Test Result Field Mappings

    Jama Connect Field	Model Field
    Name	Summary
    External ID	TestRail ID
    External URL	TestRail URL
    Test Run ID	Test Run ID
    Test Result	Test Result Status

  • Jama Test Result Relationship Mappings

    Jama Connect Relationship	Model Relationship
    Parent Artifact	Parent

TestRail Collections

• TestRail Test Cases

  • TestRail Test Case Field Mapping

    TestRail Field	Model Field
    Title	Summary
    Preconditions	Description
    ID	TestRail ID
    Location	TestRail URL
    Jama ID	Jama ID
    Jama URL	Jama URL
    Priority	Constant Value
    Case Type	Constant Value
    Template	Constant Value

    NOTE: The constant values here are needed because these fields are required in TestRail but we do not need them reflected or set in Jama Connect.

  • TestRail Test Case Relationship Mappings

    TestRail Relationship	Model Relationship
    Section	Parents
    Test Suite / Baseline	Test Suite

  • TestRail Test Step Mappings

    TestRail Field	Model Field
    Step Description	Action
    Expected Result	Expected Result

• TestRail Test Suites

  • TestRail Test Suite Field Mapping

    Test Rail Field	Model Field
    Name	Summary
    Description	Description
    ID	TestRail ID
    Location	TestRail URL
    Jama ID	Jama ID
    Jama URL	Jama URL

• TestRail Sections

  • TestRail Section Field Mappings

    TestRail Field	Model Field
    Name	Summary
    Description	Description

  • TestRail Section Relationship Mappings

    TestRail Relationship	Model Relationship
    Parent Section	Parent
    Test Suite / Baseline	Key

• TestRail Tests

  • TestRail Test Field Mappings

    TestRail Field	Model Field
    Title	Summary
    ID	TestRail ID
    Location	TestRail URL
    Test Run ID	Test Run ID
    Status	Test Result Status

  • TestRail Test Relationship Mappings

    TestRail Relationship	Model Relationship
    Test Case	Parent

Integrations

The first integration is of type Container + Work item synchronization, and uses the collections for Jama Sets, TestRail Test Suites, Jama Folders, TestRail Test Sections, as well as Jama Test Cases and TestRail Test Cases.

The second Integration is of type Work Item synchronization and uses the collections for Jama Test Results and TestRail Tests.

• Test Cases Integration
  • Type: Container + Work Items Synchronization
    • Collections
      • Container
        • Jama Sets <> TestRail Test Suites
        • Container Mirroring
          • Jama Component that shall contain Sets of Test Case items <> Test Rail Project
        • Jama Folders <> TestRail Sections
    • Work Item
      • Jama Test Cases <> TestRail Test Cases
        • Test Steps Flow
          • One Way - Jama Connect accepts Test Steps
• Test Results Integration
  • Type: Work Items Synchronization
    • Collection
      • Work Items
        • Jama Test Results < Test Rail Tests