General
The Report Requester extension is a Qlik Sense extension that can be used to allow Qlik users to interact with Mail & Deploy to Request predefined Reports.
You need to set up HTTPS in the Server Settings and connect to the API via HTTPS in order for the extension to work. For more information, see Settings.
Section Access
The extension can be placed in Apps using Section Access if these Apps are Mail & Deploy Datasources with their Authentication Type defined to Impersonation (Section Access). For more information, see How to use Mail & Deploy Extensions with Apps that have Section Access
Alternate States
Alternate State selections are supported in version 3.4.1 and above.
Installation
The ZIP file that contains the extension is located in the SelfService\Qlik Sense sub-folder of the root installation directory.
For Mail & Deploy SaaS environments, see Where to download the Mail & Deploy Extensions for Mail & Deploy SaaS?.
Configuration
Once the extension is placed on a sheet, you can specify the following properties:
Connection
Name |
Description |
|---|---|
| API Service URL | The URL of the API Service of the Mail & Deploy instance to connect to (e.g. https://mdserver:14999/Api or https://company.mail-and-deploy.com/api). |
| Access Key | The access key to use for authentication; this needs to be the access key of a User with a role of at least API User. |
Report
Name |
Description |
|---|---|
| Configuration | Static or Dynamic. Static: the below settings will be configured using dropdowns. Dynamic: the below settings can be configured with expressions. |
| Workspace | Workspace where the Report to be requested is located. |
| Datasource | The Datasource that points to the App that the current selection will be passed to. Typically it is the App where the Extension is placed. |
| Report | The Report that should be generated. |
| File Type | The Report's Output file type. For more information about the File Types' ids when using the Static Configuration option, see How do I configure the File Type property in the Report Requester for Mail & Deploy?. |
Cycle
Name |
Description |
|---|---|
| Enable Cycle | No or Yes. No: The cycle is not enabled. Yes: The settings below can be configured. |
| Cycle Field | This field will be cycled and filtered to generate the corresponding reports, one per value of the dimesion. |
| Feed Parameter | No or Yes. No: No additional parameter will be sent to the report. Yes: The current value of the cycled field will be sent to the report in the parameter defined in the Cycle Parameter Name. |
| Cycle Parameter Name | The name of the parameter defined in the report that will receive the current value of the cycled field. |
| ZIP File Name | The name of the ZIP file that will contain the reports. The name of the file should not include the extension (.zip). |
Parameters
Name |
Description |
|---|---|
| Name | Name of the parameter that matches to a parameter defined in the Report definition. |
| Value(s) | Values to be sent to the Report's parameter. |
Distribution
Name |
Description |
|---|---|
| Distribution Type | Download or E-Mail. Download: The report will be generated and downloaded immediately. The report will be sent by email and the following properties can be set. |
| E-Mail Address(es) | The report(s) will be sent to the E-Mails specified in this property. |
| E-Mail Subject | The subject of the E-Mail. |
| E-Mail Body | The body of the E-Mail. |
Appearance
Name |
Description |
|---|---|
| Button Background Color | An expression to set the color of the button's background. |
| Button Text Color | An expression to set the button's text color. |
| Icon | An expression to set the button's icon, for more information, see How do I configure the Icon property in the Report Requester for Mail & Deploy?. |
| Font Size (px) | Set the button's text to this font size. |
| Tooltip | An expression to set the button's tooltip. |
Localization
Name |
Description |
|---|---|
| Button Caption | An expression to set the button's caption. |
| Processing Button Caption | An expression to set the processing message. |
| Success Title | An expression to set the title of the message box that is displayed when the report has been successfully requested. |
| Success Message | An expression to set the content of the message box that is displayed when the report has been successfully requested. |
Conditions
Name |
Description |
|---|---|
| Show Condition | Condition to show/hide the button. The button will be showed if the condition is true or if this property is empty. |
| Usage Condition | Condition to request a report. If the condition is not met, the following message box will be displayed. If this property is empty, the button will always request the report. Use this condition to be sure the user will request a reasonable size report, for instance, GetSelectedCount(SalesRep)<20. |
| Usage Condition Title | Title of the message box displayed if the usage condition is not met. |
| Usage Condition Message | Content of the message box displayed if the usage condition is not met. |
Layout
Name |
Description |
|---|---|
| Apply Custom Layouts | Valid only for Mail & Deploy on-prem environments: the report will be generated considering -when technically possible- the changes in the charts done by the user, for example, changing the top/left dimensions of a pivot table. |
Options
Name |
Description |
|---|---|
| Apply Current Selections | Check or Not checked. Check: The current Selections will be applied to the Database specified in the property Report > Datasource. Not checked: The current selection will not be passed to Mail & Deploy. |
| Variable Values | Apply All, Apply None, Apply Selected. Apply All: All the variables present in the App will be sent to Mail & Deploy and re-applied. Apply None: No variables will be sent to Mail & Deploy. Apply Selected: Only the variables specified in the property Variables will be sent to Mail & Deploy. The syntax to specify the Variables is ='variable1;variable2;...' |
Send to Mail & Deploy only the variables that can change interactively, for example, using an input box, as sending and processing them can take quite some time, specially for those Apps having many variables.
By default, the extension will use the Apply All setting.