Elasticsearch installieren

Schritte für die Installation von Elasticsearch:

1. Installationsverzeichnis \elasticsearch\ in das Dateisystem des Rechners kopieren, auf dem Elasticsearch installiert werden soll.

2. elasticsearch_setup.exe aus dem Installationsverzeichnis ausführen.

Der Installationsassistent wird gestartet. Folgen Sie den Schritten des Installationsassistenten.

3. Geben Sie folgende Parameter an:

HTTP-Port	Port von Elasticsearch. Default: 9200
Indexverzeichnis	Indexverzeichnis für Elasticsearch. Das Indexverzeichnis sollte auf einem möglichst schnellen und großen Datenträger und nicht innerhalb des Installationsverzeichnisses angelegt werden.
Maximaler Speicher	Maximaler Arbeitsspeicher für den Dienst in MB
Sprachpaket	Europa Elasticsearch wird für europäische Sprachen konfiguriert. Asien Elasticsearch wird für asiatische Sprachen konfiguriert. Diese Option steht nur für Kyocera Enterprise Information Manager zur Verfügung.

4. Passen Sie vor dem Dienststart die Dienstparametern an:

   elasticsearch-service-x64w.exe aus dem Verzeichnis \bin\ ausführen.

   Dienstparameter:

   Log On > Account	Konto für die Dienstanmeldung Elasticsearch benötigt ein administratives Konto.
   Logging > Level	Optional: Protokollierungslevel für die Dienstprotokollierung
   Logging > Path	Optional: Pfad für Dienstprotokolle
   Logging > Stdout	Optional: Umleitung der Standardausgabe in eine Datei
   Logging > Stderror	Optional: Umleitung der Standardfehlerausgabe in eine Datei

5. Weitere optionale Anpassungen:

   • Indexverzeichnis anpassen

   Über die Konfigurationsdatei elasticsearch.yml aus dem Elasticsearch-Verzeichnis \config\ kann das Indexverzeichnis angepasst werden. Parameter: path.data

   • Windows-Dienststeuerung

   Über die Windows-Dienststeuerung die Wiederherstellung bei Dienstfehlern konfigurieren: Wählen Sie Dienst neu starten für alle Fehler.

   • Logging

   Über die Konfigurationsdatei elasticsearch.yml aus dem Elasticsearch-Verzeichnis \config\ kann das Elasticsearch-Protokollverzeichnis angepasst werden. Parameter: path.logs

   • Suchen: AND/OR

   Für die Volltextsuche werden mehrere Begriffe durch das boolesche AND verbunden, wenn der Benutzer keinen Operator angibt. Über die Konfigurationsdatei search-prod.yml aus dem Verzeichnis \config\ von yuuvis® RAD service-manager kann der Standard-Operator umgestellt werden. Parameter: osfts.default-operator: OR

   • Suchen: Unscharfe Suche

   Über die Konfigurationsdatei search-prod.yml aus dem Verzeichnis \config\ von yuuvis® RAD service-manager kann die unscharfe Suche aktiviert werden.

   Parameter: osfts.fuzzy-search: true

   Bei der unscharfen Suche werden Kombinationen von Begriffen nur gefunden, wenn die Kombination in den Metadaten oder im Inhalt vorliegt.

   • Shard-Anzahl

   Standard: Ein Shard pro Index.

   Über die Konfigurationsdatei index-prod.yml aus dem Verzeichnis \config\ von yuuvis® RAD service-manager kann die Shard-Anzahl angegeben werden. Parameter: osfts.number-of-shards

   Änderungen erfordern eine Reindexierung über yuuvis® RAD services-admin:

   • URL aufrufen: http://<service-admin-IP>:7291/swagger-ui.html#!/api-controller/reindex
   • Buttton Try it out! klicken

   Die Reindexierung wird sofort gestartet.

   • CSV für den Export von Trefferlisten

   Über die Konfigurationsdatei search-prod.yml aus dem Verzeichnis \config\ von yuuvis® RAD service-manager kann das Trennzeichen für Spalten in exportierten CSV-Dateien angegeben werden. Parameter: csv.delimiter: ';'. Default: Semikolon.

   CSV-Dateien werden immer UTF-8-codiert ausgegeben, Default ohne BOM. Mit dem Parameter csv.writeBOM: true wird die Datei mit BOM ausgegeben. Die Ausgabe mit BOM sollte für eine korrekte Anzeige von Umlauten und Sonderzeichen beispielsweise in Excel eingestellt werden.

   Für den Export von Trefferlisten können Organisations-Referenz-Felder und Objekt-Referenz-Felder aufgelöst werden. Statt IDs werden dann Bezeichnungen ausgegeben.

   Dazu ist folgender Eintrag in der Datei extend.json notwendig:

    "search": {
       "resolveReferencesCSV": true,
       "resolveReferencesCSVThreshold": 5
     }, 

   Der Export kann durch die Auflösungen deutlich mehr Zeit beanspruchen. Der Parameter resolveReferencesCSVThreshold legt fest, ab wie vielen Auflösungen ein Hinweis für den Benutzer eingeblendet wird. Der Benutzer kann dann den Export abbrechen. Default: 10.000

   • Auto-Vervollständigung

   Die maximale Anzahl der Vorschläge für Felder mit der entsprechenden Eigenschaft kann über die Konfigurationsdatei index-prod.yml aus dem Verzeichnis \config\ von yuuvis® RAD service-manager angegeben werden. Parameter: osfts.autocomplete.suggestions-size: 500. Default: 500.

   Die Auto-Vervollständigung kann über folgenden Eintrag in der Konfigurationsdatei application-es.yml aus dem Verzeichnis \config\ von yuuvis® RAD service-manager deaktiviert werden:

   osfts.autocomplete.enabled: false

   Eine Neuerstellung des Auto-Vervollständigungs-Index kann über yuuvis® RAD services-admin erfolgen:

   • URL aufrufen: http://<service-admin-IP>:7291/swagger-ui.html#!/api-controller/completeAutocompleteIndexUsingPOST
   • Optional: Zeitraum eingeben
   • Buttton Try it out! klicken

   Die Index-Erstellung wird sofort gestartet.

   • Index-Bereinigung

   Nach dem Löschen größerer Mengen von Dokumenten kann der Volltextindex über yuuvis® RAD services-admin bereinigt werden.

   • URL aufrufen: http://<service-admin-IP>:7291/swagger-ui.html#!/api-controller/cleanUpUsingPOST
   • Optional: Objekttyp angeben
   • Buttton Try it out! klicken

   Die Bereinigung wird sofort gestartet.

   Die Bereinigung erfolgt batchweise, die Batch-Größe ist über die Datei index-prod.yml aus dem Verzeichnis \config\ von yuuvis® RAD service-manager konfigurierbar: 

   osfts.cleanup.bulkSize: 1000

   • Tabellen

     Tabellen mit mehr als 20.000 Zeilen führen bei Reindexierungen zu Fehlern. Reindexierungen können beispielsweise auch bei Aktualisierungen von Elasticsearch notwendig sein.

     Diese Grenze ist über den Parameter osfts.tableRowSize der Datei index-prod.yml aus dem Verzeichnis \config\ von yuuvis® RAD service-manager festgelegt. Der Wert darf nicht erhöht werden.

   • Fehlerbehandlung

   Wenn Fehler bei Indexierungen auftreten, dann wird als Standard dreimal im Abstand von einer Stunde ein erneuter Versuch gestartet.

   Dieses Verhalten kann durch eine Konfiguration in der Datei index-prod.yml aus dem Verzeichnis \config\ von yuuvis® RAD service-manager geändert werden:

   routing:
     errorHandling:
       retry: 3
       periodInMinutes: 60
       startPolicy: "0 0/1 * ? * * *" 

   Parameter:

   retry	Anzahl der Versuche
   periodInMinutes	Abstand zwischen den Versuchen
   startPolicy	Zeitplan für Versuche in Cron-Notation

   • Linguistic Plugin

   Eine Sprache für das Linguistic Plugin wird bei der Installation von yuuvis® RAD service-manager angegeben. Über die Konfigurationsdatei index-prod.yml aus dem Verzeichnis \config\ von yuuvis® RAD service-manager kann eine andere Sprache aktiviert werden:

   osfts:
     languages: 'de'

   Geben Sie hier das Kürzel für die gewünschte Sprache an: Deutsch (de), Englisch (en), Französisch (fr), Spanisch (es) oder Italienisch (it). Lizenzen für mehrere und weitere Sprachen können von OPTIMAL SYSTEMS erworben und hier eingebunden werden.

   • Güte-Kriterien der Trefferlisten

   Als Standard verwendet yuuvis® RAD neben den Standard-Kriterien von Elasticsearch weitere Güte-Kriterien für die Sortierung von Trefferlisten. Beispielsweise werden Dokumente, die der Benutzer selbst bearbeitet hat und die Anzahl der Versionen einbezogen und höher gewichtet.

   Sie können dieses Scoring über die Konfigurationsdatei search-prod.yml auf die Standard-Kriterien von Elasticsearch beschränken:

   osfts:
     modify-score: false

   Sie können statt dessen das Scoring über Parameter anpassen:

   osfts:
     boost_mode: sum
     boost: 1.5

   boost_mode: Default: avg.

   boost: Default: 1.

   Informationen zu den Werten finden Sie in den Dokumentationen von Elasticsearch.

   • Strukturbaum / structureservice

   Komplexe Konfigurationen des Strukturbaums über den Service 'structureservice' können zu Fehlern führen.

   Ergänzen Sie gegebenenfalls die Konfigurationsdatei elasticsearch.yml aus dem Elasticsearch-Verzeichnis \config\ um folgenden Eintrag:

   indices.query.bool.max_nested_depth: 100

6. Starten Sie den Dienst Elasticsearch.
7. Konfigurieren Sie die Authentifizierung für Elasticsearch:
• Führen Sie die Batch-Datei elasticsearch-set-initial-passwords.bat aus dem Elasticsearch-Verzeichnis \bin\ mit administrativen Rechten aus.
• Öffnen Sie die Datei built-in.usr aus dem Elasticsearch-Verzeichnis \config\.
• Kopieren Sie das Passwort des Benutzers 'elastic'.
• Geben Sie das Passwort bei der Installation von yuuvis® RAD service-manager an.