Mappings

Using Mappings

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

${<Field>}

The available keywords are listed in the following table:

Field	Content
ActivityEntriesCountDEPRECATED	Returns the number of activity entries in the issue.
AffectedVersions	The project versions affected by the issue (a list with 1 version per line).
AffectedVersionsCount	Returns the number of affected version in the issue.
AffectedVersionsList	The project versions affected by the issue (separated by commas).
AggregateOriginalEstimate	The sum of originally estimated time for issue completion, in seconds.
AggregateOriginalEstimateFormatted	The sum of originally estimated time for issue completion formatted as defined in the Jira Time Tracking options.
AggregateRemainingEstimate	The sum of remaining estimated time for issue completion, in seconds.
AggregateRemainingEstimateFormatted	The sum of remaining estimated time for issue completion formatted as defined in the Jira Time Tracking options.
AggregateTimeSpent	The sum of time spent working on the issue, in seconds.
AggregateTimeSpentFormatted	The sum of time spent working on the issue formatted as defined in the Jira Time Tracking options.
Assignee	The issue assignee display name.
AssigneeGroups	The groups to which the issue assignee belongs.
AssigneeId	The issue assignee ID.
AssigneeUserDisplayName	The issue assignee display name.
AssigneeUserEmailAddress	The issue assignee email address.
AssigneeUserNameDEPRECATED	The issue assignee nickname.
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.
AttachmentsResources	A JSON containing all the information regarding issue attachments.
BaseURL	The Jira Cloud instance url.
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 to which 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}. If you want to print the date and time, you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):Created}
CreatedDate	The issue creation date time in ISO Format. If you want to print only the date, you should use ${dateformat("yyyy-MM-dd"):CreatedDate}. If you want to print the date and time, you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):CreatedDate}
CreatedDateTime	The issue creation date time in ISO Format. If you want to print only the date, you should use ${dateformat("yyyy-MM-dd"):CreatedDateTime}. If you want to print the date and time, you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):CreatedDateTime}
Creator	The issue creator ID.
Current Date	The current date time in ISO Format. If you want to print only the date, you should use ${dateformat("yyyy-MM-dd"):Current Date}. If you want to print the date and time, you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):Current Date}
Current Date Time	The current date time in ISO Format. If you want to print only the date, you should use ${dateformat("yyyy-MM-dd"):Current Date Time}. If you want to print the date and time, you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):Current Date Time}
CurrentDate	The current date time in ISO Format. If you want to print only the date, you should use ${dateformat("yyyy-MM-dd"):CurrentDate}. If you want to print the date and time, you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):CurrentDate}
CurrentDateTime	The current date time in ISO Format. If you want to print only the date, you should use ${dateformat("yyyy-MM-dd"):CurrentDateTime}. If you want to print the date and time, you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):CurrentDateTime}
Description	The issue description. WIKI
DocumentId	Unique ID generated identifying the document.
Due Date	The issue due date.
DueDate	The issue due date.
DueDateTime	The issue due date.
Environment	The issue environment. WIKI
FilterJQL	Current JQL used to search Issues.
FilterName	Current Filter Name used to search Issues.
FixVersions	The versions an issue fixes.
FixVersionsCount	Returns the number of fix versions in the issue.
FixVersionsList	The versions an issue fixes, separated by commas.
FixVersionsReleaseDate	The release date of the versions an issue fixes.
FixVersionsReleaseDateList	The release dates of the versions being fixed by an issue, separated by commas.
HistoryEntriesCount	Returns the number of history entries of the issue.
Id	The issue ID. For example, 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.
Issue Type	The issue type name.
Issue Type.Id	The issue type id.
Issue Type.Name	The issue type name.
Issue Type.Description	The issue type description.
Issue Type.Type	The type of the issue type (Standard or Sub-Task).
Issue Type.IconURL	The icon url of the issue type.
IssueType	The issue type name.
IssueTypeDescription	The issue type description.
IssueTypeName	The issue type name.
IssuesCount	The number of exported issues.
Key	The internal issue Key. For example, PROJECT-1.
Labels	The issue labels.
LabelsCount	Returns the number of labels in the issue.
LinksCount	Returns the number of links to 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.
ParentIssueDescriptionDEPRECATED	The parent issue description.
ParentIssueId	The parent issue ID.
ParentIssueKey	The parent issue key.
ParentIssueSummary	The parent issue summary.
Priority	The issue priority.
PriorityDescription	The issue priority description.
Project	The issue project name related with the issue.
ProjectComponents	The issue project components.
ProjectId	The issue project id.
ProjectID	The issue project id.
ProjectKey	The issue project key.
ProjectLead	The issue project lead account id.
ProjectName	The issue project name.
ProjectURL	The issue project url.
ProjectCategory	The issue project category.
Project.Components	The issue project components an issue belongs.
Project.Id	The issue project Id.
Project.ID	The issue project id.
Project.Key	The issue project key.
Project.Lead	The issue project leader.
Project.Name	The issue project name.
Project.URL	The issue project URL.
Project.Category	The issue project category.
Project.Description	The issue project description.
ProjectVersionsCount	Returns the number of project versions.
RemainingEstimate	The remaining estimated time for issue completion, in seconds.
RemainingEstimateFormatted	The remaining estimated time for issue completion formatted as defined in the Jira Time Tracking options.
Reporter	The issue reporter display name.
ReporterId	The issue reporter Id.
ReporterID	The issue reporter Id.
ReporterGroups	The groups to which the issue reporter belongs.
ReporterUserDisplayName	The issue reporter Jira display name.
ReporterUserEmailAddress	The issue reporter Jira email address.
ReporterUserName DEPRECATED	The issue reporter Jira username.
Resolution	The issue resolution.
ResolutionDescription	The issue resolution description.
Resolved	The issue resolution date in ISO format. If you want to print only the date, you should use ${dateformat("yyyy-MM-dd"):Resolved} .If you want to print the date and time, you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):Resolved}.
SecurityLevel	The issue security level.
SecurityLevelDescription	The issue security level description.
SecurityLevelId	The issue security level ID.
SprintsCount	Returns the number of sprints.
Sprint	The sprints in which the issue is present (separated by comma).
Status	The issue status.
StatusDescription	The issue status description.
StatusTransitionsCount	Returns the number of status transitions of the Issue.
SubTasks	List of issue subtasks.
SubtasksCount	Returns the number of subtasks of the Issue.
Summary	The issue summary.
Time Spent	The time spent working on the issue.
TimeSpent	The time spent working on the issue.
TimeSpentFormatted	The time spent working on the issue formatted as Jira.
Updated	The issue update timestamp. If you want to print only the date, you should use ${dateformat("yyyy-MM-dd"):Updated}. If you want to print the date and time, you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):Updated}.
UpdatedDate	The issue update timestamp. If you want to print only the date, you should use ${dateformat("yyyy-MM-dd"):UpdatedDate}. If you want to print the date and time, you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):UpdatedDate}.
UpdatedDateTime	The issue update timestamp. If you want to print only the date, you should use ${dateformat("yyyy-MM-dd"):UpdatedDateTime}. If you want to print the date and time, you should use ${dateformat("dd-MM-yyyy HH:mm:ss"):UpdatedDateTime}.
URL	Returns the URL of the Issue detail screen.
UserAccountId	The user account id who is exporting.
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.
UserRole	The user roles who is exporting.
Votes	The number of times an issue was voted.
Watchers	Returns a list of Users that are watching the Issue. Functions: fullname and emailaddress can be used with this field.
Watches	The number of watches of the issue.
WorklogsCount	Returns the number of worklogs in the issue.

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. For example, if a custom field named "Reason" is translated in Jira to French as "Raison", you can refer to the field in the template with ${Reason} or ${Raison}.

You can also use wiki if the custom field is a rendered field.

Jira Agile Epic Link

The Xporter allows rendering all the fields from the Epic Link for an issue. This Epic Link feature is available with the Jira Agile App.

${Epic Link.Field}

Expand to see the examples on sample code

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

Parent

${Parent.Field}