Formulare mit INQUIRY4
INQUIRY4-External ist ein externes WEBSALE Modul zur Erstellung von individuellen Kontakt-, Support- und Serviceformularen für deinen WEBSALE-Onlineshop. Die Formulare können ganz nach deinen Anforderungen konfiguriert werden.
Formulare über INQUIRY4-External können einfach und problemlos an verschiedenen Stellen in dein Shop-Frontend integriert werden. Auch Links zu den Formularen können überall platziert werden.
Das Look & Feel der Formulare kann mittels HTML und CSS individuell gestaltet werden.
Inhaltsverzeichnis
- 1 Einleitung
- 2 Besondere Funktionen des Programms
- 3 Aufruf von INQUIRY4-Formularen
- 4 Grundlagen für Anfrageformulare
- 4.1 Benötigte Dateien für ein Formular
- 4.2 Speicherort der benötigten Dateien
- 4.3 Eingabefelder für Formulare
- 4.4 Syntax-Regeln für die Eingabefelder
- 4.4.1 Feldname
- 4.4.2 Feldwert
- 4.4.3 Listboxen mit und ohne Feldwert
- 4.5 Konfigurationsdatei
- 4.5.1 Allgemeine Angaben
- 4.5.2 Beschreibung der Parameter:
- 4.5.3 Angaben zur Bestätigungs-E-Mail an den Anfragenden
- 4.5.4 Angaben zur Anfrage-E-Mail
- 4.5.5 PDF-Download der Anfrage
- 4.5.6 Konfiguration des WEBSALE-Upload-Moduls
- 4.5.7 Konfiguration der CAPTCHA-Funktionalität
- 4.5.8 Konfiguration des Blacklisting
- 4.5.9 Fehlermeldungen für den Anwender
- 4.5.10 Allgemeine Anfragefelder
- 4.5.11 Adressfelder
- 4.5.12 Sektion SendUserEmail
- 5 Globale Konfigurationsdatei inquiry-global.config
- 5.1 Erklärung und Beschreibung der Parameter
- 5.2 Aktivierung / Deaktivierung nur für bestimmte Formulare
- 5.3 Konfiguration von IP-Reputationslisten
- 5.4 Konfiguration Web Application Firewall (WAF)-Prüfungen
- 5.5 Konfiguration eigener Prüfungsmechanismen über REST-Schnittstelle
- 5.6 Konfiguration für das Herausfiltern bestimmter Zeichen aus Eingaben
- 5.7 Konfiguration zusätzlicher Inhaltsfilter mittels Regular Expressions
- 5.8 Fehlermeldungsausgabe der Protection-Regeln im Template
- 6 Tags und Templates
- 6.1 Verwendung von Tags
- 6.1.1 Arten von Tags
- 6.1.2 Verschachtelung von Tags
- 6.2 Unterstützte Tags
- 6.2.1 Tags der Adressdaten
- 6.2.2 Tags der optionalen Lieferadresse
- 6.2.3 Tags von allgemeinen Eingabefeldern
- 6.2.4 Tags der CAPTCHA-Funktionen
- 6.2.5 Tags des PDF-Downloads
- 6.2.6 Tags des Dateiuploads
- 6.2.7 Design Control Tags
- 6.2.8 Spezielle Tags
- 6.3 Regeln für ein HTML-E-Mail-Template
- 6.1 Verwendung von Tags
- 7 Besondere Namen und Klassen
- 8 Verwendung von INQUIRY4 mit WEBSALE E-Commerce
- 9 Anhang
- 10 Haftungs- und Gewährleistungsausschluss
Einleitung
Zielgruppe für diese Dokumentation
Diese Dokumentation richtet sich an Personen, die entsprechendes Wissen über die Erstellung von HTML-Seiten besitzen und die Grundlagen von HTML beherrschen.
Allgemeine Anwendung des Programms
INQUIRY4 ist ein universelles Formularprogramm, mit dem auf einfache Art beliebige Anfrage-Formulare betrieben werden können.
INQUIRY4 ist ein CGI-Programm, das gänzlich auf Java-Applets, Java-Scripts und Cookies verzichtet. Es unterstützt daher alle Browser auf dem Markt.
INQUIRY4 bearbeitet und kontrolliert die Eingaben von Anfrageformularen und sendet die Eingaben per E-Mail an einen Formularempfänger. Alternativ können alle Anfragen über den Online-Servicebereich (OSB) von WEBSALE in der Übersicht und im Detail angesehen werden.
INQUIRY4 wurde zur Verwendung in Verbindung mit WEBSALE E-Commerce Shops entwickelt. Eine Nutzung des Programms ist auch ohne Shop möglich.
Verbrauch von Leistungseinheiten
Genauso wie bei jedem anderen Aufruf eines Programms am Server wird auch beim Aufruf von INQUIRY4 Rechenleistung benötigt. Daher wird der Leistungsverbrauch ebenfalls über die Leistungseinheiten mit abgerechnet.
Sofern INQUIRY4 über WS-ExternInclude innerhalb einer Shopseite in WEBSALE E-Commerce integriert aufgerufen wird, entsteht sowohl für den Aufruf von INQUIRY4 als auch für den Aufruf von WEBSALE E-Commerce Rechenleistungsbedarf und Laufzeit.
Es besteht jedoch eine einfache Möglichkeit einzelne Eingabefelder auf jeder oder vielen Shopseiten anzuzeigen ohne den zusätzlichen Bedarf an Leistungseinheiten oder Laufzeit. (s. „Einzelnes Formular-Eingabefeld auf jeder Shopseite“)
Besondere Funktionen des Programms
Refererschutz
Der HTTP-Referer-Schutz ist von der WEBSALE AG für INQUIRY4 entwickelt worden, da es im Internet Anbieter gibt, die für deren Kunden automatisiert Formulare ausfüllen und so mit Leichtigkeit mehrere tausend Anfragen pro Stunde generieren können. Dies sind insbesondere Anbieter, die für ihre Kunden Gewinnspiele oder Kataloganfragen etc. automatisiert ausfüllen. Ein auf diese Art an deinem Gewinnspiel teilnehmende “Kunde“ kennt also weder dich noch hat er deine Website angesehen noch hat er einem Newsletterversand zugestimmt und ist somit für dich weitgehend wertlos.
Auch im Bereich Formulare für Kataloganforderung könnten durch solche Anbieter hohe Kosten ohne Nutzen generiert werden, da keine wirklich an eurem Angebot interessierte Kunden die Kataloge erhalten würden.
Prüfung und Erhalt der Benutzer-Eingaben
Vor dem Absenden eines Formulars werden die erforderlichen Eingabefelder geprüft, ob sie ausgefüllt sind.
Wird das Formular unvollständig ausgefüllt, so wird die Formularseite erneut mit Hinweisen zu den fehlenden Feldern angezeigt. Alle bis dahin gemachten Eingaben bleiben voll erhalten. Dies ergibt eine angenehme Benutzerführung und die u. U. fehlerträchtige Verwendung des "Back-Button" des Browsers ist nicht erforderlich.
SPAM-Vermeidung
Für die SPAM-Vermeidung stellen wir Ihnen verschiedene Möglichkeiten zur Verfügung:
CAPTCHA-Unterstützung
Verschiedene, optionale CAPTCHA-Funktionen zur SPAM-Vermeidung können verwendet werden:
CAPTCHA-Funktion der WEBSALE AG. Kein JavaScript erforderlich und stets verfügbar.
Der Anfragende muss eine kleine Rechenaufgabe lösen, um die Anfrage abzusendenExterne CAPTCHA-Funktion „ReCaptcha“ mittels Bilderkennung und höchster Sicherheitsstufe. JavaScript ist erforderlich. Die Verfügbarkeit wird jedoch nicht garantiert. Der Anfragende muss eine Zeichenkette aus einem Bild ablesen und korrekt in ein Eingabefeld eingeben, um die Anfrage abzusenden.
Friendly Captcha - Sie können das Friendly Captcha-Widget in Ihre Webanwendung einbauen, um Spam zu bekämpfen, ohne die Benutzerfreundlichkeit zu beeinträchtigen.
Friendly Captcha sendet dem Benutzer ein kryptografisches Rätsel, das Gerät des Benutzers benötigt einige Sekunden, um dieses zu lösen, der Benutzer muss nichts tun.captcha.eu - Datenschutzfreundliches CAPTCHA-System aus der EU. Es setzt auf eine non-intrusive Verifizierung, die vollständig ohne Benutzereingriff funktioniert. Es gibt keine sichtbaren Aufgaben für den Nutzer. Zudem werden keine Tracking-Technologien eingesetzt, sodass captcha.eu höchste Datenschutzstandards gemäß der DSGVO erfüllt.
Blacklisting
Zur SPAM-Vermeidung können unterschiedliche Blacklists (z. B. auf Basis der IP-Adresse oder des MX-Records) verwendet werden, um bestimmten, unerwünschten Anfragenden bzw. automatisierten Programmen das Absenden einer Anfrage zu unterbinden.
Unterstützung von IP-Reputationslisten
Zur SPAM-Vermeidung kann die IP-Adresse des Anfragenden mit frei verfügbaren IP-Reputationslisten abgeglichen werden. Dadurch werden bekannte Spam- oder Angriffsbots automatisch erkannt und blockiert.
Wir haben uns entschieden, drei große, frei verfügbare Anbieter zu unterstützen:
blocklist.de – Erkennt IP-Adressen, die mit Brute-Force-Angriffen auf Server, Mailserver und Webdienste in Verbindung stehen.
firehol.org – Aggregiert verschiedene IP-Blocklisten und stellt optimierte Firewall-Regeln bereit.
stopforumspam.com – Spezialisiert auf die Identifikation von Spam-Bots, die in Foren, Blogs und Kommentarbereichen aktiv sind.
Durch die Aktivierung dieser Funktion kann der Schutz vor Spam und automatisierten Angriffen weiter verbessert werden.
→ Detaillierte Dokumentation zur Konfiguration von IP Reputationslisten
Erweiterte Web Application Firewall (WAF)-Prüfungen
Zusätzlich können verschärfte Web Application Firewall (WAF)-Regeln für Inquiry4 aktiviert werden. Diese erweiterten Prüfungen helfen, Angriffsversuche frühzeitig zu erkennen und zu blockieren, indem sie z. B. SQL-Injections, Cross-Site Scripting (XSS) und andere bekannte Angriffsmuster automatisch identifizieren.
Die aktivierte WAF-Policy setzt die aktuellen Sicherheitsregeln des OWASP Core Rule Set (CRS) ein. Da die Sicherheitsregeln regelmäßig aktualisiert werden, empfehlen wir die offizielle Dokumentation des OWASP CRS-Projekts für detaillierte Informationen: 🔗 OWASP Core Rule Set (CRS) Project
→ Detaillierte Dokumentation zur Konfiguration Web Application Firewall (WAF)-Prüfungen
Eigene Prüfungsmechanismen über REST-Schnittstelle
Da es zahlreiche Anbieter mit unterschiedlichen Preismodellen für SPAM-Erkennung gibt, bieten wir eine einfache REST-Schnittstelle für eine individuelle Server-to-Server-Prüfung. So können Sie eine eigene Lösung integrieren, um Anfragen anhand externer Dienste oder interner Algorithmen zu bewerten, bevor diese weiterverarbeitet werden. Dies bietet maximale Flexibilität für Ihre persönliche SPAM-Erkennung.
→ Detaillierte Dokumentation zur Konfiguration eigener Prüfungsmechanismen über REST-Schnittstelle
Zeichen-Filterung aus Eingaben
Es können bestimmte Zeichen definiert werden, die automatisch aus Benutzereingaben herausgefiltert werden. Dies verhindert die Verarbeitung unerwünschter oder potenziell schädlicher Inhalte und verbessert die Sicherheit und Datenintegrität.
→ Detaillierte Dokumentation zur Konfiguration für das Herausfiltern bestimmter Zeichen aus Eingaben
Zusätzliche Inhaltsfilter mittels Regular Expressions
Es können benutzerdefinierte Regular Expressions (RegEx) definiert werden, um unerwünschte Zeichenketten oder Muster in den Eingaben zu erkennen und zu blockieren. Dies ermöglicht eine flexible Anpassung an spezifische Anforderungen, wie das Filtern von bestimmten Keywords, verdächtigen Mustern oder schadhaften Skripten.
→ Detaillierte Dokumentation zur Konfiguration zusätzlicher Inhaltsfilter mittels Regular Expressions
Verbindung zu WEBSALE-Shops
Benutzerdaten, die in einem WEBSALE-Shop z. B. aufgrund eines Benutzer-Logins bereits bekannt sind, können an das Formularprogramm übergeben werden, um dem Benutzer das erneute Ausfüllen z. B. von Adressfeldern zu ersparen.
PDF-Download der Anfrage
Nach Absenden des Formulars kann dem Benutzer angeboten werden, seine Anfrage als PDF herunterzuladen. Das Template, aus dem die PDF-Datei erzeugt wird, ist frei designbar.
Unterstützung von Dateiuploads
Optional können zu einer Anfrage Dateien vom Benutzer hochgeladen werden. Dies wird durch Verwendung des WEBSALE-Upload-Moduls realisiert. Die hochgeladenen Dateien werden an die E-Mail angehängt, die dem Angefragten zugesendet wird, oder in einem eigenen FTP-Verzeichnis gespeichert.
Ein ausführliches Beispiel für ein Anmeldeformular mit Datei-Upload finden Sie in der Frontend-Dokumentation:
https://doku.websale.net/index.html?guide_uploadmodulfuerformulareinquiry.html
Wenn Sie das WEBSALE-Upload-Modul mit INQUIRY4 verwenden wollen müssen Sie dies für jedes Anfrageformular einzeln beauftragen!
Aufruf von INQUIRY4-Formularen
Der Aufruf eines Formulars erfolgt über
den Aufruf des Inquiry-Programms
mit Angabe einer Shop- und SubshopID und
Angabe einer Konfigurationsdatei.
In der Konfigurationsdatei (s. Kapitel Konfigurationsdatei) ist angegeben, welches Formular-Template für das Formular verwendet werden soll.
Beispiel:
https://www.ihre-domain.de/cgi/inquiry4.cgi?inq4=<ihre-shopid>.<ihre subshopid>&cfg=<ihre-config>
Parameter | Beschreibung |
---|---|
inq4 | Erforderlicher Aufruf-Parameter. In diesem Parameter müssen Sie ihre ShopID und ihre SubShopID durch einen Punkt getrennt angeben. |
cfg (veraltet: ".ini") | Erforderlicher Aufruf-Parameter. Den Namen der Konfigurationsdatei, z. B. „anfrage.config". |
m | Optionaler Parameter Wenn Sie INQUIRY4 in Verbindung mit einem WEBSALE E-Commerce-Testshop oder DevPack verwenden wollen, müssen Sie im Parameter "m" die MallID angeben, z. B. m=test oder m=devpack. |
Weitere, optionale Parameter
In INQUIRY4 können bereits beim Aufruf ein Teil oder alle Daten der Formularfelder übergeben werden.
Dies wird häufig in Kombination mit dem WEBSALE-Shop verwendet.
Als Parametername wird der HTML-Name des entsprechenden Feldes angegeben. Eine Ausnahme stellt hierbei das Geburtsdatum dar (siehe nächstes Kapitel, “Spezielle Parameter“).
Beispiel: Übergabe des Vornamens beim Aufruf von INQUIRY4
Inquiry-URL:
.../cgi/inquiry4.cgi?inq4=<ihre-shopid>.<ihre-subshopid>&cfg=<ihre-config>&first_name=Wolfgang
Wichtig: Bei eingeschaltetem aktivem Refererschutz (s. Kapitel “Refererschutz“) und dabei übergebenem ungültigem Referer werden keine Parameter übernommen.
Spezielle Parameter
Parameter | Beschreibung |
---|---|
a_dateofbirth_day | Geburtsdatum der Rechnungsadresse Diese Parameter werden verwendet, um Geburtsdaten zu übergeben, wenn automatisch generierte Listboxen zum Einsatz kommen. |
d_dateofbirth_day | Geburtsdatum der Lieferadresse Diese Parameter werden verwendet, um Geburtsdaten zu übergeben, wenn automatisch generierte Listboxen zum Einsatz kommen. |
ref | Angabe eines Referers Dient statistischen Zwecken. Dieser Aufrufparameter sollte nicht verwechselt werden mit dem Konfigurationsparameter “Referer“, der sich auf den HTTP-Referer bezieht (siehe Kapitel „Konfigurationsdatei“ und Kapitel „Refererschutz“). |
subref | Angabe eines SubReferers. Dient statistischen Zwecken |
a-userindex | Angabe des Userindexes, nur in Verbindung mit dem WEBSALE-Shop. |
a-userid | Angabe der User-ID, nur in Verbindung mit dem WEBSALE-Shop. |
immediate | Erlaubt “One-Klick“-Anfragen. Wenn dieser Parameter auf „yes“ gesetzt ist, werden die mit dem Aufruf des Formularprogramms übergebenen Parameter auf Vollständigkeit geprüft und dann die Anfrage sofort ausgeführt, ohne dass der Anfragende ein Anfrageformular zum Ausfüllen sieht. Er bekommt also unmittelbar die Bestätigungsseite angezeigt. WICHTIG: Der Parameter “immediate“ wird nur bei aktivem Refererschutz (siehe 3.1 Refererschutz) verarbeitet! |
Grundlagen für Anfrageformulare
Benötigte Dateien für ein Formular
Je Formular benötigen Sie:
ein HTML-Formular-Template (*.htm)
ein HTML-Antwort-Template (*.htm)
ein HTML-Antwort-Template für die Erzeugung eines PDFs (*.htm)
eine Konfigurationsdatei (*.config)
ein HTML-E-MailTemplate (*.hmail)
Definitionsdateien für Anrede, Titel und Länderauswahl (*.dat)
Üblicherweise gehört zu einem Formular immer ein kompletter Satz mit den oben genannten Dateien.
Sie können auch für unterschiedliche Anfrageformulare z. B. stets das gleiche Antwort-Template und/oder die gleiche Anrede-Definition usw. verwenden.
Ob und welche Dateien jeweils verwendet werden, legen Sie nach Ihrem Ermessen in der dem Formular zugehörigen Konfigurationsdatei (.config) fest.
Dieser Dokumentation liegen folgende Beispiele bei:
Fallbeispiel | Beispieldateien |
Standardanfrage in eigener Seite mit Download der Anfrage als PDF, Popup oder iFrame | anfrage.config |
Standardanfrage integriert in WEBSALE E-Commerce mit WS-ExternInclude | externinclude_anfrage.config |
Standardanfrage in eigener Seite, Popup oder iFrame mit CAPTCHA-Funktion Rechenaufgabe zur SPAM-Vermeidung | anfrage_captcha_rechnen.config |
Erläuterung der einzelnen Beispieldateien:
Datei | Beschreibung |
anfrage.config | Konfigurationsdatei einer Standardanfrage |
anfrage.htm | Anfrageseite einer Standardanfrage |
antwort.htm | Antwortseite einer Standardanfrage |
antwort_pdf.htm | HTML-Template für die Erzeugung der PDF-Datei |
antwort.hmail | HTML-E-Mail-Template an den Anfragenden einer Standardanfrage |
anfrage.hmail | HTML-E-Mail-Template an den Angefragten einer Standardanfrage |
externinclude_anfrage.htm | Anfrageseite einer Standardanfrage, welche mit ExternInclude eingebunden wird |
externinclude_anfrage.config | Konfigurationsdatei einer Standardanfrage, welche mit ExternInclude eingebunden wird |
externinclude_antwort.htm | Antwortseite einer Standardanfrage, welche mit ExternInclude eingebunden wird |
tpl_externinclude_anfrage.htm | Shoptemplate auf dem eine Standardanfrage mit ExternInclude eingebunden wird |
anfrage_captcha_rechnen.config | Konfigurationsdatei einer Standardanfrage mit CAPTCHA-Funktion Rechenaufgabe |
anfrage_captcha_rechnen.htm | Anfrageseite einer Standardanfrage mit CAPTCHA-Funktion Rechenaufgabe |
Speicherort der benötigten Dateien
Die benötigten Dateien müssen innerhalb des WEBSALE E-Commerce Shops abgelegt werden.
Alle Konfigurationsdateien (config-Dateien, Länder-, Titel- und Anredeauswahldateien sowie Blacklist-Dateien) müssen im zugehörigen Konfigurationsverzeichnis des Subshops im Unterverzeichnis inquiry gespeichert werden:
/websale8_shop-<ihre-shopid>/konfiguration/<ihre-subshopid>/inquiry/
Alle Template-Dateien (E-Mail- und Formular-Templates) müssen im zugehörigen Template-Verzeichnis des Subshops gespeichert werden:
/websale8_shop-<ihre-shopid>/benutzer/templates/<ihre-subshopid>/
Eingabefelder für Formulare
Ein Template für ein Anfrageformular können Sie mit einem HTML-Editor Ihrer Wahl erstellen.
INQUIRY4 verarbeitet und kontrolliert folgende Eingabefelder:
Checkboxen
Radio Buttons
Listboxen
einzeilige Textfelder
mehrzeilige Textfelder (max. 4048 Zeichen)
Wie bereits erwähnt, bleiben alle gemachten Eingaben voll erhalten. Um dies zu erreichen, muss INQUIRY4 die bereits gemachten Eingaben in die entsprechenden Felder auf dem Template integrieren.
Es ist daher notwendig, dass die HTML-Syntax im Formular einigen Regeln entspricht, die im Folgenden erläutert werden. Diese Regeln werden üblicherweise auch von allen gängigen HTML-Editoren eingehalten.
Syntax-Regeln für die Eingabefelder
Feldname
Alle Feldnamen müssen in Anführungszeichen stehen. Es darf kein Leerzeichen zwischen "name=" und Feldname sein.
<input type="text" name="Feldname" ...>
<input type="text" name= "Feldname" ...>
<input type="text" name=Feldname ...>
Feldwert
Alle Feldwerte müssen in Anführungszeichen stehen. Es darf kein Leerzeichen zwischen "value=" und Feldwert sein.
<input type="text" ... value="Feldwert">
<input type="text" ... value= "Feldwert">
<input type="text" ... value=Feldwert>
Listboxen mit und ohne Feldwert
Listboxen können mit und ohne Feldwert (value=“...“) angegeben werden.
INQUIRY4 unterstützt beide Methoden. Wenn ein Feldwert vorhanden ist, wird der entsprechende Eintrag ausgewählt, ansonsten der passende Eintrag ohne Feldwert gesucht und ausgewählt.
Ohne Feldwert:
<select name="Feldname">
<option></option>
<option>Herr</option>
<option>Frau</option>
</select>
Mit Feldwert:
<select name="Feldname">
<option value=""></option>
<option value="Herr">Herr</option>
<option value="Frau">Frau</option>
</select>
Verwenden Sie Listboxen mit Feldwert, dies erleichtert die Arbeit insbesondere bei fremdsprachigen Formularseiten, da Sie dann stets den gleichen value (z. B. value=“Herr“) verwenden können und lediglich im lesbaren Text die Übersetzung (z. B. “Monsieur“)
Konfigurationsdatei
In der Konfigurationsdatei wird angegeben,
an welche E-Mail-Adresse die Anfragen gesendet werden,
welche Templates verwendet werden sollen,
welche Fehlermeldungen ausgegeben werden,
welche Formularfelder von INQUIRY4 abgefragt und kontrolliert werden sollen.
Code-Beispiele finden Sie in diesem Dokument unter „Fehler: Verweis nicht gefunden“
Allgemeine Angaben
Die allgemeinen Angaben finden Sie in der Sektion <Basic>
.
<Basic>
InquiryPage = anfrage.htm
ConfirmPage = antwort.htm
CommonInputRequired = yes
Language = DEU
EMailCheckMethod = domain # [none][syntax][domain]
CountryDat = ../country.dat
SalutationDat = ../salutation.dat
TitleDat = ../title.dat
Referer = www.ihr-shop.de
WSOMAllow = yes
TransferEmptyValues = no # [yes][no], Std: no
Charset = ISO-8859-1
TextAreaWrap = 30
NoEmptyCountryListboxEntry = no # [yes|no], Std: no
PresetSTC = yes # [yes|no], Std: yes
VS4Allow = yes # [yes|no], Std: yes
InquiryFormatMinorVersion = # Std: 1
</Basic>
Beschreibung der Parameter:
Parameter | Beschreibung | Werte |
---|---|---|
InquiryPage | Name der HTML-Anfrageseite. | Dateiname z. B. anfrage.htm |
ConfirmPage | Name der HTML-Antwortseite. | Dateiname z. B. antwort.htm |
CommonInputRequired | Wenn Sie diesen Parameter auf "yes" setzen, dann muß mindestens ein allgemeines Anfragefeld vom Anfragenden ausgefüllt worden sein, ansonsten erfolgt eine entsprechende Fehlermeldung. | [yes][no] |
Language | Die gewünschte Sprache für Anrede und Titel im ISO-Code. | 3-stelliger Länder ISO-Code, z. B. DEU |
CountryDat | Optionaler Parameter Hier können Sie die Länder-Konfigurationsdatei aus ihrem WEBSALE-Shop verwenden. | Dateiname, z. B. country.dat |
SalutationDat | Optionaler Parameter Hier können Sie die Anrede-Konfigurationsdatei aus ihrem WEBSALE-Shop verwenden. | Dateiname, z. B. salutation.dat |
TitleDat | Optionaler Parameter Hier können Sie die Titel-Konfigurationsdateiaus ihrem Websale-Shop verwenden. | Dateiname, z. B. title.dat |
Referer | Optionaler Parameter Hier können Sie verschiedeneURLs, jeweils durch Komma getrennt, angeben. Eine Referer-URL dient dem Schutz vor unerwünschten automatisierten Anfragen und ist von der Behandlung her einzustufen wie ein Passwort, d. h. ein Referer ist vertraulich zu behandeln. (s. Kapitel “Refererschutz“) Durch Angabe einer oder mehrerer URLs wird der Refererschutz eingeschaltet. Wenn nichts angegeben wird, nimmt INQUIRY4 alle übergebenen Parameter an, der Refererschutz ist damit ausgeschaltet! | URL, www.ihr-shop.de |
WSOMAllow | Wenn Sie diesen Parameter auf „yes“ setzen, dann werden alle erzeugten Anfragen vom WSOM (WEBSALE Order Manager) verarbeitet und können somit über den WSOM in Warenwirtschaftssysteme automatisiert eingelesen werden. Anwendungsbeispiel: Anfrage zur Zusendung eines Katalogs. | [yes][no] |
TransferEmptyValues | Wenn Sie diesen Parameter auf „yes“ setzen werden alle leeren Felder der Anfrage mit übergeben. Steht dieser Parameter auf "no" so werden leere Felder nicht mit übergeben. Dies betrifft die Tags AUTOGENERATE-Full, AUTOGENERATE-Addr, AUTOGENERATE-Common, AUTOGENERATE-Readable und AUTOGENERATE-Technical sowie die Datenübergabe an den WSOM. Wenn die Anfragedaten durch den WSOM abgeholt werden und optionale Felder in dem Anfrageformular vorhanden sind kann durch die Übertragung der leeren Felder eine einheitliche Felderdefinition erreicht werden. | [yes][no] |
Charset | Hier geben Sie den Zeichensatz der Anfrage an. Dieser Zeichensatz wird auch für die erzeugten E-Mails verwendet, wenn in den entsprechenden Sektionen kein anderer Zeichensatz angegeben ist. Der Parameter muss vorhanden sein, um Konvertierungen in UTF-8 per Tag durchführen zu können. | Zeichensatz, z. B. ISO-8859-1 |
TextAreaWrap | Hier können Sie angeben nach wie vielen Zeichen die Ausgabe einer Textarea in den E-Mails umgebrochen werden soll. Ist dieser Wert 0 erfolgt kein automatischer Umbruch. | Zeichenanzahl, z. B. 30 |
NoEmptyCountryListboxEntry | Hier können Sie festlegen ob der erste Eintrag in der Listbox zur Länderauswahl ein leerer Eintrag sein soll. yes: Es wird kein leerer Eintrag erzeugt, der erste Eintrag ist "vorausgewählt". no: Der erste Eintrag wird als leerer (nicht ausgewählter) Eintrag erzeugt. | [yes][no] |
PresetSTC | Hier können Sie festlegen ob Anrede, Titel und Land vorausgefüllt sein sollen, wenn INQUIRY per ExternInclude eingebunden wird. | [yes][no] |
VS4Allow | Hier können Sie festlegen ob Anfragen an das VS/4 weitergeleitet werden sollen. | [yes][no] |
InquiryFormatMinorVersion | Parameter zur Beeinflussung von nicht abwärtskompatiblen Änderungen des technischen Ausgabeformats. Momentan max. verwendet: Wert 2. Für Werte >= 2 gilt: In der technischen Übergabe von Textarea-Daten wird als Sektionsname <Value> anstelle von <value> verwendet. | [1][2] |
Angaben zur Bestätigungs-E-Mail an den Anfragenden
Alle Definitionen zur E-Mail an den Anfragenden finden Sie in der Sektion <ConfirmEmail>
.
<ConfirmEmail>
SendEmail = yes
EmailSubject = Ihre Anfrage
SenderEmail = abc@domain.de
SenderName = Firma XYZ
charset = ISO-8859-1
EmailTemplate = confirm.hmail
UseExternMailSystem = no
ExternMailTemplate =
</ConfirmEmail>
Parameter | Beschreibung | Werte |
---|---|---|
SendEmail | Legt fest, ob an den Anfragenden eine Bestätigungsemail geschickt wird. Wenn der Wert von SendEmail userselect ist, muss die Sektion <SendUserEmail> vorhanden sein, in welcher das zugehörige HTML-Element zur Auswahl definiert ist. | [yes][no][userselect] |
EmailSubject | Der Betreff der E-Mail. | Text, z. B. Ihre Anfrage |
SenderEmail | Die E-Mail-Adresse des Absenders. | E-Mail-Adresse, abc@domain.de |
SenderName | Der Name des Absenders. | Text, z. B. Firma XYZ |
Charset | Optionaler Parameter Der in der E-Mail verwendete Zeichensatz. Wichtig für die sprachabhängig korrekte Darstellung der Mailtexte beim Empfänger. Ist der Parameter nicht angegeben wird der globale Zeichensatz (Parameter Charset in der Sektion Basic) verwendet. | ISO-Zeichensatz, z. B. ISO-8859-1 |
EmailTemplate | Das HTML-Template der E-Mail. Weitere Informationen zu “Tags und Templates“ finden Sie im entsprechenden Abschnitt dieses Dokuments. | Dateiname, z. B. confirm.hmail |
UseExternMailSystem | Bei Verwendung eines Drittanbieters für den E-Mail-Versand wird dieser Anbieter hier angegeben. Standard ist „no“, d. h., das Shop-eigene Mail-System wird verwendet. | [no][InxMail], |
ExternMailTemplate | Template, auf dem das JSON-Objekt zur Übergabe an den externen Mail-Anbieter, z. B. InxMail, angelegt wird | Dateiname |
Angaben zur Anfrage-E-Mail
Alle Angaben zur E-Mail an den Angefragten finden Sie in der Sektion <InquiryEmail>
.
<InquiryEmail>
SendEMail = yes
EmailSubject = Anfrage
EmailAddress = ihreAdresse@ihre-domain.de
charset = ISO-8859-1
EmailTemplate = templates/request.hmail
SenderAddress = optionaleAnfrageadresse@ihre-domain.de
UseExternMailSystem = no
ExternMailTemplate =
</InquiryEmail>
Parameter | Beschreibung | Werte |
---|---|---|
SendEmail | Legt fest, ob an den Angefragten eine Bestätigungs-E-Mail geschickt wird. | [yes][no] |
EmailSubject | Der Betreff der E-Mail. | Text, z. B. Ihre Anfrage |
EmailAddress | Die E-Mail-Adresse zu der die Anfrage gesendet wird. Es können auch mehrere Adressen, durch Komma getrennt, angegeben werden. | E-Mail-Adresse, abc@domain.de |
Charset | Optionaler Parameter Der in der E-Mail verwendete Zeichensatz. Ist der Parameter nicht angegeben, so wird der globale Zeichensatz (Parameter Charset in der Sektion „Basic“) verwendet. | ISO-Zeichensatz, z. B. ISO-8859-1 |
EmailTemplate | Das HTML-Template der E-Mail. Weitere Informationen zu Tags und Templates finden Sie in dieser Dokumentation. | Dateiname, z. B. confirm.hmail |
SenderAddress | Optionale Absenderadresse. Ist diese Adresse angegeben, so wird sie als Absenderadresse verwendet. Die vom Benutzer eingegebene Adresse wird dann als Antwortadresse verwendet. | E-Mail-Adresse, abc@domain.de |
UseExternMailSystem | Bei Verwendung eines Drittanbieters für den E-Mail-Versand wird dieser Anbieter hier angegeben. Standard ist „no“, d. h., das Shop-eigene Mail-System wird verwendet. | [no][InxMail], Standard: no |
ExternMailTemplate | Template, auf dem das JSON-Objekt zur Übergabe an den externen Mail-Anbieter, z. B. InxMail, angelegt wird | Dateiname |
PDF-Download der Anfrage
Alle Einstellungen zur PDF-Erzeugung sind in der Sektion <PDF> zu finden.
<PDF>
Allow = yes
Template = antwort_pdf.htm
Filename = anfrage.pdf
</PDF>
Parameter | Beschreibung | Werte |
---|---|---|
Allow | Legt fest ob die Anfrage als PDF heruntergeladen werden kann. | [yes][no], Standard: no |
Template | Name des HTML-Templates welches für die PDF-Erzeugung verwendet wird. | Dateiname, z. B. antwort_pdf.htm |
Filename | Der Dateiname der erzeugten PDF-Datei. | Dateiname, z. B. anfrage.pdf |
Konfiguration des WEBSALE-Upload-Moduls
Alle Einstellungen zur Verwendung des WEBSALE-Upload-Moduls sind in der Sektion <Upload>
zu finden.
<Upload>
Allow = yes
UploadIni = upload.config
UploadDescr = Anhänge
AttachUploadsToInquiryEMail-Allow = yes
</Upload>
Parameter | Beschreibung | Werte |
---|---|---|
Allow | Legt fest, ob die Uploadfunktion verwendet werden soll | [yes][no], Standard: no |
UploadIni | Konfigurationsdatei des WEBSALE-Upload-Moduls | Dateiname, |
UploadDescr | Dieser Text erscheint in den automatisch erzeugten Anfragedaten als Text über der Liste der hochgeladenen/angehängten Dateien. | Text, z. B. Anhänge |
AttachUploadsToInquiryEMail-Allow | Erlaubt Datei-Anhänge an Mails | [yes][no], Standard: no |
Ein ausführliches Beispiel für ein Anmeldeformular mit Datei-Upload finden Sie in der Frontend-Dokumentation:
https://doku.websale.net/index.html?guide_uploadmodulfuerformulareinquiry.html
Konfiguration der CAPTCHA-Funktionalität
Konfiguration
Die Einstellungen zur CAPTCHA-Funktion sind in der Sektion <Captcha> zu finden.
<Captcha>
UseArithmeticCaptcha = yes
UseReCaptchaV3 = yes
CaptchaDescription = Eine kleine Rechenaufgabe
CaptchaNotFilledIn = Bitte lösen Sie die Rechenaufgabe
CaptchaError = Die Rechenaufgabe wurde nicht gelöst
</Captcha>
Sie können als CAPTCHA-Funktionalität entweder die Rechenaufgabe, das ReCaptcha- oder das Friendly-Captcha-Verfahren verwenden.
Parameter | Beschreibung | Werte |
---|---|---|
UseArithmeticCaptcha | Legt fest ob die CAPTCHA-Funktion in Form einer Rechenaufgabe verwendet werden soll. | [yes][no], Standard: no |
UseRecaptchaCaptcha | Wenn Sie als CAPTCHA-Funktion die Rechenaufgabe verwenden möchten, muss dieser Parameter auf "no" stehen! | [yes][no], Standard: no |
CaptchaDescription | Dieser String beschreibt die CAPTCHA-Funktionalität und kann auf dem Template ausgegeben werden. | Text, z. B. Eine kleine Rechenaufgabe |
CaptchaNotFilledIn | Dieser Fehlerstring wird angezeigt, wenn das CAPTCHA-Eingabefeld nicht ausgefüllt wurde. | Text, z. B. Bitte lösen Sie die Rechenaufgabe |
CaptchaError | Dieser Fehlerstring wird angezeigt, wenn das CAPTCHA-Eingabefeld falsch ausgefüllt wurde. | Text, z. B. Die Rechenaufgabe wurde nicht gelöst |
Die CAPTCHA-Funktion in Form einer Rechenaufgabe stellt die drei Grundrechenarten Addition, Subtraktion und Multiplikation zur Verfügung. Diese drei Grundrechenarten werden standardmäßig mit vorgegebenen Wertebereichen verwendet. Sie können allerdings die Einstellungen für jede dieser Grundrechenarten individuell konfigurieren. Dazu können Sie folgende drei Sektionen verwenden:
Parameter | Beschreibung | Werte |
---|---|---|
CaptchaOperation+ | Addition |
|
CaptchaOperation- | Subtraktion |
|
CaptchaOperation* | Multiplikation |
|
Beispiel:
<CaptchaOperation+>
Allow = yes
Operand1RangeStart = 1
Operand1RangeEnd = 9
Operand2RangeStart = 1
Operand2RangeEnd = 9
+Sign = plus
+Sign = +
+Sign = und
</CaptchaOperation+>
Parameter | Beschreibung | Werte |
---|---|---|
Allow | Legt fest ob diese Grundrechenart verwendet wird. | [yes][no], Standard: yes |
Operand1RangeStart | Legt den kleinsten Wert des ersten Operanden fest. (optional) | Zeichenanzahl, z. B. 1 |
Operand1RangeEnd | Legt den größten Wert des ersten Operanden fest. (optional) | Zeichenanzahl, z. B. 9 |
Operand2RangeStart | Legt den kleinsten Wert des zweiten Operanden fest. (optional) | Zeichenanzahl, z. B. 1 |
Operand2RangeEnd | Legt den größten Wert des zweiten Operanden fest. (optional) | Zeichenanzahl, z. B. 9 |
+Sign | Bis zu 10 Einträge je Grundrechenart werden unterstützt. Ist mindestens ein Eintrag einer Grundrechenart vorhanden werden die standardmäßig konfigurierten Strings nicht mehr verwendet! Eine textuelle Repräsentation der Rechenoperation. | Text, z. B. plus |
Konfiguration Google ReCaptcha (Version 3)
Google ReCaptcha Version 2 wurde deaktiviert und funktioniert daher nicht mehr. INQUIRY4 unterstützt derzeit Google ReCaptcha Version 3.
<Captcha>
...
UseReCaptchaV3 = yes
Site-Key = # z. B. 6Le0SJsUxxxxxxxxxxxxxxxxx_xxxxxxxxxxxxxx
Secret-Key = # z. B. 6Le0SJsUxxxxxx_xxxxxxxxxxxxxxxxxx_xxxxxx
Api-Url = https://www.google.com/recaptcha/api.js
Verify-Url = https://www.google.com/recaptcha/api/siteverify
CaptchaV3EmptyToken = Token ist leer #
CaptchaV3EmptySecretKey = Secret-Key ist nicht gesetzt #
CaptchaV3ResponseError = Recaptcha Response ist false #
CaptchaV3ScoreError = Score ist weniger als 0.5 #
CaptchaV3ActionName = # z. B. kontakt
CaptchaV3TechnicalProblem = Techn. Problem, keine Verbindung
CustomScore = # Wert von 0.1 – 1.0; Standard: 0.5
...
</Captcha>
Parameter | Beschreibung | Werte |
---|---|---|
UseReCaptchaV3 |
| [yes|no]; Standard: no |
Site-Key | Site-Key, wird von Google bezogen |
|
Secret-Key | Secret-Key, wird von Google bezogen |
|
Api-Url | Standardwert von Google | |
Verify-Url | Standardwert von Google | |
CaptchaV3EmptyToken | Fehlermeldung, wenn Token leer ist | Text, z. B. Token ist leer |
CaptchaV3EmptySecretKey | Fehlermeldung, wenn Secret-Key nicht gesetzt ist | Text, z. B. Secret-Key ist nicht gesetzt |
CaptchaV3ResponseError | „Success“-Parameter in Response ist "false" | Text, z. B. Recaptcha Response ist false |
CaptchaV3ScoreError | „Score“-Parameter in Response ist weniger als 0.5 | Text, z. B. Score ist weniger als 0.5 |
CaptchaV3ActionName | ActionName für Seite (z. B homepage, login ...) | Text, z. B. Kontakt |
CaptchaV3TechnicalProblem | Fehlermeldung bei technischem Problem | Text, z. B. Techn. Problem, keine Verbindung |
CustomScore | Recaptcha Custom Score (0.1 – 1.0), wir vergleichen diesen Wert mit der Response von Google, um zu prüfen, ob Form gültig ist | Zeichenanzahl, z. B. 30 Standard: 0.5. |
Konfiguration Friendly Captcha
Friendly Captcha sendet dem Benutzer ein kryptografisches Rätsel, das Gerät des Benutzers benötigt einige Sekunden, um dieses zu lösen, der Benutzer muss nichts tun.
<Captcha>
...
UseFriendlyCaptchaV1 = yes
FriendlyCaptchaV1ApplicationID = #ApplicationID aus FriendlyCaptcha Backend
FriendlyCaptchaV1APIKey = #API-Key aus FriendlyCaptcha
FriendlyCaptchaV1ApiUrl = https://eu-api.friendlycaptcha.eu/api/v1/puzzle #Endpoint (bei FC dokumentiert, global oder EU Endpoint)
FriendlyCaptchaV1VerifyUrl = https://eu-api.friendlycaptcha.eu/api/v1/siteverify #Endpoint (bei FC dokumentiert, global oder EU Endpoint)
FriendlyCaptchaV1TechnicalProblem = #
FriendlyCaptchaV1Denied = #
FriendlyCaptchaV1EmptySolution = #
...
</Captcha>
Parameter | Beschreibung | Werte |
---|---|---|
UseFriendlyCaptchaV1 |
| [yes|no]; Standard: no |
FriendlyCaptchaV1ApplicationID | ApplicationID, wird von FriendlyCaptcha bezogen |
|
FriendlyCaptchaV1APIKey | API-Key, wird von FriendlyCaptcha bezogen |
|
© 2025 WEBSALE AG | Impressum | Datenschutz