Skip to main content
Version: 1.x

Description Workflow

A Description Workflow defines the lifecycle of a description — which statuses a description can move through and in which order. It mirrors the concept of the Plan Workflow but applies to individual descriptions within a plan.

info

The workflow does not create statuses — it connects them. You must first create Description Statuses before you can build a workflow.

How It Works​

A description workflow is made up of:

  • Starting Status — the status automatically assigned to a description when it is first created.
  • Status Transitions — pairs of statuses defining which moves are allowed (e.g., from Draft → Complete).

Where to Configure​

Description Workflow is configured per tenant in Tenant Configuration under the Description Workflow section.

note

If no workflow is configured for a tenant, the platform uses a built-in default workflow.

Internal Statuses​

Description statuses map to three internal states, which control platform behavior:

Internal StatusDescription Behavior
DraftThe description is editable
FinalizedThe description is read-only
CanceledThe description is read-only. Used automatically by the platform when a plan is finalized and a description is not included

Configuration Steps​

Step 1 — Create Your Description Statuses​

Ensure all required statuses exist on the Description Statuses page. Each status defines:

  • Its Internal Status (Draft, Finalized, or Canceled)
  • Available Actions (Export)
  • Authorization — who can transition a description to this status
  • Visual appearance (color, icon)

Step 2 — Open Tenant Configuration​

Navigate to Tenant Configuration from the side navigation and expand the Description Workflow section.

Step 3 — Set the Starting Status​

Select the status that newly created descriptions will receive. This should be a status with Internal Status: Draft.

Step 4 — Define Status Transitions​

Click Add status transition to define each allowed move:

  • From Status — the status the description is currently in
  • To Status — the status the description is allowed to move to

Step 5 — Save​

Save the Tenant Configuration. The new workflow takes effect immediately.

Example Workflows​

Simple Workflow​

StatusInternal StatusTransitions To
DraftDraftComplete
CompleteFinalizedDraft

Starting status: Draft

Review Workflow​

StatusInternal StatusAvailable ActionsTransitions To
DraftDraftExportReady for Review
Ready for ReviewDraftExportDraft, Approved
ApprovedFinalizedExportDraft

Starting status: Draft

Relationship to Plan Finalization​

When a plan is finalized, the platform automatically handles descriptions that were not explicitly included in the finalization — those descriptions receive the Canceled internal status. Ensure your workflow includes a status mapped to Canceled internal status if you need to display canceled descriptions distinctly.

See Also​