Einleitung

Das Plugin bietet Endnutzern des Shops die Möglichkeit den aktuellen Warenkorb als PDF herunterzuladen.

Features

• Vielseitige Konfigurationsmöglichkeiten der Darstellung der PDF

• Große Auswahl an Einstellungen

Installation / Update

Systemvoraussetzungen

Shopware 6.3 und alle damit einhergehenden Systemvoraussetzungen müssen erfüllt sein.

Weitere Voraussetzungen

Es werden keine Accounts zu Drittanbietern oder API-Zugänge benötigt.

Plugin-Installation

Um das Plugin zu installieren, sind folgende Schritte notwendig:

Manueller Upload

1. Download des Plugins

2. Im Admin Dashboard unter Einstellungen → System → Plugins auf den Button Upload Plugin klicken

3. Die Datei markieren und hochladen

Aktivierung

Ist das Plugin hochgeladen muss das Plugin noch installiert & aktiviert werden. Bitte beachten Sie, dass nur installierte Plugins aktiviert werden können. Um das Plugin zu installieren, wählen Sie in der rechten Spalte (Button mit 3 grauen Punkten) den Punkt installieren aus. Nach erfolgreicher Installation können Sie das Plugin aktivieren und dann mit der weiteren Konfiguration fortfahren.

Plugin-Update

Sämtliche in der Pluginkonfiguration durchgeführten Änderungen bleiben bei einem Pluginupdate erhalten. Die Ausnahme hiervon bilden neu hinzugefügte Textblöcke, die einen bisher vorhandenen Textblock ersetzen.

Konfiguration

Shop

Die Konfiguration des Plugins ist in verschiedene, logisch aufgeteilte Bereiche gegliedert.

Allgemeine Plugineinstellungen:

• Plugin anzeigen (Ja/Nein): Gibt an, ob das Plugin grundsätzlich aktiviert sein soll.

• Button im Ajax Warenkorb anzeigen (Ja/Nein): Gibt an, ob der Button im Sidebar-Warenkorb angezeigt wird oder ausschließlich im “echten” Warenkorb.

• Button-Stil (Auswahl):
  - Primär: Der Button wird ähnlich dargestellt wie der “Zur Kasse” Button im Sidebar-Warenkorb
  - Sekundär:
  - Link: Der Button wird ähnlich dargestellt wie der “Zum Warenkorb” Button im Sidebar-Warenkorb
  - Custom CSS: Dieses Auswahlfeld hat nur in Kombination mit der nächsten Option einen Effekt auf die Darstellung des Plugins

• Custom CSS für Button (Text): Dieses Feld erlaubt Ihnen eigenes CSS für die Darstellung der Buttons zu definieren.

• Benutzergruppen (Mehrfachauswahl): Die Einstellungsmöglichkeit listet alle in Ihrem Shop angelegten Kundengruppen auf. Die Anzeige des Plugins wird auf die hier angezeigten Kundengruppen limitiert.

Allgemeine PDF-Einstellungen:

• Rechnungsanschrift auf PDF anzeigen (Ja/Nein): Gibt an, ob auf den generierten PDFs Felder für eine Rechnungsanschrift ausgewiesen werden

• Lieferanschrift auf PDF anzeigen (Ja/Nein): Gibt an, ob auf den generierten PDFs Felder für eine Lieferanschrift ausgewiesen werden

• Rechnungs- und Lieferanschrift vorausfüllen (Ja/Nein): Gibt an, ob die in der PDF angezeigten Adress-Felder für eingeloggte Nutzer mit der Standard Liefer- bzw. Rechnungsanschrift vorausgefüllt werden.

• B2B Felder anzeigen (Ja/Nein): Fügt beiden Anschriften Felder für Firma und Umsatzsteuer-ID hinzu.

• Zahlungsart vorauswählen (Ja/Nein): Markiert bei eingeloggten Nutzern die Standard-Zahlungsart auch im PDF als aktiv. Bitte beachten Sie die Info am Ende dieses Einstellungs-Blocks, um mehr über diese Option zu erfahren.

• Versandart vorauswählen (Ja/Nein): Markiert die für diesen Warenkorb genutzte Standard-Versandart auch im PDF als aktiv. Bitte beachten Sie die Info am Ende dieses Einstellungs-Blocks, um mehr über diese Option zu erfahren.

• Datei-Präfix (Texteingabe): Beim Speichern oder Download der PDF wird jeweils ein Dateiname mit aktuellem Datum und aktueller Uhrzeit generiert. Die Eingabe hier wird vorangestellt, z.B. wird aus “MeinAngebot” beim Speichern der Dateiname “MeinAngebot_06112020_052711”.

• Schriftart (Auswahl): Gibt an, welche Schriftart zur Erstellung der PDF genutzt werden soll.

• PDF-Download (Auswahl): Gibt an, ob sich die PDFs in einem neuen Tab öffnen oder heruntergeladen werden.

• Erlaubte Zahlungsarten (Auswahl): Listet alle im Shop angelegten Zahlungsarten auf und limitiert die Anzeige im PDF auf die hier ausgewählten. Bitte beachten Sie, dass der Rulebuilder hier ebenfalls eine Rolle spielt und bei entsprechender Konfiguration eines Artikels z.B. Vorkasse trotz Auswahl bei dieser Einstellung nicht angezeigt wird. Wenn keine Auswahl getroffen wird, werden alle für diesen Warenkorb passenden Zahlungsarten angezeigt.

• Erlaubte Versandarten (Auswahl): Listet alle im Shop angelegten Versandarten auf und limitiert die Anzeige im PDF auf die hier ausgewählten. Bitte beachten Sie, dass der Rulebuilder hier ebenfalls eine Rolle spielt und bei entsprechender Konfiguration eines Artikels z.B. DHL trotz Auswahl bei dieser Einstellung nicht angezeigt wird. Wenn keine Auswahl getroffen wird, werden alle für diesen Warenkorb passenden Versandarten angezeigt.

PDF-Header Einstellungen:

• Header Höhe in cm (Zahlenfeld): Gibt die Höhe des Headers auf den generierten PDFs an.

• Header Hintergrundfarbe (Farbwähler): Setzt die Hintergrundfarbe für den Header.

• Logo (Medienauswahl): Das Logo wird immer oben rechts positioniert.

PDF-Footer Einstellungen

• Footer Höhe in cm (Zahlenfeld): Gibt die Höhe des Footers auf den generierten PDFs an.

• Footer-Spalten (Auswahl): Gibt an, in wie viele Spalten der PDF-Footer aufgeteilt wird.

• Footer-Schriftgröße (Auswahl): Legt die für den Footer angewandte Schriftgröße fest.

• Footer-Spalten 1 bis 5 (Hinweisfeld): Sie können die Inhalte des Footers ganz einfach wie im Abschnitt Individualisierung - Textblöcke angegeben anpassen

• “Kleingedrucktes” (Hinweisfeld): Sie können die Inhalte des Kleingedruckten ganz einfach wie im Abschnitt Individualisierung - Textblöcke angegeben anpassen

• Footer Hintergrundfarbe (Farbwähler): Setzt die Hintergrundfarbe für den Footer.

• Footer Schriftfarbe (Farbwähler): Setzt die Schriftfarbe für den Footer.

PDF-Warenkorb Einstellungen:

• Warenkorb-Header Hintergrundfarbe (Farbwähler): Setzt die Hintergrundfarbe für den Warenkorb-Header.

• Warenkorb-Header Schriftfarbe (Farbwähler): Setzt die Schriftfarbe für den Warenkorb-Header.

• Warenkorb-Footer Hintergrundfarbe (Farbwähler): Setzt die Hintergrundfarbe für den Warenkorb-Footer.

• Warenkorb-Footer Schriftfarbe (Farbwähler): Setzt die Schriftfarbe für den Warenkorb-Footer.

ERP-System

Das Plugin erfordert keine Schnittstelle zu einem ERP-System.

Betrieb

Das Plugin erfordert nach einmaliger Konfiguration keine weiteren Einstellungen.

Shop

Das Plugin fügt je nach Konfiguration zwei für Nutzer des Shops sichtbare Buttons in die Storefront ein.

Individualisierung

Das Plugin kann im Frontend entsprechend modifiziert werden.

Templates

• Anzeige im Warenkorb (/storefront/page/checkout/cart/index.html.twig) via Block page_checkout_cart_action_proceed in Block s360_pdf_cart_wrapper

• Anzeige im Ajax-Warenkorb (Seitenleiste, /storefront/component/checkout/offcanvas-cart.html.twig) via Block component_offcanvas_cart_actions_cart in Block s360_pdf_ajaxcart_wrapper

CSS

Das Plugin bietet bis hin zur Verwendung von Inline-CSS viele Möglichkeiten die Darstellung in der Shop-Storefront anzupassen. Änderungen, die über die Konfigurationsmöglichkeiten in der Administration hinausgehen, sind über das Template-System von Shopware in Ihrem eigenen Storefront-Template möglich.

Textblöcke

Sie können die verwendeten Textbausteine ganz einfach über die Administrationsoberfläche Ihrer Shopware-Installation anpassen. Unter Einstellungen wählen Sie im ersten Reiter “Shop” den Punkt “Textbausteine” aus, klicken dann in der rechten Spalte bei dem Textbaustein-Set, für das Sie Änderungen vornehmen wollen, auf “bearbeiten”. Danach können Sie oben in der Suche nach “s360-pdf.” suchen und finden alle Textbausteine, die für das Plugin relevant sind.

Troubleshooting

Logs prüfen

Um herauszufinden, wo ein Problem liegt, helfen Ihnen und uns die Logs. Je nach Fehlerbild ist eines der folgenden drei Logs dafür mehr oder weniger relevant.

Browser-Log

Das Browser-Log ist meist relevant, wenn sich irgendwas im Frontend des Shops merkwürdig verhält oder nicht reagiert. (Beispiel: Sie klicken einen Button und augenscheinlich passiert gar nichts.)

Das Browser-Log sehen Sie, wenn Sie im Browser F12 drücken und dort dann auf Konsole (oder Console) wechseln.

Shop-Log

Das Shop-Log ist immer dann interessant, wenn im Frontend unerwartete Fehlermeldungen ausgegeben werden oder das Plugin zwar auf Eingaben im Frontend reagiert, aber nicht das Ergebnis liefert, was erwartet wurde. Manchmal ergibt sich auch durch das Browser-Log, dass die Informationen eher im Shop-Log zu suchen sind.

Webserver-Log

Das Webserver-Log wird dann relevant, wenn Sie irgendwo auf einen Error 500 (= weiße Seite) stoßen. Das Webserver-Log kann Ihnen Ihr Hoster zur Verfügung stellen.

FAQ

Ich habe mein Plugin aktiviert, sehe aber im Warenkorb keinen “PDF-anzeigen” Button?

Eine der häufigsten Ursachen hierfür ist, dass die Vererbung des Templates nicht korrekt durchgeführt wird. Um sicherzugehen, dass es sich lediglich um einen Darstellungsfehler und nicht um einen Programmierfehler handelt, macht es Sinn, das Plugin einmalig im Shopware-eigenen Storefront Template und ohne andere Plugins zu testen. Sollte der Fehler nicht mehr bestehen und das Plugin wie erwartet funktionieren, lassen sich die Ursachen nun nach dem Ausschlussprinzip der Reihe nach durchgehen. Aktivieren Sie zuerst ihr u.U. angepasstes Storefront-Template und prüfen Sie die Funktionalität, dann aktivieren Sie Schritt für Schritt Ihre Plugins.

Changelog

v1.0.0 (Oktober 2020)

• Initiales Release

Support und Kontakt

siehe Support und Kontakt