Compresses one or more files into the file specified. To specify more than one file to compress use wildcards (i.e. * or ?). Generally used to compress files before backing them up or in preparation for transfer over the Internet via FTP or E-mail.
Declaration
<AMCOMPRESS SOURCE="text" ARCHIVEFILE="text" TYPE="text (options)" COMPRESSION="text (options)" PATHINFO="text (options)" OVERWRITE="YES/NO" ISNEWER="YES/NO" ISNEWERTHAN="text (date expression)" ISOLDERTHAN="text (date expression)" ARCHIVETURNOFF="YES/NO" PASSWORD="text (encrypted)" DOSFORMAT="YES/NO" ATTRFILTER="text" />
Example: Compress file(s) from "c:\sourcefolder\*.*" into the file "c:\targetfolder\targetfilename.zip". Use Zip compression. Use fast compression. Overwrite existing files. Exclude the file mask(s) "*.txt".
<AMCOMPRESS SOURCE="c:\sourcefolder\*.*" ARCHIVEFILE="c:\targetfolder\targetfilename.zip" TYPE="zip" COMPRESSION="fast" EXCLUDE="*.txt" OVERWRITE="YES" />
See Also: Decompress Files, Encrypt, Decrypt, Calculate File Checksum, Split File, Read from File, Get File(s) information, Join File
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Files to Compress |
Text |
Yes |
(Empty) |
a)SOURCE="c:\sourcefolder\file.txt" b)SOURCE="c:\sourcefolder\*.txt" c)SOURCE="file.txt" |
Specifies the file(s) to compress. 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 compress all files matching a certain mask. |
|
Destination File |
Text |
Yes |
(Empty) |
a)ARCHIVEFILE="c:\destfolder\file.zip" b)ARCHIVEFILE="c:\destfolder\*.zip" c)ARCHIVEFILE="file.zip" |
Indicates the destination folder and file name for the file(s) being compressed. This should be a fully qualified path with a file name. Folders that do not exist will be automatically created at runtime. |
|
Compression Type |
Text Options |
Yes |
Zip |
TYPE="tar" |
Specifies the type of compression that should be used for the file(s) being compressed. AWE supports the following compression types:
|
|
Level of Compression |
Text Options |
Yes |
Normal |
DESTKEY="keyName" |
Indicates the level of compression that should be used for the file(s) being compressed. The more compression that is used, the slower the process. No Compression is the fastest option. The available options are:
|
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Include Subfolders |
Yes/No |
No |
Yes |
SUBFOLDERS="no" |
When set to YES, specifies that, if present, subfolders should be searched for files matching the mask specified in the Files to compress parameter. The default value is set to YES. |
|
Preserve Folder Structure |
Text |
No |
Relative |
PATHINFO="absolute" |
Specifies how path information should be stored in the compressed file that is created. Valid only if the Include Subfolders parameter is set to YES. If set to NO, this parameter is ignored. The available options are:
|
|
Overwrite if exist |
Yes/No |
No |
No |
OVERWRITE="yes" |
If set to YES, indicates that, if matching file(s) already exist in the compressed file, they will be overwritten. The default value is NO. |
|
Only if newer |
Yes/No |
No |
No |
ISNEWER="yes" |
If set to YES, specifies that only matching files that are newer than those in the compressed file will be overwritten. The default value is NO. Valid only if the Overwrite if exist parameter is set to YES. |
|
Turn archive attribute off |
Yes/No |
No |
No |
ONLYFOLDERSTRUCT="yes" |
If set to YES, denotes that the "archive" attribute of the source file(s) should be switched OFF. The Windows "archive" attribute is generally used to track whether a file has been backed-up. By turning the source file's archive attribute off - this indicates to many backup programs that the file has already been backed-up. The default value is set to NO. |
|
Store files in DOS 8.3 format |
Yes/No |
No |
No |
DOSFORMAT="yes" |
If set to YES, specifies that the filenames in the compressed file should be truncated to their 8.3 DOS style equivalents. NOTE: Should only be enabled if the compressed file will be used on an older operating system that does not support long filenames. |
|
Password protect files |
Text |
No |
(Empty) |
PASSWORD="mypassword" |
If specified, causes the compressed file to be password protected - thus the user will be prompted for a password upon extraction. |
|
Exclude Mask |
Text |
No |
(Empty) |
EXCLUDE="*.txt" |
Causes the action to omit compressing files matching the mask(s) specified. Wildcard masks (i.e. * or ?) may be used. |
|
Only if newer than |
Date |
No |
(Empty) |
ISNEWERTHAN= "%DateSerial(2001,10,12) + TimeSerial(00,00,00)%" |
Causes the action to only compress files if the source is newer than the date/time specified. If this parameter is left blank or not included, the date of the files will be ignored (excluding Only if newer parameter). |
|
Only if older than |
Date |
No |
(Empty) |
ISOLDERTHAN= "%DateSerial(2001,10,12) + TimeSerial(00,00,00)%" |
Causes the action to only compress files if the source is older than the date/time specified. If this parameter is left blank or not included, the date of the files will be ignored (excluding Only if newer parameter). |
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Attributes |
Text Options |
No |
(Empty) |
ATTRFILTER="+R+A-H" (compress read-only & archive files but not hidden files) |
This group of settings causes the action to filter which files are compressed based on the attribute settings of the source file(s). In visual mode, a group of controls are provided to assist in the selection of this parameter. In markup mode, a single text item must be specified that contains the attributes of the files you want to compress. Available Options:
|