Handbuch eKomiMeetsMage für Version 0.9.0 Handbuch Version
Transcrição
Handbuch eKomiMeetsMage für Version 0.9.0 Handbuch Version
Handbuch eKomiMeetsMage für Version 0.9.0 Handbuch Version 0.1 Zuletzt geändert 18.05.2012 Handbuch eKomiMeetsMage v0.9.0 Inhaltsverzeichnis 1 Einleitung .............................................................................................................. 3 1.1 Voraussetzungen............................................................................................................. 3 1.2 Funktionsübersicht .......................................................................................................... 3 2 Installation ............................................................................................................ 4 2.1 Vorbereitung und Hinweise zur eigenhändigen Installation............................................. 4 2.2 Installation Testversion .................................................................................................... 4 2.2.1 Vorbereitung .............................................................................................................. 4 2.2.2 Installation ionCube ................................................................................................... 4 2.2.3 Registrierung Test-Lizenz ......................................................................................... 6 2.2.4 Installation der Extension .......................................................................................... 6 2.2.5 Eintragung der Lizenz ............................................................................................... 7 2.3 Installation Kaufversion ................................................................................................... 7 3 Benutzung der Extension .................................................................................... 8 3.1 Erste Konfiguration .......................................................................................................... 9 3.1.1 Magento CronJob als Voraussetzung ....................................................................... 9 3.1.2 eKomi API Daten hinterlegen .................................................................................... 9 3.2 eKomiMeetsMage Lifecycle........................................................................................... 11 3.3 eKomi Bestandskunden................................................................................................. 12 3.4 Review Übersicht........................................................................................................... 12 3.5 Sendestatus................................................................................................................... 13 3.6 Frontend - Sichtbarkeit für den Kunden......................................................................... 14 (c) 2012 meets-ecommerce Online Agentur GmbH Seite 2 von 15 Handbuch eKomiMeetsMage v0.9.0 1 Einleitung In diesem Handbuch finden Sie eine Übersicht über die Installation und Funktionsweise von eKomiMeetsMage. Wenn Sie zu einem bestimmten Thema keine Antworten in dieser Anleitung finden, schreiben Sie uns eine E-Mail [email protected]. 1.1 Voraussetzungen LexMeetsMage hat folgende Voraussetzungen: • PHP Version 5.3.x • Magento Commerce Community Edition 1.4.2, 1.5.x, 1.6.x • eKomi Account (ekomi.de) 1.2 Funktionsübersicht Funktion Beschreibung Automatischer Import Alle Reviews werden automatisiert von eKomi in Ihr Magento importiert und den richtigen Produkten zu gewiesen. Leichte Konfiguration Über das Magento Admin Interface können Sie einfach und bequem Ihre eKomi Account Daten hinterlegen. Automatischer E-Mail Versand Kunden die bei Ihnen bestellt haben, bekommen automatisiert eine E-Mail zur Bewertung Ihres Shop und Ihrer Produkte. Review Übersicht Sie können sich alle Review zu den Produkten in einer Übersicht anzeigen lassen und einfach aktivieren und deaktivieren. Wenn Sie weitere Funktionalitäten wünschen oder brauchen, schreiben Sie uns via E-Mail an [email protected]. (c) 2012 meets-ecommerce Online Agentur GmbH Seite 3 von 15 Handbuch eKomiMeetsMage v0.9.0 2 Installation Die Installation von eKomiMeetsMage ist nach dem Magento Standard aufgebaut. Dieses Kapitel beschreibt alle notwendigen Schritte zur Installation der Extension. 2.1 Vorbereitung und Hinweise zur eigenhändigen Installation Eigenständige Installation Warnung: für die eigenständige Installation von eKomiMeetsMage übernimmt meets-ecommerce keinerlei Haftung. Wir empfehlen eindringlich die Installation auf einem Test Shop von Ihnen durchzuführen. Des Weiteren empfehlen wir bei der Übernahme in den Live Shop folgendes zu tun: • Backup Ihrer Datenbank • Backup Ihres kompletten Magento Ordners bzw. Systems • Extension installieren 2.2 Installation Testversion Die Testversion erfordert einige Schritte mehr als die Installation der Kaufversion. Bitte folgenden Sie den Schritten in diesem Kapitel. 2.2.1 Vorbereitung Damit Sie unsere Extension testen können, benötigen Sie eine Testversion. Die Testversion können Sie auf der Produktseite von eKomiMeetsMage herunterladen. Zu finden unter meets-ecommerce.de/extensions. 2.2.2 Installation ionCube ionCube ist notwendig, damit die Test-Extension einwandfrei läuft. ionCube dient meets-ecommerce zur Verschlüsslung des Source Codes der Extension und (c) 2012 meets-ecommerce Online Agentur GmbH Seite 4 von 15 Handbuch eKomiMeetsMage v0.9.0 speichert generell keine weiteren Daten bzw. hat für Sie als Nutzer keine weiteren Nachteile. Die Nutzung von ionCube verschlüsselter Software setzt einen so genannten Loader voraus. Die Loader von ionCube sind für alle gängigen Systeme auf der ionCube Homepage1 verfügbar. Die einfachste Art der Installation funktioniert über den Loader Wizard von ionCube selbst. Der Loader Wizard wird mit jedem Download von einem Loader selbst mitgeliefert (Loader Download, siehe Fußnote 2). Die selbstständige Installation oder durch uns durchgeführter Installation setzt die Zugriffsrechte in Ihren PHP bzw. Web Server Einstellungen voraus. Bitte erfragen Sie dies bei Ihrem Hoster. Gehen Sie mit dem Loader Wizard wie folgt vor: 1. Laden Sie den passenden Loader für Ihr Betriebssystem herunter (http://www.ioncube.com/loaders.php) 2. Entpacken Sie das Archiv 3. Kopieren Sie den „loader-wizard.php“ in Ihr Web Verzeichnis 4. Rufen Sie die „loader-wizard.php“ mit Ihrem Browser auf – bspw. www.example.com/loader-wizard.php 5. Folgen Sie den Anweisungen in Anleitungen 6. Nach der Befolgung der Anleitung sollte alles funktionieren Falls Sie dennoch Probleme haben sollten, fragen Sie bei Ihrem Hoster an oder lassen Sie uns die Installation durchführen - fragen Sie uns via [email protected] - die Installation ist kostenpflichtig! 1 http://www.ioncube.com/loaders.php (c) 2012 meets-ecommerce Online Agentur GmbH Seite 5 von 15 Handbuch eKomiMeetsMage v0.9.0 2.2.3 Registrierung Test-‐Lizenz Folgende Schritte sind notwendig, damit Sie eine Testversion registrieren können. 1. Erstellen Sie ein Nutzerkonto auf meets-ecommerce.de 2. Loggen Sie sich in Ihrem Nutzerkonto ein 3. Gehen Sie in Ihrem Nutzerkonto auf „Lizenzen“ a. Sofern Sie noch keine Lizenz gekauft oder angelegt haben, erhalten Sie automatisch generierte Lizenzdaten, sobald Sie die erste Lizenz gekauft bzw. angelegt haben. Wenn das bereits geschehen ist, gehen Sie zu Schritt 4. 4. Wählen Sie die richtige Lizenz für das zu testende Produkt aus – bspw. „eKomiMeetsMage v0.9.0“ und speichern Sie dies 5. Jetzt sollten Sie oben Ihre Lizenz-Zugangsdaten sehen sowie unten Ihre erstellte Lizenz sehen 2.2.4 Installation der Extension Die Installation der Extension gestaltet sich sehr einfach. Folgen Sie bitte den folgenden Schritten: 1. Laden Sie sich die Extension herunter (die Test-Version auf der Produktdetailseite der jeweiligen Extension) 2. Entpacken Sie das Archiv 3. Kopieren Sie den gesamten Inhalt aus dem Ordner „src/“ in Ihren Magento Hauptordner 4. Loggen Sie sich in Ihr Magento Backend > dort sollten Sie den Punkt „meetsecommerce “ sehen. Wenn nicht, löschen Sie den Cache und loggen sich neu ein. Achtung: Es kann auch dazu kommen, dass Sie eine weiße Seite sehen oder eine Fehlermeldung, dass ionCube nicht vorhanden ist. Dann haben Sie voraussichtlich einen Fehler bei der Installation von ionCube gemacht. Damit Sie das verifizieren können, sollten Sie noch mal den Loader (aus dem Kapitel „Installation ionCube“ laden. (c) 2012 meets-ecommerce Online Agentur GmbH Seite 6 von 15 Handbuch eKomiMeetsMage v0.9.0 2.2.5 Eintragung der Lizenz Sofern Sie eine Lizenz erstellt haben müssen in Ihr Magento Backend gehen und diese eintragen, falls nicht gehen in das Kapitel „Registrierung Test-Lizenz“. Gehen dazu wie folgt vor: 1. Loggen Sie sich in Ihrem Magento Backend ein 2. Gehen Sie auf „meets-ecommerce“ > „Lizenz Magement“ 3. Tragen Sie ein a. Lizenz-Benutzer: E-Mail (im Nutzeraccount auf Lizenzen) b. Lizenz-Passwort: Passwort (im Nutzeraccount auf Lizenzen) 4. Oben rechts sehen Sie ein Button mit „Lizenz-Account updaten“ 5. Betätigen Sie diesen, damit Ihre Extension mit dem Server verbunden wird 6. Sobald Sie erfolgreich verbunden wurden, bestätigt Ihnen das eine grün hinterlegte Nachricht. 7. Wenn Sie zu diesem Account eine Lizenz besitzen oder auch mehrere, sehen Ihre Lizenz Details 8. Jetzt können Sie Ihre Extension nutzen 2.3 Installation Kaufversion Die Installation der Extension gestaltet sich sehr einfach. Folgen Sie bitte den folgenden Schritten: 1. Laden Sie sich die Extension herunter (den Link zum Download finden Sie in Ihrem Nutzerkonto unter Downloads) 2. Entpacken Sie das Archiv 3. Kopieren Sie den gesamten Inhalt aus dem Ordner „src/“ in Ihren Magento Hauptordner 4. Loggen Sie sich in Ihr Magento Backend > dort sollten Sie den Punkt „meetsecommerce “ sehen. Wenn nicht, löschen Sie den Cache und loggen sich neu ein. (c) 2012 meets-ecommerce Online Agentur GmbH Seite 7 von 15 Handbuch eKomiMeetsMage v0.9.0 Information: den Cache können Sie im Magento Backend unter „System -> Cache Management“ löschen bzw. invalidieren. 3 Benutzung der Extension Der Aufbau der Extension ist simpel. Sie finden alle nötigen Konfigurationsmasken in Ihrem Magento Backend unter „meets-ecommerce > eKomiMeetsMage“ (siehe Abbildung 1). Abbildung 1: Menüstruktur eKomiMeetsMage Im Folgenden eine kurze Übersicht der einzelnen Menüpunkte. Konfiguration In diesem Bereich müssen die API Daten für Ihren eKomi Account hinterlegen. Review Übersicht Alle importierten Kundenmeinungen von eKomi können Sie hier übersehen und wenn Sie möchten auch deaktvieren. Sendestatus Der Sendestatus zeigt Ihnen an, welche Kundenbefragungs-E-Mails bereits versendet worden sind bzw. welche ausstehen oder fehlgeschlagen sind. (c) 2012 meets-ecommerce Online Agentur GmbH Seite 8 von 15 Handbuch eKomiMeetsMage v0.9.0 3.1 Erste Konfiguration eKomiMeetsMage ist so konzipiert, dass alle notwendigen Daten automatisiert von eKomi nach Magento importiert werden. Damit diese Informationen einwandfrei in Ihr Magento geladen werden können, müssen Sie ein paar kurze Konfigurationen vornehmen. 3.1.1 Magento CronJob als Voraussetzung Als Grundbestandteil von eKomiMeetsMage ist der Magento CronJob. Dieser muss zwingend installiert und konfiguriert sein. Die Konfiguration des Magento CronJobs für Ihr System entnehmen Sie bitte der folgenden Seite: http://www.magentocommerce.com/wiki/1__installation_and_configuration/how_to_setup_a_cron_job 3.1.2 eKomi API Daten hinterlegen Als Voraussetzung der Nutzung von eKomiMeetsMage ist ein eKomi Account zwingend erforderlich. Diesen können Sie auf http://www.ekomi.de bestellen, dieser ist kostenpflichtig! Bitte denken Sie daran die API Variante von eKomi zu beantragen. Bei Zweifeln, fragen Sie uns bitte [email protected] Eingabe der API Daten Nach dem Sie den CronJob installiert haben und einen eKomi Account haben, müssen die API Daten bei Magento hinterlegen. Gehen Sie dazu in Magento Backend unter „meets-ecommerce > eKomiMeetsMage > Konfiguration“. Sobald Sie auf der Einrichtungsseite sind, wählen Sie bitte den eKomi Modus aus. Wählen „Single Store“ aus. „Single Store“ bedeutet, dass Sie für alle Stores in Ihrem Magento System ein eKomi Account verwenden (siehe auch Abbildung 2). Im „Multi Store“ würden Sie pro Store in Magento ein eKomi Account benötigen. (c) 2012 meets-ecommerce Online Agentur GmbH Seite 9 von 15 Handbuch eKomiMeetsMage v0.9.0 Abbildung 2: Wählen Sie den passenden eKomi Modus Information: In der aktuellen Version von eKomiMeetsMage ist nur der „Single Store“ Modus verfügbar. In einem späteren Update (dass Sie kostenlos herunterladen können) wird der „Multi Store“ Modus verfügbar. Wenn Sie nun den passenden Modus ausgewählt haben, müssen Sie Ihre API Daten hinterlegen. Diese erhalten Sie von eKomi. Bitte geben Sie dann Ihre eKomi API ID sowie das dazugehörende eKomi API Passwort an (siehe Abbildung 3) Sobald alles eingetragen ist, klicken Sie bitte oben rechts auf „Konfiguration speichern“. Nach erfolgreicher Eingabe sehen Sie das der API Verbindungsstatus verifiziert ist und Sie sehen Ihre Account Details über der Eingabe Maske (siehe Abbildung 4). Abbildung 3: API Daten hinterlegen Abbildung 4: eKomi Account Details (c) 2012 meets-ecommerce Online Agentur GmbH Seite 10 von 15 Handbuch eKomiMeetsMage v0.9.0 Jetzt haben Sie alle nötigen Schritte vorgenommen, die notwendig sind, dass eKomiMeetsMage lauffähig ist. 3.2 eKomiMeetsMage Lifecycle Bevor wir tiefer in die folgenden Kapitel einsteigen, möchten wir Ihnen hier erklären, wie eKomiMeetsMage funktioniert bzw. wie der generelle Ablauf von der Bestellung bis hin zu der Rückführung in Ihr System ist. Kunde bestellt in Ihrem Shop Kunde sieht Bewertungen in Ihrem Shop eKomiMeetsMage sendet Bewertungs-‐ Link an Kunden eKomiMeetsMage importiert Bewertungen Kunde bewertet auf ekomi.de eKomi gibt Bewertung frei Abbildung 5: Lifecycle eKomi und eKomiMeetsMage Kunde bestellt in Ihrem Shop: Der Kunde bestellt in Ihrem Online-Shop, die Daten werden bei eKomiMeetsMage gespeichert. eKomiMeetsMage sendet Bewertungs-Link an Kunden: Der Bewertungs-Link wird von eKomiMeetsMage bei eKomi angefordert und zum konfigurierten Zeitpunkt versendet. Kunden bewertet auf ekomi.de: Der Bewertungs-Link für den Kunden auf ekomi.de, wo er die Ware und den Shop bewertet. eKomi gibt Bewertung frei: eKomi gibt die Bewertung frei, bzw. bearbeitet diese. eKomiMeetsMage importiert Bewertungen: Die Produktbewertungen werden von eKomi automatisch in Ihr System importiert. Kunde sieht Bewertung in Ihrem Shop: Ihre Kunden sehen dann die richtigen Bewertungen. (c) 2012 meets-ecommerce Online Agentur GmbH Seite 11 von 15 Handbuch eKomiMeetsMage v0.9.0 3.3 eKomi Bestandskunden Wenn Sie bereits seit längerem einen eKomi Account betreiben müssen Sie bei der Einführung von eKomiMeetsMage beachten, dass das Matching, der Produktbewertungen bei eKomiMeetsMage über die so genannte SKU bzw. Artikelnummer funktioniert. Warnung: Das bedeutet, dass eKomiMeetsMage nur Produkte zu ordnen kann, die auch die korrekte SKU’s bzw. Artikelnummern beinhalten. Wenn Sie nicht sicher sind, dann Fragen Sie bitte bei eKomi (www.ekomi.de) nach oder Ihren aktuellen Dienstleister. Bei weiteren Fragen steht Ihnen natürlich auch unser Support unter [email protected] zur Verfügung. Wenn Änderungen an eKomiMeetsMage nötig sind, wird meets-ecommerce kostenpflichtig unterstützend zur Seite stehen, fragen Sie bitte auch hier bei [email protected] an für weitere Informationen. 3.4 Review Übersicht Als zentrale Stelle von eKomiMeetsMage dient Ihnen die Review Übersicht. Dort finden Sie alle Kundenbewertungen und -meinungen zu all Ihren Produkten. Sie können dort Bewertungen zu Produkten suchen und auch Administrieren (de- und aktivieren) (siehe Abbildung 6). Zur Review Übersicht kommen Sie über „meetsecommerce > eKomiMeetsMage > Review Übersicht“. Abbildung 6: Review Übersicht (c) 2012 meets-ecommerce Online Agentur GmbH Seite 12 von 15 Handbuch eKomiMeetsMage v0.9.0 Wie auf Abbildung 6 zu sehen, können Sie hier alle Reviews einsehen und bei Bedarf auch sortieren nach Zeit, Status, Bewertung, Artikel und Kundenmeinungen. Klicken Sie hierzu einfach auf den Tabellennamen. Eine oder mehrere Bewertungen können Sie aktivieren bzw. deaktivieren in dem in der Tabelle die gewünschten Bewertungen anklicken und dann oben rechts auf „Aktionen“ und dann „Aktivieren“ bzw. „Deaktivieren“ wählen und abschließend mit „ausführen“ bestätigen. Siehe auch Abbildung 7. Abbildung 7: Bewertungen deaktivieren / aktivieren 3.5 Sendestatus Jeder Kunde der im Online Shop kauft, in dem eKomiMeetsMage installiert und konfiguriert ist, bekommt nach einer bestimmten Zeit eine E-Mail mit der Aufforderung bzw. Bitte eine Bewertungen abzugeben. Information: Die Texte und die Zeit, wann der Kunde diese E-Mail bekommt, können Sie bequem in Ihrem eKomi Interface definieren. Die E-Mails werden automatisch durch den CronJob versendet. Oftmals ist es schwierig festzustellen ob E-Mails überhaupt rausgesendet wurden. Wir haben daher den Sendestatus implementiert, damit Sie sehen, welche E-Mails bereits raus sind, welche ausstehend und welche fehlgeschlagen sind. Siehe auch Abbildung 8). (c) 2012 meets-ecommerce Online Agentur GmbH Seite 13 von 15 Handbuch eKomiMeetsMage v0.9.0 Abbildung 8: E-Mail Sende-Status Wie im Abbildung 8 zu sehen, sehen Sie alle wichtigen Informationen auf einen Blick um immer auf dem Laufenden zu bleiben! 3.6 Frontend - Sichtbarkeit für den Kunden eKomiMeetsMage ist eine Standard-Software und ist im Shop-Frontend nicht immer komplett auf Ihre Bedürfnisse angepasst. Aufgrund dessen haben wir für Sie ein Standard-Layout vorbereitet, dass auf dem Standard-Layout von Magento basiert. Siehe dazu Abbildung 9 und 10. Abbildung 9: eKomi Durchschnittbewertung unter dem Produktnamen Abbildung 10: Detailbewertungen (c) 2012 meets-ecommerce Online Agentur GmbH Seite 14 von 15 Handbuch eKomiMeetsMage v0.9.0 Damit Sie in der Lage sind, diese Layout selbstständig anzupassen bzw. anpassen zu lassen möchten wir Ihnen hier eine Übersicht der wichtigen Dateien für die Anpassungen von eKomiMeetsMage im Frontend geben. magento/app/design/frontend/default/default/layout/ekomimeetsmage.xml Hier finden Sie die Layout-Einstellungen für das Frontend. magento/app/design/frontend/default/default/layout/template/ekomimeetsmage /product/name.phtml In dieser Datei befindet sich das HTML für die Darstellung unter dem Produktnamen (siehe auch Abbildung 9). magento/app/design/frontend/default/default/layout/template/ekomimeetsmage /product/feedback.phtml In dieser Datei befindet sich das HTML für die Darstellung der Detailbewertungen auf der Produktseite (siehe auch Abbildung 10). magento/skin/frontend/default/default/css/ekomimeetsmage/style.css Alle CSS Definition finden Sie in dieser Datei. Information: Wenn Sie selber nicht eKomiMeetsMage anpassen möchten oder können, helfen wir Ihnen gerne weiter. Dieser Service ist allerdings kostenpflichtig und kommt ganz auf Ihre Anforderungen an. Fragen Sie doch einfach unter [email protected] an. Angebote und Anfragen sind kostenlos und unverbindlich! (c) 2012 meets-ecommerce Online Agentur GmbH Seite 15 von 15