Laboperator Schema Docs
Edit on GitHub

Field

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

A valid field schema is either a valid JSON schema as per Draft 7 or one of our custom field types. Some additional properties are allowed at the top level.

all of
  • object
  • reference or reference or reference or reference or reference or reference
ui:widget
string
one of: checkbox switch text textarea

A flag indicating the widget variant for fields of type string or boolean. All other field types ignore this setting. Boolean fields can be displayed as either a checkbox or a switch to toggle between a binary state. The default appearance is a checkbox. Fields of type string can be configured as a multi-line textarea element. Their default appearance is a single-line text input.

ui:options
object

Display configuration options for certain field types and widget settings. If a field or widget does not support ui:options, the setting is ignored.

label
boolean
default: true

A flag indicating whether a field of type boolean has a display label. Setting this to false will display either only a checkbox or switch control element, without any visible label.

readOnly
boolean
default: false

A flag indicating whether a field can be updated once the workflow run has been started.

prepare
boolean
default: false

A flag indicating whether a field must be assigned a value before workflow execution can be started.

Setting both the prepare and the hidden flag to true results in a validation error, because it would not be possible to start workflow execution.

hidden
boolean
default: false

A flag indicating whether a field is hidden from the user. A hidden field can still be explicitly referenced as, for example, the source data for a table or in the description of a substep and thereby have a visual representation.

Setting both the prepare and the hidden flag to true results in a validation error, because it would not be possible to start workflow execution.

defaultValue
any

Assign a default value to a field. Fields without a default value that also don't require a value to be assigned via the prepare flag are empty at the start of a workflow execution.

output
boolean
default: true

A flag indicating whether a field is included in the output of a workflow run export.

formatSpecifier
reference
Format Specifier

A specifier describing number formatting for fields of type number, integer, and quantity. All other field types ignore this flag.

group
string <= 50 characters

A flag that is used to group fields during the workflow preparation stage. Fields with the same group name are displayed together in the order of definition. All fields without a specified group are displayed separately.

changeReason
reference
Change Reason

A flag indicating whether subsequent field updates require a reason and prompt the user with a reason dialog. The first update to a field's value never requires a reason, any further updates always do. Consider the following example:

Examples:
type: string
enum:
  - German
  - English

type: string
output: false
group: Analyst Notes
ui:widget: textarea

type: boolean
ui:widget: switch
ui:options:
  label: false

type: array
hidden: true
items:
  type: object
  properties:
    weight:
      type: number
    name:
      type:
        - string
        - "null"
      changeReason: true
defaultValue:
  - weight: 12
    name: Sample 1
  - weight: 17
    name: Sample 2
Where is this used?
Other schemas that have a reference ($ref) to this schema.