Folder Settings tab

Use this tab to specify new or existing folders to store documents in the IBM Content Manager Enterprise system. In addition, you must specify a Content Manager item type to use for assigning attributes for each folder in the folder hierarchy using Kofax Values, and optionally assign an item type to each folder.

Export Connector name

Enter a name for your export connector. This name appears on the list of export connectors in your scan application. This field is not required, but may help you keep track of export connectors if you use the Kofax Capture multiple export feature. Maximum length is 32 characters.

Add documents to folder

Select this check box to export documents to a new or existing Content Manager folder.

  • When selected, all other options on the tab become available as you select or add Content Manager folders.

  • When not selected, all other options on the tab become unavailable. At export time, documents are stored at the root level of the Content Manager library server.

Folder Hierarchy

This area provides a hierarchical view of the folders defined during export setup. At export time, the folders you define are used for storing documents in the IBM Content Manager Enterprise system. Use the Add Folder and Delete Folder buttons to add or delete folders from the hierarchy.

Add Folder button

Click this button to add a new folder to the folder hierarchy. Each folder added can have different item type attributes.

New folders are added to the bottom of the hierarchy with the name "Folder n," where n represents the level of the folder in the hierarchy. The level starts at 1.

Only one subfolder per folder is allowed.

Note The names shown in the folder hierarchy are used during export setup only. Once a new folder is added, you can select it from the hierarchy and specify folder attributes for it. The folders detected at export time are based on the folder attributes that you specify. See Folder Attributes in this topic for more information.
Delete Folder button

Click this button to delete the selected folder and any subfolders.

Folder Attributes

Use these options to specify a Content Manager item type to use for assigning attributes to folders, and determining the search criteria for finding existing Content Manager folders at export time. The options you set apply to the folder selected in the folder hierarchy.

Item type

This list contains the available Content Manager item types as defined for the current Content Manager library server (a Content Manager library server was selected when you logged in to the export connector). The item type is used for assigning attributes to new folders in the IBM Content Manager Enterprise system. Notice that only the item types allowed for the logged-in user are listed.

Only one item type can be selected per folder. However, you can select a different item type for each folder.

Refer to the documentation that came with your IBM Content Manager Enterprise product for more information about defining item types.

Searches

Use the Search check boxes to indicate which Content Manager attributes to use when searching for existing folders in the IBM Content Manager Enterprise system at export time. The marked Content Manager attributes become the search criteria for finding Content Manager folders. The check boxes are available for attributes that are linked to Kofax Values.

During export, the parent folder hierarchy in Content Manager is searched for folders that match the search criteria. If the folder is found, documents are exported to it. If the folder is not found, it is created. Note the following:

  • The initial search is performed based on the attributes marked for search. If exactly one match for the parent folder is found, the document is stored into that folder.

  • If more than one parent folder is found based on the attributes marked for search, another search is performed. The new search includes all linked attributes, including those not explicitly marked for search.
    • If exactly one match for the folder is found, the document is stored into that folder.

    • If more than one match is found, the document is exported into the first matching folder that is found, and a warning is written to the Kofax Capture error log.

    • If no match is found, the first folder from the initial search is selected.

  • Searching for folder child component attributes is not supported. As a result, the Search check box is unavailable for child component attributes.

  • To specify the first level child component attribute values, ensure that new folders are created at export time. Therefore, if you perform a search based on the root attributes only, the values for the child component attributes are lost when the search routine finds an existing folder. This occurs because the existing folder is not updated at export time. To do so, do one or both of the following:

    • Use unique root attribute values that do not already apply to existing folders in the IBM Content Manager Enterprise system.

    • Clear all the Search check boxes to force the export connector to create a new folder.

Content Manager Attributes

Use this table to establish links between Content Manager attributes for folders and Kofax Values. At export time, the specified Kofax Values are used as search criteria for finding existing folders in Content Manager, or as properties for folders that must be created in Content Manager. For details, see Content Manager attributes.

Kofax Values

This list includes the available Kofax Values to link with Content Manager attributes. To do so, select the Kofax Value field associated with an attribute, and a context menu button appears. Click the button to display a menu of options for linking values to your Content Manager attributes. You can select Kofax Values as listed here:

The data types for the linked Kofax Values must be compatible with Content Manager data types. The data types are checked for compatibility when you save your settings during export setup. See Data Type Compatibility.

Unlink Field

Select this option to unlink a Kofax Value from the selected Content Manager attribute.

Document Index fields

Displays a list of Kofax Capture index fields defined for the document class. If no document index fields are defined for the document class, this option is not available.

Folder Index Fields

Select this option to display a list of Kofax Capture index fields defined for the folder class. If no index fields are defined for the folder class, this option is not available.

Batch fields

Displays a list of Kofax Capture batch fields defined for the batch class. If no batch fields are defined for the batch class, this option is not available.

Kofax Values

Displays a list of Kofax Values.

Custom Values

Displays a custom index field called #Original File Names. The index field value is a list of original file names delimited by the multi-value separator defined on the General Settings tab.

For example, if a document has 3 pages that consist of image1.jpg, image2.jpg, and image3.jpg with a semicolon as the separator, the value of {#Original File Names} would be:

"image1.jpg;image2.jpg;image3.jpg"

You can select the custom index field from the menu, or type the text {#Original File Names}.

  • With Kofax Capture, you must select Use the original file name of image and eDocument files when you set Export Properties during batch class configuration.

  • With Kofax TotalAgility, you must set Original file name support to True on the Export Connectors - Properties screen.

  • With Kofax Express, original file name support is not available.

Text Constant

Select this option to specify a text constant. Then, enter the desired text. Leading and trailing spaces are removed.

Dynamically select item type at export using the following Kofax Value

Use this check box to dynamically assign an item type for the specified folder at export time. To do so, click the context menu button to display a menu of options for linking a Kofax Value to represent the item type for your folder. At export time, the specified Kofax Value is dynamically assigned to the specified folder. Note that:

  • The name of the dynamic item type is case sensitive and must match the Content Manager name at export time. You must use the item type name when dynamically assigning an item type to your folders.

  • You can use dynamic item types for some folders and static item types for other folders.

  • A static root attribute or child component attribute must be found in the dynamic item type.

The following two examples help to illustrate the use of dynamic item types:

  1. Your IBM Content Manager Enterprise library server contains several item types that are identical or are very similar. During export setup, you can select any item type containing the desired Content Manager attributes from the Item type list and link the appropriate attributes. During Kofax Capture processing, enter the desired item type for your batch of documents.

  2. Your IBM Content Manager Enterprise library server contains all the defined root attributes or the most commonly used root attributes. This ensures that all attributes are accounted for, regardless of which item type is selected at export time. During export setup, you can use the new master item type. If the item type is not found in the master, then the export fails and the batch is routed to the Kofax Capture Quality Control queue. For more information about creating item types, see the IBM Content Manager Enterprise product documentation.