Kofax�Export
Connector�for
TotalAgility
1.1.0
Administrator's Guide
2012-06-08
©
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, and the Kofax product names stated herein 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
Administrator's Guide .........................................................................................................................................................5
Overview ...........................................................................................................................................................................5
Training ........................................................................................................................................................................ 5
Getting Help for Kofax Products .............................................................................................................................5
Installing the Export Connector ....................................................................................................................................6
Removing the Export Connector ............................................................................................................................. 6
Repairing the Export Connector ..............................................................................................................................7
Setting Up Kofax Export Connector for TotalAgility for Kofax Capture ...............................................................8
Setting Up Kofax Export Connector for TotalAgility for Kofax Express ............................................................... 8
Modifying the Source Code .......................................................................................................................................... 9
Kofax Export Connector for TotalAgility Administrator's Guide
3
Contents
4
Kofax Export Connector for TotalAgility Administrator's Guide
This guide is intended to be used by the administrator who will install and set up Kofax
Export Connector for TotalAgility.
Overview
Kofax Export Connector for TotalAgility provides the capability for Kofax Capture or
Kofax Express to initiate a process or case in TotalAgility during the export step. The export
connector user interface includes the ability to map Kofax Capture values to process and case
initialization variables.
The export connector uses the Kofax value “Repository Document ID” to pass a reference to
the stored image into TotalAgility.
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.
Administrator's Guide
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.
▪ Access to support tools
Kofax Export Connector for TotalAgility Administrator's Guide
5
Administrator's Guide
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.
Installing the Export Connector
You can install this export connector on a Kofax Capture client workstation or standalone
workstation, a computer with Kofax Express installed, or on a computer with both programs
installed.
To install the export connector, you must have Windows administrator privileges. If you do
not have administrator privileges when attempting to install this export connector, you may
receive error messages and several of the files may not install correctly.
Important Kofax Express must not be running during the installation process.
In the location you extracted KofaxExportConnector-1.1.0_For_TotalAgility.ZIP
1
file, in the \Installation folder, run the installer kec-bpm.msi.
When the installation wizard appears, follow the instructions.
2
When the installation is complete, a message appears that indicates the export connector
was successfully installed. Installing the export connector automatically registers it with
Kofax Capture or Kofax Express. However, if you install the connector on a computer
where both Kofax Capture and Kofax Express are installed, the connector will register
with Kofax Capture only. In this situation, follow the instructions in the Kofax Express
Help to add and register the connector with Kofax Express. Repeat this procedure on all
computers that will use the export connector.
Removing the Export Connector
Use the following procedures to remove the export connector from Kofax Capture or Kofax
Express and from your computer.
Removing the Export Connector from Kofax Capture
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.
6
Kofax Export Connector for TotalAgility Administrator's Guide
Administrator's Guide
In the Export Connector Manager window, select the export connector, and click
2
Remove.
Removing the Export Connector from Kofax Express
Removing the Export Connector from a Job
On the Job Setup tab, in the Export group, verify that the connector is not associated with
any unprocessed jobs. If necessary, assign another connector to a job.
Removing the Export Connector Registration
Verify that you have completed processing for all jobs that require the export connector.
1
You cannot unregister a connector that is assigned to an existing job.
On the Kofax menu, click Options.
2
The Options window appears.
On the Options window, click Export Connectors.
3
On the Export Connectors list, select the name of the connector to unregister, and click
4
Remove.
The Export Connectors list is refreshed, and the export connector is no longer available
for use with Kofax Express.
Removing the Export Connector from Your Computer
You can use Control Panel options to remove the export connector, or you can follow these
instructions:
Run the .msi file that was 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.
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
When complete, a message appears to indicate the export connector was successfully
repaired.
Kofax Export Connector for TotalAgility Administrator's Guide
7
Administrator's Guide
Setting Up Kofax Export Connector for TotalAgility for Kofax Capture
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 documents.
Start the Kofax Capture Administration module.
1
On the Batch tab, expand the batch class to select associated document classes. Then,
2
right-click the applicable document class.
On the displayed menu, select Export Connectors.
3
The Export Connectors window lists all available export connectors. Available export
connectors are those that are registered with Kofax Capture.
Under Available Export Connectors, select TotalAgility Export Connector and click Add.
4
In the Setup window, specify the settings for exporting documents:
5
URL
The address of the server where the TotalAgility web services are located. For example,
http://<hostname>/PlatformManagerWs/PlatformManagerWs.asmx where:
<hostname> is the host name of the TotalAgility server
and
PlatformManagerWs/PlatformManagerWs.asmx is the virtual path to the TotalAgility
Platform Manager Web service.
Replace the default “localhost” with the host name of your TotalAgility server.
User name
The user name required to connect to the TotalAgility server.
Note The user must be a TotalAgility user that already exists or was created in
TotalAgility's console. There is no password required because validation takes place at
TotalAgility.
Setting Up Kofax Export Connector for TotalAgility for Kofax Express
Once you create a job, you can select and setup the export connector.
Start Kofax Express.
1
On the Job Setup tab, in the Connector list, click TotalAgility Export Connector.
2
Click the setup tool.
3
The login window appears.
In the setup window on the TotalAgility tab, specify the settings for connecting to the
4
TotalAgility server:
URL
The address of the server where the TotalAgility web services are located. For example,
http://<hostname>/PlatformManagerWs/PlatformManagerWs.asmx where:
<hostname> is the host name of the TotalAgility server
8
Kofax Export Connector for TotalAgility Administrator's Guide
and
PlatformManagerWs/PlatformManagerWs.asmx is the path to the connection file.
Replace the default “localhost” with the host name of your TotalAgility server.
User name
The user name required to connect to the TotalAgility server.
Note The user must be a TotalAgility user that already exists or was created in
TotalAgility's console. There is no password required because validation takes place at
TotalAgility.
Complete the setup for the other tabs. Click Help on any tab for details about individual
5
settings.
When you finish with the setup, click OK.
6
Modifying the Source Code
The source code is provided for the export connector on the Kofax Capture installation media.
The source code can be opened, edited, and compiled in Microsoft Visual Studio 2010 or later.
For assistance, see the Microsoft Visual Studio documentation.
Administrator's Guide
Install this export connector. Refer to Installing the Export Connector for the installation
1
instructions. When you install the export connector, you will install the required
components referenced in the source code.
In the location where you extracted the
2
KofaxExportConnector-1.1.0_For_TotalAgility.zip file, in the \Source folder,
locate the KofaxExportConnector-1.1.0_For_TotalAgility_Source.zip file. Copy
the file to an appropriate location on your workstation and extract the file contents.
Open, make any desired modifications, and compile the export connector source code in
3
Microsoft Visual Studio.
Copy the files in the \Target\Release\Bin\Kofax.Connector.TotalAgility folder to
4
the installation folder.
When you are prompted to replace the existing file, select Yes.
Repeat this procedure on each Administration and Export workstation that will be using the
export connector.
Kofax Export Connector for TotalAgility Administrator's Guide
9
Administrator's Guide
10
Kofax Export Connector for TotalAgility Administrator's Guide
Loading...