Create Folder Class Window - General Tab

Use this window to create a folder class.

Name

Lists the folder class name. Maximum length is 32 characters, including spaces (leading and trailing spaces are removed). The name, which must be unique, is not case-sensitive.

Description

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

Index Fields

Define one or more index fields (up to 32,000) by clicking New Index Field and editing the information in the Index 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.

Display Label

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

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 importing the batch class.

If a display label is left blank, the index field name is displayed.

You may want to limit the length of your display labels. Although the index 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 wraps to several lines, which may be difficult for users to read.

Field type

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

Default

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

Required

Select True or False. If set to True, a folder based on this folder class is not created until this field has a value.

Verify

Select True or False. If set to True, the folder index field must be verified in the Verification module after being processed in the Validation module.

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.

Sticky

Select True or False. If set to True, the value of this index field is carried over to the next folder. The validation or verification operators can override the value in the subsequent folder if necessary.

If you specify "Sticky" and a default value, the default is used rather than the value from the previous folder.

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 Index Field button

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

You can also right-click in the Index 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 an index field selected, the new index field is inserted above the selected one. It is added with the same attributes as the selected index field.

Delete Index Field button

Deletes an index field from the Index Fields table. Select the index field you want to delete, and click Delete Index Field.

You can also right-click the index 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 the numeric keypad.