OliveTin/docs/modules/ROOT/pages/action_execution/ondemand.adoc

[#exec-on-click]
[#onclick]
= Execute on click

OliveTin has several options to control what happens when an action button is clicked and the execution starts. This can be controlled on a per-action basis using the `onclick` configuration option.

You can also set the default for OliveTin using the `defaultOnClick` configuration option.

NOTE: The older names `popupOnStart` and `defaultPopupOnStart` do exactly the same thing. OliveTin copies legacy values into `onclick` / `defaultOnClick` during config load. New configurations should use `onclick` and `defaultOnClick`.

== Big Flashy Buttons (default)

[source,yaml]
.`config.yaml`
----
actions:
  - title: Ping the Internet
    onclick: default
----

This will also be the option that is used if no other values match.

image::../flashyButton.png[]

== Execution Dialog

When an action uses `execution-dialog`, OliveTin opens the execution results view with the command output, plus the start time, end time, exit code, and duration.

[NOTE]
The legacy option `execution-dialog-stdout-only` is deprecated in OliveTin 3k. It is still accepted in config files for compatibility, but is treated the same as `execution-dialog`.

[source,yaml]
.`config.yaml`
----
actions:
  - title: Check dmesg logs
    onclick: execution-dialog
----

.Example of `onclick: execution-dialog`
image::action_customization/execution-dialog/executionDialog.png[]

== Execution Buttons

This mode will create a new button for each individual execution. This can be useful for actions that are executed again and again.

The text of the button (eg, "0s" in the screenshot below), is the time it took to execute the action in seconds.

[source,yaml]
.`config.yaml`
----
actions:
  - title: date
    onclick: execution-button
----

image::../executionButtons.png[]

== Action execution history

The `history` option opens the action details page for that binding when the execution starts, so you can see past runs and status for the same action.

[source,yaml]
.`config.yaml`
----
actions:
  - title: Long-running job
    onclick: history
----