User Guide

10.5.0
- 10.5.3
- 10.4.0
- 10.2.3
- 10.2.2 HotFix 1
- 10.2.2
- 10.2.1
- 10.2

Back Next

GZip Task

The GZip task can compress one or more files on the local file system using the GZip standard.

Field	Definition
Basic Tab
Label	Specify a label for this task.
Input File	Specify the path and file name of a single file to GZip.
Input Files Variable	Specify the name of a variable of type File List which contains files to GZip. For example, ${variableName}
Output File	Specify the path and file name where the GZipped file should be saved. This is not allowed when GZipping multiple files using inputFilesVariable attribute or a nested File Set element.
Output Directory	Specify the directory where the output files should be saved.
When File Exists	Specify the action to take when the GZipped file already exists. The default value is 'rename' which changes the destination file name to a new name so the existing file remains untouched. Default Value: rename
Advanced Tab
Compression Level	Specify the compression level to use. Valid values range between 'very low' and 'maximum'. A higher compression level will cause the file(s) to be more compressed, however compression will take longer. A lower compression level will cause the file(s) to compress faster. Default Value: medium
Output Variables Tab
Output File Variable	If desired, specify the name of a variable which will contain the GZipped files. This variable will be of type File List and may be used in subsequent tasks that accept a File List input variable. The variable will be created if it does not exist.
Processed Input Files Variable	If desired, specify the name of a variable which will contain the input files that were successfully Gzipped. This variable will be of type File List and may be used in subsequent tasks that accept a File List input variable. The variable will be created if it does not exist.
Number of Files Archived Variable	If desired, specify the name of a variable which will contain the number of files compressed. The variable may be used in subsequent tasks. The variable will be created if it does not exist.
Control Tab
Version	The version of this task.
Log Level	Specify the level of logging to use while executing this task. Valid options are - silent, normal, verbose and debug. Default Value: Inherited from parent Module
Execute Only If	Specify a condition that must be satisfied before this task can be executed. This task will be skipped if the specified condition is not met.
Disabled	Whether or not this task is disabled. Default Value: false
On Error Tab
On Error	Specify the action to take when this task errors out. Valid options are - abort, continue, call:[module] and setVariable:[name]=[value]. For call:[module] replace [module] with the name of the module in the project (e.g. call:ErrorModule). For setVariable:[name]=[value] replace [name] with a variable name and [value] with the variable value (e.g. setVariable:error=true). Default Value: Inherited from parent Module