Skip to main content
Version: Current

Workflow Example

This example shows how a workflow artifact fits into a BDL document.

It demonstrates workflow identity and placement without inventing undocumented activity, transition, start-form, assignment, or runtime structures.

Example​

{
  "schema": "barsa.definition.v1",
  "project": {
    "code": "SAMPLE",
    "caption": "Sample",
    "systemId": "${RESOLVE_SYSTEM_ID}",
    "version": "1.0.0"
  },
  "references": {},
  "artifacts": [
    {
      "kind": "workflow",
      "code": "CustomerApproval",
      "caption": "Customer Approval"
    }
  ]
}

What this example demonstrates​

  • Workflows are first-class BDL artifacts.
  • A workflow has its own stable authoring identity.
  • Workflow definitions belong in the root artifacts collection.
  • Display captions remain separate from machine-oriented codes.

Real workflow structure​

A production workflow may require:

  • Start conditions
  • Activities or steps
  • Transitions
  • Assignments
  • Forms
  • Rules
  • Commands
  • Notifications
  • Runtime variables
  • Completion behavior

The exact structure of these elements must come from the active BDL baseline and runtime evidence.

Do not invent workflow activity IDs, transition identifiers, start forms, or runtime bindings.

Runtime sensitivity​

Workflows are especially sensitive to the distinction between language support and runtime support.

A workflow shape may be expressible in BDL while a specific runtime behavior or authoring operation remains unavailable or limited.

Always check all four capability layers before relying on a workflow feature.

Existing workflows​

When working with an existing Barsa workflow, resolve its live metadata before attempting changes.

Do not infer current activities, transitions, forms, or identifiers from captions alone.

Safe authoring pattern​

Start with the smallest workflow definition that can be validated.

Add activities, transitions, assignments, and related artifacts incrementally.

Validate each meaningful change before execution.

If runtime behavior is uncertain, treat the uncertainty as a diagnostic requirement rather than filling the gap with guessed structure.

Known limitations​

Some workflow capabilities may have explicit known gaps or lossless-authoring limitations.

Consult the Known Gaps and Troubleshooting sections before treating a complex workflow definition as production-ready.

Next​

The next examples cover rules and commands.