Artikelaktionen

    Sie sind hier: Startseite Plone4 - Das CMS der … Formular-Ordner

    Formular-Ordner

    Ein Formular-Ordner dient in Plone 4 dazu, Kontaktformulare zu erstellen.

    Überblick

    Grundsätzlich stehen diverse typische Formular-Elemente (Texteingabe, Abfragen, Auswahlbuttons, Hochladefunktion etc.) zur Verfügung.

    Der Name Formular-Ordner weist darauf hin, dass es sich tatsächlich um einen Ordner handelt. Die einzelnen Formular-Elemente des neuen Formulars sind somit in der Registerkarte Anzeigen als Objekte enthalten.

    Um ein Formular zu erstellen, wird zunächst der Ordner ausgewählt in dem das Formular veröffentlicht werden soll. Klicken Sie den Reiter Hinzufügen und dort den Punkt Formular-Ordner an (siehe Abb.1).

    ordner-hinzufugen.png 

    Abbildung 1: Formular-Ordner hinzufügen

    Nun erscheint ein Fenster, in dem die benötigten Informationen zur Erstellung erscheinen. Hier werden die wichtigsten Informationen zur Erstellung eines einfachen Standard-Formulars eingegeben. Im nächsten Schritt kann dieses Formular noch mit weiteren Abfrageoptionen erweitert werden.

    option-formular-hinzu.png

    Abbildung 2: Optionen beim Hinzufügen von Formular-Ordnern

     option-formular-hinzu-2.png

    Abbildung 3: Weitere Optionen beim Hinzufügen von Formular-Ordnern

    Felder, die ein rotes Kästchen besitzen, müssen ausgefüllt werden, die anderen sind optional.

    Der Titel muss, eine Beschreibung kann eingegeben werden (siehe Abb.2 Nr. 1 und 2).  Dieser Text erscheint hervorgehoben im Formular und wird in Auflistungen angezeigt. Titel und Beschreibung sind dann im fertigen Formular oben zu sehen (siehe auch Abb.4 Nr. 1 und 2).
    Der Button zum Absenden des Formulars (siehe Abb.4 Nr. 7) kann beliebig beschriftet werden (siehe Abb.2 Nr. 3).
    Ebenso kann ein Button zum Leeren des Formulars (siehe Abb.4 Nr. 7) aktiviert werden. Hierzu muss das entprechende Häkchen gesetzt werden (siehe Abb. 2 Nr. 4). Auch hier kann eine eigene Beschriftung festgelegt werden (siehe Abb.2 Nr. 5).
    Optional kann eine Danke-Seite ausgewählt werden (siehe Abb.2 Nr. 7). Diese wird nach dem Absenden des Formulars angezeigt. Die Danke-Seite findet sich im Formular-Ordner unter Inhalte und kann dort aufgerufen und personalisiert werden.
    Weitere Informationen hierzu finden sich in einem eigenen Abschnitt weiter unten.

    Um das Formular sicherer zu machen, kann eine SSL-Verbindung erzwungen werden (siehe Abb.2 Nr. 8). Dann werden alle Formulardaten verschlüsselt übermittelt. Dies ist vor allem bei personenbezogenen Daten unbedingt empfohlen.

     nutzeransicht.png

    Abbildung 4: Formular in der Endnutzeransicht

    Standardmäßig ist ein Formular so eingestellt, dass die eingegebenen Daten an die hinterlegte Email-Adresse des Portals gesendet werden. Hierzu dient der Verarbeitungsadapter der standardmäßig auf den E-Mail-Adapter verweist (siehe Abb.2 Nr. 6). Weitere Informationen zum Verarbeitungsadapter finden sich in einem eigenen Abschnitt.

    Um das Formular weiter zu personalisieren, können vor und nach dem Formular eigene Texte festgelegt werden (siehe Abb.4 Nr. 3 und 6). Die Texte können, wie bei anderen Seiten, frei formatiert und mit Bildern ergänzt werden (siehe Abb.3 Nr. 1 und 2).

    Hinzufügen von Formularfeldern

    Beim Erstellen eines Formulars lassen sich noch keine weiteren Formular-Felder hinzufügen, stattdessen werden standardmäßig Felder für Email-Adresse, Betreff und Kommentar erzeugt (siehe Abb.4 Nr. 4).
    Nach dem Erstellen lassen sich beliebige Felder hinzufügen. Dies geschieht entweder über die Registerkarte Inhalt (siehe Abb.5 Nr. 1) oder QuickEdit (siehe Abb.5 Nr. 2).

     registerkarten.pngAbbildung 5: Registerkarten beim Formular-Ordner

    Hinzufügen mit QuickEdit

    Mit Klick auf die Registerkarte QuickEdit wird eine Ansicht aufgerufen, die schnell und einfach das Hinzufügen, Entfernen und Bearbeiten von Formularfeldern erlaubt (siehe Abb.6). 

    qucik-edit.pngAbbildung 6: Formular bearbeiten mithilfe von QuickEdit

    Bereits angelegte Felder finden sich in der Mitte (siehe Abb.6 Nr. 5). Diese können entweder gelöscht (siehe Abb.6 Nr. 7), bearbeitet (siehe Abb.6 Nr. 6) oder in der Reihenfolge verändert werden (siehe Abb.6 Nr. 8). Letzteres geschieht durch „Drag & Drop“, also durch Anklicken und Verschieben.

    Neue Felder können aus der Toolbox (siehe Abb.6 Nr. 1) ebenso per Drag & Drop hinzugefügt werden. Neben dem Bereich Basic Fields finden sich unter More Fields, Fieldsets und Actions noch weitere Felder zum Hinzufügen. Diese werden in einem späteren Abschnitt genauer beschrieben.

    Wenn ein Feld hinzugefügt wurde, müssen, je nach Feldtyp, diverse Angaben gemacht werden (siehe Abb.7 Nr. 1). Zudem muss für das Feld der Button „Speichern“ (siehe Abb. 7 Nr. 2) bestätigt werden um die Änderungen zu übernehmen.

     feldeienfueg.pngAbbildung 7: Formularfeld hinzufügen

     

    Hinzufügen über Inhalt

    Neue Formularfelder können in Plone 4 auch über die Registerkarte Inhalte eingefügt werden (siehe Abb. 8 Nr. 1). Hintergrund ist das ein Formular-Ordner sich wie ein normaler Ordner verhält und die Formularfelder wie Plone4-Objekte. Dementsprechend werden die Felder über das Untermenü „Hinzufügen“ (siehe Abb. 8 Nr. 2) erstellt.

    hinzuf-inhalte-3.png 

    Abbildung 8: Formularfelder über die Registerkarte „Inhalt“ einfügen

    Die bereits angelegten Felder werden in dieser Ansicht auch aufgelistet und können über die entsprechenden Schaltflächen (siehe Abb. 8 Nr. 5) geändert werden. Die Reihenfolge kann hier ebenso über Drag & Drop verändert werden (siehe Abb. 8 Nr. 4). Wenn ein Objekt angeklickt wird (siehe Abb. 8 Nr. 6) öffnet sich die Seite für dieses Element. Hier wird dann die Registerkarte „Bearbeiten“ ausgewählt um weitere Einstellungen zu erhalten (siehe Abb. 9 Nr. 1). Die weiteren Einstellungen sind dabei abhängig von der Art des Formularfelds.

     bearbeiten-inhalt.png

    Abbildung 9: Formular-Felder bearbeiten

    Wichtig ist hier zu verstehen das jedes Formularfeld ein eigens Objekt in Plone 4 ist. Wenn ein Element bearbeitet wird öffnet Plone die entsprechende Seite. Um auf die Ebene des Formularordners zurückzukommen muss dieser also wieder im Menu ausgewählt werden (siehe Abb. 10 Nr.1).

     

    Abbildung 10: Ordner in Navigation auswählen

     

    Arten von Formularfeldern

    Die meisten Formularfelder dienen zur Eingabe von Informationen. Hierzu stehen verschieden Arten von Feldern zur Verfügung. Einige ermöglichen die freie Eingabe von Texten und/oder Zahlen, andere bieten nur eine oder mehrere Optionen zur Auswahl die lediglich bestätigt oder abgelehnt werden können. Die so eingegebenen Daten werden dann wahlweise an den Seitenadministrator verschickt oder können von eingeloggten Webseitenverwaltern runtergeladen werden. Dies ist abhängig von den genutzten Verarbeitungsadaptern. Diese werden im nächsten Abschnitt noch einmal ausführlich erklärt.

    Im Folgenden werden die verschiedenen Formularfelder kurz vorgestellt und erklärt was für eine Ausgabe erzeugt wird. Im Anschluss werden dann die Einstellungsmöglichkeiten erklärt.

    Aussehen

    Erklärung

    Ausgabe

     checkbox-field.png

    Ermöglicht eine Option an oder abzuwählen

    True oder False bzw selbsthinterlegt Werte (nur bei Email-Adapter)

     datum-zeit-feld.png

    Ermöglicht eine Datums- und Zeitangabe zu machen

    Formatiertes Datum/Zeit, z.B:

    2015-01-17 16:15

     

     ganzahlfeld.png

    Ermöglicht die Eingabe einer Ganzzahl

    Eingegebene Ganzzahl

     mehrfachauswahl-feld.png

    Ermöglicht die Auswahl ein oder mehrerer Optionen

    Ausgewählte Werte, z.B.:

    ['Peter', 'Mary',‘Bill‘]

     

     auswahlfeld.png

    Ermöglicht die Auswahl einer Option

    Ausgewählter Wert, z.B:

    Bob

     zeicxhenkettenfeld.png

    Ermöglicht die Eingabe eines freien Texts

    Der eingegebene Text

     einfaches-text-feld.png

    Ermöglicht die Eingabe eines freien Texts. Kann auch über mehr als eine Zeile angelegt werden.

    Der eingegebene Text

     captcha-feld.png

    Erzeugt ein Feld mit verzerrter Schrift. Dient zum herausfiltern automatischer Roboteranfragen und Spam. Nur beim erfolgreichen übertragen wird das Formular abgesendet.

    Der eingegebene Text

     dateifeld.png

    Ermöglicht das hochladen und verschicken einer lokalen Datei.

    Die hochgeladene Datei wird per Email mitgeschickt (nur bei Email-Adapter). Beim Export der CSV-Datei wird nur der Dateiname übermittelt.

     deztimal-feld.png

    Ermöglicht die Eingabe einer Gleitkommazahl

    Eingegebene Zahl

     bezeichnung.png

    Ermöglicht eine genauere Erläuterung beizufügen. Dient zur Beschriftung und hat keine Eingabemöglichkeit

    Kein Output

     bewertungsfeld.png

    Ermöglicht die Eingabe über eine mehrstufige Skala. Eignet sich für Umfragen.

    Ausgewählte Option pro Frage, z.B.:

    1: Agree, 2: Strongly agree

     

     zeielenfeld.png

    Texte die im Zeilenfeld werden bei jedem Zeilenumbruch als eigener Wert gespeichert. So kann in jeder Zeile eine Name eingegeben werden und jeder Name wird als eigener Wert in einer Kette übermittelt.

    Eingegebener Wert pro Zeile getrennt durch Komma.

    Folgender Text:

    bi

    ba

    bo

    bu

    wird so übermittelt:

    ['bi', 'ba', 'bo', 'ba', 'bu']

     

     passwort-feld.png

    Ermöglicht die Eingabe eines Textes ohne diesen anzuzeigen

    Der eingegebene Text

     bezeichnugsfeld.png

    Ermöglicht eine genauere Erläuterung. Kann im Gegensatz zur normalen Bezeichnung auch formatiert werde.

    Kein Output

     texteingabefeld.png

    Das Texteingabefeld dient zur Eingabe von formatiertem Text.

    Der eingegebene Text inklusive der Formatierung in HTML

     fieldset.png

    Ein Fieldset legt einen Rahmen um einen bestimmten Bereich. Hierzu wird ein Objekt vom Typ „Fieldset Begin“ und eines vom Typ „Fieldset End“ benötigt. Die Elemente dazwischen werden dann von einem Rahmen umgeben.

    Kein Output

     

    Wiederkehrende Einstellungen

    Jedes Feld hat verschiedene Einstellungsmöglichkeiten. Die Einstellungsmöglichkeiten werden über das Quick-Edit Register mit dem entsprechenden Icon (quickeditbearbeitung.png) aufgerufen. Eine weitere Möglichkeit die Einstellungsmöglichkeiten aufzurufen ist über das Inhaltsregister in der Formular-Ordner Übersicht. Hier wird zunächst das Formularfeld ausgewählt und dann die Registerkarte „Bearbeiten“. Im Folgenden werden die Einstellungen kurz erklärt. Hierbei ist zu beachten das nicht alle Einstellungen bei jedem Formularfeld zur Verfügung stehen.

    Zwingend erforderlich

    Ist diese Option ausgewählt kann das Formular nur abgesendet werden, wenn das Formularfeld eine Eingabe hat.

    Voreinstellungen

    Unter dieser Option lässt sich angeben wie ein Formularfeld zu Beginn gefüllt ist. Bei Eingabefelder (Ganzzahlfeld, Zeichenkettenfeld, Textfeld,…) lässt sich hier ein Text eingeben der zu Beginn erscheint. Bei Auswahlfeldern (Checkbox, Auswahlfeld, Mehrfachauswahlfeld) lässt sich hier eine Auswahl treffen die zu Beginn vorausgewählt ist.

    Felderläuterung

    Hier wird ein Text angegeben zur Erklärung. Dieser erscheint, je nach Feldtyp, über, neben oder unter dem Eingabefeld.

    Validator

    Ein Validator dient dazu die Inhalte eines Eingabefeldes zu überprüfen. Beim Zeichenkettenfeld stehen hier diverse Option zur Verfügung. So kann zum Beispiel geprüft werden ob das Feld eine gültige Email- oder Webseitenadresse ist. Bei Checkboxen kann geprüft werden ob ein Feld ausgewählt wurde. So kann zum Beispiel ein bestimmtes Häkchen erzwungen werden. In der Praxis findet so etwas Anwendung bei der Bestätigung von AGBs.

    Zeilen

    Die Option Zeilen steht bei Auswahllisten und mehrzeiligen Textfeldern zur Verfügung. Das Eingabefeld, bzw. die Liste, ist dann so viele Zeilen lang wie hier angegeben wurde.

    Optionen

    Auswahlfelder und Mehrfachauswahlfelder brauchen Optionen zur Auswahl. Unter Optionen kann pro Zeile eine Auswahlmöglichkeit angelegt werden. Dies sind die Optionen die später für den Nutzer sichtbar sind.

    Präsentations-Widget

    Unter Präsentations-Widget kann das Erscheinungsbild für Auswahlfelder und Mehrfachauswahlfelder verändert werden.

    Anzeigetext für True/False

    Diese Einstellungsmöglichkeit gibt es nur bei Checkboxen. Hier wird ein Wert festgelegt der angezeigt wird wenn das Häkchen gesetzt (true) bzw. nicht gesetzt (false) wurde. Der Text erscheint auf der Danke-Seite und der verschickten Email. Bei der Verarbeitung durch den Datenadapter erscheint weiterhin der Wert True bzw. False.

    Maximale Länge

    Der Wert für die maximale Länge gibt an wie viele Zeichen in einem Feld geschrieben werden dürfen.

    Größe

    Der Wert für die Größe gibt an wie breit ein Eingabefeld ist.

    Kleinster/Größter akzeptierter Wert

    Hier kann ein Bereich festgelegt werden in den sich ein Wert befindet sll. Diese Einstellung ist nur bei Zahleneingaben (Ganzzahl-,Dezimalzahl) vorhanden.

    Besondere Formularobjekte

    Die meisten Formularelemente sind direkt im Formular sichtbar. Einige Ausnahmen werden im Folgenden kurz besprochen.

    Danke Seite

    Die Danke-Seite ist ein spezielles Element das standardmäßig in jedem Formular-Ordner vorhanden ist. Dabei handelt es sich um eine Seite die angezeigt wird wenn das Formular abgeschickt wurde. Die Danke-Seite findet man im Formular-Ordner unter Inhalte. Nachdem die Danke-Seite angeklickt wurde können über die Registerkarte „Bearbeiten“ diverse Einstellungen vorgenommen werden.

     danke-1.png

    Abbildung 11: Bearbeitungsoptionen bei der Danke-Seite

    Neben einem Titel (siehe Abb. 11 Nr. 2) kann ein Beschreibungstext (siehe Abb. 11 Nr. 3) angegeben werden. Beides wird in festgelegter Formatierung angezeigt. Optional kann noch ein formatierter Text als Vorwort eingegeben werden (siehe Abb. 11 Nr. 4). Nach dem Vorwort folgt die Anzeige der Nutzereingaben. Welche Felder dabei angezeigt werden lässt sich über die Registerkarte „Fields“ (siehe Abb. 11 Nr. 1) festlegen.

     danke-2.png

    Abbildung 12: weitere Bearbeitungsmöglichkeiten

    Nach den angezeigten Feldinhalten wird der Epilog angezeigt der sich ebenso selbstformatiert anlegen lässt (siehe Abb. 12 Nr. 1). Außerdem kann eine Meldung festgelegt werden die angezeigt wird wenn das Formular nicht richtig übertragen wurde (siehe Abb. 12 Nr. 2).  

    Verarbeitungsadapter

    Der Formularordner von Plone 4 stellt verschiedene Adapter zur Verarbeitung zur Verfügung. Diese Verarbeitungsadapter legen fest was nachdem absenden mit den Daten passiert. Standardmäßig ist der E-Mail-Adapter aktiviert.

     

    E-Mail Adapter

    Der E-Mail-Adapter ist bei jedem Formular-Ordner zu Beginn bereits angelegt. Er dient dazu die Formulareingaben per Email weiterzuleiten. Wenn der E-Mail-Adapter nicht verändert wird, werden alle Formulardaten an die Emailadresse des Portaladministrators geschickt. Um weitere Einstellungen vorzunehmen muss der E-Mail-Adapter über die Registerkarte „Inhalte“ (siehe Abb. 13 Nr.1) beim Formular-Ordner ausgewählt werden.

    inhaltsregister.png 

    Abbildung 13: E-Mail-Adapter auswählen

    Nun öffnet sich die Standard-Ansicht des E-Mail-Adapters.

     emailadap-standard.png

    Abbildung 14: Standard-Ansicht des Email-Adapters

    Von hier aus können die anderen Unterregister (siehe Abb. 14 Nr.1) aufgerufen werden. Zudem lassen sich hier die wichtigen Einstellungen vornehmen. Zum einen kann ein Titel für den E-Mail-Adapter ausgewählt werden. Dies kann zum Beispiel nützlich sein wenn mehrere E-Mail-Adapter angelegt wurden die an verschiedene Personen gehen. Zudem kann ein Empfänger mit Name (siehe Abb. 14 Nr.3) und E-Mail (siehe Abb. 14 Nr.4) hinterlegt werden. An diese Adresse werden dann die Formulardaten gesendet. Wenn die Felder nicht ausgefüllt sind wird die Mail an die hinterlegte Adresse des Portaladministrators geschickt.

    Falls die Formulardaten noch an weitere Adresse versendet werden soll kann man dies über das Unterregister „Adressing“ eingestellt werden.

     adressing.png

    Abbildung 15: Unterregister Addressing

    Zum einen kann der Empfänger aus den Formulareingaben herausgelesen werden. Hierzu kann eines der vorhandenen Textfelder ausgelesen werden (siehe Abb. 15 Nr.1). Diese Option sollte nicht leichtfertig benutzt werden, da sie ermöglicht das Außenstehenden E-Mails über die Mailserver der Uni verschicken können. Wenn hier ein Feld ausgewählt ist wird dadurch die Standardadresse überschrieben. Ebenso können beliebig viele weitere Mailadressen eine Kopie der Formulardaten erhalten. Diese werde unter Kopie-Empfänger (siehe Abb. 14 Nr.2) eingetragen. Alle Empfänger sind dann im Kopf der Email zu sehen. Falls eine Mailadresse die Daten erhalten solle ohne in der Email sichtbar zu sein kann diese unter Blindkopie-Empfänger hinterlegt werden. Zudem kann noch eine Antwortadresse aus den vorhandenen Feldern gelesen werden. Normalerweise ist dies die angegebene E-Mail-Adresse. Wenn der Empfänger der Formulardaten auf antworten klickt geht die Antwort an diese Adresse.

    Über das Unterregister „Message“ können zusätzliche Inhalte für die E-Mail angegeben werden. So kann ein Text vor und nach den eigentlichen Formulardaten angegeben werden. Hier wird auch festgelegt welche Felder alles per Email übermittelt werden.

     

    Das Layout der Email wird standardmäßig als ZPT-Vorlage gespeichert (siehe Abb. 16 Nr.1). Diese kann im Unterregister „Template“ verändert werden. Mithilfe von TAL (Template Attribut Sprache) lassen sich diese Vorlagen personalisieren. Dies ist aus Performancegründen allerdings nicht zu empfehlen.

    Wenn die Email nicht im HTML-Format sondern als reiner Text versendet werden soll kann dies entsprechend eingestellt werden (siehe Abb. 16 Nr.2). Außerdem können Standardheader ausgewählt werden die der Email beigefügt werden (siehe Abb. 16 Nr.3). Bei Bedarf können auch eigen Header definiert werden (siehe Abb. 16 Nr.4).

     templates.pngAbbildung 16: Template für E-Mail-Adapter

    Falls die Email verschlüsselt gesendet werden soll kann im Unterregister „Encryption“ eine Schlüssel-ID angegeben werden.

    Fortgeschrittene Nutzer können den Formularversand noch weiter personalisieren über das Unterregister „Overrides“. Hierzu werden TALES-Ausdrücke verwendet. Diese sind aus Performancegründen allerdings nicht zu empfehlen. Weitere Informationen hierzu finden Sie unter folgendem Link.

    https://docs.plone.org/working-with-content/managing-content/ploneformgen/override_defaults.html

     

    Datenspeicheradapter

    Ein Datenspeicheradapter sorgt dafür das die Formulardaten im System gespeichert und bei Bedarf runtergeladen werden können. Er lässt sich auch in Kombination mit einem E-Mail-Adapter benutzen. Ein Datenspeicheradapter wird über die Ansicht des Formularordners hinzugefügt (siehe Abb. 17).

     datenspeicher-hinzu.png

    Abbildung 17: Datenspeicheradapter hinzufügen

    Um die gespeicherten Daten abzuholen wird zunächst der Datenspeicheradapter über das Register „Inhalte“ des Formularordners geöffnet.

    datensp-anz.pngAbbildung 18: Datenspeicheradapter

    Unter der Registerkarte „Anzeigen“ lassen sich die gespeicherten Formulardaten als CSV runterladen (siehe Abb. 18 Nr.1) oder löschen (siehe Abb. 18 Nr. 2). Eine CSV-Datei ist eine Liste der Daten, meist mit Komma getrennt. Diese lässt sich in Programmen zur Tabellenverarbeitung öffnen.

    Unter der Registerkarte „Bearbeiten“ lassen sich weitere Einstellungen vornehmen.

    datenadapbear1.png Abbildung 19: Bearbeitungsoptionen des Datenspeicheradapters

    Hier wird zum Beispiel festgelegt welche Feldinhalte gespeichert werden (siehe Abb. 19 Nr. 3). Alle Feldnamen die auf der rechten Seite stehen werden gespeichert. Wenn kein einziges Feld auf der rechten Seite ist werden alle Feldinhalte gespeichert. Neben den Feldinhalten lassen sich noch zusätzliche Daten speichern (siehe Abb. 19 Nr. 4). Auf diese Weise lassen sich zum Beispiel Uhrzeit und Datum der Versendung speichern. Standardmäßig wird der HTTP_USER_AGENT gespeichert. Dieser speichert Informationen über den Browser und das Betriebssystem.

    Unter „Download-Format “ (siehe Abb. 19 Nr. 5) kann festgelegt werden ob die CSV Datei mit Kommas oder Tabs getrennt wird. Ebenso kann festgelegt werden ob die Feldnamen als Spaltennamen mitgespeichert werden (siehe Abb. 19 Nr. 6).

    Über das Unterregister „Saved Data“ (siehe Abb. 19 Nr. 1) lassen sich alle gespeicherten Daten im Browser betrachten. Schließlich können über das Unterregister „Overrides“ TALES-Ausdrücke benutzt werden um die Daten automatisch zu verarbeiten.

    Adapter für eigenes Skript

    So wie bei den anderen Adaptern lässt sich auch der Adapter für ein eigenes Skript hinzufügen. Hier kann ein eigenes Python-Skript hinterlegt werden um eine automatisierte Verarbeitung umzusetzen. Diese Funktion ist für fortgeschrittene Nutzende gedacht die Programmierkenntnisse haben.