ASCII Descriptor

An (ASCII) descriptor is an XML document describing the structure of data records in a text file. It serves the adapters ASCII Writer, COBOL Copybook Writer and COBOL Copybook Reader as rules definition for the conversion between text and XML. The repository path of descriptor documents is specified in this adapters as parameter. Thus, descriptors normally are not included as own process component into processes.

For text files in Cobol Copybook format, you can generate a specific descriptor document using the Cobol Copybook to XML Wizard automatically. For CSV text documents, you can use the CSV Converter.

Elements

`<Descriptor>`	Root element. Contains one or multiple elements `<Record>`, as well as attributes described below.
`<Record>`	Corresponds to a data record in the text file. It can contain one or multiple elements `<Column>` or `<Record>`, as well as attributes described below.
`<Column>`	Corresponds to a column, i.e., a concrete value in the text file, and has attributes described below, but it may not have child elements.

Attributes of <Descriptor>

Attribute	Description
`Id`	Data record ID (optional) The attribute is used within the ASCII Reader and ASCII Writer.
`Name`	Name of the root element in the XML document The attribute is used within the GDV Message Writer, the COBOL Copybook Writer (`String`) and the COBOL Copybook Reader (`String`).
`Description`	Description text for the ASCII descriptor (optional)
`RecordSeparator`	Separator for the data records (optional) The attribute is used within the GDV Message Writer, the ASCII Reader (`EscapedString`) and ASCII Writer (`EscapedString`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`). In case of `EscapedString` some escape characters are replaced automatically: `\n`: new line (`newline`) `\r`: carriage return (`carriage return`) `\t`: Tab – move the cursor forward by a specified space (`tab`) `\u....`: hexadecimal numbers with 4 digits are converted to integer, e.g., `\u00FF` to `255`
`Columns`	Required number of columns of the data record (optional) The attribute is used within the ASCII Reader (`integer`) and ASCII Writer (`integer`).
`RecordOrder`	Order of the single data records (optional) The attribute is used within the ASCII Reader and ASCII Writer. Possible values: `Fix`: the order remains as in text file `Loose`: the order from the ASCII descriptor is adopted
`RecordLength`	Length of the single data records (optional) The attribute is used within the GDV Message Reader (`integer`) .
`Identifier`	Value of the data record identifier (optional) The attribute is used within the ASCII Reader (`String`) and ASCII Writer (`String`).
`IdentifierPos`	Position of the data record identifier (optional) The attribute is used within the GDV Message Reader (`integer`), the ASCII Reader (`integer`) and ASCII Writer (`integer`) and the COBOL Copybook Writer (`integer`) and COBOL Copybook Reader (`integer`).
`IdentifierLength`	Lenght of the data record identifier (optional) The attribute is used within the GDV Message Reader (`integer`), the ASCII Reader (`integer`) and ASCII Writer (`integer`) and the COBOL Copybook Writer (`integer`) and COBOL Copybook Reader (`integer`).
`TeilsatzPos`	Specifies the position within the record data The attribute is used within the GDV Message Reader (`integer`) . Possible values: `Identifier = TeilsatzPos`: sub-records are read `0`: all sub-records are read
`Suffix`	Suffix (optional). Marks the end of a data record. The attribute is used within the ASCII Reader (`EscapedString`) and ASCII Writer (`EscapedString`) . In case of `EscapedString` some escape characters are replaced automatically: `\n`: new line (`newline`) `\r`: carriage return (`carriage return`) `\t`: Tab – move the cursor forward by a specified space (`tab`) `\u....`: hexadecimal numbers with 4 digits are converted to integer, e.g., `\u00FF` to `255`
`Prefix`	Prefix (optional). Marks the beginning of a data record The attribute is used within the ASCII Reader (`EscapedString`) and ASCII Writer (`EscapedString`) . In case of `EscapedString` some escape characters are replaced automatically: `\n`: new line (`newline`) `\r`: carriage return (`carriage return`) `\t`: Tab – move the cursor forward by a specified space (`tab`) `\u....`: hexadecimal numbers with 4 digits are converted to integer, e.g., `\u00FF` to `255`
`Mandatory`	Declare data record as mandatory (optional) The attribute is used within the ASCII Reader and ASCII Writer. Possible values: `true`: mandatory data record `false`: no mandatory data record
`Multiple`	Data record can exist multiple times (optional) The attribute is used within the ASCII Reader and ASCII Writer. Possible values: `true`: Data record can exist multiple times (see attribute `Occurs`) The attribute `Occurs` must contain a value, otherwise the error `java.lang.NumberFormatException: null` will be output. `false`: Data record can exist only once.
`Length`	Required length of the data record in characters (optional) The attribute is used within the ASCII Reader (`LengthFormat`) and ASCII Writer (`LengthFormat`).
`Separator`	Separator for the data records (optional) The attribute is used within the ASCII Reader (`EscapedString`) and ASCII Writer (`EscapedString`) . In case of `EscapedString` some escape characters are replaced automatically: `\n`: new line (`newline`) `\r`: carriage return (`carriage return`) `\t`: Tab – move the cursor forward by a specified space (`tab`) `\u....`: hexadecimal numbers with 4 digits are converted to integer, e.g., `\u00FF` to `255`

Attributes of <Record>

Attribute	Description
`Id`	ID of the data record The attribute is used within the ASCII Reader (`String`) and ASCII Writer (`String`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`).
`Name`	Name of the data record elements in the XML document The attribute is used within the GDV Message Reader and GDV Message Writer, the ASCII Reader (`String`) and ASCII Writer (`String`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`).
`Prefix`	Prefix (optional). Marks the beginning of a data record. The attribute is used within the ASCII Reader (`EscapedString`) and ASCII Writer (`EscapedString`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`). In case of `EscapedString` some escape characters are replaced automatically: `\n`: new line (`newline`) `\r`: carriage return (`carriage return`) `\t`: Tab – move the cursor forward by a specified space (`tab`) `\u....`: hexadecimal numbers with 4 digits are converted to integer, e.g., `\u00FF` to `255`
`Suffix`	Suffix (optional). Marks the end of a data record. The attribute is used within the ASCII Reader (`EscapedString`) and ASCII Writer (`EscapedString`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`). In case of `EscapedString` some escape characters are replaced automatically: `\n`: new line (`newline`) `\r`: carriage return (`carriage return`) `\t`: Tab – move the cursor forward by a specified space (`tab`) `\u....`: hexadecimal numbers with 4 digits are converted to integer, e.g., `\u00FF` to `255`
`Mandatory`	Declare data record as mandatory (optional) The attribute is used within the ASCII Reader and ASCII Writer and the COBOL Copybook Writer and COBOL Copybook Reader. Possible values: `true`: mandatory data record `false`: no mandatory data record
`Multiple`	Data record can exist multiple times (optional) The attribute is used within the ASCII Reader and ASCII Writer and the COBOL Copybook Writer and COBOL Copybook Reader. Possible values: `true`: Data record can exist multiple times (see attribute `Occurs`) The attribute `Occurs` must contain a value, otherwise the error `java.lang.NumberFormatException: null` will be output. `false`: Data record can exist only once.
`IdentifierPos`	Position of the data record identifier (optional) The attribute is used within the ASCII Reader (`integer`) and ASCII Writer (`integer`).
`IdentifierLength`	Length of the data record identifier (optional) The attribute is used within the ASCII Reader (`integer`) and ASCII Writer (`integer`).
`Identifier`	Value of the data record identifier (optional) The attribute is used within the GDV Message Writer and GDV Message Reader, the ASCII Reader (`String`) and ASCII Writer (`String`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`).
`ColumnSeparator`	Column separator (optional) The attribute is used within the ASCII Reader (`EscapedString`) and ASCII Writer (`EscapedString`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`). In case of `EscapedString` some escape characters are replaced automatically: `\n`: new line (`newline`) `\r`: carriage return (`carriage return`) `\t`: Tab – move the cursor forward by a specified space (`tab`) `\u....`: hexadecimal numbers with 4 digits are converted to integer, e.g., `\u00FF` to `255`
`Columns`	Number of required columns of the data record (optional)
`ColumnOrder`	Order of the single columns (optional) The attribute is used within the ASCII Reader and ASCII Writer. Possible values: `Fix`: the order remains as in text file `Loose`: the order from the ASCII descriptor is adopted
`Occurs`	Number of repetitions of the data record The attribute is used within the ASCII Reader (`integer`) and ASCII Writer (`integer`) and the COBOL Copybook Writer (`integer`) and COBOL Copybook Reader (`integer`).
`Description`	Description text for the data record (optional)
`Length`	Required length of the data record in characters (optional) The attribute is used within the GDV Message Reader (`integer`), the ASCII Reader (`integer`) and ASCII Writer (`integer`) and the COBOL Copybook Writer (`integer`) and COBOL Copybook Reader (`integer`).

Attributes of <Column>

Attribute	Description
`Id`	Column ID (optional) The attribute is used within the ASCII Reader (`String`) and ASCII Writer (`String`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`).
`Name`	Name of the field element within the XML document The attribute is used within the GDV Message Reader (`String`), the ASCII Reader (`String`) and ASCII Writer (`String`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`).
`Type`	Data type of the column/field The attribute is used within the GDV Message Writer (`Integer\|String`), the ASCII Reader (`Integer\|String`) and ASCII Writer (`Integer\|String`) and the COBOL Copybook Writer (`Integer\|String`) and COBOL Copybook Reader (`Integer\|String`). Possible values: `String`: string value `Number`: numeric value
`Prefix`	Prefix (optional). Marks the beginning of a field value. The attribute is used within the ASCII Reader (`EscapedString`) and ASCII Writer (`EscapedString`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`). In case of `EscapedString` some escape characters are replaced automatically: `\n`: new line (`newline`) `\r`: carriage return (`carriage return`) `\t`: Tab – move the cursor forward by a specified space (`tab`) `\u....`: hexadecimal numbers with 4 digits are converted to integer, e.g., `\u00FF` to `255`
`Suffix`	Suffix (optional). Marks the end of a field value. The attribute is used within the ASCII Reader (`EscapedString`) and ASCII Writer (`EscapedString`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`). In case of `EscapedString` some escape characters are replaced automatically: `\n`: new line (`newline`) `\r`: carriage return (`carriage return`) `\t`: Tab – move the cursor forward by a specified space (`tab`) `\u....`: hexadecimal numbers with 4 digits are converted to integer, e.g., `\u00FF` to `255`
`Mandatory`	Declare as mandatory field (optional) The attribute is used within the ASCII Reader and ASCII Writer and the COBOL Copybook Writer and COBOL Copybook Reader. Possible values: `true`: mandatory field `false`: no mandatory field
`Multiple`	Field can exist multiple times (optional) The attribute is used within the ASCII Reader and ASCII Writer. Possible values: `true`: Field can exist multiple times `false`: Field can exist only once
`IdentifierPos`	Position of the column identifier (optional) The attribute is used within the ASCII Reader (`integer`) and ASCII Writer (`integer`).
`IdentifierLength`	Length of the column identifier (optional) The attribute is used within the ASCII Reader (`integer`) and ASCII Writer (`integer`).
`Identifier`	Value of the column identifier (optional) The attribute is used within the ASCII Reader (`integer`) and ASCII Writer (`integer`).
`Default`	Default value of the field (only for mandatory fields) The attribute is used within the ASCII Reader (`String`) and ASCII Writer (`String`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`).
`Regex`	Regular expression describing the column values (optional) The attribute is used within the ASCII Reader (`String`) and ASCII Writer (`String`) and the COBOL Copybook Writer (`String`) and COBOL Copybook Reader (`String`). Example: `[0-9a-fA-F]+.`
`Length`	Required field length in characters (optional) The attribute is used within the GDV Message Writer (`integer`) and GDV Message Reader (`integer`), the ASCII Reader (`LengthFormat`) and ASCII Writer (`LengthFormat`) and the COBOL Copybook Writer (`LengthFormat`) and COBOL Copybook Reader (`LengthFormat`). Within COBOL Copybook Writer and COBOL Copybook Reader the following values are possible: `integers`: e.g., 10 is interpreted as 10.0 `no value`: is interpreted as 0.0 `decimals`: e.g., 10,2 is interpreted as 10.2
`RecordMultiplicator`	Repeat data record The attribute is used within the COBOL Copybook Writer and COBOL Copybook Reader. Possible values: `true`: repeat field (specified in `RecordMultiplicated`) `false`: do not repeat field
`RecordMultiplicated`	ID of the multiple occurring data record (if `RecordMultiplicator` is set to `True`) The attribute is used within the COBOL Copybook Writer (`integer`) and COBOL Copybook Reader (`integer`).
`Binary`	When reading/writing the data is encoded from Base64 to binary or from binary to Base64 The attribute is used within the COBOL Copybook Writer and COBOL Copybook Reader.
`Occurs`	Number of repetitions of the column The attribute is used within the COBOL Copybook Writer (`integer`) and COBOL Copybook Reader (`integer`).