HDG / ENGINEERING NOTES

Designing a portable workflow schema

A field guide to workflow steps, deterministic simulation and future execution engines.

Separate models from executors

A workflow specification defines nodes, labels and configuration values. An execution engine decides when a node runs, evaluates conditions and records outcomes. Keeping these concepts separate avoids presenting a visual simulation as a live automation service.

The public Workflow Studio implements schema validation and a readable simulation trace; it does not call external tools or evaluate real-world business events.

Use explicit schema versions

A top-level version field allows backward-compatible migrations. Every step should have a stable ID, a known type and bounded configuration. Importers should reject oversized payloads and normalize unsupported attributes.

Document changes in the changelog, test round-trip import/export and keep example files small enough to inspect manually.

Plan for real execution deliberately

Real orchestration would add authenticated connectors, idempotency keys, retry state, step logs and a durable queue. Secrets should reside server-side with scoped access, never inside exported workflow JSON.

Only add execution capabilities once governance, cost controls and failure reporting exist. This creates a more trustworthy transition from prototype to product.

Keep the user in control

An operator should be able to understand a flow without running it: read the sequence, check its conditions, compare changes and export a copy. Portability is useful even before connecting external systems.

Try the interactive studio and inspect the schema documentation to see the current behavior and limitations firsthand.

Shortcut: / or Ctrl+K · Esc to close