User Guide > Process Steps and Components > Iterator Step > File Transfer Iterator
Was this helpful?
File Transfer Iterator
The File Transfer Iterator splits a file into pieces that are stored in message objects that can be transferred to another location and reassembled. The iterator uses properties on the message object to store information about how the pieces are reassembled into a complete file. For an example of using the properties, see File Transfer Aggregator. Whatever transfer mechanism is used must preserve the message properties. The File Folder Queue components use the Serialize and Deserialize options to preserve the message properties.
File Transfer Iterator Properties
Property Name
Default Value
Description
TransferUnitType
Bytes
Type of unit to use when splitting the file into pieces. This option is used along with the TransferUnitCount option to determine the size of the pieces to split the file into. The options available are:
• Bytes
• Records
TransferUnitCount
0
Number of units each piece of the file contains. This option is used in conjunction with the TransferUnitType option to determine the size of the pieces to split the file into. For example, if the TranferUnitType is Records and the TransferUnitCount is 10, then each message object contains 10 records from the source file.
SourceName
 
Path and file name of file that is split into pieces.
Encoding
ENC_OEM or 0
Character set of the source data. This indicates using the default character set for the system. The ENC_ names can be used in expressions for setting the encoding value.
Allowable values for supported character sets are listed under Encoding Tips.
RecordSeparator
 
The record separator to use when dividing the source into groups of records. This should be Unicode characters. Default is none.
Some allowable values are:
• \r\n (CR-LF)
• \n (LF)
• \r (CR)
• \n\r (LF-CR)
• \x2028 (Unicode line separator)
• \x2029 (Unicode paragraph separator)
• \f (Form feed)
• \r\n\r\n (Windows empty line)
• \n\n (Unix empty line)
Note:  The actual characters (or escape sequences) must be used, that is, using 'CR-LF' will not work, you must use '\r\n'.
RecordLength
 
If records are separated by a record separator, this property must be set to 0. If the records are fixed-length (no separator), then this should be the actual record length. Any time this property has a value other than 0, the RecordSeparator property will be ignored.
TargetName
 
Name that is given to the file when it is reassembled. The TargetName option includes the path and file name.
TargetHost
 
Name of the host where the target file is reassembled. This option is used by the File Transfer Aggregator to verify that the file is being reassembled on the correct host.
BinaryIndicator
False
Indicates whether the file being read should be opened in binary mode.
Supported Actions
Action
Description
Connect
Opens a persistent connection to the component source.
Disconnect
Break the connection with the component source.
GetMessage
Returns data from the Iterator in a djmessage object. The maximum size limit for DJMessage is 512 MB.
Supported Action Parameters
Action
Parameter
Description
Connect
Database
Name of the database.
GetMessage
Message
When the GetMessage action is called for an Iterator, the Iterator advances to the next element in the Iterator source and returns it in the message body of the specified DJMessage object. The maximum size limit for DJMessage is 512 MB.
Supported Action Properties
There are no supported action properties.
Supported DJFT Properties and Parameters
The following properties must be set manually, if the previous process step does not generate it before calling the component.
Property
Description
SourceName
The name of the source file.
TranferUnitType
Indicates how to divide the source file into pieces. Allowable values are Bytes and Records.
TransferUnitCount
The number of bytes of number or records to include in each piece.
RecordLength
The number of characters to include in a record.
SourceRecordSeparator
The record separator to use when splitting the source. Default None.
SourceEncoding
The character set of the source data. The default is ENC_OEM (0).
TargetHostSystem
The name of the target host system.
TargetName
The name of the target file.
The following are the parameters.
Parameter
Description
TransferId
Uniquely identifies each transfer. It is a hash of the source name, target host, target name and transfer start time.
PieceNumber
Indicates the sequential order of the piece.
PieceSize
Indicates the size of the message body in bytes.
Priority
The priority of the piece. Default 0. The last message has a priority of 1.
TotalPieceCount
The total number of pieces.
StartTime
The date/time the transfer started.
Last modified date: 02/01/2024