UCS@school - Handbuch zur CLI-Import Schnittstelle

Dieses Handbuch richtet sich an Administratoren und Programmierer. Die Importsoftware ist im Auslieferungszustand stark konfigurierbar, kann aber zusätzlich programmatisch erweitert werden. In diesem Handbuch werden der Ablauf eines Importvorganges, Konfigurationsoptionen und Programmierschnittstellen beschrieben.

UCS@school bringt für viele regelmäßig wiederkehrende Verwaltungsaufgaben Werkzeuge und Schnittstellen mit. Die Übernahme von Benutzerdaten aus der Schulverwaltung ist eine dieser wiederkehrenden Aufgaben, die über die neue Importschnittstelle für Benutzer automatisiert erledigt werden kann.

Der UCS@school Import ermöglicht es Benutzerdaten aus einer Datei auszulesen, die Daten zu normieren, automatisch eindeutige Benutzernamen und E-Mail-Adressen zu generieren und notwendige Änderungen (Hinzufügen/Modifizieren/Löschen) automatisch zu erkennen. Er wurde so konzipiert, dass die Konten einer UCS Domäne automatisch mit dem Datenbestand eines vorhandenen Benutzerverzeichnisses abgeglichen werden können.

Die Importschnittstelle ist darauf ausgelegt, mit möglichst geringem Aufwand an die unterschiedlichen Gegebenheiten in Schulen angepasst zu werden. So ist die Basis der Importschnittstelle bereits vorbereitet, um unterschiedliche Dateiformate einlesen zu können. UCS@school bringt einen Importfilter für CSV-Dateien mit, der für unterschiedlichste CSV-Formate konfiguriert werden kann.

Über eigene Python-Plugins kann die Schnittstelle erheblich erweitert werden. Dies umfasst sowohl die Unterstützung für zusätzliche Dateiformate als auch die Implementierung von zusätzlichen Automatismen, die während des Imports greifen.

In den nachfolgenden Kapiteln werden der Ablauf eines Imports, die unterschiedlichen Konfigurationsmöglichkeiten sowie die Erweiterungsmöglichkeiten der Schnittstelle um neue Funktionalitäten beschrieben.

• 1. Ablauf des Importvorgangs
  • 1.1. Datenformate
  • 1.2. Kodierung
  • 1.3. Zuordnung von Benutzern des Quellverzeichnisses zu UCS@school-Benutzern
• 2. Konfiguration
  • 2.1. Kommandozeilenparameter
  • 2.2. UCR Konfiguration
    • 2.2.1. ucsschool/stop_notifier
  • 2.3. JSON-Konfigurationsformat
    • 2.3.1. Globale Konfiguration
    • 2.3.2. Konfiguration des Benutzerimports
  • 2.4. default-Schlüssel
  • 2.5. Zuordnung von Eingabedaten zu Benutzerattributen
    • 2.5.1. Sonderwerte
    • 2.5.2. Eigene Erweiterungen hinzufügen
  • 2.6. Formatierungsschema
  • 2.7. Einmalige Benutzernamen und E-Mailadressen
    • 2.7.1. Programmierung neuer Zählervariablen
  • 2.8. Benutzer löschen
• 3. Schulwechsel
• 4. Schuljahreswechsel
• 5. Schulübergreifende Benutzerkonten
  • 5.1. Schulspezifisches sambahome
• 6. Erweiterung um neue Funktionalität
  • 6.1. Die ImportUser Klasse
    • ImportUser
      • ImportUser.name
      • ImportUser.school
      • ImportUser.schools
      • ImportUser.firstname
      • ImportUser.lastname
      • ImportUser.birthday
      • ImportUser.expiration_date
      • ImportUser.email
      • ImportUser.password
      • ImportUser.disabled
      • ImportUser.school_classes
      • ImportUser.source_uid
      • ImportUser.record_uid
      • ImportUser.udm_properties
      • ImportUser.dn
      • ImportUser.entry_count
      • ImportUser.input_data
      • ImportUser.ucr
  • 6.2. Hooks
    • 6.2.1. Format-Hooks
  • 6.3. Subclassing
    • 6.3.1. Abstract Factory
    • 6.3.2. Überschreiben einer Methode
    • 6.3.3. Ersetzen durch eigene Klasse
  • 6.4. Prüfung der Konfiguration
• 7. LUSD Import
  • 7.1. Installation
  • 7.2. Verwendung
    • 7.2.1. Logging
  • 7.3. Konfiguration
    • 7.3.1. Kommandozeilenparameter
    • 7.3.2. Importkonfiguration
  • 7.4. Semesterstufen
  • 7.5. Fehlerbehandlung
    • 7.5.1. Migration existierender Nutzerdaten zum LUSD Import
• 8. Literaturverzeichnis
• 9. Stichwortverzeichnis