Vizlib Actions

Piers Batchelor

Modified on: Wed, 7 Jul, 2021 at 2:23 PM

Vizlib Actions are featured across a number of Vizlib extensions listed here. They provide a number of ways to create and link shortcuts across your apps, improving your user experience.

TABLE OF CONTENTS

Example

Figure 1 shows an example of Vizlib Actions being used with Vizlib Button. The action used here is Open URL, which integrates with the Button Item YouTube, adding a link to open the Vizlib YouTube channel when the button is pressed.

Figure 1: Vizlib Button Actions Example

Back to Contents

Working with Actions

When you start working with actions, there are a few things to remember.
You add and edit actions in the property panel.
You can add more than one action within a sheet.
Actions are executed in the order they're listed in the property panel (top to bottom).
Actions can also have specific properties related to the extension, we've listed them here.

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

Vizlib Sheet Menu - Actions can be set before OR after navigating to the next sheet.

Back to Contents

API Integration

API Integration allows you to complete GET/POST/PUT instructions for REST API endpoints. Documentation can be found here.

Back to Contents

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 2). 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 2: Selection in Field

Expressions can be used, if the resulting strings are dynamic, e.g. variables or expressions that change the output of the result.

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], ‘|’) & ‘)’

Back to Contents

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.

Back to Contents

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.

Back to Contents

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.

Back to Contents

Forward

This actions simulates the effect of clicking the forward button in the selection panel.

Back to Contents

Back

This actions simulates the effect of clicking the back button in the selection panel.

Back to Contents

Lock Field

Locking a field will lock the existing selections and block future selections until the field is cleared.

Back to Contents

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.

Back to Contents

Lock All Selected

This locks all selected fields, allowing you to drill down with the same set of selections.

Back to Contents

Unlock Field

This action unlocks a locked field.

Back to Contents

Unlock All

This action will unlock all fields. Selections can be made again when fields are unlocked.

Back to Contents

Unlock All Selected

Unlocks all fields that currently have selections applied.

Back to Contents

Unlock and Clear All

Allows a single field to be unlocked and cleared.

Back to Contents

Clear All

Clears all selections on all unlocked fields in the application.

Back to Contents

Clear Field

Clears selections of a given field (Figure 3).

Figure 3: Clear Field

Back to Contents

Activate Next Sheet

Activates the next ordered sheet (if any).

Back to Contents

Activate Sheet

Activates a sheet selected from a dropdown or chosen by the sheet ID (used only for sheets inside your Qlik Sense environment).

Back to Contents

Activate Previous Sheet

Activates the previous ordered sheet (if any).

Back to Contents

Apply Bookmark

Applies a chosen bookmark.

Back to Contents

Create Bookmark

Creates a bookmark based on the current selection and current state.

Back to Contents

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.

Back to Contents

Set Variable

This action can be used to set a variable (Figure 4). 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 4: Set Variable

Back to Contents

Reload App

The reload app action (Figure 5) 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 5: Reload App

Back to Contents

Open Story

Directly link to a story in Qlik Sense.

Back to Contents

Export Object... (Vizlib Button Only)

Export objects to Data, PDF or images. This is the easiest way to access export functionality in mashups. Note: This action only works with Master Items.

Back to Contents

Export Data

Export Data (Figure 6) 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.

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 6: Export Data

Back to Contents

Sleep

Sleep (Figure 7) is an action which sets a time delay in the execution of the next action. The time interval is set in milliseconds.

Figure 7: Sleep

Back to Contents

Prompt

Prompt (Figure 8) 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 8: Prompt

Back to Contents

Open Qlik App

Open Qlik App (Figure 9) 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 9: Open Qlik App

Back to Contents