[Files] Compress

Q100005: [Files] Compress

Compresses one or more files. Currently only supports .zip compression of files.

Parameter	In/Out	Description	Other Info
File source	InOut	The file source is a list of one or more files to process, using fully qualified pathnames, such as a `FileList` output parameter from another module. A typical example being the `[Files] Find` module.
Copy or move?	In	Choices: `Copy`, `Move` If `Move` is selected, the source files will be deleted after they are successfully compressed. If `Copy` is selected, the files will be left untouched.	Default: `Copy`
Destination folder	InOut	The folder where the compressed file(s) will reside. If left blank, the output file(s) will be created in the same folder as the source files.
Compression grouping	In	Choices: `None`, `Timestamp`, `Hour`, `Day`, `Week`, `Month`, `Quarter`, `Year` When compressing to a single file, the destination filename is generated based on the file prefix and the grouping options. Thus a prefix such as "ServerLogs" with the grouping set to `Month` would result in all eligible files being added to a compressed file with the name `ServerLogs_YYYYMM.zip`, where the values for YYYY and MM are set according to the run date. Selecting `None` will use a full timestamp for the current date and time.	Default: `None`
Compressed file prefix	In	The destination filename is generated based on the file prefix and some sort of timestamp according to the grouping options. Thus a prefix such as "ServerLogs" with the grouping set to `Month` would result in all eligible files being added to a compressed file with the name `ServerLogs_YYYYMM.zip`, where the values for YYYY and MM are set according to the run date. If grouping of `None` is selected, this parameter is ignored: each zip file is given the same name as the original file name, with `.zip` at the end.
Log output level	In	Choices: `Minimal`, `Verbose` The level of execution detail you want to appear in the log.	Default: `Minimal`
Source files compressed	Out	The fully qualified path names of source files that were compressed. These files are safe to delete if so desired.
File list	Out	The fully qualified pathnames of the compressed files that were created or added to.

(Italics = required parameters)

Notes

The [Files] Compress module will take all the input files supplied to it and compress them using the ZIP file compression method. The ZIP file format offers excellent support on many platforms. It can be used to individually compress files into smaller standalone copies, or it can be used to compress and contain multiple files in a singular file used for storage or communications.

Last Updated:

10/3/2023 1:06:45 AM