Email

Name

Author with Email

Simple string to display as author information.

Author

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


Info

A step call object is the more sophisticated variant of a step identifier
allowing to pass additional parameters to a step being called.


A step call object

Action Identifier Schema

Action Object Schema

Actions can come as a simple identifier string or an object to pass options.
Either variant can be used as single action or a list of actions. A list of
actions will always be executed sequentially. A somehow erroneous action
will cause the consecutive actions not to be executed.


Actions Schema

The event of adding a step to a running dynamic template.
The added step will be appended as the last step of the run.


AddStep Event

AddStep Options

Alert Object

The general scheme of a behavior always consists of a `trigger` and an
`action`. It is extended by the use of conditions, alternative
actions, multiple triggers and multiple actions.


Behavior 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`.

Behaviors Schema

Button

Buttons allow users to trigger actions with a single tap.

Buttons

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:

Change Reason

A Command handler always consists of an [action](/schemas/definitions/workflow-template/actions/).


Command Handler

CommandResponse Options

CompleteTimer Options

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

Configuration Section Schema of a step

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

Configuration Section Schema of a workflow template

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

Context information of a workflow or a step

Configuration of the workflow context information.


Context information panel settings

DataPoint Options

Used to pass arguments to an step device.

Device Object Schema

An duration string parsable by [Chronic Duration](https://github.com/henrypoydar/chronic_duration).


Duration

Dynamic member names allow to use field values for composing names in the field mapping.


Dynamic member name

Elements are used to display data points over a certain period.


Element Schema

A valid field schema is either a valid JSON schema as per [Draft 7](http://json-schema.org/draft-07/schema#) or one of our custom field types. Some additional properties are allowed at the top level.


Field

A field mapping is always required when a step defines its own fields.
The field mapping maps the global workflow fields to step internal
fields. During validation it will be ensured that the field types are
compatible.


Field Mapping

Direct assignments of values to step fields. The values are evaluated
against the field schema during validation.


Field Values

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.

Fields

FieldUpdate Options

File

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.


Flow

Flow Control

An iteration flow of steps or nested flow control schemas.
The loop will be iterated once per item in a given source array.


For-Each Array Flow

An iteration flow of steps or nested flow control schemas.
The loop will be iterated up to the given limit of an iterator integer.


For-Each Integer Flow

A format specifier is a string describing how to format a number for display. It is based on the excellent [d3-format](https://github.com/d3/d3-format) library. For example, a typical fixed point precision of two digits behind the decimal point is achieved with `.2f`. Visit their [official documentation](https://github.com/d3/d3-format#locale_format) for a complete reference and examples.

Format Specifier

An action to filter related API resources.


Get Resources

GoToPreviousStep Options

A status code is the 3 digit code ranging from 1xx to 5xx that
will be present in the response


HTTP status code

A conditional flow of steps or nested flow control schemas. In the well known if-then-else fashion a conditional flow through the workflow can be implemented.


If-Then-Else  Flow

IncidentClose Options

IncidentCreate Options

Used to add information that will be generated in the workflow report. The information can contain
reference to information present in the workflow, like fields, or workflow template information, using the
double curly brackets notation (see examples).
Besides field identifiers, the following references are supported:
- step: The step in which the reportSummary is contained. Please refer to the API documentation
  for the keys available to use for step.
- template: You can access values from any key inside the workflow template, as long as you pass the keys in the correct
  hierarchy.
- operator: The user who completed the step.


Information summary about the step that will be generated in the report.

Input Channels

JSON Pointer is a string syntax for identifying a specific value within a JavaScript Object Notation (JSON) document as defined by [RFC6901](https://tools.ietf.org/html/rfc6901). It contains a sequence of zero or more reference tokens, each prefixed by a '/' character.


JSON Pointer

A loop flow of steps or nested flow control schemas. The loop will be repeated until a condition is met. The loop will be executed at least once. Once the condition evaluates to a truthy value the loop is broken and the loop flow is considered completed.


Loop Flow

Manual Options

Markdown Formatted Content

A member name that is used as a reference elsewhere.
Allowed characters are lower "a" to "z", capital "A" to "Z", "0" to "9" and
"-" , "_". We recommend to consistently use either lowerCamelCase or
kebab-case. While snake_case is allowed, it has a chance of name collisions
with internal values.


Member Name

Duration formatting is based on the momentjs
[momentjs](https://momentjs.com/) library. Head over to
[docs](https://momentjs.com/docs/#/durations/creating/) for a full
reference and examples.


Moment Duration

The event of moving a step in a running dynamic template.
Only steps which are not yet started can be moved.


MoveStep Event

Options to an Notify action. In contrast to an alert the notification does
not interrupt the execution of a workflow and requires no user interaction.
It will only be shown to users that have the workflow open at the time of
the action being run.


Notify Object

Pages displayed as workflow context information.


Page containing context information

Defines a field of type `quantity`. A quantity is a real number with a unit represented as a string. Compatible units of a given kind will be converted automatically.


Quantity

Relationship

The event of removing a step from a running dynamic template.
Only steps which are not yet started can be removed


RemoveStep Event

RepeatSubstep Options

ResetTimer Options

The event of resolving a single iteration of `for-each` flow of steps.

ResolveForEach Event

The event of resolving the condition in an `if` flow of steps.

ResolveIf Event

The event of resolving the condition in a `loop-until` flow of steps.

ResolveUntil Event

The event of resolving the condition in a `while` flow of steps.

ResolveWhile Event

This should map to the tag of the resources we have in our API documentation


Resource tag

Options for a Scanner trigger. The application supports simulating a barcode scan by passing the 'simulateScanString' prop to the component.


Scan Options

A reference to workflow step defined outside the workflow template.
Additional properties might be added to the reference for documentation
purposes. It is recommended to use the `$comment` property.


Schema for a reference to an external step

Schema Version

Scope of time for displaying data points


Scope

A script that is evaluated and returns a value. The parsing and evaluation is based on [Dentaku](https://github.com/rubysolo/dentaku) and enhanced with custom capabilities.

Script

Defines a field of type `script`. The result of the script evaluation determines the field's value. See the [Script schema](/schemas/definitions/script) for more information on writing expressions and examples.


Secret

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

Secrets

SelectCell Options

Define accessors for selector options. You can map the selector options to fields defined in a field.


Selector Accessors

Selector Options

The schema of a selector. The options defined will be available
for selection in the substep during a workflow run. A selector can be customized
with different layouts, currently list or cards. They support both multi- and single-selection.
By overwriting the default behaviors they can be completely customized.


Selector Schema

SelectRow Options

SendCommand Options

SendEmail Options

A sequence steps or nested flow control schemas. In a sequential flow consecutive items will always be executed one after another. Therefore, a nested flow has to be completed before a consecutive item can be started. The sequential flow is the only implicit flow, meaning it does not have any key words or properties. It is typically used as the top-level flow control in a workflow.


Sequential Flow

A Set Field action updates a field with a new value.


Set Field

An action to store temporary value which last for a single chain of actions.


Set Temporary Field

A flag indicating whether a workflow run can be signed.

Signature

A URL compatible slug that can also be used as a reference elsewhere. By
default it will generated from the components name or uuid.


Slug

StartTimer Options

A step is a closed set of activities and instructions.


Step

Step Identifier

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.

Steps Section Schema

StopTimer Options

A substep is a single instruction of a step and can both content and actions
attached to it.


Substep Schema

A static array that defines the structure of a table by mapping keys from the source data to columns.

Table column mapping schema

Rules can be leveraged to dynamically change both the behavior and appearance of a table.

Table rules

Table Schema

Dynamic data that describes the current behavior of the table based on any data of changes.


Table State Schema

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

Tables Schema

A step is a closed set of activities and instructions. Steps can be defined
independent of a workflow and then be reused across different workflows.

The Workflow Step Template Schema

Defines a field of type `timer` to measure time or execute time-controlled actions.

namerequired	string (Name) Examples: `Max Mustermann`
emailrequired	string <email> (Email) Examples: `max.mustermann@company.com`

Author

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

Where is this used?

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

Author

Where is this used?

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

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