.. index:: import, users, usermanagement

.. _import_users:

Benutzer importieren
======================

Benutzerliste erstellen
-------------------------

| Eine Benutzerliste muss entweder einem Node vom **Typ O (Organisation)** oder **TENANT (Mandant)**
  zugewiesen werden.
| Aus diesem Node und der Rolle [#user_roles]_ der Benutzerliste wird dann die Primärgruppe erstellt.
| Es können verschiedene Einstellungen vorgenommen werden, die für den Import der eigentlichen Benutzerdaten notwendig sind.

**Konfigurationen der Benutzerliste**


.. csv-table::
   :header: Konfiguration, Erklärung

   Anzeigename, Name der Benutzerliste.
   Separator, Separator Charakter der zu importierenden csv [#separator]_.
   Codepage, Encoding der zu importierenden csv [#codepage]_.
   Header ignorieren, "Wahl, ob die erste Zeile der Import-Datei ignoriert werden soll."
   Rolle, Rolle der Benutzer [#user_roles]_.
   Primärgruppe, "Primärgruppe zu welcher die Benutzer zugeordnet werden. Wenn es keine Primärgruppe passend zur
   ausgewählten Rolle gibt, kann hier ein Anzeigename angegeben werden und eine neue Primärgruppe wird daraus erstellt.
   Bei vorhandener Primärgruppe, wird diese automatisch gesetzt, bei mehreren kann gewählt werden."
   Benutzerkonfiguration, "Wird automatisch anhand der Primärgruppe gesetzt. Wenn keine Primärgruppe existiert kann
   gewählt werden, welche Konfiguration dieser zugewiesen werden soll."
   Mail Domain, "Information, welche Standard-Domain gesetzt wird."


Benutzerdaten hochladen
---------------------------

.. note:: Voraussetzung hierfür ist eine zuvor erstellte Benutzerliste.

| Über den |upload| Button, kann eine csv Datei hochgeladen werden. Danach können die Spalten über die Kopfzeile der Tabelle
  gesetzt werden [#columns]_. Es muss mindestens eine Spalte zur eindeutigen Benutzeridentifizierung ausgewählt werden.
  Spalten die leer gelassen werden, werden beim Import nicht beachtet, die Daten selbst werden jedoch für später gespeichert.
| Hier haben sie eine  :download:`Vorlage </assets/User_Import_Vorlage.zip>`, wie ihre Import-Datei aussehen könnte.

Benutzer zur Liste hinzufügen, bearbeiten, löschen
----------------------------------------------------

.. note:: Voraussetzung hierfür ist eine zuvor erstellte Benutzerliste.

| Über das Hinzufügen Icon |add| können einzelne Zeilen zur Benutzerliste hinzugefügt werden. Diese werden grün markiert
  und erst mit bestätigen durch "Speichern" wirklich zur Liste hinzugefügt.
| Die Bearbeitung der Werte muss über das Bearbeiten Icon |edit| aktiviert werden.
  Durch "Speichern" werden die Werte in der Benutzerliste gespeichert. Nach dem Speichern kann man die Aktion nicht mehr rückgängig machen.
  Vor dem Speichern, kann durch "Abbrechen" der zuletzt gespeicherte Zustand wiederhergestellt werden.
| Ganze Zeilen können über das Löschen Icon |delete| gelöscht werden. Somit wird auch die Bearbeitung aktiviert.
  Durch "Löschen" werden die selektierten Zeilen vorerst rot markiert. Auch hier werden diese erst durch "Speichern" wirklich aus der Liste entfernt.

.. |upload| image:: /assets/upload.png
  :width: 25
  :alt: schwarzer Pfeil nach oben

.. |add| image:: /assets/add.png
  :width: 25
  :alt: grünes Plus

.. |edit| image:: /assets/edit.png
  :width: 25
  :alt: blauer Stift

.. |delete| image:: /assets/delete.png
  :width: 25
  :alt: roter Mülleimer

Benutzerliste importieren
---------------------------

| Möchte man die Benutzer der Liste endgültig auf den Server importieren, müssen die Listen zuerst verifiziert werden.
  Die Listen werden Standortweise verifiziert. Sobald alle Listen valide sind,
  kann der Importvorgang durch "Importieren" ausgelöst werden.
| Bevor dieser Vorgang ausgelöst werden kann, muss der Log der Validierung angesehen werden.
  Der Import wird auch hier pro Standort angestoßen.


.. hint:: Wenn in der Benutzerliste Klassen angegeben sind, welche noch nicht existieren, werden diese erstellt.


Fortschrittsanzeige und Log
-----------------------------

| Den Fortschritt des Imports oder der Validierung kann in der Benutzerverwaltung über |progress| angesehen werden. Hierüber kann auch eine Übersicht
  zu den angestoßenen Importvorgängen aller Standorte geöffnet werden.
| Der Validierungs-Log zeigt an,
  ob Fehler beim Import entstehen würden oder was angelegt, geändert oder gelöscht wird. Wenn Fehler vorliegen, kann der Import nicht
  ausgeführt werden. Anhand dieser Informationen kann die Liste abgeändert werden, bis diese den Anforderungen entspricht.
| Auch nach dem Import wird ein Log geschrieben, der aufzeigt was geändert, gelöscht oder neu angelegt wurde.


.. |progress| image:: /assets/progress.png
  :width: 25
  :alt: Fortschritt rund

Benutzerliste exportieren
-------------------------------

| Eine Benutzerliste kann auch heruntergeladen werden |download|, um diese in einem csv-fähigen Editor zu bearbeiten.
| Nach der Bearbeitung kann diese einfach wieder hochgeladen werden, um sie erneut zu importieren.


.. |download| image:: /assets/download.png
  :width: 25
  :alt: schwarzer Pfeil nach unten


.. [#user_roles]

**Benutzerrollen**

* TEACHER
* STUDENT
* STAFF

.. [#separator]

**Separatoren**

* , (Komma)
* ; (Semikolon)

.. [#codepage]

**Encoding**

* utf-8
* utf-16

.. [#columns]

**Spaltenwerte**

* Abgangsjahr (departureYear)
* Anzeigename (displayName)
* Benutzername (username)
* Eindeutige ID (uid)
* Festplattenkontingent (diskQuota)
* Geburtsdatum (birthday)
* Geschlecht (gender)
* Kennwort (password)
* Klasse (class)
* Kürzel (shortname)
* Mail (mail)
* Mailkontingent (mailQuota)
* Nachname (sn)
* Vorname (givenName)