Delimited Text Data Type
The Delimited Text data type is a very powerful and flexible data type that can satisfy many common formats like CSV, but also many proprietary formats that are dependent on custom delimiters, fixed-width columns, or other nuances. The following properties are configurable:
Serialization / Template Serialization / Deserialization Properties
Name | Default Value | Description |
---|---|---|
Column Delimiter | , | If column values are delimited, enter the characters that separate columns. For example, this is a comma in a CSV file. |
Record Delimiter | \n | Enter the characters that separate each record (a message may contain multiple records). For example, this is a newline (\n) in a CSV file. |
Column Widths | If the column values are fixed width, enter a comma separated list of fixed column widths. By default, column values are assumed to be delimited. | |
Quote Token | " | Enter the quote characters that are used to bracket delimit column values containing embedded special characters like column delimiters, record delimiters, quote characters and/or message delimiters. For example, this is a double quote (") in a CSV file. |
Double Quote Escaping | Enabled | By default, two consecutive quote tokens within a quoted value are treated as an embedded quote token. Uncheck to enable escaped quote token processing (and specify the Escape Tokens). |
Escape Token | \ | Enter the characters used to escape embedded quote tokens. By default, this is a back slash. This option has no effect unless Double Quote Escaping is unchecked. |
Column Names | To override the default column names (column1, ..., columnN), enter a comma separated list of column names. | |
Numbered Rows | Disabled | Check to number each row in the XML representation of the message. |
Ignore Carriage Returns | Enabled | Ignores carriage return (\r) characters. These are read over and skipped without processing them. |
Batch Properties
Name | Default Value | Description |
---|---|---|
Split Batch By | Record | Select the method for splitting the batch message. This option has no effect unless Process Batch is enabled in the Source Settings. The following options are available:
|
Number of Header Records | 0 | The number of header records to skip. By default, no header records are skipped. |
Batch Delimiter | The delimiter that separates messages. The batch delimiter may be a sequence of characters. | |
Include Batch Delimiter | Disabled | Check to include the batch delimiter in the message returned by the batch processor. By default, batch delimiters are consumed. |
Grouping Column | The name of the column used to group multiple records into a single message. When the specified column value changes, this signifies the boundary between messages. | |
JavaScript | Enter JavaScript that splits the batch, and returns the next message. This script has access to 'reader', a Java BufferedReader, to read the incoming data stream. The script must return a string containing the next message, or a null/empty string to indicate end of input. For additional information, see JavaScript Batch Script. |