FirstSpirit™ FormEdit

e-Spirit AG

15.12.2021
Inhaltsverzeichnis

1. Einleitung

Das Modul FirstSpirit™ FormEdit besteht aus einer redaktionellen Komponente zur Erstellung von Web-Formularen über den FirstSpirit SiteArchitect bzw. ContentCreator und einer Web-Komponente in Form eines Servlets, das die vom Nutzer eingegebenen Daten entgegennimmt und weiterverarbeitet.

1.1. Übersicht der Funktionen

Folgende Formen der Weiterverarbeitung von Formulardaten werden unterstützt:

Speichern der Daten in einer Datei im CSV-Format
Diese Art der Weiterverarbeitung speichert alle vom Formular gesendeten Werte innerhalb einer freidefinierbaren Datei im CSV-Format ab.
Speichern der Daten in einer JDBC-fähigen Datenbank
Durch Verwendung dieses Typs der Weiterverarbeitung ist es möglich, die Werte innerhalb einer Datenbank zu speichern. Über die Konfigurationseinstellung kann ein individuelles Mapping für die Formularfelder definiert werden.
Versand der Daten als E-Mail
Bei dieser Art der Weiterverarbeitung können beliebige Formulardaten per E-Mail versendet werden. Mittels einer E-Mail-Vorlage kann der Aufbau der E-Mail individuell gestaltet werden. Die E-Mails können u.a. mit Dateianhängen versendet werden, ebenso sind cc- und bcc-Empfänger möglich.
Ausgabe der Daten in das Log-File der Servlet-Engine
Diese Funktion dient dazu, alle Werte des Formulars innerhalb des Log-Files der Servlet-Engine auszugeben, in der das FormServlet initialisiert ist.
Aufruf einer URL mit Parameterübergabe
Diese Funktion ermöglicht es, eine URL mit den definierten Parametern aufzurufen, ohne dass der Benutzer diese Seite im Browser sieht (z.B. Tracking).

Weiterhin ist es möglich, die Formulare über eigene Implementierungen auszuwerten. Die oben genannten Weiterverarbeitungsmethoden können darüber hinaus miteinander kombiniert werden.

1.2. Aufbau und Funktion

Die folgende Grafik zeigt den Aufbau und die Funktionsweise des Moduls am Beispiel des Live-Servers. Bei der Nutzung innerhalb der Preview oder des Stagings werden die in FirstSpirit verwendeten Web- und Applikationsserver benutzt.

Aufbau und Funktionsweise
Abbildung 1. Aufbau und Funktionsweise


1.3. Technische Voraussetzungen

Für den FormEdit-Einsatz müssen die folgenden technischen Voraussetzungen erfüllt sein:

  • das Modul FormEdit in der aktuellen Version
  • FirstSpirit (Isolated- oder Legacy-Mode) 5.2.191107 oder höher
  • einen aktuellen Servlet-Container

2. Installation und Konfiguration

Die Installation des Moduls FirstSpirit™ FormEdit erfolgt in drei Schritten:

2.1. Installieren des Moduls auf dem Server

Das Modul muss mithilfe der mitgelieferten fsm-Datei auf dem FirstSpirit-Server hinzugefügt werden. Öffnen Sie dafür den ServerManager und wählen Sie den Bereich Server-EigenschaftenModule.

Installation des Moduls auf dem FirstSpirit-Server
Abbildung 2. Installation des Moduls auf dem FirstSpirit-Server


Im Hauptchannel ist eine Liste aller auf dem FirstSpirit-Server installierten Module zu sehen. Wählen Sie nach dem Klicken auf Installieren die fsm-Datei aus und bestätigen Sie die Auswahl mit Öffnen. Nach der erfolgreichen Installation wird das Modul in der Liste angezeigt und muss Alle Rechte erhalten (vgl. Abbildung Installation des Moduls auf dem FirstSpirit-Server).

Bestandteile des Moduls FirstSpirit™ FormEdit sind die Projekt-Applikation FS FormEdit ProjectConfiguration, die Webanwendung FS FormEdit und die Bibliothek FS FormEdit Scripts.

Die Projekt-Applikation stellt Medien, Seiten-, Absatz-, Skript- und Tabellenvorlagen zur Verfügung, die zum Gestalten von Formularen verwendet werden können. Die Komponente ist Sichtbar für den Bereich Projekt. Damit handelt es sich um eine projekt-lokale Komponente. Diese kann nach der Installation den Projekt-Komponenten innerhalb der gewünschten Projekte zugefügt werden.

Die Webanwendung stellt Servlets zur Verfügung, die innerhalb des Projekts verwendet und aufgerufen werden können. Die Komponente ist Sichtbar für die Bereiche ProjektWeb. Damit handelt es sich um eine web-lokale Komponente. Diese kann nach der Installation den unterschiedlichen Web-Bereichen (preview, staging, live, ContentCreator) innerhalb der gewünschten Projekte zugefügt werden.

Die Bibliothek stellt die für die Skripte benötitgen Klassen zur Verfügung.

Nach jeder Installation oder Aktualisierung eines Moduls ist ein Neustart des FirstSpirit-Servers notwendig.

2.2. Installation und Konfiguration der Projekt-Komponente

Für den Einsatz des FirstSpirit™ FormEdit-Moduls ist eine projektspezifische Konfiguration notwendig. Diese wird über die Projekt-Komponente vorgenommen, die dem verwendeten Projekt hinzuzufügen ist. Öffnen Sie dafür den ServerManager und wählen Sie den Bereich Projekt-EigenschaftenProjekt-Komponenten.

Installation der Projekt-Komponente
Abbildung 3. Installation der Projekt-Komponente


Im Hauptpanel ist eine Liste aller bereits vorhandenen Projekt-Komponenten zu sehen. Wählen Sie nach dem Klicken auf Hinzufügen die FS FormEdit ProjectConfiguration und bestätigen Sie die Auswahl mit OK. Die Projekt-Komponente wird der Liste im Hauptpanel hinzugefügt und muss anschließend noch konfiguriert werden (vgl. Abbildung Installation der Projekt-Komponente). Selektieren Sie dafür den Eintrag in der Liste und öffnen Sie den zugehörigen Konfigurationsdialog über Konfigurieren (vgl. Abbildung Konfiguration der Projekt-Komponente).

Konfiguration der Projekt-Komponente
Abbildung 4. Konfiguration der Projekt-Komponente


Wählen Sie aus der Combobox Schema einen Datenbank-Layer und klicken Sie auf Templates importieren. In der Auswahlliste befinden sich alle für das Projekt zugelassenen Datenbank-Layer. Sollten Sie bisher keine Layer verwenden oder wünschen Sie für das Modul eine eigene Datenbank, wählen Sie den Eintrag Neuer Layer. Ist diese Option gewählt, wird ein neuer Layer erzeugt, der auf die FirstSpirit-interne Derby-Datenbank zeigt.

Weitere Informationen zu Datenbank-Layern finden Sie im FirstSpirit Dokumentation für Administratoren.

Nachdem Sie den Button Templates importieren angeklickt haben und den Dialog schließen, ist keine Änderung der Konfiguration mehr möglich. Ein erneutes Importieren ist nur mittels Löschen und erneutem Hinzufügen der Projekt-Komponente möglich.

2.3. Installation und Konfiguration der Web-Komponente

Zusätzlich zur Projekt-Komponente muss eine Web-Komponente hinzugefügt werden. Öffnen Sie hierfür den ServerManager und wählen Sie den Bereich Projekt-EigenschaftenWeb-Komponenten.

Installation der Webanwendung innerhalb der Web-Bereiche
Abbildung 5. Installation der Webanwendung innerhalb der Web-Bereiche


Innerhalb des Hauptpanels sind vier Registerkarten zu sehen, die jeweils eine Liste der bereits vorhandenen Web-Komponenten enthalten. Selektieren Sie nach dem Klicken auf Hinzufügen für jede der vier Registerkarten die FS FormEdit-Komponente und bestätigen Sie die Auswahl jeweils mit OK. Installieren Sie die Web-Komponente anschließend auf einem aktiven Webserver. Dieser kann über die Auswahlbox gewählt werden. Die Liste im Hauptpanel ist anschließend für alle vier Registerkarten um die Web-Komponente ergänzt.

Nach dem Hinzufügen zu einem Webbereich besteht die Möglichkeit, die Komponenten zu konfigurieren, entweder mit einer von der Komponente erzeugten web.xml oder einer generischen GUI (vgl. Abbildung Konfiguration der Webanwendung).

Konfiguration der Webanwendung
Abbildung 6. Konfiguration der Webanwendung


Für die Konfiguration stehen unterschiedliche Parameter zur Verfügung:

OK Redirect
In diesem Feld wird der Pfad zu der Datei angegeben, die nach erfolgreichem Versenden der Formulardaten angezeigt wird. Auf diesen Wert wird zurückgegriffen, falls im Formular keine spezielle Seite angegeben wurde (siehe Kapitel form-start). Über das Prefix redirect: bzw. forward: kann das Weiterleitungsverhalten beeinflusst werden. Der Wert forward:ok.jsp würde z.B. eine Weiterleitung mit allen Parametern auf die Seite ok.jsp erzeugen. Ist weder forward: noch redirect: angegeben, erfolgt immer ein Redirect.
Error Redirect
In diesem Feld wird der Pfad zu der Datei angegeben, die nach fehlerhaftem Versenden der Formulardaten angezeigt wird. Auf diesen Wert wird zurückgegriffen, falls im Formular keine spezielle Seite angegeben wurde (siehe Kapitel form-start). Über das Prefix redirect: bzw. forward: kann das Weiterleitungsverhalten beeinflusst werden. Der Wert forward:error.jsp würde z.B. eine Weiterleitung mit allen Parametern auf die Seite error.jsp erzeugen. Ist weder forward: noch redirect: angegeben, erfolgt immer ein Redirect.
Form Encoding
In diesem Feld wird das Encoding angegeben, welches zum Versenden der Formulardaten verwendet werden soll. Hierbei handelt es sich ebenfalls um einen Rückgriffswert, wenn in der Konfiguration einer Weiterverarbeitungskomponente kein Encoding angegeben wurde. Beispiele sind UTF-8 oder ISO-8859-1.

Achten Sie immer drauf, dass das gewählte Encoding mit dem verwendeten Encoding der generierten Seiten übereinstimmt (MetaTags bzw. Encoding der Sprache im ServerManager).

Path Prefix
In diesem Feld ist ein Prefix anzugeben, welches dem Pfad zur Mail-Vorlage vorangestellt wird, um diese verwenden zu können. Dieses Prefix beschreibt den Teilpfad zwischen dem WebApp-Root und dem von FirstSpirit erstellten Ordner. Für die Staging-Umgebung wäre dies beispielsweise die Auftrags-ID.
Loggers.ini Path

In diesem Feld muss der Pfad zur Konfigurationsdatei fs-formlogger.ini angegeben werden. Ist dieses Feld leer oder kann die Datei nicht gefunden werden, wird auf eine leere Konfigurationsdatei zurückgegriffen.

Beispiel Staging

2708/de/conf/fs-formlogger.ini

Dem Pfad für die Staging-Umgebung ist die Auftrags-ID – hier 2708 – vorangestellt.

Beispiel Live

de/conf/fs-formlogger.ini

Der hier anzugebende Pfad kann auch absolut angegeben werden. Dieses Beispiel sucht die Datei relativ zum WebAppRoot.

Captcha Width
In diesem Feld wird die Anzeigebreite der Captcha-Grafik in Pixel bestimmt. Ist dieses Feld leer, wird ein interner Rückgriffwert des Servlets benutzt: 100.
Captcha Height
In diesem Feld wird die Anzeigehöhe der Captcha-Grafik in Pixel bestimmt. Ist dieses Feld leer, wird ein interner Rückgriffwert des Servlets benutzt: 100.
Captcha Chars
In diesem Feld wird die Anzahl der Zeichen, die in der Captcha-Grafik angezeigt werden, angegeben. Ist dieses Feld leer, wird ein interner Rückgriffwert des Servlets benutzt: 6.

2.4. Liveserver-seitiges Logging

Das Modul FirstSpirit™ FormEdit kann zur einfacheren Fehleranalyse Logausgaben in eine entsprechende Logdatei ausgeben. Dazu wird auf das log4j2-Framework zurückgegriffen, weshalb dieses für die Webanwendung zunächst entsprechend eingerichtet werden muss, falls dies noch nicht der Fall ist. Dies geschieht durch Ablegen der log4j2-Konfigurationsdatei log4j2.properties ins Verzeichnis WEB-INFclasses. Falls dieses Verzeichnis noch nicht existiert, kann dies einfach manuell angelegt werden.

Eine beispielhafte log4j2-Konfigurationsdatei könnte folgendermaßen aussehen:

status = error
dest = err
name = PropertiesConfig

property.filename = target/rolling/rollingtest.log

filter.threshold.type = ThresholdFilter
filter.threshold.level = debug

appender.console.type = Console
appender.console.name = STDOUT
appender.console.layout.type = PatternLayout
appender.console.layout.pattern = %m%n
appender.console.filter.threshold.type = ThresholdFilter
appender.console.filter.threshold.level = error

appender.rolling.type = RollingFile
appender.rolling.name = RollingFile
appender.rolling.fileName = ${filename}
appender.rolling.filePattern = target/rolling2/test1-%d{MM-dd-yy-HH-mm-ss}-%i.log.gz
appender.rolling.layout.type = PatternLayout
appender.rolling.layout.pattern = %d %p %C{1.} [%t] %m%n
appender.rolling.policies.type = Policies
appender.rolling.policies.time.type = TimeBasedTriggeringPolicy
appender.rolling.policies.time.interval = 2
appender.rolling.policies.time.modulate = true
appender.rolling.policies.size.type = SizeBasedTriggeringPolicy
appender.rolling.policies.size.size=100MB
appender.rolling.strategy.type = DefaultRolloverStrategy
appender.rolling.strategy.max = 5

logger.rolling.name = de.espirit.firstspirit.opt.formedit
logger.rolling.level = debug
logger.rolling.additivity = false
logger.rolling.appenderRef.rolling.ref = RollingFile

rootLogger.level = info
rootLogger.appenderRef.stdout.ref = STDOUT

Es ist zu beachten, dass abhängig von der Konfiguration auch Logausgaben aus anderen Modulen in der Logdatei auftauchen können.

3. Konfiguration des FirstSpirit-Projekts

Für diesen Abschnitt werden Kenntnisse im Umgang mit FirstSpirit im Bereich Datenquellen vorausgesetzt.

Die verschiedenen Weiterverarbeitungsmöglichkeiten der Formulardaten werden durch sogenannte Logger im Projekt konfiguriert. Jedem Logger wird ein bestimmter Weiterverarbeitungstyp (z.B. MailLogger) zugeordnet und mit entsprechenden Parametern versehen. Die verschiedenen Logger werden als Datensätze in einer Datenquelle gepflegt. Anhand der Logger-Konfiguration wird bei der Generierung die Logger-Konfigurationsdatei fs-formlogger.ini erzeugt. Das dazu notwendige Datenbankschema und die nötigen Tabellenvorlagen werden bei Installation der Projektkomponente erzeugt. Um Logger anlegen zu können, muss nur noch eine Datenquelle für die Tabellenvorlage form_edit.formLogger erstellt werden. Informationen zu den Logger-Typen und deren Konfigurationsmöglichkeiten finden Sie im Kapitel Logger-Konfiguration der Weiterverarbeitung.

Bitte beachten Sie, dass Sie das Mapping innerhalb der Tabellenvorlage form_edit.formLogger noch für die fehlenden Sprachen setzen. (Im Auslieferungszustand ist nur die Sprache Deutsch gemapped.) Für die sprachabhängige Spalte formLogger_description sollten weitere Spalten mit _<Sprachkürzel> angelegt werden.

3.1. Anlegen der Logger

Öffnen Sie das Projekt im SiteArchitect. Nun gibt es zum Anlegen oder Bearbeiten der Logger zwei Möglichkeiten:

  • direkt über die Datenquellen (Datenquelle: FormLogger) in der Datenquellen-Verwaltung

    Neuer Datensatz (Datenquellen)
    Abbildung 7. Neuer Datensatz (Datenquellen)


  • aus dem Absatz form-start heraus

    Neuer Datensatz (form-start)
    Abbildung 8. Neuer Datensatz (form-start)


Nach einem Klick auf den Button Neuer Eintrag in der Datenquellenansicht oder in der Eingabekomponente innerhalb des formstart-Absatzes wird folgendes Formular geöffnet:

Anlegen der Logger
Abbildung 9. Anlegen der Logger


In diesem Formular werden alle logger-spezifischen Daten erfasst:

Logger Name
Hier kann der Logger mit einem Namen versehen werden. Der Name wird innerhalb der Konfigurationsdatei als Referenzname verwendet. Der Name darf keine Leer- oder Sonderzeichen enthalten und muss projektweit eindeutig sein.
Logger Typ

Der Logger Typ wird für die Erstellung der Logger-Konfigurationsdatei fs-formlogger.ini benötigt. Folgende Logger-Typen stehen zur Verfügung:

Beschreibung
In diesem Feld kann eine kurze Beschreibung eingegeben werden, um den Logger später einfacher zuordnen zu können. Die Eingabe ist optional und nimmt keinen Einfluss auf die Funktion des Loggers.
Logger Parameter

Hier können die logger-spezifischen Konfigurationsparameter festgelegt werden. Bei einem Eintrag ist zwischen drei Vorlagen zu wählen:

  • logger-text-value

    Diese Vorlage wird bis auf eine Ausnahme – die Auswahl der Mail-Vorlage – für alle Parameter verwendet.
  • formLoggerPassword

    Diese Vorlage kann für Parameter verwendet werden, deren Inhalt in FirstSpirit nicht sichtbar sein soll.
  • logger-template-ref

    Diese Vorlage wird ausgewählt, wenn eine Mail-Vorlage für den MailLogger bzw. MailUploadLogger aus der Struktur gewählt werden soll. Die Parameter, die hier verwendet werden können, werden im nachfolgenden Kapitel erläutert.

    Parameter hinzufügen
    Abbildung 10. Parameter hinzufügen


Default-Logger
Über diese Radio-Buttons kann ein Logger als default-Logger markiert werden. Ist ein oder mehrere Default-Logger vorhanden, werden diese auch für Formulare benutzt, denen, z.B. durch ein Konfigurationsfehler, kein Logger zugeordnet werden kann.
Status
Über diese Radio-Buttons kann ein Logger aktiv bzw. inaktiv geschaltet werden. Nur aktive Logger können in einem Formular als Weiterverarbeitungsmöglichkeit ausgewählt werden.

3.2. Logger-Konfiguration der Weiterverarbeitung

Jedem Logger wird ein bestimmter Weiterverarbeitungstyp (z.B. MailLogger) zugeordnet und mit entsprechenden Parametern versehen. Die verschiedenen Logger werden als Datensätze in einer Datenquelle gepflegt. Anhand der Logger-Konfiguration wird bei der Generierung die Logger-Konfigurationsdatei fs-formlogger.ini erzeugt.

Konfiguration der Log-File-Weiterverarbeitung

Aufgabe
Ausgabe der Formulardaten in das Log-File der Servlet-Engine
Parameter (Parametername, erwarteter Wert)
  • class: de.espirit.firstspirit.opt.formedit.ConsoleLogger
  • prefix: der Log-Ausgabe vorangestellter Text
Beispiel
Parameter ConsoleLogger
Abbildung 11. Parameter ConsoleLogger


Anmerkung
  • class: Dieser Parameter wird automatisch erzeugt und muss nicht angelegt werden.

Konfiguration der CSV-Weiterverarbeitung

Aufgabe
Ausgabe der Formulardaten in eine CSV-Datei
Parameter (Parametername, erwarteter Wert)
  • class: de.espirit.firstspirit.opt.formedit.CSVLogger
  • logFile: (absoluter) Pfad zur CSV-Datei
  • encoding: Encoding für das Versenden der E-Mail, z.B. UTF-8
Beispiel
Parameter CSVLogger
Abbildung 12. Parameter CSVLogger


Anmerkungen
  • class: Dieser Parameter wird automatisch erzeugt und muss nicht angelegt werden.
  • logFile: Die Pfadangabe kann absolut oder relativ zur Webanwendung erfolgen. (Die angegebene Datei muss manuell angelegt werden.)
  • encoding: Wird dieser Parameter nicht angegeben, wird der Standardwert aus der Konfiguration der Webanwendung genutzt.

Konfiguration der Datenbank-Weiterverarbeitung

Aufgabe
Ausgabe der Formulardaten in eine (per JDBC angebundene) Datenbank

Im Gegensatz zu den „einfachen“ CSV- und Log-File-Loggern verfügt der JdbcLogger über einige Parameter mehr. Folgende Hauptaspekte können konfiguriert werden:
JDBC-Parameter (Parametername, erwarteter Wert)
  • class: de.espirit.firstspirit.opt.formedit.JdbcLogger
  • driver: JDBC-Treiber z.B. org.gjt.mm.mysql.Driver
  • user: Datenbank-Benutzer, z.B. cms
  • password: Passwort des Datenbankbenutzers
  • url: JDBC-URL zur Datenbank z.B. jdbc:mysql://localhost:3306/logging
  • table: Der Name der Tabelle in der Datenbank, in die geloggt werden soll.
Beispiel
Parameter JdbcLogger
Abbildung 13. Parameter JdbcLogger


Anmerkungen
  • class: Dieser Parameter wird automatisch erzeugt und muss nicht angelegt werden.
Abbildungsregeln

Für jeden Formular-Parameter kann definiert werden, in welche Tabellen-Spalte dieser eingefügt werden soll. Erfolgt keine explizite Zuweisung, so wird versucht, den Parameternamen als Spaltennamen zu verwenden. Schlägt auch dies fehl, so erfolgt nur ein Eintrag in unmappedColumn (siehe unten, Punkt Weitere Parameter).

Hier gilt folgendes Schema:

  • formularparameter: eindeutiger Bezeichner des Formularelements
  • spaltenname: Der Name der Spalte, in die der Wert geschrieben werden soll.

    Parameter JdbcLogger Mapping
    Abbildung 14. Parameter JdbcLogger Mapping


    Der Wert des Formularelements anschrift1 soll in der Datenbank in das Feld strasse geschrieben werden.

weitere Parameter (Parametername, erwarteter Wert)

Zusätzlich zu den Mapping-Regeln können folgende Sonderregeln angegeben werden:

  • csvColumn: Der Name der Tabellenspalte, in die der komplette Formulardatensatz in CSV-Form eingetragen wird.
  • unmappedColumn: Der Name der Tabellenspalte, in die alle nicht durch Mapping Regeln verarbeiteten Formulardaten in CSV-Form eingetragen werden.
  • timestampColumn: Der Name der Tabellenspalte, in der Datum und Uhrzeit des Request-Eingangs im Timestamp-Format gespeichert werden.

Konfiguration der E-Mail-Weiterverarbeitung

Aufgabe

Ausgabe der Formulardaten in Form einer (per Datei konfigurierbaren) E-Mail (optional auch mit Dateianhang)

Der E-Mail-Logger dient zum Versand der Formulardaten per E-Mail. Für jedes Formular wird eine separate E-Mail versandt. Das Format bzw. der Text der E-Mail kann in einer (separaten) Datei konfiguriert werden. Aufgrund der formularspezifischen Logger-Konfiguration kann bei Bedarf jedem Formular eine eigene E-Mail-Konfigurationsdatei zugeordnet werden.

Parameter
  • class: de.espirit.firstspirit.opt.formedit.MailLogger oder de.espirit.firstspirit.opt.formedit.MailUploadLogger
  • smtpHost: Name des E-Mail-Servers
  • sender: E-Mail-Adresse des Absenders
  • mailTemplatePath: (absoluter) Pfad zur E-Mail-Konfigurationsdatei
  • encoding: Encoding für das Versenden der E-Mail
  • smtpAuth: (optional) true, wenn der smtp-Server eine Authentifizierung (smtpAuth) benötigt
  • smtpAuthUser: Name des Benutzers für die Authentifizierung
  • smtpAuthPassword: Passwort für die Authentifizierung
Beispiel
Parameter MailLogger
Abbildung 15. Parameter MailLogger


Anmerkungen
  • class: Dieser Parameter wird automatisch erzeugt und muss nicht angelegt werden.
  • smtpHost: Der Hostname des Mail-Servers.
  • sender: Die Adresse, die als Absender eingetragen wird.
  • mailTemplatePath: Als Vorlage sollte hier logger-template-ref gewählt werden. Mit dieser kann die Vorlage aus der Struktur gewählt werden.
  • encoding: Wird dieser Parameter nicht angegeben, wird der Standardwert aus der Konfiguration der Webapplikation genutzt.
  • smtpAuthUser/smtpAuthPassword: Ist der Parameter smtpAuth mit dem Wert true gesetzt, sind diese Parameter Pflichtparameter und müssen angegeben werden. Als Vorlage kann hier logger-text-password gewählt werden, um die Daten verdeckt anzuzeigen.

Konfiguration der URL-Weiterverarbeitung

Aufgabe

URL-Aufruf mit Parameterübergabe an eine andere Seite

Der URL-Logger dient zum Aufrufen einer anderen Seite (URL) mit der Möglichkeit, definierte Parameter des Formulars zu übergeben. Der Anwender ruft diese Seite allerdings nicht in seinem Browser auf. Ein klassischer Anwendungsfall ist z.B. Tracking.

Parameter
  • class: de.espirit.firstspirit.opt.formedit.URLLogger
  • url.sendWithOutParams: Übergabe von Parametern (true/false)
  • url.urlPrefix: Ziel-URL (z.B. http://myserver.com/tracking.jsp)
  • url.param.<bezeichner>: eindeutiger Bezeichner der Formular-Komponente

    Ähnlich wie bei dem JdbcLogger ist es nötig, die Parameter des Formulars auf neue Parameter zu mappen. Beim URLLogger werden nur die Parameter an das UrlPrefix angehängt, die auch in der Konfiguration angegeben wurden. Werden keine URL-Parameter konfiguriert, so werden alle Parameter des Formulars an die URL angehängt.

Beispiel
Parameter URLLogger
Abbildung 16. Parameter URLLogger


Anmerkungen
  • class: Dieser Parameter wird automatisch erzeugt und muss nicht angelegt werden.
  • url.param.<param>: Der Ausdruck <param> definiert den Parameternamen, wie er an die URL angehängt werden soll.

3.3. E-Mail-Konfigurationsdatei

Aufgabe

Über die Seitenvorlage mailtemplate wird die zu versendende E-Mail konfiguriert. Die Oberfläche ähnelt der eines E-Mail-Programms.

Mail-Vorlage (Kopf)
Abbildung 17. Mail-Vorlage (Kopf)


Empfänger, Cc, Bcc
Hier können eine oder mehrere Empfänger E-Mail-Adressen angegeben werden. Bei Verwendung von mehreren Adressen sind diese durch ein Semikolon (;) zu trennen.
Reply-To
Hier kann eine Antwort-E-Mail-Adresse eingegeben werden. Diese wird benutzt, wenn der Anwender in seinem E-Mail-Programm auf Antworten klickt.
Sender
Hier kann eine E-Mail-Adresse definiert werden, die als Absender angezeigt wird. Alternativ kann aber auch über %parameter% (hier: %email%) auf ein Formularelement zurückgegriffen werden, das eine gültige E-Mail-Adresse enthält. Wird hier ein Wert angegeben, wird der in der Logger-Konfiguration angegebene Wert sender überschrieben.
Betreff
Hier kann der Betreff der zu versendenden E-Mail angegeben werden.
Upload Attachments

Hier können die Dateianhänge konfiguriert werden. Dies kann zum einen über %parameter% geschehen oder über %all%.

  • %parameter%

    Bei der Angabe dieses Parameters wird nur die Datei an die E-Mail angehängt, die über das Formularelement mit dem Bezeichner parameter übertragen wurden. Mehrere Dateien müssen mit Komma (,) getrennt werden.

    Beispiel: %lebenslauf%,%foto%
  • %all%

    Bei der Eingabe werden alle mit dem Formular abgesendeten Dateien an die E-Mail angehängt.
Text

Nach den für den E-Mail-Header benötigten Angaben folgt dann der Text der E-Mail. Dieser Text kann Platzhalter der Form %name% enthalten, mit deren Hilfe auf Werte aus dem Formular zugegriffen werden kann.

Folgende Parameter stehen zur Verfügung:

  • %date%

    Datum der Formular-Absendung
  • %time%

    Uhrzeit der Formular-Absendung
  • %csv%

    Liste alle Formularparameter als CSV
  • %unmapped%

    Liste aller nicht bearbeiteten Formularparameter als CSV (s.u.)

    Zusätzlich zu diesen Parametern kann auf jeden Formular-Parameter zugegriffen werden. Dazu wird die %-Notation und der Parameter-Name verwendet: %parameter%

    Formulardaten, die zwar gesendet wurden, allerdings nicht in der Mail-Vorlage über %-Notation ausgegeben wurden, können über den Parameter %unmapped% ausgegeben werden.

    Bei der Angabe von E-Mail-Adressen ist darauf zu achten, dass diese im Benutzernamen keine Umlaute enthalten dürfen. Umlaute im Domainnamen hingegen sind erlaubt.

Mail-Vorlage (Nachrichtenteil)
Abbildung 18. Mail-Vorlage (Nachrichtenteil)


Server Attachments

Über einen FS_CATALOG in einer Seite vom Typ mailtemplate kann der Redakteur Dateien auswählen, die automatisch mit einer Mail versendet werden. Ein Szenario wäre beispielsweise eine Anmeldung, die über ein Formular erfolgt. Als Antwort könnte dann eine Bestätigungs-Mail versendet werden, die beispielsweise AGBs enthält oder ähnliches. Diese ABGs könnten vorher in den FS_CATALOG eingepflegt werden.

Zur Auswahl der Dateiordner muss das Linktemplate der FS_CATALOG-Elemente angepasst werden. Hierbei muss für die FS_REFERENCE-Komponente der Ordner angegeben werden, aus dem gewählt werden soll, z.B. würde <FOLDER name=“root“ …> eine Auswahl aller Medien in der Medienverwaltung erlauben.

Weiter müssen unter Globale EinstellungenProjekteinstellungen folgende Variablen als Textfelder (CMS_INPUT_TEXT) definiert werden. Sie werden in der Linkvorlage im html-Kanal genutzt.

  • ps_webappContentPath: Pfad zu Webanwendung
  • ps_webappContentFolder: Der Ordner innerhalb ps_webappContentPath, in den deployt wird.

3.4. Autocompleterequest

Bei dieser Seitenvorlage handelt es sich um eine funktionsfähige Beispiel-Vorlage. Es ist auch möglich, Daten gegen eine Datenbank oder ähnliches zu prüfen.

Diese Datei ist nicht allgemein gültig und muss projektspezifisch angepasst werden, sofern es sich bei der Quelle nicht um eine XML-Datei handelt. Weitere Informationen siehe Kapitel Konzept Autovervollständigung.

Aufgabe

Diese Seitenvorlage dient zur Verarbeitung einer Eingabequelle wie z.B. XML. Bei einer Eingabe des Benutzers in ein Autovervollständigen-Formularfeld wird die in dieser Seite angegebene Quelle durchsucht und die Ergebnisse dem Benutzer eingeblendet.

Autocompleterequest
Abbildung 19. Autocompleterequest


Vergleichsattribut
Hier wird das Attribut innerhalb der XML-Quelldatei angegeben, welches mit den Eingaben des Nutzers verglichen werden soll.
Rückgabe Text
Hier kann definiert werden, welches Attribut der XML-Quelldatei dem Benutzer als Rückgabewert angezeigt werden soll.
XML Quelle
Hier muss die XML-Quelldatei ausgewählt werden, die die Ergebnisse bereitstellen soll.

3.5. Konfigurationsdatei fs-formlogger.ini

Diese Konfigurationsdatei beinhaltet alle Informationen ihrer Formulare bzw. die Zuordnung zu den Weiterverarbeitungskonfigurationen und diese selbst. Der Inhalt dieser Datei wird generisch von FirstSpirit bei der Generierung erzeugt.

Damit diese Datei richtig erzeugt werden kann, muss in der Inhalte-Verwaltung eine Seite auf Basis der Vorlage logger-ini-file erstellt werden. In diese Seite muss die UID der form start-Vorlage bzw. den von Ihnen erzeugten Vorlagen, die die Funktion der form start-Vorlage erfüllen, eingetragen werden. Die UID wird mit dem Tastaturkürzel ALT + P bei selektierter Absatzvorlage angezeigt. Außerdem ist ebenfalls die UID der Datenquelle anzugeben, die die Logger-Konfiguration enthält.

Seite fs-formlogger.ini
Abbildung 20. Seite fs-formlogger.ini


Bei der Referenzierung in der Struktur ist zu beachten, dass die Datei an der Stelle abgelegt ist, die bei der Konfiguration der Webkomponente angegeben wurde. Weiterhin ist der Dateiname der Seite in der Strukturverwaltung richtig zu setzen. Innerhalb dieses Dokuments wird der Name fs-formlogger verwendet:

Dateiname der Konfigurationsdatei
Abbildung 21. Dateiname der Konfigurationsdatei


Darüber hinaus werden in der fs-formlogger.ini die Konfigurationen der im Projekt erstellten FormEdit-Formulare persistiert, so dass diese auf dem Live-Server ausgelesen werden können. Dies hat zur Folge, dass nach Änderungen an der Formularkonfiguration (form_start-Absatz) und anschließendem Deployment, die Webapplikation neu gestartet werden muss, damit das Servlet die neue Konfiguration einlesen kann.

4. Formularerstellung

Um die Funktionalität eines Formulars zu gewährleisten, muss eine bestimmte Reihenfolge der Absatzvorlagen bei der Erstellung des Formulars eingehalten werden. Die Absatzvorlage form-start markiert immer den Anfang und die Absatzvorlage form-end immer das Ende eines Formulars. Innerhalb dieser beiden Absätze können beliebig viele Absätze der Typen form-block und form-divider auftreten.

Formularvorlagen
Abbildung 22. Formularvorlagen


Innerhalb eines form-block-Elements können beliebig viele Formular-Elemente enthalten sein.

Die Absatzvorlagen des Formular-Editors stellen alle in HTML vorhandenen Formular-Elemente zur Verfügung und geben außerdem ausreichende Möglichkeiten, die Komponenten zu konfigurieren. Für die Verwendung der Komponenten muss zuvor eine Anpassung an spezifische Designvorgaben erfolgen. Dies kann einerseits durch die direkte Anpassung des HTML-Codes in den Absatzvorlagen und/oder durch die Definition von Cascading Style Sheets in der eingebundenen Stylesheet-Datei geschehen. Jeder Formular-Komponente kann individuell eine Stylesheet-Klasse zugewiesen werden.

4.1. form-start

Die Absatzvorlage form-start leitet ein neues Formular ein. Hier können grundlegende Konfigurationen vorgenommen werden, die ausschließlich dieses Formular betreffen.

Formularüberschrift (Text)
Darstellung der Überschrift des Formulars
Formularname (Text)

Eindeutiger Bezeichner für das Formular (name-Attribut des form-Elementes)

Dieser Bezeichner darf weder Leerzeichen noch Sonderzeichen enthalten, da der Formularname als Teil des Servletaufrufs verwendet wird.

Weiterverarbeitung (ContentList)
Auswahl und Anzeige der Logger für dieses Formular
alternative Formularauswertungsseite (Seitenreferenz)
Wenn kein Logger gewünscht ist, kann hier optional eine Formular-Auswertungsseite angegeben werden.
Captcha Validierung (Checkbox)
Aktivierung der serverseitigen Captcha-Validierung

Ist diese Checkbox aktiviert, muss das Formular das Formelement Captcha beinhalten.
Clientseitige Inhaltsüberprüfung (Checkbox)
Aktivierung der clientseitigen Inhaltsüberprüfung
Bestätigungsseite (optional, Seitenreferenz)
Diese formularspezifische Bestätigungsseite wird angezeigt, wenn die E-Mail erfolgreich versendet wurde. Wird hier eine Seite ausgewählt, wird die globale Konfiguration in der web.xml überschrieben.
Fehlerseite (optional, Seitenreferenz)
Diese formularspezifische Bestätigungsseite wird angezeigt, wenn die E-Mail nicht erfolgreich versendet wurde. Wird hier eine Seite ausgewählt, wird die globale Konfiguration in der web.xml überschrieben.
Captcha ungültig (optional, Seitenreferenz)
Diese formularspezifische Seite wird angezeigt, wenn der Anwender keine oder eine falsche Eingabe tätigt. Wird hier keine Seite ausgewählt, wird stattdessen die Fehlerseite (s. o.) angezeigt.
Sendemethode (RadioButton)
Mit dieser Komponente legen Sie den Übertragungsmodus der Formularwerte fest.

Vorbelegung: POST
Fileupload (Checkbox)
Wenn diese Option gesetzt ist, können Dateien über das Formular an den Webserver übergeben werden.
form-start Absatz
Abbildung 23. form-start Absatz


4.2. form-block

Innerhalb eines form-block-Elements können beliebig viele Formular-Elemente angelegt werden. Dabei ist die Reihenfolge der Komponenten unerheblich für die Funktionalität des Formulars. Jede Komponente kann individuell konfiguriert werden. So können beispielsweise Stylesheet-Klassen verwendet und die Anzeige-Breite und Anzeige-Höhe des Formulars definiert werden. Genaue Informationen und Konfigurationsanleitungen finden sich im Kapitel Verfügbare Formular-Elemente.

form-block Absatz
Abbildung 24. form-block Absatz


4.3. form-divider

Das Element form-divider erzeugt eine grafische Trennung innerhalb des Formulars und bietet ansonsten keine Funktionalität.

4.4. form-end

Die Absatzvorlage form-end definiert das Ende des Formulars.

Hinweis für Pflichtfelder
Hier kann ein Hinweis für Pflichtfelder angeben werden, der unterhalb der Formularfelder angezeigt wird.
Beschriftung für den Submit-/Reset-Button
Geben Sie die Bezeichnung für den Button ein, mit dem die Formulardaten abgeschickt bzw. alle Eingaben des Formulars gelöscht werden. Werden hier keine Eingaben vorgenommen, wird kein Button generiert.
Stylesheet-Klasse für Buttons (optional)
Hier können Sie den Namen einer Stylesheet-Klasse für das Design der Buttons angeben. Wird keine Klasse angegeben, so werden die Buttons im Standard-Look-and-Feel des Browsers bzw. Ihrer Stylesheet-Datei angezeigt.
form-end Absatz
Abbildung 25. form-end Absatz


4.5. Verfügbare Formular-Elemente

Der Formular-Editor ermöglicht es dem Redakteur, das komplette Set an HTML-Formular-Elementen zu verwenden. Wie bereits erwähnt, empfiehlt es sich vor der Verwendung der Komponenten, eine Anpassung im HTML-Quellcode im Zusammenspiel mit der Stylesheet-Datei vorzunehmen. So können individuelle Designvorlagen eingehalten werden und stehen an jeder Stelle der Webseite zur Verfügung. Die HTML-Tags der Formular-Elemente sollten aber von Änderungen unberührt bleiben, um die korrekte Funktionalität des JavaScript-Checks zu gewährleisten.

Die Formular-Komponenten können nur in der Absatzvorlage form-block verwendet werden!

Um ein neues Formular-Element hinzuzufügen, wählen Sie einen bereits erstellten Absatz des Typs form-block aus und fügen der Content-Area-List ein neues Formular-Element hinzu:

Formular-Elemente
Abbildung 26. Formular-Elemente


Im Folgenden finden Sie eine Übersicht über die verfügbaren Standard-Elemente und deren Konfigurationsmöglichkeiten und Funktionen.

Über den eindeutigen Bezeichner bzw. den eindeutigen Gruppenbezeichner kann später auf den Inhalt des Formularfelds zugegriffen werden. Wenn z.B. ein Mail- / MailUploadLogger benutzt wird, geschieht das über %eindeutigerBezeichner%.

4.5.1. Formular-Komponente Text

Diese Komponente stellt dem Benutzer ein Formular-Textfeld zur Verfügung. Damit die Auswertung des Formulars und auch die Inhaltsüberprüfung ordnungsgemäß funktionieren kann, muss der Komponente ein in diesem Formular eindeutiger Bezeichner (name-Attribut) zugewiesen werden.

Beschriftung
In dieses Textfeld wird der Titel des Formularfeldes eingegeben.
Eindeutiger Bezeichner (name-Attribut)
In dieses Textfeld wird der eindeutige Bezeichner eingetragen.
Vorbelegung (value-Attribut)
In dieses Textfeld kann Text eingegeben werden, mit dem das Formularfeld gefüllt ist.
Bearbeitung zulassen (readonly-Attribut)
Über diese Radiobuttons wird gesteuert, ob der Benutzer das Formularfeld bearbeiten darf.
Inhaltsprüfung (gefüllt bzw. gültiger Wert)
Über diese Radiobuttons kann eine Prüfung erstellt werden, die auf Inhalt bzw. auf gültige Daten prüft.
Anzahl Zeichen (maxlength-Attribut)
Mithilfe dieses Textfelds kann die Anzahl der Zeichen definiert werden, die maximal eingegeben werden darf.
Anzeigebreite
In diesem Feld kann die Breite des Formularfeldes in Pixel angegeben werden.
Anzeigehöhe
In diesem Feld kann die Höhe des Formularfeldes in Pixel angegeben werden.
Stylesheet-Klasse (class-Attribut)
In dieses Textfeld kann der Name einer CSS-Klasse eingegeben werden.
Formular-Komponente Text
Abbildung 27. Formular-Komponente Text


4.5.2. Formular-Komponente Textarea

Die Formular-Komponente Textarea stellt dem Benutzer ein mehrzeiliges Texteingabefeld zur Verfügung. Damit die Auswertung des Formulars und auch die Inhaltsüberprüfung ordnungsgemäß funktionieren kann, muss der Komponente ein in diesem Formular eindeutiger Bezeichner (name-Attribut) zugewiesen werden.

Beschriftung
In dieses Textfeld wird der Titel des Formularfeldes eingegeben.
Eindeutiger Bezeichner (name-Attribut)
In dieses Textfeld wird der eindeutige Bezeichner eingetragen.
Vorbelegung (value-Attribut)
In dieses Textfeld kann Text eingegeben werden, mit dem das Formularfeld gefüllt ist.
Bearbeitung zulassen (readonly-Attribut)
Über diese Radiobuttons wird gesteuert, ob der Benutzer das Formularfeld bearbeiten darf.
Inhaltsprüfung (gefüllt bzw. gültiger Wert)
Über diese Radiobuttons kann eine Prüfung erstellt werden, die auf Inhalt bzw. auf gültige Daten prüft.
Anzeigebreite
In diesem Feld kann die Breite des Formularfeldes in Pixel angegeben werden.
Anzeigehöhe
In diesem Feld kann die Höhe des Formularfeldes in Pixel angegeben werden.
Stylesheet-Klasse (class-Attribut)
In diesem Textfeld kann der Name einer CSS-Klasse angegeben werden.
Formular-Komponente Textarea
Abbildung 28. Formular-Komponente Textarea


4.5.3. Formular-Komponente RadioButtons

Mit dieser Formular-Komponente können HTML-Radiobuttons erzeugt werden. Beim Hinzufügen der Radiobuttons im Bereich Optionen sollte darauf geachtet werden, dass für jeden Radiobutton eine aussagekräftige Vorbelegung angegeben wird. Die Radiobuttons werden nacheinander mit der entsprechenden Bezeichnung (Beschriftung) auf der rechten Seite der Komponente dargestellt.

Teilkomponente RadioButtons

Diese Komponente kann innerhalb eines form-block-Absatzes eingefügt werden. In diesem Absatz werden die für alle Radiobuttons gleichen Werte gesetzt. Das Hinzufügen der eigentlichen RadioButtons erfolgt innerhalb einer ContentAreaList in diesem Absatz.

Beschriftung
In dieses Textfeld wird der Titel des Formularfeldes eingegeben.
Gruppenbezeichner (name-Attribut)
In dieses Textfeld wird der eindeutige Bezeichner eingetragen.
Inhaltsprüfung (gefüllt)
Über diese Radiobuttons kann eine Prüfung erstellt werden, die prüft, ob ein Eintrag ausgewählt wurde.
Pflichtfeldhinweis
Für diesen Formularfeldtyp muss eine Meldung angegeben werden, die erscheint, wenn die Inhaltsprüfung fehlgeschlagen ist.
Stylesheet-Klasse (class-Attribut)
In dieses Textfeld kann der Name einer CSS-Klasse eingegeben werden.
Formular-Komponente RadioButtons
Abbildung 29. Formular-Komponente RadioButtons


Teilkomponente RadioButton

Diese Komponente kann ausschließlich innerhalb der Formular-Komponente RadioButtons verwendet werden. Sie dient dazu, die eigentlichen RadioButtons innerhalb der o.g. Komponente hinzuzufügen.

Beschriftung
In diesem Textfeld wird die Beschriftung der Option eingegeben.
Wert (value-Attribut)
In diesem Textfeld kann der Wert dieser Option angegeben werden.
Vorauswahl (checked-Attribut)
Über diese Radiobuttons kann eine Vorauswahl getroffen werden, ob dieses Formularfeld ausgewählt sein soll.
Stylesheet-Klasse (class-Attribut)
In diesem Textfeld kann der Name einer CSS-Klasse eingegeben werden.
Formular-Komponente RadioButton
Abbildung 30. Formular-Komponente RadioButton


4.5.4. Formular-Komponente Checkboxes

Mit dieser Formular-Komponente können HTML-Checkboxen erzeugt werden. Beim Hinzufügen der Checkboxen im Bereich Optionen sollte darauf geachtet werden, dass für jede Checkbox ein aussagekräftiger Wert angegeben wird. Die Checkboxen werden nacheinander mit der entsprechenden Bezeichnung (Beschriftung) auf der rechten Seite der Komponente dargestellt.

Teilkomponente Checkboxes

Diese Komponente kann innerhalb eines form-block-Absatzes eingefügt werden. In diesem Absatz werden die für alle Checkboxes gleichen Werte gesetzt. Das Hinzufügen der eigentlichen Checkboxen erfolgt innerhalb einer ContentAreaList in diesem Absatz.

Beschriftung
In diesem Textfeld wird der Titel des Formularfeldes eingegeben.
Gruppenbezeichner (name-Attribut)
In diesem Textfeld wird der eindeutige Bezeichner eingetragen.
Inhaltsüberprüfung (gefüllt)
Über diese Radiobuttons kann eine Prüfung erstellt werden, die prüft, ob mindestens eine Checkbox dieser Gruppe ausgewählt wurde.
Pflichtfeldhinweis
Für diesen Formularfeldtyp muss eine Meldung angegeben werden, die erscheint, wenn die Inhaltsprüfung fehlgeschlagen ist.
Stylesheet-Klasse (class-Attribut)
In diesem Textfeld kann der Name einer CSS-Klasse eingegeben werden.
Formular-Komponente Checkboxes
Abbildung 31. Formular-Komponente Checkboxes


Teilkomponente Checkbox

Diese Komponente kann ausschließlich innerhalb der Formularkomponente Checkboxes verwendet werden. Sie dient dazu, die eigentlichen Checkboxen innerhalb der o.g. Komponente hinzuzufügen.

Beschriftung
In diesem Textfeld wird die Beschriftung der Option eingegeben.
Wert (value-Attribut)
In diesem Textfeld kann der Wert dieser Option angegeben werden.
Vorauswahl (checked-Attribut)
Über diese Radiobuttons kann eine Vorauswahl getroffen werden, ob diese Checkbox ausgewählt sein soll.
Stylesheet-Klasse (class-Attribut)
In diesem Textfeld kann der Name einer CSS-Klasse eingegeben werden.
Formular-Komponente Checkbox
Abbildung 32. Formular-Komponente Checkbox


4.5.5. Formular-Komponente Password

Mit dieser Komponente kann dem Benutzer ein Passwortfeld zur Verfügung gestellt werden. Auch hier muss der Redakteur einen eindeutigen Bezeichner für die Komponente vergeben. Die Eingabe von Zeichen wird in der Komponente als * dargestellt.

Beschriftung
In dieses Textfeld wird der Titel des Formularfeldes eingegeben.
Eindeutiger Bezeichner (name-Attribut)
In dieses Textfeld wird der eindeutige Bezeichner eingetragen.
Vorbelegung (value-Attribut)
In dieses Textfeld kann Text eingegeben werden, mit dem das Formularfeld gefüllt ist.
Bearbeitung zulassen (readonly-Attribut)
Über diese Radiobuttons wird gesteuert, ob der Benutzer das Formularfeld bearbeiten darf.
Anzahl Zeichen (maxlength-Attribut)
Mithilfe dieses Textfelds kann die Anzahl der Zeichen definiert werden, die maximal eingegeben werden darf.
Anzeigebreite
In diesem Feld kann die Breite des Formularfeldes in Pixel angegeben werden.
Anzeigehöhe
In diesem Feld kann die Höhe des Formularfeldes in Pixel angegeben werden.
Stylesheet-Klasse (class-Attribut)
In diesem Textfeld kann der Name einer CSS-Klasse eingegeben werden
Formular-Komponente Password
Abbildung 33. Formular-Komponente Password


4.5.6. Formular-Komponente Hidden

Mit dieser Formular-Komponente können Felder angelegt werden, die im Browser nicht angezeigt werden, aber im Servlet oder PHP-Skript ausgewertet werden können, d.h. zusätzliche nicht sichtbare Angaben. Auch hier muss der Redakteur einen eindeutigen Bezeichner für die Komponente vergeben.

Eindeutiger Bezeichner (name-Attribut)
In diesem Textfeld wird der eindeutige Bezeichner eingetragen.
Vorbelegung (value-Attribut)
In diesem Textfeld kann Text eingegeben werden, mit dem das Formularfeld gefüllt ist.
Formular-Komponente Hidden
Abbildung 34. Formular-Komponente Hidden


4.5.7. Formular-Komponente Autocompleter

Mit dieser Formular-Komponente kann dem Benutzer die Komfortabilität geboten werden, dass ihm während seiner Eingabe Vorschläge zur Vervollständigung gemacht werden. Auch hier muss der Redakteur einen eindeutigen Bezeichner für die Komponente vergeben.

Beschriftung
In diesem Textfeld wird der Titel des Formularfeldes eingegeben.
Eindeutiger Bezeichner (name-Attribut)
In diesem Textfeld wird der eindeutige Bezeichner eingetragen.
Vorbelegung (value-Attribut)
In diesem Textfeld kann Text eingegeben werden, mit dem das Formularfeld gefüllt ist.
Request-File
Über diese Komponente kann eine Seite aus der Struktur gewählt werden, die die Eingabe entgegennimmt und die zutreffenden Werte zurückgibt.
Inhaltsprüfung (gefüllt bzw. gültiger Wert)
Über diese Radiobuttons kann eine Prüfung erstellt werden, die auf Inhalt bzw. auf gültige Daten prüft.
Anzahl Zeichen (maxlength-Attribut)
Mithilfe dieses Textfeldes kann die Anzahl der Zeichen definiert werden, die maximal eingegeben werden darf.
Anzeigebreite
In diesem Feld kann die Breite des Formularfeldes in Pixel angegeben werden.
Anzeigehöhe
In diesem Feld kann die Höhe des Formularfeldes in Pixel angegeben werden.
Stylesheet-Klasse (class-Attribut)
In diesem Textfeld kann der Name einer CSS-Klasse angegeben werden.
Formular-Komponente Autocompleter
Abbildung 35. Formular-Komponente Autocompleter


4.5.8. Formular-Komponente Combobox Standard

Die Formular-Komponente combobox standard bietet dem Redakteur eine komfortable Möglichkeit, dem Formular-Benutzer eine Auswahlliste zur Verfügung zu stellen. Die Inhalte der Liste sowie die Anzahl und das Layout sind frei formatierbar. Hier muss der Redakteur einen eindeutigen Gruppenbezeichner angeben.

Beschriftung
In diesem Textfeld wird der Titel des Formularfeldes eingegeben.
Gruppenbezeichner (name-Attribut)
In diesem Textfeld wird der eindeutige Bezeichner eingetragen.
sichtbare Einträge (size-Attribut)
In diesem Feld kann die Anzahl der sichtbaren Einträge als Zahl eingegeben werden.
Multiselect (multiple-Attribut)
Über diese Radiobuttons wird gesteuert, ob mehrere Einträge in diesem Formularfeld ausgewählt werden können.
Inhaltsprüfung (gefüllt bzw. gültiger Wert)
Über diese Radiobuttons kann eine Prüfung erstellt werden, die auf Inhalt bzw. auf gültige Daten prüft.
Options
In diese Liste können die Inhalte / Auswahlmöglichkeiten des Formularfeldes eingegeben werden.
Anzeigebreite
In diesem Feld kann die Breite des Formularfeldes in Pixel angegeben werden.
Anzeigehöhe
In diesem Feld kann die Höhe des Formularfeldes in Pixel angegeben werden.
Stylesheet-Klasse (class-Attribut)
In diesem Textfeld kann der Name einer CSS-Klasse eingegeben werden.
Formular-Komponente Combobox Standard
Abbildung 36. Formular-Komponente Combobox Standard


4.5.9. Formular-Komponente Combobox Query

Die Formular-Komponente combobox query bietet dem Redakteur eine komfortable Möglichkeit, dem Formular-Benutzer eine Auswahlliste zur Verfügung zu stellen. Die Inhalte der Liste sowie die Anzahl und das Layout sind frei formatierbar. Bei dieser speziellen SelectBox werden die Auswahloptionen aus der Datenbank über eine Query gefiltert und ausgegeben. Hier muss der Redakteur einen eindeutigen Gruppenbezeichner angeben.

Beschriftung
In diesem Textfeld wird der Titel des Formularfeldes eingegeben.
Gruppenbezeichner (name-Attribut)
In diesem Textfeld wird der eindeutige Bezeichner eingetragen.
sichtbare Einträge (size-Attribut)
In diesem Feld kann die Anzahl der sichtbaren Einträge als Zahl eingegeben werden.
Multiselect (multiple-Attribut)
Über diese Radiobuttons wird gesteuert, ob mehrere Einträge in diesem Formularfeld ausgewählt werden können.
Inhaltsprüfung (gefüllt bzw. gültiger Wert)
Über diese Radiobuttons kann eine Prüfung erstellt werden, die auf Inhalt bzw. auf gültige Daten prüft.
Datenbankabfrage
In dieses Textfeld kann der Name (UID) einer Datenbankabfrage (Query) eingegeben werden, die in der Vorlagen-Verwaltung vorhanden ist.
Spalte
In dieses Textfeld kann der Name einer Datenbankspalte bzw. eines Datenbankfeldes eingegeben werden. Die Werte dieser Spalte stehen in diesem Formularfeld zur Auswahl.
Ausgewählte(r) Wert(e) (selected-Attribut)
In diesem Textfeld können ein oder mehrere Werte angegeben werden, die in dem Formularfeld vorausgewählt sind. Bei mehreren Werten sind diese durch ein Komma (,) voneinander zu trennen.
Anzeigebreite
In diesem Feld kann die Breite des Formularfeldes in Pixel angegeben werden.
Anzeigehöhe
In diesem Feld kann die Höhe des Formularfeldes in Pixel angegeben werden.
Stylesheet-Klasse (class-Attribut)
In diesem Textfeld kann der Name einer CSS-Klasse eingegeben werden.
Formular-Komponente Combobox Query
Abbildung 37. Formular-Komponente Combobox Query


4.5.10. Formular-Komponente Combobox Date

Die Formular-Komponente combobox date bietet dem Redakteur eine komfortable Möglichkeit, dem Formular-Benutzer eine Auswahlliste zur Verfügung zu stellen. Die Inhalte der Liste sowie die Anzahl der Einträge und das Layout sind frei formatierbar. In dieser speziellen SelectBox werden automatisch drei Boxen erzeugt, über die komfortable ein Datum ausgewählt werden kann. Hier muss der Redakteur einen eindeutigen Gruppenbezeichner angeben.

Zur Umwandlung in ein richtiges Datumsformat innerhalb des Servlets wird dem eindeutigen Bezeichner ein toDate_ vorangestellt, um das Feld für das Servlet identifizierbar zu machen. Wurde als eindeutiger Bezeichner datum eingeben, hat das Feld den Bezeichner toDate_datum und muss auch so z.B. in der Mail-Vorlage verwendet werden.

Beschriftung
In diesem Textfeld wird der Titel des Formularfeldes eingegeben.
Gruppenbezeichner (name-Attribut)
In diesem Textfeld wird der eindeutige Bezeichner eingetragen.
sichtbare Einträge (size-Attribut)
In diesem Feld kann die Anzahl der sichtbaren Einträge als Zahl eingegeben werden.
Inhaltsprüfung (gefüllt bzw. gültiger Wert)
Über diese Radiobuttons kann eine Prüfung erstellt werden, die auf Inhalt bzw. auf gültige Daten prüft.
Start Jahr
In diesem Textfeld kann eine Jahreszahl eingegeben werden. Von diesem Jahr bis zum Wert des Feldes End Jahr ist eine Datumsauswahl möglich.
End Jahr
In diesem Textfeld kann eine Jahreszahl eingegeben werden. Von dem Wert des Feldes Start Jahr bis zu diesem ist eine Datumsauswahl möglich.
Anzeigebreite
In diesem Feld kann die Breite des Formularfeldes in Pixel angegeben werden.
Anzeigehöhe
In diesem Feld kann die Höhe des Formularfeldes in Pixel angegeben werden.
Stylesheet-Klasse (class-Attribut)
In diesem Textfeld kann der Name einer CSS-Klasse eingegeben werden.
Formular-Komponente Combobox Date
Abbildung 38. Formular-Komponente Combobox Date


4.5.11. Formular-Komponente Fileupload

Mit dieser Formular-Komponente ist es dem Benutzer möglich, Dateien über das Formular mitzusenden. Zudem ist es möglich, die Dateiformate einzuschränken. Auch hier muss der Redakteur einen eindeutigen Bezeichner für die Komponente vergeben.

Beschriftung
In diesem Textfeld wird der Titel des Formularfeldes eingegeben.
Eindeutiger Bezeichner (name-Attribut)
In diesem Textfeld wird der eindeutige Bezeichner eingetragen.
Inhaltsprüfung (gefüllt bzw. gültiger Wert)
Über diese Radiobuttons kann eine Prüfung erstellt werden, die auf Inhalt bzw. auf gültige Dateitypen prüft.
Akzeptierte Dateiformate
In diesem Textfeld kann eine kommaseparierte Liste von Datei-Endungen eingegeben werden. Eine Auswertung findet nur statt, wenn bei der Inhaltsprüfung gültiger Dateityp aktiviert ist. Mehrere Datei-Endungen sind durch ein | von einander zutrennen.
Anzeigebreite
In diesem Feld kann die Breite des Formularfeldes in Pixel angegeben werden.
Anzeigehöhe
In diesem Feld kann die Höhe des Formularfeldes in Pixel angegeben werden.
Stylesheet-Klasse (class-Attribut)
In diesem Textfeld kann der Name einer CSS-Klasse angegeben werden.
Formular-Komponente Fileupload
Abbildung 39. Formular-Komponente Fileupload


4.5.12. Formular-Komponente Captcha

Mit dieser Formular-Komponente wird in dem Formular eine Captcha-Grafik, ein Link, der eine neue Grafik erzeugt, und ein Textfeld zur Eingabe des Captcha-Codes erzeugt. Diese Komponente soll dazu dienen, nicht menschlichen Anwendern die Nutzung des Formulars zu verweigern.

Aktivieren Sie im Absatz form-start die Checkbox Captcha Validation, damit die Eingabe vom Servlet überprüft wird.

Beschriftung
In diesem Textfeld wird der Titel des Formularfeldes eingegeben.
Anzahl Zeichen (maxlength-Attribut)
Mithilfe dieses Textfeldes kann die Anzahl der Zeichen definiert werden, die maximal eingegeben werden darf.
Anzeigebreite
In diesem Feld kann die Breite des Formularfeldes in Pixeln angegeben werden.
Anzeigehöhe
In diesem Feld kann die Höhe des Formularfeldes in Pixeln angegeben werden.
Stylesheet-Klasse (class-Attribut)
In diesem Textfeld kann der Name einer CSS-Klasse angegeben werden.
Formular-Komponente Captcha
Abbildung 40. Formular-Komponente Captcha


Die Überlappung der Zeichen wird durch die Höhe, Breite und die Anzahl der zu rendernden Zeichen beeinflusst (siehe Kapitel Installation und Konfiguration der Web-Komponente). Es sollte immer darauf geachtet werden, dass die Zeichen nicht zu einfach lesbar sind, da diese sonst von Spam-Robotern gelesen werden können. Bei der Standardkonfiguration von 100 x 100 Pixel mit 6 Zeichen kann ein Captcha so aussehen:

Formular-Komponente captcha-Grafik
Abbildung 41. Formular-Komponente captcha-Grafik


4.6. Benötigte Medien und deren Funktion

4.6.1. Stylesheet-Datei

Um die Formular-Komponenten schnell und einfach anzupassen, sind für nahezu jede Komponente Konfigurationsfelder für Stylesheet-Klassen vorgesehen. Durch Angabe einer Stylesheet-Klasse kann somit jedes Feld einen individuellen Style erhalten. Eine beispielhafte Stylesheet-Datei formedit_css wird dem Projekt mit der Installation der Projektkomponente hinzugefügt. Die Klassennamen sollten in den Konfigurationsfeldern der Komponenten entsprechend angegeben werden. Die Anpassung der Stylesheet-Datei an individuelle Designvorgaben wird dringend empfohlen.

<script type="text/javascript" src="$CMS_REF(media:"formedit_js")$"></script>

Um eigene Stylesheet-Klassen verwenden zu können, müssen diese entweder im HTML-Header der (Seiten-)Vorlagen mittels <style>-Tag deklariert werden, oder einer bestehenden bzw. neuen Stylesheet-Datei im Projekt hinzugefügt werden.

4.6.2. JavaScript-Datei

Innerhalb der mitgelieferten Vorlagen werden Javascript-Funktionen verwendet, um z.B. das Ein- und Ausblenden von einzelnen Formularblöcken zu realisieren. Diese Funktionen sind in dem Medium formedit_js hinterlegt. Das Medium muss in allen (Seiten-)Vorlagen, in denen Javascript-Funktionen benutzt werden können, innerhalb des HTML-Headers referenziert werden:

<script type="text/javascript" src="$CMS_REF(media:"formedit_js")$"></script>

4.6.3. jQuery

Dieses freie Javascript-Framework stellt verschiedene Funktion zur Verfügung, die von den mitgelieferten Vorlagen verwendet werden. Außerdem ist diese Library Voraussetzung für die Nutzung der Formular-Komponente Autocompleter und die Formularfeld-Validierung.

Die mitgelieferte Version ist kompatibel zu den mitgelieferten Plugins. Sollte ein Update notwendig sein, ist darauf zu achten, dass dieses zu den Plugins kompatibel ist.

jQuery kann parallel zu anderen Frameworks, z.B. MooTools, eingesetzt werden. Das Framework muss in allen Vorlagen, die die Funktionen von jQuery oder dessen Plugins nutzen, innerhalb des HTML-Headers referenziert werden:

<script type="text/javascript" src="$CMS_REF(media:"jquery")$"></script>

Weitere Informationen und Updates: https://www.jquery.com

4.6.4. Formularvalidierung

Das jQuery-Plugin validate bietet eine komfortable Möglichkeit, die verwendeten Formularfelder bei Eingabe auf inhaltliche Korrektheit zu überprüfen. In den Formular-Komponenten wird auf die Basisfunktionalitäten dieses Plugins zurückgegriffen. Mithilfe dieses Plugins können aber auch Abhängigkeiten zwischen Formularfeldern und weitere Einschränkungen geprüft werden. Um diese Funktionalität im Projekt nutzen zu können, muss die Datei jquery_validate.js in allen (Seiten-)Vorlagen, in denen Formular-Komponenten benutzt werden können, innerhalb des HTML-Headers referenziert werden:

<script type="text/javascript" src="$CMS_REF(media:"jquery_validate")$"></script>

Alternativ ist es möglich, die Funktion in eine bereits bestehende Javascript-Datei einzufügen.

Von diesem Plugin werden auch die (Fehler-)Meldungen, die bei fehlender oder falscher Eingabekomponente – inline – erscheinen, in 19 Sprachen mitgeliefert. Diese Fehlermeldungen sind in dem sprachabhängigen Medium jquery_validate_messages hinterlegt und können bei Bedarf geändert und erweitert werden. Damit diese (Fehler-)Meldungen erscheinen, muss das Medium in allen (Seiten-)Vorlagen, in denen Formular-Komponenten benutzt werden können, innerhalb des HTML-Headers referenziert werden:

<script type="text/javascript" src="$CMS_REF(media:"jquery_validate_messages")$"></script>

Weitere Informationen und Updates: https://jqueryvalidation.org/documentation

4.6.5. Autocompleter

Für die Komponente Autocompleter wird ebenfalls ein jQuery-Plugin eingesetzt. Dieses stellt allerdings nur die Funktionalität bereit, eine Anfrage (Request) mit dem eingegebenen Zeichen an eine andere Seite abzusetzen und die Antwort (Response) dem Benutzer anzuzeigen. Die Datei jquery_autocomplete muss in allen (Seiten-)Vorlagen, in denen die Formular-Komponente Autocompleter benutzt werden kann, innerhalb des HTML-Headers referenziert werden:

<script type="text/javascript" src="$CMS_REF(media:"jquery_autocomplete")$"></script>

Weitere Informationen und Updates: https://github.com/agarzola/jQueryAutocompletePlugin

4.7. Konzept Autovervollständigung

Die Formular-Komponente Autocompleter stellt im eigentlichen Sinne nur eine ganz normale Texteingabe-Komponente zur Verfügung. Die Logik, die dieser Komponente die Funktionalität der Autovervollständigung bietet, besteht aus zwei Teilen:

  • Der erste Teil ist das jQuery-Plugin autocomplete. Dieses Plugin ermöglicht es, die eingebenen Zeichen im Hintergrund an eine andere dynamische Seite oder ein Servlet zu senden. Weiterhin nimmt diese die Antwort wieder entgegen und blendet sie dem Benutzer ein.
  • Der zweite Teil muss fallspezifisch implementiert werden: Dazu muss eine dynamische Seite (z.B. jsp oder php) erzeugt werden, die einen Request des Autocompleters entgegennimmt und dann damit eine Quelle (z.B. XML, Datenbank oder CSV) durchsucht. In einem weiteren Schritt müssen dann die gefundenen Daten wieder per Response an den Autocompleter zurückgegeben werden.

Dieses Konzept wird in den mitgelieferten Vorlagen anhand einer Beispiel-XML-Datei umgesetzt. Die Logik ist jsp-seitig implementiert und erfordert zusätzlich die Java-Bibliothek jdom.

Die Java Bibliothek jdom ist kein Bestandteil des Moduls FirstSpirit™ FormEdit, sondern muss separat auf dem ApplicationServer bzw. FirstSpirit-Server kopiert bzw. als Modul installiert werden. Weitere Informationen: http://www.jdom.org.

Beispiel

Diesem Beispiel liegt folgende XML-Datei (Seitenvorlage xmlDataBase) zugrunde:

<?xml version="1.0" encoding="UTF-8"?>
<jobs>
   <job jobnr="Projektleiter/in (jb-1742-a01)" jobdescription="Projektleiter/in"/>
   <job jobnr="Azubi (jb-1743-a02)" jobdescription="Azubi"/>
   <job jobnr="Template-Entwickler/in (jb-1744-a03)" jobdescription="Template-Entwickler/in"/>
   <job jobnr="Entwicklungsleiter/in (jb-1745-a04)" jobdescription="Entwicklungsleiter/in"/>
</jobs>

Bei Verwendung des Formularfeldes Autocompleter wird bei einer Eingabe nach z.B. 3 Zeichen eine Anfrage (Request) auf die in der Formular-Komponente referenzierten Seite abgesetzt. Diese Seite beruht auf der Seitenvorlage autocompleterequest. In dieser Seitenvorlage ist eine Logik implementiert, die diese Anfrage und die übermittelte Zeichenkette entgegennimmt.

incomingValue = (String) request.getParameter("q");

Innerhalb der referenzierten XML-Quelle wird in dem Vergleichsattribut nach Vorkommen der angefragten Zeichenkette gesucht.

for (Element child : children) {
   if (incomingValue == null ||
   child.getAttribute(compareAttr).getValue().toLowerCase().contains(incomingValue.toLowerCase())) {
      buffer.append(child.getAttribute(resultAttr).getValue() + "\n");
   }
}

Wenn ein zutreffender Eintrag gefunden wurde, wird eine Antwort (Response) an die Formular-Eingabekomponente gesendet:

Projektleiter/in
Entwicklungsleiter/in

Dem Formular-Anwender werden nun die gefundenen Daten angezeigt, hier z.B. der Wert des Attributs jobdescription (Rückgabetext). Wählt der Anwender jetzt eine Möglichkeit aus, wird dieser als Wert des Formularfelds gespeichert.

4.8. Fallbeispiel: Gewinnspiel

In diesem Beispiel werden alle vom Redakteur durchzuführenden Aktionen beschrieben, die erforderlich sind, um ein Formular zu erstellen, mit dem sich ein Benutzer zu einem Gewinnspiel anmelden kann.

Die vom Benutzer eingegebenen Daten sollen zum einen einer personalisierten Teilnahmebestätigung dienen und zum anderen in einer Datenbank gespeichert werden, die alle Teilnehmer enthält.

Um dieses Beispiel durchführen zu können, muss das Modul FirstSpirit™ FormEdit wie im Kapitel Installation und Konfiguration beschrieben für ein FirstSpirit-Projekt installiert werden. Des Weiteren werden eine Datenbank und ein zur Verfügung stehender E-Mail-Server vorausgesetzt.

4.8.1. Erstellen des Formulars

Legen Sie eine neue Seite in der Inhalte-Verwaltung an und wählen Sie als Vorlage formular. Fügen Sie der Seite in einem Absatzbereich nacheinander die Absätze form start, form block und form end hinzu:

Seite mit Formular-Absätzen anlegen
Abbildung 42. Seite mit Formular-Absätzen anlegen


Geben Sie nun im form start-Absatz eine Überschrift und einen Formularnamen an. Als Sendemethode wählen Sie Post und aktivieren die clientseitige Inhaltsprüfung. Sollten Sie bereits eine Bestätigungsseite und eine Fehlerseite in Ihrer Struktur zur Verfügung haben, können Sie diese hier referenzieren.

Wechseln Sie nun in den Absatz form block und legen Sie je ein Textfeld für Name, Vorname, Straße, Hausnummer, PLZ, Ort und E-Mail an. Verwenden Sie jeweils die Inhaltsprüfung Feld gefüllt. Um die Daten einfach in der Datenbank ablegen zu können, ist es ratsam, als eindeutigen Bezeichner den Spaltennamen in der Datenbank zu wählen. Für dieses Beispiel verwenden wir nachname, vorname, strasse, hausnummer, plz, ort und email als eindeutige Bezeichner:

Formularelemente
Abbildung 43. Formularelemente


Im Absatz form end sind alle erforderlichen Felder bereits vorausgefüllt, Sie können diese aber auch nach Ihren Vorstellungen anpassen.

4.8.2. Anlegen der Mail-Vorlage

Erstellen Sie in der Inhalte-Verwaltung eine neue Seite auf Basis der Vorlage mailtemplate. Als Empfänger verwenden wir das Feld aus dem Formular, da die E-Mail an den Formularanwender versendet werden soll. In diesem Beispiel also %email%.

Den Betreff können Sie ebenso wie den Nachrichtentext und die Absender-Adresse selbst definieren. Im Nachrichtentext können Sie mittels %eindeutigerBezeichner% auf alle Formularfelder zugreifen:

Mail-Vorlage
Abbildung 44. Mail-Vorlage


Ziehen Sie nun Ihre erstellte Mail-Vorlage per Drag&Drop in die Struktur-Verwaltung oder referenzieren sie über das Kontextmenü aus der Struktur-Verwaltung.

4.8.3. Anlegen der Logger-Konfiguration (E-Mail)

Wechseln Sie nun wieder in Ihren form start-Absatz und fügen Sie in der Komponente Weiterverarbeitung einen neuen Datensatz ein.

Datensatz hinzufügen
Abbildung 45. Datensatz hinzufügen


Im folgenden Dialog geben Sie einen Namen für die E-Mail-Weiterverarbeitung an und wählen den LoggerTyp MailLogger. Eine Beschreibung können Sie optional hinzufügen.

Fügen Sie nun in der Komponente Logger Parameter einen neuen Datensatz mit einem Klick auf Absatz hinzufügen hinzu und wählen Sie den Eintrag logger-text-value und klicken Sie OK. Im folgenden Dialog geben Sie als Parameter-Name smtpHost an und als Parameter-Wert die Adresse Ihres Postausgangs-Servers, z.B. smtp.mustermann.de. Selbiges wiederholen Sie für den Parameter encoding mit dem Namen des von Ihnen gewünschten Encodings (hier: UTF-8).

Nun legen Sie noch einen neuen Absatz an, diesmal allerdings mit der Vorlage logger-template-ref. Als Parameter-Name geben Sie nun mailTemplatePath ein und wählen in der Komponente Mailtemplate die von Ihnen erstellte Mail-Vorlage. Weitere Parameter sind im Abschnitt Konfiguration der E-Mail-Weiterverarbeitung erläutert.

Parameter MailLogger
Abbildung 46. Parameter MailLogger


Abschließend wählen Sie in der Komponente den Status Aktiviert (siehe Kapitel Anlegen der Logger) und klicken in der linken oberen Ecke auf das Speichern-Symbol. Der von Ihnen angelegte Logger wird nun automatisch in der Komponente Weiterverarbeitung in Ihrem form start-Absatz aufgelistet.

4.8.4. Anlegen der Logger-Konfiguration (Datenbank)

Das Anlegen der zweiten Konfiguration erfolgt genauso wie im Kapitel Anlegen der Logger-Konfiguration (E-Mail) beschrieben. Hier wählen Sie allerdings den LoggerTyp JdbcLogger und legen alle Parameter auf Basis der logger-text-value Vorlage an. Legen Sie bitte als erstes den Parameter driver mit dem Namen Ihres Datenbanktreibers an, z.B. com.mysql.jdbc.Driver für eine MySQL-Datenbank.

Bitte beachten Sie, dass der Datenbank-Treiber bereits dem FirstSpirit-Server hinzugefügt wurde.

Mit dem Parameter url übergeben Sie die Adresse zu Ihrer Datenbank, z.B. jdbc:mysql://muster:3306/formlogger und mit dem Parameter table den Namen Ihrer Tabelle (hier: demo).

Nun legen Sie die Parameter user und password an und befüllen diese mit den Anmeldedaten für die Datenbank, die Ihnen üblicherweise Ihr Datenbank-Administrator zur Verfügung stellt.

Parameter JdbcLogger
Abbildung 47. Parameter JdbcLogger


Weitere Parameter sind im Abschnitt Konfiguration der Datenbank-Weiterverarbeitung erläutert.

4.8.5. Anlegen der Konfigurationsdatei fs-formlogger.ini

Bitte lesen Sie hierzu das Kapitel Konfigurationsdatei fs-formlogger.ini.

4.8.6. Referenzieren und veröffentlichen

Abschließend referenzieren Sie alle erstellten Seiten in der Struktur und geben diese ggf. frei. Sollten Sie bzw. der Projektadministrator das Modul FirstSpirit™ FormEdit für das Staging eingerichtet haben, sollte Ihr Formular nach der Generierung im generierten Stand (http://www.ihrredaktionsserver.de:8000/fs4staging_<project_id>/…​) sichtbar sein und verwendet werden können.

5. Rechtliche Hinweise

Das FirstSpirit™ FormEdit-Modul ist ein Produkt der e-Spirit AG, Dortmund, Germany.

Für die Verwendung des Modules gilt gegenüber dem Anwender nur die mit der e-Spirit AG vereinbarte Lizenz.

Details zu möglicherweise fremden, nicht von der e-Spirit AG hergestellten, eingesetzten Software-Produkten, deren eigenen Lizenzen und gegebenenfalls Aktualisierungs-Informationen, finden Sie in der Datei THIRD-PARTY.txt, die mit dem Modul ausgeliefert wird.