# docusign/sample-app-business-csharp architecture

> Architecture diagram of the GitHub repository docusign/sample-app-business-csharp, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/docusign/sample-app-business-csharp
- Repository: https://github.com/docusign/sample-app-business-csharp

## Overview

##### Project type and purpose
- This is a full-stack Single Page Application (SPA) sample that demonstrates how to integrate DocuSign eSignature into a business workflow. The front end is an Angular client (under ClientApp) and the back end is a .NET 7.0 Web API project. It implements multiple use-cases (employment contract, T&Cs, customer profile update, custom quote) using DocuSign SDK, envelope builders, Connect notifications, and embedded signing.

##### File structure
- Top-level directories:
- ClientApp (Angular SPA)
- Controllers (Web API controllers, one per use-case)
- Domain (business logic, envelope builders and services)
- Infrastructure (DocuSign API provider, template builder, configuration, in-memory repo)
- Hubs (SignalR EventsHub for real-time updates)
- Templates (JSON and PDF templates for envelopes)
- appsettings*.json and private.key (configuration)
- Dockerfile and GitHub CI/CD pipeline
- The layering follows a clean architecture / onion pattern: Presentation (Controllers), Application/Domain (Services, Models), Infrastructure (external APIs), real-time hubs, and static templates.

##### README for additional insights
- Authentication via JWT grant or OAuth code grant
- Envelope composition for each use case using composite templates
- ‐level webhooks (event notifications)
- Embedded signing, remote signing, IDV/SMS authentication
- Local run via npm / dotnet or containerized via Docker

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend (Angular SPA)"
        style Frontend fill:#D0E8FF,stroke:#0366D6,stroke-width:2px
        Browser["User Browser"]:::user
        SPA["Angular SPA"]:::frontend
    end

    %% Backend Presentation Layer
    subgraph "Web API Controllers"
        style Controllers fill:#E2F0D9,stroke:#1E6823,stroke-width:2px
        AdminCtrl["AdminController"]:::controller
        QuoteCtrl["CustomQuoteController"]:::controller
        ProfileCtrl["CustomerProfileController"]:::controller
        EmpCtrl["EmploymentContractController"]:::controller
        TnCCtrl["TermsAndConditionsController"]:::controller
        EventsCtrl["DocuSignEventsController"]:::controller
    end

    %% Domain Layer
    subgraph "Domain Services"
        style Domain fill:#FFF4D9,stroke:#D08800,stroke-width:2px
        CQService["CustomQuoteEnvelopeService"]:::domain
        CQBuilder["CustomQuoteEnvelopeBuilder"]:::domain
        CPService["CustomerProfileEnvelopeService"]:::domain
        CPBuilder["CustomerProfileEnvelopeBuilder"]:::domain
        ECService["EmploymentContractEnvelopeService"]:::domain
        ECBuilder["EmploymentContractEnvelopeBuilder"]:::domain
        TCService["TermsAndConditionsEnvelopeService"]:::domain
        TCBuilder["TermsAndConditionsEnvelopeBuilder"]:::domain
    end

    %% Infrastructure Layer
    subgraph "Infrastructure Services"
        style Infrastructure fill:#E8E8FF,stroke:#4B00B5,stroke-width:2px
        ApiProvider["DocuSignApiProvider"]:::infra
        TemplateBuilder["TemplateBuilder"]:::infra
        ClaimsRepo["ClaimsAccountRepository"]:::infra
        EventsRepo["InMemoryEventsRepository"]:::infra
    end

    %% Real-time Layer
    subgraph "Real-time (SignalR)"
        style RealTime fill:#FFE2E2,stroke:#B50000,stroke-width:2px
        EventsHub["EventsHub"]:::realtime
    end

    %% External Services
    subgraph "External"
        style External fill:#FFF0D9,stroke:#D08800,stroke-width:2px
        DocuSign["DocuSign eSignature Platform"]:::external
    end

    %% Configuration and CI/CD
    subgraph "Configuration & Deployment"
        style Config fill:#F0F0F0,stroke:#888888,stroke-width:1px
        AppSettings["appsettings/*.json, private.key"]:::config
        DockerCI["Dockerfile & CI/CD"]:::config
    end

    %% Flows
    Browser -->|"loads SPA"| SPA
    SPA -->|"HTTP/JSON"| AdminCtrl
    SPA --> QuoteCtrl
    SPA --> ProfileCtrl
    SPA --> EmpCtrl
    SPA --> TnCCtrl

    AdminCtrl -->|calls| CQService
    QuoteCtrl -->|calls| CQService
    ProfileCtrl -->|calls| CPService
    EmpCtrl -->|calls| ECService
    TnCCtrl -->|calls| TCService

    CQService -->|uses| CQBuilder
    CPService --> CPBuilder
    ECService --> ECBuilder
    TCService --> TCBuilder

    CQBuilder -->|SDK| ApiProvider
    CPBuilder --> ApiProvider
    ECBuilder --> ApiProvider
    TCBuilder --> ApiProvider

    TemplateBuilder --> ApiProvider
    ClaimsRepo --> ApiProvider

    ApiProvider -->|HTTPS| DocuSign

    DocuSign -->|Connect Webhook| EventsCtrl
    EventsCtrl -->|store event| EventsRepo
    EventsRepo -->|push update| EventsHub
    EventsHub -->|SignalR| SPA

    AppSettings --> AdminCtrl
    AppSettings --> EventsCtrl
    AppSettings --> ApiProvider

    DockerCI --> SPA
    DockerCI --> AdminCtrl

    %% Click Events - Frontend
    click SPA "https://github.com/docusign/sample-app-business-csharp/tree/main/DocuSign.MyBusiness/DocuSign.MyBusiness/ClientApp"

    %% Click Events - Controllers
    click AdminCtrl "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Controllers/Admin/AdminController.cs"
    click QuoteCtrl "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Controllers/CustomQuote/CustomQuoteController.cs"
    click ProfileCtrl "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Controllers/CustomerProfile/CustomerProfileController.cs"
    click EmpCtrl "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Controllers/EmploymentContract/EmploymentContractController.cs"
    click TnCCtrl "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Controllers/TermsAndConditions/TermsAndConditionsController.cs"
    click EventsCtrl "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Controllers/Events/DocuSignEventsController.cs"

    %% Click Events - Domain Services
    click CQService "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Domain/CustomQuote/Services/CustomQuoteEnvelopeService.cs"
    click CQBuilder "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Domain/CustomQuote/Services/CustomQuoteEnvelopeBuilder.cs"
    click CPService "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Domain/CustomerProfile/Services/CustomerProfileEnvelopeService.cs"
    click CPBuilder "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Domain/CustomerProfile/Services/CustomerProfileEnvelopeBuilder.cs"
    click ECService "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Domain/EmploymentContract/Services/EmploymentContractEnvelopeService.cs"
    click ECBuilder "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Domain/EmploymentContract/Services/EmploymentContractEnvelopeBuilder.cs"
    click TCService "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Domain/TermsAndConditions/Services/TermsAndConditionsEnvelopeService.cs"
    click TCBuilder "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Domain/TermsAndConditions/Services/TermsAndConditionsEnvelopeBuilder.cs"

    %% Click Events - Infrastructure
    click ApiProvider "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Infrustructure/Services/DocuSignApiProvider.cs"
    click TemplateBuilder "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Infrustructure/Services/TemplateBuilder.cs"
    click ClaimsRepo "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Infrustructure/Services/ClaimsAccountRepository.cs"
    click EventsRepo "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Infrustructure/Services/InMemoryEventsRepository.cs"

    %% Click Events - Real-time
    click EventsHub "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Hubs/EventsHub.cs"

    %% Click Events - Templates
    click TemplateJSON1 "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Templates/Employment_Contract.json"
    click TemplateJSON2 "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Templates/T_&_C_Supplement.json"
    click TemplateJSON3 "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Templates/Sales_Contract.json"
    click TemplateJSON4 "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Templates/User_Profile_Update.json"
    click TemplatePDF "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Templates/ORDER_FORM.pdf"

    %% Click Events - Config & CI/CD
    click AppSettings "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/appsettings-example.json"
    click AppSettings "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/appsettings.Development.json"
    click AppSettings "https://github.com/docusign/sample-app-business-csharp/blob/main/DocuSign.MyBusiness/DocuSign.MyBusiness/private.key"
    click DockerCI "https://github.com/docusign/sample-app-business-csharp/blob/main/.github/workflows/ci-cd.yml"
    click DockerCI "https://github.com/docusign/sample-app-business-csharp/tree/main/DocuSign.MyBusiness/DocuSign.MyBusiness/Dockerfile"

    %% Styling
    classDef frontend fill:#D0E8FF,stroke:#0366D6,color:#000
    classDef controller fill:#E2F0D9,stroke:#1E6823,color:#000
    classDef domain fill:#FFF4D9,stroke:#D08800,color:#000
    classDef infra fill:#E8E8FF,stroke:#4B00B5,color:#000
    classDef realtime fill:#FFE2E2,stroke:#B50000,color:#000
    classDef external fill:#FFF0D9,stroke:#D08800,color:#000
    classDef config fill:#F0F0F0,stroke:#888888,color:#000
    classDef user fill:#FFFFFF,stroke:#000000,color:#000,stroke-dasharray: 2 2
```
