This article gives an overview of the available blocks in the Github connector in Qlik Application Automation. It will also go over some basic examples of retrieving file/blob contents from your repos as well as other functionalities within a GitHub account.

As with most connectors provided for automations the authentication for this connector is based on the oAuth2 Protocol, so when connecting to it you provide the user name and password of the account directly to the Github platform to request access so it is done in the most secure manner there is.

Let's now go over a few basic examples of how to use the Github connector:

How to list owned repositories and check their contents from your Github account:

1. Create an automation;
2. From the left menu, select the Github connector;
3. drag and drop the "List my repositories" block
4. drag and drop the "List repositories contents" block inside the loop created by the first block:

Now the "list my repositories" block offers a couple of filtering options depending what result you want (all repos or just the private or public ones and if you want the result to come in sorted by some rule) but they are mostly optional. Not filling them in will return by default all repositories.

As for the "List repository contents" block you will need to fill in the username you use for your github account as well as the repository name which can be filled in with the results gotten from the first block. You can leave the path parameter empty to get the contents from the root folder or you can specify a path and the contents of that path will be returned.

As stated, if you expect to retrieve only one record, the use of "get repository content" block is more better suited. Also, you might want to switch this "List repository contents" block On Error status to either warning or ignore since Github API platform returns a 404 error if one of the queried repositories is empty.

Now if you are planning to use the "Get repository content" block another warning should be mentioned and that this block only works for files or blobs up to a maximum of 1 MB in size, as per Githubs platform limitations. The response of this block should look like:

As you can see we have a couple of information stubs of that file, but most importantly from here is the SHA property, which is needed if you are planning to later on use the "Create or update file contents" block, required input parameter for the update of a file/blob.

Now if you're planning on updating files that are bigger than 1MB and you require the SHA of that file, we suggest using the list repository contents block and search for the required file and SHA in that result.

As for other functionalities of the Github connector we support also getting and listing commits or issues present in a repository, listing of users and many other requests but, if you are in need of a request that isn't present, we also offer the functionality to create your own requests to the Github API by making use of the RAW API blocks. These API blocks and their uses are explained in a separate article.

You can find attached to this article a simple JSON example which you can upload to your workspace, if you want to see a quick example of how to use version control to back up your QCS apps I suggest visiting the related article.

The information in this article is provided as-is and to be used at own discretion. Depending on tool(s) used, customization(s), and/or other factors ongoing support on the solution below may not be provided by Qlik Support.

Related Content

How to: Qlik Application Automation for backing up and versioning Qlik Cloud apps on Github

While accessing Microsoft Azure SQL (MS-CDC) as the source database, the task reports an error message during the task startup.

The messages in the task log file:

[SOURCE_CAPTURE  ]V:  Execute: 'select is_cdc_enabled from sys.databases d where d.database_id=db_id()'  (ar_odbc_stmt.c:2768)
[SOURCE_CAPTURE  ]E:  MS-CDC Fitness Check: Database is not enabled for MS-CDC [1020101]  (sqlserver_mscdc.c:727)
[SOURCE_CAPTURE  ]E:  Failed in MS-CDC fitness check [1020101]  (sqlserver_endpoint_capture.c:274)

The error occurs even if the DBA has correctly set up the database for MS-CDC by executing the following:

exec source_db_name.dbo.sp_cdc_enable_db

Environment

• Qlik Replicate, all versions
• Microsoft Azure SQL source, all versions

Resolution

Add an internal parameter to adjust task behavior:

1. Open the Microsoft Azure SQL (MS-CDC) source endpoint
2. Go to the Advanced tab
3. Open Internal Parameters
4. Add a new parameter named UseDBNameInsteadOfDBID, and enable it by ticking the checkbox: 
   
   

With the new inclusion of the Get Chart Image block in the Qlik Reporting connector in Qlik Application Automation, you now have more options to notify a group of users with more in-depth data and charts using Slack, Microsoft Teams, and email.

This article will guide you in sending your first chart image to Slack with Qlik Application Automation.

It explains a basic example of a template configured in Qlik Application Automation for this scenario.

You can make use of the template which is available in the template picker. You can find it by navigating to Add new -> New automation -> Search templates and searching for 'Send a Chart Image to Slack' or 'Embed a chart image in an email' in the search bar, and clicking the Use template option.

For guidance on sending charts via Microsoft Teams and mail, go to the "Next Steps" section at the end of this article.

You can download examples of the automations from this article: Send-chart-image-to-slack.json, Send-chart-image-to-outlook.json, Send-chart-image-to-mail.json, Send-chart-image-to-microsoft-teams.json

Full Automation

Configure the Automation

1. Open the automation editor and search for the Qlik Cloud Services connector on the left-hand menu.
   
   
2. Drag the blocks “Select Field Value” and “Create Bookmark” to the canvas and fill in the required inputs. You can add multiple Select Field Value blocks to apply selections to various fields. The Create Bookmark block is then used to create a temporary bookmark that can pass the selections to the Get Chart Image block.
   
   
   
   
   
   
   

   Warning: Whenever the “Get Chart Image” block is to be used, we advise you to only use it with temporary bookmarks or pre-existing persistent bookmarks.

2. Search for the Qlik Reporting connector on the left-side menu, then drag the "Get Chart Image" block to the editor and attach it below the previous block.
   
   Choose the same app you chose when creating the temporary bookmark and use the ID value received from the “Create Bookmark” block. 
   
   
   
   The height and width inputs are not required and default to 1000 if the fields are empty.
   
   Manually insert the Object ID input; it can not yet be retrieved through an API call.
   
   To find the chart ID from the app, open the app, then click Edit Sheet, right-click the chart, and open the Share/Embed menu from the menu dropdown that appears. You will see the object ID of the chart under the chart preview section as shown below:
   
   
   

    

3. Add the 'Condition' block to check whether the "Get Chart Image" block has returned a successful response.
   
   
   
   
   1. If the condition block outcome evaluates to true:
      
      
      • Search for Slack connector from the left-side menu, add the "Upload File To Channel" block, and fill in all the required inputs.
        
        
        
        
      • The chart image gets posted on the Slack channel as shown below:
        
        
         

   2.  If the condition block outcome evaluates to false:

      • Add the "Update Run Title" block to specify that the "Get Chart Image" block failed due to an error.
        
        
        
        
      • Add an "Error" block to throw an error message from the "Get Chart Image" block and set the current automation run to be in a failed state.
        
        
        

Configure and send the Output

Embed the chart in the email

1. To embed the image in an email, you'll need to replace the Slack block with Send Mail block from the Microsoft Outlook 365 connector or the Send Mail block from the Mail connector and configure the block's Type parameter to HTML.
2. In the body of the HTML, start adding a <img> tag and set the src parameter of the img tag to "data&colon;image/png;base64,".
   

   
   

3. Add the Get Chart Image block output at the end of the src parameter.
   

   
   

4. Click the Get Chart Image label in the input parameter, and pick the Add formula option; then search for the "base64 encode" formula to apply it to the output from the Get Chart Image block.
   
   
   
   
   

   
   

5. Finalize the img tag with an optional width and height to style the image.
   
   

Send the chart to a channel in Microsoft Teams

1. To send the image to Microsoft Teams, replace the Slack block with the Send Html Message With Base 64 Image block from the Microsoft Teams connector.
2. Configure the "Base 64" parameter of the block by mapping it to the output of the Get Chart Image block.
   

   
   

3. Click the field mapping for the Get Chart Image again and open the formula picker. Search for the base64 encode formula and apply it.
   
   
   
   
    
4. Set the Image Content Type parameter to image/png and (optionally) provide additional HTML content that will be inserted before or after the image.
   

   
   

The information in this article is provided as-is and will be used at your discretion. Depending on the tool(s) used, customization(s), and/or other factors, ongoing support on the solution below may not be provided by Qlik Support.

Environment

• Qlik Cloud 
• Qlik Application Automation 

Related Content

• Distributing Chart Images through Automation

Reading an XLS file which includes a specific character leads to Qlik Sense failing with the following error:

An Error occurred
Connection lost. Make sure Qlik Sense is running properly. If your session has timed out due to inactivity, refresh to continue working.
Error code: 16

Example:

1. Create a new app
2. Open the Data load editor
3. Select Attached files and import an xls file which includes 2363B code characters.
4. ??? is shown as the date after the character
5. Click Insert script, followed by Load data and confirm the result by clicking Close
6. Go to Edit Sheet
7. Add a table and add the previously loaded data as dimensions
8. The error is displayed

The error is avoided when using XLSX or CSV files with identical data. 

Qlik Cloud is not affected.

Resolution

Workaround:

Use xlsx or csv as source files.

Fix Version:

No fix is yet available for Qlik Sense Enterprise on Windows. Qlik anticipates a fix for its May 2025 release. 

Information provided on this defect is given as is at the time of documenting. For up-to-date information, please review the most recent Release Notes, or contact support with the ID QB-29693 for reference.

Cause

The error is triggered when reading .xls files containing strings with UTF-16 surrogate pair characters, such as emojis or rare Asian characters. The specific characters leading to the problem are uncommon. 

Environment

• Qlik Sense Enterprise on Windows, all versions

Loop and Reduce will remove an app's section access that was defined through the load script. Offline usage needs to be enabled in your tenant's management console in order to use the Loop And Reduce block on an app outside a personal space. More information on offline usage.

See How to Loop and Reduce with always one selected value fields if your app contains always one selected value fields.

This article explains how a loop and reduce operation can be performed on a Qlik Sense app by using Qlik Application Automation. It covers two examples, in the first one, the reloaded apps will be (re)published to one space. In the second example, each reduced app will be (re)published to a separate space.

This article covers two advanced examples, a more basic example can be found here .

Covered in this article:

• 1. Loop and reduce to one space
• 2. Loop and reduce to multiple spaces

The source app used in this article can be downloaded here.

Attached to this article are 2 files of the exported automations used in this article. More information on importing automations can be found here.

1. Loop and reduce to one space

In this example, all reduced apps will be (re)published to the same space.

Create a new automation and follow these steps to perform a loop and reduce action on a Qlik Cloud app:

1. Go to the Qlik Cloud Services connector and search for the block "Loop And Reduce". Drag this block inside the automation editor.
   
   
2. Specify the id for the app that should be used as a source app. The reduction will be performed on this app. Next, specify the field name over which the loop should run, for each unique value of the specified field name, a reduced app will be created. In this example, CountryName will be used as the reduction value.
   
   

    

3. The reduced apps are stored on the Temporary File services. The Loop And Reduce block will return a list of file ids together with the unique value of the reduction field and a list of sheet ids for the sheets that were public on the source app.
   
   
4. The next step is to import the apps from the Temporary File services. To do this search for the block "Import App From Export Id" and drag this block in the loop that's created by the Loop And Reduce block. This block will import one app from the temporary file services into your personal space.
   Tip: specify the reduced value that's outputted by the Loop and Reduce block in the Name parameter of the Import block. See the below image for an example:
   
   

    

5. When an app is imported, all sheets will be made private, this is the default behavior of the import app block. The next step is to publish the sheets that were public in the source app.
   
   
6. Because each reduced app will have a list of sheets that were public, a Loop block is necessary to loop over the list. Search for a "Loop" block in the block menu or find it under Basic and connect it right below the "Import App From Export Id" block. Specify the "Public Sheets" list returned by the Loop And Reduce block as the value for the "Loop over items of list" input parameter of the Loop block.
   
   

    

7. Now to publish each sheet of the imported app, search for the block "Publish Sheet" in the Qlik Cloud Services connector and drag that block in the loop generated by the "Loop" block. In this block, specify the id that's returned by the Import App block as App Id and use the current item in the loop as Sheet Id.
   
   

    

8. Nex step is to publish or republish the imported app to a managed space. This can be done with the block "Publish App To Managed Space". Search for this block in the Qlik Cloud Services connector and connect it below the loop block. Set the Run Mode to "(Re)publish by name", if the managed space already contains an app with the same name as the imported app, the imported app will be republished, or else it will be published.
   
   
9. In the configuration of the Publish App To Managed Space block, set the App Id equal to the id returned by the Import App From Export Id block. For the Space Id, perform a lookup or manually enter an id, make sure you're specifying a managed space. The Data parameter should be set to "source".
   
   

    

10. Finally, when your app is published to a managed space, the imported app will still exist in your personal space. To remove this app, search for the block "Delete App" in the Qlik Cloud Services connector and connect it to the Publish App To Managed Space block. Specify the id returned by Import App From Export Id as the App Id in the block's settings.
    
    

An example of a completed automation:

Attached example file: loop_and_reduce_to_same_space.json

2. Loop and reduce to multiple spaces

In this example, each reduced app will be published to a different space. We'll use the Insurance Claims app and the automation for the first example again. Since this app reduces on the field CountryName, we'll start by creating a managed space for each unique value that's found for CountryName. This results in the following list of spaces:

Next is to create a mapping for each unique reduction value and the corresponding space's id. There are multiple ways to achieve this. In this example, this mapping is stored in a JSON list of objects with the keys reduction_value and space_id. Feel free to use an automation to create the managed spaces and build this list.

Example:

[
	{
		"reduction_value": "Scotland",
		"space_id": "6138a3062c1054d8158c189a"
	},
	{
		"reduction_value": "Northern Ireland",
		"space_id": "6138a318faed485d36ae911f"
	},
	{
		"reduction_value": "England",
		"space_id": "6138a337faed485d36ae9126"
	},
	{
		"reduction_value": "Wales",
		"space_id": "6138a33f98b0d0bf7e719dfb"
	},
	{
		"reduction_value": "Guernsey",
		"space_id": "6138a349faed485d36ae912b"
	},
	{
		"reduction_value": "Isle of Man",
		"space_id": "6138a35aba392246d331e611"
	},
	{
		"reduction_value": "Jersey",
		"space_id": "6138a3653ec592fe53a8d55b"
	}
]

The next step is to store the mapping in the automation. Execute the following steps to do this:

1. Search for the Variable block and add this to the automation.
   
   
2. Go to the block's settings, click Manage variables and add a new variable of type list.
   
   
3. Go to the operations section of the variable and set the first operation to empty the variable.
   
   
4. Add a second operation Merge other list into... and click the List input field of that operation, in the dropdown that appears, select Add Formula.
   
   
5. From the formula picker, search for the formula Object and select it. Copy the JSON mapping to the json input field of the Object formula and click Save.
   
   
6. Add the block to the beginning of the automation from the first part of this article:
   
   

    

7. The next step is to find the right space id for each reduced app. To do that, add the block Lookup Item In List in the automation right before the block Publish App To Managed Space.
   
   
8. Go to the settings of the Lookup Item In List block and specify the variable that contains space_id/reduction_value mapping as input list. The condition inside the lookup should compare the mapping's reduction_value to the Reduced Value of the current item in the loop of Loop And Reduce. See the below image for an example:
   
   
   

    

9. Finally, specify the space_id from the output of the lookup block as Space Id in the settings of the Publish App To Managed Space.
   
   

    

Attached example file: loop_and_reduce_to_mulitple_spaces.json

The information in this article is provided as-is and to be used at own discretion. Depending on tool(s) used, customization(s), and/or other factors ongoing support on the solution below may not be provided by Qlik Support.

QlikView and Qlik Sense files are like ZIP file, as in they are highly compressed. So obtaining an estimate of how much RAM is needed for loading Apps into memory (footprint) is difficult to provide across the board. The expected memory usage associated with the app can also depend on how many users access the app and how much they are used.

Environment: 

• QlikView, all versions
• Qlik Sense Enterprise on Windows,  all versions
• Qlik Cloud

An estimate of the RAM needed per app can be built on the below, but for accuracy always test by loading the app into memory and using the Qlik Scalability Tools to obtain a baseline of memory usage for each app as it is accessed by the foreseeable number of users. 

Telemetry logging which allows for using the Telemetry Dashboard, is also an available suitable tool.

Since the release of the February 2019 version, Sense System Performance Analyzer monitoring App can be used to determine app footprint as well. Since the release of the June 2018 version, App Metadata Analyzer monitoring App can also be used. However, these last three may not provide the same data as the Scalability Tools.

An alternative is to use a test environment and simply observe RAM usage increases as apps are first opened (footprint), and as number of users accessing the app increase, then as number of operations are performed within the app. The test environment results for observed memory and CPU usage can be recorded as a baseline for the particular app in production, which assists in determining future sizing/scaling needs.

Need direct assistance in evaluating your Qlik Sense and QlikView apps? Qlik's Professional Services are available to assist you.

RAMInitial = SizeOnDisk × FileSizeMultiplier ; this is the initial RAM footprint for any application 

FileSizeMultiplier: range between 2-10 (this is a compression* ratio depending on the data contained in the app) 

*Compression is based upon the data, and how much we can compress depends upon the homogeneity of the data. The more homogeneous, the more compression Qlik can achieve. 
More information on one way of optimizing a document can be found on the Qlik Design Blog: Symbol Tables and Bit-Stuffed Pointers

RAMperUser = RAMinitial ×  userRAMratio ; this is the RAM per each incremental user 

userRAMratio: range between 1% -10%
 

Total RAM used per app :

TotalRAM = (RAMperUser × Number of users) + RAMinitial 

Example:

SizeOnDisk = 1 GB

File Size Multiplier 6 (range is from 2 to 10) This is an example value. A value can be obtained by reviewing telemetry (how far does the app expand?) or opening the app in a QlikView or Qlik Sense desktop and measuring the expansion based on how large it grows in memory.

RAMinitial = 1 * 6 = 6 GB

If we take a RAM Ratio per User of 6% then it is 0.06 (range is from 1 to 10)

RAMperUser = 6 x 0.06 = 0.36GB

Then RAM Required for 30 Users

TotalRAM = (RAMperUser × No. users) + RAMinitial 
TotalRAM =  (0.36 * 30) + 6
TotalRAM = 16.8 GB

Related Content:

• App Metadata Analyzer
• Sense System Performance Analyzer 
• Qlik Sense Scalability Tools - Community
• How to enable Qlik Sense QIX performance logging and use the Telemetry Dashboard
• Single/Multi-threading in QlikView
• Qlik Sense Performance Benchmark
• Qlik Sense Scalability Tools

For information about Qlik Sense failover candidates, see Qlik Sense Failover Central node: Requirements and Considerations.

Out of the box, you need to toggle the option to enable a rim node as a failover node during first time setup. In this article, we will outline how to accomplish elevating an existing node to being a failover candidate primarily using the QRS APIs.

Steps:

1. Perform a GET /qrs/ServerNodeConfiguration/full API call
   
   
2. Copy the JSON response
   
   
3. Edit the JSON to include only the node that you want to elevate
           Remember to remove the []'s which bracket the JSON response
   
   
4. Change the failoverCandidate to be true and slightly modify the modifiedDate
   
   
5. Perform a PUT /qrs/ServerNodeConfiguration/{GUID_of_note_to_elevate} with the edited JSON in the body
   
   
6. Export full trusted root from existing Central candidate
   
   
7. Stop services on the newly elevated rim
   
   
8. Deleted the existing trusted root certificate on the newly elevated rim
   
   
9. Import the copy of the certificate that was previously exported from an existing Central candidate
   
   
10. Start all services on the rim

Environment

Qlik Sense Enterprise on Windows 

Related Content 

https://community.qlik.com/t5/Official-Support-Articles/Removing-a-Rim-Node-not-to-be-a-Failover-candidate-in-the/ta-p/1711472 

Qlik Replicate task fails during run time:

RetCode: SQL_ERROR SqlState: S1000 NativeError: 4 Message: [SAP AG][LIBODBCHDB DLL][HDBODBC] General error;4 cannot allocate enough memory: OOM. please check traces for further information [1022502] (ar_odbc_stmt.c:2789)

Resolution

To address the memory error:

1. If not already stopped, manually stop the current task
2. Edit the source SAP HANA endpoint / from Advanced tab
3. Add the following three Internal Parameters:
   
   
   • fetchQueryHints 
     value:  NO_CS_EXPR_JOIN
   • hextobinLocation
   • value: excludingJoin
   • maxFetchIntervalSize (note that this internal parameter is depreciated in 2023.5 and 2023.11 as the parameter now appears as an endpoint setting)
     value: 10000
     
     
     

For more information on how to set Internal Parameters, see: Qlik Replicate: How to set Internal Parameters and what are they for? 

Environment

Qlik Replicate 
SAP Hana Endpoint

It is not possible to Include and Must_include variables with native Qlik Cloud scripts. Doing so leads to the error:

Unable to fetch file

Resolution

The possibility to include native Qlik Cloud scripts in other apps is on the roadmap for 2025.

In the meantime, there are two possible workarounds:

• Manually copy and paste the script to a txt file, then save it as a qvs file and reimport it
• In the native script: 
  1. Enter the script editor
  2. Access the script's history
  3. Export the script from there
  4. You will receive a qvs in text format
  5. Import the qvs to the tenant and use that in the “include” variable

Cause

There are two sorts of script files in Qlik Cloud:

Native scripts: they are qvf files. They can be reloaded on their own, but currently cannot be included.

Qvs scripts: they are imported as datasets, and they are txt files. They cannot be reloaded on their own, but they can be included.

Environment

• Qlik Cloud

Question

Does NPrinting have the ability to send NPrinting reports to a Microsoft Sharepoint or other worldwide web url address destination?

Environment

• Qlik NPrinting: All Versions

Resolution

• It is not possible to automatically distribute Qlik NPrinting reports from an Qlik  NPrinting publish task to any type of HTTP, FTP or any other worldwide web url addresspath.
• Therefore, it is not possible to send NPrinting Reports to an MS SharePoint worldwide web address.
• To workaround, it is possible to use a local or network path as defined in Distributing reports to folders
• Create a network share on the Sharepoint server and use that network folder as a destination for the distribution of your Qlik NPrinting reports.

Local and Network path examples:

• Local: c:\nprinting\output
• network: \\myfileserver\files\nprintingoutput
  
  NOTE: Keep in mind that the NPrinting Scheduler service user account must have NTFS file and folder security permission to access local or network share folder destinations. It must also be in the same domain as the share point or destination server host address path or the NP service account will fail to open the network path.
  

*This feature is not planned nor on the NPrinting road map at this time. You can check our 'ideas' page to determine if this has been requested. You can add your request at the link below if it has not: Ideation 

Related Content

• NPrinting Engine System Requirements
  • Storage: Only Windows, local or shared, storage is supported.

A user has been given permissions to a section of the Management Console with a new security rule (example: Apps or Streams), but when they access the console, all sections remain grayed out.
 

To give a user access to the different sections in the QlikSense Management Console, seperate rules need to be added to allow access to QMC Section Resources. 

The following filters are used to grant access to the different sections. A user with access to a QMC section can open that section, but will only see objects according to the user's access rights.

QMC section resources

Resource filter Filter will target

Related Content

• Security Rule Example: License Management only access in the Qlik Sense Management Console (QMC) 
• Qlik Sense Management Console sections grayed out and cannot be accessed 
• Available resource filters 

Analyzing endpoints for Qlik Sense Enterprise on Windows, using for example https://www.ssllabs.com/ssltest/analyze.html may indicate:

• The site being vulnerable for POODLE attacks and Insecure renegotiation
• Certificates using SHA1 instead of SHA256 cipher
• Potential CVE-2019-1559 vulnerability

Environment:

Qlik Sense Enterprise on Windows 

Protecting the platform

Please review Qlik Sense Enterprise on Windows securityfor information on how to protect the Qlik Sense platform. 

The security in Qlik Sense Enterprise does not depend only on the Qlik software. It also relies on the security and hardening of the environment that Qlik Sense operates in. This means that the security of, for example, the operating system and the cryptographic ciphers available have to be set up and configured to provide the security needed for Qlik Sense.

See Qlik Sense: TLS Support on what protocols and ciphers are supported in which version. 

Mitigate POODLE attack

To mitigate POODLE attacks, one step is to completely disable SSLv3.0 on the server. 
See Microsoft Security Advisory 3009008 for more instructions on how to accomplish this and the impact of doing so.
See Qlik Sense: TLS Support on what protocols and ciphers are supported in which version. 

Mitigate Zombie POODLE / GOLDENDOODLE attack

To mitigate POODLE attacks, one step is to completely disable all cipher suites with the string CBC. This needs to be carried out in the Windows OS.

Insecure renegotiation

Insecure renegotiation may be mitigated by disabling renegotiation. This can be done at the OS level by adding the following Windows registry key:

[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL]
"DisableRenegoOnServer"=dword:00000001

However, it is recommended to review all Schannel settings ( Secure Channel ) and that a Windows Administrator should configure it to meet their requirements.

See Qlik Sense: TLS Support on what protocols are supported in which version. 


Note: Any changes at the OS level must be thoroughly tested as they may cause other software to no longer function as expected, or clients may be unable to communicate with the server. If any side effects are experienced, the changes should be reverted back to the original settings.

This article will outline how to successfully change the service account running Qlik Sense. 

Contents:

• Account Requirements: What the account needs access to.
• Prep work
• Changing Qlik Sense dependencies
• Change the service account
• External Dependencies
• Video Demonstration
• Related Content

Account Requirements: What the account needs access to.

1. Certificates
   • Access to the certificate(s) for the site
2. Files and file shares
   • Access to the installation path for Qlik Sense
   • Access to %ProgramData%
   • Access to C:\Program Files\Qlik
   • Access to the Service Cluster share
3. Access to external systems as data sources, e.g.
   • Databases
   • UNC shares to QVDs, CSVs, etc

Note: Many of the file level permissions would ordinarily be inherited from membership to the Local Administrators group. For information on non-Administrative accounts running Qlik Sense Services see Changing the user account type to run the Qlik Sense services on an existing site.

Prep work

Record the Share Path. Navigate in the Qlik Management Console (QMC) to Service Cluster and record the Root Folder.

 

 

 

Changing Qlik Sense dependencies

1. Stop all Qlik Sense services
2. Ensure permissions on the Program Files path (this should be provided by Local Administrator rights):
   1. Navigate to the installation path (default: C:\Program Files\Qlik)
   2. Select the Sense folder > Right Click > Properties > Security > Edit > Add
      1. Lookup the new service account
      2. Ensure that the account has Full control over this folder
3. Ensure permissions on the %ProgramData% path (this should be provided by Local Administrator rights):
   1. Navigate to the installation path (default: C:\ProgramData\Qlik)
   2. Select the Sense folder > Right Click > Properties > Security > Edit > Add
      1. Lookup the new service account
      2. Ensure that the account has Full control over this folder
4. Ensure access to the certificates used by Qlik Sense
   1. Start > MMC > File > Add/Remove Snap-In > Certificates > Computer Account > Finish
      1. Go into Certificates (Local Computer) > Personal > Certificates
      2. For the Qlik CA server certificate (under Certificates (Local Computer) > Personal > Certificates)
         • Right Click on the Server Certificate > All Tasks > Manage Private Keys > Ensure that the new service account has control
      3. If using a third party certificate, do the same
5. Ensure access to the Service Cluster path used by Qlik Sense
   1. Start > Computer Management > Shared Folders > Shares > Select the Share path
   2. Right click on the Share Path > Properties > Share Permissions > Add the new service account to have full control
   3. Open Windows File Explorer and navigate to the folder (e.g. C:\Share) > Right click on the folder > Security > Edit > Add the new service account to have full control
6. Ensure membership in the Local Groups that Qlik Sense requires:
   1. Start > Computer Management
   2. Navigate to Local Users and Groups > Local Groups
   3. Add the new service account as a member of:
      • Administrators (if using this configuration option)
      • Performance Monitor Users
      • Qlik Sense Service Users

Change the service account

1. Swap the account for all Qlik Services except the Qlik Sense Repository Database Service.
   1. Open the Windows Services Console
   2. Locate the services
   3. One by one open the Properties of the Service and change the accountover by using the Windows services control panel
2. Start all Qlik Sense Services
3. Access the QMC to validate functionality, preferably as a previously configured RootAdmin
4. Access the Data Connections section of the QMC
5. Toggle the User ID field and change the data connections used by the License and Operations Monitor apps to use the new user ID and password:
   
   
   
   
6. Add the RootAdmin role to the new service account*
   1. QMC > Users
   2. Filter on the new UserID > Edit
   3. Add RootAdmin role
      
      *If this account is not existing yet in Qlik Sense, you would need to try to connect to the Hub/QMC with this new account first, in order to be able to see it in QMC>Users.
      
      
7. Execute the License Monitor reload task
8. Inspect the configured User Directory Connectors and change the User ID and password combination if previously configured.

External Dependencies

1. Go into the QMC > Data Connections section and inspect all Folder data connections to determine all network shares that the service account needs access to. Either change them yourself or alert the necessary teams to provide both Share and NT level access to these shares.
2. Inspect all Data Connections and ensure that none use the old Service account and password. Follow up with necessary teams to provide access to data sources that used the old credentials.

Video Demonstration

Related Content

How to change the share path in Qlik Sense (Service Cluster) 

The tAddCRCRow component computes the correct value for Chinese characters in the local Studio (Windows).

However, when the same Job is set to be executed in the remote JobServer (Unix), the component is showing same calculated values for different input values.

The sample output from the Unix JobServer execution log is shown below:

The first column is part of the CRC and the last column is calculated CRC.

Resolution

For the string containing Chinese characters, the CRC calculation did not function correctly when the target was a JobServer in Unix.

Adding the below properties in the Studio -> Run Tab -> Advanced settings -> Use specific JVM Arguments resolves the issue.

-Duser.country=CN
-Duser.language=zh
-Dfile.encoding=UTF-8

The correct output is now displayed.

Environment

• Talend Data Integration 7.3.1, 8.0.1

In SAP, addresses are stored centrally in ADRC for various entities, such as users, business partners (customers/vendors), employees, etc. 

If the best practices for Gold Client are not followed, especially creating an empty target client, copying master data and executing the Number Range bump (to artificially increase the current numbers and avoid conflicts between data in source vs target), inconsistencies can happen.

Scenario One

A common scenario is when the users or company addresses between the source and the target are not aligned.

If you do a client copy, the users will get inconsistent because of divergent entries in Address data (ADRC table). This can lead to short dumps. Example: When creating new users in SU01.

Follow this standard approach to resolve the above scenario:

1. Go to transaction SUCOMP
2. On the title bar, select: Company then Standard address (Shift + F6)
3. The Company field contains the default company name 
4. On the header, select: Change (Shift + F4)
5. The default company address can be maintained 

After the default company is maintained please execute the report RSADRCK2 via transaction SE38 to assign the default company address to the users.

Afterwards, the address data will also be shown in SU01.

Scenario Two

In other scenarios for Adress Data in:  Business Partners, Customers, Vendors, Users or Employees when the matching address data can be realigned with Qlik Gold Client.

For that, please EXPORT the corresponding data from the source using /HTG/ZGOLD -> Data Snap and then IMPORT on target using  /HTG/ZGOLD -> Import Control with option Replace Conflicting Data.

Data types:

• SEC - USER DATA (for users + profiles)
• CA - BUSINESS PARTNERS (for BPs)
• CA - VENDOR MASTER (for vendors)
• SD - CUSTOMER MASTER (for customers)
• HR - EMP MAST WITH PAY POSTING (for employees)

If you cannot resolve the issue, submit a support case with Qlik Support, and the Qlik Gold Client team will respond accordingly. See How to Submit a Qlik Gold Client Support Case for details.

Related Content

Refer to SAP notes:

• 0459763 - Data inconsistency in table USR21
• 2310559 - Error in SU01 user creation - CX_SUID_IDENTITY_NO_CHECK dump
• 2468479 - How to maintain the default company address
• 3151050 - There is a data inconsistency in the company addresses

Environment

• Qlik Gold Client

Issue reported:

• License Monitor Task fails with message Error: HTTP protocol error 403 (Forbidden)

Diagnosis:

• Open "Tasks" in the QMC and view the 'information' icon within the 'status' column for the failed task
• Download the Script log file
• The downloaded Script Log file for the License Monitor ends with:
  
        2019-12-10 21:11:49      Error: HTTP protocol error 403 (Forbidden):
        2019-12-10 21:11:49      
        2019-12-10 21:11:49      The server refused to fulfill the request.
        2019-12-10 21:11:49      Execution Failed
        2019-12-10 21:11:49      Execution finished.
  
   

Cause(s):

The License Monitor acquires license data from the Qlik Sense Repository Service (QRS) through QRS API calls. The requests to these end-points are by default made by the user running the Qlik Sense services, but the related data connections may have been configured to run with a custom user. 

The user executing the API calls must fulfill two requirements;

• User is not blocked in Qlik Sense
• User is assigned RootAdmin role

Resolution:

Assign RootAdmin role to the user running Qlik Sense services

This is most often the only required action, since the license monitor app by default relies on user running Qlik Sense services.

1. In the QMC, navigate to 'Users' 
2. In the 'Users' under the User ID column find the row with the service account 
3. Edit that service account row
4. Select 'Add role' button
5. Hover over the new field and select 'RootAdmin' in the list
6. Reload License Monitor app

Run monitor app connections with customer RootAdmin account.

NOTE: This set is only required if a custom data connection user is required to comply with local security policies. 

Use a custom RootAdmin account for the Data Connections that start with monitor_apps_REST_*

1. In the QMC, in the left panel under Manage Content, select Data Connections
2. Under the 'Name' column are the connections starting with monitor_apps_REST_*
3. Edit each of these data connections you will see a User ID and Password  field
   • Enter a user into the User ID field (domain\username format)
   • Enter a password in the Password field
4. The user must have a 'Root Admin' role assignment;
   
   • In the QMC, navigate to 'Users' 
   • In the 'Users' under the User ID column find the row with the  desired user account 
   • Edit that service account row
   • Select 'Add role' button
   • Hover over the new field and select 'RootAdmin' in the list
5. Reload License Monitor app
   
   

Confirm that UDC filter include account used for data connections

• Confirm that user used for data connections is not marked as Blocked in QMC Users section
• If user is blocked, adjust UDC filter to include the user account used for the Data Connections
• Sync UDC and reload License Monitor app

When performing an Export of a Native Map in Qlik Sense only the points are being shown and not the actual background.

Current export result (Satellite background image is missing):

Or the map is entirely blank:

Environment

• Qlik Sense Enterprise on Windows 

Resolution

The port 443 to  imagery provider services.arcgisonline.com is probably blocked
Check and open port 443  (scroll down to "Web browser ports" and check "map").

To successfully configure your S3 storage bucket (staging) on your SQL Warehouse, first follow the instructions outlined in Setting general connection properties (help.qlik.com).

In addition:

• Add an instance profile or service principle (IAM user) to your Compute which has access to the S3 storage bucket. This is the same S3 bucket you enter into your Qlik Replicate endpoint for Staging.  You can navigate to the Data Access properties section of your SQL Warehouse through your Workspace settings. 
  
  Click on your User Name in the upper right corner => Click Settings => Compute => SQL warehouses (Manage).
  
  See:
  
  
  • Configure a SQL warehouse to use an instance profile
  • Connect to Amazon S3
    
    
• If you choose to use Unity Catalog, you need to add an external storage location for the S3 storage bucket.  Again, this is the same bucket you enter in the Replicate endpoint for staging. Unity Catalog is not technically a requirement but if you choose to utilize Serverless we recommend you use Unity instead of the Hive Metastore.
  
  See:
  
  
  • Create a storage credential for connecting to AWS S3
  • Create an external location to connect cloud storage to Databricks

Environment:

• Qlik Replicate

Changing the background color of the button object to none results in the button displaying with the default background color (#006580). This is a known limitation as of today.

Resolution

Qlik is reviewing QB-29806 for future improvements. 

Workaround

To achieve transparency (mimicking none as the background color):

1. In the button's background option, choose "By Expression"
2. Fill in the expression as follows:

   ARGB(0,0,0,0)

   

Cause

This feature predates the introduction of transparency in the colorpicker, meaning it was designed to revert to the default color when none is chosen. 

Internal Investigation ID(s)

QB-29806

Environment

• Qlik Sense Enterprise on Windows August 2023 and higher
• Qlik Cloud