Kofax Business Interaction Server User Manual

KOFAX

Business
Interaction
Server

Component

Installation Guide

10300690-000 Rev A

© 2008 Kofax Image Products, Inc., 16245 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. For information on
third-party software included in this product, see BISTHIRDPARTYLICENSEREADME.txt,
which is in the Documentation folder where Kofax Business Interaction Server is installed
(usually C:\Program Files\Kofax\Business Interaction Server).

THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS
OF KOFAX IMAGE PRODUCTS, INC. USE, DISCLOSURE OR REPRODUCTION IS
PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF KOFAX
IMAGE PRODUCTS, INC.

Kofax Image Products, Kofax, and the Kofax logo are trademarks or registered trademarks of
Kofax Image Products, 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
Image Products, 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

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Introducing the Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Kofax Business Interaction Server Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Ascent Capture Add-ins Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Product Compatibility Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Installing Kofax Business Interaction Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Kofax Business Interaction Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Kofax Template Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Installing Ascent Capture Add-ins Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

What Next? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Starting and Stopping the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Using the Status Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Using the Services Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Viewing the Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Upgrading Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Uninstalling Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Changing, Repairing, or Removing Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Kofax Business Interaction Server Component Installation Guide iii

iv Kofax Business Interaction Server Component Installation Guide

Overview

Introduction

This installation guide provides an overview of the Kofax Business Interaction Server
components and how they work together, and installation instructions for each
component. This information will help you plan your installation and understand
how to set up the system to meet your needs.

In addition to this guide, there are several configuration guides and Help that provide
the information you need after the components are installed.

Product Overview

With Kofax Business Interaction Server, you can respond to customer documents
(orders, invoices, etc.) released into Ascent Capture or being validated in the Ascent
Xtrata Pro Validation module. You can provide the customer with a confirmation or
notification email or fax, described below.

 A Confirmation is an email or fax message to a customer with informational

content, such as when an order is received. A confirmation is triggered when an
Ascent Capture batch is released.

 A Notification is an email or fax message requiring some action on the

customer’s part, such as to provide missing data that is required before an order
can be processed. A notification is triggered in the Ascent Xtrata Pro Validation
module when missing data or some other error is detected.

Introducing the Components

The product consists of two main parts: the Kofax Business Interaction Server and the
Ascent Capture Add-ins, each of which consists of several components as described
below. Towards the end of each description recommended installation plan
instructions are preceded by two asterisks **. A possible installation plan is illustrated
in Figure 1.

Kofax Business Interaction Server Components

 Business Interaction Server

The application server and components that run the workflows, apply the
correct templates, and send the confirmations and notifications to the customer.
**Install on a dedicated server.

Kofax Business Interaction Server Component Instal lation Guide 1

Important Business Interaction Server installs with a default concurrent user
site license and an evaluation license that is valid until 15 September, 2008. The
license adds the line “This is a trial version of Business Interaction Server” to the
footer of each confirmation and notification message: When you install a
production license the footer is not added.

 Template Designer

An application to create “templates” that control the look, layout, and content of
the email or fax confirmation and notification messages.
**Install on a computer where it can be used by the person designing templates
and that can connect to the Business Interaction Server via http.

 Component Documentation

The documentation for the Business Interaction Server components.
**Install where Adobe Reader and a Web browser are installed, so the welcome
screen, Help, and PDF documentation can be viewed.

 Sample Databases

Optional sample databases that can be used to perform data lookup. See the
Kofax Business Interaction Server Configuration Guide for information about data
lookup.

 Sample Templates

A growing collection of sample templates that you can open and explore in
Kofax Template Designer while you learn how to create your own templates.
**Install where you can access the samples from the Kofax Template Designer
application. By default, sample templates are installed in C:\Program
Files\Kofax\Business Interaction Server\Avalin\SampleTemplates.

 Fax Connectors

Required to send fax confirmations or notifications through a TOPCALL or a
RightFax server. See the Kofax Business Interaction Server Configuration Guide for
information about configuring fax connectors.
**Install on the same computer as the Business Interaction Server.

Note To send messages through a RightFax server, you need RightFax FaxUtil
installed on the computer where the RightFax fax connector (RWS) is installed.

Ascent Capture Add-ins Components

 Release Script

An Ascent Capture release script that triggers a confirmation workflow when an
Ascent Capture batch is released.
**Install on the Ascent Capture Server.

 Ascent Xtrata Pro Validation Add-in

An Ascent Xtrata Pro Validation module plug-in where the validation operator
can trigger a notification workflow.

2 Kofax Business Interaction Server Component Installation Gui de

**Install where Ascent Xtrata Pro Validation is installed and where you want to

Ascent Capture Server

Release Script

Configuration Utility

Business Interaction Server Kofax Template Designer

Ascent Xtrata Pro Validation

Ascent Xtrata Pro Validation Add-in

Kofax Business Interaction Server

Ascent Capture Add-ins Components

generate notifications.

 Configuration Utility

A BIS menu for configuration is added to the Ascent Capture Administration
module menu bar.
**Install on the Ascent Capture Server.

Figure 1. An Installation Plan

Kofax Business Interaction Server Component Instal lation Guide 3