Edit on GitHub

Workflow Template Schema

A schema that is used to validate a part of Laboperator workflow templates.

A workflow template consists of one or multiple steps to orchestrate devices and data with information and control elements.

Workflow Template Schema
schema_versionrequired
reference
Schema Version

A valid Workflow Schema version.

inforequired
reference
Info

The info section of a Workflow (Step) Template holds general information about the template.

config
reference
Configuration Section Schema of a workflow template

The configuration section of a workflow template holds general options for the workflow display.

elements
array of reference
Element Schema

Data elements allow to display data from device channels.

tables
reference
Tables Schema

Tables display a collection of data in an ordered arrangement of rows and columns.

buttons
reference
Buttons

Buttons allow users to trigger actions with a single tap.

fieldsrequired
reference
Fields

Fields are top-level and step-level variables in a workflow template. A field can be used to store and retrieve information during workflow execution.

stepsrequired
reference
Steps Section Schema

The steps section defines all steps used in a workflow. A step is a set of closed activities and instructions. Steps can be defined outside of a workflow and then be reused across different workflows.

flowrequired
reference
Flow

A set of sequential steps that define the flow of the workflow. Each step can be configured with additional flow control mechanisms to support conditional execution and repetition.

contextInfo
reference
Context information of a workflow or a step

Used to display contextual information related to the workflow or step.

behaviors
reference
Behaviors Schema

Behaviors provide means to define the behavior of a step. They can be used to control devices, record results, wait for device responses, control flow within a step and much more. The general scheme of a behavior is trigger => action.

secrets
reference
Secrets

Secrets are sensitive information that should not be stored in workflow fields, for example passwords or API tokens.

Where is this used?
Other schemas that have a reference ($ref) to this schema.

No references found.