# dwayneselsig/somtodayopenapi2microsoftschooldatasync architecture

> Architecture diagram of the GitHub repository dwayneselsig/somtodayopenapi2microsoftschooldatasync, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync
- Repository: https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync

## Overview

##### Project type and purpose
- This is a .NET console-application (C#) whose sole purpose is to fetch data from the Somtoday Connect OpenAPI, transform it into Microsoft School Data Sync (SDS) CSV format (V1 or V2.1), and write the CSV files to disk.
- It is an open-source integration tool, not a full-stack web app. It runs on a schedule (e.g., Windows Task Scheduler) and logs status to the Windows Event Viewer.

##### File structure
- SomtodayOpenAPI2MicrosoftSchoolDataSync/Program.cs – entry point that loads configuration, invokes business logic, and handles high-level orchestration.
- Helpers/ – contains components:
– OpenAPIHelper.cs: handles HTTP calls to Somtoday Connect (authentication, paging, error handling).
– BusinessLogicHelper.cs: implements core sync logic (filtering by location, applying unique IDs, date/year-end logic, guardian sync toggles).
– SDScsvHelperV1.cs and SDScsvHelperV2.cs: transform in-memory models into SDS-compliant CSV rows.
– FileHelper.cs: creates output directories, writes CSV files to disk.
– SettingsHelper.cs and SomEnvironmentConfig.cs: read and validate settings from App.config.
– EventLogHelper.cs: writes informational and error entries to Windows Event Viewer.
- Models/ – DTOs representing OpenAPI resources (lesgroepen, leerlingen, docenten) and CSV row schemas.
- OpenAPIs/ – auto-generated client proxy (openapi.json & openapi.cs) for Somtoday Connect REST endpoints.
- App.config – contains all runtime settings (environment, filters, client credentials, output folder, formatting choices, toggles).
- SomtodayOpenAPI2MicrosoftSchoolDataSync.csproj & packages.config – NuGet dependencies (e.g., Newtonsoft.Json, HTTP client libraries).

##### README for additional insights
- Describes the high-level workflow: fetch lesson groups, filter out items without teachers or students, assign unique IDs, sanitize invalid characters, generate CSV, and log to Event Viewer.
- Configuration options drive branching behavior (TEST vs. PROD, location filtering, guardian sync, CSV version, year-end cleanup).
- Intended to be run nightly via a scheduler.

##### Detail
- Every Helper class and its role.
- Call out the App.config settings block as the root of behavior toggles.
- Do not over-complicate – the system is a linear pipeline with well-defined stages.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Actors
    Scheduler["Scheduled Task"]:::external
    SomtodayService["Somtoday Connect API"]:::external
    FileSystem["CSV Output Folder"]:::storage
    WindowsEventViewer["Windows Event Viewer"]:::external

    %% Application Entry
    Program["Program.cs\n(Console App)"]:::entry

    %% Configuration Layer
    subgraph "Configuration"
        direction TB
        AppConfig["App.config"]:::config
        SettingsHelper["SettingsHelper.cs"]:::config
        SomEnvConfig["SomEnvironmentConfig.cs"]:::config
    end

    %% Data Access Layer
    subgraph "Somtoday Connect Client"
        direction TB
        OpenAPIHelper["OpenAPIHelper.cs"]:::data
        openapiJson["openapi.json"]:::data
        openapiCs["openapi.cs"]:::data
    end

    %% Models
    subgraph "Models"
        direction TB
        SDScsvV1Model["SDScsvV1.cs"]:::model
        SDScsvV2Model["SDScsvV2.cs"]:::model
        VestigingModel["VestigingModel.cs"]:::model
    end

    %% Business Logic Layer
    subgraph "Business Logic"
        direction TB
        BusinessLogicHelper["BusinessLogicHelper.cs"]:::business
    end

    %% Transform & Output Layer
    subgraph "CSV Transformers & File Output"
        direction TB
        SDScsvHelperV1["SDScsvHelperV1.cs"]:::transform
        SDScsvHelperV2["SDScsvHelperV2.cs"]:::transform
        FileHelper["FileHelper.cs"]:::transform
    end

    %% Logging
    subgraph "Logging"
        direction TB
        EventLogHelper["EventLogHelper.cs"]:::logging
    end

    %% Project & Resources
    subgraph "Project Files"
        direction TB
        Csproj["SomtodayOpenAPI2MicrosoftSchoolDataSync.csproj"]:::project
        Packages["packages.config"]:::project
        IconResource["Icon-license.txt"]:::project
    end

    %% Relationships
    Scheduler -->|triggers| Program
    Program -->|loads| AppConfig
    Program -->|uses| SettingsHelper
    Program -->|uses| SomEnvConfig
    Program -->|calls| BusinessLogicHelper

    BusinessLogicHelper -->|fetch data| OpenAPIHelper
    OpenAPIHelper -->|HTTP calls| SomtodayService
    SomtodayService -->|returns JSON| OpenAPIHelper
    OpenAPIHelper -->|maps to DTOs| SDScsvV1Model
    OpenAPIHelper -->|maps to DTOs| SDScsvV2Model
    OpenAPIHelper -->|maps to DTOs| VestigingModel
    OpenAPIHelper -->|returns models| BusinessLogicHelper

    BusinessLogicHelper -->|process & filter| SDScsvHelperV1
    BusinessLogicHelper -->|process & filter| SDScsvHelperV2

    SDScsvHelperV1 -->|generates rows| FileHelper
    SDScsvHelperV2 -->|generates rows| FileHelper
    FileHelper -->|writes CSV| FileSystem

    Program -->|logs status| EventLogHelper
    BusinessLogicHelper -->|logs errors| EventLogHelper
    EventLogHelper -->|writes entries| WindowsEventViewer

    Program -->|references| Csproj
    Program -->|references| Packages
    Program -->|includes| IconResource

    %% Click Events
    click Program "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Program.cs"
    click AppConfig "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/App.config"
    click SettingsHelper "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Helpers/SettingsHelper.cs"
    click SomEnvConfig "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Helpers/SomEnvironmentConfig.cs"
    click OpenAPIHelper "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Helpers/OpenAPIHelper.cs"
    click openapiJson "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/OpenAPIs/openapi.json"
    click openapiCs "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/OpenAPIs/openapi.cs"
    click BusinessLogicHelper "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Helpers/BusinessLogicHelper.cs"
    click SDScsvHelperV1 "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Helpers/SDScsvHelperV1.cs"
    click SDScsvHelperV2 "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Helpers/SDScsvHelperV2.cs"
    click FileHelper "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Helpers/FileHelper.cs"
    click EventLogHelper "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Helpers/EventLogHelper.cs"
    click SDScsvV1Model "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Models/SDScsvV1.cs"
    click SDScsvV2Model "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Models/SDScsvV2.cs"
    click VestigingModel "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Models/VestigingModel.cs"
    click IconResource "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/Resources/Icon-license.txt"
    click Csproj "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/SomtodayOpenAPI2MicrosoftSchoolDataSync.csproj"
    click Packages "https://github.com/dwayneselsig/somtodayopenapi2microsoftschooldatasync/blob/master/SomtodayOpenAPI2MicrosoftSchoolDataSync/packages.config"

    %% Styles
    classDef config fill:#D0E6F5,stroke:#333,stroke-width:1px
    classDef data fill:#C8E6C9,stroke:#333,stroke-width:1px
    classDef business fill:#FFE0B2,stroke:#333,stroke-width:1px
    classDef transform fill:#FFF59D,stroke:#333,stroke-width:1px
    classDef logging fill:#E0E0E0,stroke:#333,stroke-width:1px
    classDef external fill:#F5F5F5,stroke:#333,stroke-width:1px
    classDef storage fill:#B3E5FC,stroke:#333,stroke-width:1px
    classDef entry fill:#BBDEFB,stroke:#333,stroke-width:1px
    classDef model fill:#E1BEE7,stroke:#333,stroke-width:1px
    classDef project fill:#F8BBD0,stroke:#333,stroke-width:1px
```
