Skip to content

WorkflowTransitionGroups 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 a detailed description of the WorkflowTransitionGroups table, which defines transition groups within the workflow system. These groups organise transitions and determine how they apply to different record types.

⚠️ Important: - Do not add or modify transition groups directly in this table. - Transition groups are automatically created when a new workflow is configured in the Workflow Builder.

Understanding the WorkflowTransitionGroups Table

Workflow transition groups are an integral part of the workflow structure, ensuring that transitions are organised and applied correctly across multiple record types.

Core Fields

Field Name
Type
Required
Description
PartitionKey
string
Yes
Workflow schema version
RowKey
string
Yes
Transition group ID (unique identifier)
GroupName
string
Yes
Human-readable name for the transition group
StartingRoleAssignment
string
Yes
The role with whom this transition group begins
StartingStage
string
Yes
The stage where this transition group begins
StartingStateId
string
Yes
The state where this transition group begins
TargetRecordTypes
string
Yes
Semicolon-separated list of record types that use this transition group
TransitionItemIds
string
Yes
List of transition IDs linked to this group

Important Considerations

  • Do not manually add or modify transition groups.
  • Transition groups are automatically created when a new workflow is configured in the Workflow Builder.
  • Groups help organise and control workflow transitions.
  • They determine which record types use a specific set of transitions.
  • Modifying transition groups can impact existing workflow processes.
  • Multiple record types can share the same transition group.

The workflow configuration is stored across three Azure Storage Tables: 1. WorkflowStates – Defines workflow states and their settings. 2. WorkflowTransitions – Defines how states connect through transitions. 3. WorkflowTransitionGroups (this table) – Organises transitions and assigns them to record types.

When a record is created, the workflow configuration is serialised as JSON and stored in Azure Blob Storage in the workflowinstances container.