Archive Calculate
Setting up the Qlik Cloud migration tools

Setting up the Qlik Cloud migration tools

2024-11-27 set up theQlik Cloud migration toolsON THIS page Qlik Cloud migration tools help you plan and perform your migration to Qlik Cloud. include in the t

set up theQlik Cloud migration tools

Qlik Cloud migration tools help you plan and perform your migration to Qlik Cloud.

include in the toolset are :

  • Qlik Sense to SaaS Migration AppQlik Sense app used for managing sequencing and monitoring of your migration .

  • QlikView to SaaS Migration AppQlikView app used for managing sequencing and monitoring of your migration . Utilizing QlikView Governance Dashboard.

  • Migration worksheet— ThisMicrosoft Excel spreadsheet is used to gather lists of users, roles, security rules, licenses, spaces, and more.

  • migration script—Used in the process to migrate to Qlik Cloud.

warning note

These Tools provide general guidance regarding your organization’s possible migration to Qlik Sense Enterprise SaaS. The information provided by the Tools are general guidelines, and any assessment of migration paths to Qlik Sense Enterprise SaaS for your organization’s needs will require additional due diligence.

The suggestions provided by the Tools are for informational purposes only, and do not represent a warranty or representation by Qlik of the actual Qlik Sense Enterprise SaaS deployment that may best suit your business requirements and preferences. The suggestions are based on the information provided by Customer, and any inaccuracy of, or changes to, the information provided by the Customer may result in significantly different evaluations and results. Inthe event of any conflict between the results of use of the ESR Tools and Qlik’s standard Documentation, the terms of Qlik’s standard Documentation shall control.

Revision history

The following table summarizes the changes to the Qlik Cloud migration tool .

date Notes
May 10 , 2022

Initial Release

July 12, 2022

update Migration App

New migration scripts

October 20, 2022 Bug fixes
March 7 , 2023 The Migration worksheet has been updated to support changes in the user roles
June 29, 2023

add tool forQlikView migration .

update Migration App

New migration scripts

October 31 , 2023

Revised 7_migrateapps.ps1. The script can now import apps with Public, Community and Personal contents for Sheets, Bookmarks and Stories and automatically assign to owners.

Some minor revisions to scripts to keep updated with new qlik-cli commands.

November 28, 2023 additional sheet for capacity model analysis .
May 21, 2024

update Migration App:

August 20 , 2024

update Migration App

The following image shows how migration is performed, and how the migration tools help you move users and assets to the cloud. Data from Qlik Sense Client-Managed and metadata from Qlik Cloud is pulled into the migration app. Migration data tables are saved to a CSV file and imported into Qlik Cloud using the qlik – cli script . The migration app is then reload to reflect the migration status . This process is is is essentially the same for all the item that are to be migrate .

procedure for migrate datum fromQlik Sense Client-Managed to Qlik Cloud

Setting up the Qlik Cloud migration tools

migration script

Download the .csv metadata files using the Migration app. The scripts are used to import client-managed assets into cloud. To learn more, see Using migration scripts.

Information is note noteTo be able to run the scripts, you must browse to the folder where the scripts are located. The scripts need to be run in sequence, because there are dependencies between them.

Migration preparation

The follow items is facilitate will facilitate your migration and provide a recommend work procedure .

  • Topic: plan your migration to Qlik Cloud. Assessment and preparation are essential for a successful migration .

  • Qlik Cloud migration tools — Zip file that contains:

    • Qlik Cloud Migration App, used for managing sequencing and monitoring of your migration .
    • Migration Worksheet: Excel file. Use this spreadsheet to gather lists of users, roles, security rules, licenses, spaces, and more.
    • migration script for migrating items from Qlik Sense Client-Managed to Qlik Cloud.
  • qlik – cli : Command line interface ( CLI ) , available on Qlik Developer : qlik – cli

After assessment and planning , do the follow :

  1. set up the migration app : import the appSaaS Migration 1.x.qvf into the Qlik Management Console (QMC) , set upREST Connector, modify the load script, and reload the app.

  2. Look up the ID of your tenant. You will find it in Qlik Cloud in your user profile menu, under About.

  3. Configure the migration scripts.

  4. create and apply tag to app and datum connection .

set up theMigration app

This section describes how to import the migration app, create an API key and set up a REST connection, and modify the load script in the app. To learn more, see set up theMigration app.

 

importing the Migration app

Do the following :

  1. Inthe QMC, openapp.

  2. clickimport.

  3. Navigate to the app SaaS Migration 1.x.qvf that you have downloaded.

  4. clickimport.

The app is now available in the hub.

set up theREST connection

Information is note noteTo create an API   key , you is have must have the role Developer . The role is assign in theadministration activity center of your tenant.

begin by create an API   key in your cloud tenant .

Do the following :

  1. Inthe administration activity center of your cloud tenant, openAPI keys.

  2. clickgenerate new.

  3. clickgenerate new key.

  4. enter a key description and set the expiry of the key .

  5. clickgenerate.

  6. copy the API   key and store it safely .

Next step is to configure the REST Connector in Qlik Sense Enterprise on Windows.

Do the following :

  1. InQlik Sense Enterprise on Windows, create a new data connection and select REST as the data source.

    Information is note noteIf nothing else is stated, keep the default values.

  2. Enter URL in the following format: https://<tenant>.<region>.qlikcloud.com/api/v1/items.

  3. Inthe section Additional request parameters > Query header, enterAuthorization in the Name field and in the Value field, enter’Bearer ‘ followed by the API key that you generated earlier. Note the space between ‘Bearer ‘ and your API key.

  4. Inthe section Pagination > Pagination type, selectNext URL and for ‘Next url’ path, enterroot / link / next / href.

  5. Enter a connection name, for example, REST for Qlik Cloud.

  6. clickCreate.

Modifying the load script

Do the following :

  1. Inthe Qlik Sense hub, openthe app SaaS Migration 1.x.qvf.

    The app overview is shown.

  2. Open datum load editor.

  3. Open the ** configuration ** section.

  4. On the row set vu_tenant_fqdn, enterthe fully qualified domain name of your tenant.

    example :set vu_tenant_fqdn = ‘my_tenant.eu.qlikcloud.com’;

  5. On the row Set vu_rest_connection_SaaS, enterthe name of the REST connection to your Qlik Cloud tenant.

    example :set vu_rest_connection_saas = ‘ myrestconnection for SaaS ‘ ;

  6. On the row SET vu_central_node_host_name, enterthe central node host name or the machine name.

    Example 1: SET vu_central_node_host_name = ‘sense-central-node’

    example 2 :SET vu_central_node_host_name = ‘my-central-node.domain.com’

  7. If your virtual proxy has a prefix, you need to enter it on the row SET vu_virtual_proxy_prefix = ” ;
    example :SET vu_virtual_proxy_prefix = ‘my-virtual-proxy-prefix’;

load script modification example

Setting up the Qlik Cloud migration tools

Setting up qlik-cli and configuring the migration scripts

Do the following :

  1. Install qlik-cli, a command line interface for Qlik Sense SaaS. It provides access to all public APIs through the command line, making it easier to script and automate new and old workflows. For detailed instructions, see the qlik-cli installation guide.

  2. Make sure thatqlik.exe is in your Windows execution path. Depending on how you installed qlik-cli, qlik.exe might not be in the Windows path by default.

  3. configure a connection toQlik Cloud by follow the step in the Qlik Cloud authentication setup .

  4. configure a connection toQlik Sense Client-Managed, see Qlik Sense: How to set up JWT authentication.

  5. Edit 0_globals.ps1 and set context names for:

    Context name configuration for 0_globals.ps1

    Setting up the Qlik Cloud migration tools

Information is note noteRun scripts 1 to 7 in sequence, because there are dependencies between them. For example, the script 2_setspaces.ps1 assumes that users are already in the system as a result of running the script 1_setusers.ps1.

Creating and applying tags

It is ‘s ‘s a good idea to provide Content Admin right to people who can assess and tag app and datum connection .

Do the following :

  1. create the follow tag in theQMC, tag section, for Qlik Sense Client-Managed:

    • Con Status – 05 select

    • Con Status – 10 Configured

    • Con Status – 20 Tested

    • Con Status – 30 Completed

    • Con Status – 99 Not Required

    • Con Type Data Files

    • Con Type Data Gateway – Data Access

    • Con Type Native Connector

    • App – 05 Migrated via Multi-Cloud

    • App – 05 URL Link to Qlik Sense Windows

    • App – 10 Selected for Migration Review

    • App – 20 Migration Remediation Needed

    • App – 30 Ready to Migrate

    • App – 40 Migration Complete

    • App – 99 is Migrate Will Not migrate

  2. Assess the apps and data connections and apply the tags accordingly.

  3. Inthe QMC app section, selectthe apps that will have the same tag.

  4. clickEdit and select the appropriate tag .

work iteratively with a few different app type at a time and review migration progress in the sheetApplication SaaS Migration Status in the SaaS Migration app, see migrate app.