WorkflowTransitions Schema Reference
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 guide provides detailed instructions on the WorkflowTransitions table, which defines how records move between different workflow states. The schema of this table is crucial as it dictates transition behaviour and user interactions.
⚠️ Important: - Do not add or modify transitions directly in this table. - Always use the Workflow Builder to configure transitions, as it ensures proper integration with states, roles, and stages.
Understanding the WorkflowTransitions Table
The WorkflowTransitions table stores all transitions between workflow states. These transitions correspond to the Action and Extra Transition blocks in the Workflow Builder.
Core Fields
| Field Name |
Type |
Required |
Description |
|---|---|---|---|
| PartitionKey |
string |
Yes |
Workflow schema version |
| RowKey |
string |
Yes |
Transition ID (unique identifier) |
| SourceStateId |
string |
Yes |
The state where this transition begins |
| TargetStateId |
string |
Yes |
The state where this transition leads |
| TargetStage |
string |
Yes |
The stage to be set after transition |
| TargetRoleAssignment |
string |
Yes |
Role assigned after transition |
| ActionName |
string |
Yes |
Action name displayed in the "I want to" menu |
| ActivityDescription |
string |
Yes |
Past tense description recorded in workflow history |
| OverrideTaskName |
string |
No |
Custom task name that overrides the default task name resolution |
Configuring Transition Dialogs
These fields customise the transition pop-up displayed to users.
| Field Name |
Type |
Required |
Description |
|---|---|---|---|
| DialogTitle |
string |
No |
Title shown in transition dialog |
| DialogDescription |
string |
No |
Description shown in transition dialog (HTML markup supported) |
| ButtonLabel |
string |
No |
Label for the action button |
| CommentInputLabel |
string |
No |
Label for the comment input field |
Behaviour Control Fields
These fields define additional transition behaviour and options.
| Field Name |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
| CanRecordRecommendations |
boolean |
No |
false |
Allows recording recommendations/decisions |
| CanSelectMultipleRoles |
boolean |
No |
false |
Allows selection of multiple roles |
| CanSelectDueDate |
boolean |
No |
false |
Allows selection of a due date |
| IsCommentsRequired |
boolean |
No |
true |
Makes comments mandatory |
| HideTaskSelection |
boolean |
No |
false |
Hides task selection UI |
| HideRoleSelection |
boolean |
No |
false |
Hides role selection UI |
| DisableForm |
boolean |
No |
false |
Disables the transition form |
| HideCommentsInput |
boolean |
No |
false |
Hides comments input UI |
| HideButtons |
boolean |
No |
false |
Hides action buttons |
Important Considerations
- Do not create or modify transitions directly in this table.
- Always use the Workflow Builder to configure transitions, ensuring proper integration.
- Transitions define how records move between states.
- They can trigger role assignments and stage changes.
- Dialog configuration allows customisation of the user interface.
- Transitions work with WorkflowStates and WorkflowTransitionGroups.
- Changes may impact existing workflow processes.
- HTML markup is supported in transition dialog descriptions.
Related Tables
The workflow configuration is stored across three Azure Storage Tables: 1. WorkflowStates – Defines workflow states and their settings. 2. WorkflowTransitions (this table) – Defines how states connect through transitions. 3. WorkflowTransitionGroups – Manages grouped transitions between states.
When a record is created, the workflow configuration is serialised as JSON and stored in Azure Blob Storage in the workflowinstances container.