Action

An action is something that can be performed by actor or the node of an actor. An action may trigger a state transition and / or may update the process projection.

YAML

issue:
 title: Issue new license
 actor: issuer
 if: !ref vars.license == null
 update:
   set: vars.license

JSON

{
  "issue": {
    "$schema": "https://specs.letsflow.io/v0.2.0/action/schema.json",
    "actor": "issuer",
    "responses": {
      "ok": {
        "title": "Issued new license",
        "update": [
          {
            "select": "assets.license"
          },
          {
            "select": "assets.available",
            "projection": "{shipments: shipments, quantity: quantity}"
          }
        ]
      }
    }
  }
}

JSON Schema

https://schemas.letsflow.io/v1.0.0/action

Action

$schema

The action JSON schema URI that describes the JSON structure of the action. This is also be used for automation and may be used by the UI.

title

A short title for the action.

description

A long description of the action that is shown when the action has been performed.

actor

The key of the actor that may perform this action. If more than one actor may perform the action, use an array.

if

This field must be true for the action to be allowed to be executed. Typically used in combination with a <ref> data function.

update

Update instruction or array of update instructions.

Update instruction

Update instructions can update the process information, like variables or actors.

set

A reference to the item in the process that should be updated. This must target a property of actors, vars or result. You may use current.actor to target the actor that performed the action.

This reference can't be a JMESPath expression. It must be a simple notation for object and array access (eg assets.stock.items[3]).

value

The value to which the item should be set. By default, this is the value of the response.

It's often used with a data function.

YAML

generate_nametag:
  update:
    select: vars.document
    value:
      url: !tpl https://docs.example.com/name-tags/{{ current.response.id }}
      content: !ref current.response.body
      media_type: text/html

JSON

{
  "select": "assets.document",
  "data": {
    "url": { "<tpl>": "https://docs.example.com/documents/{{ response.data.id }}" },
    "content": { "<ref>": "response.data.body" },
    "content_media_type": "text/html"
  }
}