General
The Visualization Exporter extension is a Qlik Sense extension that can be used to allow Qlik users to interact with Mail & Deploy to Export to different file types a specific App object.
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.
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. |
Datasource
Name |
Description |
|---|---|
| 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. |
Visualizations
Name |
Description |
|---|---|
| Exportable Visualizations | All Visualizations, Only Specified Objects IDs or Exclude Specified Objects IDs. All Visualizations: All the objects in the sheet will be displayed in the dropdown making it possible to export all objects. Only Specified Objects IDs: Only the specified objects will be displayed in the dropdown. Exclude Specified Objects IDs: All but the specified objects will be displayed in the dropdown. The IDs to use are the Qlik Sense object IDs. For more information, see How to identify an object in a Qlik Sense app by object id. The syntax to specify the IDs is ='objectid1;objectid2' |
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. |
Mashup
Name |
Description |
|---|---|
| Object ID Attibute | When placing this extension in a mashup, contact support@mail-and-deploy.com to help you find the required ID. |
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. |
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 export has been successfully requested. |
| Success Message | An expression to set the content of the message box that is displayed when the export has been successfully requested. |
| Export Window Title | Title of the window displaying all the possible objects to export and the additional settings. |
| 'Export Table' | The text to be displayed for the instruction 'Export Table', for example, ='Exportar Tabla'. |
| 'Export Graphic' | The text to be displayed for the instruction 'Export Graphic', for example, ='Exportar Gráfico'. |
| Page Orientation 'Landscape' | The text to be displayed to indicate Landscape, for example, ='Horizontal'. |
| Page Orientation 'Portrait' | The text to be displayed to indicate Portrait, for example, ='Vertical' |
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 export an object. If the condition is not met, the following message box will be displayed. If this property is empty, the button will always export objects. Use this condition to be sure the user will request a reasonable size export, 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 object will be exported 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.