Skip to main content
Close announcements banner

Administration

Syncing users from Qlik Sense

To make the setup of users as simple as possible Qlik Alerting imports users from the linked Qlik Sense installation. This process is automatically completed when you first install the product and connect to the datasource. To manually activate the sync process you can follow the simple steps below.

Do the following:

  1. Navigate to Admin > User Management > Users. (You will need to be logged in as an administrator or the super admin to view this menu.)
  2. Click Sync Qlik Sense Users at the bottom left of the table.
Note: This process may take a number of seconds if you have a large number of users.

Assigning administrator rights to a user

You will need to always have at least one administrator user at any one time. There is no limit on how many administrator users you can assign.

Do the following:

  1. Navigate to Admin > User Management > Users.
  2. Use the search object to find the user you wish to make an administrator and highlight that row.
  3. Click on the edit button on the bottom toolbar.
  4. Change the user role dropdown and select administrator.
  5. Click Save.

Assigning user licenses

Do the following:

  1. Navigate to Admin > License Allocation. (You will need to be logged in as an administrator or the super admin to view this menu.)

    You will see a table that identifies the license types available with a count to help you see what has been assigned.

  2. Click the edit (pencil) icon of the license type you wish to assign users to.

    The next page will show you two lists of users: on the left those who have not been assigned this license type and on the right those who are already assigned.

  3. Select those users you wish to move. Use the search to find users easily.
  4. Click on the direction arrows to move them from one list to the other.
  5. Click Update.
  6. Continue to assign users to other license types as required.
Note: A user does not need to be assigned to both a broadcast and standard license. A standard license user can receive broadcast alerts as part of their license.

Assigning user privileges

There are two different types of user roles in Qlik Alerting: user and administrator. An administrator will have access to all functionality to be able to manage all aspects of the Qlik Alerting site. Users can be given additional functionality through the assignment of user privileges.

The following user privileges are available:

User privilege Description
systemAlerts Allows the user access to system alerts functionality to create and receive system alert notifications.
broadcastAlerts Allows the user access to create broadcast and managed shared alerts which are sent to users with either a standard or a broadcast license.
broadcastNotification Allows the user access to create and manage broadcast notifications. These are manually created notification messages that can be sent to a user group.
shareAlerts Allows the user to be able to share alert records they have created with other users. This functionality makes a copy of the alert record that the recipient will take ownership of when they accept.

Steps to assign a user privilege

Do the following:

  1. Navigate to Admin > User Management > User Privileges. (You will need to be logged in as an administrator or the super admin to view this menu.)

    You will see a table that identifies the user privilege types available with a count to help you see what has been assigned.

  2. Click the edit (pencil) icon of the user privilege type you wish to assign users to.

    The next page will show you two lists of users, on the left those who have not been assigned this privilege and on the right those who are already assigned.

  3. Select those users you wish to move, use the search to find users easily.
  4. Click the direction arrows to move them from one list to the other.
  5. Click Update.
  6. Continue to assign users to other license types as required.
Note: A user does not need to be assigned to both a broadcast and a standard licenses. A standard license user can receive broadcast alerts as part of their license.

Disabling access for a user

You can disable access in two ways:

  • Remove the license allocation in Admin > User Management > License Allocation.
  • Disable the user in the Admin > User Management > Users table.
Note: If the user has an Administrator role they will still be able to login even though these settings are removed, although they will not receive alert notifications.

Remove the Administrator user role, and reset to user, for any disabled users.

Updating a Qlik Alerting license

In order to use Qlik Alerting you will need a valid license key. When you initially purchased your licenses, or when you received a renewal of your licenses, you will have received an email from Qlik which included your license details, a license key, a control number and a license JSON file (attachment).

Do the following:

  1. Navigate to Admin > License Management. (You will need to be logged in as an administrator or the super admin to view this menu.)
  2. Enter the License key.
  3. Enter the Control number.
  4. Enter the Registered email. This is the email that the license email was sent to.
  5. Upload the license file <organisationName>.json that was attached to the license email.
  6. Click Update.

Using trusted SSL certificates with Qlik Alerting

The Qlik Alerting install ships with a default self-signed certificate to secure the connection between the desktop of the user and the hosted application. This is a secure approach that enables HTTPS connections but will result in error messages in browsers, such as “The site’s security certificate is not trusted” (Chrome) or “This Connection is Untrusted” (Firefox).

This also has an affect on the way the Qlik Alerting Extension will work in Qlik Sense as this can cause cross-domain errors which require the user to click on a message that allows the browser to ‘run unsafe scripts’ (not an optimal user experience).

Steps to add a trusted SSL certificate for Qlik Alerting

Do the following:

  1. Access to the Qlik Alerting server via remote desktop.
  2. Navigate to the C:\Program Files\Qlik Alerting\config\certificates folder.
  3. Backup the server.pem and server_key.pem certificate files, so you can rollback the change if necessary.

    Note:
    • If you have been using a previous version of Qlik Alerting or Ping Alerting and have client.pem and client_key.pem certificates, you can simply rename them. Replace client with server.
    • In Qlik Alerting April 2020 there is no support for pass phrases for SSL certificates.

  4. Replace the certificate files with your equivalent server.pem and server_key.pem certificate files.
  5. Restart the Qlik Alerting Gateway service.

Changing the ports for Qlik Alerting web access

If you wish to change the default ports from 4551 for HTTP and 4552 for HTTPS you must make this change in two places. For example, if you are running Qlik Alerting on a stand alone server with no other programs reserving these ports, you may wish to use ports 80 (HTTP) and 443 (HTTPS), which makes it easy for a user as they do not have to enter these default ports in the URL each time.

Do the following:

  1. Update the settings in the web UI.
    1. In the Qlik Alerting web portal, navigate to Admin > Config.
    2. Update the HTTP and ports to those you would like to change to, for example 80 (HTTP) and 443 (HTTPS).
    3. Click Save.
  2. Update the config file for the services.
    1. On the server, navigate to C:\Program Files\Qlik Alerting\config.
    2. Open the default.json file.
    3. On line 4, 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.
    5. Restart the Qlik Alerting Gateway service.
  3. You should now be able to access Qlik Alerting through these new ports.
  4. If you have used the Qlik Sense extension in any app, you will need to reset the port setting in each of these instances.

Backup and restore the MongoDB database

You will want to periodically backup the MongoDB database as this serves as the core of Qlik Alerting. It is recommended that you backup the database before each install.

Steps to backup

  1. RDP onto the server as an administrator user.
  2. Open a command window as an administrator.
  3. Enter the following to change directory:

    cd "C:\Program Files\MongoDB\Server\4.0\bin"

    Note: If you are using a newer version of MongoDB, or it is located in a different location such as a D:\ drive, then please adjust this appropriately.
  4. Enter the following command, where Backup Name is the identifier for your backup:

    mongodump --db=qlikalerting --out="Backup Name"

  5. This will create a new folder in the C:\Program Files\MongoDB\Server\4.0\bin folder called "Backup Name" and will export all of the data from the database into JSON format files.
  6. Zip this new folder and store where you require.

Steps to restore

  1. RDP onto the server as an administrator user.
  2. Open a command window as an administrator.
  3. Enter the following to change directory:

    cd "C:\Program Files\MongoDB\Server\4.0\bin"

    Note: If you are using a newer version of MongoDB, or it is located in a different location such as a D:\ drive, then please adjust this appropriately.
  4. Move the backup to a location that is easy to identify and unzip the file so the folder is located here, for example D:\backups\Backup Name.
  5. Enter the following command, where Backup Name is the identifier for your backup:

    mongorestore "D:\backups\Backup Name"

  6. You will now have restored the qlikalerting database in MongoDB.