Skip to main content

Workflow Technical Documentation

Audience​

Developers, QA engineers, support engineers, DevOps engineers, security engineers, solution architects and implementation partners.

Overview​

This section describes the verified Workflow Service implementation and its frontend, shared-kernel, persistence, messaging and gateway boundaries. Endpoint-by-endpoint contracts are reserved for the API epic.

Summary​

Workflow is a Transitional .NET 8 Minimal API service. Definition and instance aggregates provide the canonical model; command classes orchestrate authoring and execution; EF Core repositories persist tenant-filtered aggregates; and domain events become transactional outbox messages.

No separate WorkflowEngine, executor, state-machine framework, approval service, delegation service or validator class exists. Engine behavior is implemented by WorkflowInstanceCommands together with aggregate transition methods.

Technical scope​

  • Versioned definitions, steps and conditions.
  • Running instances, tasks and append-only actions.
  • Approval, rejection, delegation and conditional stage advancement.
  • Application results, repositories, unit-of-work, audit, timeline and outbox adapters.
  • Authentication registration, missing endpoint authorization, tenant filtering and shared observability.
  • Portal calls, absent Gateway routing and API-level smoke coverage.

Documentation map​

Start with architecture, runtime composition, project structure and layer dependencies. Continue with the workflow engine, definition model, instance model, task model, approval model, delegation model, execution engine and state management.

Engineering references cover the application layer, commands, queries, validation, repositories, persistence, security, tenant isolation, observability, compatibility, testing, limitations and source map.

Requires Confirmation​

Production exposure, upstream access enforcement, message consumers, callback orchestration, tracing export, operational objectives and test ownership require confirmation.

Source References​

  • microservices/src/workflow-service/Program.cs
  • microservices/src/workflow-service/workflow-service.csproj
  • microservices/src/workflow-service/Domain/Workflow/WorkflowDefinition.cs
  • microservices/src/workflow-service/Domain/Workflow/WorkflowInstance.cs
  • microservices/src/workflow-service/Application/Commands/WorkflowInstanceCommands.cs

See Also​

Keywords​

Workflow architecture, approval engine, Workflow Service, technical foundation.

Revision Information​

  • Status: Draft
  • Last reviewed: 2026-07-20
  • Next review: 2026-10-20