Kofax
Capture
Ascent® 7.0 Release Script for XML
Release Notes
10001938-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.
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
Client Operating System Support .......................................................................................................2
Administration and Release Workstations Additional Requirements ..........................................2
Source Code ............................................................................................................................................2
Features ..........................................................................................................................................................4
Ascent Capture Values/Custom XML Elements and Document Fields .......................................4
Ascent Capture Value {Document GUID} .........................................................................................4
Release to XML Files .............................................................................................................................4
General Structure of the XML File ...............................................................................................5
Custom XML Elements ..................................................................................................................5
Batch Status Value ..........................................................................................................................6
Release Script Information Interchange Supported .........................................................................6
SecurityBoost Supported ......................................................................................................................6
Integrated Release Setup ......................................................................................................................6
Release Working Directory ..................................................................................................................7
Multiple Release Supported .................................................................................................................7
Online Help Available for Release Setup ...........................................................................................7
Image Support ........................................................................................................................................8
Adobe Acrobat Capture PDF Options ........................................................................................8
OCR Full Text Support ..................................................................................................................8
eDocument Support .......................................................................................................................8
Additional Information ................................................................................................................................9
Unsupported Ascent Capture Features ..............................................................................................9
File Name Retention .......................................................................................................................9
Kofax PDF Image Format ..............................................................................................................9
Ascent Capture Value {Document GUID} .........................................................................................9
{Index Operator’s Station ID} Ascent Capture Value .....................................................................10
Invalid Characters and Escape Sequences .......................................................................................10
Viewing XML Files That Contain Upper ASCII Characters ..........................................................10
Sharing Data Among Release Scripts ...............................................................................................11
Releasing Image Formats ...................................................................................................................11
Enable eDocument Processing ...........................................................................................................11
OCR Full Text Options .......................................................................................................................12
Adobe Acrobat Capture Options ......................................................................................................12
Operating System Requirements ...............................................................................................12
Kofax, Inc. iii
Contents
Adobe Acrobat Capture and the Ascent Capture Release Workstation Installations ........12
Releasing Adobe PDF Documents .............................................................................................13
Workflow Steps ............................................................................................................................13
Multipage TIFFs ............................................................................................................................13
Releasing From Multiple Ascent Capture Standalone Workstations ...................................14
Re-releasing Documents in Error ...............................................................................................14
Invalid Watched Folders .............................................................................................................14
Installing the Release Script ......................................................................................................................15
Important Notes About Installation .................................................................................................15
Administrative Privileges ...........................................................................................................15
Restarting Your Computer During Installation .......................................................................15
Installation Instructions ......................................................................................................................15
Upgrading the Release Script ....................................................................................................................16
Important Note About Upgrade .......................................................................................................16
Upgrade Instructions ..........................................................................................................................17
Application Maintenance ..........................................................................................................................18
Repairing the Release Script ..............................................................................................................18
Removing the Release Script ..............................................................................................................19
Associating the Release Script to a Document Class .............................................................................20
Setting Up the Release Script ....................................................................................................................21
Document Settings Tab .......................................................................................................................21
Document Storage Tab ........................................................................................................................22
Image Format Tab ................................................................................................................................23
Custom Batch Settings Tab .................................................................................................................24
General Settings Tab ...........................................................................................................................25
Publishing a Batch Class ............................................................................................................................26
Releasing Batches ........................................................................................................................................27
Known Problems ........................................................................................................................................28
Problems When Uninstalling the Release Script .............................................................................28
Possible Memory Leak When Releasing Documents .....................................................................28
Document Storage Directories ...........................................................................................................28
Duplicate Documents With Error Recovery Option ......................................................................29
Batch Status Tag Erroneously Indicates Partial ..............................................................................31
Accessing Online Help With the F1 Key ..........................................................................................31
Kofax Technical Support ...........................................................................................................................32
iv Kofax, Inc.
Introduction
This document contains the release notes for the Ascent 7.0 Release Script for XML. This release
script does the following:
Releases document images, OCR full text files, Adobe PDF documents, and eDocuments to
specified release directories.
Releases file information for the released files, document fields, and batch information to
an XML file.
Releases a Document Type Definition (DTD) file that defines the elements in the XML file.
Once document/batch data and file information for a batch is released to an XML file, the XML
file can be transformed (if necessary) into other XML formats or otherwise imported into your
back end system.
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® 7.0 Release Script for XML Release Notes
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 the Ascent 7.0 Release Script for XML
For more information about XML (Extensible Markup Language), refer to any book on XML.
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.0 Release Script for XML Release Notes
System Requirements
The Ascent 7.0 Release Script for XML requires the following components to be installed prior to
installing this release script.
Client Operating System Support
The Ascent 7.0 Release Script for XML 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 1 (Standard or Enterprise Edition)
Windows XP Professional with Service Pack 2
Note At the time of publishing these release notes, the Ascent 7.0 Release Script for XML 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.0, Ascent Capture 7.5, Kofax Capture 8, or Kofax Capture 9
Source Code
The source code for the Ascent 7.0 Release Script for XML is provided and it is located on the
Ascent 7.0 Release Script for XML installation CD. Note that two source code projects are
provided on the installation CD in the Kofax\XML\Source. Either source code project can be
opened, edited, and compiled.
Warning The XML release script was hand coded and cannot be edited in the Visual Studio Form
Designer. However, the source code project can be edited using the standard Visual Studio
Integrated Development Environment (IDE). For this case, the source code for the Ascent 7.0
Release Script for XML is provided in its present condition. (SPR 00019944)
X To modify the release script
1 Install the XML release script. Refer to Installing the Release Script on page 15 for the
installation instructions. When you install the XML release script, you will install the
required components referenced in the source code.
2 Open the XML release script, make any desired modifications, and compile the XML
source code.
Note that two source code DLL projects are provided with the Ascent 7.0 Release Script
for XML. The VBXMLShell folder on the installation CD contains the source code for the
ACXMLRel_v7.dll. The ACXMLRel_v7.dll file must be compiled in Visual Basic. Copy
this .dll to the installation directory (for example, C:\Program
Files\Ascent\CAP\ACXMLRel_v7).
The ReleaseScript folder on the installation CD contains the source code for the
Kofax.XMLRel_v7.dll and Kofax.XMLRel_v7.tlb. The Kofax.XMLRel_v7.dll and
2 Kofax, Inc.
Ascent® 7.0 Release Script for XML Release Notes
Kofax.XMLRel_v7.tlb files must be compiled in Visual Studio .Net 2003. Copy these files
to the NetAsm folder (for example, C:\Program
Files\Ascent\CAP\Kofax.XMLRel_v7\NetAsm).
If you modify an interface of the .Net module, you will need to run the regasm.exe utility
with the /codebase option. To do so, open a .Net command window, change to the
Cap\Kofax.XMLRel_v7\NetAsm folder, and run the following:
regasm Kofax.XMLRel_v7.dll /codebase
3 You will need to repeat the procedure on each Administration and Release workstation
that will be using the XML release script. You may want to make copies of the files for
backup purposes, and store the copies 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 XML release
script previously installed. To use the modified release script, you must replace the XML release
script ACXMLRel_v7.dll or the Kofax.XMLRel_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 .NET Framework and Visual Basic
documentation for assistance.
Kofax, Inc. 3
Ascent® 7.0 Release Script for XML Release Notes
Features
This section contains information about features provided with the Ascent 7.0 Release Script for
XML.
Ascent Capture Values/Custom XML Elements and Document Fields
The Ascent 7.0 Release Script for XML provides an easy-to-use interface for linking Ascent Values
to Custom XML elements, document fields, and folder fields. Examples of Ascent Values include
Document index fields, Folder index fields, Batch fields, Ascent Capture Values, and Text
Constants.
The maximum length for any Ascent Value is 254 characters. If the value contains invalid
characters, the invalid characters will be automatically replaced at release with escape sequences
that are legal for XML. However, the escape sequences will also be counted as characters. The total
length of the characters entered, including escape sequences, can be no more than the maximum
length.
Refer to Invalid Characters and Escape Sequences on page 10 for more information.
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 of 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.
Release to XML Files
When releasing batches from Ascent Capture, the Ascent 7.0 Release Script for XML releases:
Images, OCR full text files, Adobe PDF documents, and/or eDocuments are released to
directories that you specify.
A standard XML file that contains the following batch information:
Standard Ascent Capture document data (index fields), batch information (batch
fields), and paths to the released files
Custom XML elements that you define, which can contain batch-level information that
is intrinsic to your back end system (optional)
Batch status information that indicates whether all documents in a batch were
successfully released
Document Type Definition (DTD) file that defines the elements and attributes in the XML
file
Once the document/batch data and file information for a batch is released to an XML file, the
XML file can be transformed (if necessary) into other XML formats or otherwise imported into
your back end system with an application that you provide.
4 Kofax, Inc.
Ascent® 7.0 Release Script for XML Release Notes
General Structure of the XML File
The general structure of an XML file released with this release script is shown below. Like any
XML document, the file is made up of XML elements (or tags). Each element, which consists of a
start tag and an end tag, delimits data released from Ascent Capture about a batch. Some of the
elements have values or attributes.
For more details about the XML elements, refer to the Help available with the Ascent 7.0 Release
Script for XML (Help keyword: XML elements).
For the intentions of the example below, sample values/attributes are shown in italics. In an actual
XML file, the released values would be used.
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE kfx:XMLRELEASE SYSTEM "
<kfx:XMLRELEASE xmlns:kfx="http://ww w.kofax.com/dtd/">
<kfx:KOFAXXML>
<kfx:BATCHCLASS ID="
<kfx:DOCUMENTS>
<kfx:DOCUMENT DOCID="
<kfx:DOCUMENTDATA />
<kfx:PRIMARYFILES />
<kfx:SECONDARYFILES />
<kfx:OCRTEXTFILES />
</kfx:DOCUMENT>
</kfx:DOCUMENTS>
</kfx:BATCHCLASS>
<kfx:BATCHSTATUS>
</kfx:KOFAXXML>
user-specified prefix
<
</
demo
:CUSTOMXML>
</kfx:XMLRELEASE>
batch ID
batch status value
:CUSTOMXML xmlns:
filename.dtd
" NAME="
document ID
">
batch name
" DOCUMENTCLASSNAME="
</kfx:BATCHSTATUS>
demo="user-specified URI
">
document class
">
">
For additional examples of XML files, including examples of DTD files, refer to Help available
with the Ascent 7.0 Release Script for XML (Help keyword: Examples).
Custom XML Elements
In addition to the standard XML elements used to store information about document/batch data
and released files, the Ascent 7.0 Release Script for XML allows you to define custom XML
elements. The custom XML elements can be used for batch-level information that is intrinsic to the
back end system.
For more information about setting custom XML elements, refer to the Help available with the
Ascent 7.0 Release Script for XML (Help keyword: Custom XML element).
Kofax, Inc. 5
Ascent® 7.0 Release Script for XML Release Notes
Batch Status Value
In addition to document/batch information, the Ascent 7.0 Release Script for XML writes a batch
status element to the XML file that indicates whether all documents in a batch were successfully
released. This element can be used to determine if an XML file is ready to be transformed or
processed.
The element tag is <kfx:BATCHSTATUS>, which will have one of the values listed below.
Status Description
Complete Indicates that all documents were successfully released. The XML
file is ready for further processing.
Partial Indicates that at least one document in the batch was rejected.
The XML file contains information about the documents that
were successfully released, but it does not contain information
about the documents that were rejected. Rejected documents are
automatically routed to the Ascent Capture Quality Control
module.
Note It is recommended that you do not process XML files with a status of Partial or remove them
from the XML/DTD release directory. You should wait until all documents in the batch are
successfully released, and the <kfx:BATCHSTATUS> element has a status of Complete. For more
information about the batch status element, refer to the Help available with the Ascent 7.0 Release
Script for XML (Help keyword: XML elements).
Release Script Information Interchange Supported
The Ascent 7.0 Release Script for XML supports the Ascent 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 11 for more information.
SecurityBoost Supported
The Ascent 7.0 Release Script for XML 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).
Integrated Release Setup
The Ascent 7.0 Release Script for XML provides an easy-to-use setup dialog box available from the
Ascent Capture Administration module. The Ascent 7.0 Release Script for XML – Release Setup
dialog box allows you to specify release settings at batch class setup time that control how
documents and other batch information are released into an XML file.
Refer to Setting Up the Release Script on page 21 for more information.
6 Kofax, Inc.
Ascent® 7.0 Release Script for XML Release Notes
Release Working Directory
The Ascent 7.0 Release Script for XML requires that you set up a temporary storage location to
copy document images at release time. Your images reside in this location temporarily as they are
transferred from Ascent Capture to an XML file.
If the Release working directory does not exist at release setup, you will be given the option to
create the specified directory or select a different directory. On the other hand, if the directory
does not exist at release time, the directory will be automatically created.
Note The Release working directory cannot be the same as the document storage directories, such
as the directories for releasing XML/DTD file, image files, and/or OCR full text files that you
specify on the Document Storage tab.
Multiple Release Supported
The Ascent 7.0 Release Script for XML supports the Ascent Capture Multiple Release feature. This
feature allows you to assign multiple release scripts to a document class.
In addition, this release script allows you to provide a unique name for your release script at
release setup time. The name is used to refer to your release script in the Ascent Capture Release
Scripts dialog box. This field is not required, but may help you to keep track of your release scripts
when using the Multiple Release feature.
Refer to your Ascent Capture Help for more information about the multiple release feature
(Ascent Capture Help keyword: Multiple release).
In addition, for more information about setting release directories for multiple release, refer to the
Help available with the Ascent 7.0 Release Script for XML (Help keyword: Multiple release).
Online Help Available for Release Setup
The Ascent 7.0 Release Script for XML 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.0 Release Script for XML – Release Setup dialog box to display help
information about release and release setup options.
Refer to Accessing Online Help With the F1 Key on page 31 for information about a known problem.
Kofax, Inc. 7
Loading...