Skip to main content Skip to complementary content

Installing or upgrading Qlik Replicate on Windows

Install Qlik Replicate using the QlikReplicate_<version-build>_X64.exe installation kit. This kit runs on Windows 64-bit (x64) environments. For a list of the Windows versions supported by Qlik Replicate, see Windows software requirements.

Follow the instructions in the Setup wizard to install Qlik Replicate.

Later, if you need to start or stop the Qlik Replicate Server service, see the following section: Starting and stopping the Qlik Replicate Server service on Windows

Information note

In the setup wizard’s Replication Server Location screen, one of the options is Connect to a remote Linux Qlik Replicate Server. You should only select this option if you have already installed Qlik Replicate Server on a Linux machine. If you select this option, you will be prompted for the IP address and port number of the Linux machine in the following screen.

For more information on installing Qlik Replicate Server on Linux, see Setting up Qlik Replicate on Linux.

For information on the possible deployment configurations, see Qlik Replicate UI server configurations.

All of the data that is created when you use Qlik Replicate is stored in a directory called data. By default, this directory is located in the installation directory where you install Qlik Replicate. If you want to create the data directory in a different location, select this option in the installation wizard.

Warning noteQlik recommends using a block device (physical, virtual or iSCSI-based) for the data folder. Using NFS or SMB-based storage is not supported due to the associated latency which could greatly degrade the data transfer performance, as well as due to reduced reliability and compatibility issues.

If you elect to create the data directory in a different location, all command line actions must include the -d your_data_directory_pathparameter where your_data_directory_path is the location of the "data" directory.

Upgrade instructions

To upgrade Replicate:

  1. Choose one of the backup methods below.

    1. Stop all Replicate tasks and services.
    2. Back up the Replicate "data" directory to a location outside the product folder.

    This method is recommended in most cases. However, if your "data" folder is very large and there is not enough space to back it up, then use Method 2 below.

    1. Open a Windows command prompt and change the path to <PRODUCT_DIR>\bin.
    2. Then issue the following command:

      repctl [-d data_directory] exportrepository

      where [-d data_directory] is required when the Replicate "data" directory is in a non-default location.

  2. Run the Qlik Replicate setup wizard.
  3. If you notice an issue with the upgrade, you can either revert to the previous version as described below or do one of the following depending on which backup method you chose above.

    If you chose Method 1:

    1. Stop all the Replicate services.
    2. Overwrite the "data" directory with the "data" directory that you backed up earlier.
    3. Start all the Replicate services.

    If you chose Method 2:

    Issue the following command:

    repctl [-d data_directory] importrepository json_file=Full path to the exported *.json file

    where [-d data_directory] is only required if you installed the Replicate "data" directory to a non-default location.

    Example:  

    repctl -d f:/data importrepository json_file=C:\Temp\many_tables.json

    Information note

    The following server settings will not be affected:

    • The Store trace/verbose logging in memory, but if an error occurs write to the logs logging option.
    • Global and component-specific logging levels
    • File Transfer Service settings

Reverting to a previous version

To revert to a previous version:

  1. Back up the Replicate data directory to a location outside the product folder.
  2. Uninstall the product and then reinstall to the same directory.
  3. Once the installation is complete, stop all Replicate services.
  4. Overwrite the data directory with the data directory that you backed up earlier.
  5. Start all Replicate services.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!