Vizlib Server is used as the back-end solution for Vizlib Collaboration and Vizlib Finance Report for anyone using the on-premise (Enterprise) versions of those extensions. For full functionality a license for both products is needed but the same installation is made for both extensions.
If you'd like to see what to expect when you install Vizlib Server, we've created a video tutorial which takes you through it step by step.
Note: This document and the tutorial use Vizlib Server version 1.7.1 as an example, but the installation instructions are valid for all versions of Vizlib Server currently available on the Vizlib Portal (Version 1.3.0 and above).
Please make sure to check our prerequisites document before you proceed with the installation.
Import the Collaboration or Finance Report Extension from the ZIP folder in the QMC. In case you already had either the Trial or Online Extensions, then remove it first. You may want to keep a copy of it as a backup.
Download the Vizlib Server Installation file from the Downloads section of the User Portal, then upload to the target server.
Run Vizlib Server Installer with admin credentials on the target server.
Read and accept the Terms & Conditions and click Next.
Set up a new username and password for the Vizlib Management Console (VMC) admin account. That account will be used later to access the VMC - an administrative portal to configure and manage the Vizlib Server. Click Next.
Please don't forget to note down your username & password at this step as there is no way to recover it later on, and a re-installation will be required if it's lost.
Specify the port and define a new password for the database user ‘postgres’ which will be created in a new instance of PostgreSQL Server during the installation. You can use this information later to manually connect to the database to query commentary tables using tools like PG Admin.
Provide the fully qualified name of the machine where Vizlib Server is installed and the port which the server will run on. Provide the path to the PFX certificate file which will serve the Vizlib Server.
IMPORTANT! The certificate has to be issued for the URL used by your end-users. E.g. if your end-users access QlikSense by typing the following URL in their browser → https://qlik-sense.my-company.com, then the certificate has to be issued for qlik-sense.my-company.com, *.my-company.com or similar. If the certificate has been issued to a different URL or it is a self-signed certificate and end-users browsers won’t accept it, then the extension will refuse to connect to Vizlib Server due to security concerns. If you don’t have a valid certificate during installation but want to continue, then you can switch to the PEM certificate. By default, the installer will pick qlik-sense self-signed local certificates. That will allow you to verify the extension, but it will only allow you to establish a connection from the machine where the server is installed! Another option is to serve Vizlib Server over HTTP, but we strongly advise against this option. In addition, you would have to allow HTTP traffic in your QlikSense which is insecure - don’t do this unless you’re aware of and accept all consequences of doing so. Once you’ve made your decision, click Next.
Click Install to start the installation. The installation should take approximately a minute or two.
Once the installation has completed, click Finish to close the installer. Your browser will automatically launch with the VMC, with either one of the following URLs https://localhost:1980/vmc or http://localhost:1980/vmc depending on your previous selections (assuming you used the default port value). Hint - after installation, windows shortcuts are created in your windows to open VMC on both HTTP and HTTPS, so you may want to use the shortcuts instead of writing down those URLs for later use. In case you encounter any issue opening the VMC after installation, below see below overview for troubleshooting:
Troubleshooting Guidelines Known issue Very rarely, Vizlib Server Windows Service gets created but is not automatically started. If you encounter issues with opening the VMC, double-check if the Vizlib Server is running using the Task Manager. If not, start it manually. Known issue Occasionally, for slower servers, the browser is opened before Vizlib Server is fully initialized and the page is not loaded properly. If that happens, wait another minute and simply refresh the page. Known issue If you specified the PFX certificate which is password-protected, and then provided the wrong password, the page won’t be loaded properly over the https protocol. Instead, Vizlib Server will fall back to the HTTP protocol. Try to open http://localhost:1980/vmc instead. In order to check what caused the fallback, go to the Logs Browser tab and filter error logs (but first activate the product per the following steps).
Log in to VMC by using the credentials defined during installation.
Activate your license - you’ll be automatically asked to do so when you initially log in. License can be obtained from the Collaboration download section or the Finance Report download section of the Vizlib user portal. Click on Copy to clipboard below license key.
Verify connectivity with the QPS and QRS by using VMC. Open the VMC Dashboard section and verify that inside the Qlik Sense section, you can see green check icons next to the QRS and QPS.
Set up the Extension connectivity to the server. In VMC, navigate to System Settings\Server. By default the extension will use URL set in field Extension Server URL. If your fully qualified name is not accessible by your end users (e.g. because you use reverse proxy) you may need to update its value. In order for the changes to take effect, you’ll need to restart your server.
At this point, the basic setup should be complete. You can go to QlikSense and add Vizlib Collaboration or Finance Report to one of your sheets and start using it! If you encounter any issues, please check our troubleshooting section.
To update your Extension and/or Extension Server
Download new installer
Download new extension
Upload new extension to QMC
Run Vizlib Server installer and just keep on going until the upgrade starts.
Once finished, verify that it's working.
In case of any issues with step 4 -> Instead of running the new installation, uninstall the previous version first (but choose to keep database option when prompted). Once uninstallation completes, run the new installer and proceed with steps.
Once your installation is complete, please make the following checks to minimize the risk of any connection errors being thrown.
- Verify that Vizlib Server is installed and that the Windows service is running.
- Verify that you can log into the VMC on the server where you installed Vizlib Server.
- Verify the URL by the extension matches the name of the server where Vizlib Server is installed.
- Check the browser console output for any further information if an error occurs when connecting to Vizlib Server (e.g. invalid certificate, or certificate date invalid).