Create Batch Class Window - General Tab

Use the settings on this tab to create a new batch class.

Related Tabs

Name

Name of the batch class.

Priority

This is the initial priority for this batch class. It can be any value from 1 to 10, with 1 being the highest priority and 10 being the lowest. The default is 5.

The priority value specifies the order in which batches created with this batch class are processed by each module. It is most significant in the unattended modules, as operators in attended modules may select batches in any order. The initial value set here is the value specified when a batch based on this batch class is created. It may be changed in production by either the scan operator from the Scan module or Batch Manager.

Description

Enter up to 80 characters. The description is used for informational purposes only and appears whenever properties for the batch are displayed.

Image folder

Enter a path and folder name where images of this batch class are to be stored. (Alternatively, you can browse for the folder.) This folder provides temporary storage of the image files from the time they are captured by the Scan module until they are exported to permanent storage by the Export module. The folder must be accessible to all Kofax Capture modules set up to process this batch class.

Batch Fields

Define one or more batch fields. Click the New Batch Field button and edit the information in the Batch Fields table:

Name

Enter up to 32 characters, including spaces. (Leading and trailing spaces are removed.) The name, which must be unique, is not case-sensitive.

By default, batch field names are added in the form Namen (where n is a value from 0 to the maximum number of batch fields). You can enter a different name.

Display Label

For each batch field or index field, you can enter a corresponding Display Label value. The value in the Display Label (instead of the actual batch field or index field name) appears where there are field names, such as in the Scan, Validation, and Verification modules, and in batch properties in Batch Manager.

For example, you may have an index field named cust_name, but you could create a display label to have your users view the field as Customer Name. Or, if you are creating a batch class for use in another region, you could enter the labels in the language of the region that is importing the batch class.

If a display label is left blank, the batch field or index field name appears.

Tip You may want to limit the length of your display labels. Although the Index/Batch Field Name cannot exceed 32 characters, the display label can contain up to 254 characters. A label that contains more than one line of text will wrap to several lines, which may be difficult for users to read.
Field Type

Select a field type for your batch field. All previously defined field types are available in the drop-down list. Define one or more new field types. You do so by clicking the New Field Type button.

Default

Enter or select a default value for the batch field. You can enter a value, or select from the drop-down list of List of Kofax Capture Values.

Required

Select True or False. If set to True, a batch based on this batch class is not created until this field has a value. The value is typically supplied by the Scan module or Batch Manager.

Hidden

Select True or False. If set to True, the value of this field is not displayed.

You cannot set both Required and Hidden to True. If you set one to True, and then attempt to set the other to True, the first one you set is reset to False.

New Field Type button

Opens the Create Field Type window, where you can define a field type. The new field type is available in the Field Type drop-down list and the Field Types tree view tab.

New Batch Field button

Adds a new batch field to the Batch Fields table. The new batch field is added with default values for all the batch field attributes, but you can edit the defaults.

You can also right-click in the Batch Fields table and do one of the following: select Insert from the context menu or press the Insert key on the standard keyboard or the numeric keypad. If you do so with a batch field selected, the new batch field is inserted above the selected one. It is added with the same attributes as the selected batch field.

Delete Batch Field button

Deletes a batch field from the Batch Fields table. Select the batch field you want to delete, and click this button.

You can also right-click on the batch field you want to delete and do one of the following: select Delete from the context menu or press the Delete key on the standard keyboard or numeric keypad.