Kofax�Export
Connector�1.0.0
for�Pega�Rules
Process
Commander
Administrator's Guide
2012-02-17
©
2007-2012 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 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, VirtualReScan, the “VRS VirtualReScan” logo, and Kofax VRS are trademarks
or registered trademarks of Kofax, Inc. in the U.S. and other countries. All other trademarks are the
trademarks or registered trademarks of their respective owners.
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
Legal Notice .......................................................................................................................................................................... 2
Preface .................................................................................................................................................................................... 5
Related Documentation ..................................................................................................................................................5
Help for Kofax Export Connector for Pega Rules Process Commander ........................................................... 5
Kofax Export Connector for Pega Rules Process Commander Release Notes ..................................................5
Kofax Capture Installation Guide ............................................................................................................................5
Kofax Capture Administrator's Guide ....................................................................................................................5
Kofax Capture Developer’s Guide .......................................................................................................................... 5
Help for Kofax Capture ............................................................................................................................................ 6
Kofax Capture API Reference Guide ...................................................................................................................... 6
Kofax Capture Release Notes ...................................................................................................................................6
Training .............................................................................................................................................................................6
Getting Help for Kofax Products ................................................................................................................................. 6
Overview ............................................................................................................................................................................... 9
Features ............................................................................................................................................................................. 9
Installing Kofax Export Connector for Pega Rules Process Commander ................................................................. 11
System Requirements ................................................................................................................................................... 11
Installing the Export Connector ..................................................................................................................................11
Repairing the Export Connector .................................................................................................................................11
Removing the Export Connector ................................................................................................................................12
Removing the Export Connector from a Batch Class .........................................................................................12
Removing the Export Connector from the Export Connector Manager ..........................................................12
Removing the Export Connector from the Computer ........................................................................................12
Logging On to Pega Rules Process Commander From the Export Connector ....................................................12
Setup Tabs ...................................................................................................................................................................... 13
Additional Information .....................................................................................................................................................15
Authentication Methods ...............................................................................................................................................15
Additional Configuration Options ............................................................................................................................. 15
Debugging ..................................................................................................................................................................15
Data Type Configuration ............................................................................................................................................. 15
High Availability ...........................................................................................................................................................16
Setting Up Multiple Instance Support .......................................................................................................................17
Modifying the Source Code ........................................................................................................................................ 17
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
3
Contents
4
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
This guide includes the information you need to successfully install this export connector and
acquaint yourself with the software.
If you downloaded this export connector from the Kofax Electronic Delivery site, you can
extract the files from the ISO file. Refer to the instructions on the site. Or, you may have
received Kofax Export Connector for Pega Rules Process Commander as a package that
includes electronic media. In this guide, we refer to both the extracted files and the electronic
media as the “product files.”
Related Documentation
Help for Kofax Export Connector for Pega Rules Process Commander
Help for Kofax Export Connector for Pega Rules Process Commander provides online assistance for
system administrators and operators. It is available from the Administration module when
you are setting up your export connector. To display Help information, click Help from the
setup window.
Preface
Kofax Export Connector for Pega Rules Process Commander Release Notes
Late-breaking product information is available from release notes. You should read the
release notes carefully, as they contain information that may not be included in other Kofax
Export Connector for Pega Rules Process Commander documentation.
Kofax Capture Installation Guide
The Kofax Capture Installation Guide contains essential information about installing Kofax
Capture and Kofax Capture Network Server (KCN Server).
This guide is for system administrators and developers who are installing Kofax Capture or
KCN Server, or who need a description of the installation procedures and requirements.
Kofax Capture Administrator's Guide
The Kofax Capture Administrator's contains essential information about setting up batch classes
and processing documents with Kofax Capture.
Kofax Capture Developer’s Guide
The Kofax Capture Developer’s Guide provides guidance and instructions for customizing Kofax
Capture. Several examples and code segments are provided to demonstrate how to create
custom panels, Ribbon tabs, workflow agents, modules, and scripts to enhance Kofax Capture
processing.
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
5
Preface
Help for Kofax Capture
Kofax Capture online Help provides online assistance for system administrators and
operators.
Kofax Capture API Reference Guide
The Kofax Capture API Reference Guide is an online reference that provides the details of each
API library needed to customize Kofax Capture. The API Reference Guide is designed to be
used with the Kofax Capture Developer’s Guide as a primary resource for customizing Kofax
Capture.
You can access the API Reference Guide from the Kofax Capture program folder on your
Windows desktop.
Kofax Capture Release Notes
Late-breaking product information is available from release notes. You should read the
release notes carefully, as they contain information that may not be included in other Kofax
Capture documentation.
Training
Kofax offers both classroom and computer-based training that will help you make the most of
your Kofax Capture solution. Visit the Kofax Web site at www.kofax.com for complete details
about the available training options and schedules.
Getting Help for Kofax Products
Kofax regularly updates the Kofax Support site with the latest information about Kofax
products.
To access some resources, you must have a valid Support Agreement with an authorized
Kofax Reseller/Partner or with Kofax directly.
Go to http://www.kofax.com/support for:
▪ Access to product knowledge bases
Click CAPTURE: SUPPORT KNOWLEDGE.
▪ Access to the Kofax Customer Portal (for eligible customers)
Click CAPTURE: SUPPORT INTERACTIONS and log in.
To optimize your use of the portal, go to the Kofax Customer Portal login page and click
the link to open the Guide to the Kofax Support Portal. The guide describes how to access the
portal, what to do before contacting the support team, how to open a new case or view an
open case, and what information to collect before opening a case.
▪ Product information and release news
Click Product and select a product name and version.
▪ Downloadable product documentation
Click Documentation and select a product name and version.
6
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
▪ Access to support tools
Click Tools and select the tool to use.
▪ Information about the support commitment for Kofax products
Click Options and select Kofax Support Commitment.
Use these tools to find answers to questions that you have, to learn about new functionality,
and to research possible solutions to current issues.
Preface
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
7
Preface
8
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
Features
Chapter 1
Overview
This export connector manages the flow of document data after it has been acquired from
Kofax Capture as it is moved into your content management system. Document image files
can be linked to this data and also stored in the content management system.
This export connector requires that a Process Commander SOAP service has been configured
in Pega Rules Process Commander. The export connector calls the SOAP service to export
data. Since Pega Rules Process Commander is a workflow system rather than a content
management system, images are not exported to Pega Rules Process Commander. A content
management system is used to store images and the first export connector passes the
document ID from the content management system to the Pega Rules Process Commander
service.
This section contains information about features provided with this export connector.
Supported Content Management Systems
This export connector works with some Kofax Capture export connectors. This means
that these export connectors can pass the {Repository Document ID}. In order for this to
function, the Kofax export connector must come before this export connector in the batch class
workflow definition. Refer to the compatibility matrix for a list of connectors.
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
9
Overview
10
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
Installing Kofax Export Connector for
Pega Rules Process Commander
You can install this export connector on a Kofax Capture client workstation or standalone
workstation.
To install this export connector, you must have Windows administrator privileges. If you do
not have administrator privileges and install this export connector, you may receive error
messages and several of the files may not install correctly.
System Requirements
The server and client workstations used for this export connector must meet the system
requirements listed on the Kofax Web site. For information about supported operating
systems and other system requirements for this export connector, visit the Support pages on
the Kofax Web site at www.kofax.com.
Chapter 2
Installing the Export Connector
If you have installed an earlier version of the import connector, uninstall it now.
1
Start the installation by running Setup.msi from the location where downloaded
2
it. If you are running the installation from removable media, the installation should
automatically start.
Follow the instructions on the screen to install the export connector.
3
When the installation is complete, a confirmation message appears.
4
Note Installing the export connector automatically registers it with Kofax Capture.
Repeat this procedure on all Administration and Export workstations that will use this
5
export connector.
Repairing the Export Connector
You can use the repair process to replace missing, renamed, or deleted export connector files.
Run the .msi file that you used to install the export connector.
1
When the existing installation is detected, the Application Maintenance window appears.
Select Repair, and then click Next.
2
Follow the on-screen instructions to repair the export connector.
3
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
11
Installing Kofax Export Connector for Pega Rules Process Commander
When complete, a message appears to indicate the export connector was successfully
repaired.
Removing the Export Connector
Use the following procedures to remove the export connector from Kofax Capture and from
your computer.
Removing the Export Connector from a Batch Class
In the Kofax Capture Administration module, on the Batch tab, expand the batch class to
1
view associated document classes.
Right-click the applicable document class, and select Export Connectors.
2
On the Assigned Export Connectors list, select the export connector and click Remove.
3
Removing the Export Connector from the Export Connector Manager
In the Kofax Capture Administration module, do one of the following:
1
▪ For Kofax Capture 10: On the Tools tab, in the System group, click Export Connectors.
▪ For Kofax Capture 9: On the Tools menu, select Export Connector Manager.
In the Export Connector Manager window, select the export connector, and click
2
Remove.
Removing the Export Connector from the Computer
You can use the Control Panel options to remove the export connector, or you can follow
these instructions:
Run the .msi file that you used to install the export connector.
1
When the existing installation is detected, the Application Maintenance window appears.
Select Remove, and then click Next.
2
Follow the on-screen instructions to remove the export connector.
3
When the removal is complete, a message appears to indicate the export connector was
successfully removed.
Logging On to Pega Rules Process Commander From the Export Connector
Once you have associated a document class with a batch class in Kofax Capture, you
may specify the export connector to use when exporting your images, OCR full text files,
Kofax PDF documents, eDocuments, and index data. This export connector must be used
in conjunction with one or more other export connectors, and it must follow that export
connector in the Kofax Capture workflow.
12
Start the Administration module.
1
Select the Batch tab from the Definitions panel, and right-click the applicable document
2
class. (Expand the batch class item to select associated document classes.)
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
3
4
5
6
7
Setup Tabs
Installing Kofax Export Connector for Pega Rules Process Commander
A context menu appears.
From the context menu, select Export Connectors.
The Export Connectors window appears. The Export Connectors window lists all
available export connectors. Available export connectors are those that are registered
with Kofax Capture.
From the Export Connectors window, select Pega Rules Process Commander Export
Connector and click Add.
The Pega Rules Process Commander Export Connector Setup window appears with the
General Settings tab selected.
Enter the appropriate WSDL. For more information, see your system administrator.
Note The login information is saved and used during export.
Enter your basic authentication credentials.
Click OK.
The following table describe the setup options.
Location Description
General Settings Tab Specifies the necessary login information for
the Pega Rules Process Commander.
Document Settings Tab Specifies a Pega Rules Process Commander
content type which displays its associated
Pega Rules Process Commander method
elements. This tab also allows you to link
Kofax Values and index fields with method
elements.
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
13
Installing Kofax Export Connector for Pega Rules Process Commander
14
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
Additional Information
This chapter contains additional information about Kofax Export Connector for Pega Rules
Process Commander.
Authentication Methods
The following two authentication methods can be used with this export connector.
▪ HTTP basic authentication
▪ Passing the user name and password to the SOAP method as parameters
Additional Configuration Options
You can configure some additional options by using the config.xml to set a number of
configuration options.
Chapter 3
Debugging
If <Debug> is set to 1, additional information that can be used for debugging is saved
by default in the Temp\KEC-PRPC folder. An alternate location can be specified in
<DebugFolder>.
<Config>
...
<Debug>0</Debug>
<DebugFolder></DebugFolder>
When debug is enabled, the following files are saved:
▪ WSDL.wsdl: WSDL file as specified during the export connector setup.
▪ Proxy.vb: The source for the proxy generated from the WSDL.
▪ <doc order num>in.xml: The input to the SOAP operation.
▪ <doc order num>out.xml: The output from the SOAP operation.
Data Type Configuration
You can use the configuration file to specify how data types are determined by the export
connector. The comments in the config.xml file provide details.
<!-- Since PRPC does not expose type information in the WSDL, the connector
will use the following
property name conventions to determine the type. If the string field value
can be parsed by
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
15
Additional Information
the specified .NET type, then that type's ToString method will be called
with the format
specifier defined. For DateTime types, if the ToUniversal attribute = 1,
then the
ToUniversalTime method is called first. If the property name does not match
any of the
values below, then the Kofax field data type is used.-->
<DataTypes>
<!- Standard Numeric Format Strings http://msdn.microsoft.com/en-us/library/
dwhawy9k.aspx
Custom Numeric Format Strings http://msdn.microsoft.com/en-us/
library/0c899ak8.aspx
-->
<DataType PRPCName="_INT_" ManagedTypeName="System.Int32" Format="G"/>
<!- Standard Date and Time Format Strings http://msdn.microsoft.com/en-us/
library/az4se3k1.aspx
Custom Date and Time Format Strings http://msdn.microsoft.com/en-us/
library/8kb3ddd4.aspx
-->
<DataType PRPCName="_DATETIME_" ManagedTypeName="System.DateTime"
Format="u" ToUniversal="1"/>
<DataType PRPCName="_DATE_" ManagedTypeName="System.DateTime" Format="D"
ToUniversal="1"/>
<DataType PRPCName="_TIME_" ManagedTypeName="System.DateTime" Format="T"
ToUniversal="1"/>
<!- If the PRPC field name does not contain one of the listed substrings,
then the Kofax
field type is used. In that case the format can still be specified.
-->
<DataType KfxIndexFieldType="SQL_DATETIME"
ManagedTypeName="System.DateTime" Format="G" />
<DataType KfxIndexFieldType="SQL_DECIMAL"
ManagedTypeName="System.Decimal" Format="G" />
<DataType KfxIndexFieldType="SQL_NUMERIC"
ManagedTypeName="System.Decimal" Format="G" />
<DataType KfxIndexFieldType="SQL_DOUBLE" ManagedTypeName="System.Double"
Format="G" />
<DataType KfxIndexFieldType="SQL_REAL" ManagedTypeName="System.Double"
Format="G" />
<DataType KfxIndexFieldType="SQL_FLOAT" ManagedTypeName="System.Single"
Format="G" />
<DataType KfxIndexFieldType="SQL_SMALLINT" ManagedTypeName="System.Int16"
Format="G" />
<DataType KfxIndexFieldType="SQL_INTEGER" ManagedTypeName="System.Int32"
Format="G" />
</DataTypes>
High Availability
The timeout and retry values can also be configured to optimize behavior on your network.
These values are only applicable during export and not when setting up the export connector.
<Config>
<RequestTimeoutSeconds>5</RequestTimeoutSeconds>
<MaxRetries>0</MaxRetries>
Parameter Description Default Value
16
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
Additional Information
RequestTimeoutSeconds Timeout in seconds for each
request sent to the SP server.
MaxRetries Number of retries for failed
network operations.
Setting Up Multiple Instance Support
Use the Multiple Instance Support feature to run multiple instances of any Kofax Capture
service on a single computer.
Note When multiple services of the same kind are run on the same computer, a single
Concurrent station and Enterprise license are required. For example, in this case, a user
would need both an Enterprise license and a single Concurrent station license to run multiple
instances of the Export module.
To use the Multiple Instance Support feature with an export connector certified with Kofax
Capture, you will need to modify the export connector’s .inf file. The .inf file is located in
your Kofax Capture installation folder.
Locate the .inf file in your export connector installation directory. Make a copy of the
1
file for backup purposes, and store the copy in a safe location.
5
0
Right-click the .inf file.
2
A context menu appears.
From the context menu, select Open With. Use any text editor to edit this file.
3
Add the following to the .inf file: SupportsMultipleInstances=True
4
Note that you can add this line anywhere within the custom module’s parameter section.
When you are finished, save the file.
5
You need to re-register your export connector with Kofax Capture.
6
Start the Kofax Capture Administration module.
a
On the Tools tab, in the System group, click Export Connectors.
b
The Export Connector Manager window appears.
On the Export Connector Manager window, click Add.
c
Browse to the modified export connector .inf file. Select the file and click Open.
d
The Add Export Connectors window appears.
On the Add Export Connectors window, select the export connector and click Install.
e
Close all windows to complete the process.
f
Modifying the Source Code
The source code for this export connector is in the product files. The source code can be
opened, edited, and compiled in Microsoft Visual Studio.
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
17
Additional Information
Note To successfully modify and compile the export connector, development must occur on
a workstation with the appropriate versions of Kofax Capture and TAPCommon previously
installed. To use the modified export connector, you must replace the export connector Kofax
dll with the modified version on the client workstation. If you receive an access denied error,
you will need to close the Administration module. Refer to the documentation that came with
your Pega Rules Process Commander product and Microsoft Visual Studio documentation for
assistance.
Install this export connector. Refer to Installing Kofax Export Connector for Pega Rules
1
Process Commander for the installation instructions. When you install the export
connector, you will install the required components referenced in the source code.
Note If the export connector was not installed to the default folder, there will be errors
related to TAPCommon references when you attempt to compile the source code. To
fix these errors, update the TAPCommon reference paths in Microsoft Visual Studio to
reference their correct locations in the non-default installation folder.
Open the source code, make any desired modifications, and compile the source code in
2
Microsoft Visual Studio.
Copy the Kofax dll to the installation folder. When you are prompted to replace the
3
existing file, select Yes. You will need to repeat this procedure on each Administration
and Export workstation that will use the export connector.
18
Kofax Export Connector 1.0.0 for Pega Rules Process Commander Administrator's Guide
Loading...