Magento 2 Integrationsanleitung (v1)

Von Magento benötigen Sie:

• Einen Magento Store der Version 2.1.x oder höher.
• PHP-Versionen 5.6.0 und 7.0.17.
• php5-curl muss auf Ihrem Magento Server installiert sein.
• PHP SOAP Extension muss aktiviert sein.
• Das Sabre/DAV-Modul muss in Magento installiert sein.
• TCP Port 21, 32000-35000 müssen offen sein (diese werden für den Datentransfer über FTPES benötigt).
• Setzen Sie Ihre Magento Crons so, dass sie jede Minute ausgeführt werden.
• Definieren Sie für das PHP-Speicherlimit Ihrer Server ein Minimum von 512 MB: Einige Extension-Jobs sind umfangreich und benötigen mehr PHP-Speicher.
• Schließen Sie folgenden Pfad von sämtlichen Caching-Mechanismen aus, die Sie verwenden: app/code/Emarsys/Emarsys/view/frontend/templates/emarsys/javascripttracking.phtml. Unter diesem Pfad werden die dynamischen Data Collection Scripts gespeichert und das Caching verhindert ihre Ausführung.
• Stellen Sie sicher, dass jedes Mal, wenn im Magento Shop ein Artikel zum Warenkorb hinzugefügt wird, die Seite aktualisiert wird. Dies ist erforderlich, damit die Web Extend Data Collection Scripts korrekt ausgeführt werden.

Von Emarsys benötigen Sie Folgendes:

• Einen vollständig eingerichteten und funktionsfähigen Account für die Emarsys Marketing Plattform.

• Ihre Emarsys Merchant ID (diese finden Sie in Ihrem Emarsys Account, Menü Admin > Seite Datenquellen).
• Ihren Emarsys WebDAV-Ordner und die zugehörigen Credentials (für den ersten Upload von Kontaktdaten und Massenexporte).
• Ihre Emarsys API Credentials (für die laufende Synchronisierung der Kontaktdaten).
• Ihren Emarsys FTP-Ordner und die zugehörigen Credentials (gilt nur für Kunden von Smart Insight).

• Das Installationspaket (Sie können es hier herunterladen oder als komprimierte Datei vom Emarsys Support beziehen).
• Fügen Sie die IP-Adresse 185.4.123.111 und den Bereich 217.175.192.0/24 zur Whitelist hinzu (diese werden für die Opt-in-Synchronisierung von Emarsys zurück zu Magento benötigt).

Darüber hinaus müssen Sie in Ihrem Emarsys Account Folgendes erstellen:

• Einen externen Event und eine Kampagne für jeden Ihrer zugeordneten Magento Events (siehe unten).
• All jene benutzerdefinierten Datenfelder, die Sie später den Magento Kundenfeldern zuordnen wollen.
• Benutzerdefinierte Felder des Typs Textfeld kurz (max. 60 Zeichen) mit den folgenden Namen:
  • Magento Customer ID
  • Magento Customer Unique ID
  • Magento Subscriber ID

Wenn Sie mehrere Magento Stores in verschiedenen Gebietsschemas und mit unterschiedlichen Sprachen und Währungen mit demselben Emarsys Account verbinden, muss es uns möglich sein, das Kundenverhalten und die E-Commerce-Daten zwischen diesen Stores zu vergleichen.

Dafür muss Ihr Produktkatalog Werte in allen von Ihnen unterstützten Sprachen enthalten, und all Ihre E-Commerce-Daten (Produktdaten und Sales-Daten) sowie Daten zum Webverhalten müssen in derselben Währung und Sprache an Emarsys gesendet werden. Darüber hinaus bitten wir Sie, auch Folgendes zu beachten:

• Produktkatalog - Für all Ihre Magento Stores oder Websites, die mit denselben API Credentials konfiguriert sind, wird ein einzelner Produktdaten-Feed erstellt; dieser enthält lokalisierte Werte für jene Spalten, die dies erfordern. Von Ihrer Seite ist dazu nichts weiter erforderlich, außer sicherzustellen, dass dieselben API Credentials verwendet werden. Weitere Informationen erhalten Sie in: Ihren Produktkatalog vorbereiten: Lokalisierung.
• E-Commerce- und Verhaltensdaten - Um sicherzustellen, dass Produkt- und Sales-Daten auf konsistente Weise gesammelt und analysiert werden, müssen Sie beim Aktivieren der Web Extend Data Collection die Option Use base currency auf Yes setzen. Das gibt alle Preise in der Währung Ihres Standard-Magento-Stores weiter.
• Web Extend Daten: Sprache - Der Befehl Category wird in der Sprache Ihres Standard-Magento-Stores gesendet.

• In Github navigieren Sie zu emarsys/app/code/Emarsys und kopieren den Ordner Emarsys in Ihr Verzeichnis app/code in Magento.

• Öffnen Sie eine Befehlszeile, öffnen Sie das Verzeichnis der Magento 2 Installation (z.B. /var/www/html/magento2 im oben angeführten Beispiel) und fügen Sie folgenden Befehl aus, um die WebDAV-Dependenz zu erstellen: composer require sabre/dav ~3.2.0.
• Im gleichen Ordner führen Sie sodann folgenden Befehl aus: composer Update.
• Im Magento Marktplatz geben Sie Ihre Magento Authentifizierungsschlüssel (sowohl öffentlich wie privat) ein. Die entsprechende Anleitung erhalten Sie hier.
• Installieren Sie nun das Emarsys Modul mit dem Befehl: php bin/magento setup:upgrade.
• Stellen Sie dann die übrigen erforderlichen Dateien (js und andere statische Dateien) im Ordner pub mit folgendem Befehl bereit: php bin/magento setup:static-content:deploy.
• Aktualisieren Sie die Berechtigungen für die Ordner var und pub mit dem Befehl: sudo chmod 777 -R var pub.
• Zum Schluss leeren Sie den Cache mit folgendem Befehl: php bin/magento cache:flush.

Sobald Sie die Befehle wie oben beschrieben ausgeführt haben, können Sie den Status Ihres Magento Systems überprüfen, bevor Sie fortfahren. Dafür gibt es das neue Menü Emarsys, das im Magento Backend verfügbar ist.

Öffnen Sie das Menü Emarsys und gehen Sie zu Operations > Installation Checklist. Hier können Sie den Status Ihrer Installation sehen.

• System Requirements - Überprüft, ob die Anforderungen Magento erfüllt sind.
• Extension Settings - Anfangs zeigt das die Standardwerte an, die vom Installationspaket gesetzt wurden. In einer späteren Phase der Installation werden Sie diese an Ihre Anforderungen anpassen.
• Mandatory Emarsys Customer Fields - Zeigt Yes an, wenn die Felder gefunden und während der Installation von der Extension zugeordnet wurden. Falls nicht, können Sie diese in Emarsys direkt über die Checkliste erstellen.

Als Teil des Integrationspakets werden die Web Extend Data Collection Scripts auf Ihrer Magento Site installiert. Diese tracken eine Vielzahl von Browse- und Kaufaktivitäten (inklusive der Guest-Checkouts). Weitere Informationen zu diesen JavaScript-Befehlen bzw. ihrer Installation erhalten Sie in Web Extend JavaScript API Reference.

• Für die Benutzer von Predict bilden diese Scripts die Basis für die Produktempfehlungen.
• Für die Benutzer von Smart Insight bieten sie Umsatz- und Umsatzzuordnungsdaten.
• Für alle Emarsys Benutzer stellen Sie die Werte für den Standardsatz der Verhaltensfelder.

Um die Scripts zu aktivieren, öffnen Sie das Menü Emarsys, gehen Sie zu Settings > Web Extend und nehmen Sie folgende Einstellungen vor.

• Enable Web Extend JavaScript integration? - Setzen Sie diese Option auf Yes.
• Merchant ID - Ihre Emarsys Merchant ID (diese finden Sie im Menü Admin > Seite Datenquellen in Ihrem Emarsys Account).
• Test Mode - Wenn diese Option auf Yes gesetzt ist, aktiviert sie den Befehl testMode der JavaScript API Referenz; auf diese Weise können Sie Ihren Account testen, ohne die Datenkonsistenz zu gefährden. Für eine Live-Integration muss der Wert auf No gesetzt sein.
• Identify Registered Logged In Customer By - Der externe Key, der den Kontakt in Emarsys identifiziert. In dem meisten Fällen empfehlen wir, Email Address zu verwenden. Siehe Key Identifier auswählen weiter unten.

• Item Unique Identification - Der Key, der die Artikel mit Ihrem Produktdaten-Feed abgleicht.

• Use Base Currency - Nur relevant, wenn Sie über mehrere Magento Stores verfügen, die einem einzigen Emarsys Account zugeordnet sind.
  • Bei Yes werden alle Preise in Ihre Store-Standardwährung konvertiert, bevor sie an Emarsys gesendet werden.
  • Bei No werden die Preise in der Währung des lokalen Stores gesendet.
• Track Prices With Taxes - Wenn Sie Stores in verschiedenen Regionen haben, für die unterschiedliche Umsatzsteuersätze gelten, können Sie entscheiden, diese Steuern wegzulassen und nur die Nettopreise an Emarsys zu senden.
  • Bei Yes werden alle Preise inklusive Steuern gesendet.
  • Bei No werden alle Preise exklusive Steuern gesendet.
• Use Ajax Update - Falls es Ihnen nicht möglich war, den Vorlagenpfad vom Caching auszuschließen, wie oben in Anforderungen - Magento 2 beschrieben, sorgt diese Einstellung dafür, dass die Web Extend Daten nicht zwischengespeichert werden.
  • Bei Yes wird die browserseitige Aktualisierung der Produktempfehlungen aktiviert und es werden keine Web Extend Daten zwischengespeichert.
  • Bei No riskieren Sie, dass Daten zwischengespeichert werden, was zu inkonsistenten Daten in Emarsys führen kann.

Wenn Sie Ihre Einstellungen vorgenommen und Save Config geklickt haben, werden die Web Extend Scripts zu den Themes & Templates Ihrer Site hinzugefügt und die Datensammlung startet umgehend.

Wenn Sie ein Predict Kunde sind, können Sie auch definieren, welche Widgets für die Anzeige der Produktempfehlungen auf Ihren verschiedenen Webseiten verwendet werden.

Öffnen Sie dafür das Menü Emarsys und gehen Sie zu Settings > Predict.

Wählen Sie für jeden Seitentyp das Widget aus, das installiert werden soll.

Im Abschnitt Emarsys API Settings nehmen Sie folgende Einstellungen vor.

• Enabled - Setzen Sie diese Option auf Yes, um das Plugin zu aktivieren.
• API Endpoint - Folgende Werte sind möglich:
  • Default - Das ist die empfohlene Option; es wird die Standard Emarsys API URL für Ihr Environment verwendet (z.B. https://suitexx.emarsys.net/api/v2).
  • Custom URL - Das ermöglicht Ihnen, die Standard-URL anzupassen.
  • CDN - Für Kunden außerhalb von Europa (z.B. in den APAC-Ländern) können Sie ein CDN verwenden und so die Leistung verbessern. Wenn Sie meinen, dass dies die bessere Option für Sie ist, kontaktieren Sie bitte den Emarsys Support, der dann einige Einstellungen auf unserer Seite für Sie konfigurieren muss.
• Custom API URL - Wenn Sie oben die entsprechende Option ausgewählt haben, geben Sie hier die geänderte Standard-URL ein. Vergewissern Sie sich, dass sich am Ende der URL kein nachgestellter Schrägstrich (/) befindet, denn dann wird bei der Feldzuordnung ein Fehler zurückgegeben.
• API Username und API Password - Geben Sie Ihre Emarsys API Credentials ein (nicht Ihre Emarsys Account Credentials). Diese sollten Sie beim Onboarding vom Emarsys Support erhalten haben.
  Ihr Emarsys Account Owner kann ebenfalls neue API-Benutzer und -Passwörter erstellen, und zwar über das Menü Admin > Seite Sicherheitseinstellungen, siehe: API-Benutzer.
• Klicken Sie Save Config, um Ihre Einstellungen zu speichern.
• Klicken Sie Test connection, um zu überprüfen, ob Sie die Credentials korrekt eingegeben haben.
  Wenn Magento und Ihr Account der Emarsys Marketing Plattform erfolgreich verbunden wurden, sehen Sie eine gelbe Bestätigungsnachricht ganz oben auf der Seite:

Wenn keine Verbindung hergestellt werden kann, sehen Sie stattdessen eine Fehlermeldung:

Im Abschnitt WebDAV Settings nehmen Sie folgende Einstellungen vor.

• WebDAV URL, WebDAV User und WebDAV Password - Geben Sie Ihre WebDAV Credentials ein, die Sie vom Emarsys Support erhalten haben. Ihr Emarsys Account Owner kann ebenfalls neue API-Benutzer und -Passwörter erstellen, und zwar über das Menü Admin > Seite Sicherheitseinstellungen, siehe: WebDAV-Benutzer.
• Klicken Sie Save Config, um Ihre Einstellungen zu speichern.
• Klicken Sie Test connection, um zu überprüfen, ob Sie die Credentials korrekt eingegeben haben.
  Wenn eine Verbindung hergestellt werden konnte, sehen Sie eine Bestätigungsnachricht ganz oben auf der Seite.

Eine FTP-Verbindung ist für die Benutzer von Smart Insight und Predict erforderlich. Im Abschnitt FTP Settings nehmen Sie folgende Einstellungen vor.

• Hostname, Port, Username und Password - Geben Sie die Credentials ein, die Ihnen vom Emarsys Support zur Verfügung gestellt wurden. Wenn Sie ein Predict Kunde sind, der Smart Insight nicht verwendet, können Sie hier stattdessen Ihre eigenen Server-Details eingeben.
• Bulk Export Directory - Wenn Sie auf dem Server ein Unterverzeichnis angelegt haben, um die (manuellen) Massenexporte von den geplanten, regelmäßigen Exporten zu trennen, geben Sie hier den entsprechenden Ordnernamen ein (mit einem vorangestellten /).
• Use FTP over SSL(FTPS) - Setzen Sie diese Option auf Yes (empfohlen).
• Use passive mode - Setzen Sie diese Option auf Yes oder No, abhängig von Ihren IT-Anforderungen.
• Klicken Sie Save Config, um Ihre Einstellungen zu speichern.
• Klicken Sie Test connection, um zu überprüfen, ob Sie die Credentials korrekt eingegeben haben. Magento zeigt eine entsprechende Meldung an.

Bevor Sie beginnen, lesen Sie bitte den folgenden Abschnitt; er enthält einen Überblick darüber, wie Magento und Emarsys Kontakte und die zugehörigen Daten verarbeiten.

Ab Magento 2.0 ist es nicht mehr länger erforderlich, die Datenfelder der Customers und Subscribers separat zuzuordnen. Stattdessen ordnen Sie zuerst alle Kontaktdatenfelder zu, und danach die Werte für die Felder der Einzel- und Mehrfachauswahl. Die Zuordnung, die Sie hier definieren, wird sowohl für den ersten Data-Load als auch für alle späteren Synchronisierungen verwendet, und zwar für beide Kontakttypen.

Um Ihre Kontaktdatenfelder zuzuordnen, öffnen Sie das Menü Emarsys und gehen Sie zu Mappings > Customer.

• Wenn Sie mehr als einen Store haben, wählen Sie im Dropdown Store View den gewünschten Store aus:

• Im Dropdown Select Mapping wählen Sie Customer aus. Sie sehen nun sämtliche Magento Customer Attribute und können Sie den Emarsys Attributen (Kontaktdatenfeldern) zuordnen.

• Fall Sie es noch nicht getan haben, klicken Sie Update Schema, um sicherzugehen, dass alle Ihre Emarsys Felder in der Spalte Emarsys Customer Attributes verfügbar sind.
• Für jedes Magento Customer Attribute wählen Sie im Dropdown das passende Emarsys Feld aus. Über das Feld Search können Sie nach einem bestimmten Attribut suchen.

• Wenn Sie fertig sind, speichern Sie Ihre Änderungen, um die neue Zuordnung anzuzeigen.
• Wählen Sie nun Customer-Field aus dem Dropdown Select Mapping aus.
• Alle Felder für die Einzel- oder Mehrfachauswahl, die zugeordnet wurden, werden angezeigt; Sie müssen nun für jedes davon die Werte zuordnen.

Sobald Sie all Ihre Felder zugeordnet haben, müssen Sie in Ihrem Emarsys Account zwei Auto-Importe einrichten, einen für Magento Customers und einen für Subscribers.

In Ihrem Emarsys Account öffnen Sie das Menü Contacts > Auto-imports und nehmen Sie folgende Einstellungen vor:

Source File Settings (die erste Seite des Assistenten)

• Where to look for the import file - Wählen Sie Emarsys WebDAV aus und geben Sie den Pfad ein.
• Import file settings / File name - Die ersten Magento Ladedateien werden customers_<timestamp>.csv und subscribers_<timestamp>.csv genannt, daher sollten Sie customers_*.csv und subscribers_*.csv für Ihre zwei Auto-Import-Profile eingeben.

Sample File (zweite Seite)

• Sie müssen eine Beispieldatei hochladen; diese muss den Header und zumindest eine Zeile jener Datei enthalten, die Sie für den ersten Ladevorgang verwenden wollen - mit allen zugeordneten Feldern. Möglicherweise haben Sie diese Datei aus unserem Staging-System; Sie können aber auch einen ersten Ladevorgang zum WebDAV durchführen und jene Datei verwenden.

Match Fields (dritte Seite)

• Überprüfen Sie, ob die Felder korrekt zugeordnet sind, und wählen Sie Ihren Unique Identifier aus.

Wenn Sie fertig sind, vergewissern Sie sich, dass für Auto-Imports auf der Übersichtsseite der Status Enabled gesetzt ist.

Nachdem Sie Ihre Kundendaten wie oben beschrieben vorbereitet haben, können Sie die Daten ein erstes Mal laden und so all Ihre Magento Customers und Subscribers zu Emarsys hinzufügen.

Öffnen Sie das Menü Emarsys und gehen Sie zu Settings > Contact Synchronization.

• Im Abschnitt Initial DB Load bestimmen Sie den Opt-in-Status für die zu importierenden Kontakte; zur Auswahl stehen:
  • Set opt-in status for all users to true - Damit kann Emarsys umgehend an alle importierten Kontakte senden. Die Verwendung dieser Option wird von uns NICHT empfohlen, weil Sie damit riskieren, Kampagnen an Kontakte zu senden, die dem Empfang nicht explizit zugestimmt haben.
  • Set opt-in status for all users to empty - Emarsys kann erst dann an Kontakte senden, wenn deren Opt-in mithilfe einer anderen Methode bestätigt wurde (= ein Double Opt-in erfolgt ist).
  • Set opt-in status true for all users depending on attribute - Sie können den Opt-in-Wert für Ihre Magento Customers auf TRUE setzen, in Übereinstimmung mit dem Wert für Subscribed Status in Magento.

• Klicken Sie Export, um all Ihre Magento Customers mit Emarsys zu synchronisieren.

Nachdem der erste Data-Load durchgeführt wurde, müssen Sie die Einstellungen für die fortlaufende Synchronisierung neuer Daten definieren.

Es gibt zwei Methoden, um Kontaktdaten synchronisiert zu halten: Realtime-failsafe und Background.

• Realtime-failsafe (empfohlen) - Die Kontaktsynchronisierung erfolgt in Echtzeit über das Emarsys API; jede Aktualisierung in Magento wird umgehend an Emarsys gesendet. Diese Option eignet sich für jene Fälle, bei denen Emarsys die Daten sofort benötigt (z.B. für automatisierte Engagement-Programme). Fehlgeschlagene Aktualisierungen (z.B. aufgrund eines Netzwerkausfalls oder bei besonders großem Volumen) werden gereiht und einmal am Tag verarbeitet, je nach Ihren Einstellungen für Background Runtime und Background Frequency.
  Um die Option zu aktivieren, setzen Sie Realtime-failsafe auf Yes.
• Background only - Das sammelt und reiht alle Kontaktaktualisierungen und synchronisiert sie auf einmal, je nach Ihren Einstellungen für Background Runtime und Background Frequency; dafür wird der Emarsys WebDAV Ordner verwendet. Diese Option bietet sich an, wenn das Übertragen der Daten nach Emarsys nicht zeitkritisch ist; hierbei gibt es keine Volumensobergrenze für die zu synchronisierenden Daten.
  Um die Option zu aktivieren, setzen Sie Realtime-failsafe auf No.
• Background Runtime - Hier geben Sie die Tageszeit (in HH:MM:SS) an, zu der Ihr Failsafe-Export (falls Sie die Option Realtime-failsafe verwenden) bzw. Ihr regelmäßiger Background-Export ausgeführt werden soll.
• Background Frequency - Die Optionen sind Daily und Hourly. Wenn Sie 'Hourly' auswählen, wird zu der oben definierten Minute und Sekunde nach jeder vollen Stunde synchronisiert.
• Unique Field - Das ist der Unique Identifier, der sicherstellt, dass die Daten mit dem richtigen Kontakt in Emarsys synchronisiert werden. Sie können eine E-Mail-Adresse, die Magento-ID oder eine Kombination aus E-Mail-Adresse, Website-ID und Store-ID auswählen.

• Notification secret key - Hier können Sie ein beliebiges Passwort oder Secret eingeben. Dabei handelt es sich um einen rein internen Sicherheitscode, der Ihre Datendateien vor einem möglichen externen Zugriff schützen soll.

Wenn die Extension frische Daten braucht, ruft sie das Emarsys API auf und initiiert einen Export. Anstatt nun alle paar Sekunden einen Ping an Emarsys zu senden, um zu sehen, ob der Export fertig ist, stellt die Extension eine URL zur Verfügung, die Emarsys aufrufen kann, sobald der Export abgeschlossen ist. Das ist das Signal für Magento, dass die Daten abgerufen werden können.

Im Grunde zwingt dieses Aufrufen der URL aus dem Importvorgang Magento dazu, einen Emarsys Export zu überprüfen, daher muss die URL so eindeutig wie möglich sein; auf diese Weise können DOS-Attacken vermieden werden, die sowohl die Magento Instanz als auch Emarsys beeinträchtigen könnten. Der Notification secret key wird verwendet, um sicherzustellen, dass die URL eindeutig ist.

Sie sollten für diesen Key nur alphanumerische lateinische Buchstaben (a-z, A-Z, 0-9) verwenden. Weitere Informationen erhalten Sie unter https://perishablepress.com/stop-using-unsafe-characters-in-urls/.

Nun müssen Sie definieren, wie Ihr Shop mit Opt-ins und Opt-outs umgeht. Die tatsächlichen Events, welche die Nachrichten mit der Opt-in-Bestätigung triggern, werden zugeordnet, wenn Sie Ihre transaktionalen Nachrichten konfigurieren, siehe weiter unten. Um Ihre Opt-in-Strategie zu konfigurieren, gehen Sie zu Emarsys > Settings > Opt-in.

• Enable Opt-in - Bei Yes überschreiben Sie die für Magento definierten Standardeinstellungen für das Opt-in mit jenen Einstellungen, die Sie in der Integration vornehmen; damit können Sie Bestätigungsnachrichten über Emarsys triggern.
• Opt-in strategy - Es sind zwei Optionen verfügbar:
  • Double-Opt-In - Das ist die von uns empfohlene Methode, da sie sicherstellt, dass die Person, die sich anmeldet, auch jene Person ist, der die verwendete E-Mail-Adresse gehört. Sie werden aufgefordert, für Ihre transaktionalen E-Mails zwei Emarsys Events zuzuordnen - einen, der die Bestätigungs-Mail triggert, und einen, der den Opt-in-Status aktualisiert, sobald der Kontakt den Bestätigungs-Link geklickt hat.
  • Single-Opt-In - Sie müssen nur den einen Event zuordnen, mit dem der Opt-in-Status sofort aktualisiert wird.
• Newsletter Subscription on Checkout - Damit können Sie eine Checkbox für ein Newsletter-Opt-in zu Ihrer Checkout-Seite hinzufügen. Fügen Sie das Code Snippet wie beschrieben auf Ihrer Checkout-Seite ein, und die Opt-in-Information wird an Emarsys weitergegeben.

• From Magento to Emarsys - Die Magento Kontaktdatenbank gilt als Hauptdatenbank für Kontaktdetails; alle Werte, die für die zugeordneten Felder synchronisiert werden, überschreiben die bestehenden Werte in der Emarsys Applikation.
  Neue Kontakte werden mit den gleichen Feldern wie beim ersten Export nach Emarsys exportiert.
• From Emarsys to Magento - Einmal pro Tag zur festgelegten Background runtime überprüft Emarsys auch, ob es Änderungen im Feld Opt-in eines Magento Kontakts gibt. Ist dies der Fall, wird die Änderung nach Magento übertragen.

Um das Product Catalog API zu konfigurieren, öffnen Sie das Menü Emarsys, gehen Sie zu Settings > Product Catalog und scrollen Sie zum Ende der Seite.

• Enable API Export - Setzen Sie diese Option auf Yes.
• Merchant ID - Geben Sie Ihre Emarsys Merchant ID ein; diese finden Sie in Ihrem Emarsys Account im Menü Admin > Seite Datenquellen, und zwar im Feld Account-Details auf der rechten Seite.
• Bearer Token - Geben sie das Bearer Token ein; dieses finden Sie in Ihrem Emarsys Account im Menü Admin > Datenquellen > Seite Sales Data, wenn Sie Show API upload details klicken.

Sie sollten Ihre Magento Produktattributfelder den richtigen Emarsys Produktdatenfeldern zuordnen; vergewissern Sie sich dabei, dass Ihr Produktkatalog die richtigen Spalten und Feldtypen aufweist und damit unseren Produktdaten-Standards entspricht. Weitere Informationen erhalten Sie unter: Ihre Produktdatendatei vorbereiten.

Um Ihre Produktattribute zuzuordnen, gehen Sie zu Emarsys > Mappings > Product. Wenn Sie mehr als einen Store haben, achten Sie darauf, im Dropdown Store View den richtigen Store auszuwählen.

Hier ordnen Sie die Spalten des Produktdaten-Feeds zu. Für jedes Magento Attribut wählen Sie das passende Emarsys Feld aus.

• Add Emarsys Attribute - Wenn Ihnen ein Emarsys Feld fehlt, können Sie hier den entsprechenden Spalten-Header erstellen; damit machen Sie das Feld umgehend in der Dropdown-Liste der zuordenbaren Felder verfügbar. Dem Feldnamen wird das Präfix c_ hinzugefügt; das garantiert, dass der Header automatisch als benutzerdefiniertes Feld in Ihrer Emarsys Produktdatenbank erstellt wird.
• Update Schema - Importiert alle verfügbaren Emarsys Felder in Magento.
• Recommended Mapping - Ordnet die Felder auf Basis ihrer Namen automatisch zu. Wenn es sehr viele Felder zuzuordnen gibt, kann Ihnen diese Option viel Zeit ersparen.

Wenn Sie fertig sind, klicken Sie Save, um Ihre Einstellungen zu speichern.

Wenn Sie Ihre Produktdatenfelder zugeordnet haben, definieren Sie einen Zeitplan für die Synchronisierung Ihres Produktkatalogs. Dafür gehen Sie zu Emarsys > Settings > Product Catalog.

• Enable nightly product feed export - Setzen Sie das auf Yes.
• Include Bundle Products - Bei Yes werden Bundle Products im Feed mit eingeschlossen.
• Exclude Categories - Wenn Sie im Katalog enthaltene Produktkategorien ausschließen wollen, wählen Sie diese in der Baumansicht aus.
• Execute and Export at - Setzt die Uhrzeit für den Produkt-Feed (in HH:MM:SS).
• Frequency - Setzen Sie das je nach Ihren Anforderungen auf Hourly oder Daily.
  • Hourly - Wird empfohlen, wenn Ihr Produktkatalog mehrmals täglich angepasst wird. Auch für Features wie Predict Abandoned Cart ist diese Einstellung erforderlich.
  • Daily - Falls Ihr Produktkatalog sehr umfangreich ist oder seltener angepasst wird, wählen Sie diese Option aus, um das System weniger zu belasten.

Wenn Sie Save Config klicken, wird der Produktkatalog dem festgelegten Zeitplan gemäß von Magento zu Emarsys exportiert. Bei jedem Export wird der gesamte Katalog mit dem neuen Katalog überschrieben.

Wenn Sie das Smart Insight API verwenden, gehen Sie zu Emarsys >Settings > Smart Insight und scrollen Sie zu Smart Insight API Settings.

• Enable API Export - Setzen Sie diese Option auf Yes.
• Merchant ID - Geben Sie Ihre Emarsys Merchant ID ein; diese finden Sie in Ihrem Emarsys Account im Menü Admin > Seite Datenquellen, und zwar im Feld Account-Details auf der rechten Seite.
• Bearer Token - Geben sie das Bearer Token ein; dieses finden Sie in Ihrem Emarsys Account im Menü Admin > Datenquellen > Seite Sales Data, wenn Sie Show API upload details klicken.
• Maximum Records - Das definiert, wie viele Einträge mit jedem API Call übertragen werden. Abhängig von Ihren Anforderungen können Sie aus einem Bereich von 100 bis 10.000 Einträgen wählen.

Gehen Sie zuerst zu Emarsys > Mappings > Order. Hier geben Sie den Magento Bestellspalten jene Namen, die auf den Smart Insight Screens als Purchase-Attribute angezeigt werden.

Eine Gruppe von Spalten ist bereits zugeordnet - diese werden in der Spalte Emarsys Order Attribute benannt und können nicht geändert werden.

Sie können jede beliebige andere Spalte zum Export hinzufügen, indem Sie einen Attributnamen eingeben. Wenn Sie das Feld leer lassen, wird die entsprechende Spalte nicht in die Exportdatei eingeschlossen.

Wenn Sie alle Spalten in der Exportdatei benannt haben, sollten Sie einen Massenexport Ihrer historischen Sales-Daten vornehmen. Dafür öffnen Sie das Menü Emarsys und gehen zu Operations > Bulk Export.

• Export Entity Type - Wählen Sie Order aus.
• Felder From und To - Wählen Sie den Zeitbereich für die Magento Bestelldaten aus. Es gibt keine Einschränkung bzgl. der Daten, die Sie exportieren können, wir empfehlen jedoch, zumindest die Daten der letzten zwei Jahre einzuschließen.
• Export To - Wählen Sie CSV aus.

Klicken Sie Export. Die Magento Bestelldaten werden nun in die Smart Insight Datenbank geladen und stehen für die Smart Insight Segmentierung in Emarsys bereit.

Nachdem Sie die Sales-Daten das erste Mal geladen haben, müssen Sie die regelmäßigen Ladevorgänge für neue Sales-Daten konfigurieren. Dafür gehen Sie zu Emarsys > Settings > Smart Insight.

• Smart Insight Enabled - Setzen Sie diese Option auf Yes.
• Export using email as identifier - Bei Yes wird statt der Magento Customer ID die E-Mail-Adresse des Magento Kontakts zur Exportdatei hinzugefügt und dazu verwendet, die Sales-Daten einem Emarsys Kontakt zuzuordnen. Das ist wichtig, wenn Sie Magento Subscribers in Ihre Marketingkampagnen einschließen wollen, da Ihnen für diese keine Magento Customer ID zur Verfügung steht.
• Export guest checkout orders - Definiert, ob Gastbestellungen (d.h. anonyme Bestellungen) exportiert werden. Diese können nicht für die Smart Insight Segmentierung verwendet werden, verbessern aber das Produktaffinitätsmodell.
• Frequency - Hourly oder Daily. Wir empfehlen, die Option auf 'Hourly' zu setzen, da dies die Exportdateien kleiner hält.
• Order Export for Statuses - Die Emarsys Web Collection Scripts übergeben die Mehrzahl Ihrer Sales-Daten-Events an Emarsys; es gibt jedoch einige Events, die von diesen Scripts nicht getrackt werden, zum Beispiel Versandinformationen, voraussichtliche Liefertermine oder Zahlungsmethoden über Dritte wie etwa PayPal. Um diese Information in Emarsys nutzen zu können, wählen Sie die Statuswerte aus, für die Bestellungen exportiert werden sollen. Für eine Mehrfachauswahl halten Sie die STRG-Taste gedrückt.

Wenn Sie Save Config klicken, exportiert Magento alle Bestellungen, die seit dem letzten Export einen der ausgewählten Statuswerte angenommen haben, zur festgelegten Zeit.

Um zu überprüfen, ob die Subscribers ordungsgemäß synchronisiert werden, gehen Sie wie folgt vor:

1. Navigieren Sie zum Frontend Ihres Magento Shops.
2. Scrollen Sie ganz nach unten.
3. Geben Sie eine E-Mail-Adresse im Feld für die Newsletter-Registrierung ein; danach sollte Ihnen die Aktion als erfolgreich bestätigt werden.
4. Gehen Sie zum Magento Admin-Bereich.
5. Unter Marketing > Newsletter subscriber wurde ein Subscriber-Eintrag hinzugefügt.
6. Melden Sie sich bei Ihrem Emarsys Account an.
7. In der rechten oberen Ecke wählen Sie 'Suchen' aus.
8. Geben Sie die E-Mail-Adresse ein, um über den Filter 'E-Mail' zu suchen.
9. Sie sollten einen Eintrag sehen, bei dem der Opt-in-Wert auf true (Single Opt-in) synchronisiert wurde.

Um zu überprüfen, ob die Kontakte ordnungsgemäß synchronisiert werden, gehen Sie wie folgt vor:

1. Navigieren Sie zum Frontend Ihres Magento Shops.
2. Klicken Sie Register account.
3. Geben Sie die Details, wie Vorname, Nachname und E-Mail-Adresse, ein und klicken Sie Register; danach sollte Ihnen die Aktion als erfolgreich bestätigt werden.
4. Gehen Sie zum Magento Admin-Bereich.
5. Unter Customers > All customers wurde ein Customer-Eintrag hinzugefügt.
6. Melden Sie sich bei Ihrem Emarsys Account an.
7. In der rechten oberen Ecke wählen Sie 'Suchen' aus.
8. Geben Sie die E-Mail-Adresse ein, um über den Filter 'E-Mail' zu suchen.
9. Sie sollten einen mit Emarsys synchronisierten Eintrag sehen, der alle Details enthält.

Um zu überprüfen, ob die Produktdaten ordnungsgemäß synchronisiert werden, gehen Sie wie folgt vor:

1. Fügen Sie ein neues Produkt zu Ihrem Magento Store hinzu.
2. Warten Sie, bis die Produktdaten synchronisiert sind (das hängt von Ihrer Konfiguration ab).
3. Rufen Sie die Daten in Emarsys ab, um zu sehen, ob das neue Produkt korrekt importiert wurde.

Um zu testen, ob Magento Events transaktionale E-Mails in Emarsys ordnungsgemäß triggern, folgen Sie den unten angegebenen Schritten.

Um zu sehen, ob die Web Extend Datensammlungs-Skripts in Ihrem Webshop ordnungsgemäß funktionieren, gehen Sie wie folgt vor:

1. Gehen Sie zum Frontend des Webshops.
2. In der Adresszeile des Browsers fügen Sie /#sc_inspector am Ende der URL an (z.B. www.mystore.com/#sc_inspector).
3. Das Inspector Overlay wird im Browser angezeigt und zeigt Ihre Merchant ID.
4. Falls Recommended products on pages bereits für jede Seite ausgewählt ist, sehen Sie die Empfehlungen im Overlay.
5. Wenn Sie zu einer Kategorie navigieren, sehen Sie diese im Overlay.
6. Melden Sie sich bei einem Account an oder erstellen Sie einen neuen Benutzer; es wird entweder die E-Mail- oder die Customer-ID im Overlay angezeigt.
7. Wählen Sie ein Produkt aus und fügen Sie es zum Warenkorb hinzu: Im Overlay unter der Überschrift cart sehen Sie den Artikel mit Details wie Preis, Stückzahl sowie sku oder Produkt-ID.

Für jeden Magento Event, den Sie zuordnen wollen, müssen Sie in Ihrem Emarsys Account Folgendes erstellen:

• Einen externen Event pro Magento Event.
• Eine Kampagne pro externem Event. Diese sollten direkt im Interface der Kampagnenerstellung für den jeweiligen Channel (Triggered Email, SMS, Mobile Engage etc.) erstellt werden. Wenn Sie planen, auf die ursprüngliche Nachricht weitere Aktionen folgen zu lassen, können Sie diese in einem Automation Center Programm definieren; dies ist jedoch nicht der typische Anwendungsfall für transaktionale Nachrichten.
• Eine Liste der Personalisierungs-Platzhalter, die Sie den Magento Variablen für jeden Event zuordnen können (siehe weiter unten).

Wenn Sie Ihre Kampagnen in Emarsys vorbereitet haben, gehen Sie zu Emarsys > Mappings > Events.

• Für jeden verfügbaren Magento Event wählen Sie den passenden externen Event in Emarsys aus.
• Update Schema - Importiert alle verfügbaren Emarsys Events in Magento.
• Recommended Mapping - Ordnet die Events auf Basis ihrer Namen automatisch zu. Wenn es sehr viele Events zuzuordnen gibt, kann Ihnen diese Option viel Zeit ersparen.

Da Ihre Magento Kontakte mit Emarsys synchronisiert sind, können Sie in Ihrem Nachrichten-Content selbstverständlich alle üblichen Personalisierungsoptionen verwenden, die in Emarsys verfügbar sind, inklusive konditionalem Content und Block-Targeting. Es kann jedoch sein, dass wichtige Informationen zum Event nur in Magento verfügbar sind (zum Beispiel die URL des Bestätigungs-Links in einer Bestätigungs-Mail).

Um diesen Magento Content in Ihrer Emarsys E-Mail zu inkludieren, müssen Sie spezielle Magento Platzhalter zum Content hinzufügen.

Öffnen Sie Ihren Emarsys Account und fügen Sie die Platzhalter zum E-Mail-Content hinzu, und zwar mit einem doppelten % links und rechts vom Platzhalter (so sollte zum Beispiel die Variable first_name im E-Mail-Content als %%first_name%% geschrieben werden).

Diese Platzhalter können ein beliebiger Text sein und werden nur verwendet, um sicherzustellen, dass die richtigen Werte im JSON-Objekt an der richtigen Stelle in der E-Mail eingefügt werden. Platzhalter referenzieren nicht die Emarsys Datenbank und es ist nicht erforderlich, dass sie die String-IDs von Emarsys Feldern abbilden. Wir empfehlen, Namen zu wählen, die den Namen der ihnen zuzuordnenden Magento Variablen möglichst ähnlich sind.

Sie müssen diese für jeden Event zuordnen, daher sollten Sie sorgfältig tracken, welchen Platzhalter Sie in welcher transaktionalen Nachricht eingeschlossen haben.

Sobald Ihre Events zugeordnet sind, können Sie die Magento Variablen den Platzhaltern zuordnen, die Sie zum Emarsys Kampagnen-Content hinzugefügt haben. Klicken Sie Placeholders für jeden der Events.

Für jede Magento Variable fügen Sie den Emarsys Platzhalter hinzu, den Sie im Nachrichten-Content einschließen wollen. Das kann ein beliebiger Text ohne Leerzeichen sein; in der Nachricht wird er von doppelten %-Symbolen umschlossen. Siehe

Wir empfehlen, die JSON Payload zu überprüfen, die künftig an Emarsys übertragen werden soll; damit vergewissern Sie sich, dass alle Platzhalter richtig zugeordnet sind. Dafür klicken Sie JSON Request neben dem jeweiligen Event, um das Objekt anzuzeigen; jetzt können Sie die Platzhalter überprüfen und sehen genau, welche Daten an Emarsys übergeben werden, ohne dafür die Protokolldateien einsehen zu müssen.

Wenn Sie mit Ihrer Zuordnung fertig sind, gehen Sie zum Menü Emarsys > Settings > Transaction Email und aktivieren Sie die Funktion.

• Enable Emarsys Transaction Emails - Setzen Sie das auf Yes.

Von diesem Moment an triggern alle zugeordneten Events in Magento den entsprechenden externen Event in Emarsys. Sie können nun diese Events mit einer beliebigen Aktion in Emarsys verlinken (z.B. E-Mail-Versand, SMS-Kampagnen oder Mobile Engage Kampagnen).

Sobald Sie Ihre ersten Data-Loads vorgenommen und den Terminplan für die regelmäßige Synchronisierung neuer Daten eingerichtet haben, können Sie die Vorteile der Emarsys Datenmonitoring-Tools nutzen, um sicherzugehen, dass der Datenfluss ordnungsgemäß funktioniert.

Diese Tools validieren jeden Datenimport in Emarsys. Wenn ein Problem erkannt wird, wird es markiert und eine mögliche Lösung angeboten.

Sie finden diese Tools in Ihrer Emarsys Applikation unter dem Menü Admin, Seite Datenquelle.

Wenn eine neue Version der Integration verfügbar ist, werden Sie über die Magento Benachrichtigungen informiert. Es wird ein Link zum Emarsys GitHub repository angezeigt, über den Sie die neueste Version herunterladen können. Danach müssen Sie den Schritten folgen, wie Sie weiter oben in Emarsys Modul installieren beschrieben werden. Alle Ihre Einstellungen und Konfigurationen bleiben unverändert.

Wenn Sie in Emarsys neue Assets (Felder, externe Events etc.) erstellen, können Sie Ihre Magento Benutzeroberfläche jederzeit aktualisieren, indem Sie Update Schema klicken.

Sie können auch einen regelmäßigen Check im Hintergrund einrichten, um zu sehen, ob neue Assets erstellt wurden. Dafür gehen Sie zum Menü Emarsys, Settings > Transactional Email und definieren eine Uhrzeit und einen Zeitplan für den Check.

Wenn der Check ein neues Asset aufspürt, erhalten Sie eine Benachrichtigung mit der Aufforderung, das Schema erneut zu aktualisieren.

Unter Emarsys > Operations > Bulk Export können Sie jederzeit eine einmalige manuelle Synchronisierung Ihrer Magento Daten mit Emarsys vornehmen.

Sie haben vier Optionen für den Export von Daten.

• Customers und Subscribers - Wählen Sie diese Optionen aus, wenn Sie Ihre Magento Kontakte in Emarsys aktualisieren wollen, zum Beispiel, nachdem Sie ein neues Magento Feld hinzugefügt oder die Feldzuordnung geändert haben.
  • Für Customers müssen Sie einen Zeitbereich eingeben. Alle Customers, die in diesem Zeitbereich registriert wurden, werden synchronisiert.
  • Für Subscribers müssen Sie keinen Zeitbereich definieren. Alle Subscribers in Ihrem Magento Account werden synchronisiert.

• Order - Wird hauptsächlich für den ersten Data-Load von Sales-Daten verwendet. Sie können später alle Bestelldaten in einem bestimmten Zeitraum synchronisieren, zum Beispiel wenn Ihr Webshop einige Zeit offline war; Sie sollten dabei jedoch sehr vorsichtig sein, weil Smart Insight die Daten nicht dedupliziert. Sie könnten also am Ende duplizierte Bestellungen haben, was sich auf Ihr eRFM Scoring und ganz allgemein auf Ihr E-Commerce-Datenmodell auswirkt.
• Product - Da jedes Mal der gesamte Produktkatalog hochgeladen wird, ist das nur sinnvoll, wenn Sie Ihren Produktkatalog augenblicklich synchronisieren und nicht auf die nächste geplante Synchronisierung warten wollen. Über die Einstellungen für den Produktdaten-Feed können Sie bestimmte Produktkategorien von der Synchronisierung ausschließen.

Unter Emarsys > Operations > Logs finden Sie eine Liste aller Integrations-Events zwischen Magento und Emarsys. Das hilft Ihnen, während der Installation Fehler zu vermeiden und die Integration danach zu überwachen.

Für mehr Details zu einem einzelnen Event klicken Sie View.

Unter Emarsys > Settings > Logs können Sie definieren, wie lange die Protokolle gespeichert werden sollen, die Protokolldateien löschen, einen Zeitplan für die Protokollierung erstellen und die aktuellen Protokolldateien herunterladen.

• Save Log Days - Das bestimmt, wie lange die Protokolle für die Integration gespeichert werden.
• Enable Log Cleaning - Damit werden nicht mehr aktuelle Protokolle automatisch gelöscht. Setzen sie den Wert auf Yes, um Speicherplatz zu sparen.
• Send Log Report - Das lädt einmal täglich die Protokolle für die letzten 24 Stunden herunter und sendet sie an den Emarsys Support.
• Download Logs - Lädt die gesamte Protokolldatei im .csv-Format herunter.
• Clear Logs - Löscht alle gespeicherten Protokolle.
• Clear Cron Details -

Unter Emarsys > Help > Support können Sie ein Support Ticket direkt in der Magento-Benutzeroberfläche öffnen.

Wenn Sie das Dropdown Field mapping auf der Seite Contacts synchronization klicken und die Nachricht No fields available in Emarsys Suite for this website (please check API configuration) sehen, bedeutet das, dass Sie einen nachstehenden Schrägstrich (/) am Ende Ihrer Custom API URL haben. Löschen Sie diesen nachstehenden Schrägstrich.

Nachdem Sie Änderungen an der Plugin-Konfiguration vorgenommen haben, wird möglicherweise folgende Meldung angezeigt:

One or more of the Cache Types are invalidated: Configuration, Page Cache. Please go to Cache Management and refresh cache types.

Dies ist eine übliche Vorgehensweise von Magento. Klicken Sie den angezeigten Link und leeren Sie den Magento Cache.