Page tree

You are on the Xporter Cloud documentation. If you are looking for Xporter Server documentation, you can find it in this page.

Skip to end of metadata
Go to start of metadata

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.
AffectedVersionsThe project versions affected by the issue (a list with 1 version per line).
AffectedVersionsCountReturns the number of affected version in the issue.
AffectedVersionsListThe project versions affected by the issue (separated by commas).
AggregateOriginalEstimateThe sum of originally estimated time for issue completion, in seconds.
AggregateOriginalEstimateFormattedThe sum of originally estimated time for issue completion formatted as defined in the Jira Time Tracking options.
AggregateRemainingEstimateThe sum of remaining estimated time for issue completion, in seconds.
AggregateRemainingEstimateFormattedThe sum of remaining estimated time for issue completion formatted as defined in the Jira Time Tracking options.
AggregateTimeSpentThe sum of time spent working on the issue, in seconds.
AggregateTimeSpentFormattedThe sum of time spent working on the issue formatted as defined in the Jira Time Tracking options.
AssigneeThe issue assignee display name.
AssigneeGroupsThe groups to which the issue assignee belongs.
AssigneeIdThe issue assignee ID.
AssigneeUserDisplayNameThe issue assignee display name.
AssigneeUserEmailAddressThe 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.

AttachmentsCountReturns the number of attachments in the Issue.
AttachmentsResourcesA JSON containing all the information regarding issue attachments.
BaseURLThe Jira Cloud instance url.
BelongsToEpicReturns "true" if the current issue belongs to an Epic Issue; otherwise, it returns "false".
BulkIssueIndexThe index/position of the current issue being mapped. Usable only in bulk export. 0 is the index for the first issue.
BulkIssuesCountThe number of issues selected in a bulk export. Usable only in bulk export.
CommentsCountReturns the number of comments in the Issue.
ComponentsThe components to which an issue belongs.
ComponentsCountReturns the number of components in the Issue.
CreatedThe 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} 
CreatedDateThe 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} 
CreatedDateTimeThe 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} 
CreatorThe issue creator ID.
Current DateThe 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 TimeThe 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} 
CurrentDateThe 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} 
CurrentDateTimeThe 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

DocumentIdUnique ID generated identifying the document.
Due DateThe issue due date.
DueDateThe issue due date.
DueDateTimeThe issue due date.
Environment

The issue environment. WIKI

FilterJQLCurrent JQL used to search Issues.
FilterNameCurrent Filter Name used to search Issues.
FixVersionsThe versions an issue fixes.
FixVersionsCountReturns the number of fix versions in the issue.
FixVersionsListThe versions an issue fixes, separated by commas.
FixVersionsReleaseDateThe release date of the versions an issue fixes.
FixVersionsReleaseDateListThe release dates of the versions being fixed by an issue, separated by commas.
HistoryEntriesCountReturns the number of history entries of the issue.
IdThe 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.

ImagesCountReturns the number of images attached to the Issue.
Issue TypeThe issue type name.

Issue Type.Id

The issue type id.

Issue Type.Name

The issue type name.
Issue Type.DescriptionThe 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.
IssueTypeThe issue type name.
IssueTypeDescriptionThe issue type description.
IssueTypeNameThe issue type name.
IssuesCountThe number of exported issues.
KeyThe internal issue Key. For example, PROJECT-1.
LabelsThe issue labels.
LabelsCountReturns the number of labels in the issue.
LinksCountReturns the number of links to the Issue.
OriginalEstimateThe originally estimated time for issue completion, in seconds.
OriginalEstimateFormattedThe originally estimated time for issue completion formatted as defined in the Jira Time Tracking options.

ParentIssueDescriptionDEPRECATED

The parent issue description.
ParentIssueIdThe parent issue ID.
ParentIssueKeyThe parent issue key.
ParentIssueSummaryThe parent issue summary.
PriorityThe issue priority.
PriorityDescriptionThe issue priority description.
ProjectThe issue project name related with the issue.
ProjectComponentsThe issue project components.
ProjectIdThe issue project id.
ProjectIDThe issue project id.
ProjectKeyThe issue project key.
ProjectLeadThe issue project lead account id.
ProjectNameThe issue project name.
ProjectURLThe issue project url.
ProjectCategoryThe issue project category.
Project.ComponentsThe issue project components an issue belongs.
Project.IdThe issue project Id.
Project.IDThe issue project id.
Project.KeyThe issue project key.
Project.LeadThe issue project leader.
Project.NameThe issue project name.
Project.URLThe issue project URL.
Project.CategoryThe issue project category.
Project.DescriptionThe issue project description.
ProjectVersionsCountReturns the number of project versions.
RemainingEstimateThe remaining estimated time for issue completion, in seconds.
RemainingEstimateFormattedThe remaining estimated time for issue completion formatted as defined in the Jira Time Tracking options.
ReporterThe issue reporter display name.
ReporterIdThe issue reporter Id.
ReporterIDThe issue reporter Id.
ReporterGroupsThe groups to which the issue reporter belongs.
ReporterUserDisplayNameThe issue reporter Jira display name.
ReporterUserEmailAddressThe issue reporter Jira email address.

ReporterUserName DEPRECATED

The issue reporter Jira username.

ResolutionThe issue resolution.
ResolutionDescriptionThe issue resolution description.
ResolvedThe 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}. 
SecurityLevelThe issue security level.
SecurityLevelDescriptionThe issue security level description.
SecurityLevelIdThe issue security level ID.
SprintsCountReturns the number of sprints.
SprintThe sprints in which the issue is present (separated by comma).
StatusThe issue status.
StatusDescriptionThe issue status description.
StatusTransitionsCountReturns the number of status transitions of the Issue.
SubTasksList of issue subtasks.
SubtasksCountReturns the number of subtasks of the Issue.
SummaryThe issue summary.
Time SpentThe time spent working on the issue.
TimeSpentThe time spent working on the issue.
TimeSpentFormattedThe time spent working on the issue formatted as Jira.
UpdatedThe 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}.
UpdatedDateThe 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}.
UpdatedDateTimeThe 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}.
URLReturns the URL of the Issue detail screen.
UserAccountIdThe user account id who is exporting.
UserDisplayNameDisplay name of the user that is requesting the export.
UserEmailAddressEmail address of the user that is requesting the export.
UsernameUsername of the user that is requesting the export.
UserRoleThe user roles who is exporting.
VotesThe number of times an issue was voted.
WatchersReturns a list of Users that are watching the Issue. Functions: fullname and emailaddress can be used with this field.
WatchesThe number of watches of the issue.
WorklogsCountReturns 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.

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}
Expand to see the examples on sample code
${Parent.Key}
${Parent.Summary}
${Parent.Description}

WIKI indicates that the field supports wiki format. More about here.

  • No labels