Extension

Konfigurieren Sie Ihre Magento 1 Erweiterungseinstellungen, verwalten Sie die Daten-Synchronisationsoptionen und passen Sie Such-, Recommendations- und Logging-Funktionen an. Diese Anleitung behandelt außerdem die Installation via 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 zu erleichtern, ohne Magento Connect zu verwenden.

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

Wir empfehlen folgende Terminals: - Apple: iTerm, dieses muss aus dem Internet heruntergeladen werden; - Windows: Eingabeaufforderung, diese ist bereits auf Ihrem Computer installiert.

Das Script erstellt außerdem ein Backup des Magento-Ordners, sodass es bei Problemen wiederhergestellt werden kann.

Was Sie benötigen #

Für die Installation benötigen Sie SSH- oder SFTP-Zugang zu Ihrem Webshop, einschließlich Benutzername, Passwort und Domain.

Navigation zum Ordner #

1. Melden Sie sich zunächst über ein Terminal mit Ihrem Benutzernamen und Ihrer Domain auf Ihrem Magento-Server an. So gehen Sie vor:

ssh Stefan@mywebshop.com

2. Sie werden aufgefordert, das Passwort Ihres Benutzers einzugeben (das Terminal gibt beim Eintippen kein Feedback, registriert es aber trotzdem).

3. Navigieren Sie zum Root-Ordner von Magento. Oft erreichen Sie diesen mit folgendem Befehl:

cd /var/www/html

und anschließend:

ls

Dies zeigt Ihnen eine Liste der Ordner an, sodass Sie den richtigen finden können:

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

Nun müssen Sie in diesen Ordner wechseln; das geht mit:

cd NAME_FOLDER

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

Erweiterung installieren #

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

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

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

sh clerk_toolbox_magento.sh

3. Da Sie die Erweiterung installieren möchten, verwenden Sie -i zusammen mit der Version. Geben Sie folgende Zeile ein, wobei x.x.x für die gewünschte Version steht:

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

4. Sie werden nun aufgefordert, Ihr Passwort einzugeben. Anschließend fertigt das Script ein Backup Ihres Magento1-Ordners an und beginnt mit der Installation der Erweiterung:

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

Optionale Befehle #

Deinstallation Die Toolbox ermöglicht Ihnen auch die Deinstallation der Erweiterung. Das geht mit folgender Zeile:

sudo sh clerk_toolbox_magento.sh -u

In manchen Fällen, wenn Dateien beschädigt oder nicht vorhanden sind, können Sie eine Zwangsdeinstallation wie folgt durchführen:

sudo sh clerk_toolbox_magento.sh -u --force

Wiederherstellung Sollte in Ihrem Webshop etwas schiefgehen, können Sie ihn jederzeit über das beim Installieren erstellte Backup wiederherstellen.

Benutzen Sie dazu diesen Befehl:

sudo sh clerk_toolbox_magento.sh -r

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

sudo sh clerk_toolbox_magento.sh -b

my.clerk.io Einstellungen #

Um auf Ihre Synchronisationseinstellungen zwischen Clerk und Ihrer Magento 1 Erweiterung zuzugreifen, gehen Sie zu my.clerk.io, klicken Sie im linken Menü auf “Data” und anschließend auf “Configuration”.

Hier finden Sie Optionen, um festzulegen, wie Ihre Produkt-, Kunden- und Bestelldaten mit Clerk synchronisiert werden sollen.

Weitere Informationen zur Magento 1 Extension, erreichbar über Ihr Magento 1 Admin-Portal, finden Sie unten.

Bestellhistorie #

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

Seitengröße #

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

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

Server-Timeout #

Legen Sie fest, nach welcher Zeit ohne Antwort der Server ein Timeout setzt, um Ihre Daten zu schützen und sicherzustellen, dass Sie genügend Zeit für größere Datenmengen zur Synchronisation mit Clerk einplanen.

Voreinstellung ist 60 Sekunden.

Datenparsing #

Wählen Sie in diesem Bereich, ob Ihre Magento 1 Daten Werte automatisch parsen sollen.

Automatisches Parsen ist die Standard- und empfohlene Option.

Synchronisationszeit #

Legen Sie fest, zu welcher Tageszeit Ihre Shop-Daten mit Clerk synchronisiert werden sollen.

Die Voreinstellung ist “bei Bedarf”.

Erweiterungseinstellungen #

Wenn Sie v4.8.0 oder eine neuere Version der Erweiterung nutzen, haben Sie nach Eingabe Ihrer Public und Private Keys auf zwei Wegen Zugriff auf die unten beschriebenen Einstellungen:

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

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

Es ist egal, wo Sie Änderungen vornehmen, da die Erweiterung Änderungen aus my.clerk.io synchronisiert und umgekehrt.

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

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

Erweiterungsübersicht #

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

Clerk Einstellungen #

Stellen Sie wichtige Parameter im Abschnitt Clerk Settings der Magento 1 Erweiterung ein.

Hier finden Sie auch die Möglichkeit, die Clerk Erweiterung zu aktivieren/deaktivieren sowie Ihre öffentlichen und privaten API-Schlüssel.

• Realtime-Updates:

  • Additional Fields

• Seiten einbeziehen

  • Additional Fields

• E-Mails und Warenkörbe von Kunden erfassen

• Bestell-Sync deaktivieren

• Produkte ohne Lagerbestand einbeziehen

• Sprache & Import-URL: Diese Werte wurden wahrscheinlich bei der ersten Installation der Clerk Erweiterung und Synchronisierung zu my.clerk.io gesetzt. Sollten sich diese Werte ändern, wählen Sie einfach die neue Shop-Sprache oder tragen Sie die aktualisierte Import-URL hier ein.

Search Einstellungen #

Um Ihre Clerk Search Page, Search Page Facets und/oder Live Search zu aktivieren, wählen Sie “Yes” in den entsprechenden Dropdowns.

Search Page Einstellungen:

• Nach Auswahl von “Yes” erscheinen Felder, in die Sie den Namen des Search Page Content eintragen können, welcher dem data-template Feld im Embed-Code Ihres Contents in my.clerk.io entspricht. In diesem Beispiel search-page.

• Hier können Sie auch den Text für den " Load More"-Button sowie den Text für Suchanfragen ohne Ergebnis definieren.

Faceted Search Einstellungen:

• Nach Aktivierung der Faceted Search können Sie die Attribute festlegen, die Sie als Facetten auf Ihrer Search Page anzeigen möchten.

Sie können diesen Facetten beliebige Namen geben und die Reihenfolge bestimmen, in der sie angezeigt werden.

Facetten anpassen #

Clerk ermöglicht es Ihnen, die Facetten Ihrer Suchseite im Design anzupassen und über das Design-ID-Feld darauf Bezug zu nehmen.

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

Hinweis: Sie können jetzt die Daten für Kategorien und Seiten auf Ihrer Search Page genauso wie in Ihrer Live Search abrufen, was Ihnen einen größeren Informationsumfang zur Kundenansprache ermöglicht. Weitere Informationen finden Sie hier.

Live Search Einstellungen

• Nach Aktivierung von Live Search können Sie auswählen, ob Kategorien in den Ergebnissen angezeigt werden, sowie die Anzahl der Suchvorschläge, Kategorien und Content-Ergebnisse innerhalb von Live Search festlegen.

  • Sie haben außerdem die Möglichkeit festzulegen, welche Seitentypen als Suchergebnisse erscheinen, zum Beispiel “CMS Pages” oder “Blog Posts”.

  • Sie können die Position des Live Search Dropdowns über Ihr Suchfeld mit Dropdown Positioning bestimmen.

• Geben Sie anschließend den Content-Namen Ihrer Live Search an. Diesen finden Sie neben data-template im Live Search Embed-Code Ihres Contents bei my.clerk.io. In diesem Beispiel ist es live-search.

• Zuletzt tragen Sie Ihren Live Search Input Selector ein, den Sie durch Überprüfen des Suchfeldes Ihres Webshops im Browser und Identifizieren der zugehörigen ID oder Klasse ermitteln können. In diesem Beispiel #search.

Recommendations Einstellungen #

Ähnlich wie bei Search aktivieren Sie Ihre Clerk Powerstep, Exit Intent, Category Page, Product Page und Cart Einstellungen, indem Sie im jeweiligen Dropdown “Yes” auswählen.

Nach Auswahl von “Yes” im passenden Dropdown erscheint ein Feld, in das Sie den Elementnamen der Clerk Recommendations eingeben, die Sie auf der jeweiligen Seite integrieren möchten.

• Wie bei den Search-Funktionen finden Sie den Elementnamen direkt neben data-template im Embed-Code innerhalb von my.clerk.io > Recommendations > Elements. In diesem Beispiel haben wir Category Page Einstellungen aktiviert und category-page-popular als unser Element hinzugefügt.

• Sie können hier mehrere Elementnamen kommasepariert eingeben, um beispielsweise mehrere Elemente auf einer Seite anzuzeigen.

Logging #

Zu den Logging-Einstellungen gehören:

Logging-Level

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

• Fehler + Warnung: Zeichnet zusätzlich Warnungen auf, die das Modul zwar nicht stoppen, aber zu beheben sein könnten.

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

Logging nach

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

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

Übersetzung von Texten #

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

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

Dazu gehen Sie in diesen Ordner im FTP:

app->locale

Beginnen Sie mit dem dänischen Ordner da_DA und kopieren Sie die Datei Clerk_Clerk.csv.

Suchen Sie im Magento locale Ordner nach dem Ordner für Ihre Sprache und legen Sie die Datei dort ab.

Nun können Sie die Texte in Ihrer Sprache, in die rechte Spalte der CSV-Datei eintragen:

Upgrade #

Diese Anleitung zeigt Ihnen, wie Sie von früheren Versionen unserer Erweiterung auf die aktuelle upgraden.

Die neueste Erweiterung können Sie unter folgendem Link herunterladen:

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

Änderungen sichern #

Bevor Sie ein Upgrade durchführen, stellen Sie sicher, dass Sie entweder:

• Die geänderten Dateien lokal per FTP gesichert haben oder

• Ein Backup der veränderten Dateien erstellt haben, das Sie in die neue Erweiterung übertragen können.

In der Regel sind die Dateien, die am häufigsten geändert werden, 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 #

Bevor Sie das Upgrade durchführen, ist Folgendes sehr wichtig:

1. Deaktivieren Sie die alte Erweiterung auf der Seite System->Configuration->Clerk->Settings in Magento. Stellen Sie dazu Enable auf No und klicken Sie auf Save Config.

2. Anschließend deinstallieren Sie die Erweiterung entweder über Magento Connect oder durch Löschen der Dateien per FTP, wenn Sie sie direkt dort installiert haben.

Andernfalls könnte Ihre Seite Configuration nicht mehr funktionieren und keine der Erweiterungen mehr richtig arbeiten.

Neueste Version installieren #

Installieren Sie anschließend die neueste Erweiterung erneut und verschieben Sie alle von Ihnen gesicherten Dateien auf Ihren FTP-Server.

Ihre Einstellungen bleiben in der Regel auch beim Installieren der neuen Version erhalten.

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

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

Deinstallation #

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

Melden Sie sich im Magento 1 Portal Ihres Webshops an, und wählen Sie dann " System" > " Configuration" aus dem oberen Menü.

Auf der nächsten Seite finden Sie links im Menü " Clerk" und wählen " Settings".

Hier erscheint “Clerk Settings”. Wählen Sie neben " Enable" im Dropdown-Menü " No", um die Clerk Erweiterung nicht mehr zu aktivieren.

Wenn Sie Clerk über die Erweiterung implementiert haben, können Sie auch die einzelnen Module auf dieselbe Weise deaktivieren, indem Sie in diesem Bereich im jeweiligen Search- und Recommendations-Dropdown “No” auswählen:

Falls Sie Teile von Clerk direkt über Ihre FTP-Dateien eingebunden haben, entfernen Sie bitte auch die entsprechenden Embed-Codes aus diesen Dateien.