User Guide

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

Back Next

Tar Task

The Tar task compresses a file or set of files into a .tar file.

Field	Definition
Basic Tab
Label	Specify a label for this task.
Input File	Specify the path and name of a single file to tar.
Input Files Variable	Specify a variable that contains file(s) to be compressed. The type of this variable must be File List. For example, ${variableName}.
Output Directory	Specify the name and location of the output TAR file.
When File Exists	Specify the action to take when the tarred 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
Save Full Path Info	Specify whether or not to save the full path information in the output TAR file. Default Value: false
Compress	Specify whether or not to use GZip compression when creating the TAR file. Default Value: false
Output Variables Tab
Output Files Variable	If desired, specify the name of a variable which will contain the tarred file. The variable will be of type File and may be used in subsequent tasks that accept File or File List input variables. 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 processed input files. The 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 that have been successfully archived. 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