In this page
Are you looking for this Zephyr edition?

"Zephyr Essential" is the successor to Zephyr Squad. If you're installing Zephyr Essential for the first time, you'll get the new UI experience by default — this page refers to that edition. However, if you've been using Zephyr Squad for a while and haven't migrated to Essential yet, you'll still see the legacy functionality, in which case see the integration page for Zephyr Squad. Better Excel Exporter also supports Zephyr (formerly Zephyr Scale).

What is Zephyr Essential?

(supported since Better Excel Exporter 4.5.0)

Zephyr Essential is the next-generation version of Zephyr Squad, offering enhanced performance, a new REST API, and improved integration with Jira.

Zephyr Essential integration features

  • You can export the test steps for any test case. Zephyr Essential 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 Essential 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 Essential data.

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

Zephyr Essential integration vs. the Zephyr Essential built-in Excel exports

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

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

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

Configuration

Configuring the Zephyr Essential REST API access

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

Configuring the Zephyr Essential API keys
  1. Click your Jira profile icon in the top right and select Zephyr Essential 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 zephyrEssentialAccessToken variable (don't remove the quotation marks around the string!): 
    // zephyr-v2-tool.groovy

def zephyrEssentialAccessToken = "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 Essential