State

The state a process that's instantiated from this scenario can be in.

The scenario defines a finite state machine. Each state describes through which action it can transition to a new state.

Simple state

A simple state has a single transition specified by the on or after and the goto property.

Optionally you can limit who can perform the action in this state using by. Use an array for by if multiple actors are allowed to do the action.

YAML

initial:
  on: complete
  by: client
  goto: (done)
wait:
  after: 24 hours
  goto: main

JSON

{
  "initial": {
    "on": "complete",
    "by": "admin",
    "goto": "(done)"
  },
  "wait": {
    "after": "24 hours",
    "goto": "main"
  }
} 

The on, after, by, goto, and log properties that can be added to simple states are described in the documentation of transitions.

State with multiple transitions

A state can define multiple transitions. The transition depends on the action being performed in that state or by the actor who performed it.

YAML

initial:
  title: Waiting in the lobby
  description: Participants can join until the organizer starts
  transitions:
    - on: join
      by: participant
      goto: ~
    - on: join
      by: organizer
      goto: start
    - on: cancel
      by: organizer
      goto: (canceled)
    - after: 10 days
      goto: (expired)

JSON

{
  "initial": {
    "transitions": [
      {
        "on": "join",
        "by": "participant",
        "goto": null
      },
      {
        "on": "join",
        "by": "organizer",
        "goto": "start"
      },
      {
        "on": "cancel",
        "by": "organizer",
        "goto": "(canceled)"
      },
      {
        "after": "10 days",
        "goto": "(expired)"
      }
    ]
  }
}

End states

End states are states without state transitions. Unlike normal states, they can be defined implicitly by referencing them in a goto.

Properties

title

string

A short title for the state.

description

string or data function

A detailed description of the action, displayed when the state is either the current state or part of the prediction.

transitions

array of transitions

Transitions from this state to the next.

Transition

notify

string, notify instructions. or array of strings and notify instructions

Specify external services that should be notified when transitioning into this state.

If notify is a string, it's interpreted as a service name with all other properties of the notify instructions omitted.

Notify