Target Document Flow

The Target Document Flow is the EGKits platform model for how business documents move from creation through completion: statuses, valid transitions, Actions menu rules, and what the UI refreshes after every successful or failed action.

This guide is the hub. Module guides document only behavior that is implemented today — status names, action labels, and enablement rules match the application UI and shared policy code.

• Draft / planned
• In progress / submitted
• Valid / approved / completed
• Pending window / exception
• Rejected / invalid
• Cancelled / closed
• Decision gate

#Who this is for

#Platform principles

1. Status is the primary gate — Actions are enabled or disabled from the document’s current status plus a small set of flags (ETA UUID, pending rejection/cancellation, reversal windows, fully credited/returned).
2. One policy where it matters — Egyptian Tax Authority (ETA) documents share a single policy used by both API and Blazor (EtaActionPolicy + EtaActionGate). Purchasing and finance documents enforce transitions in domain aggregates and mirror those rules in the Actions menu.
3. Actions stay visible when denied — ETA screens keep menu items and show a localized denial tooltip. Purchasing/AP often hide items that do not apply. Some modules use inline icon buttons instead of a MudMenu.
4. Immediate UI sync after every action — grids reload, details refetch, status chips update, and the Actions menu re-evaluates against the new state.
5. No invented verbs — Decline Rejection and Decline Cancellation exist only for ETA invoice reversal workflows. Other modules use Approve / Reject / Cancel (or module-specific verbs) as implemented.

#Platform architecture

Platform architecture — UI, policy, backend, persistence

flowchart TB
  subgraph Apps["EGKits Blazor apps"]
    direction TB
    UI[Actions menu / row controls]
    Gate[EtaActionGate / status helpers]
  end
  subgraph Shared["Shared library"]
    direction TB
    Policy[EtaActionPolicy]
    State[EtaDocumentState]
  end
  subgraph Backend["Backend"]
    direction TB
    API[REST workflow endpoints]
    Domain[Domain aggregates]
    ETA[ETA / tax authority]
  end
  subgraph Data["Persistence"]
    direction TB
    DB[(Tenant database)]
  end

  UI --> Gate
  Gate --> Policy
  Policy --> State
  UI -->|POST action| API
  API --> Domain
  Domain --> DB
  API -->|submit / cancel / reject / decline| ETA
  ETA -->|status sync| API
  API -->|reload row / grid| UI

  class UI,Gate egkActive
  class Policy,State egkDraft
  class API,Domain egkActive
  class ETA egkWarn
  class DB egkSuccess

sequenceDiagram
  autonumber
  actor User
  participant Menu as Actions
  participant API as Backend
  participant Domain as Domain
  participant Grid as Grid
  participant Details as Details

  User->>Menu: Invoke action
  Menu->>API: POST /{id}/{action}
  API->>Domain: Enforce transition
  Domain-->>API: New status / error
  alt Success
    API-->>Menu: 2xx + payload
    Menu->>Grid: ReloadDataAsync
    Menu->>Details: Refetch row when open
  else Business rule failure
    API-->>Menu: 4xx + message
    Menu->>User: Snackbar / dialog
  end

#Module document-flow guides

#Compliance & finance

#Industry & operations

#Collaboration, CMS, AI

#Complete application & module inventory

Coverage lock: 43 Blazor EGKits* apps · 27 top-level Backend/Modules projects (excluding umbrella Modules.Domain / Modules.Infrastructure) · 25 module document-flow guides + this hub. Every app and module is listed below — either with a lifecycle guide or under an explicit no document lifecycle rationale. Helper-only folders under Modules.Domain are listed so nothing looks “missing.”

#Canonical action vocabulary

#Keeping diagrams synchronized

1. Update the shared policy or domain transition method first.
2. Update the matching guide in this series (status table + diagram + action matrix).
3. Keep UI labels identical to localization keys shown in the Actions menu.
4. Prefer several focused diagrams (and expandable <details class="egk-flow-section"> sections) over one oversized chart.
5. Diagram chrome (zoom, fullscreen, print) is provided automatically by doc-mermaid.js for every Mermaid fence in Public docs — do not add per-guide toolbar markup.
6. When adding a new Blazor app or backend module, add a row to the inventory tables above in the same PR.

#Related concepts

• Core Concepts
• Documents
• Document Archive
• Audit Trail