Elasticsearch (OXID eShop)

Modulbeschreibung

Mit diesem Modul binden Sie die hochperformante Such- und Analytic-Engine "Elasticsearch" in die Suche Ihres OXID eShops ein. Das Modul erstellt täglich automatisch einen Index aller Artikel, bietet Ihren Kunden eine fehlertolerante, schnelle Suchfunktion und Ihnen die Möglichkeit bereits über die Suchfunktion bestimmte Artikel oder Hersteller besonders hervorzuheben.

Funktionsumfang

  • Suche ist fehlertolerant.

  • Direkte Suche nach Artikelnummern möglich.

  • Hochperformater Artikel-Index mit tägl. Export der Artikel.

  • Livesuche, sodass bei Eingabe des Suchbegriffs bereits passende Artikel angezeigt werden.

  • Anzeige von relevanten Kategorien und CMS-Seiten in der Livesuche.

  • Filtermöglichkeiten auf den Suchergebnis-Seiten:

    • Filter werden automatisch anhand der Artikel-Attribute aufgebaut.

    • Preisfilter & Mehrfachauswahl möglich.

  • Intuitiv bedienbares Backend mit folgenden Funktionen:

    • Synonym-Mapping

    • Antonym-Mapping

    • Category-Mapping: Suchbegriff X zeigt nur Artikel aus festgelegten Kategorien.

    • URL-Mapping: Suchbegriff leitet auf bestimmte URL um. Zum Beispiel CMS-Seite.

    • Artikel-Mapping: Anzeige von bestimmten Artikeln bei der Suche nach X.

    • Detaillierte Auswertung der Suchanfragen:

      • Was wurde wie oft gesucht?

      • Die Auswertung kann gut verwendet werden, um mögliche Aktionen oder Werbung festzulegen.

      • Welche Suchen haben keine Treffer erzielt? Hiermit können Sie das Synonym-Mapping optimieren.

      • Anzahl der Treffer. Hiermit können Sie prüfen, ob der Min-Score passend gesetzt ist. Werden häufig sehr viele Artikel gefunden, sollte dieser dann hoch gesetzt werden.

      • Export der Auswertung als PDF, Excel-Tabelle oder CSV-Datei

    • Hersteller- und Artikel-Boost: Hiermit können bestimmte Artikel gepusht werden.

Systemvoraussetzungen

PHP-Version

  • PHP 7.0

  • PHP 7.1

  • PHP 7.2

  • PHP 7.3

  • PHP 7.4

Webserver-Konfiguration

  • IonCube Loader (mind. v5.0)

Kompatibel mit den Themes

  • Flow

  • Wave

  • RoxIVE

Kompatibel mit den OXID Versionen

  • OXID CE/PE/EE 6.0.x bis 6.2.x

Elasticsearch

  • Ein separater Elasticsearch-Server, entweder lokal oder Extern, wird benötigt

  • Elasticsearch Version 5.6.x bis 6.4.x

Installation

Wir empfehlen für die Installation Ihre Wartungsseite zu aktivieren damit es zu keinen Problemen für Ihre Kunden kommt.

  1. Falls noch nicht geschehen, laden Sie bitte zunächst das digidesk Basis-Modul herunter und installieren Sie es gemäß der enthaltenen Installationsanleitung.

  2. Für dieses Modul erstellen Sie nun einen weiteren Unterordner "elasticsearch" im Ordner "packages/digidesk", in den die heruntergeladene Zip-Datei entpackt wird

  3. Führen Sie anschließend folgenden Befehl aus dem Hauptverzeichnis des Shopsystems aus:

    composer require digidesk/elasticsearch -n

  4. Nun kann das Modul im OXID eShop Admin aktiviert werden

  5. Ggf. Tmp- Verzeichnis leeren und Views neu generieren

  6. Geben Sie in den Moduleinstellungen Ihre Serverdaten an:

    1. In dem Feld Protokoll geben Sie das Übertragungsprotokoll für Ihren Elasticsearch-Server ein: Http / Https

    2. Bei Hostname müssen Sie die URL oder IP ihres Elasticsearch-Servers angeben.

    3. Unter Port tragen Sie den Port Ihres Elasticsearch-Servers ein, standardmäßig 9200.

    4. Falls Ihr Elasticsearch Server das X-Pack Plugin installiert hat und dadurch Passwortgeschützt ist, geben Sie unter Benutzername / Passwort die Login Daten an. Die Standard Logindaten sind Benutzername: elastic und Passwort: changeme

  7. Abschliessend müssen Sie den Artikelexport manuell starten, indem Sie folgenden Befehl aus dem Hauptverzeichnis des Shopsystems ausführen:

    php source/modules/digidesk/dd_elasticsearch/bin/cron.php --key IHR_CRONKEY

    Ersetzen Sie dabei IHR_CRONKEY durch den Key den Sie in den Modul-Einstellungen des Basis-Moduls definiert haben. Achten Sie dabei darauf, dass die auf der Kommandozeile verwendete PHP-Version der Version entspricht die in Ihrem Shop verwendet wird.

Danach können Sie die Wartungsseite wieder deaktivieren.

Für den automatischen täglichen Artikelexport muss auf Ihrem Server ein täglicher Cronjob eingerichtet werden, der den oben genannten Befehl ausführt.

Für crontab sieht der Eintrag folgendermaßen aus:

0 0 * * * /usr/bin/php /pfad/zu/ihrem/shop/source/modules/digidesk/dd_elasticsearch/bin/cron.php --key IHR_CRONKEY >/dev/null 2>&1

Dies startet den Artikelexport täglich um Mitternacht. Achten Sie darauf den Pfad zu dem Script anzupassen und /pfad/zu/ihrem/shop/ mit dem tatsächlichen Pfad zu Ihrem Shop auf dem Server zu ersetzen.

Update

Wir empfehlen für das Update ihre Wartungsseite zu aktivieren damit es zu keinen Problemen für Ihre Kunden kommt.

  1. Entpacken Sie die neue Modulversion in den Ordner "packages/digidesk/elasticsearch"

  2. Deaktivieren Sie das Modul im OXID eShop Admin

  3. Führen Sie anschließend folgenden Befehl aus dem Hauptverzeichnis des Shopsystems aus:

    composer update digidesk/elasticsearch

    Die Frage, ob die Dateien des Pakets überschrieben werden sollen, bestätigen Sie bitte mit "Y".

  4. Aktivieren Sie das Modul im OXID eShop Admin

  5. Ggf. Tmp- Verzeichnis leeren und Views neu generieren

  6. Abschliessend müssen Sie den Artikelexport manuell starten, indem Sie folgenden Befehl aus dem Hauptverzeichnis des Shopsystems ausführen:

    php source/modules/digidesk/dd_elasticsearch/bin/cron.php --key IHR_CRONKEY

    Ersetzen Sie dabei IHR_CRONKEY durch den Key den Sie in den Modul-Einstellungen des Basis-Moduls definiert haben. Achten Sie dabei darauf, dass die auf der Kommandozeile verwendete PHP-Version der Version entspricht die in Ihrem Shop verwendet wird.

Danach können Sie die Wartungsseite wieder deaktivieren.

Konfiguration

Nach der Installation des Moduls haben Sie verschiedene Möglichkeiten, das Modul nach Ihren Wünschen anzupassen. Im Navigationsmenü befindet sich der neue Reiter Elasticsearch. Ein Klick auf diesen öffnet das Modulmenü.

Das Modul ist nun aktiv. Ihre Besucher haben nun auch Zugriff auf verschiedene Filter, damit ihre Suchanfragen noch genauere Ergebnisse liefern.

Auswertung

  • Unter diesem Menü erhalten Sie eine ausführliche Auswertung der Suchanfragen. Besonders im Hinblick auf die weitere Optimierung des Moduls sind diese Daten sehr wichtig. Außerdem können Sie anhand dieser Daten besser einschätzen, welche Produkte in Ihrem Shop sehr beliebt sind.

  • Das Fenster "Top-Suchen" listet alle Suchen auf und sortiert diese nach Anzahl der Anfragen. Diese Ergebnisse können Sie als Excel-Tabelle, PDF-Dokument oder als CSV-Datei exportieren.

  • Daneben finden Sie "Suchen ohne Treffer". Hier sehen Sie alle Suchen, die Ergebnislos blieben. Wichtig wären diese beispielsweise für das Synonym-Mapping. Auch hier können Sie die Daten als Excel-Tabelle, PDF-Dokument oder als CSV-Datei exportieren.

  • Das Diagramm liefert Ihnen Informationen über die Anzahl der Treffer einzelner Suchbegriffe und den jeweils erreichten Such-Score. Diese Informationen helfen Ihnen dabei den Minimal-Score einzustellen.

Allgemeine Einstellungen

  • Mit der Konfiguration Minimal-Score legen Sie einen Score fest, der mindestens erreicht werden muss, damit ein Artikel in der Suche angezeigt wird. Behalten Sie erstmal den voreingestellten Wert bei. Wenn Sie merken, dass zu viele Produkte gefunden werden, sollten Sie diesen Wert nach oben korrigieren.

  • Die Livesuche-Einstellung aktiviert bzw. deaktiviert die Livesuche

  • Mit Varianten anzeigen können Sie Varianten von der Suche ausschliessen oder berücksichtigen.

  • Die Konfiguration Auswertung-Rhytmus gibt Ihnen die Möglichkeit festzulegen ob die Suchergebnisse für den Tag, Monat oder das Jahr zusammengefasst und ausgewertet werden soll. Je kleiner die Zeitspanne desto präziser die Auswertung - jedoch erhöht sich dadurch auch der benötigte Datenbank-Speicherplatz.

  • Außerdem können sie festlegen, wieviele Artikel in der Livesuche angezeigt werden sollen.

  • Die Maximale Artikel-Anzahl in der normalern Suche sowie in der Livesuche können Sie ebenfalls begrenzen.

  • Die Einstellung Kein Treffer gibt Ihnen die Möglichkeit einen eigenen Text zu verfassen, der Kunden angezeigt werden soll, wenn die Suche keine Ergebnis liefert.

  • Die Suche mit Autocomplete können Sie nach belieben aktivieren und deaktivieren. Dabei wird dem Kunden anhand des bisher eingegebenen Suchbegriffs ein Artikel vorgeschlagen. Siehe Bild:

  • Die Einstellung Suggest anzeigen gibt an ob eine Suche ohne Ergebnis ähnliche Suchbegriffe vorschlagen soll.

  • Mit der Filter-Verknüpfung stellen Sie ein, ob das Suchergebnis auf alle aktiven Filter passen muss (Und), oder ob die aktiven Filter unabhängig voneinander Suchergebnisse liefern (Oder).

  • Die Einstellungen alternativer Einstieg lässt Sie auswählen, ob und was Ihren Kunden angezeigt wird, wenn die Suche kein Ergebnis liefert.

  • Die Konfiguration Produkt-Attribut Berücksichtigung gibt Ihnen die Möglichkeit, verschiedene Attribute bei der Suche mit ein zu beziehen. Zum Beispiel können Sie die Farbe des Artikels zu 100% berücksichtigen, was dazu führt, dass die Suche nach "blaues Board" Boards mit dem Attribut "Farbe: blau" viel höher in der Suche anzeigen werden, als Boards, die keine blaue Farbe besitzen.

Boost Einstellungen

Hier können Sie Artikeln von bestimmten Herstellern einen Boost geben. Das bedeutet, dass alle Artikel dieses Herstellers weiter oben in den Suchergebnissen angezeigt werden. Ein Boostwert von 100 garantiert, dass die Artikel dieses Herstellers in den Suchergebnissen an erster Stelle stehen.

Mapping Einstellungen

Hier können Sie verschiedene Mapping-Einstellungen vornehmen und Suchbegriffe zusammenfassen, umleiten oder ausschließen. Die notwendigen Informationen über Suchbegriffe und Suchanfragen finden Sie unter dem Menüpunkt Auswertung in der Navigationsleiste des Admin-Bereichs.

  • Das Synonym Mapping gibt Ihnen die Möglichkeit verschiedene Suchbegriffe mit anderen zu verbinden. So können Sie Tippfehler von Kunden abfangen und trotzdem das richtige Ergebnis anzeigen.

  • Mithilfe des Antonym Mapping können Sie Begriffe anhand des eingegebenen Suchbegriffs ausschliessen.

  • Dank dem Kategorie Mapping haben Sie die Möglichkeit Kategorien an Suchbegriffe zu binden. Im unteren Beispiel werden dem Kunden alle Kategorien, die mit Kitesport zu tun haben angezeigt, wenn nach kite gesucht wird.

  • Mithilfe des URL Mapping können Sie eine Umleitung einrichten, die den Kunden bei Eingabe des bestimmten Suchbegriffs auf eine andere Seite weiterleitet.

  • Mit dem Artikel Mapping können Sie bestimmen, welche Artikel bei einer bestimmten Suche zusätzlich angezeigt werden.

Frontend Einstellungen

  • Mithilfe der Farb-Mapping Einstellungen können Sie die Farbfilter erweitern. Wenn Sie diese Einstellung einrichten, erscheint dem Kunden anstatt zB. dem text "Blau" ein Kästchen mit der gemappten Farbe in der Filterauswahl.

Hilfe & Support

Haben Sie Fragen oder benötigen Sie Hilfe bei der Installation? Gerne bieten wir Ihnen auch einen Installationsservice an. Kontaktieren Sie uns einfach über eine der unten stehenden Adressen.

Last updated