---
title: "Templates"
canonical: "https://docs.getxporter.app/space/XPORTERCLOUD/431152/Templates"
format: markdown
---
> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> > Macro (toc)


> ⚠️ **Deprecation Note**
> ⚠️ 
> ⚠️ <span style="color: #0d0d0d">All HTML has been removed from the description of the templates that were in the </span>[<span style="color: #0d0d0d">Xporter Template Store</span>](https://store.getxporter.app/)<span style="color: #0d0d0d">. In the future versions of Xporter, templates will no longer support HTML.</span>

The *Templates* screen (Figure 1) a<span style="color: #0d0d0d">llows administrators to manage templates available to users.</span>

## <span style="color: #0d0d0d">Access</span>

You can [access ](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Accessing-Templates)*[Templates](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Accessing-Templates)* in the [Xporter](https://marketplace.atlassian.com/apps/891368/xporter-export-issues-from-jira?tab=overview&hosting=cloud) menu, by selecting the *Templates* option (Figure 1 - 1).

![Figure 1 - Templates](media://ff3567be-36db-4e1d-867a-282d9b218677)

## Operations

- See the existing templates (Figure 1 - 2) and their details (name, scopes, description).
- [Add a new template](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Adding-an-External-Template) by clicking the *Add* button (Figure 1 - 4).
- Access the Xporter Template Store by clicking the *Store* button (Figure 1 - 5). <span style="color: #0d0d0d">This option allows you to </span>[<span style="color: #0d0d0d">access templates from the Xporter Template Store</span>](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Adding-a-Template-from-the-Store)<span style="color: #0d0d0d"> and add them to this screen.</span>
- Download the template file. On the corresponding template, click the gear icon (Figure 1 - 6) and then select *Download* (Figure 1 - 7).
- *Set as Default* (Figure 1 - 8). If you choose this option, the selected template will be selected when users open the issue view screen.
- *Edit* a template (Figure 1 - 9). <span style="color: #0d0d0d">Allows you to change an existing template by editing the template name, description, scopes, template file, etc. More below (Figure 2).</span>
- Delete a template (Figure 1 - 10).

## Template Details

<span style="color: #0d0d0d">When creating a new template (refer to </span>[<span style="color: #0d0d0d">step 5 on this page</span>](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Adding-an-External-Template)<span style="color: #0d0d0d">), you can input the template's details.</span>

You can change an existing template's details by clicking the corresponding gear icon (Figure 1 - 6) and then clicking *Edit* (Figure 1 - 9). A modal will open (Figure 2) for you to add/change the template's settings.

![Figure 2 - Edit a template](media://bcdb93d4-efc9-4eeb-94a7-e5460a339e7d)

### Template's Attributes

#### Name

The template name displayed to the users to select the template to export the issue(s) information (Figure 2 - 1; mandatory field).

#### Description

<span style="color: #0d0d0d">Brief description of the template's purpose (up to 500 characters; Figure 2 - 2; optional field).</span>

#### [<span style="color: #0d0d0d">Scopes</span>](https://docs.getxporter.app/space/XPORTERCLOUD/431152/Templates#Scopes-Available)

<span style="color: #0d0d0d">Determine where the template will be accessible within your Jira instance (Figure 2 - 3; optional field).</span>

#### <span style="color: #0d0d0d">File</span>

<span style="color: #172B4D">The file with template content </span><span style="color: #172B4D">(Figure 2 - 4; optional field). </span><span style="color: #172B4D">The following formats are supported:</span>

- DOCX (Word Document).
- DOCM (Word Document with Macros).
- DOTX (Word Template).
- DOTM (Word Template with Macros).
- XLSX (Excel Document).
- XLSM (Excel Template with Macros).
- ODT (Open Office Document).
- RTF (Rich Text Format).
- CSV (Comma-separated values).
- TXT (Text File).

#### Settings

The following settings will only appear if you click the Advanced button (Figure 2 - 5; optional field):

- *Output formats* (Figure 2 - 6; mandatory field) - list of available template formats for a given input format. The output formats available [vary depending on the template file type](https://docs.getxporter.app/space/XPORTERCLOUD/558450/Outputs+Matrix).
- *Default output format* (Figure 2 - 7; mandatory field).
- *Break page* type (Figure 2 - 8; optional field) - only available for Word templates. H<span style="color: #172B4D">andles how Xporter should break pages. The following break pages are supported:</span>
  - Never.
  - Issues.
  - Components.
  - Issue Types.
  - Projects.
- *Include Attachments* (Figure 2 - 9; optional field) - u<span style="color: #0d0d0d">se the toggle to specify whether issue attachments should be included in the exported document.</span>

<span style="color: #172B4D">Once you're finished setting up your template, click the </span>*<span style="color: #172B4D">Update</span>*<span style="color: #172B4D"> button (Figure 2 - 10).</span>

### Scopes Available

You can select the scopes below for your template (Figure 2 - 4).

| **Scope** | **Location** |
| --- | --- |
| <span style="color: #172B4D">Bulk Export</span> | M<span style="color: #172B4D">ultiple Issues export (Issue Navigator screen) or Bulk action</span> |
| Schedule Reports | [Report scheduling](https://docs.getxporter.app/space/XPORTERCLOUD/15466498) |
| <span style="color: #172B4D">Single Export</span> | <span style="color: #172B4D">Issue detail screen</span> |
| <span style="color: #172B4D">Workflow Post Functions</span> | <span style="color: #172B4D">Xporter workflow post-functions</span> |
| <span style="color: #172B4D">JSD Request Detail</span> | <span style="color: #172B4D">Jira Service Desk Request detail screen</span> |
| <span style="color: #172B4D">JSD Request List</span> | <span style="color: #172B4D">Jira Service Desk My Requests detail screen</span> |
| <span style="color: #172B4D">Agile Boards</span> | <span style="color: #172B4D">This scope refers to Backlog, Active Sprint, and Kanban </span> |
| <span style="color: #172B4D">Releases</span> | - <span style="color: #172B4D">Manage release on Agile/Kanban boards.</span>
- <span style="color: #172B4D">Xporter is available on the Release list and detail screen.</span> |

## Template Store

You can also use the [Xporter Template Store](https://store.getxporter.app/) to [access and install templates provided by Xporter](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Adding-a-Template-from-the-Store), free of charge.

> ℹ️ **Learn More**
> ℹ️ 
> ℹ️ [Working with templates](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates)


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