Breadcrumbs

Zephyr Testing for Jira

Zephyr Testing is one of the many testing management apps in the Marketplace, and we have a small integration to help you see your Zephyr tests linked to Jira issues.

There are multiple ways to do so:

  1. Requirement → Jira issue → Zephyr test

    1. You can use the Bulk Jira linking to link or create multiple Jira issues, and then use Zephyr’s UI to link zephyr tests to issues.

    2. You can make your links from different directions:

      • Requirement → Jira issue → Zephyr test

      • Zephyr → Jira issue → Requirement

      • Jira issue → Requirement, and then add the Zephyr test later.

  2. Requirement → Zephyr test

    1. In this case, you are only able to link tests from the requirement detail.

    2. It is not possible to link requirements from the Zephyr UI.

    3. You can create 1 to many relationships. Stay tuned for improvements regarding many to many relationships.

How to see the Zephyr data in the traceability matrix

1. Requirement → Jira issue → Zephyr test

  1. Link your Zephyr Scale test case to an issue.


Screenshot 2024-08-06 at 15.38.25.png

  1. Link your requirement to a Jira issue

    1. From the Jira point of view
RY for Jira.png


b. Or, from the Confluence point of view.

See more information here: Requirement Yogi for Jira .
Link requirement to issue - From confluence.png

  1. In the Traceability Matrix, display the Jira issues.

    1. In this Jira Issues column, go to 'More Jira fields' and choose the Zephyr fields (Test Cases etc)
Add Test cases - TM.png

  1. Repeat for:

    1. Test Case status

    2. Test execution

    3. Test execution status
Zephyr matrix - Requirement Yogi.png


2. Requirement → Zephyr test

  1. Open a requirement detail and navigate to the Zephyr box at the bottom left
Link req to zephyr - Confluence.png

  1. In the Traceability matrix, click on the requirement column

    1. Click on the Zephyr fields > Test cases.

    2. Repeat the steps for Test case status, Test execution and status.
Add Zephyr column - TM.png

Other ways to see Zephyr Test information in the app

When adding test execution in the matrix, you can now choose:

  • Latest execution,

  • Or many test executions.
Display many test executions - Zephyr Requirement Yogi matrix.png

In the requirement detail, you can also see linked Zephyr test cases in the dedicated box
Requirement Detail - Zephyr.png


Administration - How to set up the integration?

1 - Enable the integration (Global admin permission)

The integration requires Zephyr Testing for Jira, and the Requirement Yogi for Jira plugins.

In the Requirement Yogi for Jira Administration page, look for the Integrations tab and enable the Zephyr Scale Integration.

Screenshot 2024-08-06 at 14.37.30.png

2 - Register an API key (All users)

We access the Zephyr Scale data through the Zephyr Scale API, and need an authentication token.

This authentication token is unique per user and expires in 3 months.

To guarantee that edit and view permissions on Jira tickets are respected, every user that wish to see Zephyr Scale information in the traceability matrix will have to complete this step.

2.1 - Create a Zephyr Scale authentication token

Please refer to the Zephyr Scale documentation to create a unique API token

2.2 Copy the token created in Jira

  1. Access the integrations configuration
Screenshot 2026-07-07 at 15.14.35.png


  1. Paste the token just created
Screenshot 2024-08-06 at 14.44.53.png

Troubleshooting

If you see an error message similar to this:

Please make sure that

  • You have access to view the object in question.

  • Your API access token is still valid.

Screenshot 2024-08-06 at 15.17.38.png