Kofax Capture 8.0 Release Script User Manual

Kofax

Capture

Kofax Capture 8.0 Release Script for

FileNet Content Manager 5.0

Administrator’s Guide

June 8, 2011

Third-party software is copyrighted and licensed from Kofax's suppliers. This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

This product is protected by U.S. Patent No. 6,370,277.

THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF KOFAX, INC. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF KOFAX, INC.

Kofax, the Kofax logo, Kofax Capture, the Kofax Capture logo, and Kofax are trademarks or registered trademarks of Kofax, Inc. in the U.S. and other countries.

FileNet Content Manager is a registered trademark of FileNet Corporation.

Microsoft and Windows are registered trademarks of Microsoft Corporation.

All other product names and logos are trade and service marks of their respective companies.

U.S. Government Rights Commercial software. Government users are subject to the Kofax, Inc. standard license agreement and applicable provisions of the FAR and its supplements.

You agree that you do not intend to and will not, directly or indirectly, export or transmit the Software or related documentation and technical data to any country to which such export or transmission is restricted by any applicable U.S. regulation or statute, without the prior written consent, if required, of the Bureau of Export Administration of the U.S. Department of Commerce, or such other governmental entity as may have jurisdiction over such export or transmission. You represent and warrant that you are not located in, under the control of, or a national or resident of any such country.

DOCUMENTATION IS PROVIDED “AS IS” AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

Introduction ...................................................................................................................................................5

Additional Documentation ..................................................................................................................5

Technical Assistance for Your Kofax Product ...................................................................................5

System Requirements ...................................................................................................................................6

FileNet Content Manager Server Support .........................................................................................6

Client Operating System Support .......................................................................................................6

Administration and Release Workstations – Additional Requirements .......................................6

Source Code ............................................................................................................................................6

Features ..........................................................................................................................................................8

Kofax Values / FileNet Content Manager Properties ......................................................................8

Kofax Capture Value {Document GUID} ...........................................................................................8

Document Storage .................................................................................................................................9

Folder Creation ......................................................................................................................................9

Release Script Information Interchange Supported .........................................................................9

File Name Retention Supported ..........................................................................................................9

SecurityBoost Supported ......................................................................................................................9

FileNet Content Manager Object Store ...............................................................................................9

Choice List Properties Supported .......................................................................................................9

Duplicate Documents ..........................................................................................................................10

Release Working Directory ................................................................................................................10

Multiple Values ....................................................................................................................................10

Multiple Release Supported ...............................................................................................................10

Online Help Available for Release Setup .........................................................................................10

Image Support ......................................................................................................................................11

Kofax PDF Support ......................................................................................................................11

OCR Full Text Support ................................................................................................................11

eDocument Support .....................................................................................................................11

Additional Information ..............................................................................................................................11

Binary and Object Properties Not Supported ..................................................................................11

Viewing FileNet Content Manager Data in Release Setup ............................................................12

Skip First Page ......................................................................................................................................12

{Index Operator’s Station ID} Kofax Capture Value ......................................................................12

Document and Folder Names ............................................................................................................12

Document Title Property .............................................................................................................12

Folder Name Property .................................................................................................................12

Multi-value Separator Option ............................................................................................................13

Viewing Content Elements .................................................................................................................14

Kofax, Inc. 3

Contents

Viewing Duplicate Documents in FileNet Content Manager Administrative Tools ................14

File Name Retention Feature .............................................................................................................14

Behavior of the SupportsOriginalFileName Property ............................................................15

File Name Considerations ..................................................................................................................16

Duplicate File Names ...................................................................................................................16

Sharing Data Among Release Scripts ...............................................................................................18

Enable eDocument Processing ...........................................................................................................18

OCR Full Text Options .......................................................................................................................18

Kofax PDF Options ..............................................................................................................................20

Installing the Release Script ......................................................................................................................20

Important Note About Installation ...................................................................................................20

Installation Instructions ......................................................................................................................21

Upgrading the Release Script ....................................................................................................................21

Application Maintenance ..........................................................................................................................21

Repairing the Release Script ..............................................................................................................21

Removing the Release Script ..............................................................................................................22

Logging On to the Release Script .............................................................................................................22

Setting Up the Release Script ....................................................................................................................24

Publishing a Batch Class ............................................................................................................................24

Releasing Batches ........................................................................................................................................25

Data Type Compatibility ...........................................................................................................................25

Valid Boolean Formats ........................................................................................................................26

Kofax Value Data Types .....................................................................................................................26

Kofax Capture Values .........................................................................................................................26

Text Constants ......................................................................................................................................27

FileNet Content Manager Permissions ....................................................................................................27

Adding Access Permissions to the FileNet Content Manager Domain .......................................28

Recommended Permissions ...............................................................................................................28

FileNet Content Manager Domain .............................................................................................29

FileNet Content Manager Object Store .....................................................................................29

Create Folders ...............................................................................................................................29

Release Documents ......................................................................................................................29

Release Script Behavior .......................................................................................................................30

4 Kofax, Inc.

Introduction

This document contains the information for the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0, which supports FileNet Content Manager versions 4.0, 4.5, and 5.0 and is also compatible with Kofax Capture 9.0. This release script copies document images, OCR full text files, Kofax PDF documents, eDocuments, and writes data from Kofax Capture into FileNet Content Manager.

Important In Kofax Capture 8, the term “release script” is used to name the scripts, to refer to the

feature in the user documentation and Help, and used in the Kofax Capture User Interface for windows, menu items, etc. In Kofax Capture 9 and up, the term is changed to ”export connector.” This version of the script for FileNet uses “release script” throughout the product.

Additional Documentation

These release notes are a supplement to the following Kofax Capture documentation and Help:

 Kofax Capture Advanced Features Guide  Kofax Capture Release Notes  Getting Started with Kofax Capture guide  Installation Guide for Kofax Capture and Kofax Capture Internet Server  Learning Kofax Capture guide  Help provided from any of the Kofax Capture modules  Help provided with the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0

Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide

For more information about FileNet Content Manager or other FileNet products, contact your FileNet Content Manager representative or refer to the documentation that came with your FileNet Content Manager product.

Technical Assistance for Your Kofax Product

Support for your Kofax product is provided by your primary application support provider, which is specified as part of the maintenance agreement associated with your purchase. Please contact your Kofax application support provider for technical assistance.

For more information about your product, visit the Kofax Support pages at www.kofax.com

 Product information and release news  Access to the Kofax Knowledgebase  Access to the online Case Management System (for eligible customers)  Downloadable product documentation

Before contacting your Kofax application support provider, please gather the following information where applicable:

 Product name, version, and serial number  Log files  Product license  Exact error message(s)  Reproduction scenario

for:

Kofax, Inc. 5

Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide

System Requirements

The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 requires the following components to be installed prior to installing this release script.

FileNet Content Manager Server Support

The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 requires the following network server components:

 FileNet Content Manager Content Engine version 4.0, 4.5, or 5.0  FileNet Content Manager supported database  Microsoft .NET Framework 3.5 Service Pack 1

Note This release script was tested using FileNet Content Manager version 5.0 on a Windows

2003 Server (with Service Pack 2), and Microsoft SQL Server 2005. The clients used were running Windows XP SP3. The DNS Server running the Active Directory server is running on Windows 2000 Server SP4.

Client Operating System Support

The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 supports the following client operating systems:

 Windows 7 (Professional, Enterprise, or Ultimate Edition)  Windows XP Professional with Service Pack 3

Note At the time of publishing these release notes, the Kofax Capture 8.0 Release Script for

FileNet Content Manager 5.0 was certified with Windows XP Professional with Service Pack 3.

Administration and Release Workstations – Additional Requirements

The Kofax Capture Administration and Release workstations must have the following components installed:

 Kofax Capture 8 or Kofax Capture 9  Web Services Enhancements (WSE) 3.0 for Microsoft .NET  Microsoft .NET Framework 3.5 Service Pack 1

Source Code

The source code for the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 is provided and it is located on the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 installation media. Note that two source code projects are provided on the installation media. The release script source code project can be opened, edited, and compiled in Microsoft Visual Basic

6.0 with Service Pack 6. The connector, connector interface, and connector interface factory projects can be opened in Microsoft Visual Studio 2005.

6 Kofax, Inc.

Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide

X To modify the release script

1 Install the FileNet Content Manager release script. Refer to Installing the Release Script

page 20 for the installation instructions. When you install the FileNet Content Manager

release script, you will install the required components referenced in the source code.

2 Open the FileNet Content Manager release script project. Make sure the project references

point to the type library files installed with the release script

(Kofax.P8Rel50_V80.ConnectorInterface.tlb and

Kofax.P8Rel50_V80.ConnectorInterfaceFactory.tlb). Make any desired modifications, and

compile the FileNet Content Manager source code in Visual Basic.

Note If Microsoft Visual Basic displays a “Permission denied” error, you must close the

Kofax Capture Administration and Release modules before attempting to compile the

release script source code.

3 Copy the P8Rel50_V80.dll to the installation directory (for example, C:\Program

Files\Kofax\CaptureSS\ServLib\Cap\P8Rel50_V80). When you are prompted to replace

the existing file, select Yes.

4 Register the P8Rel50_V80.dll using the following command line:

regsvr32 “C:\Program

Files\Kofax\CaptureSS\ServLib\Cap\P8Rel50_V80\P8Rel50_V80.dll”

You will need to repeat this procedure on each Administration and Release workstation that will be using the FileNet Content Manager release script.

Note To successfully modify and compile the release script, development must occur on a

workstation with the appropriate versions of Kofax Capture and CAPTools.

Refer to the documentation that came with your FileNet Content Manager product and Visual Basic documentation for assistance.

X To modify the connector, connector interface, or connector interface factory

1 Install the FileNet Content Manager release script. Refer to

Installing the Release Script on

page 20 for the installation instructions.

2 Open the solution Connector.sln, which contains the connector, connector interface, and

connector interface factory projects. Make any desired modifications, and rebuild the

solution in Microsoft Visual Studio 2005 under the Release build configuration.

3 Copy the following files to the installation directory (for example, C:\Program

Files\Kofax\CaptureSS\ServLib\Cap\P8Rel50_V80):

Kofax.P8Rel50_V80.Connector.dll

Kofax.P8Rel50_V80.ConnectorInterface.dll

Kofax.P8Rel50_V80.ConnectorInterface.tlb

Kofax.P8Rel50_V80.ConnectorInterfaceFactory.dll

Kofax.P8Rel50_V80.ConnectorInterfaceFactory.tlb

When you are prompted to replace the existing files, select Yes.

Kofax, Inc. 7

Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide

4 Register the Kofax.P8Rel50_V80.ConnectorInterface.dll and the

Kofax.P8Rel50_V80.ConnectorInterfaceFactory.dll by invoking the regasm command in

the command line prompt. The command to register these dll’s is:

regasm.exe [InstallDir]\<name of .dll> /codebase /tlb

For example:

regasm.exe C:\Program

Files\Kofax\CaptureSS\ServLib\Cap\P8Rel50_V80\Kofax.P8Rel50_V80.Connector

Interface.dll /codebase /tlb

RegAsm.exe is located in C:\Windows\Microsoft.NET\Framework\v2.0.50727\. To run

this executable, you can navigate to this folder and run it or place this path in the Path

environment variable and run it from any location.

5 Re-compile the release script using steps 2 through 4 in the “To modify the release script”

section above. These steps ensure that the release script references the newly registered

connector interface and connector interface factory. Make sure that the project references

the two .tlb files.

Note To successfully modify and compile the connector, connector interface, or connector

interface factory, development must occur on a workstation with Microsoft WSE 3.0

(development setup).

Features

This section contains information about features provided with the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0.

The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 provides an easy-to-use setup window available from the Kofax Capture Administration module. The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 — Release Setup window allows you to specify release settings at batch class setup time that control how documents, folders, and other information are released into the FileNet Content Manager object store.

Kofax Values / FileNet Content Manager Properties

The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 provides an easy-to-use interface for linking Kofax Capture Kofax Values to FileNet Content Manager document properties and folder properties. Examples of Kofax Values include Document index fields, Folder index fields, Batch fields, Kofax Capture Values, and Text Constants. The names of “required” FileNet Content Manager properties within a document class or folder class are marked with an asterisk (*), giving you a visual indicator that certain fields must be linked.

Kofax Capture Value {Document GUID}

The Kofax Capture Value {Document GUID} is a new value that can be used for index fields and release values. The Kofax Capture Value is a type of document ID that is unique across the central site and all remote sites that comprise an Kofax Capture installation. This Document GUID is the concatenation of the Batch GUID and the document ID number. For example, a Batch GUID of {D3C58EE2-5627-443b-BBFA-EE7A5790482A} and a document ID of 123 will yield {D3C58EE25627-443b-BBFA-EE7A5790482A} 123 as the Document GUID.

8 Kofax, Inc.

Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide

Document Storage

With the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0, you can specify new or existing folders for storing documents in the FileNet Content Manager object store for release. You can use Kofax Capture Kofax Values to specify a document name or folder name.

Folder Creation

When releasing to user-defined folders, the release script searches the FileNet Content Manager object store to locate a folder based on the Folder Name property and the location of the FileNet Content Manager object store.

If the folder is found, this folder will be used for release. The existing properties of the folder will not change, even if Kofax Values are linked to the properties for the folder.

If the folder is not found, a new folder is created in FileNet Content Manager using the values specified at release setup.

Release Script Information Interchange Supported

The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 supports the Kofax Capture Release Script Information Interchange feature. This feature allows the release scripts to pass information to other release scripts.

Refer to

Sharing Data Among Release Scripts on page 18 for more information.

File Name Retention Supported

The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 supports the Kofax Capture File Name Retention feature. This feature allows you to retain the original imported file name.

Refer to

File Name Retention Feature on page 14 for more information.

SecurityBoost Supported

The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 supports the Kofax Capture SecurityBoost feature. Refer to your Kofax Capture Help for more information about the SecurityBoost feature.

FileNet Content Manager Object Store

When setting up the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0, you can easily select the FileNet Content Manager object store to use for your released documents.

Choice List Properties Supported

FileNet Content Manager Choice List properties are supported. To enable releasing to the FileNet Content Manager object store, you must know the choice list values and link appropriate Kofax Values to the Choice List properties. Note that Choice List properties are not visually different from non-choice list properties.

For more information about the FileNet Content Manager Choice List properties, refer to the documentation that came with your FileNet Content Manager product.

Kofax, Inc. 9

+ 21 hidden pages