Die Idee zum Shopware Redirect Plugin
Mit dem Shopware Redirect Plugin wollen wir von scope01 eine große Arbeitserleichterung und Hilfe schaffen. Denn immer wieder stehen wir als Internetagentur vor der mühsamen Herausforderung, dass wir für Kunden redirects (Weiterleitungen, bzw. Umleitungen) z.B. bei einem Livegang oder bei Änderungen / Deaktivierung von Produkten in der htaccess manuell verwalten müssen.
Dies ist für den Kunden weder nachvollziehbar noch im laufenden Betrieb administrierbar. Denn in Regel arbeitet kein Kunde an einer htaccess Datei. Auch ist die Abstimmung über den Versand von Excel / CSV Daten ziemlich umständlich und zeitaufwändig. So kamen wir auf die Idee für Shopware ein Plugin zu entwickeln, in welchem die User redirects im Shopware Backend verwalten können. Zuerst haben wir das Plugin für Shopware 5 entwickelt, dann auch für Shopware 6.
Was sind Weiterleitungen?
2 Arten von Weiterleitungen sind für die Administration von Onlineshops sehr wichtig:
- Der Statuscode 301 steht für eine dauerhafte Umleitung (moved permanently). Diese kommt zum Beispiel dann zum Einsatz, wenn ein Artikel ausverkauft und bereits ein Nachfolger definiert ist. Auf diesen Nachfolger soll dann automatisch verlinkt werden.
- Der Statuscode 302 steht für eine vorübergehende Umleitung (moved temporarily). Zum Beispiel ein Artikel hat keinen Bestand mehr und soll für eine bestimme Zeit offline genommen werden. So können Sie im Shop vorübergehend auf ein alternatives Produkt weiterleiten.
Durch den Eintrag von Weiterleitungen werden Fehler (z.B. Fehler 404 nicht gefunden) für den Besucher des Onlineshops vermieden. Zusätzlich wird der Wert einer suchmaschinenoptimierten Seite von dem alten auf den neuen Artikel übertragen.
Shopware 6
Seit 2020 bieten wir unser erfolgreiches Shopware Redirect Plugin für die Version 6 von Shopware an. Dieses ist von uns grundlegend neu entwickelt worden, da sich die technische Basis von Shopware Version 5 zu Version 6 komplett verändert hat. Damit stehen auch in der neuen Version der E-Commerce Software die Möglichkeiten zur Einrichtung von Weiterleitungen zur Verfügung. Sowohl für dauerhafte (301) als auch temporäre Weiterleitungen (302). Dieses Plugin können Sie hier im Shopware Store herunterladen.
Die Administration der Weiterleitungen befindet sich in Shopware 6 unter Einstellungen – Shop – Weiterleitungen:
Shopware 5
Der Verwaltung der Weiterleitungen befindet sich in Shopware 5 unter dem Menüpunkt Einstellungen – Redirect Manager. Sobald der User das Plugin öffnet, erhält er eine Übersicht der bereits hinterlegten Weiterleitungen:
Administration im Shopware Redirect Plugin
Zur Verwaltung der Weiterleitungen werden in beiden Plugins (Shopware 5 und 6) die Startadresse (Start URL), die Zieladresse (Target URL) sowie der dazugehörige http Code eingegeben. Dabei stehen die Statuscodes 301 und 302 als Auswahl zur Verfügung . Bezüglich den Adressen (URL) kann der User kann in der Verwaltung einen neuen Eintrag hinzufügen. Sowie alle bereits hinterlegten Einträge löschen oder bearbeiten.
Neben der manuellen Bearbeitung von redirects gibt es die Möglichkeit die bereits hinterlegten Weiterleitungen für Shopware zu exportieren oder aber neue Weiterleitungen zu importieren. Hierzu stehen dem User zwei prominente Schaltflächen zur Verfügung. Der Export der Dateien erfolgt in Form einer csv-Datei mit UFT-8 Kodierung. Für den Import von Daten sind diese Vorgaben zu berücksichtigen (CSV/UTF8), sonst ist kein Import möglich.
Häufige Fragen Shopware Redirect Plugin (FAQ)
Fragen zur Funktion des Plugins
Um unser Plugin zu nutzen, müssen die alten URLs weiterhin erreichbar sein. Da dies in der Regel nicht der Fall ist, eignet sich eine Konfiguration der Weiterleitungen mittels eines einzelnen .htaccess Befehls eher. Sonst müssen Sie auch jede einzelne URL mit Quelle und Ziel in unserem Redirect Plugin hinterlegen, um das gewünschte Verhalten zu erreichen.
Ja. Dabei ist es egal, ob die verschiedenen Sales Channel über unterschiedliche Domains erreicht werden oder über die selbe Domain.
Ja. Seit der Version 1.2.0 ist es möglich, Query Strings in der Quell URL zu ignorieren. Dies kann für jede Weiterleitung individuell aktiviert/deaktiviert werden. Seit der Version 2.1.0 ist es außerdem möglich, Query Strings aus der aufgerufenen ULR in die Ziel URL zu übernehmen.
Ja. Seit der Version 2.2.0 unterstützt das Plugin spezielle Zeichen wie Umlaute in der Quell-URL. Diese Unterstützung muss in der Plugin Konfiguration aktiviert werden.
Mit dem Redirect Plugin lassen sich nur Weiterleitungen realisieren, deren Quell URLs sich in der Shopware Umgebung befinden. Die Ziel URLs können frei gewählt werden und müssen sich nicht in der Shopware Umgebung befinden.
Das Redirect Plugin ergänzt die Shopware Logiken bezüglich Weiterleitungen.
Die von Shopware gesetzten Weiterleitungen werden im Redirect Plugin nicht aufgeführt.
Nein. Ist eine Weiterleitung keinem Verkaufskanal zugewiesen, ist diese in allen Verkaufskanälen aktiv.
Fragen zur Bedienung des Plugins
In Shopware 6 unter Einstellungen – Shop – Weiterleitungen.
Grundsätzlich kann es beim Importieren vorkommen, dass eine Weiterleitung in der Import Datei bereits im System vorhanden ist. Für diesen Fall können Sie festlegen, ob das System die vorhandene Weiterleitung im System mit der Weiterleitung aus der Datei überschreiben soll, oder ob die Weiterleitung in der Datei übersprungen werden soll.
Dabei gibt es 2 Möglichkeiten, gleiche Weiterleitungen zu erkennen – für beide Möglichkeiten können Sie separat zwischen überschreiben und überspringen wählen:
- Die IDs der Weiterleitungen sind gleich
- Die Quell URLs der Weiterleitungen sind gleich
Für jede Weiterleitung kann individuell entschieden werden, wie mit Query Parametern umgegangen wird. Dabei stehen folgende Optionen zur Auswahl:
- „Query Parameter bei der Suche berücksichtigen“: Bei der Suche nach einer passenden Weiterleitung wird nach der aufgerufenen URL inklusive Query Parameter gesucht.
Beispiel: Wurde eine Weiterleitung von „/demo“ nach „/ziel“ erstellt, der Kunde ruft jedoch „/demo?einParameter“ auf, findet keine Weiterleitung statt. - „Query Parameter bei der Suche ignorieren“: Bei der Suche nach einer passenden Weiterleitung wird nach der aufgerufenen URL mit und ohne Query Parameter gesucht.
Beispiel: Wurde eine Weiterleitung von „/demo“ nach „/ziel“ erstellt und der Kunde ruft „/demo?einParameter“ auf, findet eine Weiterleitung nach „/ziel“ statt. - „Query Parameter bei der Suche ignorieren und zur Ziel-URL hinzufügen“: Bei der Suche nach einer passenden Weiterleitung wird nach der aufgerufenen URL mit und ohne Query Parameter gesucht. Anschließend werden die Query Parameter des Aufrufes an die konfigurierte Ziel-URL angehängt.
Beispiel: Wurde eine Weiterleitung von „/demo“ nach „/ziel“ erstellt und der Kunde ruft „/demo?einParameter“ auf, findet eine Weiterleitung nach „/ziel?einParameter“ statt.
Damit eine neue Weiterleitung erzeugt wird, muss das Feld in der Spalte „id“ einfach leer gelassen werden. Die Spalte darf jedoch nicht weggelassen werden.
Technische Fragen
Die Tabelle heißt scop_platform_redirecter_redirect.
Ja, der Quell Code ist auf Github verfügbar: https://github.com/scope01-GmbH/ScopPlatformRedirecter
Major Updates Shopware Redirect Plugin
Oktober 2021
Auf vielfachen Wunsch haben wir jetzt eine Import und Export Funktion in das Shopware 6 Plugin integriert. Damit können über csv Dateien Weiterleitungen importiert und exportiert werden. Vor dem Import empfehlen wir manuell ein paar Weiterleitungen anzulegen. Und diese dann als csv Datei zu exportieren. Damit haben Sie eine gute Vorlage für den weiteren Import. Denn die csv Datei ist oftmals die Ursache für Fehler. Zum Beispiel wenn ein falscher Zeichensatz oder ein falsches Trennzeichen verwendet wird.
Zusätzlich kann jetzt jede einzelne Weiterleitung aktiviert und deaktiviert werden.
September 2020
Das Shopware Redirect Plugin bieten wir seit 4 Monaten im Shopware Store und auf Github an. Alleine im Store wurde es bereits über 100 mal heruntergeladen. Auch auf Github zeigt sich bereits erste Aktivität. Die Nachfrage nach einer einfachen Administration von Weiterleitungen, direkt im Shopware Backend, ist also da.
Aus diesem Grund haben wir uns entschlossen, mit der Version 1.0.6 das Shopware Redirect Plugin einem Refactoring zu unterziehen. Mit anderen Worten wir haben den Code noch einmal grundlegend verbessert und optimiert. Für technisch Versierte hier die Änderungen im Einzelnen:
- changed plugin compatibility from 5.5.10 to 5.5.0
- fixed readme
- removed additional slash at the end fix
- removed strict_type and proprietary comment from the subscriber
- fixed php-unit test and added detail controller check for redirecting link
- removed checking for the detail controller
- new plugin configuration added and phpunit test
- added config.xml
- added more inputs for php-unit test
- Override the readme and upgraded the plugin version
- PHP-unit test override
- added a new php-unit test
- composer and readme updated
- improved translations, labels, descriptions and types
- improved translations, labels, descriptions and types
- refactored plugin testing classes cases and functionality
- added default values, validation and fixed phpstan errors
- added php headers
- fixed translation
- added more validations on update
- close detail window after successful save
- improved changelog
- added start uri validation, fixed minor styling issues
- fixed default values and added validation on importing from csv file
Bei Fragen zum Shopware Redirect Plugin oder zu Shopware wenden Sie sich bitte direkt an uns. Als zertifizierter und prämierter Shopware Partner stehen wir Ihnen gerne zur Verfügung.