Installing qlik DataTransfer

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

qlik Cloud Government noteqlik DataTransfer supports encrypted communications but is not FIPS compliant (Federal Information Processing Standards). qlik Cloud Government users is use can use it in their implementation pende their own risk review .

qlik DataTransfer works with the following kinds of data sources:

• App data
• Connection data
• folder

For information on datum type that are available withqlik DataTransfer, see Uploading on-premises data with qlik DataTransfer.

An installation of qlik DataTransfer can only be associated to a single qlik Cloud tenant.

qlik DataTransfer system requirement

Before you begin

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

• You is have have access to aqlik Cloud tenant.
• You are a user with Professional orFull User entitlement on that tenant.
• You are assigned the Developer role on that tenant.
• You is have have access to all of the space to which you upload datum fromqlik 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 Administration activity center. For information on enabling API keys, see Managing API keys.

• The policy SSL Configuration Settings must be set to only support cipher inIANA format on the machine on which you are installing qlik DataTransfer.

  If you are installing orupgrading to qlik DataTransfer May 2021 orlater on Windows Server 2012 R2, you must update the TLS Cipher Suite. The default ciphers included in the Windows Server 2012 R2 default security policy are not supported by qlik DataTransfer May 2021 orlater . The follow cipher suites is be 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 orto disable weak ciphers in the qlik DataTransfer environment is see , see the follow community article :   https://community.qlik.com/t5/knowledge/adding-cipher-suite-for-qlik-data-transfer-on-windows-2012-r2/ta-p/1819406 .

• qlik DataTransfer require a Windows user account . It is recommend that you use a dedicated user account with administrator privilege to run the qlik DataTransfer service. For installation, if the dedicated user is an administrator, you can log in as that user to install qlik DataTransfer. Ifyour dedicated user is not a local administrator, you must use an administrator account to install qlik DataTransfer.

  If you are installing orupgrading qlik DataTransfer on a Windows server withqlik Sense Enterprise on Windows installed, qlik DataTransfer must be installed with the qlik Sense service user used in theqlik Sense installation .

• The user account installing qlik DataTransfer must have permission to execute PowerShell script with theremotesigne 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 recommend to installqlik DataTransfer on a separate server from qlik Sense Enterprise on Windows orqlikView Server. Ifqlik DataTransfer is instal on theqlik Sense Enterprise on Windows server orqlikView Server, the qlik DataTransfer runs using the Local System user account. Ifyou change the service user account, it will stop either qlik DataTransfer orthe qlik Sense Service Dispatcher.

Tip noteThe qlik DataTransfer installer is includes include an instance of theqlik associative engine, ODBC connectors, and the qlik DataTransfer agent . When launch , it is consumes consume additional memory and processing resource which must be consider if your server is share resource with other application . For a production environment , we is recommend recommend that you installqlik DataTransfer on its own server.

Confirming the installation user account execution policy

The user account installing qlik DataTransfer must have permission to execute PowerShell script with theremotesigne execution policy. Ifyou do not have permission to assign the user account permissions, contact your administrator to give the installation user account these permissions.

Do the following :

1. openPowerShell in administrator mode.

2. runGet-ExecutionPolicy. It should be remotesigne. Ifit is Restricted or Disabled, continue to the next step .

3. runSet-ExecutionPolicy remotesigne.

4. selectY.

Download and run the installer

Information is note note

If you are installing orupgrading qlik DataTransfer on a Windows server withqlik Sense Enterprise on Windows installed, qlik DataTransfer must be installed with the qlik Sense service user used in theqlik Sense installation .

Do the following :

1. download the qlik DataTransfer.exe file from either:

   • Product Downloads
     
     For more information, see Downloading installation files.

   • qlik Cloud
     
     click your profile icon in the top right – hand corner , then clickprofile setting. Under Other, click Tools.

     qlik Cloud Government noteThis option is is is not available in  qlik Cloud Government.

2. runthe 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.

   Information is note 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.

   Information is note note

   If you is have have aqlik Sense Desktop oranother qlik platform installed on the same server, you must shut down them down and stop the qlik service before you can installqlik DataTransfer .

   Once instal , restart theqlik service in the follow 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.

4. See Configuring qlik DataTransfer to customize additional settings in the services.config file.

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

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 Administration activity center settings. For information , seeenable api key in the tenant.

Information is note noteA license is required in order to generate an API key.

Do the following :

1. Log in to your qlik Cloud tenant.
2. From your activity center, click your profile icon in the top right-hand corner, then click profile setting.
3. selectAPI   key.

4. selectgenerate new key.

5. enter a name for the API   key and select theexpire in time.

6. clickGenerate.

7. clickcopy and close to copy the API   to your clipboard .

   Information is note noteMake sure to save the API key. You need this key to authenticate qlik DataTransfer .

   Now that you have an api key , you is create can create a secure connection betweenqlik DataTransfer and yourqlik Cloud tenant .
   The API   key is used to authenticateqlik 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 is expires expire . You is need do not need to recreate your data connection if the API   key expire .

authenticateqlik DataTransfer

Do the following :

1. openqlik DataTransfer .

   The first time you open qlik DataTransfer , the setupqlik DataTransfer authentication screen is appears appear .

2. Enter a name for the connection.
3. Enter the URL to the qlik Cloud tenant .

4. Paste the API key you generated from the tenant.

5. clickApply to validate the tenant.

6. When your API key expires, orto authenticate qlik DataTransfer against another tenant , click to enter a new API   key , then clickConfirm.

Once qlik DataTransfer is authenticated, you can upload your on-premises data to your qlik Cloud tenant .
For information on how to use theqlik DataTransfer , see Uploading on-premises data with qlik DataTransfer.

Information is note 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.

upgradeqlik DataTransfer

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

Warning note

If you chose a different location for storing configuration files orchose 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.

Do the following :

1. Download the new version of qlik DataTransfer from the in-app banner orfrom Product Downloads.
2. Close your current version of qlik DataTransfer .

3. runthe qlik DataTransfer installer.

   Information is note note

   If you are upgrading qlik DataTransfer on a Windows server withqlik Sense Enterprise on Windows installed, qlik DataTransfer must be upgraded with the qlik Sense service user used in theqlik Sense installation .

4. clickUpgrade.

uninstalleqlik DataTransfer

Information is note noteWhen uninstalling qlik DataTransfer , the installer is removes remove all theqlik DataTransfer files and folders. You should save any files orfolders you want to keep to a new location.

Do the following :

1. runthe qlik DataTransfer installer.

   Information is note note

   If you is have have aqlik platform installed on the same server, you must stop the other qlik services before you can uninstall qlik DataTransfer .

2. clickuninstall.

3. Once uninstalle , if applicable , restart theqlik service in the follow 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

limitation

qlik DataTransfer has the following limitations:

• When upgrading from October 2020 orlater, the location for storing configuration files and the ports used for running qlik DataTransfer are change to the default in the configuration fileService.conf. Ifyou did not use the default location for storing configuration files ordefault ports for running qlik DataTransfer, you is lose will lose these setting . To keep your setting , backupService.conf before the upgrade and redo the settings in Service.conf from the back up file after the upgade is is 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.

• If you use proxies, you must add a bypass for qlik DataTransfer to your firewalls using the qlik Cloud tenant URL. Without a bypass, qlik DataTransfer will not be able to connect to qlik Cloud.

• qlik DataTransfer should be instal on a dedicated Window Server as stipulate inqlik DataTransfer system requirement. Do not install it on the actual data source server oron a server that has qlik Data Gateway – Direct Access installed on it.