Formulare mit INQUIRY4
INQUIRY4 ist ein WEBSALE-Programm 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 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.
- 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.7.1 Konfiguration
- 4.5.7.2 Konfiguration Google ReCaptcha (Version 3)
- 4.5.7.3 Konfiguration Friendly Captcha
- 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 Tags und Templates
- 5.1 Verwendung von Tags
- 5.1.1 Arten von Tags
- 5.1.2 Verschachtelung von Tags
- 5.2 Unterstützte Tags
- 5.2.1 Tags der Adressdaten
- 5.2.2 Tags der optionalen Lieferadresse
- 5.2.3 Tags von allgemeinen Eingabefeldern
- 5.2.4 Tags der CAPTCHA-Funktionen
- 5.2.5 Tags des PDF-Downloads
- 5.2.6 Tags des Dateiuploads
- 5.2.7 Design Control Tags
- 5.2.8 Spezielle Tags
- 5.3 Regeln für ein HTML-E-Mail-Template
- 5.1 Verwendung von Tags
- 6 Besondere Namen und Klassen
- 7 Verwendung von INQUIRY4 mit WEBSALE E-Commerce
- 8 Anhang
- 9 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: 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.
SPAM-Vermeidung: 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.
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:
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" ...>
Feldwert
Alle Feldwerte müssen in Anführungszeichen stehen. Es darf kein Leerzeichen zwischen "value=" und Feldwert sein.
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:
Mit Feldwert:
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>
.
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>
.
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>
.
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.
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.
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.
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:
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.
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.
Parameter | Beschreibung | Werte |
---|---|---|
UseFriendlyCaptchaV1 |
| [yes|no]; Standard: no |
FriendlyCaptchaV1ApplicationID | ApplicationID, wird von FriendlyCaptcha bezogen |
|
FriendlyCaptchaV1APIKey | API-Key, wird von FriendlyCaptcha bezogen |
|
FriendlyCaptchaV1ApiUrl | Standardwert von FriendlyCaptcha | |
FriendlyCaptchaV1VerifyUrl | Standardwert von FriendlyCaptcha | |
FriendlyCaptchaV1TechnicalProblem | Fehlermeldung bei technischem Problem | Text, z. B. Techn. Problem, keine Verbindung |
FriendlyCaptchaV1Denied | Fehlermeldung, wenn Zugriff verweigert wird | Text |
FriendlyCaptchaV1EmptySolution | Fehlermeldung, wenn Captcha nicht gelöst wurde | Text |
Konfiguration des Blacklisting
Alle Einstellungen zu verwendeten Blacklists sind in der Sektion <Filter> zu finden.
Wenn eigene, lokale Blacklists verwendet werden sollen, werden diese im Online-Servicebereich (OSB) in der INQUIRY-Konfiguration als eigenen config-Dateien angelegt (Format siehe unten).
Parameter | Beschreibung | Werte |
---|---|---|
IP-Blacklisting | Legt fest ob geprüft werden soll, ob die IP-Adresse des Anfragenden auf einer none: keine Prüfung global: Es wird nur die globale, von der WEBSALE AG gepflegte Blacklist verwendet (Für weitere Informationen kontaktieren Sie bitte WEBSALE AG) local: Es wird nur die lokal angegebene Blacklist verwendet both: Es wird die lokale und die globale Blacklist verwendet | [none][global][local][both] |
IP-Blacklist | Name der lokalen Blacklist-Datei für IP-Adressen | Beispiel: |
MX-Blacklisting | Legt fest, ob geprüft werden soll, ob einer der MX-Einträge der E-Mail-Adressen des Anfragenden (soweit vorhanden) auf einer Blacklist steht. Ist dies der Fall, kann der Anfragende die Anfrage nicht absenden. Dies ist vor allem gegen sogenannte "Gewinnspielclubs" ein Ansatz, Spam zu vermeiden! none: keine Prüfung global: Es wird nur die globale, von der WEBSALE AG gepflegte Blacklist verwendet (Für weitere Informationen kontaktieren Sie bitte WEBSALE AG) local: Es wird nur die lokal angegebene Blacklist verwendet both: Es wird die lokale und die globale Blacklist verwendet | [none][global][local][both] |
MX-Blacklist | Name der lokalen Blacklist mit MX-Einträgen, | Beispiel: |
ErrorMessage | Dieser Fehlerstring wird angezeigt, wenn der Anfragende aufgrund einer Blacklist die Anfrage nicht absenden kann. | Text, z. B. Ihre IP-Adresse ist gesperrt |
Beispiel:
Fehlermeldungen für den Anwender
Alle konfigurierbaren Fehlermeldungen sind in der Sektion <ErrorMessages> zu finden.
Parameter | Beschreibung | Werte |
---|---|---|
Error | Dieser Fehlerstring wird immer angezeigt, wenn mindestens eine Eingabe fehlt oder falsch ist. Darunter werden dann die Details zu dem (den) Fehler(n) gezeigt. | Text, z. B. Um Ihre Anfrage bearbeiten zu können, prüfen Sie bitte folgende Angaben: |
AddressEmailError | Dieser Fehlerstring wird angezeigt, wenn die Überprüfung der E-Mail-Adresse der Rechnungsadresse fehlschlug. | Text, z. B. Rechnungsanschrift: Ungültige E-Mail-Adresse |
DeliverEmailError | Dieser Fehlerstring wird angezeigt, wenn die Überprüfung der E-Mail-Adresse der Lieferadresse fehlschlug. | Text, z. B. Lieferanschrift: Ungültige E-Mail-Adresse |
CommonInputMissing | Dieser Fehlerstring wird angezeigt, wenn der Benutzer keine Eingaben in einem allgemeinen Anfragefeld (keine Adressdaten) gemacht hat und die Option gesetzt ist. Dieser Fehlerstring kann auch leer sein. Die Fehlermeldung wird dann nie angezeigt. | Text, z. B. Treffen Sie bitte ihre Wahl / machen Sie folgende Angaben |
NoInput | Dieser Fehlerstring wird angezeigt, wenn überhaupt keine Eingabe gemacht wurde, weder in allgemeinen Feldern noch in Adressfeldern. Dieser Fehlerstring kann auch leer sein. Die Fehlermeldung wird dann nie angezeigt. | Text, z. B. Füllen Sie bitte mindestens ein Feld aus |
Allgemeine Anfragefelder
INQUIRY4 kann in einem Formular bis zu 1000 allgemeine Anfragefelder bearbeiten. Ein allgemeines Anfragefeld hat folgende Form:
Parameter | Beschreibung | Werte |
---|---|---|
Allow | Wenn Sie diesen Parameter auf "yes" setzen, dann wird das Feld von INQUIRY4 bearbeitet und kontrolliert. Bei "no" wird das Eingabefeld nicht bearbeitet bzw. ignoriert. | [yes|no]; Standard: yes |
Type | Typ des Eingabefeldes. |
|
Name | Name des Eingabefeldes, welches Sie im HTML-Formular vergeben. Bitte beachten Sie: Die Namen der Eingabefelder müssen für das gesamte Formular eindeutig sein. Ein Feldname, z. B. "beratung", darf somit nicht mehrmals vorkommen. Die Namen der allgemeinen Anfragefelder dürfen nicht mi „A-“ oder „D-“ beginnen. | Text, z. B. beratung |
Descr | Textuelle Beschreibung des Feldes. Dieser Text erscheint in den E-Mails. | Text, z. B. Ich möchte Beratung |
Required | Wenn Sie diesen Parameter auf "yes" setzen, dann muß dieses Feld vom Anfragenden ausgefüllt oder markiert werden. | [yes][no]; Standard: no |
Hide | Wenn dieser Parameter auf „yes“ gesetzt wird, wird dieses Feld NICHT in einer automatisch generierten E-Mail erzeugt. | [yes][no]; Standard: no |
Max | Optional, maximale Länge der Eingabe | Zeichenanzahl, z. B. 100
|
Adressfelder
Adressfelder werden prinzipiell wie die allgemeinen Anfragefelder behandelt, besitzen jedoch jeweils eine eigene, fest definierte Sektion. Der Grund hierfür liegt u.a. darin, dass INQUIRY4 diese Felder der Adresse bzw. einer optionalen Lieferadresse zuordnet und diese gesondert behandelt.
Felder der Adressdaten beginnen mit „A-“, die der Lieferadresse mit „D-“ (für Delivery). Es werden dabei alle von WEBSALE V8 verwendeten Felder von INQUIRY4 unterstützt.
z. B.
Wert | Feld |
---|---|
Vorname |
|
Nachname (Lieferadresse) |
|
Anrede |
|
usw.
Spezialfeld: Das Feld <A-MerchantEmail>
verhält sich wie ein normales Eingabefeld. Der eingegebene/übergebene Wert wird allerdings als Liste von E-Mail-Adressen (die einzelnen E-Mail-Adressen müssen durch ein Komma voneinander getrennt sein) interpretiert. An diese E-Mail-Adressen wird zusätzlich zu der konfigurierten E-Mail-Adresse die Anfrage-E-Mail gesendet.
Sektion SendUserEmail
Dies ist ein spezielles, fest definiertes Feld, welches vorhanden sein muss, wenn der Parameter SendEmail in der Sektion <ConfirmEmail>
den Wert userselect hat.
Mit diesem Feld wird definiert, über welches HTML-Element der Benutzer steuern kann, ob er eine E-Mail erhält oder nicht.
Das Feld hat die Form:
Parameter | Beschreibung | Werte |
---|---|---|
Type | Typ des Eingabefeldes. |
|
Name | Name des Eingabefeldes, welches Sie im HTML-Formular vergeben haben. | Text, z. B. confirmemail |
Descr | Textuelle Beschreibung des Feldes. | Text, z. B. Ich möchte eine Bestätigungs-E-Mail erhalten |
UseInput | Wenn dieser Parameter „A“ ist, wird die E-Mail-Adresse zwingend benötigt, wenn der Benutzer eine Bestätigungsemail wünscht. Wenn dieser Parameter „D“ ist, wird die optionale E-Mail-Adresse der Lieferadresse zwingend benötigt, wenn der Benutzer eine Bestätigungsemail wünscht. Wenn dieser Parameter „AD“ ist wird sowohl die E-Mail-Adresse als auch die optionale E-Mail-Adresse der Lieferadresse zwingend benötigt, wenn der Benutzer eine Bestätigungsemail wünscht. | [A][D][AD] Standard: A |
Tags und Templates
INQUIRY4 bietet Ihnen die Möglichkeit, in Ihren Templates durch bestimmte, wohldefinierte „Tags“ Informationen entsprechend den Benutzereingaben einzufügen bzw. bestimmte Bereiche ein- oder auszublenden.
Verwendung von Tags
Arten von Tags
Es existieren 3 Arten von Tags:
Einfache Ersetzungs-Tags | Diese haben die Form ~TAG-Name~. Das Tag wird durch den entsprechenden Wert ersetzt. |
Bereichs-Tags | Ein Bereich wird mit {TAG-Name} geöffnet und mit {/TAG-Name} geschlossen. Dieser Bereich wird nur angezeigt, wenn das TAG irgendeinen Wert hat. |
Negative Bereichs-Tags | Ein negativer Bereich wird mit {!TAG-Name} geöffnet und mit {/!TAG-Name} geschlossen. Dieser Bereich wird nur angezeigt, wenn kein Wert für dieses TAG existiert. |
Ein Tag kann im Template entweder in Form eines einfachen Ersetzungs-Tags und/oder eines Bereichs-Tags und/oder eines negativen Bereichs-Tags eingesetzt werden. Folgende Kodierung soll hierzu gelten:
Kodierung der Einsatzmöglichkeiten, z. B.: 100
Die erste Stelle „1“ bezieht sich auf Ersetzungstags. Die 2. Stelle „0“ bezieht sich auf Bereichs-Tags und die 3. Stelle „0“ auf negative Bereichs-Tags.
1 bedeutet: wird unterstützt
0 bedeutet: keine Unterstützung
Unterstützt | Einfaches Tag | Bereichs-Tag | neg. Bereichs-Tag |
---|---|---|---|
100 | ja | nein | nein |
011 | nein | ja | ja |
111 | ja | ja | ja |
Beispiel 1:
Tag | Unterstützt | Beschreibung | Besonderheit |
---|---|---|---|
Beispiel | 100 | Tag für das Feld ABCDE | Dieser Text wird nicht beim ersten Aufruf des Formulars mit INQUIRY4 angezeigt, sondern nur, wenn beim Absenden des Formulars ein Fehler festgestellt wurde. |
Dieses Tag können Sie im Template wie folgt verwenden:
Sie können dieses Tag allerdings nicht wie folgt verwenden:
Dieses Beispiel-Tag unterstützt mit 100 also nur die Möglichkeiten eines “Einfachen Tags“, ist aber kein “Bereichs-Tag“ bzw. kein “Negatives Bereichs-Tag“.
Beispiel 2:
Tag | Unterstützt | Beschreibung |
---|---|---|
INFO-Referer | 111 | Zeigt den als Parameter |
Dieses Tag können Sie im Template wie folgt verwenden:
Dadurch wird dieses Tag durch den übergebenen Wert ersetzt.
Sie können dieses Tag allerdings auch als Bereichs-Tag oder Negatives Bereichs-Tag verwenden:
(a)
(b)
Wenn ein Referer übergeben wurde, wird nur der Bereich (a) angezeigt. Wurde kein Referer übergeben, wird nur der Bereich (b) angezeigt.
Verschachtelung von Tags
In einem Bereich (Anzeigebereich auf der erzeugten Webseite) dürfen wiederum beliebige andere Tags vorkommen.
Beispiel:
Im Fehlerfall wäre auf der Formularseite z. B. zu lesen:
Herr <Name>, die Eingabe der folgenden Punkte war nicht korrekt:
Unterstützte Tags
INQUIRY4 kennt hierbei folgende Tags:
Tags der Adressdaten
Die Tags der Adressdaten beginnen alle mit „A-“ und haben die gleiche Bezeichnung wie die zugehörige Sektion in der Konfigurationsdatei.
Es existieren drei Suffixe, die in Kombination mit dem Sektionsnamen ein gültiges Tag ergeben:
Suffix | Beschreibung |
---|---|
_value | Der vom Nutzer eingegebene Wert |
_descr | Die Beschreibung, wie in der Konfigurationsdatei angegeben |
_name | Der HTML-Name, wie in der Konfigurationsdatei angegeben. |
_max | Die in der Konfigurationsdatei angegebene maximale Eingabelänge |
_error | Fehlerhafte Eingabe:
|
Jedes so erzeugte Tag unterstützt dabei alle drei Arten von Tags.
Dadurch wird der vom Benutzer eingegebene Nachname, wenn vorhanden, angezeigt.
Hier wird ein Eingabefeld für den Vornamen erstellt, wobei der HTML-Name wie in der Konfigurationsdatei angegeben eingefügt und die Beschreibung aus der Konfigurationsdatei vorangestellt wird.
Zusätzlich können die Bereichs- und negativen Bereichs-Tags mit dem Suffix _value auf bestimmte eingegebene Werte geklammert werden.
Daneben können Zusatzfelder (sog. Suffix-Felder) verwendet werden.
Auch die Tags der Suffix-Felder beginnen mit „A-“ und haben die gleiche Bezeichnung wie die zugehörige Sektion in der Konfigurationsdatei.
Achtung: Im INQUIRY können maximal 10 Suffix-Felder (<A-Suffix1>
bis <A-Suffix10>
) genutzt werden. Wenn Sie mehr Zusatzfelder einsetzen möchten, müssen diese mit <+CommonInput>
realisiert werden. (Siehe oben Allgemeine Anfragefelder)
Zusätzliche Tags:
Tag | Unterstützt | Beschreibung | Besonderheit |
---|---|---|---|
A-Salutation_list | 100 | Generiert automatisch eine Listbox mit Anreden. Dabei wird die Datei aus der Sektion |
|
A-Salutation_complete | 100 | Die vollständige Anrede. Zur Erzeugung dieser wird die Datei aus der Sektion |
|
A-Title_list | 100 | Generiert automatisch eine Listbox mit Titeln. Dabei wird die Datei aus der Sektion | Die erzeugte Listbox besitzt die Styles-klasse |
A-Country_list | 100 | Generiert automatisch eine Listbox mit Ländern. Dabei wird die Datei aus der Sektion | Die erzeugte Listbox besitzt die Styles-klasse |
A-DateOfBirth_list | 100 | Generiert automatisch drei Listboxen zur Auswahl des Geburtsdatums. | Die erzeugten Listboxen besitzen die Styles-klasse |
Tags der optionalen Lieferadresse
Die Tags der Lieferadresse werden analog zu denen der Adressdaten gebildet.
Die Tags der Lieferadresse beginnen alle mit „D-“ und haben die gleiche Bezeichnung wie die zugehörige Sektion in der Konfigurationsdatei.
Es existieren drei Suffixe, die in Kombination mit dem Sektionsnamen einen gültigen Tag ergeben:
Suffix | Beschreibung |
---|---|
_value | Der vom Nutzer eingegebene Wert |
_descr | Die Beschreibung, wie in der Konfigurationsdatei angegeben |
_name | Der HTML-Name, wie in der Konfigurationsdatei angegeben. |
_max | Die in der Konfigurationsdatei angegebene maximale Eingabelänge |
_error | Fehlerhafte Eingabe:
|
Jedes so erzeugte Tag unterstützt dabei alle drei Arten von Tags.
Dadurch wird der vom Benutzer eingegebene Nachname, wenn vorhanden, angezeigt.
Hier wird ein Eingabefeld für den Vornamen erstellt, wobei der HTML-Name wie in der Konfigurationsdatei angegeben eingefügt und die Beschreibung aus der Konfigurationsdatei vorangestellt wird.
Zusätzlich können die Bereichs- und negativen Bereichs-Tags mit dem Suffix _value
auf bestimmte eingegebene Werte geklammert werden.
Daneben können Zusatzfelder (sog. Suffix-Felder) verwendet werden.
Auch die Tags der Suffix-Felder beginnen mit „D-“ und haben die gleiche Bezeichnung wie die zugehörige Sektion in der Konfigurationsdatei.
Achtung: Im INQUIRY können maximal 10 Suffix-Felder (<D-Suffix1>
bis <D-Suffix10>
) genutzt werden. Wenn Sie mehr Zusatzfelder einsetzen möchten, müssen diese mit <+CommonInput>
realisiert werden (Siehe oben Allgemeine Anfragefelder).
Zusätzliche Tags:
Tag | Unterstützt | Beschreibung | Besonderheit |
---|---|---|---|
D-Salutation_list | 100 | Generiert automatisch eine Listbox mit Anreden. Dabei wird die Datei aus der Sektion <Basic>, Parameter SalutationDat verwendet. | Die erzeugte Listbox besitzt die Styles-klasse „select_d_salut“. |
D-Salutation_complete | 100 | Die vollständige Anrede. Zur Erzeugung dieser wiird die Datei aus der Sektion |
|
D-Title_list | 100 | Generiert automatisch eine Listbox mit Titeln. Dabei wird die Datei aus der Sektion | Die erzeugte Listbox besitzt die Styles-klasse |
D-Country_list | 100 | Generiert automatisch eine Listbox mit Ländern. Dabei wird die Datei aus der Sektion | Die erzeugte Listbox besitzt die Styles-klasse |
D-DateOfBirth_list | 100 | Generiert automatisch drei Listboxen zur Auswahl des Geburtsdatums. | Die erzeugten Listboxen besitzen die Styles-klasse |
Tags von allgemeinen Eingabefeldern
Die Tags der allgemeinen Eingabefelder beginnen alle mit „C-“ und werden aus diesem Prefix, dem HTML-Namen und dem entsprechenden Suffix gebildet.
Es existieren drei Suffixe, die in Kombination mit dem Prefix „C-“ und dem HTML-Namen ein gültiges Tag ergeben:
Suffix | Beschreibung |
---|---|
_value | Der vom Nutzer eingegebene Wert |
_descr | Die Beschreibung, wie in der Konfigurationsdatei angegeben |
_name | Der HTML-Name, wie in der Konfigurationsdatei angegeben. |
_max | Die in der Konfigurationsdatei angegebene maximale Eingabelänge |
_error | Fehlerhafte Eingabe:
|
Jedes so erzeugte Tag unterstützt dabei alle drei Arten von Tags.
Konfigurationsdatei:
Template Anfrage:
Template E-Mail:
Hier wird eine Textarea als allgemeines Eingabefeld erstellt, im HTML-Template angezeigt und bei einer Benutzereingabe der Wert bzw. bei keiner Eingabe eine alternative Nachricht in der E-Mail verschickt.
Zusätzlich können die Bereichs- und negativen Bereichs-Tags mit dem Suffix _value
auf bestimmte eingegebene Werte geklammert werden.
Tags der CAPTCHA-Funktionen
Allgemeines Tag
Tag | Unterstützt | Beschreibung |
---|---|---|
CAPTCHA-Description | 111 | Gibt die Beschreibung der CAPTCHA-Funktionalität aus. (Konfigurationsdatei: Abschnitt Parameter |
Tags für die Rechenaufgabe und Beispiel
Tag | Unterstützt | Beschreibung | Besonderheit |
---|---|---|---|
CAPTCHA-Input_name | 100 | Der HTML-Name des CAPTCHA-Eingabefelds |
|
CAPTCHA-Input_error | 111 | Fehlerhafte Eingabe im CAPTCHA-Eingabefeld
|
|
CAPTCHA-Input_value | 111 | Der vom Anfragenden eingegebene Wert im CAPTCHA-Eingabefeld | Dieser Wert wird nur nach korrekter Eingabe des CAPTCHA- Eingabefelds ausgegeben! |
CAPTCHA-Result | 111 | Die korrekte erwartete CAPTCHA-Eingabe
| NUR ZU TESTZWECKEN VERWENDEN! |
CAPTCHA-ArithmeticOperand1 | 111 | Der erste Operand der Rechenaufgabe |
|
CAPTCHA-ArithmeticOperand2 | 111 | Der zweite Operand der Rechenaufgabe |
|
CAPTCHA-ArithmeticOperation | 111 | Die Rechenoperation der Rechenaufgabe |
|
Beispiel:
Hierbei wird das Eingabefeld im Fall einer fehlerhaften Eingabe markiert.
Wurde versucht, das Formular mit richtig gelöster Rechenaufgabe abzusenden, aber andere Eingaben wurden nicht korrekt ausgeführt, muss der Anfragende keine neue Rechenaufgabe lösen, sondern die bereits gelöste Aufgabe wird inklusive korrekt ausgefüllten Eingabefeldes wieder angezeigt.
Tags für Google ReCaptcha Version 3 und JavaScript
Tag | Unterstützt | Beschreibung |
---|---|---|
CAPTCHA-RecaptchaV3SiteKey | 100 | Site-Key, der von Google bezogen und in |
CAPTCHA-RecaptchaV3ApiUrl | 100 | URL von Google bezogen und in |
CAPTCHA-RecaptchaV3ActionName | 100 | z. B. homepage, login usw., in |
CAPTCHA-RecaptchaV3Error | 111 | Fehlermeldung von |
CAPTCHA-RecaptchaV3Score | 111 | Recaptcha Score von Google |
CAPTCHA-RecaptchaV3Response | 111 | technische Antwort von Google, kann zur Fehleranalyse verwendet werden |
CAPTCHA-RecaptchaV3ErrorCode | 111 | interner Fehlercode, kann zur Fehleranalyse verwendet werden |
JavaScript-Code, der auf dem Template eingefügt werden muss:
HTML-Code, der auf dem Formular eingefügt werden muss:
Tags für Friendly Captcha
Tag | Unterstützt | Beschreibung |
---|---|---|
CAPTCHA-FriendlyCaptchaV1ApiUrl | 111 | URL von Friendly Captcha bezogen und in |
CAPTCHA-FriendlyCaptchaV1ApplicationID | 111 | ApplicationID aus FriendlyCaptcha Backend |
CAPTCHA-FriendlyCaptchaV1Error | 111 | Fehlermeldung von |
CAPTCHA-FriendlyCaptchaV1Response | 111 | technische Antwort von Friendly Captcha, kann zur Fehleranalyse verwendet werden |
CAPTCHA-FriendlyCaptchaV1ErrorCode | 111 | interner Fehlercode, kann zur Fehleranalyse verwendet werden |
Code, der auf dem Template eingefügt werden muss:
Tags des PDF-Downloads
Tag | Unterstützt | Beschreibung | Werte / Beispiele |
---|---|---|---|
PDF-Form | 111 | Form zur Erzeugung eines PDFs der Anfrage. Wird nur auf der ConfirmPage unterstützt. Der Bereich wird nicht angezeigt, wenn der Parameter Allow in der Sektion PDF auf no steht. | |
PDF-Button | 111 | Buttonname zur Erzeugung eines PDFs der Anfrage. Wird nur auf der ConfirmPage unterstützt. Der Bereich wird nicht angezeigt, wenn der Parameter Allow in der Sektion PDF auf no steht. Muss innerhalb der PDF-Form stehen. |
Tags des Dateiuploads
Tag | Unterstützt | Beschreibung | Werte / Beispiele |
---|---|---|---|
INQUIRY-Upload | 011 | Der Bereich wird angezeigt, wenn das WEBSALE-Upload-Modul mit diesem Anfrageformular verwendet werden kann. Dies beinhaltet auch, dass der Upload in der Konfigurationsdatei aktiviert ist (Parameter Allow in der Sektion Upload) |
|
UPLOAD-Link | 100 | Link zum Upload-Modul. Dieser Link kann als Popup oder als iFrame (als iFrame auch innerhalb einer Colorbox) verwendet werden. |
|
UPLOAD-SSLLink | 100 | Link zum Upload-Modul im SSL-Modus. Dieser Link kann als Popup oder als iFrame (als iFrame auch innerhalb einer Colorbox) verwendet werden. |
|
UPLOAD-Data | 111 | Gibt die Anzahl der hochgeladenen Dateien aus bzw. zeigt an, ob Dateien hochgeladen wurden. | Dieses Tag kann auch als Schleifentag verwendet werden, um Informationen zu den hochgeladenen Dateien anzuzeigen. Beispiel: Anzeige der hochgeladenen Dateien als Schleife: Dies erzeugt bei 3 hochgeladenen Dateien (Datei1.txt, Datei2.txt und Datei3.pdf):
|
UPLOAD-File | 100 | Der Dateiname der hochgeladenen Datei. Kann nur innerhalb der Schleife des Tags UPLOAD-Data verwendet werden. |
|
UPLOAD-Position | 100 | Die Position der hochgeladenen Datei. Kann nur innerhalb der Schleife des Tags UPLOAD-Data verwendet werden. |
|
UPLOAD-Descr | 100 | Die Beschreibung der hochgeladenen Dateien (festgelegt in der Konfigurationsdatei, Sektion Upload, Parameter UploadDescr) |
|
UPLOAD-ID | 111 | Das Einzel-Tag gibt die ID des Uploads aus. |
|
Design Control Tags
INQUIRY4 unterstützt folgende INQDC-FP-Tags, inkl. Tag-in-Tag-Unterstützung. Hinsichtlich Funktionalität und Arbeitsweise entsprechen diese den DC-FP-Tags im Shop (vgl. WEBSALE-Designer-Dokumentation):
Tag | Unterstützt | Beschreibung |
---|---|---|
INQDC-FPX | 111 | X ist frei wählbar, darf aber ausschließlich aus alphanumerischen Zeichen bestehen |
INQDC-FPX_set | 100 |
|
INQDC-FPX_reset | 100 |
|
INQDC-FPX_replace | 100 |
|
INQDC-FPX_append | 100 |
|
INQDC-FPX_truncate | 100 |
|
INQDC-FPX_contains | 011 |
|
INQDC-FPX_urlencoding | 100 |
|
INQDC-FPX_slice | 100 |
|
INQDC-FPX_convertToEncoding | 100 |
|
INQDC-FPX_extractTaggedData | 100 |
|
INQDC-FPX_length | 100 |
|
INQDC-FPX_jsonencoding | 100 |
|
INQDC-CompareDigitLT | 011 |
|
INQDC-CompareDigitLTE | 011 |
|
INQDC-CompareDigitGT | 011 |
|
INQDC-CompareDigitGTE | 011 |
|
INQDC-CompareDigitIB | 011 |
|
INQDC-CompareDigitIBE | 011 |
|
INQDC-CompareStringInList | 011 |
|
INQDC-IntX | 111 | X = 1...3 |
INQDC-IntX_set | 100 |
|
INQDC-IntX_add | 100 |
|
INQDC-IntX_sub | 100 |
|
INQDC-IntX_mul | 100 |
|
INQDC-IntX_div | 100 |
|
INQDC-IntX_mod | 100 |
|
INQDC-IntX_inc | 100 |
|
INQDC-LoopX | 111 | X = 1...3 |
INQDC-LoopX_set | 100 |
|
INQDC-LoopX_position | 100 |
|
INQDC-DateTime_set | 100 |
|
INQDC-DateTime_hours | 111 |
|
INQDC-DateTime_minutes | 111 |
|
INQDC-DateTime_seconds | 111 |
|
INQDC-DateTime_year | 111 |
|
INQDC-DateTime_month | 111 |
|
INQDC-DateTime_day | 111 |
|
INQDC-DateTime_setunixtimestamp | 100 |
|
INQDC-DateTime_dayofweek | 111 |
|
INQDC-DateTime_unixtimestamp | 111 |
|
INQDC-ZeroLoopX | 111 |
|
INQDC-ZeroLoopX_set | 100 |
|
INQDC-ZeroLoopX_position | 100 |
|
INQDC-DynamicLoopX | 111 | X = 1...3 |
INQDC-DynamicLoopX_set | 100 |
|
INQDC-DynamicLoopX_settaggeddata | 100 |
|
INQDC-DynamicLoopX_setseparator | 100 |
|
INQDC-DynamicLoopX_setSeparatorTags | 100 |
|
INQDC-DynamicLoopX_position | 100 |
|
INQDC-DynamicLoopX_data | 100 |
|
Spezielle Tags
Es existieren noch folgende, zusätzliche Tags:
Tag | Unterstützt | Beschreibung | Werte / Beispiel |
---|---|---|---|
AUTOGENERATE-full | 100 | Erzeugt automatisch alle Informationen zu einer Anfrage. Zur Benutzung in E-Mail-Templates vorgesehen. | Erzeugt folgenden Inhalt in einer E-Mail:
|
AUTOGENERATE-header | 100 | Erzeugt automatisch nur den Header einer Anfrage. Zur Benutzung in E-Mail-Templates vorgesehen. | Erzeugt folgenden Inhalt in einer E-Mail: |
AUTOGENERATE-addr | 111 | Erzeugt automatisch nur die Adress-Informationen. Zur Benutzung in E-Mail-Templates vorgesehen. | Erzeugt folgenden Inhalt in einer E-Mail: |
AUTOGENERATE-common | 111 | Erzeugt automatisch nur die allgemeinen Anfrageinformationen. Zur Benutzung in E-Mail-Templates vorgesehen. | Erzeugt folgenden Inhalt in einer E-Mail: |
AUTOGENERATE-upload | 111 | Erzeugt automatisch nur die Liste der hochgeladenen Dateien. Zur Benutzung in E-Mail-Templates vorgesehen. | Erzeugt folgenden Inhalt in einer E-Mail: |
AUTOGENERATE-technical | 111 | Erzeugt alle Anfrageinformationen in einem Format, welches von technischen Systemen gelesen werden kann. Zur Benutzung in E-Mail-Templates vorgesehen. | Erzeugt folgenden Inhalt in einer E-Mail: |
INFO-ShopID | 100 | Die beim ersten Aufruf übergebene ShopID. | |
INFO-SubShopID | 100 | Die beim ersten Aufruf übergebene SubShopID. | |
INFO-MallID | 100 | Die verwendete MallID. | |
INFO-Reference | 100 | Die eindeutige Referenznummer der Anfrage. | |
INFO-Subject | 100 | Der Betreff der Anfrage-E-Mail. (Konfigurationsdatei: Sektion <InquiryEmail>, Parameter:EMailSubject) | |
INFO-Date | 100 | Datum der Anfrage. Format: TT.MM.JJJJ | |
INFO-Time | 100 | Uhrzeit der Anfrage. Format: HH:MM | |
INFO-Referer | 111 | Der beim ersten Aufruf übergebene Referer | |
INFO-Subreferer | 111 | Der beim ersten Aufruf übergebene SubReferer. | |
INFO-IPAddr | 100 | Die IP-Adresse des Users Bei Integration eines Inquiry über die ExternInclude-Technologie gibt der Tag immer die Adresse des WEBSALE Servers aus. | |
INFO-ExternIPAddr | 100 | Die IP-Adresse des Users Bei Integration eines Inquiry über die ExternInclude-Technologie gibt dieses Tag die IP-Adresse des Users aus. | |
INFO-ExternIPAddrTimeStamp | 111 | Der zugehörige Zeitstempel bei Verwendung von ExternInclude | |
INFO-ExternSessionID | 111 | SessionID des WEBSALE-Shops bei Verwendung von ExternInclude | |
INFO-ATitleCode | 100 | Der zum Titel der Rechnungsanschrift gehörende Code. | |
INFO-DTitleCode | 100 | Der zum Titel der Lieferanschrift gehörende Code. |
|
INFO-ASalutationCode | 100 | Der zur Anrede der Rechnungsanschrift gehörende Code. |
|
INFO-DSalutationCode | 100 | Der zur Anrede der Lieferanschrift gehörende Code. |
|
INQUIRY-SendUserEmail_name | 100 | Der Name des HTML-Elements zur Steuerung der Bestätigungsemail durch den Benutzer wie in der Konfigurationsdatei festgelegt. |
|
INQUIRY-SendUserEmail_descr | 100 | Die textuelle Beschreibung des HTML-Elements zur Steuerung der Bestätigungsemail durch den Benutzer wie in der Konfigurationsdatei angegeben. |
|
INQUIRY-SendUserEmail_value | 111 | Der vom Benutzer ausgewählte Wert. |
|
INQUIRY-AlreadySent | 011 | Hiermit kann auf dem Antworttemplate geklammert werden, ob eine Anfrage bereits abgesendet wurde bzw. der Benutzer zu lange inaktiv war. Fehlt dieser Bereich auf dem Antworttemplate und dieser Fall tritt ein, wird ein Standardfehlertemplate angezeigt. |
|
INQUIRY-NewInquiryLink | 111 | WICHTIG: Dieses Tag wird nur angezeigt bzw. der Link erzeugt, wenn INQUIRY4 NICHT im per ExternInclude eingebunden wird! Soll ein Link dieser Art per ExternInclude eingebunden werden, so kann ein WEBSALE-Link verwendet werden: Erzeugt einen Link zum erneuten Aufruf von INQUIRY4 mit der aktuellen Konfiguration. |
|
INQUIRY-Link | 100 | Die Form-URL zum Aufruf von INQUIRY4 . | |
INQUIRY-ReloadButton | 100 | Buttonname zum Aktualisieren der Anfrage. Es werden alle eingegebenen Daten aufgenommen und die Liste der hochgeladenen Dateien aktualisiert. Die eingegebenen Daten werden nicht geprüft und die Anfrage wird nicht abgesendet. |
|
MSG-Notify | 100 | Zeigt den allgemeinen Fehlertext an. (Konfigurationsdatei: Sektion | Dieser Text wird nicht beim ersten Aufruf von INQUIRY4 angezeigt. |
MSG-Input_error | 111 | Erzeugt eine detaillierte Liste der fehlerhaften Eingaben. | Es wird eine ul/li Liste erzeugt. Verwendete Stylesheet-Klassen: Die Reihenfolge der Meldungen in dieser Liste ist dieselbe wie die der zugehörigen Sektionen in der Konfigurationsdatei. |
URL-Template | 100 | Wird durch die URL auf das Template-Verzeichnis ersetzt. |
Regeln für ein HTML-E-Mail-Template
Damit eine HTML-E-Mail versendet werden kann, müssen beim Erstellen eines HTML-E-Mail-Templates folgende Regeln beachtet werden:
Alle relativen Links und Links zu Bildern oder Style-Dateien müssen in Anführungszeichen stehen.
Besondere Namen und Klassen
INQUIRY4 verwendet folgende Namen für Stylesheet-Klassen und Buttons:
Stylesheet-Klassen
Klasse |
|
---|---|
.input_error_ul | Liste der Fehlermeldungen |
.select_a_dateofbirth | SelectBox des Geburtsdatums der Rechnungsadresse |
.select_d_dateofbirth | SelectBox des Geburtsdatums der Lieferadresse |
.select_a_country | SelectBox der Länderauswahl der Rechnungsadresse |
.select_d_country | SelectBox der Länderauswahl der Lieferadresse |
.select_a_title | SelectBox der Titelauswahl der Rechnungsadresse |
.select_d_title | SelectBox der Titelauswahl der Lieferadresse |
.select_a_salut | SelectBox der Anredeauswahl der Rechnungsadresse |
.select_d_salut | SelectBox der Anredeauswahl der Lieferadresse |
Verwendung von INQUIRY4 mit WEBSALE E-Commerce
INQUIRY4 lässt sich auf verschiedene Arten in WEBSALE E-Commerce integrieren. So kann INQUIRY4 per Popup, iFrame oder ExternInclude eingebunden werden. Sollen einzelne Eingabefelder auf vielen oder allen Shopseiten eingebunden werden, so kann eine einfache Integrationsweise ohne zusätzlichen Leistungs- und Laufzeitbedarf angewandt werden.
Hinweise zur Verwendung von WS-ExternInclude
INQUIRY4 unterstützt das von WEBSALE angebotene Feature des externen Includes. Dadurch kann INQUIRY4 ohne iFrame auf einem Shop-Template eingebunden werden.
Siehe dazu die Beispieldateien in der Frontend-Dokumentation:
https://doku.websale.net/index.html?mats_materialien_zu_inquiry4.html
Integration auf einem Shop-Template
Beispiel-INQUIRY4-Aufruf auf einem Shop-Template
Die Tags in der angegebenen URL werden vor dem Aufruf von INQUIRY4 ersetzt
Änderungen am Anfragetemplate
Da mit jedem Aufruf von INQUIRY4 auch der WEBSALE Shop aufgerufen werden muss, muss die URL zum Abschicken eines Templates eine andere sein, als wenn INQUIRY4 im Popup oder eigenständig aufgerufen wird.
Beispiel InquiryPage-Template im Direktaufruf bzw. PopUp
Beispiel InquiryPage-Template über ExternInclude
Relative Adressierungen
Durch das direkte Einbinden haben alle relativen Adressierungen auf den Inquiry-Templates den Basispfad des WEBSALE Templates!
WEBSALE-Tags
Durch das direkte Einbinden von INQUIRY4 in den WEBSALE-Shop können WEBSALE-Tags auf den Inquiry-Templates eingesetzt werden. Diese werden durch WEBSALE entsprechend ersetzt.
Um das Formular anzeigen zu lassen, muss das Template des Shops geladen werden.
Beispiel:
Anhang
Nicht mehr unterstützte Parameter und Tags
Konfiguration der CAPTCHA-Funktionalität „ReCaptcha“, Version 2
ReCaptcha ver 2 wird von Google nicht mehr unterstützt. Die folgenden Angaben dienen lediglich zur Information.
Die Einstellungen zur CAPTCHA-Funktion „ReCaptcha“ sind in der Sektion <Captcha>
zu finden.
Parameter | Beschreibung | Werte |
---|---|---|
UseArithmeticCaptcha | Wenn Sie als CAPTCHA-Funktion ReCaptcha verwenden möchten, muss dieser Parameter auf "no" stehen! | [yes][no] |
UseRecaptchaCaptcha | Legt fest, ob die CAPTCHA-Funktion ReCaptcha verwendet werden soll. | [yes][no] |
RecaptchaPublicKey | Für die Nutzung von “ReCaptcha” notwendiger und kostenlos bei Google zu beantragender Schlüssel |
|
RecaptchaPrivateKey | Für die Nutzung von “ReCaptcha” notwendiger und kostenlos bei Google zu beantragender Schlüssel |
|
RecaptchaTheme | Legt die gewünschte Farbgestaltung des ReCaptcha-Widgets fest. | [red][white][blackglass][clean], |
CaptchaNotFilledIn | Dieses Formular ist vor Missbrauch geschützt. Um das Formular absenden zu können, muss die angezeigte Zeichenkette eingegeben werden. Dieser Fehlerstring wird angezeigt, wenn die Zeichenkette nicht eingegeben wurde. |
|
CaptchaError | Dieses Formular ist vor Missbrauch geschützt. Um das Formular absenden zu können, muss die angezeigte Zeichenkette korrekt eingegeben werden. Dieser Fehlerstring wird angezeigt, wenn die Zeichenkette falsch eingegeben wurde. |
|
CaptchaTechnicalProblem | Die Anfrage kann im Moment aus technischen Gründen nicht bearbeitet werden. Bitte versuchen Sie es zu späteren Zeitpunkt noch einmal. Dieser Fehlerstring wird angezeigt, wenn der externe Dienst nicht verfügbar ist. |
|
Konfiguration der Rechenaufgabe
Parameter "UseRecaptchaCaptcha ="
ist veraltet, wird ersetzt durch "UseReCaptchaV3 ="
.
Nicht mehr unterstützte Tags
Die folgenden Angaben dienen lediglich zur Information.
Tag | Unterstützt | Beschreibung |
---|---|---|
CAPTCHA-Description | 111 | Gibt die Beschreibung der CAPTCHA-Funktionalität aus. (Konfigurationsdatei: Sektion <Captcha>, Parameter CaptchaDescription). |
CAPTCHA-RecaptchaPublicKey | 111 | Gibt den PublicKey der ReCaptcha-Funktionalität aus.(Konfigurationsdatei: Sektion <Captcha>, Parameter RecaptchaPublicKey). |
CAPTCHA-RecaptchaTheme | 111 | Gibt die gewünschte Farbgestaltung des ReCaptcha-Widgets aus (Konfigurationsdatei: Sektion <Captcha>, Parameter RecaptchaTheme). |
Haftungs- und Gewährleistungsausschluss
Die Nutzung des Programms erfolgt auf Grundlage der dem Nutzer bekannten allgemeinen Geschäftsbedingungen der WEBSALE AG unter ausdrücklichem Ausschluss jeglicher Haftung oder Gewährleistung. Die Geschäftsbedingungen können jederzeit bei der WEBSALE AG angefordert werden. Durch die Nutzung des Programms erkennen Sie diese Bedingungen an.
Copyright © WEBSALE AG
Gutenstetter Str. 2, 90449 Nürnberg, +49 (0)911-63 221-0, kontakt@websale.de, www.websale.de
Haftungsausschluss
Alle Inhalte werden von der WEBSALE AG ausschließlich zu allgemeinen Informationszwecken veröffentlicht. Für die Richtigkeit, Vollständigkeit und Aktualität der Inhalte können wir jedoch keine Gewähr übernehmen.
Disclaimer
All content is published by WEBSALE AG for general information purposes only. However, we cannot guarantee the correctness, completeness and actuality of the contents.