› Batch Class Management › Index fields › Add index field

Add index field

An index field is used to store metadata for fields in a particular document. These fields can then be used to classify documents or extract data from the documents. Here are some potential index fields for a sample document type such as US Driver's License:

  • Address

  • First Name

  • Last Name

  • License Number

Index fields are Document Level Fields (DLF), which means they are unique to their document type. Index fields contain extraction and validation rules that determine what data should be extracted from your uploaded documents.

To create index fields, you need an existing batch class and document type.

Add new index field

To add a new index field, do the following.

  1. Go to Batch Class Management.
  2. Select your batch class and click Open.

    When you open a batch class, the Document Types page displays by default.

  3. Select your document type from the Document Types folder. This will open the Index Fields page.
  4. Click Add to create a new index field.
  5. Create a Name and Description for the index field. Click the red text box and begin typing.

    The index field name cannot be changed once the workflow has been deployed.

  6. Perform any additional configurations according to your requirements and click Apply.

Import index field

You can also import index fields between batch classes or servers. This can be helpful if you have multiple batch classes with the same index field, or if you need to move to a new Ephesoft Transact environment.

  1. Go to the Batch Class Management page and open your bach class.
  2. Select Document Types > [your document type] > Index Fields.
  3. Select one or more index fields to export.
  4. Click Export.

    This creates a .zip file that you can then import to a different batch class or Transact environment.

  5. To import the zipped index field, click Select Files in the bottom panel, or drag and drop the .zip file into the dotted area.