Designing Custom Encoders

Delimiter Properties

Table 9 Delimiter Properties

Property 

Description 

Level 

Assigns consecutive sets of delimiter parameters to delimited nodes in the Encoder node hierarchy. See Delimiter Levels for additional information.

Type 

Specifies how the delimiter is used. See Delimiter Type for additional information.

Precedence 

Indicates the priority of a certain delimiter, relative to other delimiters. See Precedence for additional information.

Optional 

Specifies how delimiters for optional nodes are to be handled when the nodes are absent from the input instance or when their fields are empty. See Optional for additional information.


Note –

Does not apply to children of choice element nodes.


Terminator 

Specifies how delimiters are to be handled for a specific terminator node in the Encoder tree. See Terminator for additional information.

Bytes 

Specifies the characters (bytes) to use to end the delimited data for the specified level. Delimiters can have begin bytes, end bytes, or both. The term “bytes” (by itself) always indicates end bytes. See Delimiter Characters (Bytes) for additional information.

Offset 

Offset of the delimited data field in bytes from the beginning of the data stream (byte 0). Value must be a non-negative integer; the default is 0.

Length 

Length of the data field in bytes, if it is of fixed length. Value must be positive integer. Entering a value clears the Bytes field

Detached 

When checked, indicates that the specified delimiter is a detached, or non-anchored, delimiter, and does not have to appear at a fixed position. 

BegBytes 

Specifies the characters (bytes) to use to begin the delimited data for the specified level. Delimiters can have begin bytes, end bytes, or both. See Delimiter Characters (Bytes) for additional information.

BegOffset 

Offset of the fixed-length data field in bytes from the beginning of the data stream (byte 0). Value must be a non-negative integer; the default is 0.

BegLength 

Length of the data field in bytes, if it is of fixed length and has a beginning delimiter. Value must be positive integer. Entering a value clears the Bytes field

BegDetached 

When checked, indicates that the specified delimiter is a detached (non-anchored) beginning delimiter, and does not have to appear at a fixed position. 

Skip 

When checked, skips identical leading delimiters. The delimiters may be defined either as begin bytes or end bytes. The purpose of this flag is to facilitate parsing tabular data. 

Collapse 

When checked, collapses identical, consecutive end delimiters into a single delimiter. As with the Skip flag, the purpose of this flag is to facilitate parsing tabular data.