Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Snap type:

Transform


Description:

This Snap decompresses the contents of a binary stream. For example, if a File Reader Snap was configured to read a compressed file, you can use this Snap to decompress the contents before passing the data to a parsing Snap. It currently supports decompressing files in the GZIP, BZIP2, and DEFLATE compression schemes. The decompression scheme can be explicitly chosen or automatically detected based on the contents of the binary stream. If the compression scheme is set to AUTO and the incoming data is not compressed, the raw input data is passed through without any changes.


Note

The Decompress Snap only uncompresses the compressed files on the first level. It does not decompress the archived folders which are located at the second level and deeper.


Prerequisites:

[None]


Support and limitations:
  • Works in Ultra Pipelines.
  • Snap supports decompression of the following compression schemes:
    • GZIP
    • BZIP2 (or BZ2)
    • DEFLATE
Account: 

Accounts are not used with this Snap.


Views:


InputThis Snap has exactly one binary input view.
OutputThis Snap has exactly one binary output view.
ErrorThis Snap has at most one binary error view and produces binaries in the view.


Settings

Label


Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Scheme



Required. The decompression scheme to use. The available options include:

  • AUTO - To automatically detect the decompression scheme to be applied (based on the compression scheme) on the incoming documents. 
  • BZIP2 - To decompress files compressed in the BZIP2 compression scheme.
  • GZIP - To decompress files compressed in the GZIP compression scheme.
  • DEFLATE - To decompress files compressed in the DEFLATE compression scheme.

Default value: AUTO 


Note
titleAUTO Scheme - Supported schemes

Automatic scheme detection and decompression is possible only for the three supported compression schemes - GZIP, BZIP2, and DEFLATE. 


Multiexcerpt include macro
nameSnap Execution
pageAnaplan Read


Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read


Insert excerpt
Binary Snap Pack
Binary Snap Pack
nopaneltrue