Zephyr Squad
Overview
Planview Hub offers seamless integration with Zephyr Squad 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.
Demo Videos
Connector Setup Details
Zephyr Squad augments Jira's capabilities with test management. Hub’s Atlassian Jira Connector provides support for Zephyr ‘Test’, 'Test Cycle' and ‘Test Execution’ artifacts. Test Artifact (without the "special" test model pieces) is supported as a regular issue type as well.
Requirements:
- The Zephyr for Jira Add-On is installed and licensed for ‘Test Execution’ support.
- The ZAPI Add-On is installed and licensed.
- Hub repository settings are set with a user with permissions to use the Zephyr API (ZAPI).
- For Zephyr Cloud, the Zephyr Access Key and Zephyr Shared Secret Key must be provided in the Hub repository settings. These can be created in the Jira Administration settings under Add-Ons, ZAPI.
Note: In Zephyr for Jira Cloud versions 7.1.1 and later, the ZAPI add-on is no longer supported and will not be required for the Zephyr Squad plugin.
The 'Test Cycle' and ‘Test Execution’ artifact types are only visible if the above requirements are met and the associated project has the ‘Test’ type enabled. Similarly, you will only be able to execute Test Cycle and Test Execution queries if the above requirements are met.
See additional connector setup details for the Jira connector here.
Other Configuration Settings
Cross-Artifact Linking
Cross-artifact linking between Zephyr artifact types are supported, including:
-
Test Execution Links to:
-
Cycle
-
Issue (Zephyr Test linked to Test Execution)
-
Defects
-
-
Zephyr Test Links to:
-
Test Executions (read-only)
-
All Jira standard relationships
-
Dates
Zephyr Cloud:
Synchronization of dates in Zephyr Cloud Test Cycles is supported starting Hub 24.4 and later releases.
Change Detection
We recommend disabling change detection in Zephyr Test Cycle and Test Execution artifacts because of a known limitation in the Zephyr API. With Change Detection enabled, a high volume of network traffic is created and integrations become non-performant.
Note: If change detection is not disabled, Hub may not process any other event until change detection is completed.
To configure change detection for your integration(s), please see the following instructions:
-
In Planview Hub, navigate to the integration page and select the integration that you want to set a change detection configuration to.
-
It is recommended that the integration is set to a one-way creation into the Zephyr connector.
-
Under the Overview section, select “Change Detection”.
-
Navigate to the Zephyr section and select “Override”.
-
Under Change Detection, set Repeat Method to “Advanced Scheduling”.
-
Set Cron to a setting that will not trigger the change detection. Example: '0 0 12 ? * * 2000.'
-
Click Save and Done.
-
Repeat these steps for the required Zephyr Integrations.
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
- Attachments (on Test Executions and Test Step Results)
- Linking Defects in Zephyr Test Executions/UiPath Test Case Log integrations (full scan required in UiPath Test Case Log integration to link defects in Zephyr Test Executions)
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? |
|---|---|---|---|
|
Test Note: Beginning in Hub version 24.4, Test Cycle, Text Execution, and Test Artifacts are fully supported. |
Planview Hub: 24.4 and later |
Any supported repository version: |
Yes |
|
Test Execution Note: Beginning in Hub version 24.4, Test Cycle, Text Execution, and Test Artifacts are fully supported. |
Planview Hub: 24.4 and later |
Any supported repository version: |
Yes |
|
Test Cycle Note: Beginning in Hub version 24.4, Test Cycle, Text Execution, and Test Artifacts are fully supported. |
Planview Hub: 24.4 and later |
Any supported repository version: |
No |
Supported Containers
Learn more about containment in Planview Hub here.
|
Containers that can synchronize between repositories |
Applicable Hub Versions |
Applicable Repository Versions |
Unique URL? |
|---|---|---|---|
|
N/A |
|||
|
Containers used to define the boundary of a collection (When clicking 'Manage Projects' on a Collection) |
|||
|
N/A |
|
|
|
|
Containers used for artifact routing |
|
|
|
|
N/A |
Supported Field Types
Test Steps:
-
The following default fields are currently supported:
-
Test Step
-
Test Data
-
Test Result
-
Order Id(Read only)
-
Note: Zephyr Test Step and Test Execution custom fields are not supported.
See additional details on supported field types in Jira here.
Functional Limitations
|
Category |
Limitation |
Applicable Hub Versions |
Applicable Repository Versions |
|---|---|---|---|
| Feature Unsupported |
Test Steps Reordering of Test Steps is not supported. |
Planview Hub: 24.4 and later |
Any supported repository version |
| Feature Unsupported |
Custom Fields Zephyr Test Step and Test Execution custom fields are not supported. |
Planview Hub: 24.4 and later |
Any supported repository version |
| Feature Unsupported |
Test Executions Zephyr Test Execution history is not supported. |
Planview Hub: 24.4 and later |
Any supported repository version |
| Third Party API Limitation |
Test Step Results Zephyr Test Step Results are supported as read- only. |
Planview Hub: 24.4 and later |
Any supported repository version |
| Feature Unsupported |
Cross-Artifact Linking Cross-artifact linking from Zephyr Test Cycle to other artifacts is not supported. |
Planview Hub: 24.4 and later |
Any supported repository version |
| Third Party API Limitation |
Cross-Artifact Linking Cross-artifact linking from Zephyr Test to Test Executions is supported as read-only. |
Planview Hub: 24.4 and later |
Any supported repository version |
| Good to Know |
Linking Defects Linking defects to Zephyr Test Execution will also link defects to the Zephyr Test. Avoidance: Avoid duplicating defect relationship links to both Test and its Test Execution by only linking defects to the Test Execution artifact. |
Planview Hub: 24.4 and later |
Any supported repository version |
| Good to Know |
Defect Fields in UiPath Any updates to the Defect field in UiPath Test Case Logs using Hub's API will not support change detection. A high fidelity full scan is required in UiPath Test Case Log integration to link defects in Zephyr Test Executions. |
Planview Hub: 24.4 and later |
Any supported repository version |
| Feature Unsupported |
Formatted ID Search For Zephyr Cloud, formatted ID search is not supported. |
Planview Hub: 17.3 and later Tasktop Sync: 4.11 and later |
Zephyr Cloud |
| Feature Unsupported |
Ad Hoc Test Cycles Synchronization of Ad Hoc Test Cycles is not supported. |
Planview Hub: 17.2 and later Tasktop Sync: 4.10 and later |
Any supported repository version: |
| Third Party API Limitation |
Test Executions Zephyr Test Execution artifacts that have assignees containing unicode characters in their username or ID will not flow in an integration. |
Planview Hub: All Tasktop Sync: 4.7 and later |
Any supported repository version: |
| Third Party API Limitation |
Test Executions Zephyr Test Execution artifacts have an "Execution Date" in the repository but the API provides it in a format like "Today 8:10 PM" which means we must represent it as a read-only String field instead of a Date field |
Planview Hub: All Tasktop Sync: 4.7 and later |
6.1, 6.3, 7.0 |
| Third Party API Limitation |
Attachments Attachments may fail to upload to Zephyr Test Executions if the filename contains symbols or non-English characters. |
Planview Hub: All Tasktop Sync: 4.7 and later |
6.1, 6.3, 7.0 |