---
title: "Report Scheduling Tutorial"
canonical: "https://docs.getxporter.app/space/XPORTERCLOUD/49905859/Report%20Scheduling%20Tutorial"
format: markdown
---
<details>
<summary>Table of Contents</summary>

> Macro (toc)
</details>

# Introduction

One of the use cases for the [Scheduled Reports](https://docs.getxporter.app/space/XPORTERCLOUD/15466498) feature of [Xporter](https://marketplace.atlassian.com/apps/891368/xporter-export-issues-from-jira?tab=overview&hosting=cloud) could be the health check of the Quality Engineering (QE) efforts within a sprint, especially for stakeholders who do not yet have access to Jira. This approach consolidates important metrics and presents them in a clear format directly to the stakeholders' inboxes.

In this tutorial, we will go through the Scheduled Reports [prerequisites](https://docs.getxporter.app/space/XPORTERCLOUD/49905859/Report+Scheduling+Tutorial#Prerequisites) and [configuration](https://docs.getxporter.app/space/XPORTERCLOUD/49905859/Report+Scheduling+Tutorial#Configuring-Scheduled-Reports) for that use case. 

# Prerequisites

## Template Available for Scheduling

To make the [Template](https://docs.getxporter.app/space/XPORTERCLOUD/431152/Templates) available for scheduling, you need to ensure the *Scheduled Reports* value (Figure 1 - 2) is present in the Scope field of each Template.

![Figure 1 - Scope](media://b1fc40dd-9511-420c-9b3e-083d8cc6886c)

Once you’ve added the *Schedule Reports* in the Template, click the *Update* button (Figure 1 - 2).

## Project Settings

Scheduled Reports can be used at the Global level or at the Project level. In this tutorial, we will focus on the Project level. To enable this feature, on your Jira Cloud instance, click the *Settings*/gear icon (Figure 2 - 1) and then click *Apps *(Figure 2 - 2). The Xporter menu will appear on the left side of the screen. There, click *Project Settings* (Figure 2 - 3).

![Figure 2 - Project settings](media://b962a62b-eec6-4b1f-bc74-61cc5ccb448c)

On the desired project, click the toggle to enable the Xporter Settings (Figure 3 - 1).

![Figure 3 - Toggle](media://7768613a-1ff6-4691-bb36-652ef04c0d3b)

## Miscellaneous

Click the *Settings*/gear icon (Figure 4 - 1) and then click *Apps *(Figure 4 - 2). The Xporter menu will appear on the left side of the screen. There, click *[Miscellaneous](https://docs.getxporter.app/space/XPORTERCLOUD/462170/Miscellaneous)* (Figure 4 - 3).

![Figure 4 - Miscellaneous](media://d97bd8aa-7c19-4947-85da-814c0cd43ac7)

Click the toggle to enable the Xporter Schedule Reports setting (Figure 4 - 8), then click the Save button (Figure 4 - 6).

You can now access Schedule Reports via the Xporter menu (Figure 2 - 4) and/or via the Apps menu (Figure 5 - 1), by entering *Xporter* (Figure 5 - 2) and then *Scheduled Reports* (Figure 5 - 3).

![Figure 5 - Apps](media://a056dc1a-35d3-405a-9221-cba1da90a020)


# Configuring Scheduled Reports

> ℹ️ [Creating a Scheduled Report](https://docs.getxporter.app/space/XPORTERCLOUD/15466498/Scheduled+Reports#Creating-a-Scheduled-Report)
> ℹ️ 
> ℹ️ [Editing/Deleting a Scheduled Report](https://docs.getxporter.app/space/XPORTERCLOUD/15466498/Scheduled+Reports#Editing/Deleting-a-Scheduled-Report)

The definition of QE health can be subjective, so feel free to customize the number and types of the Templates. 

In this example, we will be using [Defect Summary](https://store.getxporter.app/view/160), [Requirement Report](https://store.getxporter.app/view/148), and [Test Runs List](https://store.getxporter.app/view/146) report templates. You can only select **one template per scheduled report**, so we will add three items using the *Add* button (Figure 1 - 3) and [upload](https://docs.getxporter.app/space/XPORTERCLOUD/431152/Templates#Template-Details) the respective templates (Figure 1 - 4).

## Details

The content of the *Details* section (Figure 6) is mostly personal preference. 

![Figure 6 - Details](media://7b966f30-09da-43c8-9597-1eceb7519319)

## Scheduler

In the *Scheduler* section (Figure 7 - 2), assuming the sprint duration is 14 days, and you initiate the configuration a sprint in advance, by clicking *Advanced (CRON expression)* (Figure 7 - 3), you can set up the *[Cron expression](https://confluence.atlassian.com/servicemanagementserver0512/constructing-cron-expressions-for-a-filter-subscription-1306299493.html)* (Figure 7 - 4) to control the frequency: `0 0 12 */14 * ?` (Figure 7 - 4). Once you're finished, click *Continue* (Figure 7 - 5).

![Figure 7 - Scheduling](media://c572df0a-1365-41df-9cf9-a2bce81e9ec6)

In the *Condition* section (Figure 8 - 1), you can use the following [JQL](https://docs.getxporter.app/space/XPORTERCLOUD/527003) expressions (Figure 8 - 2; please refer to the Template content for the full list of supported issue types):

- Defect Summary (Figure 8 - 3): `issuetype = Bug AND sprint in openSprints()`
- Requirement Report: `issuetype = Story AND sprint in openSprints()`
- Test Runs List: `issuetype = "Test Execution" AND sprint in openSprints()`

![Figure 8 - Condition](media://69136c3c-485d-4142-89d9-28f7795420bb)

Since these queries can be useful for direct export and other Jira/Xray features, we recommend [saving them as filters](https://confluence.atlassian.com/jirasoftwareserver/saving-your-search-as-a-filter-939938748.html). Once you’re done, click the *Continue* button (Figure 8 - 4).

## Actions

Lastly, in the Actions section (Figure 9), click the *Add action* button (Figure 9 - 1). A modal will open (Figure 9). Here, select the *Send by email* action type (Figure 9 - 2) and insert your list of stakeholders (Figure 9 - 3). Once you’re done, click the *Add* button (Figure 9 - 4).

![Figure 9 - Actions](media://ffc656f5-eb15-411a-8b8a-21ae4f72d4a8)

Now, the Scheduled Reports section of your project settings should look like this (Figure 10):

![Figure 10 - Scheduled reports](media://79874c0c-38c1-41a6-a9a2-54dea46eae85)

# Tips

- Use [Audit Logs](https://docs.getxporter.app/space/XPORTERCLOUD/430884) to see the history and success/failure details.
- Each scheduled report can support multiple Actions, so you may choose to store files in a server in addition to the email delivery.
- Meaningful report names help with file management in the long run.

<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/XPORTERCLOUD/18251779/In-App+Chat+Support).
</details>