Kofax Release Script User Manual

Kofax Capture

Release Script for

FileNet Image Services

Release Notes

September 14, 2010

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, Ascent Capture, the Ascent Capture logo, and Ascent are trademarks or registered trademarks of Kofax, Inc. in the U.S. and other countries.

FileNet Image Services and IDM Desktop are registered trademarks 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 ...................................................................................................................................................1

Additional Documentation ..................................................................................................................1

System Requirements ...................................................................................................................................1

FileNet Image Services Server Support ..............................................................................................1

Client Operating System Support .......................................................................................................2

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

Source Code ............................................................................................................................................2

Features ..........................................................................................................................................................3

Kofax Capture Values / FileNet Attributes .......................................................................................3

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

Release to FileNet Image Services Repository ...................................................................................3

Multiple Release Support .....................................................................................................................3

Storage Folders .......................................................................................................................................4

Release Script Information Interchange Supported .........................................................................4

Online Help Available for Release Setup ...........................................................................................4

Image Support ........................................................................................................................................4

Kofax PDF Support ........................................................................................................................4

Adobe Acrobat Capture PDF Support ........................................................................................5

eDocuments Support .....................................................................................................................5

Additional Information ................................................................................................................................5

Unsupported Kofax Capture Features ...............................................................................................5

SecurityBoost ...................................................................................................................................5

File Name Retention .......................................................................................................................6

Commitment Of Documents ................................................................................................................6

Image Formats Settings ........................................................................................................................6

Skip First Page ........................................................................................................................................6

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

Menu Item Data Type Support ............................................................................................................6

Sharing Data Among Release Scripts .................................................................................................7

Enable eDocument Processing .............................................................................................................7

OCR Full Text is Not Supported .........................................................................................................8

Kofax PDF Options ................................................................................................................................8

Adobe Acrobat Capture Options ........................................................................................................8

Operating System Requirements for Kofax Capture ................................................................9

Adobe Acrobat Capture and the Kofax Capture Release Workstation Installations ...........9

Releasing Adobe PDF Documents ...............................................................................................9

Workflow Steps ..............................................................................................................................9

Kofax, Inc. iii

Contents

Multipage TIFFs ............................................................................................................................10

Releasing From Multiple Kofax Capture Standalone Workstations .....................................10

Re-releasing Documents in Error ...............................................................................................10

Invalid Watched Folders .............................................................................................................10

Installing the Release Script ......................................................................................................................10

Important Note About Installation ...................................................................................................10

Installation Instructions ......................................................................................................................10

Upgrading the Release Script ....................................................................................................................11

Important Note About Upgrade .......................................................................................................11

Upgrading From Version 5.0 of the FileNet Image Services Release Script ........................11

Upgrade Instructions ..........................................................................................................................12

Application Maintenance ..........................................................................................................................13

Repairing the Release Script ..............................................................................................................13

Removing the Release Script ..............................................................................................................13

Logging On to the Release Script .............................................................................................................14

Setting Up the Release Script ....................................................................................................................14

Release Login Settings Tab .................................................................................................................15

Storage Settings Tab ............................................................................................................................15

Document Properties Tab ...................................................................................................................15

Image Format Tab ................................................................................................................................15

General Settings Tab ...........................................................................................................................15

Publishing a Batch Class ............................................................................................................................15

Releasing Batches ........................................................................................................................................16

Known Problems ........................................................................................................................................16

Problems When Installing on Windows XP ....................................................................................16

Problems When Uninstalling the Release Script .............................................................................17

SMALLINT Data Type Limitation ....................................................................................................17

Document Attribute Field Length Limitation .................................................................................17

Upper ASCII Character Limitations When Creating Folders .......................................................17

Running Multiple Release Instances Requires FileNet Image Services Setting .........................18

Login Method Affects Login and Release Behavior .......................................................................18

Kofax Technical Support ............................................................................................................................19

iv Kofax, Inc.

Introduction

This document contains the release notes for the Kofax Capture Release Script for FileNet Image Services, which supports FileNet Image Services 3.6 and FileNet Image Services 4.x. This release script copies document images, PDF documents, and eDocuments to permanent storage and writes index data to the FileNet Image Services repository.

Please read these notes carefully as they contain information not included in the Kofax Capture Help or printed documentation.

Additional Documentation

These release notes are a supplement to the following:

 Kofax Capture Developers Guide  Kofax Capture Release Notes  Kofax Capture Getting Started Guide  Kofax Capture Installation Guide  Kofax Capture Help  Kofax Capture Release Script for FileNet Image Services Help

Kofax Capture Release Script for FileNet Image Services Release Notes

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

Tip For additional information about Kofax products, visit our Web site at www.kofax.com and go to the Technical Support pages. The Technical Support Web pages provide product-specific information, such as current revision levels, the latest drivers and software patches, technical tips, and a searchable knowledgebase. In addition, updates to product documentation (if any) are available from these pages.

System Requirements

The Kofax Capture Release Script for FileNet Image Services requires the following components to be installed prior to installing this release script.

FileNet Image Services Server Support

The Kofax Capture Release Script for FileNet Image Services requires the following network server components:

 FileNet Image Services 3.6 supports the following:

 FileNet Image Services 3.6 with Service Pack 2

 FileNet Image Services 4.0 supports the following:

 FileNet Image Services 4.0 with Hot Fix Pack 2

 FileNet Image Services supported database  FileNet Image Services 4.1.1  FileNet Image Services 4.1.2

Kofax, Inc. 1

Kofax Capture Release Script for FileNet Image Services Release Notes

The release script was tested using FileNet Image Services 4.1.1 on Windows 2003 Server with Service Pack 1 and Microsoft SQL Server 2000 Enterprise edition with Service Pack 4.

It was also tested using FileNet Image Services 4.1.2 on Windows 2003 Server with Service Pack 2 and Microsoft SQL Server 2005 Enterprise edition with Service Pack 3.

Client Operating System Support

The Kofax Capture Release Script for FileNet Image Services supports the following client operating systems:

 Windows 2000 Professional with Service Pack 4  Windows 2000 Server with Service Pack 4  Windows Server 2003 with Service Pack 2 (Standard or Enterprise Edition)  Windows XP Professional with Service Pack 2

Note At the time of publishing these release notes, the Kofax Capture Release Script for FileNet Image Services was certified with the Service Packs listed above.

Administration and Release Workstations – Additional Requirements

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

 Ascent Capture 7.0, Ascent Capture 7.5, Kofax Capture 8, Kofax Capture 8 Service Pack 5,

or Kofax Capture 9

 FileNet Image Services 3.6 must have the following components:

 FileNet IDM Desktop 3.2a with Patch 14

 FileNet Image Services 4.0 must have one of the following components:

 FileNet IDM Desktop 3.3  FileNet IDM 4.0

 FileNet Image Services 4.1.1 or 4.1.2 must have the following components:

 FileNet IDM Desktop 4.0.2.002

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

FileNet Image Services was certified with the FileNet IDM Desktop Patch listed above.

Source Code

The source code for the Kofax Capture Release Script for FileNet Image Services is provided and it is located on your Kofax Capture Release Script for FileNet Image Services 3.6-4.0 installation CD in the FileNet\IS3-4 folder. The source code can be opened, edited, and compiled in Visual Basic 6.0 with Service Pack 6.

X To modify the release script

1 Install the FileNet Image Services release script. Refer to Installing the Release Script on

page 10 for the installation instructions. When you install the FileNet Image Services

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

2 Kofax, Inc.

Note In order to successfully modify and compile the release script, development must occur on a

workstation with the appropriate versions of Kofax Capture, CAPTools, and the FileNet Image Services release script previously installed. To use the modified release script, you must replace the FileNet Image Services release script ISRel3-4_v7.dll with the modified version on the client workstation. If you receive an access denied error, you will need to close the Administration module.

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

Features

Kofax Capture Release Script for FileNet Image Services Release Notes

2 Open, make any desired modifications, and compile the FileNet Image Services source

code in Visual Basic. 3 Copy the newly created ISRel3-4_v7.dll to the installation directory. When you are

prompted to replace the existing file, select “Yes.” You will need to repeat this procedure

on each Administration and Release workstation that will be using the FileNet Image

Services release script. You may want to make a copy of the file for backup purposes, and

store the copy in a safe location.

This section contains information about features provided with the Kofax Capture Release Script for FileNet Image Services.

Kofax Capture Values / FileNet Attributes

The Kofax Capture Release Script for FileNet Image Services provides an easy-to-use interface for linking Kofax Capture Values to FileNet document attributes and folder attributes. Examples of Kofax Capture Values include Document index fields, Folder index fields, Batch fields, and Text Constants. The names of “required” FileNet attributes 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 number of 123 will yield {D3C58EE2-5627-443b-BBFA-EE7A5790482A} 123 as the Document GUID.

Release to FileNet Image Services Repository

The Kofax Capture Release Script for FileNet Image Services stores images, eDocuments, PDF documents, and document/index data from Kofax Capture into your FileNet Image Services repository.

Multiple Release Support

The Kofax Capture multiple release feature allows you to assign multiple release scripts to a document class, and this release script can be used in conjunction with that feature.

Kofax, Inc. 3

Kofax Capture Release Script for FileNet Image Services Release Notes

You can also provide a unique name for your release script. This name is used to refer to your script in the Release Scripts window. The field is not required, but may help you keep track of your scripts when using the Kofax Capture multiple release feature.

Refer to your Kofax Capture Help for more information about the multiple release feature (Ascent Capture Help keyword: Multiple release > about).

Storage Folders

The Kofax Capture Release Script for FileNet Image Services allows you to use Kofax Capture Values to specify a FileNet Image Services release folder for your document image storage.

Release Script Information Interchange Supported

The Kofax Capture Release Script for FileNet Image Services supports the Kofax Capture Release Script Information Interchange feature. This feature allows the release script to pass information to other release scripts.

Refer to Sharing Data Among Release Scripts on page 7 for more information.

Online Help Available for Release Setup

The Kofax Capture Release Script for FileNet Image Services Help is installed with your release script. It is available from the Administration module when you are setting up your release script. You can click the Help button from the Kofax Capture Release Script for FileNet Image Services 3.6-4.0 — Release Setup window to display help information about release options.

Image Support

This release script supports releasing the following file formats/compression formats:

 Multipage TIFF with Group 3, Group3/2D, and Group4 Compression  Multipage TIFF — Uncompressed Image Format  Multipage TIFF with JPEG Compression  Single page TIFF with Group 3, Group 3/2D, and Group 4 Compression  Single page TIFF — Uncompressed Image Format  Single page TIFF with JPEG Compression  PCX — PackBytes Compression  JPG — JPEG Compression  Kofax PDF  Adobe PDF from TIFF  Adobe PDF from JPEG  Adobe PDF from PCX

Kofax PDF Support

With the Kofax Capture Release Script for FileNet Image Services, you can release Kofax PDF documents into your FileNet Image Services repository. Kofax PDF is bundled with Kofax

4 Kofax, Inc.

+ 16 hidden pages