FAQ

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

Converting from seconds into 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:

Converting from seconds into days

%{${RemainingEstimate}/(8*60*60)}

Iterating more than one level of links

Xporter for Jira 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 should 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}

How to 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, ".")}

When used in bulk export, my template provides incorrect results. Why?

Most likely you are hitting a known limitation of the app. Check this FAQ and this issue.

How to retrieve issues from the parent issue

If you want to get fields from the parent issue of a subtask, we will need to use JQL Iteration. The iteration will only be made for a single issue. Example below:

#{for i=JQLIssuesCount|clause=key = ${ParentIssueKey}}
  Parent Key - ${JQLIssues[i].Key}
  Parent Summary - ${JQLIssues[i].Summary}
  Parent CustomField - ${JQLIssues[i].MyCustomField}
#{end}

Finding your Support Entitlement Number

Before you begin: To see the SEN in the Universal Plugin Manager, you must log in with Jira Admin permissions.

Go to the Manage Apps Administration Screen
Click over Xporter for Jira
On the App details get the SEN in the section highlighted bellow.

Common Troubleshooting

Javascript not being correctly evaluated

If your javascript placeholders are not being correctly processed, try to look to your Jira log files, they should display the reason for the error. There are some common causes for this kind 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 assure yourself 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 along with that field mapping

When making a bulk export, the resulting document has incorrect content

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, take a look at this issue.

Application Accesses for Xporter for Jira Cloud

In order to work properly, Xporter for Jira Cloud requires the following Application Accesses ( when they're available): Jira Core and Jira Software. Any other Application Accesses are optional. When Xporter for Jira Cloud does not have the required application accesses and a user tries to make an exportation, an error message will be thrown and no document will be generated. We are working on a friendly solution for this problem, take a look at this issue.

An example of an Application Accesses configuration for Xporter for Jira Cloud is shown bellow:

How can I add comments to my template (aka code comments)?

There is no Xporter Mapping representing comments, but you can use Word Comments to workaround this.

This way you can have a self-explaining template.

Page tree

FAQ