Overview
Opens an app and checks if the app needs to be migrated (if the app is deprecated).
The OpenDoc method compares the version of the app with the version of Qlik Sense and migrates the app to the current version of Qlik Sense if necessary. Once the migration is done, the app is opened.
If no migration is needed, the app is opened immediately.
The following applies:
- The app version is lower than 0.95: no migration is done. Apps older than the version 0.95 are not supported.
- The app version is at least 0.95 and less than the Qlik Sense version: the app is migrated and then opened.
- Qlik Sense and the app have the same version: the app is opened, no migration is needed.
Backups
Apps are automatically backed up before a migration, if using Qlik Sense Desktop.
Qlik Sense
When using Qlik Sense Server, no automatic back up is run. The back up should be done manually.
Qlik Sense Desktop
The backup files are located in %userprofile%\Documents\Qlik\Sense\AppsBackup\<Qlik Sense Desktop version>.
Parameters
| Name | Description | Type |
|---|---|---|
| qDocName |
• In server mode: GUID of the app. • In desktop mode: Name of the app to retrieve. This parameter is mandatory. |
String |
| qUserName |
Name of the user that opens the app. This parameter is optional. |
String |
| qPassword |
Password of the user. This parameter is optional. |
String |
| qSerial |
Current Qlik Sense serial number. This parameter is optional. |
String |
| qNoData |
Set this parameter to true to be able to open an app without loading its data. When this parameter is set to true, the objects in the app are present but contain no data. The script can be edited and reloaded. This parameter is optional and the default value is false. |
Boolean |
Logs
When this method is called, audit activity logs are produced to track the user activity.
In the case of errors, both audit activity logs and system services logs are produced.
The log files are named as follows:
| Audit activity log | System service log |
|---|---|
|
<MachineName>_AuditActivity_Engine.txt in server mode <MachineName>_AuditActivity_Engine.log in desktop mode |
<MachineName>_Service_Engine.txt in server mode <MachineName>_Service_Engine.log in desktop mode |
Where to find the log files
The location of the log files depends on if you are running Qlik Sense Desktop or Qlik Sense.
| Qlik Sense | Qlik Sense Desktop |
|---|---|
|
%ProgramData%/Qlik/Sense/Log/Engine |
%UserProfile%/Documents/Qlik/Sense/Log |
Learn more
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!