# eclipse-tractusx/portal-backend architecture

> Architecture diagram of the GitHub repository eclipse-tractusx/portal-backend, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/eclipse-tractusx/portal-backend
- Repository: https://github.com/eclipse-tractusx/portal-backend

## Overview

##### Project Type & Purpose
- It’s a set of loosely coupled microservices (Administration, Registration, Marketplace Apps, Marketplace Services, Notifications, Maintenance, Mailing, Provisioning, etc.), each exposing a Web API.
- A background “Processes.Worker” executes long-running or asynchronous domain processes via pluggable executors.
- A central relational database (or databases) is managed via EF Core migrations (PortalBackend.Migrations, Provisioning.Migrations).
- Shared functionality is extracted into internal “framework” and “externalsystems” libraries and published as NuGet packages.
- Integrates with external identity and trust systems: Keycloak (IAM), BPDM, BPN DID Resolver, Custodian wallet, DIM, Clearinghouse, Issuer, OfferProvider, OnboardingServiceProvider.

##### File Structure & Architectural Patterns
- src/<service> directories: each contains Controllers → BusinessLogic → DependencyInjection → ErrorHandling → Models → Program.cs → appsettings.json.
- src/framework: cross-cutting libraries (DBAccess, ErrorHandling, Cors, HttpClientExtensions, Token, Swagger, Logging, Models, DependencyInjection, Seeding, Web, Async).
- src/externalsystems: adapter libraries for external HTTP-based services.
- src/portalbackend: EF Core entities/models and repositories (PortalBackend.DBAccess & PortalBackend.PortalEntities) plus migrations & seeder.
- src/processes: domain process libraries + executors + “Processes.Worker” host.
- src/provisioning: separate DBAccess, library, migrations for provisioning IDP/technical user workflows.
- tests: xUnit projects for each service/library.
- docker: per‐service Dockerfiles and notices.
- GitHub workflows: CI/CD per service and code quality.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Clients & UI Layer
    subgraph "Clients & UI"
        direction TB
        PF["portal-frontend"]:::client
        RF["registration-frontend"]:::client
        Postman["Postman"]:::client
    end

    %% API Services Layer
    subgraph "API Services"
        direction TB
        Admin["Administration.Service"]:::service
        Registration["Registration.Service"]:::service
        Apps["Apps.Service"]:::service
        ServicesMS["Services.Service"]:::service
        Notifications["Notifications.Service"]:::service
        Maintenance["Maintenance.App"]:::service
        Mailing["Mailing.SendMail"]:::service
    end

    %% Background Worker Layer
    subgraph "Background Worker"
        direction TB
        Worker["Processes.Worker"]:::worker
        ACE["ApplicationChecklist.Executor"]:::executor
        DIMExec["DimUserProcess.Executor"]:::executor
        IDPExec["IdentityProviderProvisioning.Executor"]:::executor
        InviteExec["Invitation.Executor"]:::executor
        MailExec["Mailing.Executor"]:::executor
        NetRegExec["NetworkRegistration.Executor"]:::executor
        OfferSubExec["OfferSubscription.Executor"]:::executor
        SDExec["SelfDescriptionCreation.Executor"]:::executor
        UserProvExec["UserProvisioning.Executor"]:::executor
    end

    %% Shared Libraries Layer
    subgraph "Shared Libraries"
        direction TB
        Framework["Framework Libraries"]:::shared
        Externals["ExternalSystems Adapters"]:::shared
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        PortalDB[(Portal DB)]:::db
        ProvisioningDB[(Provisioning DB)]:::db
    end

    %% External Systems Layer
    subgraph "External Systems"
        direction TB
        Keycloak["Keycloak (IAM)"]:::external
        BPDM["BPDM"]:::external
        BPNDID["BPN DID Resolver"]:::external
        Clearing["Clearinghouse"]:::external
        Custodian["Custodian Wallet"]:::external
        DIM["DIM"]:::external
        Issuer["Issuer"]:::external
        OfferProv["OfferProvider"]:::external
        OnboardSP["OnboardingServiceProvider"]:::external
        SMTP["SMTP/SendGrid"]:::external
    end

    %% Connections UI -> API
    PF -->|HTTP| Admin
    PF -->|HTTP| Registration
    PF -->|HTTP| Apps
    PF -->|HTTP| ServicesMS
    PF -->|HTTP| Notifications
    PF -->|HTTP| Maintenance
    PF -->|HTTP| Mailing
    RF -->|HTTP| Registration
    Postman -->|HTTP| Admin

    %% API -> Data
    Admin -->|EF Core| PortalDB
    Registration -->|EF Core| PortalDB
    Apps -->|EF Core| PortalDB
    ServicesMS -->|EF Core| PortalDB
    Notifications -->|EF Core| PortalDB
    Maintenance -->|EF Core| PortalDB
    Mailing -->|EF Core| PortalDB

    %% API -> External
    Admin -->|HTTP via Externals| Keycloak
    Registration -->|HTTP via Externals| BPDM
    Apps -->|HTTP via Externals| BPNDID
    ServicesMS -->|HTTP via Externals| Clearing
    Notifications -->|HTTP via Externals| Custodian
    Maintenance -->|HTTP via Externals| DIM
    Mailing -->|SMTP| SMTP

    %% API -> Worker via DB
    Administration.Service -->|writes process record| PortalDB
    Registration -->|writes process record| PortalDB
    Apps -->|writes process record| PortalDB
    ServicesMS -->|writes process record| PortalDB

    %% Worker polling
    Worker -->|polls| PortalDB
    Worker -->|executes| ACE
    Worker -->|executes| DIMExec
    Worker -->|executes| IDPExec
    Worker -->|executes| InviteExec
    Worker -->|executes| MailExec
    Worker -->|executes| NetRegExec
    Worker -->|executes| OfferSubExec
    Worker -->|executes| SDExec
    Worker -->|executes| UserProvExec

    %% Shared Libraries usage
    Admin --> Framework
    Registration --> Framework
    Apps --> Framework
    ServicesMS --> Framework
    Notifications --> Framework
    Maintenance --> Framework
    Mailing --> Framework
    Admin --> Externals
    Registration --> Externals
    Apps --> Externals
    ServicesMS --> Externals
    Notifications --> Externals
    Maintenance --> Externals
    Mailing --> Externals

    %% Migrations (as jobs)
    subgraph "Migrations"
        PMig["PortalBackend.Migrations"]:::job
        ProvMig["Provisioning.Migrations"]:::job
    end
    PMig -->|migrates| PortalDB
    ProvMig -->|migrates| ProvisioningDB

    %% Provisioning DB layer
    ProvisioningDB -->|"DBAccess"| Externals
    Externals --> ProvisioningDB

    %% Click Events
    click Admin "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/administration/Administration.Service"
    click Registration "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/registration/Registration.Service"
    click Apps "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/marketplace/Apps.Service"
    click ServicesMS "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/marketplace/Services.Service"
    click Notifications "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/notifications/Notifications.Service"
    click Maintenance "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/maintenance/Maintenance.App"
    click Mailing "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/mailing/Mailing.SendMail"
    click Worker "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/processes/Processes.Worker"
    click ACE "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/processes/ApplicationChecklist.Executor"
    click DIMExec "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/processes/DimUserProcess.Executor"
    click IDPExec "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/processes/IdentityProviderProvisioning.Executor"
    click InviteExec "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/processes/Invitation.Executor"
    click MailExec "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/processes/Mailing.Executor"
    click NetRegExec "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/processes/NetworkRegistration.Executor"
    click OfferSubExec "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/processes/OfferSubscription.Executor"
    click SDExec "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/processes/SelfDescriptionCreation.Executor"
    click UserProvExec "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/processes/UserProvisioning.Executor"
    click Framework "https://github.com/eclipse-tractusx/portal-backend/tree/main/src/framework"
    click Externals "https://github.com/eclipse-tractusx/portal-backend/tree/main/src/externalsystems"
    click PMig "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/portalbackend/PortalBackend.Migrations"
    click ProvMig "https://github.com/eclipse-tractusx/portal-backend/blob/main/src/provisioning/Provisioning.Migrations"

    %% Styles
    classDef client fill:#e5f5ff,stroke:#1f78b4,color:#1f78b4
    classDef service fill:#e0f3e0,stroke:#2ca02c,color:#2ca02c
    classDef worker fill:#f0f0f0,stroke:#a0a0a0,color:#555555
    classDef executor fill:#f0f0f0,stroke:#a0a0a0,color:#555555
    classDef shared fill:#deebf7,stroke:#1f78b4,color:#1f78b4
    classDef db fill:#fff2cc,stroke:#e69f00,color:#e69f00
    classDef external fill:#fff0eb,stroke:#d95f02,color:#d95f02
    classDef job fill:#f7f7f7,stroke:#999999,color:#999999
```
