Decompress File(s)

Decompress File action tasks decompress zipped job files (files compressed as zip files).

Input

This task only accepts ZIP files, however it is not necessary that the job file be the ZIP, since this file path and name can be specified in the task itself.

Processing

Every file in the ZIP is extracted to the specified location. If a folder structure exists in the ZIP, it is respected in the output folder.

Output

This task outputs the data file it received with no modification. Metadata and job files are not touched either.

Task properties

General Tab
  • Zip file name: Enter the name of the zipped file. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these.
  • Output folder: Enter the name of the folder in which you want the decompressed files to be stored.
  • File mask: Enter a file name mask to specify which files must be decompressed. Leave the default value of *.* to decompress all the files found within the zip.
  • Password: Enter a password if the zip file is password protected.
  • Restore path structure: Select if you want the complete file structure to be rebuilt from the output folder to the decompressed files.
  • Force directories: Select if you want to allow the system to create new folders when required. If this option is not select and the Decompress file action task tries to save a file to a folder that does not exist, the task will fail.
  • Overwrite existing files: Select if you want decompressed files that have the same name as existing files to overwrite the existing files.
On Error Tab

For a description of the options on the On Error tab see Using the On Error tab.

Miscellaneous Tab

The Miscellaneous tab is common to all tasks.

It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button and are displayed in the Task Comments Pane.

Check the option Use as step description to display the text next to the icon of the plugin in the Process area.

The tab also provides an option to highlight the task in The Process area with the default color, set in the Preferences (see General appearance preferences), or the color selected or defined under Highlight color on this tab.
To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon.