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

# Xporter Basics

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> **What is Xporter for Jira Data Center?**
> 
> See [here](https://docs.getxporter.app/space/XPORTER/1412005).
> 
> > Macro (rw-step)
> 
> **What are the key features of the Xporter for Jira Data Center?**
> 
> See [here](https://docs.getxporter.app/space/XPORTER/1412005/About+Xporter+for+Jira+Data+Center#Xporter-App-Key-Features).
> 
> > Macro (rw-step)
> 
> **What are the differences between Xporter for Jira Cloud and Data Center?**
> 
> See [here](https://docs.getxporter.app/space/XPORTER/1409405/Data+Center+vs+Cloud+Version).
> 
> > Macro (rw-step)
> 
> **How can I install Xporter for Jira Data Center?**
> 
> See [here](https://docs.getxporter.app/space/XPORTER/1412018/Installation).
> 
> > Macro (rw-step)
> 
> **What can I do in Xporter, as an admin?**
> 
> See the [quick guide for admin](https://docs.getxporter.app/space/XPORTER/23298071) and the [full admin guide](https://docs.getxporter.app/space/XPORTER/1409448).
> 
> > Macro (rw-step)
> 
> **What can I do in Xporter, as a user?**
> 
> See the [quick guide for user](https://docs.getxporter.app/space/XPORTER/23298126) and the [full user guide](https://docs.getxporter.app/space/XPORTER/1409453).

# Using Xporter

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> **How can I access Xporter?**
> 
> See [here](https://docs.getxporter.app/space/XPORTER/1412133/App+Administration#Access).
> 
> > Macro (rw-step)
> 
> **What does the Xporter menu offer?**
> 
> See [here](https://docs.getxporter.app/space/XPORTER/1412133/App+Administration).
> 
> > Macro (rw-step)
> 
> **How can I export Jira Issues using Xporter?**
> 
> See [here](https://docs.getxporter.app/space/XPORTER/1409732).
> 
> > Macro (rw-step)
> 
> **How can I use Xporter Templates (from a user's perspective)?**
> 
> See [here](https://docs.getxporter.app/space/XPORTER/1412105).
> 
> > Macro (rw-step)
> 
> **How can I **<span style="color: #111111">**schedule reports?**</span>
> 
> <span style="color: #111111">See </span>[<span style="color: #111111">here</span>](https://docs.getxporter.app/space/XPORTER/1409498)<span style="color: #111111">.</span>
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**How can I learn more about Xporter?**</span>
> 
> <span style="color: #111111">You can learn all about Xporter by exploring the </span>[<span style="color: #111111">Xporter Academy</span>](https://docs.getxporter.app/space/XPORTER/1410163)<span style="color: #111111">.</span>
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**How can I learn about the Xporter releases?**</span>
> 
> <span style="color: #111111">See </span>[<span style="color: #111111">here</span>](https://docs.getxporter.app/space/XPORTER/1412592)<span style="color: #111111"> all the Xporter release notes.</span>
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**I have questions/suggestions. How can I contact the Xporter team?**</span>
> 
> <span style="color: #111111">See </span>[<span style="color: #111111">here</span>](https://docs.getxporter.app/space/XPORTERCLOUD/526206/Support)<span style="color: #111111">.</span>

# Xporter Admin Management 

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**How can I **</span><span style="color: #111111">**manage all the Xporter settings?**</span>
> 
> <span style="color: #111111">See</span><span style="color: #111111"> </span>[<span style="color: #111111">here</span>](https://docs.getxporter.app/space/XPORTER/1412133/App+Administration)<span style="color: #111111">.</span>
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**How can I manage an Xporter project's settings?**</span>
> 
> <span style="color: #111111">See</span><span style="color: #111111"> </span>[<span style="color: #111111">here</span>](https://docs.getxporter.app/space/XPORTER/1414251)<span style="color: #111111">.</span>
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**How can I create and manage Templates?**</span>
> 
> <span style="color: #111111">See</span><span style="color: #111111"> </span>[here](https://docs.getxporter.app/space/XPORTER/1409467)<span style="color: #111111">.</span>
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**How can I create and edit Permission Schemes?**</span>
> 
> <span style="color: #111111">See</span><span style="color: #111111"> </span>[here](https://docs.getxporter.app/space/XPORTER/1409475)<span style="color: #111111">.</span>
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**How can I create and edit File Servers?**</span>
> 
> <span style="color: #111111">See</span><span style="color: #111111"> </span>[here](https://docs.getxporter.app/space/XPORTER/1409479)<span style="color: #111111">.</span>
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**Which Xporter Integrations are available and how can I access them?**</span>
> 
> <span style="color: #111111">See</span><span style="color: #111111"> </span>[here](https://docs.getxporter.app/space/XPORTER/1409040)<span style="color: #111111">.</span>
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**How can I get **</span><span style="color: #0d0d0d">**access to the Xporter reports exportation history?**</span>
> 
> <span style="color: #0d0d0d">See</span><span style="color: #0d0d0d"> </span>[here](https://docs.getxporter.app/space/XPORTER/1415793)<span style="color: #0d0d0d">.</span>
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**Can I transition from**</span><span style="color: #111111">** Jira Server to Jira Cloud?**</span>
> 
> <span style="color: #111111">Yes. See</span><span style="color: #111111"> </span>[<span style="color: #111111">here</span>](https://docs.getxporter.app/space/XPORTER/1409313/Server+to+Cloud+Migration)<span style="color: #111111"> </span><span style="color: #111111">how.</span>
> 
> > Macro (rw-step)
> 
> **Can I define multiple actions that will be performed during transitions in **[**Jira workflows**](https://www.atlassian.com/software/jira/guides/workflows/overview#what-is-a-jira-workflow)**?**
> 
> Yes. See [here](https://docs.getxporter.app/space/XPORTER/1412596) how.

# Xporter Project Administration

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**How can I create and manage Templates?**</span>
> 
> <span style="color: #111111">See</span><span style="color: #111111"> </span>[<span style="color: #111111">here</span>](https://docs.getxporter.app/space/XPORTER/1409260)<span style="color: #111111">.</span>
> 
> > Macro (rw-step)
> 
> <span style="color: #111111">**How can I create and edit Permission Schemes?**</span>
> 
> <span style="color: #111111">See</span><span style="color: #111111"> </span>[<span style="color: #111111">here</span>](https://docs.getxporter.app/space/XPORTER/1409264)<span style="color: #111111">.</span>
> 
> > Macro (rw-step)
> 
> <span style="color: #172B4D">**How can I create and manage Scheduled Reports?**</span>
> 
> <span style="color: #172B4D">See</span><span style="color: #172B4D"> </span>[<span style="color: #172B4D">here</span>](https://docs.getxporter.app/space/XPORTER/1409268)<span style="color: #172B4D">.</span>

# Licenses

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> **How do I install a license provided by Xblend?**
> 
> Once you have a license provided by Xblend, perform the following steps:
> 
> 1. Go to the *Manage Xporter for Jira* section and click *License Management*.
> 2. Click the *Click here to install a license directly from Xblend *button.
> 3. Put your license in the text box (this should be a license provided by Xblend and not obtained via the Atlassian Marketplace).
> 4. Click *Add*.
> 5. After executing the previous steps, your license must be installed.
> 
> > Macro (rw-step)
> 
> **How can I replace my marketplace license with a license provided by Xblend?**
> 
> 1. On your Jira Administration panel, select the *Manage Add-ons* option.
> 2. Click the *Xporter Plugin for Jira* option. Details about the plugin will be shown.
> 3. Edit the license key, remove all the text, and click *Update*. Your marketplace license has been removed.
> 4. Go to the *Manage Xporter for Jira* section and click *License Management*.
> 5. Click the *Click here to install a license directly from Xporter* button.
> 6. Put your license in the text box (this should be a license provided by Xporter and not obtained via the Atlassian Marketplace).
> 7. Click *Add*.
> 8. After executing the previous steps, your license should be installed.

# Technical Details

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> **How can I externally use the Xporter for Jira as an API to generate documents from Issues?**
> 
> You can directly call the Xporter for Jira [servlet](https://developer.atlassian.com/server/jira/platform/servlet/), which generates the documents. An example of such a request is:
> 
> [http://jirahost:8080/plugins/servlet/jiraxporter?issueKey=ELECTRIC-3&outputType=pdf&template=Sample](http://jirahost:8080/plugins/servlet/jiraxporter?issueKey=ELECTRIC-3&outputType=pdf&template=Sample.docx)
> 
> You might need to specify the Template context.
> 
> [http://jirahost:8080/plugins/servlet/jiraxporter?issueKey=ELECTRIC-3&outputType=pdf&template=Sample&context=admin](http://jirahost:8080/plugins/servlet/jiraxporter?issueKey=ELECTRIC-3&outputType=pdf&template=Sample&context=admin)
> 
> Just replace *issueKey* and template parameter values with the ones that you need.
> 
> In *issueKey*, you can set several Issues separated with **;**. Example:
> 
> [http://jirahost:8080/plugins/servlet/jiraxporter?issueKey=ELECTRIC-1;ELECTRIC-2;ELECTRIC-3&outputType=pdf&template=Sample](http://jirahost:8080/plugins/servlet/jiraxporter?issueKey=ELECTRIC-1;ELECTRIC-2;ELECTRIC-3&outputType=pdf&template=Sample)
> 
> You can also provide a JQL statement as an input parameter, instead of providing a list of issues. Example:
> 
> [http://jirahost:8080/plugins/servlet/jiraxporter?outputType=rtf&template=AgileCard&jql=project%20%3D%20DEMO%20AND%20issuetype%20in%20(Bug%2C%20Story)%20ORDER%20BY%20summary%20ASC](http://jirahost:8080/plugins/servlet/jiraxporter?outputType=rtf&template=AgileCard&jql=project%20%3D%20DEMO%20AND%20issuetype%20in%20(Bug%2C%20Story)%20ORDER%20BY%20summary%20ASC)
> 
> It is also possible to specify the break type, use *breakissues=on* and *breaktype=(break option)*. Example:
> 
> [http://jirahost:8080/plugins/servlet/jiraxporter?outputType=pdf&template=Sample&breakissues=on&breaktype=issues&jql=project%20%3D%20DEMO%20AND%20issuetype%20in%20(Bug%2C%20Story)](http://jirahost:8080/plugins/servlet/jiraxporter?outputType=pdf&template=Sample&breakissues=on&breaktype=issues&jql=project%20%3D%20DEMO%20AND%20issuetype%20in%20(Bug%2C%20Story)) 
> 
> Also, please certify that you are performing this request on behalf of a user who has the correct permissions to use the plugin. If you need to authenticate with a specific username and password, just add the parameters *os_username* and *os_password* to the request. Example:
> 
> [http://jirahost:8080/plugins/servlet/jiraxporter?issueKey=ELECTRIC-3&outputType=pdf&template=Sample&os_username=joe&os_password=secret](http://jirahost:8080/plugins/servlet/jiraxporter?issueKey=ELECTRIC-3&outputType=pdf&template=Sample&os_username=joe&os_password=secret)
> 
> > Macro (rw-step)
> 
> **I can't open in Microsoft Word the Templates that I downloaded from the plugin administration. What is the problem?**
> 
> There is a known incompatibility between the Xporter and the [Field Security Plugin for Jira](https://marketplace.atlassian.com/plugins/com.quisapps.jira.jfs). For some reason, unknown to the Xporter Team, the [Field Security Plugin for Jira](https://marketplace.atlassian.com/plugins/com.quisapps.jira.jfs) is corrupting the files that are downloaded in the Administration.
> 
> If you have this problem, and you want to download your Templates, just temporarily disable the [Field Security Plugin for Jira](https://marketplace.atlassian.com/plugins/com.quisapps.jira.jfs), download your Templates, and re-enable the [Field Security Plugin for Jira](https://marketplace.atlassian.com/plugins/com.quisapps.jira.jfs).
> 
> > Macro (rw-step)
> 
> **How can I convert time fields to days or hours?**
> 
> Time fields (*OriginalEstimate*, *RemainingEstimate*, and *TimeSpent*)  are stored internally by Jira in seconds. If you need to convert those fields into units of days or hours, you can make use of JavaScript.
> 
> Example to convert from seconds to hours:
> 
> ```
> %{${RemainingEstimate}/(60*60)} 
> ```
> 
> Example to convert from seconds to days (replace 8 with the number of working hours per day as defined in your Jira Configuration):
> 
> ```
> %{${RemainingEstimate}/(8*60*60)} 
> ```
> 
> > Macro (rw-step)
> 
> **How can I iterate more than one level of links for a Jira Issue?**
> 
> Xporter only allows to directly iterate one level of Links for an Issue. If you want to iterate the linked issues of the linked Issues, you must do it as provided in the example below:
> 
> ```
> Issue ${Key} has ${LinksCount} links. Below is the list.
> #{for j=LinksCount}
>    Linked Issues of ${Links[j].Key}:
> #{for m=JQLIssuesCount|clause=issuekey in linkedIssues (${Links[j].Key})}
>       Linked Issue ${JQLIssues[m].Key}
> #{end}
> #{end}
> 
> ```
> 
> > Macro (rw-step)
> 
> **How can I roll back to a previous version of the plugin?**
> 
> 1. Uninstall your current version of the plugin: Navigate to your Jira administration, go to the *Manage Add-ons* section, select *Xporter for Jira Plugin* and click *Uninstall*.
> 2. Download the version that you want from the [marketplace](https://marketplace.atlassian.com/apps/891368/xporter-export-issues-from-jira?tab=overview&hosting=cloud) (click over the version and choose *download this version*).
> 3. After executing the previous step, also in the *Manage Add-ons* screen, select *Upload add-on and *browse to the file downloaded in the previous step.
> 4. The plugin should now be installed with the previous version.
> 
> > Macro (rw-step)
> 
> **How can I enable debug logging?**
> 
> 1. Go to the Jira Administration, and enter the *System* section.
> 2. Selection the *Logging & Profiling* option.
> 3. In the section *Default Loggers*, click *Configure logging level for another package*.
> 4. Set the package name to **com.xpandit.jiraxporter** and the Logging Level to **DEBUG** and click *Add*.
> 
> Once you performed the previous steps, you must reproduce your problem and retrieve the **atlassian-jira.log** file. To find the location of this file, go to your Jira Administration, click *System* > *System Info*. In the *File Paths* section, you have a location in the field **Location of atlassian-jira.log**
> 
> > Macro (rw-step)
> 
> **Is there any task that should be done when Jira is Upgraded?**
> 
> If the Jira home folder is changed, you have to make sure that the folder named "ExporterTemplates" exists there. This folder contains all the templates created on Xporter, if the folder does not exist, Xporter won't be able to generate reports.
> 
> > Macro (rw-step)
> 
> **How can I manually install a version of the plugin?**
> 
> Whenever you need to install manually, by file upload, a new or old version of the plugin, download the plugin OBR file and perform [these steps](https://confluence.atlassian.com/display/UPM/Installing+Add-ons#InstallingAdd-ons-Installingbyfileupload).
> 
> > Macro (rw-step)
> 
> **How can I export a number custom field with thousands of separators?**
> 
> You can export a number custom field with thousands separator using JavaScript. Example: %{'${NumberCustomField}'.replace(/\B(?=(\d{3})+(?!\d))/g, ".")}
> 
> > Macro (rw-step)
> 
> **How can I retrieve Issues from the parent Issue?**
> 
> If you want to get fields from the parent issue of a subtask, you will need to use [JQL iteration](https://docs.getxporter.app/space/XPORTER/1413910). The iteration will only be made for a single issue. Example:
> 
> ```
> #{for i=JQLIssuesCount|clause=key = ${ParentIssueKey}}
>   Parent Key - ${JQLIssues[i].Key}
>   Parent Summary - ${JQLIssues[i].Summary}
>   Parent CustomField - ${JQLIssues[i].MyCustomField}
> #{end}
> ```
> 
> > Macro (rw-step)
> 
> How can I find my Support Entitlement Number (SEN) ?
> 
> Before you begin: to see the SEN in the Universal Plugin Manager, you must log in with Jira Admin permissions.
> 
> 1. On your Jira instance, click the gear icon/Settings button.
> 2. Go to the *Manage Apps* screen.
> 3. A *User-installed apps* list will appear. Click *Xporter for Jira*.
> 4. There, you will see the SEN.
> 
> > Macro (rw-step)
> 
> **How should I proceed if Xporter is disabled when installing on Jira 8.16.0?**
> 
> This happens because the [Jira Cloud Migration Assistant app](https://marketplace.atlassian.com/apps/1222010/jira-cloud-migration-assistant) needs to be updated.
> 
> 1. On your Jira instance, click the gear icon/Settings button.
> 2. Go to the *Manage Apps* screen.
> 3. To update the app, select *All apps* and then search for **Jira Cloud Migration Assistant.**
> 4. Click *update request* and wait for the request to be accepted.
> 5. While the request is not accepted, you can disable the Jira Cloud Migration Assistant app and activate Xporter. Xporter is compatible with Jira Cloud Migration Assistant 1.5.1.
> 
> > Macro (rw-step)
> 
> **What should I do whenever I move my Jira platform (not to Cloud) and use Jira backup?**
> 
> Whenever you install Jira again because you migrated to the Data Center or changed the infrastructure where Jira is running, and to put the data in Jira, we use [Jira Backup](https://support.atlassian.com/jira-cloud-administration/docs/export-issues/). It allows to take all data from Xporter, and we recommend that before deleting the Jira home from your old environment you copy the **ExporterTemplates** folder and place it in the same place in the new infrastructure. You can also use Xporter's Export and Import functionality to back up your Xporter data and then import it into your new Jira.
> 
> > Macro (rw-step)
> 
> **How should I proceed if JavaScript is not being correctly evaluated?**
> 
> If your [JavaScript](https://docs.getxporter.app/space/XPORTER/1413883) placeholders are not being correctly processed, try to look at your Jira log files, they should display the reason for the error.
> 
> There are some common causes for these kinds of problems:
> 
> - You have line breaks in the middle of the JavaScript code.
> - You have not used the correct quote character for JavaScript Strings. Please ensure that you always use the single quote character and not other similar characters. Sometimes Microsoft Word replaces the single quote with curly quotes.
> 
> > ℹ️ If you are using JavaScript with fields that contain special characters (line breaks, quotes, etc.) you will need to use the [escape function](https://docs.getxporter.app/space/XPORTER/1413867/Formatting+Fields#Escaping-Fields) along with that field mapping.
> 
> > Macro (rw-step)
> 
> **How should I proceed if s****ome Unicode characters are not appearing in the export result?**
> 
> Most likely the fonts that you are using are not installed in the Jira server machine which is running under Linux.
> 
> Most of the DOC and DOCX documents that you will convent were probably created by people using Microsoft Word on Windows or Mac OS operating systems. Those people used fonts that were available to them to format the documents. Therefore, most fonts that are used by DOC and DOCX documents will be "Windows fonts" or "Office fonts" e.g.: the fonts that are installed with Microsoft Windows or with Microsoft Office. These fonts include Arial, Calibri, Cambria, Century Gothic, Courier New, Garamond, Tahoma, Verdana, Wingdings, and many others.
> 
> There are a number of Linux packages that contain Microsoft TrueType fonts that you can download and install onto your Linux machine. The exact steps might be different on different Linux distributions.
> 
> On Ubuntu, go to the Synaptic Package Manager. Find and install the *ttf-mscorefonts-installer* package. 
> 
> On openSUSE, go to Yast2, Software Management. Find and install the *fetchmsttfonts* package. 
> 
> Use Liberation Fonts which are licensed under OFL and are an alternative to standard Windows fonts: Arial, Times New Roman, and Courier New. 
> 
> For font packages for other Linux distributions, please search the documentation and the internet.
> 
> After installing the fonts, you may need to restart Jira.
> 
> > Macro (rw-step)
> 
> **What should I do if images referenced in wiki markup or HTML are not correctly rendered in the document?**
> 
> This problem usually happens when your Jira instance is running in HTTPS and Jira's Java Runtime is not able to download the images due to problems with the SSL Certificate. To resolve this problem, please try the solution available [here](https://confluence.atlassian.com/jira/connecting-to-ssl-services-117455.html).
> 
> > Macro (rw-step)
> 
> **When making a bulk export, the resulting document has incorrect content. Now what?**
> 
> There is a known limitation that can be causing this problem. To be correctly used in bulk export, the Templates cannot have more than one section. We are working on a solution for this problem. Contact us [here](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28).
> 
> > Macro (rw-step)
> 
> **How can I add comments to my template (AKA code comments)?**
> 
> There is no Xporter mapping representing comments, but you can use [Word Comments](https://support.microsoft.com/en-us/office/insert-delete-or-change-a-comment-5cb1af25-4dfe-4484-9713-2c80391ecf12) to work around this. This way you can have a self-explaining template.


<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>