Dokumentenbasiert

Jede Art von Inhalt (unabhängig davon, ob es ein Bild, eine Formularseite, eine Weiterleitung etc. ist) wird in openforms als Dokument angelegt. 

Dokumente können als Container betrachtet werden. Abhängig vom Dokumententyp können sie wiederum Dokumente oder auch Formularbausteine (Absätze) enthalten.  Der Dokumententyp  bestimmt, welche Inhalte ein Dokument haben kann, und ob bzw. welche Dokumenttypen als Unterdokument erlaubt sind. 

Dokumentenstruktur

Dokumente geben auch die Struktur der Inhalte vor. Ähnlich wie Ordner in einem Dateisystem, sind Dokumente streng hierarchisch organisiert. Es wird auch von der Baumstruktur von Dokumenten oder der Dokumentenstruktur gesprochen. 

Wie in Content-Management-Systemen üblich, kann die Baumstruktur beliebig erweitert werden. Die Baumstruktur erlaubt es, zentrale Inhalte wie Datenlisten, Bilder oder Texte abzulegen und von Formularseiten aus zu referenzieren. Somit können die Inhalte wiederverwendet werden und bei Bedarf an zentraler Stelle aktualisiert werden. Siehe auch Verweise und Referenzen.

Die Baumstruktur definiert den eindeutigen Pfad, mit dem ein Dokument angesprochen werden kann.


Tipps für eine sinnvolle Dokumentenstruktur

Nicht immer ist es sinnvoll, Formulare und Medien bereits auf Ebene der Sprachversion klar voneinander in zu trennen.

Medien (in Form von Texten, Bildern, PDFs etc.) sollten nur dann in einem zentralen Medienordner abgelegt werden, wenn sie von mehreren Formularen genutzt werden. Wird ein Dokument ausschließlich von einem Formular genutzt, so ist es in der Praxis sinnvoller, einen Dokument des Typs Standard als Sammelordner sowohl für das Formular als auch für die (expliziten) Medien desselben anzulegen. 

Im Strukturbaum kann dies wie folgt aussehen:

Verweise auf diese Medien (bspw. Mappinglisten in Bezug auf Auswahlfelder) können dann auf Standard-Ebene über den Tab Navigation gesetzt werden.

Dieses Vorgehen hat den Vorteil, dass sämtliche Medien wie auch Verweise an einer Stelle sind und gebündelt im- und exportiert werden können.

Rechte (Dokumente)

Dokumente können mit Rechten versehen werden, d.h nicht jeder Besucher kann alle Dokument lesen, bzw. nicht jeder Redakteur kann alle Dokument bearbeiten (siehe auch Dokumenten-Status und Freigabe und Rollen und Rechte).

Dokumentinhalte & Versionen

Die Inhalte eines Dokuments werden in Versionen abgelegt. Ein Dokument hat mindestens eine Version. Bei den meisten Dokumenttypen sind mehrere Versionen möglich. 

Die Versionen enthalten alle Inhalte (Texte, Bilder, Formularfelder) die dem Besucher eines Dokumentes angezeigt werden. Der Inhalt einer Version kann durch Absätze weiter strukturiert werden.

Eine Referenz (Verweis) auf ein Dokument nutzt in der Regel die aktuellste Version eines Dokuments, das den Status In Produktion besitzt. 

Publikations-Status (Versionen)

Ob ein Dokument für den Besucher zur Verfügung steht (das heißt über die Runtime-Instanz bzw. den Vorschau-Server aufgerufen werden kann), hängt von den Publikations-Status seiner Versionen ab. Diese sind:

StatusBeschreibung
in ArbeitDie Version befindet sich in Bearbeitung. Sie ist über den Button Vorschau (interne Vorschau), jedoch weder über den Vorschauserver noch über die Runtime-Instanz (von extern) aufrufbar.
fertigDie Version ist in einem Stnad, dass sie getestet werden kann. Sie ist sowohl über die interne Vorschau als auch über den Vorschau-Server aufrufbar.
in ProduktionDie Version kann ist publiziert. Sie kann also über die Runtime-Instanz aufgerufen werden.
archiviertDie Version ist nur noch archiviert vorhanden. Das bedeutet, dass sie weder aufgerufen noch bearbeitet werden kann. Sie kann jedoch über eine Kopie wiederhergestellt werden.

In jeder Version kann man über den Reiter Publizieren einen Publikations-Zeitraum bestimmen. Innerhalb des gesetzten Zeitraums wird die Version in Produktion gestellt. 

Ein Dokument ist dann für einen Besucher lesbar/sichtbar, wenn es mindestens eine Version in Produktion enthält. Bei mehreren Versionen in Produktion wird die neueste Version angezeigt.

Siehe auch Dokumenten-Status und Freigabe

Leere Dokumente

Ein Dokument ist leer, falls die Version in Produktion keinen Inhalt hat. Leere Dokumente dienen zur Strukturierung der Inhalte und spielen eine besondere Rolle beim Auflösen von Referenzen. 

Das Bild zeigt beispielhaft eine Dokumentenstruktur (es gibt mehr Dokumententypen als im Bild dargestellt)

Die tiefste Ebene der schematischen Darstellung besteht aus den Seiten (hier: Seite 1,Seite 2, Seite n). Die Inhalte der Seiten sind Absätze (Eingabefelder, Texte, Bilder, Links etc....) die letztendlich den Aufbau des Formulars widerspiegeln. Bei komplexeren Prozessen werden neben sichtbaren Seiten (also Seiten die der User angezeigt bekommt) auch so genannte Transaktionsseiten angelegt. Diese Seiten führen Hintergrundprozesse aus wie z.B. Schnittstellenaufrufe, Emailversand, PDF-Generierung, etc..