Kofax Capture Ascent® 7.1 Release Script for FileNet Content Manager 4.
© 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 FileNet Content Manager Server Support ........
Contents File Name Retention Feature .............................................................................................................12 Behavior of the SupportsOriginalFileName Property ............................................................13 File Name Considerations ..................................................................................................................14 Duplicate File Names ......................................................................................
Contents Recommended Permissions ...............................................................................................................39 FileNet Content Manager Domain .............................................................................................39 FileNet Content Manager Object Store .....................................................................................39 Create Folders .................................................................................................
Contents vi Kofax, Inc.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Introduction This document contains the release notes for the Ascent 7.1 Release Script for FileNet Content Manager 4.0, which supports FileNet Content Manager version 4.0. This release script copies document images, OCR full text files, Kofax PDF documents, eDocuments, and writes data from Ascent Capture into FileNet Content Manager 4.0.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes System Requirements The Ascent 7.1 Release Script for FileNet Content Manager 4.0 requires the following components to be installed prior to installing this release script. FileNet Content Manager Server Support The Ascent 7.1 Release Script for FileNet Content Manager 4.0 requires the following network server components: FileNet Content Manager Content Engine version 4.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Source Code The source code for the Ascent 7.1 Release Script for FileNet Content Manager 4.0 is provided and it is located on the Ascent 7.1 Release Script for FileNet Content Manager 4.0 installation CD. Note that two source code projects are provided on the installation CD. The release script source code project can be opened, edited, and compiled in Microsoft Visual Basic 6.0 with Service Pack 6.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Kofax.P8Rel4_v7.ConnectorInterfaceFactory.dll Kofax.P8Rel4_v7.ConnectorInterfaceFactory.tlb When you are prompted to replace the existing files, select “Yes.” 4 Register the Kofax.P8Rel4_v7.ConnectorInterface.dll and the Kofax.P8Rel4_v7.ConnectorInterfaceFactory.dll by invoking the regasm command in the command line prompt. The command to register these dll’s is: regasm.exe [InstallDir]\
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Features This section contains information about features provided with the Ascent 7.1 Release Script for FileNet Content Manager 4.0. The Ascent 7.1 Release Script for FileNet Content Manager 4.0 provides an easy-to-use setup dialog box available from the Ascent Capture Administration module. The Ascent 7.1 Release Script for FileNet Content Manager 4.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Release Script Information Interchange Supported The Ascent 7.1 Release Script for FileNet Content Manager 4.0 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 16 for more information. File Name Retention Supported The Ascent 7.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Duplicate Documents The Ascent 7.1 Release Script for FileNet Content Manager 4.0 allows you to select the behavior to occur at release time when a released document has the same Document Title property as another document that exists in the same folder location within the FileNet Content Manager object store.
Ascent® 7.1 Release Script for FileNet Content Manager 4.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Additional Information This section contains additional information about the Ascent 7.1 Release Script for FileNet Content Manager 4.0. Binary and Object Properties Not Supported The Ascent 7.1 Release Script for FileNet Content Manager 4.0 does not support document classes or folder classes that contain the Binary or Object properties.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Document and Folder Names The following sections explain the Document Title property and Folder Name property. Document Title Property You can use the Document Title property to specify a name for your released document. This property will always appear first in the Content Manager Properties list as specified on the Document Settings tab. By default, the Document Title property is not a required property.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Multi-value Separator Option The Multi-value separator option as specified on the General Settings tab, allows you to enter only valid printable ASCII characters. This option cannot contain the following characters: Carriage return Escape New line Space Tab The Ascent 7.1 Release Script for FileNet Content Manager 4.0 allows you to enter additional delimiters between the values to indicate blank or NULL values.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Viewing Duplicate Documents in FileNet Content Manager Administrative Tools The “Release duplicate document” option on the Document Settings tab allows you to release a duplicate document to the FileNet Content Manager object store with the same document name. However, in the FileNet Content Manager Administrative Tools component (also known as the FileNet Content Manager Enterprise Manager) documents are displayed as new documents.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Behavior of the SupportsOriginalFileName Property This section describes how pages in a document are released to FileNet Content Manager. For demonstration, let’s say that you are releasing the following 4–page document: Document1 Page 1: Page 2: Page 3: Page 4: EngDoc.xml TIF PubDoc.pdf SQADoc.tif The following table illustrates how the pages are released to FileNet Content Manager. Table 1.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes If the content element is specified to be a multipage image type or Kofax PDF image type, then the content element is combined with other images (if any) to form one content element. The content element is released with the appropriate file extension as specified by the image type. However, the content element uses the Ascent Capture file naming scheme, which is the {Document ID}.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Now, the document contains the following: 1.tif 2.tif 3.tif 1.tif 2.tif 3.tif 4.tif 5.tif At release, the Ascent Capture Release module will check the document for duplicate file names. The Release module will find 1.tif, 2.tif, and 3.tif as duplicate files. The document will be rejected and routed to the Ascent Capture Quality Control module.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 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 of information is accomplished by allowing the release scripts to pass information to other release scripts.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes OCR Full Text Options Table 2 provides a reference for releasing images when using OCR full text files. Note the following: One document is released that contains content elements for each image, eDocument, PDF document, and/or OCR full text file. The OCR full text file is always the last content element released. All images are listed in the order that they are scanned or imported from Ascent Capture.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes 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. 2 Check the Enable OCR full text check box to enable OCR full text processing for the document class. 3 Click Apply to save your settings without closing the dialog box. Click OK to save your settings and close the dialog box.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Installing the Release Script You can install the Ascent 7.1 Release Script for FileNet Content Manager 4.0 on an Ascent Capture client workstation or standalone workstation. Important Note About Installation To install the Ascent 7.1 Release Script for FileNet Content Manager 4.0, you must have Windows administrator privileges.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Application Maintenance This section describes how to repair and remove the Ascent 7.1 Release Script for FileNet Content Manager 4.0. Figure 1. Application Maintenance Dialog Box Repairing the Release Script The Repair option replaces missing, renamed, or deleted files. X To repair the release script 20 1 Insert your Ascent 7.1 Release Script for FileNet Content Manager 4.0 installation CD into your CD drive.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Removing the Release Script The Remove option will delete the release script. X To remove the release script 1 Insert your Ascent 7.1 Release Script for FileNet Content Manager 4.0 installation CD into your CD drive. 2 From your Windows task bar, select Start | Run, browse to the FileNet\CM4 folder on the CD, and run Setup.exe.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Logging On to the Release Script 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, Kofax PDF documents, eDocuments, and index data.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes http(s)://:/wsi/ For example: http://MyServerName:9080/wsi/FNCEWS40DIME/ https://MyServerName.MyDomainName.com:9443/wsi/FNCEWS40DIME/ Note If you plan to connect via https, make sure a trusted certificate is installed. Note The Ascent 7.1 Release Script for FileNet Content Manager 4.0 supports the DIME web service, which is compatible with .NET 1.1.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes 9 Click OK. The Ascent 7.1 Release Script for FileNet Content Manager 4.0 – Release Setup dialog box will display, as shown in Figure 4 on page 24. Figure 4. Ascent 7.1 Release Script for FileNet Content Manager 4.0 – Release Setup Dialog Box 10 Refer to the next section, Setting Up the Release Script, for information about the set up options. 24 Kofax, Inc.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Setting Up the Release Script The following sections describe the setup options available with the Ascent 7.1 Release Script for FileNet Content Manager 4.0. Note For more details about the setup options, refer to the Help available from the Ascent 7.1 Release Script for FileNet Content Manager 4.0 – Release Setup dialog box.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Folder Settings Tab This tab allows you to specify new or existing folders to use for storing documents in the FileNet Content Manager object store. Figure 6. Folder Settings Tab 26 Kofax, Inc.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Document Settings Tab This tab allows you to specify a Content Manager document class for the document to be released. In addition, you can assign Ascent Values to properties of a document class. Figure 7. Document Settings Tab Kofax, Inc.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Image Settings Tab This tab allows you to specify the desired image format for releasing your images, and specify whether to release OCR full text files with your document. Figure 8. Image Settings Tab 28 Kofax, Inc.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes General Settings Tab This tab allows you to specify a temporary storage location to be used at release time and specify whether to skip the first page of each document. 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.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Publishing a Batch Class After you select all 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.1 Release Script for FileNet Content Manager 4.0 Release Notes Releasing Batches With the Ascent 7.1 Release Script for FileNet Content Manager 4.0, the Ascent Capture Release module will process batches based on the settings of the associated batch classes. The Release module is responsible for releasing documents, as well as index data using the properties defined during release setup.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Known Problems This section contains information about known problems with the Ascent 7.1 Release Script for FileNet Content Manager 4.0. Problems with the Administration and Release Modules After you exit the release script’s user interface, you may notice that you are experiencing problems with the Ascent Capture Administration and Release modules.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes 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 that the Cancel button is clicked, the release script may be un-registered. In such a case, once you attempt to log on to the release script, login will fail.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Unexpected Behavior With the Release Working Directory When you specify a UNC path for the Release working directory on the General Settings tab and that path does not exist, the FileNet Content Manager release script will give you the option to create the directory. If you click “Yes” to create the directory, you will then receive a warning message that the path is invalid and the Release working directory will not be created.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Appendix A – Data Type Compatibility The figures in this appendix map Ascent Capture data types to FileNet Content Manager data types, and indicate which combinations are valid. Refer to your Ascent Capture Help for more information about Ascent Capture data types (Ascent Capture Help keyword: Data types). You can display Ascent Capture Help from the Help menu available from any Ascent Capture module.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Ascent Capture Values The following figure lists the Ascent Capture values for FileNet Content Manager data types. Refer to your Ascent Capture Help for more information about Ascent Capture values (Ascent Capture Help keyword: Ascent Capture > values). Figure 11. Ascent Capture Values 36 Kofax, Inc.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Text Constants The following figure lists the supported FileNet Content Manager data types for Ascent Capture text constants. Figure 12. Ascent Capture Text Constants Kofax, Inc.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Appendix B – FileNet Content Manager Permissions The following use case scenarios provide a quick reference for setting up permissions in FileNet Content Manager. It lists the following: A visual representation about access permissions to the FileNet Content Manager domain. Recommended permissions to the FileNet Content Manager object store. Information about the release script behavior and FileNet Content Manager permissions.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Recommended Permissions To use FileNet Content Manager and this release script, we recommend that the logged-in users have the following permissions to the FileNet Content Manager object store. If the user does not have the appropriate permissions assigned, release may fail and the batch/document will be routed to the Ascent Capture Quality Control module.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes You must also have the following security rights to use the document class: View all properties Modify all properties Create instance Read permission Release Script Behavior The FileNet Content Manager permissions may behave differently in this release script than in the FileNet Content Manager Workplace Thin client.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes Appendix C – 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.
Ascent® 7.1 Release Script for FileNet Content Manager 4.0 Release Notes 42 Kofax, Inc.
