Von der XML-Datei zum Dokument
Jede Dokumentvorlage in intracon:bk wird als XML-Datei beschrieben.
Diese XML-Datei stellt jedoch nicht das fertige Dokument dar. Sie beschreibt vielmehr, wie das Dokument aufgebaut ist und welche Inhalte während der Dokumenterzeugung eingefügt oder berechnet werden sollen.
Während der Dokumenterzeugung verarbeitet intracon:bk die XML-Datei Schritt für Schritt und erzeugt daraus das endgültige Dokument.
Das Verständnis dieses Ablaufs hilft dabei,
- Dokumentvorlagen besser zu strukturieren,
- Fehler schneller zu analysieren,
- das Verhalten einzelner XML-Elemente nachzuvollziehen und
- komplexe Dokumentvorlagen leichter zu entwickeln.
Der grundsätzliche Ablauf
Vereinfacht betrachtet besteht die Dokumenterzeugung aus mehreren aufeinanderfolgenden Verarbeitungsschritten.
XML-Dokumentvorlage
│
▼
Einlesen der XML-Datei
│
▼
Auflösen von Parametern und Variablen
│
▼
Auswertung von Bedingungen
│
▼
Ausführen von Funktionen
│
▼
Einbinden von Dokumentbausteinen
│
▼
Erzeugen des fertigen DokumentsDie tatsächliche Verarbeitung erfolgt intern wesentlich detaillierter. Für das Verständnis einer Dokumentvorlage genügt jedoch dieses vereinfachte Modell.
Die XML-Datei
Eine Dokumentvorlage beschreibt nicht das fertige Dokument, sondern dessen Aufbau.
Dabei wird festgelegt,
- welche Inhalte ausgegeben werden,
- welche Variablen verwendet werden,
- welche Berechnungen durchgeführt werden,
- welche Bedingungen gelten und
- welche Dokumentbausteine eingebunden werden.
Die XML-Datei bildet damit die Grundlage der gesamten Dokumenterzeugung.
Variablen und Parameter
Während der Dokumenterzeugung ersetzt intracon:bk die in der XML-Datei verwendeten Variablen durch ihre tatsächlichen Werte.
Diese Werte können beispielsweise stammen aus
- dem BK-Auftrag,
- Parametern der Dokumentvorlage,
- Konstanten,
- Benutzerinformationen oder
- anderen Datenquellen.
Die XML-Datei enthält daher meist keine festen Inhalte, sondern beschreibt lediglich, welche Informationen ausgegeben werden sollen.
Bedingungen
Nicht jeder Inhalt wird immer ausgegeben.
Mit XML-Elementen wie <If> oder <Case> kann die Dokumentvorlage entscheiden,
- ob ein Inhalt ausgegeben wird,
- welcher Text verwendet wird oder
- welcher Dokumentbaustein eingebunden werden soll.
Dadurch kann dieselbe Dokumentvorlage auf unterschiedliche fachliche Situationen reagieren.
Funktionen
Neben der Ausgabe von Texten und Variablen können während der Dokumenterzeugung weitere Verarbeitungsschritte durchgeführt werden.
Hierzu gehören beispielsweise
- mathematische Berechnungen,
- Datumsberechnungen,
- Zeichenkettenverarbeitung oder
- weitere Funktionen der XML-Sprache.
Das Ergebnis einer Funktion kann anschließend direkt ausgegeben oder für spätere Verarbeitungsschritte gespeichert werden.
Dokumentbausteine
Viele Dokumente enthalten wiederkehrende Inhalte.
Hierzu gehören beispielsweise
- Briefköpfe,
- Signaturen,
- Datenschutzhinweise,
- Standardtexte oder
- Fußzeilen.
Anstatt diese Inhalte mehrfach zu pflegen, können sie als Dokumentbaustein zentral verwaltet und über <Reference> in verschiedene Dokumentvorlagen eingebunden werden.
Dadurch bleibt die Dokumentvorlage übersichtlich und Änderungen müssen nur an einer Stelle vorgenommen werden.
Das fertige Dokument
Nachdem alle Verarbeitungsschritte abgeschlossen wurden, erzeugt intracon:bk das endgültige Dokument.
Zu diesem Zeitpunkt
- wurden alle Variablen aufgelöst,
- Bedingungen ausgewertet,
- Funktionen ausgeführt,
- Dokumentbausteine eingefügt und
- sämtliche Inhalte in ihre endgültige Form gebracht.
Erst dieses Ergebnis wird anschließend dem nachgelagerten Prozess zur weiteren Verwendung bereitgestellt.
Warum dieses Wissen wichtig ist
Viele Fragestellungen lassen sich leichter beantworten, wenn der grundsätzliche Ablauf der Dokumenterzeugung bekannt ist.
Beispiele:
- Warum liefert eine Variable keinen Wert?
- Weshalb wird ein
<If>nicht ausgeführt? - Warum steht ein mit
<Setter>gespeicherter Wert nicht zur Verfügung? - Weshalb wird ein Dokumentbaustein nicht eingebunden?
- Warum unterscheidet sich das Ergebnis von der XML-Struktur?
Das Verständnis des Verarbeitungsablaufs hilft dabei, solche Fragestellungen systematisch zu analysieren.
Weiterführende Artikel
Die einzelnen Verarbeitungsschritte werden in den folgenden Bereichen des XML-Handbuchs ausführlich beschrieben.
- Dokumentstruktur – Aufbau einer Dokumentvorlage
- Inhalte – Text, Variablen, Dokumentbausteine und weitere Inhaltselemente
- Bedingungen und Schleifen – Steuerung des Dokumentablaufs
- Funktionen – Berechnungen und weitere Verarbeitungsfunktionen
Hinweis
Dieser Artikel beschreibt den grundsätzlichen Ablauf der Dokumenterzeugung in vereinfachter Form.
Er dient als Einstieg in die Arbeitsweise von intracon:bk und wird im Laufe der Dokumentation kontinuierlich erweitert, sobald weitere XML-Elemente und deren Zusammenspiel beschrieben werden.