afs_zip_extract - AFS - Reference Guides

AFS Filters Description

Product
AFS
AFS_Version
7.11
Category
Reference Guides
language
English

Performs the extraction of data stored in ZIP archive files

The filter is declared with the afs_zip_extract type. It is in the antidot-paf package. It is a generator filter.

The Zip Extract filter specifications are described in the following table:

Parameter name

Mandatory

Type

Default

Description

crc_check

No

boolean

false

If set, perform a CRC check control before trying to open the archive

inherit_tags

No

boolean

false

If set, the project specific tags xId, yId, zId and language from the input document will be copied to each output document

input_layer

No

layer

CONTENTS

Layer holding the binary contents of the archive"

output_layer

No

layer

CONTENTS

Output layer

output_dir

No

directory

No export on disk

Output directory for supplemental outside-AIF storage of extracted files. If unset, only internal AIF storage is used

uri_prefix

No

string

file://localhost/

Uri prefix of new document, only when output_dir is not set

The contents of the archive file will be extracted, and the filter will create as many documents as needed. Created documents get URI of the following type: |urn:afs:xxx where xxx is a random string (UUID). It is possible, as an option, to save a standalone copy of these documents for processing outside of AIF, using the output_dir parameter. ACL/SAR of original documents are inherited by new documents. "origin_uri" field of generated layer is set to the uri of the archive file.
Note: For more information about UUID, see http://en.wikipedia.org/wiki/Universally_unique_identifier
Note: This filter launches a CRC validation test before unzipping all the data. If the ZIP archive is invalid, the input documents are marked as KO.