Inhaltsverzeichnis
Dieses Handbuch richtet sich an Administratoren und Programmierer. Die Import Software 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.
Die Importschnittstelle wurde als ein kommandozeilenbasiertes Tool umgesetzt, welches darauf ausgelegt ist, einen automatischen, nicht-interaktiven Import durchzuführen. Um dies zu erreichen, müssen bestimmte Voraussetzungen erfüllt werden, die in diesem Abschnitt anhand des Importablaufes erläutert werden.
Das Tool wurde in der Skriptsprache Python implementiert und ist in der Lage, zusätzliche/kundenspezifische Python-Dateien zu laden, die ein abweichendes Verhalten oder zusätzliche Funktionalitäten der Importschnittstelle hinzufügen.
Der Ablauf eines automatischen Imports wird über die nachfolgenden Schritte skizziert:
ucs-school-user-import
, die exportierten Daten einzulesen und die Eingabedatensätze (Benutzerdaten) konkreten UCS@school-Benutzern im LDAP-Verzeichnisdienst zuzuordnen.
Die Importschnittstelle unterstützt zwei unterschiedliche Modi, die festlegen, ob die Eingabedatensätze als neuer Soll-Zustand oder als inkrementelles Update zum Ist-Zustand interpretiert werden sollen.
Für die Analyse von Problemen wird während des gesamten Imports ein Protokoll über alle technischen Vorgänge in Logdateien mit unterschiedlichen Detailtiefen geführt.
Wenn nicht anders konfiguriert, sind das die Dateien /var/log/univention/ucs-school-import.log
und /var/log/univention/ucs-school-import.info
.
Die Importsoftware kann gegenwärtig Daten nur aus CSV-Dateien einlesen. Wie eine Unterstützung für weitere Dateiformate (z.B. JSON, XML etc.) hinzugefügt werden kann, kann dem Kapitel 8 entnommen werden.
Das Tool ucs-school-user-import
unterstützt den Import von Benutzerdaten aus mehreren Quellverzeichnissen. Um jeden UCS@school-Benutzer einem Benutzer in einer Quelldatenbank eindeutig zuordnen zu können, werden am UCS@school-Benutzerobjekt zwei zusätzliche Attribute gespeichert: sourceUID und recordUID.
Die sourceUID ist ein eindeutiger Bezeichner für die Quelldatenbank von der ein Benutzer importiert wurde. Der Bezeichner kann frei gewählt werden und muss für jede Quelldatenbank eindeutig sein. Er ist während des Imports auf der Kommandozeile bzw. in der Konfigurationsdatei für jede Quelldatenbank explizit mit anzugeben.
Die recordUID ist ein eindeutiger Bezeichner für den Benutzer in der Quelldatenbank. Als Bezeichner kann z.B. auf vorhandene Attribute innerhalb der Quelldatenbank, wie z.B. eine Schüler- oder Mitarbeiternummer, zurückgegriffen werden. Sollte kein eindeutig identifizierendes Attribut in der Quelldatenbank vorhanden sein, kann auch durch die Konkatenation von mehreren Attributen der Quelldatenbank ein ein eindeutiger Bezeichner generiert werden.
Durch die Kombination dieser beiden Bezeichner kann ein UCS@school-Benutzer genau einem Benutzer in einem bestimmten Quellverzeichnis zugeordnet werden.
sourceUID und recordUID müssen eindeutig und unveränderlich sein, sonst werden UCS@school-Benutzer beim Abgleich mit den Eingabedaten nicht gefunden und ggf. gelöscht bzw. es werden die falschen UCS@school-Benutzerobjekte modifiziert.
Mit Hilfe der beiden Bezeichner sourceUID und recordUID wird versucht, jeden Eingabedatensatz genau einem UCS@school-Benutzer zuzuordnen:
ucs-school-user-import
modifiziert.
Die Importsoftware gleicht die Eingabedaten mit dem LDAP-Verzeichnisdienst ab und passt den UCS@school-Benutzer entsprechend dem Eingabedatensatz an.
Wird vom früheren Import Skript zum Neuen migriert muss beachtet werden, dass je nachdem welche Version zuvor benutzt wurde, an den Benutzerobjekten entweder keine sourceUID gespeichert wurde, oder der Wert LegacyDB
.
Beispiele:
Die Schulen eines Schulträgers verwenden voneinander unabhängige Verwaltungssoftware. Die Software exportiert für jede Schule separate CSV-Dateien für den Import. Es wird je eine Datei für Schüler, Lehrer und Mitarbeiter erzeugt. Für den Import der CSV-Dateien wird pro Schule und Benutzerrolle eine separate Konfiguration mit individueller sourceUID benötigt. Sind die Konfigurationen hinreichend ähnlich, können die gleichen Konfigurationsdateien verwendet werden und die sie unterscheidenden Optionen an der Kommandozeile gesetzt werden. Sollten sich nur sourceUID und Benutzerrolle unterschieden, so würde der Import mit den entsprechenden Optionen z.B. so aufgerufen:
# /usr/share/ucs-school-import/scripts/ucs-school-user-import \ --conffile <gemeinsame Konfigurationsdatei> \ --sourceUID <Schulname>-<Benutzerrolle> \ --user_role <Benutzerrolle> \ --infile <CSV-Datei>
Durch die Verwendung von Schulname-Benutzerrolle
(z.B. GSMitte-student
) als sourceUID wird ein eindeutiger Bezeichner pro Schule und Benutzerrolle sicher gestellt.
Ab UCS@school Version 4.2 v4 wird nur eine sourceUID pro Schule benötigt (-<Benutzerrolle>
kann weggelassen werden), sofern mit --user_role
die Benutzerrolle angegeben wird.
In diesem Szenario ist die Verwendung schulübergreifender Benutzerkonten nicht möglich, weil dafür eine gemeinsame sourceUID der beteiligten Schulen benötigt wird.
Ein Schulträger verwendet eine Software für die Verwaltung aller seiner Schulen. Die Software exportiert für jede Benutzerrolle eine CSV-Datei. In diesen Dateien sind alle Benutzer aller Schulen (von der jeweiligen Rolle) enthalten.
Für den Import der CSV-Dateien wird nur pro Benutzerrolle eine separate Konfiguration mit individueller sourceUID benötigt, bzw. die gleiche Konfigurationsdatei und an der Kommandozeile wird gesetzt: --sourceUID <Benutzerrolle>
.
Ab UCS@school Version 4.2 v4 wird keine separate sourceUID mehr pro Benutzerrolle benötigt. Es reicht dann eine Konfigurationsdatei mit einer darin eingespeicherten sourceUID für alle Importvorgänge, sofern mit --user_role
die Benutzerrolle angegeben wird.
In diesem Szenario ist die Verwendung schulübergreifender Benutzerkonten möglich, weil Benutzer mit der gleichen Rolle an allen Schulen die gleiche sourceUID haben.
Ein Schulträger verwendet eine Software für die Verwaltung aller seiner Schulen. Die Software exportiert alle Benutzer in eine CSV-Datei. In dieser Datei sind Benutzer aller Rollen und aller Schulen enthalten. In der CSV-Datei gibt es eine Spalte in der steht welche Rolle der jeweilige Benutzer hat.
Für den Import der CSV-Dateien wird nur eine Konfigurationsdatei mit einer darin eingespeicherten sourceUID benötigt. Um die Benutzerrolle auszulesen muss die Klasse zum Einlesen von CSV-Dateien abgeleitet und erweitert werden: ucsschool.importer.reader.csv_reader.CsvReader
. Ein Code-Beispiel findet sich in der Klasse ucsschool.importer.reader.test_csv_reader.TestCsvReader
, zu welcher die Konfigurationsdatei /usr/share/ucs-school-import/configs/ucs-school-testuser-import.json
gehört.
In diesem Szenario ist die Verwendung schulübergreifender Benutzerkonten möglich, weil alle Benutzer die gleiche sourceUID haben.
Die Konfiguration des Imports wird über Dateien im JSON-Format und Kommandozeilenparameter gesteuert. Alle Kommandozeilenparameter können als Variablen in den Konfigurationsdateien verwendet werden, so dass ein Ausführen der Importsoftware ohne Kommandozeilenparameter möglich ist. Es ist aber auch möglich, über Kommandozeilenparameter sämtliche Variablen, die in Konfigurationsdateien stehen, zu überschreiben.
Beim Start von ucs-school-user-import
werden nacheinander mehrere Konfigurationsdateien eingelesen.
Jede Datei fügt der Konfiguration neue Konfigurationsvariablen hinzu oder überschreibt bereits existierende Konfigurationsvariablen von vorher eingelesenen Konfigurationsdateien.
Die Konfiguration des Imports wird in der folgenden Reihenfolge (mit aufsteigender Priorität) über folgende Konfigurationsdateien und Kommandozeilenparameter eingelesen:
/usr/share/ucs-school-import/configs/global_defaults.json
(Diese Datei sollte nicht manuell editiert werden!)
/var/lib/ucs-school-import/configs/global.json
(Diese Datei kann manuell angepasst werden – siehe unten)
/usr/share/ucs-school-import/configs/user_import_defaults.json
(Diese Datei sollte nicht manuell editiert werden!)
/var/lib/ucs-school-import/configs/user_import.json
(Diese Datei kann manuell angepasst werden – siehe unten)
-c
an der Kommandozeile angegeben wurde.
--set
gesetzt wurden.
Die Konfigurationsdateien unterhalb von /usr/share/ucs-school-import/configs/
sollten nicht editiert werden. Sie sind Teil der UCS@school-Installation und werden u.U. von Updates überschrieben.
Die Dateien unter /var/lib/ucs-school-import/configs/
werden automatisch bei der Installation angelegt und sind eigens dafür vorgesehen, eigene Einstellungen bzw. Konfigurationen vorzuhalten. Die Dateien bleiben bei Updates unangetastet.
Folgendes Verfahren wird empfohlen:
/usr/share/ucs-school-import/configs/global_defaults.json
gesetzt werden, können eigene Werte in die Datei /var/lib/ucs-school-import/configs/global.json
eingetragen werden.
/usr/share/ucs-school-import/configs/user_import_defaults.json
gesetzt werden, können eigene Werte in die Datei /var/lib/ucs-school-import/configs/user_import.json
eingetragen werden. Falls regelmäßig aus mehreren Quellverzeichnissen Benutzer importiert werden, sollten in dieser Datei auch Variablen gesetzt werden, die für alle Datenquellen gleichermaßen gelten.
/var/lib/ucs-school-import/configs/
abgelegt werden, welche schließlich an der Kommandozeile mit -c
angegeben wird. Diese Datei enthält Konfigurationseinstellungen, die auf die Spezifika der jeweiligen Schule bzw. Schulverwaltungssoftware einzugehen, und die jeweilige sourceUID passend zum Quellverzeichnis.
Die resultierende Konfiguration, die sich aus eingelesenen Konfigurationsdateien sowie verwendete Kommandozeilenparameter zusammenstellt, wird am Anfang jedes Importlaufes angezeigt und in alle Protokolldateien geschrieben. Um eine Konfiguration zu testen, kann ein Probelauf mit --dry-run
gestartet (und jederzeit gefahrlos abgebrochen) werden. Der Parameter simuliert einen Import, ohne dass Änderungen am UCS@school-Benutzern vorgenommen werden.
# /usr/share/ucs-school-import/scripts/ucs-school-user-import --help usage: ucs-school-user-import [-h] [-c CONFFILE] [-i INFILE] [-l LOGFILE] [-m] [-n] [-s SCHOOL] [--set [KEY=VALUE [KEY=VALUE ...]]] [--sourceUID sourceUID] [-u USER_ROLE] [-v] optional arguments: -h, --help show this help message and exit -c CONFFILE, --conffile CONFFILE Configuration file to use (see /usr/share/doc/ucs-school-import for an explanation on configuration file stacking). -i INFILE, --infile INFILE CSV file with users to import (shortcut for --set input:filename=...). -l LOGFILE, --logfile LOGFILE Write to additional logfile (shortcut for --set logfile=...). --set [KEY=VALUE [KEY=VALUE ...]] Overwrite setting(s) from the configuration file. Use ':' in key to set nested values (e.g. 'scheme:email=...'). -m, --no-delete Only add/modify given user objects. User objects not mentioned within input files are not deleted/deactived (shortcut for --set no_delete=...) [default: False]. -n, --dry-run Dry run - don't actually commit changes to LDAP (shortcut for --set dry_run=...) [default: False]. --sourceUID sourceUID The ID of the source database (shortcut for --set sourceUID=...) [mandatory either here or in the configuration file]. -s SCHOOL, --school SCHOOL Name of school. Set only, if the source data does not contain the name of the school and all users are from one school (shortcut for --set school=...) [default: None]. -u USER_ROLE, --user_role USER_ROLE Set this, if the source data contains users with only one role <student|staff|teacher|teacher_and_staff> (shortcut for --set user_role=...) [default: None]. -v, --verbose Enable debugging output on the console [default: False].
Nahezu alle Kommandozeilenparameter können auch in den Konfigurationsdateien angegeben werden. Um Variablen aus Konfigurationsdateien an der Kommandozeile zu setzen, kann --set
verwendet werden. Geschachtelte Konfigurationsvariablen können mit dem Doppelpunkt angegeben werden.
Um z.B. "2" als die Anzahl der Kopfzeilen in einer CSV-Datei anzugeben, kann entweder in einer Konfigurationsdatei stehen:
{ "csv": { "header_lines": 2 } }
oder es kann an der Kommandozeile der folgende Parameter verwendet werden:
--set csv:header_lines=2
Alle Zuweisungen für Variablen können leerzeichengetrennt hinter dem Kommandozeilenparameter --set
aufgelistet werden. Dabei ist zu beachten, dass nur ein --set
-Parameter an der Kommandozeile ausgewertet wird.
--set csv:header_lines=2 maildomain=univention.de no_delete=True
Das JSON-Format erlaubt Daten in verschachtelten Strukturen zu speichern, und ist sowohl von Computern als auch Menschen zuverlässig zu lesen und zu schreiben. Nach dem Editieren einer JSON-Datei kann ihre syntaktische Korrektheit mit Hilfe einer Webseite zur JSON Validierung oder eines Kommandozeilenprogramms überprüft werden:
python -m json.tool < my_config.json
Im Folgenden werden alle Konfigurationsschlüssel und ihre möglichen Werte und Typen beschrieben.
Schlüssel sind immer als Zeichenketten (string
) zu behandeln und müssen in doppelten Anführungszeichen stehen.
Als Datentypen werden folgende Typen unterstützt: Wahrheitswerte (boolean
: true
/ false
), Ganzzahlen (int
), Gleitkommazahlen (float
), Listen (list
: Werte die in [
und ]
eingeschlossen sind) und Objekte (object
: neue Verschachtelungsebene die in {
und }
eingeschlossen wird).
Die Verschachtelungstiefe wird in den Schlüsseln wie oben beschrieben mit Doppelpunkten angezeigt.
Eine Kurzreferenz aller Konfigurationsschlüssel findet sich auf dem Domänencontroller Master im Verzeichnis /usr/share/doc/ucs-school-import/
.
In den folgenden Tabellen kommt es layoutbedingt zu Leerzeichen und Umbrüchen in Variablen- und Schlüsselnamen. Diese müssen in den Konfigurationsdateien bzw. an der Kommandozeile entfernt werden. Keines der Schlüsselwörter enthält ein Leerzeichen oder einen Schrägstrich.
Tabelle 4.1. Globale Konfigurationsoptionen
Schlüssel / Kommandozeilenparameter | Beschreibung |
---|---|
§
| Ob ein Testlauf gestartet werden soll. Es werden keine Änderungen vorgenommen. |
Standard (boolean ): false | |
§
| Datei in die das ausführliche Protokoll geschrieben werden soll. Es wird außerdem eine Datei die auf .info endet, mit weniger technischen Details, angelegt. |
Standard (string ): "/var/log/univention/ucs-school-import.log" | |
| Ob ein ausführliches Protokoll auf die Kommandozeile geschrieben werden soll. |
Standard (boolean ): true |
Tabelle 4.2. Konfigurationsoptionen für den Benutzerimport
Schlüssel | Beschreibung |
---|---|
§classes | Die Methoden der Klasse DefaultUserImportFactory können überschrieben werden ohne die Klasse selbst zu ändern. Die Namen der überschriebenen Methoden ohne vorangestelltes make_ sind die Schlüssel, der volle Python-Pfad der Wert. Standardmäßig ist das Objekt leer und die Klasse DefaultUserImportFactory wird unverändert verwendet. Ein Beispiel findet sich in Abschnitt 8.3.2. |
Standard (object ): {} | |
factory | Voller Python-Pfad zu einer Klasse die von DefaultUserImportFactory abgeleitet ist. Wenn gesetzt, wird sie an ihrer Stelle verwendet (siehe Abschnitt 8.3.3). |
Standard (string ): "ucsschool.importer.default_user_import_factory. DefaultUserImportFactory" | |
input | Objekt, welches Informationen über die Eingabedaten enthält. |
Standard (object ) | |
input:type | Datenformat der angegebenen Eingabedatei. UCS@school unterstützt derzeit nur "csv" als Datenformat. |
Standard (string ): "csv" | |
| Einzulesende Datei. |
Standard (string ): "/var/lib/ucs-school-import/new-format-userimport.csv" | |
activate_new \ _users | Objekt, welches Konfigurationsmöglichkeiten zur Benutzeraktivierung enthält. Standardmäßig ist im Objekt nur der Schlüssel default gesetzt. Weitere Schlüssel (student , staff , teacher , teacher_and_staff ) sind möglich (siehe Abschnitt 4.3). |
Standard (object ): {"default": ..} | |
activate_new \ _users: \ default | Diese Variable definiert, ob ein neuer Benutzer automatisch aktiviert werden soll. Ist false eingestellt, wird das Benutzerkonto beim Anlegen automatisch deaktiviert. |
Standard (boolean ): true | |
csv | Dieses Objekt enthält Informationen darüber, wie CSV-Eingabedaten interpretiert werden sollen. |
Standard (object ): {"header_lines": .., "incell-delimiter": .., "mapping": ..} | |
csv:delimiter | Diese Variable definiert das Trennzeichen zwischen zwei Spalten. Als Wert wird üblicherweise ein Komma, Semikolon oder Tabulator verwendet. Die Importschnittstelle versucht das Trennzeichen automatisch zu erkennen, wenn diese Variable nicht gesetzt ist. |
Standard (string ): nicht gesetzt | |
§csv:header_ \ lines | Diese Variable definiert, wie viele Zeilen der Eingabedaten übersprungen werden sollen, bevor die eigentlichen Benutzerdaten anfangen. Wird der Wert "1" (Kopfdatensatz) verwendet, wird der Inhalt der ersten Zeile als Namen der einzelnen Spalten interpretiert. Die dort verwendeten Namen können dann in csv:mapping als Schlüssel verwendet werden. |
Standard (int ): 1 | |
csv:incell- \ delimiter | Dieses Objekt enthält Informationen darüber, welches Zeichen innerhalb einer Zelle zwei Daten trennt und kann z.B. bei der Angabe von mehreren Telefonnummern verwendet werden. Es kann ein Standard (default ) und pro Univention Directory Manager-Attribut eine Konfiguration (mit dem Namen des Schlüssels in csv:mapping ) definiert werden. |
Standard (object ): {"default": ..} | |
§csv:incell- \ delimiter: \ default | Standard-Trennzeichen innerhalb einer Zelle, wenn kein spezieller Schlüssel für die Spalte existiert. |
Standard (string ): "," | |
§csv:mapping | Enthält Informationen über die Zuordnung von CSV-Spalten zum Benutzerobjekt. Ist standardmäßig leer. Siehe Abschnitt 4.4. |
Standard (object ): {} | |
§deletion_grace_period | Dieses Objekt enthält Einstellungen zum Löschen von Benutzern. |
Standard (object ): {"deactivation": .., "deletion": ..} | |
§deletion_grace_period: \ deactivation | Definiert in wie vielen Tagen ein Benutzer, der nicht mehr in den Eingabedaten enthalten ist, deaktiviert (nicht gelöscht) werden soll. Wenn 0 gesetzt ist, wird das betroffene UCS@school-Benutzerkonto sofort deaktiviert. Wenn deletion_grace_period:deletion auf einen kleineren oder den gleichen Wert gesetzt ist, wird das Benutzerobjekt gelöscht statt deaktiviert. |
Standard (int ): 0 | |
§deletion_grace_period: \ deletion | Definiert die Anzahl der Tage, die nach dem Import vergehen sollen, bevor der Benutzer gelöscht aus dem Verzeichnisdienst wird. Bei einem Wert von 0 wird der Benutzer sofort gelöscht. Bei größeren Zahlen wird das geplante Löschdatum im Univention Directory Manager-Attribut ucsschoolPurgeTimestamp gesetzt. Ein Cron Job löscht automatisch Benutzer, deren geplanter Löschzeitpunkt erreicht ist. |
Standard (int ): 0 | |
scheme | Enthält Informationen über die Erzeugung von Werten aus anderen Werten und Regeln. Es können Ersetzungen wie in den UCS-Benutzervorlagen verwendet werden sowie alle Schlüssel aus |
Standard (object ): {"email": .., "recordUID": .., "username": {..}} | |
scheme:email | Schema aus dem die Email-Adresse erzeugt werden soll. Zusätzlich zu den in Abschnitt 4.5 beschriebenen Ersetzungen kommen noch zwei weitere hinzu: [ALWAYSCOUNTER] und [COUNTER2] (siehe Abschnitt 4.6). |
Standard (string ): "<firstname>[0].<lastname>@<maildomain>" | |
scheme: \ recordUID | Schema aus dem die eindeutige ID des Benutzers in der Quelldatenbank (Schulverwaltungssoftware) erzeugt werden soll. |
Standard (string ): "<email>" | |
scheme: \ username | Enthält Informationen über die Erzeugung von Benutzernamen. Standardmäßig enthält das Objekt nur die Schlüssel allow_rename und default . Weitere Schlüssel (student , staff , teacher , teacher_and_staff ) sind möglich (siehe Abschnitt 4.3). Zusätzlich zu den in Abschnitt 4.5 beschriebenen Ersetzungen kommen noch zwei weitere hinzu: [ALWAYSCOUNTER] und [COUNTER2] (siehe Abschnitt 4.6). |
Standard (object ): {"allow_rename": .., "default": ..} | |
scheme: \ username: \ allow_rename | Definiert, ob das Ändern von Benutzernamen erlaubt sein soll. Diese Variable ist z.Z. ohne Funktion. |
Standard (boolean ): false | |
scheme: \ username: \ default | Schema aus dem der Benutzername erzeugt werden soll, wenn kein Schema speziell für diesen Benutzertyp existiert. |
Standard (string ): "<:umlauts><firstname>[0].<lastname>[COUNTER2]" | |
scheme:<udm attribute name> | Univention Directory Manager-Attribute, die aus einem Schema erzeugt werden sollen. Der Schlüssel braucht nicht in csv:mapping vorzukommen. |
Standard (string ): nicht gesetzt | |
maildomain | Der Wert dieser Variable wird beim Formatieren mit einem Schema in die Variable <maildomain> eingesetzt. Wenn nicht gesetzt, wird versucht <maildomain> durch Daten aus dem System zu füllen. |
Standard (string ): nicht gesetzt | |
mandatory_ \ attributes | Liste mit Univention Directory Manager Attributnamen, die während des Imports aus den Eingabedaten oder indirekt über ein Schema gesetzt werden müssen. |
Standard (list ): ["firstname", "lastname", "name", "school"] | |
| Wenn auf true gesetzt, werden keine Benutzer gelöscht, oder nur solche für die es in den Eingabedaten explizit vermerkt ist. Dies kann genutzt werden, um eine Änderung an UCS@school-Benutzern vorzunehmen, ohne einen vollständigen Soll-Zustand zu übergeben oder um neue Benutzer hinzuzufügen.. |
Standard (bool ): false | |
output | Dieses Objekt enthält Informationen über zu produzierende Dokumente. |
Standard (object ): {"import_summary": ..} | |
§output:new_ \ user_passwords | Diese Variable definiert den Pfad zur CSV-Datei, in die Passwörter neuer Benutzer geschrieben werden. Auf den Dateinamen wird die Python-Funktion datetime.datetime.strftime() angewandt. Wenn ein Python-Format-String in ihm vorkommt, wird dieser umgewandelt (siehe Beispiel output:user_import_summary ). |
Standard (string ): nicht gesetzt | |
§output:user_ \ import_summary | Diese Variable definiert den Pfad zur CSV-Datei, in die eine Zusammenfassung des Import-Vorganges geschrieben wird. Auf den Dateinamen wird, wie bei output:new_user_passwords , die Python-Funktion datetime.datetime.strftime() angewandt. |
Standard (string ): "/var/lib/ucs-school-import/user_import_summary_%Y-%m-%d_%H:%M:%S.csv" | |
password_ \ length | Definiert die Länge des zufälligen Passwortes, das für neue Benutzer erzeugt wird. |
Standard (int ): 15 | |
| Schulkürzel/OU-Name der Schule, für die der Import sein soll. Dieser Wert gilt für alle Benutzer in den Eingabedaten. Sollte nur gesetzt werden, wenn die Schule nicht über die Eingabedaten gesetzt wird. |
Standard (string ): nicht gesetzt | |
| Eindeutige und unveränderliche Kennzeichnung der Datenquelle. Muss zwingend entweder in einer Konfigurationsdatei oder an der Kommandozeile gesetzt werden. |
Standard (string ): nicht gesetzt | |
tolerate_ \ errors | Definiert die Anzahl an (für die Import-Software) nicht-kritischen Fehlern, die toleriert werden sollen, bevor der Import abgebrochen wird. Wird der Wert -1 verwendet, bricht der Import nicht ab und fährt mit dem nächsten Eingabedatensatz fort. |
Standard (int ): 0 | |
user_deletion | Veraltet. Bitte deletion_grace_period verwenden. |
Standard (object ): nicht gesetzt | |
| Definiert die Benutzerrolle für alle Eingabedatensätze. Diese Variable sollte nur gesetzt werden, wenn die Benutzerrolle nicht in den Eingabedaten enthalten ist und die Eingabedatensätze homogen alle die gleiche Benutzerrolle verwenden sollen. Erlaubte Werte sind student , staff , teacher und teacher_and_staff . |
Standard (string ): nicht gesetzt |
Einige Einstellungen erlauben das Setzen von verschiedenen Werten, je nach Rolle des Benutzers, der gerade importiert wird.
In einem solchen Fall gibt es immer den Schlüssel default
, der automatisch verwendet wird, wenn es keinen Schlüssel in der Konfiguration für die betroffene Benutzerrolle gibt.
Erlaubte Werte für die Benutzerrollen-Schlüssel sind student
, staff
, teacher
und teacher_and_staff
.
Es müssen nicht zwangsläufig Schlüssel für alle Benutzerrollen angegeben werden.
Gilt für eine Einstellung z.B. das gleiche für Mitarbeiter und Lehrer und weicht nur der Wert für die Schüler-Benutzerrolle ab, so reicht es aus, default
und student
zu konfigurieren. In den Fällen staff
, teacher
und teacher_and_staff
wird in Abwesenheit einer spezifischen Konfiguration automatisch auf default
zurückgefallen:
{ "scheme": { "username": { "default": "<:umlauts><firstname>[0].<lastname>[COUNTER2]", "student": "<:umlauts><firstname>.<lastname><:lower>[ALWAYSCOUNTER]" } } }
Während des Imports aus einer CSV-Datei müssen die Daten einer Zeile, Attributen des anzulegenden bzw. zu ändernden Benutzerobjekts zugeordnet werden.
Diese Zuordnung geschieht im Konfigurationsobjekt csv:mapping
.
In ihm stehen Schlüssel-Wert-Paare: CSV-Spalte → Benutzerattribut.
Folgendes Beispiel zeigt wie der Import von drei Schülern an zwei Schulen konfiguriert werden kann. Die Schulverwaltungssoftware hat folgendes CSV produziert:
"Schulen","Vorname","Nachname","Klassen","Mailadresse","phone" "schule1,schule2","Anton","Meyer","schule1-1A,schule2-2B","anton@schule.local","" "schule1,schule2","Bea","Schmidt","schule1-2B,schule2-1A","bea@schule.local","0421-1234567890" "schule2","Daniel","Krause","schule2-1A","daniel@schule.local",""
Als erstes fällt auf, dass ein Schüler an zwei Schulen gleichzeitig eingeschrieben ist.
Schulübergreifende Benutzerkonten wurden mit UCS@school 4.1R2 eingeführt (siehe UCS@school 4.1 R2 v1 Release Notes) und werden von der Importsoftware unterstützt.
Entsprechend sind die Namen der Klassen so kodiert, dass sie eindeutig einer Schule zugeordnet werden können.
Anton geht also in die Klasse 1A
der Schule Schule1
und in die Klasse 2B
der Schule Schule2
.
Die Namen der Schulen bzw. Klassen sind ohne Leerzeichen und durch Komma getrennt, aufgelistet.
Als Trennzeichen innerhalb einer CSV-Zelle wird das Komma verwendet, da dies implizit aus der Standardeinstellung csv:incell-delimiter:default=","
aus /usr/share/ucs-school-import/configs/user_import_defaults.json
übernommen wurde.
Folgende Konfiguration nutzt implizit die Standardeinstellung csv:header_lines=1
aus /usr/share/ucs-school-import/configs/user_import_defaults.json
und verwendet damit die Spaltennamen aus der CSV-Kopfzeile als Schlüssel.
{ "csv": { "mapping": { "Schulen": "schools", "Vorname": "firstname", "Nachname": "lastname", "Klassen": "school_classes", "Mailadresse": "email", "phone": "phone" } } }
Um die Konfiguration zu überprüfen kann ein Testlauf mit --dry-run
gestartet werden. Anschließend steht in /var/log/univention/ucs-school-import.log
ein Protokoll das Debug-Ausgaben enthält. Hier findet sich:
2016-06-28 17:47:25 INFO user_import.read_input:81 ------ Starting to read users from input data... ------ [..] 2016-06-28 17:47:25 DEBUG base_reader.next:73 Input 3: ['schule1', 'Bea', 'Schmidt', 'schule1-2B,schule2-1A', 'bea@schule.local', 'Sch\xc3\xbclerin mit Telefon', '0421-1234567890'] -> {u'Schulen': u'schule1', u'Vorname': u'Bea', u'phone': u'0421-1234567890', u'Nachname': u'Schmidt', u'Klassen': u'schule1-2B,schule2-1A', u'Mailadresse': u'bea@schule.local'}
Ab der zweiten Zeile ist dies folgendermaßen zu lesen:
Input 3
: dritte Zeile der Eingabedatei, die Kopfzeile mitgerechnet.
['schule1', 'Bea', 'Schmidt', 'schule1-2B,schule2-1A', 'bea@schule.local', '0421-1234567890']
: Die Eingabezeile mit bereits getrennten Spalten.
{u'Schulen': u'schule1', u'Vorname': u'Bea', u'phone': u'0421-1234567890', u'Nachname': u'Schmidt', u'Klassen': u'schule1-2B,schule2-1A', u'Mailadresse': u'bea@schule.local'}
: Die Zuordnung von Daten zu den Schlüsseln aus der CSV-Kopfzeile.
Das Einlesen aus der CSV-Datei ist gelungen.
Die Daten wurden den Schlüsseln aus der CSV-Kopfzeile zugeordnet.
Da diese in csv:mapping
verwendet werden, kann nun weiter unten, beim Anlegen der Benutzer, die Zuordnung der Daten zu Benutzerattributen beobachtet werden:
2016-06-28 17:47:25 INFO user_import.create_and_modify_users:107 ------ Creating / modifying users... ------ [..] 2016-06-28 17:47:25 INFO user_import.create_and_modify_users:128 Adding ImportStudent(name='B.Schmidt', school='schule1', dn='uid=B.Schmidt,cn=schueler,cn=users,ou=schule1,dc=uni,dc=dtr', old_dn=None) (source_uid:NewDB record_uid:bea@schule.local) attributes={'$dn$': 'uid=B.Schmidt,cn=schueler,cn=users,ou=schule1,dc=uni,dc=dtr', 'display_name': 'Bea Schmidt', 'record_uid': u'bea@schule.local', 'firstname': 'Bea', 'lastname': 'Schmidt', 'type_name': 'Student', 'school': 'schule1', 'name': 'B.Schmidt', 'disabled': 'none', 'email': u'bea@schule.local', 'birthday': None, 'type': 'importStudent', 'schools': ['schule1'], 'password': 'xxxxxxxxxx', 'source_uid': u'NewDB', 'school_classes': {'schule1': ['schule1-2B'], 'schule2': ['schule2-1A']}, 'objectType': 'users/user'} udm_properties={u'phone': [u'0421-1234567890'], 'overridePWHistory': '1', 'overridePWLength': '1'}...
Hier ist nun zu sehen, dass Daten umgewandelt und Attributen zugeordnet wurden, sowie dass einige Attribute aus anderen Daten generiert wurden:
scheme:username
und scheme:recordUID
erzeugt worden.
In udm_properties werden Daten am Benutzerobjekt gespeichert, die nicht zu den Attributen der ImportUser
Klasse gehören (siehe Abschnitt 8.1).
Die Schlüssel entsprechen der Ausgabe des Kommandos:
udm users/user
Bei der obigen, langen Ausgabe handelt es sich um die Beschreibung eines ImportUser
Objektes.
Dieses zu kennen wird wichtig für die Programmierung von Hooks (siehe Abschnitt 8.2), mit denen vor und nach dem Anlegen, Ändern oder Löschen von Benutzern noch Aktionen ausgeführt werden können.
Es existieren zwei "Sonderwerte" die in der Konfiguration der Zuordnung (mapping
) verwendet werden können: __action
und __ignore
:
__action
: Steht in einer CSV-Spalte immer die auf einen eingelesenen Benutzer anzuwendende Aktion als Buchstabe kodiert, so wird die Import-Software keine eigene Entscheidung darüber fällen, sondern dieser Anweisung folgen.
Anlegen (add): A
, Ändern (modify): M
oder Löschen (delete): D
.
__ignore
: Der Inhalt dieser Spalte wird ignoriert. Die kann z.B. verwendet werden, wenn die CSV-Datei leerer Spalten, oder solche mit nicht zu importierenden Daten, enthält.
Weitere, eigene Interpretationen von Eingabewerten können in einer von ucsschool.importer.reader.csv_reader.CsvReader
abgeleiteten Klasse (siehe Abschnitt 8.3) in der Methode handle_input()
erzeugt werden.
Als Beispiel kann handle_input()
in ucsschool.importer.legacy.legacy_csv_reader.LegacyCsvReader
dienen, welches für den Import des alten CSV-Dateiformats den Sonderwert __activate
(neue Benutzer de/aktivieren) hinzufügt.
Um Unterstützung für den Import von anderen Dateiformaten als CSV (JSON, XML etc) hinzuzufügen, kann von ucsschool.importer.reader.base_reader.BaseReader
abgeleitet werden (siehe Abschnitt 8.3).
Es kann wünschenswert – oder wie im Fall von Benutzername und E-Mail-Adresse notwendig – sein, Attribute aus den Werten anderer Attribute zu erzeugen. Zum Beispiel speichern und exportieren Schulverwaltungssoftwares häufig keine Benutzernamen und E-Mail-Adressen, die zur eingesetzten Infrastruktur passen.
Aus diesem Grund unterstützt die Importsoftware die Erzeugung von Attributen mit Hilfe von konfigurierbaren Schemata. Das Format ist das gleiche wie das bei den UCS-Benutzervorlagen eingesetzte. Es existieren dedizierte Konfigurationsschlüssel für die Attribute email, recordUID und username. Darüber hinaus können Schemata für beliebige Univention Directory Manager Attribute (mit dem Namen des Attributs als Schlüssel) hinterlegt werden.
Im folgenden Beispiel würde allen aus den Eingabedaten übernommenen Telefonnummern die Ländervorwahl vorangestellt (und die führende 0 der Städtevorwahl entfernt), sowie die E-Mail-Adresse aus Vor- und Nachname berechnet:
{ "scheme": { "email": "<firstname>[0].<lastname>@<maildomain>", "recordUID": "<email>", "phone": "+49-<phone>[1:]" } }
Benutzernamen und Email-Adressen müssen in der gesamten Domäne, nicht nur an einer Schule, einmalig sein. Darüber hinaus kann es die Anforderung geben, dass Benutzernamen und Email-Adressen auch "historisch einmalig" sind, also auch dann nicht wiederverwendet werden, wenn die vorherigen Konten bereits lange gelöscht sind.
Aus diesem Grund können zur Erzeugung von Benutzernamen und Email-Adressen, über die üblichen Variablen in Formatierungsschema (siehe Abschnitt 4.5) hinaus, spezielle Zählervariablen verwendet werden. Diese Variablen werden bei ihrer Verwendung automatisch hochgezählt. Ihr Wert wird pro Benutzername bzw. Email-Adresse gespeichert. Es existieren zwei Variablen, die sich darin unterscheiden wie die ersten Benutzer mit gleichem Benutzernamen bzw. Email-Adresse, benannt werden:
[ALWAYSCOUNTER]
ist ein Zähler der bei seiner ersten Verwendung eine 1 einsetzt.
Benutzernamen für anton
wären: anton1
, anton2
, anton3
...
Analog für anton@dom.ain
: anton1@dom.ain
, anton2@dom.ain
, anton3@dom.ain
...
[COUNTER2]
ist ein Zähler der bei seiner ersten Verwendung keine Zahl einsetzt, erst bei seiner zweiten.
Benutzernamen für anton
wären: anton
, anton2
, anton3
...
Analog für anton@dom.ain
: anton@dom.ain
, anton2@dom.ain
, anton3@dom.ain
...
Im folgenden Beispiel würden für Bea Schmidt
die Benutzernamen b.schmidt
, b.schmidt2
, b.schmidt3
sowie Email-Adressen bea.schmidt1@dom.ain
, bea.schmidt2@dom.ain
, bea.schmidt3@dom.ain
erzeugt werden:
{ "scheme": { "username": { "default": "<:umlauts><firstname>[0].<lastname><:lower>[COUNTER2]" }, "email": "<firstname>.<lastname>[ALWAYSCOUNTER]@<maildomain>" }, "maildomain": "dom.ain", }
Die [0]
im Beispiel bedeutet, dass nur das erste Zeichen des davor stehenden Attributes genommen wird. Es ist auch möglich Bereiche anzugeben. Weitere Informationen dazu finden sich im Kapitel Benutzervorlagen des UCS Handbuchs.
Um neue Zählervariablen hinzuzufügen, muss von der Klasse ucsschool.importer.utils.username_handler.UsernameHandler
abgeleitet und die Methode counter_variable_to_function()
überschrieben werden (siehe Abschnitt 8.3).
Um diese neuen Zählervariablen auch für Email-Adressen zu verwenden, muss ucsschool.importer.utils.username_handler.EmailHandler
von der neuen, abgeleiteten UsernameHandler
Klasse sowie von ucsschool.importer.utils.username_handler.EmailHandler
abgeleitet werden.
Um Zählervariablen nur für Email-Adressen hinzuzufügen muss nur von der Klasse ucsschool.importer.utils.username_handler.EmailHandler
abgeleitet, und oben beschriebene Methoden überschrieben werden.
Für das Löschen von Benutzern kann in zwei Varianten konfiguriert werden:
Das Benutzerkonto wird sofort oder später gelöscht, nicht deaktiviert.
Dies entspricht dem Löschen eines Kontos im Univention Management Console-Modul ucs-handbuch]), zum definierten Zeitpunkt.
(siehe [
Diese Variante wird ausgewählt durch das Setzen von deletion_grace_period:deletion
auf einen Wert kleiner oder gleich dem von deletion_grace_period:deactivation
. Ist der Wert von deletion_grace_period:deletion=0
, wird sofort (während des Imports) gelöscht. Ist der Wert größer als 0
, wird ein Verfallsdatum im Univention Directory Manager-Attribut ucsschoolPurgeTimestamp gespeichert. Der Benutzer wird erst an diesem Tag durch einen Cron Job gelöscht.
Das Benutzerkonto wird erst deaktiviert und später gelöscht.
Dies entspricht dem Deaktivieren oder Setzen eines Kontoablaufdatums im Univention Management Console-Modul
und späteren Löschens in selbigem. Der Benutzer wird zuerst deaktiviert (kann sich nicht mehr einloggen), aber erst zu dem gesetzten Datum gelöscht. Bis zum finalen Löschen kann das Benutzerkonto noch reaktiviert werden, sollte es durch einen Import wieder "angelegt" werden.
Diese Variante wird ausgewählt durch das Setzen von deletion_grace_period:deletion
auf einen Wert größer dem von deletion_grace_period:deactivation
. Ist der Wert von deletion_grace_period:deactivation=0
, wird der Account sofort (während des Imports) deaktiviert. Ist der Wert größer als 0
, wird ein Verfallsdatum im Univention Directory Manager-Attribut user_expiry gespeichert. Der Benutzer kann sich ab diesem Tag nicht mehr anmelden. Der Wert von deletion_grace_period:deletion
wird wie in der ersten Variante beschrieben im Univention Directory Manager-Attribut ucsschoolPurgeTimestamp gespeichert und die Löschung später durch einen Cron Job durchgeführt.
Um eine der Löschvarianten zu ändern oder neue hinzuzufügen, muss von der Klasse ucsschool.importer.mass_import.user_import.UserImport
abgeleitet und die Methode do_delete()
überschrieben werden (siehe Abschnitt 8.3).
Bei einem Schulwechsel verlässt ein Schüler oder Lehrer seine ursprüngliche Schule A und wird an einer anderen Schule B aufgenommen. Hierbei sind drei Szenarien denkbar:
Schule A und Schule B werden vom gleichen Quellverzeichnis abgedeckt, die beiden Schulverwaltungen pflegen die Daten ihrer Schüler oder Lehrer jedoch unabhängig voneinander. Der Schulwechsel findet also in zwei Schritten statt. Es können zwei Szenarien auftreten:
Der Schuljahreswechsel erfolgt in drei Schritten:
Seit UCS@school 4.1 R2 werden schulübergreifende Benutzerkonten unterstützt. Ein Benutzerobjekt existiert im LDAP-Verzeichnis nur einmal: an seiner primären Schule (Attribut school). An weitere, festgelegte Schulen (Attribut schools) wird nur ein Ausschnitt des LDAP-Verzeichnisses seiner primären Schule repliziert: sein Benutzerobjekt und die Standardgruppen. Verlässt der Benutzer die Schule (durch Entfernen aus dem Attribut schools), so wird sein Benutzerobjekt dort gelöscht und nicht mehr dorthin repliziert. Bei der Verwendung von schulübergreifenden Benutzerkonten gilt es einige Dinge zu beachten.
Der Klassenarbeitsmodus und die Materialverteilung arbeiten grundsätzlich so, dass sie auf dem Schulserver an dem sie veranlasst wurden, die hochgeladenen Dateien in die Heimatverzeichnisse der betroffenen Benutzer kopieren. Befindet sich ein Heimatverzeichnis nicht auf dem Server, scheitert dies.
Windows-Clients verwenden das LDAP-Attribut homeDirectory (LDAP-Attribut sambaHomePath bzw. Univention Directory Manager-Attribut sambahome) um beim Einloggen das Netzwerklaufwerk mit den Dokumenten des Benutzers einzubinden. Wenn die primäre Schule eines Benutzers eine andere ist, als die, an der er gerade eine Klassenarbeit schreiben soll, so existiert sein Heimatverzeichnis dort unter Umständen nicht.
Es existieren drei Varianten des Umgangs mit der Univention Directory Manager-Attribut sambahome, mit folgenden Vor- und Nachteilen:
sambahome wird regulär durch das Import-Skript gesetzt und nicht manuell verändert. sambahome ist dann immer ein Verzeichnis auf dem Schulserver der primären Schule des jeweiligen Benutzers.
sambahome wird durch das Import-Skript für alle auf einen (per Univention Configuration Registry) festgesetzten, zentralen, Server gesetzt.
sambahome wird durch das Import-Skript auf einen Server mit einem Alias-Namen gesetzt. Je nach dem an welcher Schule sich der Benutzer befindet, bekommt er vom DNS-Server eine andere IP-Adresse für den gleichen Servernamen geliefert.
Es folgt eine Anleitung zur Einrichtung der dritten Variante.
Die folgenden Befehle müssen, mit angepassten Hostnamen und IP-Adressen, auf jedem Schulserver ausgeführt werden:
# UCR Variablen verfügbar machen eval "$(ucr shell)" # Name (Alias) des Servers auf dem das Heimatverzeichnis liegt ucr set ucsschool/import/set/sambahome=schoolserver # DNS-Eintrag schoolserver.$domainname -> IP-Adresse des *jeweiligen* Schulservers ucr set "connector/s4/mapping/dns/host_record/schoolserver.$domainname/static/ipv4"=172.16.3.12 # DNS-Eintrag aktivieren invoke-rc.d univention-s4-connector restart
Folgendes muss auf dem DC Master ausgeführt werden:
# Name (Alias) des Servers auf dem das Heimatverzeichnis liegt (wird vom Import ausgewertet) ucr set ucsschool/import/set/sambahome=schoolserver # DNS Forward-Eintrag einrichten (school.local durch korrekte Domäne ersetzen, # IP-Adresse eines zentralen Server, z.B. des DC Master, verwenden) udm dns/host_record create \ --superordinate "zoneName=school.local,cn=dns,$ldap_base" \ --set name=schoolserver \ --set a=172.16.1.1
Der Befehl host schoolserver
sollte nun auf allen Schulservern die IP-Adresse des jeweiligen Schulservers liefern.
Mit nslookup schoolserver
können die gleiche DNS-Anfrage komfortabel an verschiedene DNS-Server geschickt werden.
Die UCS@school Importsoftware ist so geschrieben worden, dass ihre Funktionalität möglichst einfach und gleichzeitig umfangreich veränderbar und erweiterbar ist. Dazu stehen zwei Methoden zur Verfügung:
ImportUser
Klasse
Die Klasse ImportUser
wird verwendet um Daten von eingelesenen oder zu ändernden Benutzern zu speichern. An Objekten der ImportUser
Klasse können folgende Attribute gesetzt werden:
Tabelle 8.1. Attribute der ImportUser Klasse
Attribut | Typ | Beschreibung |
---|---|---|
name | string | Benutzername |
school | string | Primäre Schule des Benutzers (Position des Objektes im LDAP) |
§schools | string / liste | Alle Schulen des Benutzers inkl. der primären Schule, als ein kommaseparierter String oder als Liste von Strings. |
firstname | string | Vorname |
lastname | string | Nachname |
birthday | string | Geburtsdatum im Format JJJJ-MM-TT |
email | string | E-Mail-Adresse |
password | string | Passwort (wird für neue Benutzer automatisch erzeugt, wenn nicht in den Eingabedaten vorhanden). |
disabled | boolean | Ob ein neuer Benutzer deaktiviert erzeugt werden soll. |
school_classes | string / object | Klassen in denen der Benutzer ist. Als String im Format Es können Klassen aus mehreren Schulen aufgelistet werden; diese Schulen müssen alle in |
source_uid | string | Kennzeichnung der Datenquelle |
record_uid | string | ID des Benutzers in der Datenquelle |
udm_properties | object | Alle anderen Univention Directory Manager Attribute die in den Eingabedaten enthalten waren, werden in dieses Python dictionary gespeichert. Oben stehende Attribute und ihre Univention Directory Manager-Pendants ( |
Weitere interessante Attribute, die jedoch nur gelesen und nicht modifiziert werden sollten, sind:
Tabelle 8.2. Attribute der ImportUser
Klasse (nur lesen)
Attribut | Typ | Beschreibung |
---|---|---|
dn | string | DN des Benutzer-Objekts im LDAP, wenn es jetzt gespeichert werden würde. |
entry_count | int | Zeile in CSV-Datei, aus der Daten des Benutzers stammen. Ist 0, wenn dies nicht zutrifft. |
input_data | list | Unveränderte Eingabedaten aus der CSV-Datei, bereits zu Elementen einer Liste aufgeteilt. |
ucr | object | Eine Univention Configuration Registry-Instanz zum Auslesen von Univention Configuration Registry-Einstellungen. |
Hooks sind Stellen im Programmcode, an die zusätzlicher Code "gehängt" werden kann. Für den Benutzerimport sind acht Stellen vorgesehen: jeweils vor und nach dem Anlegen, Ändern, Löschen oder Verschieben von Benutzern.
Zur Nutzung der Hook-Funktionalität muss eine eigene Python-Klasse erstellt werden, die von ucsschool.importer.utils.user_pyhook.UserPyHook
ableitet.
In der Klasse können Methoden pre_create()
, post_create()
, etc. definiert werden, welche zum jeweiligen Zeitpunkt ausgeführt werden.
Der Name der Datei mit der eigenen Klasse muss auf .py
enden und im Verzeichnis /usr/share/ucs-school-import/pyhooks
abgespeichert werden.
Der Quellcode der Klasse UserPyHook
ist zu finden in /usr/lib/pymodules/python2.7/ucsschool/importer/utils/user_pyhook.py
. In ihm sind alle Methoden und Signaturen dokumentiert.
Die Methoden der Hook-Klasse bekommen als Argument das Benutzerobjekt übergeben, das aus dem LDAP geladen wurde bzw. im LDAP gespeichert werden soll. Veränderungen an diesem Objekt werden bei dessen Abspeicherung direkt ins LDAP übernommen.
Die Klasse definiert ein dictionary priority
mit dessen Hilfe eine Reihenfolge definiert werden kann, sollten mehrere Hook-Klassen mit zum Einsatz kommen, die die gleichen Methoden definieren.
Die Namen der Methoden die ausgeführt werden sollen sind die Schlüssel, Methoden mit höheren Zahlen werden zu erst ausgeführt.
Ist der Wert None
, wird die Methode deaktiviert.
Zur Erstellung einer eigenen Hook-Klasse kann das Beispiel in /usr/share/doc/ucs-school-import/hook_example.py
kopiert und angepasst werden.
Alle Funktionen die nicht ausgeführt werden sollen, sollten entweder gelöscht oder deaktiviert werden (indem ihr Wert in priority
auf None
gesetzt wird).
Das könnte Beispielsweise so aussehen:
import datetime import shutil from ucsschool.importer.utils.user_pyhook import UserPyHook class MyHook(UserPyHook): priority = { "pre_create": 1, "post_create": None, "pre_remove": 1 } def pre_create(self, user): if user.birthday: bday = datetime.datetime.strptime(user.birthday, "%Y-%m-%d").date() if bday == datetime.date.today(): self.logger.info("%s has birthday.", user) user.udm_properties["description"] = "Herzlichen \ Glückwunsch" def post_create(self, user): # Diese Function ist deaktiviert. self.logger.info("Running a post_create hook for %s.", user) def pre_remove(self, user): # backup users home directory self.logger.info("Backing up home directory of %s.", user) user_udm = user.get_udm_object(self.lo) homedir = user_udm["unixhome"] shutil.copy2(homedir, "/var/backup/{}".format(user.name))
pre_create()
wird bei einem neuen Benutzer ein Gruß am Benutzerobjekt gespeichert, wenn er Geburtstag hat.
post_create()
Funktion ist durch das None
in priority
deaktiviert.
pre_remove()
wird ein Backup des Heimatverzeichnisses des Benutzers gemacht, bevor er gelöscht wird.
In pre_create()
wird in udm_properties
an den Schlüssel description der Wert Herzlichen Glückwunsch
geschrieben.
Das explizite Abspeichern des user
Objektes ist in dieser Funktion nicht nötig, da dies ja beim auf den Hook folgenden create
geschieht.
In der Funktion wird außerdem mit self.logger.info()
ein Text zu Protokoll gegeben.
Es handelt sich bei self.logger um eine Instanz eines Python logging
Objekts.
In pre_remove()
wird das Heimatverzeichnis des Benutzers benötigt.
Da dies nicht eines der direkt am Objekt stehenden Daten ist (siehe Abschnitt 8.1), muss zuerst das gesamte Benutzerobjekt aus dem LDAP geladen werden.
Dies tut user.get_udm_object()
, welches als Argument ein LDAP-Verbindungsobjekt erwartet.
Dieses ist im Hook-Objekt an self.lo gespeichert.
Falls das Benutzerobjekt in einem post-Hook geändert werden soll, so ist es möglich user.modify_without_hooks()
auszuführen, aber generell sollte ein erneutes Modifizieren nach dem Speichern vermieden werden.
Die Methoden create()
, modify()
und remove()
des Benutzerobjekts sollten von Hook-Methoden nicht ausgeführt werden, da dies zu einer Rekursion führen kann.
Hooks erlauben das Ausführen von neuem Code zu bestimmten Zeitpunkten. Sie erlauben aber nicht bestehenden Code zu verändern. In einer objektorientierten Sprache wie Python wird dies üblicherweise getan, indem eine Klasse modifiziert wird. Soll für einen bestimmten Fall nur ein Teil der Klasse verändert werden, wird von ihr abgeleitet und nur dieser Teil verändert, der unveränderte Teil wird geerbt.
Folgendes Beispiel zeigt, wie der Klasse, welche die historisch einmaligen Benutzernamen erzeugt, eine weitere Variable hinzugefügt werden kann.
Ein weiteres Beispiel ist in /usr/share/doc/ucs-school-import/subclassing_example.py
zu finden.
from ucsschool.importer.utils.username_handler import UsernameHandler class MyUsernameHandler(UsernameHandler): @property def counter_variable_to_function(self): name_function_mapping = super(MyUsernameHandler, self).counter_variable_to_function name_function_mapping["[ALWAYSWITHZEROS]"] = self.always_counter_with_zeros return name_function_mapping def always_counter_with_zeros(self, name_base): number_str = self.always_counter(name_base) number_int = int(number_str) new_number_str = "{:04}".format(number_int) return new_number_str
In counter_variable_to_function()
wird den existierenden beiden Variablen eine weitere hinzugefügt und auf die neue Funktion verwiesen.
always_counter_with_zeros()
verwendet always_counter()
zur Erzeugung der nächsten freien Zahl, schreibt diese aber dann so um, dass sie immer vier Stellen lang ist (der Anfang wird mit Nullen aufgefüllt).
Wird die Klasse unter /usr/local/lib/python2.7/dist-packages/usernames_with_zeros.py
abgespeichert, so kann sie unter Python als usernames_with_zeros.MyUsernameHandler
verwendet werden.
Zuvor muss das Verzeichnis angelegt werden:
mkdir -p /usr/local/lib/python2.7/dist-packages
Ob Python die Klasse findet, lässt sich testen mit:
python -c 'from usernames_with_zeros import MyUsernameHandler'
(Es sollte keine Ausgabe geben.)
Die neue Funktionalität lässt sich testen mit:
# python >>> from usernames_with_zeros import MyUsernameHandler >>> print MyUsernameHandler(15).format_username("Anton[ALWAYSCOUNTER]") Anton1 >>> print MyUsernameHandler(15).format_username("Anton[ALWAYSWITHZEROS]") Anton0002 >>> print MyUsernameHandler(15).format_username("Anton[ALWAYSWITHZEROS]") Anton0003 >>> exit()
Es gibt jetzt eine neue Klasse mit der neuen Funktionalität. Die Importsoftware muss nun noch dazu gebracht werden, diese neue, ihr nicht bekannte Klasse zu verwenden.
Die Architektur der Importsoftware ist als Abstrakte Fabrik (Abstract Factory) implementiert. In ihr wird die Erzeugung von Objekten zentralisiert. Sie zeichnet sich u.a. dadurch aus, dass sie erlaubt das Austauschen mehrerer Komponenten einer Software konsistent zu halten. Im Fall der Importsoftware ist die abstract factory jedoch nicht Abstrakt, alle Methoden wurden implementiert.
An allen Stellen der Importsoftware die z.B. mit dem Einlesen von CSV-Dateien zu tun haben, wird nicht die Klasse ucsschool.importer.reader.csv_reader.CsvReader
direkt instantiiert, sondern es wird von der eingesetzten factory eine Instanz verlangt (factory.make_reader()
) und verwendet.
Welche Klasse dem verwendeten Objekt zugrunde liegt ist nicht bekannt, sie muss nur die Methoden der ersetzten Klasse mit der gleichen Signatur implementieren.
Auf diese Art könnte z.B. der CSV-Reader
durch einen JSON-Reader
ersetzt werden.
Alles was dann zu tun bleibt, ist, die factory zu verändern.
Dies kann auf zwei Arten geschehen:
DefaultUserImportFactory
Klasse.
DefaultUserImportFactory
durch eine eigene Klasse.
Welche Methode gewählt wird, hängt davon ab ob die Anpassungen nur punktuell sind, oder ob es sich um ein größeres Umschreiben der Importsoftware handelt.
Es ist möglich die Methoden der DefaultUserImportFactory
Klasse einzeln zu überschreiben, ohne ihren Code zu ändern.
Damit die factory Objekte der MyUsernameHandler
Klasse aus dem obigen Beispiel beim Aufruf von make_username_handler()
liefert, muss in die Konfiguration folgendes eingetragen werden (siehe Konfigurationsoption classes
):
{ "classes": { "username_handler": "usernames_with_zeros.MyUsernameHandler" } }
Sollen umfangreichere Änderungen an der Importsoftware durchgeführt werden, kann von ucsschool.importer.default_user_import_factory.DefaultUserImportFactory
abgeleitet und ihre Methoden ersetzt werden.
In der Konfigurationsdatei kann die zu nutzende factory-Klasse über den Schlüssel factory
als voller Python-Pfad angegeben werden.
Obiges Beispiel lässt sich anstatt in der Konfiguration classes:username_handler
zu setzen auch so lösen:
from ucsschool.importer.default_user_import_factory import DefaultUserImportFactory from usernames_with_zeros import MyUsernameHandler class MyUserImportFactory(DefaultUserImportFactory): def make_username_handler(self, max_length): return MyUsernameHandler(max_length)
Wird diese Datei nun als /usr/local/lib/python2.7/dist-packages/my_userimport_factory.py
abgespeichert, so kann sie in der Konfiguration zur Verwendung als factory für die Importsoftware folgendermaßen aktiviert werden:
{ "factory": "my_userimport_factory.MyUserImportFactory" }
Der nächste Importvorgang lädt nun anstelle der DefaultUserImportFactory
die MyUserImportFactory
und wenn in der Importsoftware ein Objekt zur Erzeugung von Benutzernamen angefordert wird, so wird die neue Klasse entscheiden, das eines vom Typ MyUsernameHandler
geliefert wird.
[ucs-handbuch] Univention GmbH. 2017. Univention Corporate Server - Handbuch für Benutzer und Administratoren. https://docs.software-univention.de/handbuch-4.2.html.