Zephyr Integration

In this page

What is Zephyr?

(supported since Better Excel Exporter 4.5.0)

Zephyr (formerly Zephyr Scale) is the most popular test management solutions integrated with Jira, enabling teams to create, execute, and track tests directly within Jira.

Zephyr integration features

• You can export the test steps for any test case. Zephyr test cases are attached to Jira issues. This enables creating Excel files that contain issue field values, test case details, like name, priority, status, objective and precondition and the following test step data: test step instructions, test step data, expected result.
• You can export the test executions that belong to test cases attached to any Jira issues. Executions are exported with their details for a comprehensive report: test case, execution status, assignee, executor user, execution date and comments.
• You can export the test step results of the test executions for detailed test reports. The following details are exported for each step: ID, step instructions, test data, expected result, execution status and the actual result.
• Better Excel Exporter offers ready-made report templates to calculate test results by projects and testers. It also comes with reports for testers workload. A Zephyr test execution history report is also available. Although these are useful as is, they can also be used as a starting point to create custom Excel reports from Zephyr data.

(Need more features? Tell us in a support ticket!)

Zephyr integration vs. the Zephyr built-in Excel exports

You may want to ask: if Zephyr has a built-in Excel export feature, why would you use another app for the same?

While the Zephyr built-in Excel exports may be sufficient for basic use cases, the Better Excel Exporter integration is more powerful in, at least, these:

• It is extremely customizable.
  Instead of accepting the pre-defined export types in Zephyr, you can define your own types via Excel templates.
• It supports all the powerful Excel features.
  You can use Excel formulas and functions, custom calculations in Groovy (sorting, complex math, data integration, etc.), charts, pivot tables, pivot charts, Visual Basic macros, among others.
• It is integrated with all the popular Jira apps.
  You can freely combine Zephyr data and other apps' data in the same Excel file.
• It comes with powerful templates optimized for Zephyr.
  You can use those "as is", or customize them to your needs.
• It is well-documented with the customization guide, the Expression Reference Manual, the recipes, and such.

If at least one of these is important for you, give the app a try.

Configuration

Configuring the Zephyr REST API access

As this integration relies on the Zephyr REST API, you need to configure the credentials for the REST API calls in zephyr-v2-tool.groovy.

Configuring the Zephyr API keys

1. Click your Jira profile icon in the top right and select Zephyr API Access Tokens.
2. Click Create access token, click Copy, then Close.
3. Click the cog icon "⚙" in the top right → Apps → Excel Templates (under Better Excel Exporter).
4. Open the zephyr-v2-tool.groovy template for editing and paste the key to the value of the zephyrScaleAccessToken variable (don't remove the quotation marks around the string!):

   // zephyr-v2-tool.groovy
   
   def zephyrScaleAccessToken = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjb250ZXh0Ijp7ImJhc2VVcmwiOiJodHRwczovL21pZG9yaWdlcmdlbHlkZXY2LmF0bGFzc2lhbi5uZXQiLCJ1c2VyIjp7ImFjY291bnRJZCI6IjVjMzM0OTg1YTAzNzZkNGZlMWU1MWY3NCIsInRva2VuSWQiOiI5OGJhZTgxYy04ZDI1LTQ2YmEtODBkOC02NTA2ZDBkZGY5NDEifX0sImlzcyI6ImNvbS5rYW5vYWgudGVzdC1tYW5hZ2VyIiwic3ViIjoiZjEzMDNkODMtYTM5NC0zNDcyLWE0NTYtNmIyYmM5ZmE5YTYyIiwiZXhwIjoxNzc4OTIwMzc2LCJpYXQiOjE3NDczODQzNzZ9.LYGX01BFvLKjKZdzHe8Q9M81NmxawQkL5ES5F7dcn7M"
   

5. Save the changes in zephyr-v2-tool.groovy. (Don't worry about storing keys here: this file is visible only for Jira administrators, who would have super-user permissions anyway.)

Learn more about Zephyr

• Zephyr product information (at its own vendor)
• Zephyr documentation
• Zephyr app page (on the Atlassian Marketplace)