---
title: "Exercise 1 - Setting up Xporter"
canonical: "https://docs.getxporter.app/space/XPORTER/1413209/Exercise%201%20-%20Setting%20up%20Xporter"
format: markdown
---
> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> > Macro (toc)

## Introduction

This is the first exercise of the Basic Level. The main goal is to give you an idea of the tasks that must be performed to print your first report.

Immediately after [installing the Xporter app](https://docs.getxporter.app/space/XPORTER/1412018) and taking care of the [license details](https://docs.getxporter.app/space/XPORTER/1413614), when you refresh the Apps page of the Jira Administration, the Xporter for Jira administration section will be displayed on the left sidebar.

> ℹ️ The Xporter for Jira administration section allows you to manage the [Global Settings](https://docs.getxporter.app/space/XPORTER/1409516), [Templates](https://docs.getxporter.app/space/XPORTER/1409467), [Permissions Schemes](https://docs.getxporter.app/space/XPORTER/1409475), [File Servers](https://docs.getxporter.app/space/XPORTER/1409479) and the [Vendor License](https://docs.getxporter.app/space/XPORTER/1409488).

## Configuration

Navigate to [Global Settings](https://docs.getxporter.app/space/XPORTER/1409516/Global+Settings), and you'll see its four major sections: Output Options (Figure 1 - 1), Bulk Export Options (Figure 1 - 2), Global Permissions (Figure 1 - 3) and Jira Service Desk (Figure 1 - 4).

![Figure 1 - Global settings](media://18c8ff6f-ae43-45fa-a476-455b91842e67)

### Output Options

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Here, you can select the available formats of the Xporter-generated report, as well as the Default format (Figure 1 - 1).
> 
> > Macro (rw-step)
> 
> If you unselect all the options and click *Save *(Figure 1 - 4), you will get an error message informing you that *It is required to have at least one Output Format enabled*.
> 
> > Macro (rw-step)
> 
> Select only the **XLSX (Excel)**, **DOCX (Word)** and **PDF** on the *Output formats,* as well as **PDF** on the *Default format* and click *Save* again. This time, a success message will be displayed informing you that the Global Settings were successfully saved. 
> 
> > ℹ️ - Even with all the Output formats selected, the [format of your generated report](https://docs.getxporter.app/space/XPORTER/1413353) is limited by the extension of the Template you're using.
> > ℹ️ - When the set *Default format* isn't compatible with the template you've selected to export, only the compatible options you've selected on the *Output format* will be available. If you did not select a compatible format, you won't be able to generate a document.

### Bulk Export Options

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Here, you can select the default *Break Pages* option (Figure 1 - 2), and set the *Maximum number of Issues* allowed to export at one time, as well as the *Maximum number of simultaneous requests* of Xporter processes that can be run.
> 
> > Macro (rw-step)
> 
> Whatever the *Break Pages* option you select here, you'll always have the opportunity to change it whenever you try to bulk export. For now, select Issues and click *Save *(Figure 1 - 4).
> 
> > ℹ️ - While **Never** makes all the Issues content to be displayed in a continuous text on the generated file, all the other options make use of Page Breaks to split the Issue's content according to your preference (e.g.: by Project, by Issue Type, etc.), taking into account the way they are currently sorted on your Jira view.
> > ℹ️ - XLSX templates can't have page breaks, so that option isn't displayed when you have selected a Template of that type.
> 
> > Macro (rw-step)
> 
> On the *Maximum number of issues,* replace the default value with **2**, and on the *Maximum number of simultaneous requests,* replace it with **1** and click *Save *(Figure 1 - 4)*.*
> 
> > ⚠️ - If you try to perform a [Bulk export](https://docs.getxporter.app/space/XPORTER/1413812) containing more Issues than the value set in *Maximum number of issues,* an error message (*The number of selected issues is above the maximum allowed (<value>))* will be displayed when you try to Bulk export the Issues.
> > ⚠️ - Also, if the Bulk export operations request quantity is larger than the set *Maximum number of issues,* an error message* (The number of export requests running has exceeded its limit)* will be displayed when you try to Bulk export the Issues.
> > ⚠️ - The *Maximum number of simultaneous requests* feature is not available in Xporter for Jira Cloud.

### Global Permissions

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Here (Figure 1 - 3), you can enable/disable options related to enforcing the [*Permission Scheme*](https://docs.getxporter.app/space/XPORTER/1409475) configuration, display the *Xporter panel on Single issue view*, *Allow anonymous requests* and *Including Attachments* of the Issue on generated reports.
> 
> > Macro (rw-step)
> 
> We'll explore Permission Schemes thoroughly in our next exercise. For now, just select the *On* option on *Enable Xporter for Jira for all projects and all users* for now and click *Save *(Figure 1 - 4)*.*
> 
> > Macro (rw-step)
> 
> *The **Enable Xporter for Jira panel on Single Issue View *allows displaying a panel on the right sidebar of a single Issue page to allow exporting without leaving its page. Leave this option disabled.
> 
> > Macro (rw-step)
> 
> Enabling the *Allow anonymous requests* option lets unauthenticated users invoke the Xporter for Jira Servlet, so be aware of the security risk. Leave it disabled.
> 
> > Macro (rw-step)
> 
> Enabling *Include Attachments *means when [exporting a single Issu](https://docs.getxporter.app/space/XPORTER/1409721)e with its output format set to PDF, if the Issue has any attachments, they will also be attached to the generated report. Make sure it is enabled and click *Save* (Figure 1 - 4). A modal will open, informing you that *t**his option can decrease Xporter for Jira performance.* Click *Confirm* and you're done.

### Jira Service Desk

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Enabling* Xporter for Jira Service Desk* allows your Service Desk Customer to get their tickets printed on reports. All [Templates](https://docs.getxporter.app/space/XPORTER/1409467/Templates) available are defined by you when you set the Scope list by Template.
> 
> > Macro (rw-step)
> 
> With all the initial setup configurations finished, you just need a Template to start exporting your generated reports. You can use the [Xporter Template Store](https://docs.getxporter.app/space/XPORTER/1409467/Templates#Xporter-Template-Store) to help with this. Along with user-created templates, Xporter for Jira provides an external [Template Store](https://store.getxporter.app/) where you can find and download templates provided by our team. Just select one that you like, click *download* and you are good to go.
> 
> > Macro (rw-step)
> 
> Navigate to the Xporter Template Store, search for *Issue Details with Cover Page*, click *Install* and repeat the process for the *Issue Detail Excel* template.

## Exercise(s)

### 1 - [Exporting a Single Issue](https://docs.getxporter.app/space/XPORTER/1409721/Single+Issue)

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> To export your first report, navigate to an Issue of your choosing on your Jira instance. Click the *Export* option (Figure 2 - 1) and select *Xporter* (Figure 2 - 2). A modal will open (Figure 3).
> 
> ![Figure 2 - Export](media://972d9ce6-5ae0-49d8-8ff9-2c652e4e12ca)
> 
> > Macro (rw-step)
> 
> Select the *Issue Details with Cover Page* template <span style="color: #333333">(Figure 3 - 1)</span>. Since it is a DOCX template, the output format available options will only display **PDF** and **DOCX.** Choose **Issue Detail Excel** instead; that will change to **PDF** and **XLSX **(Figure 3 - 2). Click the *Export* button (Figure 3 - 3).
> 
> ![Figure 3 - Export](media://7867091d-28a2-4438-9394-85d74f24e295)
> 
> > Macro (rw-step)
> 
> A modal will open with the export progress. Click the *Download* button (Figure 4 - 1) to get your report when it's ready.
> 
> ![Figure 4 - Download](media://489afb8f-8a09-4e95-ab09-4e57384d9a44)

#### Exporting a Single Issue with Attachments

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> On a new browser tab, go back to the Global Settings screen (Figure 1). 
> 
> > Macro (rw-step)
> 
> Enable the *Enable Xporter for Jira panel on Single Issue View,* and click *Save* (Figure 1 - 4).
> 
> > Macro (rw-step)
> 
> Return to the previous tab, click *Back to Issue*, and now the *Xporter for Jira* panel will be displayed on the right sidebar of the issue. This time, add two attachments of your choosing to the Issue.
> 
> > Macro (rw-step)
> 
> Select the **Issue Details with Cover Page** template with the **PDF** output and click *Export*. Open the generated file with a PDF reader and you'll see your generated document along with the attached Issue files (Figure 5).
> 
> ![Figure 5 - PDF](media://2002e766-2201-423a-a749-f5be6c0af7e8)
> 
> > ℹ️ **PDF note**
> > ℹ️ 
> > ℹ️ The browser-embedded PDF viewers don't allow you to check the PDF attachments, so we suggest using a standalone PDF reader like Adobe Acrobat, and checking the attachments on the left sidebar.

### 2 - Exporting a Single Issue Invoking the Xporter for Jira Servlet

> ℹ️ **Browser info**
> ℹ️ 
> ℹ️ The following steps are based on the Google Chrome interface.

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> On your Issue page, press **F12** to display the browser console and go to the *Network* tab.
> 
> > Macro (rw-step)
> 
> Click *Export* on the *Xporter for Jira* panel and a new entry will appear on the *Network* console. Right-click it, and navigate to *Copy *(Figure 6 - 1)* -> Copy link address *(Figure 6 - 2).
> 
> ![Figure 6 - Copy](media://99351ecb-e919-4908-806f-68d4b37f25f8)
> 
> > Macro (rw-step)
> 
> Open a new browser tab, paste the link and click *Enter. *The file will be generated.
> 
> > Macro (rw-step)
> 
> Now, open a new browser window in Incognito mode (press **Ctrl + Shift + n** on your keyboard), paste the same link and click *Enter.* An error page will be displayed, and by expanding the *Request assistance* option, you will see **Invalid permissions** under *Cause.*
> 
> > Macro (rw-step)
> 
> Return Xporter for Jira Global Settings screen (Figure 1), enable the *Allow anonymous requests *options and click *Save *(Figure 1 - 4).
> 
> > Macro (rw-step)
> 
> Repeat the action on the Incognito mode browser window, and the file will now be generated.

### 3 - Exporting a Bulk of Issues

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> On your Jira instance, go to *Issues* (Figure 7 - 1) and then click *Search for issues* (Figure 7 - 2). Make sure more than two Issues are displayed.
> 
> ![Figure 7 - Issues](media://1795dd8e-6075-4be7-8ccc-b853ecc546d3)
> 
> > Macro (rw-step)
> 
> Click the *Export* button (Figure 8 - 1) and select the *Xporter* option (Figure 8 - 2). A modal will open showing an error message, stating that the number of selected issues is above the maximum allowed.
> 
> ![Figure 8 - Export](media://91996cb1-4d5b-4eb5-95f0-6713903fff4c)
> 
> > Macro (rw-step)
> 
> Return to the Global Settings screen (Figure 1), and, on the *Maximum number of issues *option*,* replace the default value with **10000**, and click *Save *(Figure 1 - 4)*.*
> 
> > Macro (rw-step)
> 
> Back to the Issue Navigator (Figure 7), make sure less than 10.000 Issues are displayed, click the *Export* button (Figure 8 - 1) and select Xporter (Figure 8 - 2). 
> 
> > Macro (rw-step)
> 
> You will navigate to a screen where you can select the Template and Output format of your generated report. If the **XLSX Issue Detail Excel** Template is selected, you will also see the additional **Break pages** selector with its default option set to *Issues* when the **Issue Details with Cover Page Template** is selected instead.
> 
> > ℹ️ **Beak Pages**
> > ℹ️ 
> > ℹ️ - If you select **Projects** on the *Break Pages*, a break occurs only when an Issue belongs to a different project than the previous one on the stack of Issues to be printed.
> > ℹ️ - The same logic is used for **Issue Types** (when an Issue is from a different Issue type than the previous one on the stack of issues to be printed) and **Components** (when an Issue is associated with different components than the previous one on the stack of Issues to be printed).
> 
> > Macro (rw-step)
> 
> Also, if you open two browser windows on the Issue Navigator and try to bulk export on the second window, while the same action is being performed on the first window, an error message is showing, stating *The number of export requests running has exceeded its limit*. If you return to the tab with Global Settings screen, and on the *Maximum number of simultaneous requests* option replace the default value with **10**, click *Save*, and repeat the process, no error message will be displayed.

**4 - Working with the Enable Xporter for Jira for all Projects and all Users Option**

> ℹ️ - This option will be explored in detail at a later [exercise.](https://docs.getxporter.app/space/XPORTER/1413608) For now, there's a simple exercise to test it.
> ℹ️ - This exercise assumes you currently don't have a Permission Scheme configuration.

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Navigate to the tab with Xporter for Jira administration section and go to the Global Settings screen (Figure 1). There, disable the *Enable Xporter for Jira for all projects and all users*, and click *Save *(Figure 1 - 4).
> 
> > Macro (rw-step)
> 
> Go to the Issues screen (Figure 7) and you'll notice the Xporter option (Figure 7 - 2) will now be missing since no Permission Scheme is configured to allow you to use Xporter.
> 
> Also, on the Issue Navigator, if you try to bulk export, an *error *message will be displayed, informing you that you are *Unable to export the selected issues.* If you check the details, you will be see on the modal, that the *User has no permissions for using Xporter for Jira in current Permission Scheme* for each of the Issues you tried to bulk export.
> 
> > Macro (rw-step)
> 
> Return to the Global Settings screen (Figure 1), enable the *Enable Xporter for Jira for all projects and all users*, and click *Save *(Figure 1 - 4).


> ℹ️ **Exercise 1 is now complete. Proceed to **[**Exercise 2**](https://docs.getxporter.app/space/XPORTER/1413502)** to learn how to manage Xporter Templates.**
> ℹ️ 
> ℹ️ If you like this exercise, please [write us and leave a comment](https://docs.getxporter.app/space/XPORTERCLOUD/460118/Support) or a 👍. Your feedback is very important to us.
> ℹ️ 
> ℹ️ Thank you in advance. Enjoy our product!

<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/XPORTER/23102936).
</details>