Installing Qlik GeoAnalytics server

This guide covers the installation of the Qlik GeoAnalytics Server for local hosting of services for Qlik GeoAnalytics.

This installation is for Windows (8 or later).

Note that specified keys and paths are examples, and need to be modified for each installation.

This guide serves as an overview, consult the installation guides for each individual product for more detail.

Prerequisites

  • Review Qlik GeoAnalytics server requirements for information on required Memory, CPU and disk space specifications.
  • Ensure you have 64-bit Java SE Server JRE version 8-12 or later installed on the server device. You can get free Java OpenJDK from https://jdk.java.net/ or https://developers.redhat.com/products/openjdk/download/, or a commercial license at https://www.oracle.com/java/java-se-subscription.html.
  • The Server communicates using both HTTP and HTTPS, so ensure those ports (default 80 and 443) are open on the server device.

Download

Download the QlikGeoAnalytics server standalone installation files from Qlik.

Install

Run the Qlik GeoAnalytics server installation program. Parameters set during installation can be changed afterward by rerunning the same installer, or edited directly in the config file at C:\ProgramData\Qlik GeoAnalytics Server\config.ini (if you do make any changes, restart the Qlik GeoAnalytics server service).

To upgrade a GeoAnalytics server to the latest version, run the latest version of the installer. Configurations from the previous installation will be loaded (including data package services).

Warning: Warning: Before you upgrade to the latest GeoAnalytics server version, check if you have a version older than April 2018 installed. If you have an older version, you must upgrade GeoAnalytics Package to version 18.04 or later, as older data packages will not work with newer versions of the server software. You should upgrade the data package before you upgrade the GeoAnalytics server version, or map services will stop working. To upgrade the data package, review the Qlik GeoAnalytics Data Package Installation Guide.

Memory configuration

During installation “Max memory” must be configured. GeoAnalytics operations and route database require significant memory to be allocated, and your recommended maximum memory configuration depends on what data package you will use with the server. Also note that the Java environment itself may use more system memory and exceed the maximum you specify. For the Map data package, 2 GB is sufficient. For Enterprise data packages, 18 GB is recommended. Consult the readme file in the data package for more information on memory consumption.

The memory configuration can be changed by rerunning the same installer, or by opening the Java tab in the Configure Service desktop program. Changes will come into effect after restarting the service under the General tab.

HTTPS

If you use HTTPS to communicate with your QlikGeoAnalytics server, you will need a certificate for your site name (a self-signed cert will not work). The server must have the certificate and private key bundled in either the Java KeyStore or the PKCS12 (.pfx, .p12) format.

In order to install the certificates, you can export existing certs from the Windows Certificate Manager by right-clicking them, and selecting All Tasks > Export. Ensure that it is configured to export the private key, and on the Export File Format screen, select PKCS #12, and to include all certificates in the certification path. Then set a password and save it to a location where it can be accessed by the QlikGeoAnalytics server. Additional HTTPS-related security settings like HSTS can also be enabled; see Advanced settings below for more details.

Passwords

Only characters in the ASCII character set are supported in passwords. This applies to all passwords set during installation, including administrator, API and Keystore passwords.

Java 11 or later

The GeoAnalytics server software is not able to automatically locate the Java 11 JDK DLL required to run the server as a Windows service, so you will need to set it manually using the Configure Service program. In the Configure Service program, locate the Java tab, uncheck Use default and select the file ..\[JDK 11 home folder]\bin\server\jvm.dll as the Java Virtual Machine. You will also need to ensure that the Java 9 Options field does not contain “ -- add - modules=java.activation”. If it does, remove it, as it is not compatible with Java 11 or later.

Warning: Automatic detection should work with the Java 11 JRE, but as it is still in development, it has not been tested.

Add the Qlik GeoAnalytics server license

Log into the Qlik GeoAnalytics server Admin Interface from the start menu, or in browser at http://localhost:<port>/ravegeo/admin/, using the port specified during installation (default: 80).

Enter the administrator user name and password created in the server installation.

Go to the License Administration section, and add the license by pasting the license (LEF) code you received from Qlik into the text area and clicking Add License. In the field below, paste the LEF control number.

If the server has internet access, it will contact the Qlik license servers daily to verify the LEFis valid. You can force an update check by pressing the “Refresh” button. If you do not have a license for Qlik GeoAnalytics server, please contact a Qlik reseller.

Install and configure map data

Map data files and the Qlik GeoAnalytics Data Package Installation is available at the Qlik download site. Follow the guide to install and configure the required map data.

If you perform a map data upgrade, make sure you have configured enough memory for the new data package. See the data package's README file for memory requirements.

Verify the installation

To verify that the installation succeeded, check that it is possible to display a map.

In the Qlik GeoAnalytics server administration interface, go to WebMap5 Module - > Diagnostics Pages - > (default) Go To Diagnostics Pages - > Simple Test. The test should display a sample map that looks like this example:

Example map with configurable visualization options at right

In WebMap5 Module - > Module Status, you should see the following installed packages (may differ based on your GeoAnalytics version):

  • Configured WebMap Service: osm.15.6
  • Configured Geometry Services: default
  • Configured Vector Tile Services: osm.15.6
  • Configured Maps: tiledraster.15.6, default.16.6, plain.15.6

If you have installed the map services for the Qlik Sense map, then additional services should be visible here.

If your installation is not working properly, check the log at: Server Administration - > View Log and reinstall if necessary.

Using GeoAnalytics with Qlik Sense map

From Qlik Sense April 2018, the built-in Map chart can be used with GeoAnalytics server in an on-premise solution, but GeoAnalytics Data Package 18.04 or newer is required.

Install the data package according to the installation guide, ensuring you include the optional configuration steps to enable support for Qlik Sense Map.

Navigate to your Qlik Sense installation location, and edit the file mapconf.json to set the URL for the map server (serverUrl), and to enter the Sense user key you selected during data package installation in (serverKey).

For example:
{

"serverUrl":"https://mysite.com ",

"serverKey":"abcdefg"

}

Note: Every time Qlik Sense is upgraded, this file will be overwritten, so you will need to edit it again.

Using GeoAnalytics server with Qlik GeoAnalytics

When installing Qlik GeoAnalytics extensions and/or connectors for Qlik Sense/QlikView, use the serial number of your GeoAnalytics server LEF (the first row of the LEF, a 16 digit code) as your license key.

Set the default server URL for extensions and connectors to your local GeoAnalytics server location, instead of the default (e.g. https://maps.qlikcloud.com):

  • For Qlik Sense Server, edit the file ../Extensions/ideviomap/settings.js to define the location: { "server": "https://myurl.com" }
  • For Qlik Sense Desktop, the default URL can be changed on Step 3 of the GeoAnalytics installation/setup.
  • For the connector, set the serverURL in the file IdevioGeoAnalyticsConnector.exe.config which is located by default at:
    • C:\Program Files\Common Files\Qlik\Custom Data\QvIdevioConnector (for Qlik Sense)
    • C:\Program Files\Common Files\QlikTech\Custom Data\QvIdevioConnector (for QlikView)

Advanced settings

Editing C:\ProgramData\Qlik GeoAnalytics Server\config.ini allows you to enable more advanced settings and features such as HSTS. These options can be added anywhere in the config file.

Advanced features available for server configuration

Setting

Type

Default

Description

stsMaxAgeSeconds

Integer

-1

Disabled if value is negative. If value is positive, enables HSTS and sets max-age to the specified value.

stsIncludeSubdomains

Boolean

false

Enables includeSubDomains on the HSTS header.

disableGzip

Boolean

false

Disables GZIP compression if enabled.

disableRemoteAdmin

Boolean

false

Disables access to the admin GUI from other computers if enabled.

sslKeystoreType

String

 

Certificate key store type. Set to pkcs12 to use PKCS#12 certs in Java 7.

Pseudo-anonymization for IP address/referrer information in logs

You can configure the GeoAnalytics server settings to offer pseudo-anonymization for IP addresses/referrer information. When this feature is enabled, logged referrer headers will be stripped down to only contain protocol, host, and port number. IPv4 addresses will be masked such that the last octet will be set to 0, and IPv6 addresses will set the last 80 bits to 0. To enable this feature, add an attribute named anonymizeLogging to the root tag in the file C:\ProgramData\Qlik GeoAnalytics Server\server3\config\ServerSettings.xml and set it to true.

Troubleshooting

If the server fails to start, check for errors is the server log files, located at C:\ProgramData\Qlik GeoAnalytics Server\server3\logs. Each log file can offer different information:

Log file Description Check if

daemon.[date].log

Server service log

Service does not start
jetty.log

Jetty log

Service or server fails to function
main.log Main server log Server cannot be reached, or GeoAnalytics functionality does not work

Service does not start after install

Check the log folder for the file jetty.log. If the file exists, open it and find the end of the file. If the error “java.net.BindException: Address already in use: bind” is present, that means another program is currently using the port you selected for Qlik GeoAnalytics server. Either disable/reconfigure that other program, or change the port configuration for Qlik GeoAnalytics server.

Service fails with error code 1/daemon log displays errors related to Win32

These errors can occur if the service is using 32-bit Java on a 64-bit system. Ensure that you have 64-bit Java installed, and then either:

  • Uninstall all versions of 32-bit Java if not needed.
  • Force the service to use 64-bit Java by opening the Configure Service tool. Go to the Java tab, uncheck Use default, and as Java Virtual Machine select ..\bin\client\jvm.dll (jre\bin\server\jvm.dll if you use JDK), which is located in the Java home folder, usually ..\Program Files\Java\[java version].

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?