Kofax
Capture
Kofax Capture 8.0 Release Script for
FileNet Content Manager 5.0
Administrator’s Guide
June 8, 2011
© 1994 - 2011 Kofax, Inc., 15211 Laguna Canyon Road, Irvine, California 92618, U.S.A. All rights
reserved. Use is subject to license terms.
Third-party software is copyrighted and licensed from Kofax's suppliers. This product includes
software developed by the Apache Software Foundation (http://www.apache.org/).
This product is protected by U.S. Patent No. 6,370,277.
THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF KOFAX,
INC. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR EXPRESS
WRITTEN PERMISSION OF KOFAX, INC.
Kofax, the Kofax logo, Kofax Capture, the Kofax Capture logo, and Kofax 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.
Contents
Introduction ...................................................................................................................................................5
Additional Documentation ..................................................................................................................5
Technical Assistance for Your Kofax Product ...................................................................................5
System Requirements ...................................................................................................................................6
FileNet Content Manager Server Support .........................................................................................6
Client Operating System Support .......................................................................................................6
Administration and Release Workstations – Additional Requirements .......................................6
Source Code ............................................................................................................................................6
Features ..........................................................................................................................................................8
Kofax Values / FileNet Content Manager Properties ......................................................................8
Kofax Capture Value {Document GUID} ...........................................................................................8
Document Storage .................................................................................................................................9
Folder Creation ......................................................................................................................................9
Release Script Information Interchange Supported .........................................................................9
File Name Retention Supported ..........................................................................................................9
SecurityBoost Supported ......................................................................................................................9
FileNet Content Manager Object Store ...............................................................................................9
Choice List Properties Supported .......................................................................................................9
Duplicate Documents ..........................................................................................................................10
Release Working Directory ................................................................................................................10
Multiple Values ....................................................................................................................................10
Multiple Release Supported ...............................................................................................................10
Online Help Available for Release Setup .........................................................................................10
Image Support ......................................................................................................................................11
Kofax PDF Support ......................................................................................................................11
OCR Full Text Support ................................................................................................................11
eDocument Support .....................................................................................................................11
Additional Information ..............................................................................................................................11
Binary and Object Properties Not Supported ..................................................................................11
Viewing FileNet Content Manager Data in Release Setup ............................................................12
Skip First Page ......................................................................................................................................12
{Index Operator’s Station ID} Kofax Capture Value ......................................................................12
Document and Folder Names ............................................................................................................12
Document Title Property .............................................................................................................12
Folder Name Property .................................................................................................................12
Multi-value Separator Option ............................................................................................................13
Viewing Content Elements .................................................................................................................14
Kofax, Inc. 3
Contents
Viewing Duplicate Documents in FileNet Content Manager Administrative Tools ................14
File Name Retention Feature .............................................................................................................14
Behavior of the SupportsOriginalFileName Property ............................................................15
File Name Considerations ..................................................................................................................16
Duplicate File Names ...................................................................................................................16
Sharing Data Among Release Scripts ...............................................................................................18
Enable eDocument Processing ...........................................................................................................18
OCR Full Text Options .......................................................................................................................18
Kofax PDF Options ..............................................................................................................................20
Installing the Release Script ......................................................................................................................20
Important Note About Installation ...................................................................................................20
Installation Instructions ......................................................................................................................21
Upgrading the Release Script ....................................................................................................................21
Application Maintenance ..........................................................................................................................21
Repairing the Release Script ..............................................................................................................21
Removing the Release Script ..............................................................................................................22
Logging On to the Release Script .............................................................................................................22
Setting Up the Release Script ....................................................................................................................24
Publishing a Batch Class ............................................................................................................................24
Releasing Batches ........................................................................................................................................25
Data Type Compatibility ...........................................................................................................................25
Valid Boolean Formats ........................................................................................................................26
Kofax Value Data Types .....................................................................................................................26
Kofax Capture Values .........................................................................................................................26
Text Constants ......................................................................................................................................27
FileNet Content Manager Permissions ....................................................................................................27
Adding Access Permissions to the FileNet Content Manager Domain .......................................28
Recommended Permissions ...............................................................................................................28
FileNet Content Manager Domain .............................................................................................29
FileNet Content Manager Object Store .....................................................................................29
Create Folders ...............................................................................................................................29
Release Documents ......................................................................................................................29
Release Script Behavior .......................................................................................................................30
4 Kofax, Inc.
Introduction
This document contains the information for the Kofax Capture 8.0 Release Script for FileNet
Content Manager 5.0, which supports FileNet Content Manager versions 4.0, 4.5, and 5.0 and is
also compatible with Kofax Capture 9.0. This release script copies document images, OCR full text
files, Kofax PDF documents, eDocuments, and writes data from Kofax Capture into FileNet
Content Manager.
Important In Kofax Capture 8, the term “release script” is used to name the scripts, to refer to the
feature in the user documentation and Help, and used in the Kofax Capture User Interface for
windows, menu items, etc. In Kofax Capture 9 and up, the term is changed to ”export connector.”
This version of the script for FileNet uses “release script” throughout the product.
Additional Documentation
These release notes are a supplement to the following Kofax Capture documentation and Help:
Kofax Capture Advanced Features Guide
Kofax Capture Release Notes
Getting Started with Kofax Capture guide
Installation Guide for Kofax Capture and Kofax Capture Internet Server
Learning Kofax Capture guide
Help provided from any of the Kofax Capture modules
Help provided with the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
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.
Technical Assistance for Your Kofax Product
Support for your Kofax product is provided by your primary application support provider, which
is specified as part of the maintenance agreement associated with your purchase. Please contact
your Kofax application support provider for technical assistance.
For more information about your product, visit the Kofax Support pages at www.kofax.com
Product information and release news
Access to the Kofax Knowledgebase
Access to the online Case Management System (for eligible customers)
Downloadable product documentation
Before contacting your Kofax application support provider, please gather the following
information where applicable:
Product name, version, and serial number
Log files
Product license
Exact error message(s)
Reproduction scenario
for:
Kofax, Inc. 5
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
System Requirements
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 requires the following
components to be installed prior to installing this release script.
FileNet Content Manager Server Support
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 requires the following
network server components:
FileNet Content Manager Content Engine version 4.0, 4.5, or 5.0
FileNet Content Manager supported database
Microsoft .NET Framework 3.5 Service Pack 1
Note This release script was tested using FileNet Content Manager version 5.0 on a Windows
2003 Server (with Service Pack 2), and Microsoft SQL Server 2005. The clients used were running
Windows XP SP3. The DNS Server running the Active Directory server is running on Windows
2000 Server SP4.
Client Operating System Support
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 supports the following
client operating systems:
Windows 7 (Professional, Enterprise, or Ultimate Edition)
Windows XP Professional with Service Pack 3
Note At the time of publishing these release notes, the Kofax Capture 8.0 Release Script for
FileNet Content Manager 5.0 was certified with Windows XP Professional with Service Pack 3.
Administration and Release Workstations – Additional Requirements
The Kofax Capture Administration and Release workstations must have the following
components installed:
Kofax Capture 8 or Kofax Capture 9
Web Services Enhancements (WSE) 3.0 for Microsoft .NET
Microsoft .NET Framework 3.5 Service Pack 1
Source Code
The source code for the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 is
provided and it is located on the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0
installation media. Note that two source code projects are provided on the installation media. 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 2005.
6 Kofax, Inc.
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
X To modify the release script
1 Install the FileNet Content Manager release script. Refer to Installing the Release Script
on
page 20 for the installation instructions. When you install the FileNet Content Manager
release script, you will install the required components referenced in the source code.
2 Open the FileNet Content Manager release script project. Make sure the project references
point to the type library files installed with the release script
(Kofax.P8Rel50_V80.ConnectorInterface.tlb and
Kofax.P8Rel50_V80.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
Kofax Capture Administration and Release modules before attempting to compile the
release script source code.
3 Copy the P8Rel50_V80.dll to the installation directory (for example, C:\Program
Files\Kofax\CaptureSS\ServLib\Cap\P8Rel50_V80). When you are prompted to replace
the existing file, select Yes.
4 Register the P8Rel50_V80.dll using the following command line:
regsvr32 “C:\Program
Files\Kofax\CaptureSS\ServLib\Cap\P8Rel50_V80\P8Rel50_V80.dll”
You will need to repeat this procedure on each Administration and Release workstation that will
be using the FileNet Content Manager release script.
Note To successfully modify and compile the release script, development must occur on a
workstation with the appropriate versions of Kofax Capture and CAPTools.
Refer to the documentation that came with your FileNet Content Manager product and Visual
Basic documentation for assistance.
X To modify the connector, connector interface, or connector interface factory
1 Install the FileNet Content Manager release script. Refer to
Installing the Release Script on
page 20 for the installation instructions.
2 Open the solution Connector.sln, which contains the connector, connector interface, and
connector interface factory projects. Make any desired modifications, and rebuild the
solution in Microsoft Visual Studio 2005 under the Release build configuration.
3 Copy the following files to the installation directory (for example, C:\Program
Files\Kofax\CaptureSS\ServLib\Cap\P8Rel50_V80):
Kofax.P8Rel50_V80.Connector.dll
Kofax.P8Rel50_V80.ConnectorInterface.dll
Kofax.P8Rel50_V80.ConnectorInterface.tlb
Kofax.P8Rel50_V80.ConnectorInterfaceFactory.dll
Kofax.P8Rel50_V80.ConnectorInterfaceFactory.tlb
When you are prompted to replace the existing files, select Yes.
Kofax, Inc. 7
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
4 Register the Kofax.P8Rel50_V80.ConnectorInterface.dll and the
Kofax.P8Rel50_V80.ConnectorInterfaceFactory.dll by invoking the regasm command in
the command line prompt. The command to register these dll’s is:
regasm.exe [InstallDir]\<name of .dll> /codebase /tlb
For example:
regasm.exe C:\Program
Files\Kofax\CaptureSS\ServLib\Cap\P8Rel50_V80\Kofax.P8Rel50_V80.Connector
Interface.dll /codebase /tlb
RegAsm.exe is located in C:\Windows\Microsoft.NET\Framework\v2.0.50727\. To run
this executable, you can navigate to this folder and run it or place this path in the Path
environment variable and run it from any location.
5 Re-compile the release script using steps 2 through 4 in the “To modify the release script”
section above. These steps ensure that the release script references the newly registered
connector interface and connector interface factory. Make sure that the project references
the two .tlb files.
Note To successfully modify and compile the connector, connector interface, or connector
interface factory, development must occur on a workstation with Microsoft WSE 3.0
(development setup).
Features
This section contains information about features provided with the Kofax Capture 8.0 Release
Script for FileNet Content Manager 5.0.
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 provides an easy-to-use
setup window available from the Kofax Capture Administration module. The Kofax Capture 8.0
Release Script for FileNet Content Manager 5.0 — Release Setup window 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.
Kofax Values / FileNet Content Manager Properties
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 provides an easy-to-use
interface for linking Kofax Capture Kofax Values to FileNet Content Manager document
properties and folder properties. Examples of Kofax Values include Document index fields, Folder
index fields, Batch fields, Kofax 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.
Kofax Capture Value {Document GUID}
The Kofax Capture Value {Document GUID} is a new value that can be used for index fields and
release values. The Kofax Capture Value is a type of document ID that is unique across the central
site and all remote sites that comprise an Kofax 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 {D3C58EE25627-443b-BBFA-EE7A5790482A} 123 as the Document GUID.
8 Kofax, Inc.
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
Document Storage
With the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0, you can specify new
or existing folders for storing documents in the FileNet Content Manager object store for release.
You can use Kofax Capture Kofax 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 Kofax 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.
Release Script Information Interchange Supported
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 supports the Kofax 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 18 for more information.
File Name Retention Supported
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 supports the Kofax Capture
File Name Retention feature. This feature allows you to retain the original imported file name.
Refer to
File Name Retention Feature on page 14 for more information.
SecurityBoost Supported
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 supports the Kofax Capture
SecurityBoost feature. Refer to your Kofax Capture Help for more information about the
SecurityBoost feature.
FileNet Content Manager Object Store
When setting up the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.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 Kofax
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.
Kofax, Inc. 9
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
Duplicate Documents
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.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 Kofax Capture Quality Control module.
Release Working Directory
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.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 Kofax 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 Kofax Capture 8.0 Release Script for FileNet Content Manager 5.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 13 for more information.
Multiple Release Supported
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 supports the Kofax 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 Kofax Capture Release Scripts
window. 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 Kofax Capture Help for more information about the Multiple Release feature.
Online Help Available for Release Setup
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.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 Kofax Capture 8.0 Release Script for FileNet
Content Manager 5.0 — Release Setup window to display help information about release options.
10 Kofax, Inc.
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
Image Support
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 Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0, you can release Kofax
PDF documents into the FileNet Content Manager object store. Kofax PDF is bundled with Kofax
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 20 for more information about Kofax PDF documents.
OCR Full Text Support
With the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0, you can release
documents processed through the Kofax Capture OCR Full Text module into the FileNet Content
Manager object store.
Refer to
OCR Full Text Options on page 18 for more information about OCR full text files.
eDocument Support
With the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.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 18 for more information about eDocument files.
Additional Information
This section contains additional information about the Kofax Capture 8.0 Release Script for
FileNet Content Manager 5.0.
Binary and Object Properties Not Supported
The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.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.
Kofax, Inc. 11
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
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 Kofax Capture Quality Control module.
{Index Operator’s Station ID} Kofax Capture Value
The Kofax 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.
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. However, it could be modified
to be required from FileNet Content Manager.
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 Kofax 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 Kofax Capture Quality Control module.
12 Kofax, Inc.
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
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 (/)
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 Kofax Capture 8.0 Release Script for FileNet Content Manager 5.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 Kofax Capture Quality Control
module.
Caution 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 Kofax Capture 8.0 Release
Script for FileNet Content Manager 5.0 Help.
Kofax, Inc. 13
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
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 Kofax 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 P8Rel50_V80.INF file. The location of the INF file is where
you installed Kofax Capture (for example, C:\Program
Files\Kofax\CaptureSS\ServLib\Cap\P8Rel50_V80\P8Rel50_v80.INF).
Enable the “Use the original file name of image and eDocument files” check box on the
Release Properties window in the Kofax Capture Release module.
When the above properties are set correctly, all the files will retain their original file name when
released.
14 Kofax, Inc.
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
For more information about the Release Properties window, see the Kofax Capture Help (Ascent
Capture Help keyword: Release Properties window). You can display Kofax Capture Help from the
Help menu available from any Kofax Capture module. Alternatively, you can click
Start | Programs | Kofax Capture | Kofax Capture Help.
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: EngDoc.xml
Page 2: <unnamed> TIF
Page 3: PubDoc.pdf
Page 4: SQADoc.tif
The following table illustrates how the pages are released to FileNet Content Manager.
Table 1. SupportsOriginalFileName Property Behavior
Supports
Original
File
Property
TRUE {Doc ID}.tif*
FALSE {Doc ID}.tif*
Multipage Image Type Single Page Image Type Kofax PDF Image Type
OCR No OCR OCR No OCR OCR No OCR
EngDoc.xml
PubDoc.pdf
1.txt
1.xml
2.pdf
1.txt
{Doc ID}.tif*
EngDoc.xml
PubDoc.pdf
{Doc ID}.tif*
1.xml
2.pdf
EngDoc.xml
1.tif
PubDoc.pdf
SQADoc.tif
1.txt
1.xml
2.tif
3.pdf
4.tif
1.txt
EngDoc.xml
1.tif
PubDoc.pdf
SQADoc.tif
1.xml
2.tif
3.pdf
4.tif
{Doc ID}.pdf*
EngDoc.xml
PubDoc.pdf
1.txt
{Doc ID}.pdf*
1.xml
2.pdf
1.txt
{Doc ID}.pdf*
EngDoc.xml
PubDoc.pdf
{Doc ID}.pdf*
1.xml
2.pdf
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
Kofax, Inc. 15
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
the {Document ID} value. The {Document ID} is a unique, sequential number associated
with the page and is assigned by Kofax Capture.
If the content element has been imported, the content element will retain the original
file name and file extension.
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 Kofax 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 Kofax Capture
.
Notice that when the INF setting or the Kofax 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 Kofax 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 Kofax 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 Kofax 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 Kofax 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 Kofax 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 Kofax 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
16 Kofax, Inc.
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
The document already contains the following imported files:
1.tif
2.tif
3.tif
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 Kofax 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 Kofax 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, Kofax 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 Kofax 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 Kofax Capture Quality Control module.
To resolve the problem, you will need to delete the rejected documents in the Kofax Capture
Quality Control module. Then, re-scan and/or re-import the files and release with a different file
name.
Kofax, Inc. 17
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
Sharing Data Among Release Scripts
The Kofax 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 Kofax 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 window. For example:
Kofax 7.5 FileNet Content Manager 5.0
Kofax Capture Text
Only the first release script can set the RepositoryDocumentID value. Subsequent release scripts
can only read this value.
Refer to your Kofax Capture Help for more information about configuring the
RepositoryDocumentID. You can display Kofax Capture Help from the Help menu available from
any Kofax Capture module. Alternatively, you can click Start | Programs | Kofax
Capture | Kofax 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
1 From the Create Batch Class window or Batch Class Properties window, select the
Advanced tab.
2 Check the “Allow import of eDocument files” check box to enable eDocument processing.
3 Click Apply to save your settings without closing the window. Click OK to save your
settings and close the window.
Note If you do not enable eDocument processing in Kofax Capture, the eDocument files are
simply ignored at release time.
For more information about eDocument processing, refer to the Kofax Capture Help.
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 Kofax Capture.
18 Kofax, Inc.
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
To release eDocuments, you must enable the “Allow import of eDocument files” option on
the Kofax Capture Batch Class Properties window.
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 Kofax 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 Type eDocuments Release Result
Multipage image No Releases one document that contains a content element for
Single page image No Releases one document that contains a content element for
. Refer to page 19 for instructions.
the multipage image and a content element for the OCR full
text file.
Yes Releases 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 Kofax Capture. The OCR full text
file is always the last content element released.
each single page image and a content element for the OCR
full text file.
Yes Releases 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 Kofax Capture. The OCR full text
file is always the last content element released.
PDF image No Releases one document that contains a content element for
the PDF image and a content element for the OCR full text
file.
Yes Releases 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 Kofax Capture. The OCR full text file is
always the last content element released.
X To enable OCR full text processing for a document class
1 From the Create Document Class window or Document Class Properties window, 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 window. Click OK to save your
settings and close the window.
Kofax, Inc. 19
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
X To add the OCR Full Text module to a batch class
1 From the Create Batch Class window or Batch Class Properties window, select the Queues
tab.
2 Select OCR Full Text from the list of Available Queues, and click Add.
3 Click Apply to save your settings without closing the window. Click OK to save your
settings and close the window.
For more information about OCR full text processing, refer to the Getting Started with Kofax Capture
guide.
Kofax PDF Options
To release Kofax PDF documents, you must enable Kofax Capture Kofax PDF generation in your
applicable document class and add the Kofax PDF Generator module to your applicable batch
class.
Refer to the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Help for details
about how Kofax PDF documents and non-image files are released to FileNet Content Manager.
X To add the Kofax PDF Generator module to a batch class
1 From the Create Batch Class window or Batch Class Properties window, select the Queues
tab.
2 Select PDF Generator from the list of Available Queues, and click Add.
3 Click Apply to save your settings without closing the window. Click OK to save your
settings and close the window.
X To enable Kofax PDF generation for a document class
1 From the Create Document Class window or Document Class Properties window, select
the PDF tab.
2 Check the Enable Kofax PDF generation check box to enable Kofax PDF processing for the
document class.
3 Click Apply to save your settings without closing the window. Click OK to save your
settings and close the window.
For more information about the Kofax PDF Generator module, refer to the Getting Started with
Kofax Capture guide.
Installing the Release Script
You can install theKofax Capture 8.0 Release Script for FileNet Content Manager 5.0 on an Kofax
Capture client or standalone workstation.
Important Note About Installation
To install the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.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.
20 Kofax, Inc.
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
Before you install the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0, refer to
System Requirements
on page 6 for information about installation requirements.
Installation Instructions
Use the following instructions to install the Kofax Capture 8.0 Release Script for FileNet Content
Manager 5.0.
X To install the release script
1 Access your release script installation media.
2 From your Windows task bar, select Start | Run, browse to the FileNet\CM5 folder, and
run Setup.exe. The installation program will start.
3 Follow the instructions on the screen to install the release script.
4 When 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 Kofax Capture.
5 Repeat this procedure on all Administration and Release workstations that will use the
FileNet Content Manager release script.
Upgrading the Release Script
Upgrade to the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 is not
supported. You must remove the previous version before you can install this version.
Application Maintenance
This section describes how to repair and remove the Kofax Capture 8.0 Release Script for FileNet
Content Manager 5.0.
Repairing the Release Script
The Repair option replaces missing, renamed, or deleted files.
X To repair the release script
1 Access your release script installation media.
2 From your Windows task bar, select Start | Run, browse to the FileNet\CM5 folder, and
run Setup.exe. Setup will detect an existing installation and the Application Maintenance
window appears.
3 From the Application Maintenance window, select Repair and then click Next.
4 Follow the instructions on the screen to repair the release script.
5 When the repair is complete, a message will display that indicates the release script was
successfully installed.
Kofax, Inc. 21
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
Removing the Release Script
The Remove option will delete the release script.
X To remove the release script
1 Access the installation media.
2 From your Windows task bar, select Start | Run, browse to the FileNet\CM5 folder, and
run Setup.exe.
3 Setup will detect an existing installation and the Application Maintenance window
appears.
4 From the Application Maintenance window, select Remove and then click Next.
5 Follow the instructions on the screen to delete the release script.
6 When 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 Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0.
Refer to your Microsoft documentation for more information about the Add or Remove Programs
utility.
Note After uninstalling, the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.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 Kofax Capture 8.0
Release Script for FileNet Content Manager 5.0 from the Release Script Manager.
Logging On to the Release Script
Once you have associated a document class with a batch class in Kofax 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
1 Start the Kofax Capture Administration module. The module’s main screen appears.
2 Select 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 appears.
3 From the context menu, select Release Scripts. The Release Scripts window appears.
22 Kofax, Inc.
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
4 The Release Scripts window lists all available release scripts. Available release scripts are
those that are registered with Kofax Capture. From the Release Scripts window, select the
“Kofax Capture 8.0 FileNet Content Manager 5.0” release script and click Add. The
FileNet Content Manager Login Information window appears.
5 Enter your FileNet Content Manager user name and password.
6 Enter your FileNet Content Manager site URL. The release script supports the following
format:
http(s)://<Server name>:<Port number>/wsi/<Folder containing FileNet Web
Service>
For example:
http://MyServerName:9080/wsi/FNCEWS40MTOM/
https://MyServerName.MyDomainName.com:9443/wsi/FNCEWS40MTOM/
Important If you plan to connect via https, make sure a trusted certificate is installed.
Note The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 supports the
MTOM Web service, which is compatible with .NET 2.0.
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.
7 To 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 window appears 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 Kofax 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 window will not
display during release. Release will fail and the batch will be routed to the Kofax
Capture Quality Control module.
Note Do not select this feature if you plan to run the Kofax Capture Release module as a
service or if you plan to run the Release module during off-hours. The FileNet Content
Manager Login Information window requires a user response, which interferes with the
automated nature of running the Release module as a service or without operator
attention.
8 Click OK. The Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 – Release
Setup window appears.
9 Refer to the next section, Setting Up the Release Script, for information about the set up
options.
Kofax, Inc. 23
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
Setting Up the Release Script
The following sections describe the setup options available with the Kofax Capture 8.0 Release
Script for FileNet Content Manager 5.0.
Note For more details about the setup options, refer to the Help available from the Kofax Capture
8.0 Release Script for FileNet Content Manager 5.0 – Release Setup window.
Table 3. Setup Options
Tab Description
Storage Settings Specifies the desired FileNet Content Manager object
store to be used for release.
Folder Settings Specifies new or existing folders to use for storing
documents in the FileNet Content Manager object store.
Document Settings Specifies a Content Manager document class for the
document to be released. In addition, you can assign
Kofax Values to properties of a document class.
Image Settings Specifies the desired image format for releasing your
images, and specify whether to release OCR full text files
with your document.
General Settings Specifies a temporary storage location to be used at
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 appear 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
1 Start the Kofax Capture Administration module. The module’s main screen appears.
2 Select the Batch class tab from the Definitions panel, and right-click the applicable batch
class. A context menu appears.
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.
3 From the context menu, select Publish. The Publish window appears.
4 From the Publish window, select your batch class and click Publish. Kofax Capture will
check all of your batch class settings and display the results in the Results box.
24 Kofax, Inc.
If no problems are detected, the message “Publishing successful” appears.
If problems are detected, error and/or warning messages appear along with the
recommended actions to resolve the problems. Perform the recommended actions, and
then try to publish the batch class again.
5 Run 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 Kofax 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 Kofax Capture Help for more information about batch classes.
Releasing Batches
With the Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0, the Kofax 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 Kofax 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 Kofax
Capture and/or the network system. To start the Release module, select Start | Programs | Kofax
Capture <version>| Release. All batches queued for release will be released after initiation of the
Release module.
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
Note Refer to your Kofax Capture Help for more information about configuring the Release
module. You can display Kofax Capture Help from the Help menu available from any Kofax
Capture module. Alternatively, you can click Start | Programs | Kofax Capture | Kofax Capture
Help.
X To release a batch
1 Start the Kofax Capture Release module. The module’s main screen appears. Any batches
waiting to be released will be processed.
Note If the FileNet Content Manager Login Information window displays, enter a FileNet
Content Manager user name, password, and site URL. Refer to
Script on page 22.
2 Once your batch is released, it will be removed from Kofax Capture. If any documents or
pages are rejected, the batch will be routed to the Kofax Capture Quality Control module.
3 When you want to exit the Release module, select Batch | Exit from the Release module’s
menu bar.
Data Type Compatibility
The figures in this section map Kofax Capture data types to FileNet Content Manager data types,
and indicate which combinations are valid.
Logging On to the Release
Kofax, Inc. 25
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
Refer to your Kofax Capture Help for more information about Kofax Capture data types. You can
display Kofax Capture Help from the Help menu available from any Kofax 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.
Kofax Value Data Types
When Kofax 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 Kofax Capture batch fields and index fields.
Figure 1. Kofax Value Data Types
Kofax Capture Values
The following figure lists the Kofax Capture values for FileNet Content Manager data types.
Refer to your Kofax Capture Help for more information about Kofax Capture values (Ascent
Capture Help keyword: Kofax Capture > values).
26 Kofax, Inc.
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
Figure 2. Kofax Capture Values
Text Constants
The following figure lists the supported FileNet Content Manager data types for Kofax Capture
text constants.
Figure 3. Kofax Capture Text Constants
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.
Kofax, Inc. 27
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
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 4. Permissions Scenario for the FileNet Content Manager Domain
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 Kofax Capture Quality Control module.
28 Kofax, Inc.
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
Refer to the documentation that came with your FileNet Content Manager product for more
details about FileNet Content Manager permissions.
Caution 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 Kofax 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 Kofax 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
Kofax, Inc. 29
Kofax Capture 8.0 Release Script for FileNet Content Manager 5.0 Administrator’s Guide
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 5) 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 5. 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.
30 Kofax, Inc.
Loading...