Breadcrumbs

Flat File Adapter Reference


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.


There were errors rendering macro:

  • An unknown error occurred.


Class <<FlatFileSubRecord>>



There were errors rendering macro:

  • An unknown error occurred.


Attribute <<FlatFileAttribute>>

Fixed Layout


Tagged Value

Description

Allowed Values

Example

decimals

Replaced by format.



externalLength

Number of characters of the field (only for fixed length records relevant).

any integer


format


Error rendering macro 'multiexcerpt' : Page loading failed


any valid number or dateTime pattern

S9G999G990D00


%Y.%m.%d-%H:%M:%

nativeTyp

deprecated

Replaced by format.



order

The evaluation order of the attributes. If offset is not used, order reflects the field number within the record.

any integer


offset

The character position of this field within the record.

any integer


padding

Defines the padding rule for the field. When parsing, the characters on the left or right side are ignored up to the first different character. When composing, the field is filled on the left or right side with the specified character.

left("<any character>")

left("0")

right("<any character>")

right(" ")

suppressEscaping


Error rendering macro 'multiexcerpt' : Page loading failed


true

attribute values of this attribute will not be un-escaped (parser) or escaped (composer)


false

escaping/un-escaping is not suppressed

parseMacro

A macro that is executed while parsing/composing a file or complex field.

This macro can contain multiple commands separated by commas or spaces. Macros on classes are executed before the processing of its attributes or associations. The ID represents a counter.

The following counters are available:

  • eight automatic counters with ID AUTO0 .. AUTO7

  • two automatic line counters with ID LINE0and LINE1 (parsing only)

  • unlimited custom counters with ID CUSTOM0 .. CUSTOMx

Automatic counters are increased by 1 for each processed record. Custom counters have to be increased manually using the increase macro. All counters have the initial value of 0 when they process the first record.

For more details on macro commands see Macro Expressions .

any valid macro expression (see Macro Expressions)

GetCounter(0)

composeMacro


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

Error rendering macro 'multiexcerpt-include' : Page loading failed



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"


There were errors rendering macro:

  • An unknown error occurred.


Action "parse"


Error rendering macro 'multiexcerpt' : Page loading failed


Parameter Types

Error rendering macro 'multiexcerpt-include' : Page loading failed

Related Pages: