Skip to main content

Installing Qlik DataTransfer

Qlik DataTransfer is a lightweight Windows application that lets you upload data from on-premises data sources to a SaaS editions of Qlik Sense tenant without firewall tunneling. The service account owner (SAO) or tenant administrator generates an API key from the tenant, which is then used to authenticate Qlik DataTransfer . Once authenticated, you can schedule automatic data reloads or upload data manually.

Note: Qlik DataTransfer supports encrypted communications but is not FIPS compliant (Federal Information Processing Standards). Qlik Sense Enterprise SaaS - Government (US) users can use it in their implementation pending their own risk review.

Qlik DataTransfer works with the following kinds of data sources:

  • App data
  • Connection data
  • Folders

For information on data types that are available with Qlik DataTransfer, see Uploading on-premises data with Qlik DataTransfer.

An installation of Qlik DataTransfer can only be associated to a single SaaS editions of Qlik Sense tenant.

Before you begin

Before you download and run the Qlik DataTransfer installer, make sure you meet the following requirements:

  • You have access to a SaaS editions of Qlik Sense tenant.
  • You have professional access on that tenant.
  • You are assigned a developer role on that tenant.
  • You have access to all of the spaces to which you upload data from Qlik DataTransfer. For more information, see Managing spaces.
  • You have administrator permission on a Windows machine that has access to on-premises data sources.
  • Your Windows machine meets the following system requirements: System requirements for Qlik DataTransfer.
  • API keys are enabled in the Management Console. For information on enabling API keys, see Managing API keys.
  • The policy SSL Configuration Settings must be set to only support ciphers in IANA format on the machine on which you are installing Qlik DataTransfer.

    If you are installing or upgrading to Qlik DataTransfer May 2021 or later on Windows Server 2012 R2, you must update the TLS Cipher Suite. The default ciphers included in the Windows Server 2021 R2 default security policy are not supported by Qlik DataTransfer May 2021 or later. The following cipher suites must be present:

    • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

    • TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256

    • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

    • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384

    • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

    For instructions for updating the TLS Cipher Suite in your system or to disable weak ciphers in the Qlik DataTransfer environment, see the following community article: https://community.qlik.com/t5/Knowledge/Adding-Cipher-Suite-for-Qlik-Data-Transfer-on-Windows-2012-R2/ta-p/1819406.

  • Qlik DataTransfer requires a Windows user account. It is recommended that you use a dedicated user account to run the Qlik DataTransfer service. If the dedicated user is an administrator, you can log in as that user to install Qlik DataTransfer. If your dedicated user is not a local administrator, you must use an administrator account to install Qlik DataTransfer.

    If you are installing or upgrading Qlik DataTransfer on a Windows server with Qlik Sense Enterprise on Windows installed, Qlik DataTransfer must be installed with the Qlik Sense services user used in the Qlik Sense installation.

  • The user account installing Qlik DataTransfer must have permission to execute PowerShell scripts with the RemoteSigned execution policy

  • If you change the service log on account after configuring Qlik DataTransfer with your tenant, you must reconfigure the tenant and connections. Then, in %ProgramData%/Qlik/DataTransfer/DataUpload/storage, delete token.json. Restart the Qlik DataTransfer service.

  • For February 2021 SR1, it is recommended to install Qlik DataTransfer on a separate server from Qlik Sense Enterprise on Windows or QlikView Server. If Qlik DataTransfer is installed on the Qlik Sense Enterprise on Windows server or QlikView Server, the Qlik DataTransfer runs using the Local System user account. If you change the service user account, it will stop either Qlik DataTransfer or the Qlik Sense Service Dispatcher.

Tip: The Qlik DataTransfer installer includes an instance of the Qlik associative engine, Simba ODBC connectors, and the Qlik DataTransfer agent. When launched, it consumes additional memory and processing resources which must be considered if your server is sharing resources with other applications. For a production environment, we recommend that you install Qlik DataTransfer on its own server.

Confirming the installation user account execution policy

The user account installing Qlik DataTransfer must have permission to execute PowerShell scripts with the RemoteSigned execution policy. If you do not have permission to assign the user account permissions, contact your administrator to give the installation user account these permissions.

  1. Open PowerShell in administrator mode.

  2. Run Get-ExecutionPolicy. It should be RemoteSigned. If it is Restricted or Disabled, continue to the next step.

  3. Run Set-ExecutionPolicy RemoteSigned.

  4. Select Y.

Download and run the installer

Note:

If you are installing or upgrading Qlik DataTransfer on a Windows server with Qlik Sense Enterprise on Windows installed, Qlik DataTransfer must be installed with the Qlik Sense services user used in the Qlik Sense installation.

  1. Download the Qlik DataTransfer.exe file from either:

    1. The Qlik Downloads site.

    2. The cloud hub. Click your profile icon in the top right-hand corner, then click Profile settings. This option is not available in Qlik Sense Enterprise SaaS - Government (US).

  2. Run the installer and accept the Qlik User License Agreement. The default installation path is %Program Files%\Qlik\DataTransfer. When entering the service credentials , the username must be in the form domain\username.

    Note:

    If you enter a username that is more than 20 characters long, it must be in User Principal Name (UPN) format, and must include the full domain name. For example, longusername@full.domain.name.

    Note:

    If you have a Qlik Sense Desktop or another Qlik platform installed on the same server, you must shut down them down and stop the Qlik services before you can install Qlik DataTransfer .

    Qlik dataTransfer installer screen

    Once installed, restart the Qlik services in the following order:

    1. Qlik Sense Service Dispatcher

    2. Qlik Logging Service

    3. Qlik Sense Repository Service

    4. Qlik Sense Proxy Service

    5. Qlik Sense Engine Service

    6. Qlik Sense Scheduler Service

    7. Qlik Sense Printing Service

  3. On the Service Credentials window, enter username and password for the account that you want use to run the Qlik DataTransfer services.

The installer creates a desktop shortcut to launch Qlik DataTransfer application.

Ports

Qlik DataTransfer uses the following ports:

Service Port Direction

Secure web browser communication (HTTPS)

Note: You must open this port in your firewall.
443 Outbound
Data Upload service 5505 Internal
Engine service 5506 Internal
Connector Registry proxy 5507 Internal

If you have a port conflict with one of the default service ports, you can change it in the services.conf file, located in %Program Files%\Qlik\DataTransfer.

[globals] LogPath="${ALLUSERSPROFILE}\Qlik\DataTransfer\Log" StoragePath="${ALLUSERSPROFILE}\Qlik\DataTransfer" DataUploadServicePort=5505 EnginePort=5506 ConnectorRegistryPort=5507

Logs and data file storage

Qlik DataTransfer log files are located here: %ProgramData%\Qlik\DataTransfer\Log

Qlik DataTransfer data connections are located here: %ProgramData%\Qlik\DataTransfer\DataUpload

You can change the default storage path in the services.conf file, located in %Program Files%\Qlik\DataTransfer.

[globals] LogPath="${ALLUSERSPROFILE}\Qlik\DataTransfer\Log" StoragePath="${ALLUSERSPROFILE}\Qlik\DataTransfer" DataUploadServicePort=5505 EnginePort=5506 ConnectorRegistryPort=5507
Note: We recommend that you back up the files in storage folder to a secure location.

Generate an API key

API keys expire. The default expiration times might not be appropriate for your business needs. Before generating an API key, consider changing the maximum token expiration in the Management Console settings. For information, see Enabling API keys in the tenant.

Do the following:

  1. Log in to your SaaS editions of Qlik Sense tenant.
  2. From the cloud hub, click your profile icon in the top right-hand corner, then click Profile settings.
  3. Select API Keys.
  4. Select Generate new key.

    Cloud hub settings menu, generate API key
  5. Enter a name for the API key and select the Expires in time.
  6. Click Generate.

    Generate new API key screen

  7. Click Copy and close to copy the API to your clipboard.

    Note: Make sure to save the API key. You need this key to authenticate Qlik DataTransfer .
    API key summary screen

    Now that you have an API key, you can create a secure connection between Qlik DataTransfer and your SaaS editions of Qlik Sense tenant. The API key is used to authenticate Qlik DataTransfer when uploading data to the tenant. Since the API has an expiry time, you need to create a new API key and reauthenticate Qlik DataTransfer when this key expires. You do not need to recreate your data connections if the API key expires.

Authenticate Qlik DataTransfer

Do the following:

  1. Open Qlik DataTransfer .

    The first time you open Qlik DataTransfer , the Setup Qlik DataTransfer authentication screen appears.

    Qlik dataTransfer API key connection screen
  2. Enter a name for the connection.
  3. Enter the URL to the SaaS editions of Qlik Sense tenant.
  4. Paste the API key you generated from the tenant.

  5. Click Apply to validate the tenant.

  6. When your API key expires, or to authenticate Qlik DataTransfer against another tenant, click to enter a new API key, then click Confirm.

Once Qlik DataTransfer is authenticated, you can upload your on-premises data to your SaaS editions of Qlik Sense tenant. For information on how to use the Qlik DataTransfer , see Uploading on-premises data with Qlik DataTransfer.

Note: If you change the service log on account after configuring Qlik DataTransfer with your tenant, you must reconfigure the tenant and connections to ODBC data sources.

Upgrading Qlik DataTransfer

Qlik DataTransfer displays a notification banner when new versions are available. Qlik DataTransfer does not automatically upgrade to newer versions.

Warning:

If you chose a different location for storing configuration files or chose different ports to run Qlik DataTransfer from the configuration file Service.conf, the upgrade will override it. Back up your Service.conf file prior to the upgrade and copy it to the default configuration folder after the upgrade is completed to keep your settings.

If the Qlik DataTransfer is using the Local System account, it will not prompt you for service user credentials and continue using Local System.

Qlik DataTransfer upgrade banner

Do the following:

  1. Download the new version of Qlik DataTransfer from the in-app banner or from the Qlik Downloads site.
  2. Close your current version of Qlik DataTransfer .
  3. Run the Qlik DataTransfer installer.

    Note:

    If you are upgrading Qlik DataTransfer on a Windows server with Qlik Sense Enterprise on Windows installed, Qlik DataTransfer must be upgraded with the Qlik Sense services user used in the Qlik Sense installation.

  4. Click Upgrade.

    Upgrade QlikDataTransfer window

Uninstalling Qlik DataTransfer

Note: When uninstalling Qlik DataTransfer , the installer removes all the Qlik DataTransfer files and folders. You should save any files or folders you want to keep to a new location.

Do the following:

  1. Run the Qlik DataTransfer installer.

    Note:

    If you have a Qlik platform installed on the same server, you must stop the other Qlik services before you can uninstall Qlik DataTransfer .

  2. Click Uninstall.
  3. Once uninstalled, if applicable, restart the Qlik services in the following order:

    1. Qlik Sense Service Dispatcher

    2. Qlik Logging Service

    3. Qlik Sense Repository Service

    4. Qlik Sense Proxy Service

    5. Qlik Sense Engine Service

    6. Qlik Sense Scheduler Service

    7. Qlik Sense Printing Service

Limitations

Qlik DataTransfer has the following limitations:

  • When upgrading from October 2020 or later, the location for storing configuration files and the ports used for running Qlik DataTransfer are changed to the default in the configuration file Service.conf. If you did not use the default location for storing configuration files or default ports for running Qlik DataTransfer, you will lose these settings. To keep your settings, backup Service.conf before the upgrade and redo the settings in Service.conf from the backed up file after the upgade is complete.

  • If you did not use the default location for storing configuration files in Service.conf, you will need to manually delete the files in the folder you selected.