afs_layer_serialize - AFS - Reference Guides

AFS Filters Description

Product
AFS
AFS_Version
7.11
Category
Reference Guides
language
English

The layer serialize filter enables writing the layer of a received document in a file. It is useful when a PaF is to be operated to modify some files, without indexing them. For instance, a PaF with an XSL filter and a layer serialize filter allows to keep the XSL result. The filter always passes the document to the next filter.

The filter is declared with the afs_layer_serialize type. It is in the antidot-paf-misc package. It is a processor filter.

This filter can be instantiated only once at any given moment. It will not read the "instances" parameter in the configuration.

The Layer Serializer filter specifications are described in the following table:

Parameter name

Mandatory

Type

Default

Description

output_dir

Yes

directory

N/A

The path of the output directory where to extract the layer. It is the absolute path (not relative to the current PaF).

input_layer

No

layer

CONTENTS

It is the layer to write on the disk.

suffix

No

string

No suffix appended

If specified, the suffix is added to the file name, hence giving it an extension.

use_doc_id

No

boolean

false

If set to true, the numerical doc_id of the document is used as the file name.

Note: The final filename is based on the base name of the file in the initial document.