This page explains the Flat File Adapter in Bridge context. If you were looking for the same information regarding the PAS Designer, refer to Flat File Adapter in the Designer guide.
Tagged Values
Class <<FlatFile>>
This is the root record of the flat file declaration. This class cannot have any attributes, only associations to <<FlatFileRecord>> classes and <<FlatFileGroup>> classes are allowed.
| Tagged Value | Description | Allowed Values | Example | |
|---|---|---|---|---|
| escapeCharacter | Defines the character used for escaping when a reserved character is used within a field value. | any character | / |
|
| fillCharacter | Defines a dummy character to fill non-existent values (results in NULL). Used for fixed attribute layout only. | any character | 0 |
|
| quoteCharacter | The quoteCharacter will be ignored by reading field value. | any character | / |
|
| recordSeparator | Separator of the different records, normally line feed and carriage return. For serialized files, any other character can be defined. | any character or one of | <newline> |
|
<esc> |
|
|||
<newline> |
parses correctly on Unix and Windows platforms | |||
<space> |
|
|||
<tab>
<tabulator> |
|
|||
<unixnewline> |
composes newline | |||
<windowsnewline> |
composes newline and carriage return | |||
| reservedCharacters | Defines a list of characters to be escaped automatically when the file is composed. | any character | {"/", "%", "&", "(", ")"} |
|
Class <<FlatFileRecord>>
This class describes the attributes of a record. A record is one "line" in a file and can consist of multiple attributes.
There were errors rendering macro:
- An unknown error occurred.
Class <<FlatFileGroup>>
This class is used to group multiple records into one (virtual) structure. A group does not have a representation in the flat file itself.
| Tagged Value | Description | Allowed Values | Example | |
|---|---|---|---|---|
| pattern |
Error rendering macro 'multiexcerpt-include' : Page loading failed
|
any character | ^Pattern.* |
|
| a valid regular expression | ||||
Class <<FlatFileSubRecord>>
| Tagged Value | Description | Allowed Values | Example | |
|---|---|---|---|---|
| condition | A condition that must evaluate true if the record exists. The condition can refer to a self object which represents the current state of the parent. | any valid conditional expression | self.UNS.exists() |
|
| evaluationOrder | Defines the order in which the associations starting on same parent class must be processed, see Flat File Adapter Parsing Process. | any integer |
|
|
| offset | Define the position of this record in the flat file, starting with 0 for the first record and always relative to the parent element. | any integer |
|
|
Attribute <<FlatFileAttribute>>
Fixed Layout
There were errors rendering macro:
- An unknown error occurred.
Separated Layout
| Tagged Value | Description | Allowed Values | Example | |
|---|---|---|---|---|
| format |
Error rendering macro 'multiexcerpt-include' : Page loading failed
|
|
|
|
| order | The evaluation order of the attributes. If offset is not used, order reflects the field number within the record. | any integer | ||
| offset | The relative position of the field in respect of the other fields in the record, e.g. field number 3 has offset = 2. | any integer |
|
|
| suppressEscaping |
Boolean value to suppress escaping.
|
|
|
|
| parseMacro |
Error rendering macro 'multiexcerpt-include' : Page loading failed
|
any valid macro expression (see Macro Expressions) | GetCounter(0) |
|
| composeMacro | ||||
Attribute <<FlatFileComplexAttribute>>
This class is used to divide fields into sub-fields. You can think of this like a <<FlatFileRecord>> placed within a single field.
There were errors rendering macro:
- An unknown error occurred.
Action "parse"
There were errors rendering macro:
- An unknown error occurred.
Parameters
Action "compose"
Action "parse"
Parameter Types