---
title: "Exercise 1 - Setting up Xporter"
canonical: "https://docs.getxporter.app/space/XPORTERCLOUD/560103/Exercise%201%20-%20Setting%20up%20Xporter"
format: markdown
---
> Macro (rw-ui-expands-macro)
>
> > Macro (rw-expand)
>
> > Macro (toc)
## Introduction
In this set of exercises, we will introduce [Xporter](https://marketplace.atlassian.com/apps/891368/xporter-export-issues-from-jira?tab=overview&hosting=cloud), discuss some available configurations, and demonstrate how to use it to export data from Jira.
Immediately after [installing the Xporter app](https://docs.getxporter.app/space/XPORTERCLOUD/558863/Xporter+for+Jira+Cloud+Installation), you will be redirected to the [*Getting Started with Xporter*](https://docs.getxporter.app/space/XPORTERCLOUD/560457/Getting+Started)* *page (Figure 1).
### Getting Started
Here, we provide an overview of Xporter and explain fundamental concepts.
We cover general configurations, template management, and exporting options:
- [**Miscellaneous**](https://docs.getxporter.app/space/XPORTERCLOUD/462170/Miscellaneous)
- [Global Permissions](https://docs.getxporter.app/space/XPORTERCLOUD/462170/Miscellaneous#Global-Permissions).
- [Xporter Visibility](https://docs.getxporter.app/space/XPORTERCLOUD/462170/Miscellaneous#Xporter-Visibility).
- [**Templates**](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates)
- [**Exporting**](https://docs.getxporter.app/space/XPORTERCLOUD/558706)
## Configuring Xporter
### Miscellaneous
[Navigate](https://docs.getxporter.app/space/XPORTERCLOUD/460808/Xporter+App+Administration) to the **[Miscellaneous ](https://docs.getxporter.app/space/XPORTERCLOUD/462170/Miscellaneous)**[page](https://docs.getxporter.app/space/XPORTERCLOUD/462170/Miscellaneous), on Jira Administration, and you'll see its major sections:
- Global Permissions: allows administrators to use permission schemes to manage permissions between Jira users. This option overrides permission scheme configurations, making Xporter functionalities available to all users and for every issue.
- Xporter Visibility: administrators can define where Xporter should appear in Jira. Locations such as *Service Desk*, *Single Issue View*, or *Agile Boards* can be hidden with this configuration.
### Installing the First Template
> Macro (rw-ui-steps-macro)
>
> > Macro (rw-step)
>
> Once the [initial Xporter setup configuration](https://docs.getxporter.app/space/XPORTERCLOUD/558863/Xporter+for+Jira+Cloud+Installation) is finished, you need a [template](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates) to start exporting Jira Issues.
>
> > ℹ️ [Accessing and adding Templates](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates)
>
> > Macro (rw-step)
>
> Along with user-created templates, Xporter for Jira provides the [Xporter Template Store](https://store.getxporter.app/) where you can find and install templates provided by our team, for free.
>
> [Choose one that suits your needs, click the ](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Adding-a-Template-from-the-Store)*[D](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Adding-a-Template-from-the-Store)**[ownload](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Adding-a-Template-from-the-Store)*[ ](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Adding-a-Template-from-the-Store)*[template](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Adding-a-Template-from-the-Store)*[ button](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Adding-a-Template-from-the-Store), and you are good to go.
>
> > Macro (rw-step)
>
> Navigate to the Xporter Template Store, using the search bar (Figure 2 - 1) and find and enter the *Issue Details with Cover Page* template (Figure 2 - 2). A new page will open (Figure 3). There, click the *Download Template button* (Figure 3 - 1) and repeat the process for the *Issue Detail Excel* template.
>
> 
>
> 
## Exercises
### 1 - [Exporting a Single Issue](https://docs.getxporter.app/space/XPORTERCLOUD/558706/Exporting+Issues#Exporting-a-Single-Issue-Using-the--Actions- Button)
> Macro (rw-ui-steps-macro)
>
> > Macro (rw-step)
>
> Go to your Jira Cloud instance and open a Jira Issue.
>
> From the *Options* menu (Figure 1 - 1), select *Xporter* (Figure 1 - 2).
>
> 
>
> > Macro (rw-step)
>
> A modal will open (Figure 2).
>
> 
>
> Select the *Issue Details with Cover Page* template (Figure 5 - 1). Since it is a DOCX template, the *Output format* available options will only display word-compatible formats like PDF and DOCX (Figure 5 - 2).
>
> > Macro (rw-step)
>
> Choose the *Issue Detail Excel* template (Figure 6 - 1) instead, which will change the template's output to other formats like PDF or XLSX (Figure 6 - 2).
>
> 
>
> > Macro (rw-step)
>
> Click the *Export* button (Figure 6 - 3). The report download will start, and you will get the report file on your machine.
### 2 - Exporting a Single Issue with Attachments
> Macro (rw-ui-steps-macro)
>
> > Macro (rw-step)
>
> Return to the [Templates screen](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Accessing-Templates).
>
> > Macro (rw-step)
>
> There, find and [edit](https://docs.getxporter.app/space/XPORTERCLOUD/427622/Working+with+Templates#Accessing-Templates) the *Issue Details with Cover Page* template (Figure 7 - 1).
>
> 
>
> > Macro (rw-step)
>
> Click the *Advanced* option (Figure 7 - 2) and enable the toggle to include attachments (Figure 7 - 3).
>
> > Macro (rw-step)
>
> Click the *Update* button (Figure 7 - 4).
>
> > Macro (rw-step)
>
> Choose a Jira issue and add attachments.
>
> > Macro (rw-step)
>
> Select the *Issue Details with Cover Page* template (Figure 8 - 1), add the PDF output format (Figure 8 - 2), and click the *Export *button (Figure 8 - 3).
>
> 
>
> The report download will start, and you will get the PDF report file on your machine.
>
> > Macro (rw-step)
>
> Open the generated file with a PDF reader to view the report with the attached issue files (Figure 9 - 1).
>
> 
> ℹ️ The browser-embedded PDF viewers don't allow you to check the PDF attachments. Because of this, it's recommended using a standalone PDF reader like [Adobe Acrobat](https://get.adobe.com/reader/), and check the attachments on the left sidebar.
### 3 - Exporting a Bulk of Issues
> Macro (rw-ui-steps-macro)
>
> > Macro (rw-step)
>
> On your Jira Cloud instance, select the *Filters* option (Figure 9 - 1), then click *View all issues* (Figure 9 - 2), and finally, select the *New search* option (Figure 9 - 3).
>
> 
>
> > Macro (rw-step)
>
> Customize the *JQL* (Figure 9 - 4) to display multiple Issues (Figure 9 - 5; less than 10.000, which is the Xporter maximum issues to be exported).
>
> > Macro (rw-step)
>
> Click *Apps* (Figure 10 - 1), and then select *Xporter* (Figure 10 - 2). A modal will open where you can choose the exporting options (Figure 11).
>
> 
>
> > Macro (rw-step)
>
> Export the *Issue Details with Cover Page* template (Figure 11 - 1) with the *Output format* as DOCX (Figure 11 - 2) and the *Break pages* selector with the *Issues* value (Figure 11 - 3).
>
> 
>
> Click the *Export* button (Figure 11 - 4).
>
> > Macro (rw-step)
>
> A new modal will open (Figure 12), confirming the exporting success (Figure 12 - 1).
>
> 
>
> > Macro (rw-step)
>
> The generated document will be available for 10 minutes to be downloaded. When possible, click the *Download* button (Figure 12 - 2) to retrieve it. The PDF file will be saved on your machine.
>
> After downloading, open it and you'll see that all Issues are printed, each starting after a page break.
> ℹ️ **Break Pages**
> ℹ️
> ℹ️ Other possible values on the *Break Pages* option (Figure 11 - 3):
> ℹ️
> ℹ️ - **Projects**: a break occurs only when an issue belongs to a different project than the previous one on the stack of Issues to be printed.
> ℹ️ - **Issue Types: **when an Issue is from a different Issue type than the previous one on the stack of Issues to be printed
> ℹ️ - **Components**: when an Issue is associated with different components than the previous one on the stack of Issues to be printed.
### 4 - Working with the *Enable Xporter for all Projects and all Users* Option
> Macro (rw-ui-steps-macro)
>
> > Macro (rw-step)
>
> In your Jira Cloud instance, click the *Settings*/gear icon button (Figure 13 - 1), and then select *Apps* (Figure 13 - 2).
>
> On the side menu, go to *Xporter* and click *Miscellaneous *(Figure 13 - 3).
>
> 
>
> Use the toggle to disable the *Enable Xporter for all Projects and all Users* option (Figure 13 - 4).
>
> Click the *Save* button (Figure 13 - 5).
>
> > Macro (rw-step)
>
> On your Jira Cloud instance, select the *Filters* option (Figure 9 - 1), then click *View all issues* (Figure 9 - 2).
>
> > Macro (rw-step)
>
> Click *Apps* (Figure 10 - 1) and then select *Xporter* (Figure 10 - 2). A modal will open and you will see an error message about not having permission schemes associated (Figure 14).
>
> 
>
> > Macro (rw-step)
>
> Go back to the *Miscellaneous* page (Figure 15), and use the toggle to enable the *Enable Xporter for all Projects and all Users* option (Figure 15 - 1).
>
> 
>
> Click the *Save* button (Figure 15 - 2).
> ℹ️ **Exercise 1 is now complete. Proceed to **[**Exercise 2**](https://docs.getxporter.app/space/XPORTERCLOUD/528515)** 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!
Support/Troubleshooting
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).