In this page

What is Zephyr?

(supported since Better Excel Exporter 3.1.0)

Zephyr is the most popular test management solution for the Jira platform.

Zephyr integration features

  • You can export the test steps for any test list. Zephyr tests are regular Jira issues. This enables creating Excel files that contain issue field values and the following test step data: test step instructions, test step data, expected result, test step attachment count and test step attachment file names.
  • You can export the test executions for any test list. Executions are exported with their details for a comprehensive report: test cycle, version, execution status, assignee, executor user, execution date, execution defects, step defects 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 comments.

(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:

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

Tutorial video

Watch this short video to get the gist of exporting Zephyr tests to Excel reports! (Although the video below was captured about the app's Server version, the Cloud version is very similar. The only major difference is that in the Cloud version you cannot export directly from the Zephyr screens, due to a limitation in Atlassian Connect.)

Zephyr Excel export samples

Zephyr test steps

Zephyr test cases are Jira issues of the "Test" type. This export example generated from the issue-navigator-with-test-steps.xlsx Excel template shows a mix of regular issue fields in the left (key, summary, priority) and Zephyr test step details in the right (instructions, test data, expected result).

jira-zephyr-test-steps.xlsx

Zephyr test executions

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

jira-zephyr-test-executions.xlsx

Zephyr test step results

This highly detailed Excel export captures the Zephyr 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-test-step-results.xlsx

Zephyr test report

You can also export custom Excel reports from Zephyr test data. The zephyr-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 Excel reports by copying this template.

jira-zephyr-report.xlsx

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-tool.groovy.

Configuring the Zephyr API keys
  1. Click the cog icon "⚙" in the top right → AppsGenerate API Keys (under Zephyr for Jira Cloud).
  2. Click Create System Key, enter a name for the key pair and click Submit.
  3. Copy the Access Key from the System Keys section (using the copy-page icon).
  4. Click the cog icon "⚙" in the top right → AppsExcel Templates (under Better Excel Exporter).
  5. Open the zephyr-tool.groovy template for editing and paste the key to the value of the $zephyrAccessKey variable (don't remove the quotation marks around the string!):
    // zephyr-tool.groovy
    
    /* Zephyr REST API authentication. */
    def zephyrAccessKey = "ZjFkNjQ3ZDMtNjRiZi0zMmU5LTgzYzItOGYyOWIxMmRiYzA4IDU1NzA1OCUzQTUyZDJjMDVlLWRmNjQtNGMyYy1iYmI2LWJkYzZhY2ZkZmU5MyBaQVBJ"
    def zephyrSecretKey = "7Wdthr-OoVKTuZvDkdFSGLIiL9pqvAwkfN0Tc7goO3g"
    
  6. Similarly, copy the Secret Key, and paste it to the value of $zephyrSecretKey.
  7. Save the changes in zephyr-tool.groovy. (Don't worry about storing keys here: this file is visible only for Jira administrators, who would have super-user permissions anyway.)
Configuring the user account ID
  1. Click your profile icon in the top right, and select Profile.
  2. Copy the account ID from the end of the URL in the address bar (its format should be like 447058:52d2c05e-df64-4b2c-bab6-bdc6acfdfe95).
  3. Click the cog icon "⚙" in the top right → AppsExcel Templates (under Better Excel Exporter).
  4. Open the zephyr-tool.groovy template for editing and paste the ID to the value of the $zephyrAccountId variable (don't remove the quotation marks around the string!):
    // zephyr-tool.groovy
    
    def zephyrAccountId = "447058:52d2c05e-df64-4b2c-bab6-bdc6acfdfe95"
    
  5. Save the changes in zephyr-tool.groovy.

Learn more about Zephyr