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. Therefore, you must set the deserialize option to TRUE to read information from the header file.
File Transfer Aggregator Properties
You can specify the following properties when you create an instance of this aggregator component in the Configuration tab > Message Components section.
Property Name
Description
BuilderDirectory
Name of the directory that the aggregator must use as a temporary directory when processing message objects.
NotifyDirectory
Location where the aggregator generates notification files.
Typically, the instance properties are set in a process that splits the file using the File Transfer Iterator. After an iterator step is used to execute 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 aggregator can write any notification information to a file such as the status of the file that was reassembled. This file is generated if the NotifyDirectory option is set.
Note:  The BuilderDirectory and NotifyDirectory options do not support Internet addresses. The property values must be local directories or directories that can be accessed from the local computer.
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( "DJFT TargetMode" ) = "Append"
msg.Properties( "DJFT TargeExpirationType" ) = "Hours"
msg.Properties( "DJFT 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
Connect
Opens a persistent connection to the component source.
Disconnect
Break the connection with the component source.
PutMessage
Sends the data contained in a DJMessage Object to the aggregator. The maximum size limit for DJMessage is 512 MB.
Supported Action Parameters
Action
Parameter
Parameter Description
Connect
-
-
Disconnect
-
-
PutMessage
Message
When the PutMessage action is called for an aggregator, 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
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.
TransferUnitType
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.
Supported Character Sets for encoding
The following are the values for supported character sets:
ENC_UTF16= -4
ENC_UTF8= -3
ENC_UCS2= -2
ENC_ERROR= -1
ENC_OEM= 0
ENC_ISO8859_1= 1// 8859-1
ENC_CP1252= 2// Microsoft 1252
ENC_ISO8859_2= 3
ENC_ISO8859_3= 4
ENC_ISO8859_4= 5
ENC_ISO8859_5= 6
ENC_ISO8859_6= 7
ENC_ISO8859_7= 8
ENC_ISO8859_8= 9
ENC_ISO8859_9= 10
ENC_CP1250= 11
ENC_CP1251= 12
ENC_CP1253= 13
ENC_CP1254= 14
ENC_CP1255= 15
ENC_CP1256= 16
ENC_CP1257= 17
ENC_CP1258= 18
ENC_SHIFTJIS= 19// Japanese Shift-JIS
ENC_WSHIFTJIS = 20 //Windows Shift-JIS (932)
ENC_GB2312 = 21 // Windows Extended GB (936)
ENC_KSC5601= 22// Win Unified Hangul (949)
ENC_BIG5= 23// Windows Big5 (950)
ENC_CP037= 24// EBCDIC USA/Canada
ENC_CP500= 25// EBCDIC International
ENC_CP875= 26// EBCDIC Greek
ENC_CP1026= 27 // EBCDIC Latin5 Turkish
ENC_CP437= 28// DOS Latin US
ENC_CP737= 29// DOS Greek
ENC_CP775= 30 // DOS Baltic Rim
ENC_CP850= 31 // DOS Latin 1
ENC_CP852= 32 // DOS Latin 2
ENC_CP855= 33 // DOS Cyrillic
ENC_CP857= 34 // DOS Turkish
ENC_CP860= 35 // DOS Portugese
ENC_CP861= 36 // DOS Icelandic
ENC_CP862= 37 // DOS Hebrew
ENC_CP863= 38 // DOS Canada
ENC_CP864= 39 // DOS Arabic
ENC_CP865= 40 // DOS Nordic
ENC_CP866= 41// DOS Cyrillic Russian
ENC_CP869= 42 // DOS Greek 2
ENC_CP874= 43 // DOS Thai
ENC_CP273= 44// EBCDIC Germany
ENC_CP277 = 45 // EBCDIC Norway and Denmark
ENC_CP278 = 46 // EBCDIC Sweden and Finland
ENC_CP280= 47// EBCDIC Italy
ENC_CP284= 48// EBCDIC Spain
ENC_CP285= 49// EBCDIC UK
ENC_CP297= 50// EBCDIC France
Last modified date: 02/01/2024