General tab - Extended Synchronization Settings window

Use the General tab to modify the extended synchronization settings.

The following Project settings are available:

Filename

Shows the full name (including the path) of the project file that was used for synchronization.

Description

A description that was set within the Project Builder project properties.

Copy project during publish

This option is selected by default, causing the project file to be copied to a subdirectory of the Kofax Capture installation every time the batch class is published. The path of the project file is saved to the custom properties for Server.

Important For a client/server installation and especially if you are using Kofax Transformation Modules with KCN Server this option must be selected, otherwise Server may not have access to the project file.

For testing on a local system, it may be useful to clear this option. This is especially true if you have a big database and publish the project very often, as a lot of disk space is consumed.

Send data to Kofax Reporting

Clear this option so that Kofax Transformation Modules does NOT collect statistical information for the reporting platform for the current batch class. This is especially useful for a batch class that is created for testing purposes only. However, statistical data for the modules in the workflow, such as when the module is started and closed, is still available and reported. This option is selected by default.

Tip You can define for a field or table field not to gather any statistical data by clearing the Use for statistics option in the field's properties in Project Builder.
Note The Send data to Kofax Reporting does not affect any settings for the KTM Statistics export connector. When an export connector is defined for a document class statistical data is gathered and can be viewed in the Statistics Viewer.
Populate all index fields for read-only access in script

If this option is selected, you can access all index fields of a Kofax Capture document class in script during Kofax Transformation Modules processing. For each index field an XValue, AC_Field_<fieldname>, is created that can be accessed read-only in script. If this option is cleared, the XValues are not created; however, you can access all mapped fields in script for read and write access. If needed, you can map a field to an index field and hide it from the user by not adding the field to the validation form or by hiding it on the form. This option is cleared by default. For more details about XValues, refer to the Kofax Transformation Modules Scripting Help.

Note This option is enabled only if Kofax Capture 10.0.2 (service pack 2) or a newer version is installed.

Important The number of document class index fields is also dependent on how Kofax Transformation Modules classes are synchronized to Kofax Capture document classes. For example, if you map two Kofax Transformation Modules classes that have different fields to the same Kofax Capture document class and map all fields for those classes, this document class ends up with index fields from both classes. That means that, if the option above is selected, both Kofax Transformation Modules classes have XValues for index fields that are not needed for that class. During processing for each document a considerable number of XValues are created, which can cause performance issues when loading a batch. It is best practice in such a case to clear the "Populate all index fields for read-only access in script" option.
Expose document UniqueID in script

Select this option to make the Kofax Capture UniqueID attribute for documents is available as an XValue on the XDocInfo level. The key is named "AC_UNIQUEID" and its value is read-only. This option is cleared by default.

Note Selecting this option may result in some performance issues. Please ensure that you enable this option only if it is required.
Delete empty batches on batch close

Select this option to delete an empty batch. This is true for batches that bypass all user modules as well as a batch that is manually closed by a user during any user module.

Important Selecting this setting can cause problems if you are using partial batch release. A workaround is to use document routing to move all of your documents to other batches and then delete the empty batch that is left over.
Import bar codes as XDocument objects

When selected, this setting imports any bar code information recognized during scan and saves it in the XDocument so that it is available when that document is processed further.

For example, select this option if you wish to use Enhanced Bar Codes for the Bar Code Locator.

For more information on Enhanced Bar Codes, refer to the Help for Project Builder.