---
title: "Document Generator"
canonical: "https://docs.getxray.app/space/XRAYCLOUD/44565169/Document%20Generator"
format: markdown
---
<details>
<summary>Table of Contents</summary>

> Macro (toc)
</details>

# Introduction

The Xray Document Generator (Figure 2) is a feature that allows you to create customized templates and generate documents based on your Jira data, including Xray Issues, [Requirements, and Defects](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565860). It is easy to set up and start creating your reports. Here's an overview of the end-to-end process for using the Document Generator:

- **Evaluate existing Templates: **collaborate with your Jira administrators to review the available Template collection, both at the instance and project levels.
- **[Add new Templates](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565177)** are required, you can source them from:
  - **The Xray Template Store**: a repository of pre-built Templates:
  - **Customized Templates**: build your own Templates or edit existing ones (tip: while you can create a Template from scratch, it’s often faster and easier to modify an existing Template from the Template Store).
- **Customize Your Template:**
  - Use the [Template Building](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565181) section of this documentation for guidance.
  - Refer to the Document Generator and Xporter code snippets page for coding examples to enhance your Templates.
- **Explore the Curated List of Templates: **check the [Curated List of Document Generator Templates](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44578476) page for examples of pre-built Templates from the default package or the Template Store. These examples also highlight potential customizations.
- **Select the Scope: **choose the scope of data you want to analyze and access the appropriate menu option for the Document Generator.
- **[Export Your Document](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565173)****: **generate and export the document in your preferred format.

# Access

> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)

## Operations

### [Template Management](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565177)

<span style="color: #172b4d">Administrators can add, edit, delete, and download the Templates available to the users and access the Template Store (Figure 2).</span>

### [Template Building](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565181)

Templates (Figure 3) are documents in DOCX (Microsoft Word) or XLSX (Microsoft Excel) formats. These templates allow you to include mappings that are dynamically replaced with data from Issue fields, custom fields, and other related information, such as comments, work logs, attachments, and more.

![Figure 3 - Template](media://23d02ec3-8052-4d36-ab89-d327d07e9b68)

### [Exporting](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565173)

You can export a Single or Multiple Issues using the actions button (Figure 4 - 1) and then selecting *Xray - Document Generator* button (Figure 4 - 2). This option is available on a Single Issue, Multiple Issue, and the Agile Boards panel.

![Figure 4 - Button](media://af3f7874-d429-4491-ba28-3d16d28c3803)

If you exceed the number of exports running, you will see this error message (Figure 5).

![Figure 5 - Error](media://8c0e5184-7844-4a0a-95b7-c5e214a34ae7)

This message is related to a restriction in Xray: each instance allows **a maximum of six concurrent exports**. If more than six exports are triggered simultaneously, this message will appear.

This limit is applied uniformly across all tenants, including [Xray Enterprise](https://www.getxray.app/xray-enterprise) customers, and it can’t be adjusted per tenant.  


<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://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44577312).
</details>