Extension

Konfigurieren Sie Ihre Magento 2 Erweiterungseinstellungen, verwalten Sie Optionen zur Datensynchronisierung und passen Sie Search-, Recommendations- und Protokollierungsfunktionen an. Dieser Leitfaden behandelt außerdem die Installation über das Toolbox Script, das Upgrade und das Deinstallieren.

Installation mit Toolbox #

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

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, sie 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 es zu installieren, benötigen Sie SSH- oder SFTP-Zugang zu Ihrem Webshop einschließlich Benutzername und Passwort.

Navigation zum Ordner #

1. Melden Sie sich zunächst über ein Terminal bei 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 Benutzer einzugeben (das Terminal gibt beim Eintippen des Passworts kein Feedback, aber es wird trotzdem erfasst).

Navigieren Sie zum Root-Ordner von Magento2. Dies tun Sie mit folgendem Befehl:

cd /var/www/html

und dann:

ls

Dies zeigt Ihnen eine Liste der Ordner, um Ihnen zu helfen, den richtigen zu finden:

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

Nun müssen Sie in den Ordner wechseln; das machen Sie mit folgendem Befehl:

cd NAME_FOLDER

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

Erweiterung installieren #

1. Wenn Sie sich im Root-Verzeichnis 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 im Anschluss diese Zeile ein, um eine Liste der verfügbaren Optionen im Toolbox zu sehen:

sh clerk_toolbox_magento2.sh

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

sudo sh clerk_toolbox_magento2.sh -i

4. Sie werden nun aufgefordert, Ihr Passwort einzugeben. Nachdem Sie dies getan haben, erstellt das Script ein Backup Ihres Magento2-Ordners und beginnt mit der Installation der Erweiterung:

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

Optionale Befehle #

Deinstallieren

Mit dem Toolbox Script können Sie die Erweiterung auch deinstallieren. Das machen Sie mit folgender Zeile:

sudo sh clerk_toolbox_magento2.sh -u

Wiederherstellen

Falls in Ihrem Webshop etwas schiefgeht, können Sie ihn jederzeit mit dem Backup, das bei der Installation der Erweiterung erstellt wurde, wiederherstellen.

Verwenden Sie hierfür die folgende Zeile:

sudo sh clerk_toolbox_magento2.sh -r

Backup

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

sudo sh clerk_toolbox_magento2.sh -b

my.clerk.io Einstellungen #

Um Ihre Magento 2 Daten-Einstellungen in Clerk zuzugreifen und zu ändern, gehen Sie zu my.clerk.io, klicken Sie im Menü links auf “Data” und gehen Sie dann zu “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 sowie den Zeitpunkt der Datensynchronisierung zu Clerk festlegen (Standard ist “bei Bedarf”).

Erweiterungseinstellungen #

Wenn Sie v6.7.0 oder eine neuere Version der Erweiterung verwenden, können Sie nach dem Hinzufügen Ihrer Public und Private Keys auf folgende Einstellungen auf zwei Wegen 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 die Erweiterung sämtliche Änderungen mit my.clerk.io synchronisiert und umgekehrt.

In my.clerk.io können Sie auch Ihre aktuelle Version der Erweiterung, Ihre Plattform und die PHP-Version sehen.

Klicken Sie einfach auf “Edit” neben einer Einstellung, um die verfügbaren Optionen anzuzeigen:

Übersicht #

Um Ihre Clerk-Erweiterung in Magento 2 aufzurufen, melden Sie sich im Admin-Portal Ihres Webshops an und gehen Sie dann zu Stores > Settings > Configuration > Clerk > Configuration

Allgemein #

Sie finden Ihre Clerk Extension Versionsnummer sowie Ihre öffentlichen und privaten API-Schlüssel im Bereich Allgemein.

Um Pages (Seiten) in Ihre Datensynchronisation mit Clerk einzubeziehen, wählen Sie im nächsten Dropdown “Yes” und geben Sie zusätzliche Felder an, die Sie mit Ihren Seitendaten synchronisieren möchten (z. B. Bilder oder Seitentypen), durch Kommas getrennt.

Sie können außerdem die Standardsprache für die synchronisierten Shopdaten im letzten Dropdown unter Allgemein definieren.

Synchronisierung #

Im Bereich Synchronization des Clerk Plugins können Sie synchronisierte Kunden-, Bestell-, Warenkorb- und Produktdaten anpassen.

Optionen sind ausgegraut und nicht verfügbar, wenn Webseiten-Daten verwendet werden, erkennbar an dem Häkchen auf der rechten Seite des jeweiligen Abschnitts.

Deaktivieren Sie einfach das entsprechende Kästchen, um Änderungen vorzunehmen.

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

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

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

  • Um zusätzliche Warenkorb-Felddaten hinzuzufügen, tragen Sie diese als durch Komma getrennte Werte im Bereich “additional fields” unten ein.

• Wählen Sie in den nächsten beiden Dropdowns jeweils “yes”, um nur verkäufliche Produkte und/oder nur Produkte mit Sichtbarkeit zu Clerk zu synchronisieren.

• Wenn Sie die Bestell-Synchronisierung deaktivieren müssen, können Sie dies im Dropdown durch Auswählen von “Yes” tun.

Kundensynchronisation #

Aktivieren Sie die Kundendaten-Synchronisierung, indem Sie “Yes” im Dropdown in diesem Abschnitt wählen.

Wenn Sie zusätzliche Kundenattribute in die Clerk-Synchronisation aufnehmen möchten, tragen Sie deren Werte als durch Komma getrennte Liste in das Textfeld ein.

Search #

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

• Nach der Auswahl “Enabled” geben Sie den Namen Ihres Search Page Content an, der dem data-template-Feld in Ihrem Einbettungscode Ihres Contents auf my.clerk.io entspricht. In diesem Beispiel: search-page.

• Sie können im Textfeld den anzuzeigenden Text für “load more” und “no results” festlegen.

Live search #

• Nach Auswahl von “Enabled” im Dropdown, um Live Search zu aktivieren, wählen Sie, ob Categories in Ihren Suchergebnissen angezeigt werden sollen.

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

• Es besteht auch die Möglichkeit, für welche Seiten-Typen Suchergebnisse angezeigt werden (z. B. “CMS Pages”, “Blog Posts” oder “All”).

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

• Geben Sie anschließend den Content-Namen für Ihre Live Search an. Diesen finden Sie neben data-template im Einbettungscode Ihrer Live Search innerhalb Ihres my.clerk.io Contents. Wahrscheinlich lautet dieser live-search.

• Zuletzt haben Sie die Möglichkeit, Ihren Live Search Input Selector und Form Selector anzugeben; diese finden Sie, indem Sie die Suchbox Ihres Webshops im Browser inspizieren und die zugehörige ID oder Klasse des Inputs und Formulars identifizieren.

  • In diesem Beispiel: #search als Input Selector; für den Form Selector wird die Webseite genutzt.

Facettennavigation #

Um Facetten zu Ihrer Search Page hinzuzufügen, wählen Sie zuerst das Kontrollkästchen “Enabled” unter Faceted Navigation.

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

• Nach der Hinzufügung erscheinen Ihre gewählten Attribute unter Titles. In diesem Bereich können Sie den Titel für die jeweilige Facette setzen und bestimmen, an welcher Position in der Facettenliste dieses Attribut erscheint.

Hinweis: Sie können nun Daten für Kategorien und Seiten in Ihrer Search Page genauso abrufen wie in Ihrer Live search. Damit steht Ihnen eine größere Informationsvielfalt zur Verfügung, um Ihre Kunden zu engagieren. Für weitere Informationen klicken Sie hier.

Facetten anpassen #

• Clerk ermöglicht Ihnen das Styling Ihrer Suchseiten-Facetten direkt im Design. Sie können dieses anzeigen, indem Sie sich auf das Design ID Feld beziehen.

• Die Design ID befindet sich im Clerk Backend, in der ganz linken Spalte jedes Designs auf der Design-Übersichtsseite und in der unteren linken Ecke, sobald Sie das Design zur Bearbeitung aufrufen.

Powerstep und Exit Intent #

Ähnlich wie bei Search können Sie Ihren Clerk Powerstep aktivieren, indem Sie “Yes” im Dropdown auswählen, dann die gewünschte Powerstep-Art wählen (entweder Page oder Popup).

• Geben Sie den Content-Namen für Ihren Powerstep an; diesen finden Sie im Feld data-template im Einbettungscode Ihres Powerstep Contents auf my.clerk.io. Im Beispiel: power-step-others-also-bought.

• Folgen Sie demselben Vorgehen hier für das Aktivieren Ihres Exit Intent und das Identifizieren sowie Hinzufügen des entsprechenden Exit Intent Content.

Recommendations #

Auch ähnlich wie bei Search können Sie die Clerk Product, Category und Cart Page Settings aktivieren, 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 wurden Product Page, Category Page und Cart Page aktiviert und category-page-popular als Element der Kategorie-Seite, product-page-alternatives und product-page-others-also-bought auf der Produktseite und cart-others-also-bought auf der Warenkorb-Seite angegeben.

Protokollierung #

Um die Protokollierungseinstellungen zu ändern, gehen Sie zunächst in Ihr Magento2-Backend und wählen Stores => Configuration => Clerk => Configuration:

Suchen Sie das Dropdown namens Logging Settings und wählen Sie Ihre bevorzugte Protokollierungsstufe.

Beenden Sie mit einem Klick auf Save:

Die Protokollierungseinstellungen beinhalten:

Logging Level wählen

• Only Errors: Protokolliert ausschließlich Fehler, die das korrekte Funktionieren des Moduls verhindern.

• Error + Warn: Protokolliert zusätzlich Warnungen, die zwar das Modul nicht stoppen, aber dennoch behoben werden sollten.

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

Wohin wird protokolliert

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

• my.clerk.io: Protokolliert alles im Bereich Developers->Logs des my.clerk.io Backends.

Upgrade #

Wenn Sie eine Version vor 3.0.0 verwenden, führt das Upgrade dazu, dass Ihre Designs nicht mehr funktionieren, da Clerk.js 2 verwendet wird. Wenn Sie eine ältere Version nutzen, befolgen Sie bitte stattdessen diese Anleitung.

Wichtig: Vergessen Sie nicht, Backups aller geänderten Dateien zu machen, da diese überschrieben werden.

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

So wird es gemacht:

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

2. Navigieren Sie in das Webroot-Verzeichnis (normalerweise “/var/www/your_domain/public_html”)

3. Aktivieren Sie Root Access, indem Sie su eintippen und anschließend Ihr Passwort eingeben.

4. Geben Sie die folgenden 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 von Erweiterungen in Magento 2 erfolgt auch die Deinstallation per Kommandozeile.

Geben Sie zum Entfernen der Erweiterung nacheinander die folgenden Befehle ein:

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

2. composer remove clerk/magento2