Skip to content

Jet Actions

A Jet Action defines a transition between states in a Jet's lifecycle. Jet Actions are defined on the Jet Template: they specify a from state, a transit state, and a to state, and can run a Flight Plan when triggered. Users trigger actions from a Jet (e.g. from the States and Actions tab or the kanban) to move the Jet to a new state (e.g. Start, Stop, Restart).

Special cases:

  • Create Jet: an action with no from state and a to state is used to create a new Jet (see Jet Template).
  • Destroy Jet: an action with a from state and no to state is used to destroy a Jet.

Access Rules

Group Action Condition
User R Action access level is "User" and (Template access level is "User" or user is in "Users" on the template or on any Jet from that template)
Manager R Action access level is "Manager" or less and (Template access level is "Manager" or less or user is in "Users" or "Managers" on the template)
Manager CRUD Action access level is "Manager" or less and user is in "Managers" on the Jet Template
Root CRUD Any record

Info

CRUD stands for Create, Read, Update, Delete.

Jet Action Configuration

Jet Actions are edited on the Jet Template form, Actions tab.

Jet Action Form

Fields

Field Description
Name Action name (e.g. "Start", "Stop"). Shown on the Jet when the action is available.
Reference Used for automation and YAML export/import. Leave blank to generate automatically. (Often hidden; visible to technical users.)
Priority Order of the action in the template (lower = higher priority). (Often hidden.)
Access Level Minimum Access Level required to trigger this action (User, Manager, or Root).
Flight Plan Flight Plan executed when this action is triggered (e.g. start/stop script on the server).
From State Source state. Leave blank for an initial action (used to create a new Jet).
Transit State Required. State shown while the action is running (e.g. "Starting", "Stopping").
To State Destination state. Leave blank for a final action (used to destroy the Jet).
Error State State to set if the action's Flight Plan fails. If empty, the Jet may revert to the from state.
Note Optional notes.

Triggering an action

From a Jet, only actions whose From State matches the Jet's current state are offered. Triggering an action moves the Jet to the Transit State, runs the Flight Plan (if set), then moves it to the To State (or Error State on failure).