JIRA Requirements Sync

Description

For Zephyr, To learn how to sync your requirements via the JIRA Requirements Sync feature within Zephyr system, please view the steps below.

Terminology

 Click to view more information on terminology regarding this page
TermDescriptio
JIRA Requirements SyncThe ability to sync/import your requirements from JIRA utilizing a unique way of filtering via JQL and organizing your synced/imported requirements in folders dependent on fields.
Top-Level Folder NameThe name of the folder that houses the synced/imported from the JIRA Requirements Sync feature.
Field 1 & 2Individual fields that help organize the requirements synced/imported into folders. For example, field 1 could be "version" which would organize the requirements into folders depending on the version of the requirement.

JIRA Requirements Synchronization

 Prior to using JIRA Requirements Sync

Prior to using JIRA Requirements Sync, the user must be on the Requirements page within a specific project/release. There must also be a JIRA instance connected to this project and there must be existing requirements in JIRA for the connected JIRA instance.


Release 6.2 brings the release specific requirement tree structure which fixes JIRA sync limitation in 6.1.2 where:

  • If the same JQL is used in multiple releases of the same project, the requirement(s) and requirement tree auto changes will only get reflected to the latest release of a project. 

Any JIRA sync that has the same JQL from any (different) releases of same project that is migrated from 6.1.2 over to 6.2 will need to have their JIRA sync re-created to utilize features from 6.2, so that it is able to maintain the same requirement(s) in the multiple requirement tree.

Duplicate folders inside a parent requirement tree are not allowed. If an auto Jira Sync operation occurs, multiple folders with same name  are created and they need to be deleted manually before a JIRA sync can be re-saved.

Scenario: You are a current user in Zephyr. As a user in the system, you want to be able to sync your requirements from JIRA using the JIRA Requirements Sync feature on the Requirements page in the Zephyr system.


1. Click on the  button next to the release folder on the left-hand side.

2. Click on "Jira Sync Config".


3. Enter a JQL string to filter the requirements that you want to search and sync.

4. Click "Search" to view the list of requirements requirements.

5. Enter a name for the "Top-Level Folder Name" text box.

  • Top-Level Folder Name - A name given to the folder where these requirements will be synced to.

6. Choose if you want to further categorize your requirements into folders by selecting a category for field 1 and field 2.

  • If you make a selection for field 1 and 2, the requirements synced will be categorized first by field 1 folder and then categorized by field 2 folders under field 1.


7. Click on the "Save" button after you've finalized your folder name, folder field filters, and you are satisfied with the requirements that you want to sync.


View JIRA Requirements Synced

Prior to viewing synced requirements

Prior to using JIRA Requirements Sync, the user must be on the Requirements page within a specific project/release. There must also be a JIRA instance connected to this project and there must be existing requirements in JIRA for the connected JIRA instance. The user should have already synced their requirements using the JIRA Requirements Sync function.

Scenario: You are a current user in Zephyr. As a user in the system, you want to be able to view your recently synced requirements in the Zephyr system.



1. Navigate through the newly created folder(s) to view your recently synced/imported requirements within the specific release.

2. Click on the "Top-Level Folder" and navigate through the following folders if you selected a category for field 1 and 2 when syncing.