---
title: "TTT: Recommendations"
canonical: "https://docs.getxporter.app/space/XPORTER/1409129/TTT%3A%20Recommendations"
format: markdown
---
> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> 
> 
> > Macro (toc)

# Introduction

Xporter for Jira Data Center is utilized across various industries by teams aiming to create fully customizable reports from Jira Issues and related entities.

As a versatile tool, Xporter can effortlessly generate reports for hundreds or even thousands of Issues, depending on the context (e.g., release report). However, report generation can consume considerable time and resources based on the report definition and the source data it utilizes.

This page offers some best practices to ensure that your Jira performance remains unaffected as much as possible.

Careless usage of Xporter may impact Jira's performance and the efficiency of the teams using it. However, by adhering to these recommendations, many problems can be mitigated or even completely avoided.

# General Recommendations

These recommendations are relevant for both standard users and Jira administrators.

## Do's

| **#** | **Action** | **Purpose and Recommendations** | **How To** |
| --- | --- | --- | --- |
| 1 | **Define the maximum number of Issues allowed to be exported** | Configuring the maximum number of Issues allowed to be exported to reduce the computational resources required to generate the report | Go to *[General Settings](https://docs.getxporter.app/space/XPORTER/1409516)* and set the value on the field** :**<br>[Bulk Export Option](https://docs.getxporter.app/space/XPORTER/1409516/Global+Settings#Bulk-Export-Options-(Figure-3---1)) > <u>Maximum number of Issues</u> |
| 2 | **Set a maximum number of simultaneous export processes** | If your organization has a large number of users, configure this setting with a low value (e.g.: "2") to reduce the performance overhead | Go to *General Settings* and set the value on the field** :**<br>Bulk Export Option > <u>Maximum number of simultaneous requests</u> |
| 3 | **Disable Xporter for all projects and users and set up Xporter Permission Schemes** | If Xporter is aimed to be used just by a few people in your organization, we highly recommend setting up Xporter [Permission Schemes](https://docs.getxporter.app/space/XPORTER/1409475). Permission Schemes will guarantee that only expected users will be able to utilize Xporter. This implies the creation of a Permission Scheme and the association of the scheme to a specific project(s). | Go to *General Settings* and disable the setting *Enable Xporter for all projects and all users* located in the [Global Permission section](https://docs.getxporter.app/space/XPORTER/1409516/Global+Settings#Global-Permissions-(Figure-3---2)) |
| 4 | **Use **[**Xporter Templates**](https://docs.getxporter.app/space/XPORTER/1409467)** wisely** | Sometimes, Xporter causes considerable performance overhead on Jira because the Template is too complex and/or the user is trying to export a large amount of data.<br>1. Try to reuse existing Templates available in [Xporter’s Template Store](https://store.getxporter.app/). They can be the base of your final Template.
2. In case of doubts, visit the [Xporter documentation and see examples](https://docs.getxporter.app/space/XPORTER/1409467) or [contact ](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28)[Xporter support](https://jira.xpand-it.com/servicedesk/customer/portal/2). | The Xporter Template Store is free.<br>More on building templates [here](https://docs.getxporter.app/space/XPORTER/1412105). |
| 5 | **Use Xporter multi-action workflow post-function** | If you want to generate a report during a workflow transition and you need to do multiple actions with it, please use the new Xporter Multi-Action [Workflow Post-Function](https://docs.getxporter.app/space/XPORTER/1412596) instead of creating several post-functions. | N/A |
| 6 | **Filter data at the source (Jira) instead of filtering inside the Template** | <span style="color: #000000">Make sure that the source data you use is only data you need to export.</span><br>Exporting or processing unnecessary data requires additional time and consumes additional resources:<br>1. Select only the Issues that are relevant to the report as a source.
2. Don't do filtering at the Template level, if you can filter data/Issues at the source. | Define a [JQL iteration](https://docs.getxporter.app/space/XPORTER/1413910), which gives you all the desired data to be exported |
| 7 | **Use **[**Excel Templates**](https://docs.getxporter.app/space/XPORTER/1413935)** to perform entity listing** | Processing some Template formats is more efficient than others.<br>If you need to make entity listings, Excel is better suited. We highly recommend you use Excel-based templates to generate entity listings. | Use XLSX-based Templates |

## Don'ts

| **#** | **Action** | **Consequence** | **Recommendation** |
| --- | --- | --- | --- |
| 1 | **Don't use complex Templates to export a large number of Issues' data** | Large amounts of data to be processed and complex Templates/reports will require additional computational resources, which may impact Jira's performance | We highly recommend that you export data in chunks and merge all documents later on, manually |
| 2 | **Don't schedule reports with large amounts of data frequently** | If reports are scheduled frequently and the amount of data to be exported is huge, the scheduled reports processing can substantially affect your Jira performance, because new export processes will spawn more frequently (eventually, leading to the overlap of the creation of the same reports) | Create scheduled reports daily, at the least. Be careful with the amount of data to be exported, the exporting process can affect Jira's performance. |
| 3 | **Don't export long text fields using an Excel template** | Whenever exporting a long text to an Excel cell, the text may not be fully visible because the cell is size-limited. This problem will worsen if you export the Template as PDF. | Avoid exporting long text fields to Excel cells |

#   
Xray Integration Recommendations

## Do's

| **#** | **Action** | **Purpose and Recommendations** |
| --- | --- | --- |
| 1 | **Reuse existing "Test & QA" related templates** | Xporter Template Store already provides many Templates related to testing and Xray. Please check the "[Test & QA" section](https://store.getxporter.app/?platf=JIRACLOUD&cats=1&sort=1&order=desc) and try to reuse an existing Template, adapting it to your needs. Some of those Templates are described in the next section. |
| 2 | **Delimit the scope of data used for the reports ** | Testing can lead to tons of data, including many Test Runs coming from automated testing.<br>Please select wisely the source data (i.e.: Issues and Test Runs), both inside the Template itself (i.e.: iterations) and also the selected Issues used as input for the Template generation. |
| 3 | **Properly choose where to trigger reports** | Testing reports are mostly heavy by nature; thus, avoid having heavy reports being generated as post-functions on workflows, for example.<br>Generating these kinds of reports should be a manually triggered action as frequently as possible.<br>Exporting from a bulk action should also be restricted for certain Templates. |

## Templates related with testing

Xray provides a set of templates related to Xray in the [Xporter Template Store](https://store.getxporter.app/). We highly suggest you use them as a basis for your reporting needs. 

The table below sums up some of these Templates and provides some additional recommendations for the most intensive (more resource-demanding) ones.

| **Template Name** | **Content Overview** |
| --- | --- |
| [Xray Test Report](https://store.getxporter.app/view/142?platf=JIRA8&sort=1&order=desc&keyWord=Xray%20Test%20Report) | This report includes all information about a specific Test, such as:<br>- Description.
- Last Execution Status.
- Pre Conditions.
- Requirements.
- Test Steps. |
| [Xray Test Set](https://store.getxporter.app/view/150?platf=JIRA8&sort=1&order=desc&keyWord=Xray%20Test%20Set) | This report includes all information about a specific Test Set and its tests. It includes the following information:<br>- Test Set Description.
- List of all tests, and for each one it includes:
  - Test Summary.
  - Test Description.
  - Pre Conditions.
  - Requirements.
  - Test Steps. |
| [Xray Text Execution (Basic)](https://store.getxporter.app/view/140?platf=JIRACLOUD&sort=1&order=desc&keyWord=Xray%20test%20execution) | Xray Test Execution Report has a brief of the all execution, it contains:<br>- Details
  - Description
  - Begin and end date
  - Revision
  - Test Environments
  - Test Plan Key
- Overall Execution Status (% per status)
- List of all Test runs
  - Key
  - Summary
  - Test Type
  - Number of Requirements
  - Number of Defects
  - List of Test Sets
  - Assignee
  - Status |
| [Xray Test Plan (Basic)](https://store.getxporter.app/view/138?platf=JIRACLOUD&sort=1&order=desc&keyWord=Xray%20Test%20Plan) | Xray Test Plan Report contains:<br>- Test Plan Details
  - Begin and end date.
  - Summary and description.
- Overall Execution Status (% per status)
- List of all Tests and their list of executions and status. |
| [Xray Requirement Traceability Matrix Report](https://store.getxporter.app/view/152?platf=JIRACLOUD&sort=1&order=desc&keyWord=Xray%20Requirement%20Traceability%20Matrix) | This report generates a table where all requirements are listed with the following information:<br>- Summary.
- Status.
- List of Tests.
- List of Defects.<br>> ⚠️ - This report can require considerable time and resources to be generated.
> ⚠️ - Please reduce the number of requirements used as the source for the report (e.g.: you may generate the report just for the requirements assigned to a given version). |


> ℹ️ - These and other templates can be downloaded from THE Xporter administration or directly from Xporter's Template Store.
> ℹ️ - Locally, templates may be modified and later uploaded back to Xporter.
> ℹ️ - If you need something that is not available out-of-the-box on the available templates or if you are having difficulties customizing your own template , please [contact the Xporter Support team](https://jira.xpand-it.com/servicedesk/customer/portal/2) and we'll be more than glad to help you out.

<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://docs.getxporter.app/space/XPORTER/23102936).
</details>