General
The Task Executor extension is a Qlik Sense extension that can be used to allow Qlik users to interact with Mail & Deploy to start predefined Tasks.
NOTE
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.
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. |
Task
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. |
| Task | The name of the task that should start when pressing the button. |
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 Task's parameter. |
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. |
| Success Title | An expression to set the title of the message box that is displayed when the task has been successfully requested. |
| Success Message | An expression to set the content of the message box that is displayed when the task 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 start a task. If the condition is not met, the following message box will be displayed. If this property is empty, the button will always request the task. Use this condition to be sure the user will request a reasonable size task, 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. |