What is the Document Generator?


Xray Document Generator is a feature that allows you to customize your own templates and generate documents regarding your Jira data, mainly, Xray issues, requirements, and defects. It's easy to set up and start creating your documents.

How can you use the Document Generator?


  • Create a hard copy of the test-related issues (especially relevant for regulated industries)
  • Prepare a presentation for the board with the latest status of your tests exported directly from Xray.
  • Store your release coverage and status before launch with a quick report with Document Generator
  • Share information with someone without Jira access, for example relevant stakeholders
  • Export agile boards with requirement status and coverage.
  • Customize your report templates and embed your brand into all your exports.

Exporting Reports


You can create documents directly from the Issue detail screen by clicking on the Xray Document Generator button available on tools section (1) or from Issue Navigator screen (2).


Issue Detail Screen (1)


Issue Navigator Screen (2)












After clicking on it, you can select the template to use and the output format.



Having chosen the template and the output format, now you can generate your document by clicking on Export button, otherwise, we can close the dialog by clicking on Close button.

Once the generation process is finished you can get your document by clicking on Download button. If you want to generate another document you just have to click on Back button or leave the dialog by closing it.




When generating reports through the Issue Navigator Screen, you will export information from several issue at once. 

In this case, you can select the Break Type, where you can define if you want or not a page break on word documents, and if so, how. 


The values available for this field, are:




Creating your own templates 


Templates are documents built using Microsoft Word or Excel formats. Along with the document content, it is possible to specify mappings that will be replaced by the issue fields, custom fields, and other data such as comments, work logs, attachments, and even Xray customized data.


Check documentation for template building and template management: 




Check out our documentation to learn more about the Document Generator.