User Guide > Process Steps and Components > Invoker Step > Unzip Invoker
Was this helpful?
Unzip Invoker
This component is used to unzip, decompress, or extract an existing zip file.
Zip Invoker Properties
There are no Zip Invoker properties.
Supported Actions
Action
Description
Execute
You can either specify a zip file using the Zip File property, or pass a zip file to the component through a DJMessage using the SourceMessage parameter. If a DJMessage is used as a source, then load the body of the DJMessage with the zip file prior to the Unzip step.
Supported Action Parameters
When the Execute option is used, the following property must be set:
Action
Parameter
Description
Execute
SourceMessage
Set this property to use DJMessage as a source. If a DJMessage is used as a source, then load the body of the DJMessage with the zip file prior to the unzip step.
Note:  Either the SourceMessage parameter or the Zip File property must be defined, otherwise no source error occurs. If both are defined, the Zip File property takes precedence over the SourceMessage parameter.
Note:  The maximum size limit for DJMessage is 2 GB.
IMPORTANT!  You can use DJMessage properties in a preceding step (script, start step, decision) to set the value for the Zip File property. If this is the case, it will take precedence or override the Zip File property in the component. Order of precedence will be:
a) DJMessage property defined before the Unzip Invoker step
b) Zip File property
c) SourceMessage parameter
Supported Action Properties
Property Name
Description
Password
For better security, a password may have been set to open the zip file. This property allows you to specify the password for a password protected zip file.
Zip File
The path and name of the zip file that is to be extracted. You can use a Macro to ensure the portability of the process.
Note:  This property overrides the SourceMessage parameter
Output Directory
(Required) The output directory for the extracted files.
File Matching Pattern
Allows you to specify a regular expressions or matching pattern using wildcards and literal characters to extract only those files that match the specified pattern. Thus limiting or filtering the files that are extracted from the zip file. This is case-insensitive.
For example, a zip file may consist of 100 files of different formats and extensions, but you may want to extract only files with “.csv” extension. In this case you can specify “*.csv” in the File Matching Pattern text box.
Flatten
The flatten property enables you to either maintain the original directory structure when extracting the files from the zip file, or discard that structure and extract all files to a single folder (the current directory).
Valid values:
• TRUE - Do not retain the directory structure when extracting files and flatten everything out.
• FALSE (default) - Retain the directory structure when extracting files.
Error Codes
Code
Description
Reason
2
Bad name
File Name has duplicate zip entry
6
Write error
Error occurs when writing zip file to local directory.
12
No source error
The Output Directory property has not been specified.
12
No source error
The Output Directory is not valid.
12
No source error
The Zip File property has not been specified.
46
License error
Unzip Invoker is not licensed or its license has expired.
Last modified date: 10/22/2024