Upgrading and migrating QlikView Server

When you upgrade QlikView Server, you can either upgrade on the same server, or you can upgrade and migrate to a different server. This topic outlines the steps you need to follow to upgrade to a newer version of QlikView Server, and includes the steps for migrating your installation, including certificates, to another server with a different machine name.

This documentation describes how to upgrade and migrate an installation running QlikView Server 12.00 or later. If your installation runs QlikView Server 11.20 or an earlier version, see: Upgrading and migrating QlikView Server from 11.20 to November 2017 or later. For a description of how to upgrade QlikView Desktop, see: Upgrading and Updating QlikView Desktop.

Best practices

For a successful upgrade of QlikView, take the following basic practices into account:

  • Ensure that you have created an appropriate backup of your QlikView Server installation. For a detailed list of the files and folders to backup, see Backup and upgrade preparation.
  • Perform the upgrade during a scheduled downtime. All QlikView services must be stopped for the upgrade to be successful.
  • Licensing information and settings are saved by default when QlikView Server is removed. They are applied to any subsequent installation of QlikView Server on the system.
  • Ensure that you have a valid maintenance contract before upgrading your QlikView Server installation. Attempting to upgrade without a valid maintenance contract will result in limited functionality of QlikView Server. See: Maintenance contract on upgrade.

  • If Digital Certificate Authentication is used for communication between QlikView services, the new certificates created during the upgrade must be installed on all machines, except for the machine running the QlikView Management Service (QMS). See: Updating certificates.

Upgrading on the same machine

To upgrade QlikView Server on the same machine:

  1. Create a backup of your QlikView Server installation. It is always important to create a backup of your installation, however this step is not an essential if you are upgrading on the same machine. See Backup and upgrade preparation.
  2. If your installation uses digital certificates for authentication, create a backup of the certificates. Certificates are updated automatically when you upgrade a QlikView Server installation on the same machine. However, we recommend that you create a backup of your certificates anyway. See: Backing up and restoring certificates.
  3. Download the latest version of QlikView Server from www.qlik.com.

  4. Stop the QlikView services. During the upgrade process all the services are stopped and restarted automatically, but we still recommend that you stop all services before upgrading. To avoid interrupting running tasks, shut down only the QlikView Distribution Service (QDS) by performing a graceful shutdown right before the upgrade procedure. For more information on graceful shutdown, see: Shutting down a QlikView Distribution Service.
  5. Run the installation program as an administrator, and follow the on screen instructions. For a step-by-step description of the install procedure, see: Installing QlikView Server.

  6. During the installation, select a service authentication method. Choose either Use digital certificates or Use QlikView Administrators Group. If you previously used digital certificates then you should also choose this option when you upgrade.
  7. Restart your machine once the installation process has finished to ensure that all services start up correctly.
  8. Open QlikView Management Console and apply your license information for QlikView Server, and QlikView Publisher.
  9. Restart the server to apply the license information.

Upgrading on a multi-server deployment

To upgrade a multi-server installation:

  1. Stop all services on each machine before you perform the upgrade.
  2. If your installation uses digital certificates for authentication, create a backup of the certificates stored on the machine running the QlikView Management Service. Certificates are updated automatically when you upgrade QlikView Server on the same machine. However, we recommend that you create a backup of your certificates anyway. See: Backing up and restoring certificates.
  3. Perform the upgrade procedure on each machine of the multi-server setup.
  4. If digital certificates are used, install the new certificates on all machines running QlikView services except for the machine running the QlikView Management Service (QMS). For a detailed description of this procedure, see: Updating certificates.

Maximize Uptime

This procedure requires more planning, but the system uptime for end users is maximized.

Proceed as follows to perform the upgrade:

  1. Perform a backup. See: Backup and upgrade preparation.
  2. Stop the QlikView Management Service (QMS). Doing so, the QlikView Management Console becomes unavailable.
  3. Upgrade in the following order (let the installer restart the services):
    1. QlikView Web Server (QVWS)
    2. Directory Service Connector (DSC)
    3. QlikView Server (QVS)
    4. QlikView Distribution Service (QDS)
    5. QlikView Management Service (QMS)
  4. Start the QMS, so that the QlikView Management Console becomes available again.

Upgrading to a different machine

To make the migration of your QlikView Server installation to a new machine easier, upgrade to the latest version on your current machine first, and then migrate your content to the target machine. For a summary of the steps necessary for upgrading and migrating a multi-server deployment, see: Upgrading and migrating a multi-server deployment.

Upgrade the current machine

To upgrade your current machine to the latest version of QlikView Server, follow the procedure listed in Upgrading on the same machine.

Install QlikView Server on the target machine

  1. Download the latest version of QlikView Server from www.qlik.com.
  2. Launch the QlikView Server install wizard, and follow the on screen instructions. For a step-by-step description of the installation procedure, see: Installing QlikView Server.
  3. During the installation, select a service authentication method. Choose either Use digital certificates or Use QlikView Administrators Group. Make sure to select Use digital certificates if the installation on your current machine uses certificates as the authentication method.
  4. Restart your machine once the installation process has finished to ensure that all services start up correctly.
  5. Open the QlikView Management Console and apply your license information for QlikView Server, and QlikView Publisher.
  6. Note: As a QlikView Server license is applicable to only one installation at a time, shut down the installation on the current machine before applying your license information to the new installation on you target machine.

Migrate and restore your QlikView Server backup

Once you have installed the latest version of QlikView Server on both your current and target machines, you can proceed to migrate the content of your installation from the current machine and restore it on the target machine. The procedure varies depending on whether your installation uses QlikView Administrators Group or digital certificates as the authentication method.

Before starting the migration procedure, make sure to create a backup of your current QlikView Server installation. Without an appropriate backup, you won't be able to restore your QlikView Server installation on the target machine. See Backup and upgrade preparation.

Note: If your installation uses digital certificates for authentication, it is vital that you create a backup of the certificates on your current machine. See: Backing up and restoring certificates.

Migrating an installation that uses QlikView Administrators Group

  1. Once you have installed the latest version of QlikView Server on both the current and target machine, create an appropriate backup of the current machine. See Backup and upgrade preparation.
  2. Stop all QlikView services on both current machine and target machine.
  3. On the target machine, remove or rename the %ProgramData%\QlikTech\ManagementService\QVPR folder, as this will be replaced with your backed up version. 
  4. Copy the QVPR folder from your current machine to your target machine (make a note of the folder name).
  5. Edit the .xml files in the %ProgramData%\QlikTech\ManagementService folder, replacing all references to the current machine name with the target machine name.
  6. Restart the QlikView services. Start the QlikView Management Service first, then wait a minute, and start the other services in any order.
  7. Restore the SourceDocuments folder and Mounted Folders.
    • If you are storing your source documents in the default %ProgramData%\QlikTech\SourceDocuments folder, then move all your source documents to the same location on the target machine.
    • If you are storing your source documents in a different folder location, then add the source documents folder path in the QlikView Management Console. To do this see the Add section in Source Folders.
    • If you are distributing tasks to mounted folders, reinsert the path to the mounted folders. To do this see the Mounter Folders section in Folders.
  8. Shut down your old server machine.

Migrating an installation that uses digital certificates

When you migrate a QlikView Server installation that uses certificates, some settings are encrypted. These settings cannot be decrypted if QlikView cannot access the certificates originally used for the encryption. Restoring the certificates from your current machine to the target machine for the migration allows you to decrypt the migrated settings. Once decrypted, these settings are encrypted again using the encryption key stored in the certificates from the target machine.

  1. Once you have installed the latest version of QlikView Server on both the current and target machine, create an appropriate backup of the current machine, including certificates. See Backup and upgrade preparation.
  2. Stop all QlikView services on both current machine and target machine.
  3. Copy the certificates backup from your current machine to your target machine and save it in a preferred location.
  4. Restore the certificates from the current machine to the target machine using the MMC (Microsoft Management Console). For a step-by-step description of this procedure, see: Restoring certificates. Once the old certificates are restored, you should see two sets of certificates in the MMC, with two different expiration dates.
  5. On the target machine, remove or rename the %ProgramData%\QlikTech\ManagementService\QVPR folder, as this will be replaced with your backed up version. 
  6. Copy the QVPR folder from your current machine to your target machine (make a note of the folder name).
  7. Edit the .xml files in the %ProgramData%\QlikTech\ManagementService folder, replacing all references to the current machine name with the target machine name.
  8. Restart the QlikView services. Start the QlikView Management Service first, then wait a minute, and start the other services in any order.
  9. Restore the SourceDocuments folder and Mounted Folders.
    • If you are storing your source documents in the default %ProgramData%\QlikTech\SourceDocuments folder, then move all your source documents to the same location on the target machine.
    • If you are storing your source documents in a different folder location, then add the source documents folder path in the QlikView Management Console. To do this see the Add section in Source Folders.
    • If you are distributing tasks to mounted folders, reinsert the path to the mounted folders. To do this see the Mounter Folders section in Folders.

    If the decryption of the migrated files was successful, your tasks, bookmarks and all other custom settings should now be in place and visible in the QlikView Management Console.

  10. Shut down your old server machine.

Upgrading and migrating a multi-server deployment

When upgrading and migrating a multi-server installation, perform the above procedures for each machine in your multi-server deployment.

Here you find a summary of the necessary steps:

  1. Perform the upgrade procedure on each machine of the multi-server setup.
  2. Perform a backup of each current machine in your multi-server installation.
  3. If your installation uses digital certificates for authentication, create a backup of the certificates on the machine running the QlikView Management Service (QMS).
  4. Install a running, licensed version of QlikView Server on each of the target machines.
  5. If your installation uses digital certificates for authentication, restore the certificates on the target machine where the QMS is installed.
  6. Migrate and restore the backup specific for each machine of the installation. For example, the QVPR folder must be migrated (and the machine name changed) only to the target machine running the QlikView Management Service.
  7. Restore the SourceDocuments folder.
  8. Shut down the old server machines.
  9. If Digital Certificate Authentication is used, install the new certificates on all machines running QlikView services except for the machine running the QlikView Management Service (QMS). For a detailed description of this procedure, see: Updating certificates

Did this information help you?

Can you tell us why it did not help you and how we can improve it?