Prerequisites for the Vizlib Server
Before you begin the installation of Vizlib Server, please review the prerequisites below and verify that the points are fulfilled for the target environment.
Installation on a Qlik Sense Node
Target server needs to be x64 Windows Server Machine (2019, 2016, 2012 R2 & R1, 2008 R2)
Recommended server is the Central QS node
Ports 1980 and 1982 (postgres db) need to be unused on target server
Port 1980 needs to be open (in firewall) for communication from where the end users connect to the server
Qlik Sense (QMC) needs to be set up with SSL browser certificate thumbprint
The certificate used in Qlik Sense needs to be stored on a drive accessible to the server in PFX file format. If the PFX file is protected with a password the password needs to be available during installation
Read more about Certificates here
Account with administrative privileges
Permission to write to C drive
Multi Node environments need to have the Virtual Proxy setup according to Virtual proxy and Session Cookie Domain
PM2 can not be used by another process on the server
Installation on a dedicated stand-alone server
Target server needs to be x64 Windows Server Machine (2019, 2016, 2012 R2 & R1, 2008 R2)
Ports 443 and 1982 (postgres db) needs to be unused on target server
Qlik Sense Servers have to be accessible from the dedicated server on ports 443, 4243, 4242
Certificate issued for DNS to be used by the Vizlib Server
Needs to share the domain or be a subdomain of the DNS used by the clients to connect to Qlik Sense. E.g. vizlibserver.YOURDOMAIN.com
Read more about Certificates here
Virtual Proxy setup according to Virtual proxy and Session Cookie Domain
Account with administrative privileges
Permission to write to C drive
PM2 can not be used by another process on the server
Virtual Proxy and Session Cookie Domain
Vizlib Server uses the Qlik Sense Session to validate the authenticated user with the Qlik Proxy Service. By default the session cookie is valid only for the machine that the proxy is installed on.
If Vizlib Server is installed on the Central QS Node in a Single node environment, then the cookies will be shared between Qlik Sense and Vizlib Server with default Virtual Proxy configuration, because they will share the fully qualified domain name (FQDN).
If Vizlib Server is installed on a stand-alone server the default Virtual Proxy will not be able to share cookies with Vizlib Server. Make sure that these criteria are fulfilled if you use a stand-alone server for Vizlib Server:
User should connect to Qlik Sense with a Virtual Proxy that is not the default
Dedicated server FQDN is on the same domain or subdomain that the Virtual Proxy Qlik Sense uses
Virtual Proxy property Session cookie domain needs to be set to the same domain in the URL that the users use to connect to Qlik Sense. E.g. YOURDOMAIN.com if the user uses qliksense.YOURDOMAIN.com and Vizlib Server is installed on machine vizlibserver.YOURDOMAIN.com.
Certificates
Certificates are used to SSL encrypt the communication with Vizlib Server. Use a certificate issued by a third party certificate authority, or from your own CA server (ask an IT technician at your company for help, they know what to do). Here are links to some recommended third party certificate authorities that sell certificates
Supported certificate files are:
PFX, without or with password
PEM
Important: When exporting certificate from the windows certificate store, private key has to be included.
Workaround without third party certificates
If you don’t want to use or don’t have access to a proper certificate, choose one of these options:
Allow HTTP in the Qlik Sense Proxy and HTTPS disabled in Vizlib Server
Users need to connect over HTTP protocol e.g. http://qliksense.YOURDOMAIN.com/hub
| NOTE! This is not recommended in production because the communication will be unencrypted between Qlik Sense and the user. Only use in test environments or with non-sensitive data. |
HTTPS disabled in Vizlib Server Management Console
Use exported certificates from Qlik Sense Node
This option will only work when Vizlib Server is installed on a Qlik Sense Node server. User will only be able to use Vizlib Collaboration and Finance Report if they RDP to the server to establish a secure connection in the browser. The exported PEM files are located at:
C:\ProgramData\Qlik\Sense\Repository\Exported Certificate
This path should be added to the Key file path, Cert file path and Ca file path fields.
Vizlib Server configured with Qlik Sense exported certificates