Extension

Konfigurieren Sie Ihre Magento 2-Extension-Einstellungen, verwalten Sie Daten-Synchronisationsoptionen und passen Sie Search-, Recommendations- und Logging-Funktionen an. Dieser Leitfaden behandelt außerdem die Installation über das Toolbox Script, das Upgrade und die Deinstallation.

Installation mit Toolbox #

Das Clerk Toolbox Script wurde entwickelt, um die Installation der Clerk-Extension in Ihrem Magento-Webshop zu erleichtern, ohne Magento Connect zu verwenden.

Das Toolbox Script wird direkt von einem Terminal ausgeführt.

Wir empfehlen Folgendes:

- Apple: iTerm, Sie müssen es aus dem Internet herunterladen;

- Windows: Eingabeaufforderung, diese ist bereits auf Ihrem Computer installiert.

Das Script erstellt außerdem ein Backup des Magento2-Ordners, sodass es wiederhergestellt werden kann, falls etwas schiefgeht.

Was Sie benötigen #

Um die Installation durchführen zu können, benötigen Sie SSH- oder SFTP-Zugang zu Ihrem Webshop, einschließlich Ihres Benutzernamens und Passworts.

Zum Ordner navigieren #

1. Melden Sie sich zuerst mithilfe eines Terminals auf Ihrem Magento-Server an, indem Sie Ihren Benutzernamen und Ihre Domain wie folgt verwenden:

ssh Stefan@mywebshop.com

2. Sie werden aufgefordert, das Passwort für Ihren User einzugeben (das Terminal gibt während der Eingabe des Passworts kein Feedback, nimmt das Passwort aber trotzdem an).

Navigieren Sie zum Root-Ordner von Magento2. Das machen Sie folgendermaßen:

cd /var/www/html

und geben Sie ein:

ls

Dies gibt Ihnen eine Liste der Ordner, um Ihnen bei der Auswahl des richtigen zu helfen:

Suchen Sie in der Ordnerliste nach dem richtigen Ordner, in diesem Fall wäre es magento2.

An diesem Punkt müssen Sie in den Ordner wechseln, das geht mit folgendem Befehl:

cd NAME_FOLDER

NAME_FOLDER wird durch den tatsächlichen Namen des Ordners ersetzt.

Extension installieren #

1. Wenn Sie sich im Root-Ordner befinden, laden Sie das Toolbox Script mit folgender Zeile herunter:

sudo wget https://raw.githubusercontent.com/clerkio/clerk-magento2/master/clerk_toolbox_magento2.sh

2. Geben Sie anschließend diese Zeile ein, um eine Liste der verfügbaren Optionen innerhalb des Toolbox Scripts zu sehen:

sh clerk_toolbox_magento2.sh

3. Da Sie die Extension installieren möchten, verwenden Sie -i zusammen mit der neuesten Versionsnummer der Extension. Geben Sie diese Zeile ein:

sudo sh clerk_toolbox_magento2.sh -i

4. Nun werden Sie aufgefordert, Ihr Passwort einzugeben. Danach erstellt das Script ein Backup Ihres Magento2-Ordners und beginnt mit der Installation der Extension:

5. Fertig! Nun ist die Extension installiert und Sie können sie im Magento2-Backend konfigurieren.

Optionale Befehle #

Deinstallation

Mit dem Toolbox Script können Sie die Extension auch deinstallieren. Das geht mit dieser Zeile:

sudo sh clerk_toolbox_magento2.sh -u

Wiederherstellung

Falls in Ihrem Webshop etwas schiefgeht, können Sie ihn jederzeit mithilfe des Backups, das bei der Installation der Extension erstellt wurde, wiederherstellen.

Nutzen Sie dazu folgenden Befehl:

sudo sh clerk_toolbox_magento2.sh -r

Backup

Bei der Installation der Extension wird immer zuerst ein Backup erstellt, Sie können aber auch ein separates Backup mit dieser Zeile erstellen:

sudo sh clerk_toolbox_magento2.sh -b

my.clerk.io-Einstellungen #

Um Ihre Magento 2-Dateneinstellungen in Clerk zu verwalten und zu verändern, rufen Sie my.clerk.io auf, klicken Sie im linken Menü auf “Data” und gehen dann zu “Configuration”.

Hinweis: Informationen zur Magento 2 Clerk-Extension, die Sie über das Magento Admin-Portal erreichen, finden Sie weiter unten in diesem Artikel.

Hier können Sie die URL Ihres Shops, die Seitengröße Ihrer Daten-Synchronisationen sowie die Uhrzeit, zu der Ihre Daten mit Clerk synchronisiert werden sollen, festlegen (Standard: “when needed”).

Extension-Einstellungen #

Wenn Sie v6.7.0 oder eine neuere Version der Extension verwenden, können Sie die untenstehenden Einstellungen auf zwei Arten nach Eingabe Ihres Public- und Private Keys aufrufen:

• Über das Magento2-Backend unter Stores > Settings > Configuration > Clerk > Configuration

• Über my.clerk.io unter Developers > Extensions

Es ist egal, wo Sie Änderungen vornehmen, da die Extension sich mit allen Änderungen in my.clerk.io synchronisiert und umgekehrt.

In my.clerk.io können Sie auch die aktuelle Version Ihrer Extension, Ihre Plattform und die PHP-Version einsehen.

Klicken Sie einfach auf “Edit” bei einer Einstellung, um die verfügbaren Optionen zu sehen:

Übersicht #

Um Ihre Clerk-Extension im Magento 2 zu öffnen, loggen Sie sich in das Admin-Portal Ihres Webshops ein und folgen dem Pfad Stores > Settings > Configuration > Clerk > Configuration

Allgemein #

Im Bereich General finden Sie die Versionsnummer Ihrer Clerk Extension sowie die öffentlichen und privaten API-Keys Ihres Shops.

Um Seiten in Ihre Daten-Synchronisation mit Clerk einzubeziehen, wählen Sie “Ja” im nächsten Dropdown-Menü und geben Sie alle zusätzlichen Felder, die Sie mit Ihren Seitendaten synchronisieren möchten (wie Bilder oder Seitentyp), als durch Kommas getrennte Werte ein.

Sie können außerdem die Standardsprache für die synchronisierten Shop-Daten im letzten Dropdown-Menü im Bereich General festlegen.

Synchronisation #

Im Bereich Synchronization des Clerk-Plugins können Sie die Synchronisation für Kunden-, Bestell-, Warenkorb- und Produktdaten anpassen.

Optionen sind ausgegraut und können nicht aktualisiert werden, wenn die Website-Daten genutzt werden, erkennbar an der markierten Checkbox rechts neben jedem Abschnitt.

Verwenden Sie die passende Checkbox, um den Bereich zur Bearbeitung freizugeben.

• Use Real-time Updates: Wählen Sie “Ja”, um Echtzeit-Updates für Ihre mit Clerk synchronisierten Daten zu aktivieren.

• Collect Emails: Hier “Ja” wählen, um Kunden-E-Mails zu synchronisieren.

• Collect Baskets: Um Warenkorb-Daten zu erfassen und mit Clerk zu synchronisieren, wählen Sie hier “Ja”.

  • Um zusätzliche Warenkorb-Datenfelder hinzuzufügen, geben Sie diese als kommagetrennte Werte im Bereich “additional fields” unten an.

• In den nächsten beiden Dropdowns wählen Sie “ja”, um nur verkäufliche Produkte und/oder nur Produkte mit Sichtbarkeit für Clerk zu synchronisieren.

• Sollten Sie die Bestell-Synchronisation deaktivieren wollen, können Sie dies hier mit “Ja” tun.

Kundensynchronisation #

Aktivieren Sie die Synchronisation der Kundendaten, indem Sie “Ja” im Dropdown in diesem Abschnitt wählen.

Wenn Sie zusätzliche Kundenattribute mit Clerk synchronisieren möchten, geben Sie diese als kommagetrennte Liste im Textfeld an.

Search #

Aktivieren Sie die Search Page Ihres Shops, indem Sie hier im Dropdown “Ja” auswählen.

• Nach Auswahl von “Enabled” geben Sie den Namen Ihres Search Page Elements ein, der mit dem data-template-Feld im Embed-Code Ihres Elements bei my.clerk.io übereinstimmt. In diesem Beispiel: search-page.

• Sie können den Text für " load more" und " no results", der angezeigt werden soll, in die entsprechenden Textboxen eintragen.

Live Search #

• Nach Auswahl von “Enabled” im Dropdown zur Aktivierung der Live Search wählen Sie aus, ob Categories in den Suchergebnissen angezeigt werden sollen.

  • Sie können auch die Anzahl der Such-Suggestions, Categories und Content-Ergebnisse festlegen, die neben Ihren Produkt-Ergebnissen in der Live Search angezeigt werden sollen.

• Außerdem können Sie auswählen, welche Seitentypen als Suchergebnisse angezeigt werden, z. B. “CMS Pages”, “Blog Posts” oder “All”.

• Sie können mit Dropdown Positioning die Position des Live Search-Dropdowns aus Ihrer Suchbox wählen.

• Geben Sie als Nächstes den Element-Namen für Ihre Live Search an, den Sie im Embed-Code neben data-template in Ihrem my.clerk.io Element für die Live Search finden. Das ist wahrscheinlich live-search.

• Zum Schluss haben Sie die Möglichkeit, Ihren Live Search Input Selector und Form Selector anzugeben, die Sie finden, indem Sie die Suchbox Ihres Webshops im Browser untersuchen und die zugehörige ID oder Klasse für die Eingabe und das Formular identifizieren.

  • In diesem Beispiel: #search als Eingabeselector und die Auswahl “website” als Form Selector.

Facettierte Navigation #

Um Facetten zu Ihrer Search Page hinzuzufügen, wählen Sie zunächst die Checkbox “Enabled” unter Faceted Navigation.

• Klicken Sie auf die Attribute, die Sie Ihren Facetten hinzufügen möchten, und klicken Sie auf “save config”.

• Nach dem Hinzufügen erscheinen Ihre hinzugefügten Attribute unter Titles. In diesem Bereich können Sie den Titel für die jeweilige Facette und deren Position in der Facettenliste festlegen.

Hinweis: Sie können jetzt die Daten für Kategorien und Seiten auf Ihrer Search Page genauso abrufen wie in Ihrer Live Search und haben so einen größeren Informationsumfang, um Ihre Kunden zu begeistern. Weitere Informationen finden Sie hier.

Facetten anpassen #

• Clerk ermöglicht es Ihnen, Ihre Search Page Facetten im Design zu gestalten, und Sie können dies tun, indem Sie auf das Design-id-Feld Bezug nehmen.

• Die Design-ID finden Sie im Clerk Backend, in der ganz linken Spalte jedes Designs auf der Designübersichtsseite und unten links, sobald Sie das Design zur Bearbeitung öffnen.

Powerstep und Exit Intent #

Ähnlich wie bei Search aktivieren Sie Ihren Clerk Powerstep, indem Sie im Dropdown “Ja” auswählen, und anschließend den Typ des Powersteps (Page oder Popup) bestimmen.

• Geben Sie den Element-Namen für Ihren Powerstep an, den Sie im Embed-Code neben data-template in Ihrem my.clerk.io Powerstep Element finden, in diesem Beispiel power-step-others-also-bought.

• Folgen Sie demselben Vorgehen wie oben, um Ihr Exit Intent zu aktivieren und das passende Exit Intent Element zu identifizieren und hinzuzufügen.

Recommendations #

Ebenfalls ähnlich zur Search-Integration aktivieren Sie die Clerk-Product-, Category- und Cart Page Settings, indem Sie im jeweiligen Dropdown “Enabled” wählen.

• Wie bei den Search-Funktionen finden Sie den Elementnamen neben data-template im Einbettungscode unter my.clerk.io > Recommendations > Elements.

  • In diesem Beispiel haben wir die Einstellungen für Product Page, Category Page und Cart Page aktiviert, und category-page-popular als Element für Category Page, product-page-alternatives und product-page-others-also-bought für die Product Page sowie cart-others-also-bought für die Category Page angegeben.

Logging #

Um die Logging-Einstellungen zu ändern, navigieren Sie zunächst in Ihrem Magento2-Backend zu Stores => Configuration => Clerk => Configuration:

Suchen Sie das Dropdown mit der Bezeichnung Logging Settings und stellen Sie Ihre bevorzugten Einstellungen ein.

Klicken Sie zum Abschluss auf Save:

Zu den Logging-Einstellungen gehören:

Logging Level wählen

• Nur Fehler: Protokolliert Fehler, die das ordnungsgemäße Funktionieren des Moduls verhindern.

• Fehler + Warnung: Protokolliert zusätzlich Warnungen, die das Modul nicht stoppen, aber ebenfalls beachtet werden sollten.

• Fehler + Warnung + Debug: Protokolliert alles, mit dem das Modul interagiert. Dies sollte nicht auf einem Live-Webshop aktiviert werden, da es die Seite verlangsamt.

Wohin protokollieren

• File: Speichert das Log auf dem Magento2-Server als Datei.

• my.clerk.io: Protokolliert alles unter Developers->Logs im my.clerk.io-Backend.

Upgrade #

Wenn Sie eine Version vor 3.0.0 verwenden, werden beim Upgrade Ihre Designs nicht mehr funktionieren, da Clerk.js 2 verwendet wird. Bei einer älteren Version befolgen Sie stattdessen diese Anleitung.

Wichtig: Erstellen Sie unbedingt Backups von allen modifizierten Dateien, da diese überschrieben werden.

Das Upgrade der Magento 2-Extension erfolgt über die Kommandozeile.

Gehen Sie dabei wie folgt vor:

1. Melden Sie sich über die Kommandozeile auf Ihrem Server an.

2. Navigieren Sie in Ihren Webroot-Ordner (üblicherweise " /var/www/your_domain/public_html").

3. Aktivieren Sie Root Access, indem Sie su eingeben und Ihr Passwort eingeben.

4. Geben Sie diese Befehle in folgender Reihenfolge ein:

   composer update clerk/magento2

   php bin/magento setup:upgrade

   php bin/magento setup:di:compile

5. Warten Sie, bis das Upgrade abgeschlossen ist.

Ihr Magento 2 ist nun auf die neueste Version aktualisiert.

Deinstallation #

Genau wie bei der Installation von Extensions in Magento 2 muss auch die Deinstallation über die Kommandozeile erfolgen.

Geben Sie dazu folgende Befehle der Reihe nach ein, um die Extension zu entfernen:

1. php bin/magento setup:module:disable Clerk_Clerk

2. composer remove clerk/magento2