Mappings

Using Mappings

To use a mapping, just open your template document and type the mapping using the following notation:

${<Field>}

The keywords available are in listed in the following table:

Please check the Deprecated Mappings page to ensure you are using the most recent mappings.

Field	Content
AffectedVersions	The project versions the issue affects (a list with 1 version per line).
AffectedVersionsList	The project versions the issue affects, separated with commas.
AssigneeId	The issue assignee id.
AssigneeUserDisplayName	The issue assignee JIRA display name.
AssigneeUserEmailAddress	The issue assignee JIRA e-mail address.
AssigneeUserName	The issue assignee JIRA user name.
AssigneeGroups	The groups which the issue assignee belongs to.
Attachments	The attachments of the current issue (a list with 1 attachment per line). Note: You can iterate over Attachments and get some metadata from them.
AttachmentsCount	Returns the number of attachments in the Issue.
BelongsToEpic	Returns "true" if the current issue belongs to an Epic Issue, otherwise it returns "false".
BulkIssueIndex	The index/position of the current issue being mapped. Usable only in bulk export. 0 is the index for the first issue.
BulkIssuesCount	The number of issues selected in a bulk export. Usable only in bulk export.
CommentsCount	Returns the number of comments in the Issue.
Components	The components an issue belongs.
ComponentsCount	Returns the number of components in the Issue.
Created	The issue creation date time in ISO Format. If you want to print only the date you should use ${dateformat("yyyy-MM-dd"):Created} but if you want to print the date and time you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):Created}
Description	The issue description.
DocumentId	Unique ID generated identifying the document.
Due Date	The issue due date.
Environment	The issue environment.
EstimatedTime	The estimated time for issue completion. Do not use this field as it will become soon deprecated . Use RemainingEstimate .
FilterJQL	Current JQL used to search Issues.
FilterName	Current Filter Name used to search Issues.
FixVersions	The versions an issue fixes.
FixVersionsReleaseDate	The release date of the versions an issue fixes.
FixVersionsList	The versions an issue fixes, separated by commas.
FixVersionsReleaseDateList	The release dates of the versions an issue fixes, separated by commas.
Id	The issue ID. Ex: 1
Images	When used as a single field "${Images}", it renders the images List of images attached to the issue. Images are rendered in an order respecting the creation date. For this field, you are allowed to define extra attributes with the max image width, max image height and the sort order of the images. Examples: ${Images\|maxwidth=100\|maxheight=100} ${Images\|maxwidth=100\|maxheight=100\|sortby=name} ${Images\|maxwidth=100\|maxheight=100\|sortby=date} Note: You can iterate over images and get some metadata from them.
ImagesCount	Returns the number of images attached to the Issue.
IssueTypeDescription	The issue type description.
IssueTypeDescriptionTranslated	The translated issue type description.
IssueTypeName	The issue type.
IssueTypeNameTranslated	The translated issue type.
JQLIssuesCount	The number of the issues returned by the parent JQL Iteration.
Key	The internal issue Key. Ex: PROJECT-1.
Labels	The issue labels.
LinksCount	Returns the number of links of the Issue.
OriginalEstimate	The originally estimated time for issue completion, in seconds.
OriginalEstimateFormatted	The originally estimated time for issue completion formatted as defined in the JIRA Time Tracking options.
ParentIssueDescription	The parent issue description.
ParentIssueId	The parent issue ID.
ParentIssueKey	The parent issue key.
Priority	The issue priority.
PriorityTranslated	The issue priority translated to the language of the logged user.
PriorityDescription	The issue priority description.
PriorityDescriptionTranslated	The issue priority description translated to the language of the logged user.
ProjectComponents	The project components an issue belongs.
ProjectId	The issue project.
ProjectKey	The issue project key.
ProjectName	The issue project name.
ProjectURL	The issue project URL.
ProjectLead	The issue project leader.
RemainingEstimate	The originally estimated time for issue completion formatted as defined in the JIRA Time Tracking options.
RemainingEstimateFormatted	The remaining estimated time for issue completion formatted as defined in the JIRA Time Tracking options.
ReporterId	The issue reporter ID.
ReporterUserDisplayName	The issue assignee JIRA display name.
ReporterUserEmailAddress	The issue assignee JIRA e-mail address.
ReporterUserName	The issue reporter JIRA user name.
ReporterGroups	The groups which the issue reporter belongs to.
Resolution	The issue resolution.
ResolutionTranslated	The issue resolution translated to the language of the logged user.
Resolved	The issue resolution date in ISO format. If you want to print only the date you should use ${dateformat("yyyy-MM-dd"):Resolved} but if you want to print the date and time you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):Resolved}
ResolutionDescription	The issue resolution description.
ResolutionDescriptionTranslated	The issue resolution description translated to the language of the logged user.
ResolutionDesc
SecurityLevel	The issue security level.
SecurityLevelId	The issue security level ID.
Status	The issue status.
StatusTranslated	The issue status translated to the language of the logged user.
StatusTransitionsCount	Returns the number of status transitions of the Issue.
StatusDescription	The issue status description.
StatusDescriptionTranslated	The issue status description translated to the language of the logged user.
Sprint	The Issue Sprint Name.
SubTasks	List of issue subtasks.
SubtasksCount	Returns the number of subtasks of the Issue.
Summary	The issue summary.
TestsCount	Returns the number of Tests in an issue of type Test Set.
TestStepsCount	Returns the number of Test Steps in an issue of type Test.
Time Spent	The time spent working on the issue.
Updated	The issue update timestamp. If you want to print only the date you should use ${dateformat("yyyy-MM-dd"):Updated} but if you want to print the date and time you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):Updated}
UserDisplayName	Display name of the user that is requesting the export.
UserEmailAddress	Email address of the user that is requesting the export.
Username	Username of the user that is requesting the export.
URL	Returns the Url for the Issue detail screen.
Votes	The number of times an issue was voted.
Watches	The number of watches of the issue.
Watchers	Returns a list of Users that are watching the Issue. Functions: fullname and emailaddress can be used with this field.
Commits	The number of commits for this issue.
Branches	The number of branches for this issue.
PullRequests	The number of pull requests for this issue.
Builds	The number of builds for this issue.
Reviews	The number of reviews for this issue.
Parent	Return fields from Parent issues.

Custom Field Mappings

The Xporter for JIRA plugin supports custom fields. To use your own defined custom fields, just use the same notation:

${<Custom field name>}

The <Custom field name> must match exactly the name on which you created the custom field. Example:

${My Special One And Only Custom Field}

If you have Custom Fields with the same name, it is possible to explicitly indicate the custom field that you want to export using its internal JIRA identifier. You can find the identifier of a custom field, by going to the JIRA administration, section fields, and edit the custom field. The id will appear in the URL (ex: http://jiraserver/secure/admin/EditCustomField!default. jspa ?id=10070 ). The notation to be used is:

${<Custom field name>[<Custom field id>]}

Expand to see the example on sample code

${My Custom Field[10070]}

The officially supported custom fields are:

Number Field
Text Field (read only)
Text Field (multi-line)
Group Picker (single group)
Group Picker (multiple groups)
User Picker (single user)
User Picker (multiple users)
Date Picker
Date Time Picker
Select List (single choice)
Select List (multiple choices)
URL Field

The plugin may work with other custom fields (even provided by other plugins). This depends on the way other custom field types implement the rendering of the field values.

Custom Fields can also be referenced using their translated name. Example: If a custom field named "Reason" is translated in JIRA to french in "Raison", you can refer to the field in the template with ${Reason} or ${Raison}.

JIRA Agile Epic Link

The Xporter for JIRA allows rendering all the fields from the Epic Link for an issue. This Epic Link feature is available with the JIRA Agile Add-on.

${Epic Link.Field}

Expand to see the examples on sample code

${Epic Link.Key}
${Epic Link.Summary}
${Epic Link.LinkType}

Page tree

Mappings

Using Mappings

Custom Field Mappings

JIRA Agile Epic Link