afs_doc_set_meta - AFS - Reference Guides

AFS Filters Description

Product
AFS
AFS_Version
7.11
Category
Reference Guides
language
English

Set a document meta-data (x, y, z or custom) with a manually specified (or xpath matched) value

The filter is declared with the afs_doc_set_meta type. 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 Set a doc meta (any including x,y,z) with a given value or xpath expression filter specifications are described in the following table:

Parameter name

Mandatory

Type

Default

Description

use_xpath

No

boolean

false

Boolean toggle to extract meta value from xpath. If false, metadata value will be the value associated to the metadata key in 'metadatas' parameter. If true, metadata value will be the value of the xpath associated to the metadata key in 'metadatas' parameter.

separator

No

string

When use_xpath is true, multiple xpath may be present. In this case, all the values corresponding to the xpath are concatenated with this separator.

input_layer

No

layer

CONTENTS

The layer where @xpath is applied if use_xpath is set

metadatas

Yes

map

N/A

Value used to set the meta variable.

If use_path is true then the value will be extracted from xpath specified by this field, otherwise the manually specified value with be used.

Nothing will be set if use_path is set to true and there is no match.

ns_map

No

map

N/A

XML Namespaces (which may be used with xpath expression)

afs_doc_set_meta sets a doc variable (x, y, z or custom) with a value given in parameter. If the variable is already defined the old value is overridden.