JIRA Requirements Sync

Owned by Kevin Pham (Deactivated)
Last updated: Oct 10, 2024 by Dominik Trygar
4 min read

 

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-user-guide/requirements/jira-requirements-sync.html

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

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. 

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.

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 or filter to filter the requirements you want to search and sync.

 

The older JQL search data remains as it is in the search result even if you change the JQL string for Jira Sync Config and even if it does not satisfy the current JQL. 
The data gets removed if there is any update on the requirement via webhook call back.

4. Click "Search" to view the list of 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.

When choosing fields 1 and 2, users have the option to select Sprint or Epic Link and if users are selecting these fields to structure their requirements, the folder structure for the requirements will include both the Sprint ID and Name as well as the Epic ID and Name.
Whatever changes in Jira to Sprint will immediately be reflected in the folder structure as well as the requirement. The folder structure will be updated in Zephyr if there are changes made to the sprint for the requirement. The requirement in Zephyr will include any reflected changes made when the fields are updated in Jira.



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

View JIRA Requirements Synced

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 fields 1 and 2 when syncing.

 


Disable Jira Sync

  • Users can Disable the Jira Sync Requirement when they are done with the release to avoid unnecessary callback from Jira.

  • This will help the System performance as Zephyr Enterprise will not check for those releases whose Jira sync is disabled.

  • This feature is only available when a new webhook integration is done.

  1. Click on the image-20240320-115615.png button next to the Release on the left-hand side.

  2. Click on "Disable Jira Sync".

Manual Jira Sync Update

  • Users can Sync the Jira Sync Requirement Manually by using the Manual Jira Update this can be useful when a webhook call back has not brought the latest changes

  • On doing Manual Jira Update on Jira Sync Folder

    • It will bring the requirement that satisfies the JQL or Filter

    • It will remove the requirement if any requirement does not satisfy the JQL or Filter

    • It will Update the requirement if any changes are made on the Requirement.

  1. Click on the image-20240320-120135.png button next to the Jira sync folder on the left-hand side.

  2. Click on "Manual Jira Update".

 

You will get the pop-up to sync.

On Click on sync, it will bring the Job Progress.