Kofax Ascen 7.5 Release Script User Manual
Kofax
Capture
Ascent® 7.5 Release Script for
Hummingbird DM 6.0
Release Notes
10001948-000
© 1994 - 2010 Kofax, Inc., 15211 Laguna Canyon Road, Irvine, California 92618, U.S.A. All rights
reserved. Use is subject to license terms.
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.
Hummingbird DM, DOCSFusion, and Hummingbird Records Management are registered trademarks
of Hummingbird Ltd.
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.
Contents
Introduction ...................................................................................................................................................1
Additional Documentation ..................................................................................................................1
System Requirements ...................................................................................................................................2
Hummingbird DM Server Support .....................................................................................................2
Hummingbird Records Management Support .................................................................................2
Client Operating System Support .......................................................................................................2
Administration and Release Workstations – Additional Requirements .......................................2
Source Code ............................................................................................................................................3
Features ..........................................................................................................................................................4
Ascent Capture Value {Document GUID} .........................................................................................4
Ascent Values / DM Index Fields .......................................................................................................4
DM Custom Constants ..................................................................................................................4
Excluding DM Index Fields ..........................................................................................................4
Security ....................................................................................................................................................4
Versioning Options ...............................................................................................................................5
DM Libraries and Profiles ....................................................................................................................5
Keywords ................................................................................................................................................5
Duplicate Documents ............................................................................................................................5
Folder Support .......................................................................................................................................5
Release to Records Management System ...........................................................................................6
Integrated Release Setup ......................................................................................................................6
SecurityBoost Supported ......................................................................................................................6
Online Help Available for Release Setup ...........................................................................................6
Image Support ........................................................................................................................................7
Kofax PDF Support ........................................................................................................................7
Adobe PDF Support .......................................................................................................................7
OCR Full Text Support ..................................................................................................................7
eDocument Support .......................................................................................................................7
Additional Information ................................................................................................................................8
Unsupported Ascent Capture Features ..............................................................................................8
File Name Retention .......................................................................................................................8
Access to Documents and Folders ......................................................................................................8
{Index Operator’s Station ID} Ascent Capture Values .....................................................................9
Context Menu Removed From the Folder Hierarchy ......................................................................9
Hummingbird DM Projects .................................................................................................................9
Hummingbird DM User Permissions .................................................................................................9
Application and Document Type Fields ..........................................................................................10
Kofax, Inc. iii
Contents
Releasing to Records Management ...................................................................................................10
Search Criteria for Duplicate Folders ...............................................................................................10
DM Check Box Attributes Requires Numeric Values ....................................................................11
Releasing to Localized Versions of Hummingbird DM .................................................................11
Excluding DM Profile Attributes ......................................................................................................11
Sharing Data Among Release Scripts ...............................................................................................13
OCR Full Text Options .......................................................................................................................14
Kofax PDF Options ..............................................................................................................................15
Adobe Acrobat Capture Options ......................................................................................................16
Operating System Requirements for Ascent Capture .............................................................16
Adobe Acrobat Capture and the Ascent Capture Release Workstation Installations ........16
Releasing Adobe PDF Documents .............................................................................................16
Workflow Steps ............................................................................................................................16
Multipage TIFFs ............................................................................................................................17
Releasing from Multiple Ascent Capture Standalone Workstations ....................................17
Re-releasing Documents in Error ...............................................................................................17
Invalid Watched Folders .............................................................................................................17
Installing the Release Script ......................................................................................................................18
Important Note About Installation ...................................................................................................18
Installation Instructions ......................................................................................................................18
Replacing a Previous Version of the Release Script ...............................................................................19
Application Maintenance ..........................................................................................................................20
Repairing the Release Script ..............................................................................................................20
Removing the Release Script ..............................................................................................................21
Logging on to the Release Script ..............................................................................................................22
Setting Up the Release Script ....................................................................................................................25
Document Settings Tab .......................................................................................................................25
Folder Settings Tab ..............................................................................................................................26
Security Settings Tab ...........................................................................................................................27
Image Format Tab ................................................................................................................................28
General Settings Tab ...........................................................................................................................29
Publishing a Batch Class ............................................................................................................................30
Releasing Batches ........................................................................................................................................31
Known Problems ........................................................................................................................................32
FOLDER_PROF Folder Profile ..........................................................................................................32
Public Folder and File Plan Locations are Not Supported ............................................................32
ITEM_TYPE Custom Constant is Not Supported ...........................................................................32
DM Profile Attributes .........................................................................................................................32
Problems When Installing on Windows XP ....................................................................................32
Problems When Uninstalling the Release Script .............................................................................33
Uninstalling the DMRel Folder .........................................................................................................33
Blank Passwords are Not Supported ................................................................................................33
Deleting the Last Remaining Folder from the Hummingbird DM Server ..................................33
Duplicate “Billable” Attributes in the LAWPROF Profile .............................................................33
iv Kofax, Inc.
Contents
eDocument Name Not Preserved at Release ...................................................................................34
Images, PDF Documents, and eDocuments Display in Versions Tab .........................................34
“Error 75 – Path/File Access” Error .................................................................................................34
Select a Version to Publish Dialog Box Displays During Release ................................................35
Adobe Acrobat Capture Error ...........................................................................................................35
Releasing Versions of Documents With OCR Attachments ..........................................................35
Possible Memory Leak When Releasing Documents .....................................................................36
OCR Full Text Files Saved With TIF Extension ...............................................................................36
Customizing a Hummingbird Profile Form ....................................................................................36
Releasing Kofax PDF With TIFF Files ...............................................................................................36
Multiple Release Problems .................................................................................................................37
Using Duplicate User Names .....................................................................................................37
Releasing Documents With Multiple Release ..........................................................................37
Appendix A – Data Type Conversion .....................................................................................................38
Ascent Value Data Types ...................................................................................................................38
Text Constants ......................................................................................................................................38
Appendix B – Kofax Technical Support ..................................................................................................39
Kofax, Inc. v
Contents
vi Kofax, Inc.
Introduction
This document contains the release notes for Ascent 7.5 Release Script for Hummingbird DM,
which supports Hummingbird DM 6.0. This release script releases images, OCR full text files, PDF
documents, eDocuments, and index values from Ascent Capture into your DM repository.
Please read these notes carefully as they contain information not included in the Ascent Capture
Help or printed documentation.
Additional Documentation
These release notes are a supplement to the following:
Ascent Capture Advanced Features Guide
Ascent Capture Release Notes
Getting Started with Ascent Capture guide
Installation Guide for Ascent Capture and Ascent Capture Internet Server
Learning Ascent Capture guide
Help provided from any of the Ascent Capture modules
Help provided with Ascent 7.5 Release Script for Hummingbird DM
Ascent® 7.5 Release Script for Hummingbird DM 6.0 Release Notes
For more information about Hummingbird DM or other Hummingbird products, contact your
Hummingbird representative or refer to the documentation that came with your Hummingbird
DM 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.
Kofax, Inc. 1
Ascent® 7.5 Release Script for Hummingbird DM 6.0 Release Notes
System Requirements
Ascent 7.5 Release Script for Hummingbird DM requires the following components to be installed
prior to installing this release script.
Hummingbird DM Server Support
Ascent 7.5 Release Script for Hummingbird DM requires the following network server
components:
Hummingbird DM Server 6.0
Hummingbird DM Web Server 6.0
Hummingbird DM API 6.0
Hummingbird DM Extension API 6.0
Note This release script was tested against a Hummingbird DM Server 6.0.3 on a Windows 2003
Server (with Service Pack 1) and Microsoft SQL Server 2000 (with Service Pack 4).
Hummingbird Records Management Support
Ascent 7.5 Release Script for Hummingbird DM supports the following Hummingbird Records
Management systems:
Hummingbird Records Management Server 6.0
Client Operating System Support
Ascent 7.5 Release Script for Hummingbird DM supports the following client platforms:
Windows 2000 Professional with Service Pack 4
Windows 2000 Server with Service Pack 4
Windows Server 2003 with Service Pack 1 (Standard or Enterprise Edition)
Windows XP Professional with Service Pack 2
Note At the time of publishing these release notes, Ascent 7.5 Release Script for Hummingbird
DM was certified with the Service Packs listed above.
Administration and Release Workstations – Additional Requirements
The Ascent Capture Administration and Release workstations must have the following
components installed:
Ascent Capture 7.5 with Service Pack 1 or higher, Kofax Capture 8, or Kofax Capture 9
Hummingbird Windows Explorer DM Extension 6.0
2 Kofax, Inc.
Ascent® 7.5 Release Script for Hummingbird DM 6.0 Release Notes
Source Code
The source code for Ascent 7.5 Release Script for Hummingbird DM is provided and it is located
on the Ascent 7.5 Release Script for Hummingbird DM 6.0 installation CD in the
Hummingbird\DM6 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 Hummingbird DM release script. Refer to Installing the Release Script on page 18
for the installation instructions. When you install the Hummingbird DM release script,
you will install the required components referenced in the source code.
2 Open, make any desired modifications, and compile the Hummingbird DM source code
in Visual Basic.
3 Copy the newly created DMRel6_v7.dll to the installation directory (for example,
C:\Program Files\Ascent\CAP\DMRel6_v7\DMRel6_v7.dll). 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 Hummingbird DM release
script. You may want to make a copy of the file for backup purposes, and store the copy in
a safe location.
Note In order to successfully modify and compile the release script, development must occur on a
workstation with the appropriate versions of Ascent Capture, CAPTools, and the Hummingbird
DM release script previously installed. To use the modified release script, you must replace the
Hummingbird release script DMRel6_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 Hummingbird DM product and Visual Basic
documentation for assistance.
Kofax, Inc. 3
Ascent® 7.5 Release Script for Hummingbird DM 6.0 Release Notes
Features
This section contains information about features provided with Ascent 7.5 Release Script for
Hummingbird DM.
Ascent Capture Value {Document GUID}
The Ascent Capture Value {Document GUID} is a new value that can be used for index fields and
release values. This Ascent Capture value is a type of document ID that is unique across the
central site and all remote sites that comprise an Ascent Capture installation. The 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
{D3C58EE2-5627-443b-BBFA-EE7A5790482A} 123 as the Document GUID.
Ascent Values / DM Index Fields
Ascent 7.5 Release Script for Hummingbird DM provides an easy-to-use interface for linking
Ascent Capture Ascent Values to DM index fields. Examples of Ascent Values include Document
index fields, Folder index fields, Batch fields, Ascent Capture Values, and Text Constants. The
names of “required” DM index fields are marked with an asterisk (*), giving you a visual indicator
that certain fields must be linked.
DM Custom Constants
Allowed values for DM index fields defined in a DM profile are available for selection from the
Ascent 7.5 Release Script for Hummingbird DM 6.0 — Release Setup dialog box. This allows you
to easily link DM custom constants to DM index fields.
Excluding DM Index Fields
If desired, you can exclude certain DM index fields from the list of fields to be linked during
release setup. You do this by creating the ACFusion.INI file in the Ascent root directory (for
example, C:\Program Files\Ascent).
Refer to Excluding DM Profile Attributes on page 11 for more information about excluding DM
index fields.
Security
Options available with the Hummingbird DM release script allow document access rights and
folder access rights to be defined for selected DM groups and users during release setup. One
example is that users can be granted access rights that allow the profile of a released document
and/or user-defined folder to be edited.
Refer to Access to Documents and Folders on page 8 for more information about security options.
4 Kofax, Inc.
Ascent® 7.5 Release Script for Hummingbird DM 6.0 Release Notes
Versioning Options
Ascent 7.5 Release Script for Hummingbird DM supports two methods for versioning documents:
Version using Document Number Instead of the Document Name: This is a feature that
allows you to version your documents using the Hummingbird DM document number.
The document number is created by Hummingbird DM. This feature is available on the
General Settings tab.
Version Document: This method allows you to version your documents using the
document name.
Note that if you select the “Version using the document number instead of the Document name”
option, the following options will be unavailable on the Document Settings tab:
Version document
Create exception document
Create new document
DM Libraries and Profiles
When setting up Ascent 7.5 Release Script for Hummingbird DM, you can easily select the DM
library and profile to use for releasing images. The Ascent 7.5 Release Script for Hummingbird
DM 6.0 – Release Setup dialog box honors access privileges defined for your Hummingbird DM
users, and makes accessible only those libraries and profiles allowed for the logged in user. The
Hummingbird DM release script supports all libraries, including default, remote, and
independent libraries.
Keywords
For profiles that contain keyword fields, the Hummingbird DM release script allows you to add
one or more keywords to a document. You can also control how new keywords are handled. For
example, you can create new keywords in the DM repository, or skip keywords not found in the
indexed document.
Duplicate Documents
Ascent 7.5 Release Script for Hummingbird DM offers three options for handling duplicate
documents. For example, you can specify that duplicate documents be:
Created as new major versions to existing documents
Created as exception documents, and given unique exception document names
Created as new documents with the same name as the existing documents
Folder Support
Ascent 7.5 Release Script for Hummingbird DM displays folders from a selected library in a
hierarchical tree view that provides an easy-to-use format for choosing the DM folder to select or
create at release time. From the Ascent 7.5 Release Script for Hummingbird DM 6.0 – Release
Setup dialog box, you can add, rename, and delete user-defined DM folders that have not yet been
created in the DM repository. Simply select an Ascent Value or specify a text constant to find or
create the DM folder.
Kofax, Inc. 5
Ascent® 7.5 Release Script for Hummingbird DM 6.0 Release Notes
Release to Records Management System
Ascent 7.5 Release Script for Hummingbird DM copies document images, OCR full text files, PDF
documents, eDocuments, and index values from Ascent Capture into your DM repository.
Optionally, you can release documents into your Hummingbird Records Management system.
For more information about releasing to Records Management, refer to the Help that is available
with the Ascent 7.5 Release Script for Hummingbird DM (Help keyword: Records Management).
Integrated Release Setup
Ascent 7.5 Release Script for Hummingbird DM provides an easy-to-use setup dialog box
available from the Ascent Capture Administration module. This dialog box allows you to specify
release settings at batch class setup time that control how documents are released into your DM
repository.
SecurityBoost Supported
Ascent 7.5 Release Script for Hummingbird DM supports the Ascent Capture SecurityBoost
feature. The SecurityBoost feature allows you to enhance Ascent Capture security for systems
using Windows XP and Windows 2000.
Refer to your Ascent Capture Help for more information about the SecurityBoost feature. (Ascent
Capture Help keyword: SecurityBoost > about)
Online Help Available for Release Setup
Ascent 7.5 Release Script for Hummingbird DM 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 Ascent 7.5 Release Script for Hummingbird DM 6.0 — Release
Setup dialog box to display help information about release options.
6 Kofax, Inc.
Ascent® 7.5 Release Script for Hummingbird DM 6.0 Release Notes
Image Support
This release script supports the following file formats/compression formats:
Multipage TIFF with Group 3, Group 3/2D, and Group 4 Compression
Multipage TIFF with JPEG Compression
Multipage TIFF — Uncompressed
JPG with JPEG Compression
Kofax PDF
Adobe PDF from JPEG
Adobe PDF from TIFF
Kofax PDF Support
With Ascent 7.5 Release Script for Hummingbird DM, you can release Kofax PDF documents into
your Hummingbird DM repository. Kofax PDF is bundled with Ascent Capture and does not
require additional software implementation. Kofax PDF documents can be saved in the following
output types:
PDF Image Only
PDF Image + Text
Refer to Kofax PDF Options on page 15 for more information about Kofax PDF documents.
Adobe PDF Support
Ascent 7.5 Release Script for Hummingbird DM supports releasing Adobe PDF documents into
your Hummingbird DM repository. The software is provided by Adobe Acrobat Capture and is
not included with the Ascent Capture product. To release Adobe PDF documents, you must
install the Adobe® Acrobat Capture® 3.0 Clustered or Personal Edition software.
Refer to Adobe Acrobat Capture Options on page 16 for more information about Adobe PDF
documents.
OCR Full Text Support
With Ascent 7.5 Release Script for Hummingbird DM, you can release documents processed
through the Ascent Capture OCR Full Text module into your DM repository.
Refer to OCR Full Text Options on page 14 for more information about OCR full text files.
eDocument Support
With Ascent 7.5 Release Script for Hummingbird DM, you do not need to limit your batches to
image files. eDocuments are supported for release into your DM repository.
Kofax, Inc. 7
Ascent® 7.5 Release Script for Hummingbird DM 6.0 Release Notes
Additional Information
This section contains additional information about Ascent 7.5 Release Script for Hummingbird
DM.
Unsupported Ascent Capture Features
Ascent 7.5 Release Script for Hummingbird DM does not support the following Ascent Capture
feature.
File Name Retention
This release script does not support file name retention. Therefore, the original imported file name
will not be retained and the default numeric name will be used.
If you have enabled “Use the original file name of image and eDocument files” check box in the
Ascent Capture Release Properties dialog box and you release a batch in Hummingbird DM, the
release will fail with the following error message. (SPR 30293)
The specified file does not exist.
In addition, if you set the “SupportsOriginalFileName” property to “True”
(SupportsOriginalFileName=True) in Hummingbird DM and you release a batch, the release will
fail with the same error message.
Refer to your Ascent Capture Help for more information about retention of file names. (Ascent
Capture Help keyword: Release Properties dialog box)
Tip The Ascent Capture Value “{First Page Original File Name}” allows you to retain the original
file name for the first page of a document. This value can be linked to DM attributes that support
Ascent Values. Notice that the DM attribute type must be able to accept all the characters that are
part of the original file name and must not exceed the defined length or release may fail.
Access to Documents and Folders
If you create documents and folders with no security settings at release setup, the documents and
folders will only be available for you to edit. This means that your released documents and userdefined folders are protected and can only be accessed by you. If you want certain DM groups and
users to have access to your documents and folders, you must use the Security Settings tab to
assign access privileges to your documents and folders.
For more information about the Security Settings tab, refer to the Help available with Ascent 7.5
Release Script for Hummingbird DM (Help keyword: Security Settings tab).
Warning If you create documents with no security settings and place it in a folder with security
settings, the documents will automatically inherit the permissions that you set for the folder.
8 Kofax, Inc.
Loading...