Let's learn how to add Document Generator Add-in to Microsoft!
UI 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:
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
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:
UI Steps
size
small
UI Step
Navigate into "Jira Administration" > "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 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
UI Text Box
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
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.
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}