ASCII-Deskriptor | X4Documentation

Ein (ASCII-)Deskriptor ist ein XML-Dokument, das die Struktur von Datensätzen in einer Textdatei beschreibt und u. a. den Adaptern

ASCII Writer

COBOL Copybook Writer

und

COBOL Copybook Reader

als Regeldatei zur Konvertierung zwischen Text- und XML-Daten dient. Der Repository-Pfad von Deskriptor-Dokumenten wird in diesen Adaptern als Parameter angegeben. Deskriptoren werden also in der Regel nicht als eigener Baustein in Prozesse eingebunden.

Für Textdateien im Cobol Copybook-Format können Sie ein spezifisches Deskriptor-Dokument über den Cobol Copybook to XML Wizard automatisch erzeugen. Für CSV-Textdokumente verwenden Sie den CSV Converter.

Elemente

`<Descriptor>`	Wurzelelement. Enthält ein oder mehrere Elemente `<Record>` sowie die unten genannten Attribute.
`<Record>`	Entspricht einem Datensatz in der Textdatei. Kann ein oder mehrere Elemente `<Column>` oder `<Record>` sowie die unten genannten Attribute enthalten.
`<Column>`	Entspricht einer Spalte bzw. einem konkreten Wert in der Textdatei und besitzt die unten genannten Attribute, darf aber keine Kindelemente besitzen.

Attribute von <Descriptor>

Attribut	Beschreibung
`Id`	ID des Datensatzes (optional) Das Attribut wird im ASCII Reader und ASCII Writer verwendet.
`Name`	Name des Wurzelelements im XML-Dokument Das Attribut wird im GDV Message Writer sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet.
`Description`	Beschreibungstext für den ASCII-Deskriptor (optional)
`RecordSeparator`	Trennzeichen für die einzelnen Datensätze (optional) Das Attribut wird im GDV Message Writer, im ASCII Reader (`EscapedString`) und ASCII Writer (`EscapedString`) sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet. Im Falle von `EscapedString` werden einige Escape-Zeichen automatisch ersetzt: `\n`: neue Zeile (`newline`) `\r`: Wagenrücklauf (`carriage return`) `\t`: Tab – Cursor um einen vorgegebenen Abstand weiterrücken (`tab`) `\u....`: Hexadezimalzahlen mit 4 Ziffern werden in ganze Zahlen umgewandelt, z.B. `\u00FF` zu `255`
`Columns`	Erforderliche Spaltenanzahl des Datensatzes (optional) Das Attribut wird im ASCII Reader (`integer`) und ASCII Writer (`integer`) verwendet.
`RecordOrder`	Reihenfolge der einzelnen Datensätze (optional) Mögliche Werte: `Fix`: Die Reihenfolge bleibt wie in der Textdatei. `Loose`: Die Reihenfolge aus dem ASCII-Deskriptor wird übernommen. Das Attribut wird im ASCII Reader und ASCII Writer verwendet.
`RecordLength`	Länge der einzelnen Datensätze (optional) Das Attribut wird im GDV Message Reader (`integer`) verwendet.
`Identifier`	Wert des Datensatz-Identifikators (optional) Das Attribut wird im ASCII Reader (`String`) und ASCII Writer (`String`) verwendet.
`IdentifierPos`	Position der Datensatz-Identifikatoren (optional) Das Attribut wird im GDV Message Reader (`integer`) , im ASCII Reader (`integer`) und ASCII Writer (`integer`) sowie im COBOL Copybook Writer (`integer`) und COBOL Copybook Reader (`integer`) verwendet.
`IdentifierLength`	Länge der Datensatz-Identifikatoren (optional) Das Attribut wird im GDV Message Reader (`integer`) , im ASCII Reader (`integer`) und ASCII Writer (`integer`) sowie im COBOL Copybook Writer (`integer`) und COBOL Copybook Reader (`integer`) verwendet.
`TeilsatzPos`	Gibt die Position innerhalb der Record-Daten an Das Attribut wird im GDV Message Reader (`integer`) verwendet. Mögliche Werte: `Identifier = TeilsatzPos`: Sub-Records werden gelesen. `0`: Es werden alle Sub-Records gelesen.
`Suffix`	Suffix-Angabe (optional). Markiert das Ende eines Datensatzes. Das Attribut wird im ASCII Reader (`EscapedString`) und ASCII Writer (`EscapedString`) verwendet. Im Falle von `EscapedString` werden einige Escape-Zeichen automatisch ersetzt:\n: neue Zeile (newline) \r: Wagenrücklauf (carriage return)\t: Tab – Cursor um einen vorgegebenen Abstand weiterrücken (tab) \u....: Hexadezimalzahlen mit 4 Ziffern werden in ganze Zahlen umgewandelt, z.B. \u00FF zu 255
`Prefix`	Präfix-Angabe (optional). Markiert den Beginn eines Datensatzes. Das Attribut wird im ASCII Reader (`EscapedString`) und ASCII Writer (`EscapedString`) verwendet. Im Falle von `EscapedString` werden einige Escape-Zeichen automatisch ersetzt:\n: neue Zeile (newline) \r: Wagenrücklauf (carriage return)\t: Tab – Cursor um einen vorgegebenen Abstand weiterrücken (tab) \u....: Hexadezimalzahlen mit 4 Ziffern werden in ganze Zahlen umgewandelt, z.B. \u00FF zu 255
`Mandatory`	Datensatz als Pflichtdatensatz deklarieren (optional) Das Attribut wird im ASCII Reader und ASCII Writer verwendet. Mögliche Werte: `true`: Pflichtdatensatz `false`: kein Pflichtdatensatz
`Multiple`	Datensatz kann mehrfach vorhanden sein (optional) Das Attribut wird im ASCII Reader und ASCII Writer verwendet. Mögliche Werte: `true`: Datensatz kann mehrfach vorhanden sein (siehe Attribut `Occurs`). Das Attribut `Occurs` muss hierbei einen Wert enthalten, da sonst der Fehler `java.lang.NumberFormatException: null` ausgegeben wird. `false`: Datensatz darf nur einmal vorhanden sein.
`Length`	Erforderliche Länge des Datensatzes in Zeichen (optional) Das Attribut wird im ASCII Reader (`LengthFormat`) und ASCII Writer (`LengthFormat`) verwendet.
`Separator`	Trennzeichen für die einzelnen Datensätze (optional) Das Attribut wird im ASCII Reader (`EscapedString`) und ASCII Writer (`EscapedString`) verwendet. Im Falle von `EscapedString` werden einige Escape-Zeichen automatisch ersetzt:\n: neue Zeile (newline) \r: Wagenrücklauf (carriage return)\t: Tab – Cursor um einen vorgegebenen Abstand weiterrücken (tab) \u....: Hexadezimalzahlen mit 4 Ziffern werden in ganze Zahlen umgewandelt, z.B. \u00FF zu 255

Attribute von <Record>

Attribut	Beschreibung
`Id`	ID des Datensatzes (optional) Das Attribut wird im ASCII Reader (`String`) und ASCII Writer (`String`) sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet.
`Name`	Name der Datensatz-Elemente im XML-Dokument Das Attribut wird im GDV Message Reader und im GDV Message Writer, im ASCII Reader (`String`) und ASCII Writer (`String`) sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet.
`Prefix`	Präfix-Angabe (optional). Markiert den Beginn eines Datensatzes. Das Attribut wird im ASCII Reader (`EscapedString`) und ASCII Writer (`EscapedString`) sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet. Im Falle von `EscapedString` werden einige Escape-Zeichen automatisch ersetzt:\n: neue Zeile (newline) \r: Wagenrücklauf (carriage return)\t: Tab – Cursor um einen vorgegebenen Abstand weiterrücken (tab) \u....: Hexadezimalzahlen mit 4 Ziffern werden in ganze Zahlen umgewandelt, z.B. \u00FF zu 255
`Suffix`	Suffix-Angabe (optional). Markiert das Ende eines Datensatzes. Das Attribut wird im ASCII Reader (`EscapedString`) und ASCII Writer (`EscapedString`) sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet. Im Falle von `EscapedString` werden einige Escape-Zeichen automatisch ersetzt:\n: neue Zeile (newline) \r: Wagenrücklauf (carriage return)\t: Tab – Cursor um einen vorgegebenen Abstand weiterrücken (tab) \u....: Hexadezimalzahlen mit 4 Ziffern werden in ganze Zahlen umgewandelt, z.B. \u00FF zu 255
`Mandatory`	Datensatz als Pflichtdatensatz deklarieren (optional) Das Attribut wird im ASCII Reader und ASCII Writer sowie im COBOL Copybook Writer und COBOL Copybook Reader verwendet. Mögliche Werte: `true`: Pflichtdatensatz `false`: kein Pflichtdatensatz
`Multiple`	Datensatz kann mehrfach vorhanden sein (optional) Das Attribut wird im ASCII Reader und ASCII Writer sowie im COBOL Copybook Writer und COBOL Copybook Reader verwendet. Mögliche Werte: `true`: Datensatz kann mehrfach vorhanden sein (siehe Attribut `Occurs`). Das Attribut `Occurs` muss hierbei einen Wert enthalten, da sonst der Fehler `java.lang.NumberFormatException: null` ausgegeben wird. `false`: Datensatz darf nur einmal vorhanden sein.
`IdentifierPos`	Position der Datensatz-Identifikatoren (optional) Das Attribut wird im ASCII Reader (`integer`) und im ASCII Writer (`integer`) verwendet.
`IdentifierLength`	Länge der Datensatz-Identifikatoren (optional) Das Attribut wird im ASCII Reader (`integer`) und im ASCII Writer (`integer`) verwendet.
`Identifier`	Wert des Datensatz-Identifikators (optional) Das Attribut wird im GDV Message Reader und im GDV Message Writer, im ASCII Reader (`String`) und ASCII Writer (`String`) sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet.
`ColumnSeparator`	Spalten-Trennzeichen (optional) Das Attribut wird im ASCII Reader (`EscapedString`) und ASCII Writer (`EscapedString`) sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet. Im Falle von `EscapedString` werden einige Escape-Zeichen automatisch ersetzt:\n: neue Zeile (newline) \r: Wagenrücklauf (carriage return)\t: Tab – Cursor um einen vorgegebenen Abstand weiterrücken (tab) \u....: Hexadezimalzahlen mit 4 Ziffern werden in ganze Zahlen umgewandelt, z.B. \u00FF zu 255
`Columns`	Erforderliche Spaltenanzahl des Datensatzes (optional)
`ColumnOrder`	Reihenfolge der Spalten Das Attribut wird im ASCII Reader und im ASCII Writer verwendet. Mögliche Werte: `Fix`: Die Reihenfolge bleibt wie in der Text-Datei. `Loose`: Die Reihenfolge aus dem ASCII-Deskriptor wird übernommen.
`Occurs`	Anzahl der Wiederholungen des Datensatzes Das Attribut wird im ASCII Reader (`integer`) und ASCII Writer (`integer`) sowie im COBOL Copybook Writer (`integer`) und COBOL Copybook Reader (`integer`) verwendet.
`Description`	Beschreibungstext für den Datensatz (optional)
`Length`	Erforderliche Länge des Datensatzes in Zeichen (optional) Das Attribut wird im GDV Message Reader (`integer`), im ASCII Reader (`LengthFormat`) und ASCII Writer (`LengthFormat`) sowie im COBOL Copybook Writer (`integer`) und COBOL Copybook Reader (`integer`) verwendet.

Attribute von <Column>

Attribut	Beschreibung
`Id`	Spalten-ID (optional) Das Attribut wird im ASCII Reader (`String`) und ASCII Writer (`String`) sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet.
`Name`	Name des Feld-Elements im XML-Dokument Das Attribut wird im GDV Message Reader (`String`), im ASCII Reader (`String`) und ASCII Writer (`String`) sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet.
`Type`	Datentyp der Spalte bzw. des Felds Das Attribut wird im GDV Message Writer (`Integer\|String`), im ASCII Reader (`Integer\|String`) und ASCII Writer (`Integer\|String`) sowie im COBOL Copybook Writer (`Integer\|String`) und COBOL Copybook Reader (`Integer\|String`) verwendet. Mögliche Werte: `String`: Zeichenkette `Number`: Zahlenwert
`Prefix`	Präfix-Angabe (optional). Markiert den Beginn eines Feldwerts. Das Attribut wird im ASCII Reader (`EscapedString`) und ASCII Writer (`EscapedString`) sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet. Im Falle von `EscapedString` werden einige Escape-Zeichen automatisch ersetzt:\n: neue Zeile (newline) \r: Wagenrücklauf (carriage return)\t: Tab – Cursor um einen vorgegebenen Abstand weiterrücken (tab) \u....: Hexadezimalzahlen mit 4 Ziffern werden in ganze Zahlen umgewandelt, z.B. \u00FF zu 255
`Suffix`	Suffix-Angabe (optional). Markiert das Ende eines Feldwerts.
`Mandatory`	Feld als Pflichtfeld deklarieren (optional) Das Attribut wird im ASCII Reader und ASCII Writer sowie im COBOL Copybook Writer und COBOL Copybook Reader verwendet. Mögliche Werte: `true`: Pflichtfeld `false`: kein Pflichtfeld
`Multiple`	Feld kann mehrfach vorhanden sein (optional) Das Attribut wird im ASCII Reader und ASCII Writer verwendet. Mögliche Werte: `true`: Feld kann mehrfach vorhanden sein. `false`: Feld darf nur einmal vorhanden sein.
`IdentifierPos`	Position der Spalten-Identifikatoren (optional) Das Attribut wird im ASCII Reader (`integer`) und ASCII Writer (`integer`) verwendet.
`IdentifierLength`	Länge der Spalten-Identifikatoren (optional) Das Attribut wird im ASCII Reader (`integer`) und ASCII Writer (`integer`) verwendet.
`Identifier`	Wert des Spalten-Identifikators (optional) Das Attribut wird im ASCII Reader (`String`) und ASCII Writer (`String`) verwendet.
`Default`	Standardwert des Felds (nur bei Pflichtfeldern) Das Attribut wird im ASCII Reader (`String`) und ASCII Writer (`String`) sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet.
`Regex`	Regulärer Ausdruck, der die Spaltenwerte beschreibt (optional) Das Attribut wird im ASCII Reader (`String`) und ASCII Writer (`String`) sowie im COBOL Copybook Writer (`String`) und COBOL Copybook Reader (`String`) verwendet. Beispiel: `[0-9a-fA-F]+.`
`Length`	Erforderliche Feldlänge in Zeichen (optional) Das Attribut wird im GDV Message Reader (`integer`) und im GDV Message Writer (`integer`), im ASCII Reader (`LengthFormat`) und ASCII Writer (`LengthFormat`) sowie im COBOL Copybook Writer (`LengthFormat`) und COBOL Copybook Reader (`LengthFormat`) verwendet. Im COBOL Copybook Writer und COBOL Copybook Reader sind folgende Wert-Angaben möglich: `ganze Zahlen`: z.B. 10 wird als 10,0 interpretiert `keine Angabe`: wird als 0,0 interpretiert `Dezimalzahlen`: z.B. 10.2 wird als 10,2 interpretiert
`RecordMultiplicator`	Datensatz wiederholen Das Attribut wird im COBOL Copybook Writer und COBOL Copybook Reader verwendet. Mögliche Werte: `true`: spezielles Feld (angegeben in `RecordMultiplicated`) wiederholen `false`: Feld nicht wiederholen
`RecordMultiplicated`	ID des mehrfach auftretenden Datensatzes (falls `RecordMultiplicator` auf `true` gesetzt wurde) Das Attribut wird im COBOL Copybook Writer (`integer`) und COBOL Copybook Reader (`integer`) verwendet.
`Binary`	Beim Lesen/Schreiben werden die Daten von Base64 nach binär bzw. von binär nach Base64 kodiert Das Attribut wird im COBOL Copybook Writer und COBOL Copybook Reader verwendet.
`Occurs`	Anzahl der Wiederholungen der Spalte Das Attribut wird im COBOL Copybook Writer (`integer`) und COBOL Copybook Reader (`integer`) verwendet.