FirstSpirit™ FormEdit

e-Spirit AG

13.12.2018
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.181007 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).