Modul-Dokumentation „Produkt-Anfrage Formular“

Allgemeine Infos zum Modul und zu uns 😊

Was das Modul kann

Mit diesem Modul kannst auf deiner Produkt-Detailseiten im Shop ein Anfrageformular einblenden, mit dem deine Kunden schnell und einfach eine Frage speziell zum Artikel stellen können, ohne aufwändig die Artikelnummer oder -bezeichnung abtippen zu müssen.

Das Anfrageformular lässt sich generell aktivieren und artikelweise deaktivieren oder auch umgekehrt. Du kannst aber das Anfrageformular auch nur für Artikel einblenden lassen, für die kein Preis hinterlegt wurde.

Du bestimmst in den Modul-Einstellungen, welche Formularfelder angezeigt werden sollen – und welche davon ausgefüllt werden müssen (Pflichtfelder). Das Modul bringt auch eine E-Mail Prüfung mit und ist optional durch das OXID Captcha gegen Spam schützbar.

Ab Version 3.07 kannst du auch das Erscheinungsbild des Formulars an das Layout deines Shops anpassen – es lässt sich im Tab anzeigen (wenn dein Shop auf der Detailseite Tabs verwendet) oder aber auch im Overlay .

Wenn der Kunde angemeldet ist, werden die Formularfelder so weit wie möglich aus den Kunden-Stammdaten vorausgefüllt, so dass der manuelle Aufwand für ihn so gering wie möglich gehalten wird.

Nach Absenden der Anfrage wird eine E-Mail an die im Shop hinterlegte E-Mail Adresse versendet. Du kannst artikelweise eine andere E-Mail Adresse festlegen, so dass die Anfrage auch direkt an den bearbeitenden Mitarbeiter gesendet werden kann.

Die Artikelnummer und -bezeichnung des angefragten Produkts wird immer automatisch mitgesendet, so dass du immer sofort weißt, auf welchen Artikel sich die Frage bezieht.

Updates

Prüfe, mit welcher Version des Moduls du bisher gearbeitet hast, und führe folgende Schritte aus:

Modul Version bis 3.06

In den Modul-Versionen bis 3.06 waren Anpassungen (changed-full) an einem Admin-Template nötig. Diese Anpassungen sind jetzt nicht mehr notwendig und können zurückgebaut werden.

Es handelt sich um das Template article_extend.tpl. Bitte entferne die Anfragetab-Modul spezifischen Anpassungen in dieser Datei (sonst sind Eingabefelder im Artikel auf dem Tab „Erweitert“ ggf. doppelt).

Modul Version bis 3.09

Da wir die Struktur des Moduls ab 3.10 etwas verändert haben, ist es ratsam, das Modul einmal zu entfernen und neu wieder zu installieren. Deine Einstellungen gehen dabei nicht verloren! Deaktiviere das Modul und lösche dann das Verzeichnis dwa/anfragetab auf dem Server.

Alle Modul Versionen

Für Module ab 3.10 deaktiviere vor dem Update das Modul.

Hat dein Shop die Version 6.0 oder höher, prüfe vor der Installation, ob das Modul oeCaptcha von OXID in deinem Shop bereits installiert ist. Ist es nicht installiert kannst du die Captcha-Funktion nicht nutzen und musst diese deaktivieren! Wenn du sie nutzen willst, ist es wichtig, dass das Modul vor unserem Modul installiert und aktiviert wird! Gern können wir dir das Modul in deinem Shop installieren. Sprich uns einfach an!

Führe nun die folgenden Schritte durch, als würdest du das Modul neu installieren.

Theme und Darstellungsform wählen

Das Anfrage-Modul bringt ab Version 3.07 verschiedene Möglichkeiten mit, das Anfrage-Formular in die Artikelseite einzubetten.

Während das Formular bislang nur auf einem zusätzlichen Tab untergebracht werden konnte, ist es nun auch möglich, es in einem Overlay (Popup) anzuzeigen.

Gehe in die Modul-Einstellungen (Modul, Tab „Einstell.“). Wähle dort unter „Allgemeine Einstellungen“, ob dein Theme auf Azure, Wave oder Flow basiert (wichtig für Overlay-Funktion, da diese in beiden Themes komplett anders sind) und ob du das Formular im Overlay oder im Tab öffnen lassen willst.

Wichtig: Wenn du „Overlay“ verwendest, musst du eine der folgenden Optionen wählen, damit das Anfrage-Formular aufrufbar ist:

1. Du stellst ein, dass der Button anstelle des Warenkorb-Buttons angezeigt wird, wenn der Artikel keinen Preis hat,
2. Du stellst ein, dass der Anfrage-Button angezeigt werden soll (Modul-Einstellungen unter „Allgemeine Einstellungen“),
3. Du bettest einen eigenen Button in deinem Theme an einer (oder mehreren) beliebigen Stelle ein (siehe Kapitel "Anfrage-Tab selbst verlinken").

Wenn du nur Option 1 wählst, ist der Anfrage-Button – und damit auch das Anfrage-Formular – ausschließlich für Artikel ohne Preis sichtbar.

Die anderen Einstellungen, die hier möglich sind, sind nicht ganz so wichtig – die erklären wir unten.

Texte für das Formular anpassen (wichtig bei Erstinstallation)

Das Modul liefert mehrere vorgefertigte CMS-Snippets, mit dem du die Usability des Anfrage-Formulars noch verbessern kannst.

So ist über und unter dem Anfrage-Formular jeweils ein Bereich vorbereitet, in dem du einen eigenen Text hinterlegen kannst.

Gehe dazu im OXID Backend auf Kundeninformation → CMS Seiten. Gib im Suchfeld über „Ident“ (über der Liste) „dwa_anfrage“ ein – es werden fünf Snippets angezeigt:

Bitte ändere nur den Inhalt, nicht den Titel dieser Snippets. Er wird nicht im Formular angezeigt! Du kannst den Inhalt beliebig anpassen, auch formatieren (fett etc.).

Eines der Snippets (Text nach Absenden des Formulars) ist standardmäßig aktiviert, dieser Text ist obligatorisch. Deaktiviere ihn nicht, denn sonst erhalten Kunden nach Absenden des Formulars kein Feedback.

Die übrigen Snippets sind standardmäßig inaktiv. Passe hier auf Wunsch den Text an und aktiviere das Snippet dann.

Anfrage an alternativen Ansprechpartner schicken

Mit diesem Modul kannst du Anfragen zum Artikel an den Shopowner oder an einen speziellen Ansprechpartner für den Artikel senden lassen (siehe Kapitel "Anfragen an verschiedene Mitarbeiter senden"). Dafür gibt es in den Artikeln auf dem Tab „Erweitert“ ein extra Feld für die E-Mail Adresse.

OXID eShop bringt aber auch selbst schon einen „Alternativen Ansprechpartner“ für Artikel mit, dessen E-Mail Adresse du ebenfalls auf dem Tab „Erweitert“ eintragen kannst. OXID setzt damit einen E-Mail Link auf die Produktdetailseite.

Wenn du dieses Feld schon gepflegt hast und die dort eingetragenen E-Mail Adressen nun für das Anfrage-Formular nutzen möchtest, gehe auf Service → Tools und führe dort das folgende SQL aus:

UPDATE oxarticles SET dwasendanfragetab = oxquestionemail WHERE dwasendanfragetab = '';

Kopiere diesen Code dazu in das Eingabefeld und klicke dann auf „Update starten“.

Spam vermeiden

Das Anfrage-Modul verwendet zum Spamschutz das Original OXID Captcha. Das Modul oeCaptcha muss bereits vor Modulinstallation eingerichtet sein!

Bis mind. OXID 6.2 gibt es einen Fehler in der oxajax.min.js, der das Neuladen des Captcha-Bildes nach Versand des Formulars mit Fehlermeldung verhindert. Dadurch kann das Formular dann ohne ein Neuladen der Seite nicht mehr abgeschickt werden, da der Captcha Code  immer als falsch gemeldet wird. Ändere in der src/js/widgets/oxajax.min.js an zwei Stellen errors.default zu errors['default'], um den Fehler zu beheben. Gern sind wir hier bei der Fehlerbehebung behilflich. Sprich uns einfach an.

Datenschutz

Um das Formular DSGVO-konform zu gestalten, empfehlen wir, einen Datenschutz-Hinweis im Formular zu integrieren. Du kannst den Text in das Snippet einbinden, das über dem Formular angezeigt wird (siehe Kapitel "Texte für das Formular anpassen (wichtig bei Erstinstallation)"), oder du aktivierst die entsprechende Datenschutz-Checkbox, mit der der Nutzer der Datenschutzerklärung zustimmen muss.

Die Datenschutz-Checkbox lässt sich in den Moduleinstellungen unter dem Punkt „Datenschutz“ aktivieren. Ist sie im Formular eingebunden, ist sie auch immer Pflicht, d. h. das Formular kann erst abgesendet werden, wenn die Checkbox vom Nutzer bestätigt wurde.

Optional kannst du einen Link auf deine Datenschutzerklärung in den Text integrieren. Füge dazu den absoluten Link auf deine Datenschutz-Seite in das entsprechende Feld in den Datenschutz-Einstellungen des Moduls ein.

Um den Text der Checkbox anzupassen, kopiere bitte die 3 Einträge aus der Language-Datei in deine cust_lang.php (deines Themes) und passe die Texte an.

DWA_ANFRAGETAB_LABEL_DS1 - Text vor dem Link, darf auch leer sein

DWA_ANFRAGETAB_LABEL_DSLINK – wenn leer, wird kein Link integriert!

DWA_ANFRAGETAB_LABEL_DS2 - Text hinter dem Link, darf auch leer sein

Konfiguration und Verwendung

Anfrage-Formular für Artikel ausblenden

Das Anfrage-Formular ist automatisch bei allen Artikeln aktiviert (außer du wählst die Option, dass es nur für Artikel ohne Preis angezeigt werden soll, siehe Kapitel "Anfragen für Artikel ohne Preis aktivieren").

Du kannst es jedoch jederzeit für beliebige Artikel deaktivieren. Gehe dazu in den Artikeldaten auf den Tab „Erweitert“ und entferne in der entsprechenden Checkbox (unten) das Häkchen.

Wenn du die Anfrage nur für einzelne Artikel aktivieren möchtest, führe unter Service → Tools bitte zunächst folgende SQL-Anweisung aus, um das Anfrage-Formular für alle Artikel zu deaktivieren:

UPDATE oxarticles SET dwashowanfragetab = 0

Gehe dazu auf Service → Tools, kopiere diesen Code in das Eingabefeld und klicke auf „Update starten“.

Anschließend kannst du die Anfrage bei den gewünschten Artikeln auf dem Tab „Erweitert“ aktivieren.

Anfragen an verschiedene Mitarbeiter senden

Standardmäßig wird die Anfrage per E-Mail an den Shop-Owner gesendet.

Du kannst aber für jeden Artikel eine abweichende E-Mail Adresse angeben, z. B. wenn ein bestimmter Mitarbeiter für die Erstellung von individuellen Angeboten zuständig ist. Trage die gewünschte E-Mail Adresse beim Artikel auf dem Tab „Erweitert“ in den Artikeldaten im OXID eShop Backend vor (Feld „Anfrage senden an“).

OXID selbst bringt bereits ein Feld „Alternativer Ansprechpartner“ für Artikel mit, das du ebenfalls auf dem Tab „Erweitert“ pflegen kannst. Falls du dieses Feld bisher genutzt hast, kannst du die dort eingetragenen E-Mail Adressen ganz einfach als Modul-Einstellung übernehmen (siehe Kapitel "Anfrage an alternativen Ansprechpartner schicken").

Betreff der E-Mail anpassen

Das Modul liefert ein CMS-Snippet mit, mit dem du den Betreff der versendeten E-Mail ganz einfach anpassen kannst. So lassen sich z. B. der Titel oder die Artikelnummer des Produkts (ist bereits vorbereitet) integrieren. Das Snippet wird nur verwendet, wenn es aktiviert ist.

Der Ident des Snippets lautet dwa_anfragetab_mailsubj.

Folgende Variablen lassen sich verwenden:

Artikelnummer: [{$oProduct->oxarticles__oxartnum->value}]

Artikelname: [{$oProduct->oxarticles__oxtitle->value}]

Kopie der Anfrage an Kunden

Wähle in den Modul-Einstellungen, ob deine Kunden eine Kopie der versendeten E-Mail erhalten sollen. Gehe dazu unter Erweiterungen → Module auf die Extension und klicke auf den Tab „Einstellungen“. Diese Option ist standardmäßig deaktiviert.

Du kannst außerdem für Kunden einen extra Einleitungstext in der E-Mail aktivieren, den du auch selbst anpassen kannst. Hinterlege dort z. B. den Hinweis, dass es sich bei dieser E-Mail um eine Kopie handelt. Ein entsprechendes CMS-Snippet haben wir bereits für dich vorbereitet, du brauchst es nur anpassen und aktivieren.

Die Ident lautet dwa_anfragetab_mailintrotocust.

Anfragen für Artikel ohne Preis aktivieren

Du kannst im Modul einstellen, dass das Formular nur angezeigt werden soll, wenn für den Artikel kein Preis angegeben wurde. Anfragen sind dann nur für Artikel ohne Preis (Preis = 0 Euro) möglich.

Diese Einstellung nimmst du in den Modul-Einstellungen (Tab „Einstellungen“ im Modul) vor.

„Nur wenn Artikel keinen Preis hat, wird Anfrage-Formular angezeigt.“

Ist diese Option aktiviert, wird das Anfrage-Formular nur bei Artikeln ohne Preis angezeigt.

„Wenn Artikel keinen Preis hat, wird "Anfrage"-Button angezeigt.“

Ist diese Option aktiviert, wird bei Produkten ohne Preis anstelle des Warenkorb-Buttons ein Anfrage-Button angezeigt. Bei Klick auf den Button öffnet sich das Anfrage-Formular.

Anfrage-Formular anpassen

Felder ein- / ausblenden

Du kannst alle Felder des Anfrage-Formulars beliebig ein- oder ausblenden. Gehe dazu in die Moduleinstellungen (Erweiterungen → Module → Modul auswählen → Tab „Einstellungen“) und setze oder entferne unter „Formularfelder“ die Häkchen bei den Feldern. Auch das Captcha lässt sich so deaktivieren.

Wichtig! Wenn du das „Produkt-Anfrage Formular“ mit der OXID Shop Edition CE/ PE 4.10.x oder EE 5.3.x und dem Theme „Flow“ verwendest, aktiviere bitte das Formularfeld „Leerzeile vor Kommentar“. Dieses Häkchen verhindert bei aktiviertem Liefertermin einen Umbruch in deinem Anfrage-Tab.

Pflichtfelder

Du kannst selbst festlegen, welche Eingabefelder Pflicht sind. Gehe dazu in die Moduleinstellungen (Erweiterungen → Module → Modul auswählen → Tab „Einstellungen“) und setze oder entferne unter „Pflichtfelder“ die Häkchen bei den Feldern.

Dateiupload aktivieren und anpassen

Du kannst optional einen Dateiupload im Anfrageformular aktivieren.

Gehe dazu in die Moduleinstellungen und setze das entsprechende Häkchen.

Im Feld „erlaubte Dateiendungen“ legst du fest, welche Dateitypen erlaubt sind. Trenne mehrere Angaben mit Komma (siehe Screenshot unten).

Lässt du das Feld leer, sind alle Dateitypen erlaubt. Beachte, dass jpg und jpeg unterschieden werden (also beide eingetragen werden müssen, wenn du jpeg Dateien erlauben willst). Groß-/Kleinschreibung hingegen wird nicht unterschieden.

Die Datei wird als Anhang (Attachment) an die Mail versendet.

Link zum Anfrageformular unter der Artikel-Beschreibung

Du kannst unter der Artikelbeschreibung automatisch einen Link zum Anfrage-Modul einfügen. Dazu muss nur das entsprechende CMS-Snippet aktiviert werden.

Der Linktext wird als CMS Snippet (Kundeninformation → CMS-Seiten) unter dem Ident „dwa_anfragetab_content_desc“ bei der Installation / beim Update automatisch angelegt.

Damit der Link richtig angezeigt wird, aktiviere das Snippet!

Das Snippet wird nur dann angezeigt, wenn das Anfrage-Formular für den Artikel aktiviert wurde. Es wird automatisch verlinkt, so dass das Anfrage-Formular geöffnet wird, wenn der Kunde auf den Text klickt.

Anfrage-Tab selbst verlinken

Diese Funktion haben wir ab Version 3.07 vereinfacht – wenn du von einer früheren Version upgradest, kannst du die betreffenden Stellen entsprechend anpassen, musst es aber nicht. Aber Achtung – Overlay funktioniert nur mit den neuen Links bzw. Buttons, die wie hier beschrieben eingefügt wurden.

Du kannst überall auf der Detailseite einen Link oder einen Button einfügen, der bei Klick das Anfrage-Formular öffnet. Dazu hast du zwei Möglichkeiten:

1. Du setzt den Link oder Button an eine feste Stelle innerhalb deines Themes,
2. Du setzt den Link oder Button in die Langbeschreibung eines Artikels.

Bei beiden Varianten übergibst du einen Titel für den Button bzw. Link, der automatisch übersetzt wird, falls der String im Language-Array hinterlegt wurde (siehe Hinweis unten).

WICHTIG: Wenn du das Modul deaktivierst müssen die so gesetzten Buttons und Links aus dem Theme entfernt werden, um Fehler zu vermeiden.

Einfügen im Theme

Mittels Smarty-Anweisung kannst du überall auf der Detailseite einen Anfrage-Button oder -Link einfügen, der das Anfrage-Formular öffnet.

Das Snippet dafür lautet

für einen Button:

[{$oView->dwaGetAnfrButton('xxx')}]

für einen Link:

[{$oView->dwaGetAnfrLink('xxx')}]

Ersetze xxx durch einen beliebigen Linktext bzw. Button-Label, das automatisch übersetzt wird, wenn der String entsprechend in der Language-Datei hinterlegt ist.

Beispiel: Du verwendest im Theme folgenden Aufruf:

[{$oView->dwaGetAnfrLink('ANFRAGELINK')}]

In deiner cust_lang.php (im Theme für de) hinterlegst du die entsprechende Übersetzung:

'ANFRAGELINK' => 'Hier gelangst du zu unserem Anfrageformular.',

Einfügen in der Artikel-Langbeschreibung

Mit dieser Funktion lässt sich ein Button oder Link für eine Anfrage an beliebiger Stelle innerhalb der Langbeschreibung platzieren.

Wichtig – die Funktion muss in den Moduleinstellungen aktiviert werden. Gehe dazu im Modul auf den Tab „Einstellungen“ und aktiviere unter „Allgemeine Einstellungen“ den Punkt „Anfrage-Button/Link Platzhalter in Artikelbeschreibung ersetzen“.

Du kannst nun an beliebiger Stelle in den Langbeschreibungen der Artikel folgende Platzhalter verwenden (auch mehrere in derselben Beschreibung):

für einen Button:

[[ANFRAGEBUTTON name="xxx"]]

für einen Link:

[[ANFRAGELINK name="xxx"]]

Ersetze auch hier xxx durch einen beliebigen Linktext bzw. Button-Label. Da du für jede Sprache eine eigene Artikel-Beschreibung hast, ist hier keine automatische Übersetzung aktiv.