Vizlib Actions are featured across a number of Vizlib products (please see the full list here). These provide a number of ways to enhance a Qlik Sense application and create and link shortcuts across your apps. These can be used to seamlessly enhance making selections in Vizlib Filter and Vizlib Table, or create custom buttons with Vizlib Advanced Text Object or Vizlib KPI Designer to improve the user experience.
- in Vizlib Table, inputs/values for actions are now evaluated at row level (this means the same result applies to all rows), see version 3.6.0 for more detail
- in Vizlib Sheet Menu, actions can be set before OR after navigating to the next sheet
TABLE OF CONTENTS
- API Integration
- Selection in Field
- Select Excluded
- Select Possible
- Select Alternative
- Forward
- Back
- Lock Field
- Lock All
- Lock All Selected
- Unlock Field
- Unlock All
- Unlock All Selected
- Unlock and Clear All
- Clear All
- Clear Field
- Activate Next Sheet
- Activate Sheet
- Activate Previous Sheet
- Apply Bookmark
- Create Bookmark
- Open URL
- Set Variable
- Reload App
- Open Story
- Export Object... (only in Vizlib Button)
- Export Data
- Sleep
- Prompt
- Open Qlik App
API Integration
API Integration allows you to complete GET/POST/PUT instructions for REST API endpoints. Documentation can be found here.
Selection in Field
This action enables users to select single or multiple values within a field. There are two inputs required, the field name, and the values.
Field names FOR ALL types should be specified as a string result. Expressions can be used but the result is only a string (Figure 1). If you are using a string, then do not wrap it in quotes or use an expression for a single string (the following characters must not be used any equals sign, quotes or square brackets: = " " ' ' [] ).
Figure 1: String Example
Expressions can be used, if the resulting strings are dynamic, e.g. variables or expressions that change the output of the result. Note: that the field "Alpha" does not contain square brackets.
Figure 2: Expression Example
Further selection examples are listed here:
- Selecting a single value - A single value can be specified as a string, which can be delivered as a hard coded string, or a resultant string derived from a variable.
- Selecting multiple values - To select multiple values, Qlik sense search strings are supported here. A common format example for selecting multiple values would be: (London|Berlin|Barcelona).
- Important note: multiple values with spaces need to have the following formatting: '("United Kingdom"|"South Korea")'
- Dynamically selecting multiple values:If we want to dynamically select cities that are in Europe, we can do the following: ‘(‘ & Concat(distinct {<Continent={‘Europe’}>} [City], ‘|’) & ‘)’
Select Excluded
This action selects all values in the desired field, that have been excluded from the current selection. The values that are dark grey will be selected. This may deselect selections applied to other fields.
Select Possible
This action selects all values in the desired field, that are able to be selected within the current selection. The values that are white will be selected.
Select Alternative
This action selects all values in the desired field, that are alternatively available from the current selection. The values that are light grey will be selected. This won’t affect deselect selections applied to other fields.
Forward
This actions simulates the effect of clicking the forward button in the selection panel.
Back
This actions simulates the effect of clicking the back button in the selection panel.
Lock Field
Locking a field will lock the existing selections and block future selections until the field is cleared.
Lock All
This action will lock all fields. No selections can be made when fields are locked. No more accidental selections when in this mode.
Lock All Selected
This locks all selected fields, allowing you to drill down with the same set of selections.
Unlock Field
This action unlocks a locked field.
Unlock All
This action will unlock all fields. Selections can be made again when fields are unlocked.
Unlock All Selected
Unlocks all fields that currently have selections applied.
Unlock and Clear All
Allows a single field to be unlocked and cleared.
Clear All
Clears all selections on all unlocked fields in the application.
Clear Field
Clears selections of a given field.
Activate Next Sheet
Activates the next ordered sheet (if any).
Activate Sheet
Activates a sheet selected from a dropdown or chosen by the sheet ID (used only for sheets inside your Qlik Sense environment).
Activate Previous Sheet
Activates the previous ordered sheet (if any).
Apply Bookmark
Applies a chosen bookmark.
Create Bookmark
Creates a bookmark based on the current selection and current state.
Open URL
Opens a URL (the link must contain the protocol identified e.g. https://, http://, ftp://, sftp://). This must be used to link to any resources outside your Qlik Sense environment.
Set Variable
This action can be used to set variable. Please note that the requirements are similar to select in field etc, a simple string should be entered, or an expression that results in a string, the image below demonstrates use of a simple string to specify both the variable name and value.
Figure 3: Set Variable
Reload App
The reload app action allows a user to trigger a reload (or a partial reload). This is only possible if the user has a security rule linked that allows them to use the reload app ability. Qlik Sense does not provide user feedback on reload progress, it is recommended that this is used with a fast reload, ideally QVD based (to ensure that user’s of your Qlik Sense app are not kept waiting).
Figure 4: Reload App
Open Story
Directly link to a story in Qlik Sense.
Export Object... (only in Vizlib Button)
Export objects to Data, PDF or images. This is the easiest way to access export functionality in mashups. Works only with Master Items
Export Data
Export data offers a unique export option that can be driven entirely by a user, when implemented correctly, without the need for developer input. This opens up further opportunities of self-service reporting and data retrieval using Qlik Sense alone - no need to raise a ticket, simply dive in.
Export Data is available with the Vizlib Advanced Text Object, and will be rolled out to the KPI, Table & rest of the library very soon. Dimensions & Measure sets can also be defined via dynamic variables - most performant and user-friendly way to export data in Qlik Sense. Supports mashups!
Figure 5: Export Data
Sleep
Sleep is an action which sets a time delay in the execution of the next action. The time interval is set in milliseconds.
Figure 6: Sleep
Prompt
Prompt is used to set properties for instructions contained in a popup. You can choose the popup type (Info, Error, Success), and set the popup title and description.
Figure 7: Prompt
Open Qlik App
Open Qlik App is used to manage properties for opening another Qlik Sense app. You simply select the app from the Open Qlik App dropdown, select the sheet you want to open from Open Sheet, then enable Pass Selections To Target App if you'd like to transfer your current set of selections to when the app opens.
Figure 8: Open Qlik App