Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

ZIP Archive - Unzip

ZIP Archive Command Grooper.Core

Extracts files from the ZIP Archive and saves them as child documents of the Batch Folder.

Remarks

The Unzip command expands the contents of the attached ZIP Archive, creating a new child for each extracted file under the Batch Folder.

  • Supports sparse extraction (via the 'Sparse' property), where extracted children reference content inside the ZIP file without duplicating file data.
  • Allows filtering by file extension using 'Included Extensions' and 'Excluded Extensions'.
  • The 'Local Save Extensions' property enables saving certain file types as files on the Batch Folder rather than as child attachments.
  • The 'Output Extension' property can be used to change the file extension of extracted files.
  • The 'Maximum Files' property limits the number of files extracted (0 for no limit).
  • When 'Ignore Duplicates' is enabled, only unique files (by content hash) are extracted.
  • The 'Sort By Name' property controls whether files are extracted in name order.
  • The 'ZIP Disposition' property determines what happens to the original ZIP attachment after extraction (keep, remove, or replace).

Typical usage scenarios include:

  • Bursting a ZIP file into individual documents for downstream processing.
  • Selectively extracting only certain file types from a ZIP archive.
  • Efficiently handling large ZIP files by using sparse extraction to avoid unnecessary file duplication.

This command is available from the context menu of a Batch Folder with a ZIP Archive attachment.

Properties

NameTypeDescription

See Also

Notification