What is the Xray 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.

Your end-to-end flow with Document Generator would look like this:

  1. Work with your Jira admins to evaluate the template collection already available (at the instance and/or the project level). 
  2. If needed, add more templates. There are 2 sources: the store and your customization.
    1. While you can build a template from scratch, we recommend editing one of the existing assets from the store.
    2. You would leverage the Template Building section of this documentation alongside code customization examples in Document Generator and Xporter code snippets
    3. Please check Curated list of Document Generator Templates to see some concrete examples of available templates (from the default package or the store) and their possible edits.
  3. Select the scope you want to analyze and choose the corresponding menu option for Document Generator
  4. Export

Template Management

Administrators can add, edit, delete, and download the templates that will be available to the users.

Template Building

Templates are documents in DOCX (Microsoft Word) or XLSX (Microsoft 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 many other types of data.


You can export a Single or Multiple Issues using the Xray - Document Generator button. This option will be available on Single Issue, Multiple Issue, and Agile Boards panel.