The Templates screen allows administrators to add, edit, delete and download the templates that will be available to the users.

Xray Cloud Documentation > Template Management > image2020-6-26_10-40-52.png

Xray Cloud Documentation > Template Management > image2020-6-24_16-29-9.png

Managing Templates

The operations available on this screen are:

Add New Template: Allows you to create a new template.
Store: With this option, you'll be able to install templates from the Template Store in this screen.
Download Template: Allows you to download the template file. This operation is available in the hyperlink with the template file name.
Edit Template: Allows you to change an existing template, changing the template name, template description and template file.
Delete Template: Allows you to delete an existing template.

Xray Cloud Documentation > Template Management > image2020-6-24_16-7-19.png

Template Details

Each template has the following attributes:

Name: the name that is displayed to the users in order 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.
Output formats: list of available template formats for a given input format. For more information go to Outputs Matrix Page.
Default output format: one of the output formats allowed to be displayed as default.
Default break page type: handles how Xray - Document Generator should break pages. The following break pages are supported:
- Never
- Issues
- Components
- Issue Types
- Projects
Include Attachments: define if single exportation with that template will include attachments.
File: the file with template content. The following formats are supported:
- 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
Bulk Export	Multiple Issues export (Issue Navigator screen) or Bulk action
Single Export	Issue detail screen
Agile Boards	This scope refers to Backlog and Active Sprint and Kanban
Agile Releases	Manage Release on Agile/Kanban boards. Document Generator is available on Release list and detail screen.

Template Store

Document Generator provides another way to get awesome templates. Use the Template Store to access and install templates provided by us, free of charge.

The Store will be displayed in the dialogue and allows you to install and re-install all of the available templates.

Xray Cloud Documentation > Template Management > image2020-6-26_9-47-6.png

Furthermore, the template store also shows a thumbnail with the report generated based on the template selected.

Xray Cloud Documentation > Template Management > image2020-6-26_9-44-27.png

Managing Templates at Project Settings

All features related to Templates management on App Administration are included at Project level.

Xray Cloud Documentation > Template Management > image2020-6-24_16-22-10.png