Skip to main content
Skip table of contents

Zephyr Scale for Jira

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

BETA

The integration is still a work in progress.

If you are seeing some limits, or would like us to implement more: Let us know through the support: https://support.requirementyogi.com/

How to set up the integration?

1 - Enable the integration (Instance admin)

The integration requires Zephyr Scale 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 personal configuration

Screenshot 2024-08-06 at 14.43.24.png

  1. Paste the token just created

Screenshot 2024-08-06 at 14.44.53.png

How to see the Zephyr Scale data in the traceability matrix

To see the Zephyr Scale fields, you’ll need to link your Zephyr test cases to a Jira issue. Then, we’ll be able to get the Zephyr data.

Note that only test cases linked to a Jira issue and a requirement can be displayed for now.

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

Screenshot 2024-08-06 at 15.38.25.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)

Screenshot 2024-08-06 at 15.35.39.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

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.