User Guide > Process Steps and Components > Aggregator Step > File Transfer Aggregator
Was this helpful?
File Transfer Aggregator
File Transfer Aggregator reassembles a file that was split into message objects by the File Transfer Iterator. The aggregator uses information stored in the properties of the message objects to reassemble the file.
File Transfer Aggregator Properties
Property Name
Description
Builder Directory
Browse and select a directory that can be used as a temporary directory when processing message objects.
Note:  This option does not support Internet addresses. The property value must be a directory on your local computer.
The instance properties are set in a process that splits the file using the File Transfer Iterator. After an iterator step that executes a GetMessage action using the File Transfer Iterator, a Script step is used to set the properties on the message returned by the iterator step.
The following expressions demonstrate how to set the message properties in the Script step:
Dim msg as DJMessage
Set msg = FindMessage("Iterator_1_Output")
msg.Properties("TargetMode") = "Append"
msg.Properties("TargeExpirationType") = "Hours"
msg.Properties("TargetExpiration") = 2
Where,
• TargetMode: Indicates whether to replace or append to the target. Allowable values are Replace and Append.
• TargeExpirationType: The type of the target expiration value. Allowable values Years, Months, Days, Hours, Minutes, Seconds.
• TargetExpiration: The time period for the transfer. The time expires when the current time equals the start transfer time plus the target expiration value.
Supported Actions
Action
Description
PutMessage
Sends the data contained in a DJMessage Object to the aggregator. The maximum size limit for DJMessage is 2 GB.
Supported Action Parameters
Action
Parameter
Parameter Description
PutMessage
Message
When the PutMessage action is called, the aggregator uses the body and/or properties of the Message parameter to add to the final output file that it is creating.
Supported Action Properties
Property
Description
Target File Path
The target file path and name.
Encoding
Encoding of the source file:
• ISO-8859-1 to ISO-8859-9
• UTF-8 (default)
• UTF-16
• Shift_JIS
• Cp1252
• EUC-JP
For value descriptions, see Encoding Tips.
Aggregate with Common Header
Select Yes to aggregate all file pieces with common headers into a single file with the same header.
Default value is No.
Record Separator
The record separator to use when dividing the source into groups of records.
Type of select from the following list of allowed values:
• CR-LF
• LF-CR
• CR
• LF
• System-Default (default)
Note:  This property is visible only when the Aggregate with Common Header property is set to Yes.
Supported DJMessage Properties
The following properties must be set manually or by using a preceding step:
Property
Description
TransferId
Uniquely identifies each transfer. It is a hash of the source name, target host, target name and transfer start time.
SourceName
The name of the source file.
PieceNumber
Indicates the sequential order of the piece.
TotalPieces
The total number of pieces.
StartTime
A numeric representation of the date/time the transfer started.
This is the current time as UTC milliseconds from the epoch.
SourceEncoding
Encoding of the source file:
• ISO-8859-1 to ISO-8859-9
• UTF-8 (default)
• UTF-16
• Shift_JIS
• Cp1252
• EUC-JP
For value descriptions, see Encoding Tips.
Last modified date: 10/22/2024