Unzip Advanced
- Last Updated: November 30, 2023
- 2 minute read
- MOVEit Automation
- Version 2023.1
- Version 2023
- Documentation
Unzip Advanced unzips archives containing one or more files, with an optional ZIP password. It can work with archives that contain nested folders and can also handle the "bzip2" encryption type used by the WinZip 9.0 file compression utility. When run as a traditional task process, Unzip Advanced is run once and processes all of the downloaded files. In an Advanced Task, this script should be run after a source, but before a file loop.
Use the UnzipAdvanced_IgnoreAfterUnzip parameter to specify whether the zip file is processed by any other task steps. For example, if the parameter value is "Yes", the contents of the zip file, but not the zip file itself are copied to the destination.
Input Parameters
- UnzipAdvanced_DuplicateBehaviour - Specifies how to treat duplicate files. The default value is "Keep Both".
- Keep Both - Keep duplicate files, automatically renaming the second and subsequent duplicates. For example, if
file.txtexists 3 times, it is extracted 3 times with the following filenamesfile.txt,file_1.txt, andfile_2.txt. - Overwrite - The second and subsequent duplicates overwrite the earlier duplicates.
- Skip - Do not extract the second and subsequent duplicates.
- Fail - Terminate the script if a duplicate is encountered.
- Keep Both - Keep duplicate files, automatically renaming the second and subsequent duplicates. For example, if
- UnzipAdvanced_IgnoreAfterUnzip - Specifies if MOVEit Automation should ignore zip files for further processing after they are unzipped. The values are "Yes" or "No". The default is "Yes"
- UnzipAdvanced_Password - Specifies an optional
password to apply to the Zip file. Default value is blank, which indicates no decryption is to
be done. Note: Using a password to protect a Zip archive is not usually enough protection to thwart a determined hacker
- UnzipAdvanced_PreserveDirs - Specifies if MOVEit Automation should preserve the directory structure in the zip file. The values are "Preserve" or "Ignore". The default is "Ignore"
Output Parameters
- ZipFileSize - Number of bytes in the zip file. This and other size parameters are populated whether or not the Zip file is successfully unzipped. If more than one zip file is encountered, this parameter contains only the size of the last zip file processed by this task run.
- ZipFileSizeKB - Number of kilobytes (KB) in the zip file.
- ZipFileSizeMB - Number of megabytes (MB) in the zip file.
- ZipFileSizeGB - Number of gigabytes (GB) in the zip file.
Notes
In a Traditional Task, this built-in script should be run Once After All Downloads.
In an Advanced Task, this built-in script should be run after a source, but before a file loop.
This built-in script cannot be run as the first step of a task.
The task's "Cache Files" option must be set to "Use Random Names".