---
title: "Xporter Template: Test Report"
canonical: "https://docs.getxray.app/space/XRAYCLOUD/44566393/Xporter%20Template%3A%20Test%20Report"
format: markdown
---
> Macro (ui-expand)
> 
> > Macro (toc)

# Purpose

This report enables you to extract the detailed specification of Tests, so that you can generate a document that contains a snapshot of the latest specification. This can be used for revision/approval, or even to share it with someone else that hasn't access to Jira and wishes to pursue testing.

Possible usage scenarios:

- see the detailed specification of the Test(s), including the Test steps of manual scripted Test cases and the Gherkin of BDD Test scenarios
- see all Preconditions required by the Test(s)
- see all the requirements covered by the given Test(s)
- see all Test Sets where the Test(s) are included in
- see all Test Plans where the Test(s) are included in


# Output Example(s)

The following screenshots show an example of the sections you should expect in this report.

![Figure 1 - Example](media://85198b65-8fd1-4d2c-834a-a7d283c1dd76)

![Figure 2 - Example](media://b0321af6-4470-4318-8d1e-c2d3b45970c7)

![Figure 3 - Example](media://9efbc950-6f48-4133-ab72-6aa6fd5fc3ab)

![Figure 4 - Example](media://782223b3-b421-42fa-b6c0-3f36a984ec28)

# How to use

This report can be generated from the Issue details screen, or from the Issue Search/navigator page.

> ℹ️ **Learn more**
> ℹ️ 
> ℹ️ General information about all the existing places available to export from, and how to perform it, is available in the [Exporting](https://docs.getxporter.app/space/XPORTERCLOUD/253296713/Exporting+Issues) page.

## Source data

This report is applicable to one or more Test Issues.

## Output format

The standard output format is .DOCX, so you can open it in Microsoft Word, Google Docs, and other tools compatible with this format.  You can also export it to .PDF.

## Report assumptions

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

1. Issue types having these names
  1. "Test", "Test Set", "Test Plan"
2. Tests use the "tests" issue link type to cover issues (e.g., Story)

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

## Usage examples

### Export the test specification of all Tests having the "Login" component, or by other criteria  based on the Test Issue fields

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> In your Jira Cloud Project, on *Filters*, click *Search work items* (Figure 5 - 1).
> 
> The work items screen will open (Figure 5). There, click *More filters* (Figure 5 - 2) and select *Components* (Figure 5 - 3).
> 
> ![Figure 1 - Filters.png](media://a1a0e563-e634-42a0-a7ff-90c4e30b954c)
> 
> > Macro (rw-step)
> 
> Using the same search bar, search by component "Login" (Figure 6 - 2), or by other criteria based on the Test Issue's fields.
> 
> ![Figure 6 - Login](media://808474a0-d757-46fa-a200-bb5c46ad351d)
> 
> > Macro (rw-step)
> 
> Click *Apps* (Figure 7 - 1) and then select *Xporter* (Figure 7 - 2).
> 
> ![Figure 7 - Apps](media://9c0a38b1-65e4-4eb1-be12-907c9b4cc804)
> 
> > Macro (rw-step)
> 
> A modal will open (Figure 8). There, select your Xporter template (Figure 8 - 1), the output format (Figure 8 - 2), and the output file name (optional field; Figure 8 - 3). Then, click *Export* (Figure 8 - 4). 
> 
> ![Figure 8 - Modal.png](media://4163feef-14dc-4113-bd68-7462d9897d63)
> 
> > Macro (rw-step)
> 
> A new modal will open (Figure 9).
> 
> Click *Download* (Figure 9 - 1), and the report file will be downloaded immediately to your machine.
> 
> ![Figure 9 - Download](media://8020bb7b-438c-4bf2-a3be-21fe2d647c62)


### Export the test specification for all Tests contained in a Test Repository folder (including sub-folders)

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Go to the [Testing Board](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565166), right-click a folder, and click *View Issues in Navigator* (Figure 10 - 1).
> 
> ![Figure 10 - Issues](media://e0f26861-7318-42f2-a282-f15a85fc824d)
> 
> > Macro (rw-step)
> 
> You will be redirected to the work items screen (Figure 11).
> 
> Click *Apps* (Figure 11 - 1) and then select *Xporter* (Figure 11 - 2).
> 
> ![Figure 11 - Apps](media://4c950521-b459-4e7e-90f9-5b1f3f222c60)
> 
> > Macro (rw-step)
> 
> A modal will open (Figure 12). There, select your Xporter template (Figure 12 - 1), the output format (Figure 12 - 2), and the output file name (optional field; Figure 12 - 3). Then, click *Export* (Figure 12 - 4). 
> 
> ![Figure 12 - Modal](media://7f071f94-a789-4e9d-b757-97b7b766a668)
> 
> > Macro (rw-step)
> 
> A new modal will open (Figure 13).
> 
> Click *Download* (Figure 13 - 1), and the report file will be downloaded immediately to your machine.
> 
> ![Figure 13 - Download](media://e3591ac6-5e18-4f6e-af1e-dfc7bd95ad4a)


### Export the test specification for all Tests contained in a Test Plan or in one of its folders (including sub-folders)

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Go to the Testing Board (Figure 14) and select Test Plans (Figure 14 - 1).
> 
> ![Figure 14 - Test plans](media://649f6e18-0357-44f9-9d1e-e53fe2e2cc37)
> 
> > Macro (rw-step)
> 
> Right-click an Issue, and click *View Issue* (Figure 15 - 1).
> 
> ![Figure 15 - Issue](media://e6abed68-ee0b-4014-a821-db5d55b67a2b)
> 
> > Macro (rw-step)
> 
> On the Issue, click the actions icon (Figure 16 - 1) and select the *Xporter* option (Figure 16 - 2).
> 
> ![Figure 16 - Issue](media://c6ca8b41-0553-498e-834b-1cf3b1a9e20b)
> 
> > Macro (rw-step)
> 
> A modal will open (Figure 17). There, select your Xporter template (Figure 17 - 1), the output format (Figure 17 - 2), and the output file name (optional field; Figure 17 - 3). Then, click *Export* (Figure 17 - 4). 
> 
> ![Figure 17 - Export](media://65d904a0-51d3-4b2f-a7e4-f5f99e9342dd)
> 
> > Macro (rw-step)
> 
> A new modal will open (Figure 18).
> 
> Click *Download* (Figure 18 - 1), and the report file will be downloaded immediately to your machine.
> 
> ![Figure 18 - Download](media://13d21577-2bc7-49ea-8b71-21aba16a5283)

# Understanding the report

The report shows detailed information about the Tests, focused on their specification (e.g., manual steps, [Gherkin](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565320), Test charter).

## Layout

The report is composed of several sections. Two major sections are available: Introduction and Test Executions details.

By default, and to avoid overload/redundancy of information, only the "Introduction" section will be rendered; you can change this behavior on the template (more info ahead).

### "Introduction" section

This section is divided into three sub-sections:

1. Document Overview
2. Total tests
3. Requirements covered by these Tests

Each of these sections is explained below.

#### Document Overview

Brief description of what you will find in this report and how it was generated.

#### Total tests

In this section, the total tests are grouped by their Test type and a count is shown.

| **Test Type** | **Number of Tests** |
| --- | --- |
| Manual | Number of tests that are step/script-based; usually these are known as "manual" (even though "manual" is a rough simplification) |
| Gherkin | Number of Gherkin-based Tests; usually these correspond to Cucumber test scenarios, with Test Type "Cucumber", but may also refer to other Gherkin-based frameworks |
| Unstructured | Number of tests that are neither scripted nor Gherkin-based; usually these correspond to unstructured tests; this includes the tests having Test Type "Generic", "Exploratory", etc. |

> ℹ️ If you wish to count Tests by custom Test Types, you can do so. See more information ahead on how to customize this report.


The output will have the following information (Figure 19).

![Figure 19 - Table](media://ae60b015-feef-40fe-b4ab-65a09e338a40)

#### Requirements covered by these Tests

In this section we have an overview of all the requirements that are covered by the Tests in this report.

| **Field** | **Description** | **Code** |
| --- | --- | --- |
| Key | Key of the requirement (in this case we are adding it as link) | @{title=${Links[j].Key}|href=${BaseURL}/browse/${Links[j].Key}} |
| Summary | Summary of the requirement | ${Links[j].Summary} |
| Version | Project version assigned to the requirement | ${Links[j].FixVersions} |
| Workflow Status | Workflow Status of the requirement | ${Links[j].Status} |

The requirements are listed in a table as follows.

![Figure 20 - Table](media://aef47701-76f9-4f49-b647-dad925686fd6)

### Tests

This section will gather all the information related to each Test, focused on its specification.

It is composed of several sub-sections that will be filled with information if it is available or will be filled with a message showing that no information is available.

#### Test Summary

This section has a table with information regarding each Test in this report (and will repeat these sections for each Test). The information is presented as a table with the following fields:

| **Field** | **Description** | **Code** |
| --- | --- | --- |
| *Test Type* | Test Type | *${TestType}* |
| *Label(s)* | Labels assigned to the Test issue | *${Labels}* |
| *Component(s)* | Components assigned to the Test issue | *${Components}* |
| *Priority* | Priority assigned to the Test issue | *${Priority}* |


The resulting table looks like the one below.

![Figure 21 - Table](media://c2543c03-e91e-497c-abe1-07aeaf205373)

#### Test Description

The description of the Test (*${wiki:Description}*)

![Figure 22 - Description](media://9df76c22-6f88-4f49-891b-0b8927495a33)

#### Test Issue Attachments

This section only appears if you have any attachments associated with the Test.

| **Key** | **Description** |
| --- | --- |
| File Name | File Name of the Attachment |
| Author | The Author of the attachment |
| File Size | File Size of the attachments in bytes. |

This appears in the document in a table form. A thumbnail is shown for images.

![Figure 23 - Table](media://fdb81d35-46ba-43dd-b5ca-f4b721a00fa4)

#### Status of the last execution

This section shows the last execution status for the Test.

![Figure 24 - Status.png](media://5aa87a72-88af-4f6d-9eee-30b5af2526ef)

#### Requirements

In this section, we have an overview of all the requirements that are covered by the Test.

| **Field** | **Description** | **Code** |
| --- | --- | --- |
| Key | Key of the requirement (in this case we are adding it as link) | *@{title=${Links[j].Key}|href=${BaseURL}/browse/${Links[j].Key}}* |
| Summary | Summary of the requirement | *${Links[j].Summary}* |
| Version | Project version assigned to the requirement | *${Links[j].FixVersions}* |
| Workflow Status | Workflow Status of the requirement | *${Links[j].Status}* |

The requirements are listed in a table as follows.

![Figure 25 - Table](media://1a3b429f-ae08-4e2b-9b69-4149cc89c77d)

#### Preconditions

If the Test requires any Preconditions, they will be shown.

| **Key** | **Description** | **Code** |
| --- | --- | --- |
| *Key* | Key of the Precondition in the form of a link | *@{title=${PreConditions[n].Key}|href=${BaseURL}/browse/${PreConditions[n].Key}}* |
| *Summary* | Summary of the Precondition | *${PreConditions[n].Summary}* |
| *Condition* | Condition | *${wiki:PreConditions[n].Definition}* |

The Preconditions are listed in a table as follows.

![Figure 26 - Table](media://efedc0cc-4481-4385-8f4d-744ec7b0b83c)

#### Test Details

This section shows the Test details; for that we are considering the different possible Test Types we can have in Xray. For each type we will fetch different information.

| **Type** | **Key** | **Description** | **Code** | **Output** |
| --- | --- | --- | --- | --- |
| Unstructured<br>(e.g., "Generic") | Test Type | Test Type field | *${TestType}* | ![Figure 27 - Table](media://6047423a-3e9e-470d-be54-f6f11051b1a3) |
| Specification | Definition of the Generic test | ${Generic Test Definition} |
| Gherkin<br>(e.g., "Cucumber") | Test Type | Test Type field | *${TestType}* | ![Figure 28 - Table](media://e4a4164f-2aa7-4b43-8e39-b6f42a6bb0ae) |
| Gherkin Specification | Gherkin specification of the Test | *${Cucumber* Scenario} |
| Structured<br>(e.g., "Manual") | (Step) | Step Number | *${TestSteps[m].StepNumber}* | ![Figure 29 - Table](media://40649ff9-27bf-4d32-89e2-66911a7d7c33) |
| Action | Action of the Test Step | *${TestSteps[m].Action}* |
| Data | Data of the Test Step | *${TestSteps[m].Data}* |
| Expected Result | Expected Result of the Test Step | *${TestSteps[m].ExpectedResult}* |
| Attachments | Attachment of the Test Step; images will be rendered | *@{title=${TestSteps[m].Attachments[sa].Name}|href=${TestSteps[m].Attachments[sa].FileURL}}*<br>*!{${TestSteps[m].Attachments[sa].Attachment}|maxwidth=100}* |

#### Test Sets

If the Test is part of Test Sets, they will be shown.

| **Key** | **Description** | **Code** |
| --- | --- | --- |
| *Key* | Key of the Test Set in the form of a link | *@{title=${TestSets[x].Key}|href=${BaseURL}/browse/${TestSets[x].Key}}* |
| *Summary* | Summary of the Test Set | *${TestSets[x].Summary}* |
| *Version* | Project version assigned to the Test Set | *${TestSets[x].FixVersions}* |

The Test Sets are listed in a table as follows.

![Figure 30 - Table](media://fc580106-0065-4b9a-8c7b-41b41098985f)

#### Test Plans

If the Test is part of Test Plans, they will be shown.

| **Key** | **Description** | **Code** |
| --- | --- | --- |
| *Key* | Jira Key of the Test Plan in the form of a link | *@{title=${TestPlans[x].Key}|href=${BaseURL}/browse/${TestPlans[x].Key}}* |
| *Summary* | Summary of the Test Plan | *${TestPlans[x].Summary}* |
| *Version* | Project version assigned to the Test Plan | *${TestPlans[x].FixVersions}* |

The Test Plans are listed in a table as follows.

![Figure 31 - Table](media://c85cd4a8-1316-4af4-ad60-f2f3c2a28bdb)

### Appendix A: Approval

This section is added for the cases where you need to have a signature validating the document.

![Figure 32 - Example](media://4cedfb46-f1c9-4a25-8070-96c9d4bd4413)

# Customizing the report

## <span style="color: #000000">Adding or removing information to/from the report</span>

<span style="color: #000000">To add additional information, usually we're thinking of adding:</span>

- <span style="color: #000000">fields of the Preconditions, "requirements", Test Sets, or of the Test Plans associated with the Test</span>

### <span style="color: #000000">Exercise: add a field from the related "requirement" issue </span>

<span style="color: #000000">Let's say we have a "Severity" field on the "requirement" (i.e., covered issue) that is linked to the Test, and that we want to show it on the report.</span>

<span style="color: #000000">We can copy the column "Summary" from the "Requirements" section and adapt it.</span>

1. <span style="color: #000000">on the "Requirements" section,</span>
  1. <span style="color: #000000">copy "Summary" (i.e., insert a column next to it and copy the values from the existing "Summary" column)</span>
  2. <span style="color: #000000">change the contents to</span>
    1. <span style="color: #000000">${Links[j].Severity}</span>

### <span style="color: #000000">Exercise: add a custom test step field </span>

<span style="color: #000000">Let's say we have a "StepField1" test step custom field configured for our project and that it might be used in some test steps of some Tests.</span>

1. <span style="color: #000000">Go to the Test Details section</span>
2. <span style="color: #000000">Add the "Step Custom Fields" column to the table</span>
3. <span style="color: #000000">Add the name of the test step custom field along with the value, in the content cell </span>
  1. <span style="color: #000000">StepField1: ${wiki:TestSteps[n].StepField1}</span>

Keep in mind that you cannot easily iterate through all such custom fields with one statement, you need to target each one individually by name.

 Performance

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

> ℹ️ **Some tips**
> ℹ️ 
> ℹ️ - Remove rendering of images for Test Issue Attachments and for Test Step's attachments
> ℹ️ - limit the number of input issues

# Known limitations

- Modular tests are not fully supported: you will see a note that a test was called, but not its key/steps/etc.
- Data-driven Tests are not supported.


<details>
<summary>Support/Troubleshooting</summary>

If you have questions or technical issues, please [contact the Support team via the Customer Portal (Jira service management)](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28) or [send us a message using the in-app chat](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44577312).
</details>