Kofax Capture Ascent® 7.
© 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.
Contents Introduction ...................................................................................................................................................1 Additional Documentation ..................................................................................................................1 System Requirements ...................................................................................................................................2 Client Operating System Support ...............
Contents Adobe Acrobat Capture and the Ascent Capture Release Workstation Installations ........12 Releasing Adobe PDF Documents .............................................................................................13 Workflow Steps ............................................................................................................................13 Multipage TIFFs ............................................................................................................................
Ascent® 7.0 Release Script for XML Release Notes 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.
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.
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.
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.
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.
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 , which will have one of the values listed below.
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.
Ascent® 7.
Ascent® 7.0 Release Script for XML Release Notes Additional Information This section contains additional information about the Ascent 7.0 Release Script for XML. Unsupported Ascent Capture Features Ascent 7.0 Release Script for XML does not support the following Ascent Capture feature. File Name Retention The Ascent 7.0 Release Script for XML does not support file name retention.
Ascent® 7.0 Release Script for XML Release Notes {Index Operator’s Station ID} Ascent Capture Value The Ascent Capture Value {Index Operator’s Station ID} has been deprecated and replaced by {Validation Operator’s Station ID}. It is strongly recommended that you use {Validation Operation’s Station ID} instead. Invalid Characters and Escape Sequences Table 1 lists characters that are not valid for various names and values, due to XML constraints.
Ascent® 7.0 Release Script for XML Release Notes Sharing Data Among Release Scripts The Ascent Capture Release Script Information Interchange feature is useful when more than one release script has been configured for a particular batch class and document class combination. The sharing information is accomplished by allowing the release scripts to pass information to other release scripts.
Ascent® 7.0 Release Script for XML Release Notes OCR Full Text Options To release OCR full text files, you must enable Ascent Capture OCR full text processing in your applicable document class and add the OCR Full Text module to your applicable batch class. X To enable OCR full text processing for a document class 1 From the Create Document Class dialog box or Document Class Properties dialog box, select the OCR tab.
Ascent® 7.0 Release Script for XML Release Notes Releasing Adobe PDF Documents To release in Adobe PDF format, you must install the appropriate Adobe Acrobat Capture software. In addition, the Release working directory must be available to the Ascent Capture workstation where you are setting up the release script and the Adobe Acrobat Capture workstation. One way to do this is to specify a UNC path for the Release directory.
Ascent® 7.0 Release Script for XML Release Notes Releasing From Multiple Ascent Capture Standalone Workstations If you use multiple Ascent Capture standalone workstations and one Adobe Acrobat Capture hub, you must create unique Adobe Acrobat Capture “workflows” and “watched folders” for each Ascent Capture standalone workstation. This is because Adobe Acrobat Capture uses Ascent Capture document IDs for its document naming scheme.
Ascent® 7.0 Release Script for XML Release Notes Installing the Release Script You can install the Ascent 7.0 Release Script for XML on an Ascent Capture client workstation or standalone workstation. Important Notes About Installation Read the following important installation notes before you install your release script. Before you install the Ascent 7.0 Release Script for XML, refer to System Requirements on page 2 for information about installation requirements.
Ascent® 7.0 Release Script for XML Release Notes Figure 2. Restart Windows Prompt (Click Yes) 6 The installation program will install the .NET Framework. When the .NET Framework is installed, the message similar to the following will display: Figure 3. Installation of .NET Framework Complete a Click OK to close the message box. b If the following prompt displays after the .NET Framework is installed, click No. Warning If you are prompted to restart your computer immediately after the .
Ascent® 7.0 Release Script for XML Release Notes Upgrade Instructions Use the following instructions to upgrade to the Ascent 7.0 Release Script for XML. X To upgrade the release script 1 Release any existing batches associated with the release scripts. Refer to Releasing Batches on page 27 for more information. 2 From the Definitions panel in the Administration module, select the Batch class tab, and right-click the applicable document class associated with the release script.
Ascent® 7.0 Release Script for XML Release Notes Application Maintenance This section describes how to repair and remove the Ascent 7.0 Release Script for XML. Figure 5. Application Maintenance Dialog Box Repairing the Release Script The Repair option replaces missing, renamed, or deleted files. X To repair the release script 18 1 Insert your Ascent 7.0 Release Script for XML installation CD into your CD drive.
Ascent® 7.0 Release Script for XML Release Notes Removing the Release Script The Remove option will remove the release script. X To remove the release script 1 Insert your Ascent 7.0 Release Script for XML installation CD into your CD drive. 2 From your Windows task bar, select Start | Run, browse to the Kofax\XML folder on the CD, and run Setup.exe. 3 Setup will detect an existing installation and the Application Maintenance dialog box will display, as shown in Figure 5 on page 18.
Ascent® 7.0 Release Script for XML Release Notes Associating the Release Script to a Document Class Once you have associated a document class with a batch class in Ascent Capture, you may specify the release script to use when releasing your images, OCR full text files, Adobe PDF documents, eDocuments, and index data. X To associate the release script to a document class 1 Start the Ascent Capture Administration module. The module’s main screen will display.
Ascent® 7.0 Release Script for XML Release Notes Setting Up the Release Script The following sections describe the setup options available with the Ascent 7.0 Release Script for XML. Note For more details about the setup options, refer to the Help available from the Ascent 7.0 Release Script for XML – Release Setup dialog box. Document Settings Tab This tab allows you to specify document fields and link Ascent Values to them. The fields are released to the XML file per document. Figure 7.
Ascent® 7.0 Release Script for XML Release Notes Document Storage Tab This tab allows you to specify release directories for the XML/DTD files, image files, and OCR full text files. Figure 8. Document Storage Tab 22 Kofax, Inc.
Ascent® 7.0 Release Script for XML Release Notes Image Format Tab This tab allows you to specify the desired image formats for releasing your images. You can specify a primary format and a secondary format. If Adobe PDF is selected as an image format, the PDF Settings on this tab will become available for selection. Note Files are released with the appropriate file extensions, as specified by the selected image type.
Ascent® 7.0 Release Script for XML Release Notes Custom Batch Settings Tab This tab allows you to create, edit, and/or remove batch-level custom XML elements and attributes. At release, the custom elements are released to the area in the XML file. Figure 10. Custom Batch Settings Tab 24 Kofax, Inc.
Ascent® 7.0 Release Script for XML Release Notes General Settings Tab This tab allows you to specify a temporary storage location to be used for the release process. In addition, you can specify whether to skip the first page of each document at release. You may want to skip the first page if you are using standalone separator sheets to separate your documents, and you do not want to release the separator sheets with your documents. Figure 11. General Settings Tab Kofax, Inc.
Ascent® 7.0 Release Script for XML Release Notes Publishing a Batch Class After you select all of your batch class settings, you must publish your batch class before you can use it. The publishing process checks the integrity of the settings in your batch class, and makes the batch class available for use. If problems are found with any of the settings, error and warning messages will display along with the recommended actions for fixing the problems.
Ascent® 7.0 Release Script for XML Release Notes Releasing Batches With the Ascent 7.0 Release Script for XML, the Ascent Capture Release module is responsible for releasing batches and release batch information to an XML file, as defined by release setup settings. A Document Type Definition (DTD) file is also released that defines the elements in the XML file. Once the batch is successfully released, the XML file can be processed as desired.
Ascent® 7.0 Release Script for XML Release Notes Known Problems This section contains information about known problems with the Ascent 7.0 Release Script for XML. Problems When Uninstalling the Release Script If you click the Cancel button while you are uninstalling the release script, all the release script original files will remain properly installed on the system. However, depending on the point during the uninstallation the Cancel button is clicked, the release script may be un-registered.
Ascent® 7.0 Release Script for XML Release Notes Warning Files in the Release working directory and all of its subdirectories are temporary, and are deleted after the batch is successfully released from Ascent Capture. If you specify document storage directories that are the same as the subdirectories of the Release working directory, your files will be deleted. Workaround: When specifying the document storage and release working directories during release setup, use the same format for the paths.
Ascent® 7.0 Release Script for XML Release Notes information about the third, fourth, or fifth document is written to the XML file, and the XML file has a status of Partial. Then, the batch is fixed in the Ascent Capture Quality Control module and reprocessed. At release, the entire batch is successfully released, information about all five documents is appended to the existing XML file, and the XML file has a status of Complete.
Ascent® 7.0 Release Script for XML Release Notes Batch Status Tag Erroneously Indicates Partial The Batch Status tag will retain the value Partial if the batch is sent through Release on its final pass without documents to process. For example, consider the case where one or more documents are successfully released, but at least one document is rejected at release.
Ascent® 7.0 Release Script for XML Release Notes Kofax Technical Support For additional technical information about Kofax products, visit the Kofax Web site at www.kofax.com and select an appropriate option from the Support menu. The Kofax Support pages provide product-specific information, such as current revision levels, the latest drivers and software patches, online documentation and user manuals, updates to product release notes (if any), technical tips, and an extensive searchable knowledgebase.
