Vizlib Server is the back-end solution for anyone using the on-premise (Enterprise) versions of Vizlib Collaboration and Vizlib Finance Report. This guide contains all the technical information you'll need to get ready for the installation, and we've included a checklist which you can work through to make sure you've got everything to install Vizlib Server.
TABLE OF CONTENTS
- Vizlib Server Installation Prerequisites - Setup Guide
- Architecture
- Checklist
- Installation - Qlik Sense Node
- Installation - Stand-Alone Server
- SSL Certificates
- Next Steps - Installation
Vizlib Server Installation Prerequisites - Setup Guide
This article forms part of the Vizlib Server setup guide - three separate documents designed to be used together, but also consulted individually. The Installation Prerequisites (this article) contains technical advice and a checklist to prepare for an installation, the Installation document guides you through the steps for installations or updates, and the Configuration reference has instructions for completing the setup.
Architecture
If you're looking to use Vizlib Server with Vizlib Collaboration extensions, there are several possible architectural models, you can check which one best fits your requirements here.
Checklist
Before you start the installation, make sure you have all the information and permissions you need. Work through all the items in this checklist and then you'll be ready to start.
- Minimum system requirements:
- OS: Windows Server x64 (2022, 2019, 2016, 2012 R2)
- CPU: 4 core Processor
- RAM: 8GB RAM
- Storage: 1GB of free space.
- Check your install environment meets the specification and you have all the required user permissions to run the install. You will need a Vizlib Server license for each install environment (e.g. installing on a development environment and a live environment will require 2 licenses).
- Use the Qlik Management Console (QMC) to check your Qlik Sense environment for any trial or online versions of Vizlib Collaboration or Vizlib Finance, and remove them.
- Install the version of Vizlib Collaboration or Vizlib Finance you are going to use. You can find instructions and a video tutorial on installing Vizlib extensions here.
The installation has several steps where you'll be asked to enter data values. We've listed them here for you to create (or confirm) and note down to get ready for the installation.
- Username and Password to create an administrator account for the Vizlib Management Console (VMC) - the VMC is the administrative portal used by Enterprise customers.
Note on VMC: Your VMC administrator username and password can't be recovered. If they're lost or forgotten you'll need to re-start the installation, so we advise keeping a note of them.
- Database password and port: You can either choose to create a new instance of PostgreSQL Server with the username Postgres during the installation, or use an existing PostgreSQL instance.
Note on Database User Credentials: You can use the database username and password to connect manually to the database using query tools. - Database version: Vizlib Server is currently shipped with Postgres 14.1.1 (versions prior to v.4.0.0 of Vizlib Server used version 13 of Postgres), so we recommend using version 14.1.1 when using an external Postgres DB. Version 11 and above are supported.
- Server host name and port number: The machine and port where the installation will run.
- SSL certificate: Confirm the certificate type, directory path and password (if it's required).
- URL: The URL on the certificate must match the Qlik Sense access URL for users.
Note on Certificate URL: If the access URL is https://qlik-sense.my-company.com then the certificate must be issued for a matching URL e.g. qlik-sense.my-company.com, *.my-company.com. If the certificate URL is issued to a different URL or the certificate is self-signed and users decline to accept it, Vizlib Server will be unable to connect to any extensions.
Note on Certificate Types: If you don’t have a valid certificate during installation but want to complete the process, then you can switch to the PEM certificate. By default, the installer will pick Qlik Sense self-signed local certificates. You will be able to verify the extension, but will only be able to connect from the machine where Vizlib Server is installed.
Note on HTTP: Vizlib Server can be installed using HTTP, but we do not advise using this option for production environments. It compromises the security of your Qlik Sense data by allowing HTTP traffic, leaving you vulnerable to security breaches.
- Product License: A valid license key for Vizlib Collaboration or Vizlib Finance needs to be entered to complete the installation. You can copy the key from the user portal before the installation and store it, or use the link on the license screen.
Installation - Qlik Sense Node
These are the technical specifications for installing Vizlib Server on single and multi-node Qlik Sense environments.
- Recommended Qlik Sense server: Central QS node.
- Ports: 2 ports need to be left open on your environment for the installation - one for the postgres database (default port 1982) and one open for communication between end user connection locations and the target server (default 1980). Note: The port numbers listed here are the defaults, other ports can be substituted during the installation.
- Firewall: Port 1980 needs to be open.
- Qlik Sense and Qlik Management Console (QMC): setup of SSL browser certificate thumbprint required.
- SSL: Qlik Sense SSL Certificate to be stored in PFX format on a drive accessible to the server. For password-protected PFX files, the password will be required for the installation (see SSL Certificates below for more information). Note: Multi-node Qlik Sense environments will require a separate set of SSL certificates for each node.
- User: Windows Server / Qlik Sense account(s) with administrative privileges.
- Permissions: Write to C: drive on target server.
- Multi Node environments need to be configured with a Virtual Proxy. Full instructions are in Configuration guide here.
- PM2 cannot be used by another process on the server.
Installation - Stand-Alone Server
These are the technical specifications for installing Vizlib Server on a stand-alone server.
- Ports: 443 and 1982 (postgres database) to be unused.
- Qlik Sense Server ports: 443, 4243, 4242, 4747 to be accessible on the target server.
- DNS: Certificate issued for DNS to be used by Vizlib Server.
Domain and URL: Vizlib Server to share domain or be subdomain of DNS used client Qlik Sense connection e.g. vizlibserver.YOURDOMAIN.com (see SSL Certificates below for more information).
- Virtual Proxy to be set up according to instructions in Configuration guide here.
- User: Windows Server / Qlik Sense account(s) with administrative privileges.
- Permissions: Write to C: drive on target server.
- PM2 cannot be used by another process on the server.
SSL Certificates
SSL Certificates are used to encrypt user communication with Vizlib Server. We recommend these options for issuing certificates.
- A third party certificate authority like DigiCert, COMODO, or GoDaddy.
- Your own CA server. Contact your IT department for support on completing this request.
Supported file formats for Vizlib Server are PFX (without or with password) or PEM. The private key must be included with the certificate when exporting it from the Windows certificate store.
The certificate files should be saved to a location which can be reached from Vizlib Server.
It's possible to setup Vizlib Server without a third party issued certificate by allowing traffic via HTTP (which carries a security risk) or using exported certificates from a Qlik Sense node. Both of these options are outlined in the Configuration guide here.
Next Steps - Installation
Once you've worked through all of the items in the Checklist, you're ready to install Vizlib Server. You can find the installation guide here.