eKomi-Plugin Dokumentation

Im Shopware Community Store finden Sie zwei eKomi-Plugins. Bitte beachten Sie, dass Sie für alle Funktionen nur dieses Plugin benötigen. Das Plugin eKomi – Import Produktbewertungen pflegen wir nur noch für jene Händler, die dieses Plugin bereits nutzen. Neue Funktionen werden nicht mehr implementiert.

Tutorial Video

Das Video zeigt nicht die aktuelle Version des Plugins

eKomi Schnittstelle mit Rich-Snippets & optimierter Bewertungsdarstellung

Das Plugin steht hier im Shopware Community Store zum Download zur Verfügung.

Überblick der Funktionen:

  • eKomi Widget Integration im Frontend
  • Transfer der Produktbewertungen von eKomi zu Shopware
  • Erweiterte Darstellung der Produktbewertungen auf Produkt Detailseiten in Shopware
  • Rich-Snippet Integration im HTML-Code (für das Emotion Template unter Shopware 4.x)
  • Versand der Bewertungs-Aufforderungs-Emails über das Shopware-Mail-System
  • Blacklist für Bewertungs-Emails

Kompatibilität:

  • ab Shopware 4.0.4
  • bis Shopware 5.0.0 (ab Version 1.1.10 des Plugins)

1. Installation des Plugins, Kurzbeschreibung

Über den Community-Store http://store.shopware.de/

1. Laden Sie das eKomi-Plugin aus dem Community-Store herunter: URL: http://store.shopware.de/
2. Loggen Sie sich nun in Ihr Shopware-Backend ein
3. Wählen Sie das Feld Einstellungen > Plugin-Manager und betätigen Sie im Plugin- Manager den Button Plugin manuell hinzufügen. Es öffnet sich ein Popup, um das Plugin hochzuladen: Wählen Sie die Buttons Plugin auswählen und anschließend Plugin hochladen um das eKomi-Plugin ins Backend zu laden

Über den Community-Store im Backend

1. Loggen Sie sich in Ihr Shopware-Backend ein
2. Wählen Sie das Feld Einstellungen > Plugin-Manager und wählen sie den Tab Community Store aus
3. Hier finden Sie das eKomi-Plugin über die Suchfunktion und können es über die Buttons > Details und Plugin installieren ihrem Backend hinzufügen. Hierzu ist lediglich die Eingabe Ihrer Shopware-ID und Ihres Passwortes nötig

Für beide Varianten geht es hier weiter:

4. Das Plugin wird installiert und es erscheint eine Meldung über die erfolgreiche Installation im Backend. Außerdem öffnet sich ein Popup mit den Möglichkeiten, das Plugin zu aktivieren oder zu deaktivieren.

4.1 Falls Sie es zu einem späteren Zeitpunkt aktivieren wollen, finden Sie das eKomi-Plugin „eKomi Schnittstelle für 4.x und 5.x“ in der Auflistung Inaktive Plugins unter dem Menüpunkt Meine Erweiterungen > Community-Erweiterungen oder einfach über die Suchfunktion
4.2 Durch einen Klick auf das Stift-Symbol in der Zeile des eKomi Plugins lässt sich Ihr Plugin aktivieren und konfigurieren.

1.1 Wo finde und wie aktiviere ich das eKomi-Plugin im Backend konkret?

Zur Aktivierung/Deaktivierung Ihres eKomi-Plugins gelangen Sie über die Shopware- Backend-Felder Einstellungen > Plugin Manager und dort unter den Rubriken Meine Erweiterungen > Community-Erweiterungen. Hier finden sie in der rechten Navigation die Rubrik Inaktive Plugins. Über den Stift (Plugin editieren) neben dem eKomi-Plugin gelangen Sie zur Detailseite und können das Plugin für Ihren Shop aktivieren und konfigurieren. Die Aktivierung erfolgt über die Checkbox Aktiv bzw. unter Shopware 5.x über die Schaltfläche Aktivieren (Aktiviert das Plugin und deren Hooks und Subscribes) – und geben Sie zudem zumindest die Interface ID und das Passwort ein. Die Anleitung zur detaillierten Konfiguration finden Sie im Folgenden. Bitte betätigen Sie nach jeder Konfiguration den Button Plugin-Einstellungen speichern.

Plugin Installation

1.2 Konfiguration

Im Folgenden erhalten Sie eine detaillierte Beschreibung der Konfigurationsmöglichkeiten für Ihr eKomi-Plugin.

1.2.1 Mindestkonfiguration

Um das eKomi-Plugin nutzen zu können bedarf es, neben dem Setzen der Checkbox Aktiv (Aktiviert das Plugin und deren Hooks und Subscribes) bzw. dem Klicken der enstprechenden Schaltfläche „Aktivieren“, mindestens der Eingabe der zwei Felder Interface ID sowie Passwort (hierbei handelt es sich um Pflichtfelder): Diese zwei Angaben finden Sie in Ihrem eKomi-Kundencenter unter dem Menüpunkt Vertragsdaten: dort werden sie auf der rechten Seite angezeigt. Sollten Sie diese Daten dort noch nicht finden (oder schriftlich erhalten haben), empfiehlt es sich, den Kontakt telefonisch oder per Mail an support@ekomi.de aufzunehmen.

Plugin Konfiguration

Um Ihr eKomi-Plugin nutzen zu können, sind keine weiteren Angaben notwendig. Für weitere Konfigurationen werden Standardwerte angenommen, die Sie der genauen Konfigurationsbeschreibung unten entnehmen können.

Bitte achten Sie jedoch auf die korrekte Einstellung des Shopware-Cronjobs, die für das reibungslose Funktionieren Ihres eKomi-Plugins unerlässlich ist! Detaillierte Angaben zum Cron-Job finden Sie hier.

1.2.2 Details zur Konfiguration
Die hier genannten Einstellungen beziehen sich auf die aktuelle Version (1.1.11) des Plugins. Umfang und Reihenfolge der Konfigurationsoptionen können sich in älteren Versionen deutlich unterscheiden. Wir empfehlen, sämtliche Plugins immer aktuell zu halten.
ekomi1

Individueller Bewertungszeitraum für Artikel (Standard: deaktiviert): die Aktivierung dieses Items ermöglicht es Ihnen, individuelle Bewertungszeiträume für bestimmte Produkte einzustellen: In der jeweiligen Artikelkonfiguration Ihres Backends erscheint die Möglichkeit zur Einstellung einer individuellen Verzögerungszeit.

Interface ID und Passwort: Siehe 1.2.1 unter „Mindestkonfiguration“

Bestellnummer für Export: unter diesem Dropdown Menü legen Sie fest, ob als Bestellnummer für den Export eine „Interne ID“ oder eine „offizielle Bestellnummer“ vergeben wird.

Artikelnummer für Export: In diesem Dropdown Menü können Sie wählen, ob Sie für die Zuordnung von Bewertungen zu Artikeln die Artikel-Bestellnummer, die Artikel-ID oder die Herstellernummer für den Import bzw. Export verwenden wollen. Wenn Sie beispielsweise das Shopsystem umstellen möchten, ist es sinnvoll, hier bspw. die Herstellernummer für die Zuordnung zu wählen, da sich bei der Umstellung die Artikelnummern Ihrer Artikel höchstwahrscheinlich ändern werden.

Name des E-Mail-Versenders: hier tragen Sie Ihre Firmenbezeichnung ein. Dieser Name wird dem Kunden als Absender der Bewertungs-E-Mail angezeigt.

E-Mail-Adresse des Versenders: hier tragen Sie Ihre Firmen-E-Mail-Adresse ein. Diese E- Mail-Adresse wird dem Kunden als E-Mail-Adresse des Versenders der Bewertungs-E-Mail angezeigt.

Shopware Template Name: hier geben Sie den Namen des E-Mail-Template an, dass aktuell wird sofern Sie sich für ‚Shopware‘-basierte E-Mails entscheiden (eine Erklärung erfolgt zu dem nachfolgenden Item). Ohne eine Einstellung wird als Name standardmäßig „eKomiReviewTemplate“ bei der Installation vergeben und aktiviert.

ekomi2E-Mail Template (Standard: ‚eKomi‘): mit diesem Item können Sie definieren, auf welche Weise Ihr Kunde für die Bewertung angeschrieben werden soll: zur Auswahl stehen Ihnen das eKomi-Template (eKomi) und das Shopware-Template (Shopware) als Anschreiben-Vorlagen zur Verfügung.

Sofern keine besonderen Anforderungen an das Anschreiben an Ihre Kunden bestehen, also keine besondere Anrede und/oder ein Versand von Anhängen, Grafiken oder Ähnlichem, so ist die Standard-Einstellung für das E-Mail-Template empfehlenswert und benötigt keiner weiteren Konfiguration.

Sofern Sie jedoch in den E-Mails an Ihre Kunden eine besondere Anrede und/oder das Versenden von Anhängen, Grafiken oder Ähnlichem wünschen, bietet das Shopware-Template weitere Konfigurations-Möglichkeiten. Sofern Sie sich für das Shopware-Template entscheiden, tragen Sie bitte auch Ihre E-Mail-Adresse und den Namen des Versenders ein: Wählen Sie hierzu unter Einstellungen > eMail Vorlagen und > User eMails das eKomiReviewTemplate aus: Hier lässt sich der Text, der an Ihre Kunden gesendet wird, anpassen. Wichtig: am Ende bitte über den Button Vorlage speichern die Änderungen bestätigen und aktivieren.

Optimierte Darstellung der Bewertungen (Standard: Aktiviert): sollte aktiviert werden – denn hiermit aktivieren/deaktivieren Sie die optimierte Darstellung des eKomi Design-Templates. Deaktiviert stünde lediglich die Shopware-Standardeinstellung zum Bewertungs-Template zur Verfügung.

eKomi Produktbewertungen (Standard: Aktiviert): hiermit aktivieren/deaktivieren Sie den Import von eKomi- Produktbewertungen zu Shopware und die Anzeige der eKomi-Produktbewertungen auf Ihren Shop-Seiten. Wenn Sie die eKomi-Produktbewertungen nicht verwenden, werden Shopware Produktbewertungen verwendet.

eKomi-Widget

eKomi-Widget im Frontend

image3

Das Widget als emotion-Element

eKomi-Widget auf Registrierungsseite (Standard: Aktiviert): hiermit aktivieren/deaktivieren Sie die Anzeige des eKomi-Widgets auf der Registrierungsseite.

eKomi-Widget auf Kategorie-Ansicht (Standard: Aktiviert): hiermit aktivieren/deaktivieren Sie die Anzeige des eKomi-Widgets auf der Kategorie-Ansicht.

Das eKomi-Widget ist mit Installation des Plugins seit Version 1.1.11 als emotion-Element verfügbar

Bewertung der Rezension (Standard: Aktiviert): hiermit ermöglichen Sie Ihren Kunden die Rezensionen als hilfreich oder weniger hilfreich zu bewerten. Hierzu werden im Frontend Daumen zur Bewertung als hilfreiche oder nicht hilfreiche Rezension angezeigt (s. hierzu auch Abbildung unten).

BewertungenvergleichenDarstellung beste vs. schlechteste Bewertung (Standard: Aktiviert): wahlweise kann hiermit eine Box-Darstellung aktiviert/deaktiviert werden, in der die hilfreichste positive der hilfreichsten negativen Bewertung gegenübergestellt wird.

 

Produktbewertungen im Shop erlauben (Standard: Deaktiviert): durch Wählen von „Ja“ erlauben Sie Produktbewertungen im Shop und es befindet sich ein Feld zur Eingabe von Bewertungen im Shop-Frontend; bei der Wahl von „Nein“ lässt sich die Bewertung nur über eKomi einstellen und im Shop-Frontend ist kein Feld mehr zur Eingabe von Bewertungen vorhanden.

Filterfunktion der Bewertungen (Standard: Aktiviert): hiermit ermöglichen Sie Ihren Kunden, die angezeigten Bewertungen zu Filtern (nach 1- bis 5-Sterne Bewertungen).

image6eKomi-Logo bei Produktbewertungen (Standard: Aktiviert): Hier können Sie auswählen, ob auf den Artikeldetailseiten im Bereich der Bewertungen das eKomi-Logo (siehe Abbildung rechts) angezeigt werden soll oder nicht.

eKomi Bewertungs-URL: hier legen Sie die Seite fest, auf die Ihr Kunde umgeleitet wird, sofern er auf das eKomi-Icon „eKomi – The Feedback Company“ auf dem Bewertungs-Tab der Detail-Seite klickt (siehe Abbildung).

Bestellstatus: in diesem Dropdown-Menü wählen Sie aus, welcher Bestellstatus eine Bestellung haben soll, damit der Versand einer Bewertungsmail an Ihren Kunden erfolgt (mit Angaben wie “Offen”, “Komplett ausgeliefert” bis hin zu “Abgebrochen”).

Früheste Bestellung (Tage vor Import): mit der Auswahl von 3, 7, 14 oder 28 Tagen legen Sie die Anzahl der Tage für die Verzögerung des E-Mail Versands fest. Falls Ihre Kunden für manche Ihrer Produkte etwas Zeit zur Überprüfung und Bewertung benötigen, stellen Sie zum Beispiel 7 Tage ein.

Versand Bewertungsmail: hiermit können Sie bestimmen, auf welche Weise Ihr Kunde den Versand der Bewertungsmail beeinflussen kann. Dazu stehen Ihnen drei Möglichkeiten zur Auswahl: (1) „Opt-In (Empfehlung)“, (2) „Opt-In vorausgewählt (nicht empfohlen)“ und (3) „ohne Zustimmung (nicht empfohlen)“:

Mit der Wahl von (1) „Opt-In (Empfehlung)“ erscheint für Ihre Kunden auf der finalen Warenkorb-Seite eine Checkbox mit dem Satz „Ich möchte den Einkauf später bewerten und von eKomi nach der Lieferung einmalig per E-Mail an die Abgabe einer Bewertung erinnert werden. Meine Einwilligung kann ich jederzeit widerrufen.“ Sofern der Kunde die Checkbox aktiviert, erhält er entsprechend einmalig eine Bewertungsmail. Andernfalls wird keine Bewertungsmail verschickt.

Auch bei der zweiten Möglichkeit (2) „Opt-In vorausgewählt (nicht empfohlen)“ erscheint diese Checkbox für Ihren Kunden, allerdings ist diese Checkbox automatisch vor-aktiviert. Bei Auswahl der dritten Variante (3) „ohne Zustimmung (nicht empfohlen)“ erscheint keine Checkbox und Bewertungsmails werden automatisch an alle Kunden verschickt.

Hinweis: Die Datenstrukturen von eKomi und Shopware divergieren teilweise, so dass eine Zuweisung/Bestimmung von Feldern notwendig ist: diese Felder werden im Folgenden beschrieben. Die Auswahlmöglichkeiten für die folgenden 6 Felder (von article-id bis datum) lauten: “Keine Daten importieren”, Datum, Name, ArticleID, Rating und Feedback.

Daten für Feld article-id: hier können Sie die Artikel-ID von eKomi der Shopware-Artikel- ID zuordnen.

Daten für Feld name: hier wählen Sie die Zuordnung des Felds Name aus; Auswahlempfehlung ist: Name.

Daten für Feld headline: Shopware verfügt über zwei Felder für Bewertungen: eine Überschrift und ein Kommentar; eKomi hingegen hat nur ein Feld, das Feedback-Feld (keine Überschrift). Sie können somit entscheiden, ob das eKomi Feedback unter Headline oder unter dem nächsten Menüpunkt ‘Daten für Feld comment’ sichtbar wird oder auch für beide Felder angezeigt wird.

Daten für Feld comment: (s. auch ‘Daten für Feld headline’) zu empfehlen ist hier die Angabe Feedback.

Daten für Feld points: hier empfiehlt sich die Angabe von Rating.

Daten für Feld datum: hier empfiehlt sich die Angabe von Datum.

Daten für Feld active (konstanter Wert): alle Bewertungen, die von eKomi kommen, können standardmäßig angezeigt oder nicht angezeigt werden. 1 steht hierbei für aktiv – die Bewertungen werden angezeigt – und 0 steht für inaktiv – die Bewertungen werden nicht angezeigt.

Daten für Feld E-Mail (konstanter Wert): die Bewertungstabelle in Shopware benötigt ein E-Mail-Feld, das eKomi nicht übergibt – hier könne Sie einen Standardwert eintragen wie eKomi oder eKomi-Bewertung.

Bestellungen ignorieren vor: mit dieser Angabe erlauben Sie dem Plugin, bestimmte Bestellungen zu ignorieren – beispielsweise solche Bestellungen, die zeitlich vor der Installation des Plugins lagen. Sie können hierzu einen genauen Zeitpunkt bzw. ein Datum und eine Uhrzeit im Viertelstundentakt angeben, vor welchem keine Bewertungsnachrichten für Bestellungen versendet werden sollen.

Name Format: mit diesem Feld bestimmen Sie die Anzeige des Namens des Bewertenden. Zum Beispiel lässt sich nur der Vorname, nur der Nachname usw. anzeigen. Der Name wird dabei im Moment des Imports bestimmt: d.h. sofern zuvor beispielsweise der Vorname angezeigt wurde und mit dieser Einstellung einige Produktbewertungen importiert wurden, anschließend eine Änderung vorgenommen wird, in der der Nachname angezeigt werden soll, ergibt sich eine Mischung aus Vorname und Nachname in Ihren Bewertungen.

Mindestanzahl der Rezensionen für Vergleich: Hier können Sie eine Anzahl von Rezensionen eintragen, die mindestens vorliegen sollten, um für Ihre Kunden den Vergleich von Rezensionen anzuzeigen (empfohlene Menge etwa 6 Rezensionen).

Mindestanzahl der Bewertungen für Vergleich: Hier können Sie eine Anzahl von Bewertungen eintragen, die mindestens vorliegen sollten, um für Ihre Kunden den Vergleich von Bewertungen anzuzeigen (empfohlene Menge etwa 6 Bewertungen).

Fernwartungs-Key: Dieser Schlüssel wird manuell eingegeben und dient der sicheren Identifikation im Falle einer Fernwartung.

Einstellungen für das Emotion template (Shopware 4.x)

Ab Shopware 5 werden Rich-Snippets von Shopware nativ unterstützt und nicht mehr über das Plugin ausgegeben. Einstellungen, die in diesem Bereich unter Shopware 5.x vorgenommen werden, haben keinen Effekt.

Preisausgabe im Rich-Snippet deaktivieren (Grundpreis-Problem) (Standard: Aktiviert): hiermit lässt sich die Ausgabe der Bewertungen nach Google steuern bzw. aktivieren/deaktivieren. Ein schönes Beispiel hierzu finden Sie auch in unserem Video-Tutorial.

Rich Snippet für Startseite (Shopbewertung) (Standard: Aktiviert): hiermit aktivieren/deaktivieren Sie die Möglichkeit zur Anzeige von Rich Snippets der Bewertungen Ihres Shops.

Rich Snippets für Detailseite (Produktbewertung) (Standard: Aktiviert): hiermit aktivieren/deaktivieren Sie die Möglichkeit zur Anzeige von Rich Snippets der Bewertungen Ihrer einzelnen Produkte.

Einstellungen für das Responsive template (Shopware 5.x)

eKomi Badge im Header anzeigen (Standard: Deaktiviert): Hier können Sie wählen, ob in ihrem Shop-Header das eKomi-Badge angezeigt werden soll (siehe Abbildung).

image1

Weitere Informationen: 

Zusätzlich ist es möglich über das Backend Panels des eKomi Plugins (im Reiter Marketing) bestimmte Kunden-eMail-Adressen auf eine Blacklist zu setzen. Alle Adressen, die auf dieser Blacklist zu finden sind erhalten bis auf weiteres keine eKomi-Mails.

 

Anmerkung: Diese Option steht ausschließlich im Shopware 5 Responsive Template zur Verfügung. Sollten Sie ein anderes Template nutzen, sollten Sie diese Funktion deaktiviert lassen.

Im Anschluss einer jeden Änderung der Konfigurationen ist es wichtig, die Änderungen über den Button “Plugin-Einstellungen speichern” zu bestätigen.

Zu empfehlen ist weiterhin, den Cache Ihres Shopware-Shops zu nach der Speicherung zu leeren: dies ist möglich unter Einstellungen > Shopware Cache leeren.

Außerdem ist für ein reibungsloses Funktionieren Ihres eKomi-Plugins ist die korrekte Konfiguration des Shopware-Cronjobs unerlässlich: Das Shopware Plugin mit der Bezeichnung Cron gewährleistet einen permanenten Datenabgleich zwischen Shopware und Ihrem Shop. Dieser steuert Ihren Datenabgleich. Bitte beachten Sie zur korrekten Installation und Konfiguration die Anleitung zum Cron-Plugin, die Sie unter der folgenden URL finden: http://wiki.shopware.de/Cronjobs_detail_1102.html

Der Cronjob muss mit ausreichenden Rechten und Ressourcen auf Server-Seite ausgestattet sein, sonst kann es zu Problemen bei der Ausführung kommen.

1.2.4 Freigabe von Bewertungen

Die Bewertungen Ihrer Kunden können Sie über Ihr Backend unter Artikel > Bewertungen prüfen und freigeben: Die Freigabe der Bewertung erfolgt mit einem Klick auf das grüne Plus- Zeichen. Mit einem Klick auf das rote Minus-Zeichen löschen Sie wiederum die Bewertung. Außerdem lassen sich über das Stift-Blase-Symbol die Bewertungen Ihrer Kunden kommentieren bzw. eine Antwort verfassen. Auf der rechten Seite befindet sich eine Spalte mit „Mehr Informationen“, in der Sie eine Vorschau der Bewertung sehen können.

Freigabe

2.0 Bekannte Probleme
eKomi-Opt-In kollidiert mit AGB- oder Newsletter-Bestätigung im Checkout

eKomiOptIn

In Shopware 4 hat die Checkbox zur Bestätigung der AGB eine feste Position oberhalb des Warenkorb-Inhaltes bekommen (absolute Positionierung des Elements via CSS). Damit wir an der gleichen Stelle unsere eKomi-Opt-In-Funktion anzeigen können, müssen wir dieses Element auch absolut positionieren. Kunden, die an dieser Stelle eine andere (längere) Formulierung für das Akzeptieren der AGB oder eine weitere Checkbox z.B. für die Anmeldung zum Newsletter verwenden, könnten Darstellungsprobleme bekommen.

Dies ist leider nicht allgemeingültig zu lösen. In diesen Fällen können Sie ab der Plugin-Version 1.1.15 an folgender Stelle die Position unsere Checkbox verändern:

Datei NFXeKomiInterface\Views\emotion\frontend\_resources\css\ekomi.css in unserem Plugin-Verzeichnis finden sie folgenden Bereich:

/* CONFIRM PAGE EKOMI OPT-IN CHECKBOX */
/* Bei Darstellungsproblemen auf der Confirm-Page bitte die Werte left und top entsprechend anpassen */
/* Achtung – ihre Anpassungen werden bei jedem Update ueberschrieben */
/* ekomi checkbox container */
.ekomi_confirm_checkbox{
left: 37px;
position: absolute;
top: 100px;
}

Für das Beispiel im oben stehenden Screenshot müsste z.B. die Positionierung via top auf folgenden Wert geändert werden:

top: 110px;