Record format transformation
You can transform the records of a file between variable and fixed for text and binary files, using padding and unpadding. The destination xFileRecordLength must be greater or equal to the source xFileRecordLength.
See Configure record transformation in message handler to configure this function in the message handler.
See Configure record transformation on pickups and deliveries to configure this function on a PeSIT or OFTP pickup or delivery.
See Metadata for record file management for details about attribute handling.
Note: When you set the virtual or local record format to OCTET_STREAM, record format transformation is disabled.
VARIABLE_TEXT
Description
- This is the most flexible format for text.
- Records are variable length text lines terminated by an EOL marker.
- When reading the file, any EOL marker (LF or CR-LF) can be used.
- When writing the file, the current operating system EOL marker is used.
- FileRecordLength is the maximum length of the line (EOL marker excluded from the count).
Possible transformations
You can transform VARIABLE_TEXT into:
- FIXED_TEXT (will do padding)
- FIXED_BINARY (will do padding)
- VARIABLE_BINARY
Warning: The source file lines are unpadded during the transformation. Be aware of the source padding character setting. To avoid unpadding, set the source padding character to an unused character (such as 0x7F).
FIXED_TEXT
Description
- Records are fixed length text lines terminated by an EOL marker.
- Only an EOL marker of the system the software is installed on is handled.
- FileRecordLength is the maximum length of the line (EOL marker excluded from the count).
Possible transformations
You can transform FIXED_TEXT into:
- VARIABLE_TEXT (with unpadding)
- FIXED_BINARY
- VARIABLE_BINARY (with unpadding)
VARIABLE_BINARY
Description
- Special record format that follows OFTP specifications.
- Records are of variable size and can contain any type of character (ASCII, EBCDIC, …).
- There is no EOL marker. EOL markers are ignored.
- Each record begins with a 16 bit header that indicates the record length (maximum length 65535 bytes per record).
- FileRecordLength is the maximum length of a record.
Possible transformations
You can transform VARIABLE_BINARY (each record having the length header info) into:
- FIXED_BINARY (with padding),
- FIXED_TEXT (with padding) if the destination character set is ASCII or equivalent.
- VARIABLE_TEXT if the destination character set is ASCII or equivalent.
FIXED_BINARY
Description
- Records are of fixed size and can contain any type of characters (such as ASCII, EBCDIC, ...).
- There is no EOL marker. EOL markers are ignored.
- FileRecordLength is the length of the line, EOL marker excluded.
Possible transformations
You can transform FIXED_BINARY into:
- VARIABLE_BINARY (with unpadding).
- FIXED_TEXT if the destination character set is ASCII or equivalent.
- VARIABLE_TEXT (with unpadding) if the destination character set is ASCII or equivalent.
OCTET_STREAM
If you set the virtual or local record format to OCTET_STREAM, no records are detected and the record format transformation function is disabled.
Related topic:
Character transcoding
Metadata for record file management