Zephyr (formerly Zephyr Scale)
Overview
Planview Hub offers seamless integration with Zephyr (formerly Zephyr Scale) through the Atlassian Jira connector. This collaboration enables users to leverage the powerful test management capabilities of Zephyr Squad within the Planview Hub platform.
For more information, please refer to the sections below.
Connector Setup Details
Zephyr augments Jira's capabilities with test management. Hub’s Atlassian Jira Connector provides support for Zephyr ‘Test Case’ and ‘Test Case Folder’ artifacts.
Note: This functionality is only currently supported for Jira Cloud.
Requirements:
-
The Zephyr Plugin is installed and licensed for support.
-
The Zephyr Cloud Location and Zephyr Cloud API Token must be provided in the Atlassian Jira Hub repository settings.
-
Zephyr Cloud Location: The base URL for the Zephyr API. If left blank, the default global endpoint https://api.zephyrscale.smartbear.com/v2 is used. For the EU region, use https://eu.api.zephyrscale.smartbear.com/v2.
-
Zephyr Cloud API Token: This token is used to authenticate all Zephyr API requests.
-
To generate an access token, navigate to General settings page and choose the option “Zephyr API Access Tokens”. For more information, please refer to the documentation here.
See additional connector setup details for the Jira connector here.
Other Configuration Settings
Change Detection
Due to third party API limitations, changes to the following fields may not trigger change detection or cause a synchronization immediately. To ensure these updates synchronize, a high-fidelity full scan must occur, or another qualifying change must be made to the artifact:
-
Zephyr Test Steps
-
Plain Text Test Script
-
BDD – Gherkin Script
Learn more about how to configure change detection and full scan intervals in Planview Hub here.
Supported Artifacts
Supported Work Items
Learn about the difference between containers and work items in Planview Hub here.
| Supported Artifact Type | Applicable Hub Versions | Applicable Repository Versions | Unique URL? |
|---|---|---|---|
|
Zephyr – Test Case |
Planview Hub: 26.3 and later |
Zephyr Cloud |
Yes |
Supported Containers
Learn more about containment in Planview Hub here.
|
Containers that can synchronize between repositories |
Applicable Hub Versions |
Applicable Repository Versions |
Unique URL? |
|---|---|---|---|
|
Zephyr – Test Case Folder |
Planview Hub: 26.3 and later |
Zephyr Cloud |
No |
|
Containers used to define the boundary of a collection (When clicking 'Manage Projects' on a Collection) |
|||
|
Projects Note: Planview Hub provides limited support for Team-Managed Projects |
Planview Hub: 26.3 and later | Zephyr Cloud |
N/A |
|
Containers used for artifact routing |
|
|
|
|
Projects Note: Planview Hub provides limited support for Team-Managed Projects |
Planview Hub: 26.3 and later | Zephyr Cloud |
N/A |
Supported Field Types
|
Standard Field Type |
How is the field type referenced in the repository? |
Sample Repository Fields Supported |
Particular Repository Fields NOT Supported |
|---|---|---|---|
|
|
Text |
Name, Project ID (Read Only), Key (Read Only), Formatted ID (Read Only), ID (Read Only), API ID (Read Only) |
|
|
|
Select List (single choice) |
Status, Priority, Component, Type (Read Only), Project (Read Only) |
|
|
|
|
|
Labels |
|
|
|
|
|
|
|
Date |
|
|
|
|
Date Time Picker |
Created On (Read Only) |
|
|
|
Duration |
Estimated run time |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Owner |
|
|
|
|
|
|
|
Learn how to configure relationships in Planview Hub here. |
|
Issues, Folder, Parent Folder |
|
|
|
|
Objective, PreCondition, Plain Text Test Script, BDD – Gherkin Script |
|
|
|
External Link |
Web Links |
|
|
|
URI String Text |
Location (Read Only field: Only Supported for Zephyr - Test Case) |
|
String 
Multi Select
Test Steps:
-
The following default fields are currently supported:
-
Step
-
Test Data
-
Expected Result
-
Reordering of test steps is supported.
See additional details on supported field types in Jira here.
Functional Limitations
|
Category |
Limitation |
Applicable Hub Versions |
Applicable Repository Versions |
|---|---|---|---|
|
Third Party API Limitation
|
Test Steps If test steps are configured, at least one and at most 100 test steps must always remain in a test case. It is not possible to synchronize a test case that has zero test steps from the source repository into Zephyr, as the API enforces a minimum of one step. Users must ensure the source test case retains at least one step. |
Planview Hub: 26.3 and later |
Zephyr Cloud |
|
Functional Limitation |
Test Steps "Call to step" test steps are not supported. Any test step of this type will not be synchronized. |
Planview Hub: 26.3 and later |
Zephyr Cloud |
|
Third Party API Limitation
|
Comments and Attachments Comments and Attachments are not supported. |
Planview Hub: 26.3 and later |
Zephyr Cloud
|
|
Third Party API Limitation
|
Custom fields Custom fields are not supported. |
Planview Hub: 26.3 and later |
Zephyr Cloud |
|
Third Party API Limitation
|
Query Language Search the Zephyr API does not support server-side filtering. |
Planview Hub: 26.3 and later
|
Zephyr Cloud |
|
Third Party API Limitation |
Test Case versions are not supported. |
Planview Hub: 26.3 and later |
Zephyr Cloud |
|
Third Party API Limitation
|
Test Case Folders cannot be updated after creation — due to API limitation the name and parent folder link are all immutable; once set, none of these can be changed or removed. |
Planview Hub: 26.3 and later
|
Zephyr Cloud
|
|
Functional Limitation |
Location For Zephyr – Test case folder, location field is not available. |
Planview Hub: 26.3 and later |
Zephyr Cloud
|
|
Unsupported Feature |
Zephyr Data Center is not supported |
Planview Hub: 26.3 and later
|
Any supported repository version |