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

Unzip Task

The following table describes the fields in the

Basic Tab

of an Unzip Task:

Field	Description
Label	Specify a label for the task.
Input File	Specify the path and name of a single file to unzip.
Input Files Variable	Specify a variable that contains files to uncompressed. The type of the variable must be File List. For example, ${variableName}.
Output Directory	Specify the directory path to which the contents of the input ZIP files should be extracted.
When File Exists	Specify the action to take when a file being extracted already exists. The default value is rename. The default value changes the destination file name to a new name so that the existing file does not change.

The following table describes the fields in the

Advanced Tab

of an Unzip Task:

Field	Description
Password	Specify the password to use to decrypt the zip files. Specify only if the input zip files are encrypted. When you unzip multiple encrypted ZIP files, they must have the same password. Otherwise, the task will fail.
Is Password Encrypted?	Specify whether the password is in the encrypted form. Default is false.
Ignore Path Information	Specify whether to ignore the path information contained in the input zip files when you extract a file. If set to true, all entries in the zip files are be extracted to the specified output directory. No sub-directories will be created even if the entries in the zip file have directory information associated with them. If set to false, all entries in the zip files will be extracted to the specified output directory. The directory information in the zip files is preserved. Default is false.
Make Base Directories	Specify whether or not a separate base directory should be created for storing the contents of each input zip file. When set to true, in the specified output directory, a sub-directory will be created for each input zip file. The directory name will be derived from the input zip file name. Default is 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 is 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 zip files. If set to 'false', the dates on the extracted files will be overridden to the date and time when they are extracted. Default is true.

The following table describes the fields in the

Output Variables Tab

of an Unzip Task:

Field	Description
Output Files Variable	Specify the name of a variable that contains all the extracted files. The variable is of type File List and can be used in subsequent tasks that accept a File List input variable. The variable is created if it does not exist.
Processed Input Files Variable	Specify the name of a variable that contains the processed input zip files. The variable is of type File List and can be used in subsequent tasks that accept a File List input variable. The variable is created if it does not exist.
Number of Files Archived Variable	Specify the name of a variable that contains the number of files that have been successfully extracted. The variable is created if it does not exist.

The following table describes the fields in the

Control Tab

of an Unzip Task:

Field	Description
Version	The version of this task.
Log Level	Specify the level of logging to use while executing this task. You can select silent , normal , verbose , or debug . The default value is inherited from the parent module.
Execute Only If	Specify the secret key ring that contains the sender's public keys. This is required only if no PGP key ring resource was specified or if you need to override the secret key ring specified in the PGP key ring resource.
Disabled	Whether this task is disabled. Default is false.

The following table describes the fields in the

On Error Tab

of an Unzip Task:

Field	Description
On Error	Specify the action to take when the task errors out. You can select abort , continue , call:[module] , or setVariable:[name]=[value] . When you select call:[module] , replace [module] with the name of the module in the project, for example, call:ErrorModule . When you select setVariable:[name]=[value] , replace [name] with a variable name and [value] with the variable value, for example, setVariable:error=true . The default value is inherited from the parent module.

Field

Description

On Error

Specify the action to take when the task errors out. You can select

abort

continue

call:[module]

, or

setVariable:[name]=[value]

When you select

call:[module]

, replace

[module]

with the name of the module in the project, for example,

call:ErrorModule

When you select

setVariable:[name]=[value]

, replace

[name]

with a variable name and

[value]

with the variable value, for example,

setVariable:error=true

The default value is inherited from the parent module.

Decompress the File with SSH Authentication

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal

0 COMMENTS

Back Next

We’d like to hear from you! Log in to comment.

Rename Saved Search

Table of Contents

User Guide

User Guide

Unzip Task

Unzip Task