Seminar Magda Intensivseminar: Entwicklung, Integration und Erweiterung

Der Intensivpfad bündelt Architektur, lokale Entwicklung, Registry, APIs, Kommandozeile, Connectors, Minions, Suche und UI-Erweiterung. Eine durchgängige Erweiterung wird vom Metadatenmodell über Integration und Anreicherung bis zur sichtbaren Benutzeroberfläche entwickelt und bereitgestellt.

Inhaltsübersicht

1. Architektur und lokale Umgebung
2. Metadatenmodell und Registry
3. Events und Webhooks
4. API, API-Schlüssel und mgd
5. Connector entwickeln
6. Minion entwickeln
7. Suche und Indexierung
8. UI-Anpassung und Plugin-Komponente
9. Authentifizierungs- und Integrationsgrenzen
10. Auslieferung und Abschlussprojekt
11. Praxisübungen und Voraussetzungen

Zielgruppe

Softwareentwicklung, Datenengineering, Integrationsarchitektur, Plattformengineering und technische Produktentwicklung.

Lernziele

• Magda-Architektur und Entwicklungsabläufe sicher beherrschen.
• Records, Aspects, Events und Webhooks korrekt modellieren.
• APIs und mgd für robuste Automatisierung einsetzen.
• Eigene Connectors und Minions entwickeln und betreiben.
• UI- und Plugin-Erweiterungen integrieren, testen und ausliefern.

Seminarinhalte

1. Architektur und lokale Umgebung

1. Schritt 1: Kernservices, Datenflüsse und Erweiterungspunkte zuordnen.
2. Schritt 2: Lokale Entwicklungsumgebung aufbauen und verifizieren.
3. Schritt 3: Build-, Test- und Containerabläufe reproduzierbar ausführen.

2. Metadatenmodell und Registry

1. Schritt 1: Records und Aspects für einen neuen fachlichen Anwendungsfall entwerfen.
2. Schritt 2: JSON-Schemas erstellen und mit Beispieldaten validieren.
3. Schritt 3: Erstellung, Änderung und Historie über Registry-APIs prüfen.

3. Events und Webhooks

1. Schritt 1: Relevante Registry-Ereignisse auswählen.
2. Schritt 2: Webhook mit Filter- und Zustellanforderungen konfigurieren.
3. Schritt 3: Wiederholung, Idempotenz und Fehlerbehandlung testen.

4. API, API-Schlüssel und mgd

1. Schritt 1: Technischen Benutzer und minimal berechtigten API-Schlüssel vorbereiten.
2. Schritt 2: Datensätze per API und CLI suchen, erstellen und aktualisieren.
3. Schritt 3: Automatisierung mit Protokollierung und Wiederanlauf absichern.

5. Connector entwickeln

1. Schritt 1: Quellsystem und Mapping analysieren.
2. Schritt 2: Abruf, Transformation und Registry-Schreibvorgang implementieren.
3. Schritt 3: Connector containerisieren und als wiederholbaren Job ausführen.

6. Minion entwickeln

1. Schritt 1: Ereignis und Ziel-Aspect für eine Anreicherung definieren.
2. Schritt 2: Verarbeitung idempotent implementieren.
3. Schritt 3: Fehler, Wiederholung und Qualitätsauswirkung überwachen.

7. Suche und Indexierung

1. Schritt 1: Weg vom Registry-Ereignis bis zum Suchindex nachvollziehen.
2. Schritt 2: Suchfelder, Relevanz und Filter für die Erweiterung bewerten.
3. Schritt 3: Indexierungsfehler diagnostizieren und erneute Verarbeitung prüfen.

8. UI-Anpassung und Plugin-Komponente

1. Schritt 1: Oberflächenkonfiguration und wiederverwendbare Komponente auswählen.
2. Schritt 2: Eigene Darstellung für das neue Aspect implementieren.
3. Schritt 3: Fehlerzustände, Berechtigungen und Barrierefreiheit testen.

9. Authentifizierungs- und Integrationsgrenzen

1. Schritt 1: Sitzung, API-Schlüssel und technische Identitäten unterscheiden.
2. Schritt 2: Plugin-Anforderungen für besondere Identitätsanbieter skizzieren.
3. Schritt 3: Geheimnisse und Zugriffsgrenzen in der Auslieferung absichern.

10. Auslieferung und Abschlussprojekt

1. Schritt 1: Container und Helm-Konfiguration für alle Erweiterungen erstellen.
2. Schritt 2: End-to-End-Test vom Quellsystem bis zur UI durchführen.
3. Schritt 3: Betriebs-, Fehler- und Übergabedokumentation vervollständigen.

Praxisübungen

• Entwurf und Implementierung eines eigenen Metadaten-Aspects.
• API- und CLI-gestützte Automatisierung der Datensatzpflege.
• Eigener Connector mit Mapping und Container-Job.
• Eigener Minion zur automatischen Metadatenanreicherung.
• UI-Komponente und End-to-End-Bereitstellung per Helm.

Voraussetzungen

Gute Kenntnisse in TypeScript oder einer vergleichbaren Sprache, HTTP, JSON, Git, Containertechnik und grundlegenden Kubernetes-Konzepten.