The Document Generator function in Xray is a powerful tool that allows you to create highly customizable reports. These reports can be shared with stakeholders who may not have access to Jira, ensuring that everyone stays informed.


Document Generator enables you to export information from Xray using a template in the following formats.


Remember, the key to effective reporting is customization and clarity. With Xray’s Document Generator, you have the tools to achieve both. Happy reporting! 😊


Base Templates


Specific reports will be accessible based on the project screen you’re on and the issue type you’ve chosen. Below is a sample that you can use as a reference for your own setup.


Find how to get templates from our Template Store.

Navigate into "Jira Administration" → click on "Apps".

From the left-hand side menu select "Document Generator" within Xray Settings

Select the option "Store" and "install" one or more templates from the available list.


(Video Description: How to get a template from the template store)

See an example for getting a report on Requirement Traceability Matrix.
Navigate to the Issues board in your project
From the Issues board view select the option from the top right corner of the board view "Go to all issues"
Click the button "Apps" and select the option "Xray - Document Generator"
Within the pop-up screen select the report "Xray Requirement Traceability Matrix" and "Export"
Document Generator will make your file ready, and once it does, press "Download"


(Video Description: Report on Requirement Traceability Matrix)



See an example for getting a report for Other Test Reports

Within any Issue screen → from the top right corner of the pop-up window, select the three dots option and click "Xray - Document Generator"

In this example, we chose to select Xray issue type Test Execution Report and click "Export"

Document Generator will make your file ready, and once it does, press "Download"


(Video Description: How to extract a report)


For any other report, select the respective Xray Issue type and choose the respective report, such as: 

 → Test | Test Report

→ Test Set | Test Set Report

→ Test Plan | Test Plan Report

→ Test Execution | Test Execution Report



Looking for Custom Templates? Check them out here.