Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
UI Steps
UI Step

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.

UI Step

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 Doc. Gen.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.

UI Step

Exporting Reports


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


Issue Detail Screen (1)

Image Added


Issue Navigator Screen (2)


Image Added





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

Image Added



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. 

Image Added




Tip

Xray Document generator is available on the Agile Boards/Releases and you will be able to export all the issues allowed by Xray that belong to the Active Sprint, Backlog or Releases.


From Active Sprint

Image Added

From Backlog

Image Added


From Releases

Image Added




Image Removed


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.


Check documentation for template building and template management: 


UI Step

Creating your own templates 

Template ManagementExporting

Image Removed

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



Info

Check out our documentation to learn more about the Document Generator

Image Removed

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

.