Ausgabeformat "Text"
Dieses Ausgabeformat generiert aus den Indexdaten des Dokumentes eine einfache Textdatei ("plain text"). In die Textdatei können Referenzen auf die Dateianlagen eingebunden werden.
Abweichend vom Standard werden die auszugebenden Felder nicht über OutputFormat[].Fields[] definiert. Stattdessen müssen die Felder direkt als Variablen in die zu konfigurierende Textvorlage eingefügt werden, die den Inhalt der Ausgabedatei beschreibt. Die Variablen sind in der Syntax %{Variablenname}% anzugeben. Der Name entspricht bei Indexfeldern dem Namen der Eigenschaft .Field[].Name im Feldkatalog.
Die zusätzliche Angabe einer Ausgabefelddefinition ist nur erforderlich, wenn für einen typisierten Wert eine spezielle Formatierung seiner Textrepräsentation gewünscht ist. Dabei ist nur das .Fields[].OutputFormat zu setzen. Der .Fields[].OutputName hat hier keine Relevanz.
Eigenschaft | Beschreibung |
|---|---|
OutputFormat[].Line[]* OutputFormat[].ItemLine[] OutputFormat[].AttachFileLine[] | Über diese Konfigurationseigenschaften wird die Textvorlage definiert, die den Inhalt der Ausgabedatei beschreibt. Die Definition erfolgt zeilenweise, d.h. jeder Array-Eintrag entspricht einer Ausgabezeile.
Zur Laufzeit werden diese Fragmente entsprechend der Anzahl der Tabellenpositionen/Dateianlagen ggf. mehrfach generiert, zu einem Block zusammengefügt und an einer vorgegebenen Position in die primären Zeilen eingefügt. Diese Einfügeposition ist durch die internen Variablen In den Zeilen aller 3 Eigenschaften können Variablen für Kopfdatenfelder sowie allgemeine Dokument-, System- und Umgebungsvariablen genutzt werden. Nur in In Als generelle funktionale Einschränkung gilt für dieses Ausgabeformat, dass keine multiplen Tabellen von Indexdaten innerhalb eines Dokumentes unterstützt werden, sondern nur maximal eine Tabelle. |
OutputFormat[].LineFeed(#) | Zeilenumbruchzeichen, die zur Trennung der definierten Ausgabezeilen genutzt werden Standardwert: |
OutputFormat[].ItemLineSep(#) OutputFormat[].AttachFileSep(#) | optionale Angabe von Trennzeichen Mit diesen Trennzeichen werden die multiplen Fragmente voneinander abgegrenzt, die über Standardmäßig erfolgt die Trennung mit dem Zeilenumbruch, der in |
OutputFormat[].Encoding | Zeichenkodierung der zu erstellenden Textdatei (siehe Verschiedenes) Standardwert: |
Das folgende Beispiel zeigt einen Auszug der Konfiguration für ein Dokument mit 2 Tabellenzeilen und 2 Dateianlagen sowie den Aufbau der Textdatei, die daraus resultiert.
{
"OutputFormat": [
{
"Line": [
"--- DOCUMENT ---"
"Field 1: %Field1%",
"--- ITEMS ---",
"%ItemLine%",
"--- ATTACHMENTS ---",
"%AttachFileLine%"
],
"ItemLine": [
"(#%ItemNo%) Items Field 1: %Items.Field1%"
],
"AttachFileLine": [
"(#%FileNo%) Name: %FileName%"
]
}
]
}Aufbau der generierten Textdatei:
--- DOCUMENT --- Field 1: … --- ITEMS --- (#1) Items Field 1: … (#2) Items Field 1: … --- ATTACHMENTS --- (#1) Name: … (#2) Name: …