Version: GSB 7Schnittstellen
Zur Beschreibung der Schnittstelle, die zur Erstellung neuer Gästebucheinträge benötigt wird, werden sämtliche Funktionen betrachtet, die der Benutzer von der Website aus ausführen kann. Diese werden in Website aufgeführt.
In Administration werden alle Funktionen präsentiert, die zur Administration des Gästebuches angeboten werden. Hierzu gehören alle Aufgaben, die im Rahmen der Pflege der Gästebucheinträge anfallen.
Abschließend wird in Konfiguration des Gästebuches auf die Konfiguration des Gästebuches eingegangen, die im Regelfall aus dem Intranet der jeweiligen Behörde vorgenommen wird.
Hinweis: Die Administration des Gästebuches ist eine regelmäßige Tätigkeit, welche die Pflege der Einträge innerhalb des Gästebuchs umfasst. Diese Tätigkeit ist von der Konfiguration eines Gästebuches innerhalb eines GSB Mandanten zu unterscheiden: diese Tätigkeit wird einmalig bei der Erstellung eines Mandanten umgesetzt.
Website
Ansicht des Gästebuchs
Auf der Einstiegsseite des Gästebuches werden alle Einträge absteigend nach Freigabe- / Einstellungsdatum sortiert aufgelistet. Wie in Abbildung 1 zu erkennen ist, werden in der Liste der Einträge nahezu alle Informationen angezeigt, die zuvor in Datenstrukturen definiert wurden. Lediglich diejenigen Attribute, die zur internen Verarbeitung benötigt werden, bleiben verborgen (Freigabedatum, Freigabestatus, ID und ID_Gaestebuch). Aufgrund dieser Tatsache gibt es auch keine Detailseite für die aufgelisteten Gästebucheinträge. Weiterhin ist zu erkennen, dass die Benutzer des Gästebuches eine Blättern-Funktion zur Verfügung gestellt bekommen, um die dargestellte Seite auch bei vielen Einträgen übersichtlich zu halten. Die Anzahl der dem Benutzer angezeigten Einträge pro Seite ist konfigurierbar.
Abbildung 1
Eintrag erstellen
Benutzer der Website rufen zur Erstellung eines Beitrags die Gästebuchseite auf. Hier bekommen sie einen Link mit der Beschriftung „Eintrag erstellen“, nach dessen Auswahl ein Eingabeformular für einen neuen Eintrag angezeigt wird. Wie in Abbildung 2 zu erkennen ist, werden die folgenden Felder zur Erstellung eines neuen Eintrages angeboten: Titel, Untertitel, Vorname, Nachname, E-mail, Text und Link. Bei den Feldern Titel und Text handelt es sich um Pflichtfelder, ohne deren Eingabe kein neuer Eintrag erstellt werden kann.
Der in der Abbildung zu erkennende Link mit der Beschriftung „Vorschau“ generiert eine Vorschau des erzeugten Eintrages, die oberhalb des Eingabeformulars angezeigt wird.
Die Dateneingabe kann über den Link „absenden“ abgeschlossen werden. Hierbei werden die Formulardaten auf die zugrunde liegenden Datenstrukturen sowie zulässige Zeichen geprüft. Sollten unzulässige Eingaben gemacht worden sein, wird die Erstellung des Eintrages abgewiesen und der Benutzer durch eine entsprechende Meldung unterhalb des letzten Eingabefeldes darüber informiert.
Abbildung 2
Bei einem nicht-moderierten Gästebuch wird nach dem Absenden der Eintrag in der Listenansicht angezeigt. Im Falle eines moderierten Gästebuchs hingegen, wird der Eintrag dem Moderator vorher zur Freischaltung vorgelegt.
Administration
Über die Administrationsseiten des Gästebuches können Site-Administatoren und / oder Moderatoren die Gästebücher und Einträge verwalten. Der Zugang zur Administrationsseite des GSBAdmin erfolgt standardgemäß über die URL < www.gsbadmin.ivbb.bund.de/ >, kann aber für jeden Server und somit für alle darauf zugreifenden Mandanten angepasst werden. Seit der GSB Version 7 stehen die in diesem Dokument beschriebene Administrationsseiten des Gästebuches auch im Adminportal - Gästebuch zur Verfügung.
Abbildung 3 zeigt die Gästebuch-Administrationsseite im Mandant GSB Admin, die über den Link „Gästebuch Administration“ der Administrationsseite des GSBAdmin aufgerufen werden kann. Hier stehen dem Administrator folgende Funktionalitäten zur Verfügung, die in den folgenden Abschnitten weiter beschrieben werden:
- Gästebuch erstellen
- Gästebuchdaten bearbeiten
- Gästebuch löschen
- Einträge bearbeiten
- Einträge suchen
- Einträge löschen
- Einträge freischalten
Abbildung 3
Gästebücher verwalten
Nach dem Aufruf der Funktion „Gästebücher verwalten“ bekommt der Administrator eine Liste aller Gästebücher des Mandanten angezeigt (siehe Abbildung 3). In dieser Liste sind alle zu der Liste gehörigen Daten (z.B. Name, Typ) dargestellt. Über einen hinter jedem Listeneintrag dargestellten Link „Einträge“ gelangt der Administrator zum Funktionalitätsblock „Einträge verwalten“.
Gästebuch erstellen
Diese Funktionalität befähigt den Administrator zum Anlegen eines neuen Gästebuches. Pro Mandant können mehrere Gästebücher getrennt voneinander angelegt und verwaltet werden. In Abbildung 4 ist das entsprechende Formular zur Erstellung eines neuen Gästebuches zu erkennen. Wie zu erkennen ist, sind hierzu Name und Typ (moderiert oder unmoderiert) des Gästebuches anzugeben.
Abbildung 4
Gästebuch bearbeiten
Abbildung 5 zeigt ein Formular, das dem bereits vorgestellten Formular zu Erfassung von Gästebüchern ähnelt. Hierin werden jedoch die Felder mit den bereits existenten Daten initialisiert, die der Administrator im Anschluss an dieser Stelle aktualisieren kann.
Abbildung 5
Durch den Link „Bearbeiten“ werden die vorgenommenen Änderungen bestätigt und somit ins System übernommen. Über den „Zurücksetzen“-Link werden sämtliche Änderungen verworfen in die Daten in den ursprünglichen Zustand zurückversetzt.
Gästebuch löschen
In der Listenansicht der Gästebücher (vgl. Abbildung 3) wird an jedem Eintrag ein Link mit der Beschriftung „Löschen“ dargestellt. Abbildung 6 zeigt die sich anschließende Bestätigungsaufforderung - nachdem der Link betätigt wurde - deren positiver Abschluss das Löschen des Gästebuches durchführt.
Abbildung 6
Gästebucheinträge verwalten
Auf der Gästebuch-Administrationsseite (siehe Abbildung 3) wird zu jedem Gästebuch ein Link mit der Bezeichnung „Einträge“ angezeigt. So bekommt der Administrator - wie auf der nachfolgenden Abbildung zu sehen - analog zur Website-Ansicht standardgemäß die Liste aller Einträge des Gästebuchs absteigend sortiert nach Freigabe-/ Einstellungsdatum angezeigt.
Da bei einem größeren Gästebuch eine einfache Listendarstellung mit der Zeit zu unübersichtlich würde wird unterhalb der Einträge eine Suchfunktion angeboten. Die Suche kann hierbei nach einem oder mehreren Attributen eines Eintrages eingeschränkt werden.
Abbildung 7
Eintrag suchen
Zur komfortablen Pflege der Gästebucheinträge steht dem Administrator eine Suchfunktion zur Verfügung (siehe Abbildung 7). Dabei werden die Attribute der Gästebucheinträge per Volltextsuche nach den eingegebenen Suchbegriffen durchsucht. Darüber hinaus kann das Suchergebnis über Freigabe-/ und Einstellungsdatum weiter eingeschränkt werden. Im Falle eines moderierten Gästebuches kann der Administrator außerdem die Suche auf nicht-freigegebene Einträge einschränken.
Ein Datum muss in der Form „TT.MM.JJJJ“ eingetragen werden.
Wie in Abbildung 7 zu erkennen ist, werden die Ergebnisse der Suche oberhalb des Suchformulars angezeigt. Standardgemäß werden hierbei 10 Einträge pro Seite angezeigt.
Eintrag bearbeiten
Zusätzlich (zur Website-Ansicht) hat hier (siehe Abbildung 7) jeder Listeneintrag einen Link „bearbeiten“, mit dessen Hilfe das Erfassungsformular eines Eintrags mit den aktuellen Eintragsdaten initialisiert und anschließend angezeigt wird. Dieses Formular ist in Abbildung 8 dargestellt. Administratoren können hier nun Änderungen vornehmen und diese über den Button „absenden“ abschließen oder mit „zurücksetzen“ wieder rückgängig machen.
Abbildung 8
Eintrag löschen
Wie in der Liste der Suchergebnisse in Abbildung 7 zu erkennen ist, können Administratoren über den Link mit der Beschriftung „löschen“ ein konkreten Eintrag aus dem Gästebuch entfernen. Wie in Abbildung 9 zu erkennen ist, wird der Administrator im Anschluss an das Auslösen dieser Funktion nochmals aufgefordert, den Löschvorgang zu bestätigen. Erst durch diese Bestätigung wird ein Gästebucheintrag endgültig aus dem entsprechenden Gästebuch gelöscht.
Abbildung 9
Eintrag freischalten
Wie bereits erwähnt wurde, müssen in einem moderierten Gästebuch alle neuen Einträge durch einen Administrator freigegeben werden. Diese Freigabe kann aus der Listenansicht der vorhandenen Einträge gestartet werden. Der Administrator kann sich hierzu zunächst mit Hilfe der Suchfunktion alle Einträge anzeigen lassen, die noch nicht freigegeben wurden. Die Ergebnisliste enthält dann für jeden Eintrag an der Stelle des Freigabedatums einen Link mit der Beschriftung „freigeben“, über den die Funktion der Freigabe initiiert wird.
In Abbildung 10 ist das Formular zur Freigabe eines Gästebucheintrages zu erkennen. Wie bereits erwähnt wurde, kann der Administrator eines moderierten Gästebuches Einträge überarbeiten, bevor er diese letztendlich freigibt. Aus diesem Grund bietet das dargestellte Formular die Möglichkeit, alle durch den Benutzer getätigten Eingaben zu überarbeiten, bevor über den Link mit der Beschriftung „freigeben“ der Prozess der Freigabe gestartet wird, innerhalb dessen der Status geändert wird. Nach der Betätigung dieses Links erscheint eine erneute Bestätigungsaufforderung, deren positiver Abschluss letztendlich die Freigabe des Eintrags durchführt. Mit dem Link „Zurücksetzen“ können die Eingaben wieder in ihren ursprünglichen Zustand zurückversetzt werden.
Abbildung 10
Konfiguration des Gästebuches
Wie bereits einleitend in diesem Kapitel erwähnt wurde, erfolgt die Konfiguration des Gästebuches aus dem Intranet. Somit wird in diesem Unterkapitel die dritte Schnittstelle des Gästebuches erläutert.
Im Gegensatz zur Administration, innerhalb derer in erster Linie die Freigabe und Pflege von Gästebucheinträgen durchgeführt wird, werden im Rahmen der Konfiguration grundlegende Einstellungen am Gästebuch vorgenommen.
Das Gästebuch bietet zur Konfiguration im Editor unter „/Sites/standardlsg/DE/Service/Gaestebuch/Gaestebuch“ (Originalbezeichnung: FEGuestbook) folgende Eintragsmöglichkeiten, die im Folgendem weiter erklärt werden:
- Datenbank ID (Originalbezeichnung: guestbookID)
- Einträge pro Seite (Originalbezeichnung: resultsPerPage)
- Sortierkriterium (Originalbezeichnung: sortProperty)
Datenbank ID
Die „Datenbank ID“ ist eine eindeutige Identifikationsnummer des Gästebuchs, damit dieses in einer Datenbank gespeichert und auch wieder geladen werden kann.
Ein Eintrag in diesem Feld ist zwingend erforderlich.
Einträge pro Seite
„Einträge pro Seite“ bestimmt, wie viele Einträge der Endnutzer auf einer Seite sehen kann, d.h. ab wie vielen Einträgen eine neue Seite angelegt wird, zu der dann geblättert werden kann. (siehe Website)
Sollte hier nichts eingetragen werden, so wird als Standard der Wert 10 gesetzt.
Sortierkriterium
Das „Sortierkriterium“ legt fest, in welcher Reihenfolge die einzelnen Einträge geordnet werden.
Eingetragen werden sollte es nach dem Muster „+ / - “, für auf- oder absteigend, gefolgt vom jeweiligen Attributnamen. Sollten mehrere Sortierkriterien gewünscht sein, so sollten diese nach Ihrer Priorität geordnet und durch Kommata getrennt werden.
Zulässige Attributnamen sind: (vergleiche: Datenstrukturen)
- firstName (Vorname des Benutzers, der den Eintrag geschrieben hat)
- lastName (Nachname des Benutzers)
- email (E-Mail Adresse des Benutzers)
- title (Titel des Gästebucheintrages)
- subtitle (Untertitel des Gästebucheintrages)
- text (eingetragener Text)
- link (eingetragener Link)
- entryDate (Einstellungsdatum)
- releaseDate (Freigabedatum)
Als Standard, der greift, wenn sonst keine Einträge gemacht wurden, wird hier „-entryDate“ gesetzt. D.h. die Einträge werden nach dem Datum Ihres Erstellens angeordnet, wobei – bedingt durch das Minus – der aktuellste Eintrag an erster Stelle steht.