Decompresses one or more compressed files into the destination folder specified. Wildcards (i.e. * or ?) may be used to decompress files matching a certain mask. Usually used to decompress files received from the Internet via FTP or when restoring from a backup.
Declaration
<AMDECOMPRESS ARCHIVEFILE="text" DESTINATION="text" TYPE="zip" OVERWRITE="Yes/No" PASSWORD="text" EXCLUDE="text" />
Example
Description: This sample step decompresses file(s) located in compressed file "c:\temp\ArchiveFile.zip" to "c:\TargetFolder\". It is set to overwrite existing files and exclude the file mask(s) "*.jpg".
<AMDECOMPRESS ARCHIVEFILE="c:\temp\ArchiveFile.zip" DESTINATION="c:\TargetFolder\" TYPE="zip" OVERWRITE="YES" PASSWORD="AM1TLax4GRtZO1P9mYTOXoER2pY3uoOmE4TaME" EXCLUDE="*.jpg" />
See Also
Compress Files, Encrypt, Decrypt, Calculate File Checksum, Split File, Sign, Verify
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Archive File(s) |
Text |
Yes |
(Empty) |
a)FILE="c:\source\zipfile.zip" b)FILE="c:\sourcefolder\*.zip" |
Specifies the file(s) to decompress. This can be a fully qualified path and filename (preferred) or a single file (requires use of the Change Folder action). Wildcards (i.e. * or ?) may be used to specify all files matching a certain mask. |
|
Extract to Folder |
Text |
Yes |
(Empty) |
DESTINATION="c:\destination\" |
Specifies the destination folder for the file(s) being decompressed. This should be a fully qualified path. Folders that do not exist will be automatically created at runtime. |
|
Compression Type |
Text Options |
Yes |
Zip |
TYPE="zip" |
Indicates the compression type of the file(s) to be decompressed. The available options are:
|
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Restore Folder Structure |
Yes/No |
No |
Yes |
CREATEFOLDERS="no" |
If set to YES, specifies that subfolders present in the archive file should be automatically created and files should be placed in their corresponding subfolders upon decompression. This parameter is set to YES by default. |
|
Overwrite if exists |
Yes/No |
No |
No |
OVERWRITE="yes" |
If set to YES, indicates that if matching file(s) already exist in the destination folder, they should be overwritten. This parameter is set to NO by default. |
|
Use this password if needed |
Text |
No |
(Empty) |
PASSWORD="mypassword" |
If specified, uses the password entered to decompress a password protected file. |
|
Exclude Mask |
Text |
No |
(Empty) |
EXCLUDE="*.txt" |
Causes this action to omit decompressing files from the archive matching the mask(s) specified. Wildcard masks (i.e. * or ?) may be used. |