How to Install / Update Vizlib Extensions on your Qlik Sense Desktop

This article describes how to install and update Vizlib extensions on a Qlik Sense desktop (we're using Vizlib Library as an example). If you need to install Vizlib extensions on a Qlik Sense server, you can find a full set of instructions here.

This topic contains the following sections:

Important: Before you start, check that you have a Vizlib account (sign up here) and that you're using a version of Qlik Sense which is compatible with Vizlib extensions (we only support the previous six Qlik Sense releases, full details here.

Vizlib User Portal

When you log in to the Vizlib User Portal it will open at the Products page (Figure 1), listing details relating to all your Vizlib products, including license type and subscription status.

Figure 1: Vizlib User Portal

You can find more information about the Vizlib User Portal in our Best Practice article here.

 

Download - Product

You can download a Vizlib product with one click.

  • Go to the product you want and click the Download button on the right of the panel (Figure 2) and select Online or Offline (in offline installations, the Qlik Sense Enterprise Server doesn't require an internet connection).

  • The download appears as a .zip file at the bottom of the screen, and flashes when it completes.

Note: If you're just starting to work with Vizlib, we recommend this type of download.

Figure 2: Download Product

If you've chosen the Online option, the Download link uses the Auto-update feature and automatically downloads the latest version of the package. Users with a subscription can also find a monthly bundle for the product by clicking Versions and searching the version history.

Important: We strongly recommend you avoid using Auto-update in a production environment.

 

Download - Extensions

You can also download individual Vizlib extensions in a .zip file, and choose a specific version of the extension.

Important: We strongly recommend using fixed versions of our extensions in production.

  • Open the product you want in the navigation bar to open the homepage, or click on Learn more to the left of the download link (Figure 3).

  • Click Extensions in the Information section on the right side of the screen.

  • You'll open the Extensions search screen, with all the extensions for the product listed in alphabetical order. There are 2 filters you can use to help find the extension version you want.

    • Select the year from the left hand navigation menu and scroll through the versions available.

    • Enter the extension name in the search bar at the top of the screen.

  • The example in Figure 3 shows a search filter used to download a version of Vizlib Teamwork.

  • Click Online to begin the download. If you're an Enterprise user, you can also download an Offline version. Figure 3 uses an Enterprise account for Vizlib Collaboration as an example, so there are online and offline downloads displayed.

  • The download will appear as a .zip file at the bottom of the screen and flash when it's completed.

Figure 3: Download Extensions

 

Qlik Sense Desktop

Once you've got the files you need, you can upload them to your Qlik Sense desktop. If you're updating an existing version of the extension, you'll need to remove any previous versions of the extensions which are already installed, or the import will fail. Any Climber extensions will have the extension cl-.

  • Open Qlik Sense, then extract the .zip file to the default extension folder (documents/qlik/sense/extensions).

 

Working with Vizlib Extensions

Once the extension file has been uploaded, you can start working with Vizlib extensions. When you're in Edit mode, you can find them in the Custom Objects tab (Figure 4) in Assets (the left hand settings menu).

Figure 4: Custom Objects