You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

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


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


Custom Templates

To facilitate editing existing or create new templates, install our add-in in Word and Excel apps. 



Let's learn how to add Document Generator Add-in to Microsoft!


(Video Description: How to add Document Generator Add-in to Microsoft)

Let's see how we can edit an existing template!


Xray offers a variety of report types, yet you might find the need to customize them. If so, you’re welcome to:


Navigate into "Jira Admin Settings" and to "Document Generator" under Xray settings

From any listed report, on the far right of each line click the button and select "Download" for the report you want to change


(Video Description: How to download an existing report)


You now have the ability to open the report in Word or Excel and make modifications using our add-in. Furthermore, without the help of our add-in, you can also make edits using any other document editor of your choice.


Let's see an example of how to create a new template.


As an example, we will demonstrate using the Xray Add-in with Word.


Start with either a blank document or a company template, and set the layout to either portrait or landscape.
Design a header for your document using the given fields. Feel free to incorporate your company logo if desired.
  • Project Name: ${ProjectName}
  • Prepared by: ${fullname:Assignee}
  • Document Date: %{(new Date()).getDate() + "/" + ((new Date()).getMonth()+1) + "/" + (new Date()).getFullYear()}
Give a title to your report, in our case "List of TestRuns Covering the Requirement"
In this example, we’ll be creating a table that includes only the headers for the following seven fields:
  • Key
  • Execution Status
  • Executed by
  • Start Date
  • End Date
  • Defect Count
  • Comment
You can now proceed to incorporate the following code into your document underneath the header.&{for issues}#{for a=TestRunsCount}
${TestRuns[a].Key}${TestRuns[a].Execution Status}${TestRuns[a].Executed By}${TestRuns[a].Started On}${TestRuns[a].Finished On}${TestRuns[a].ExecutionDefectsCount}${TestRuns[a].Comment}
#{end}&{end}


Let's upload the newly created examples and use them for a single Test run

Let's upload the newly created examples and use them for multiple Test run

Looking to know how to use Base Templates? Check them out here.
  • No labels