---
title: "Template Management"
canonical: "https://docs.getxray.app/space/XRAY/159908575/Template%20Management"
format: markdown
---
> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> > Macro (toc)

# Introduction

<span style="color: #172b4d">The Templates screen (Figure 1), available via the </span><span style="color: #172b4d">[Document Generator](https://getxraydocs.atlassian.net/wiki/spaces/XRAY/pages/160235683)</span><span style="color: #172b4d"> (Figure 1 - 1), allows administrators to add, edit, delete, and download the report templates available to the users.</span>

![Figure 1 - Document generator](media://10837eeb-c644-471b-843d-671dc4105057)

# Operations

## Managing Templates

The operations available on this screen are:

- **Add New Template**: create a new template (Figure 2 - 1).
- **Store: **install templates from the Template Store in this screen (Figure 2 - 2).
- **Download Template**: download the template file. This operation is available in the hyperlink with the template file name (Figure 2 - 3).
- **Edit Template**: change an existing template (changing the template name, template description, and template file; Figure 2 - 3).
- **Delete Template** (Figure 2 - 3).

![Figure 2 - Operations](media://1295a5c2-61d5-4966-8a12-798edad4e0b7)

## Template Details

Each template has the following attributes:

- **Name:** the name that is displayed to the users to select the template to export the Issue(s) information.
- **Description:** here you can describe what is the goal of the template (up to a maximum of 500 characters).
- **Scopes: **where the template will be available.
- **Entities:** a group of Issue or Issue Types that are available as Xray Entities.
- **Output formats: **list of available template formats for a given [input format](https://docs.getxporter.app/space/XPORTER/1413353/Outputs+Matrix).
- **Default output format: **<span style="color: #172b4d">one of the output formats allowed to be displayed as the default.</span>
- **Default break page type: **<span style="color: #172b4d">handles how </span><span style="color: #172b4d">**Xray - Document Generator**</span><span style="color: #172b4d"> should break pages. The following break pages are supported:</span>
  - Never.
  - Issues.
  - Components.
  - Issue Types.
  - Projects.

- <span style="color: #172b4d">**File: **</span><span style="color: #172b4d">the file with template content. 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).

## Template Scopes

Template scopes define where the template will be available. The following scopes are available:

| **Scope** | **Location** |
| --- | --- |
| Issue Navigator | Issue Navigator screen |
| Issue Details | Issue details screen |
| Agile Boards | <span style="color: #172b4d">This scope refers to Backlog, Active Sprint, and Kanban board</span> |
| Agile Releases | Manage Release on Agile/Kanban boards. Document Generator is available on the Release list and detail screen. |
| [Test Plan Board](https://getxraydocs.atlassian.net/wiki/spaces/XRAY/pages/301663993) | Test Plan Board screen |
| [Test Repository](https://getxraydocs.atlassian.net/wiki/spaces/XRAY/pages/1242169372) | Test Repository screen |

## Template Entities

Template Entities (Figure 3 - 1) define the Issue types or group of Issues (Coverables or Defects) that are considered as Xray entities and are available to be exported.

![Figure 3 - Entities](media://db311426-c0e3-49dd-aa9f-4b76ba86525f)

## Template Store

**Document Generator** provides another way to get report templates. 

You can use the Template Store (Figure 4) to access and install templates provided by Xray for free.

<span style="color: #172b4d">The Store will be displayed in the dialogue and allows you to install and re-install all of the available templates.</span>

![Figure 4 - Template store](media://64993e97-5fe6-4c10-aaf7-c50c3051407c)

<span style="color: #172b4d">The Template Store also shows a thumbnail of the report generated based on the template selected (Figure 5).</span>

![Figure 5 - Thumbnail](media://df6ca81e-fc82-4d03-82e3-87517f91b540)


## Managing Templates at Project Settings

<span style="color: #172b4d">All features related to the Template management on App Administration are included at the Project level (Figure 6).</span>

![Figure 6 - Project](media://226a5a34-d308-435d-bd6c-57e87981c3b3)

## Disabling the Document Generator Templates at the Project Level

A Jira Administrator can disable the document generator templates at the Project level (Figure 7).

![Figure 7 - Project](media://e9061fc5-2119-44d3-912e-04a57a923952)

> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> 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://getxraydocs.atlassian.net/wiki/spaces/XRAY/pages/301501383).