Page History

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.

...

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

...

UI Tabs

UI Tab title Document Generator Add-in ui-text-box-steps size small UI Step In your Word or Excel application, you can find the Add-ins typically situated under the “Home” tab. UI Step 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: Image AddedLet's learn how to add Document Generator Add-in to Microsoft! Multimedia name S - Document Generator - Microsoft Add-in.mp4 width 100% height 40% (Video Description: How to add Document Generator Add-in to Microsoft) UI Tab title Edit an existent existing Template UI Text Box Let's see how we can edit an existing template! Info Xray offers a variety of report types, yet you might find the need to customize them. If so, you’re welcome to: you can follow the steps below. UI Steps size small UI Step Navigate into "Jira Admin SettingsAdministration" > "Apps" and to "Document Generator" under Xray settings UI Step From any listed report, on the far right of each line click the button and select "Download" for the report you want to change Multimedia name S - Document Generator - Download an existing Report.mp4 width 100% height 40% (Video Description: How to download an existing report) You now have the ability to 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. UI Tab title Create a New Template Info This article shows an example you can follow, still, to learn more on mappings for both Jira and Xray, feel free to see them in our Template Building documentation. text-box UI Steps size small ui- Let's see an example of how to create a new template. UI Tab title Single Test Run UI Text Box Let's upload the newly created examples and use them for a single Test run step Start with either a blank document or a company template, and set the layout to either portrait or landscape. UI Step 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()} UI Step Give a title to your report, in our case "List of TestRuns Covering the Requirement" UI Step 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 UI Step 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! Tip #{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} Code Block language text theme FadeToGrey title Snippets from Xray Document Generator collapse true &{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} UI Step After completing the above steps, go ahead and give it a name, then save your work! UI Expand title Find an example of a Template View file name Template Example.docx height 150 UI Tab title Uploading a Template UI Steps size small UI Step Navigate into "Jira Administration" > "Apps" and to "Document Generator" under Xray settings UI Step From the top right corner, click the button "Add" and upload any given template you want to make available. Image Added Info 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.  UI Tab title Multiple Test Run UI Text Box Let's upload the newly created examples and use them for multiple Test run