Page tree

You are on the Xporter Server documentation. If you are looking for Xporter Cloud 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:

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

Field

Content

AffectedVersions

The project versions affected by the issue (a list with 1 version per line).

AffectedVersionsList The project versions affected by the issue (separated by commas).
AggregateOriginalEstimate

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

AssigneeId

The issue assignee ID.

AssigneeUserDisplayName

The issue assignee Jira display name.

AssigneeUserEmailAddress

The issue assignee Jira email address.

AssigneeUserName

The issue assignee Jira username.

AssigneeGroupsThe groups to which the issue assignee belongs.

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.

BelongsToEpic

Returns "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.

Components

The components to which an issue belongs.

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

Current DateReturns the current date.
Current Date TimeReturns the current date time.

Description

The issue description.

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

FilterJQLCurrent JQL used to search Issues.
FilterNameCurrent 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.
FixVersionsReleaseDateListThe release dates of the versions being fixed by an issue, separated by commas.

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.

ImagesCountReturns the number of images attached to the Issue.

IssueTypeDescription

The issue type description.

IssueTypeDescriptionTranslatedThe translated issue type description.

IssueTypeName

The issue type.

IssueTypeNameTranslatedThe translated issue type.
Issue TypeThe Issues Type name.
Issue Type.IdThe id of the issue type.
Issue Type.NameThe Name of the issue type.
Issue Type.TypeThe Type of the issue type.
Issue Type.IconURLThe Icon URL of the issue type.
JQLIssuesCountThe number of the issues returned by the parent JQL Iteration.

Key

The internal issue Key. For example, PROJECT-1.

Labels

The issue labels.

LinksCountReturns the number of links to the Issue.

OriginalEstimate

The originally estimated time for issue completion, in seconds.

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

PriorityTranslatedThe issue priority translated into the language of the logged user.

PriorityDescription

The issue priority description.

PriorityDescriptionTranslatedThe issue priority description translated into the language of the logged user.

Project.Components

The project components an issue belongs.

Project.Category

The issue project category.

Project.Id

The issue project Id.

Project.Key

The issue project key.

Project.Name

The issue project name.

Project.URL

The issue project URL.

Project.LeadThe issue project leader.
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.

ReporterId

The issue reporter ID.

ReporterUserDisplayName

The issue assignee Jira display name.

ReporterUserEmailAddress

The issue assignee Jira email address.

ReporterUserName

The issue reporter Jira username.

ReporterGroupsThe groups to which the issue reporter belongs.

Resolution

The issue resolution.

ResolutionTranslated The issue resolution translated into 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} .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.

ResolutionDescriptionTranslatedThe issue resolution description translated into the language of the logged user.
ResolutionDesc

SecurityLevel

The issue security level.

SecurityLevelId

The issue security level ID.

Status

The issue status.

StatusTranslatedThe issue status translated into the language of the logged user.
StatusTransitionsCountReturns the number of status transitions of the Issue.

StatusDescription

The issue status description.

StatusDescriptionTranslatedThe issue status description translated to the language of the logged user.
SprintThe Issue Sprint Name.

SubTasks

List of issue subtasks.

SubtasksCountReturns the number of subtasks of the Issue.

Summary

The issue summary.

TestsCountReturns the number of Tests in an issue of type Test Set.
TestStepsCountReturns 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}. 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.

URLReturns the URL of the Issue detail screen.

Votes

The number of times an issue was voted.

Watches

The number of watches of the issue.

WatchersReturns a list of Users that are watching the Issue. Functions: fullname and emailaddress can be used with this field.
CommitsThe number of commits for this issue.
BranchesThe number of branches for this issue.
PullRequestsThe number of pull requests for this issue.
BuildsThe number of builds for this issue.
ReviewsThe number of reviews for this issue.
ParentReturn fields from Parent issues.

XporterTemplate Mappings

Field

Content

XporterTemplate.NameThe template name.
XporterTemplate.DescriptionThe template description.
XporterTemplate.Type

The template type (Docx, Xlsx, ...).

XporterTemplate.FilenameThe template file name.
XporterTemplate.SourceThe template installation source (Store, User upload).
XporterTemplate.CreatorThe creator of the template.
XporterTemplate.ModifiedByWho has modified the template.
XporterTemplate.CreatedThe template createddate.
XporterTemplate.UpdatedThe template updated date.
Expand to see the examples on sample code
${XporterTemplate.Name}
${XporterTemplate.Description}
${XporterTemplate.Type}
${XporterTemplate.Filename}
${XporterTemplate.Source}
${XporterTemplate.Creator}
${XporterTemplate.ModifiedBy}
${XporterTemplate.Created}
${XporterTemplate.Updated}

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

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}
  • No labels