Extension

Konfigurieren Sie Ihre Magento 2 Erweiterungseinstellungen, verwalten Sie Daten-Synchronisierungsoptionen und passen Sie Such-, Recommendations- und Protokollierungsfunktionen 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 erstellt, um es einfach zu machen, die Clerk Erweiterung in Ihrem Magento-Webshop zu installieren, ohne Magento Connect zu verwenden.

Das Toolbox Script wird direkt über ein Terminal ausgeführt.

Wir empfehlen folgende:

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

- Windows: Eingabeaufforderung, 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 Benutzernamen und Passwort.

Navigieren zum Ordner #

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

Navigieren Sie zum Hauptverzeichnis (“root folder”) von Magento2. Das geht mit folgendem Befehl:

cd /var/www/html

und tippen Sie danach:

ls

Dies gibt Ihnen eine Liste von Ordnern, um Ihnen bei der Suche nach dem richtigen zu helfen:

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

Jetzt müssen Sie nur noch in den Ordner wechseln. Schreiben Sie dazu:

cd NAME_FOLDER

NAME_FOLDER ersetzen Sie durch den tatsächlichen Namen des Ordners.

Erweiterung installieren #

1. Wenn Sie sich im Hauptverzeichnis 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 danach diese Zeile ein, um eine Liste der verfügbaren Optionen innerhalb der 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 folgende Zeile ein:

sudo sh clerk_toolbox_magento2.sh -i

4. Nun werden Sie 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 kann im Magento2-Backend konfiguriert werden.

Optionale Befehle #

Deinstallation

Mit der Toolbox können Sie die Erweiterung auch deinstallieren. Das geht mit folgender Zeile:

sudo sh clerk_toolbox_magento2.sh -u

Wiederherstellung

Für den Fall, dass in Ihrem Webshop etwas schiefgeht, können Sie ihn jederzeit über das Backup wiederherstellen, das beim Installieren der Erweiterung erstellt wurde.

Verwenden Sie dazu diese Zeile:

sudo sh clerk_toolbox_magento2.sh -r

Backup

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

sudo sh clerk_toolbox_magento2.sh -b

my.clerk.io Einstellungen #

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

Hinweis: Informationen zur 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 Datensynchronisierungen und den zeitlichen Ablauf, wann Ihre Daten zu Clerk synchronisiert werden sollen (Standard ist “bei Bedarf”) einstellen.

Erweiterungseinstellungen #

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 die Erweiterung mit allen Änderungen synchronisiert wird, die in my.clerk.io vorgenommen werden – und umgekehrt.

In my.clerk.io sehen Sie außerdem Ihre aktuelle Erweiterungs-Version, 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 aufzurufen, melden Sie sich im Admin-Portal Ihres Webshops an und folgen Sie diesem Pfad: Stores > Settings > Configuration > Clerk > Configuration

Allgemein #

Im Abschnitt “General” finden Sie Ihre Clerk-Erweiterungsversion sowie die öffentlichen und privaten API-Schlüssel Ihres Shops.

Um Seiten in Ihre Datensynchronisierung mit Clerk einzubeziehen, wählen Sie im nächsten Dropdown “Yes” und geben Sie beliebige zusätzliche Felder ein, die Sie mit Ihren Seitendaten einbeziehen möchten (z. B. Bilder oder Seitentyp) als durch Komma getrennte Werte an.

Sie können außerdem im letzten Dropdown in “General” die Standardsprache für Ihre synchronisierten Shopdaten einstellen.

Legacy Authentication #

Diese Einstellung steuert, ob die Erweiterung JWT-Header-Authentifizierung oder die ältere Private-Key-Methode verwendet. Das Deaktivieren wird dringend empfohlen, da JWT einen sichereren und moderneren Authentifizierungsfluss für alle API-Anfragen zwischen Magento 2 und Clerk.io bietet.

Store ID #

Dies ist ein Legacy-Konfigurationsfeld, das in modernen Installationen von Clerk.io nicht mehr verwendet wird. Es kann ignoriert werden, da die Erweiterung die Store-Scopes automatisch mit den nativen Store- und Website-APIs von Magento identifiziert und verwaltet.

Synchronisation #

Im Abschnitt Synchronization des Clerk-Plugins haben Sie die Möglichkeit, Ihre synchronisierten Kunden-, Bestell-, Warenkorb- und Produktdaten anzupassen.

Optionen sind ausgegraut und können nicht aktualisiert werden, wenn die Websitedaten verwendet werden; dies wird durch das aktivierte Kontrollkästchen rechts in jedem Abschnitt angezeigt.

Entfernen Sie einfach das Häkchen im entsprechenden Feld, 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-Mails zu synchronisieren.

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

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

• Falls Sie die Bestell-Synchronisierung deaktivieren möchten, können Sie dies über dieses Dropdown tun, indem Sie “Yes” wählen.

Zusätzliche Felder #

Eine durch Kommas getrennte Liste zusätzlicher Produktattribute, die Sie mit Clerk.io synchronisieren möchten (zum Beispiel color, size, material). Damit können Sie diese benutzerdefinierten Attribute in Ihren Clerk.io-Designs für Recommendations, Suchfilter oder E-Mail-Kampagnen verwenden.

Search Non-Indexed Attributes #

Wenn aktiviert, stellt Clerk.io eine erweiterte Anfrage, um Werte für benutzerdefinierte Attribute zu erhalten, die nicht im Standard-Magento-Produktsatz vor-indiziert sind. Das stellt sicher, dass alle angeforderten benutzerdefinierten Felder erfolgreich synchronisiert werden – kann jedoch etwas mehr Serverressourcen erfordern.

Stellen Sie es sich so vor, als würden Sie einen sehr höflichen Assistenten bitten, sich durch die hintersten Regale Ihres Lagers zu wühlen, anstatt nur die Liste am Eingang zu lesen.

Rückgesendete Bestellungen verfolgen #

Mit dieser Option kann die Erweiterung auf die Erstellung von Gutschriften in Magento (Rückerstattungen und Retouren) reagieren. Informationen zu zurückgesendeten Produkten und Mengen werden automatisch an Clerk.io gesendet, sodass Ihre Recommendations und Analysen immer genau sind.

Bildtyp #

In diesem Dropdown können Sie auswählen, welcher Magento-Bildtyp und welche Größe (wie Base Image, Small Image oder Thumbnail) an Clerk.io übertragen werden sollen. Das ist nützlich, um die Bildqualität und das Seitenverhältnis auf Ihr Shoptheme und Design abzustimmen.

Kundensynchronisation #

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

Wenn Sie zusätzliche Kundenattribute haben, die Sie in die Clerk-Synchronisierung einbeziehen möchten, tragen Sie diese hier durch Kommas getrennt ein.

Sync Subscribers #

Aktivieren Sie diese Option, um die Newsletter-Abonnenten Ihres Shops mit Clerk.io zu synchronisieren.

Für registrierte Kunden, die auch Newsletter-Abonnenten sind, aktualisiert die Erweiterung automatisch ihr bestehendes Kundenprofil mit subscribed: true und fügt deren individuellen Abmeldelink hinzu.

Für Gastabonnenten (die nur den Newsletter abonniert, aber kein Kundenkonto haben), synchronisiert die Erweiterung diese als unabhängige Profile – in Clerk.io identifiziert durch ihre E-Mail-Adresse – mit einem SUB ID-Präfix. So wird Ihre gesamte Abonnenten-Audience erfasst, ohne doppelte Profile für registrierte Kunden zu erstellen. Das ist besonders für eine umfassende E-Mail-Marketing-Zielgruppe und individuelle E-Mail-Kampagnen hilfreich.

Search #

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

• Nachdem Sie “Enabled” gewählt haben, geben Sie den Namen des Search Page Elements ein. Dieser entspricht dem data-template-Feld aus dem Embed-Code Ihres Elements in my.clerk.io. In diesem Beispiel: search-page.

• Sie können den " load more"- und “no results"-Text anpassen, indem Sie den gewünschten Text in das jeweilige Feld eintragen.

Kategorien einbeziehen #

Aktivieren Sie diese Option, um Kategorietreffer direkt auf Ihrer Haupt-Suchergebnisseite neben den Produkten anzuzeigen. Das hilft Kunden, leichter in Ihrem Shop zu navigieren, indem relevante Kollektionen und Kategorien zum Suchbegriff angezeigt werden.

Anzahl der Kategorien #

Legt die maximale Anzahl von Kategorietreffern fest, die auf der Suchseite angezeigt werden. Beispiel: Wenn Sie 5 einstellen, werden bis zu fünf passende Kategorien angezeigt, um Usern einen schnellen Zugriff auf relevante Katalogbereiche zu ermöglichen.

Anzahl der Seiten #

Legt die maximale Anzahl von CMS- oder Inhaltsseite-Treffern auf der Suchseite fest. Ideal, um zusätzlich zu Produkten passende Blog-Artikel, Guides oder Infoseiten (z. B. Rückgabeinfos) anzuzeigen.

Seiten-Typ #

Filtert, welche Arten von CMS- oder Inhaltsseiten in den Suchergebnissen angezeigt werden sollen. Sie können auswählen, nur Standard-CMS-Seiten, bestimmte Blogartikel oder alle mit Clerk.io synchronisierten Inhaltsseiten anzuzeigen.

Live search #

• Nachdem Sie im Dropdown “Enabled” ausgewählt haben, um Live Search zu aktivieren, wählen Sie aus, ob Sie Categories in den Suchergebnissen anzeigen möchten.

  • Sie können außerdem die Anzahl der Suchvorschläge, Kategorien und Inhaltsseiten wählen, die innerhalb von Live Search zusätzlich zu den Produkt-Treffern angezeigt werden sollen.

• Außerdem können Sie auswählen, welche Seiten-Typen die Suchergebnisse anzeigen, z. B. “CMS Pages”, “Blog Posts” oder “All”.

• Mit Dropdown Positioning können Sie die Position des Live-Search-Dropdowns im Verhältnis zu Ihrer Suchbox festlegen.

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

• Abschließend können Sie Ihren Live Search Input Selector sowie Form Selector eintragen, die Sie beim Inspizieren der Suchbox Ihres Webshops mit dem Browser finden – hierbei handelt es sich um die ID oder Klasse des Inputfelds und Formulars.

  • In diesem Beispiel: #search als Input Selector und das Verwenden der Website für den Form Selector.

Facettierte Suche #

Um Facetten zu Ihrer Suchseite hinzuzufügen, markieren Sie zunächst das “Enabled”-Kästchen unter Faceted Navigation.

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

• Nach dem Hinzufügen erscheinen Ihre Attribute unter Titles. Dort können Sie den anzuzeigenden Titel für die jeweilige Facette festlegen und auswähle, an welcher Position in der Facettenliste das Attribut angezeigt wird.

Facets In Url #

Wenn diese Funktion aktiviert ist, werden die ausgewählten Suchfacetten (Filter) direkt an die URL-Query-Parameter angehängt. Dadurch können Kunden ihre gefilterten Suchergebnisse als Lesezeichen speichern, aktualisieren oder teilen, wobei der Filterstatus erhalten bleibt.

Multiselect Attributes #

Erlaubt es Ihnen auszuwählen, welche Suchfacetten die gleichzeitige Auswahl mehrerer Optionen unterstützen sollen (z. B. Filterung nach “Rot” und “Blau”). Das sorgt für ein flexibleres und benutzerfreundlicheres Filtern.

Hinweis: Sie können jetzt die Daten für Kategorien und Seiten auf Ihrer Suchseite genauso wie in Ihrer Live Search abrufen, was Ihnen eine größere Informationsvielfalt für Ihre Kunden bietet. Weitere Informationen finden Sie hier.

Facetten anpassen #

• Clerk ermöglicht es, Ihre Suchseiten-Facetten direkt im Design zu gestalten; Sie können dies über das Design ID-Feld referenzieren.

• Die Design-ID finden Sie im Clerk Backend, ganz links bei jedem Design auf der Designübersichtsseite und unten links, sobald Sie ein Design zum Bearbeiten aufgerufen haben.

Powerstep und Exit Intent #

Ähnlich wie Search lässt sich Ihr Clerk Powerstep aktivieren, indem Sie im Dropdown “Yes” auswählen. Dann können Sie den Typ des Powersteps festlegen (Page oder Popup).

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

• Gehen Sie beim Aktivieren Ihres Exit Intent genauso vor und identifizieren und tragen Sie das entsprechende Exit Intent Element ein.

Powerstep Filter Duplicates #

Durch Aktivieren dieser Option werden doppelte Produkte daran gehindert, innerhalb mehrerer Slider im Powerstep empfohlen zu werden. Wenn ein Produkt bereits in einem Slider angezeigt wurde, wird es von Clerk.io automatisch aus weiteren Slidern auf derselben Seite herausgefiltert.

Recommendations #

Auch ähnlich zu Search können Sie Ihre Clerk Product, Category und Cart Page Settings aktivieren, indem Sie das jeweilige Dropdown auf “Enabled” setzen.

• Genau wie bei den Search-Funktionen finden Sie den Elementnamen neben data-template im Embed-Code in my.clerk.io > Recommendations > Elements.

  • In diesem Beispiel haben wir die Einstellungen für Produkt-, Kategorie- und Warenkorbseite aktiviert und z. B. category-page-popular für die Kategorieseite, product-page-alternatives und product-page-others-also-bought auf der Produktseite sowie cart-others-also-bought als Kategorie-Element eingebunden.

Category Filter Duplicates #

Bei Aktivierung verhindert diese Einstellung, dass doppelte Produkte über mehrere Sliders auf Ihren Kategorieseiten empfohlen werden. So wird sichergestellt, dass Kunden eine vielfältige Produktauswahl statt mehrfach derselben Artikel sehen.

Product Filter Duplicates #

Ist diese Option aktiviert, werden doppelte Produkte daran gehindert, über mehrere Sliders auf Ihren Produktdetailseiten empfohlen zu werden. Das hält Ihre Empfehlungen frisch und erhöht die Chance, dass verschiedene Produkte das Interesse Ihrer Kunden wecken.

Cart Filter Duplicates #

Durch Aktivierung dieser Option werden doppelte Produkte daran gehindert, auf mehreren Slidern der Warenkorbseite empfohlen zu werden. Das ist besonders effektiv für Cross-Selling, da so eine größere und attraktivere Auswahl an Last-Minute-Ergänzungen geboten wird.

Schließlich: Wenn ein Kunde bereits beim ersten Slider keinen neongrünen Toaster kauft, wird er es beim dritten Mal vermutlich auch nicht tun – und Sie vermeiden, dass Ihr Shop verrückt wirkt.

Protokollierung (Logging) #

Als Erstes müssen Sie, um die Logging-Einstellungen zu ändern, ins Magento2-Backend gehen und Stores => Configuration => Clerk => Configuration auswählen:

Suchen Sie das Dropdown Logging Settings und wählen Sie die gewünschte Logging-Einstellung.

Beenden Sie mit Save:

Die Logging-Einstellungen beinhalten:

Logging-Level wählen

• Nur Errors: Es werden nur Fehler geloggt, die das korrekte Funktionieren des Moduls verhindern.

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

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

Log-Speicherort wählen

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

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

Log File Link #

Zeigt den absoluten Pfad zur lokalen Log-Datei auf Ihrem Magento-Server an (typisch /var/log/clerk_log.log). So können Entwickler oder Administratoren beim Debuggen der Erweiterungs-Funktionalität die Roh-Logdateien leicht finden und prüfen.

Upgrade #

Wenn Sie eine Version vor 3.0.0 verwenden, wird das Upgrade Ihre Designs beeinträchtigen, da Clerk.js 2 verwendet wird. Bei älteren Versionen folgen Sie bitte stattdessen dieser Anleitung.

Wichtig: Denken Sie daran, Backups aller geänderten Dateien zu machen, da diese beim Upgrade überschrieben werden.

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

Gehen Sie dazu folgendermaßen vor:

1. Loggen Sie sich per Kommandozeile auf Ihrem Server ein.

2. Navigieren Sie in Ihr Webroot-Verzeichnis (in der Regel “/var/www/your_domain/public_html”)

3. Aktivieren Sie den Root-Zugang, indem Sie su eingeben und anschließend Ihr Passwort.

4. Geben Sie nacheinander die folgenden Befehle ein:

   composer update clerk/magento2

   php bin/magento setup:upgrade

   php bin/magento setup:di:compile

5. Warten Sie, bis die Erweiterung das Upgrade abgeschlossen hat.

Ihr Magento 2 ist nun auf die neueste Version aktualisiert.

Deinstallation #

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

Geben Sie einfach die folgenden Befehle nacheinander ein, um die Deinstallation durchzuführen:

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

2. composer remove clerk/magento2