Extension

Konfigurieren Sie Ihre Magento 2 Erweiterungseinstellungen, verwalten Sie Daten-Synchronisierungsoptionen 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 Erweiterung in Ihrem Magento Webshop ohne Verwendung von Magento Connect zu erleichtern.

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

Wir empfehlen diese:

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

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

Das Script erstellt auch ein Backup des Magento2-Ordners, damit es wiederhergestellt werden kann, falls etwas schiefgeht.

Was Sie benötigen #

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

Zum Ordner navigieren #

1. Melden Sie sich zunächst über ein Terminal bei Ihrem Magento Server an, indem Sie Ihren Benutzernamen und Domain wie folgt verwenden:

ssh Stefan@mywebshop.com

2. Sie werden aufgefordert, das Passwort für Ihren Benutzer einzugeben (das Terminal gibt während der Eingabe kein Feedback, registriert das Passwort aber trotzdem).

Navigieren Sie zum Root-Ordner von Magento2. Das können Sie so machen:

cd /var/www/html

und:

ls

Dies zeigt Ihnen eine Liste der Ordner, damit Sie den richtigen finden:

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

Nun müssen Sie nur noch in diesen Ordner wechseln, indem Sie schreiben:

cd NAME_FOLDER

NAME_FOLDER wird durch den tatsächlichen Ordnernamen ersetzt.

Erweiterung installieren #

1. Wenn Sie sich im Root-Ordner befinden, müssen Sie das Toolbox Script mit dieser Zeile herunterladen:

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 im Toolbox Script anzuzeigen:

sh clerk_toolbox_magento2.sh

3. Da Sie die Erweiterung installieren möchten, verwenden Sie -i zusammen mit der letzten Versionsnummer der Erweiterung. Geben Sie folgendes ein:

sudo sh clerk_toolbox_magento2.sh -i

4. Jetzt werden Sie aufgefordert, Ihr Passwort einzugeben. Nach der Eingabe erstellt das Script ein Backup Ihres Magento2-Ordners und beginnt mit der Installation der Erweiterung:

5. Fertig! Die Erweiterung ist jetzt installiert, und Sie können sie im Magento2 Backend konfigurieren.

Optionale Befehle #

Deinstallation

Mit dem Toolbox Script können Sie die Erweiterung auch deinstallieren. Dazu verwenden Sie diese Zeile:

sudo sh clerk_toolbox_magento2.sh -u

Wiederherstellung

Falls in Ihrem Webshop etwas schiefgeht, können Sie das während der Installation erstellte Backup zur Wiederherstellung nutzen.

Verwenden Sie dafür diese Zeile:

sudo sh clerk_toolbox_magento2.sh -r

Backup

Beim Installieren der Erweiterung erstellt das Script immer zuerst ein Backup, aber Sie können auch separat ein Backup erstellen mit dieser Zeile:

sudo sh clerk_toolbox_magento2.sh -b

my.clerk.io Einstellungen #

Um Ihre Magento 2 Dateneinstellungen in Clerk zu bearbeiten, gehen Sie zu my.clerk.io, klicken Sie im linken Menü auf “Data” und dann auf “Configuration”.

Hinweis: Informationen über die Magento 2 Clerk Erweiterung, die über das Magento Admin-Portal verfügbar ist, finden Sie später in diesem Artikel.

Hier können Sie die URL Ihres Shops, die Seitengröße Ihrer Datensynchronisationen und die Uhrzeit für die Datensynchronisierung mit Clerk einstellen (Standard ist “when needed”).

Erweiterungs-Einstellungen #

Wenn Sie v6.7.0 oder eine neuere Version der Erweiterung verwenden, können Sie nach Hinzufügen Ihrer Public und Private Keys auf die folgenden Einstellungen auf zwei Arten zugreifen:

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

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

Es spielt keine Rolle, wo Sie die Änderungen vornehmen, da sich die Erweiterung mit allen Änderungen in my.clerk.io synchronisiert und umgekehrt.

In my.clerk.io sehen Sie außerdem Ihre aktuelle Version der Erweiterung, Ihre Plattform und die PHP-Version.

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

Übersicht #

Um Ihre Clerk-Erweiterung in Magento 2 zu öffnen, melden Sie sich im Adminportal Ihres Webshops an und folgen Sie dem Pfad Stores > Settings > Configuration > Clerk > Configuration

Allgemein #

Im Bereich Allgemein finden Sie Ihre Clerk-Erweiterungsversionsnummer sowie die Public und Private API Keys Ihres Shops.

Um Pages in Ihre Datensynchronisation mit Clerk einzubinden, wählen Sie im nächsten Dropdown “Yes” und geben Sie dort alle zusätzlichen Felder ein, die Sie in die Page-Daten aufnehmen möchten (wie Bilder oder Seitentyp) als Komma-separierte Werte.

Sie können außerdem die Standardsprache für Ihre synchronisierten Shopdaten im letzten Dropdown in Allgemein festlegen.

Synchronisation #

Im Abschnitt Synchronization des Clerk Plugins können Sie Ihre synchronisierten Kunden-, Bestell-, Warenkorb- und Produktdaten anpassen.

Optionen sind ausgegraut und nicht bearbeitbar, wenn die Website-Daten verwendet werden, erkennbar am Haken rechts in jedem Abschnitt.

Entfernen Sie einfach den Haken, um die Einstellungen zu bearbeiten.

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

• Collect Emails: Wählen Sie hier “Yes”, um Kunden-Emails zu synchronisieren.

• Collect Baskets: Um Warenkorbdaten zu erfassen und mit Clerk zu synchronisieren, wählen Sie hier “Yes”.

  • Um zusätzliche Felder für den Warenkorb zu erfassen, tragen Sie diese als Komma-separierte Werte im Bereich “additional fields” unten ein.

• Wählen Sie in den nächsten zwei Dropdowns “yes”, um nur verkaufbare Produkte zu synchronisieren und/oder nur Produkte mit Sichtbarkeit für Clerk zu synchronisieren.

• Wenn Sie die Bestellsynchronisation deaktivieren möchten, können Sie dies durch Auswahl von “Yes” im entsprechenden Dropdown tun.

Kundensynchronisation #

Aktivieren Sie die Kundendatensynchronisation, indem Sie “Yes” im Dropdown dieses Abschnitts wählen.

Wenn Sie zusätzliche Kundenattribute in der Clerk Synchronisation aufnehmen möchten, tragen Sie diese in das Textfeld als Komma-separierte Liste ein.

Search #

Aktivieren Sie die Search Page Ihres Shops, indem Sie im Dropdown “Yes” wählen.

• Nach Auswahl von “Enabled” geben Sie Ihren Search Page Element Namen ein, der dem Feld data-template im Embed Code Ihres Elements in my.clerk.io entspricht. In diesem Beispiel: search-page.

• Sie können den Text für “load more” und “no results”, der angezeigt wird, in den jeweiligen Textfeldern eintragen.

Live Search #

• Nachdem Sie “Enabled” im Dropdown gewählt haben, um Live Search zu aktivieren, wählen Sie, ob Categories in Ihren Suchergebnissen angezeigt werden sollen.

  • Sie können auch die Anzahl der Such-Vorschläge, Kategorien und Content Ergebnisse wählen, die zusätzlich zu den Produktergebnissen in Live Search angezeigt werden.

• Zusätzlich haben Sie die Option, auszuwählen, welche Seiten-Typen als Suchergebnisse angezeigt werden, z. B. “CMS Pages”, “Blog Posts” oder “All”.

• Die Position des Dropdowns der Live Search neben Ihrem Suchfeld legen Sie mit Dropdown Positioning fest.

• Geben Sie als nächstes den Element Namen für Ihre Live Search an. Sie finden diesen neben data-template im Embed Code Ihres Live Search Elements in my.clerk.io. Dies ist vermutlich live-search.

• Zuletzt können Sie den Live Search Input Selector und den Form Selector angeben, die Sie ermitteln, indem Sie das Suchfeld Ihres Webshops im Browser inspizieren und die zugehörige ID oder Klasse für das Input und das Formular herausfinden.

  • In diesem Beispiel: #search als Input Selector, und die Website wird zur Identifikation des Form Selectors verwendet.

Facettierte Navigation #

Um Facetten zu Ihrer Search Page hinzuzufügen, wählen Sie zuerst das Feld “Enabled” bei Faceted Navigation aus.

• Klicken Sie auf die Attribute, die Sie Ihren Facetten hinzufügen möchten und speichern Sie die Konfiguration.

• Einmal hinzugefügt, erscheinen die gewählten Attribute unter Titles. In diesem Abschnitt können Sie den Titel festlegen, der für die Facette angezeigt wird, und welche Position das Attribut in der Facettenliste haben soll.

Hinweis: Sie können nun die Daten für Kategorien und Seiten in Ihrer Search page genauso aufrufen wie in der Live Search. So können Sie Ihre Kunden mit mehr Information ansprechen. Weitere Infos finden Sie hier.

Facetten anpassen #

• Clerk ermöglicht es Ihnen, Ihre Facetten der Search Page direkt im Design zu gestalten und über das Feld Design-ID anzuzeigen.

• Die Design-ID finden Sie im Clerk Backend, in der ganz linken Spalte jedes Designs auf der Design-Übersichtsseite und unten links auf der Seite, wenn Sie das Design zum Bearbeiten öffnen.

Powerstep und Exit Intent #

Ähnlich wie bei Search aktivieren Sie Ihren Clerk Powerstep durch Auswahl von “Yes” im Dropdown und wählen dann die Art des Powersteps (entweder Page oder Popup).

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

• Folgen Sie demselben Ablauf, um Ihren Exit Intent zu aktivieren und das entsprechende Exit Intent Element zu hinterlegen.

Recommendations #

Ebenfalls ähnlich wie bei Search aktivieren Sie die Clerk Product, Category und Cart Page Settings durch Auswahl von “Enabled” in den jeweiligen Dropdowns.

• Wie bei den Search-Funktionen finden Sie den Elementnamen neben data-template im Embed Code 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 unser Category Page Element, product-page-alternatives und product-page-others-also-bought auf unserer Product Page sowie cart-others-also-bought als unser Category Page Element angegeben.

Logging #

Um die Logging-Einstellungen zu ändern, gehen Sie zuerst in das Magento2 Backend und wählen Sie Stores => Configuration => Clerk => Configuration:

Suchen Sie das Dropdown Logging Settings und wählen Sie Ihre bevorzugten Logging-Einstellungen.

Beenden Sie den Vorgang mit einem Klick auf Save:

Die Logging-Einstellungen enthalten:

Logging Level wählen

• Only Errors: Es werden alle Fehler geloggt, die das fehlerfreie Funktionieren des Moduls verhindern.

• Error + Warn: Zusätzlich werden Warnungen geloggt, die keine Funktionsstörung auslösen, aber möglicherweise ebenfalls behoben werden sollten.

• Error + Warn + Debug: Loggt alles, womit das Modul interagiert. Dies sollte auf einem Live-Webshop nicht aktiviert werden, da es die Seite verlangsamt.

Wohin soll geloggt werden

• File: Das Log wird auf dem Magento2-Server in eine Datei geschrieben.

• my.clerk.io: Alles wird unter Developers->Logs im my.clerk.io Backend geloggt.

Upgrade #

Wenn Sie eine Version vor 3.0.0 verwenden, führt ein Upgrade zu Problemen mit Ihren Designs, da Clerk.js 2 verwendet wird. Wenn Sie eine ältere Version nutzen, folgen Sie stattdessen dieser Anleitung.

Wichtig: Vergessen Sie nicht, Backups aller geänderten Dateien anzulegen – diese werden überschrieben.

Das Upgrade der Magento 2 Erweiterung erfolgt über die Kommandozeile.

Gehen Sie dazu so vor:

1. Melden Sie sich per Kommandozeile auf Ihrem Server an.

2. Navigieren Sie zu Ihrem Webroot-Verzeichnis (meist " /var/www/your_domain/public_html")

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

4. Geben Sie folgende Befehle der Reihe nach ein:

   composer update clerk/magento2

   php bin/magento setup:upgrade

   php bin/magento setup:di:compile

5. Warten Sie bis die Erweiterung fertig ist.

Ihr Magento 2 ist jetzt auf die neueste Version aktualisiert.

Deinstallation #

Wie bei der Installation erfolgt auch die Deinstallation von Erweiterungen in Magento 2 über die Command Line.

Um sie zu entfernen, geben Sie nacheinander die folgenden Befehle ein:

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

2. composer remove clerk/magento2