Skip to content

Alert Template Fields for Failed App Reloads (Qlik Sense Cloud)

List of template fields available in Butler's failed app reload alert messages for Qlik Sense Cloud.

Template Fields

Butler uses the Handlebars library for templating work.

Handlebars offers a lot of useful features (nested template fields, evaluation context, template comments) and it's recommended that you browse through at least the language features section of their getting started guide to get a feeling for what's possible.

Important

If a template field is used for an alert type where that field is not supported, the field will simply be blank. No errors will occur, but it can still be tricky to debug if you're not aware of this.

The following template fields are available in alert messages:

Basic App Information

Field nameDescription
tenantIdID of the tenant where the reload took place
tenantCommentComment for the tenant, as entered in Qlik Cloud
tenantUrlURL to the tenant
userIdID of the user who triggered the reload
userNameName of the user who triggered the reload
appIdID of Sense app
appNameName of app
appDescriptionDescription of app
appUrlURL to the app
appHasSectionAccessDoes the app have section access? (true/false)
appIsPublishedIs the app published? (true/false)
appPublishTimeDate/time when app was published
appThumbnailURL to the app thumbnail

App Owner Information

Field nameDescription
appOwnerNameName of app owner
appOwnerUserIdApp owner user's user id
appOwnerPictureURL to the app owner's profile picture
appOwnerEmailApp owner email

Reload Information

Field nameDescription
reloadTriggerWhat triggered the reload? Manually, scheduled etc
sourceSource of the reload. Usually com.qlik/engine
eventTypeType of QS Cloud event. For example com.qlik.v1.app.reload.finished
eventTypeVersionVersion of the event type
endedWithMemoryConstraintDid the reload end due to a memory constraint? (true/false)
isDirectQueryModeIs the app in Direct Query mode? (true/false)
isPartialReloadWas the reload a partial reload? (true/false)
isSessionAppIs the app a session app? (true/false)
isSkipStoreShould storing (to disk) the reloaded app be skipped? (true/false)
reloadIdID of the reload
rowLimitRow limit for the reload
statements[]Array of statements from the engine
statusStatus of the reload. For example error

Performance Metrics

Field nameDescription
usageDurationDuration of the reload
peakMemoryBytesPeak memory usage during the reload
sizeMemoryBytesMemory usage during the reload
appFileSizeSize of app file (on disk)

Error Information

Field nameDescription
errorCodeError code for the reload. For example "EngineReloadScriptError"
errorMessageError message for the reload. For example "error in app script or datasource"
logMessageLog message from the Sense log files (see example below)

Execution Timing

Duration

Field nameDescription
executionDuration.hoursexecutionDuration is a JSON object.
Duration of reload (hours part)
executionDuration.minutesDuration of reload (minutes part)
executionDuration.secondsDuration of reload (seconds part)

Start Time

Field nameDescription
executionStartTime.startTimeUTCJSON object.
UTC timestamp for reload start
executionStartTime.startTimeLocal1Reload start timestamp, format 1
executionStartTime.startTimeLocal2Reload start timestamp, format 2
executionStartTime.startTimeLocal3Reload start timestamp, format 3
executionStartTime.startTimeLocal4Reload start timestamp, format 4
executionStartTime.startTimeLocal5Reload start timestamp, format 5

Stop Time

Field nameDescription
executionStopTime.stopTimeUTCJSON object.
UTC timestamp for reload end
executionStopTime.stopTimeLocal1Reload end timestamp, format 1
executionStopTime.stopTimeLocal2Reload end timestamp, format 2
executionStopTime.stopTimeLocal3Reload end timestamp, format 3
executionStopTime.stopTimeLocal4Reload end timestamp, format 4
executionStopTime.stopTimeLocal5Reload end timestamp, format 5

Script Log Information

Field nameDescription
executionStatusTextFinal reload task status message, for example FAILED
scriptLogSizeSize of the reload's script log (characters)
scriptLogSizeRowsSize of the reload's script log (rows)
scriptLogSizeCharactersSize of the reload's script log (characters)
scriptLogHeadCountNumber of lines extracted from the start of the script log
scriptLogTailCountThe first y lines from the reload's script log
scriptLogHeadThe first x lines from the reload's script log
scriptLogTailNumber of lines extracted from the end of the script log
Field nameDescription
qliksSenseQMCLinks to QMC, as defined in main config file
qliksSenseHubLinks to Hub, as defined in main config file
genericUrlsLinks to other systems, as defined in main config file

Example Log Message

The logMessage field contains detailed information from the Sense log files. Here's an example:

ReloadID: 670e1df04cf4e529c035c902
Started loading data
(A detailed script progress log can be downloaded when the reload is finished)
Characters << AUTOGENERATE(26) 26 Lines fetched
ASCII << AUTOGENERATE(255) 191 Lines fetched
Transactions << AUTOGENERATE(1000) 2,027 Lines fetched

Data has not been loaded. Please correct the error and try loading again.
The following error occurred:
Unknown statement: ThisFailsForSure...

The engine error code: EDC_ERROR:11002
The error occurred here:
ThisFailsForSure...

Released under the MIT License.