1. Home
  2. Transact
  3. Features and Functions
  4. Administrator Role and Features
  5. Batch Class Management
  6. Index Fields

Index Fields


Index fields are the configurations which are used in Extraction module. Index fields are configured inside a Document Type. There could be multiple Index Fields for each Document Type. All the Extraction Modules are executed using these settings of Index Fields. The Index Fields have following functionality:

Copy Index Fields:

Index Fields can be copied from the Index Fields menu bar. On selecting an already present index field, the field can be duplicated by clicking on Index Field menu bar. When clicking copy button in menu bar, the copy of selected Index Field is created and a success message is displayed on the top right corner. When copying an Index Field all the KV Extraction rules and Validation rules inside it are duplicated in the new copied Index Field. Below attached is the screenshot for the same:


The copied Index Field should have a unique name:

Category in Index Fields:

Category of an Index Field can be described as the group into which it will be assigned. An Index Field can be assigned to any user defined category, will be displayed in combo-box. All the Index Fields belonging to the same category will be displayed under same tab on Validation screen. Any Index Field that does not have any category will be assigned by default “Group 1”. Below specified screenshot displays the different categories of index field set as “Group 1” and “Group 2”:

Field Type:

Field Type defines that this Index Field will extract which type of value. This configuration is used to define how the extracted results of the Index Field will be displayed on Validation screen. There are different type of settings/widgets which could be used to display the results of the extraction for Index Field:

  1. TEXT
  2. LIST
  4. DATE
  6. COMBO

Each configuration is used to display a widget on Validation screen in which the extracted data will be displayed. The configuration can be done as follows:



Additional Configurations:

Index Fields has an additional configurations column incorporating the following properties:

  • Force Review Index field with force review property is set will be marked for review by the Operator in Validation stage.
    Tag ForceReview will be set to true in Batch XML, under the following hierarchy:
  • Force Review (Alternate Values): Index field with additional configuration set as Force Review (Alternate Values) will be marked for review by Operator whenever if there is an alternate value extracted with same confidence as the value set as main value.
    Tag ForceReview will be set to true in Batch XML
  • Field Value Change Script :This property governs whether field value change script will run for that index field or not, if Field Value Change Script Switch is set as ON in Validation plugin.
  • Hidden: All the Index Fields which are assigned as hidden will not be visible on Validation screen. The values will be extracted for the hidden Index Fields but the values will not be visible to the operator on Validation screen, they will only be updated in the batch xml for running batch.
  • Read Only: This configuration makes the Index Field only readable on the Validation screen. The Index Fields which will be declared as Read Only, any value extracted for them will be present on the Validation screen but will not be available for editing. Operator can only read the values for these fields.
  • Apply to all :If user configure “Apply to all” functionality for any Index Field of a Document Type on BCM screen. Then if the value of the Field is empty or not extracted by any extraction plugin. Then, its value will be populated with the value of the field of different document which is in focus last time and has some value and this field should belong to same Document Type and both field should be same.


The configuration for these properties can be done in additional configurations combo-box through checkboxes as shown in the screenshot.


Was this article helpful to you? Yes No