Prerequisites to Connecting to Qlik Sense Server (obsolete)
The approach described in this article is considered obsolete. A simpler configuration process is described in Establish Connectivity to Qlik Sense.
In order to connect to and authenticate against the Qlik Sense (QS) server, several requirements must be satisfied. Metric Insights accesses the Qlik Sense server via the same ports and protocol that your users access Qlik Sense via web browser – ports 80 (http) and 443 (https). In addition, Metric Insights accesses the Qlik Sense Websocket API over port 4747 as well as Qlik Sense Proxy REST API over port 4243.
NOTE: If using a Load Balancer, forward the same ports (80/443, 4247 and 4243).
1. Create a Qlik Sense Certificate (on QS server in QMC)
As of Release 5.5, Metric Insights uses a client certificate for authentication with the Qlik Sense server.
To create a certificate, go to your Qlik Sense server and sign into the QMC. In the QMC, go to the Certificates page and fill in the following fields:
- Add machine name
- Machine name can be any non-empty string
Certificate password (Required):
- Remember this value because you will be used in the following steps.
- Export file format must be “Windows format."
- Disk Location where your certificate will be exported
- Qlik Sense creates the following certificate files: client.pfx, root.cer, server.pfx and exports them to the specified folder
- Click [Export certificates] to initiate the process
Instructions on exporting a Qlik Sense certificate can also be found in the following Qlik Sense help article Exporting certificates
2. Install Java on the machine
Follow this link to download and install Java.
3. Install a Remote Data Processor
A Remote Data Processor must be used to avoid certain Qlik Sense specific issues, such as:
For step-by-step installation instructions, see: Configuring a Remote Data Processor (v6+)
4. Install Chrome Browser on QS Server (optional)
If the Chrome Browser does not already exist on the QS server, install Chrome.
- Metric Insights utilizes a Chrome Driver to grab images of Report Objects. For the Chrome Driver to work, the Chrome browser must be present on the same system.
- Chrome driver and chromium are version-compatible. The compatibility is to be checked here ChromeDriver - WebDriver for Chrome.
Metric Insights has a one-shop-stop solution for Chrome and Chrome driver.
You can download a zipped third-party folder from our AWS account
- Click the link for the folder to be downloaded to your machine
Unzip it and replace the thirdparty folder in
C:\Program Files (x86)\Metric Insights\Insightd
5. Configure Qlik Sense Parameters
With the release of Version 6.2.1, .conf files are no longer required for advanced configuration in Metric Insights. It is recommended to use the Plugin Config page to adjust parameters and their values. See this article for more details.
- Specify the following four parameters and provide values for them (leave the pathToBrowser and pathToDriver as in the example below if you replaced the third-party folder)
- client_key_path: specify the path to the client.pfx certificate file <- (if using certificate auth)
- client_key_pass: specify the password for client.pfx <- (if using certificate auth)
- pathToBrowser: specify the path to chrome.exe (Chrome Browser)
- pathToDriver: specify the path to chromedriver.exe (Chrome Driver)
client_key_path=C:\Program Files (x86)\Metric Insights\Certificates\ client_key_pass=<cert-password-from-step-1.3> pathToBrowser=C:\Program Files (x86)\Metric Insights\Insightd\thirdparty\chrome-win32\chrome.exe pathToDriver=C:\Program Files (x86)\Metric Insights\Insightd\thirdparty\chromedriver.exe
- As of Release 5.4.0 and beyond, chrome.exe (Chrome Browser) and chromedriver.exe (Chrome Driver) are included in the RDP package.
- pathToBrowser and pathToDriver variables do not need to be specified unless you want to use your own Chrome Browser and Chrome Driver files, in which case you have to define the path to these files.
- Start Metric Insights Daemon to make the RDP send a heartbeat to the Metric Insights application (on your Windows machine: Services>>pick Metric Insights Daemon from the list >> Restart option).
- Go to Metric Insights UI and check the heartbeat for your Remote Data Processor.
- Once the heartbeat is received, try the "Test connection" option in your Qlik Sense connection profile.
Optional Commands for Managing Qlik Sense Certificates in Metric Insights
NOTE: if you want to delete keytool aliases created in step 4 above, then use the following commands:
List alias for root.cer in keytool:
"C:\Program Files (x86)\Java\jre1.8.0_111\bin\keytool.exe" -list -keystore "C:\Program Files (x86)\Java\jre1.8.0_111\lib\security\cacerts"
Enter keystore password: changeit
Delete alias for root.cer in keytool:
"C:\Program Files (x86)\Java\jre1.8.0_111\bin\keytool.exe" -delete -alias qsnew10 -keystore "C:\Program Files (x86)\Java\jre1.8.0_111\lib\security\cacerts"
Enter keystore password: changeit