---
title: "Recommendations"
canonical: "https://docs.getxporter.app/space/XPORTERCLOUD/23363610/Recommendations"
format: markdown
---
> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> > Macro (toc)

# Introduction

[Xporter for Jira Cloud](https://marketplace.atlassian.com/apps/891368/xporter-export-issues-from-jira?tab=overview&hosting=cloud) 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.

# Recommendations

## General Recommendations

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

Do's

| **#** | **Action** | **Purpose and Recommendations** | **How To** |
| --- | --- | --- | --- |
| 1 | **Disable Xporter for all projects and users and setting up Xporter **[**Permission Schemes**](https://docs.getxporter.app/space/XPORTERCLOUD/528718/Permission+Schemes) | If Xporter is intended to be used by only a select few within your organization, we highly recommend setting up Xporter Permission Schemes. Permission schemes ensure that only designated users can access Xporter. This involves creating a permission scheme and associating it with specific project(s). | Go to **Miscellaneous** and disable the [*<span style="color: #000000">Enable Xporter for all projects and all users</span>*](https://docs.getxporter.app/space/XPORTERCLOUD/462170/Miscellaneous)<span style="color: #000000"> setting.</span> |
| 2 | **Use **[**Xporter Templates**](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates) | At times, Xporter can cause significant performance issues in Jira, either because the template is overly complex or because the user is attempting to export a large amount of data.<br>Consider reusing existing templates available in the [Xporter Template Store](https://store.getxporter.app/). These templates can serve as the foundation for your final template.<br>If you have any doubts, refer to the [Xporter documentation](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates) for examples or [Xporter support](https://jira.getxray.app/servicedesk/customer/portal/2). | The [Xporter Template Store is accessible via the Xporter app Administration](https://docs.getxporter.app/space/XPORTERCLOUD/528787) and/or through the Xporter [website](https://store.getxporter.app/). <span style="color: #0d0d0d">Templates from the store are available for free use.</span> |
| 3 | **Use the **[**Xporter Multi-Action workflow post-function**](https://docs.getxporter.app/space/XPORTERCLOUD/460608/Workflow+-+Post+Function) | When generating a report during a workflow transition and needing to perform multiple actions, utilize the Xporter Multi-Action workflow post-function instead of creating several post-functions. | N/A |
| 4 | **Filter data at the source (Jira) instead of filtering inside the Template** | Ensure that the data you retrieve from the source is only the data you need for export. Exporting or processing unnecessary data consumes additional time and resources.<br>Select only the issues relevant to the report as the data source.<br>Avoid filtering at the template level if you can filter data/issues at the source. | Define a [JQL](https://docs.getxporter.app/space/XPORTERCLOUD/527003) <span style="color: #0d0d0d">query that retrieves all the desired data for export</span> |
| 5 | **Use **[**Excel Templates**](https://docs.getxporter.app/space/XPORTERCLOUD/558471)** to perform entity listing** | Certain template formats are more efficient for processing than others.<br>For entity listings, we recommend using the XLX format. | We highly recommend using Excel Templates (XLX files) for generating entity listings |

### Dont's

| **#** | **Action** | **Consequence** | **Recommendation** |
| --- | --- | --- | --- |
| 1 | **Avoid using complex Templates to export a large number of issues data** | Processing large volumes of data and complex templates or reports requires additional computational resources, which can impact Jira's performance | If feasible, we highly recommend exporting data in smaller chunks and then merging all documents manually |
| 2 | **Don't schedule reports with large amounts of data frequently** | Frequent [scheduling of reports](https://docs.getxporter.app/space/XPORTERCLOUD/15466498/Scheduled+Reports) with substantial data exports can significantly impact Jira's performance. The processing of scheduled reports may overlap, leading to duplication of report creation. | Consider scheduling reports daily, at a minimum.<br>Exercise caution regarding the amount of data being exported, as the exporting process can impact Jira's performance. |
| 3 | **Avoid exporting long text fields using an Excel Template** | When exporting lengthy text to an Excel cell, the text may not be fully visible due to cell size limitations. This issue can become more pronounced when exporting the template as a PDF. | If possible, refrain from exporting long text fields to Excel cells. |

##   
Xray Integration Recommendations

### Do's

| **#** | **Action** | **Purpose and Recommendations** |
| --- | --- | --- |
| 1 | **Reuse existing *****Test & QA***** related templates** | <span style="color: #0d0d0d">Xporter's </span>[<span style="color: #0d0d0d">Template Store</span>](https://store.getxporter.app/)<span style="color: #0d0d0d"> already offers numerous templates tailored for testing and </span>[<span style="color: #0d0d0d">Xray</span>](https://www.getxray.app/)<span style="color: #0d0d0d">. Explore the </span>[<span style="color: #0d0d0d">Test & QA section</span>](https://docs.getxporter.app/space/XPORTERCLOUD/23363610/Recommendations#Templates-Related-to-Testing)<span style="color: #0d0d0d"> to find templates that suit your needs. Consider adapting an existing template to meet your specific requirements.</span> |
| 2 | **Limit the scope of data used for reports ** | Testing often generates large amounts of data, including numerous test runs from automated testing. Be selective in choosing the source data (i.e., Jira Issues and test runs) both within the template itself (i.e., [Iterations](https://docs.getxporter.app/space/XPORTERCLOUD/428318)) and in the selected Issues used as input for template generation. |
| 3 | **Properly choose when to trigger reports** | Testing reports are typically resource-intensive. Avoid automatically generating heavy reports, such as post-functions on workflows. Instead, manually trigger the generation of these reports as frequently as necessary. Additionally, consider restricting bulk action exports for certain Templates. |

### Templates Related to Testing

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

The table below summarizes some of these templates and provides additional recommendations for the more resource-demanding ones.

| **Template Name** | **Content Overview** | **Usage Notes** |
| --- | --- | --- |
| [Xray Test Report](https://store.getxporter.app/view/144) | This report includes all information about a specific test, such as:<br>- Description.
- Last Execution Status.
- Pre Conditions.
- Requirements.
- Test Steps. | N/A |
| [Xray Test Set](https://store.getxporter.app/view/153) | This report includes all information about a specific test set and its tests. It includes:<br>- Test Set Description.
- List of all tests, and for each one it includes:
  - Test Summary.
  - Test Description.
  - Pre Conditions.
  - Requirements.
  - Test Steps. | N/A |
| [Xray Text Execution (Basic)](https://store.getxporter.app/view/140) | Xray Test Execution Report 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. | N/A |
| [Xray Text Execution (Advanced)](http://store.xporter.xpand-it.com/view/10?platf=2&cats=1) | This report is an extension of the previous one. This includes all data mentioned above plus more detailed information per test run, such as:<br>- List of Defects.
- List of Requirements.
- Test Details. | As the number of test runs can be considerably high, and the information recorded for each one can be extensive, please use this report carefully as it can require considerable time and resources to be generated.<br>An alternative would be to use the [Xray Test Execution (Basic) template](https://store.getxporter.app/view/140) instead, if the high-level progress information is enough for you. |
| [Xray Test Plan (Basic)](https://store.getxporter.app/view/138) | 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. | N/A |
| [Xray Test Plan (Advanced)](http://store.xporter.xpand-it.com/view/68?platf=2&cats=1) | This is a more detailed report regarding the test plan. This one includes all information present in the previous one, plus detailed information related to each test execution. | Similar to what happens with the [Xray Test Execution (Advanced) template](http://store.xporter.xpand-it.com/view/10?platf=2&cats=1), as the number of test runs can be considerably high, and the information recorded for each one can be extensive, please use this report carefully as it can require considerable time and resources to be generated.<br>A test plan can have multiple test executions related to it, therefore increasing the total amount of runs.<br>An alternative would be using the Xray Test Plan (Basic) template instead if the high-level progress information is enough for you. |
| [Xray Requirement Traceability Matrix Report](https://store.getxporter.app/view/152) | This report generates a table where all requirements are listed with the following information:<br>- Summary.
- Status.
- List of Tests.
- List of Defects. | This report may require considerable time and resources to be generated.<br>Please reduce the number of requirements used as a source for the report (e.g.: you may generate the report just for the requirements assigned to a given version). |


> ℹ️ These and other [Templates](https://docs.getxporter.app/space/XPORTERCLOUD/431152) can be downloaded from the Xporter administration menu or directly from Xporter's Template Store. You can modify templates locally and later upload them 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 our Support Team](https://jira.getxray.app/servicedesk/customer/portal/2) Team 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/XPORTERCLOUD/18251779/In-App+Chat+Support).
</details>