Qlik Alerting installation

Install Qlik Alerting

Do the following:

1. Check that the MongoDB service is running in the Windows services window or that your server has access to the external MongoDB instance.

2. Download the Qlik Alerting installer and save it to you hard drive ready for installation. This is accessible from Product Downloads.

   See: Downloading installation files

3. Right-click the Qlik Alerting Installer.exe file, and then click Run as Administrator.
4. Click Yes if you get the User Account Control message.
5. Accept the license agreement and click Next.
6. Once the installation is finished, open Windows services and check to ensure that all the Qlik Alerting services are running. If any of these are not running, start through this window.

Access Qlik Alerting through the browser on the server, use http://localhost:4551 or https://localhost:4552 for the initial setup. You can also access the server from your desktop browser if you have setup the appropriate firewall and server DNS details.

Qlik Sense connection configuration

Do the following:

1. Enter the following details for your Qlik Sense site.

   • Qlik Sense hostname is the IP or DNS of the Qlik Sense Server. (This should be an allow-listed value in the Qlik Sense Virtual Proxy is the URL which you use to access the server from any desktop.)

   • Qlik Sense Service listen port HTTPS is the HTTPS connection port for Qlik Sense. This will normally be the default value of 443 but if this has been customized you can change the value here. You can see if this and the following Qlik Ports have been customized in the Qlik Management Console (QMC) in the settings for the proxy you will be connection to.

   • Qlik REST API listen port will default to 4243 as per the standard install of Qlik Sense.

   • Qlik Repository API listen port will default to 4242 as per the standard install of Qlik Sense.

   • Connect as user directory is the Qlik Sense directory that the above user is assigned to.

   • Connect as user id is the Qlik Sense UserID that you will use to test the connection and run some of the background connection tasks.

     Information noteEnsure this user is a root admin in Qlik Sense or a user who can access all users, tasks, and apps. This user must also have a valid license in Qlik Sense.

   • Filter for user fetch (optional) allows the limiting of the users that will sync across from Qlik Sense. See Filter users from Qlik Sense for details on the options and syntax to use.

   • Virtual proxy prefix (optional) will remain blank by default. Qlik Alerting connects using the Windows authentication pattern. In most cases the ‘Central Proxy (Default)’ virtual proxy setup will work in this way so you can leave this field blank. If you have a different authentication setup, or wish to connect to a different virtual proxy, enter the Prefix for the virtual proxy in this field.

   • Session cookie header name will default to X-Qlik-Session. This is the standard setup of the default virtual proxy. If you are connecting to different virtual proxy, this value will be changed (as it is distinct for each virtual proxy). Check the virtual proxy in the QMC to identify the value to enter here. It is common to use X-Qlik-Session-<Prefix> but this is not mandatory.

   • Alias hostname allows you to enter a different URL for user access to the server and is used in all Qlik Sense links in emails and mobile notifications.

     • Ensure that this is the URL that users use to access the Qlik Sense environment from their browsers.

     • If users access with a different virtual proxy to the data connection above, add this virtual proxy to the URL, for example, qliksense.company.com/okta where okta is the user access virtual proxy prefix.

     • If you are using the Qlik Alerting extension and connecting to it with a proxy or reverse proxy, enter the server address in the Reverse proxy URL redirection field.

   • Authentication specifies the authentication pattern. To enable single sign-on authentication using Qlik Sense Enterprise on Windows credentials, select SSO. Then add the authentication URL in the Authentication URL field.

     For information on how to set up single sign-on authentication, see Configuring single sign-on from Qlik Sense Enterprise on Windows to Qlik Alerting.

2. On the right hand side use the buttons to upload your certificates that have been exported from Qlik Sense, you need only the client.pem and client_key.pem files.

   See Exporting Qlik Sense certificates for instructions on how to obtain the certificates from Qlik Sense.

   Information noteEnsure you have recently updated certificates from Qlik Sense as these exported certificates can be invalid after a Qlik Sense Enterprise upgrade. The Qlik Sense Enterprise February 2020 release was a release which requires all exported certificates to be regenerated.
3. Click Test Connection. You should see a message saying connection successful.
4. Click Save to save your configuration settings.

Select an administration user

In order to manage the Qlik Alerting site an administration user must be present in the Qlik Alerting repository. Enter the domain\username of the administration user to search for the correct user.

If no email address is present for this selected admin user you will be prompted to add an email to ensure that you can set the password when first logging on.

Qlik Alerting will send you an email directly with a set password link. Click on this to set your password.

Additional step if ports were changed in Qlik Alerting settings step

Do the following:

1. On the server navigate to C:\Program Files\Qlik Alerting\config.
2. Open the default.json file in a text editor.

3. In the gateway object, on line 4 by default, edit "httpPort": 4551; changing the 4551 value to your HTTP port entered in the Qlik Alerting settings step, for example port 80.

4. On line 5, edit "httpsPort": 4552; changing the 4552 value to your HTTPS port entered in the Qlik Alerting settings step, for example port 443.

   {
   	"gateway": {
           "ip": "localhost",
           "httpPort": 80,
           "httpsPort": 443,
           "https": true
       },
       

5. Restart the Qlik Alerting Gateway service.