DocuNECT Export Connector for Kofax in v5.0

Installing and Configuring DocuNECT v5.0


This export connector is a plug-in to the Kofax Capture v10.2 platform that allows document scanned and indexed to be released to DocuNECT v5.0.


Before You Begin

1. Review the Component Compatibility page to ensure that the target environment meets the necessary specifications.

2. The target scanning workstation(s) must have the Microsoft .NET Framework v4.5 installed (if not already present). A link to the foundation classes can be found in the Downloads page.

3. Remove all previous versions of the DocuNECT Export Connector for Kofax product.


Run the Install for the DocuNECT Export Connector for Kofax

The following points provides a step-by-step guide to installing the export connector:

1. Locate the .msi file which can be downloaded from the Downloads page. Once located, double-click on the file to initiate the install wizard.

2. Once the install wizard is initiated a welcome screen will be displayed.

3. After pressing the Next button the installation folder screen is displayed. It is recommended to select the defaults, but the location of the installation files can be changed. Upon pressing the Next button, the confirm installation screen is displayed.

4. On pressing the Next button, the files will be installed.

5. A screen will be displayed confirming that the installation is complete.

6. Open the Kofax Aministration module, click on the Tools menu and press the Export Connectors button as shown below:

KfxAdminModule.jpg

7. Press the Add button and browse for the DocuNECTKfxExport.inf file located in the \Program Files (x86)\DocuNECT Export for Kofax folder. On selecting the file, a popup will be displayed confirming the installation is complete.


Configuring the DocuNECT Export Connector in the Batch Class

The following points provides a step-by-step guide to configuring the export connector:

1) Select the Export Connectors option in the right-hand mouse click menu on the document class within the batch class as shown below:

kfxExportConnectors.jpg

2) Select the DocuNECT Export Connector and press the Add » button and connector setup will be displayed.

DCN Instance Tab

This tab manages the connection to the DocuNECT instance. The connection for setup and release uses DocuNECT's Document Framework - Web Services. The Name field allows a name to be entered to define the export script and is optional. This is useful if multiple DocuNECT Export Connectors are being defined for one Kofax document class.

kfxExport_DCNInstance.jpg

The following table provides an explanation of the fields.

Field Description
Web Server The name of the web server where the DocuNECT Web product is installed on.
Instance Name The name of the DocuNECT instance.
SSL Indicates whether the target DocuNECT Web server is accessed by using SSL encryption.
Username The DocuNECT username that will be used for both configuration and release.
Password The DocuNECT user password that will be used for both configuration and release.

Index Settings Tab

This tab manages the linking of the Kofax fields to the DocuNECT cabinet indexes.

kfxExport_IndexSettings.jpg

The following table provides an explanation of the fields.

Field Description
Cabinet This allows the DocuNECT cabinet to be selected. Note, this displays all the cabinets that the user (specified in the DCN Instance tab) has access to. This makes sure that will be no security issues on release to DocuNECT.
Indexes On selecting the cabinet the associated indexes will be displayed on the left side of the grid. Against each field, use the link button kfxLinkButton.jpg to associate the Kofax mapping.

Distribution Tab

This tab manages the fields required for the distribution to DocuNECT.

kfxExport_Distribution.png

The following table provides an explanation of the fields.

Field Description
Temp Export Directory This is a temporary folder that Kofax uses while release the batch document to DocuNECT. Once the batch has been processed then the documents are deleted.
Select Lifecycle All documents being uploaded to DocuNECT need to be associated to a lifecycle. The lifecycle is created in the Administration section of DocuNECT Web, or the Lifecycle Editor.
Remove Cover Page Check this box if the first page needs to be removed.

The Export Process to DocuNECT

When the batch documents are released to DocuNECT the following behavior should be noted.

1) Any document indexes that fail validation will result in an error and the batch will be sent to the Quality Control stage in Kofax with the error message.
2) All validation defined in the DocuNECT cabinet will be applied, including:
- Required Fields
- Fields compared against picklist and data sources
- Validation rules (regular expression formats defined in the index schema)
3) If there is no value indexed in Kofax, but a default value for the index has been defined in the index definition then this will be applied.
4) Database lookups, if defined, will be executed on export and will overwrite other values if indexed in Kofax.