TestRail
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 TestRail.
TestRail & UiPath Test Manager
In this integration scenario, a Test Section is created in TestRail. Hub will flow the Test Section into UiPath as a Test Set. A test case is then created in TestRail and synchronized over to UiPath. When the tester in TestRail begins running her tests, Hub will flow the tests back over to UiPath as test case logs to maintain full visibility across the lifecycle.
The goal of this integration scenario is to synchronize the UiPath Test Case artifact with the TestRail Test Case artifact. To do this, you'll need to configure the following integrations:
- UiPath Test Sets <> TestRail Test Sections
- UiPath Test Cases <> TestRail Test Cases
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 |
| Created | Created | Date Time | N/A |
| Modified | Modified | Date Time | N/A |
| Location | URL | Location | N/A |
| Parent Artifact | Parent | Relationship | N/A |
| None | Test Manager ID | String | N/A |
| None | Test Manager URL | String | N/A |
Test Steps
| Smart Field | Label | Type | Field Values |
|---|---|---|---|
| Action | Action | String | N/A |
| Expected Result | Expected Result | String | N/A |
| Id | Id | String | N/A |
TestRail
You will need to add the following custom fields to your TestRail instance:
| Name | Type |
|---|---|
| Test Manager ID | String |
| Test Manager 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.
UiPath
For this integration scenario, you'll need to configure the following UiPath collections:
Work Item Collections
- UiPath Test Cases
Container Collections
- UiPath Test Sets
Field Mapping
Map the following UiPath fields to the model:
| Collection | UiPath Field | Model Field |
|---|---|---|
| UiPath Test Cases | Name | Summary |
| Description | Description | |
| Key | Test Manager ID | |
| URL | Test Manager URL | |
| UiPath Test Sets | Name | Summary |
| Description | Description |
Test Step Field Mapping
Map the following UiPath fields to the model:
| Collection | UiPath Field | Model Field |
|---|---|---|
| UiPath Test Cases | Description | Action |
| Expected Result | Expected Result | |
| Id | Id |
Relationship Specification
Configure the following relationship mappings:
| Collection | UiPath Field | Model Field |
|---|---|---|
| UiPath Test Cases | Test Sets | Parent |
TestRail
For this integration scenario, you'll need to configure the following TestRail collections:
Work Item Collections
- TestRail Test Cases
Container Collections
- TestRail Test Sections
Field Mapping
Map the following TestRail fields to the model:
| Collection | TestRail Field | Model Field |
|---|---|---|
| TestRail Test Cases | Title | Name |
| Preconditions | Description | |
| Test Manager ID | Test Manager ID | |
| Test Manager URL | Test Manager URL | |
| Template | Constant Value | |
| TestRail Test Sections | Name | Summary |
| Description | Description | |
| ID | Formatted ID |
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 | Parent |
| Test Suite / Baseline | Constant Value | |
| TestRail Test Sections | Test Suite / Baseline | 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:
- UiPath Test Sets <> TestRail Test Sections
- UiPath Test Cases <> TestRail Test Cases
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 |
|---|---|---|---|---|
|
UiPath Test Sets <> TestRail Test Sections |
Container + Work Item Synchronization |
Two-way Creation | UiPath <> TestRail | N/A |
|
UiPath Test Cases <> TestRail Test Cases |
Work Item Synchronization | Two-way Creation | UiPath <> TestRail |
One-way Flow TestRail collection accepts test steps |
Functional Limitations
| Category | Limitation | Applicable Repository Version |
|---|---|---|
| Third Party API Limitation |
Test Steps Test Steps on a Test Case are read-only and can only synchronize from TestRail to UiPath. |
Any supported repository version: |
| Third Party API Limitation |
Test Results Test Results are read-only and cannot be synchronized from TestRail or UiPath. |
Any supported repository version: |
TestRail & Microsoft Azure DevOps
In this integration scenario, a tester creates a test case in Azure DevOps. Hub will flow the test case, along with its fields and sub-entities to TestRail, so that the tester in TestRail can create the appropriate tests to flow back over to Azure DevOps. Back in Azure DevOps, the test results will flow back over to TestRail to maintain full visibility across the lifecycle.
The goal of this integration scenario is to synchronize the Azure DevOps Test Case artifact with the TestRail Test Case artifact, while including the Test Results from the Azure DevOps artifact. To do this, you'll need to configure the following integrations:
- Azure DevOps Test Suites <> TestRail Test Sections
- Azure DevOps Test Cases <> TestRail Test Cases
- Azure DevOps Test Runs <- TestRail Tests
- Azure DevOps Test Results -> TestRail 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 |
| Formatted ID | Formatted ID | String | N/A |
| Location | URL | Location | N/A |
| Created | Created | Date Time | N/A |
| Modified | Modified | Date Time | N/A |
| Parent Artifact | Parent | Relationship | N/A |
| None | Test Suite | Relationship | N/A |
| None | Azure DevOps ID | String | N/A |
| None | Azure DevOps URL | String | N/A |
| None | TestRail ID | String | N/A |
| None | TestRail URL | String | N/A |
Azure DevOps
You will need to add the following custom fields to your Azure DevOps instance:
| Name | Type |
|---|---|
| TestRail ID | String |
| TestRail URL | String |
TestRail
You will need to add the following custom fields to your TestRail instance:
| Name | Type |
|---|---|
| Azure DevOps ID | String |
| Azure DevOps URL | String |
Create your Collections
Azure DevOps
For this integration scenario, you'll need to configure the following Azure DevOps collections:
Work Item Collections
- Azure DevOps Test Cases
- Azure DevOps Test Runs
- Azure DevOps Test Results
Container Collections
- Azure DevOps Test Suites
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.
Field Mapping
Map the following Azure DevOps fields to the model:
| Collection | Azure DevOps Field | Model Field |
|---|---|---|
| Azure DevOps Test Cases | Title | Summary |
| Description | Description | |
| Formatted ID | Azure DevOps ID | |
| URL | Azure DevOps URL | |
| TestRail ID | TestRail ID | |
| TestRail URL | TestRail URL | |
| Iteration Path | Constant Value Based on Projects | |
| Area Path | Constant Value Based on Projects | |
| Azure DevOps Test Runs | Summary | Summary |
| Azure DevOps Test Results | Configuration | Constant Value |
| Azure DevOps Test Suites | Title | Summary |
| Description | Description | |
| Formatted ID | Formatted ID | |
| Iteration Path | Constant Value | |
| Area Path | Constant Value |
Relationship Specification
Configure the following relationship mappings:
| Collection | Azure DevOps Field | Model Field |
|---|---|---|
| Azure DevOps Test Results | Parent Test Run | Parent |
| Parent Test Plan | Constant Value | |
| Azure DevOps Test Suites | Parent | Parent |
| Azure DevOps Test Cases | Test Suites | Test Suite |
TestRail
For this integration scenario, you'll need to configure the following TestRail collections:
Work Item Collections
- TestRail Test Cases
- TestRail Tests
- TestRail Test Results
Container Collections
- TestRail Test Sections
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.
Field Mapping
Map the following TestRail fields to the model:
| Collection | TestRail Field | Model Field |
|---|---|---|
| TestRail Test Cases | Title | Summary |
| Preconditions | Description | |
| Azure DevOps ID | Azure DevOps ID | |
| Azure DevOps URL | Azure DevOps URL | |
| ID | TestRail ID | |
| Location | TestRail URL | |
| Priority | Constant Value | |
| Case Type | Constant Value | |
| Template | Constant Value | |
| TestRail Tests | Title | Summary |
| Status | Constant Value Based on Projects | |
| TestRail Test Sections | Name | Summary |
| Description | Description |
Relationship Specification
Configure the following relationship mappings:
| Collection | TestRail Field | Model Field |
|---|---|---|
| TestRail Test Sections | Parent Section | Parent |
| TestRail Test Cases | Test Suite / Baseline | Test Suite |
| TestRail Test Results | Test | 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:
- Azure DevOps Test Suites <> TestRail Test Sections
- Azure DevOps Test Cases <> TestRail Test Cases
- Azure DevOps Test Runs <- TestRail Tests
- Azure DevOps Test Results -> TestRail 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/Container Mirroring |
|---|---|---|---|
| Azure DevOps Test Suites <> TestRail Test Sections | Container + Work Item Synchronization | Two-way Creation | ADO <> TestRail |
| Azure DevOps Test Cases <> TestRail Test Cases | Work Item Synchronization | Two-way Creation | ADO <> TestRail |
| Azure DevOps Test Runs <- TestRail Tests | Work Item Synchronization |
One-way Creation Azure DevOps Accepts New Artifacts |
ADO <- TestRail |
| Azure DevOps Test Results -> TestRail Test Results | Work Item Synchronization | Two-way Creation | ADO <> TestRail |
Functional Limitations
| Category | Limitation | Applicable Repository Version |
|---|---|---|
| Good to Know |
Test Runs Test Runs can only be created on automated Test Runs. |
Any supported 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 Step Results Due to an ADO API limitation, test step results are not supported. |
Any supported repository version: |
| Good to Know |
Tests The TestRail Test artifact is read-only. |
Any supported repository version: |
| Good to Know |
Test Results Test Results can technically be created bidirectionally, however, there are certain required relationship fields in ADO that do not map to TestRail. |
Any supported repository version: |
| Good to Know |
Outcome Field The Outcome Field on the Azure DevOps Test Result artifact is likely to map to the status field. |
Any supported repository version: |
TestRail & Jama
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.
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: |
TestRail & Jira Xray
In this integration scenario, a tester creates a test case in TestRail. Hub will flow the test case, along with its fields and sub-entities to Xray. Back in TestRail, the tester begins running his tests. Hub will then flow the test results back over to Xray to maintain full visibility across the lifecycle.
The goal of this integration scenario is to synchronize the Xray Test Case artifact with the TestRail Test Case artifact, while including the Test Results from the TestRail artifact. To do this, you'll need to configure the following integrations:
- Jira Xray Test Sets <> TestRail Test Sections
- Jira Xray Tests <> TestRail Test Cases
- Jira Xray Test Executions <- TestRail Tests
- Jira Xray Test Runs <- TestRail 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 (if applicable) |
|---|---|---|---|
| Summary | Summary | String | N/A |
| Description | Description | Rich Text | N/A |
| None | Test Status | Single Select | Untested, Blocked, Failed, Passed, Retest |
| 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 | Parents | Relationships | N/A |
| Parent Artifact | Parent | Relationship | N/A |
|
None |
Xray ID |
String |
N/A |
|
None |
Xray URL |
String |
N/A |
| None | TestRail ID | String | N/A |
| None | TestRail URL | String | N/A |
Test Steps
| Smart Field | Label | Type | Field Values |
|---|---|---|---|
| Action | Action | String | N/A |
| Expected Result | Expected Result | String | N/A |
| Id | Id | String | N/A |
Xray
You will need to add the following custom fields to your Xray instance:
| Name | Type |
|---|---|
| TestRail ID | String |
| TestRail URL | String |
TestRail
You will need to add the following custom fields to your TestRail instance:
| Name | Type |
|---|---|
| Xray ID | String |
| Xray URL | String |
Create your Collections
Xray
For this integration scenario, you'll need to configure the following Xray collections:
Work Item Collections
- Xray Test Sets
- Xray Tests
- Xray Test Executions
- Xray Test Runs
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.
Field Mapping
Map the following Xray fields to the model:
| Collection | Xray Field | Model Field |
|---|---|---|
| Xray Test Sets | Summary | Summary |
| Description | Description | |
| Priority | Constant Value | |
| Xray Tests | Summary | Summary |
| Description | Description | |
| Key | Xray ID | |
| URL | Xray URL | |
| Priority | Constant Value | |
| TestRail ID | TestRail ID | |
| TestRail URL | TestRail URL | |
| Xray Test Executions | Summary | Summary |
| Priority | Constant Value | |
| TestRail ID | TestRail ID | |
| TestRail URL | TestRail URL | |
| Xray Test Runs | Formatted ID | Xray ID |
| Status | Test Status |
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 Tests | Test Sets association with a Test | Parents |
| Xray Test Runs | Test Run Test Execution key | Parent |
TestRail
For this integration scenario, you'll need to configure the following TestRail collections:
Work Item Collections
- TestRail Test Sections
- TestRail Test Cases
- TestRail Tests
- TestRail Test Results
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.
Field Mapping
Map the following TestRail fields to the model:
| Collection | TestRail Field | Model Field |
|---|---|---|
| TestRail Test Sections | Name | Summary |
| Description | Description | |
| TestRail Test Cases | Title | Summary |
| Preconditions | Description | |
| Xray ID | Xray ID | |
| Xray URL | Xray URL | |
| ID | TestRail ID | |
| Location | TestRail URL | |
| Priority | Constant Value | |
| Case Type | Constant Value | |
| Template | Constant Value | |
| TestRail Tests | Title | Summary |
| ID | TestRail ID | |
| Location | TestRail URL | |
| Status | Constant Value Based on Projects | |
| TestRail Test Results | Xray ID | Xray ID |
| Status | Test Status |
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 |
| TestRail Test Results | Test | 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:
- Jira Xray Test Sets <> TestRail Test Sections
- Jira Xray Tests <> TestRail Test Cases
- Jira Xray Test Executions <- TestRail Tests
- Jira Xray Test Runs <- TestRail 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 | Test Step Flow |
|---|---|---|---|---|
| Xray Test Sets <> TestRail Test Sections | Work Item Synchronization | Two-way Creation | Xray <> TestRail | N/A |
| Xray Tests <> TestRail Test Cases | Work Item Synchronization | Two-way Creation | Xray <> TestRail |
One-way Flow TestRail accepts test steps |
| Xray Test Executions <- TestRail Tests | Work Item Synchronization |
One-way Creation Xray accepts new artifacts |
Xray <- TestRail | N/A |
| Xray Test Runs <- TestRail Test Results | Work Item Synchronization | Two-way Creation | Xray <> TestRail | N/A |
Functional Limitations
| Category | Limitation | Applicable Repository Version |
|---|---|---|
| Configuration Requirement |
Test Sections Test Sections must be specified in order to flow into TestRail. |
Any supported repository version: |
| Good to Know |
Test Steps Test Steps can only flow from Xray to TestRail. |
Any supported repository version: |
| Good to Know |
Test Results Test Results in TestRail are read-only. |
Any supported repository version: |
TestRail & Micro Focus ALM Octane
In this integration scenario, a Test Suite is created in Micro Focus ALM Octane. Hub will flow the Test Suite into TestRail as a Test Section. A test case is then created in TestRail and synchronized over to ALM Octane. When the tester in TestRail begins running her tests, Hub will flow the results back over to ALM Octane as a test run to maintain full visibility across the lifecycle.
The goal of this integration scenario is to synchronize the ALM Octane Test artifact with the TestRail Test Case artifact. To do this, you'll need to configure the following integrations:
- ALM Octane Test Suites <> TestRail Test Sections
- ALM Octane Tests <> TestRail Test Cases
- ALM Octane Test Runs <- TestRail Tests
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 |
| Created | Created | String | N/A |
| Modified | Modified | String | N/A |
| Parent Artifact | Parent | Relationship | N/A |
| None | TestRail ID | String | N/A |
| None | TestRail URL | String | N/A |
| None | Octane ID | String | N/A |
| None | Octane URL | String | N/A |
ALM Octane
You will need to add the following custom fields to your ALM Octane instance:
| Name | Type |
|---|---|
| TestRail ID | String |
| TestRail URL | String |
TestRail
You will need to add the following custom fields to your TestRail instance:
| Name | Type |
|---|---|
| Octane ID | String |
| Octane 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.
ALM Octane
For this integration scenario, you'll need to configure the following ALM Octane collections:
Work Item Collections
- ALM Octane Tests
- ALM Octane Test Runs
Container Collections
- ALM Octane Test Suites
Field Mapping
Map the following ALM Octane fields to the model:
| Collection | ALM Octane Field | Model Field |
|---|---|---|
| ALM Octane Tests | Name | Summary |
| Description | Description | |
| Creation time | Created | |
| TestRail ID | TestRail ID | |
| TestRail URL | TestRail URL | |
| Formatted ID | Octane ID | |
| URL | Octane URL | |
| Phase | Constant Value | |
| ALM Octane Test Runs | Name | Summary |
| TestRail ID | TestRail ID | |
| TestRail URL | TestRail URL | |
| Release | Constant Value | |
| Native status | Constant Value | |
| ALM Octane Test Suites | Name | Summary |
| Description | Description | |
| Application modules | Constant Value |
Test Step Field Mapping
Map the following ALM Octane fields to the model:
| Collection | ALM Octane Field | Model Field |
|---|---|---|
| ALM Octane Tests | Description | Action |
Relationship Specification
Configure the following relationship mappings:
| Collection | ALM Octane Field | Model Field |
|---|---|---|
| ALM Octane Test Runs | Test | Parent |
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 Sections
Field Mapping
Map the following TestRail fields to the model:
| Collection | TestRail Field | Model Field |
|---|---|---|
| TestRail Test Cases | Title | Summary |
| Preconditions | Description | |
| Created On | Created | |
| ID | TestRail ID | |
| Location | TestRail URL | |
| Octane ID | Octane ID | |
| Octane URL | Octane URL | |
| Priority | Constant Value | |
| Case Type | Constant Value | |
| Template | Constant Value | |
| TestRail Tests | Title | Summary |
| ID | TestRail ID | |
| Location | TestRail URL | |
| Status | Constant Value Based on Projects | |
| 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 Tests | Test Case | 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:
- ALM Octane Test Suites <> TestRail Test Sections
- ALM Octane Tests <> TestRail Test Cases
- ALM Octane Test Runs <- 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 |
|---|---|---|---|---|
|
ALM Octane Test Suites <> TestRail Test Sections |
Container + Work Item Synchronization | Two-way Creation | ALM Octane <> TestRail | N/A |
|
ALM Octane Tests <> TestRail Test Cases |
Work Item Synchronization | Two-way Creation | ALM Octane <> TestRail |
One-way Flow ALM Octane accepts test steps |
|
ALM Octane Test Runs <- TestRail Tests |
Work Item Synchronization | Two-way Creation | ALM Octane <> TestRail | N/A |
Functional Limitations
| Category | Limitation | Applicable Repository Version |
|---|---|---|
| Good to Know |
Test Steps Test Steps are supported but you must select which direction you want them to flow upon initial integration configuration |
Any supported repository version:
|
| Third Party API Limitation |
Tests Tests in TestRail are read-only so integration is one-way only. |
Any supported repository version: |
Synchronizing TestRail & Jama Test Steps
Use the instructions below to configure the following integrations:
- TestRail Test Steps → Jama Test Steps
- Jama Test Steps → TestRail Test Steps
Step 1: Connect to your Repository
First, connect to your repository by following the instructions here.
You can learn more about TestRail-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.
A Test Steps entity will be added. On the Model Configuration screen, you will then see two panels:
- 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.
- 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.
Here is an example of a very simple Test Model with Test Steps:
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 a Jama Test Case or TestRail Test Case
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)
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:
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