Default Index Field Value plugin
The Default Index Field Value plugin gives a default value to the document level index field. The administrator can configure this default value either by providing some default value or via batch field values. Batch field values are provided by a user when uploading a batch via web scanner or upload batch screen.
This plugin is basically introduced for the purpose of providing some default value to those document level index field values that are not extracted by any of the other extraction plugins. Although this plugin has no dependency, we recommend to place this plugin after all the extraction plugins.
Configuration
To configure this plugin, you need to turn ON the switch of the Default Index Field Value plugin. By default, the switch value is OFF. Then administrators need to configure Default Value or Default Value Batch Class Field or both for the index field they want to configure on the index field screen of Batch Class Management.
In the Default Value column, the administrator can give any value to assign to that Index Field. However, in the Default Value Batch Field column, the administrator can only configure the Batch Class Fields of the same type. For example, if the Index Field data type is "String", then in the Default Value Batch Field column of that field only the String type Batch Class Field is shown in the drop-down list to configure.
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 populates the field with the corresponding system-defined variable value and saves 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, from the Default Value Batch Class Field drop-down list on the Index Fields screen, select the required value. The fields are arranged in alphabetical order, highlighted in grey and placed below the user configured batch class fields under a separator.
How it works
If the Default Index Field Value plugin switch is ON and the administrator configures both the Default Batch Class Field Value and Default Value for the Index Field, then the preference is given to Batch Class Field Value. If a user does not provide any value for the Batch Class Field when uploading a batch through a web scanner or upload batch screen, then the Default Value is taken into consideration. If in this case a user does not provide any Default Value, then no value is provided to that document level index field.
If the administrator only configures Default Batch Class Field Value and a user does not provide any value for the Batch Class Field when uploading a batch through a web scanner or upload batch screen, then no value is provided to that document level index field.