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

Compare with Current View Page History

« Previous Version 38 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 creating new templates, install our add-in in Word and Excel apps. 



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

In your Word or Excel application, you can find the Add-ins typically situated under the “Home” tab.

Based on the version of Office you’re using, a drop-down menu or a pop-up window will appear. Look for the term “Xray” and select “Add” to include our add-in. The icon for this add-in should resemble the following:



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

How can I 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 Administration" > "Apps" 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 can 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.


How to create a new template.



You should be able to use the available mappings from Jira and Xray while using the documentation available here: 



Start with either a blank document or a company template, and set the layout to either portrait or landscape.
Craft a header for your document, and with the help of the Xray Document Generator add-in, insert the specified fields. You’re welcome to add your company logo if you wish.
  • Project Name: ${ProjectName}
  • Prepared by: ${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 add the following fields under your table header in your document, using the snippets provided by our Xray Document Generator Add-in. The code below serves as a guide. Don’t hesitate to explore beyond what’s provided if you’re feeling adventurous. More code here!


#{for Tips} Using our Xray Document Generator Add-in, go to “Xray Entities” and load any of them into your document. These entities display the fields that you can fill in your document. #{end}


Snippets from Xray Document Generator
&{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}


After completing the above steps, go ahead and give it a name, then save your work!




Navigate into "Jira Administration" > "Apps" and to "Document Generator" under Xray settings

From the top right corner, click the button "Add" and upload any given template you want to make available.


Now that you know how to create and upload a template, feel free to visit [Xray Cloud] Utilizing Templates in Xray’s Document Generator for more information. 

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