Skip to main content
Planview Customer Success Center

Jama

Overview

Planview Hub offers integration solutions to flow test artifacts such as test results, test steps, and their associated tests, test runs, test instances, and folder structures.

Please review the sections below to learn more about supported test scenarios using Jama.

           

Jama & TestRail

In this integration scenario, a tester creates a test case in Jama. Hub will flow the test case, along with its fields and sub-entities to TestRail, so that the tester in TestRail can begin running her tests. Hub will then flow the test results back over to Jama to maintain full visibility across the lifecycle.

Screenshot 2024-04-26 at 11.48.38 AM.png

The goal of this integration scenario is to synchronize the TestRail Test Case artifact with the Jama Test Case artifact, while including the Test Results that exist on the related TestRail Test artifact. To do this, you'll need to configure the following integrations:

  • Jama Test Sets <> TestRail Test Suites
  • Jama Test Set Folders <> TestRail Test Sections
  • Jama Test Cases <> TestRail Test Cases
  • Jama Test Results <- TestRail Tests

See the instructions below to configure this integration scenario.

Connect to your Repositories

First, connect to your repository by following the instructions here.

You can learn more about connector-specific configuration in our Connector Docs.

Set Up your Model

Review general details on creating or reusing a model.

For this integration scenario, you will need to add the following fields to your model:

Smart Field Label Type Field Values
Summary Summary String N/A
Description Description Rich Text N/A
Formatted ID Formatted ID String N/A
Location URL Location N/A
Parent Artifact Parent Relationship N/A
None Key Relationship N/A
None Parents Relationships N/A
None Test Suite Relationship N/A
Created Created Date Time N/A
Modified Modified Date Time N/A
None TestRail ID String N/A
None TestRail URL String N/A
None Test Run ID String N/A
None Jama ID String N/A
None Jama URL String N/A

Test Steps

Smart Field Label Type Field Values
Summary Summary String N/A
Action Action String N/A
Expected Result Expected Result String N/A

 

Jama

You will need to add the following custom fields to your Jama instance:

Name Type
TestRail ID String
TestRail URL String
Test Run ID String

TestRail

You will need to add the following custom fields to your TestRail instance:

Name Type
Jama ID String
Jama URL String
Test Run ID String

Create your Collections

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Jama

For this integration scenario, you'll need to configure the following Jama collections:

Work Item Collections

  • Jama Test Cases
  • Jama Test Results

Container Collections

  • Jama Test Sets
  • Jama Test Set Folders
Field Mapping

Map the following Jama fields to the model:

Collection Jama Field Model Field
Jama Test Cases Name Summary
Description Description
TestRail ID TestRail ID
TestRail URL TestRail URL
ID Jama ID
URL Jama URL
Jama Test Results Name Summary
TestRail ID TestRail ID
TestRail URL TestRail URL

Test Run ID

Test Run ID
Test Result Status Constant Value
Jama Test Sets Name Summary
Description Description
TestRail ID TestRail ID
TestRail URL TestRail URL
Set Key Constant Value
Child Item Type Constant Value
Jama Test Set Folders Name Summary
Description Description
Test Step Field Mapping

Map the following Jama fields to the model:

Collection Jama Field Model Field
Jama Test Cases Notes Summary
Action Action
Expected Result Expected Result
Relationship Specification

Configure the following relationship mappings:

Collection Jama Field Model Field
Jama Test Cases Parent Artifact Parents
Set Test Suite
Jama Test Results Parent Artifact Parent
Jama Test Set Folders Parent Artifact Parent
Set Key

TestRail

For this integration scenario, you'll need to configure the following TestRail collections:

Work Item Collections

  • TestRail Test Cases
  • TestRail Tests

Container Collections

  • TestRail Test Suites
  • TestRail Test Sections
Field Mapping

Map the following TestRail fields to the model:

Collection TestRail Field Model Field
TestRail Test Cases 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
TestRail Tests Title Summary
ID TestRail ID
Location TestRail URL
Test Run ID Test Run ID
Status Constant Value Based on Projects
TestRail Test Suites Name Summary
Description Description
ID TestRail ID
Location TestRail URL
TestRail Test Sections Name Summary
Description Description
Test Step Field Mapping

Map the following TestRail fields to the model:

Collection TestRail Field Model Field
TestRail Test Cases Step Description Action
Expected Result Expected Result
Relationship Specification

Configure the following relationship mappings:

Collection TestRail Field Model Field
TestRail Test Cases Section Parents
Test Suite / Baseline Test Suite
TestRail Tests Test Case Parent
TestRail Test Sections Parent Section Parent
Test Suite / Baseline Key

Configure your Integrations

You can learn general details on configuring integrations here: 

For this integration scenario, you will need to configure the following integrations:

  • Jama Test Sets, Test Case Folders & Test Cases <> TestRail Test Suites, Test Sections, & Test Cases
  • Jama Test Results <- TestRail Tests

Review the details in the table below to ensure that your integrations are configured correctly.

Integration Integration Type Artifact Creation Flow Artifact Routing/Container Mirroring Test Step Flow
Jama Test Sets, Test Case Folders & Test Cases <> TestRail Test Suites, Test Sections Container + Work Item Synchronization Two-way Creation Jama <> TestRail

One-way Flow 

Jama accepts test steps

Jama Test Results & TestRail Tests

Work Item Synchronization

One-way Creation

Jama accepts new artifacts

Jama <- TestRail N/A

Functional Limitations

Category Limitation Applicable Repository Version
Third Party API Limitation

Test Steps

Test Steps can be enabled in Test Cases but can only flow in one direction.

Any supported repository version:

Configuration Requirement

Test Steps

You must select the Test Case test step type in TestRail to utilize test steps.

Any supported repository version:

Configuration Requirement

Priority Field

The Priority field must be specified on the Test Case artifact.

Any supported repository version:

Good to Know

Test Results

Test Results is a custom work item created in Jama.

Any supported repository version:

 

           

           

Jama & Microsoft Azure DevOps

In this integration scenario, a Requirement is created in Jama. Hub will flow the Requirement into Azure DevOps as an Epic. A test case is then created in Azure DevOps and synchronized over to Jama. When the tester in Azure DevOps begins running his tests, Hub will flow the test results back over to Jama to maintain full visibility across the lifecycle.

Screenshot 2024-04-22 at 11.47.54 AM.png

The goal of this integration scenario is to synchronize Test Results from Azure DevOps over to Jama. To do this, you'll need to configure the following integrations:

  • Jama Requirements <> Azure DevOps Epics
  • Jama Test Cases <> Azure DevOps Test Cases
  • Jama Test Results <- Azure DevOps Test Results

Connect to your Repositories

First, connect to your repository by following the instructions here.

You can learn more about connector-specific configuration in our Connector Docs.

Set Up your Model

Review general details on creating or reusing a model.

For this integration scenario, you will need to add the following fields to your model:

Smart Field Label Type Field Values
Summary Summary String N/A
Description Description Rich Text N/A
Priority Priority Single Select Blocker, Critical, High, Medium, Low
Status Status Single Select New, To Do, In Progress, Done
Formatted ID Formatted ID String N/A
Created Created Date Time N/A
Modified Modified Date Time N/A
Location URL Location N/A
Parent Artifact Parent Relationship N/A
None Related Relationships N/A
None Test Coverage Relationships N/A
None Azure DevOps ID String N/A
None Azure DevOps URL String N/A
None Jama ID String N/A
None Jama URL String N/A
None ADO Test Result Status Single Select Passed, Warning, Not Executed, Timeout, Failed, Inconclusive, Error, In Progress, Unspecified, Not Applicable, Aborted, None, Blocked, Paused

 

Jama

You will need to add the following custom fields to your Jama instance:

Name Type
Azure DevOps ID String
Azure DevOps URL String

Azure DevOps

You will need to add the following custom fields to your Azure DevOps instance:

Name Type
Jama ID String
Jama URL String

Create your Collections

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Jama

For this integration scenario, you'll need to configure the following Jama collections:

Work Item Collections

  • Jama Requirements
  • Jama Test Cases
  • Jama Test Results
Field Mapping

Map the following Jama fields to the model:

Collection Jama Field Model Field
Jama Requirements Name Summary
Description Description
Priority Priority
ADO ID Azure DevOps ID
ADO URL Azure DevOps URL
ID Jama ID
URL Jama URL
Jama Test Cases Name Summary
Description Description
Priority Priority
Status Status
ADO ID Azure DevOps ID
ADO URL Azure DevOps URL
ID Jama ID
URL Jama URL
Jama Test Results Name Summary
ADO ID Azure DevOps ID
ADO URL Azure DevOps URL
Test Result Status ADO Test Result Status
Relationship Specification

Configure the following relationship mappings:

Collection Jama Field Model Field
Jama Requirements Parent Artifact Parent
Jama Test Cases Related to upstream Related
Jama Test Results Parent upstream Test Coverage

Azure DevOps

For this integration scenario, you'll need to configure the following Azure DevOps collections:

Work Item Collections

  • Azure DevOps Epics
  • Azure DevOps Test Cases
  • Azure DevOps Test Results
Field Mapping

Map the following Azure DevOps fields to the model:

Collection Azure DevOps Field Model Field
Azure DevOps Epics Title Summary
Description Description
Priority Priority
Formatted ID Azure DevOps ID
URL Azure DevOps URL
Jama ID Jama ID
Jama URL Jama URL
Iteration Path Constant Value Based on Projects
Area Path Constant Value Based on Projects
Azure DevOps Test Cases Title Summary
Description Description
Priority Priority
State Status
Formatted ID Azure DevOps ID
URL Azure DevOps URL
Jama ID Jama ID
Jama URL Jama URL
Iteration Path Constant Value Based on Projects
Area Path Constant Value Based on Projects
Azure DevOps Test Results Test Case Title Summary
Formatted ID Azure DevOps ID
URL Azure DevOps URL
Outcome ADO Test Result Status
Configuration Constant Value
Relationship Specification

Configure the following relationship mappings:

Collection Azure DevOps Field Model Field
Azure DevOps Epics Parent Parent
Azure DevOps Test Cases Related Related
Parent Constant Value
Azure DevOps Test Results Parent Test Case Test Coverage
Parent Test Plan Constant Value

Configure your Integrations

You can learn general details on configuring integrations here: 

For this integration scenario, you will need to configure the following integrations:

  • Jama Requirements <> Azure DevOps Epics
  • Jama Test Cases <> Azure DevOps Test Cases
  • Jama Test Results <- Azure DevOps Test Results

Review the details in the table below to ensure that your integrations are configured correctly.

Integration Integration Type Artifact Creation Flow Artifact Routing

Jama Requirements <> Azure DevOps Epics

Work Item Synchronization Two-way creation Jama <> ADO

Jama Test Cases <> Azure DevOps Test Cases

Work Item Synchronization Two-way creation Jama <> ADO

Jama Test Results <- Azure DevOps Test Results

Work Item Synchronization

One-way creation 

Jama <- ADO

Jama <- ADO

Functional Limitations

Category Limitation Applicable Repository Version
Third Party API Limitation

Test Steps

Test steps are not supported in Azure DevOps.

Any supported repository version:

Third Party API Limitation

Test Results

Test Results are One direction from ADO to Jama because ADO Test Run must be specified.

Any supported repository version:

 

           

           

Jama & Micro Focus ALM/QC

In this integration scenario, a tester creates a requirement & test case in Jama. Hub will flow the test case and requirement, along with their fields to ALM, so that the tester in ALM can begin running her tests. Hub will then flow the test results back over to Jama to maintain full visibility across the lifecycle.

Screenshot 2024-05-22 at 2.15.01 PM.png

The goal of this integration scenario is to synchronize the ALM Test artifact with the Jama Test Case artifact, while including the Test Results that exist on the related ALM Test artifact. To do this, you'll need to configure the following integrations:

  • Jama Requirement Folders & Requirements <> ALM Requirement Folders & Requirements
  • Jama Test Case Folders & Test Cases <> ALM Test Folders & Tests
  • Jama Test Results <- ALM Test Runs
  • Jama Defects <> ALM Defects

See the instructions below to configure this integration scenario.

Connect to your Repositories

First, connect to your repository by following the instructions here.

You can learn more about connector-specific configuration in our Connector Docs.

Set Up your Model

Review general details on creating or reusing a model.

For this integration scenario, you will need to add the following fields to your model:

Smart Field Label Type Field Values
Summary Summary String N/A
Description Description Rich Text N/A
Priority Priority Single Select Blocker, Critical, High, Medium, Low
Status Status Single Select New, To Do, In Progress, Done
Formatted ID Formatted ID String N/A
Location URL Location N/A
Parent Artifact Parent Relationship N/A
None Parents Relationships N/A
None Test Coverage Relationships N/A
Created Created Date Time N/A
Modified Modified Date Time N/A
None ALM ID String N/A
None ALM URL String N/A
None Jama ID String N/A
None Jama URL String N/A

Test Steps

Smart Field Label Type Field Values
Summary Summary String N/A
Action Action String N/A
Expected Result Expected Result String N/A
Id Id String N/A
Status Status Single Select Passed, Failed, Not Completed
None Step Name String N/A

 

Jama

You will need to add the following custom fields to your Jama instance:

Name Type
ALM ID String
ALM URL String

ALM

You will need to add the following custom fields to your ALM instance:

Name Type
Jama ID String
Jama URL String

Create your Collections

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Jama

For this integration scenario, you'll need to configure the following Jama collections:

Work Item Collections

  • Jama Requirements
  • Jama Test Cases
  • Jama Test Results
  • Jama Defects

Container Collections

  • Jama Requirement Folders
  • Jama Test Case Folders
Field Mapping

Map the following Jama fields to the model:

Collection Jama Field Model Field
Jama Requirements Name Summary
Description Description
Priority Priority
Created Date Created
ALM ID ALM ID
ALM URL ALM URL
Jama Test Cases Name Summary
Description Description
Phase Status
Created Date Created
ALM ID ALM ID
ALM URL ALM URL
ID Jama ID
URL Jama URL
Jama Test Results Name Summary
Description Description
Jama Defects Name Summary
Description Description
Priority Priority
Status Status
Created Date Created
ALM ID ALM ID
ALM URL ALM URL
ID Jama ID
URL Jama URL
Jama Requirement Folders Name Summary
Description Description
Created Date Created
Jama Test Case Folders Name Summary
Description Description
Test Step Field Mapping

Map the following Jama fields to the model:

Collection Jama Field Model Field
Jama Test Cases Notes Summary
Action Action
Expected Result Expected Result
Jama Test Results Notes Summary
Action Action
Expected Result Expected Result
Relationship Specification

Configure the following relationship mappings:

Collection Jama Field Model Field
Jama Requirements Parent Artifact Parent
Jama Test Cases Parent Artifact Parents
Jama Test Results Parent upstream Test Coverage
Jama Requirement Folders Parent Artifact Parent
Jama Test Case Folders Parent Artifact  Parent

ALM

For this integration scenario, you'll need to configure the following ALM collections:

Work Item Collections

  • ALM Requirements
  • ALM Tests
  • ALM Test Runs
  • ALM Defects

Container Collections

  • ALM Requirement Folders
  • ALM Test Folders
Field Mapping

Map the following ALM fields to the model:

Collection ALM Field Model Field
ALM Requirements Name Summary
Description Description
Priority Priority
Creation Date Created
Formatted ID ALM ID
URL ALM URL
ALM Tests Test Name Summary
Description Description
Status Status
Creation Date Created
Formatted ID ALM ID
URL ALM URL
Jama ID Jama ID
Jama URL Jama URL
ALM Test Runs Run Name Summary
Test Description Description
Tester Constant Value
ALM Defects Summary Summary
Description Description
Priority Priority
Status Status
Detected on Date Created
Formatted ID ALM ID
URL ALM URL
Severity Constant Value
Detected By Constant Value
Jama ID Jama ID
Jama URL Jama URL
ALM Requirement Folders Name Summary
Description Description
Creation Date Created
ALM Test Folders Name Summary
Description Description
Test Step Field Mapping

Map the following ALM fields to the model:

Collection ALM Field Model Field
ALM Tests Description Action
Expected Result Expected Result
Step ID Id
Step Name Summary
Step Name Step Name
ALM Test Runs Description Action
Expected Expected Result
Step ID Id
Status Status
Step Name Summary
Step Name Step Name
Relationship Specification

Configure the following relationship mappings:

Collection ALM Field Model Field
ALM Requirements Parent Folder Parent
ALM Tests Requirement Coverage Parents
ALM Test Runs Test Instance Test Coverage
ALM Requirement Folders Parent Folder Parent
ALM Test Folders Parent Folder Parent

Configure your Integrations

You can learn general details on configuring integrations here: 

For this integration scenario, you will need to configure the following integrations:

  • Jama Requirement Folders & Requirements <> ALM Requirement Folders & Requirements
  • Jama Test Case Folders & Test Cases <> ALM Test Folders & Tests
  • Jama Test Results <- ALM Test Runs
  • Jama Defects <> ALM Defects

Review the details in the table below to ensure that your integrations are configured correctly.

Integration Integration Type Artifact Creation Flow Artifact Routing/Container Mirroring Test Step Flow
Jama Requirement Folders & Requirements <> ALM Requirement Folders & Requirements Container + Work Item Synchronization Two-way Creation Jama <> ALM

N/A

Jama Test Case Folders & Test Cases <> ALM Test Folders & Tests Container + Work Item Synchronization Two-way Creation Jama <> ALM

One-way Flow

Jama accepts test steps

Jama Test Results <- ALM Test Runs Work Item Synchronization Two-way Creation Jama <> ALM No Flow
Jama Defects <> ALM Defects Work Item Synchronization Two-way Creation Jama <> ALM N/A

Functional Limitations

Category Limitation Applicable Repository Version
Good to Know

Test Results

Test Results are a custom work item created in Jama.

Any supported repository version:

 

           

           

Jama & Micro Focus ALM Octane

In this integration scenario, a tester creates a set of requirements in Jama. Hub will flow the requirements over to Octane, so that the tester in Octane can begin designing running his tests. Hub will then flow the test results back over to Jama to maintain full visibility across the lifecycle.

Screenshot 2024-05-30 at 11.05.01 AM.png

The goal of this integration scenario is to synchronize the Octane Test artifact with the Jama Test Case artifact, while including the Test Runs that exist on the Octane Test artifact. To do this, you'll need to configure the following integrations:

  • Jama Requirement Folders & Requirements <> Octane Requirement Folders & Requirements
  • Jama Test Case Folders <> Octane Test Suites
  • Jama Test Cases <> Octane Tests
  • Jama Test Results <> Octane Test Runs
  • Jama Defects <> Octane Defects

See the instructions below to configure this integration scenario.

Connect to your Repositories

First, connect to your repository by following the instructions here.

You can learn more about connector-specific configuration in our Connector Docs.

Set Up your Model

Review general details on creating or reusing a model.

For this integration scenario, you will need to add the following fields to your model:

Smart Field Label Type Field Values
Summary Summary String N/A
Description Description Rich Text N/A
Formatted ID Formatted ID String N/A
Location URL Location N/A
Status Status Single Select New, To Do, In Progress, Done
Parent Artifact Parent Relationship N/A
Created Created Date Time N/A
Modified Modified Date Time N/A
None Octane ID String N/A
None Octane URL String N/A
None Jama ID String N/A
None Jama URL String N/A

Test Steps

Smart Field Label Type Field Values
Summary Summary String N/A
Action Action String N/A
Expected Result Expected Result String N/A
Id Id String N/A
Status Status Single Select Passed, Failed, Not Completed

 

Jama

You will need to add the following custom fields to your Jama instance:

Name Type
Octane ID String
Octane URL String

Octane

You will need to add the following custom fields to your Octane instance:

Name Type
Jama ID String
Jama URL String

Create your Collections

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Jama

For this integration scenario, you'll need to configure the following Jama collections:

Work Item Collections

  • Jama Requirements
  • Jama Test Cases
  • Jama Test Results
  • Jama Defects

Container Collections

  • Jama Requirement Folders
  • Jama Test Case Folders
Field Mapping

Map the following Jama fields to the model:

Collection Jama Field Model Field
Jama Requirements Name Summary
Description Description
Status Status
ID Jama ID
URL Jama URL
Octane ID Octane ID
Octane URL Octane URL
Jama Test Cases Name Summary
Description Description
Phase Status
Octane ID Octane ID
Octane URL Octane URL
ID Jama ID
URL Jama URL
Jama Test Results Name Summary
Description Description
Jama Defects Name Summary
Description Description
Priority Priority
Status Status
ID Jama ID
URL Jama URL
Octane ID Octane ID
Octane URL Octane URL
Jama Requirement Folders Name Summary
Description Description
Jama Test Case Folders Name Summary
Description Description
Test Step Field Mapping

Map the following Jama fields to the model:

Collection Jama Field Model Field
Jama Test Cases Notes Summary
Action Action
Expected Result Expected Result
Jama Test Results Notes Summary
Action Action
Expected Result Expected Result
Relationship Specification

Configure the following relationship mappings:

Collection Jama Field Model Field
Jama Requirement Folders Parent Artifact Parent
Jama Defects Parent Artifact Parent

Octane

For this integration scenario, you'll need to configure the following Octane collections:

Work Item Collections

  • Octane Requirements
  • Octane Tests
  • Octane Test Runs
  • Octane Defects

Container Collections

  • Octane Requirement Folders
  • Octane Test Suites
Field Mapping

Map the following Octane fields to the model:

Collection Octane Field Model Field
Octane Requirements Name Summary
Description Description
Phase Status
Formatted ID  Octane ID
URL Octane URL
Jama ID Jama ID
Jama URL Jama URL
Octane Tests Name Summary
Description Description
Phase Status
Formatted ID Octane ID
URL Octane URL
Jama ID Jama ID
Jama URL Jama URL
Octane Test Runs Name Summary
Description Description
Release Constant Value
Octane Defects Name Summary
Description Description
Priority Priority
Phase Status
Formatted ID Octane ID
URL Octane URL
Jama ID Jama ID
Jama URL Jama URL
Octane Requirement Folders Name Summary
Description Description
Octane Test Suites Name Summary
Description Description
Application modules Constant Value
Test Step Field Mapping

Map the following Octane fields to the model:

Collection Octane Field Model Field
Octane Tests Description Action
Octane Test Runs Actual Action
Description Expected Result
ID Id
Result Status
Relationship Specification

Configure the following relationship mappings:

Collection Octane Field Model Field
Octane Requirement Folders Parent Artifact Parent
Octane Requirements Parent Constant Value
Octane Defects Feature Parent

Configure your Integrations

You can learn general details on configuring integrations here: 

For this integration scenario, you will need to configure the following integrations:

  • Jama Requirement Folders & Requirements <> Octane Requirement Folders & Requirements
  • Jama Test Case Folders <> Octane Test Suites
  • Jama Test Cases <> Octane Tests
  • Jama Test Results <> Octane Test Runs
  • Jama Defects <> Octane Defects

Review the details in the table below to ensure that your integrations are configured correctly.

Integration Integration Type Artifact Creation Flow Artifact Routing/Container Mirroring Test Step Flow
Jama Requirement Folders & Requirements <> Octane Requirement Folders & Requirements Container + Work Item Synchronization Two-way Creation Jama <> Octane

N/A

Jama Test Case Folders <> Octane Test Suites

Container + Work Item Synchronization

Two-way Creation

Jama <> Octane N/A
Jama Test Cases <> Octane Tests Work Item Synchronization Two-way Creation Jama <> Octane

One-way Flow

Octane accepts test steps

Jama Test Results <> Octane Test Runs Work Item Synchronization Two-way Creation Jama <> Octane

One-way Flow

Jama accepts test steps

Jama Defects <> Octane Defects Work Item Synchronization Two-way Creation Jama <> Octane N/A

Functional Limitations

Category Limitation Applicable Repository Version
Configuration Requirement

Test Steps

Test Steps can be enabled in Test Cases but you must select the direction to flow upon initial configuration.

Any supported repository version:

Good to Know

Test Steps

Test Steps on Test Results only flow one-way into Jama.

Any supported repository version:

Third Party API Limitation

Tests

Octane Tests cannot be linked to Test Suites.

Any supported repository version:

Good to Know

Test Results

Test Results is a custom work item created in Jama.

Any supported repository version:

 

           

           

Jama & Jira Xray

In this integration scenario, a tester creates a requirement folder with requirements in Jama. Hub will flow the requirements along with its fields to Xray, so that the tester in Xray can begin designing and running her tests. Hub will then flow the test results and defects back over to Jama to maintain full visibility across the lifecycle.

Screenshot 2024-05-29 at 2.43.45 PM.png

The goal of this integration scenario is to synchronize the Xray Test artifact with the Jama Test Case artifact, while including the test results and bugs from the Xray Test artifact. To do this, you'll need to configure the following integrations:

  • Jama Requirement Folders <> Xray Epics
  • Jama Requirements <> Xray Stories
  • Jama Test Case Folders <> Xray Test Sets
  • Jama Test Cases <> Xray Tests
  • Jama Test Result Folders <> Xray Test Executions
  • Jama Test Results <> Xray Test Runs
  • Jama Defects <> Xray Bugs

See the instructions below to configure this integration scenario.

Connect to your Repositories

First, connect to your repository by following the instructions here.

You can learn more about connector-specific configuration in our Connector Docs.

Set Up your Model

Review general details on creating or reusing a model.

For this integration scenario, you will need to add the following fields to your model:

Smart Field Label Type Field Values
Summary Summary String N/A
Description Description Rich Text N/A
Formatted ID Formatted ID String N/A
Location URL Location N/A
Status Status Single Select New, To Do, In Progress, Done
Priority Priority Single Select Blocker, Critical, High, Medium, Low
Parent Artifact Parent Relationship N/A
None Parents Relationships N/A
Created Created Date Time N/A
Modified Modified Date Time N/A
None Xray ID String N/A
None Xray URL String N/A
None Jama ID String N/A
None Jama URL String N/A

Test Steps

Smart Field Label Type Field Values
Summary Summary String N/A
Action Action String N/A
Expected Result Expected Result String N/A
Id Id String N/A

 

Jama

You will need to add the following custom fields to your Jama instance:

Name Type
Xray ID String
Xray URL String

Xray

You will need to add the following custom fields to your Xray instance:

Name Type
Jama ID String
Jama URL String

Create your Collections

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Jama

For this integration scenario, you'll need to configure the following Jama collections:

Work Item Collections

  • Jama Requirement Folders
  • Jama Requirements
  • Jama Test Case Folders
  • Jama Test Cases
  • Jama Test Result Folders
  • Jama Test Results
  • Jama Defects
Field Mapping

Map the following Jama fields to the model:

Collection Jama Field Model Field
Jama Requirement Folders Name Summary
Description Description
Xray ID Xray ID
Xray URL Xray URL
ID Jama ID
URL Jama URL
Jama Requirements Name Summary
Description Description
Status Status
Xray ID Xray ID
Xray URL Xray URL
ID Jama ID
URL Jama URL
Jama Test Case Folders Name Summary
Description Description
Xray ID Xray ID
Xray URL Xray URL
ID Jama ID
URL Jama URL
Jama Test Cases Name Summary
Description Description
Phase Status
Xray ID Xray ID
Xray URL Xray URL
ID Jama ID
URL Jama URL
Jama Test Result Folders Name Summary
Description Description
Xray ID Xray ID
Xray URL Xray URL
ID Jama ID
URL Jama URL
Jama Test Results Name Summary
Xray ID Xray ID
Test Result Status Constant Value
Jama Defects Name Summary
Description Description
Priority Priority
Status Status
Xray ID Xray ID
Xray URL Xray URL
ID Jama ID
URL Jama URL
Test Step Field Mapping

Map the following Jama fields to the model:

Collection Jama Field Model Field
Jama Test Cases Notes Summary
Action Action
Expected Result Expected Result
Relationship Specification

Configure the following relationship mappings:

Collection Jama Field Model Field
Jama Requirements Parent Artifact Parent
Jama Test Cases Parent Artifact Parents
Jama Test Results Parent Artifact Parent
Jama Defects Parent Artifact Parent

Xray

For this integration scenario, you'll need to configure the following Xray collections:

Work Item Collections

  • Xray Epics
  • Xray Stories
  • Xray Test Sets
  • Xray Tests
  • Xray Test Executions
  • Xray Test Runs
  • Xray Bugs
Field Mapping

Map the following Xray fields to the model:

Collection Xray Field Model Field
Xray Epics Summary Summary
Epic Name Summary
Description Description
Key Xray ID
URL Xray URL
Jama ID Jama ID
Jama URL Jama URL
Priority Constant Value
Xray Stories Summary Summary
Description Description
Status Status
Key Xray ID
URL Xray URL
Jama ID Jama ID
Jama URL Jama URL
Priority Constant Value
Xray Test Sets Summary Summary
Description Description
Key Xray ID
URL Xray URL
Jama ID Jama ID
Jama URL Jama URL
Priority Constant Value
Xray Tests Summary Summary
Description Description
Status Status
Key Xray ID
URL Xray URL
Jama ID Jama ID
Jama URL Jama URL
Priority Constant Value
Xray Test Executions Summary Summary
Description Description
Key  Xray ID
URL Xray URL
Jama ID Jama ID
Jama URL Jama URL
Priority Constant Value
Xray Test Runs Summary Summary
Formatted ID Xray ID
Xray Bugs Summary Summary
Description Description
Priority Priority
Status Status
Key Xray ID
URL Xray URL
Jama ID Jama ID
Jama URL Jama URL
Test Step Field Mapping

Map the following Xray fields to the model:

Collection Xray Field Model Field
Xray Tests Test Step Action Action
Expected Result Expected Result
Id Id
Relationship Specification

Configure the following relationship mappings:

Collection Xray Field Model Field
Xray Stories Epic Link Parent
Xray Tests Test Sets association with a test Parents
Xray Test Runs Test Run Test Execution key Parent
Xray Bugs Epic Link Parent

Configure your Integrations

You can learn general details on configuring integrations here: 

For this integration scenario, you will need to configure the following integrations:

  • Jama Requirement Folders <> Xray Epics
  • Jama Requirements <> Xray Stories
  • Jama Test Case Folders <> Xray Test Sets
  • Jama Test Cases <> Xray Tests
  • Jama Test Result Folders <> Xray Test Executions
  • Jama Test Results <> Xray Test Runs
  • Jama Defects <> Xray Bugs

Review the details in the table below to ensure that your integrations are configured correctly.

Integration Integration Type Artifact Creation Flow Artifact Routing/Container Mirroring Test Step Flow
Jama Requirement Folders <> Xray Epics Work Item Synchronization Two-way Creation Jama <> Xray

N/A

Jama Requirements <> Xray Stories

Work Item Synchronization

Two-way Creation

Jama <> Xray N/A
Jama Test Case Folders <> Xray Test Sets Work Item Synchronization Two-way Creation Jama <> Xray N/A
Jama Test Cases <> Xray Tests Work Item Synchronization Two-way Creation Jama <> Xray

One-way Flow

Jama accepts test steps

Jama Test Result Folders <> Xray Test Executions Work Item Synchronization Two-way Creation Jama <> Xray N/A
Jama Test Results <> Xray Test Runs Work Item Synchronization Two-way Creation Jama <> Xray N/A
Jama Defects <> Xray Bugs Work Item Synchronization Two-way Creation Jama <> Xray N/A

Functional Limitations

Category Limitation Applicable Repository Version
Configuration Requirement

Relationship Specification

The Story/Task relationship must use the Epic Link relationship rather than the Parent Link to enable bidirectional relationship flow.

Any supported repository version:

Good to Know

Test Steps for Test Cases

Test Steps For Test Cases flow one-way from Xray to Jama.

Any supported repository version:

 

           

           

Jama & Tricentis Tosca

In this integration scenario, a Test Case is created in Jama. Hub will flow the Test Case over to Tosca. When the tester in Tosca begins running his tests, Hub will flow the test results back over to Jama to maintain full visibility across the lifecycle.

Screenshot 2024-04-29 at 11.09.26 AM.png

The goal of this integration scenario is to synchronize Test Cases and Test Results between Jama and Tosca. To do this, you'll need to configure the following integrations:

  • Jama Test Case Folders & Test Cases <> Tosca Test Case Folders & Test Cases
  • Jama Test Result Folders & Test Results <> Tosca Execution Lists & Execution Entries

Connect to your Repositories

First, connect to your repository by following the instructions here.

You can learn more about connector-specific configuration in our Connector Docs.

Set Up your Model

Review general details on creating or reusing a model.

For this integration scenario, you will need to add the following fields to your model:

Smart Field Label Type Field Values
Summary Summary String N/A
Description Description Rich Text N/A
Status Status Single Select New, To Do, In Progress, Done
None Parents Relationships N/A
Parent Artifact Parent Relationship N/A
Formatted ID Formatted ID String N/A
Created Created Date Time N/A
Modified Modified Date Time N/A
Location URL Location N/A
None Tosca ID String N/A
None Tosca URL String N/A
None Test Status Single Select Untested, Blocked, Failed, Retest, Passed

Jama

You will need to add the following custom fields to your Jama instance:

Name Type
Tosca ID String
Tosca URL String

Create your Collections

You can learn general details on configuring collections here:

Review the details in the sections below to ensure that any required fields are mapped in your collections.

Jama

For this integration scenario, you'll need to configure the following Jama collections:

Work Item Collections

  • Jama Test Cases
  • Jama Test Results

Container Collections

  • Jama Test Case Folders
  • Jama Test Result Folders
Field Mapping

Map the following Jama fields to the model:

Collection Jama Field Model Field
Jama Test Case Folders Name Summary
Description Description
Jama Test Cases Name Summary
Description Description
Phase Status
Tosca ID Tosca ID
Tosca URL Tosca URL
Jama Test Result Folders Name Summary
Description Description
Jama Test Results Name Summary
Test Result Status Test Status
Tosca ID Tosca ID
Tosca URL Tosca URL
Test Step Field Mapping

Map the following Jama fields to the model:

Collection Jama Field Model Field
Jama Test Cases Notes Summary
Action Action
Expected Result Expected Result
Relationship Specification

Configure the following relationship mappings:

Collection Jama Field Model Field
Jama Test Case Folders Parent Artifact Parent
Jama Test Cases Parent Artifact Parents
Jama Test Results Parent Artifact Parent

Tosca

For this integration scenario, you'll need to configure the following Tosca collections:

Work Item Collections

  • Tosca Test Cases
  • Tosca Execution Entries

Container Collections

  • Tosca Test Case Folders
  • Tosca Execution Lists
Field Mapping

Map the following Tosca fields to the model:

Collection Tosca Field Model Field
Tosca Test Case Folders Name Summary
Description Description
Tosca Test Cases Name Summary
Description Description
TestCaseWorkState Status
Formatted ID Tosca ID
URL Tosca URL
SynchronizationPolicy Constant Value
Tosca Execution Lists Name Summary
Description Description
Tosca Execution Entries Name Summary
Actual Result Test Status
ID Tosca ID
Formatted ID Tosca URL
Test Step Field Mapping

Map the following Tosca fields to the model:

Collection Tosca Field Model Field
Tosca Test Cases Name Action
UniqueId Id
Test Step JSON Test Step JSON
Relationship Specification

Configure the following relationship mappings:

Collection Tosca Field Model Field
Tosca Test Case Folders Parent Folder Parent
Tosca Test Cases Test Folder Parents
Tosca Execution Entries Execution List Parent

Configure your Integrations

You can learn general details on configuring integrations here: 

For this integration scenario, you will need to configure the following integrations:

  • Jama Test Case Folders & Test Cases <> Tosca Test Case Folders & Test Cases
  • Jama Test Result Folders & Test Results <> Tosca Execution Lists & Execution Entries

Review the details in the table below to ensure that your integrations are configured correctly.

Integration Integration Type Artifact Creation Flow Artifact Routing/Container Mirroring
Jama Test Case Folders & Test Cases <> Tosca Test Case Folders & Test Cases Container + Work Item Synchronization Two-way Creation

Jama <> Tosca 

Jama Test Result Folders & Test Results <> Tosca Execution Lists & Execution Entries Container + Work Item Synchronization

Two-way Creation

Jama Test Result Folders <> Tosca Execution Lists

One-way Creation

Jama Test Results <- Tosca Execution Entries

Jama Test Result Folders <> Tosca Execution Lists

Jama Test Results <- Tosca Execution Entries

Functional Limitations

Category Limitation Applicable Repository Version
Configuration Requirement

Test Steps

Test Steps are supported on Test Cases but you must select the direction you'd like them to flow upon initial integration configuration.

Any supported repository version:

Feature Unsupported

Test Step Results

Test Step Results are not supported.

Any supported repository version:

Third Party API Limitation

Execution Entries

The Execution Entry artifact in Tosca only includes read-only fields. As a result, the Tosca Execution Entry & Jama Test Results integration must be one-way from Tosca to Jama.

Any supported repository version:

 

           

           

Synchronizing Jama & Octane Test Steps

Use the instructions below to configure the following integrations:

  • Jama Test Steps → Jama Test Steps
  • Jama Test Steps → Octane Test Steps
  • Octane Test Steps → Jama Test Steps

Step 1: Connect to your Repository

First, connect to your repository by following the instructions here

You can learn more about Jama-specific configuration in our Connector Docs.

Step 2: Construct your Model

To flow test steps, you will need to add the Test Steps entity when creating your Test model.

To do this, click + Add Entity and select the Test Steps option.

Screenshot 2023-07-07 at 10.59.01 AM.png

A Test Steps entity will be added. On the Model Configuration screen, you will then see two panels:

  1. Test Fields: In the top section, add any fields you'd like to flow on the test (or test run) artifact that are not part of its associated test steps.
  2. Test Step Fields: In the bottom section, add any fields you'd like to flow that are a part of test steps. You'll see that Hub provides some Smart Fields that are test step specific to help you get started, but you can add any other desired fields by leaving the Smart Field blank.

Note: All test steps fields must be of the same type (i.e., all must be string fields or all must be rich text fields), as you cannot configure different types for each test step field in Jama.

Screenshot 2023-07-07 at 10.59.55 AM.png

Here is an example of a very simple Test Model with Test Steps:

Screenshot 2023-07-07 at 11.02.52 AM.png

You can find general details on how to create a model here.

Step 3: Create your Collection

You can find general details on how to create a collection here.

You will see a Map Test Fields sash on your collection if:

  • Your model is a Model with Test Steps, and
  • Your artifact is an Octane Test, or Jama Test Case

Screenshot 2023-07-18 at 4.41.19 PM.png

The process to map test step fields is very similar to the process on the normal Field Mapping screen. Note that both relationship(s) and other field types for test steps will be mapped on this one sash.

Note: Tests and Test Steps do not require a typical relationship field mapping to link them. We've added behind-the-scenes smarts to couple them for you.

Step 4: Configure your Integration

You can find general details on how to configure an integration here.

To see a Test Step Flow link on the Integration Configuration screen, the following conditions must be met:

  • Model is of type 'Model with Test Steps'
  • Artifacts in both collections have test steps
  • The relevant Hub connectors must support test steps (see Connector Documentation to confirm)

Screenshot 2023-07-18 at 4.46.45 PM.png

Clicking the link will bring you to the Test Step Flow screen, where you can click Select to choose your desired Test Step Flow style:

Screenshot 2023-07-18 at 4.49.02 PM.png

Due to the sequential nature of test steps, test step flow has some unique properties:

  • Test steps can only flow in one direction
  • The target collection’s test steps will be kept in strict synchronization with the source collection. This means that all updates, deletions, and re-ordering of test steps will be mimicked in the target collection. Since the source collection is the system of record, any test steps that exist in the target collection but not the source collection will be removed.
  • If the test steps on the target artifact are changed by an end-user, they will be updated by Hub when one of the fields or ordering on the source artifact's test steps is changed.

NoteComments, attachments, and inline/embedded images are not currently supported on Test Steps.