Purpose

This report lists some details of the selected Defects in Xray, enabling them to be extracted in an Excel format. With this ability to extract the report you can use it for analysis of trends and current testing status, or process this information to generate some metrics, for example, or even share it with someone else who still needs access to Jira.

Possible usage scenarios:

• see all the Defect statuses & count for a given version
• see the linked Requirements, Tests, and Defects
• track the Defects that are taking the most time to get resolved

Output Example(s)

The template contains 4 tabs, the following tables show an example of the columns/rows you should expect.

How to use

This report can be generated from different places/contexts, including:

• Issue view screen
• Issue search page (main search page or as a bulk operation)

Source data

In the store, you can find 2 subtypes for this template:

• "Bugsormix" - 1 or more Bug issue as well as a mix of Bug and Test Execution issues
• "Testexecs" - 1 or more Test Execution issues

Output format

The standard output format is .XLSX so you can open it in Microsoft Excel, Google Sheets, and other tools compatible with this format. From those tools, you can generate a .CSV file.

Report assumptions

The template has a set of assumptions that you have to make sure your Jira/Xray environment complies with:

1. Issue types having the name: "Test Execution", "Bug"
2. Bug final status being "Done" or "Resolved"
3. Finished Bugs having the "Resolved date" populated

If any of these assumptions is not met, you need to update the template or the environment accordingly.

Usage examples

Export Test Executions of your project

1. from the Issue Navigator/Search, search by the issueType (i.e., "Test Execution") from your project (e.g., "BOOK") and then use bulk export or Export->Xporter
   
   

project = "BOOK" and issuetype="Test Execution" order BY created DESC

Export Bugs associated with a given fix version

1. from the Issue Navigator/Search, search by the release (i.e., "fixVersion") of your project (e.g., "EWB") and then use bulk export or Export->Xporter
   
   

project = "BOOK" and issuetype= "Bug" and fixVersion=1.2 order BY created DESC

Export Test Executions and Bugs obtained in a given Environment

1. from the Issue Navigator/Search, search by Test Executions or Bugs assigned to that Test Environment  (e.g., "chrome") and then use bulk export or Export->Xporter

project = "BOOK" and issuetype in ("Test Execution", Bug) and environment IS chrome order BY created DESC

Export Bug or Test Execution from its detailed view

1. open the Bug/Test Execution issue and export it using this template

Understanding the report

The report shows information about the Defects in a list form as well as provides summary tables.

Layout

The report is composed of 4 sheets - "ReqsImpactSummary", "DefectSummary", "DetailedDefectList", and "Input". By default, all tabs are rendered. The layout is the same regardless of the template subtype used.

"ReqsImpactSummary" sheet

This sheet presents a table listing requirements ("Story" issue type) impacted by defects from your exported issues.

"DefectSummary" sheet

"DetailedDefectList" sheet

"Input" sheet

Customizing the report

The common customization actions are:

• adding/removing columns
• changing the level of detail in the columns

Exercise 1: add a field from the related Test Execution issue 

Let's say we have a "Description" field on the Test Execution issue that we want to show on the report.

We can copy the column "Summary" and adapt it.

1. Copy the "Summary" column 
2. Insert the copied content in a column next to the “Fix Versions”
   1. Change the header of the column to be “Description”
   2. Change the cell content from ${Summary} to ${Description}
   3. Save the template and upload it

As this report is column-based, if some columns are not relevant to you, you should be able to delete them. Make sure that no temporary variables are created in the cells of those columns that are used in other subsequent columns.

Exercise 2: add more details to the Test Plan column

Let's say you want to see not only the Test Plan Key, but also the Test Plan Summary, and make it a hyperlink while you are at it.

1. Navigate to the "Test Plan" column 
2. Edit the statement from ${Test Plan} to ${link:title=${Test Plan},href=${BaseURL}/browse/${Test Plan}}

You can apply similar changes to the Defects column by editing the following statements:

• ${TestRuns[n].ExecutionDefects[d].Key}  (line 6)
• ${TestRuns[n].Iterations[it].TestSteps[r].Defects[dc].Key} (line 22)

with the syntax like (the example is for line 6): 

@{title=${TestRuns[n].ExecutionDefects[d].Key}|href=${BaseURL}/browse/${TestRuns[n].ExecutionDefects[d].Key}} | ${TestRuns[n].ExecutionDefects[d].Summary} | ${TestRuns[n].ExecutionDefects[d].Priority}

Keep in mind that only 1 hyperlink will be active per Excel cell (the one associated with the first line item). Also, ${Test Plan} value is treated as a single list, so if you have multiple test plans linked to the same execution and you want to separate the urls, you will need to further customize the code from the example above. On a related note, as you probably noticed, Test Plan and Test Environment are displayed slightly differently from Defects by default - comma separation, square brackets (the DocGen version has the brackets for empty Test Plan cells, doesn't have them for non-empty Test Environments).

You can further finetune the content and formatting via JavaScript, you can find more useful snippets in this tutorial for Xporter and DocGen.

Performance

Performance can be impacted by the information that is rendered and by how that information is collected/processed.

The number of Test Executions and Test Runs, depending on scenarios, can be considerably high, especially with CI/CD. As this report sums up quite a lot of information, please use it wisely.