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 Content Manager is a registered trademark 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.
System Requirements ...................................................................................................................................2
FileNet Content Manager Server Support .........................................................................................2
Client Operating System Support .......................................................................................................2
Administration and Release Workstations – Additional Requirements .......................................2
Features ..........................................................................................................................................................5
Online Help Available for Release Setup ...........................................................................................7
Image Support ........................................................................................................................................8
Kofax PDF Support ........................................................................................................................8
OCR Full Text Support ..................................................................................................................8
eDocument Support .......................................................................................................................8
Additional Information ................................................................................................................................9
Binary and Object Properties Not Supported ....................................................................................9
Viewing FileNet Content Manager Data in Release Setup ..............................................................9
Skip First Page ........................................................................................................................................9
{Index Operator’s Station ID} Ascent Capture Value .......................................................................9
Document and Folder Names ............................................................................................................10
Document Title Property .............................................................................................................10
Folder Name Property .................................................................................................................10
General Settings Tab ...........................................................................................................................29
Publishing a Batch Class ............................................................................................................................30
Known Problems ........................................................................................................................................32
Problems with the Administration and Release Modules .............................................................32
Problems When Installing on Windows XP ....................................................................................32
Problems When Uninstalling the Release Script .............................................................................33
Document Title Property ....................................................................................................................33
Document and Folder Classes That Do Not Allow Instances .......................................................33
Revoking User Permissions to the Object Store ..............................................................................33
Removing Or Renaming Folders in the FileNet Content Manager Object Store .......................33
Unexpected Behavior With the Release Working Directory .........................................................34
Documents Released with Unrecognized MIME Type ..................................................................34
Empty Folders May Be Created .........................................................................................................34
Text Constants ......................................................................................................................................37
Appendix B – FileNet Content Manager Permissions ...........................................................................38
Adding Access Permissions to the FileNet Content Manager Domain .......................................38
Appendix C – Kofax Technical Support .................................................................................................41
Kofax, Inc.v
Contents
viKofax, Inc.
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.
Please read these release 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 the Ascent 7.1 Release Script for FileNet Content Manager 4.0
For more information about FileNet Content Manager or other FileNet products, contact your
FileNet Content Manager representative or refer to the documentation that came with your
FileNet Content Manager 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.
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:
Note This release script was tested using FileNet Content Manager version 4.0 on a
Windows 2003 Server (with Service Pack 1), and Microsoft SQL Server 2000 (with Service Pack 4).
The clients used were running Windows XP SP2 and Windows 2000 SP4. The DNS Server running
the Active Directory server is running on a Windows 2000 Server SP4.
Client Operating System Support
The Ascent 7.1 Release Script for FileNet Content Manager 4.0 supports the following client
operating systems:
Windows 2000 Professional with Service Pack 4
Windows 2000 Advanced Server with Service Pack 4
Windows Server 2003 (Standard or Enterprise Edition)
Windows XP Professional with Service Pack 2
Note At the time of publishing these release notes, the Ascent 7.1 Release Script for FileNet
Content Manager 4.0 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
Web Services Enhancements (WSE) 2.0 SP3 for Microsoft .NET
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. The
connector, connector interface, and connector interface factory projects can be opened in Microsoft
Visual Studio 2003 SP1.
X To modify the release script
1Install the FileNet Content Manager release script. Refer to Installing the Release Script on
page 19 for the installation instructions. When you install the FileNet Content Manager
release script, you will install the required components referenced in the source code.
2Open the FileNet Content Manager release script project. Make sure the project references
point to the type library files installed with the release script
(Kofax.P8Rel4_v7.ConnectorInterface.tlb and
Kofax.P8Rel4_v7.ConnectorInterfaceFactory.tlb). Make any desired modifications, and
compile the FileNet Content Manager source code in Visual Basic.
Note If Microsoft Visual Basic displays a “Permission denied” error, you must close the
Ascent Capture Administration and Release modules before attempting to compile the
release script source code.
3Copy the P8Rel4_v7.dll to the installation directory (for example, C:\Program
Files\Ascent\CAP\P8Rel4_v7). When you are prompted to replace the existing file, select
“Yes.”
4Register the P8Rel4_v7.dll using the following command line:
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.0 — Release Setup dialog box allows you to specify release
settings at batch class setup time that control how documents, folders, and other information are
released into the FileNet Content Manager object store.
The Ascent 7.1 Release Script for FileNet Content Manager 4.0 provides an easy-to-use interface
for linking Ascent Capture Ascent Values to FileNet Content Manager document properties and
folder properties. Examples of Ascent Values include Document index fields, Folder index fields,
Batch fields, Ascent Capture Values, and Text Constants. The names of “required” FileNet
Content Manager properties within a document class or folder class are marked with an
asterisk (*), giving you a visual indicator that certain fields must be linked.
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. The 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. 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 of 123 will yield
{D3C58EE2-5627-443b-BBFA-EE7A5790482A} 123 as the Document GUID.
Document Storage
With the Ascent 7.1 Release Script for FileNet Content Manager 4.0, you can specify new or
existing folders for storing documents in the FileNet Content Manager object store for release. You
can use Ascent Capture Ascent Values to specify a document name or folder name.
Folder Creation
When releasing to user-defined folders, the release script searches the FileNet Content Manager
object store to locate a folder based on the Folder Name property and the location of the FileNet
Content Manager object store.
If the folder is found, this folder will be used for release. The existing properties of the folder will
not change, even if Ascent Values are linked to the properties for the folder.
If the folder is not found, a new folder is created in FileNet Content Manager using the values
specified at release setup.
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.1 Release Script for FileNet Content Manager 4.0 supports the Ascent Capture File
Name Retention feature. This feature allows you to retain the original imported file name.
Refer to File Name Retention Feature on page 12 for more information.
SecurityBoost Supported
The Ascent 7.1 Release Script for FileNet Content Manager 4.0 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)
FileNet Content Manager Object Store
When setting up the Ascent 7.1 Release Script for FileNet Content Manager 4.0, you can easily
select the FileNet Content Manager object store to use for your released documents.
Choice List Properties Supported
FileNet Content Manager Choice List properties are supported. To enable releasing to the FileNet
Content Manager object store, you must know the choice list values and link appropriate Ascent
Values to the Choice List properties. Note that Choice List properties are not visually different
from non-choice list properties.
For more information about the FileNet Content Manager Choice List properties, refer to the
documentation that came with your FileNet Content Manager product.
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.
You can specify that the duplicate document be released to the object store or rejected to the
Ascent Capture Quality Control module.
Release Working Directory
The Ascent 7.1 Release Script for FileNet Content Manager 4.0 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 the FileNet Content Manager
object store.
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 automatically be created.
Multiple Values
The Ascent 7.1 Release Script for FileNet Content Manager 4.0 supports properties that contain
multiple values. You can specify the desired delimiter to separate the values when entering
multiple values for your document and folder class properties using the Multi-value separator
option as specified on the General Settings tab. For example, if you specified a single semi-colon (;)
delimiter for the multi-value separator, you would enter the following:
apple;orange;pear
Refer to Multi-value Separator Option on page 11 for more information.
Multiple Release Supported
The Ascent 7.1 Release Script for FileNet Content Manager 4.0 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 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)
Online Help Available for Release Setup
The Ascent 7.1 Release Script for FileNet Content Manager 4.0 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.1 Release Script for FileNet Content Manager 4.0
— Release Setup dialog box to display help information about release options.
This release script supports the following file formats / compression formats:
Multipage TIFF — Group 3, Group 3/2D, and Group 4 Compression
Multipage TIFF — Uncompressed Image Format
Multipage TIFF — JPEG Compression
Single page TIFF — Group 3, Group 3/2D, and Group 4 Compression
Single page TIFF — Uncompressed Image Format
Single page TIFF — JPEG Compression
JPG — JPEG Compression
PCX — PackBytes Compression
Kofax PDF
Kofax PDF Support
With the Ascent 7.1 Release Script for FileNet Content Manager 4.0, you can release Kofax PDF
documents into the FileNet Content Manager object store. 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 18 for more information about Kofax PDF documents.
OCR Full Text Support
With the Ascent 7.1 Release Script for FileNet Content Manager 4.0, you can release documents
processed through the Ascent Capture OCR Full Text module into the FileNet Content Manager
object store.
Refer to OCR Full Text Options on page 17 for more information about OCR full text files.
eDocument Support
With the Ascent 7.1 Release Script for FileNet Content Manager 4.0, you do not need to limit your
batches to image files. eDocuments are supported for release into FileNet Content Manager.
Refer to Enable eDocument Processing on page 16 for more information about eDocument files.
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. Note the following:
If Binary and/or Object properties are not required and are part of the selected document
or folder class, the properties will be hidden.
If Binary and/or Object properties are required and are part of the selected document or
folder class, you will receive an error message at release setup when you attempt to select
the document or folder class. In addition, you will not be able to select the document or
folder class.
Viewing FileNet Content Manager Data in Release Setup
All FileNet Content Manager information is refreshed in release setup when you log in to the
release script. This includes the available object stores, document classes, document properties,
folder classes, folder properties, and existing folders. Also, whenever you select an object store in
release setup, available document classes, folder classes, and existing folders are refreshed. In
addition, whenever you select a class in release setup, the document and folder properties are
refreshed. However, if document or folder properties are modified in FileNet Content Manager
after the first time a class is selected, you must log out of the release script and log back in to see
the latest properties.
Skip First Page
The “Skip first page of each document” option as specified on the General Settings tab, allows you
to discard the first page of each document from the image. However, if you are releasing only one
image in a document and you select this option, release will fail and the document will be routed
to the Ascent Capture Quality Control module.
{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
Operator’s Station ID} instead.
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. However, it could be modified
to be required from FileNet Content Manager.
Refer to Document Title Property on page 33 for more information about a known problem.
Folder Name Property
You can use the Folder Name property to specify a name for your release folder. This property
will always appear first in the Content Manager Properties list as specified on the Folder Settings
tab. This is a required property. Required folder properties are shown with an asterisk in front of
their names (for example, *Folder Name). You must provide an Ascent Value for all required
folder properties.
If the Folder Name property resolves to a NULL value, the document will be rejected and routed
to the Ascent Capture Quality Control module.
Invalid Folder Name Characters
The Folder Name property cannot contain the following characters:
Asterisk (*)
Backslash (\)
Colon (:)
Greater than sign (>)
Less than sign (<)
Pipe (|)
Question mark (?)
Quotation marks (“)
Slash mark (/)
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. For example:
bowling;fishing;;golfing;;;racing;swimming
The blank or NULL value will be converted to an empty string when released to FileNet Content
Manager. However, the following FileNet Content Manager data types do not accept empty
strings:
Boolean
DateTime
Float
ID
Integer
The document will be rejected and the batch will be routed to the Ascent Capture Quality Control
module.
Warning The Multi-value separator should not be part of your value. For example, if you specify
a period (.) as one of your values and you specify the period as the Multi-value separator, the
release script will assume the value is the separator. In addition, if you use the Multi-value
separator for a single-value property, the literal string will be used.
For more information about the Multi-value separator, refer to the Ascent 7.1 Release Script for
FileNet Content Manager 4.0 Help (Help keyword: Multi-value separator).
Viewing Content Elements
In FileNet Content Manager, if you attempt to view the content elements of a released document,
you will only be able to directly view the first content element in the list. In order to view the
remaining content elements, you must open the properties of the released document and select the
Content Element tab. Then, double-click on any one of the content elements in the list to view.
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. No
document versioning will occur. All duplicate documents will be released with a sequential whole
number. Note that this release script does not append a number to the end of the Document Title
property.
To illustrate, consider an object store that already contains the following released documents:
TapDoc
Guide(3)
If you release two more documents to the same FileNet Content Manager object store with
identical file names as the above released documents, the file names will display in the FileNet
Content Manager Administrative Tools component as:
TapDoc(1)
Guide(4)
When releasing documents that already exist in the FileNet Content Manager Administrative
Tools component with the same file name, the first duplicate document is always assigned with
the number 1. Each additional duplicate document will increase the number by one whole number
(for example: 2, 3, 4).
Note This behavior does not occur in the FileNet Content Manager Workplace Thin client. For
more information, refer to the documentation that came with your FileNet Content Manager
product.
File Name Retention Feature
To use the Ascent Capture File Name Retention feature, you must do the following:
Set the SupportsOriginalFileName property to TRUE in the release script
(SupportsOriginalFileName=TRUE). This is the default setting.
This property is defined in the P8Rel4_v7.INF file. The location of the INF file is where you
installed Ascent Capture (for example, C:\Program Files\Ascent\CAP\P8Rel4_v7.INF).
Enable the “Use the original file name of image and eDocument files” check box on the
Release Properties dialog box in the Ascent Capture Release module.
When the above properties are set correctly, all the files will retain their original file name when
released.
For more information about the Release Properties dialog box, see the Ascent Capture Help
(Ascent Capture Help keyword: Release Properties dialog box). You can display Ascent Capture
Help from the Help menu available from any Ascent Capture module. Alternatively, you can click
Start | Programs | Ascent Capture | Ascent Capture Help.
Multipage Image TypeSingle Page Image TypeKofax PDF Image Type
Original
File
OCRNo OCROCRNo OCROCRNo OCR
Property
TRUE{Doc ID}.tif*
EngDoc.xml
PubDoc.pdf
1.txt
{Doc ID}.tif*
EngDoc.xml
PubDoc.pdf
EngDoc.xml
1.tif
PubDoc.pdf
SQADoc.tif
EngDoc.xml
1.tif
PubDoc.pdf
SQADoc.tif
{Doc ID}.pdf*
EngDoc.xml
PubDoc.pdf
1.txt
{Doc ID}.pdf*
EngDoc.xml
PubDoc.pdf
1.txt
FALSE{Doc ID}.tif*
1.xml
2.pdf
1.txt
{Doc ID}.tif*
1.xml
2.pdf
1.xml
2.tif
3.pdf
4.tif
1.xml
2.tif
3.pdf
4.tif
{Doc ID}.pdf*
1.xml
2.pdf
1.txt
{Doc ID}.pdf*
1.xml
2.pdf
1.txt
Legend
* {Doc ID} is an abbreviation for {Document ID}
When releasing documents to the FileNet Content Manager object store, there is a one-to-one
correspondence between the document’s pages and the content elements. Therefore, one
document will be released that contains content elements for each image, OCR full text file, Kofax
PDF document, and/or eDocument.
Note the following:
The following will apply when the document is released with the
SupportsOriginalFileName property set to TRUE:
If the content element has been scanned (such as the <unnamed> TIFF image in
the 4–page document), the content element is released with the appropriate file
extension as specified by the image type. However, the content element file name uses
the {Document ID} value. The {Document ID} is a unique, sequential number associated
with the page and is assigned by Ascent Capture.
If the content element has been imported, the content element will retain the original
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}.
If the document is released with the SupportsOriginalFileName property set to FALSE,
each content element contained within the document is released with the file name
assigned by Ascent Capture
.
Notice that when the INF setting or the Ascent Capture Release module is not set, the release
script will not use the File Name Retention feature. In addition, OCR full text files and Kofax PDF
documents released from Ascent Capture do not use the File Name Retention feature, regardless
of the configuration.
Note The SupportsOriginalFileName property is not case-sensitive.
File Name Considerations
If the Ascent Capture File Name Retention feature is enabled, problems may develop when a new
input file has the same name as a pre-existing file.
When releasing new input files with the File Name Retention feature enabled, the Ascent Capture
Release module checks the batch to see if pre-existing image files (including eDocuments) have
the same name as the new input file. Each document in the batch is checked to avoid duplicate file
names. If a match is found, the new input file is rejected and the following error message may
display:
A duplicate file name was encountered: <
FileName
>.
The rejected document will be routed to the Ascent Capture Quality Control module.
Duplicate File Names
The following case scenarios explain how a new image file may have the same name as a
pre-existing file when the Ascent Capture File Name Retention feature is enabled.
Case 1
When pages in an image file have been scanned, the file is named with a sequential number
that is assigned by Ascent Capture. However, if the document already contains an imported
file that used a similar file naming scheme (for example, 1.tif or 2.tif), the new scanned image
file may match the name of the imported file.
To illustrate, let’s say that you scanned the following pages into a document:
1.tif
2.tif
3.tif
4.tif
5.tif
The document already contains the following imported files:
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.
Case 2
When a multipage image file has been imported and you are releasing single page image
types, all of the pages in the document will have the same file name.
To explain, let’s say that you import the following multipage image document:
1.tif
At release setup, you choose to release the document as a single page image type. The
multipage image document contains four pages. At release, Ascent Capture will then process
each page in the document as a single page image type. Notice that each page within the
document will have the same file name.
1.tif
1.tif
1.tif
1.tif
The Release module will check the document for duplicate file names. The document will be
rejected and routed to the Ascent Capture Quality Control module.
Case 3
If the same file is imported more than once, then the files will have the same file name.
For example, let’s say that you imported the same file three times. The document will contain
the following:
1.tif
1.tif
1.tif
At release, the Release module will check the document for duplicate file names. The
document will be rejected and routed to the Ascent Capture Quality Control module.
To resolve the problem, you will need to delete the rejected documents in the Ascent Capture
Quality Control module. Then, re-scan and/or re-import the files and release with a different file
name.
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. The Ascent Capture Value {Repository Document ID} is used to store and
retrieve the RepositoryDocumentID that will be used by the first invoked release script. Therefore,
the first release script that runs can set this value, and subsequent release scripts can read the same
value.
Notice that when you are passing the RepositoryDocumentID information to a different release
script, the release script must exist within the same document class using multiple release. In
addition, the release script that is passing the RepositoryDocumentID information must be placed
first in the list on the Release Scripts dialog box. For example:
Ascent 7.1 FileNet Content Manager 4.0
Ascent Capture Text
Only the first release script can set the RepositoryDocumentID value. Subsequent release scripts
can only read this value.
Refer to your Ascent Capture Help for more information about configuring the
RepositoryDocumentID. You can display Ascent Capture Help from the Help menu available
from any Ascent Capture module. Alternatively, you can click Start | Programs | Ascent
Capture | Ascent Capture Help.
Enable eDocument Processing
To release eDocument files, you must enable eDocument processing in your applicable batch class
property.
X To enable eDocument processing
1From the Create Batch Class dialog box or Batch Class Properties dialog box, select the
Advanced tab.
2Check the “Allow import of eDocument files” check box to enable eDocument processing.
3Click Apply to save your settings without closing the dialog box. Click OK to save your
settings and close the dialog box.
Note If you do not enable eDocument processing in Ascent Capture, the eDocument files are
simply ignored at release time.
For more information about eDocument processing, refer to the Ascent Capture Help (Ascent
Capture Help keyword: eDocuments > about).
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.
To release eDocuments, you must enable the “Allow import of eDocument files” option on
the Ascent Capture Batch Class Properties dialog box.
To release OCR full text files, you must enable the “Release OCR with document” option
on the Image Settings tab. In addition, you must enable Ascent Capture OCR full text
processing in your applicable document class and add OCR Full Text module to your
applicable batch class
Table 2. OCR Full Text Reference
Image TypeeDocumentsRelease Result
Multipage imageNoReleases one document that contains a content element for
. Refer to page 18 for instructions.
the multipage image and a content element for the OCR full
text file.
YesReleases one document that contains a content element for
the multipage image, a content element for each of the
eDocuments, and then the OCR full text file is the last content
element. All images are listed in the order that they are
scanned or imported from Ascent Capture. The OCR full text
file is always the last content element released.
Single page imageNoReleases one document that contains a content element for
each single page image and a content element for the OCR
full text file.
YesReleases one document that contains a content element for
each single page image, a content element for each of the
eDocuments, and then the OCR full text file is the last content
element. All images are listed in the order that they are
scanned or imported from Ascent Capture. The OCR full text
file is always the last content element released.
PDF imageNoReleases one document that contains a content element for
the PDF image and a content element for the OCR full text
file.
YesReleases one document that contains a content element for
the PDF image, a content element for each of the eDocuments,
and then the OCR full text file is the last content element. All
images are listed in the order that they are scanned or
imported from Ascent Capture. The OCR full text file is
always the last content element released.
X To enable OCR full text processing for a document class
1From the Create Document Class dialog box or Document Class Properties dialog box,
select the OCR tab.
2Check the Enable OCR full text check box to enable OCR full text processing for the
document class.
3Click Apply to save your settings without closing the dialog box. Click OK to save your
settings and close the dialog box.
X To add the OCR Full Text module to a batch class
1From the Create Batch Class dialog box or Batch Class Properties dialog box, select the
Queues tab.
2Select OCR Full Text from the list of Available Queues, and click Add.
3Click Apply to save your settings without closing the dialog box. Click OK to save your
settings and close the dialog box.
For more information about OCR full text processing, refer to the Getting Started with Ascent Capture guide.
Kofax PDF Options
To release Kofax PDF documents, you must enable Ascent Capture Kofax PDF generation in your
applicable document class and add the Kofax PDF Generator module to your applicable batch
class.
Refer to the Ascent 7.1 Release Script for FileNet Content Manager 4.0 Help for details about how
Kofax PDF documents and non-image files are released to FileNet Content Manager (Help
keyword: File format combinations).
X To add the Kofax PDF Generator module to a batch class
1From the Create Batch Class dialog box or Batch Class Properties dialog box, select the
Queues tab.
2Select PDF Generator from the list of Available Queues, and click Add.
3Click Apply to save your settings without closing the dialog box. Click OK to save your
settings and close the dialog box.
X To enable Kofax PDF generation for a document class
1From the Create Document Class dialog box or Document Class Properties dialog box,
select the PDF tab.
2Check the Enable Kofax PDF generation check box to enable Kofax PDF processing for the
document class.
3Click Apply to save your settings without closing the dialog box. Click OK to save your
settings and close the dialog box.
For more information about the Kofax PDF Generator module, refer to the Getting Started with Ascent Capture guide.
18Kofax, Inc.
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. If you do not have administrator privileges and install this release script,
you may receive error messages and several of the files may not install correctly.
Before you install the Ascent 7.1 Release Script for FileNet Content Manager 4.0, refer to System Requirements on page 2 for information about installation requirements.
Installation Instructions
Use the following instructions to install the Ascent 7.1 Release Script for FileNet Content Manager
4.0.
X To install the release script
1Insert your Ascent 7.1 Release Script for FileNet Content Manager 4.0 installation CD into
2From your Windows task bar, select Start | Run, browse to the FileNet\CM4 folder on the
CD, and run Setup.exe. The installation program will start.
3Follow the instructions on the screen to install the release script.
4When the installation is complete, a message will display that indicates the release script
was successfully installed.
Note Installing the release script automatically registers it with Ascent Capture.
5Repeat this procedure on all Administration and Release workstations that will use the
FileNet Content Manager release script.
Upgrading the Release Script
Upgrade to the Ascent 7.1 Release Script for FileNet Content Manager 4.0 is not supported.
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
1Insert your Ascent 7.1 Release Script for FileNet Content Manager 4.0 installation CD into
your CD drive.
2From your Windows task bar, select Start | Run, browse to the FileNet\CM4 folder on the
CD, and run Setup.exe.
3Setup will detect an existing installation and the Application Maintenance dialog box will
display, as shown in Figure 1.
4From the Application Maintenance dialog box, select “Repair” and then click Next.
5Follow the instructions on the screen to repair the release script.
6When the repair is complete, a message will display that indicates the release script was
1Insert your Ascent 7.1 Release Script for FileNet Content Manager 4.0 installation CD into
your CD drive.
2From your Windows task bar, select Start | Run, browse to the FileNet\CM4 folder on the
CD, and run Setup.exe.
3Setup will detect an existing installation and the Application Maintenance dialog box will
display, as shown in Refer to Figure 1 on page 20.
4From the Application Maintenance dialog box, select “Remove” and then click Next.
5Follow the instructions on the screen to delete the release script.
6When the uninstallation is complete, a message will display that indicates the release
script was successfully uninstalled.
Alternatively, you can use the Add or Remove Programs utility from the Windows Control Panel
to uninstall the Ascent 7.1 Release Script for FileNet Content Manager 4.0.
Refer to your Microsoft documentation for more information about the Add or Remove Programs
utility.
Refer to Problems When Uninstalling the Release Script on page 33 for information about a known
problem.
Note After uninstalling, the Ascent 7.1 Release Script for FileNet Content Manager 4.0 will
continue to display in the Release Script Manager, although it will not be functional. To remove
the release script from the list, you must go into every batch class and associated document class,
select the applicable release script from the Assigned Release Scripts list and click Remove. You
must do this for every instance of the FileNet Content Manager release script. After all references
to the release script are removed, you will be able to delete the Ascent 7.1 Release Script for
FileNet Content Manager 4.0 from the Release Script Manager.
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.
To release to FileNet Content Manager, the logged-in user must have the following:
A valid FileNet Content Manager user name and password
Permissions to create new objects and modify existing objects
Permissions to connect to the FileNet Content Manager object store
Contact your FileNet Content Manager administrator for assistance.
X To log on to the release script
1Start the Ascent Capture Administration module. The module’s main screen will display.
2Select the Batch class tab from the Definitions panel, and right-click the applicable
document class. (Expand the batch class item to select associated document classes.) A
context menu will display.
3From the context menu, select “Release Scripts.” The Release Scripts dialog box will
display.
Figure 2. Release Scripts Dialog Box
4The Release Scripts dialog box lists all available release scripts. Available release scripts
are those that are registered with Ascent Capture. From the Release Scripts dialog box,
select the “Ascent 7.1 FileNet Content Manager 4.0” release script and click Add. The
FileNet Content Manager Login Information dialog box will display, as shown in Figure 3
on page 23.
5Enter your FileNet Content Manager user name.
6Enter your FileNet Content Manager password.
7Enter your FileNet Content Manager site URL. The release script supports the following
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. The MTOM web service, which is
compatible with .NET 2.0, is not supported.
The server name is not case-sensitive. The portion after the port number is case-sensitive.
The login information will be used to log on to the FileNet Content Manager object store.
This information will be saved and used during release.
Figure 3. FileNet Content Manager Login Information Dialog Box
Note The login information will be saved and used during release.
8To prompt for a user ID and password if the release script is not able to log on to FileNet
Content Manager at release time, select the “If unable to log in during release, prompt for
valid login information” check box.
If selected and there is a problem logging on to the FileNet Content Manager release
script, the FileNet Content Manager Login Information dialog box will display during
release. The user may then enter a valid user name and password, and click OK.
However, if the user clicks the Cancel button, the release will fail and the batch will be
routed to the Ascent Capture Quality Control module.
If not selected and problems occur when logging on to the FileNet Content Manager
release script, the FileNet Content Manager Login Information dialog box will not
display during release. Release will fail and the batch will be routed to the Ascent
Capture Quality Control module.
Note Do not select this feature if you plan to run the Ascent Capture Release module as a
service or if you plan to run the Release module during off-hours. The FileNet Content
Manager Login Information dialog box requires a user response, which interferes with the
automated nature of running the Release module as a service or without operator
attention.
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.
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.
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. In addition, you can specify a multi-value separator for
your document and folder class properties.
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.
If you ever decide to edit your batch class, you must publish your batch class again before your
changes can be used. Your changes will not be applied to batches created before the new
publication date.
X To publish a batch class
1Start the Ascent Capture Administration module. The module’s main screen will display.
2Select the Batch class tab from the Definitions panel, and right-click the applicable batch
class. A context menu will display.
3From the context menu, select “Publish.” The Publish dialog box will display.
4From the Publish dialog box, select your batch class and click Publish. Ascent Capture
will check all of your batch class settings and display the results in the Results box.
a If no problems are detected, the message “Publishing successful” will display.
b If problems are detected, error and/or warning messages will display along with the
recommended actions to resolve the problems. Perform the recommended actions, and
then try to publish the batch class again.
5Run some sample batches through the system to test the operation of the release script.
After successfully publishing, you can create batches based on your batch class. As your batches
flow through your Ascent Capture system, they will be routed from module to module. The
modules that are used to process a batch, and the order that processing occurs, are specified as
part of the batch class definition for the batch.
Refer to the Ascent Capture Help for more information about batch classes (Ascent Capture Help
keyword: Batch classes > about).
30Kofax, Inc.
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.
The Ascent Capture Release module usually runs as an unattended module on a Windows
workstation, periodically polling the Release module for available batches. The Release module
may be configured to run during off-hours to avoid any impact to the throughput of Ascent
Capture and/or the network system. To start the Release module, select
Start | Programs | Ascent Capture | Release. All batches queued for release will be released after
initiation of the Release module.
Note Refer to your Ascent Capture Help for more information about configuring the Release
module (Ascent Capture Help keyword: Release module > about). You can display Ascent Capture
Help from the Help menu available from any Ascent Capture module. Alternatively, you can click
Start | Programs | Ascent Capture | Ascent Capture Help.
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. (SPR 00017588)
When you close the Ascent Capture Administration and the Release module, an error message
displays. The above problems occur because the VirtualReScan (VRS) 4.0 DLL is attempting to
access an Ascent Capture DLL that the workstation has already shut down. You will need to
download the VRS 4.0 Service Pack 1 from the Support pages on the Kofax Web site.
Refer to your Microsoft documentation for more information about the Windows Task Manager
utility.
X To install VRS 4.0 Service Pack 1
1Use the Windows Task Manager utility to end all processes for the Ascent Capture
Administration and Release modules. You will need to look for Admin.exe and
Release.exe in the list of Processes. Make certain that you have removed all instances of
the Admin.exe process.
2Download VRS 4.0 Service Pack 1 from the Kofax Web site. The file that downloads is a
self-extracting executable that contains VRS 4.0 Service Pack 1.
3Run the executable file to install VRS 4.0 Service Pack 1.
4Follow the instructions on your screen. When the installation is complete, a message will
display that indicates Service Pack 1 was successfully installed.
5Repeat this procedure on all Administration and Release workstations.
Note VRS 4.0 with no Service Pack is installed “silently” as part of the Ascent Capture 7.0
installation process. “Silently” means that VRS 4.0 is automatically installed as a component of the
Ascent Capture 7.0 program. Therefore, VRS 4.0 will not display in the list of installed programs in
the Add or Remove Programs utility from the Windows Control Panel. Note that VRS 4.0 Service
Pack 1 is not a cumulative package and does not contain the VRS 4.0 installation.
Problems When Installing on Windows XP
If you are installing the Ascent 7.1 Release Script for FileNet Content Manager 4.0 on a Windows
XP Professional workstation and you specify a mapped drive, you will receive the following error
message. (SPR 24611)
Error 1904. Module <
support personnel.
Workaround: The error message is incorrect and can simply be ignored. Click the Ignore button
and the release script will successfully install and register the release script.
MappedDrive
> failed to register. HRESULT –2147467259. Contact your
If you click the Abort button, the installation will end. If you click the Retry button, you will
receive the error message again.
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. (SPR 31221)
Workaround: If this problem occurs, run Repair. Refer to Repairing the Release Script on page 20
for more information. Alternatively, you can re-register the release script in the Release Script
Manager.
Document Title Property
You can use the Document Title property to specify a name for your released document. If the
Document Title property resolves to a NULL value, the release script will not use the FileNet
Content Manager Document Object ID to name the document. However, the Document Title
property appears as if it is used by the FileNet Content Manager Object ID in the FileNet Content
Manager Administrative Tools component. In the FileNet Content Manager Workplace Thin client
the Document Title property will display “undefined name.” (SPR 00010817)
Note that once the document is released, you cannot search for the document using the blank
name or the FileNet Content Manager Object ID.
Workaround: Specify a name for your released document.
Document and Folder Classes That Do Not Allow Instances
Document and Folder classes that do not allow instances are not displayed in the Ascent 7.1
Release Script for FileNet Content Manager 4.0. (SPR 00011903)
Revoking User Permissions to the Object Store
If the permissions to a particular FileNet Content Manager object store have been suddenly
revoked for the logged-in user and that user attempts to release a batch, the release will fail with
the following error message. (SPR 00012367)
The user <
store has been removed or renamed. Please verify that you have the appropriate
permissions and the object store is available.
UserName
> is not authorized to the <
ObjectStore
> object store or the object
Workaround: Your system administrator will need to restore the access permissions to the
FileNet Content Manager object store for the logged-in user. Then, the user can unreject the
documents in error and re-release the batch. Once the batch is successfully released, the user’s
permissions can be revoked.
Removing Or Renaming Folders in the FileNet Content Manager Object Store
If a folder has been renamed or removed in your selected FileNet Content Manager object store,
you will not receive a warning when you open release setup. At release, the document will be
rejected and routed to the Ascent Capture Quality Control module. (SPR 00013301)
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.
(SPR 00011417)
Workaround: Specify an existing UNC path for the Release working directory.
Documents Released with Unrecognized MIME Type
If you attempt to release a document with an unknown MIME type, the file extension is used as
the MIME type. This is not always accurate. To ensure that documents are released with the
correct MIME type, install the missing MIME-compliant application on your release workstation.
For example, to open an .XLS MIME type, install Microsoft Excel on the release workstation. Once
the applicable MIME types are registered on the release workstation, documents will be released
with the correct MIME type.
Empty Folders May Be Created
One or more empty folders may be created in the release destination if document release fails.
(SPR 00031814)
Intermittent Permission Error
When releasing batches continuously for a long period of time, some batches may fail to release
due to the user account temporarily losing permission to either create a folder or upload a
document. The failed batches will need to be unrejected in the Quality Control module and
released again. (IBM defect number ecmdb00742846, SPR 00032045)
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.
Valid Boolean Formats
The valid Boolean formats include the following:
Any non-zero number and “TRUE”
“0” and “FALSE”
Note The Boolean values (TRUE or FALSE) are not case-sensitive.
Ascent Value Data Types
When Ascent Value fields are copied to FileNet Content Manager properties, their data types are
converted to FileNet Content Manager data types. The following figure lists the supported FileNet
Content Manager data types for Ascent Capture batch fields and index fields.
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.
Refer to the documentation that came with your FileNet Content Manager product for more
details about FileNet Content Manager permissions.
Adding Access Permissions to the FileNet Content Manager Domain
The following sample scenario illustrates how you can easily allow or deny access permissions to
the FileNet Content Manager domain. The instructions are simply the security permissions that
you can add to a particular node. The “P8Users” accounts indicate the users/groups that have
been granted the appropriate permissions to access a particular node in the FileNet Content
Manager domain.
Figure 13. Permissions Scenario for the FileNet Content Manager Domain
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.
Refer to the documentation that came with your FileNet Content Manager product for more
details about FileNet Content Manager permissions.
Warning FileNet Content Manager group permissions override individual user permissions. In
addition, documents do not inherit permissions from their parents when using the release script.
FileNet Content Manager Domain
To log on to the FileNet Content Manager release script, the logged-in user must be a member of
the FileNet Content Manager domain.
FileNet Content Manager Object Store
To access a FileNet Content Manager object store in release setup, you must select an object store
to which the logged-in user has the appropriate authorization to connect. If you select an object
store that you do not have authorization to connect, you will receive an error message prompting
you to select an object store that you have the appropriate permissions to access.
Create Folders
To create folders, you must have permission to access the FileNet Content Manager object store. In
addition, you must have permissions to create new objects and modify existing objects on the
object store. This will allow new folders to be created to organize the objects in the object store. If
you do not have the necessary permissions, an error will be logged at release and the documents
will be rejected and routed to the Ascent Capture Quality Control module. No validation is
performed during release setup to ensure that you have the appropriate permissions to create
folders on the selected object store.
You must also have the following security rights to use the folder class:
View all properties
Modify all properties
Create instance
Read permission
Release Documents
To release documents, you must have permission to access the FileNet Content Manager object
store. In addition, you must have permissions to create new objects and modify existing objects on
the object store. This will allow documents to be released to FileNet Content Manager. If you do
not have the necessary permissions, an error will be logged at release and the documents will be
rejected and routed to the Ascent Capture Quality Control module. No validation is performed
during release setup to ensure that you have the appropriate permissions to release documents to
the selected object store.
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. For example, if you give access permissions to
the User-defined Document Class node (as shown in Figure 14) and do not give access to the
Document Class node (also known as the system class node in FileNet Content Manager), the
release will fail with an error.
Figure 14. FileNet Content Manager Domain
When permissions are denied to the Document Class node, the FileNet Content Manager system
will deny access to all the subclasses below the Document Class node in the hierarchy. This
problem occurs because the release script uses a different API set then FileNet Content Manager.
Notice that you will not see this behavior in the FileNet Content Manager Workplace Thin client.
Note If information is changed in FileNet Content Manager while release setup is open, the
release script will not see the latest changes. Therefore, you must log out of the release script and
log back in for the changes to take effect. When adding and/or removing domain users, you may
need to stop and restart the “Content Engine Object Store” service on the Content Engine Server to
see the latest changes.
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.
The Kofax Web site also contains information that describes support options for Kofax products.
Please review the site for details about the available support options.
If you need to contact Kofax Technical Support, please have the following information available:
Ascent Capture software version
FileNet Content Manager release script version
Operating system and Service Pack version
Network and client configuration
Copies of your error log files
Information about your release script