Dies ist eine alte Version des Dokuments!
Inhaltsverzeichnis
Ersteinrichtung
Installation
Die Einrichtung des Servers und Installation der Software ist im internen GitLab-Wiki bzw. der README beschrieben.
Wird im Browser die Startseite des frisch installierten CMS aufgerufen, erscheint eine Fehlermeldung bezüglich eines fehlenden Moduls. Dies ist beabsichtigt und resultiert daraus, dass bisher keinerlei Konfiguration im Backend des CMS erfolgt ist!
Portal-spezifische Konfiguration, Grafiken, und Datensätze sind nicht Bestandteil des Quellcodes und müssen individuell erstellt werden.
Die Verwendung und Anpassung des Designs mittels Layout-Templates sind in einem separaten Kapitel beschrieben.
Benutzer anlegen
Aus Sicherheitsgründen ist die Registrierung von neuen Nutzern standardmäßig deaktiviert.
Um einen ersten Nutzer anzulegen muss in der Konfigurationsdatei .env
im Wurzelverzeichnis der Anwendung auf dem Webserver folgender Eintrag ergänzt oder angepasst werden:
USER_REGISTRATION=true
Danach im Browser die Login-Seite der installierte Webanwendung (https://example.com/login) aufrufen und auf den Registrieren-Link klicken. Die Angabe eines Nutzernamens, Passwort und einer gültigen Emailadresse ist obligatorisch.
Nach erfolgter Registrierung verschickt das System eine Email mit einem Bestätigunslink, um die Emailadresse zu verifizieren.
Der allererste registrierte Nutzer erhält automatische alle Adminstratoren-Rechte (Nutzergruppe Super-Admin)!
Danach sollte die Benutzer-Registrierung mittels
USER_REGISTRATION=false
wieder deaktiviert werden, falls nicht unbedingt benötigt!
Datensatztypen definieren
Als erstes muss mindestens ein Typ für Datensätze angelegt werden:
- Menüpunkt Konfiguration –> Datensatztypen
- Button [Neuer Listeneintrag]
- einen systemweit eindeutigen Bezeichner eingeben, Attribut
code
wählen - Button [Neuer Einzelwert]
- einen beschreibenden deutschen Namen eingeben, Attribut
name_de
wählen - ggf. die letzten beiden Schritte für weitere Sprachen wiederholen
Gliederungspunkte definieren
Auch wenn keine Gliederung der Anzeigefelder erfolgen soll, muss zumindest ein Gliederungspunkt angelegt werden, da dieser für die Feld-Zuordnungen benötigt wird. Über die Konfigurationseinstellungen kann dann definiert werden, dass der Gliederungspunkt im Frontend nicht angezeigt wird.
Sollen die Anzeigefelder im Front- und/oder Backend in bestimmte Kategorien gegliedert werden, sollten mehrere Gliederungspunkte definiert werden (z.B. könnten die Anzeigefelder Wiss. Name, Synonyme, Dt. Name etc. einer Kategorie / einem Gliederungspunkt „Systematik“ zugeordnet werden)
- Menüpunkt Konfiguration –> Gliederungspunkte
- Button [Neuer Listeneintrag]
- einen beschreibenden deutschen Namen eingeben, Attribut
name_de
wählen –> Speichern - wenn dem Listeneintrag weitere Attribute (z.B. Namen in anderen Sprachen, Beschreibungen, Konfigurationseinstellungen etc.) zugewiesen werden sollen, dann werden neue Einzelwerte hinzugefügt
- nachfolgendes Beispiel für Konfiguration, dass Gliederungspunkt im Frontend standardmäßig ausgeklappt erscheinen soll (wird keine Konfigurationseinstellung vorgenommen ist der Gliederungspunkt eingeklappt):
- Button [Neuer Einzelwert]
- Attribut
config
auswählen - unter Wert
{„show_collapsed“:true}
eingeben (Anm. Die Einträge für Konfigurationseinstellungen müssen einen definierten JSON-Format entsprechen –> nur von sehr fortgeschrittenen Nutzern vorzunehmen) - Speichern
- ggf. die letzten Schritte für Hinzufügen weiterer Attribute wiederholen
Namen der Anzeigefelder definieren
- Menüpunkt Konfiguration –> Anzeigefelder-Namen
- Button [Neuer Listeneintrag]
- einen beschreibenden deutschen Namen eingeben, Attribut
name_de
wählen –> Speichern - wenn dem Listeneintrag weitere Attribute (z.B. Namen in anderen Sprachen, Beschreibungen, Konfigurationseinstellungen etc.) zugewiesen werden sollen, dann werden neue Einzelwerte hinzugefügt
- nachfolgendes Beispiel für Hinzufügen einer Beschreibung des Feldes:
- Button [Neuer Einzelwert]
- Attribut
description_de
auswählen - unter Wert eine Beschreibung eingeben
- Speichern
- ggf. die letzten Schritte für Hinzufügen weiterer Attribute wiederholen
Anzeigefelder definieren
Für alle Datensatztypen können nun individuelle Anzeigefelder angelegt werden.
- Menüpunkt Konfiguration –> Anzeigefelder
- Button [Neues Anzeigefeld]
Der Name des Anzeigefeldes sollte kurz sein und bestimmt die Benennung in der Frontend-Anzeige der Datensätze. Es kann aus vorhandenen, vorher definierten Einträgen (Anzeigefelder-Namen) ausgewählt oder ein neuer Name vergeben werden. Wird in der Auswahlliste —Neu—
ausgewählt, erscheint eine neues Feld in dem der neu zu vergebende Name eingegeben wird. Dieser erscheint dann auch unter Anzeigefelder-Namen.
Auswählbar sind immer nur die Namen in der Sprache, die aktuell unter dem Menüpunkt Sprache ausgewählt ist, d.h. wenn Deutsch ausgewählt ist, stehen nur die Anzeigefeld-Namen zur Auswahl, denen das Attribut name_de
zugeordnet ist. Neu angelegte Namen werden dementsprechend automatisch ebenfalls mit dem der aktuellen Sprache zugeordneten Attribut versehen.
Die Beschreibung ist prinzipiell frei verwendbar und wird ausschließlich im Backend für bessere Unterscheidbarkeit und genauerer Beschreibung verwendet. Sie sollte idealerweise den Namen des Datensatztyp, Namen des Gliederungspunktes und den Namen des Anzeigefeldes enthalten: z.B: Artdatensatz → Fundortdaten → Naturraum
Wird bei der Definition des Anzeigefeldes auch die Feldzuordnung angelegt (siehe unten), wird das Feld automatisch nach dem Schema Name des Gliederungspunktes → Name des Anzeigefeldes
ausgefüllt, d.h. der Datensatztyp muss wenn gewünscht noch manuell hinzugefügt werden.
Zwingend ist die Auswahl des Datentyps. Dieser legt fest, welchen Inhalt das Anzeigefeld enthalten und darstellen kann. Dies bestimmt ganz wesentlich die Struktur der zu verwaltenden Datensätze.
Achten Sie auf die Auswahl des richten Datentyps.
Es empfiehlt sich, während des Anlegens eines Anzeigefeldes auch die Feldzuordnung anzulegen. Dazu wird der Haken der Checkbox Eine neue Zuordnung für dieses Anzeigefeld anlegen gesetzt. Daraufhin wird das Eingabeformular um mehrere Felder erweitert:
- Über die ersten beiden Felder wird ausgewählt welchem der vorher angelegten Gliederungspunkte und Datensatztypen das jeweilige Anzeigefeld zugeordnet werden soll.
- Zudem kann definiert werden ob das Anzeigefeld nur bei bestimmten Taxa verwendet werden soll (setzt voraus, dass bereits eine Taxliste vorhanden ist, aus der der einzutragende Wert ausgewählt werden kann.
- Unter öffentliche Sichtbarkeit ist wählbar, ob das Anzeigefeld im Frontend erschienen soll.
- Die beiden letzten Felder erstmal nicht ausfüllen.
Für andere Wege zur Definition der Feldzuordnung siehe folgenden Abschnitt.
Feldzuordnung definieren
Um Anzeigefelder überhaupt nutzen zu können, bedarf es sogenannter Feldzuordnungen. Diese bestimmen die Sortierung und Gruppierung der Anzeigefelder innerhalb eines Datensatztyps und legen fest, für welche Datentypen und Taxa die Anzeigefelder verwendet werden sollen.
Prinzipiell können Feldzuordnung auf drei Wegen erzeugt werden:
- Direkt während des Anlegen eines Anzeigefeldes (siehe oben unter Anzeigefelder definieren
- Per Stapelverarbeitung (sinnvoll bei großer Menge von Anzeigefeldern)
- Einzeln, manuell
Den letzten beiden Punkten ist gemein, dass die zuzuordnenden Anzeigefelder bereits existieren müssen!
Bei der einzelnen, manuellen Definition der Feldzuordnungen können weitere Einstellungen vorgenommen werden bzw. können dort auch weitere Feldzuordnungen für Anzeigefelder vorgenommen werden (ein Anzeigefeld kann mehrere verschiedenen Feldzuordnungen haben). Auch die Sortierung der Anzeigefelder kann hier geändert werden.
- Menüpunkt Konfiguration –> Feld-Zuordnungen
- Button [Sortieren]
- per Drag&Drop können jetzt die Anzeigefelder für jeden Datensatz in die gewünschte Reihenfolge gebracht werden (:!:Die Zahl, die in den tabellarischen Ansichten vor jedem Anzeigefeld steht, ist die vom System vergebene ID und hat nichts mit der Sortierreihenfolge zu tun)
Datentyp-spezifische Konfiguration einzelner Anzeigefelder
Die Software bietet vielfältige Konfigurations-Möglichkeit für die einzelnen Anzeigefelder. Art und Umfang dieser Optionen ist vom jeweiligen Datentyp (Bilddatei, Karte, Taxon, Ziechenkette, Fließkommawert etc. ) abhängig.
- Menüpunkt Konfiguration –> Feld-Zuordnungen
- Button [Bearbeiten] in Zeile des jeweiligen Anzeigefeldes (Stift-Symbol)
- es öffnet sich eine Ansicht mit den aktuellen Feldzuordnungen und Einstellungen (hier nicht bearbeitbare Konfigurationen sind ausgegraut)
- im unteren Bereich werden die Datentyp-spezifische Konfigurationsoptionen angezeigt
Module konfigurieren
Abhängig von den angelegten Anzeigefeldern und ihren Zuordnungen kann es erforderlich sein, bestimmte Module grundlegend zu konfigurieren. Die Anwendung wird ggf. darauf aufmerksam machen.
Daten importieren
An diesem Punkt ist die Struktur der Datensätze grundlegend definiert. Somit können nun Datensätze einzeln angelegt, bearbeitet und angezeigt werden oder in großer Menge aus einer CSV-Datei importiert werden.