Laboperator Schema Docs
Edit on GitHub

Change Reason

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

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:

1. field has no value
2. update to `10`
3. update to `22` => reason required
4. update to `null` => reason required
5. update to `14` => reason required
6. user does not submit reason => field value is still `null`

A reason can be submitted programmatically as part of a set_field action, which would then not prompt the reason dialog to the user during workflow execution. See Set Field schema for more information.

For fields of type array or object the changeReason setting can be applied both at the top-level, meaning any partial update of an existing value requires a reason, or for individual items and properties only. Nested settings take precedence over higher-level settings.

A field update that requires a reason will always fail if no reason is provided.

one of
  • boolean
  • object
boolean

A field flagged with the boolean changeReason: true setting uses the default message and validation settings for its reason dialog.

Examples:
message: >
  Field update requires a reason. Please select one of the options or submit
  your own.
validation: ^\w.+\s.+
options:
  - Solution factor too high
  - Solution factor too low
Where is this used?
Other schemas that have a reference ($ref) to this schema.

No references found.