Zielgruppe Site AdminVersion: GSB10.1Datentabellen

Die Auswahl einer Datentabelle erfolgt über den Einstiegsdialog und kann jederzeit über eine Drop-Down-Liste im oberen rechten Bereich des Portlets geändert werden (vgl. Abbildung 1). 

Der Einstieg in das Portlet erfolgt durch eine Übersicht über verfügbaren Datentabellen. Aus dieser Ansicht heraus wird eine Datentabelle ausgewählt, auf die die Administrationsfunktionen angewendet werden. Die Administrationsfunktionen werden in den folgenden Sichten eingebettet: 

• Datentabelle: Einstiegspunkt ins Portlet, mit der Übersicht über alle Datentabellen
• Datensätze: Übersicht über alle Datensätze mit direktem Zugriff zum Bearbeiten, Löschen oder Freigeben eines Datensatzes.
• Statistik: Einsicht in die Statistik zu einer Datentabelle
• Ereignisprotokoll: Einsicht in die Ereignisprotokollierung zu einer Datentabelle

In der Ansicht „Alle Datentabellen“ werden die verfügbaren Datentabellen in einer tabellarischen Form dargestellt, wobei von jeder Datentabelle der zugehörige sprechende Name ausgegeben wird, der im Content-Repository vergeben wurde. Rechts neben dem Namen befindet sich die Schaltfläche zum Bearbeiten des Schemas der Datentabelle. Eine Datentabelle, für die noch kein Schema definiert wurde, wird durch das Namenspräfix „(neu)“ gekennzeichnet. 

Im rechten Teil der Tabelle werden für jede Datentabelle die 

• Gesamtzahl der Datensätze
• und die Anzahl der freizugebenden Datensätze 

angegeben. Außerdem werden durch Schaltflächen am rechten Rand der Tabelle Aktionen zum Wechsel in folgende Sichten bereitgestellt 

• Datensätze suchen
• Statistik der Datentabelle
• Ereignisprotokoll der Datentabelle. 

Bei der Auswahl einer dieser Aktionen erfolgt unmittelbar ein Wechsel in die entsprechende Sicht, wobei die zugehörige Datentabelle als „ausgewählte Datentabelle“ selektiert wird (die Sichten werden weiter unten beschrieben). Die Ansichten und Aktionen in allen anderen Registerkarten beziehen sich jeweils immer auf die aktuell ausgewählte Datentabelle, die in der Drop-Down-Box im oberen rechten Bereich des Portlets angezeigt wird.

Abbildung 1: Einstieg in die Verwaltung von Datentabellen

In der Explorer-Ansicht wird der Verzeichnisbaum des Content-Repositories angezeigt, durch den sich der Benutzer navigieren kann, um die Datentabelle in einem bestimmten Verzeichnis zu identifizieren. Die Handhabung dieser Ansicht erfolgt analog zur Explorer-Ansicht im Portlet zur Verwaltung von Kommentaren und Bewertungen wird daher nicht gesondert beschrieben.

Erstellen einer Datentabelle

Eine neue Datentabelle muss zuerst über den GSB Editor im Content angelegt werden - wird also nicht im Adminportal erstellt!

Dazu wird ein Dokument vom Typ Datentabelle an der vorgesehenen Stelle im Content-Baum angelegt. Der Name des Dokuments ist dabei gleichzeitig auch der Name der Datentabelle im Adminportal.

Nach dem Anlegen einer Datentabelle wird zusätzlich automatisch ein Ordner auf gleicher Ebene angelegt, der dem Namensschema <Datentabelle-Name>_Forms entspricht. In diesem Ordner werden die generierten Formularelemente abgelegt, die zur Erfassung von Einträgen auf der Site benötigt werden. Das Erstellen der Formularelemente erfolgt im Adminportal dynamisch in Abhängigkeit des Schemas einer Datentabelle über den Button "Preview-Dokumente erstellen" in der Übersichtsseite der Funktion.

Entfernen einer Datentabelle

Um eine Datentabelle zu entfernen, muss das Datentabellen-Dokument über den GSB Editor im Content gelöscht werden.

Beim Entfernen einer Datentabelle verbleiben die erstellen Formularelemente im Content, da nicht ausgeschlossen werden kann, dass die Formularelemente zur Zeit der Löschung verschoben / umbenannt / ausgeliehen sind.

Bearbeiten eines Datentabellenschemas

Die Bearbeitung des Schemas einer existierenden Datentabelle erfolgt analog zu der initialen Definition, mit der Ausnahme, dass bestimmte Operationen aufgrund der Implementierung im Liferay zu inkonsistenten Datensätze bzw. zum Datenverlust führen können.

Zu diesen Operationen zählen:

• Löschen eines Datenfeldes -> führt zu Datenverlust, da die zum Datenfeld gehörenden Werte aus den Datensätzen entfernt werden
• Ändern der ID eines bestehenden Datenfeldes -> führt zu Datenverlust, da dies gleichbedeutend mit dem Löschen und erneutem Anlegen eines Datenfeldes ist
• Entfernen oder Umbenennen des Schlüssels einer Option -> führt zu inkonsistenten Datensätzen, da innerhalb der Datensätze auf ein Schlüssel verwiesen wird, der nicht mehr existiert.
• Hinzufügen eines Datenfeldes, dass als Pflichtfeld deklariert wird -> führt zu inkonsistente Datensätze, da für bereits existierende Datensätze der Wert des Feldes unbesetzt bleibt

Die Benutzeroberfläche weist bei der Bearbeitung eines Schemas mit einer Warnmeldung auf die beschriebenen Gefahren hin. Alle weiteren Operationen, wie beispielsweise das Hinzufügen von neuen Datenfelder (nicht Pflichtfeld) oder das Umbenennen von Labels können ohne Konsequenzen durchgeführt werden.

Als weitere Konfigurationsoption kann für eine Datentabelle ausgewählt werden, ob diese moderiert ist oder nicht. Bei einer moderierten Datentabelle werden neue Datensätze zunächst im Status „in Prüfung“ angelegt und müssen von einem Administrator explizit freigegeben werden. Bei einer nicht-moderierten Datentabelle werden neue Datensätze automatisch freigegeben. Wenn der Moderations-Modus einer Datentabelle von „moderiert“ auf „unmoderiert“ geändert wird, werden automatisch alle Datensätze freigegeben, die bis dahin nicht freigegeben wurden.

Die Bearbeitung des Schemas eine Datentabelle wird über die Schaltfläche mit dem Stift-Symbol aufgerufen woraufhin sich unmittelbar der in Abbildung 3 gezeigte Dialog öffnet. Die Auswahl einer möglichen Vorlage (Abbildung 2) entfällt bei der Bearbeitung eines existierenden Schemas.

Die Schemadefinition der Datentabelle entspricht der Standardschnittstelle zur Kommunikation zwischen dem Liferay und anderen GSB-Komponenten. GSB-seitig wird für den Dokumenttyp Datentabelle ein Standardtemplate  für die GSB SL umgesetzt, das auf der Basis der Schemadefinition einer Datentabelle ein einfaches HTML-Formular generiert. Innerhalb des Formulars werden die definierten Datenfelder untereinander in der Reihenfolge angeordnet, in der diese in der Schemadefinition aufgeführt sind. Das Standardtemplate interpretiert die in der Tabelle angegebenen Parameter der Datentypen in der beschriebenen Weise. Auf der Basis des Standardtemplates können mandantenspezifische Anpassungen des Templates erfolgen, um individuelle Anforderungen umzusetzen.

Zusätzlich zum GSB SL Standardtemplate wird für Datentabellen ein Transfer-Mechanismus geschaffen, der die zur Darstellung einer Eingabemaske erforderlichen GSB-Elemente im GSB-Content anlegt. Die Eingabemaske ermöglicht die Eingabe von Datensätze für die Datentabelle.

Zu den angelegten Elementen gehören unter anderem Labels, HTMLInput-Elemete, FormIntegrator. Der Transfer-Mechanismus wird durch die Schaltfläche „Generiere GSB-Formular“ (Upload-Symbol) angestoßen, die neben dem Namen der Datentabelle angeordnet ist. Die Elemente im Content werden relativ zu dem zu der Datentabelle zugehörigen Dokument in einem weiteren Unterordner (bzw. Unterordnerstruktur) im Content angelegt. Im Content können die angelegten Elemente weiter konfiguriert werden, bspw. indem diesen GSB-Validatoren hinzugefügt werden. Sollte sich im Zielordner bereits ein gleichnamiger Ordner vorhanden sein, wird ein neuer Ordner mit Timestamp-Postfix angelegt.

Suchen nach Datensätzen

In der Übersicht „Datensätze suchen“ werden die Datensätze der aktuell ausgewählten Datentabelle angezeigt.

Die aktuell ausgewählte Datentabelle wird in der Dropdown-Box im oberen rechten Bereich des Portlets angezeigt und kann dort geändert werden.

Abbildung 4: Übersicht über die Datensätze einer Datentabelle

In der tabellarischen Darstellung werden zunächst die ID des Datensatzes und dessen Freigabestatus angezeigt. Die dann folgenden Spalten sind von der Definition der Datentabelle abhängig. Das Beispiel in Abbildung 4 zeigt die Felder einer Datentabelle. Um die Darstellung nicht zu überfrachten, werden in der initialen Ansicht zunächst nur zwei Felder der ausgewählten Datentabelle angezeigt, auch wenn die Datentabelle mehrere Felder umfasst. Die Anzeige von weiteren bzw. alternativen Feldern kann über die Schaltfläche „Feldauswahl“ konfiguriert werden.

Die ausgewählten Felder werden zusätzlich in der Suchleiste angezeigt und können dort mit bestimmten, vom Datentyp des Feldes abhängigen Suchkriterien versehen werden. Für Text- und numerische Attribute kann ein Suchtext eingegeben werden. Für Auswahlwerte steht eine Filterung nach einem bestimmten Auswahlwert zur Verfügung. Für Datumswerte kann ein von-bis-Bereich selektiert werden.

Neben den vom Datensatz abhängigen Suchkriterien werden standardmäßig die folgenden Suchkriterien angeboten: 

• Nur Live-Datensätze anzeigen (Standardmäßig aktiviert; bei der Auswahl „ja“ werden nur Live-Datensätze angezeigt, bei der Auswahl „nein“ werden Live und Preview-Datensätze angezeigt)
• Datensatz-ID (Textfilter auf die ID eines Datensatzes)
• Status („freigegeben“: es werden nur freigegebene Datensätze angezeigt; „in Prüfung“: es werden nur Datensätze angezeigt, die sich zur Zeit in Prüfung befinden, „alle“: es werden sowohl freigegeben als auch in Prüfung befindliche Datensätze angezeigt) 

Nach einem Klick auf die Schaltfläche „Suche starten“ wird die Suche durchgeführt. Als Ergebnis der Suche werden die Datensätze zurückgeliefert, die allen angegebenen Suchkriterien entsprechen (es erfolgt also eine Verknüpfung der angegebenen Suchkriterien). Mit der Schaltfläche „Eingabe löschen“ wird die Suche zurückgesetzt.

Wenn ein Feld über die aktuelle Feldauswahl abgewählt wird, wird dieses auch aus der Menge der angezeigten Suchkriterien entfernt. Falls für ein solches abgewähltes Feld ein Suchkriterium definiert war, wird dieses Suchkriterium zurückgesetzt.

Bearbeiten von Datensätzen

Am rechten Rand der Tabelle in Abbildung 4 befinden sich Schaltflächen zum

• löschen
• bearbeiten
• freigeben

eines Datensatzes, wobei die Freigeben-Schaltfläche nur dann angezeigt wird, falls der betreffende Datensatz noch nicht freigegeben wurde. Die Schaltflächen sind mit Tool-Tipps ausgestattet, die bei einem Mouse-Over einen kurzen Hinweis auf die Funktion der Schaltfläche bieten. Bei der Ausführung von Aktionen bleibt die Tabellenansicht nach Möglichkeit auf der ausgewählten Seite stehen. Eine Ausnahme hiervon besteht bspw. dann, wenn der letzte Datensatz auf einer Tabellenseite gelöscht wird.

Wie im unteren Bereich der zu erkennen ist, stehen drei weitere Schaltflächen zur Verfügung. Mittels der Schaltfläche „Alle Datensätze löschen“ werden sämtliche Datensätze aus der betreffenden Datentabelle entfernt, wobei die Datentabelle selbst aber erhalten bleibt. Die Schaltfläche „Daten exportieren“ ermöglicht einen Export der Datensätze, die gemäß der eingestellten Suchkriterien aktuell in der Tabelle angezeigt werden. Über die Schaltfläche „Datensatz hinzufügen“ kann letztlich ein Datensatz zu der Datentabelle hinzugefügt werden. Der Dialog zum Hinzufügen eines Datensatzes entspricht im Wesentlichen dem Dialog zum Bearbeiten eines Datensatzes, mit der Ausnahme, dass keine ID angezeigt wird.

Die Abbildung 5 zeigt den Dialog zum Bearbeiten eines Datensatzes. Im oberen Bereich des Dialogs werden zunächst die Datensatz-ID, die zugehörige Datentabelle und der Freigabestatus angezeigt. Die unterhalb der Überschrift „Daten“ angezeigten Datenfelder sind wiederum von der Definition der Datentabelle abhängig. Durch einen Klick auf die Schaltfläche „Übernehmen“ werden die ggf. vorgenommenen Änderungen am Datensatz gespeichert und der Dialog geschlossen. Durch die Betätigung der Schaltfläche „Abbrechen“ wird der Dialog geschlossen, ohne dass die Änderungen gespeichert werden. Durch betätigen der Schaltfläche „Datensatz löschen“ wird der aktuell zum Bearbeiten geöffnete Datensatz unmittelbar in der Datenbank gelöscht (nach vorheriger Sicherheitsabfrage, ob der Datensatz tatsächlich gelöscht werden soll).

Abbildung 5: Bearbeitung eines Datensatzes

Freigeben von Datensätzen

Unterhalb der Registerkarte „Datensätze freigeben“ werden in einer tabellarischen Form (siehe Abbildung 6) alle bislang noch nicht freigegebenen Einträge angezeigt.

Die Ansicht der Datensätze entspricht der tabellarischen Ansicht unterhalb von „Datensätze suchen“, mit der Ausnahme, dass der Freigabestatus eines Datensatzes nicht angezeigt wird, da in dieser Ansicht ausschließlich noch nicht freigegebene Datensätze angezeigt werden.  Ferner entfällt in dieser Ansicht die Suchfunktionalität mit der dazugehörigen Suchleiste.

Abbildung 6: Freigabe von Datensätzen

Importieren von Datensätzen

Datensätze aus einer CSV-Datei können in eine ausgewählte Datentabelle importiert werden.

Unterhalb der Registerkarte „Datensätze importieren“ können Datensätze aus einer CSV-Datei in die ausgewählte Datentabelle importiert werden. Wichtig hierbei ist, dass das Format der Import-Datei mit dem Schema der Datentabelle übereinstimmen muss. D.h. die Bezeichnungen der Tabellenköpfe müssen mit den Bezeichnungen der Datenfelder in der Datentabelle übereinstimmen und die zugehörigen Werte in den einzelnen Zeilen müssen den korrekten Typ aufweisen.

In der Import-Ansicht, die in Abbildung 7 dargestellt ist, kann eine einzelne Datei per Dialog oder per Drag & Drop hochgeladen werden. Nachdem die Datei erfolgreich hochgeladen wurde, wird zunächst überprüft, ob das Format der Eingabe-Datei korrekt ist und auf das Schema der ausgewählten Datentabelle angewendet werden kann. Letzteres liegt vor, falls die folgenden Kriterien erfüllt sind: 

• Zu jedem als Pflichtfeld definierten Datenfeld existiert eine korrespondierende Spalte in der CSV-Datei
• Die Werte in einer Spalte in der CSV, die zu einem Datenfeld X korrespondiert, müssen in den Typ von X konvertiert werden können 

Die Reihenfolge der Spalten in der eingegebenen CSV-Datei ist nicht von Bedeutung, da die Zuordnung zu den Datenfelder der Datensätze über die Namen der Tabellenköpfe hergestellt wird. Außerdem kann die CSV-Datei Spalten umfassen, die nicht zu einem Datenfeld zugeordnet werden können. Diese Spalten werden beim Import ignoriert. Die IDs der importierten Datensätze werden vom Import-Mechanismus erzeugt und können nicht aus dem CSV-Export übernommen werden.

Abbildung 7: Importieren von Datensätzen

Die CSV-Datei ist ferner korrekt, wenn die Datei im UTF-8-Format hochgeladen wird, die Spalten mit dem vordefinierten Trennzeichen voneinander getrennt sind, das Trennzeichen selber nicht als Bestandteil des Wertes innerhalb einer Spalte auftritt und jede Zeile die vollständige Anzahl von Spalten aufweist. 

Wenn das Eingabeformat der Datei korrekt ist und die Daten auf das Schema der Datentabelle angewendet werden können, werden die Datensätze in der hochgeladenen Datei in der tabellarischen Form (vergleiche Abbildung 7) dargestellt. In dieser Darstellung werden erneut zunächst nur die ersten beiden Datenfelder der Tabelle angezeigt, wobei weitere oder alternative Felder über die Schaltfläche „Feld Auswahl“ konfiguriert werden können. Mit Hilfe des Lösch-Icons am rechten Tabellenrand können einzelne Datensätze aus der Menge der zu importierenden Datensätze entfernt werden. 

Durch die Schaltfläche „Datensätze importieren“ werden die Datensätze in die Datentabelle übernommen und zunächst nicht freigegeben. Um die Datensätze nach dem Import automatisch freizugeben, ist die Schaltfläche „Datensätze importieren und freigeben“ zum Auslösen des Imports zu betätigen. In beiden Fälle informiert das Portlet anschließend über den erfolgten Import oder gibt eine Fehlermeldung aus, falls es zu einem unterwarteten Problem während des Imports gekommen ist. 

Sollte das Eingabeformat der Datei nicht korrekt sein oder die Daten der Datei nicht auf das Schema der ausgewählten Datentabelle angewendet werden können, gibt das Portlet nach dem Hochladen der Importdatei eine Fehlermeldung oder eine Warnmeldung aus. Eine Warnmeldung wird ausgegeben, wenn durch den Import Datensätze erzeugt werden, deren Pflichtfelder nicht vollständig besetzt sind, was dazu führt, dass die Datensätze inkonsistent zu der Schema-Definition sind. Für alle weiteren möglichen Fehlerquellen wird eine Fehlermeldung ausgegeben, die möglichst weitgehend die Fehlerursache eingrenzt.

Statistik

Der Menüpunkt „Statistik“ ist die Unterpunkte „Anzahl Datensätze“ und „Auswertung von Auswahl-Datenfeldern“ untergliedert.

Diese Ansichten werden in den folgenden Unterabschnitten beschrieben.

Anzahl Datensätze

In der Sicht „Anzahl Datensätze“ wird die Entwicklung der Gesamtzahl der Datensätze der aktuell ausgewählten Datentabelle grafisch als Liniendiagramm dargestellt (vergleiche Abbildung 8). Es stehen Filter zur Verfügung, um die dargestellten Daten einzuschränken und um die dargestellte Zeiteinheit (Tage, Wochen) auszuwählen. Außerdem können die angezeigten Daten über die Schaltfläche „Daten exportieren“ im CSV-Format exportiert und heruntergeladen werden.

Abbildung 8: Statistik zu einem Gästebuch

Auswertung von Auswahl-Datenfelder

Unterhalb der Registerkarte „Auswertung Auswahl-Datenfelder“ kann die Verteilung der Werte aller Auswahlfelder der aktuell ausgewählten Datentabelle eingesehen werden (vergleiche Abbildung 9). Auf der linken Seite werden zunächst alle Auswahlfelder der Datentabelle und, nach diesen Auswahlfeldern gruppiert, die möglichen Werte der jeweiligen Auswahlfelder dargestellt. Die Verteilung der Werte für ein Auswahlfeld wird rechts neben den Werten als Balkendiagramm (prozentuale Verteilung) und als prozentualer Zahlenwert angegeben. Die Darstellung in Abbildung 9 zeigt eine mögliche Verteilung für das Auswahlfeld (Härtegrad).

Abbildung 9: Auswertung von Auswahlfeldern

Ereignisprotokoll

Zur Dokumentation und Erhöhung der Nachvollziehbarkeit wird die Verwaltung von Datentabellen um ein Ereignisprotokoll erweitert.

Das Ereignisprotokoll erfasst die folgenden Ereignisse: 

• Datensatz erstellt (Benutzer)
• Datensatz bearbeitet (Admin)
• Datensatz freigegeben (Admin/System)
• Datensatz gelöscht (Admin)

Der Zugriff auf das Ereignisprotokoll erfolgt unter der gleichnamigen Registerkarte. Zur Filterung der dargestellten Ereignisse stehen mehrere Suchkriterien (Auslöser, Ereignis, ID des Datensatzes) zur Verfügung. Mittels der Schaltfläche „Daten exportieren“ kann die aktuelle Menge der gefundenen Ereignisse im CSV-Format exportiert und heruntergeladen werden.

Abbildung 10: Ereignisprotokoll