haupia

e-Spirit AG

06.05.2021

Inhaltsverzeichnis

1. Einleitung
- 1.1. Architektur
- 1.2. Technische Voraussetzungen
2. Komponenten
3. DSGVO
4. Installation und Konfiguration
5. Tiefergehende Konfiguration
6. Proxy-Konfiguration
7. SSL
8. haupia-Cockpit
9. Anwendungsfälle
- 9.1. Autocomplete
10. Monitoring
11. Betrieb
- 11.1. Zurücksetzen des Master-Admin-Passwortes
12. Troubleshooting
13. Unsignierte SSL-Zertifikate
14. Rechtliche Hinweise

1. Einleitung

haupia bündelt Anforderungen, die Kunden an die Suchfunktion einer Online-Präsenz stellen: Eine intuitiv bedienbare, hochperformante Suchlösung, die auf umfangreichen Webseiten einsetzbar ist und relevante Ergebnisse liefert. Es bietet sowohl eine hohe Trefferqualität als auch einen optimalen Suchkomfort und bindet Kunden somit auf der Webseite.

Gleichzeitig stellt es durch das integrierte haupia-Cockpit Redakteuren eine Web-Oberfläche bereit, die ohne IT-Kenntnisse verwendbar ist. Redakteure aus Fach- und Marketingabteilungen werden so in die Lage versetzt, Suchergebnisse auf der Webpräsenz zu steuern und zu überwachen. Das Cockpit stellt dafür Statistiken, Filter sowie Analysefunktionen bereit und erlaubt die Indizierung verschiedenster Datentypen (z. B. XML, Audio, Video, Medien) aus unterschiedlichen Datenquellen. Mithilfe individualisierter Trefferlisten können Redakteure im Backend Suchergebnisse priorisieren und gewichten sowie ausgewählte Inhalte zu vordefinierten Suchanfragen ausgeben lassen.

1.1. Architektur

Die Funktionalitäten von haupia werden über eine Architektur verschiedener Komponenten realisiert (vgl. Abbildung Architektur).

Bei diesen Komponenten handelt es sich um:

ZooKeeper
Solr
haupia

Abbildung 1. Architektur

Das Zusammenspiel der Komponenten erfolgt immer nach dem folgenden Schema:

Für die Erstellung des Suchindexes muss haupia zunächst die notwendigen Daten erfassen. Dafür greift es kundenseitig auf die zu erfassenden Informationen zu, die in Form von Webseiten, Portalen oder Datenbanken vorliegen können. Darüber hinaus stellt die REST-Schnittstelle die Möglichkeit bereit, den Suchindex von außen mit weiteren Daten zu befüllen.
Danach normalisiert der haupia-Server die erfassten Daten und überträgt sie an den Solr-Server. Dieser nimmt die Daten entgegen und persistiert sie in einem Index.
Die Abfrage der Daten erfolgt äquivalent: Der haupia-Server nimmt die Anfrage entgegen, modifiziert sie und leitet sie dann an den Solr-Server weiter. Dieser antwortet mit einem Suchergebnis, das vom haupia-Server über die REST-Schnittstelle an die Endanwendung des Kunden zurückgeliefert wird.
Das haupia-Cockpit ist losgelöst von den übrigen Komponenten zu sehen. Es dient der Verwaltung des haupia-Servers und bietet dafür eine einfache, webbasierte Administrationsoberfläche an. In dieser können unter anderem Suchlösungen erstellt und konfiguriert werden.
Die im haupia-Cockpit vorgenommenen Konfigurationen werden neben den Solr-Konfigurationsdaten auf dem ZooKeeper-Server gespeichert.

Die Kommunikation nach außen ist durch HTTPS geschützt, zwischen den Komponenten erfolgt sie per HTTP.

1.2. Technische Voraussetzungen

Der Einsatz haupias besitzt die folgenden technischen Voraussetzungen:

Java 11 oder höher
ZooKeeper in der Version 3.4.10.
Solr in der Version 8.1.1 im Cloud-Modus
haupia in der aktuellsten Version

ZooKeeper und Solr sind nicht in der Auslieferung enthalten. Sie müssen daher vor der Installation in der jeweils angegebenen Version heruntergeladen werden.

2. Komponenten

Die haupia-Architektur besteht aus den nachfolgenden Komponenten:

haupia: haupia ist eine hochperformante, Apache-Solr/Lucene-basierte Suchlösung für Online-Portale wie Webseiten sowie Mitarbeiter- oder Newsportale. Das haupia-Cockpit bietet eine administrative Weboberfläche unter anderem für die Konfiguration von Suchoperatoren und die Analyse von Suchstatistiken an.
ZooKeeper: ZooKeeper bietet einen zentralen Dienst für verteilte Systeme und dient der Verwendung eines Konfigurations- bzw. Synchronisationsdienstes sowie einer Namensregistrierung. Es arbeitet mit Knoten, um Konflikte zwischen den zu speichernden Daten zu verhindern.. Die Knoten speichern die Daten in einem hierarchischen Namensraum, der einer Baumdatenstruktur ähnelt.
Solr: Solrs wichtigste Funktionen sind eine Volltextsuche, Trefferhervorhebung, facettierte Suche, Echtzeit-Indizierung und Datenbankintegration. Durch die Ausrichtung auf Such- und Indexreplikation sowie Skalierbarkeit und Fehlertoleranz wird es häufig für die Enterprise-Suche und Analytics-Anwendungsfälle verwendet.

3. DSGVO

3.1. Hinweise zur DSGVO

3.1.1. Was ist die DSGVO?

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 u.a. die Möglichkeit:

zu erfahren, welche personenbezogenen Daten von ihnen gespeichert und wie diese verarbeitet werden (Informationspflicht und Auskunftsrecht),
die Datenerhebung einzuschränken (Recht auf Einschränkung der Verarbeitung),
die erhobenen Daten zu beeinflussen (Recht auf Berichtigung) und
die erhobenen Daten zu löschen (Recht auf Vergessen).

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

3.1.2. Was sind personenbezogene Daten?

Personenbezogene Daten sind alle Informationen, durch die eine natürliche Person direkt oder indirekt identifiziert werden kann. Dies schließt jegliche potenzielle Identifizierungsmerkmale ein, direkte Identifizierungsmerkmale, wie etwa:

Namen,
E-Mail-Adressen,
Telefonnummern

indirekte Identifizierungsmerkmale, wie:

Standortdaten,
Kundennummern,
Personalnummern

Online-Identifizierungsmerkmale, wie zum Beispiel:

IP-Adressen,
Cookies,
Tracking Pixel

3.2. DSGVO und haupia

3.2.1. Von der Suche erfasste Daten

Die Such-Engine haupia 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 Produktes.

Der Hersteller e-Spirit weist ausdrücklich darauf hin, dass es in der Verantwortung des Kunden liegt, erfasste Daten daraufhin zu prüfen, ob sie personenbezogene Daten enthalten und entsprechende Maßnahmen sicherzustellen.

3.2.2. Personenbezogene Systemdaten

Neben den redaktionellen Daten speichert haupia 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 ggf. Kontakt mit einem Bearbeiter eines Elementes aufnehmen zu können. Teile dieser Daten werden in Logdateien vorgehalten. Diese Daten werden im Folgenden „Personenbezogene Systemdaten“ genannt (siehe unten).

3.3. Personenbezogene Systemdaten in haupia

Die e-Spirit AG nimmt den Schutz und die Sicherheit Ihrer Daten sehr ernst. Selbstverständlich halten wir uns an die gesetzlichen Datenschutzbestimmungen und behandeln personenbezogene Daten aber auch nicht-personenbezogene Daten unserer Nutzer mit entsprechender Sorgfalt. Wir erheben personenbezogene Daten nur dann, wenn sie für die Sicherheit und die Funktionsfähigkeit von haupia notwendig sind.

Nachfolgend informieren wir Sie darüber, welche personenbezogenen Daten wir erheben, wenn Sie haupia nutzen und wie wir mit diesen Daten umgehen:

3.3.1. Daten zur Autorisierung und Authentifizierung von Benutzern in haupia

Warum werden die Daten benötigt?

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

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

Wo werden die Daten verwendet bzw. angezeigt?

Informationen zum Benutzer werden an diversen Stellen angezeigt, z. B.:

bei der Anmeldung am Cockpit
bei der Vergabe von Gruppenrechten
beim Ändern eines Objektes über die Auditierung
u.v.m.

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?

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

Das Deaktivieren eines Nutzers im Benutzermanagement löscht seine Daten nicht.

3.3.2. Daten für die Fehleranalyse und Fehlerbehebung in haupia (Protokollierung)

Warum werden die Daten benötigt?

haupia verwendet Logfiles, um Aktionen und Ereignisse auf dem haupia-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 haupia 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 haupia-Servers geschrieben.

Wie lange werden die Daten gespeichert?

Standardverhalten: Wird eine fest eingestellte Dateigröße von 100 MB erreicht, wird die aktuelle Log-Datei 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.

3.3.3. Daten für die Auditierung von Konfigurationselementen

Warum werden die Daten benötigt?

Eine Zielsetzung der Datenspeicherung in haupia ist die Nachvollziehbarkeit der letzten Änderungen, aber auch Informationen über das Erstellen von Konfigurationselementen. Dazu speichert haupia Auditierungs-Daten.

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

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

Wo werden die Daten verwendet bzw. angezeigt?

Die Auditierungs-Daten (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: Beim Löschen eines Benutzer 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 beim Löschen das Standardverhalten nicht angewendet wurde. Nach dem Anonymisieren wird ein Bericht angezeigt, in welchen Elementen der User anonymisiert wurde. Es werden dazu keine Informationen gelogged, der Bericht ist die einzige Möglichkeit Informationen über die Anonymisierung zu bekommen.

3.3.4. Verwendung von Cookies im Cockpit

Warum werden die Daten benötigt?

haupia 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.

4. Installation und Konfiguration

Für die Verwendung der Funktionalitäten haupias müssen zunächst die einzelnen Komponenten installiert werden, die beliebig verteilbar und frei skalierbar sind. Es ist essentiell, dass sie in der folgenden Reihenfolge installiert werden, damit die grundlegenden Konfigurationen richtig vorgenommen werden können:

ZooKeeper
Solr
haupia

ZooKeeper und Solr sind nicht in der Auslieferung enthalten. Sie müssen daher vor der Installation in der Version, die in den technischen Voraussetzungen genannt ist, heruntergeladen werden.

Es wird davon abgeraten, die Installation der Komponenten als root auszuführen. Stattdessen wird die Verwendung eines technischen Benutzers mit den entsprechenden Zugriffsrechten empfohlen. Es wird erwartet, dass der Name des technischen Benutzers jeweils dem Namen der Komponente entspricht.

Solr legt diesen Benutzer automatisch an. Eine manuelle Erstellung ist daher in diesem Fall nicht notwendig.

Da die meisten Rechnersysteme auf Linux basieren, konzentrieren sich auch die folgenden Unterkapitel ausschließlich auf die Installation unter Linux. Die angegebenen Befehle beziehen sich dabei auf das folgende System:

Ubuntu 18/04 LTS (Bionic Beaver)
OpenJDK 11

Des Weiteren wird für die Installationsbeschreibung das Szenario einer einfachen Redundanz angenommen (vgl. Abbildung einfache Redundanz). Die zwei auf der folgenden Abbildung dargestellten Knoten N₁ und N₂ entsprechen zwei physikalischen oder virtuellen Systemen, auf denen jeweils eine ZooKeeper-, Solr- und haupia-Instanz zu installieren ist. Solch ein Cluster-Betrieb aus mindestens zwei Knoten gewährleistet eine grundlegende Ausfallsicherheit und Datenredundanz.

Sind die Aspekte Ausfallsicherheit und Datenredundanz für Sie nicht relevant, lässt sich der gesamte Stack auch auf einem einzigen Knoten installieren. Das Kapitel zum Betrieb eines einzelnen Knotens beschreibt die dafür zu beachtenden Unterschiede.

Abbildung 2. einfache Redundanz

Das beschriebene Szenario kann als Grundlage für einen Cluster-Betrieb mit beliebig vielen Knoten angesehen werden.

Abbildung 3. Cluster-Betrieb mit beliebig vielen Knoten

4.1. Verwendete Ports

Im Rahmen der nachfolgenden Kapitel zur Installation der verschiedenen Komponenten werden diverse Ports genannt. Die folgende Tabelle zeigt eine Übersicht über diese Ports und erläutert ihre Bedeutung.

Tabelle 1. verwendete Ports

Port	Bedeutung
8181	Dieser Port ist für das haupia-Cockpit und erlaubt den Zugriff auf die REST API.
8983	Dieser Port erlaubt den Zugriff auf die Solr-Oberfläche und die API.
2181	Dieser Port ermöglicht die Client-Kommunikation einer ZooKeeper-Instanz.
2888	Dieser Port dient der Kommunikation zwischen den ZooKeeper-Instanzen.
3888	Dieser Port dient ebenfalls der Kommunikation zwischen den ZooKeeper-Instanzen.

4.2. ZooKeeper

Für die Sicherung der Konfigurationen von Solr und haupia ist die Installation und Konfiguration zweier ZooKeeper-Instanzen notwendig, die nicht in der Auslieferung enthalten sind. Laden Sie ZooKeeper dafür in der Version, die in den technischen Voraussetzungen angegeben ist, herunter und installieren Sie es auf beiden Systemen in das zu erstellende Verzeichnis ZooKeeper. Dieser Ordner kann sich an einer beliebigen Stelle in dem jeweiligen System befinden.

Standardmäßig ist die Annahme, dass sich das zu erstellende Installationsverzeichnis im opt-Verzeichnis des zugehörigen Systems befindet. Abweichungen sind in der ZooKeeper.service-Datei entsprechend anzupassen.

Erzeugen Sie anschließend pro System mit dem folgenden Befehl die notwendige Konfigurationsdatei unter conf/zoo.cfg.

Anlegen der Konfigurationsdatei (auf beiden System auszuführen).

cp ~/zookeeper/conf/zoo_sample.cfg ~/zookeeper/conf/zoo.cfg

Legen Sie in demselben Verzeichnis eine Datei mit dem Namen java.env an, um die Menge des ZooKeeper zur Verfügung stehenden Speichers anzupassen. In dieser Datei müssen Sie die Parameter zur Änderung des Speichers für ZooKeeper angeben.

Anlegen der java.env-Datei (auf beiden Systemen auszuführen).

touch ~/zookeeper/conf/java.env

Standardmäßig speichert ZooKeeper Konfigurationsdaten im tmp-Verzeichnis. Da dieses jedoch nur der temporären Speicherung dient, wird stattdessen das im Installationsverzeichnis beider Systeme zu erstellende Verzeichnis ZooKeeper-data benötigt. Damit ZooKeeper es für die Persistierung verwendet, ist auf beiden Systemen der Pfad des ZooKeeper-data-Verzeichnisses in der zoo.cfg-Datei als Wert des Parameters dataDir anzugeben. Ergänzen Sie in derselben Datei die Hostnamen bzw. statischen IP-Adressen aller einzubindenden ZooKeeper-Instanzen. In diesem Fall entspricht diese Angabe den Hostnamen hostname-n1 und hostname-n2. Für die Kommunikation untereinander benutzen die ZooKeeper-Instanzen standardmäßig die Ports 2888 und 3888. Die Portangabe nach dem Strichpunkt bezieht sich auf den Port auf den der zookeeper auf Verbindungen horcht. Zusätzlich muss eine Angabe gemacht werden, die sog. "4 letter words" Kommandos erlaubt. Diese werden vom Solr benötigt.

zoo.cfg - Angabe der ZooKeeper-Instanzen (auf beiden System identisch).

server.1=hostname-n1:2888:3888;2181
server.2=hostname-n2:2888:3888;2181

4lw.commands.whitelist=*

Bei der Serverkonfiguration im Abschnitt oben wird pro Server eine id mitgegeben, zum Beispiel bei "sever.1" ist die id 1. Die id sollte eine Zahl sein zwischen 1 und 255. Die id des Servers wird definiert in der Datei "myid" im Datenverzeichnis. Diese muss angelegt werden uns enthält nur die id.

Anschließend lassen sich beide ZooKeeper-Server mithilfe des folgenden Befehls starten.

Starten des ZooKeeper-Servers (auf beiden Systemen auszuführen).

~/zookeeper/bin/zkServer.sh start

Zusätzlich zu den haupia-Konfigurationen werden auch die Einstellungen des Solr-Servers in ZooKeeper gespeichert. Um Konflikte zu vermeiden, ist eine Trennung der Daten notwendig. Dies erreichen Sie durch die Erzeugungen eines leeren Solr-Knotens, den ZooKeeper für die Persistierung der Solr-Dateien nutzt. Der Knoten lässt sich nur mit einem laufenden ZooKeeper-Client erstellen, der anschließend wieder zu beenden ist.

Da ZooKeeper die Daten synchron hält, ist die Erstellung des Solr-Knotens nur auf einer der beiden Instanzen notwendig.

Der ebenfalls benötigte haupia-Knoten wird während der Installation des haupia-Servers automatisch erzeugt und muss daher nicht manuell angelegt werden.

Erzeugung des Solr-Knotens (auf einem System auszuführen).

~/zookeeper/bin/zkCli.sh
create /solr ""
quit

Kopieren Sie abschließend die ZooKeeper.service-Datei, die in der Auslieferung im Ordner systemd-samples enthalten ist, auf beiden Systemen jeweils in das Verzeichnis etc → systemd → system. Diese ermöglicht, ZooKeeper als Service zu nutzen und über systemctl zu steuern.

Es ist zu gewährleisten, dass in der service-Datei jeweils sowohl der Benutzer als auch der Pfad des Installationsverzeichnisses richtig angegeben sind. Standardmäßig wird der Benutzer ZooKeeper sowie eine Installation unter opt angenommen.

Die Speicherung der Konfigurationen aus dem Backend von haupia erfolgt ebenfalls in ZooKeeper. Der Name des root-Knotens lautet dabei standardmäßig haupia. So ist eine Trennung zu den Solr-Daten gewährleistet. Innerhalb dieses Ordners sind die Konfigurationsdaten lesbar gespeichert. Die vergebenen Namen in der Konfiguration sind gleichzeitig die Namen der Knoten.

4.3. Solr

Die Persistierung kundenspezifischer Daten, die der haupia-Server sammelt, erfolgt mithilfe zweier Solr-Server. Diese sind nicht in der Auslieferung enthalten und müssen daher manuell installiert werden. Laden Sie dafür Solr in der Version, die in den technischen Voraussetzungen angegeben ist, herunter und installieren Sie es auf beiden Systemen in das zu erstellende Verzeichnis Solr. Das Verzeichnis kann sich an einer beliebigen Stelle in dem jeweiligen System befinden.

Standardmäßig ist die Annahme, dass sich das zu erstellende Installationsverzeichnis im opt-Verzeichnis des zugehörigen Systems befindet. Abweichungen sind in der solr.service-Datei entsprechend anzupassen.

Solr stellt für die Installation das Skript install_solr_service.sh bereit, das Sie zunächst aus der heruntergeladenen Datei extrahieren und anschließend auf beiden Systemen ausführen müssen. Dabei können Sie das Zielverzeichnis für die Persistierung der gesammelten Daten jeweils frei wählen. Das Skript installiert beide Solr-Server als Service, legt auf ihnen den Benutzer solr an und erzeugt zusätzlich alle benötigten Dateien sowie Verzeichnisse.

Für die noch ausstehende Konfiguration müssen sich beide Solr-Server zwingend in einem nicht laufenden Zustand befinden.

Installation des Solr-Servers (auf beiden System auszuführen).

./install_solr_service.sh solr-8.1.1.tgz -d <VARIABLE_PATH> -n

Beispielsweise für die Speichernutzung benötigen die Solr-Server diverse Java-Variablen. Diese sind pro System in der Konfigurationsdatei etc/default/solr.in.sh zu definieren.

Des Weiteren muss in dieser Datei jeweils die Verwendung der Solr-Cloud aktiviert und der Solr-Knoten, der zuvor während der ZooKeeper-Installation erzeugt wurde, angegeben werden.

Vor der Ausführung des Skripts ist sicherzustellen, dass der Solr-Knoten während der ZooKeeper-Installation erzeugt wurde und dort tatsächlich existiert.

Anpassung der Solr-Konfiguration (auf beiden Systemen auszuführen).

sed -i 's/#ZK_HOST=.*/ZK_HOST=hostname-n1:2181,hostname-n2:2181\/solr/' /etc/default/solr.in.sh

Kopieren Sie abschließend die solr.service-Datei, die in der Auslieferung im Ordner systemd-samples enthalten ist, auf beiden Systemen jeweils in das Verzeichnis etc → systemd → system. Diese ermöglicht, Solr als Service zu nutzen und über systemctl zu steuern.

Es ist zu gewährleisten, dass in der service-Datei jeweils sowohl der Benutzer als auch der Pfad des Installationsverzeichnisses richtig angegeben sind. Standardmäßig wird eine Installation unter opt angenommen.

haupia liefert ein eigenes Schema mit, das auf dem Solr-Server zu installiert ist. Dafür müssen nach der Solr-Installation, aber vor dem ersten Start, folgende Jar-Dateien zusätzlich im Classpath vorhanden sein. Diese sind ein Bestandteil der Solr-Auslieferung und im contrib-Verzeichnis enthalten.

morfologik-stemming-X.Y.Z.jar
morfologik-fsa-X.Y.Z.jar
morfologik-polish-X.Y.Z.jar
lucene-analyzers-morfologik-X.Y.Z.jar
lucene-analyzers-smartcn-X.Y.Z.jar

4.4. haupia

haupia ist eine auf Spring Boot basierende Suchlösung und ermöglicht die Steuerung, Filterung und Analyse von individualisierten Trefferlisten. Um die Funktionalitäten des haupia-Stacks zu nutzen, ist dieser auf beiden Systemen in das zu erstellende Verzeichnis haupia zu installieren. Er wird in Form einer zip-Datei bereitgestellt. In dem pro System erstellten Installationsverzeichnis ist außerdem die Lizenz abzulegen, die sich vom Technical Support anfordern lässt. Das Verzeichnis kann an einer beliebigen Stelle in dem jeweiligen System erzeugt werden.

Abweichungen sind in der haupia.service-Datei und in der application.yml für alle Parameter entsprechend anzupassen. Standardmäßig ist die Annahme, dass sich das zu erstellende Installationsverzeichnis im opt-Verzeichnis des zugehörigen Systems befindet.

Nach der Installation des haupia-Stacks ist auf beiden Systemen die Durchführung der folgenden Konfigurationsschritte notwendig:

Erzeugung des Verzeichnisses data: Der haupia-Stack benötigt für die Datenspeicherung das Verzeichnis data. Dieses ist innerhalb des jeweiligen Installationsverzeichnisses manuell zu erstellen.

Anpassung der application.yml-Datei

Die in der Auslieferung enthaltene application.yml-Datei ermöglicht die Konfiguration der haupia-Server. Dabei sind insbesondere die folgenden Punkte zu beachten:

Der haupia-Server verwendet standardmäßig den Port 8181. Diesen können Sie jedoch pro System optional anpassen.
Die Kommunikation des Servers ist nach außen per SSL geschützt. In der Auslieferung ist dafür ein selbstsigniertes Zertifikat enthalten. Dieses dient ausschließlich der lokalen Entwicklung und muss für den produktiven Einsatz zwingend gegen ein offiziell signiertes Zertifikat ausgetauscht werden.
Für die Speicherung von Konfigurationsdaten benötigt der haupia-Server eine Verbindung zu dem ZooKeeper seines Systems. Dafür muss ihm unter dem Parameter connection des Keys ZooKeeper die Adresse des entsprechenden ZooKeeper-Servers bekannt gemacht werden.
Das zuvor angelegte Verzeichnis data muss dem haupia-Stack bekannt gemacht werden. Dafür ist in der zugehörigen application.yml-Datei der Parameter root des Keys haupia entsprechend anzupassen.
Den ZooKeeper-Instanzen muss der Host-Name jeder einzelnen haupia-Instanz bekannt sein. Dieser ist daher jeweils zwingend als Wert des Parameters server.address anzugeben. Erfolgt keine Angabe, ist keine Verwendung des haupia-Cockpits möglich.
Die Ermittlung von Benutzerdaten erfolgt durch den Zugriff auf einen Cache. Dieser benötigt im Fall von Änderungen eine gewisse Zeitspanne für die Aktualisierung. Der Parameter haupia.zookeeper.users.cache.await definiert die Zeitspanne in Sekunden, in der auf eine solche Aktualisierung gewartet wird. Initial entspricht der Standardwert einem Timeout von einer Sekunde.
haupia ermittelt das zu verwendende URL-Schema aus der Solr Cluster Property urlScheme. Ist dieser Wert nicht gesetzt, wird standardmäßig http verwendet. Der Parameter solr.url.scheme ermöglicht eine Überschreibung des Verhaltens und muss den Wert http oder https besitzen.
Es ist möglich, den Solr-Server mithilfe einer Basis-Authentifizierung zu sichern. Die notwendigen Zugangsdaten sind über die Parameter solr.auth.username und solr.auth.password anzugeben.
Beim Nutzen des haupia-Connect FirstSpirit-Moduls kann über den Parameter haupia.connect.datagenerator.pool.size konfiguriert werden auf wieviele FirstSpirit-Projekte in Form eines eigenen Datengenerators reagiert werden muss. Ist der Wert kleiner als die Anzahl der angebundenen FirstSpirit-Projekte, so führt dies dazu dass nicht von allen Projekten Daten empfangen werden können. Ist dieser Wert nicht gesetzt, so gilt ein Maximum von 'Anzahl der Kerne * 500'.

Der Master-Admin wird beim initialen Start des ersten haupia-Servers automatisch erzeugt und muss daher für alle Instanzen dieselben Daten besitzen. Er ist weder deaktivier- noch löschbar und verhindert so ein Aussperren aus dem haupia-Cockpit. Das Master-Admin-Passwort kann im haupia-Cockpit geändert werden. Ein Start des haupia-Servers mit dem optionalen Parameter resetAdminPassword setzt das Master-Admin-Passwort auf den Wert aus der application.yml zurück.

Start-Parameter, Encoding und JVM-Modus: Die beiden haupia-Server benötigen zum Starten den Parameter -Dhaupia.master.profile=STANDALONE. Dieser ist standardmäßig in der mitgelieferten server.conf-Datei enthalten und darf nicht geändert werden. Darüber hinaus lassen sich in dieser Datei unter anderem das Encoding und der Modus der Java Virtual Machine bestimmen. Diese sind ebenfalls bereits gesetzt und lassen sich bei Bedarf anpassen. Zusätzlich bietet die Datei die Möglichkeit, die Speichernutzung des jeweiligen haupia-Servers zu definieren.

Starten Sie den haupia-Stack des ersten Systems über das in der zip-Datei enthaltene server.jar. Diese enthält ein Launch-Skript, welches den Einsatz der jar-Datei als Unix-Service ermöglicht. Erst, wenn die Logdatei der ersten haupia-Instanz die folgende Meldung über den erfolgreichen Start enthält, kann die zweite Instanz analog gestartet werden:

Logmeldung.

less /opt/haupia/logs/haupia.log
(...) Started Server in 60 seconds (JVM running for 61.2)

Bei einem direkten Start der server.jar wird der Prozess im Vordergrund ausgeführt. Das Startskript erkennt automatisch, wenn es als Link unter etc → init.d ausgeführt wurde und startet in diesem Fall als Service. Um auch die server.jar als Service zu starten, muss die Variable MODE auf service gesetzt werden:

MODE=service ./server.jar start

Kopieren Sie abschließend die haupia.service-Datei, die in der Auslieferung im Ordner systemd-samples enthalten ist, auf beiden Systemen jeweils in das Verzeichnis etc → systemd → system. Diese ermöglicht, haupia als Service zu nutzen und über systemctl zu steuern.

Es ist zu gewährleisten, dass in der service-Datei jeweils sowohl der Benutzer als auch der Pfad des Installationsverzeichnisses richtig angegeben sind. Standardmäßig wird der Benutzer haupia sowie eine Installation unter opt angenommen.

Die installierten und konfigurierten haupia-Instanzen kommunizieren miteinander und führen eine sogenannte Leader Election durch, mit der die führende Instanz festgelegt wird. Während sich der REST-Service auf allen laufenden Instanzen identisch verhält, lässt sich das haupia-Cockpit ausschließlich auf dem Leader aufrufen. Dies hat zur Folge, dass sowohl die Konfiguration als auch die automatische bzw. manuelle Ausführung der Datengeneratoren ebenfalls lediglich auf der führenden Instanz möglich ist.

Bei dem Versuch das Cockpit über eine andere Instanz als dem Leader anzusprechen, erfolgt eine automatische Weiterleitung. Diese Weiterleitung wird durch eine an ZooKeeper adressierte Leader-Abfrage realisiert. Dem ZooKeeper muss dafür der Host-Name jeder einzelnen Instanz bekannt sein.

Darüber hinaus muss die haupia-Lizenz in einer Textdatei auf dem haupia-Server hinterlegt sein. Die Beantragung der Lizenz erfolgt über den Technical Support der e-Spirit AG. Der folgende Key ermöglicht in der application.yml-Datei auf diese Lizenzdatei zu verweisen:

Verweis zur haupia-Lizenz.

haupia:
   licence:
      path: ./license.txt

5. Tiefergehende Konfiguration

haupia basiert auf Spring Boot und lässt sich über die application.yml-Datei, die im haupia-Verzeichnis neben dem haupia-Jar liegt, konfigurieren. Die application.yml-Datei bietet eine Vielzahl von Konfigurationsmöglichkeiten, die in der Spring-Boot-Dokumentation beschrieben sind. Beispielsweise stellt sie die Möglichkeit bereit, Logging- und Sicherheitseinstellungen vorzunehmen. Das nachfolgende Beispiel erläutert die Konfiguration von SSL, die einen häufigen Anwendungsfall darstellt.

Beispiel: SSL-Konfiguration

haupia nutzt per default SSL, um eine sichere Übertragung der Daten zu ermöglichen, und verwendet dabei den Spring-Boot-Jetty. Dies funktioniert in den meisten Fällen. Bei der Wahl des Protokolls oder der Verschlüsselung können aber Problemen auftreten. Die Spring-Boot-Dokumentation beschreibt die Konfigurationsschlüssel server.ssl.enabled-protocols und server.ssl.ciphers, mit denen sich etwaige Probleme lösen lassen. Um zunächst eine Liste möglicher Parameter zu bekommen, muss das Logging für Jetty an der richtigen Stelle auf DEBUG gesetzt werden. Dazu ist der application.yml-Datei folgende Konfiguration hinzuzufügen:

Konfiguration des Jetty Loggings.

logging:
   level:
      org:
         eclipse:
            jetty:
               util:
                  ssl: DEBUG

Nach der Konfiguration des Loggings und einem Neustart enthält das Log am Ende des Startvorgangs eine DEBUG-Ausgabe, die ungefähr folgendes Aussehen besitzt:

Beispiel für eine DEBUG-Ausgabe der SSL-Informationen des Jettys.

May 22 11:14:50 haupia-cluster-1 server.jar[1208]: 2017-05-22 11:14:50.621 DEBUG 1230 --- [ main] o.e.jetty.util.ssl.SslContextFactory : Selected Protocols [TLSv1, TLSv1.1, TLSv1.2] of [SSLv2Hello, SSLv3, TLSv1, TLSv1.1, TLSv1.2]
May 22 11:14:50 haupia-cluster-1 server.jar[1208]: 2017-05-22 11:14:50.622 DEBUG 1230 --- [ main] o.e.jetty.util.ssl.SslContextFactory : Selected Ciphers [TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, [...]
May 22 11:14:50 haupia-cluster-1 server.jar[1208]: A, SSL_DH_anon_WITH_DES_CBC_SHA, [...]

Diesen zwei Logausgaben geben die aktuellen Werte für das Protokoll und die Verschlüsselung sowie die möglichen Werte aus. Um die Verschlüsselung bei Bedarf auf zwei Verschlüsselungsverfahren zu begrenzen, ist die application.yml-Datei wie folgt anzupassen:

Konfiguration der SSL-Verschlüsselungsverfahren.

server:
   ssl:
      ciphers:
         TLS_DHE_RSA_WITH_AES_128_CBC_SHA,
         TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256

Gleiches gilt für das verwendete Protokoll. Nach einer erfolgreichen Konfiguration ist diese bei einem Neustart in den Logs zu finden.

5.1. Konfiguration der Solr-Replikas

Nach der Installation ZooKeepers, Solrs und haupias müssen in der Solr-Weboberfläche abschließend die nachfolgenden Schritte durchgeführt werden. Sie ermöglichen auf beiden Solr-Instanzen die automatische Replikation der Daten, die haupia für die Beantwortung von Suchabfragen benötigt.

Die beschriebenen Schritte beziehen sich lediglich auf beschriebenen den Cluster-Betrieb mit mindestens zwei Knoten. Für den Betrieb eines einzelnen Knotens sind sie ignorierbar.

Öffnen Sie über die URL http://hostname-<INSTANCE>:8983 zunächst die Solr-Weboberfläche auf einem der beiden Systeme und wählen Sie den Menüpunkt Collections. Die Weboberfläche zeigt daraufhin eine Liste aller existierenden Collections. Selektieren Sie in dieser Liste die Collection, die den Namen des Mandanten trägt, und klicken Sie auf den Punkt Shard: shard1.

Mithilfe des Buttons add replica lässt sich dann eine weitere Replika anlegen. Belassen Sie das Dropdown im Zustand No specified node und erzeugen sie die Replika über den Button Create Replica. Solr wählt dabei automatisch einen freien Knoten aus.

Laden Sie Weboberfläche nach der Erstellung der Replika neu und überprüfen Sie die Existenz der zweiten Replika über einen Klick auf den Punkt Shard: shard1.

Wiederholen Sie die beschriebenen Schritte anschließend mit der Collection, die den Suffix _signals besitzt.

5.2. Betrieb eines einzelnen Knotens

Sind die Aspekte und Datenredundanz nicht relevant, lässt sich der gesamte Stack auch auf einem einzigen Knoten installieren.

Abbildung 4. Betrieb eines einzelnen Knotens

Die Installation der einzelnen Instanzen erfolgt analog zur Beschreibung in den vorhergehenden Kapiteln. Allerdings sind die folgenden Unterschiede zu beachten:

Angabe von ZooKeeper-Instanzen

Im Cluster-Betrieb müssen in den zoo.cfg-Dateien aller Systeme die Hostnamen bzw. statischen IP-Adressen aller einzubindenden ZooKeeper-Instanzen angegeben werden. Diese Angabe entfällt im Fall eines einzelnen Knotens.

sed-Skript zur Anpassung der Solr-Konfiguration

Die Anpassung der Solr-Konfiguration erfolgt über das Skript solr.in.sh. Der Befehl für dessen Ausführung lautet in diesem Fall wie folgt:

Anpassung der Solr-Konfiguration für den Betrieb eines einzelnen Knotens.

sed -i 's/#ZK_HOST=.*/ZK_HOST=localhost:2181\/solr/' /etc/default/solr.in.sh

Solr-Replikas

Die Erstellung von Replikas bezieht sich nur auf den Cluster-Betrieb. Für den Betrieb eines einzelnen Knotens ist ihre Erzeugung daher zu ignorieren.

5.3. LDAP

Die Verwaltung der für die Nutzung haupias notwendigen Benutzer und Gruppen sowie die Definition der Berechtigung findet standardmäßig innerhalb des haupia-Cockpits statt. Die Speicherung der Benutzer und Gruppen erfolgt über den zuvor installierten ZooKeeper-Server.

Alternativ dazu besteht jedoch die Möglichkeit, die Benutzer- und Gruppenverwaltung auf Basis von LDAP umzusetzen. Dabei ist zu beachten, dass sich diese Möglichkeit nur auf die Authentifizierung (Benutzer und Gruppen), nicht jedoch auf die Autorisierung (ACLs) bezieht.

Die Anbindung LDAPs stellt lediglich einen lesenden Zugriff auf den LDAP-Server her. Eine Verwaltung der Benutzer und Gruppen innerhalb des haupia-Cockpits ist anschließend nicht mehr möglich.

Für die Nutzung LDAPs müssen auf dem LDAP-Server die folgenden Aspekte gegeben sein.

LDAP-seitig sind die Benutzer an den Gruppen zu konfigurieren.
Erfolgt die Verwaltung der Benutzer und Gruppen über das haupia-Cockpit, stellt es für den allerersten Login und die initiale Zuweisung von Berechtigungen einen Master-Admin bereit. Äquivalent dazu wird auch LDAP-seitig ein solcher Master-Admin vorausgesetzt. Dieser muss der ebenfalls benötigten Gruppe ADMIN zugeordnet sein.

Abbildung 5. LDAP-seitige Benutzerverwaltung

Es ist zu beachten, dass jeder in der Admin-Gruppe enthaltene Benutzer uneingeschränkt die Berechtigungen innerhalb des haupia-Cockpits bearbeiten darf.

Der erfolgreiche Login eines Benutzers setzt voraus, dass dem haupia-Cockpit der LDAP-seitig verwendete Passwort-Encoder bekannt ist. Dieser kann daher im Passwortfeld in der Form {id}hash angegeben werden. Die Id entspricht dabei der Id des Hashing-Algorithmus' und muss einem der folgenden Werte entsprechen:
- bcrypt
- sha, SHA oder SHA-1
- md4 oder MD4
- md5 oder MD5
- noop oder NOOP
- pbkdf2
- SHA-256, SHA256 oder sha256

Alternativ besteht die Möglichkeit, den Passwort-Encoder in der application.yml-Datei des haupia-Servers als Wert des Parameters haupia.ldap.default-password-encoder zu definieren.

Zusätzlich zu den LDAP-seitigen Anpassungen müssen in der application.yml-Datei des haupia-Servers die folgenden Pflichtparameter angegeben werden:

haupia.ldap.enable
Des Weiteren ist die Nutzung LDAPs zu aktivieren. Dafür ist der Wert des Parameters haupia.ldap.enable auf true zu setzen.
spring.ldap.username & spring.ldap.password
Für die Verbindung zum LDAP-Server wird ein technischer Benutzer benötigt, der dem haupia-Server bekannt zu machen ist. Aus diesem Grund muss der Distinguished Name (DN) sowie das Passwort des technischen Benutzers für die Parameter spring.ldap.username und spring.ldap.password angegeben werden.
haupia.ldap.user-search-base bzw. haupia.ldap.group-search-base
Für die Suche der Benutzer- bzw. Gruppen-Objekte ist ebenfalls der entsprechende Distinguished Name (DN) als Wert des Parameters haupia.ldap.user-search-base bzw. haupia.ldap.group-search-base anzugeben.
(Beispiel.: ou=people,dc=example,dc=org bzw. ou=groups,dc=example,dc=org)

Die Suche nach Benutzer- bzw. Gruppen-Objekten bezieht sich ausschließlich auf die angegebene Ebene. Subtrees sind von dieser Suche ausgeschlossen.

Zusätzlich zu diesen Pflichtangaben lassen sich darüber hinaus optional weitere Anpassungen vornehmen:

spring.ldap.urls
Dieser Parameter enthält eine Liste der URLs zu den verfügbaren LDAP-Servern. Standardmäßig besitzt der Parameter den Wert ldap://localhost:389.
spring.ldap.base
Mit diesem Parameter lässt sich für alle gegen den LDAP-Server ausgeführten Operationen ein DN-Suffix definieren.
haupia.ldap.user-filter
Um ein User-Objekt im Baum des LDAP-Servers zu finden, kann mit diesem Parameter ein Filter angegeben werden. Standardmäßig besitzt er den Wert uid={0}. Der Platzhalter {0} wird dabei durch den eingegebenen Benutzernamen ersetzt.
haupia.ldap.group-filter
Äquivalent zum User-Filter ermöglicht dieser Parameter die Angabe eines Gruppen-Filters, der alle zu einem Benutzer gehörenden Gruppen-Objekte findet. Standardmäßig besitzt er den Wert (member={0}). Der Platzhalter {0} wird in diesem Fall durch den Distinguished Name (DN) des entsprechenden Benutzers ersetzt.
haupia.ldap.default-password-encoder
Wird der verwendete Password-Encoder nicht dem Passwortfeld auf dem LDAP-Server hinzugefügt, kann er stattdessen mithilfe dieses Parameters angegeben werden. Standardmäßig besitzt er den Wert bcrypt.
haupia.ldap.user-attributes.uid & haupia.ldap.user-attributes.password
Die Werte dieser Parameters entsprechen den Feldern, in denen der Name bzw. das Passwort eines Benutzers LDAP-seitig gespeichert sind. Standardmäßig besitzen sie die Werte uid und userPassword.
haupia.ldap.user-attributes.language & haupia.ldap.user-attributes.default-language
Mithilfe des language-Parameters lässt sich steuern, in welcher Sprache das haupia-Cockpit gestartet wird. Fehlt er, wird stattdessen der Wert des default-language-Parameters verwendet. Dieser definiert als Default-Sprache initial Englisch.
haupia.ldap.group-attributes.name & haupia.ldap.group-attributes.user
Äquivalent zu den User-Attributen entsprechen die Werte dieser Parameter dem Namen einer Gruppe sowie der Liste der in einer Gruppe enthaltenen Benutzer. Sie besitzen standardmäßig die Werte cn und member.

Die Gruppennamen werden im haupia-Cockpit grundsätzlich in Großbuchstaben angezeigt, auch wenn sie LDAP-seitig eine andere Schreibweise besitzen.

LDAP-Parameter in der application.yml.

spring:
   [...]
   ldap:
      urls: ldap://localhost:389
      password: admin
      username: cn=admin,dc=example,dc=org
      base: dc=example,dc=org

[...]

haupia:
   [...]
   ldap:
      enable: false
      user-search-base: ou=people,dc=example,dc=org
      user-filter: uid={0}
      group-search-base: ou=groups,dc=example,dc=org
      group-filter: (member={0})
      default-password-encoder: bcrypt
      user-attributes:
         uid: uid
         password: userPassword
         language: language
         default-language: en
      group-attributes:
         name: cn
         user: member

6. Proxy-Konfiguration

Sollte ein http(s)-Proxy nötig sein, damit die Web/XML-Crawler Zugriff auf ihre Crawl-Ziele haben, so lässt dieser sich per JAVA_OPTS konfigurieren. Die relevanten Parameter zur Konfiguration sind die folgenden:

Tabelle 2. Proxy-Konfiguration

Parameter	Beschreibung	Wert
http\|https.proxyHost	Host für den http(s)-Proxy	12.13.14.15
http\|https.proxyPort	Port für den http-Proxy	8080
http.nonProxyHosts	Ausnahmen, bei denen der Proxy nicht berücksichtigt werden soll.	localhost

Exemplarischer Eintrag in der server.conf-Datei.

JAVA_OPTS="-server
-Dhaupia.master.profile=STANDALONE
-Dfile.encoding=UTF-8
-Dhttp.proxyHost=12.13.14.15
-Dhttp.proxyPort=8080
-Dhttps.proxyHost=12.13.14.15
-Dhttps.proxyPort=8080
-Dhttp.nonProxyHosts=localhost|127.0.0.1"

7. SSL

Die Verarbeitung der von haupia gesammelten Daten setzt eine Kommunikation zwischen den einzelnen Komponenten sowie der Endanwendung des Kunden voraus. Die Kommunikation des haupia-Stacks nach außen ist dabei per SSL geschützt. Der haupia-Server verwendet dafür standardmäßig ein selbstsigniertes Zertifikat, das in der Auslieferung enthalten ist.

Für den Einsatz des haupia-Stacks im Produktivbetrieb wird die Verwendung eines offiziell signierten Zertifikats dringend empfohlen. Das in der Auslieferung enthaltene, selbstsignierte Zertifikat ist lediglich für den Einsatz in lokalen Entwicklungsumgebungen ausgerichtet.

Für die Durchführung der nachfolgenden Schritte wird vorausgesetzt, dass bereits ein offiziell signiertes Zertifikat angefordert wurde und die Datei server.crt somit zur Verfügung steht. Des Weiteren wird angenommen, dass alle notwendigen Dateien jeweils in demselben Verzeichnis abgelegt sind.

Für den Einsatz des haupia-Stacks im Produktivsystem ist zunächst ein neuer Keystore zu erzeugen. Dieser muss dem Server bekannt gemacht werden, um die bereits vorhandenen Zertifikate zu ersetzen. Der nachfolgende Befehl zeigt ein Beispiel für die Erzeugung des neuen Keystores:

Erzeugung des neuen Keystores.

openssl pkcs12 -export -in server.crt -inkey server.key -out server.p12 -name server -CAfile ca.crt -caname root

Der Befehl bewirkt eine Konvertierung des x509-Zertifikats und des zugehörigen Keys in eine pkcs12-Datei. Das dabei zu vergebene Passwort ist in der application.yml-Datei unter dem Parameter key-store-password des Keys ssl anzugeben. An derselben Stelle muss der neu erstellte Keystore für den Parameter key-store sowie das keyAlias server definiert werden.

SSL-Parameter.

ssl:
   key-store: server.p12
   key-store-password: PASSWORD
   keyStoreType: PKCS12
   keyAlias: server

8. haupia-Cockpit

Das haupia-Cockpit ist ein Bestandteil haupias. Es dient der Backend-seitigen Verwaltung der durch haupia erfassten Daten und bietet dafür eine einfache, webbasierte Oberfläche an. Diese gliedert sich in die Bereiche Konfiguration, Analyse, Daten und System, die über das Menü zu erreichen sind. Der Button mit dem Weltkugel-Icon stellt darüber hinaus einen Sprachumschalter zwischen Deutsch und Englisch bereit.

Das haupia-Cockpit ist standardmäßig unter der folgenden URL erreichbar:

http://<Servername>:8181

Der erste Aufruf des Cockpits muss mit dem Master-Admin erfolgen. Er wird beim initialen Start des haupia-Servers automatisch mit den Daten aus der application.yml erzeugt.

Ist die Benutzer- und Gruppenverwaltung über einen LDAP-Server realisiert, können die Zugangsdaten abweichen.

Nach der validen Eingabe wird er automatisch auf das Dashboard des Cockpits weitergeleitet. Eine erneute Authentifizierung ist erst nach einer expliziten Abmeldung oder nach dem Ablauf einer Sitzung erforderlich.

Abbildung 6. haupia Dashboard

8.1. Konfiguration

Der Bereich Konfiguration gliedert sich in die Untermenüs Prepared Search, Stoppwörter und Synonyme. Mithilfe dieser Bereiche lässt sich die Ausgabe der von haupia erfassten Daten konfigurieren.

Die nachfolgenden Unterkapitel beschreiben die Untermenüs und die durch sie zur Verfügung gestellten Funktionen.

8.1.1. Prepared Search

Die kundenseitige Erfassung der benötigten Daten erfolgt über die sogenannten Datengeneratoren, die ein Bestandteil des Bereichs Daten sind. Für ihre Verwaltung stellt haupia 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.

CloudModus

Im CloudModus wird in der Liste außerdem die Erreichbarkeit jeder Prepared Search angezeigt.

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 aufgerufen wird und sich in die zwei Tabs Allgemein und Facetten gliedert.

Abbildung 8. Prepared Search anlegen

Allgemein

Innerhalb des Tabs Allgemein ist zunächst ein Name für die neu zu erstellende Prepared Search anzugeben. Wenn Haupia im Cloudmodus ist befindet sich die neben dem Eingabefeld für den Namen eine Checkbox mit welcher die Erreichbarkeit einer Prepared Search umgestellt werden kann. Die anschließende Selektion beliebig vieler Datengeneratoren in der gleichnamigen Auswahlliste zeigt deren verfügbare Felder. Die initial aktivierte Checkbox Verbose blendet dabei alle technischen Felder ein bzw. aus. Die zusammen mit der Checkbox bereitgestellte Schaltfläche ermöglicht die Gewichtung der ausgewählten Felder.

CloudModus

Im CloudModus erscheint neben dem Eingabefeld für den Namen ein Radiobutton, mit welchem man die Erreichbarkeit einer Prepared Search umschalten kann. Wenn eine Prepared Search auf erreichbar gestellt wird, kann sie über das Internet abgefragt werden, ansonsten ist sie nur so erreichbar, wie es das Cockpit auch ist.

Diese lassen sich per Button in die Liste der für eine Suche relevanten Felder übernehmen, die standardmäßig die Felder content,link und title enthält. Eine zuvor definierte Gewichtung wird dabei automatisch jedem dieser Felder zugeordnet.

Die Liste stellt pro Feld die folgenden Konfigurationsmöglichkeiten bereit

Highlight: Mit der Aktivierung dieser Checkbox wird ein Suchwort innerhalb eines Textausschnitts im Suchergebnis hervorgehoben. Die Länge des Textausschnitts ist dabei frei konfigurierbar (siehe unten).
Ausgabe: Diese Option definiert, ob das Feld im Suchergebnis angezeigt wird. Im Falle des Links, der lediglich auf das gesamte Dokument verweist, ist dies zum Beispiel möglicherweise nicht gewünscht.
Durchsuchen: Damit das zugehörige Feld von der Suche berücksichtigt wird, ist diese Checkbox zu aktivieren.

Die Deaktivierung der Option Durchsuchen blendet die nachfolgenden Optionen Teiltreffer und Gewichtung für das entsprechende Feld aus.
Teiltreffer: Diese Option ermöglicht die Berücksichtigung von Teiltreffern. Ist die Checkbox selektiert findet die Suche nach Strom beispielsweise auch den Treffer Ökostromanbieter. Das Suchwort muss dabei eine Länge von drei bis zwanzig Zeichen besitzen.
Gewichtung: Die Gewichtung bietet die Möglichkeit, für Treffer der ausgewählten Felder eine Priorisierung festzulegen und damit das Suchergebnis zu beeinflussen.

Der Button mit dem Symbol eines Mülleimers, der für jedes Feld angezeigt wird, erlaubt die Löschung des entsprechenden Felds aus der Liste.

Der Tab enthält darüber hinaus die folgenden allgemeinen Konfigurationsmöglichkeiten

Treffer pro Seite: Entsprechend ihres Namens gibt diese Schaltfläche die maximale Trefferanzahl an, die auf einer Suchergebnisseite dargestellt werden. In Verbindung mit dem URL-Parameter page lässt sich außerdem eine Aufteilung der Suchergebnisse auf mehrere Seiten realisieren.
Länge Highlight (in Zeichen): Mithilfe dieser Schaltfläche lässt sich wie zuvor erwähnt die Länge des Textausschnitts definieren, in dem ein Suchbegriff visuell hervorgehoben wird.
Sortieren nach: Die Suchergebnisse werden standardmäßig absteigend nach ihrem Score sortiert. Ist eine andere Sortierung gewünscht, ermöglicht dieses Texteingabefeld eine entsprechende Anpassung. Dafür ist ein beliebiges Feld anzugeben und durch den Ausdruck ASC für eine aufsteigende oder DESC für eine absteigende Sortierung zu ergänzen.
Spellcheck (Trefferzahl kleiner als): Ist die Anzahl der Suchergebnisse kleiner als der an dieser Stelle konfigurierte Wert, erfolgt eine Rechtschreibprüfung und die Suche nach Suchwörtern ähnlicher Schreibweise.
Must Match: Für die Suche nach mehreren Begriffen legt die Eingabe dieses Texteingabefelds fest, wie diese zu verknüpfen sind:
- Der Wert 0 entspricht einer Oder-Beziehung zwischen den verwendeten Suchbegriffen.
- Der Wert 100% entspricht einer Und-Beziehung zwischen den verwendeten Suchbegriffen.
- Ein absoluter Wert definiert die Anzahl der Begriffe, die in einem Suchtreffer enthalten sein müssen. Der Wert 2 bei fünf Suchbegriffen besagt beispielsweise, dass zwei der fünf Ausdrücke innerhalb eines Suchergebnisses enthalten sein müssen. Die Werte 2 und 50% sind bei vier Suchbegriffen äquivalent zueinander.
Groovy-Skript: Prepared Searches erlauben darüber hinaus die Einbindung eines selbst zu implementierenden Groovy-Skripts. Ein solches Skript ermöglicht zusätzliche Modifikationen des Datenbestands. So lassen sich beispielsweise weitere Dokumente dem Datenbestand hinzufügen oder der bestehende Datenbestand bearbeiten.

Facetten

Facetten bieten die Möglichkeit, Trefferlisten nach Feldern, die in einem Dokument vorhanden sind, einzuschränken. Da sich Facetten immer auf die im Tab Allgemein selektierten Datengeneratoren beziehen, ist der Tab Facetten initial leer.

Abbildung 9. Facetten

Neue Facette

Für die Erstellung einer neuen Facette existiert eine eigene Ansicht, die per Klick auf den Button Neue Facette aufgerufen wird. Dieser ist nur dann aktiv, wenn im Tab Allgemein mindestens ein Datengenerator definiert ist.

Innerhalb des Tabs ist im gleichnamigen Dropdown zunächst ein Feld auszuwählen. Die verfügbaren Felder stammen dabei aus den selektierten Datengeneratoren. Mit der Auswahl des Felds erscheint eine Liste der diesem Feld zugehörigen Werte, für die folgende Konfigurationsmöglichkeiten verfügbar sind:

Sortieren nach Trefferzahl | alphabetisch: Diese Option definiert, ob die Werte absteigend nach ihrer Anzahl oder alphabetisch nach ihrem Namen in der Facettenliste dargestellt werden.
Werte anzeigen bei Trefferzahl größer als: Mithilfe dieser Option lassen sich Werte, deren Trefferzahl den angegebenen Schwellwert unterschreiten, aus der Facettenliste ausschließen.
Mehrfachauswahl möglich: Diese Option erlaubt die Filterung der Suchergebnisliste nach unterschiedlichen Aspekten. So kann die Suche nach einem bestimmten Objekt beispielsweise im Anschluss sowohl auf eine bestimmte Größe als auch auf eine bestimmte Farbe eingeschränkt werden. Die Suche wird dadurch spezifischer und die Suchergebnisliste minimiert.
Eigenen Filter exkludieren: Um für die Suche verschiedene Filteroptionen bereitzustellen, darf sich die Auswahl eines Filters nur auf die Suchergebnisliste, aber nicht auf die Filteroptionen beziehen. Andernfalls würden die übrigen Optionen durch die Suche ebenfalls ausgeblendet.

Existieren für die Facette Sprache beispielsweise die Filteroptionen Deutsch, Englisch und Französisch liefert die Suche bei der Auswahl der Option Englisch nur noch englische Dokumente zurück. Wird der Filter Englisch in diesem Fall nicht exkludiert, zeigt auch die Liste der zur Verfügung stehenden Filter nur noch Englisch an. In diesem Fall ist es nicht mehr möglich auf einen Filter zu wechseln oder in Zusammenhang mit der vorhergehenden Konfigurationsmöglichkeit eine Mehrfachauswahl zu treffen.

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:

Name: Die Spalte enthält den Namen der Prepared Search, der während der Erzeugung angegeben wurde.
Letzte Bearbeitung: Die Informationen in dieser Spalte zeigen, wann die Prepared Search zuletzt verändert wurde und wer diese Änderung durchgeführt hat.

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 angezeigt werden, 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.

8.1.2. Stoppwörter

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 haupia für jede der 26 unterstützten Sprachen eine Liste sogenannter Stoppwörter, die im Menübereich Konfiguration → Stoppwörter in Form eines Drop-Down-Menüs bereitgestellt werden. 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 angezeigt werden, erlauben die Bearbeitung bzw. Löschung eines einzelnen Eintrags der Liste.

Jede Änderung an der selektierten Liste muss abschließend über den Button mit dem Symbol eines Hakens, der neben dem Drop-Down-Menü dargestellt ist, gespeichert werden. Erst mit diesem Klick werden die Anpassungen übernommen, auch wenn sie zuvor bereits in der Liste sichtbar sind.

Damit die Änderungen an den Stoppwörter-Listen berücksichtigt werden, ist ein erneuter Durchlauf der Datengeneratoren notwendig.

8.1.3. Synonyme

Ä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 haupia für jede der 26 unterstützten Sprachen eine Liste sogenannter Synonyme bereit. 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, die per Klick auf den Button mit dem Plus-Symbol in die Liste übernommen werden. Über das Feld Add a tag lassen sich ihnen jeweils die entsprechenden Ersetzungen zuordnen.

In Bezug auf die Ersetzungen ist zu beachten, dass zukünftige Suchabfragen das Suchwort ignorieren und nur noch die ihm zugeordneten Ersetzungen berücksichtigen. Soll das Suchwort ebenfalls in die Suchabfragen einbezogen werden, muss es sich selbst als Ersetzung hinzugefügt werden.

Beispiel

Das Suchwort KFZ besitzt die Ersetzung PKW. Eine Suchanfrage nach dem Begriff KFZ liefert aufgrund dessen ausschließlich Suchergebnisse zum Begriff PKW.

Das Suchwort wird sich dann selbst als zusätzliche Ersetzung hinzugefügt, so dass es die Ersetzungen PKW und KFZ aufweist. Suchanfragen nach dem Begriff KFZ liefern anschließend Suchergebnisse zu den Begriffen PKW und KFZ.

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

8.2. Analyse

Der Bereich Analyse glieder sich in die Untermenüs Statistiken und Adaptable Results. Sie ermöglichen sowohl die Analyse der getätigten Suchabfragen als auch die manuelle Steuerung der Trefferreihenfolge für einzelne Suchbegriffe.

Die nachfolgenden Unterkapitel beschreiben die Untermenüs und die durch sie zur Verfügung gestellten Funktionen.

8.2.1. Statistiken

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 zu analysierenden Daten werden automatisch alle fünfzehn Minuten aktualisiert, so dass die Analyse jederzeit auf einem möglichst aktuellen Datenbestand basiert.

Die nachfolgenden Felder dienen der Spezifizierung der zu analysierenden Daten:

Das Drop-Down-Menü Anzahl Ergebnisse zeigt an, ob für die Analyse die 10, 25, 50 oder 100 meistgesuchten Suchwörter ausgegeben werden sollen.
Die Felder Von und Bis legen den zu berücksichtigenden Zeitraum fest.
Das Feld Tags ermöglicht die Anpassung der Statistik durch spezifische Filterkriterien. Sie dienen der Kategorisierung von Suchabfragen und lassen sich während deren Ausführung definieren. Standardmäßig erfolgt die Eingabe der Tags in der Basic-Ansicht, in der sie sich durch einfaches Anklicken auswählen lassen. Alle ausgewählten Tags sind durch eine Und- bzw. Oder-Verknüpfung miteinander verbunden. Der Button Advanced erlaubt darüber hinaus den Wechsel zu einer komplexeren Eingabe der Tags.

Ein Wechsel von der Basic- zur Advanced-Eingabe ist jederzeit möglich. Der Wechsel in die andere Richtung ist nur dann durchführbar, wenn sich die eingegebene Filterung in der Basic-Eingabe abbilden lässt.

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.

8.2.2. Adaptable Results

Die durch haupia ermittelten Inhalte werden in einer Vielzahl unterschiedlicher Felder gespeichert. Diesen kann während der Konfiguration einer Prepared Search eine Gewichtung zugeordnet werden, 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 aufgerufen wird.

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 lässt sich über die ebenfalls pro Eintrag angezeigten Buttons Elevate und Exclude beeinflussen:

Elevate: Der Button Elevate hebt das Suchergebnis grün hervor und verschiebt es an die erste Position der Ergebnisliste. Über die anstelle des Elevate-Buttons erscheinenden Pfeil-Buttons lässt sich die Position des Eintrags noch genauer festlegen. Dabei ist jedoch zu beachten, dass sich die Positionierung über die Pfeil-Buttons nur auf die priorisierten Einträge bezieht. Eine Vermischung priorisierter und nicht priorisierter Einträge ist nicht möglich. Über den Button mit dem Symbol eines Minuszeichens kann die Priorisierung wieder aufgehoben werden.
Exclude/Include: Der Button Exclude hebt das Suchergebnis gelb hervor und entfernt es aus der Ergebnisliste. Dies bedeutet, dass es nicht mehr im Frontend angezeigt wird. Der stattdessen erscheinende Button Include fügt das Suchergebnis wieder der Liste hinzu.

Sowohl Elevations als auch Exclusions basieren auf Links, die zu einem bestimmten Zeitpunkt im Index vorhanden sind. Durch die Veränderung der Suchergebnisliste kann es daher zu Situationen kommen, in denen die Links nicht mehr verfügbar und somit vom Datengenerator nicht mehr erfassbar sind. Aufgrund ihrer fehlenden Entsprechung im Index sind diese Links nicht mehr in der Listenansicht anzeigbar. Es handelt sich bei ihnen um sogenannte verwaiste Elevations bzw. Exclusions.

Im Fall solcher Einträge erscheint in der Detailansicht eines Adaptable Results eine Warnung. Diese listet die verwaisten Links und ihre Dokumenten-IDs auf. Durch die Aktivierung des Häkchens unter der Warnung wird beim Speichern eine Bereinigung durchgeführt.

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 ist in der Form http[s]://www.newdocument.com zu erfolgen und 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 muss mithilfe des Speichern-Buttons persistiert werden. 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:

Name: Das während der Erstellung des Adaptable Results verwendete Suchwort fungiert gleichzeitig als dessen Name und wird in dieser Spalte dargestellt.
Prepared Search: Die Spalte enthält die Prepared Search, auf die sich die Suchanfrage bezieht. Sie wird während der Erstellung des Adaptable Results selektiert.
Letzte Bearbeitung: Die Informationen in dieser Spalte zeigen, wann das Adaptable Result zuletzt verändert wurde und wer diese Änderung durchgeführt hat.

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 angezeigt werden, 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.

8.3. Daten

Für die Erstellung eines Suchindexes greift haupia kundenseitig auf die zu erfassenden Daten zu, die in Form von Webseiten, Portalen oder Datenbanken vorliegen können. Ihre Erfassung erfolgt über sogenannte Datengeneratoren, die unterschiedliche Konfigurationsmöglichkeiten bereitstellen. Die auf dem Solr-Server persistierten Daten lassen sich anschließend über den ebenfalls durch das Cockpit bereitgestellten Browser einsehen. Dieser stellt neben den Inhalten auch alle Metadaten dar.

Die nachfolgenden Unterkapitel beschreiben sowohl die Datengeneratoren als auch den Browser im Detail.

8.3.1. Datengeneratoren

Für die kundenseitige Erfassung der benötigten Daten stellt haupia 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:

Web
XML
Extern

Neben diesen bei der manuellen Erstellung relevanten Datengeneratorarten existieren noch weitere, welche nicht manuell angelegt werden können. Ein Beispiel hierfür ist die Art 'API', welche vom haupia-Connect FirstSpirit-Modul erzeugt wird.

Datengenerator anlegen

Für die Erstellung eines neuen Datengenerators existiert eine eigene Ansicht, die per Klick auf den Button Neuer Datengenerator aufgerufen wird 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:

Allgemein: Innerhalb des Tabs Allgemein ist zunächst ein Name für den zu erstellenden Datengenerator anzugeben und eine Default-Sprache auszuwählen. Der Zähler Mindestanzahl Dokumente zur Synchronisation definiert, ab wann eine Persistierung der erfassten Daten in den vom Solr-Server erzeugten Index erfolgt. Die übrigen Einstellungen ermöglichen eine regelmäßige und automatische Erfassung der benötigten Daten und sind über die Checkbox Regelmäßig starten de-/aktivierbar. Dafür kann zwischen einem täglichen und wöchentlichen Startintervall gewählt und über die Angabe eines Datums sowie einer Uhrzeit der nächste Startzeitpunkt festgelegt werden.

Abbildung 17. Datengenerator - Allgemein

Sprachen entsprechen hier den nach ISO 639-1 vorgesehenen Werten, also Sprachcodes welche aus zwei Zeichen bestehen. Findet ein Datengenerator an Dokumenten Sprachkürzel vor welche länger sind, so wird alles nach dem zweiten Zeichen abgeschnitten. So wird z.B. aus dem Sprachcode "de_DE" im Rahmen der Generierung der Wert "de".

Enhancer: Der Tab Enhancer ermöglicht die Erzeugung der folgenden Enhancer. Sie dienen der Modifikation der durch den Datengenerator erfassten Daten vor ihrer Persistierung auf dem Solr-Server. Die Erstellung eines Enhancers erfolgt über einen Klick auf den Button Neuer Enhancer.

Groovy-Skript
Dieser Enhancer ermöglicht die Einbindung eines selbst zu implementierenden Groovy-Skripts. Ein solches Skript ermöglicht zusätzliche Modifikationen des Datenbestands. So lassen sich beispielsweise weitere Dokumente dem Datenbestand hinzufügen oder bestehende Dokumente bearbeiten bzw. löschen.

Der Button Validieren überprüft das erstellte Skript auf mögliche Fehler.
Extrahieren von Namen und Nomen
Entsprechend seines Namens extrahiert dieser Enhancer Namen und Nomen und speichert sie in den Feldern names_multi_keyword und nouns_multi_keyword.

Dieser Enhancer ist nur für die Sprache Deutsch einsetzbar und besitzt für andere Sprachen keine Funktion.

Web-Crawler

Der Tab Web-Crawler ist spezifisch für den gleichnamigen Datengenerator und wird daher nur für diesen angezeigt. Er erfasst alle Inhalte eines bestehenden Webauftritts. Dies umfasst sowohl die HTML-Inhalte (jedoch ohne in ihnen enthaltene HTML-Kommentare) als auch alle Dateien jeglichen Formats. Dafür benötigt er zunächst eine Start-URL sowie die Angabe, wie viele Seiten maximal zu erfassen sind. Entspricht die Start-URL einer Sitemap, werden die in der Sitemap enthaltenen Verweise nacheinander erfasst.

Durch die Angabe des Werts Null für die zu erfassende Seitenanzahl wird der gesamte Webauftritt erfasst.

Um HTML-Inhalte bei der Erzeugung des Suchindexes zu ignorieren, müssen diese durch HTML-Kommentare der Form "<!-- NO INDEX -→" und "<!-- INDEX -→" gekennzeichnet sein.

Enthalten die erfassten Seiten Verweise auf andere Inhalte, folgt der Datengenerator ihnen und erfasst die verlinkten Inhalte ebenfalls. Dabei werden auch kanonische Verweise berücksichtigt. Auf diesem Weg erfasst er den mit der Start-URL angegeben Webauftritt entweder vollständig oder bis zum angegebenen Limit.

Durch den Datengenerator zu ignorierende Verweise müssen mit Attribut rel="nofollow" gekennzeichnet sein.

Mit einem im Feld Check URL Script angegebenen, selbstimplementierten Groovy-Skript lässt sich die Erfassung und Verarbeitung verlinkter Inhalte individuell beeinflussen. Der Button Validieren überprüft das erstellte Skript auf mögliche Fehler.

Der Datengenerator kann ausschließlich Verweisen von HTTP- auf HTTP(S)-Seiten zu folgen. Der Wechsel von HTTPS zu HTTP ist ihm nicht möglich.

Die übrigen Einstellungen ermöglichen eine Spezifierung der Suchanfragen des Datengenerators:

Mit der De-/Aktivierung der Checkbox No-Script Bereiche im HTML ignorieren lässt sich bestimmen, ob die in diesen Bereichen enthaltenen Inhalte ebenfalls zu erfassen sind.
Ist die Checkbox robots.txt beachten aktiviert, berücksicht der Datengenerator die in ihr definierten Einschränkungen. Andernfalls ignoriert er diese und erfasst den gesamten des Webauftritts.
Enhalten die erfassten Links zusätzliche Parameter, können diese durch die Aktivierung der Checkbox Parameter aus URL entfernen übersprungen werden. Auf diesem Weg lassen sich Redundanzen in den erfassten Dokumenten vermeiden.
Das Feld Charset legt fest, mit welchem Charset die Persistierung der erfassten Daten erfolgt.
Sowohl für die Erfassung der Daten als auch für den Abruf der persistierten Dokumente bringt haupia den User-Agent haupia-agent mit. Sein Referenzname ist in dem entsprechenden Feld enthalten und lässt sich beliebig überschreiben.
Der für den Abstand zwischen zwei Downloads definierte Wert bestimmt, wie schnell haupia die einzelnen Suchabfragen absetzt. Auf diese Weise kann eine Überlastung des Webservers aufgrund einer zu hohen Abfrage-Frequenz vermieden werden.

Erhält der Datengenerator auf eine Suchanfrage keine Antwort, gibt der Read and connect-Timeout die Zeitspanne bis zum Abbruch der Datenerfassung an.

Bei der Erfassung der Inhalte eines bestehenden Webauftritts kann der Web-Crawler unterschiedliche Status Codes erhalten. Diese werden wie folgt verarbeitet:

2xx: Diese Status Codes entsprechen den Standard Codes. In diesem Fall werden die Inhalte durch den Web-Crawler normal verarbeitet.
301: Dieser Status Code entspricht einem Redirect. Der Web-Crawler übernimmt an dieser Stelle die URL der neuen Seite.
302 und 307: Diese beiden Status Codes bezeichnen ebenfalls jeweils einen Redirect. Auch in diesem Fall übernimmt der Web-Crawler die Inhalte der neuen Seite, der alten Verweis bleibt jedoch erhalten.
4xx und 5xx: Diese Status Codes bezeichnen Fehlerstatus. Die betroffenen Seiten werden durch den Web-Crawler ignoriert und der Fehler als DEBUG geloggt.

Für die sich aus einem 3xx Status Code ergebenen Redirect-Verweise, wird die Strip Parameters-Konfiguration berücksichtigt.

Abbildung 18. Web-Crawler

XML-Crawler

Der Tab XML-Crawler ist ebenfalls spezifisch für den gleichnamigen Datengenerator und wird daher nur für diesen angezeigt. Er erfasst XML-Daten aus einer definierten Quelle, die nicht in Form einer Webseite vorliegt. Dafür ist im entsprechenden Feld eine XML-URL anzugeben. Besteht die Notwendigkeit, mehrere Quellen zu erfassen, lässt sich an dieser Stelle auch die URL einer Seed-Datei übergeben. Der Datengenerator folgt dann den in dieser Datei enthaltenen Verweisen, deren Anzahl nicht limitiert ist.

Die Erfassung von XML-Sitemaps ist nur mithilfe des Web-Datengenerators möglich.

Sowohl für die Erfassung der Daten als auch für den Abruf der persistierten Dokumente bringt haupia den User-Agent haupia-agent mit. Sein Referenzname ist in dem entsprechenden Feld enthalten und lässt sich beliebig überschreiben.

Erhält der Datengenerator auf eine Suchanfrage keine Antwort, gibt der Read and connect-Timeout die Zeitspanne bis zum Abbruch der Datenerfassung an.

Abbildung 19. XML-Crawler

Externer Crawler

Der externe Datengenerator sammelt selbst keine Informationen, sondern erfasst ausschließlich Daten, die ihm von außen über die REST-Schnittstelle übergeben werden. Er besitzt daher in seinem spezifischen Tab keine zusätzlichen Konfigurationsmöglichkeiten. Die in den Tabs Allgemein und Enhancer vorgenommenen Einstellungen sind für ihn ausreichend.

Die Übertragung der Daten an die REST-Schnittstelle ist durch eine Eigenimplementierung zu realisieren. Die dafür notwendigen Informationen sind in der Dokumentation haupia REST API for external datagenerators enthalten.

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:

Name: Die Spalte enthält den Namen des Datengenerators, der während der Erzeugung angegeben wurde.
Typ: Diese Spalte gibt an, ob es sich um einen Datengenerator des Typs Web, XML oder Extern handelt.
Status: Diese Spalte zeigt den Zustand an, in dem sich der Datengenerator aktuell befindet. Je nach Vorgang kann er einen der folgenden Status besitzen: Bereit, Erfassen, Erster bzw. Zweiter Enhancer, Synchronisiert oder Fehler.
Letzte Bearbeitung: Die Informationen in dieser Spalte zeigen, wann der Datengenerator das letzte Mal verändert wurde und wer diese Änderung durchgeführt hat.

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.

Die Persistierung der Daten durch den Solr-Server findet in regelmäßigen Intervallen statt. Es kann daher bis zu fünfzehn Minuten dauern, bis die Daten abrufbar sind.

Der Button Collection neu laden ermöglicht die sofortige Synchronisation. Er ist ausschließlich für Mitglieder der Gruppe ADMIN sichtbar und berücksichtig die erfassten Daten aller Datengenerator. Die Synchronisation der Daten eines einzelnen Datengenerators ist nicht möglich.

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 angezeigt werden, 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.

8.3.2. Browser

Für die Darstellung der per Datengenerator erfassten und durch den Solr-Server persistierten Daten stellt haupia 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 Dokumente 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

8.3.3. Verfügbare Felder und Feldtypen

Mit haupia 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:

Pflichtfelder
statische Felder
dynamische Felder

Für die Nutzung haupias 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:

Tabelle 3. Pflichtfelder

Bezeichner	Beschreibung	Inhalt
id	Eindeutige ID eines Dokuments	Mit dem Inhalt dieses Felds ist jedes Dokument im Index eindeutig identifizierbar.
title	Titel eines Dokuments	Der Titel eines Dokuments ist beispielsweise als Überschrift auf einer Suchergebnisseite nutzbar.
content	Inhalt eines Dokuments	Der Inhalt des Dokuments ist - neben dem Titel - die inhaltliche Grundlage für die Suchfunktion. Inhalte, die für die Auffindung des Dokuments relevant sind, sind im Normalfall während der Datengenerierung in dieses Feld zu schreiben.
link	URL des Dokuments	Der URL eines Dokuments ist die Sprungmarke, mit der die Quelle des indizierten Dokuments im Rahmen eines Suchvorgangs vom Endnutzer abrufbar ist. Dies kann zum Beispiel ein Link hinter dem Titel des Dokuments sein, welcher dann zum eigentlichen Dokument führt.

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:

Tabelle 4. Statische Felder

Bezeichner	Beschreibung	Inhalt
thumbnail	Kompaktansicht als Bildverweis	Um die Kompaktansicht der Dokumente in einer Suchergebnisseite anzuzeigen, ist die URL einer solchen Kompaktansicht in diesem Feld zu speichern.
keywords	Schlagwörter	Dieses Feld ist für Begriffe vorgesehen, die vor der Übernahme in den Index keine sprachliche Verarbeitung wie beispielsweise Stemming durchlaufen sollen.
language	Sprachkürzel	Dieses Feld beinhaltet das Sprachkürzel nach ISO 639-1. Das Kapitel Datengeneratoren enthält weitere Informationen hierzu.

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:

Tabelle 5. Dynamische Felder

Namensschema	Beschreibung	Inhalt
*_integer	Integer-Ganzzahlwerte	Felder dieser Art tragen Ganzzahlwerte aus dem Wertebereich Integer (`32-bit signed integer`).
*_long	Long-Ganzzahlwerte	Felder dieser Art tragen Ganzzahlwerte aus dem Wertebereich Long (`64-bit signed integer`).
*_double	Double-Gleitkommazahlenwerte	Felder dieser Art tragen Gleitkommazahlenwerte aus dem Wertebereich Double (`64-bit IEEE floating point`).
*_date	Datumswerte	Felder dieser Art tragen Datumswerte und sind entsprechend für zum Beispiel zeitliche Sortierungen zu verwenden. Die Werte sind im UTC-Format angegeben: zum Beispiel `2020-10-05T12:14:29.058Z`
*_keyword	Schlagwörter	Analog zum statischen Feld `keywords` beinhalten Felder dieses Typs Schlagwörter. Liegt ein solches Feld an einem Dokument vor, so wird der Wert automatisch als Facettenwert verarbeitet. Existiert die Facette noch nicht, so wird sie angelegt.
*_keyword_lc	Schlagwörter in Kleinbuchstaben	Felder dieses Typs beinhalten Schlagwörter, welche im Rahmen der Indizierung automatisch in Kleinbuchstaben umgewandelt wurden.
*_sort	Sortierwerte	Dieser Feldtyp ermöglicht die Speicherung sortierbarer Werte. Die Werte in diesen Feldern sind in Kleinbuchstaben umgewandelt und von Leerzeichen bereinigt.
*_sort_de	Sortierwerte – Spezialfall Deutsch	Dieser Feldtyp verhält sich analog zu `*_sort`. Er besitzt jedoch die Besonderheit, dass Umlaute sowie das `ß` bei den entsprechenden Vokalen beziehungsweise dem `s` einsortiert werden.
*_token	Gruppierungswerte	Dieser Feldtyp ermöglicht die Gruppierung von Dokumenten anhand der Feldinhalte, zum Beispiel Dokument- oder Produktkategorien.
*_pnt	Räumliche Punktwerte	Felder dieses Typs beinhalten räumliche Punktwerte, um z.B. geografische Informationen zu hinterlegen. Die Werte haben das Format `lat,lon` (basierend auf den englischen Begriffen `latitude` und `longitude` für den Breiten- und Längengrad), zum Beispiel `1.23,4.56` Weitere Informationen sind in der Dokumentation zur zugrundeliegenden Solr-Spatial-Search enthalten.
*_facet_string	Textfacettenwerte	Felder dieses Typs beinhalten textuelle Werte zur Nutzung als Facettenausprägungen. Diese Felder werden durch die Nutzung von Bezeichnern der Art `*_keyword` automatisch angelegt und mit Facettenwerten befüllt.
*_facet_double	Gleitkommazahlenfacettenwerte	Felder dieses Typs beinhalten numerische Werte zur Nutzung als Facettenausprägungen. Um beispielsweise einen numerischen Facettenwert für die Facette `price_keyword` zu nutzen, ist ein entsprechender Wert in ein Feld `price_facet_double` einzutragen (zum Beispiel per Groovy-Skript-Enhancer).
*_stored_only	Unverarbeitete Werte	Felder dieses Typs beinhalten Inhalte mit bis zu 32766 Zeichen, welche nicht durchsuchbar gemacht oder in sonstiger Weise verarbeitet sind. Sie können jedoch beim Abruf von Dokumenten zur Anzeige mit abgefragt werden.
*_stored_only_big	Große unverarbeitete Werte	Felder dieses Typs beinhalten Inhalte unbeschränkter Größe, welche nicht durchsuchbar gemacht oder in sonstiger Weise verarbeitet werden sollen. Sie können jedoch beim Abruf von Dokumenten zur Anzeige mit abgefragt werden.
*_autocomplete	Begriffe für die Autovervollständigung	Felder dieses Typs beinhalten Begriffe, welche neben dem Inhalt des Dokuments zur Autovervollständigung verwendbar sind.
*_expanded_autocomplete	Begriffe für wortübergreifende Autovervollständigung	Felder dieses Typs beinhalten Begriffe, welche neben dem Inhalt des Dokuments zur Autovervollständigung über zwei Worte hinweg verwendbar sind.

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:

Tabelle 6. Statische/dynamische Felder für Sprachkürzel [de/en/fr/…]

Namensschema	Beschreibung	Inhalt
*_text_de	Sprachabhängiger textueller Inhalt	Diese Felder enthalten Inhalte, die sprachabhängig textuell verarbeitet sind.
*_autocomplete_de	Sprachabhängige Begriffe für die Autovervollständigung	Felder dieses Typs beinhalten sprachabhängige Begriffe, welche neben dem Inhalt des Dokuments zur Autovervollständigung verwendbar sind.
*_expanded_autocomplete_de	Sprachabhängige Begriffe für wortübergreifende Autovervollständigung	Felder dieses Typs beinhalten sprachabhängige Begriffe, welche neben dem Inhalt des Dokuments zur Autovervollständigung über zwei Worte hinweg verwendbar sind.

8.3.4. Details zu den Sprachen

Die haupia 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 haupia 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 haupia den Sprachen die folgenden Features zu:

Lowercase: Die interne Persistierung der erfassten Daten erfolgt in Kleinschreibweise. Dies hat keinerlei Auswirkung auf die Ausgabe der Informationen und dient lediglich deren Verarbeitung.
Normalisierung: Die Normalisierung dient der Angleichung ähnlicher Schreibweisen von Wörtern. In skandinavischen Sprachen wird beispielsweise eine Ersetzungen der Zeichen æÆäÄöÖøØ (sowie der Varianten aa, ao, ae, oe und oo) zu åÅæÆøØ durchgeführt. Die verschiedenen Schreibweisen blåbärsyltetöj und blaabaersyltetoej ergeben somit die normalisierte Form blåbærsyltetøj.
Stemming: Das Stemming ermöglicht die Verknüpfung verschiedener, morphologischer Varianten eines Worts mit ihrem gemeinsamen Wortstamm. Die Begriffe Wörter, Worte und Wortes besitzen beispielsweise den gemeinsamen Wortstamm Wort.
Stoppwörter: Die Stoppwörter bezeichnen eine Liste von Begriffen, die sehr häufig in einer Sprache vorkommen. Zu ihnen gehören beispielsweise Artikel, Pronomen und Bindewörter. Aufgrund ihrer Häufigkeit sollen sie für den Suchindex nicht in Betracht gezogen werden. Die Auslieferung enthält für jede Sprache eine solche Liste, deren Konfiguration über das haupia-Cockpit möglich ist.
Synonyme: Für Sprachen, die Synonyme zulassen, besteht innerhalb des haupia-Cockpits die Möglichkeit, eine Liste zu erstellen, die einem Begriff andere, ähnliche Wörter zuordnet. Diese Wörter werden bei einer Suche gleich behandelt.

Tabelle 7. Sprachen

Sprache	Kürzel	Lowercase	Normalisierung	Stemming	Stoppwörter	Synonyme
Arabisch	ar	ja	ja	ja	ja	ja
Bengali	be	ja	nein	nein	ja	ja
Bulgarisch	bg	ja	nein	ja	ja	ja
Chinesisch Traditionell	zh-tw	ja	ja	nein	ja	ja
Chinesisch Vereinfacht	zh-cn	ja	ja	ja	ja	ja
Dänisch	da	ja	ja	ja	ja	ja
Deutsch	de	ja	nein	ja	ja	ja
Englisch	en	ja	nein	ja	ja	ja
Estnisch	et	ja	nein	nein	ja	ja
Finnisch	fi	ja	nein	ja	ja	ja
Französisch	fr	ja	ja	ja	ja	ja
Griechisch	gr	ja	nein	nein	ja	ja
Holländisch	nl	ja	nein	ja	ja	ja
Indonesisch	id	ja	nein	ja	ja	ja
Italienisch	it	ja	ja	ja	ja	ja
Japanisch	ja	ja	nein	nein	ja	ja
Koreanisch	ko	ja	ja	nein	ja	ja
Kroatisch	hr	ja	nein	nein	ja	ja
Lettisch	lv	ja	nein	ja	ja	ja
Litauisch	lt	ja	nein	ja	ja	ja
Malaiisch	ms	ja	nein	nein	ja	ja
Norwegisch	no	ja	nein	ja	ja	ja
Polnisch	pl	ja	nein	ja	ja	ja
Portugiesisch	pt	ja	nein	ja	ja	ja
Rumänisch	ro	ja	nein	ja	ja	ja
Russisch	ru	ja	nein	ja	ja	ja
Schwedisch	sv	ja	ja	ja	ja	ja
Serbisch	sr	ja	ja	nein	ja	ja
Slowakisch	sk	ja	nein	nein	ja	ja
Spanisch	es	ja	nein	ja	ja	ja
Thai	th	ja	nein	nein	ja	ja
Tschechisch	cs	ja	nein	ja	ja	ja
Türkisch	tr	ja	ja	ja	ja	ja
Ukrainisch	uk	ja	nein	ja	ja	ja
Ungarisch	hu	ja	nein	ja	ja	ja
Vietnamesisch	vi	ja	nein	nein	ja	ja

8.4. System

Der Bereich System besitzt als einzigen Unterpunkt das Benutzermanagement. Dieses dient der Erzeugung und Konfiguration von Benutzern und Gruppen und gliedert sich daher in zwei gleichnamige Reiter. Die folgenden Unterkapitel erläutern die Funktionalitäten der beiden Reiter im Detail.

Ist die Benutzer- und Gruppenverwaltung auf Basis von LDAP realisiert, besitzt das haupia-Cockpit ausschließlich einen lesenden Zugriff auf sie. Das Cockpit dient in diesem Fall nur der Auflistung der Benutzer und Gruppen, jedoch nicht ihrer Bearbeitung oder Löschung. Lediglich die Berechtigungen werden auch im LDAP-Fall über das haupia-Cockpit verwaltet.

Abbildung 21. Benutzermanagement

8.4.1. Benutzer

Der Zugriff auf das haupia-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.

Ist die Benutzerverwaltung auf Basis von LDAP realisiert, besitzt das haupia-Cockpit ausschließlich lesenden Zugriff auf sie. Die Erstellung, Bearbeitung und Löschung von Benutzern ist in diesem Fall innerhalb des Cockpits nicht möglich.

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 aufgerufen wird.

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 angezeigt wird, lässt sich eine Zuordnung wieder rückgängig machen.

Während die Gruppenzuordnung optional ist, handelt es sich bei Angabe der E-Mail-Adresse und der Definition des Passworts um Pflichtfelder.

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:

Name: Die sortierbare Spalte enthält den Namen und die bei der Erstellung des Benutzers angegebene E-Mail-Adresse. Der Name wird automatisch aus der E-Mail-Adresse generiert.
Gruppen: Die Spalte enthält die Liste aller Gruppen, denen der Benutzer angehört. Die den Gruppen zugeordneten Berechtigungen bestimmen die Zugriffsmöglichkeiten des Benutzers.
Aktiv: Der Schieberegler in dieser Spalte ermöglicht die Deaktivierung eines Benutzers, ohne diesen direkt zu löschen. Der Benutzer kann sich nach der Deaktivierung nicht mehr in das haupia-Cockpit einloggen.

Eine Deaktivierung des Master-Admins ist nicht möglich. Daher steht der Schieberegler für ihn nicht zur Verfügung.

Letzte Bearbeitung: Die Informationen in dieser sortierbaren Spalte zeigen, wann der Benutzer das letzte Mal verändert wurde und wer diese Änderung durchgeführt hat.

Mit Ausnahme des Master-Admins werden in der Tabelle pro Benutzer außerdem zwei Buttons angezeigt, die eine Bearbeitung bzw. 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 angezeigt wird.

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.

Der Master-Admin kann niemals gelöscht werden. Daher steht der Lösch-Button für ihn nicht zur Verfügung.

Alternativ besteht über Checkboxen, die in der Übersichtsliste vor jedem Benutzer angezeigt werden, 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.

Bei der Löschung eines Benutzers lassen sich dessen 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.

8.4.2. Gruppen

Der Zugriff auf die Bereiche und Funktionen des haupia-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.

Ist die Gruppenverwaltung auf Basis von LDAP realisiert, besitzt das haupia-Cockpit ausschließlich lesenden Zugriff auf sie. Die Erstellung und Löschung von Gruppen ist in diesem Fall innerhalb des Cockpits nicht möglich.

Des Weiteren ist die Bearbeitung der Gruppen auf die Konfiguration der Berechtigungen beschränkt.

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 aufgerufen wird.

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 angezeigt wird, 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.

Während die Zuordnung der Berechtigungen optional ist, handelt es sich bei der Angabe des Namens um ein Pflichtfeld.

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:

Name: Die Spalte enthält den Namen der Gruppe, der während ihrer Erzeugung angegeben wurde.
Letzte Bearbeitung: Die Informationen in dieser Spalte zeigen, wann die Gruppe das letzte Mal verändert wurde und wer diese Änderung durchgeführt hat.

Mit Ausnahme der Gruppen ADMIN und USER werden in der Tabelle pro Gruppe außerdem zwei Buttons angezeigt, 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 lässt sich die der Gruppe zugeordnenten Benutzer sowie die Berechtigungen ändern. Die Zuordnung eines Benutzers zur Gruppe erfolgt über seine Auswahl aus dem Drop-Down-Menü Benutzer 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 angezeigt wird. 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.

Die Gruppen ADMIN und USER können niemals gelöscht werden. Daher steht der Lösch-Button für sie nicht zur Verfügung.

Alternativ besteht über Checkboxen, die in der Übersichtsliste vor jeder Gruppe angezeigt werden, 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.

9. Anwendungsfälle

Im Rahmen einer Integration der haupia können verschiedene Anwendungsfälle auftreten, welche bestimmte Konfigurations- beziehungsweise Entwicklungstätigkeiten erfordern. Die folgenden Abschnitte beschreiben derartige Anwendungsfälle gemeinsam mit typischen Lösungsansätzen.

Solche Lösungsansätze können Anpassungen im Cockpit an den Konfigurationen von Prepared Searches sowie Datengeneratoren beinhalten. Dies schließt die Erstellung und Anpassung von Groovy-Skript-Enhancern ein. Außerdem können die vorgestellten Lösungsansätze Anpassungen an den Anfragen gegen die Such-API mit sich führen. Somit richtet sich der nachfolgende Abschnitt vor allem an Entwickler.

Die hier skizzierten Ansätze sind lediglich als Implementierungs- und Integrationsansätze und somit als Ergänzung der Dokumentation, jedoch nicht als vollumfängliche Erläuterung der angeschnittenen Themen zu verstehen.

9.1. Autocomplete

Beim Autocomplete handelt es sich um eine Funktion, die eine durch den Anwender getätigte Sucheingabe sinnvoll ergänzt Grundlage für diese Ergänzung sind die sich im Suchindex befindlichen Daten, welche abhängig von der bisher getätigten Eingabe als sinnvolle Suchbegriffe vorgeschlagen werden.

Als Datengrundlage für die Autocomplete-Funktion dienen die Inhalte des content-Felds, welches auch zur Generierung des Suchindex herangezogen wird. Somit ist die Funktion im Normalfall nutzbar, ohne dass für eine Prepared Search eine spezifische Konfiguration notwendig ist. Die Sprachabhängigkeit wird hierbei für Nutzende transparent gestaltet, eine Konfiguration bezogen auf die zur Vervollständigung genutzte Sprache ist somit nicht nötig.

Grundsätzlich senden Nutzende der Autocomplete-Funktion eine Abfrage mit einem Präfix an die haupia. Die Antwort auf diese Anfrage beinhaltet eine definierte Anzahl von Begriffen, welche mit dem übergebenen Präfix beginnen und von der haupia für diesen als relevant identifiziert wurden - zum Beispiel, weil sie häufig in Dokumenten vorkommen. Daraufhin können Verwendende durch die Eingabe erweiterter Zeichenfolgen und somit einer erneuten Abfrage eine verfeinerte Vorschlagsliste abrufen.

Senden Nutzende zum Beispiel den Präfix son an die haupia, so könnte eine Antwort zum Beispiel wie folgt aussehen:

beispielhafte Antwort.

[
   "sondern",
   "sonnenenergie",
   "sonnenspektrums"
]

Erweitern Anfragende die Eingabe zu "sonn", führt ein Absenden der Abfrage zu einer verfeinerten Liste:

verfeinerte Liste.

[
   "sonnenenergie",
   "sonnenspektrums"
]

Im Folgenden werden die Abfragen beschrieben, welche ein solches Verhalten ermöglichen. Dieses Beispiel basiert auf der Annahme, dass eine Prepared Search mithras vorhanden ist, welche als Ziel der Autocomplete-Abfragen dient.

Weiterhin besteht die Annahme, die Prepared Search sei, wie im Kapitel Prepared Search beschrieben, mit einen Datengenerator verknüpft, dessen indizierte Dokumente das Beispiel ermöglichen. Konkret heißt dies, die in den Beispielen aufgeführten Suchwortvorschläge befinden sich in den indizierten Inhalten.

9.1.1. Sprachunabhängiger Autocomplete

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"
]

9.1.2. Sprachabhängiger Autocomplete

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"
]

9.1.3. Wortübergreifendes Autocomplete

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
mehrwortige Autocomplete-Funktion für definierte Begriffe

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"
]

9.1.4. Anmerkungen

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 haupia 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

10. Monitoring

Monitoring dient der Überwachung von Prozessen, Abläufen und Zuständen. Dabei soll vor allem sichergestellt werden, dass der haupia Server weiterhin einwandfrei läuft und es zu keinen Ausfällen kommt.

Auch haupia bietet für seinen eigenen Server diese Möglichkeit. Über eine einfache Anbindung an Prometheus können die Daten des Servers erfasst und ausgewertet werden. Damit die Kommunikation zwischen Prometheus und haupia funktioniert, müssen an beiden Enden kleinere Konfigurationen vorgenommen werden.

Auf der Seite von haupia muss in der application.yml der Key management.metric.export.prometheus.enabled auf true gesetzt werden.

management:
   metrics:
      export:
         prometheus:
            enabled: true

Danach ist der Prometheus Service unter folgender URL erreichbar: haupia-Server:Port/actuator/prometheus

Zuletzt muss der haupia-Server noch Prometheus bekannt gemacht werden. Dies geschieht in der Konfigurationsdatei prometheus.yml und benötigt folgende Einstellungen:

scrape_configs:
- job_name : haupia
  metrics_path: /actuator/prometheus
  scheme: https
  basic_auth:
     username: USERNAME
     password: PASSWORD
  static_configs:
     - targets:
       - haupia-server:PORT

10.1. Metriken

Um die Aktivität eines haupia Servers zu Überwachen, erfasst Prometheus die sogenannten Metriken. Diese sind Parameter welche bestimmte Messgrößen des Servers beschreiben. Die Metriken werden von Prometheus periodisch erfasst und gespeichert. Aus diesen lassen sich einige Informationen über das Verhalten des haupia Servers ableiten.

Interessant sind dabei vorallem die JVM Parameter, wie Speichernutzung und die Anzahl der Threads. Weitere wichtige Metriken beinhalten die CPU Auslastung oder die Performance von HTTP Requests.

Abbildung 26. Prometheus Metriken

10.2. Grafana

Für eine umfangreichere Visualisierung mit Dashboards kann zusätzlich eine Grafana-Instanz konfiguriert werden. Grafana ist eine Software, die Werte aus Metriken in Graphen darstellt. Dies hat den Vorteil, dass die Werte visuell anschaulicher werden und einfacher miteinander verglichen werden können. Informationen zur Installation und zum Start eines Grafana-Servers befinden sich auf der offiziellen Webseite.

Fügt man in der Grafana-Benutzeroberfläche den konfigurierten Prometheus-Server als Datenquelle hinzu, hat man bei der Gestaltung eines Dashboards Zugriff auf die von haupia zur Verfügung gestellten Metriken.

Abbildung 27. Grafana Graphen

10.3. Solr-Prometheus-Exporter

Mit der Version 8 stellt Solr ebenfalls einen Prometheus-Exporter zur Verfügung. Dieser befindet sich im contrib Unterordner des Solr-Installationsordners. Weitere Informationen zum Betrieb und zur Konfiguration des Exporters befinden sich in der offiziellen Dokumentation

11. Betrieb

Dieses Kapitel enthält Hinweise, die für den Betrieb haupias sowie der verbundenen Systeme notwendig sind.

11.1. Zurücksetzen des Master-Admin-Passwortes

Beim initialen Start des haupia-Servers wird der Master-Admin automatisch mit den Daten aus der application.yml erzeugt. Sein Passwort lässt sich danach jederzeit im haupia-Cockpit ändern. Ein Start des haupia-Servers mit dem optionalen Parameter resetAdminPassword setzt das Master-Admin-Passwort auf den Wert aus der application.yml zurück. Auf diesem Weg wird ein Aussperren aus dem haupia-Cockpit verhindert.

12. Troubleshooting

Die Verarbeitung von Daten in haupia kann nur funktionieren, wenn die einzelnen Komponenten einwandfrei arbeiten. Treten Störungen auf oder ist eine Aktualisierung notwendig, sind daher stets sowohl der haupia-Server als auch alle ZooKeeper- und Solr-server zu betrachten. Die nachfolgenden Abschnitte beschreiben einige Lösungsansätze für bekannte Herausforderungen.

Aktivierung von Spring-Boot-Actuatoren

Spring Boot liefert eine Reihe von Actuatoren mit, die in der default-Konfiguration von haupia aktiviert sind. Mit diesen ist es möglich, zur Laufzeit einen Einblick in den Server zu bekommen. Die Actuatoren liefern zum Beispiel Informationen zum aktuellen Environment oder zu den Konfigurationen der verschiedenen Log-Level. Detaillierte Hintergrundinformationen zu den Actuatoren sind in der Spring-Boot-Actuatoren-Dokumentation zu finden.

Die Actuatoren stellen ihre Informationen über REST-Services zur Verfügung. Diese sind über eine http-Basic-Authentifizierung gesichert und benötigen valide Zugangsdaten eines Admin-Users.

Die nachfolgende Konfiguration aktiviert die default-Actuatoren-Endpunkte, deaktiviert allerdings explizit den heapdump-Endpunkt. Der heapdump-Endpunkt ermöglicht einen Download in GB-Größe, was eventuell in einer Produktionsumgebung nicht gewünscht ist.

Konfiguration für default-Endpunkte.

management:
   endpoint:
      health:
         show-details: when-authorized
      metrics:
         enabled: true
      prometheus:
         enabled: true
   endpoints:
      web:
         exposure:
            include: "*"
            exclude:
               - "heapdump"
   metrics:
      export:
         prometheus:
            enabled: false
            descriptions: false

Die folgende URL stellt einen Überblick über die aktuellen Actuatoren-Endpunkte bereit.

Method: GET

URL: /actuator

Der Aufruf führt eine Basic-Authentifizierung mit einem Admin-User aus. Zu diesem Zweck kann der Nutzer aus der application.yml-Datei verwendet werden.

Mögliche Rückmeldung bei einer Abfrage der Actuatoren.

{
   "_links": {
      "self": {
         "href": "https://haupia-server:8181/actuator",
         "templated": false
      },
      "auditevents": {
         "href": "https://haupia-server:8181/actuator/auditevents",
         "templated": false
      },
      "beans": {
         "href": "https://haupia-server:8181/actuator/beans",
         "templated": false
      },
      "health": {
         "href": "https://haupia-server:8181/actuator/health",
         "templated": false
      },
      "conditions": {
         "href": "https://haupia-server:8181/actuator/conditions",
         "templated": false
      },
      [...]
      "mappings": {
         "href": "https://haupia-server:8181/actuator/mappings",
         "templated": false
      }
   }
}

Verwendung der Logging-API zur Anpassung der Log-Level

Es existiert ein spezieller Spring-Boot-Actutator zum Umgang mit den Log-Einstellungen. Dieser ermöglicht die Anpassung der Log-Level zur Laufzeit. Der Aufruf der folgenden relativen URL auf einer haupia-Instanz erzeugt die Ausgabe alle derzeit konfigurierten Log-Level ausgegeben:

Method: GET
URL: /actuator/loggers

Es können auch Informationen zu einem speziellen Logger ausgegeben werden:
Method: GET
URL: /actuator/loggers/<Logger>

Beispiel-URL zur Abfrage des Loggers de.arithnea.haupia.Server:
URL: /actuator/loggers/de.arithnea.haupia.Server

Der folgende Code-Ausschnitt zeigt eine mögliche Antwort des haupia-Servers auf diese Abfrage.

Beispiel-Rückmeldung.
```
{
   "configuredLevel": "INFO",
   "effectiveLevel": "INFO"
}
```
Die Anpassung eines Log-Levels wird durch einen POST-Request gegen eine konkrete Logger-URL ausgeführt, in dem im JSON-Format das neue Log-Level übermittelt wird:
Method: POST
URL: /actuator/loggers/<Logger>

Der Body ist ein JSON-Objekt, das als Wert für den Key configuredLevel das gewünschte Log-Level besitzt.

Beispiel:

curl-Aufruf.
```
$ curl 'https://haupia-server:8181/actuator/loggers/de.arithnea.haupia.Server'
-i -u 'user:password' -X POST \
   -H 'Content-Type: application/json' \
   -d '{
      "configuredLevel" : "DEBUG"
   }'
```
Der zurückgegebene HTTP-Statuscode 204 bestätigt das erfolgreiche Setzen des Log-Levels.

Prometheus-Endpoint

Prometheus ist ein Tool für das Monitoring von Prozessen. Das Tool erfasst in regelmäßigen Abständen den Zustand eines Prozesses und erlaubt eine zeitliche Auswertung der Daten. Dies ermöglicht zum Beispiel, den Speicherverbrauch im Verhältnis zu den Anfragen an die REST-Services zu beobachten. haupia liefert bereits vorkonfiguriert einen Prometheus-Endpunkt mit, der über die application.yml-Datei zu aktivieren ist. Für die Aktivierung muss folgender Key auf true gesetzt werden:

Beispiel für die Aktivierung des Prometheus-Endpunkts.

management:
   metrics:
      export:
         prometheus:
            enabled: true

Anschließend ist unter folgender URL ein Endpoint verfügbar:

URL: /actuator/prometheus

Der Endpoint lässt sich in Prometheus zum Beispiel wie folgt einbinden.

Beispiel für die Einbindung des Endpoints in Prometheus.

scrape_configs:
   - job_name: 'haupia'
   metrics_path: '/actuator/prometheus'
   scheme: https
   basic_auth:
      username: admin@localhost.de
      password: admin
   static_configs:
      - targets: ['haupia-server:8181']

13. Unsignierte SSL-Zertifikate

Beim Crawling eines https-Servers kann der unten dargestellte Fehler auftreten. Er sagt aus, dass im Keystore kein gültiges Zertifikat eingetragen ist.

Möglicher Fehler bei unsigniertem SSL-Zertifikat.

Caused by: sun.security.validator.ValidatorException:
PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target

Für die Behebung des Fehlers ist das SSL-Zertifikat des gecrawlten https-Servers in den Keystore des haupia-Servers einzubinden. Die Einbindung des Zertifikats erfolgt durch einen Download der Zertifikatsdatei, die der JRE mit dem keytool-Befehl hinzuzufügen ist.

Ein exemplarischer Aufruf für Mac OS sieht wie folgt aus:

Beispielaufruf.

sudo keytool -import -alias BELIEBIGER_ALIAS -keystore /PFAD_ZUR_JAVA_JRE/lib/security/cacerts -file /PFAD/ZUM/ZERTIFIKAT/zertifikats.datei

Nach erfolgreicher Einbindung des Zertifikats tritt der beschriebene Fehler nicht mehr auf und die Seite kann wie gewünscht gecrawlt werden.

14. Rechtliche Hinweise

haupia ist ein Produkt der e-Spirit AG, Dortmund, Germany.
Für die Verwendung des Produkts gilt gegenüber dem Anwender nur die mit der e-Spirit AG vereinbarte Lizenz.