In this page

What is Zephyr?

(supported since Better PDF Exporter 1.3.0)

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

Zephyr integration features

  • As Zephyr tests are regular Jira issues, this enables creating self-containing exports from Zephyr tests with all their details from field values (test details), through attachments and comments, to test steps (instructions).
  • You can export the test executions for any test. Executions are exported with their (customizable) details for a comprehensive report: test cycle, version, status, defects, executor user and execution date.
  • You can export the test step results of the test executions for detailed test reports. In this case, the following (customizable) details are exported for each step: status, defects, comments and execution date.

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

Zephyr integration vs. the Zephyr built-in PDF exports

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

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

If any of these are important for you, give it a try.

Tutorial video

Watch this short video to get the gist of exporting Zephyr tests to PDF documents! (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 PDF export samples

Zephyr test steps PDF export

This example shows the export of the Zephyr test steps (with the corresponding test data and expected result), augmented with regular Jira issue information, from field values through attachments to links.

jira-zephyr-atm-test-steps.pdf

Zephyr test executions PDF export

This Zephyr test PDF export also contains the executions of the test, in addition to the definition of that. If you care only about the executions, you can easily customize the PDF template and remove the unwanted parts.

jira-zephyr-atm-test-executions.pdf

Zephyr test step results PDF export

This is the most detailed example, exporting to PDF all Zephyr test executions and their step results. The document also includes the defects related to the test or to a single test step, plus the executor and the test execution time.

jira-zephyr-atm-test-step-results.pdf

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 issue-fo.vm.

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 → AppsPDF Templates (under Better PDF Exporter).
  5. Open the issue-fo.vm template for editing and paste the key to the value of the $zephyrAccessKey variable (don't remove the quotation marks around the string!):
    #set($zephyrAccessKey = "ZjFkNjQ3ZDMtNjRiZi0zMmU5LTgzYzItOGYyOWIxMmRiYzA4IDU1NzA1OCUzQTUyZDJjMDVlLWRmNjQtNGMyYy1iYmI2LWJkYzZhY2ZkZmU5MyBaQVBJ")
    #set($zephyrSecretKey = "7Wdthr-OoVKTuZvDkdFSGLIiL9pqvAwkfN0Tc7goO3g")
    
  6. Similarly, copy the Secret Key, and paste it to the value of $zephyrSecretKey.
  7. Save the changes in issue-fo.vm. (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 → AppsPDF Templates (under Better PDF Exporter).
  4. Open the issue-fo.vm template for editing and paste the ID to the value of the $zephyrAccountId variable (don't remove the quotation marks around the string!):
    #set($zephyrAccountId = "447058:52d2c05e-df64-4b2c-bab6-bdc6acfdfe95")
    
  5. Save the changes in issue-fo.vm.

Configuring the Zephyr PDF templates

The template issue-fo.vm contains the following configuration parameters in its top part, to enable these features:

#set($exportZephyrTestSteps = $pdfView.name.contains('Steps'))
#set($exportZephyrTestExecutions = $pdfView.name.contains('Executions'))
#set($exportZephyrTestExecutionDetails = $pdfView.name.contains('Results'))

As you see, the template checks if the view name contains certain words, and turns on the different features accordingly. If the export is made with the default Zephyr views (like "Zephyr Test Steps"), these will work as expected. But, nothing prevents you from enforcing them to true or false like this:

#set($exportZephyrTestSteps = true)
## ...

About performance: exporting Zephyr test execution details (test step results and step defects) will significantly increase the number of required Zephyr REST calls and thus the total rendering time. If you are experiencing timeout issues, either set $exportZephyrTestExecutionDetails to false or export a smaller number of tests in one go.

Note that the issue-fo.vm template makes the Zephyr REST calls only for the issues that are actual Zephyr tests. It decides whether an issue is a Zephyr test by checking its issue type name (if it is a "Test"). Therefore, if you rename issue types, you also need to adapt the logic around this part in the template code:

## Zephyr test steps
#if($issue.issueTypeObject.name == "Test")
	## ...

Learn more about Zephyr