Default Index Field Value Plugin

 Overview

Default Index Field Value Plugin will be responsible for providing a default value to the document level index field. Admin can configure this default value either by providing some default value or via batch field values which is provided by the user at the time of uploading batch via web-scanner or upload batch screen.

Description

Default Index field value plugin is used for providing default values to the document level index fields which is configured by the admin at the time index field configuration. This plugin is basically introduced for the purpose of providing some default value to those document level index field whose values are not extracted by any of the other extraction plugin. Though this plugin has no dependency but the best place to place this plugin is after all the extraction plugin.

Configuration

In order to configure this plugin admin needs to “ON” the switch of the Default Index Field Value Plugin. By default switch value is “OFF”. Then admin needs to configure Default Value or Default Value Batch Class Field or both for the index field he wants to configure on the index field screen of BCM.

In the Default Value column admin can give any value he wants to assign to that Index Field but in the Default Value Batch Field column admin can only configure those Batch Class Field which is same type i.e. if Index Field data type is String type then in the Default Value Batch Field column of that field only String type Batch Class Field will be shown in the drop-down to configure. For this please refer the below screen-shot.

The Default Index Field Value plugin includes five global batch class fields. They can be used to default any index field to the value of the configured system defined variable. If no value is extracted for that field by configured extraction rules, the Default Index Field Value plugin will populate the field with the corresponding system defined variable value and save it in batch.xml.

The following global default value batch class fields are available for the plugin:

Field Name Variable on the UI
Batch Class Description SYS:$BatchClass:Description
Batch Class Identifier SYS:$BatchClass:Identifier
Batch Class Name SYS:$BatchClass:Name
Batch Creation Date SYS:$Batch:CreationDate
UNC Folder SYS:$Batch:UNCPath

To configure the index field, the user needs to simply select required value from the Default Value Batch Class Field drop-down on the Index Fields screen. The fields are arranged in alphabetical order, highlighted in grey and placed below the user configured batch class fields under a separator.

Note that above-mentioned names of the global batch class fields are reserved for system defined variables and should not be used when creating new customized batch class fields.

 

How It Works

If the Default Index Field Value Plugin switch is “ON” and admin configure both Default Batch Class Field Value and Default Value for the Index Field. Then preference will be given to the Batch Class Field Value. If in case user doesn’t provide any value for the Batch Class Field at the time of uploading batch through web-scanner or upload batch screen, then Default Value will be taken into consideration. If in this case user doesn’t provide any Default Value also, then no value provided to that document level index field.

If admin only configure Default Batch Class Field Value and user case doesn’t provide any value for the Batch Class Field at the time of uploading batch through web-scanner or upload batch screen, then no value provided to that document level index field.