Performs reload of the Qlik Applications specified. The reloading process for the multiple applications will be processed in a step-by-step order.
Syntax
QOps-Reload -Filter [-Profile] [-Attached] [-Detached] [-Status] [-Wait] [-ShowLogs <n>] [-Timeout <seconds>]
Parameters meaning:
-Filter defines parameters for selecting applications to process with QOps, allows filtering by following:
- Application Name
- Application Id
- Application Owner
- Application Stream
The multiple masks are supported in a way of repeating the field identifier with a semicolon separator, ex.: -Filter "Name=*ibcs*;Name=*api*,Id=*,Owner=*,Stream=*"
The Semicolon defines result joining with OR logic, the Comma defines results joining with AND logic. When the field name is omitted all possible values for this field will be applied.
-Profile overrides default User Profile with the specified one
-Attached means that application(s) will be reloaded synchronously and further command input will be available once reloading has been completed, set by default
-Detached means that application(s) will be reloaded asynchronously and further command input will be available immediately
-Status shows application(s) reloading status according to the -Filter applied
-Wait keeps reloading status table opened until all reloading has been completed
-ShowLogs <n> outputs the last n lines of application reloading logs when it is failing, works with -Detached/-Status and -Wait keys only. When n is set to -1, outputs all rows from reloading log file.
-Timeout <seconds> sets how many seconds QOps waits before it stops waiting. Leaving it off changes nothing: every command waits exactly as long as it did before.
It bounds how long QOps watches, not how long the reload may take. When the time runs out nothing is cancelled: the reload carries on in Qlik and usually finishes. The run says so and names what was still running, so a reload you stopped waiting for can be told apart from one that failed.
It applies wherever QOps polls for the answer, which on Qlik Sense means -Detached -Wait and -Status -Wait. A plain attached reload on Qlik Sense is handled by the Qlik engine in a single call that QOps waits out rather than polls, so -Timeout does not reach it; the engine's own hour-long ceiling still applies there.
-Mode explicitly overrides the platform mode. Values: QlikSense, QlikSaaS, QlikView. When not specified, QOps auto-detects from configuration.
-VerboseLog enables full verbose output including complete API response dumps and debug information. By default, QOps now produces concise output summaries.
Examples
QOps-Reload -Filter "Name=*project1*;Name=*project2*,Owner = username1"
Performs reload of the Qlik Applications specified. The reloading process for the multiple applications will be processed in a step-by-step order. For the QlikView mode the Qlik Management Console installation is required.
Syntax
QOps-Reload -Filter -ServiceURL [-Profile]
Parameters meaning:
-Filter defines parameters for selecting applications to process with QOps, allows filtering by following:
- Application Name
The multiple masks are supported in a way of repeating the field identifier with a semicolon separator, ex.: -Filter "Name=*ibcs*;Name=*api*"
The Semicolon defines result joining with OR logic, the Comma defines results joining with AND logic. When the field name is omitted all possible values for this field will be applied.
-ServiceURL defines an URL for the Qlik Management Console connection.
-Profile overrides default User Profile with the specified one
-Attached means that application(s) will be reloaded synchronously and further command input will be available once reloading has been completed, set by default
-Detached means that application(s) will be reloaded asynchronously and further command input will be available immediately
-Status shows application(s) reloading status according to the -Filter applied
-Wait keeps reloading status table opened until all reloading has been completed
-ShowLogs <n> outputs the last n lines of application reloading logs when it is failing, works with -Detached/-Status and -Wait keys only. When n is set to -1, outputs all rows from reloading log file.
Examples
QOps-Reload -Filter "Name=*application*" -ServiceURL "http://localhost:4799"
Performs reload of the Qlik Applications specified. The reloading process for the multiple applications will be processed in a step-by-step order.
Syntax
QOps-Reload -Filter [-Profile] [-Attached] [-Detached] [-Status] [-Wait] [-ShowLogs <n>] [-Timeout <seconds>]
Parameters meaning:
-Filter defines parameters for selecting applications to process with QOps, allows filtering by following:
- Application Name
- Application Id
- Application Owner
- Application Space
The multiple masks are supported in a way of repeating the field identifier with a semicolon separator, ex.: -Filter "Name=*ibcs*;Name=*api*,Id=*,Owner=*,Space=*"
The Semicolon defines result joining with OR logic, the Comma defines results joining with AND logic. When the field name is omitted all possible values for this field will be applied.
-Profile overrides default User Profile with the specified one
-Attached means that application(s) will be reloaded synchronously and further command input will be available once reloading has been completed, set by default. If -Attached and -Detached are both set, the detached one is dropped.
-Detached hands the reload of every selected application to the tenant and returns as soon as they are accepted, with one row per application: the id of the reload that was started, the application's name, and the state that reload is in. Add -Wait to hold until every one of them finishes instead.
-Status reports the most recent reload of every application the filter selects, and starts nothing. This is the other half of -Detached: start the reloads in one run, ask how they went in a later one. Asking while a reload is still running is the normal case. The answer is the state of the last reload of each application, not a history.
The states read the same as on Qlik Sense:
| State | Meaning |
|---|---|
| Queued | accepted, not started yet |
| Started | running |
| FinishedSuccess | finished, data updated |
| FinishedFail | finished, the script failed; -ShowLogs says why |
| Aborting, Aborted | being cancelled, cancelled |
| NeverStarted | the tenant has never reloaded this application |
| Error | the reload ended in a state QOps does not recognise |
-Wait holds until the reload reaches a terminal state and reports its outcome, instead of reporting whatever state it is in at the moment you ask. Anything that has to know whether the reload succeeded, such as a pipeline or a chained step, needs it.
-ShowLogs <n> returns the last n lines of the reload log of the reloads that failed; 0 is off. Only a failed reload has a log to show. On Qlik Cloud the log comes back together with the status, so it does not need -Wait: QOps-Reload -Status -ShowLogs 200 returns the log of the last reload that failed without reloading anything.
-Timeout <seconds> sets how many seconds one run waits before QOps stops waiting. On Qlik Cloud it takes precedence over ReloadTimeoutSeconds in the repository's .qopsconfig, which in turn takes precedence over the built-in 600 seconds, so the file can carry what suits most of your applications while one command makes room for the one that takes longer:
ReloadTimeoutSeconds: 1800
It bounds how long QOps watches, not how long the reload may take. When the time runs out nothing is cancelled: the reload carries on in Qlik Cloud and usually finishes. The run names the reload id, so you can ask about it afterwards with -Status.
Such a run reports the application as Unfinished. That is deliberately neither a success nor a failure: the reload did not fail, and it has not been confirmed either, so a pipeline treats it as not successful. If you want a reload you never wait for, use -Detached.
On Qlik Cloud -Timeout applies to -Detached -Wait, -Status -Wait and the plain attached reload.
Examples
QOps-Reload -Filter "Name=*project1*;Name=*project2*,Owner = username1"
QOps-Reload -Filter "Name=Sales*" -Detached
Starts the reloads and returns at once, with the reload id of each application.
QOps-Reload -Filter "Name=Sales*" -Status -ShowLogs 200
Reports the last reload of each application and returns the last 200 log lines of any that failed. Starts nothing.
QOps-Reload -Filter "Name=Sales Dashboard" -Timeout 1800
Reloads and waits at most 30 minutes for the result.