Unarchive

Unarchive is a processor that extracts files from an archive in ZIP or RAR format (ZIP64-compliant).

Any files that are not recognized as an archive are passed through the Problem jobs folder.

Note:
  • The Unarchive tool replaces the (now outdated) Uncompress tool, which did not provide Unicode support. Only use the old Uncompress (now available in the Legacy category) if you need support for MIME.
  • Very large archives (+4 GB) can be unarchived as well.

Keywords

Keywords can be used with the search function above the Flow elements pane.

The keywords for the Unarchive are:

Filenames and folder structure

The following table describes the resulting file or folder structure and the corresponding naming conventions.

Multiple files from the same archive are always placed in a job folder. If the intention is to inject these files into the flow as separate jobs, a job dismantler should be placed directly after the Unarchive flow element.

Archive contents

Unarchive result

Single file

The file (named as specified in the archive).

Multiple files or folders with a common root folder

A job folder (named as the nearest common root folder) containing all files and folders (named as specified in the archive).

Multiple files or folders without a common root folder

A job folder (named as the archive after stripping the extension) containing all files and folders (named as specified in the archive).

Connections

Unarchive allows only a single outgoing connection.

Properties

Property

Description

Name

The name of the flow element displayed in the canvas.

Description

A description of the flow element displayed in the canvas. This description is also shown in the tooltip that appears when moving your cursor over the flow element.

Passwords

A list of passwords for opening password-protected archives; each of the passwords in the list will be tried in turn.

The script expression can be used to determine a password dynamically, for example based on the sender of the packed data.

Note: The result of the script expression evaluation must be a string containing one password or a list of passwords separated by a newline character ('\n').

Example:

var thePasswords = new Array();
thePasswords.push( "password" );
thePasswords.push( "password2" );
thePasswords.join( '\n' );

Remove redundant folders

If set to Yes, for archives where the files or job folders are contained in deeply nested subfolder structures, removes all but the deepest subfolder level while uncompressing.

Example: A PDF file that is archived as "Folder 1\Folder 2\Folder 3\Test.pdf" is uncompressed as "\Folder3\Test.pdf", if this option is enabled.

Note: The Unarchive tool cannot read passwords which have been encrypted using the AES encryption. Switch uses zlib which does not support the AES encryption. As a workaround, users can try using a third-party archiver as a command line application from Switch.