Was this helpful?
File Folder Queue
File Folder Queue allows a file folder to be treated like a message queue. The files in the folder can be retrieved into message objects by using the GetMessage action in a Queue step. Message objects can also be written to the folder as files using the PutMessage action. The properties of the session control the files that are read and the names of the files that are written, as well as whether to preserve the message properties.
Note:  When the File Folder Queue becomes empty, an error message is displayed in the result window and the log - “Error reading message: FFQueue: No more files matching the pattern *.<extension> can be found in directory <path>”. This error indicates that there are no more files to process. If you are using this component in a loop, you can look in the log file and see how many times the process iterated through the loop before the error was thrown.
File Folder Queue Properties
 
Property
Default Value
Description
Directory
 
Folder for reading and writing files.
Working Directory
-
Directory name used to store temporary files that are created when retrieving files with the GetMessage action. If this property is not specified, the connector creates a directory called DJFTFFQueue in the directory specified for the Directory property. This new directory is used to store temporary files.
Deserialize
FALSE
If a message object was written to a folder with the Serialize property set, the message properties are stored in a separate file with an .hdr extension. When reading a file from a folder using the GetMessage action, the Deserialize property indicates that the message properties must be read from the .hdr file.
Serialize
FALSE
When a message object is written to a file with the PutMessage action, only the message body is written. The Serialize property indicates whether to write the message properties to a separate file with an .hdr extension.
Pattern
*
Pattern used to match files to be read using the GetMessage action.
GetMsgClass
dat
The file extension that is appended to the file name when reading a file with the GetMessage Action.
PutMsgClass
dat
File extension that is appended to the file name generated by the FileFormat property when writing a message object to a file with the PutMessage action.
MessageTimeOut
5
Indicates the time to wait (in seconds) to retrieve the first file from the folder when retrieving files with the GetMessage action. The files to be retrieved are determined by the Pattern property.
The MessageTimeOut property works with the SleepInterval property . The File Folder Queue tries to read the first file then sleep for the specified sleep interval. This continues based on the value in the MessageTimeOut option.
PollingTimeOut
5
Indicates the time to wait to retrieve all of the files from the folder when retrieving files with the GetMessage action. The files to be retrieved are determined by the Pattern property. The PollingTimeOut property works with the PollingTimeOutType property.
PollingTimeOutType
Minutes
Type of the polling timeout value. The options available are:
Years
Months
Days
Hours
Minutes
Seconds
SleepInterval
1000
Indicates the time to sleep when no messages are available to process. The sleep interval is in milliseconds.
BrowseMode
FALSE
If this property is set to TRUE, the messages read from the folder are not removed. Else, the files are deleted after processing.
FilenameFormat
MessageFile%n
When writing a message object to a file using the PutMessage action, this format is used to create the file name. The following format specifications can be used to build the format. Each specification begins with a percent sign (%). The specifiers represent properties on the message object that are created by the File Folder Iterator. Any or all of the specifications can be included in any order.
Note:  The format must generate unique names for the files.
The supported formats are:
MessageFile%n
%i TransferId
%p PieceNumber
%s SourceName
%h TargetHostName
%t TargetName
%d Transport Start Date/Time
%n Number starting with 0 (zero)
%c Current date/time stamp displaying number of seconds elapsed since midnight GMT January 1, 1970 (value always contains 10 digits)
Examples
TargetName: TargetFFQFile
PieceNumber: 5
FileFormat: %t%p
MessageClass: dat
Filename: TargetFFQFile5.dat
 
 
Best Practice — The %n and %c format specifications enable you to create unique file names for generic messages. These should be used together to ensure greatest efficiency.
If only %n is used in the file name specification, for example, MessageFile%n, the connector tries to assign the file name "MessageFile0" when a message is created. If this is unique it is used, but if it already exists in the specified directory, %n is incremented by 1 and this is checked against existing files. This continues until a unique file name is found. This means that the more messages that are created, the longer it takes for a unique name to be found.
If only %c is used, the process is limited to writing one file per second as the file name it tries to assign for the new message is not unique until the timestamp has advanced. Therefore, use a combination of %n and %c. For example, MessageFile%c%n creates as many messages each second as required and %n is reset to 0 each time the timestamp changes.
Source 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. On the integration engine command line, the number must be used.
Binary Indicator
FALSE
Indicates whether the files being read must be opened in binary mode.
Supported Actions
Action
Description
Connect
Opens a persistent connection to the database.
Disconnect
Closes an existing database connection and performs any clean up actions if required.
GetMessage
Retrieves message into a message object.
PutMessage
Writes a message object into the queue.
Supported Action Parameters
Action
Parameter
Description
GetMessage
PutMessage
Message
Name for the incoming message
Supported Action Properties
There are no supported properties for the actions.
Last modified date: 02/01/2024