Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

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.

  • Base Templates: Xray provides a selection of free base templates to help you get started. These templates are designed to export information from your issues, including all data that an issue may contain, such as attachments. This feature enables you to present comprehensive reports without the need to start from scratch.
  • Custom Templates: In addition to the base templates, Xray also allows you to create your own templates. This can be done using our add-in for Microsoft Word and Excel

...

  • .


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

Image ModifiedImage ModifiedImage Modified


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


Info
titleReadme
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.


UI Tabs
UI Tab
titleTemplate Store
UI Text Box

Find how to get templates from our

...

Template Store.

UI Steps
sizesmall
UI Step

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

UI Step

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

UI Step

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


Multimedia
nameDocument Generator - Get a new template..mp4
width100%
height40%

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

UI Tab
title

...

Requirement Traceability Matrix
UI Text Box
See an example for getting a report on

...

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


Multimedia
nameDocument Generator - Requirement Traceability Matrix.mp4
width100%
height40%

(Video Description: Report on Requirement Traceability Matrix)


UI Expand
titleExample of an Extraction here.

View file
nameIssues.docx
height150


UI Tab
title

...

Other Reports
UI Text Box

See an example for getting a report

...

for Other Test Reports

ui-

...

steps

...

size

...

small
ui

...

-step

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

UI Step

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

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


Multimedia
nameDocument Generator - Test Execution Report Final.mp4
width100%
height40%

(Video Description: How to extract a report)


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

Image Added  Test | Test Report

Image Added → Test Set | Test Set Report

Image Added → Test Plan | Test Plan Report

Image Added → Test Execution | Test Execution Report



UI Expand
titleExample of an Extraction here.

View file
nameFF-32.docx
height150

Info

Looking for Custom Templates? Check them out here.

...