Extension

Konfigurieren Sie Ihre Magento 1 Extension-Einstellungen, verwalten Sie Optionen zur Datensynchronisierung 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 entwickelt, um die Installation der Clerk Extension in Ihrem Magento-Webshop zu erleichtern, ohne Magento Connect zu verwenden.

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

Wir empfehlen folgende Terminals: - Apple: iTerm, das Sie aus dem Internet herunterladen müssen; - Windows: Eingabeaufforderung, die bereits auf Ihrem Computer installiert ist.

Das Script erstellt außerdem ein Backup des Magento-Ordners, sodass dieser 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, Passworts und Domain-Namens.

Navigation zum Ordner #

1. Melden Sie sich zunächst über ein Terminal mit Ihrem Benutzernamen und Ihrer Domain auf Ihrem Magento-Server an, indem Sie Folgendes eingeben:

ssh Stefan@mywebshop.com

2. Sie werden aufgefordert, das Passwort für Ihren Benutzer einzugeben (das Terminal gibt beim Eingeben des Passworts kein Feedback, aber es wird trotzdem registriert).

3. Navigieren Sie zum Root-Ordner von Magento. Oft gelingt dies, indem Sie schreiben:

cd /var/www/html

und anschließend:

ls

Mit dem Befehl ls werden Ordner aufgelistet, sodass Sie Ihr Magento-Rootverzeichnis finden können.

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

Nun müssen Sie in den Ordner wechseln, das tun Sie mit:

cd NAME_FOLDER

NAME_FOLDER wird hier durch den echten Namen des Ordners ersetzt.

Extension installieren #

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

sudo wget https://raw.githubusercontent.com/clerkio/clerk-magento/master/clerk_toolbox_magento.sh

2. Geben Sie anschließend folgende Zeile ein, um alle verfügbaren Optionen im Toolbox Script anzuzeigen:

sh clerk_toolbox_magento.sh

3. Da Sie die Extension installieren möchten, verwenden Sie -i zusammen mit der gewünschten Version. Geben Sie folgende Zeile ein, wobei x.x.x die zu installierende Version ist:

sudo sh clerk_toolbox_magento.sh -i x.x.x

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

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

Optionale Befehle #

Deinstallation: Mit der Toolbox können Sie die Extension auch deinstallieren. Dies funktioniert mit folgendem Befehl:

sudo sh clerk_toolbox_magento.sh -u

In manchen Fällen können Sie bei beschädigten oder fehlenden Dateien eine forcierte Deinstallation wie folgt durchführen:

sudo sh clerk_toolbox_magento.sh -u --force

Wiederherstellung: Wenn in Ihrem Webshop etwas schiefgeht, können Sie ihn jederzeit anhand des Backups wiederherstellen, das bei der Extension-Installation erstellt wurde.

Nutzen Sie hierfür folgende Zeile:

sudo sh clerk_toolbox_magento.sh -r

Backup: Beim Installieren der Extension erstellt das Script immer zuerst ein Backup, Sie können aber auch separat ein Backup anlegen mit:

sudo sh clerk_toolbox_magento.sh -b

my.clerk.io Einstellungen #

Um Ihre Sync-Einstellungen zwischen Clerk und Ihrer Magento 1 Extension aufzurufen, gehen Sie zu my.clerk.io, klicken Sie im linken Menü auf “Data” und wählen Sie dann “Configuration”.

Hier finden Sie Optionen, mit denen Sie bestimmen können, wie Ihre Produkt-, Kunden- und Bestelldaten mit Clerk synchronisiert werden.

Die unten aufgeführten Einstellungen sind in der Magento 1 Extension über Ihr Magento 1 Admin-Portal verfügbar.

Bestellhistorie #

Wählen Sie, wie weit zurück Sie Bestelldaten aus Ihrem Shop zu Clerk rückwirkend synchronisieren möchten.

Seitengröße #

Wählen Sie die Seitengröße Ihrer synchronisierten Daten im Dropdown-Menü unten.

Kleinere Seitengrößen können helfen, Host-Timeouts während der Synchronisierung zu vermeiden, während größere Seitengrößen schneller synchronisieren können.

Server-Timeout #

Legen Sie die Zeitspanne ohne Antwort fest, bevor der Server ein Timeout verursacht. Dies dient dem Schutz Ihrer Daten und stellt sicher, dass bei größeren Datenmengen genügend Synchronisierungszeit für Clerk eingeräumt wird.

Standard ist 60 Sekunden.

Daten-Parsing #

Wählen Sie, ob Ihre Magento 1 Daten automatisch geparst werden sollen.

Automatisches Parsing ist die Standard- und empfohlene Option.

Synchronisierungszeit #

Legen Sie fest, zu welcher Tageszeit Ihre Shopdaten mit Clerk synchronisiert werden sollen.

Standard ist „bei Bedarf“.

Extension-Einstellungen #

Wenn Sie v4.8.0 oder eine neuere Version der Extension nutzen, können Sie nach Hinzufügen Ihrer Public- und Private Keys auf diese Einstellungen auf zwei Wegen zugreifen:

• Über das Magento-Backend unter Clerk > Configuration > Settings

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

Egal, wo Sie Änderungen vornehmen: Die Extension synchronisiert alle Änderungen, die in my.clerk.io vorgenommen wurden, und umgekehrt.

In my.clerk.io sehen Sie auch Ihre aktuelle Extension-Version, Ihre Plattform und die PHP-Version.

Klicken Sie bei einer Einstellung auf Edit, um die verfügbaren Optionen anzuzeigen.

Extension-Übersicht #

Um auf Ihre Magento 1 Clerk Extension zuzugreifen, melden Sie sich im Admin-Konto Ihres Shops an und wählen Sie “Configuration” > “Clerk” > “Settings”.

Clerk-Einstellungen #

Legen Sie die wichtigsten Parameter im Abschnitt Clerk Settings der Magento 1 Extension fest.

Hier lassen sich die Aktivierung/Deaktivierung der Clerk Extension sowie Ihre öffentlichen und privaten API-Keys einstellen.

• Echtzeit-Updates:

  • Zusätzliche Felder

• Seiten einbeziehen

  • Zusätzliche Felder

• E-Mails und Warenkörbe der Kunden erfassen:

• Sync Subscribers: Importiert den Status der Newsletter-Abonnenten zur Verwendung in Clerk.io E-Mail Audiences.

• Bestell-Sync deaktivieren:

• Produkte mit Lagerbestand anzeigen

• Nur Produkte mit Sichtbarkeit synchronisieren: Beschränkt den Produktfeed auf Produkte mit den ausgewählten Magento-Sichtbarkeitswerten.

• Return Tracking aktivieren: Sendet retournierte Artikel an Clerk.io, wenn Magento eine Rücksendung registriert.

• Benutzerdefinierte Bildbreite/-höhe: Legt die Maße für Bilder im Produktfeed fest. Lassen Sie beide Felder leer, um die Extension-Standardgröße von 210 Pixel zu verwenden.

• Sprache & Import-URL: Diese wurden wahrscheinlich beim ersten Installieren der Clerk-Extension gesetzt und mit my.clerk.io synchronisiert. Sollten sie sich ändern, wählen Sie einfach die neue Shopsprache oder tragen Sie die aktualisierte Import-URL hier ein.

Search-Einstellungen #

Aktivieren Sie Ihre Clerk Search Page, Search Page Facets und/oder Live Search, indem Sie in den jeweiligen Dropdowns „Yes“ auswählen.

Suchseiteneinstellungen:

• Nach Auswahl von Yes tragen Sie den Elementnamen der Search Page aus dem data-template Feld des Embed Codes ein. Zum Beispiel verwenden Sie search-page, wenn das Ihr Elementname ist.

• Hier können Sie auch den Text für den " Load More"-Button und den Text, der angezeigt wird, wenn für eine Abfrage keine Ergebnisse gefunden werden, anpassen.

• Show Categories, Number of Categories, Number of Pages und Pages Type steuern, welche Nicht-Produkt-Ergebnisse auf der Suchseite angezeigt werden.

Einstellungen für Facettierte Suche:

• Nach der Aktivierung der facettierten Suche können Sie die Attribute eingeben, die Sie als Facetten auf Ihrer Suchseite anzeigen lassen möchten.

Sie können diese Facetten auch beschriften und die Reihenfolge der Facetten festlegen.

Mit Multiselect Attributes können Besucher mehr als einen Wert innerhalb einer Facette gleichzeitig auswählen.

Facetten anpassen #

Clerk erlaubt es Ihnen, Ihre Suchseiten-Facetten im Design zu gestalten — Sie können dies anzeigen, indem Sie mit dem Design-ID-Feld darauf referenzieren.

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 zum Bearbeiten öffnen.

Hinweis: Ab sofort können Sie die Daten für Kategorien und Seiten in Ihrer Suchseite genauso wie bei der Live-Suche aufrufen. Damit erweitern Sie die Informationsvielfalt, mit der Sie Ihre Kunden ansprechen können. Für weitere Informationen sehen Sie hier nach.

Live-Suche-Einstellungen

• Nach Aktivierung der Live Search können Sie einstellen, ob Categories in den Ergebnissen erscheinen sowie wie viele suggestions, categories und content-Ergebnisse in der Live Search angezeigt werden.

  • Sie können auch festlegen, welche page types als Suchergebnisse angezeigt werden, zum Beispiel “CMS Pages” oder “Blog Posts”.

  • Mit Dropdown Positioning wählen Sie die Position des Live-Suche-Dropdowns am Suchfeld.

• Geben Sie als nächstes den Elementnamen für Ihre Live Search an; diesen finden Sie neben data-template in Ihrem Live Search Embed-Code im my.clerk.io Element. Wahrscheinlich ist das live-search.

• Den Live Search Input Selector ermitteln Sie, indem Sie das Suchfeld Ihres Webshops inspizieren und die Input-ID oder Klasse ausfindig machen. Für ein Input mit der ID search verwenden Sie #search.

• Form Selector ist der Selector für das Suchformular. Nutzen Sie ihn, wenn Ihr Theme ein eigenes Formular verwendet und die Standard-Weiterleitung der Suche nicht korrekt ist.

Recommendations-Einstellungen #

Ähnlich wie bei Search, aktivieren Sie die Clerk-Einstellungen für Powerstep, Exit Intent, Category Page, Product Page und Cart, indem Sie für die jeweiligen Dropdowns „Yes“ auswählen.

Nach Auswahl von „Yes“ erscheint ein Feld, in das Sie den Elementnamen für die Clerk Recommendations auf der jeweiligen Seite eintragen.

• Den Namen des Elements finden Sie in der data-template Angabe des Embed Codes unter Recommendations > Elements in my.clerk.io. Tragen Sie beispielsweise für die Category Page in den Einstellungen category-page-popular ein, wenn das der Name Ihres Elements ist.

• Sie können hier bei Bedarf mehrere Elementnamen als kommagetrennte Werte eintragen, wenn Sie auf der Seite mehrere Elemente anzeigen möchten.

• Doppelte filtern ist für Powerstep, Category Page, Product Page und Cart verfügbar. Aktivieren Sie dies, um zu verhindern, dass dasselbe Produkt mehrfach in mehreren Recommendation-Slidern auf der Seite erscheint.

Protokollierung #

Die Protokollierungseinstellungen umfassen:

Protokollierungsstufe

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

• Fehler + Warnungen: Protokolliert zudem Warnungen, die das Modul nicht stoppen, aber dennoch behebungswürdig sind.

• Fehler + Warnungen + Debug: Protokolliert alles, womit das Modul interagiert. Dies sollte in einem Live-Shop nicht aktiviert werden, da es die Seite verlangsamt.

Protokollierung nach

• Datei: Speichert das Protokoll als Datei auf dem Magento-Server.

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

Setzen Sie Enable auf Yes, bevor Sie die Protokollierung verwenden. Beim Protokollieren in eine Datei wird der Pfad genutzt, der in der Konfiguration angezeigt wird. Debug Mode öffnet die Debugging-Anleitung der Extension.

Übersetzung von Texten #

Die Clerk für Magento Erweiterung enthält bereits Übersetzungen für dänisch, englisch, niederländisch und italienisch.

Sie können problemlos eine Übersetzung für Ihre eigene Sprache hinzufügen, sodass die Frontend-Bereiche korrekt angezeigt werden.

Gehen Sie dafür im FTP in den folgenden Ordner:

app->locale

Gehen Sie zunächst in den dänischen Ordner da_DA und kopieren Sie die Datei Clerk_Clerk.csv.

Suchen Sie den Ordner für Ihre Sprache (im Magento locale Ordner) und fügen Sie die Datei dort ein.

Übersetzen Sie die Texte in der rechten Spalte der CSV-Datei und speichern Sie ab.

Aktualisierung #

Dieser Leitfaden zeigt Ihnen, wie Sie von einer früheren Version der Extension zur neuesten Version aktualisieren.

Sie können die aktuelle Extension unter folgendem Link herunterladen:

https://github.com/clerkio/clerk-magento/releases/latest

Änderungen speichern #

Bevor Sie ein Upgrade versuchen, stellen Sie sicher, dass Sie entweder:

• Die geänderten Dateien lokal auf Ihrem FTP gespeichert haben oder

• Ein Backup aller geänderten Dateien erstellt haben, das Sie in die neue Extension übernehmen können.

In der Regel sind dies die von Entwicklern am häufigsten geänderten Dateien: Product.php und Productbase.php, welche die Produktattribute steuern.

Diese Dateien finden Sie hier:

app->code->community->Clerk->Clerk->Model->Catalog->Product.php

app->code->community->Clerk->Clerk->Model->Catalog->Productbase.php

Deaktivieren und deinstallieren #

Vor einem Upgrade ist es sehr wichtig, dass Sie Folgendes tun:

1. Deaktivieren Sie die alte Extension auf der Seite System->Configuration->Clerk->Settings in Magento. Setzen Sie dafür einfach Enable auf No und klicken Sie auf Save Config.

2. Deinstallieren Sie sie anschließend entweder über Magento Connect oder durch Löschen der Dateien vom FTP, falls Sie diese direkt hier installiert haben.

Andernfalls kann es sein, dass Ihre Configuration-Seite nicht mehr funktioniert und keine der Extensions danach funktioniert.

Neueste Version installieren #

Installieren Sie abschließend die aktuelle Extension erneut und kopieren Sie alle gesicherten Dateien auf Ihren FTP-Server.

Ihre Konfiguration sollte auch nach einer Neuinstallation erhalten bleiben.

Überprüfen Sie System->Configuration->Clerk, um sicherzustellen, dass alles noch vorhanden ist.

Nun haben Sie die aktuelle Version von Clerk für Magento installiert!

Deinstallation #

Um Clerk aus Ihrem Magento 1 Shop zu entfernen, müssen Sie die Extension im Admin-Portal von Magento 1 deaktivieren.

Melden Sie sich im Magento 1 Portal Ihres Webshops an und wählen Sie anschließend oben im Menü „ System" > " Configuration“.

Suchen Sie auf der nächsten Seite im linken Menü nach „ Clerk“ und wählen Sie „ Settings“.

Hier erscheint „Clerk Settings“. Wählen Sie neben „ Enable“ im Dropdown-Menü „ No“, um die Clerk Extension zu deaktivieren.

Wenn Sie Clerk.io über die Extension implementiert haben, können Sie einzelne Module auch deaktivieren, indem Sie die entsprechenden Search- und Recommendations-Dropdowns auf No setzen.

Wenn Sie einzelne Elemente von Clerk direkt über Ihre FTP-Dateien installiert haben, achten Sie darauf, die entsprechenden Embed-Codes aus diesen Dateien zu entfernen.