Subscriptions
  • 23 Aug 2024
  • 3 Minutes to read
  • Dark
    Light

Subscriptions

  • Dark
    Light

Article summary

General

Subscriptions can be used to distribute report documents to a User on a regular basis.

NOTE

You can achieve the same functionality using Tasks. Subscriptions, however, are simpler to set up and can optionally be managed by Users themselves through the Hub or the Qlik Sense Extension.

Managing Subscriptions

Subscriptions can be managed in the following ways:

Subscribing to a Report

This type of subscription can be used to subscribe to a Report. The following properties are available:

Name

Description
NameThe name of the subscription.
UserThe User to which the created report document will be distributed.
ReportThe Report from which the report document shall be created.
File TypeThe file type in which the report document shall be created. The available file types depend on the Report from which the report document shall be created.
Parameter ValuesA list of parameter values you can supply to the report Parameters. Parameter values can only be supplied if the report has at least one parameter.
Add To LibraryWhen enabled, the created report document will be added to the Library of the User.
Send By E-MailWhen enabled, the created report document will be sent to the e-mail address of the User. This property is only available if the user has an e-mail address.
File Type SettingsSome file types support File Type Settings (e.g. a password with which to protect the report document if it is created as Adobe PDF Document) which can be specified.
Execution PlanThe Execution Plan that determines how often the subscription will create a report document.

Subscribing to a Datasource Object

This type of subscription can be used to subscribe to a single Datasource
object.

Example: In this case the report document will be created from a single Datasource
object, such as a bar chart, a pivot table, or any other supported visualization.

The following properties are available:

Name

Description
NameThe name of the subscription.
UserThe User to which the created report document will be distributed.
Datasource ObjectThe Datasource object (e.g. a bar chart or other visualization) from which the report document shall be created.
Document TitleAn Expression that needs to return a string that contains the title to assign to the created report document. The document title is displayed in the Hub Library.
File TypeThe file type in which the report document shall be created. The available file types depend on the Datasource object from which the report document shall be created.
Export As TableIf you select this option, the actual data behind the visualization will be contained in the report document rather than the graphical representation; in that case, not all file types are available.
Page SizeThe page size with which the report document shall be created; this property is only applicable for file types that support page layouting (e.g. Microsoft Word Documents).
Page OrientationThe page orientation with which the report document shall be created; this property is only applicable for file types that support page layouting (e.g. Microsoft Word Documents).
File Type SettingsSome file types support File Type Settings (e.g. a password with which to protect the report document if it is created as Adobe PDF Document) which can be specified.
FiltersAn optional list of one or more filters that will be applied before the report document is created. Every filter has a Field property that contains the Datasource field to be filtered and one or more Values to which the filter shall be set. If a filter value starts with an equals sign (=) you can use an expression native to the type of Datasource from which the object is extracted (e.g. if you extract an object from a Qlik Sense Datasource , you can use the filter value =year(today()) to filter to the current year).
Execution PlanThe Execution Plan that determines how often the subscription will create a report document.

Was this article helpful?

What's Next