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 experience. This page refers to this edition.
However, if you've been using Zephyr Squad for a while and haven't migrated to Zephyr Essential yet, you'll still see the legacy experience. In that case, see Zephyr Squad instead.
Note that Better Excel Exporter also supports the Zephyr (formerly Zephyr Scale) edition.

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.

Zephyr Essential Excel export samples

Zephyr Essential test steps

Zephyr Essential test steps

This export example generated from the issue-navigator-with-zephyr-v2-test-steps.xlsx Excel template shows a mix of regular issue fields in the left (key, summary, priority) and Zephyr Essential test step details in the right (instructions, test data, expected result).

jira-zephyr-essential-test-steps.xlsx

Zephyr Essential test executions

Zephyr Essential test executions

Export Zephyr Essential test execution reports to Excel easily! Run a JQL search in Jira to find any arbitrary set of Zephyr Essential tests, then generate a filterable, searchable, shareable, grouped list of their test executions.

jira-zephyr-essential-test-executions.xlsx

Zephyr Essential test step results

Zephyr Essential test step results

This highly detailed Excel export captures the Zephyr Essential test results in three logical levels: tests, test executions for each test, and test step results for each test execution. Being a complete snapshot of testing data, you can search this, import this to external systems, use it for archiving purposes, etc.

jira-zephyr-essential-test-steps-results.xlsx

Zephyr Essential test report

Zephyr Essential test report

You can also export custom Excel reports from Zephyr Essential test data. The zephyr-v2-*-report.xlsx template gives a valuable overview of test executions per version, test cycle and tester, shows the test execution history, and shows which tests and executions discover the most defects. Build your own Zephyr Essential Excel reports by copying this template.

jira-zephyr-essential-report.xlsx

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