Workflow Glossary

Configuration Scope: Exportable

This setting is included in configuration exports and will be the same across all environments once the config file is imported.

Overview

This glossary provides definitions and explanations for key terms and concepts related to workflows in the system. It covers workflow states, transitions, roles, stages, and other essential components involved in building, editing, and managing workflows.

Glossary

Term	Definition
Action Block	A component used in the workflow builder to define specific actions that can be performed within a workflow. It is linked to a state and dictates how tasks are managed.
Azure Blob Storage	A cloud storage solution used to store workflow configurations, including serialised records of workflow instances. These records are stored in the workflowinstances container.
Azure Storage Tables	Data storage solutions in Azure where workflow-related tables, such as WorkflowStates, WorkflowTransitions, and WorkflowTransitionGroups, are stored. They define the structure and rules of workflow management in the application.
CanRecordRecommendations	A field used in the WorkflowTransitions table, which controls whether recommendations or decisions can be recorded during a transition.
CanSelectMultipleRoles	A field in the WorkflowTransitions table that specifies whether multiple roles can be selected during a transition. This allows flexibility in workflow management where multiple individuals or roles are responsible for a particular task.
CanSelectDueDate	A field in the WorkflowTransitions table that enables users to set a due date for a transition. It is typically used when the timing of a transition needs to be tracked or enforced.
Core Fields	The essential fields within workflow-related tables such as WorkflowStates, WorkflowTransitions, and WorkflowTransitionGroups. These fields define the basic properties and configurations of workflows, such as state IDs, role assignments, and target record types.
Dialog Configuration Fields	A set of fields in the WorkflowTransitions table that define the user interface for transitions, such as dialog titles, descriptions, and button labels.
DisableForm	A field in the WorkflowTransitions table that, when enabled, disables the form associated with a transition.
Extra Transition Block	A configuration block in the Workflow Builder table that defines additional settings for transitions. It is used to add further details to how transitions should behave, including whether certain elements (such as tasks, roles, or comments) should be hidden.
HideButtons	A field in the WorkflowTransitions table that controls whether action buttons should be hidden during a transition.
HideCommentsInput	A field in the WorkflowTransitions table that, when enabled, hides the comments input field during a transition.
HideRoleSelection	A field in the WorkflowTransitions table that hides the role selection UI during a transition.
HideTaskSelection	A field in the WorkflowTransitions table that hides the task selection UI during a transition.
IsCommentsRequired	A field in the WorkflowTransitions table that indicates whether a comment is mandatory during a transition. If enabled, users must provide a comment before completing the transition.
PartitionKey	A field in the WorkflowStates, WorkflowTransitions, and WorkflowTransitionGroups tables that stores the workflow schema version. Editing this field is not recommended as it could lead to incorrect application operation.
Record Type	The type of record that a particular workflow is designed to manage. Each record type can have different workflow configurations, and the transitions and states may vary depending on the record type.
RowKey	A unique identifier for a record in the workflow-related tables, such as WorkflowStates, WorkflowTransitions, and WorkflowTransitionGroups. It is used to distinguish between different records within the same table.
StartingRoleAssignment	A field in the WorkflowTransitionGroups table that specifies the role with whom a transition group begins.
StartingStage	A field in the WorkflowTransitionGroups table that specifies the stage at which the transition group begins.
StartingStateId	A field in the WorkflowTransitionGroups table that specifies the state where the transition group begins.
TargetRecordTypes	A field in the WorkflowTransitionGroups table that defines which record types are applicable to a specific transition group. It is typically a semicolon-separated list of record types that will use the transitions within the group.
Transition Item ID	A field in the WorkflowTransitionGroups table that links a transition group to one or more transitions. It identifies which specific transitions are part of the group.
Workflow Instance	A serialised instance of a workflow configuration stored in workflowinstances in Azure Blob Storage. It represents the specific state and transition of a record as it progresses through the workflow.
Workflow Schema	The set of rules, states, transitions, and configurations that govern the workflow system. The schema defines the structure of workflows and how records move between states, roles, and stages.
Workflow State	A specific task in a workflow. Each state can have associated roles, and transition rules that determine how a record moves to the next state.
Workflow State Configuration	The setup and rules for defining states in a workflow. It includes fields like PartitionKey, RowKey, and CanManageSignatures, which help manage the behaviour and actions associated with each state.
Workflow Transition	A process that moves a record from one state to another within the workflow.
Workflow Transition Group	A collection of transitions that are grouped together for a specific workflow. The group defines which transitions can be used together and which record types they apply to. Each group has a starting state and a list of associated transitions.