SmartSearch

Die Datenschutzgrundverordnung (DSGVO) ist eine EU-Verordnung, die das Grundrecht europäischer Bürger auf Privatsphäre schützt und den Umgang mit personenbezogenen Daten regelt. Vereinfacht gesagt, haben alle Personen, von denen Daten erhoben werden, über die DSGVO unter anderem die folgenden Möglichkeiten:

Ausführliche Informationen zur DSGVO finden sich im Blogpost DSGVO - Alles Wichtige auf einen Blick.

Personenbezogene Daten sind alle Informationen, durch die eine natürliche Person direkt oder indirekt identifizierbar ist. Dies schließt jegliche potenziellen Identifizierungsmerkmale ein:

Die Such-Engine SmartSearch speichert Daten als Dokumente, die auf verschiedenen Plattformen zur Verfügung gestellt werden können. Art und Umfang der Daten, im Folgenden "erfasste Daten" genannt, sind abhängig vom Einsatzzweck des Produkts.

Neben den redaktionellen Daten speichert die SmartSearch personenbezogene Daten (grundsätzlich die E-Mail, bei Verwendung von LDAP den Username des Benutzers) die zur Anmeldung an dem System und beim Auditieren von Konfigurationen verwendet werden, um gegebenenfalls Kontakt mit einem Bearbeiter eines Elements aufnehmen zu können. Teile dieser Daten werden in Logdateien vorgehalten. Diese Daten werden im Folgenden „Personenbezogene Systemdaten“ genannt (siehe unten).

Warum werden die Daten benötigt?

Die SmartSearch arbeitet mit einem durchgängigen Benutzer- und Rechtesystem. Neue Benutzer werden über das Benutzermanagement angelegt und verwaltet. Nach der Erstellung ist der Benutzer auf dem Server bekannt und kann sich (mit einen gültigen Login) über das SmartSearch-Cockpit anmelden. Der Zugriff auf die Konfigurationselemente wird über Gruppenrechte/Rollen erteilt.

Damit ist sichergestellt, dass nur authentifizierte Nutzer Zugriff auf die SmartSearch erhalten und diese Nutzer Elemente nur gemäß der ihnen erteilten Rechte bearbeiten dürfen.

Wo werden die Daten verwendet beziehungsweise angezeigt?

Informationen zum Benutzer werden an diversen Stellen angezeigt, zum Beispiel:

Wo werden die Daten gespeichert?

Die Anmeldeinformationen der einzelnen Benutzer werden grundsätzlich in der Konfigurationskomponente gespeichert. Im Falle von LDAP werden die personenbezogenen Systemdaten nur lesend aus dem LDAP des Kunden geladen.

Wie lange werden die Daten gespeichert?

Bei der Entfernung eines Benutzers über das Benutzermanagement werden die Anmeldeinformationen des Benutzers sofort aus der Konfigurationskomponente entfernt.

Warum werden die Daten benötigt?

Die SmartSearch verwendet Logfiles, um Aktionen und Ereignisse auf dem SmartSearch-Server zu protokollieren. Logfiles werden zur Aufrechterhaltung des sicheren Betriebs erhoben. Sie können verwendet werden, um Fehlerzustände zu analysieren und zu beheben. Einige der von der SmartSearch verwendeten Logfiles enthalten unter anderem IP-Adresse, Login-Namen, Datum, Uhrzeit, Request usw. und damit personenbezogene Daten.

Wo werden die Daten gespeichert?

Grundsätzlich werden Logfiles in das Unterverzeichnis logs des SmartSearch-Servers geschrieben.

Wie lange werden die Daten gespeichert?

Standardverhalten: Wird eine fest eingestellte Dateigröße von 100 MB erreicht, wird die aktuelle Logdatei archiviert. Es werden bis zu neun archivierte Dateien behalten. Wenn dann eine neue Datei archiviert wird, wird die älteste gelöscht. Dieses Verhalten kann über die Konfigurationsdatei logback-spring.xml angepasst werden.

Warum werden die Daten benötigt?

Eine Zielsetzung der Datenspeicherung in der SmartSearch ist die Nachvollziehbarkeit der letzten Änderungen, aber auch Informationen über die Erstellung von Konfigurationselementen. Dazu speichert die SmartSearch Auditierungsdaten.

Bei jeder Änderung, die ein Redakteur an Konfigurationselementen (zum Beispiel einer Prepared Search) vornimmt, wird daran vermerkt, wer die letzte Änderung vorgenommen hat und wann. Damit wird eine eventuell bestehende letzte Änderung überschrieben.

Wird ein Konfigurationselement neu angelegt, wird daran vermerkt, wer das Element angelegt hat und wann.

Wo werden die Daten verwendet beziehungsweise angezeigt?

Die Auditierungsdaten (Welcher Benutzer hat wann eine Änderung durchgeführt?) werden in Listenansichten für die Konfigurationselemente angezeigt.

Wo werden die Daten gespeichert?

Die Daten werden an den Konfigurationselementen in der Konfigurationkomponente gespeichert.

Wie lange werden die Daten gespeichert?

Standardverhalten: Bei der Löschung eines Benutzers werden die Referenzen auf diesen anonymisiert. Es ist zudem möglich, nachträglich Referenzen von bereits gelöschten Benutzern zu anonymisieren, für den Fall, dass bei der Löschung nicht das Standardverhalten angewandt wurde. Nach der Anonymisierung wird ein Bericht angezeigt, in welchen Elementen der User anonymisiert wurde. Es werden dazu keine Informationen geloggt. Der Bericht ist die einzige Möglichkeit, Informationen über die Anonymisierung zu bekommen.

Warum werden die Daten benötigt?

Die SmartSearch verwendet im Cockpit Cookies, um die Session des Users zu speichern und zum Schutz vor XSRF-Attacken.

Wo werden die Daten verwendet bzw. angezeigt?

Die Cookies werden im Browser gespeichert und ab dem Einloggen mit jeder Interaktion mit dem Cockpit mitgeschickt.

Wie lange werden die Daten gespeichert?

Die Lebenszeit der Cookies wird auf session gesetzt.

Die kundenseitige Erfassung der benötigten Daten erfolgt über die sogenannten Datengeneratoren, die ein Bestandteil des Bereichs Daten sind. Für ihre Verwaltung stellt die SmartSearch die Prepared Searches zur Verfügung. Diese ermöglichen die Optimierung der Suchergebnisse durch die Priorisierung einzelner Daten.

Die Erstellung und Verwaltung der Prepared Searches erfolgt in der gleichnamige Oberfläche, die über den Menübereich Konfiguration → Prepared Search aufrufbar ist.

Der Bereich zeigt eine Liste aller bereits existierenden Prepared Searches und ist initial leer.

Abbildung 7. Prepared Searches

Neue Prepared Search

Für die Erstellung einer neuen Prepared Search existiert eine eigene Ansicht, die per Klick auf den Button Neue Prepared Search aufrufbar ist und sich in die zwei Tabs Allgemein und Facetten gliedert.

Abbildung 8. Prepared Search anlegen

Liste bestehender Prepared Searches

Nach der Speicherung und erfolgreichen Erzeugung der Prepared Search wird sie der Liste bestehender Prepared Searches im gleichnamigen Bereich hinzugefügt. Die Liste gliedert sich in zwei Spalten mit den folgenden Informationen:

Prepared Search bearbeiten

Der Button mit dem Symbol eines Stifts ermöglicht die Bearbeitung einer Prepared Search. Ein Klick auf ihn öffnet die Detailansicht mit den vorgenommenen Eingaben. Diese lassen sich entsprechend der zuvor beschriebenen Möglichkeiten verändern.

Prepared Search löschen

Der Button mit dem Symbol eines Mülleimers ermöglicht die Löschung einer Prepared Search. Ein Klick auf diesen Button öffnet einen Dialog mit einer Sicherheitsabfrage, mit der die Löschung zu bestätigen ist.

Alternativ besteht über Checkboxen, die in der Übersichtsliste vor jeder Prepared Search sichtbar sind, die Möglichkeit, mehrere Prepared Searches für die Löschung auszuwählen. Der Button Ausgewählte löschen entfernt diese markierten Prepared Searches, nachdem zuvor ebenfalls eine Sicherheitsabfrage bestätigt wurde.

Jeder geschriebene Text enthält Artikel, Füllwörter und weitere Begriffe, die für eine Suchabfrage irrelevant und daher zu ignorieren sind. Aus diesem Grund besitzt die SmartSearch für jede der 26 unterstützten Sprachen eine Liste sogenannter Stoppwörter, die sie im Menübereich Konfiguration → Stoppwörter in Form eines Drop-Down-Menüs bereitstellt. Die in diesen Listen enthaltenen Begriffe werden bei der Erfassung der Daten durch die Datengeneratoren ignoriert und nicht in den Suchindex aufgenommen.

Für die Bearbeitung einer Stoppwörter-Liste ist sie zunächst in dem Drop-Down-Menü zu selektieren. Die Oberfläche zeigt daraufhin alle in ihr enthaltenen Stoppwörter an.

Abbildung 10. Stoppwörter

Das Feld Neue Stoppwörter hinzufügen ermöglicht die kommaseparierte Eingabe weiterer Stoppwörter, die per Klick auf den Button mit dem Plus-Symbol in die Liste übernommen werden. Die Buttons mit dem Symbol eines Stifts bzw. eines Mülleimers, die pro Stoppwort sichtbar sind, erlauben die Bearbeitung bzw. Löschung eines einzelnen Eintrags der Liste.

Jede Änderung an der selektierten Liste erfordert abschließend eine Speicherung über den Button mit dem Symbol eines Hakens, der neben dem Drop-Down-Menü dargestellt ist. Erst mit diesem Klick erfolgt eine Übernahme der Anpassungen, auch wenn sie zuvor bereits in der Liste sichtbar sind.

Äquivalent zu den Stoppwörtern, mit denen sich irrelevante Begriffe aus dem erfassten Datenbestand herausfiltern lassen, ermöglichen die Synonyme die Ergänzung spezifischer Bezeichnungen. Im Menübereich Konfiguration → Synonyme stellt die SmartSearch für jede der 26 unterstützten Sprachen eine Liste sogenannter Synonyme zur Verfügung. Die Listen sind initial leer und werden in Form eines Drop-Down-Menüs bereitgestellt.

Für die Ergänzung von Begriffen zu einer dieser Listen ist sie zunächst in dem Drop-Down-Menü zu selektieren. Enthält sie bereits Synonyme, werden diese daraufhin angezeigt.

Abbildung 11. Synonyme

Das Feld Neue Synonyme hinzufügen ermöglicht die kommaseparierte Eingabe weiterer Synonyme, deren Übernahme in die Liste per Klick auf den Button mit dem Plus-Symbol erfolgt. Über das Feld Add a tag lassen sich ihnen jeweils die entsprechenden Ersetzungen zuordnen.

Des Weiteren erlauben die Buttons mit dem Symbol eines Stifts bzw. eines Mülleimers, die pro Suchwort sichtbar sind, die Bearbeitung bzw. Löschung eines einzelnen Eintrags in der Liste.

Jede Änderung an der selektierten Liste erfordert abschließend eine Speicherung über den Button mit dem Symbol eines Hakens, der neben dem Drop-Down-Menü dargestellt ist. Erst mit diesem Klick erfolgt eine Übernahme der Anpassungen, auch wenn sie zuvor bereits in der Liste sichtbar sind.

Der Bereich Statistiken ermöglicht die Analyse der Suchanfragen einer spezifischen Prepared Search. Das gleichnamige Feld listet dafür alle bestehenden Prepared Searches auf, aus der die zu analysierende Prepared Search per Checkbox auszuwählen ist.

Die nachfolgenden Felder dienen der Spezifizierung der zu analysierenden Daten:

Der Button Übernehmen führt die Ermittlung der häufigsten Suchwörter aus, die sich anhand der vorgenommenen Konfiguration für die ausgewählte Prepared Search ergeben. Sie werden anschließend als Liste in der Oberfläche angezeigt.

Abbildung 12. Statistiken

Der Button CSV herunterladen stellt sowohl die definierten Konfigurationsdaten als auch die auf ihrer Basis ermittelten Suchwörter in Form einer CSV-Datei bereit. Sie enthält zusätzlich zu diesen Informationen einen Deeplink und die absolute Summe aller Suchanfragen - mit und ohne Filterung. Der Deeplink ermöglicht den erneuten Download der Datei.

Den in der CSV enthaltenen Deeplink stellt auch der Button Copy to clipboard > Deep Link CSV bereit. Der Button Copy to clipboard > Deep Link Cockpit stellt einen Link bereit, mit dem sich der Bereich Statistiken inklusive der vorgenommenen Konfiguration erneut aufrufen lässt. Auf diesem Weg können sowohl die Einstellungen als auch das auf ihnen basierende Ergebnis Dritten zur Verfügung gestellt werden.

Die Speicherung der durch die SmartSearch ermittelten Inhalte geschieht in einer Vielzahl unterschiedlicher Felder. Diesen lässt sich während der Konfiguration einer Prepared Search eine Gewichtung zugeordnen, um sie so unterschiedlich zu priorisieren. Sie erhalten dadurch einen sogenannten Score, der automatisch berechnet wird und jeweils die Reihenfolge einer Suchergebnisliste bestimmt. Die manuelle Steuerung dieser Suchergebnislisten, den sogenannten Adaptable Results, erfolgt im gleichnamigen Bereich.

Abbildung 13. Adaptable Results

Der Bereich zeigt eine Liste aller bereits bestehenden Adaptable Results, die jeweils der Suchabfrage zu einem Suchwort einer Prepared Search entsprechen.

Adaptable Result anlegen

Für die Erstellung eines neuen Adaptable Results existiert eine eigene Ansicht, die per Klick auf den Button Neue Adaptable Result aufrufbar ist.

Abbildung 14. Neues Adaptable Result

Innerhalb der Ansicht ist eine Prepared Search auszuwählen und ein beliebiger Suchbegriff einzugeben, für den die Reihenfolge der Suchergebnisse verändert werden soll. Ein Klick auf den Button Übernehmen deaktiviert die beiden Felder und ermittelt anhand der Angaben die zugehörige Ergebnisliste, die in Form einer Tabelle angezeigt wird. Der Button Zurücksetzen blendet die Tabelle aus und aktiviert die beiden Felder wieder.

Neben dem Titel, dem Link und den ausgewerteten Tokens des dargestellten Dokuments zeigt jeder Eintrag in der Tabelle den ihm zugeordneten Score, aus dem sich seine Position in der Liste ergibt. Diese ist über die ebenfalls pro Eintrag angezeigten Buttons Elevate und Exclude beeinflussbar:

Das Feld Seite manuell hinzufügen ermöglicht die manuelle Ergänzung zusätzlicher Dokumente durch die Angabe ihrer URL. Diese müssen bereits im Index der Datengeneratoren, die der ausgewählten Prepared Search zugeordnet sind, enthalten sein. Die Eingabe der entsprechenden URL muss in der Form http[s]://www.newdocument.com zu erfolgen und ist mit dem Plus-Button zu bestätigen. Ist das Dokument im Index enthalten, wird es der Ergebnisliste hinzugefügt. Andernfalls erscheint ein entsprechender Hinweis.

Jede Änderung an der Suchergebnisliste ist mithilfe des Speichern-Buttons zu persistieren. Erst mit diesem Klick werden die Anpassungen übernommen, auch wenn sie zuvor bereits in der Liste sichtbar sind.

Liste bestehender Adaptable Results

Nach der Speicherung und erfolgreichen Erzeugung des Adaptable Results wird es der Liste bestehender Adaptable Results im gleichnamigen Bereich hinzugefügt. Die Liste gliedert sich in drei Spalten mit den folgenden Informationen:

Adaptable Result bearbeiten

Der Button mit dem Symbol eines Stifts ermöglicht die Bearbeitung eines Adaptable Results. Ein Klick auf ihn öffnet die Detailansicht mit den vorgenommenen Eingaben. Diese lassen sich entsprechend der zuvor beschriebenen Möglichkeiten verändern.

Adaptable Result löschen

Der Button mit dem Symbol eines Mülleimers ermöglicht die Löschung eines Adaptable Results. Ein Klick auf diesen Button öffnet einen Dialog mit einer Sicherheitsabfrage, mit der die Löschung zu bestätigen ist.

Alternativ besteht über die Checkboxen, die in der Übersichtsliste vor jedem Adaptable Result sichtbar sind, die Möglichkeit, mehrere Adaptable Results für die Löschung auszuwählen. Der Button Ausgewählte löschen entfernt diese markierten Adaptable Results, nachdem zuvor ebenfalls eine Sicherheitsabfrage bestätigt wurde.

Für die kundenseitige Erfassung der benötigten Daten stellt die SmartSearch sogenannte Datengeneratoren bereit. Ihre Erstellung und Verwaltung erfolgt in der gleichnamigen Oberfläche, die über den Menübereich Daten → Datengeneratoren aufrufbar ist.

Abbildung 15. Datengenerator

Der Bereich zeigt eine Liste aller bereits existierenden Datengeneratoren und ist daher initial leer. Bei der Erstellung weiterer Datengeneratoren ist zwischen drei Arten zu unterscheiden:

Datengenerator anlegen

Für die Erstellung eines neuen Datengenerators existiert eine eigene Ansicht, die per Klick auf den Button Neuer Datengenerator aufrufbar ist und sich in drei Tabs gliedert. Neben den zwei Tabs Allgemein und Enhancer, die für alle Datengeneratoren identisch sind, besitzt jeder von ihnen zusätzlich ein spezifisches Tab.

Abbildung 16. Datengenerator - Tabs

Die nachfolgenden Absätze beschreiben zuerst die beiden identisch Tabs, bevor eine Erläuterung der spezifischen Tabs folgt:

Liste bestehender Datengeneratoren

Nach der Speicherung und erfolgreichen Erzeugung des Datengenerators wird er der Liste bestehender Datengeneratoren im gleichnamigen Bereich hinzugefügt. Die Liste gliedert sich in eine vierspaltige Tabelle mit den folgenden Informationen:

Datengenerator bearbeiten

Der Button mit dem Symbol eines Stifts ermöglicht die Bearbeitung des Datengenerators. Ein Klick auf ihn öffnet die Detailansicht mit allen vorgenommenen Konfigurationen. Diese lassen sich entsprechend der zuvor beschriebenen Möglichkeiten verändern.

Datengenerator ausführen

Der Button mit dem Play-Symbol startet manuell die Ausführung des Datengenerators. Er erfasst daraufhin die Daten der konfigurierten Quelle und überträgt sie an den Solr-Server.

Datengenerator löschen

Der Button mit dem Symbol eines Mülleimers ermöglicht die Löschung eines Datengenerators. Ein Klick auf diesen Button öffnet einen Dialog mit einer Sicherheitsabfrage, mit der die Löschung zu bestätigen ist.

Alternativ besteht über die Checkboxen, die in der Übersichtsliste vor jedem Datengenerator sichtbar sind, die Möglichkeit, mehrere Datengeneratoren für die Löschung auszuwählen. Der Button Ausgewählte löschen entfernt diese markierten Datengeneratoren, nachdem zuvor ebenfalls eine Sicherheitsabfrage bestätigt wurde.

Für die Darstellung der per Datengenerator erfassten und durch den Solr-Server persistierten Daten stellt die SmartSearch einen Browser bereit. Dieser ist über den Menüpunkt Daten → Browser aufrufbar.

Für die Darstellung ist im Drop-Down-Menü zunächst ein Datengenerator auszuwählen. Der Browser listet daraufhin alle Dokumente auf, die durch diesen Datengenerator erfasst wurden. Per Klick auf ein solches Dokument lassen sich außerdem alle Felder und die in ihnen gespeicherten Metainformationen anzeigen. Die Buttons Vorheriges Dokument und Nächstes Dokument ermöglichen ein Durchblättern durch die erfassten Dokumente, deren Gesamtanzahl zwischen ihnen ablesbar ist.

Abbildung 20. Browser

Mit der SmartSearch wird eine Datenstruktur - das sogenannten Solr-Schema - ausgeliefert, welche die für erfasste Dokumente vorhandenen Felder definiert. Diese Felder am Dokument beinhalten nach einer Datenerfassung strukturierte Inhalte, die im Bezug auf das Dokument im Index gespeichert sind. Da die Inhalte verschiedener Felder potenziell Einfluss auf die Ergebnisse einer Suchabfrage haben, werden im folgenden einige relevante Felder erläutert. Einige Felder werden während des Laufs von Datengeneratoren automatisch angelegt und mit Werten befüllt. Der Groovy-Skript-Enhancer bietet außerdem die Möglichkeit, weitere Felder und Werte hinzuzufügen.

Grundsätzlich besteht ein Feld aus einem Bezeichner und einem oder mehreren Werten. Es existieren drei Arten von Feldern, welche sich in ihrem Gebrauch und ihrer Funktion unterscheiden können:

Für die Nutzung der SmartSearch ist es wichtig, Anwendungsfälle und Inhalt der verfügbaren Felder zu verstehen. Die folgenden Tabellen geben eine Übersicht über die drei Feldarten sowie den relevanten Teil der vorhandenen Felder und skizzieren deren Inhalt:

Pflichtfelder

Die Bezeichner sowie Werte von Pflichtfeldern sind zwingend an jedem Dokument vorhanden, erstere sind außerdem unveränderbar.

Die nachfolgende Tabelle zeigt eine Übersicht von Feldern dieser Art:

Statische Felder

Die Bezeichner statischer Feld sind ebenso wie die der Pflichtfelder unveränderbar. Im Gegensatz zu diesen besitzen statische Felder jedoch nicht zwingend einen Wert.

In der folgenden Tabelle sind einige typische statische Felder aufgeführt:

Dynamische Felder

Die Bezeichner dynamischer Felder folgen einer Namenskonvention und können in Abhängigkeit des Einsatzes und Dokuments vorhanden oder nicht vorhanden sein. Dynamische Felder sind dafür vorgesehen, das Schema flexibel für zukünftig nötige Daten und die Anwendung somit robuster zu gestalten.

Dynamische Felder verhalten sich wie statische Felder, außer dass ihre Bezeichner einen Platzhalter enthalten. Werden durch den Start einer Datengenerierung Dokumente indiziert, können Daten, welche keinem statischen Feld zuordenbar sind, durch ein dynamisches Feld aufgefangen werden.

So kann ein Dokument beispielsweise ein Feld custom_date beinhalten, welches im Solr-Schema nicht vorhanden ist. Die Daten in diesem Feld würden über das dynamische Feld *_date dennoch in den Index übernommen.

Weitere Informationen zu dynamischen Feldern sind der Solr-Dokumentation zu entnehmen.

Eine Übersicht der wichtigsten verfügbaren dynamische Felder ist folgender Tabelle zu entnehmen:

Statische/dynamische Felder für Sprachkürzel

Neben den oben beschriebenen Arten von Feldern existieren noch Felder, welche pro Sprache an Dokumenten vorhanden sein können und deren Namensschemata die folgende Tabelle veranschaulichen soll:

Die SmartSearch speichert die kundenseitig erfassten Inhalte in einer Vielzahl unterschiedlicher Felder, für deren Definition sie die Prepared Searches bereitstellt. Diesen kann bei der Ausführung eine Sprache übergeben werden, um die Erfassung der Daten sprachabhängig durchzuführen. Die nachfolgende Tabelle zeigt eine Übersicht aller derzeit für die SmartSearch konfigurierten Sprachen inklusive ihrer Kürzel (nach ISO 639-2) und der für sie verfügbaren Features. Die Anwendung der Features erfolgt automatisch bei der Verarbeitung der erfassten Informationen. Weitere Informationen zu den einzelnen Sprachen sind in der Solr-Dokumentation enthalten.

Aktuell ordnet die SmartSearch den Sprachen die folgenden Features zu:

Der Zugriff auf das SmartSearch-Cockpit setzt einen aktiven Benutzer voraus. Für die initiale Anmeldung existiert daher ein Master-Admin, mit dem weitere Benutzer erstellbar sind. Die Berechtigungen eines Benutzers ergeben sich aus seiner Gruppenzugehörigkeit, die während seiner Erzeugung zu definieren ist. Die Erstellung und Verwaltung der Benutzer erfolgt im gleichnamigen Reiter des Usermanagements.

Abbildung 22. Reiter - Benutzer

Der Reiter zeigt eine Liste aller bereits bestehender Benutzer, die initial lediglich den Master-Admin enthält.

Benutzer anlegen

Für die Erstellung eines neuen Benutzers existiert eine eigene Ansicht, die per Klick auf den Button Neuer User aufrufbar ist.

Abbildung 23. Benutzer anlegen

Innerhalb der Ansicht ist zunächst die E-Mail-Adresse des neuen Benutzers anzugeben sowie ein Passwort zu definieren. Des Weiteren kann der Benutzer an dieser Stelle direkt einer oder mehreren Gruppen hinzugefügt werden. Das Drop-Down-Menü Gruppen zeigt dafür die Liste existierender Gruppen. Die Zuweisung des Benutzers zu einer aus der Liste ausgewählten Gruppe erfolgt über das Plus-Symbol neben dem Drop-Down-Menü. Über das Mülleimer-Symbol, das für jede zugewiesen Gruppe sichtbar ist, lässt sich eine Zuordnung wieder rückgängig machen.

Liste bestehender Benutzer

Nach der Speicherung und erfolgreichen Erzeugung des neuen Benutzers wird er der Liste bestehender Benutzer im gleichnamigen Reiter hinzugefügt. Die Liste gliedert sich in eine vierspaltige Tabelle mit den folgenden Informationen:

Mit Ausnahme des Master-Admins werden in der Tabelle pro Benutzer außerdem zwei Buttons angezeigt, die eine Bearbeitung beziehungsweise Löschung des Benutzers ermöglichen.

Benutzer bearbeiten

Der Button mit dem Symbol eines Stifts ermöglicht die Bearbeitung eines Benutzers. Ein Klick auf ihn öffnet die Detailansicht mit allen Informationen. In der Ansicht lässt sich die Gruppenzuordnung des Benutzers ändern, indem er weiteren Gruppen hinzugefügt oder aus ihnen entfernt wird. Die Zuweisung erfolgt über die Auswahl einer Gruppe aus dem Drop-Down-Menü Gruppen und einem anschließenden Klick auf das Plus-Symbol. Die Entfernung des Benutzers aus einer Gruppe ermöglicht das Mülleimer-Symbol, das für jede zugewiesene Gruppe sichtbar ist.

Benutzer löschen

Der Button mit dem Symbol eines Mülleimers ermöglicht die Löschung eines Benutzers. Ein Klick auf diesen Button öffnet einen Dialog mit einer Sicherheitsabfrage, mit der die Löschung zu bestätigen ist. Der Dialog enthält eine Checkbox, die standardmäßig aktiviert ist. Sie bewirkt die Entfernung aller Referenzen des zu löschenden Benutzers auf sein Benutzerkonto. Stattdessen werden sie durch den technischen Benutzer ANONYMUS ersetzt und dadurch anonymisiert. Eine Deaktivierung der Checkbox erhält die Referenzen des Benutzers. Sie lassen sich im Nachhinein über den Button Referenzen zu gelöschten Benutzern entfernen anonymisieren.

Alternativ besteht über Checkboxen, die in der Übersichtsliste vor jedem Benutzer sichtbar sind, die Möglichkeit, mehrere Benutzer für die Löschung auszuwählen. Der Button Ausgewählte löschen entfernt diese markierten Benutzer, nachdem zuvor ebenfalls eine Sicherheitsabfrage bestätigt wurde.

Auch bei der Löschung mehrerer Benutzers lassen sich deren bestehende Referenzen durch einen technischen Benutzer ersetzen und damit anonymisieren. Wurde diese Option deaktiviert, lassen sich die Referenzen im Nachhinein über den Button Referenzen zu gelöschten Benutzern entfernen entfernen. Er stellt dieselbe Funktion bereit und anonymisiert die Referenzen aller nicht mehr existierenden Benutzer, indem er sie durch den technischen Benutzer ANONYMUS ersetzt.

Der Zugriff auf die Bereiche und Funktionen des SmartSearch-Cockpits setzt verschiedene Berechtigungen voraus. Sie werden über Gruppen definiert, denen die einzelnen Benutzer zuzuordnen sind. Initial existiert lediglich ein Master-Admin, für den zuerst die notwendigen Berechtigungen zur Erstellung neuer Benutzer und Gruppen aktiviert werden müssen. Die Erstellung und Verwaltung der Gruppen erfolgt im gleichnamigen Reiter des Benutzermanagements.

Abbildung 24. Reiter - Gruppen

Der Reiter zeigt eine Liste aller bereits bestehenden Gruppen, die initial lediglich die Admin- und User-Gruppe enthält.

Gruppe anlegen

Für die Erstellung einer neuen Gruppe existiert eine eigene Ansicht, die per Klick auf den Button Neue Gruppe aufrufbar ist.

Abbildung 25. Gruppe anlegen

Innerhalb der Ansicht ist ein Gruppenname zu vergeben, der lediglich Buchstaben, Zahlen und Bindestriche enthalten darf. Des Weiteren können der Gruppe an dieser Stelle direkt ein oder mehrere Benutzer hinzugefügt werden. Das Drop-Down-Menü Benutzer zeigt dafür die Liste bestehender Benutzer. Die Zuweisung eines aus der Liste ausgewählten Benutzers erfolgt über das Plus-Symbol neben dem Drop-Down-Menü. Über das Mülleimer-Symbol, das für jeden zugewiesenen Benutzer sichtbar ist, lässt sich eine Zuordnung wieder rückgängig machen.

Darüber hinaus lassen sich in dieser Ansicht die Berechtigungen der Gruppe bestimmen. Dafür sind alle Bereiche des Cockpits aufgelistet, für die einzeln die Berechtigungen Lesen, Bearbeiten und Löschen per Checkbox de-/aktivierbar sind. Für die Bereiche Datengenerator und Search steht außerdem das Recht Ausführen zur Verfügung. Der Button Alle selektieren ermöglicht die gleichzeitige Aktivierung aller dargestellten Berechtigungen.

Liste bestehender Gruppen

Nach der Speicherung und erfolgreichen Erzeugung der neuen Gruppe wird sie der Liste bestehender Gruppen im gleichnamigen Reiter hinzugefügt. Die Liste gliedert sich in eine zweispaltige Tabelle mit den folgenden Informationen:

Mit Ausnahme der Gruppen ADMIN und USER zeigt die Tabelle pro Gruppe außerdem zwei Buttons an, die eine Bearbeitung oder Löschung der Gruppe ermöglichen.

Gruppe bearbeiten

Der Button mit dem Symbol eines Stifts ermöglicht die Bearbeitung einer Gruppe. Ein Klick auf ihn öffnet die Detailansicht der Gruppe mit allen Informationen. In der Ansicht lassen sich die der Gruppe zugeordneten Benutzer sowie die Berechtigungen ändern. Die Zuordnung eines Benutzers zur Gruppe erfolgt über seine Auswahl aus dem Drop-Down-Menü Benutzer und einem anschließenden Klick auf das Plus-Symbol. Die Entfernung eines Benutzers aus der Gruppe ermöglicht das Mülleimer-Symbol, das für jeden zugewiesenen Benutzer sichtbar ist. Die De-/Aktivierung der Berechtigungen ist mithilfe der pro Berechtigung angezeigten Checkbox möglich.

Gruppe löschen

Der Button mit dem Symbol eines Mülleimers ermöglicht die Löschung einer Gruppe. Ein Klick auf diesen Button öffnet einen Dialog mit einer Sicherheitsabfrage, mit der die Löschung zu bestätigen ist. Die Löschung entfernt die Gruppe und alle durch sie definierten Berechtigungen.

Alternativ besteht über Checkboxen, die in der Übersichtsliste vor jeder Gruppe sichtbar sind, die Möglichkeit, mehrere Gruppen für die Löschung auszuwählen. Der Button Ausgewählte löschen entfernt diese markierten Gruppen, nachdem zuvor ebenfalls eine Sicherheitsabfrage bestätigt wurde.

Die einfachste Form der Autocomplete-Abfrage für eine Prepared Search mithras für die Zeichenfolge "son" sieht aus wie folgt. Die Zeichenfolge entspricht dabei dem Wert des Parameters prefix.

/rest/api/v1/prepared_search/mithras/autocomplete?prefix=son

Wurde eine solche Abfrage durch Nutzende abgesetzt, so kann eine Antwort (abhängig von der Datenbasis) wie folgt aussehen:

[
   "sonningen",
   "sonnenenergie",
   "sonnigen",
   "sondern",
   "sonnenspektrums"
]

Das bisherige Beispiel betrachtet den Fall, dass eine Autocomplete-Abfrage sprachunabhängig über alle Dokumente hinweg erfolgt. Dies kann jedoch dazu führen, dass Begriffe aus mehreren im Index vorhandenen Sprachen vorgeschlagen werden:

mehrsprachige Vorschläge. 

[
   "song",
   "sonne"
]

Durch das Hinzunehmen des Sprachparameters language zur Abfrage ist es möglich, auf eine bestimmte Sprache einzuschränken:

language-Parameter. 

/rest/api/v1/prepared_search/mithras/autocomplete?prefix=son&language=de

So führt die zuvor stehende beispielhafte Abfrage für die Sprache Deutsch mit dem Kürzel de zu einem entsprechenden Ergebnis:

sprachabgängige Antwort. 

[
   "sonne"
]

In manchen Anwendungsfällen kann es gewünscht sein, die vorgeschlagenen Begriffe nicht auf durch Leerzeichen getrennte Wörter, sondern über Leerzeichen hinweg zu erweitern. Ein typisches Beispiel sind Suchbegriffe wie "Modell 4A Version 2", "Presse aktuell" oder "Vertrag kündigen".

Soll die Autocomplete-Funktion solche mehrwortigen Begriffe vorschlagen, so gibt es grundsätzlich zwei Möglichkeiten dies umzusetzen:

Mehrwortige Autocomplete-Funktion für freien Inhalt

Für einen zwei Worte umfassenden Autocomplete über ein Leerzeichen hinweg besteht für Nutzende die Möglichkeit, dynamische Felder vom Typ _expandend_autocomplete zu nutzen. Diese werden bei einer Datengenerierung für das Feld content automatisch befüllt, und können durch das Anhängen des Suffixes _expanded über den Parameter field abgerufen werden:

expanded-Suffix. 

/rest/api/v1/prepared_search/mithras/autocomplete?prefix=ene&field=content_expanded

mehrwortige Vorschläge. 

[
   "energy",
   "energy facts",
   "energy locations"
]

Sollen die Inhalte anderer Felder für eine solche mehrwortige Autovervollständigung genutzt werden, so müssen die Inhalte bei der Datengenerierung in einem Groovy-Skript-Enhancer in ein entsprechendes Feld vom Typ *_expanded_autocomplete_[Sprachkürzel] übertragen werden. In diesem Beispiel wird ein freier Text in das Feld texte_expanded_autocomplete_en kopiert:

Feld texte_expanded_autocomplete_en. 

document.addData("texte_expanded_autocomplete_en", "Solar energy is the energy of the future, and we have dedicated ourselves to this future. With our solutions and products, we would like to make sure that you are best equipped for this energy of the future. This is the only way for each of us to achieve the highest levels of sustainability and environmental protection for ourselves, our families and our companies")

Nutzende können nun eine Abfrage gegen dieses Feld (ohne den Suffix _autocomplete_[Sprachkürzel]) senden:

Abfrage des Felds. 

/rest/api/v1/prepared_search/mithras/autocomplete?prefix=sol&field=texte_expanded

Die Antwort auf diese Abfrage beinhaltet eine leerzeichenübergreifende Autovervollständigung, falls entsprechende Begriffe in den indizierten Daten vorhanden sind:

leerzeichenübergreifende Vorschläge. 

[
   "solar energy",
   "solutions",
   "solar",
   "solutions and"
]

Mehrwortige Autocomplete-Funktion für definierte Begriffe

In manchen Situationen kann es als Suchanbieter hilfreich sein, die Wortvorschläge sehr genau kontrollieren zu können. Sind die indizierten Inhalte zum Beispiel Produkte, so soll die Vervollständigung der Eingabe "mod" eventuell die Vorschläge "modell 4a version 1" sowie "modell 4a version A" anbieten.

Um dieses Verhalten zu erreichen, steht das sprachunabhängige dynamische Feld _keyword_lc zur Verfügung. Dazu muss bei der Einrichtung des Datengenerators an einem an der Prepared Search konfigurierten Datengenerator in einem Groovy-Skript-Enhancer ein solches Feld befüllt werden. Folgender exemplarischer Groovy-Skript-Code setzt den Wert des dynamischen Felds model_keyword_lc auf modell 4a version 1:

Ersetzung eines dynamischen Felds. 

document.setSingleValue("model_keyword_lc", "modell 4a version 1")

Gibt es nun im Index Dokumente mit den Werten modell 4a version 1 bzw. modell 4a version 2, so kann ein Nutzender der Autocomplete-Funktion durch den Parameter field das Feld model_keyword_lc gezielt zur Vervollständigung der Eingabe "mod" nutzen:

gezielte Vervollständigung. 

/rest/api/v1/prepared_search/mithras/autocomplete?prefix=mod&field=model_keyword_lc

Anders als bei den bisherigen Beispielen, in denen nur passende Auszüge aus Feldinhalten zurückgegeben wurden, beinhaltet die Antwort auf eine solche Abfrage alle vollständigen Werte des übergebenen dynamischen Felds. Im aktuellen Beispiel könnte die Antwort entsprechend wie folgt aussehen:

Antwort mit vollständigen Werten. 

[
   "modell 4a version 2",
   "modell 4a version 1"
]

Die Autocomplete-Funktion schlägt keine Wörter vor, die in Stopwortlisten vorkommen. Bei Änderungen an einer Stopwortliste ist eine erneute Indizierung durch einen Datengenerator-Lauf nötig, damit sich die Änderung in der Liste der ausgelieferten Autocomplete-Vorschläge niederschlägt.

Es ist ratsam, keine Autocomplete-Anfragen für Prefixe mit weniger als drei Buchstaben an die SmartSearch zu senden. Wenn auch grundsätzlich möglich, können Abfragen mit solch kurzen Prefixen eine erhöhte Last verursachen. Auch sind die Vorschläge in den Antworten solcher kurzen Anfragen häufig nicht sinnvoll, da die Anzahl der möglichen Vorschläge noch sehr lang und somit wenig eingrenzend ist.

Grundsätzlich sind die Vorschlagslisten noch um sogenannte Filter-Queries erweiterbar. Solche Filter-Queries schränken die Liste der Vervollständigungsvorschläge weiter ein, indem sie die Menge der ihnen zugrunde liegenden Dokumente durch eine Anfrageklausel verkleinern. Die ist durch eine Erweiterung des Parameters fq durch eine solche Klausel erreichbar. Das folgende Beispiel zeigt entsprechend nur noch Vorschläge aus Dokumenten an, in deren indiziertem Inhalt das Feld mime_type den Wert 'html' enthält. .Einschränkung durch Filter-Queries

rest/api/v1/prepared_search/mithras/autocomplete?prefix=ene&fq=mime_type:html