Skip to content
Cyoda Documentation
Settings

WorkflowConfiguration

WorkflowConfiguration

Section titled “WorkflowConfiguration”

“Workflow configuration schema version 1.0. Supports workflow-level and transition-level criterion using QueryCondition types: ‘group’, ‘simple’, and ‘function’. Function conditions enable externalized integration for external processing and validation logic.”

Schema Viewer

Section titled “Schema Viewer”

WorkflowConfiguration

Workflow configuration schema version 1.0. Supports workflow-level and transition-level criterion using QueryCondition types: 'group', 'simple', and 'function'. Function conditions enable externalized integration for external processing and validation logic.

versionstringrequired
Version of the workflow configuration schema
namestringrequired
Name of the workflow
descstring
Description of the workflow
initialStatestringrequired
Initial state for entities in this workflow
activeboolean
Flag indicating if the workflow is active
criterionQueryCondition
Optional criterion to determine if this workflow applicable to an entity. Supported condition types in workflows: 'group', 'simple', and 'function'.
statesobjectrequired
Map of state codes to state definitions. State names must start with a letter and contain only letters, numbers, underscores, and hyphens.

Description

Section titled “Description”

Workflow configuration schema version 1.0. Supports workflow-level and transition-level criterion using QueryCondition types: ‘group’, ‘simple’, and ‘function’. Function conditions enable externalized integration for external processing and validation logic.

Properties

Section titled “Properties”
  • version (string, required): Version of the workflow configuration schema
  • name (string, required): Name of the workflow
  • desc (string): Description of the workflow
  • initialState (string, required): Initial state for entities in this workflow
  • active (boolean): Flag indicating if the workflow is active
  • criterion (object): Optional criterion to determine if this workflow applicable to an entity. Supported condition types in workflows: ‘group’, ‘simple’, and ‘function’.
  • states (object, required): Map of state codes to state definitions. State names must start with a letter and contain only letters, numbers, underscores, and hyphens.
Section titled “Related Schemas”

See other schemas in the common category.