Premium Search Pro Shopware Plugin

OFFIZIELLE DOKUMENTATION AB VERSION 4.1.14

2

Inhaltsverzeichnis 1 Was ist Premium Search Pro ................................................................................................................................................ 3

1.1 Konfigurierbarer Modus .................................................................................................................................................. 3

2 Installation ............................................................................................................................................................................................ 4

2.1 Such-Index aufbauen .......................................................................................................................................................... 6

3 Schlüsselwort-Matching .............................................................................................................................................................. 7

4 Sucheinstellungen ............................................................................................................................................................................ 9

4.1 Allgemeine Einstellungen ................................................................................................................................................. 9

4.2 Relevanz anhand eines Beispiels erklärt ............................................................................................................. 10

4.3 Erweiterte Einstellungen ............................................................................................................................................... 12

5 Tabellenkonfiguration ............................................................................................................................................................... 16

5.1 Produkt-Attribute indexieren ................................................................................................................................... 18

6 Suchbegriff Modifizierung ....................................................................................................................................................... 21

6.1 Entfernen vom Bindestrich ......................................................................................................................................... 21

6.2 Entfernen von alleinstehenden Sonderzeichen ............................................................................................. 21

7 Module ................................................................................................................................................................................................ 25

8 Templates ......................................................................................................................................................................................... 26

8.1 Erstellen eines eigenen Template ........................................................................................................................... 27

8.1.1 Erstellen eines eigenen Template via Theme ...................................................................................... 27

8.1.2 Erstellen eines eigenen Template via Plugin ......................................................................................... 28

9 Dynamische Objekte ................................................................................................................................................................ 30

10 Zusätzliche Schlüsselwörter & weitere Einstellungen ........................................................................................ 31

11 Apache Solr ..................................................................................................................................................................................... 33

11.1 Installation von Apache Solr ...................................................................................................................................... 33

11.1.1 Installation von Apache Solr mit Docker ............................................................................................... 33

11.1.2 Installation von Apache Solr ohne Docker .......................................................................................... 35

11.2 Apache Solr auf einem externen Server ........................................................................................................... 37

11.3 Plugin Konfiguration mit Apache Solr ................................................................................................................. 37

12 Fragen .................................................................................................................................................................................................. 39

3

1 Was ist Premium Search Pro

Premium Search Pro ersetzt die Shopware Standard Suche. Die Grundfunktionen des Plugins sind sehr einfach verständlich. Die Erweiterung bietet eine Vielzahl an Konfigurations-Möglichkeiten. Dadurch lässt sich die Suche sehr gut individualisieren.

Ziel dieser Erweiterung ist, das Finden von Produkten für den Kunden so effizient und bequem wie möglich zu gestalten. Die Suchresultate sind bereits ohne spezifische Konfigurationen sehr präzise.

1.1 Konfigurierbarer Modus

Die Erweiterung kann in unterschiedlichen Modi genutzt werden:

- Datenbank Indexierung - Apache Solr - Lucene PHP (veraltet)

Der Vorteil der Datenbank Indexierung sowie von Lucene PHP ist eindeutig der geringe Konfigurationsaufwand, denn bei diesen Modi muss keine zusätzliche Konfiguration vorgenommen werden. Allerdings sollte die Datenbank Indexierung bevorzugt werden, da die Performance bei Lucene PHP nicht besonders hochstehend ist. Die Datenbank Indexierung sowie Lucene PHP sind geeignet für kleine bis mittelgrosse Produktanzahlen. Bei Shops mit einer Indexgrösse von 15'000 empfehlen wir Apache Solr zu verwenden, da Apache Solr die beste Skalierbarkeit aufweist. Premium Search Pro eignet sich für Shopware Shops mit einer Produktzahl unter 30'000. Falls Sie mehr Produkte haben empfehlen wir den Einsatz von Elasticseaerch1.

Der Modus Apache Solr ist aus Sicht der Performance definitiv der beste Modus. Der minimale Nachteil bei Apache Solr ist der grössere Konfigurationsaufwand. Sie können Apache Solr auf zwei unterschiedliche Varianten nutzen:

- Installation auf dem gleichen Server, eine lokale Installation - Installation auf einem externen Server

Wir werden die Installation von Apache Solr im Kapitel Apache Solr erklären.

1 https://developers.shopware.com/sysadmins-guide/elasticsearch-setup/

4

2 Installation

Um das Plugin zu installieren, öffnen Sie einfach den Reiter Einstellungen und wählen Sie Plugin-Manager aus.

Klicken Sie auf den Menüpunkt Installiert.

Geben Sie in das Suchfeld «Premium Search Pro» ein. Klicken Sie auf das grüne Symbol mit dem Plus. Durch das klicken dieses Buttons wird die Erweiterung installiert.

Klicken Sie anschliessend auf den Button Aktivieren. Nachdem der Aktivierungs-Prozess abgeschlossen ist, haben Sie das Plugin bereits erfolgreich installiert.

Im Fenster, das zurzeit geöffnet ist, können Sie die Konfiguration der Erweiterung vornehmen. In der folgenden Tabelle sehen Sie alle Konfigurationsmöglichkeiten. Die meisten Felder sind nur relevant, falls Sie Apache Solr nutzen wollen.

Feld Beschreibung Daten bei Neuinstallation / Deinstallation löschen

Falls Sie bei diesem Feld die Option Ja selektiert haben, werden alle Daten der Erweiterung bei einer Neuinstallation / Deinstallation gelöscht.

Such Modus In diesem Feld können Sie den Such Modus festlegen. Wie zuvor beschrieben können Sie hier zwischen «Datenbank Indexierung», «Apache Solr» und «Lucene PHP» wählen.

Datei-Indexierung aktivieren Dieses Feature ist nur für die Datenbank Indexierung verfügbar. Falls Sie dieses Feature aktivieren ist die Performance der Indexierung etwas besser.

Abbildung 2.1 - Der Plugin Manager ist unter dem Menü-Reiter zu finden.

Abbildung 2.2 - Premium Search Pro im Plugin-Manager.

5

Apache Solr Schema Modus Wählen Sie den Apache Solr Schema Modus. Dieses Feld ist nur relevant, falls Sie Apache Solr nutzen.

Apache Solr Host In diesem Feld müssen Sie die URL zu Ihrer Apache Solr Instanz festlegen. Falls Sie eine lokale Apache Solr Installation haben, können Sie http://localhost bzw. https://localhost eintragen. Dieses Feld ist nur relevant, falls Sie Apache Solr nutzen.

Apache Solr Port In diesem Feld müssen Sie den Port zu Apache Solr festlegen. Dieses Feld ist nur relevant, falls Sie Apache Solr nutzen.

Apache Solr Benutzername Geben Sie in diesem Feld den Benutzernamen für Apache Solr ein. Falls Sie keine Authentifizierung für Apache Solr verwenden, können Sie dieses Feld leer lassen. Dieses Feld ist nur relevant, falls Sie Apache Solr nutzen.

Apache Solr Passwort Geben Sie in diesem Feld das Passwort für Apache Solr ein. Falls Sie keine Authentifizierung für Apache Solr verwenden, können Sie dieses Feld leer lassen. Dieses Feld ist nur relevant, falls Sie Apache Solr nutzen.

Apache Solr Pfad Geben Sie in diesem Feld den Pfad zum Produkte-Kern an. In den meisten Fällen können Sie das Feld mit folgendem Wert ausfüllen: /solr/(NameDesKerns). Wobei (NameDesKerns) mit dem Namen des Kerns ausgetauscht werden muss. Dieses Feld ist nur relevant, falls Sie Apache Solr nutzen.

Apache Solr Pfad für Module Geben Sie in diesem Feld den Pfad zum Module-Kern an. In den meisten Fällen können Sie das Feld mit folgendem Wert ausfüllen: /solr/(NameDesKerns). Wobei (NameDesKerns) mit dem Namen des Kerns ausgetauscht werden muss. Dieses Feld ist nur relevant, falls Sie Apache Solr nutzen.

Cron Job Modus Wählen Sie Ihren gewünschten Cron Job Modus.

Tabelle 2.1 - Auflistung aller Konfigurations-Möglichkeiten.

Die Erweiterung funktioniert bereits mit den Standard-Einstellungen. Das heisst, dass die Erweiterung bereits einsatzbereit ist, ohne eine Änderung an der Konfiguration vorzunehmen.

Damit Ihre Kunden im Frontend nach Produkten suchen können, müssen Sie nun noch den Suchindex aufbauen.

6

2.1 Such-Index aufbauen

Gehen Sie im Backend auf den Reiter Einstellungen und klicken Sie im Menü auf den Eintrag Premium Search Pro. Im darauf erscheinenden Fenster befinden sich am unteren Fensterrand zwei Buttons, Komplette Suchindexierung neu aufbauen und Suchindexierung neu aufbauen.

Button Beschreibung Komplette Suchindexierung neu aufbauen Mit diesem Button können Sie die komplette

Suchindexierung neu aufbauen. Dies eignet sich bei der erstmaligen Installation der Erweiterung.

Suchindexierung neu aufbauen Mit diesem Button werden nur die geänderten Produkte neu indexiert. Das heisst, wenn Sie im Backend die Daten eines bestimmten Produkts ändern, dann wird nur der Index dieses Produkt neu aufgebaut. Achtung, nur Änderungen, die über Doctrine durchgeführt werden, werden vom System registriert. Wenn externe Änderungen direkt über die Datenbank oder per API durchgeführt werden, werden diese Änderungen nicht registriert. Damit diese Änderungen ebenfalls indexiert werden, muss der komplette Suchindex neu aufgebaut werden.

Tabelle 2.2 - Beschreibung der beiden Buttons.

Logischerweise müssen Sie bei einer Erstinstallation den Button Komplette Suchindexierung neu aufbauen klicken. Es erscheint ein Dialog-Fenster. Bei der Stapelgrösse empfehlen wir die Option 1500. Klicken Sie anschliessend auf den Button Vorgang starten. Die Zeit für das Aufbauen des kompletten Suchindex ist abhängig von der Produkteanzahl Ihres Shops sowie der Rechenpower Ihres Servers. Nachdem der Index komplett aufgebaut wurde, kann das Plugin bereits genutzt werden. Gehen Sie ins Frontend Ihres Shops und geben Sie einige Suchbegriffe ein.

Abbildung 2.1 - Die Buttons um den Suchindex neu aufzubauen.

Abbildung 2.2 - Das Dialog-Fenster, um den Suchindex neu aufzubauen.

7

3 Schlüsselwort-Matching

Wer kennt das nicht? Der Kunde gibt einen Produktnamen, eine Kategorie oder einen Hersteller in der Shop-Suche ein und dabei erhält er ein unbefriedigendes Suchergebnis.

In den meisten Fällen passiert dies aufgrund einer falschen Schreibweise oder der Verwendung von Synonymen. Auch wenn nach der Mehrzahl gesucht wird, erhält der Kunde oft kein Ergebnis (beispielsweise T-Shirts anstatt T-Shirt).

Hierfür bieten wir mit dem Schlüsselwort-Matching eine einfache und effiziente Lösung. Sie können mithilfe des Schlüsselwort-Matching bestimmte Suchbegriffe umleiten. Beispielsweise können Sie Trasher zu Thrasher umleiten. Wenn nun der Kunde im Frontend nach Trasher sucht, wird der Suchalgorithmus automatisch nach Thrasher suchen. Dabei erfährt der Kunde nie etwas davon.

Falsch geschriebener Begriff Korrigierter Begriff Beschreibung Snoboard Snowboard Wenn ein Kunde im

Frontend nach Snoboard sucht, wird der Suchalgorithmus automatisch nach Snowboard suchen.

Trasher Thrasher Wenn ein Kunde im Frontend nach Trasher sucht, wird der Suchalgorithmus automatisch nach Thrasher suchen.

Tabelle 3.1 - Beispiele von Schlüsselwort-Matchings.

Mit dem Key Feature Schlüsselwort-Matching können Sie nun alle Suchanfragen, die nicht korrekt waren, ganz einfach und effizient auf die richtigen Schlüsselwörter umleiten. Dies erleichtert das Einkaufserlebnis Ihrer Kunden und steigert somit Ihren Umsatz durch effizientere Trefferquoten.

Abbildung 3.1 - Das Schlüsselwort-Matching.

8

Die Übersicht der gesuchten Schlüsselwörter kann auch für Analyse-Zwecke genutzt werden. Die Spalten Durchschnittliche Produkteanzahl sowie die Anzahl der Suchanfragen sind wichtige Daten für die Analyse Ihres Shops. Wenn beispielsweise viele Kunden nach dem Begriff Snowboard suchen, Sie allerdings keine Snowboards im Sortiment haben, könnte die Anschaffung von Snowboards für Sie sehr interessant sein.

9

4 Sucheinstellungen

In den Sucheinstellungen können Sie die Suche nach Ihren Wünschen gestalten. In den folgenden Abschnitten werden wir die einzelnen Einstellungsmöglichkeiten genau erläutern.

4.1 Allgemeine Einstellungen

In den Allgemeinen Einstellungen haben Sie die Möglichkeit bestimmte Daten-Felder in der Suche zu inkludieren bzw. zu exkludieren. Die Erweiterung bietet Ihnen die Möglichkeit weitere Daten-Felder in die Suche zu integrieren. Dies können Sie im Reiter Tabellenkonfiguration vornehmen. Weitere Informationen zu diesem Feature finden Sie im Kapitel Tabellenkonfiguration.

Art Beschreibung Artikelbezeichnung inkludieren Wenn aktiviert, wird die Artikelbezeichnung

indexiert. Das heisst, dass im Frontend nach der Artikelbezeichnung gesucht werden kann.

Artikelnummer inkludieren Wenn aktiviert, wird die Artikelnummer indexiert. Das heisst, dass im Frontend nach der Artikelnummer gesucht werden kann.

Herstellername inkludieren Wenn aktiviert, wird der Herstellername indexiert. Das heisst, dass im Frontend nach dem Herstellernamen gesucht werden kann.

Artikeleigenschaften inkludieren Wenn aktiviert, werden die Artikeleigenschaften indexiert. Das heisst, dass im Frontend nach den Artikeleigenschaften gesucht werden kann.

Konfigurator-Optionen inkludieren Wenn aktiviert, werden die Konfigurator-Optionen indexiert. Das heisst, dass im Frontend nach den Konfigurator-Optionen gesucht werden kann. Die Konfigurator-

Abbildung 4.1 - Die Sucheinstellungen.

10

Optionen sind die Optionen von Varianten, z.B. Blau, Grün, S, M, XL etc.

Kategorienname inkludieren Wenn aktiviert, wird der Kategorienname indexiert. Das heisst, dass im Frontend nach dem Kategoriennamen gesucht werden kann.

Kategorienpfad inkludieren Wenn aktiviert, wird der Kategorienpfad indexiert. Das heisst, dass im Frontend nach dem Kategorienpfad gesucht werden kann. Der Kategorienpfad besteht aus allen Elternkategorien z.B. Deutsch – Bekleidung – T-Shirts. Nun werden alle diese Kategorien indexiert.

Kurzbeschreibung inkludieren Wenn aktiviert, wird die Kurzbeschreibung der Produkte indexiert. Das heisst, dass im Frontend nach der Kurzbeschreibung gesucht werden kann. Achtung, dies kann die Indexierungs-Zeit verlangsamen, da die Kurzbeschreibung meist aus vielen Wörtern besteht. Zusätzlich kann dieses Feld unerwartete Ergebnisse liefern, da die Kurzbeschreibung teilweise Wörter beinhaltet die nicht zwingend zum jeweiligen Produkt passen.

Beschreibung inkludieren Wenn aktiviert, wird die Beschreibung der Produkte indexiert. Das heisst, dass im Frontend nach der Beschreibung gesucht werden kann. Achtung, dies kann die Indexierungs-Zeit verlangsamen, da die Beschreibung meist aus vielen Wörtern besteht. Zusätzlich kann dieses Feld unerwartete Ergebnisse liefern, da die Kurzbeschreibung teilweise Wörter beinhaltet die nicht zwingend zum jeweiligen Produkt passen.

Tabelle 4.1 - Die Übersicht der allgemeinen Einstellungen.

Alle Daten-Felder haben eine zugewiesene Relevanz. Standardmässig hat die Artikelbezeichnung die Relevanz 100. Alle Wörter in der Artikelbezeichnung werden nun mit der Relevanz 100 indexiert. Des Weiteren hat der Herstellername eine Relevanz von 90. Alle Wörter im Hersteller Daten-Feld werden nun mit der Relevanz 90 indexiert.

4.2 Relevanz anhand eines Beispiels erklärt

In diesem Abschnitt erklären wir die Relevanz anhand eines Beispiels. Der Index besteht in diesem Beispiel lediglich aus drei Produkten.

11

Produkt A

Daten-Feld Inhalt Relevanz Artikelbezeichnung Astral 100 Herstellername Alien Workshop 90 Eigenschaften Joey Guevara Astral 80 Kategorienname Decks 80

Tabelle 4.2 - Die Daten von Produkt A.

Produkt B

Daten-Feld Inhalt Relevanz Artikelbezeichnung Magazine Logo T-Shirt 100 Herstellername Thrasher 90 Eigenschaften Vorne Crew Regular Fit Solid 80 Kategorienname T-Shirts 80

Tabelle 4.3 - Die Daten von Produkt B.

Produkt C

Daten-Feld Inhalt Relevanz Artikelbezeichnung Solid BB Hood 100 Herstellername Adidas 90 Eigenschaften Vorne Herren Solid BB S 80 Kategorienname Hoodies 80

Tabelle 4.4 - Die Daten von Produkt C.

Die folgende Tabelle stellt den Index in vereinfachter Form dar. Jedem Schlüsselwort sind die jeweiligen Produkte zugewiesen mit der korrekten Relevanz. Falls ein Schlüsselwort in einem Produkt mehrmals vorkommt, wird die Relevanz summiert. In diesem Beispiel haben die Schlüsselwörter Thrasher, Vorne und Solid mehrere zugewiesene Produkte.

Schlüsselwort Produkte Relevanz Astral Produkt A 180 (100 + 80) Alien Produkt A 90 Workshop Produkt A 90 Joey Produkt A 80 Guevara Produkt A 80 Decks Produkt A 80 Magazine Produkt B 100 Logo Produkt B 100 T-Shirt Produkt B 100 Thrasher Produkt B 90

Produkt C 90 Vorne Produkt B 80

Produkt C 80 Crew Produkt B 80

12

Regular Produkt B 80 Fit Produkt B 80 Solid Produkt B 100

Produkt C 180 (100 + 80) T-Shirts Produkt B 80 BB Produkt C 180 (100 + 80) Hood Produkt C 100 Adidas Produkt C 90 Herren Produkt C 80 S Produkt C 80 Hoodies Produkt C 80

Tabelle 4.5 - Die vereinfachte Übersicht des Produkteindex.

In der nachfolgenden Tabelle sehen Sie eine Übersicht von verschiedenen Suchabfragen.

Suchbegriff Produkte Relevanz Astral Produkt A 180 Thrasher Produkt B 90

Produkt C 90 Thrasher Crew Produkt B 170 (90 + 80) Thrasher Hoodies Produkt C 170 (90 + 80) Thrasher Vorne Produkt B 170 (90 + 80)

Produkt C 170 (90 + 80) Tabelle 4.6 - Die Übersicht von verschiedenen Suchabfragen.

In diesem Beispiel können Sie die Auswirkung der Relevanz-Werte sehen. Falls Sie die Relevanz eines bestimmten Daten-Feldes ändern, wird sich die Relevanz der Produkte ebenfalls ändern. Die Relevanz hat Auswirkung auf die Sortierung der Produkte, falls der Kunde den Sortierungsmodus Beste Ergebnisse ausgewählt hat.

4.3 Erweiterte Einstellungen

In den erweiterten Einstellungen können Sie das Verhalten der Suche festlegen. Dabei haben eine Vielzahl an verschiedenen Einstellungsmöglichkeiten. In der nachfolgenden Tabelle werden wir die einzelnen Felder genau erläutern.

Feld Beschreibung Standard Sortierungs-Modus Mit diesem Feld können Sie den Standard

Sortierungs-Modus festlegen. Standardmässig ist der Modus Beste Ergebnisse aktiviert. Dieser Modus sortiert nach der Relevanz. Alle anderen Modi berücksichtigen die Relevanz nicht.

Varianten Modus Legen Sie den Varianten Modus fest. Beispiel Szenario: Ein Kunde sucht nach T-Shirts Schwarz.

13

Beispiel Artikel: T-Shirt mit Farbvarianten: Weiss (Hauptvariante), Schwarz, Blau, Grün. Option Ausblenden: Der Beispielartikel wird ausgeblendet, weil die Hauptvariante (Weiss) nicht schwarz ist. Option Tiefe Relevanz: Der Beispielartikel wird am Schluss des Listings angezeigt, wenn der Kunde den Sortierungsmodus Beste Ergebnisse selektiert hat. Option Anzeigen: Der Beispielartikel wird normal dargestellt.

Livesuche Suchverzögerung Legen Sie die Suchverzögerung in der Livesuche fest. Dieser Wert muss in Millisekunden angegeben werden. Wenn der Kunde einen Suchbegriff eingibt wird x Millisekunden gewartet bevor die Suchabfrage gesendet wird. Wenn der Wert zu tief ist, werden zu viele Suchanfragen gesendet, besonders für langsame Schreiber kann das mühsam sein.

Anzahl der Ergebnisse in der Livesuche Legen Sie die Anzahl der Ergebnisse in der Livesuche fest. Die Produkte werden in der Livesuche nach der Relevanz sortiert. Somit werden die x relevantesten Produkte dargestellt.

Anzahl der Ergebnisse in der Livesuche (Mobile)

Legen Sie die Anzahl der Ergebnisse in der Livesuche fest. Dieses Feld bezieht sich auf mobile Geräte. Die Produkte werden in der Livesuche nach der Relevanz sortiert. Somit werden die x relevantesten Produkte dargestellt.

Boost Live Suche freischalten Wenn selektiert ist die Live Suche wesentlich schneller. Wichtiger Hinweis: Wenn Sie diesen Modus aktivieren, werden keine Plugins geladen. Falls Sie Plugins installiert haben, welche die Live Suche betreffen, empfehlen wir die normale Live Suche zu verwenden, also dieses Feld nicht zu selektieren. In diesem Modus wird die Live Suche in einem minimalen Boot aufgerufen. In unseren Tests wurde die Suche dadurch bis zu 10x schneller.

14

Beim Speichern der Einstellungen wird die Lauffähigkeit dieses Modus geprüft. Falls die Lauffähigkeit nicht gewährleitet wird, wird der Modus automatisch wieder deaktiviert. Die Lauffähigkeit dieses Modus ist abhängig von den installierten Plugins. Dieser Modus ist nicht mit allen Plugins kompatibel.

Apache Solr Status Dieses Feld stellt den aktuellen Status von Apache Solr dar. Dieses Feld ist nur relevant, falls Sie Apache Solr nutzen.

Varianten Aufsplittung aktivieren Legen Sie das Verhalten der Varianten-Aufsplittung fest. Falls Sie dieses Feature aktivieren, werden die Varianten im Frontend aufgesplittet. Dadurch werden alle Varianten der gefundenen Produkte dargestellt.

UND Suchlogik verwenden Bei der UND Suchlogik müssen alle Suchbegriffe im Produkteindex vorhanden sein, damit die Produkte gefunden werden. Wenn der Kunde T-Shirts Blau eingibt, dann müssen die Produkte die Schüsselwörter T-Shirts sowie Blau beinhalten. Wenn die Produkte nur eines der beiden Schlüsselwörter beinhalten werden Sie nicht angezeigt. Bei der ODER Suchlogik muss nur mindestens ein Schlüsselwort vorhanden sein. Das heisst bei der Suche nach T-Shirts Blau, werden T-Shirts dargestellt und zusätzlich alle blauen Produkte.

UND Suchlogik für Module verwenden Bei der UND Suchlogik für Module müssen alle Suchbegriffe im Modulindex vorhanden sein, damit die Module gefunden werden. Wenn der Kunde Thrasher T-Shirts eingibt, dann müssen die Module die Schüsselwörter Thrasher sowie T-Shirts beinhalten. Wenn die Module nur eines der beiden Schlüsselwörter beinhalten werden Sie nicht angezeigt. Bei der ODER Suchlogik muss nur mindestens ein Schlüsselwort vorhanden sein. Das heisst bei der Suche nach Thrasher T-Shirts, wird der Hersteller Thrasher sowie die Kategorie T-Shirts dargestellt.

Ungenaue Treffer freischalten Aktivieren Sie ungenaue Treffer. Dadurch sucht der Suchalgorithmus nach ungenauen Treffern. Bei ungenauen Treffern können falsch geschriebene Suchbegriffe zu Resultaten

15

führen. Wenn ein Kunde T-Sihrts anstatt T-Shirts schreibt, werden trotzdem T-Shirts dargestellt, weil der Suchalgorithmus eine Ähnlichkeit in den Suchbegriffen entdeckt. Dieses Feature kann die Performance in der Datenbank Indexierung negativ beeinträchtigen. Falls Sie ungenaue Treffer nutzen freischalten wollen, überlegen Sie sich Apache Solr zu nutzen.

Platzhalter Treffer freischalten Schalten Sie Platzhalter Treffer frei. Wenn ein Kunde nach einem Tisch sucht und er den Suchbegriff Tisc eingibt, dann sucht die Platzhalter Suche nach Tisc*.

Minimale Ähnlichkeit für ungenaue Treffer in %

Legen Sie die minimale Ähnlichkeit für ungenaue Treffer fest. Je höher der Wert umso genauer werden die Resultate. Das heisst aber gleichzeitig, dass falsch geschriebene Suchbegriffe weniger berücksichtigt werden. Bei einer minimalen Ähnlichkeit von 90%, müssen die Suchbegriffe zu 90% übereinstimmen.

Minimale Relevanz für Platzhalter Treffer Legen Sie die minimale Relevanz von Platzhalter Treffern fest.

Alle Varianten indexieren Legen Sie fest, ob alle Varianten indexiert werden sollen oder nicht. Nicht bedeutet, dass nur die Hauptvarianten indexiert werden. Falls Sie nur die Hauptvarianten indexieren kann dies eine erhebliche Performance-Verbesserung bewirken.

Tabelle 4.7 - Die Übersicht der erweiterten Einstellungen.

16

5 Tabellenkonfiguration

Die Tabellenkonfiguration kann genutzt werden, um weitere Daten-Felder in den Suchindex zu inkludieren. Im Reiter Tabellenkonfiguration sehen Sie die Bereiche Eigene Tabellen und Zusätzliche Suchfelder. Im Bereich Eigene Tabellen haben Sie die Möglichkeit weitere Tabellen in den Index Prozess aufzunehmen. Die Tabelle allein hat allerdings noch keinen Einfluss auf den Suchindex. Damit Sie den Suchindex beeinflussen können, müssen Sie noch zusätzliche Suchfelder hinzufügen. Sobald Sie eine eigene Tabelle erstellt haben, sind alle Felder dieser bestimmten Tabelle im Dropdown-Menü Feld wählen verfügbar. Mit dem Klicken auf einen Eintrag im Dropdown-Menü, wird das jeweilige Daten-Feld automatisch zur Liste der Zusätzliche Suchfelder hinzugefügt. Durch den Doppelklick mit der linken Maustaste, können Sie einen bestimmten Listen-Eintrag modifizieren. Im folgenden Abschnitt erklären wir die Bereiche Eigene Tabellen sowie Zusätzliche Suchfelder Schritt für Schritt. Um die Tabellenkonfiguration nutzen zu können, werden MySQL-Kenntnisse vorausgesetzt. Bei Fragen helfen wir Ihnen natürlich gerne weiter.

In der folgenden Tabelle werden alle Spalten der Eigenen Tabellen tabellarisch beschrieben.

Spalte Beschreibung Tabelle Legen Sie den Namen der Tabelle fest. Diese

Tabelle muss in der Datenbank existieren. Achten Sie auf die korrekte Schreibweise der Tabelle.

Alias Legen Sie den Alias der Tabelle fest. Der Alias sollte einzigartig sein, also achten Sie darauf, dass Sie keine doppelten Aliase vergeben.

Bedingung Legen Sie die Join-Bedingung fest. Die festgelegte Zeichenkette wird dynamisch im ON Bereich des Joins verwendet.

Abbildung 5.1 - Die Tabellenkonfiguration.

17

Art Legen Sie die Art des Joins fest. Folgende Optionen können ausgewählt werden: LEFT JOIN, INNER JOIN, RIGHT JOIN.

Priorität Legen Sie die Priorität der Tabelle fest. Falls eine Tabelle abhängig ist von einer anderen Tabelle, muss die abhängige Tabelle eine tiefere Priorität besitzen, weil diese Tabelle zuerst im SQL-Statement vorkommen muss.

Aktiv Falls Sie eine Tabelle deaktivieren wollen, können Sie die jeweilige Tabelle über diese Spalte deaktivieren. Dies hat den Vorteil, dass Sie den Eintrag nicht komplett löschen müssen.

Tabelle 5.1 - Die Spalten der eigenen Tabellen.

In der nachfolgenden Tabelle werden alle Spalten der Zusätzlichen Suchfelder tabellarisch dargestellt.

Spalte Beschreibung Tabelle In dieser Spalte wird der Name der

abhängigen Tabelle dargestellt. Alias In dieser Spalte wird der Alias der abhängigen

Tabelle dargestellt. Feld In dieser Spalte wird der Name des Tabellen-

Feldes dargestellt. Alias Legen Sie den Alias des Suchfeldes fest. Dieser

Wert sollte einzigartig sein, also achten Sie darauf, dass Sie keine doppelten Alias festlegen.

Aktiv Falls Sie ein bestimmtes Suchfeld deaktivieren wollen, können Sie das jeweilige Suchfeld über diese Spalte deaktivieren. Dies hat den Vorteil, dass Sie den Eintrag nicht komplett löschen müssen.

Indexierung aktiv Aktivieren Sie die Indexierung für dieses Suchfeld. Wenn aktiviert, wird der Inhalt dieses Suchfeldes indexiert. Dadurch kann nach dem Inhalt dieses Feldes gesucht werden.

In Meta-Daten speichern Speichern Sie den Inhalt dieses Feldes in den Metadaten. Dadurch können Sie dieses Feld im Frontend auslesen. Dies ist nützlich, wenn Sie ein eigenes Template für die Suche schreiben. Weitere Informationen über Templates finden Sie im Kapitel Templates.

18

Relevanz Legen Sie die Relevanz dieses Feldes fest. Der Inhalt dieses Feldes wird mit der festgelegten Relevanz indexiert. Dieses Feld ist nur relevant, falls Sie die Indexierung dieses Feldes aktiviert haben.

Übersetzung-Art Legen Sie die Art der Übersetzung fest. Dieses Feld kann genutzt werden, um Übersetzungen ebenfalls zu indexieren. Falls Sie nicht wissen, wie die Übersetzungs-Art lautet, finden Sie möglicherweise weitere Informationen in der Shopware Standard Tabelle s_core_translations. Das relevante Tabellen-Feld ist objecttype.

Übersetzung-Feld Legen Sie das Feld der Übersetzung fest. Dieses Feld kann genutzt werden, um Übersetzungen ebenfalls zu indexieren. Falls Sie nicht wissen, wie das Übersetzungs-Feld lautet, finden Sie möglicherweise weitere Informationen in der Shopware Standard Tabelle s_core_translations. Das relevante Tabellen-Feld ist objectdata.

Übersetzung-Referenz Feld Wählen Sie das passende Referenzfeld fest für die Übersetzung. In den meisten Fällen handelt es sich um eine ID. Der Inhalt des Referenzfeldes sollte mit dem objectkey der Tabelle s_core_translations übereinstimmen.

Tabelle 5.2 - Die Spalten der zusätzlichen Suchfelder.

Damit Sie ein besseres Verständnis für die Tabellenkonfiguration bekommen, stellen wir Ihnen einige Beispiele zur Verfügung.

5.1 Produkt-Attribute indexieren

In diesem Beispiel zeigen wir, wie Produkt-Attribute indexiert werden können. In der nachfolgenden Tabelle sehen Sie die passende Konfiguration der Eigenen Tabellen. Damit Sie dieses Beispiel in Ihrem Shop einbauen können, müssen Sie den Button Tabelle hinzufügen klicken. Sie finden diesen Button in der Liste Eigene Tabellen.

Abbildung 5.2 - Bildliche Darstellung der eigenen Tabellen für das Beispiel.

19

Spalte Inhalt Beschreibung Tabelle s_articles_attributes Diese Tabelle beinhaltet alle

zusätzlichen Attribute von Produkten. Das ist eine Shopware Standard Tabelle.

Alias productAttributes Wir legen einen Alias für die Tabelle fest. Dieser Alias sollte eindeutig sein.

Bedingung product.id = productAttributes.articleID Wir wollen die Attribute des jeweiligen Produktes erhalten.

Art INNER JOIN Wir wollen einen INNER JOIN durchführen.

Priorität 1 Wir legen eine Priorität von eins fest.

Aktiv Ja Wir wollen diese Tabelle aktivieren.

Tabelle 5.3 - Ein Beispiel-Konfiguration für Produkte Attribute.

Mit dieser Konfiguration wird allerdings noch nichts Neues indexiert. Damit die Attribute indexiert werden, müssen wir die passenden Felder in den zusätzlichen Suchfeldern hinzufügen. Wählen Sie im Dropdown-Menü Feld wählen, productAttributes.attr1 (s_articles_attributes). Sobald Sie diesen Eintrag ausgewählt haben, wird automatisch ein neuer Eintrag zur Liste der zusätzlichen Suchfelder hinzugefügt. Mithilfe eines Doppelklicks, mit der linken Maustaste, können Sie den Eintrag bearbeiten.

Spalte Inhalt Beschreibung Tabelle s_articles_attributes Der Name der abhängigen

Tabelle. Alias productAttributes Der Alias der abhängigen

Tabelle. Feld attr1 Der Name des Feldes. Aktiv Ja Wir wollen das Feld

aktivieren. Indexierung aktiv Ja Wir wollen die Indexierung

aktivieren, damit der Kunde im Frontend nach dem Attribute suchen kann.

In Meta-Daten speichern

Ja Wir wollen den Inhalt dieses Feldes in den Metadaten speichern. Dadurch können wir den Inhalt dieses Attributes im Template

Abbildung 5.3 - Bildliche Darstellung der zusätzlichen Suchfelder für das Beispiel.

20

darstellen, falls wir ein eigenes Template verwenden.

Relevanz 10 Der Inhalt dieses Feldes wird mit der Relevanz von 10 indexiert.

Übersetzung-Art article Wir legen die Art der Übersetzung fest.

Übersetzung-Feld __attribute_attr1 Wir legen das Feld der Übersetzung fest.

Übersetzung-Referenz Feld

productAttributes.id (s_articles_attributes)

Wir legen das Referenzfeld der Übersetzung fest.

Tabelle 5.4 - Ein Beispiel-Konfiguration für Produkte Attribute.

Auf die genau gleiche Weise können Sie nun weitere Attribute hinzufügen. Beispielsweise können Sie nun das 12. Attribut hinzufügen, indem Sie den Eintrag productAttributes.attr12 (s_articles_attributes) auswählen.

21

6 Suchbegriff Modifizierung

Mit der Suchbegriff Modifizierung haben Sie die Möglichkeit mithilfe von regulären Ausdrücken die Indexierung bzw. Suchbegriffe zu modifizieren. Mit diesem Feature haben Sie die Möglichkeit gewisse Zeichen aus der Indexierung bzw. aus Suchbegriffen zu entfernen. Nachfolgend werden wir die beiden Standard-Einträge genauer erläutern.

Falls Sie weitere Einträge hinzufügen wollen, können Sie dies mit Klicken des Buttons Eintrag hinzufügen erreichen.

6.1 Entfernen vom Bindestrich

In diesem Abschnitt erläutern wir den ersten Eintrag. Dieser Eintrag ist zuständig, um alle Bindestriche in Wörtern zu ersetzen mit einem Leerzeichen. Dies hat zur Folge, dass die Wörter mit einem Bindestrich in zwei separate Wörter geteilt werden. Beispielsweise wird dieses Wort Hello-World in Hello und World geteilt.

Spalte Inhalt Beschreibung Suchmuster /-/ Der reguläre Ausdruck sucht

nach allen Bindestrichen in den Zeichenketten.

Ersetzen durch {$SPACE} Alle gefunden Bindestriche werden durch ein Leerzeichen ersetzt.

Modifikatoren i Mit diesem Modifikator wird die Gross- und Kleinschreibung nicht beachtet.

Art Beides Wir legen fest, dass in der Indexierung sowie in der Suche, der Bindestrich mit einem Leerzeichen ersetzt wird.

Aktiv Ja Damit dieser Eintrag Einfluss auf die Indexierung sowie auf die Suche hat, wird dieser Eintrag aktiviert.

Position 1 Wir legen eine Position von eins fest.

Tabelle 6.1 - Die tabellarische Übersicht des ersten Eintrages.

6.2 Entfernen von alleinstehenden Sonderzeichen

In diesem Abschnitt erklären wir den zweiten Eintrag. Dieser Eintrag ist zuständig, um alle alleinstehenden Sonderzeichen zu entfernen. Dies hat zur Folge, dass folgende alleinstehende Zeichen entfernt werden: &, /, % etc.

Spalte Inhalt Beschreibung

22

Suchmuster /\s+[^\w]+\s+/ Der reguläre Ausdruck sucht nach allen alleinstehenden Sonderzeichen in den Zeichenketten.

Ersetzen durch {$SPACE} Alle gefunden alleinstehenden Sonderzeichen werden durch ein Leerzeichen ersetzt.

Modifikatoren i Mit diesem Modifikator wird die Gross- und Kleinschreibung nicht beachtet.

Art Beides Wir legen fest, dass in der Indexierung sowie in der Suche, die alleinstehenden Sonderzeichen mit einem Leerzeichen ersetzt werden.

Aktiv Ja Damit dieser Eintrag Einfluss auf die Indexierung sowie auf die Suche hat, wird dieser Eintrag aktiviert.

Position 2 Wir legen eine Position von zwei fest.

Tabelle 6.2 - Die tabellarische Übersicht des zweiten Eintrages.

6.3 Entfernen von HTML-Tags

In diesem Abschnitt erläutern wir den dritten Eintrag. Dieser Eintrag ist zuständig, um alle HTML-Tags mit einem Leerzeichen zu ersetzen. Beispielsweise wird folgende Zeichenkette $amp; mit einem Leerzeichen ersetzt.

Spalte Inhalt Beschreibung Suchmuster /&#?[a-z0-9]{2,8};/ Der reguläre Ausdruck sucht

nach allen HTML-Tags in den Zeichenketten.

Ersetzen durch {$SPACE} Alle gefunden Zeichenketten werden durch ein Leerzeichen ersetzt.

Modifikatoren i Mit diesem Modifikator wird die Gross- und Kleinschreibung nicht beachtet.

Art Beides Wir legen fest, dass in der Indexierung sowie in der Suche, die HTML-Tags mit einem Leerzeichen ersetzt werden.

Aktiv Ja Damit dieser Eintrag Einfluss auf die Indexierung sowie auf die

23

Suche hat, wird dieser Eintrag aktiviert.

Position 3 Wir legen eine Position von drei fest.

Tabelle 6.3 - Die tabellarische Übersicht des dritten Eintrages.

6.4 Satzzeichen vor Wörtern entfernen

In diesem Abschnitt erklären wir den vierten Eintrag. Dieser Eintrag ist zuständig, um alle Satzzeichen vor Wörtern mit einem Leerzeichen zu ersetzten. Beispielsweise wird folgende Zeichenkette .Haus zu Haus umgewandelt.

Spalte Inhalt Beschreibung Suchmuster /\s+\p{P}+([^\s]+)/ Der reguläre Ausdruck sucht

nach allen Satzzeichen, die direkt vor einem Wort stehen.

Ersetzen durch {$SPACE} Alle gefunden Zeichenketten werden durch ein Leerzeichen ersetzt.

Modifikatoren u Mit diesem Modifikator wird der unicode-Support freigeschaltet.

Art Beides Wir legen fest, dass in der Indexierung sowie in der Suche, die Satzzeichen mit einem Leerzeichen ersetzt werden.

Aktiv Ja Damit dieser Eintrag Einfluss auf die Indexierung sowie auf die Suche hat, wird dieser Eintrag aktiviert.

Position 4 Wir legen eine Position von vier fest.

Tabelle 6.4 - Die tabellarische Übersicht des vierten Eintrages.

6.5 Nur Buchstaben und Zahlen behalten

In diesem Abschnitt erläutern wir den fünften Eintrag. Dieser Eintrag ist zuständig, um nur Buchstaben und Zahlen zu behalten. Alle anderen Zeichen werden ersetzt mit einem Leerzeichen. Diese Modifizierung ist standardmässig deaktiviert. Wenn Sie diesen Eintrag aktivieren, sind alle zuvor beschriebenen Einträge hinfällig, denn dieser entfernt sowieso alle weiteren Zeichen. Wenn Sie diese Modifizierung aktivieren, kann der Suchindex wesentlich kleiner werden, was zu einer Performance-Optimierung führt. Allerdings kann es sein, dass die Suchresultate nicht mehr gleich genau sind wie zuvor, da viele Informationen im Datensatz entfernt werden. Wir empfehlen, diese Option zu testen, falls die Suche weiterhin genau ist, können Sie diese Modifizierung aktiviert lassen und alle anderen Einträge deaktivieren.

24

Spalte Inhalt Beschreibung Suchmuster /[^\pL_0-9]/ Der reguläre Ausdruck sucht

nach allen Zeichen, die weder Buchstaben noch Zahlen sind.

Ersetzen durch {$SPACE} Alle gefunden Zeichenketten werden durch ein Leerzeichen ersetzt.

Modifikatoren u Mit diesem Modifikator wird der unicode-Support freigeschaltet.

Art Beides Wir legen fest, dass in der Indexierung sowie in der Suche, die Satzzeichen mit einem Leerzeichen ersetzt werden.

Aktiv Nein Damit dieser Eintrag keinen Einfluss auf die Indexierung sowie auf die Suche hat, wird dieser Eintrag deaktiviert.

Position 5 Wir legen eine Position von fünf fest.

Tabelle 6.5 - Die tabellarische Übersicht des fünften Eintrages.

25

7 Module

Die Erweiterung Premium Search Pro bietet die Möglichkeit nicht nur nach Produkten zu suchen, sondern auch nach Kategorien, Herstellern und Shop-Seiten. Zusätzlich haben Sie die Möglichkeit weitere Module zur Suche hinzuzufügen. Im Reiter Module können Sie die einzelnen Module verwalten. Das Prinzip dieser Konfiguration ist sehr ähnlich zur Tabellenkonfiguration.

Auf die Konfiguration der Module gehen wir in dieser Dokumentation nicht ein. Wenn das Prinzip der Tabellenkonfiguration verstanden wurde, sollte die Konfiguration von Modulen möglich sein. Wie auch für die Tabellenkonfiguration sind auch bei der Modulkonfiguration MySQL-Kenntnisse vorausgesetzt. Bei Fragen helfen wir Ihnen natürlich sehr gerne.

Abbildung 7.1 – Ein Beispiel einer Modul-Konfiguration

26

8 Templates

Premium Search Pro bietet ein Template System für die Live Suche. Im Reiter Template können Sie ganz bequem und einfach Ihr gewünschtes Template auswählen. Standardmässig ist das Template Standard Template ausgewählt. Falls Sie ein anderes Template nutzen wollen, müssen Sie dies einfach mit einem Mausklick selektieren und anschliessend den Button Template Aktivieren klicken.

Zusätzlich können Sie jedes Template nach Ihren Wünschen anpassen. Dazu erscheinen im rechten Bereich des Fensters alle verfügbaren Einstellungen. In der folgenden Tabelle fassen wir alle verfügbaren Einstellungsmöglichkeiten zusammen.

Feld Beschreibung Label Hintergrund Farbe Legen Sie die Hintergrundfarbe des Labels

fest. Label Text Farbe Legen Sie die Textfarbe des Labels fest. Label Rahmen Farbe Legen Sie die Rahmenfarbe des Labels fest. Label Breite der Live Suche Legen Sie die Labelbreite der Live Suche fest. Module ohne Resultate ausblenden Blenden Sie Module, die keine Resultate haben

automatisch aus. Produkte ohne Treffer ausblenden Blenden Sie die Produktliste automatisch aus,

falls keine Resultate gefunden werden. Zu eindeutigem Treffer weiterleiten Leiter Sie direkt zum eindeutigen Treffer

weiter, falls die Suche genau auf ein bestimmtes Element zutrifft.

Produkt Anzahl von Modulen anzeigen Stellen Sie die Produkteanzahl von Modulen dar.

Modulresultate zusammenführen Stellen Sie die Modulresultate in einer gemeinsamen Liste dar.

Hersteller des Produkts anzeigen Stellen Sie den Herstellernamen eines Produktes dar.

Top Seller Batch anzeigen Stellen Sie den Top Seller Batch dar, falls es sich bei dem jeweiligen Produkt um einen Top Seller handelt.

Newcomer Batch anzeigen Stellen Sie den Newcomer Batch dar, falls es sich beim jeweiligen Produkt um einen Newcomer handelt.

Pseudopreis anzeigen Stellen Sie den Pseudopreis dar, falls das jeweilige Produkt einen Pseudopreis besitzt.

Produkt Bewertung anzeigen Stellen Sie die Produktbewertung dar, falls das jeweilige Produkt eine Bewertung besitzt.

Verfügbarkeit der Produkte anzeigen Stellen Sie die Verfügbarkeit der Produkte dar. Tabelle 8.1 - Die Übersicht aller verfügbaren Einstellungsmöglichkeiten.

27

Erhalten Sie einen Eindruck von allen Templates, indem Sie alle Templates durchtesten. Die Templates bauen auf dem Responsive Theme von Shopware auf. Falls Sie ein eigenes Theme verwenden, besteht die Möglichkeit, dass nur das Standard Template funktioniert.

Unser Template System basiert auf Smarty sowie jQote22.

8.1 Erstellen eines eigenen Template

In diesem Abschnitt erklären, wie Sie ein eigenes Template erstellen können. Sie können das Template in Ihrem eigenen Theme erstellen oder durch ein zusätzliches Plugin. Bei beiden Varianten sind gewisse Programmierkenntnisse vorausgesetzt. Damit das eigene Template verwendet wird, müssen Sie das Template Eigenes Template auswählen.

8.1.1 Erstellen eines eigenen Template via Theme Um ein eigenes Template via Theme zur erstellen, müssen Sie Ihr Theme bearbeiten. Gehen Sie dazu in den Ordner des Themes. ShopRoot/themes/Frontend/ThemeName.

Bei diesem Ordner handelt es sich um den Root Ordner des Themes. Erstellen Sie nun die Datei custom.tpl im Ordner frontend/search. Um eine gute Grundlage des Template zu haben, können Sie den Inhalt der Datei ShopRoot/custom/plugins/OntiusSimpleSearch/Resources/views/frontend/search/advanced.tpl kopieren und in der zuvor neu erstellten Datei custom.tpl einfügen. Falls Sie Shopware unter Version 5.2.11 nutzen, finden Sie die Datei unter ShopRoot /engine/Shopware/Plugins/Community/Frontend/OntiusSimpleSearch/Resources/views/frontend/search/advanded.tpl. Nun können Sie den Inhalt der Datei nach Ihren Wünschen ändern.

2 https://github.com/aefxx/jQote2

Abbildung 8.1 - Die Übersicht der verfügbaren Templates.

28

8.1.2 Erstellen eines eigenen Template via Plugin Um ein eigenes Template via Plugin zu erstellen, müssen Sie ein neues Plugin erstellen bzw. ein Existierendes bearbeiten. Wir gehen davon aus, dass Sie wissen wie ein Plugin erstellt wird.

Erstellen Sie einen neuen Subscriber, also eine Klasse erstellen die das Interface Enlight\Event\SubscriberInterface implementiert. Fügen Sie die statische Funktion getSubsribedEvents() zur Klasse hinzu. Als Rückgabewert sollte diese Klasse ein Array zurückgeben. Geben Sie Diese Klasse muss ein Array zurückgeben. Das Array sollte folgenden Eintrag beinhalten:

'Enlight_Controller_Action_PostDispatchSecure_Frontend' => ['onPostDispatchFrontend', 100]

Anschliessend müssen Sie die Funktion onPostDispatchFrontend zur Klasse hinzufügen. Die komplette Klasse können Sie im folgenden Bild genauer betrachten. Dieser Subscriber registriert lediglich den Pfad PluginOrdner/Resources/views/.

Als nächstes müssen Sie die Datei custom.tpl im Ordner PluginOrdner/Resources/views/frontend/search/ erstellen. Wahrscheinlich müssen Sie einige Ordner noch erstellen, bevor Sie die Datei custom.tpl anlegen können.

Abbildung 8.2 - Der Code für die Subscriber-Klasse.

29

Um eine gute Grundlage des Template zu haben, können Sie den Inhalt der Datei ShopRoot/custom/plugins/OntiusSimpleSearch/Resources/views/frontend/search/advanced.tpl kopieren und in der zuvor neu erstellten Datei custom.tpl einfügen. Falls Sie Shopware unter Version 5.2.11 nutzen, finden Sie die Datei unter ShopRoot /engine/Shopware/Plugins/Community/Frontend/OntiusSimpleSearch/Resources/views/frontend/search/advanded.tpl. Nun können Sie den Inhalt der Datei nach Ihren Wünschen ändern.

Dieser Abschnitt geht davon aus, dass Sie wissen wie ein Plugin auf Shopware entwickelt wird. Deshalb werden hier keine weiteren Informationen gegeben. Falls Sie Fragen haben, helfen wir Ihnen natürlich gerne weiter.

30

9 Dynamische Objekte

Der Reiter Dynamische Objekte ist ein Feature für die Boost Suche. Mit diesen dynamischen Objekten können Sie gewünschte RequestHandlers, Subscribers sowie ConditionHandlers dynamisch laden. Bei der Standard Livesuche werden immer alle Klassen geladen. Hingegen bei der Boost Live Suche wird ein minimaler Boot verwendet, dadurch werden nur die nötigen Klassen geladen. Dadurch kann die Boost Live Suche bist zu 10x schneller sein wie die Standard Live Suche.

Um gewisse Klassen in der Boost Live Suche zu aktivieren, müssen Sie die gewünschte Klasse aktivieren. Durch einen Doppelklick auf den gewünschten Listeneintrag, können Sie den Aktiv-Status beeinflussen. Nachdem Sie den Status geändert haben müssen Sie den Button Aktualisieren drücken.

Damit die Änderungen Wirkung zeigen, müssen Sie den Button Suchindexierung neu aufbauen klicken.

31

10 Zusätzliche Schlüsselwörter & weitere Einstellungen

Mit den zusätzlichen Schlüsselwörtern können Sie den Suchindex beeinflussen. Beispielsweise können Sie zum Produkt X das Schlüsselwort Blau mit einer Relevanz von 110 hinzufügen. Dadurch kann das Produkt X auch mit dem Suchbegriff Blau gefunden werden.

Falls das Produkt X bereits Blau im Datensatz besitzt, wird die Relevanz summiert. Das heisst wenn Blau im Produktnamen enthalten ist und die Artikelbeschreibung eine Relevanz von 100 hat, dann wird der Begriff Blau mit einer Relevanz von 210 (100 + 110) indexiert.

Mit diesen zusätzlichen Schlüsselwörtern können Sie die Suche auf Ihre Wünsche anpassen.

Modul Menü Beschreibung Produkte Artikel – Übersicht – Artikel auswählen Fügen Sie zusätzliche

Schlüsselwörter zu einem bestimmten Produkt hinzu. Diese Schlüsselwörter wirken sich nur auf das bestimmte Produkt aus.

Kategorien Artikel – Kategorien – Kategorie auswählen Fügen Sie zusätzliche Schlüsselwörter zu einer bestimmten Kategorie hinzu. Diese Schlüsselwörter wirken sich auf alle zugewiesenen Produkte der jeweiligen Kategorie aus.

Hersteller Artikel – Hersteller – Hersteller auswählen Fügen Sie zusätzliche Schlüsselwörter zu einem bestimmten Hersteller hinzu. Diese Schlüsselwörter wirken sich auf alle zugewiesenen Produkte des jeweiligen Herstellers aus.

Tabelle 10.1 - Übersicht der verschiedenen Backend Modulen.

Neben den zusätzlichen Schlüsselwörtern können Sie auch die Relevanz und die Kundengruppen anpassen. Diese Einstellungen können auf Produkte, Kategorien sowie Herstellereben festgelegt werden. Wenn ein bestimmtes Produkt in Ihrem Shop besonders wichtig ist, können Sie die Relevanz des Produktes hochschrauben, dadurch wird dieses Produkt immer weit vorne erscheinen.

Wenn Sie ein bestimmtes Produkt nur für eine bestimmte Kundengruppe anzeigen wollen, dann müssen Sie nur die gewünschte Kundengruppe anzeigen. Dieses Verhalten können Sie auf ein einziges Produkt beschränken, auf eine ganze Kategorie oder auch auf einen ganzen Hersteller.

32

Die zusätzlichen Schlüsselwörter sind auch für die Module verfügbar.

Modul Menü Beschreibung Kategorien Artikel – Kategorien – Kategorie auswählen Fügen Sie zusätzliche

Schlüsselwörter zu einer bestimmten Kategorie hinzu.

Hersteller Artikel – Hersteller – Hersteller auswählen Fügen Sie zusätzliche Schlüsselwörter zu einem bestimmten Hersteller hinzu.

Shopseiten Inhalte – Shopseiten – Shopseite auswählen Fügen Sie zusätzliche Schlüsselwörter zu einer bestimmten Shopseite hinzu.

Tabelle 10.2 - Übersicht der unterschiedlichen Backend Modulen.

33

11 Apache Solr

Mit Apache Solr wird Ihre Shop-Suche die beste Performance haben, besonders bei Shops mit hohen Produktanzahlen ist ein Unterschied eindeutig wahrzunehmen. Wir empfehlen Apache Solr spätestens ab einer Indexgrösse von 15'000 zu verwenden. Neben der starken Performance sind auch die bessere Skalierbarkeit sowie die Entlastung der Datenbank ein wichtiger Punkt.

11.1 Installation von Apache Solr

Im folgenden Abschnitt erklären wir die Installation von Apache Solr. Dabei gehen wir auf zwei unterschiedliche Varianten ein, die Installation mit Docker und die Installation ohne Docker. Bei beiden Varianten sind gewisse Grundkenntnisse mit Linux Systemen vorausgesetzt. In dieser Dokumentation gehen wir nur auf Linux Debian Systeme ein. Bitte führen Sie diese Installation nur aus, falls Sie Ihren Server wirklich gut kennen. Damit Sie diesen Anweisungen folgen können, brauchen Sie SSH-Zugang auf Ihren Server, damit Sie die Anweisungen ausführen können.

11.1.1 Installation von Apache Solr mit Docker Damit Sie Docker nutzen können, müssen Sie Docker installieren, falls Sie Docker noch nicht installiert haben. Die Installation von Docker wird auf der offiziellen Seite von Docker3 gut erklärt. Neben Docker müssen Sie auch docker-compose auf Ihrem System installiert haben. Die Installation wird auf dieser Seite4 gut erklärt.

Nachdem Sie Docker auf Ihrem Server installiert haben, müssen Sie in den folgenden Ordner wechseln: ShopRoot/custom/plugins/OntiusSimpleSearch/Resources/apache_solr/. Falls Sie Shopware unter Version 5.2.11 nutzen müssen Sie in den folgenden Ordner wechseln: ShopRoot/engine/Shopware/Plugins/Community/Frontend/OntiusSimpleSearch/Resources/apache_solr/. Mit dem Befehl cd5 können Sie das aktuelle Verzeichnis wechseln.

1. In diesem Verzeichnis finden Sie eine Datei namens docker-compose.yml. Diese Datei erstellt einen Solr Container mit dem offiziellen Solr Docker Image6. Ändern Sie den hostname zur Ihrem gewünschten Hostnamen. Standardmässig steht solr.yourdomain.com. Bleiben Sie in diesem Verzeichnis und führen Sie folgenden Befehl aus. $ docker-compose up –build -d

2. Führen Sie anschliessend folgenden Befehl aus, um alle Docker Container aufzulisten. Die

Spalten Container ID und Container Name sind wichtig für die nächsten Schritte. $ docker ps -a

3 https://docs.docker.com/install/linux/docker-ce/ubuntu/ 4 https://linuxize.com/post/how-to-install-and-use-docker-compose-on-ubuntu-18-04/ 5 cd steht für Change Directory 6 https://hub.docker.com/_/solr/

34

3. Ändern Sie die Dateiberechtigungen der Datei setup-apache-solr.sh mit folgendem Befehl.

$ chmod 744 setup-apache-solr.sh

4. Falls setup-apache-solr.sh ein falsches Dateiformat hat, können Sie das Dateiformat wie

auf diesem Link7 beschrieben ändern. Wenn Sie auf einem Linux System arbeiten, braucht die Datei ein unix Dateiformat.

5. Um Apache Solr korrekt aufzusetzen müssen Sie noch folgenden Befehl ausführen. Sobald Sie diesen Befehl ausführen werden Sie nach der Container ID gefragt. Mit dem Befehl in Schritt 2 haben Sie die Container ID erhalten. Kopieren Sie die Container ID an die entsprechende Stelle. Drücken Sie Enter, nachdem Sie die Container ID eingegeben haben. Das gleiche müssen Sie für den Container Name machen. Drücken Sie nach Eingabe des Container Namens erneut Enter. Nun müssen Sie Ihr Passwort für den Benutzer solr festlegen. Wählen Sie ein sicheres Passwort. Dieses Passwort wird für die Basic Authentication verwendet. Drücken Sie Enter nach Eingabe des Passworts. Nun müssen Sie noch das Zertifikat-Passwort eingeben. Sie können dieses Passwort in der Datei docker-compose.yml ändern. Falls Sie dieses Passwort nicht geändert haben, können Sie solrSearchEngine99 eingeben. Drücken Sie nach der Eingabe des Passworts erneut Enter. Nun müssen Sie noch festlegen, ob Sie den klassischen Modus von Apache Solr verwenden möchten oder nicht. Falls Sie den klassischen Modus verwenden möchten geben Sie y ein. Falls Sie den Managed-Schema Modus verwenden möchten geben Sie n ein. Drücken Sie nach Eingabe erneut Enter. Anschliessend wird Apache Solr automatisch für Sie aufgesetzt. $ ./setup-apache-solr.sh

Die Installation von Apache Solr ist nun bereits abgeschlossen. Nun werden wir noch einige nützliche Befehle auflisten, damit Sie Apache Solr über die Kommandozeile verwalten können.

Damit Sie in einen Docker Container gelangen, um dort Befehle auszuführen, können Sie den folgenden Befehl verwenden. Wie bereits erwähnt, müssen Sie {$ContainerName} mit dem Namen des Containers ersetzen.

$ docker exec -it {$ContainerName} /bin/bash

Falls Sie in den Docker Container gelangen wollen mit Root Berechtigungen müssen Sie folgenden Befehl ausführen.

7 https://stackoverflow.com/questions/82726/convert-dos-line-endings-to-linux-line-endings-in-vim

35

$ docker exec -it --user=root {$ContainerName} /bin/bash

Um einen bestimmten Kern zu löschen, können Sie folgenden Befehl verwenden. Ersetzen Sie {$ContainerID} mit der ID des Containers und {$CoreName} mit dem Namen des Kerns.

$ docker exec -it--user=solr {$ContainerID} bin/solr delete -c {$CoreName}

Um einen bestimmten Docker Container zu löschen können Sie folgenden Befehl verwenden.

$ docker rm -f {$ContainerName}

Nach der erfolgreichen Installation von Apache Solr kann das Admin Tool unter https://localhost:8983 aufgerufen werden. Sie werden nach Benutzername und Passwort gefragt. Der Benutzername lautet: solr. Das Passwort haben Sie in Schritt 3 definiert. Falls Sie die Installation auf einem remote Server ausführen, wird localhost nicht funktionieren, weil localhost auf Ihren lokalen Computer zeigt.

11.1.2 Installation von Apache Solr ohne Docker In diesem Abschnitt erklären wir die Installation von Apache Solr ohne Verwendung von Docker. Apache Solr setzt Java 8 oder höher voraus. Das heisst, dass Sie mindestens Java 8 auf Ihrem Server installiert haben müssen.

1. Um die Version von Java zu überprüfen, können Sie folgenden Befehl ausführen. $ java -version

Falls der Befehl java nicht gefunden wurde, haben Sie Java noch nicht auf Ihrem System installiert. Wenn die Ausgabe dieses Befehls eine Version unter 8 anzeigt, müssen Sie Java 8 installieren. Achtung, bitte vergewissern Sie sich, dass andere Programme auf Ihrem System möglicherweise mit einer älteren Java Version laufen und somit ein Update auf Java 8 Probleme verursachen kann. Falls Java noch nicht installiert ist, bzw. eine ältere Java Version auf Ihrem Server installiert ist, müssen Sie Java auf Ihrem System installieren. Wir setzen voraus, dass Sie wissen wie Java auf Ihrem Server installiert wird.

2. Wir empfehlen Apache Solr im Verzeichnis /opt/ zu installieren. Falls Sie Apache Solr im Verzeichnis /opt erstellen wollen, dann wechseln Sie in dieses Verzeichnis mit dem Befehl cd.

3. Anschliessend müssen Sie Apache Solr mit folgendem Befehl auf Ihrem Server herunterladen. $ wget "https://archive.apache.org/dist/lucene/solr/7.6.0/solr-7.6.0-src.tgz"

36

4. Installieren Sie Apache Solr mit folgendem Befehl. $ tar xzf solr-7.6.0.tgz solr-7.6.0/solr/bin/install_solr_service.sh --strip-components=2

5. Ändern Sie den SOLR_HOST in der Datei /etc/default/solr.in.sh. Mit folgendem Befehl können Sie die Datei mithilfe des Vi-Editors öffnen. $ vi /etc/default/solr.in.sh

6. Überprüfen Sie nun den Status von Apache Solr mit diesem Befehl.

$ service solr start

7. Wechseln Sie zum Benutzer solr mit folgendem Befehl.

$ su -s /bin/bash solr

8. Falls Sie den Managed Schema von Apache Solr verwenden wollen, können Sie direkt zu

Schritt 10 springen. Nun müssen Sie die Konfiguration des Produkte Kerns in das folgende Verzeichnis kopieren: /opt/solr-7.6.0/solr/server/solr/configsets/productsCore/. Alle Dateien für die Konfiguration des Produkte Kerns finden Sie im folgenden Verzeichnis: ShopRoot/custom/plugins/OntiusSimpleSearch/Resources/apache_solr/core_config/productsCore. Falls Sie Shopware unter Version 5.2.11 verwenden, finden Sie die Dateien im folgenden Verzeichnis: ShopRoot/engine/Shopware/Plugins/Community/Frontend/OntiusSimpleSearch/Resources/apache_solr/core_config/productsCore.in den Docker Container kopieren. Die Dateien können Sie mithilfe von FTP oder SCP kopieren. Sie können die Dateien auf manuell mithilfe des Vi-Editors anlegen. Bitte achten Sie darauf, dass die Dateien die korrekten Benutzer- und Gruppenrechte besitzen. Benutzer sowie Gruppe sollten solr sein. Falls diese nicht der Fall ist, können Sie dies mithilfe von diesem Befehl erreichen. $ sudo chown -R solr:solr /opt/solr-7.6.0/solr/server/solr/configsets/productsCore/

9. Den Schritt 8 müssen Sie für den Modul-Kern ebenfalls durchführen. Die Konfigurations-

Dateien finden Sie im Verzeichnis modulesCore.

10. Nun können Sie die Kerne mit folgendem Befehl erstellen. Falls Sie den Managed Schema Modus von Apache Solr verwenden, müssen Sie den Parameter -d nicht angeben, also alles nach -c productsCore bzw. -c modulesCore können Sie entfernen. $ /opt/solr-7.6.0/solr/bin/solr create_core -c productsCore -d productsCore

37

$ /opt/solr-7.6.0/solr/bin/solr create_core -c modulesCore -d modulesCore

Bei dieser Installation handelt es sich um eine einfache Installation von Apache Solr. Wenn Sie zusätzlich noch Basic Authentication und HTTPS nutzen wollen, können Sie in der Datei setup-apache-solr.sh Informationen erhalten. Es handelt sich dabei um eine Docker Installation, allerdings sind die Schritte sehr ähnlich.

Nach der erfolgreichen Installation von Apache Solr kann das Admin Tool unter dem festgelegten SOLR_HOST aufgerufen werden. Fügen Sie den konfigurierten Port8 ebenfalls der URL an. Beispielsweise solr.yourdomain.com:8983. Direkt über den Server kann das Admin Tool auch über http://localhost:8983 aufgerufen werden.

11.2 Apache Solr auf einem externen Server

Sie können Apache Solr auch auf einem externen Server nutzen. Dies hat den Vorteil, dass Ihr Shop Server weniger belastet wird. Dabei können Sie Apache Solr selbst auf einem anderen Server installieren oder Sie nutzen ein Hosting Angebot.

11.3 Plugin Konfiguration mit Apache Solr

Damit Premium Search Pro Apache Solr verwenden kann, müssen Sie gewisse Einstellungen in der Plugin Konfiguration vornehmen. Gehen Sie dazu im Backend Ihres Shops auf Einstellungen -Plugin Manager – Installiert – Premium Search Pro. Um die Konfiguration des Plugins zu öffnen, müssen Sie auf das Stift-Symbol klicken. Die folgende Tabelle beschreibt, wie die Konfiguration vorgenommen werden muss.

Feld Inhalt Beschreibung Apache Solr Schema Modus Legen Sie den Schema Modus

fest. Apache Solr Host https://localhost Der Host zu Apache Solr.

Wenn Apache Solr auf dem gleichen Server installiert ist, dann kann localhost verwendet werden. Falls Apache Solr auf einem anderen Server installiert wurde, muss der SOLR_HOST angegeben werden, z.B. https://solr.yourdomain.com.

8 Der Standard-Port von Apache Solr ist 8983.

38

Apache Solr Port 8983 Legen Sie den Port zu Apache Solr fest. Der Standard-Port von Apache Solr ist 8983.

Apache Solr Benutzername Geben Sie in diesem Feld den Benutzernamen für Apache Solr ein. Falls Sie keine Authentifizierung für Apache Solr verwenden, können Sie dieses Feld leer lassen. Dieses Feld ist nur relevant, falls Sie Apache Solr nutzen. Der Standardbenutzername lautet solr.

Apache Solr Passwort Geben Sie in diesem Feld das Passwort für Apache Solr ein. Falls Sie keine Authentifizierung für Apache Solr verwenden, können Sie dieses Feld leer lassen. Dieses Feld ist nur relevant, falls Sie Apache Solr nutzen.

Apache Solr Pfad /solr/productsCore Geben Sie den Pfad zum Produkte Kern an. Ersetzen Sie productsCore mit dem Namen Ihres Produkt-Kerns.

Apache Solr Pfad für Module /solr/modulesCore Geben Sie den Pfad zum Modul-Kern an. Ersetzen Sie modulesCore mit dem Namen Ihres Modul-Kerns.

Tabelle 11.1 - Beschreibung der Apache Solr Plugin Konfiguration.

39

12 Fragen

Falls Sie noch Fragen oder Verbesserungsvorschläge zu Premium Search Pro haben, zögern Sie nicht uns zu kontaktieren. Sie erreichen uns mit den folgenden Kontaktdaten.

Email: info@ontius.com

Telefon: +41 52 203 96 96