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

Untar Task

The Untar task will extract files from 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 uncompressed. The type of this variable must be File List. For example, ${variableName}.
Output Directory	Specify the directory path to which the contents of the input TAR files should be extracted.
When File Exists	Specify the action to take when a file being extracted 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
Is Tar File Compressed?	Specify whether or not the tar file being untarred is compressed using GZip Default Value: false
Ignore Path Information	Specify whether or not to ignore the path information contained in the input tar file(s) while extracting. If set to true, all entries in the tar file(s) will be extracted to the specified output directory. No sub-directories will be created even if the entries in the tar file have directory information associated with them. If set to false, all entries in the tar file(s) will be extracted to the specified output directory. The directory information in the tar file(s) is preserved. Default: false
Make Base Directories	Specify whether or not a separate base directory should be created for storing the contents of each input tar file. When set to true, in the specified output directory, a sub-directory will be created for each input tar file. The directory name will be derived from the input tar file name. Default Value: false
When Base Directory Exists	Specify the action to take when the base directory exists. This is applicable only when the 'Make Base Directories' option is set to true. The default value is 'rename' which changes the destination file name to a new name so the existing file remains untouched. Default Value: rename
Preserve Dates	Specify whether or not the dates on the extracted files should be preserved. If set to 'true', the dates will be taken from the input tar files. If set to 'false', the dates on the extracted files will be overridden to the date and time when they are extracted. Default Value: true
Output Variables Tab
Output Files Variable	If desired, specify the name of a variable which will contain all extracted 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.
Processed Input Files Variable	If desired, specify the name of a variable which will contain the processed input tar file(s). 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 extracted. 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