# gt-analytics/fuam-basic architecture

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

- Interactive diagram: https://gitdiagram.com/gt-analytics/fuam-basic
- Repository: https://github.com/gt-analytics/fuam-basic

## Overview

##### Project type and purpose
- FUAM (Fabric Unified Admin Monitoring) is a solution-accelerator built entirely on Microsoft Fabric. It orchestrates data extraction via Pipelines and Notebooks, persists it in a Lakehouse (Delta Parquet), and exposes it through Semantic models and Power BI reports for unified monitoring of tenant usage, capacities, activities, and settings.

##### File structure
- Top-level files:
- LICENSE, README.md – project metadata
- files/deployment_file.json – deployment parameters (likely used by the Deploy notebook)
- start/Deploy_FUAM_Basic_Gen2.ipynb – primary deployment notebook
- media/… – images and screenshots for documentation
- No traditional “src/” or “backend/” folders because Fabric handles compute and storage via the service surface.

##### README for architectural insights
- Core components: Pipelines, Notebooks, Lakehouses, Semantic models, Power BI reports
- Modular structure: ingestion modules for Activities, Workspaces, Capacities, Tenant Settings, etc.
- Data flow: initial + incremental load via parameterized orchestration → raw data stored → transformation into Delta Parquet → semantic layer & Direct Lake consumption.

##### Main components and relationships
a. Components
1. Orchestration Pipelines (Fabric Pipelines)
2. Compute Units running Notebooks (extraction & transformation code)
3. Lakehouse (raw zone + curated zone with Delta Parquet tables)
4. Semantic Model (Lakehouse SQL endpoint / Direct Lake)
5. Power BI Reports (FUAM_Basic_Overview_Report + drill-downs)
6. Deployment Notebook (start/Deploy_FUAM_Basic_Gen2.ipynb)
7. Deployment Config (files/deployment_file.json)
8. External Fabric APIs (Tenant Scanner API, Git Connections, etc.)

b. Data flows
- Pipelines → trigger Notebooks → call Fabric REST APIs → write raw JSON to Lakehouse raw zone
- Notebooks (transform) → read raw JSON → write Delta Parquet tables to curated zone
- Semantic Model → points to Delta Parquet via Direct Lake → serves as dataset to Power BI
- Power BI → consumes dataset for dashboards

c. Architectural patterns
- Modular ingestion: each data domain (Activities, Capacities, Workspaces) is its own Notebook/module
- Parameterized orchestration: single main pipeline controls full vs. incremental loads
- Layered data zones: raw (persist API payloads) vs. curated (schema-on-write Delta Parquet)
- Direct Lake semantic layer for “live” reporting

d. Key technologies
- Fabric Pipelines (orchestration)
- Fabric Notebooks (Python/Power Query)
- Fabric Lakehouse (Delta Parquet storage)
- Fabric SQL Endpoint (Direct Lake)
- Power BI Reports
- Deployment via Notebook using deployment_file.json

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Deployment and Metadata
    subgraph "Deployment"
        DeploymentNotebook["Deployment Notebook"]:::compute
        DeploymentConfig["Deployment Config"]:::compute
        README["README.md"]:::compute
        LICENSE["LICENSE"]:::compute
        Media["media/"]:::compute
    end

    %% Ingestion Layer
    subgraph "Ingestion Layer"
        OrchestrationPipeline["Orchestration Pipeline"]:::compute
        subgraph "Ingestion Notebooks"
            GetActivities["Notebook: GetActivities"]:::compute
            GetWorkspaces["Notebook: GetWorkspaces"]:::compute
            GetCapacities["Notebook: GetCapacities"]:::compute
            GetTenantSettings["Notebook: GetTenantSettings"]:::compute
        end
    end

    %% External APIs
    ExternalAPIs["External Fabric APIs"]:::api

    %% Storage Layer
    subgraph "Storage Layer"
        LakehouseRaw["Lakehouse Raw Zone\n(ActivitiesRaw, WorkspacesRaw, ...)"]:::storage
        LakehouseCurated["Lakehouse Curated Zone\n(Delta Parquet Tables)"]:::storage
    end

    %% Semantic Layer
    SemanticModel["Semantic Model\n(SQL Endpoint / Direct Lake)"]:::semantic

    %% Consumption Layer
    subgraph "Consumption Layer"
        PowerBI["Power BI Reports"]:::report
        CustomReports["User/Custom Reports"]:::report
    end

    %% Connections
    DeploymentNotebook -->|uses parameters| DeploymentConfig
    DeploymentNotebook -->|reads| README
    DeploymentNotebook -->|reads| LICENSE
    DeploymentNotebook -->|reads| Media

    DeploymentNotebook -->|provisions| OrchestrationPipeline
    DeploymentConfig -->|provides parameters| OrchestrationPipeline

    OrchestrationPipeline -->|triggers| GetActivities
    OrchestrationPipeline -->|triggers| GetWorkspaces
    OrchestrationPipeline -->|triggers| GetCapacities
    OrchestrationPipeline -->|triggers| GetTenantSettings

    GetActivities -->|calls API| ExternalAPIs
    GetWorkspaces -->|calls API| ExternalAPIs
    GetCapacities -->|calls API| ExternalAPIs
    GetTenantSettings -->|calls API| ExternalAPIs

    ExternalAPIs -->|writes JSON| LakehouseRaw
    LakehouseRaw -->|transform notebooks| LakehouseCurated

    LakehouseCurated -->|serves| SemanticModel
    SemanticModel -->|live query| PowerBI
    SemanticModel -->|live query| CustomReports

    %% Click Events
    click DeploymentNotebook "https://github.com/gt-analytics/fuam-basic/blob/main/start/Deploy_FUAM_Basic_Gen2.ipynb"
    click DeploymentConfig "https://github.com/gt-analytics/fuam-basic/blob/main/files/deployment_file.json"
    click README "https://github.com/gt-analytics/fuam-basic/blob/main/README.md"
    click LICENSE "https://github.com/gt-analytics/fuam-basic/tree/main/LICENSE"
    click Media "https://github.com/gt-analytics/fuam-basic/tree/main/media/"

    %% Styles
    classDef compute fill:#E3F2FD,stroke:#0D47A1,color:#0D47A1;
    classDef storage fill:#E8F5E9,stroke:#1B5E20,color:#1B5E20;
    classDef semantic fill:#E0F2F1,stroke:#00695C,color:#00695C;
    classDef report fill:#FFFDE7,stroke:#F9A825,color:#F9A825;
    classDef api fill:#ECEFF1,stroke:#607D8B,color:#607D8B;
```
