Qlik Cloud RunAutomation

Qlik Cloud RunAutomation
Certified
Run a Qlik Automate automation

Starts a run of a Qlik Automate automation and, by default, waits for it to reach a final status. finished with warnings counts as a success unless failOnWarnings is set. Automation inputs are out of scope: they require Triggered mode and a per-automation webhook token.

yaml
type: io.kestra.plugin.qlikcloud.automations.RunAutomation

Examples

Run a Qlik Automate automation by id

yaml
id: qlik_run_automation_by_id
namespace: company.team

tasks:
  - id: run_automation
    type: io.kestra.plugin.qlikcloud.automations.RunAutomation
    tenantUrl: https://mytenant.eu.qlikcloud.com
    apiKey: "{{ secret('QLIK_API_KEY') }}"
    automationId: 60f2e3b1a1b2c3d4e5f6a7b8

Run a Qlik Automate automation by space and automation name

yaml
id: qlik_run_automation_by_name
namespace: company.team

tasks:
  - id: run_automation
    type: io.kestra.plugin.qlikcloud.automations.RunAutomation
    tenantUrl: https://mytenant.eu.qlikcloud.com
    apiKey: "{{ secret('QLIK_API_KEY') }}"
    spaceName: Sales Analytics
    automationName: Refresh source extracts

Run an automation, then reload the app it feeds

yaml
id: qlik_automation_then_reload
namespace: company.team

tasks:
  - id: run_automation
    type: io.kestra.plugin.qlikcloud.automations.RunAutomation
    tenantUrl: https://mytenant.eu.qlikcloud.com
    apiKey: "{{ secret('QLIK_API_KEY') }}"
    automationId: 60f2e3b1a1b2c3d4e5f6a7b8

  - id: reload_app
    type: io.kestra.plugin.qlikcloud.apps.Reload
    tenantUrl: https://mytenant.eu.qlikcloud.com
    apiKey: "{{ secret('QLIK_API_KEY') }}"
    appId: 70a3f4c2b2c3d4e5f6a7b8c9
    assets:
      enableAuto: true

Properties

apiKey *string

API key

A Qlik Cloud API key, or a pre-obtained OAuth 2.0 access token: both are sent as-is in the Authorization: Bearer header. Generate an API key from the tenant's Management Console (Identity & access > API keys).

tenantUrl *string

Qlik Cloud tenant URL

The tenant root URL, e.g. https://mytenant.eu.qlikcloud.com. Do not append /api/v1.

automationId string

Automation ID

Qlik Cloud automation identifier. Mutually exclusive with spaceName + automationName.

automationName string

Automation name

Automation name, resolved together with spaceName. Mutually exclusive with automationId.

failOnWarnings booleanstring

Defaultfalse

Fail on warnings

If true, a run that finished with warnings (finished with warnings) fails the task instead of succeeding. Default false.

maxDuration string

DefaultPT4H

Max wait duration

Ceiling for waiting on completion. Default PT4H (Qlik Cloud reloads are capped at about 3h). On timeout the task fails with the last known status; the remote run is NOT canceled.

pollFrequency string

DefaultPT10S

Poll frequency

Interval between status checks when waiting. Default PT10S; cannot usefully go below 1s (Qlik Cloud rate limits).

reattach booleanstring

Defaulttrue

Reattach to an in-flight or already-finished run

If true (default), the task remembers the run it triggered (keyed by this taskrun id) and, on a worker restart or a manual Restart, adopts it instead of triggering a duplicate: a still-running run resumes polling, an already-finished run is adopted as-is. A stored id no longer found on Qlik Cloud (404) logs a warning and triggers a fresh run. The trigger call itself is never blindly retried on an ambiguous failure (e.g. a timeout), since that could create a duplicate run; the failure surfaces so a flow-level retry or a manual restart can safely re-attach or re-trigger.

A manual Restart of an execution on the same flow revision keeps the original taskrun ids, so this remembered run is still found afterward. In particular, after a maxDuration timeout or a wait: false return, the remembered entry is deliberately kept (the remote run may still be in progress): a later Restart of that taskrun then reattaches to it instead of triggering a fresh one. To force a brand-new run on the next attempt regardless of what is remembered — for example after fixing the app or automation itself — set reattach: false for that attempt, or clear it by giving the task a different id (a flow update that changes the taskrun id).

spaceName string

Space name

Name of the Qlik Cloud space containing the target resource, used together with its name property. Ignored when the id is set.

wait booleanstring

Defaulttrue

Wait for completion

If true (default), polls Qlik Cloud until the run reaches a final status.

Outputs

automationId string

Automation ID

Resolved automation identifier — useful when the automation was targeted by name.

automationName string

Automation name

runId string

Run ID

Qlik Cloud identifier of the triggered automation run.

spaceId string

Space ID

Id of the Qlik Cloud space containing the automation.

startTime string

Formatdate-time

Start time

status string

Run status

One of the documented Qlik Automate statuses. Final: finished, finished with warnings, failed, stopped, exceeded limit. Still running: not started, starting, queued, running, must stop (a stop was requested but the run hasn't finished ending yet).