Let'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 existing Template
UI Text Box
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:
UI Steps
size
small
UI Step
Navigate into "Jira Admin Settings" 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 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
UI Text Box
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.
UI Steps
size
small
UI Step
Start with either a blank document or a company template, and set the layout to either portrait or landscape.
UI Step
Design Craft a header for your documentusing the given fields. Feel free to incorporate , and with the help of the Xray Document Generator add-in, insert the specified fields. You’re welcome to add your company logo if desiredyou wish.
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
proceed to incorporate
add the following
code into
fields under your table header in your document
underneath the header.
, 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.
Code Block
language
text
&{forissues}#{fora=TestRunsCount}
${TestRuns[a].Key}
${TestRuns[a].ExecutionStatus}
${TestRuns[a].ExecutedBy}
${TestRuns[a].StartedOn}
${TestRuns[a].FinishedOn}
${TestRuns[a].ExecutionDefectsCount}
${TestRuns[a].Comment}
#{end}&{end}
UI Expand
title
Template Example
View file
name
Template Example.docx
height
150
UI Tab
title
Single Test Run
UI Text Box
Let's upload the newly created examples and use them for a single Test run
UI Tab
title
Multiple Test Run
UI Text Box
Let's upload the newly created examples and use them for multiple Test run