Qlik Cloud Monitoring Apps Workflow Guide

Sonja_Bauernfeind · Dec 5, 2025 7:31:22 AM

This template was updated on December 4th, 2025 to replace the original installer and API key rotator with a new, unified deployer automation.

The original templates will remain available for a short period; these will be removed on or after January 28, 2026.

Installing, upgrading, and managing the Qlik Cloud Monitoring Apps has just gotten a whole lot easier! With a single Qlik Automate template, you can now install and update the apps on a schedule with a set-and-forget installer using an out-of-the-box Qlik Automate template. It can also handle API key rotation required for the data connection, ensuring the data connection is always operational.

Some monitoring apps are designed for specific Qlik Cloud subscription types. Refer to the compatibility matrix within the Qlik Cloud Monitoring Apps repository.

'Qlik Cloud Monitoring Apps deployer' template overview

This automation template is a set-and-forget template for managing the Qlik Cloud Monitoring Applications, including but not limited to the App Analyzer, Entitlement Analyzer, Reload Analyzer, and Access Evaluator applications. Leverage this automation template to quickly and easily install and update these or a subset of these applications with all their dependencies. The applications themselves are community-supported; and, they are provided through Qlik's Open-Source Software (OSS) GitHub and thus are subject to Qlik's open-source guidelines and policies.

For more information, refer to the GitHub repository.

Features

Can install/upgrade all or select apps.
Can create or leverage existing spaces.
Programmatically verified prerequisite settings, roles, and entitlements, notifying the user during the process if changes in configuration are required, and why.
Installs latest versions of specified applications from Qlik’s OSS GitHub.
Creates required API key.
Creates required analytics data connection.
Creates a daily reload schedule.
Reload applications post-install.
Tags apps appropriately to track which are installed and their respective versions.
Supports both user and capacity-based subscriptions.

Configuration:

Update just the configuration area to define how the automation runs, then test run, and set it on a weekly or monthly schedule as desired.

Configure the run mode of the template using 7 variable blocks

Users should review the following variables:

configuredMonitoringApps: contains the list of the monitoring applications which will be installed and maintained. Delete any applications not required before running (default: all apps listed).
refreshConnectorCredentials: determines whether the monitoring application REST connection and associated API key will be regenerated every run (default: true).
reloadNow: determines whether apps are reloaded immediately following updates (default: true).
reloadScheduleHour: determines at which hour of the day the apps reload at for the daily schedule in UTC timezone (default: 06)
sharedSpaceName: defines the name of the shared space used to import the apps into prior to publishing. If the space doesn't exist, it'll be created. If the space exists, the user will be added to it with the required permissions (default: Monitoring - staging).
managedSpaceName: defines the name of the managed space the apps are published into for consumption/ alerts/ subscription use.If the space doesn't exist, it'll be created. If the space exists, the user will be added to it with the required permissions (default: Monitoring).
versionsToKeep: determines how many versions of each staged app is kept in the shared space. If set to 0, apps are deleted after publishing. If a positive integer value other than 0, that many apps will be kept for each monitoring app deployed (default: 0).

App management:

If the monitoring applications have been installed manually (i.e., not through this automation), then they will not be detected as existing. The automation will install new copies side-by-side. Any subsequent executions of the automation will detect the newly installed monitoring applications and check their versions, etc. This is due to the fact that the applications are tagged with "QCMA - {appName}" and "QCMA - {version}" during the installation process through the automation. Manually installed applications will not have these tags and therefore will not be detected.

FAQ

Q: Can I re-run the installer to check if any of the monitoring applications are able to be upgraded to a later version?

A: Yes. The automation will update any managed apps that don't match the repository's manifest version.

Q: What if multiple people install monitoring applications in different spaces?

A: The template scopes the application's installation process to a managed space. It will scope the API key name to `QCMA – {spaceId}` of that managed space. This allows the template to install/update the monitoring applications across spaces and across users. If one user installs an application to “Space A” and then another user installs a different monitoring application to “Space A”, the template will see that a data connection and associated API key (in this case from another user) exists for that space already. It will install the application leveraging those pre-existing assets.

Q: What if a new monitoring application is released? Will the template provide the ability to install that application as well?

A: Yes, but an update of the template from the template picker will be required, since the applications are hard coded into the template. The automation will begin to fail with a notification an update is needed once a new version is available.

Q:I have updated my application, but I noticed that it did not preserve the history. Why is that?

A: Each upgrade may generate a new set of QVDs if the data models for the applications have changed due to bug fixes, updates, new features, etc. The history is preserved in the prior versions of the application’s QVDs, so the data is never deleted and can be loaded into the older version.

jda_bryan · ‎2023-12-05

This is fantastic functionality. These apps are so important to tenant administration and leveraging the automation process to enable and manage them is such a useful lift. The video help was absolutely spot on. Thank you!!

luizcdepaula · ‎2023-12-06

Hi @Sonja_Bauernfeind ,

This is fantastic and a great step towards automating the updates of the monitoring apps. I found it was extremely easy to use the automation. I just have some feedback.

1. It would be fantastic if instead of setting up the alerts and running on demand, we could have it scheduled to run every month automatically, looking for updates. So, being able to save the current selections of the settings would be great.

2. We have the API Key with expiration in 3 years. The max window to be scheduled is 30 days. We will run it on demand, but being able to schedule with more custom window would be nice.

Thank you!

Luiz DP

Daniel_Pilla · ‎2023-12-06

Hi @jda_bryan , thank you so much for the feedback. I am glad you find the applications and resources so useful! We here at Qlik also use and depend on them, and agree 🙂

Hi @luizcdepaula , thank you for the feedback as well!

I thought about this quite a bit and actually almost built that. After speaking internally with colleagues, we decided that three automations might be too much, and in addition, polling the apps on a regular basis incurs automation runs, so we did not want to have people run up their quotas by checking frequently when we could do it with no impact with Qlik Data Alerts. In addition, the automation would have to be customizable as you might only want to check for certain apps, or you might want to snooze certain updates. It also requires SMTP for emails, while Qlik Data Alerting does not as they can be received in the client. For those reasons we opted not to, but you could very easily write an automation that loops over the apps, checks their respective versions, and then compares them to the version found in the manifest here. That is the same source that the installer uses.
I will defer this one over to @Emile_Koslowski for any updates to the scheduling capabilities. That said, you can use any RESTful method of triggering the automation programmatically on any custom schedule that you'd like using another scheduling mechanism. For example, you could use an Qlik app with load script to trigger the automation to start using the REST connector, then set that script on a yearly schedule.

I hope this helps!

Cheers,

Shohamgg · ‎2023-12-07

Wow, what a wonderful resource.
you clearly put a lot of work into this and it shows.
Thank you

I have two small comments 🙂
1) Sunday is a working day for me but it is not available for selection.
2) App Analyzer failed to load but the Automation declared "Success!"

Thank you for this tool. it helps a lot!
Also I learned more about Application Automations capabilities

Daniel_Pilla · ‎2023-12-07

Hi @Shohamgg ,

Thanks for the kind words! Glad you like it.

1. You can edit the reload schedule to add on Sunday for each application in the Managed space (or Shared/Personal if you did not publish). You can just tick on Sunday there for each. We did not include it in the installer by default so we are not reloading 7 days a week unnecessarily.

2. The automation is responsible for importing the selected applications, setting them up, and optionally triggering their reloads. The automation completes before the reloads finish and does not wait for success/failure there. If you are having an issue with the App Analyzer, please create an issue on the GitHub page here with details and I will take a look.

Cheers!

luizcdepaula · ‎2023-12-07

Hi @Daniel_Pilla ,

Thank you for your response.

1. I can see now the reason of the alerts and not scheduling. Still having the option would be great. Just too many alerts 🙂 . I will definitely take you up on the automation looping over the apps. If you have already something built I would highly appreciate.

2. Using an app as trigger is doable, I just don't like the fact that I need to add another app just for scheduling, adding another layer of liability.

This is great though! I know it is hard to accommodate every need, and this is great.

Thanks,

Luiz DP

petrus · ‎2024-01-03

Hi @Daniel_Pilla , I really like that solution. It simplifies the whole process of deploying the apps over time. But what happens if we have some additional sheets as private/community during the upgrade process? The old app is removed and new one is published as a new copy or this works the way of republishing existing app by new one?

Btw qvd's are removed during the upgrade process too?

Thanks

PR

Daniel_Pilla · ‎2024-01-03

Hi @petrus ,

If the application is published to a managed space, the installer will offer you the option of publishing a new copy side-by-side or publishing and replacing the older version. If you choose to publish and replace, all of the community/private content will be preserved, else, that content will only reside on the archived (branded Legacy) older version.

Regarding QVDs, all of the original QVDs will remain but they are suffixed with a version number. Each version of the app reloads from its respective version numbered QVDs. This is to safeguard against data model changes etc. This really only impacts the Reload Analyzer and Entitlement Analyzer heavily. I'd advise checking the release notes for each latest release to see if it is for a major bug fix or if its just an enhancement etc to see if its worth jumping to the latest version if you really require the history. The older versions of the applications will also still be operational against the historical QVDs, so if history is needed for reference it can be viewed in the older versions, as the newer versions will generate their own QVDs.

I hope this helps!

Cheers,

AlexOmetis · ‎2024-02-22

Hi,

We love this automation - it saves so much time when setting up a new tenant!

Are there plans to make it work with tenants with Capacity licensing? I know there's the capacity monitoring for data/automations etc but it doesn't cover many of the areas that these apps do.

Daniel_Pilla · ‎2024-02-23

Hey @AlexOmetis,

Good to hear from you and glad you like it!

The reason the automation was scoped to user-based tenants initially was primarily because the App Analyzer and the Reload Analyzer needed to be adjusted to operate correctly on a Capacity-based tenant. In addition, the Entitlement Analyzer is largely irrelevant for a Capacity tenant and there are no plans of supporting/migrating it to Capacity-based tenants. Rather than write in the logic to exclude certain apps, adjust pre-requisite checks depending on license, and modify the other apps before releasing the template, we chose to get it out the door faster and release it for user-based tenants first as Capacity is still quite new.

That said, it is on my agenda for next month to modify the automation to support both license types now that the App Analyzer and Reload Analyzer apps have been adjusted to work on Capacity-based tenants. There will have to be a number of modifications done to the automation, however the net is that you will not see the Entitlement Analyzer available to install if you are on a capacity-based tenant with the new automation. I can't provide a projected release date, but work will begin likely next week.

Cheers!

Qlik Cloud Monitoring Apps Workflow Guide