Working with report tasks

A report task controls the generation of tabular reporting output from a Qlik Sense app. Create a report task to configure the delivery of the report to your desired recipients. Create and manage report tasks in the Report tasks tab within in the Reporting section of an app.

A report task converts the report template into the report output. The task can be run manually or on a schedule.

A report task is where all the building blocks of a tabular report – template, filters, and distribution list – come together to generate the output. When you create a report task, you also set the report file names, the users and groups who receive the output, the email or output folder details, and the schedule for when its reports are generated.

With the help of report filters, you can use a single report task to administer and employ a report bursting use case. Report bursting allows you to generate reports with varied information with different subsets of data for different recipient parties. For more information, see Burst reporting using report filters.

How report generation works

You must define a distribution list for the app before you can create report tasks.

In a report task, you select the recipients and groups from your distribution list that you want to generate reports for. When adding recipients as receivers of the task output, you add the recipient as a user-filter pairing which corresponds to a single recipient-level filter that has been applied to them in the distribution list. You cannot combine multiple recipient-level filters in the same user report, but you can add each user-filter pairing individually in the task configuration so that a separate report is generated and sent to the same user for each filter.

When a report task runs, a unique report is generated for each distinct recipient-level filter applied across all users added to the report task. A report task can generate a maximum of 100 unique reports.

You can choose to send the generated reports by email, store them to a Microsoft SharePoint folder, or both. When you deliver reports via a Microsoft SharePoint distribution folder, reports are not sent directly to recipients and a separate report is stored for each filter defined on the recipients you have included in the task. For further details, see Report generation with distribution folders.

Requirements for email delivery

To send report task output by email, toggle on the Email switch under Distribute in the dialog when you are creating the report task.

If you are sending the reports by email, an SMTP server must be configured for the Qlik Cloud tenant. For instructions on setting this up, see Configuring email support.

Requirements for storing reports in Microsoft SharePoint folders

If you need to automatically save generated reports to a folder in your Microsoft SharePoint network, toggle on the Folder switch under Distribute in the dialog when you are creating the report task.

To store the report output to a Microsoft SharePoint folder, a connection to the Office 365 Sharepoint connector must be created in the space. For more information, see Delivering tabular reports to a distribution folder.

Creating a report task

Do the following:

1. Open the Report tasks tab in the Reporting section of the Qlik Sense app.

2. Click Create report task. The report task dialog opens.

3. Enter a Title for your report task. Optionally, add a Description.

4. If you have already uploaded a template, click Add existing template and select the template. Add the report template that was created with the Qlik add-in for Microsoft Excel.

   Click Upload new if you have not already uploaded the template you want to use.

5. Click Next. The dialog moves to the Output tab.

6. Type a File name for the report output. This is the file name your recipients will see.

   Information note

   If you add any of the following text elements to the file name, they are removed from the output file names:

   • \ / < > : " ' ? *

   • ASCII control characters

   • Whitespace at the beginning and end of the file name

7. Select a Timestamp format. This is appended to the File name you entered above.

8. Under Format, select the output format for the reports. You can select either Microsoft Excel (.xlsx) or PDF.

   For information about preparing your template for PDF or printed output, see Getting started with using the Qlik add-in for Microsoft Excel.

9. Select a Filter to apply to the reports. 

   This filter applies to the entire report task, unlike filters you add to individual recipients. For more information about how task-level and recipient-level filters interact with each other, see Using filters in reports.

10. Click Next to proceed to the Distribute dialog tab.

11. Add the recipients and groups from your distribution list who will receive the report output. Note that a separate recipient must be added for each recipient-level filter you want to generate reports for. See How report generation works.

12. Click Next to proceed to the Distribute dialog tab.

13. Specify how to distribute and deliver your reports. Toggle on at least one of the following options:

    • To deliver your reports by Email, leave the Email switch on. This is the default delivery method.

    • To deliver your reports to a Microsoft SharePoint folder, toggle on the Folder switch.

    For specifics about configuring email and distribution folder options, see Requirements for email delivery and Requirements for storing reports in Microsoft SharePoint folders.

14. Click Next to proceed to the Schedule dialog tab.

15. Configure the report distribution schedule. Reports can be sent whenever data is refreshed, or on a daily, weekly, monthly, or yearly schedule.

16. Click Save.

Your report will be sent to your recipients at the scheduled time. You can also send the report task output at any time. See Manually sending reports.

Manually sending reports

You can run a report task manually when you need recipients to receive the reports immediately.

This is also helpful when you're testing your report configuration.

Do the following:

1. Open the Report tasks tab in the Reporting section of an app.

2. Click next to the report task you want to run.

3. Click Send now.

Requirements for a report task to run successfully

The report template creator creates a template based on their access to the app content. However, a report task runs based on the app access of the report task owner. Therefore, if a user creates a template based on an app sheet that is private to them, the report task cannot run successfully.

There are also requirements related to report task ownership. For more information, see Ownership of report tasks.

Editing report tasks

You can change the configuration of the report task after it has been created.

Do the following:

1. Open the Report tasks tab in the Reporting section of an app.

2. Click next to the report task.

3. Click Edit.

Deleting a report task

Do the following:

1. Open the Report tasks tab in the Reporting section of an app.

2. Click next to the report task you want to delete.

3. Click Delete.

Tenant admins can delete and manage report tasks in the Subscriptions section of the Management Console. See Managing user reports and subscriptions.

Enabling or disabling a report task

A report task can be enabled or disabled. When it is enabled, the report task generates output as per the configured schedule, and can be manually run as needed. When it is disabled, the report task cannot generate output on the schedule, but can still be manually run as needed.

You might want to enable or disable the report task manually. There are also situations in which a report task will be automatically disabled.

Do the following:

1. Open the Report tasks tab in the Reporting section of an app.

2. Click next to the report task you want to turn on or off.

3. Click Enable or Disable.

If you are a tenant admin, you can enable and disable the report task in the Subscriptions section of the Management Console. For more information, see Managing user reports and subscriptions.

Canceling a currently running report task

There might be a time when a report task is currently running but you need to cancel it. This might be when there is a server error, or when the task is taking too long.

Do the following:

1. Open the Report tasks tab in the Reporting section of an app.

2. Click next to the report task you want to cancel.

3. Click Cancel.

Section access considerations

If the app uses section access, report generation works differently. For more information, see Tabular reporting and section access.

Ownership of report tasks

When you create a report task, you become its owner. Administrators can change the owner of a report task. For more information, see Managing user reports and subscriptions. In a shared space, to transfer ownership of a report task to another user, that user needs to have Can edit permissions in the space.

Anyone with Can edit access to the space can run a report task, but if the report task owner does not have Can edit access to the space, the report task cannot run successfully. Therefore, if the user who owns a report task loses Can edit access, or is removed from the space or the tenant, either the ownership of the report task needs to change or the report task should be recreated by someone with sufficient permissions.

Keep in mind that if you change the owner of a report task for an app which uses section access, certain behaviors can be expected. For more information, see Tabular reporting and section access.

Report filters and report task ownership

Report filters also have corresponding owners. The creator of a report filter is its first owner. Changing the owner of a report task does not change the owner of any report filters used by the report task.

Permissions for report tasks

Managing the reports tasks of an app requires specific roles. The permissions requirements vary depending on the type of space in which your app is located.

Requirements for apps in shared spaces

You need Can edit access to the space to perform the following actions on a report task from within the app:

• View

• Create

• Run

• Delete

• Enable

• Disable

For more information, see Managing permissions in shared spaces.

Requirements for apps in managed spaces

Users with the Owner (Professional, Full User, or Analyzer entitlement), Can manage (Professional, Full User, or Analyzer entitlement), or Can operate (Professional or Full User entitlement only) space roles in the managed space can perform the following actions on a report task from within the app:

• View

• Create

• Run

• Delete

• Enable

• Disable

For more information, see Managing permissions in managed spaces.

Requirements for an app in your personal space

You must have the Private Analytics Content Creator user role in the tenant to view, create, edit, and delete report tasks.

Administering report tasks in the Management Console

As an administrator, you manage report tasks in the Subscriptions section of the Management Console. See Managing user reports and subscriptions.