Edit on Github

Field

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

Schema

This schema describes a field's value. 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 textarea

A flag indicating the widget variant for fields of type string or boolean.

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 textarea element, which allows for multi-line text. The default appearance is a single-line input.

If a field type does not support a certain ui:widget, the setting is ignored.

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 that toggles the display label of a boolean field.

readOnly
boolean

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

prepare
boolean

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

Setting both the prepare and the hidden flag results in a validation error.

hidden
boolean

A boolean 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 hidden and the prepare flag results in a validation error.

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 boolean flag indicating whether a field should be included in the output of a workflow run export.

formatSpecifier
reference
A string describing how to format a number for display.

A specifier describing number formatting for numeric field types. All other field types ignore this flag.

group
string <= 50 characters

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

changeReason
reference
Change Reason

Where is this used?

Other schemas that have a reference ($ref) to this schema.