Dokumentation FAQ (Plugin für Shopware)

Link zum Plugin: http://bit.ly/netzperfekt-faq

In dieser Dokumentation wird das Plugin FAQ und Support beschrieben. Mit diesem Plugin können Sie in Ihrem Shopware-Shop einen (oder mehrere) FAQ-Bereiche aufbauen und diese direkt mit einem Support-Formular koppeln. 

Dadurch, dass Ihre Nutzer zunächst in den bisher bereits aufgetretenen Fragen und Antworten (FAQ) selbst nach einer passenden Antwort suchen, kann Ihr Support oftmals deutlich entlastet werden.

Als Support-Formular kann jedes beliebige Shopware-Formular (z.B. das im Standard vorhandene Kontakt-Formular) verwendet werden. Sofern ein Nutzer mit seinem Kundenkonto angemeldet ist, werden überdies die Formularfelder bereits vorausgefüllt.

Falls Sie das Support- und Ticket-System Zendesk einsetzen, können Sie dieses direkt ankoppeln. Alle eingehenden Support-Anfragen werden so automatisch direkt nach Zendesk übertragen.

Das Plugin dient somit zur Effizienzsteigerung und Vereinfachung Ihres Support-Prozesses.

Installation und Einrichtung

Benötigt wird Shopware ab Version 5.2.7. 

Installieren Sie bitte das Shopware-Plugin wie gewohnt über den Plugin-Manager.
(Allgemeine Hinweise dazu finden sich unter http://community.shopware.com/Plugin-Manager-ab-Shopware-5_detail_1856_643.html). 

Die Eingabe eines Lizenzschlüssels ist nicht notwendig. Falls Sie von einer Testversion auf die Kaufversion gewechselt haben, kann es bis zu 24h dauern, bis der neue Lizenzstatus im Plugin-Manager angezeigt wird.

In den Plugin-Settings kann gibt es einige grundlegende Einstellungen, die für jeden FAQ-Bereich gelten:


Formular eingeklappt anzeigenFalls Sie einem FAQ-Bereich ein Support-Formular zuordnen, können Sie hierüber bestimmen, ob es standardmässig angezeigt wird (= Nein), oder zunächst eingeklappt ist (= Ja). Der Nutzer kann somit animiert werden, nicht sofort das Formular auszufüllen, sondern zunächst selbst nach der passenden Lösung zu suchen.

Formular-Header anzeigen: Für jedes Shopware-Formulare kann ein einleitender Text definiert werden. Hier können Sie bestimmen, ob dieser zusätzlich nach dem FAQ-Bereich über dem Formular angezeigt werden soll.

Zendesk Subdomain, Zendesk User und Token: Falls Sie die Anbindung an das Ticketsystem Zendesk wünschen, müssen Sie hier die korrekten Zugangsdaten eintragen. Bitte wenden Sie sich dazu an Ihren Zendesk-Dienstleister, weitere Informationen dazu finden Sie auch unter https://support.zendesk.com/hc/en-us/articles/226022787-Generating-a-new-API-token-.

FAQ durchsuchen: Mit unserem Plugin Suchen im Blog, CMS, Herstellern und Kategorien (bit.ly/netzperfekt-sucheueberall) können Sie optional auch die FAQ-Bereiche mit durchsuchen. Wenn Sie dieses Plugin nicht einsetzen, ist diese Einstellung wirkungslos.

FAQ-Bereich anlegen

Das Plugin ist über einen eigenen Menüpunkt unter Backend / Inhalte / FAQ & Support erreichbar. Nun können beliebig viele FAQ-Bereiche definiert werden.

Die Bedienung funktioniert wie von Shopware insgesamt gewohnt: Über Hinzufügen erstellen Sie einen neuen Bereich, das Minus-Symbol löscht einen Bereich und der Bleistift erlaubt die Bearbeitung. Ein Doppelklick auf einen Eintrag in der Liste bietet einige Felder zur direkten Bearbeitung an. 

Die FAQ-Bereiche sind hierarchisch wie folgt organisiert:

  • FAQ-Bereich (z.B. „Fragen und Antworten“)
    • FAQ-Gruppen (z.B. „Allgemein“)
      •     FAQ-Eintrag 1
      •     FAQ-Eintrag 2
      •     FAQ-Eintrag 3
    •     …
    •     FAQ-Gruppen (z.B. „Versand“)
      •     FAQ-Eintrag 1
      •     FAQ-Eintrag 2
      •     …
  • FAQ-Bereich (z.B. „Produkte“)


Sie können auf jeder Hierarchiestufe beliebig viele Einträge anlegen, sollten aber bedenken, dass üblicherweise eine gut überschaubare Menge an Informationen maximal 7-9 Elemente enthalten sollte.

Legen Sie zunächst einen neuen FAQ-Bereich an:


Die Felder haben folgende Bedeutung:

Schlüssel: vergeben Sie hier bitte einen eindeutigen Namen für diesen FAQ-Bereich, dieser wird nur intern benutzt, sollte aber keine Sonderzeichen oder Leerzeichen beinhalten.

Titel, Headerbild und Beschreibung: diese Informationen werden im neuen FAQ-Bereich
über den Gruppen und Einträgen angezeigt.

Text über Kontaktformular: Falls Sie ein Shopware-Formular zugeordnet haben und verwenden möchten, können Sie hier einen Text eintragen, der direkt über dem Formular angezeigt wird (z.B. eine Aufforderung in der Art: „Falls Sie mit unseren FAQ Ihr Problem noch nicht lösen konnten, schreiben Sie uns bitte über das folgende Formular.“). 

Formular-ID: hier können Sie optional ein Shopware-Formular zuordnen. Die Formular ID finden Sie direkt im Formulareditor (Backend / Inhalte / Formulare), in dem Sie das gewünschte Formular bearbeiten. Es ist dann die Zahl hinter sFid=



Wichtig: nachdem Sie die Grundinformationen für den neuen FAQ-Bereich eingegeben haben, drücken Sie bitte den Speichern-Button!

Anschliessend können Sie den Tab Gruppen anwählen und beginnen, die gewünschten FAQ-Gruppen einzugeben. (Kommt es hier zu einem "Rauswurf" des Backendnutzers -> Berechtigung category / read ist erforderlich)

Analog verfahren Sie dann mit den Grunddaten zu einer FAQ-Gruppe:

Die Felder sollten selbsterklärend sein, die hier eingegebenen Informationen werden innerhalb der FAQ-Gruppe ausgegeben. Sie können auswählen ob diese Gruppe nur in einer bestimmten Kategorie angezeigt wird, oder in allen Artikeln und dafür nicht in der globalen FAQ. So können zu Artikeln einer ganz bestimmten Gruppe individuelle FAQ erscheinen.

Im Tab Einträge können Sie nun beliebig viele FAQ-Einträge (in diesem FAQ-Bereich und dieser FAQ-Gruppe) anlegen - denken Sie an die oben beschriebene Hierarchie.

Titel, Frage und Antwort sind die eigentlichen Informationen des FAQ-Eintrages. 

Sticky können Sie ankreuzen, wenn es sich um eine besonders wichtige Frage/Antwort handelt. Diese wird dann stets oben innerhalb der Gruppe dargestellt und ist bereits ausgeklappt. Somit kann dieser spezifische Eintrag von Ihren Nutzen kaum übersehen werden.

Link erlaubt es, einen (internen oder externen) Link mit dem FAQ-Eintrag zu verbinden.

Header-Bild: optional können Sie noch ein Bild auswählen, dass über dem FAQ-Eintrag dargestellt wird, etwa zur visuellen Erläuterung Ihrer Antwort.

Aufruf im Frontend

Der Aufruf im Frontend erfolgt über den vergebenen Titel des FAQ-Bereiches.
Wenn dieser z.B. FAQ lautet, können Sie den FAQ-Bereich entsprechend unter der Adresse 

http://www.IhrShop.de/FAQ 

aufrufen. Leerzeichen im Titel werden zu Bindestrichen, „Fragen und Antworten“ also zu www.IhrShop.de/Fragen-und-Antworten.

Alternativ können Sie den FAQ-Bereich auch über den vergebenen Schlüssel aufrufen. Die URL dazu lautet: 

www.IhrShop.de/NetzpFaq/index/faq/<Schlüssel>

Sie können diese Adressen zum Beispiel verwenden, um einen FAQ-Bereich in das Shopware-Menü einzubinden. Legen Sie dazu einfach eine neue Kategorie im Kategoriebaum an und nehmen hier keine Produktzuordnung vor. Stattdessen tragen Sie den gewünchten FAQ-Link in das Feld Auf externe Seite verlinken ein.


Support Formular verwenden

Wie oben beschrieben, können Sie optional jedem FAQ-Bereich ein Formular zuordnen.
Dabei handelt es sich um die normalen Shopware-Formulare (Backend / Inhalte / Formulare), die Sie wie gewohnt definieren können. In Erweiterung dazu gibt es einige besondere Felder, die vom Plugin automatisch mit Informationen gefüllt werden und somit beim Absenden dann auch übertragen werden.

Die Verbindung zum Plugin erfolgt dabei über den Feldnamen in der Formular-Definition:

Entspricht der Feldname einer der folgenden Bezeichnungen (auf exakte Schreibweise achten!), erfolgt eine automatische Übertragung von Informationen wie beschrieben:

bereich: Hier wird der Inhalt der Drop-Down-Liste eingetragen, die über dem Kontaktformular angezeigt wird.    

kdnr: Sofern der Nutzer mit seinem Shopware-Kundenkonto angemeldet ist, wird hier die aktuelle Kundennummer eingetragen.

faq: Hier werden die Gruppe und FAQ-Eintrag übernommen, die der Nutzer zuletzt angeklickt hat.

faq1: Hier wird die Gruppe (Titel) übernommen, die der Nutzer zuletzt angeklickt hat.

faq2: Hier wird der FAQ-Eintrag (Titel) übernommen, die der Nutzer zuletzt angeklickt hat.

anrede, vorname, nachname, email, telefon: diese Felder werden automatisch befüllt, sofern der Nutzer mit seinem Shopware-Kundenkonto angemeldet ist.

Hinweis: alle Felder sind optional. Wenn Sie nicht vorhanden sind, werden sie nicht befüllt.

Anbindung an Zendesk

Sofern die Zendesk-Zugangsdaten in den Plugin-Einstellungen hinterlegt sind, kann für jeden FAQ-Bereich gewählt werden, ob die Weiterleitung des Support-Formulars wie gewohnt per E-Mail erfolgen soll oder direkt in Zendesk erzeugt wird. Hier wird dann ein Zendesk-Ticket über die Zendesk-Schnittstelle (API) vollautomatisch im Hintergrund angelegt und kann im gewohnten Zendesk-Umfeld weiter bearbeitet werden.


Wir wünschen Ihnen viel Erfolg 
mit unserem Plugin und 
gute Geschäfte mit Shopware.