cms4shop Anwenderhandbuch Version 1.3 Schnittstelle Shopware 5.1 / CMS CONTENIDO Mai 2016

Transkript

1 Anwenderhandbuch cms4shop Version 1.3 Schnittstelle Shopware 5.1 / CMS CONTENIDO Mai 2016 four for business AG Nordring 82 B D Offenbach + 49 (69) support@4fb.de

2 Inhaltsverzeichnis 1 Funktionsbeschreibung Systemvoraussetzungen Lieferumfang Vorbereitung zur Installation von cms4shop Installation von Shopware Installation von CONTENIDO Hinweis: Shop in den Wartungsmodus setzen Konfiguration des CMS CONTENIDO Herunterladen der neuen Dateien Schreibrechte auf neue Ordner setzen Installation des SOAP Server Plugins Anpassen der Schnittstellen-Konfiguration Installation des Shopware REST Plugins Installation des Enterprise Cache Plugins Einrichtung der Zuordnungsmodule(falls benötigt) Modifizieren des Layouts für direkte Seiten-Übertragung Konfiguration von Shopware Herunterladen der neuen Dateien Schreibrechte auf neue Ordner setzen Aktivieren des Plugins Plugin Konfiguration Konfigurationswerte Installation abschließen Hinweise bezüglich IP-Sperren und.htaccess Installation testen Funktionalitäten Gemischte Navigation CMS Unterkategorien anzeigen Navigationsbox Content Suche Einkaufswelten CONTENIDO Artikel Teaser Lizenzbedingungen Weiterentwicklungen am System Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 2 von 29

3 Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 3 von 29

4 1 Funktionsbeschreibung cms4shop ist die Schnittstelle vom Shopsystem Shopware und dem CMS CONTENIDO. Über diese Verbindung ist es möglich, Navigationspunkte und Artikel (Seiten) aus dem CMS im Onlineshop darzustellen. Aktuelle Themen und Neuerungen bezüglich cms4shop inklusive Funktionsbeispielen finden Sie unter: Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 4 von 29

5 2 Systemvoraussetzungen Um den ordnungsgemäßen Betrieb von cms4shop gewährleisten zu können, müssen die aktuellen Systemvoraussetzungen der jeweils verwendeten Version von Shopware und CONTENIDO erfüllt werden. Für den Betrieb von cms4shopist die aktivierte SOAP Erweiterung für PHP ( zwingend erforderlich. Als Systemanforderungen für CONTENIDO in Version 4.9 sind erforderlich: n Scriptsprache PHP ab der Version 5.5 n Datenbank MySQL ab der Version 5.5 n Webserver Apache ab Version 2 Bitte beachten Sie, dass CONTENIDO 4.9 im Gegensatz zu den Vorgängerversionen mindestens PHP 5.3 erfordert. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 5 von 29

6 3 Lieferumfang Zusammen mit diesem Anwenderhandbuch erhalten Sie alle benötigten Dateien, um das cms4shop in Shopware einsetzen zu können. Das Installationspaket setzt sich aus folgenden Plugins zusammen: n 1 cms4shop Plugin für Shopware die Schnittstellenkonfiguration und Frontend Darstellung n 3 CONTENIDO Plugins: 1. Die Schnittstellen Konfiguration (soap) 2. Verbindung Shopware REST-Api (Shopware_rest) 3. Content Cache Invalidierung (cms4shop_enterprise_cache) Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 6 von 29

7 4 Vorbereitung zur Installation von cms4shop 4.1 Installation von Shopware Sofern Sie diesen Schritt nicht bereits erledigt haben, installieren Sie bitte den Shopware Shop (mindestens Version 5) auf Ihrem Webserver. Folgen Sie dabei bitte der Installationsanleitung des Herstellers. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 7 von 29

8 4.2 Installation von CONTENIDO Installieren Sie bitte das CMS CONTENIDO (mindestens Version 4.9.0) auf Ihrem Webserver. Folgen Sie dabei bitte der Installationsanleitung des Herstellers. Die CONTENIDO Installationsanleitung finden Sie unter folgender Adresse: oder im docs Verzeichnis von CONTENIDO. cms4shop setzt auf SOAP-Standard, deshalb ist der Installationspfad von CONTENIDO frei wählbar. 4.3 Hinweis: Shop in den Wartungsmodus setzen Wir empfehlen dringend die erste Installation des cms4shop auf einem Testsystem durchzuführen. Während der Bearbeitung der Aktualisierung wird Ihr Shop möglicherweise nicht wie gewohnt reagieren. Es liegt in Ihrem Ermessen, eine entsprechende Wartungsseite für die Dauer der Bearbeitung Ihren Kunden anzuzeigen. Um den Wartungsmodus zu aktivieren, wählen Sie Einstellungen- >Grundeinstellungen->System->Wartung aus. Mehr Informationen über das Thema Wartung: Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 8 von 29

9 5 Konfiguration des CMS CONTENIDO 5.1 Herunterladen der neuen Dateien Laden Sie zuerst die CONTENIDO Plugins und Module herunter. Dieser befindet sich unter folgender URL: Nach dem Herunterladen entpacken Sie bitte die Plugins das Verzeichnis: contenido/plugins. Damit ist das Backend Verzeichnis von CONTENIDO gemeint. Die Dateien im Verzeichnis contenido/cms müssen in das CONTENIDO Modulverzeichnis cms/data/module entpackt werden. Falls Ihr Mandanten Verzeichnis nicht cms lautet, so muss es nach xyz/data/modules entpackt werden. xyz steht für Mandantenverzeichnis. 5.2 Schreibrechte auf neue Ordner setzen Setzen Sie auf die kopierten Verzeichnisse rekursiv volle Schreibrechte. Die Rechte können mit sudo chmod 0777 R pfad/zum/plugin gesetzt werden. 5.3 Installation des SOAP Server Plugins Melden Sie sich im CONTENIDO Backend mit Systemadministratorrechten an. Navigieren Sie zum Punkt Administration, Plugin Manager. Installieren Sie das hochgeladene Plugin SOAP Webservice mit dem Ordnernamen soap. Um die Konfiguration für das Plugin vornehmen zu können, melden Sie sich aus dem Backend ab und wieder neu an. 5.4 Anpassen der Schnittstellen-Konfiguration Um eine korrekte Verbindung zur Shopware aufbauen zu können, muss das Plugin konfiguriert werden. Tragen Sie im Feld SOAP URL die Adresse zum Shop mit anführendem Slash am Ende ein. Beispiel: Die weiteren Konfigurationen für Vorlagen werden später in der Entwickler- Dokumentation näher beschrieben. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 9 von 29

10 5.5 Installation des Shopware REST Plugins Melden Sie sich im CONTENIDO Backend mit Systemadministratorrechten an. Navigieren Sie zum Punkt Administration, Plugin Manager. Installieren Sie Shopware REST Plugin und melden Sie sich im Backend neu an. Nach der erneuten Anmeldung erscheint ein neuer Navigationspunkt in CONTENIDO unter Extras, Shopware REST. Tragen Sie dort die Shopware Url zum REST-Service ohne Slash am Ende ein z.b. In die Felder Benutzername und Api Key müssen die Zugangsdaten für REST Api eingetragen werden. Legen Sie sich am Besten einen neuen Benutzer in Shopware dafür ein. Weitere Informationen zur REST Api finden Sie hier: Installation des Enterprise Cache Plugins Melden Sie sich im CONTENIDO Backend mit Systemadministratorrechten an. Navigieren Sie zum Punkt Administration, Plugin Manager. Installieren Sie cms4shop Enterprise Cache Plugin. Nach der Installation des Plugins werden verschiedene CONTENIDO Hooks nach Aktionen wie Artikel speichern, löschen, verschieben uvm. aufgerufen, diese invalideren Content Cache über die Shopware REST Api. So müssen Sie bei der Änderung der Inhalte den Cache nicht manuell leeren. 5.7 Einrichtung der Zuordnungsmodule (falls benötigt) Die Zuordnungsmodule werden benötigt falls Sie die Inhalte mit den Produkten verknüpfen möchten. Dadurch ist es möglich auf den Content Seiten die passenden Produkte anzuzeigen z.b. wie hier: Funktionen/index.html Erstellen Sie unter Style, Vorlagen eine neue Vorlage mit dem Layout system. Das Layout system beinhaltet nur ein Container und keine sonstigen Definitionen. Weisen Sie dem Layout system das Modul Shopware_rest_assignment_ajax zu. Erstellen Sie unter Content Artikel - Systemseiten ein Artikel und weisen Sie diesem die angelegte Vorlage zu. Nach der Zuweisung muss die Artikel-ID als Einstellung hinterlegt werden. Wechseln Sie dazu auf Administration, Mandanten, Mandanten auswählen, Mandanteneinstellungen und tragen Sie dort folgende Einstellung ein: Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 10 von 29

11 Typ: cms4shop_ajax Name: idart Wert: Vermerkte Artikel Id Erstellen Sie unter Style, Vorlagen eine neue Vorlage oder wählen Sie in der bereits existierenden Vorlage das Modul Shopware_rest_assignment aus. Sie sind nun in der Lage die Zuordnungen von Inhalten zu Produkten bzw. Shopware Kategorien zu machen. 5.8 Modifizieren des Layouts für direkte Seiten-Übertragung Um dynamische Inhalte komplett übertragen zu können, müssen Sie Ihr Layout geringfügig anpassen. Navigieren Sie im CONTENIDO Backend unter Style, Layouts zum jeweiligen benutzten Layout und bearbeiten Sie den HTML-Quellcode wie folgt: Fügen Sie vor dem ersten Element oder Container im <body>-tag ihrer Webseite, welcher übertragen werden soll, folgenden Code ein: <!-- BEGIN:CONTENT --> Fügen Sie nach dem letzten Element oder Container im <body>-tag ihrer Webseite, welcher übertragen werden soll, folgenden Code ein: <!-- END:CONTENT --> Speichern Sie die Änderungen am Layout mit Klick auf den grünen Haken. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 11 von 29

12 6 Konfiguration von Shopware 6.1 Herunterladen der neuen Dateien Das cms4shop Plugin kann auf zwei Wegen heruntergeladen werden. Entweder direkt aus dem Shopware Store unter oder über den Plugin Manager innerhalb von Shopware. n Wenn Sie das Plugin aus dem Shopware Store herunterladen, müssen Sie diese über das Shopware Backend importieren. Klicken Sie dazu im Backend auf Einstellungen->Plugin Manager. Nach dem Öffnen des Plugin Managers, wählen Sie links unten Community-Erweiterungen aus. Danach klicken Sie bitte auf Plugin manuell hinzufügen. Es öffnet sich ein Upload Dialog. Wählen Sie dort zuvor heruntergeladenes Archiv aus und klicken Sie auf Plugin hochladen. Nach dem erfolgreichen hochladen erscheinen die Plugins in der Liste der inaktiven Plugins. n Wenn Sie die Plugins über den Plugin Manager herunterladen, werden diese automatisch in die richtigen Ordner entpackt und erscheinen dann unter Community-Erweiterungen. 6.2 Schreibrechte auf neue Ordner setzen Setzen Sie auf das Verzeichnis soap, FfbCms4shop rekursiv volle Schreibrechte. Die Rechte können z.b. mit sudo chmod 0777 R pfad/zum/ /plugin gesetzte werden. 6.3 Aktivieren des Plugins Aktivieren Sie das Plugin im Backend von Shopware. Klicken Sie auf Einstellungen->Plugin Manager. Nach dem Öffnen des Plugin Managers, wählen Sie links unten Community-Erweiterungen aus. Nach dem Laden von lokalen Erweiterungen erscheint ein neues Plugin cms4shop im Bereich inaktive Plugins. Mit dem Klick auf das grüne Plus Zeichen lässt sich das Plugins installieren. Nach der erfolgreichen Installation bestätigen Sie bitte die Speicherung der Einstellungen. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 12 von 29

13 6.4 Plugin Konfiguration Nach der Aktivierung der Plugins kann dieses konfiguriert werden. Dazu müssen Sie auf den Stift in der Plugin Konfiguration von cms4shop klicken. Die Werte sind mit Defaultwerten vorbelegt und können pro Shop geändert werden. Die Beschreibung der Felder und der Konfiguration finden Sie im nächsten Abschnitt. 6.5 Konfigurationswerte Benutzername: Hiermit ist der CONTENIDO Backend Benutzer gemeint. Tipp: Erstellen Sie in CONTENIDO unter Administration Benutzer einen separaten CONTENIDO Backend Benutzer, der nur für die Anmeldung im Rahmen des cms4shop verwendet wird. Passwort: Hiermit ist das Passwort des CONTENIDO Backend Benutzers gemeint. Das Passwort wird als MD5-Hash in der Datenbank gespeichert und zur Authentifizierung benötigt. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 13 von 29

14 CONTENIDO Clientid: Hiermit ist CONTENIDO Mandanten-ID gemeint. Diese wird im CONTENIDO Backend nach erfolgreichem Loginbeim jeweiligen Mandanten angezeigt.in der Regel ist die Mandanten-IDnach der Installation 1. CONTENIDO Sprachid:Hiermit ist CONTENIDO Sprach-ID gemeint. Die Sprach- IDwird unter Administration->Sprachen im CONTENIDO Backend angezeigt(siehe Screenshot). In der Regel ist die Sprach-ID nach der Installation 1. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 14 von 29

15 Start-Kategorie der Navigation: Durch diese Einstellung wird festgelegt, welcher Ausschnitt der CONTENIDO Navigation im Shop angezeigt werden soll. Um die gewünschte Kategorie-ID auszulesen, klicken Sie bitte auf Content- >Kategorie im CONTENIDO Backend. Im mittleren Bereich der Seite erscheint der gesamte Kategoriebaum. Bei Mouseover über die entsprechende Startkategorie wird die Kategorie-ID eingeblendet. Max. Navigationstiefe: Durch diese Einstellung wird festgelegt wie viele Ebenen der dargestellte Kategoriebaum im Shop haben kann. Adresse des SOAP Servers: Hiermit ist die Adresse zum CONTENIDO SOAP Server gemeint. Dieser befindet sich im soap-plugin Verzeichnis der CONTENIDO Installation und ist über Backend URL zu erreichen. Die Struktur sieht folgendermaßen aus: <Adresse zum CONTENIDOBackend>/plugins/soap/soap_server.php Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 15 von 29

16 Beispiel: Die Adresse zum Backend von CONTENIDO lautet: Die Adresse zum SOAP-Server würde nun lauten: SOAP-Anfragen speichern: Durch diese Einstellungen werden alle SOAP Anfragen unter: engine/shopware/plugins/community/frontend/ffbcms4shop/views/frontend/soapl og/soap_calls.log gespeichert. CONTENIDO Navigation zeigen: Durch diese Einstellung wird die Content Navigation im Shop in der linken Sidebar dargestellt. Cache-Status: Durch diese Einstellung wird CONTENIDO Content im Shopware Cache abgelegt. Dadurch erhöht sich die Seitenperformance, da die Inhalte nicht mehr per SOAP geladen werden müssen. Cache-Lebensdauer: Durch die Einstellung kann festgelegt werden, wie lange die Inhalte im Cache gültig sind. Nach dem Ablauf der Zeit, werden die SOAP Abfragen erneut ausgeführt und Cache neu geschrieben. Content Suche: Durch diese Einstellung kann die Content Suche aktiviert werden. Die Suchergebnisse werden dabei im separaten Tab auf der Suchergebnisseite angezeigt. Ergebnisse pro Seite: Hier kann festgelegt werden wie viele Content Ergebnisse pro Seite ausgegeben werden. Beschränkung der Suche auf Kategorien: Durch diese Einstellung können Sie einschränken, in welchen CONTENIDO Kategorien gesucht werden darf. Eine Null bedeutet, dass es keine Einschränkung gibt. Ein Artikel können Sie immer aus der Suche ausschließen, indem sie diesen Artikel Eigenschaften als nicht suchbar markieren. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 16 von 29

17 Nachdem Sie die alle Werte eingetragen haben, klicken Sie bitte auf Speichern. Nach erfolgreicher Speicherung der Konfiguration werden Sie durch einen Dialog benachrichtigt. Wenn CONTENIDO in mehreren Subshops verwendet wird, dann muss die Konfiguration für alle Subshops vorgenommen werden. 6.6 Installation abschließen Somit ist die Installation von cms4shop abgeschlossen. Vergessen Sie bitte nicht gegebenenfalls den Wartungsmodus von Shopware wieder zu deaktivieren. 6.7 Hinweise bezüglich IP-Sperren und.htaccess Es ist wichtig, dass sich Shop- und CMS-Server gegenseitig bzw. selbst aufrufen können. Oftmals wird eine solche Verbindung durch IP-Sperren oder eine.htaccess verweigert, was dann zu Problemen bei der Inbetriebnahme führt. Sollten Sie IP- Sperren nutzen, stellen Sie bitte sicher, dass die Server selbst ebenfalls Zugriff haben. Bei der Nutzung eines.htaccess-passwortschutzes ist es zudem ratsam, in den soap -Ordner im Shop und im classes -Verzeichnis von CONTENIDO eine separate.htaccess-datei mit dem Inhalt Satisfyany abzulegen. 6.8 Installation testen Rufen Sie bitte das Shopware Frontend auf und klicken Sie auf eine beliebige Produktkategorie. Auf der linken Seite sollten Sie die CONTENIDO Navigationsstruktur sehen. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 17 von 29

18 Beim Klick auf eine beliebige Kategorie werden CONTENIDO Artikel im Shop dargestellt. Gratulation. Sie haben es geschafft. Die Installation ist erfolgreich abgeschlossen. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 18 von 29

19 7 Funktionalitäten 7.1 Gemischte Navigation Inhalte aus dem CMS und Inhalte aus dem Shop werden gemischt in der Produktnavigation von Shopware dargestellt. Damit können Produktkategorien durch zusätzliche Informationen angereichert werden. Die einfache Zuweisung des Contents (Artikel aus CONTENIDO) erfolgt über das Backend von Shopware. Die entsprechende Struktur der Kategorien und Artikel werden automatisch geladen. Bei inaktiven und nicht freigegebenen Artikeln erfolgt keine Anzeige im Frontend. Um jeweiligen Sprachbaum aus CONTENIDO anzeigen zu lassen, wählen Sie bitte die Sprache aus. Durch den angezeigten Sprachbaum erfolgt keine Zuweisung bzw. Mapping einer anders sprachigen Kategorie, also kein Mapping von z.b. einer deutschen Kategorie auf einen englischen Kategoriebaum aus CONTENIDO. Es geht nur um die Anzeige der/einer gewünschten Sprache. Automatisch werden in der Auswahlliste Auswahl der Kategorien die entsprechenden Kategorien aus CONTENIDO geladen. Durch die Selektion einer Kategorie aus der Liste erfolgt die Zuweisung der Shopzu einer CMS-Kategorie. Das Mapping ist sofort live. Das Steuern der Inhalte erfolgt über CONTENIDO und das on/offline setzen von Kategorien und Artikeln. Sollten also ein Inhalt einmal nicht angezeigt werden, ist die Wahrscheinlichkeit hoch, dass Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 19 von 29

20 entweder die Kategorie oder der Artikel in CONTENIDO noch nicht den Status online haben. 7.2 CMS Unterkategorien anzeigen Um die Pflege und Darstellung zu vereinfachen, können innerhalb der Shop- Navigation auch die weiteren Unterkategorien aus CONTENIDO automatisch angezeigt werden. Damit ist es nicht notwendig, auch Unterkategorien im Shop- Backend anzulegen und jeweils auf die entsprechenden CMS-Kategorie zu mappen. Sollen aus CONTENIDO weitere Unterkategorien automatisch angezeigt werden, wird nur die übergeordnete Kategorie gemappt (siehe 7.1) und der Haken bei Unterkategorien anzeigen gesetzt. 7.3 Navigationsbox Die Kategoriestruktur aus CONTENIDO kann im Shop-Frontend ausgegeben werden. Hierzu ist bereits in dem Plugin Templates die Ausgabe implementiert. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 20 von 29

21 Die Ausgabe basiert in dem Demoshop auf folgender Kategoriestrukur im CONTENIDO-Backend. 7.4 Content Suche Die Content Suche ermöglicht schnelles auffinden der relevanten Content Ergebnisse. Wenn die Content Suche aktiviert ist, werden die Content Ergebnisse im separaten Tab auf der Suchergebnisseite angezeigt. Wenn keine Inhalte für die Suchbegriffe gefunden werden, wird die Standardsuchansicht des Shops angezeigt. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 21 von 29

22 7.5 Einkaufswelten CONTENIDO Artikel Mit dem CONTENIDO Artikel können Sie einfach in Ihre bestehenden oder neuen Einkaufwelten die CMS Inhalte integrieren. Dazu müssen Sie das Widget in den Grid ziehen und in der Konfiguration gewünschte Artikel auswählen. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 22 von 29

23 Nach der Auswahl wird der gesamte Artikel in den Einkaufswelten angezeigt. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 23 von 29

24 7.6 Einkaufswelten CONTENIDO Artikel Teaser Mit dem CONTENIDO Artikel Teaser können Sie einfach in Ihre bestehenden oder neuen Einkaufwelten CMS die Inhalte integrieren. Dazu müssen Sie das Widget in das Grid der Einkaufswelten ziehen und in der Konfiguration den gewünschten Artikel auswählen. Dabei können ebenfalls die CMS-ID s angepasst werden. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 24 von 29

25 Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 25 von 29

26 Nach der Speicherung sieht das Ergebnis wie folgt aus: Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 26 von 29

27 Durch den Klick auf mehr kann der gesamte Artikel im Shop aufgerufen werden. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 27 von 29

28 8 Lizenzbedingungen Die Schnittstelle cms4shop und das CMS CONTENIDO unterliegen dem Urheberrecht der four for business AG. Die Schnittstelle ist quelloffen und darf vom Kunden verändert werden. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 28 von 29

29 9 Weiterentwicklungen am System Das cms4shopwird zukünftig von der four for business AG weiter entwickelt. Falls Sie Vorschläge für funktionale Verbesserungen oder Erweiterungen haben, wenden Sie sich bitte per an Ebenso unterstützen wir Sie gerne bei Ihrer individuellen Implementierung. Anwenderhandbuch 1.3 für CONTENIDO 4.9 Cms4shop Seite 29 von 29