---
title: "Mappings"
canonical: "https://docs.getxporter.app/space/XPORTERCLOUD/558575/Mappings"
format: markdown
---
> ℹ️ A mapping template in [Xporter](https://marketplace.atlassian.com/apps/891368/xporter-export-issues-from-jira?tab=overview&hosting=cloud) for Jira Cloud sets placeholders in a document template where Jira issue data is inserted during document generation.

## Using Mappings

To <span style="color: #0d0d0d">utilize</span> a mapping, <span style="color: #0d0d0d">insert the field in your template using this notation: </span>`${<Field>}`

<span style="color: #0d0d0d">Below are the available keywords:</span>

> ℹ️ [Wiki] indicates that the field [supports wiki format](https://docsxporter.atlassian.net/wiki/spaces/XPORTERCLOUD/pages/527053/Wiki+Markup+HTML+and+Links).

| **Field** | **Content** |
| --- | --- |
| ActivityEntriesCount[DeprecaTED] | Returns the number of activity entries in the issue |
| AffectedVersions | The project versions affected by the issue (a list with one version per line) |
| AffectedVersionsCount | Returns the number of affected versions in the issue |
| AffectedVersionsList | The project versions affected by the issue (separated by commas) |
| AggregateOriginalEstimate | The sum of the originally estimated time for issue completion, in seconds |
| AggregateOriginalEstimateFormatted | The sum of the originally estimated time for issue completion formatted as defined in the [Jira Time Tracking](https://confluence.atlassian.com/display/JIRA/Configuring+Time+Tracking) options |
| AggregateRemainingEstimate | The sum of the remaining estimated time for issue completion, in seconds |
| AggregateRemainingEstimateFormatted | The sum of the remaining estimated time for issue completion formatted as defined in the [Jira Time Tracking](https://confluence.atlassian.com/display/JIRA/Configuring+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](https://confluence.atlassian.com/display/JIRA/Configuring+Time+Tracking) options |
| Assignee | The issue assignee display name |
| AssigneeGroups | The groups to which the issue assignee belongs to |
| AssigneeId | The issue assignee ID |
| AssigneeUserDisplayName | The issue assignee display name |
| AssigneeUserEmailAddress | The issue assignee email address |
| AssigneeUserName[DeprecaTED] | The issue assignee nickname |
| Attachments | - The attachments of the current issue (a list with one attachment per line).
- 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 on the issue |
| Components | The components to which an issue belongs to |
| 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 must use **${dateformat("yyyy-MM-dd"):Created}**
- If you want to print the date and time, you must 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 must use **${dateformat("yyyy-MM-dd"):CreatedDate}**
- If you want to print the date and time, you must 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 must use **${dateformat("yyyy-MM-dd"):CreatedDateTime} **
- If you want to print the date and time, you must 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 must use **${dateformat("yyyy-MM-dd"):Current Date}**
- If you want to print the date and time, you must 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 must use **${dateformat("yyyy-MM-dd"):Current Date Time}**
- If you want to print the date and time, you must 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.<br>If you want to print only the date, you should use **${dateformat("yyyy-MM-dd"):CurrentDateTime}**<br>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 to identify the document |
| Due Date | The issue's due date |
| DueDate | The issue's due date |
| DueDateTime | The issue's 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 that an issue fixes |
| FixVersionsCount | Returns the number of fixed versions in the issue |
| FixVersionsList | The versions that an issue fixes, separated by commas |
| FixVersionsReleaseDate | The release date of the versions that an issue fixes |
| FixVersionsReleaseDateList | The release dates of the versions that are 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}", 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:<br>${Images|maxwidth=100|maxheight=100}<br>${Images|maxwidth=100|maxheight=100|sortby=name}<br>${Images|maxwidth=100|maxheight=100|sortby=date}<br>**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](https://confluence.atlassian.com/display/JIRA/Configuring+Time+Tracking) options |
| ParentIssueDescription[DeprecaTED] | The parent issue description |
| ParentIssueId | The parent issue's ID |
| ParentIssueKey | The parent issue's key |
| ParentIssueSummary | The parent issue summary |
| Priority | The issue priority |
| PriorityDescription | The issue priority description |
| Project | The issue project name related to 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 to |
| 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](https://confluence.atlassian.com/display/JIRA/Configuring+Time+Tracking) options |
| Reporter | The issue reporter display's name |
| ReporterId | The issue reporter ID |
| ReporterID | The issue reporter ID |
| ReporterGroups | The groups to which the issue reporter belongs to |
| ReporterUserDisplayName | The issue reporter Jira display's name |
| ReporterUserEmailAddress | The issue reporter's Jira email address |
| ReporterUserName [DeprecaTED] | The issue reporter's 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 must use **${dateformat("yyyy-MM-dd"):Updated}**
- If you want to print the date and time, you must use **${dateformat("dd-MM-yyyy  HH:mm:ss"):Updated}** |
| UpdatedDate | - The issue update timestamp.
- If you want to print only the date, you must use **${dateformat("yyyy-MM-dd"):UpdatedDate}**
- If you want to print the date and time, you must use **${dateformat("dd-MM-yyyy  HH:mm:ss"):UpdatedDate}** |
| UpdatedDateTime | - The issue update timestamp.
- If you want to print only the date, you must use **${dateformat("yyyy-MM-dd"):UpdatedDateTime}**
- If you want to print the date and time, you must use **${dateformat("dd-MM-yyyy  HH:mm:ss"):UpdatedDateTime}** |
| URL | Returns the URL of the issue detail screen |
| UserAccountId | The user account ID that is exporting |
| UserDisplayName | Display name of the user that is requesting the export |
| UserEmailAddress | Email address of the user who 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 in this field. |
| Watches | The number of watches in 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, use the same notation: `${<Custom field name>}`

The *<Custom field name>* must exactly match the name of the custom field you created. For example: `${My Special One And Only Custom Field}`

If you have multiple custom fields with the same name, you can explicitly indicate the custom field you want to export using its internal Jira identifier.

<span style="color: #0d0d0d">To find the identifier of a custom field, go to Jira administration, navigate to the fields section, and edit the custom field. The ID will appear in the URL</span> (example:  [http](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)[:](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)[//](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)[jiraserver](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)[/secure/admin/EditCustomField](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)[!](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)[default](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)[.](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)[ ](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)[jspa](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)[ ](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)[?](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)[id=](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)**[10070](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070)**[ ](http://jiraserver/secure/admin/EditCustomField!default.jspa?id=10070) ). 

The notation to use is: `${<Custom field name>[<Custom field id>]}`

##### **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 also work with other custom fields (even those provided by other plugins), depending on how other custom field types implement the rendering of the field values.

> ℹ️ Custom Fields can be referenced using their translated names as well. For instance, 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 markup if the custom field supports it.

## Jira Agile Epic Link

Xporter allows rendering all the fields from the epic link for an Issue. 

This epic link feature is available with the Jira Agile app.

Notation: `${Epic Link.Field}`

##### **Sample Code**

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

## Parent

Notation: `${Parent.Field}`

##### **Sample Code**

```
${Parent.Key}
${Parent.Summary}
${Parent.Description}
```


<details>
<summary>Support/Troubleshooting</summary>

If you have questions or technical issues, please [contact the Support team via the Customer Portal (Jira service management)](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28) or [send us a message using the in-app chat](https://docs.getxporter.app/space/XPORTERCLOUD/18251779/In-App+Chat+Support).
</details>