User Guide > Process Steps and Components > Iterator Step > Zip Iterator
Was this helpful?
Zip Iterator
The Zip Iterator component can be used to extract data from an existing zip file. The zip file must be loaded into the Zip Iterator component first, and then the files can be extracted from the component for processing. To extract multiple or all the files within the Zip Iterator component, a loop must be created in Process Designer using the decision step, for more information, see Decision Step. In this scenario, a different file will be extracted from the Zip Iterator component every time the Zip Iterator step is executed within the loop.
Supported Actions
Action
Description
PutMessage
The PutMessage action is used to "put", or load, a zip file into the Zip Iterator component. When this action is selected, the associated Parameters and Properties can be used to specify the zip file name, location, and password.
GetMessage
The GetMessage action "gets" or retrieves files from the Zip Iterator component. The DJMessage specified in the message parameter is used to store the file. Once the GetMessage action has been fired, the body of the DJMessage will be loaded with the contents of a file from the Zip Iterator component. The DJMessage can be used to pass this file to another step, or it can be written to disk using the FileWrite function in a Script Step. For more information about FileWrite function, see FileWrite Function.
Disconnect
Closes an existing connection and performs clean up as needed.
Supported Action Parameters
Name
Parameter
Description
PutMessage
Message
The DJMessage parameter for the PutMessage action can be used to load or input a zip file into the Zip Iterator component.
GetMessage
Message
The DJMessage parameter for the GetMessage action retrieves a file from the Zip Iterator component and loads it into the body of the specified DJMessage.
Supported Action Properties
Name
Property
Description
PutMessage
Zip File
Click Browse and select the desired zip file to load into the Zip Iterator component.
 
Password
Enter the password (if applicable) for the zip file supplied in the Zip File property.
GetMessage
File Matching Pattern
You can use this property to filter the required files to retrieve from the component. Define the pattern by using Java regular expression to extract the files matching the pattern. This property only evaluates file names and extensions, not the content of the files. Also, if you want to search more than one string or character in a file name or extension, then you can use pipe delimiter.
Note:  String pattern matching is case-insensitive.For example, the expression E returns a file that includes the letter e in either the file name or the extension.
Additional Information
You can override the following PutMessage properties using a DJMessage property. When set, DJMessage properties takes precedence over the property values specified in the component.
Following is the syntax to set DJMessage property for the Zip Iterator:
Mydjmessagename.Properties("ZipFile") = C:\Mypath\Myzipfile.zip
Action
Property
Description
Input
ZipFile
Where the zip file located.
Password
Enter the password (if applicable) to open the zip file.
Output
FileName
File name of the zip file entry.
Folder
Folder hierarchy which contains the file. Empty if file is at the root of the zip file.
ContentType
Media type of the zip file entry.
FileSize
Uncompressed size of the zip file entry in bytes.
Errors
Code
Error Name
Reason
1
End of message error
No more messages to return in the GetMessage action.
4
Read error
Read zip message from the DJMessage.
8
Write error
Write message to a file.
12
No source error
No zip file input available to unzip.
46
License error
Zip Iterator is not licensed, or the license is expired.
Last modified date: 07/26/2024