---
title: "Reports with Xporter"
canonical: "https://docs.getxray.app/space/XRAY/160236127/Reports%20with%20Xporter"
format: markdown
---
[Xporter](https://marketplace.atlassian.com/apps/891368/xporter-export-issues-from-jira?hosting=server&tab=overview) is a Jira app that allows you to export information from Jira issues and supported Jira plugins, including Xray, to Word, Excel, PDF, or other type of documents.

Through its integration with Xray, Xporter provides a simple way to export single or bulk Tests, for example, or even a Test Plan and thus make a customized testing related report.

The layout of the output document can be customized using templates built in .<span style="color: #172B4D">DOCX (Microsoft Word), .XLSX (Microsoft Excel) or even .ODT (Open Office) files.</span>

<span style="color: #172B4D">Templates are regular documents where certain placeholders (e.g.,</span>*<span style="color: #172B4D"> </span>**<span style="color: #172B4D">#{...}, ${...}, &{...},</span>*<span style="color: #172B4D"> </span><span style="color: #172B4D">%{...}) can be used to render some fields or to perform auxiliary operations.</span>

<span style="color: #172B4D">The Xporter language syntax used within the document template allows you to:</span>

- <span style="color: #172B4D">**implement core logic**</span>
  - <span style="color: #172B4D">define temporary/auxiliary variables</span>
  - <span style="color: #172B4D">implement conditional blocks (i.e., "if" statements) using JavaScript</span>
  - <span style="color: #172B4D">perform iterations/loops (i.e., "for" statements) over fields or entities that are list based (e.g., components, comments), with ability to filter</span>
- <span style="color: #172B4D">**process data**</span>
  - <span style="color: #172B4D">obtain the input issue(s) used during the export document request</span>
  - <span style="color: #172B4D">obtain issues on-demand using JQL queries</span>
- <span style="color: #172B4D">**render information**</span>
  - <span style="color: #172B4D">render issue's custom fields using "mappings" in Xporter's terminology</span>
  - <span style="color: #172B4D">render entities and attributes connected to Jira issues from supported Jira apps using tailored "mappings" for this purpose</span>
  - <span style="color: #172B4D">render text using a JavaScript expression</span>

<span style="color: #172B4D">Please check Xporter's documentation to learn more about</span><span style="color: #172B4D"> </span>[<span style="color: #172B4D">Working with Templates</span>](https://docs.getxporter.app/space/XPORTER/1412105/Working+with+Templates)<span style="color: #172B4D">, and the page that has more information about the</span><span style="color: #172B4D"> </span>[<span style="color: #172B4D">mappings available to obtain Xray related data</span>](https://docs.getxporter.app/space/XPORTER/1413922)<span style="color: #172B4D">.</span>

<span style="color: #172B4D">Ready to use templates are freely available for use or further customization from a template store. The template store can be accessed right from Xporter administration under the</span><span style="color: #172B4D"> </span>[<span style="color: #172B4D">Templates section</span>](https://docs.getxporter.app/space/XPORTER/1409467)<span style="color: #172B4D">, or also from a given</span><span style="color: #172B4D"> </span>[<span style="color: #172B4D">project settings page</span>](https://docs.getxporter.app/space/XPORTER/1409260)<span style="color: #172B4D">.</span>

<span style="color: #172B4D">After being installed, and depending on the configured settings for the template, documents/reports can be </span>[<span style="color: #172B4D">generated/exported</span>](https://docs.getxporter.app/space/XPORTER/1409732)<span style="color: #172B4D"> from different places, such as the issue screen, Issue search/Navigator page, workflow post-functions, etc.</span>

# How to

- <span style="color: #172B4D">Provisioning Templates</span>
  - [<span style="color: #172B4D">Global Templates</span>](https://docs.getxporter.app/space/XPORTER/1413922)
  - [<span style="color: #172B4D">Project-level Templates</span>](https://docs.getxporter.app/space/XPORTER/1409260)
- <span style="color: #172B4D">Building Template</span>
  - [<span style="color: #172B4D">Working with Templates</span>](https://docs.getxporter.app/space/XPORTER/1412105)
  - [<span style="color: #172B4D">Mappings available to obtain Xray related data</span>](https://docs.getxporter.app/space/XPORTER/1413922)
  - [<span style="color: #172B4D">Tutorials, Tips & Tricks for Document Generator and Xporter</span>](https://getxraydocs.atlassian.net/wiki/spaces/X710/pages/45187095)
- [<span style="color: #172B4D">Exporting documents</span>](https://docs.getxporter.app/space/XPORTER/1409732)


# Sample Reports

- [Curated list of Xporter Templates](https://getxraydocs.atlassian.net/wiki/spaces/XRAY/pages/160301188)
- [All available Xporter Templates related to testing on the public template store](https://store.getxporter.app/?platf=JIRA8&cats=1&sort=1&order=desc)