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 configured inside a document type. You can have multiple index fields for each document type. Transact uses the index field settings during extraction.

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 the combo-box. All the Index Fields belonging to the same category will be displayed under the same tab on the 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”:

Figure 1. Category Field

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 the Validation screen in which the extracted data will be displayed. The configuration can be done as follows:

Figure 2. Field Type

Additional Configurations:

Index Fields have an additional configurations column with the following properties:

  • Force Validation: Index fields with the force validation property set will be automatically marked for manual validation.
    The tag “ForceReview” will be set to “true” in the batch.xml, under the following hierarchy:

    • Documents
      • Document Level Fields
        • DocumentLevelField
          • ForceReview
  • Force Validation (Alternate Values): Index field with the additional configuration set as Force Validation (Alternate Values) will be marked for manual validation whenever there is an alternate value extracted with the same confidence as the value set as the main value.
    The tag “ForceReview” will be set to “true” in the 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 the Validation screen. The values will be extracted for the hidden Index Fields but the values will not be visible to the operator on the 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. The operator can only read the values for these fields.
  • Apply to all: If you configure “Apply to all” functionality for any Index Field of a Document Type on the BCM screen. Then if the value of the field is empty or not extracted by any extraction plugin, its value will be populated with the value of this index field. This field should belong to the same Document Type and both fields should be the same.

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

Figure 3. Additional Configurations


Was this article helpful to you? Yes 1 No 1