User Guide : Map Connectors : Source and Target Map Connectors : Archive Queue
 
Share this page                  
Archive Queue
This is an add-on connector and is not included in the default installation of Actian DataConnect Studio IDE. The connector is available at esd.actian.com.
Archive Queue is a messaging component that enables you to access a compressed or uncompressed archive that is stored on disk or in a DJMessage object within a workflow. Archive Queue treats the archive like a read-only message queue. You can use the GetMessage action to retrieve files within an archive into a message object.
Archive Queue supports the following archive/compression formats:
• ZIP
• JAR
• TAR
• TAR.GZ
• TAR.BZ2
• TAR.XZ
Step Actions
This component supports the following step actions:
Action
Description
GetMessage
Reads a file that matches the given pattern into the supplied DJMessage.
Disconnect
Explicitly disconnects from the archive file, releasing all file handles.
Tip:  Use the Disconnect action before attempting to remove or overwrite an archive file.
Properties
Process Properties
This invoker uses the following process properties.
Property
Description
Archive Type
The archive/compression type. The supported types are ZIP/JAR, TAR, TAR.GZ, TAR.BZ2, and TAR.XZ.
Source
Indicates whether the source archive is a file on disk or contained within a DJMessage.
Note
When the source is contained in a DJMessage, you must first Base64 encode the message body. See B64Encode Function.
Source Message/File
The path to the source file or the name of the source message.
GetMessage Pattern
The pattern to use to detect files to be read from the archive file. An asterisk (*) represents a wildcard. This pattern will be matched only against the name of the file, excluding extensions. The queue will traverse subdirectories within the archive implicitly.
Examples: File* or *12
To retrieve a specific file, type the full name of the file, excluding extension.
The pattern is displayed in clear text. If you prefer to conceal the value, have your Administrator configure it as an encrypted macro.
GetMessage Extension
The pattern to use to detect files to be read from the archive file. An asterisk (*) represents a wildcard. This pattern will be matched against the file extension. The default is csv.
Binary
Indicates whether the files that are read from the archive are binary rather than text files. If set to True, a Base64-encoded message is returned.
Step Properties
This component uses the following step properties. When you use the GetMessage action, Archive Queue populates the supplied message object with the contents of the next file that matches the given file name and extension patterns. In addition to returning the contents of the file, the original FilePath and FileName values are returned as message properties.
Property
Description
FileName
Contains the original name of the file within the archive.
FilePath
Contains the original full path of the file within the archive.
Examples
logMessage("INFO", "The original name of my file:" & myMessage.properties("FileName"))
logMessage("INFO", "The original path of my file:" & myMessage.properties("FilePath"))