UML Documentation Hub

This section provides extensive UML documentation covering all business processes, entity relationships, and system flows in the Company Manager platform.

Business Domains

Domain	Description	Key Diagrams
E-Commerce	Orders, payments, shipping, inventory	Order lifecycle, payment flows, shipping states
Subscriptions	Recurring billing, subscription management	Subscription lifecycle, billing cycles
CRM	Leads, opportunities, clients	Sales pipeline, lead qualification
CMS	Content management, publishing	Content workflow, magazine production
Communications	Email infrastructure, automation	Email delivery, automation flows
Workflows	Automation engine, job processing	Workflow execution, node types
Field Service	Interventions, equipment	Service dispatch, equipment lifecycle
Events	Bookings, availability	Booking flow, calendar management
POS	Point of sale, kitchen display	Transaction flow, kitchen orders
Platform	Multi-tenant, permissions	Tenant isolation, RBAC

Diagram Types

Entity Relationship Diagrams (ERD)

Show the data model and relationships between entities in each domain.

State Machine Diagrams

Illustrate the lifecycle states and transitions for key entities like orders, subscriptions, and workflows.

Sequence Diagrams

Detail the step-by-step interactions between system components for business processes.

Activity Diagrams

Show the flow of activities and decision points in business processes.

Component Diagrams

Display the architectural components and their interactions.

Platform Overview

graph TB
    subgraph "Business Domains"
        EC[E-Commerce]
        SUB[Subscriptions]
        CRM[CRM & Sales]
        CMS[CMS & Publishing]
        COM[Communications]
        WF[Workflows]
        FS[Field Service]
        EV[Events & Bookings]
        POS[Point of Sale]
    end

    subgraph "Core Platform"
        MT[Multi-Tenant Engine]
        PERM[Permission System]
        SR[Service Registry]
        QM[Queue Manager]
    end

    subgraph "Data Layer"
        DB[(PostgreSQL)]
        CACHE[(Redis)]
        PRISMA[Prisma ORM]
    end

    subgraph "External Integrations"
        STRIPE[Stripe]
        WP[WordPress]
        PS[PrestaShop]
        EMAIL[Email Providers]
    end

    EC --> MT
    SUB --> MT
    CRM --> MT
    CMS --> MT
    COM --> MT
    WF --> MT
    FS --> MT
    EV --> MT
    POS --> MT

    MT --> PERM
    MT --> SR
    SR --> QM

    SR --> PRISMA
    QM --> CACHE
    PRISMA --> DB

    EC --> STRIPE
    CMS --> WP
    EC --> PS
    COM --> EMAIL

    style MT fill:#e1f5fe
    style SR fill:#f3e5f5
    style DB fill:#e8f5e9

Multi-Tenant Data Flow

All business domains operate within the multi-tenant architecture:

flowchart LR
    subgraph "Request Flow"
        REQ[API Request] --> AUTH[Authentication]
        AUTH --> TENANT[Tenant Context]
        TENANT --> SITE[Site Context]
    end

    subgraph "Data Access"
        SITE --> ROUTER[TRPC Router]
        ROUTER --> SERVICE[Service Registry]
        SERVICE --> QUERY[Database Query]
        QUERY --> FILTER[Tenant Filter]
    end

    subgraph "Response"
        FILTER --> DATA[Tenant Data]
        DATA --> RESP[API Response]
    end

    style TENANT fill:#fff3e0
    style FILTER fill:#e8f5e9

Key Patterns

Service Registry Pattern

All business logic flows through the service registry to ensure proper caching and tenant isolation:

sequenceDiagram
    participant Router as TRPC Router
    participant Registry as Service Registry
    participant Cache as Service Cache
    participant Factory as Service Factory
    participant Service as Business Service

    Router->>Registry: getService("order", ctx)
    Registry->>Cache: Check cache (tenantId key)

    alt Cache Hit
        Cache-->>Registry: Return cached instance
    else Cache Miss
        Registry->>Factory: Create service
        Factory->>Service: new OrderService(ctx)
        Service-->>Factory: Instance
        Factory-->>Registry: Instance
        Registry->>Cache: Store with TTL
    end

    Registry-->>Router: Service instance
    Router->>Service: Execute business logic

State Machine Pattern

Core entities follow state machine patterns for lifecycle management:

stateDiagram-v2
    [*] --> Draft: Create
    Draft --> Sent: Submit
    Draft --> Cancelled: Cancel
    Sent --> Confirmed: Accept
    Sent --> Draft: Revise
    Sent --> Cancelled: Reject
    Confirmed --> Fulfilled: Process
    Confirmed --> Cancelled: Cancel
    Fulfilled --> Completed: Deliver
    Fulfilled --> Cancelled: Cancel
    Completed --> [*]
    Cancelled --> [*]

    note right of Draft: Initial state
    note right of Confirmed: Payment received
    note right of Completed: Final state

Getting Started

Understand the platform: Start with Platform Architecture to understand multi-tenancy and permissions
Explore your domain: Navigate to your area of interest using the table above
Follow the flows: Use sequence diagrams to understand process interactions
Check state machines: Review lifecycle states for key entities

Architecture Diagrams - High-level system architecture
Business Processes - Business workflow documentation
Data Models - Database schema documentation
API Documentation - TRPC API reference

UML Documentation