You are on page 1of 233

InputAccel 5.

3 ®

Installation and Configuration Guide


InputAccel Installation and
Configuration Guide
with Licensing overview

Version 5.3
© Copyright 2007 EMC Corporation. All rights reserved.
EMC2, Captiva, AdvantEdge, ClaimPack, ClaimsEditor, ClaimsEditor Professional, FormWare, InputAccel, InputAccel Express, ISIS and
PixTools are registered trademarks, and CodeLink, Digital Mailroom, Dispatcher, eInput, FirstPass, and QuickScan Pro are trademarks of
EMC Corporation. All other trademarks used herein are the property of their respective owners.
EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.
The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with respect to the
information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use,
copying, and distribution of any EMC software described in this publication requires an applicable software license.

Document number: install.pdf - 5.3 (GS 04-May-2007) ENU


Contents

About this guide 1


Intended audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Notation conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Suggested reading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 1
System requirements and recommendations 5
Installation Overview 6
InputAccel Server requirements and recommendations 8
InputAccel Server software requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
InputAccel Server recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
InputAccel client module requirements and recommendations 12
InputAccel client software requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
InputAccel module recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
ECM Web Service requirements and recommendations 16

iii
Network recommendations 17

Chapter 2
Upgrading InputAccel 21
Overview 22
Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
An InputAccel Upgrade Plan 23
Upgrade Phase 1: Preproduction Testing and Acceptance . . . . . . . . . . . . . . . . . . . . . . . . 24
Upgrade Phase 2: Upgrading InputAccel Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Upgrade Phase 3: Upgrading InputAccel clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Upgrade Phase 4: Taking Advantage of New Product Features. . . . . . . . . . . . . . . . . . . . 26
InputAccel Server Upgrade Procedure 26
InputAccel Client Upgrade Procedure 28
Upgrading Scan workstations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Upgrading FileNet Panagon IS/CS Compatible Export . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Upgrading Documentum Server Compatible Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
InputAccel Server Rollback Procedure 31
InputAccel Client Rollback Procedure 35

Chapter 3
Installing the InputAccel Server 39
Understanding installer concepts 41
Special information for the installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Installing the InputAccel Server 43
Installing InputAccel Server interactively . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Installing the InputAccel Server silently . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Removing the Hardware Security Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Upgrading an existing InputAccel Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Installing on an NTFS vs. FAT partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Selecting the type of installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Granting the “Act as part of the operating system” right . . . . . . . . . . . . . . . . . . . . . . . . . 49
Enabling automatic server startup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Proceeding with InputAccel Server setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Attaching the hardware security key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Modifying the InputAccel Server TCP port assignment . . . . . . . . . . . . . . . . . . . . . . . . . 51
Firewall settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Installing a ScaleServer group of InputAccel Servers 52
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
ScaleServer-compatibility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

iv
ScaleServer licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
ScaleServer registry configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
ScaleServer functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Setting up a ScaleServer group 73
Don’t forget to restart the servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Setting up multiple ScaleServer groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Synchronizing ScaleServer registry entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Setting up InputAccel in an MSCS cluster 77
Setting up InputAccel Server in an MSCS cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Setting up a ScaleServer group with MSCS clustered servers . . . . . . . . . . . . . . . . . . . . . 81
Setting up the EMC Captiva Input Management Console in an MSCS cluster . . . . . . . . 81
Installing Audit Extensions 84
Configuring InputAccel to enable auditing functionality . . . . . . . . . . . . . . . . . . . . . . . . . 86
Information logged by the InputAccel server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Modifying server installations 88
Modifying server installations interactively . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Modifying server installations silently . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Removing server installations 88
Repairing server installations 89
Viewing server installation log files 89
Additional security for the InputAccel Server 90

Chapter 4
Installing client modules 93
Before installing InputAccel modules 94
Installing the InputAccel Server first . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Installing scanner drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Modifying the Services file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Updating your InputAccel shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Installing modules on the Administrator workstation. . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Understanding client installer concepts 96
Special information for the client installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Using the installer in standard interactive mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Using the installer in silent mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Installing InputAccel client modules 98
Installing InputAccel client modules interactively . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Upgrading your InputAccel client installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Installing base InputAccel modules silently . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Connecting to an InputAccel Server Running Microsoft XP SP2 with Firewall . . . . . . 104
Installing third-party software used by InputAccel . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

v
Modifying client installations 105
Modifying base client installations interactively . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Modifying base client installations silently . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Removing client installations 106
Repairing client installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Automating silent installation 106
Viewing client installation log files 107
Viewing the user-specified log file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Chapter 5
Activating the InputAccel Server 109
Activating the InputAccel Server on a single computer using an activation file . . . . . . 110
Switching to an activation file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Activating an InputAccel Server on an MSCS Cluster using an activation file . . . . . . . 111

Chapter 6
Common Installation Topics 115
Special information for the installer 116
Silent Installations 117
Silent installation mode information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Using the installer in silent mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Modifying silent installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Modifying the Services file 122
Modifying Installations 123
Removing Installations 123
Removing the InputAccel Server and client modules interactively . . . . . . . . . . . . . . . . 124
Repairing Installations 124
Repairing the InputAccel Server and client modules interactively . . . . . . . . . . . . . . . . 124
Viewing Log Files 125
Reading Log Files 126

Chapter 7
Licensing InputAccel 129
Installing license codes 130
ScaleServer licensing 130

vi
Server licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
ScaleServer Client licenses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
ScaleServer registry configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Understanding license fields 134
Understanding license types 136
Daily licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Group Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Periodic licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Service bureau licenses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Universal client license. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Calculating page counts 142

Chapter 8
Configuring InputAccel 145
Defining users and groups 146
Choosing an InputAccel Server startup mode 147
Choosing a startup mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Running the InputAccel Server manually 149
Running client modules as services 150
Starting a module as a service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Installing a module as a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Configuring the service wait time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Uninstalling a module as a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Granting the “Act as part of the operating system” right 157

Chapter 9
Maintaining InputAccel 159
Testing the performance of the InputAccel Server 160
Reassessing the storage requirements of an InputAccel Server . . . . . . . . . . . . . . . . . . . 164
Tips for increasing the performance of an InputAccel Server 165
Backing up the InputAccel Server 168
The IAS directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
The IAS\batches directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
The IAS\activation directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
The IAS\process directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
The IAS\modules directory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
The registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
License files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

vii
Backing up InputAccel clients 174
The win.ini file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
The Index module's validation DLL and ActiveX DLLs . . . . . . . . . . . . . . . . . . . . . . . . 176
Modified process source code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Scanner drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
PSG customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Shortcut Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Troubleshooting during production 178
The InputAccel Server disconnects during long process times . . . . . . . . . . . . . . . . . . . 178
The InputAccel Server will not start. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Appendix A
Command-line instructions 181
Supported InstallShield switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Supported MSI switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Supported MSI properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
InputAccel client feature names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Appendix B
InputAccel Server registry values 199
Adding or modifying server registry values 199
Server registry values 202
Backing up and restoring server registry values 214

Index 217

viii
About this guide

Intended audience

This guide is designed for the system administrator in charge of installing and
maintaining InputAccel Server and InputAccel features on a TCP/IP network.
This guide:
„ Defines the system requirements and gives recommendations for the
computer running InputAccel Server and the workstations running
individual modules.
„ Highlights tasks that you need to perform before installing InputAccel
Server and client modules.
„ Explains procedural steps for upgrading, installing, and configuring
InputAccel Server and client modules, and for creating user accounts.
„ Outlines basic steps for running, maintaining, and troubleshooting the
system.

1
Installation and Configuration Guide

Notation conventions

Table 1: Notation conventions


This table describes the notation conventions used in EMC Captiva user guides.

Convention Description Example


Bold print Used to format option, From the File menu, select New
command, and label Batch.
names.
Indicates that the user At the prompt, type: c:\program
must type the text files\inputaccel\client\binnt\iaipi.e
exactly as shown. xe.

Greater than Separates cascading From the Windows Start menu, select
symbol (>) menu options. Programs > InputAccel > Scan.

Italics Used to format place You can specify a domain name


holders. following the syntax: domain\user.
Indicates emphasis. Do not use ODBC calls in your IPP.

Italics and Used to format term Production mode is the mode in


bold print definitions. which the module processes your
batches.

Mono-spaced Used to format code p.Scan.OutputImage =


font samples and variables. p.Index.InputImage

Suggested reading

In addition to assuming that all readers possess a working knowledge of


Microsoft® Windows® conventions, this guide also assumes that the readers
are familiar with the InputAccel Server and InputAccel client/server

2
About this guide

architecture and product terminology. For more information about products in


the InputAccel family, see:
„ The Process Developer Help, which describes how to plan, create, and
test an InputAccel process.
„ The Administrator Module Help, which describes how to create a batch
based on a custom or preinstalled InputAccel process.

3
Installation and Configuration Guide

4
1
Chapter

System requirements and


recommendations
This chapter includes the following sections outlining the system
requirements and recommendations for running various InputAccel features:
Installation Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
InputAccel Server requirements and recommendations . . . . . . . . . . . . 8
InputAccel Server software requirements . . . . . . . . . . . . . . . . . . . . 8
InputAccel Server recommendations . . . . . . . . . . . . . . . . . . . . . . . 9
InputAccel client module requirements and recommendations. . . . . . 12
InputAccel client software requirements . . . . . . . . . . . . . . . . . . . 12
InputAccel module recommendations. . . . . . . . . . . . . . . . . . . . . . 13
ECM Web Service requirements and recommendations . . . . . . . . . . . 16
Network recommendations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

5
Installation and Configuration Guide

Note: If you are upgrading any existing module to version 5.3, or want to use any
version 5.3 module, then you must upgrade your InputAccel Server to version 5.3.
EMC Captiva supports use of clients from one prior version (InputAccel version
5.2) connecting to the version 5.3 InputAccel Server. For more information on
upgrading from an earlier version, see Chapter 2, “Upgrading InputAccel,” on
page 21.

Installation Overview
Following are the steps required to install a complete InputAccel system. You
should perform the steps in this order to ensure a smooth and trouble-free
installation.
1. Check system requirements for the InputAccel Server and client
workstations.
„ For server requirements, see “InputAccel Server requirements and
recommendations” on page 8.
„ For client requirements, see “InputAccel client module requirements
and recommendations” on page 12.
2. Install (or upgrade) the InputAccel Server(s)
„ Upgrade each of the InputAccel Server in your facility by following
the instructions in “InputAccel Server Upgrade Procedure” on page
26.
or
„ Install your InputAccel Server or ScaleServer group of servers by
following the instructions in Chapter 3, “Installing the InputAccel
Server,” on page 39.
3. Install the client software
The desired InputAccel client software should now be installed (or
upgraded from an earlier version) on each workstation. You may choose
to install all modules, or just selected modules. For example, if you are
only going to perform image processing on a particular workstation, then

6
Chapter 1: System requirements and recommendations

you may want to only install the Image Enhancement module on that
workstation.
„ To upgrade, “InputAccel Client Upgrade Procedure” on page 28.
„ To install new modules, see Chapter 4, “Installing client modules,” on
page 93 for full information.

Note: You must be logged on as an administrator or a member of the


Administrators group in order to successfully install the client and server
software.

4. Install the security key


Each InputAccel Server requires a security key in order for licensing to
function properly. This key is either a hardware key (for a parallel port or
a USB port) or an activation file (.caf file).
If you use a hardware key, then it must be placed on the InputAccel
Server's parallel port or USB port as explained in “Attaching the hardware
security key” on page 50.
If you use an activation file, then see Chapter 5, “Activating the
InputAccel Server,” on page 109.

7
Installation and Configuration Guide

InputAccel Server requirements and


recommendations
This section lists the system requirements and recommendations for the
computer running the InputAccel Server.

InputAccel Server software requirements


The InputAccel Server is a Microsoft Windows application. You may install
each InputAccel Server on:
„ Microsoft Windows Server 2003 with SP1.
„ Microsoft Windows 2000 Server/Advanced Server with Service Pack 4
or later.
„ Microsoft Internet Explorer version 4.0 or later for viewing on-line help
In low-volume environments only, you may install InputAccel Servers on:
„ Microsoft Windows 2000 (Server and Workstation) with Service Pack 4
or later.
„ Microsoft Windows XP Professional with Service Pack 21 with Data
Execution prevention support
„ Microsoft Internet Explorer version 4.0 or greater for viewing on-line
help
„ Microsoft Internet Explorer version 5.5 or greater for using the ECM
Web Service Importer module’s web-based configuration mode.

Note: EMC Captiva recommends using the “Server” versions of the Windows
products whenever possible to provide maximum performance.

1. InputAccel Server is supported by Microsoft Windows XP Service Pack 2 with Data Execution
prevention support. InputAccel Server cannot be installed on Windows XP Home Edition.

8
Chapter 1: System requirements and recommendations

InputAccel Server recommendations


For best performance, we highly recommend dedicating a single Windows
2000, or Windows Server 2003 to run each InputAccel Server. Due to the way
Windows switches tasks, running additional modules on the same computer as
the InputAccel Server can result in a significant performance drop, even if the
additional modules do not use much CPU time. Further recommendations are
listed in the following sections.

Processors
In high volume environments, we recommend running your InputAccel
Servers on dual processor systems. The InputAccel Server software can use
one processor while Windows runs on the second processor—this gives more
CPU time to the InputAccel Server software. Note that the InputAccel Server
software does not benefit greatly from more than two processors.
An ideal computer to use in this environment would be a dual 2.8 GHz (or
faster) processor system with 20KB of level 1 cache and 512KB of level 2
cache (or more). Furthermore, an ideal system would be a server-type system
that includes a hot-swappable storage backplane for multiple disk drives, is
rack mountable, and includes options for remote system management.
The minimum recommended server is a Pentium II 450 MHz with 128MB
RAM. Refer to the Microsoft Windows 2000/XP/Server 2003 system
documentation for additional recommendations and information.

Parallel or USB port


The InputAccel Server can use either a hardware security key or an activation
file (without using a physical hardware security key) to control the licensing
of the InputAccel system. If your InputAccel Server will be using a hardware
security key, then you should be aware that hardware security keys are
available that connect to the parallel port or USB port.

9
Installation and Configuration Guide

Disk systems
The speed of the InputAccel Server file system often proves to be the most
important performance characteristic in high volume InputAccel installations.
There are many high-end disk controllers and disk systems that should
provide excellent performance. Rather than focus our testing and
recommendations on specific disk controller options, we instead offer some
tips in purchasing and configuring the disk system for the best performance
for InputAccel.
We recommend that you use trusted and reliable suppliers of disk system
components. For high volume systems you should buy the equipment that
promises to deliver the highest performance. The drives should be high RPM,
high capacity, Ultra/Wide SCSI-3 units. The disk controller(s) should include
hardware-level support for RAID 0+1, provide on-board disk caching of at
least 32MB, allow for Write-Back (write to RAM) caching, and provide
battery-backup for the on board cache.
In the InputAccel environment, RAID 0 (data striping) offers considerably
higher performance than RAID 5 (redundant parity drive) systems. If data
redundancy is a concern, then we recommend using RAID 0 in combination
with RAID 1 (mirrored data). Often this is referred to as RAID 0+1. Use of
native NTFS mirror sets, stripe-set, or stripe-set with parity configurations
(available through Windows 2000/Server 2003 Disk Management, or
Windows XP Professional Disk Management) are not recommended.
The disk controller card should be configured to use Write-Back caching
rather than Write-Thru caching. Write-Thru caching slows disk I/O by waiting
until after data has been physically written to disk before completing a write
operation. With Write-Back caching, the I/O operation completes almost
immediately as the controller card caches the write operation in it's own RAM
so that it can be written to disk at a more convenient time.

10
Chapter 1: System requirements and recommendations

RAM
The more RAM the better, but 1.5GB is a good starting place for higher
volume installations. For lower volume installations, 256-512 MB of RAM
should be suitable.
As the load on the system increases, you should use the Windows
Performance Monitor (see page 160) to track how often the InputAccel Server
software swaps to disk and to track free memory resources while the system is
running.
Note: The InputAccel Server machine needs to have as much RAM as the
likely peak of total virtual bytes (this includes other programs running on the
machine).

11
Installation and Configuration Guide

InputAccel client module requirements and


recommendations
This section lists the system requirements and recommendations for the client
computers running InputAccel modules.

InputAccel client software requirements


The InputAccel modules are Microsoft Windows applications. You may run
InputAccel clients on:
„ Microsoft Windows Server 2003 with SP1.
„ Microsoft Windows XP Professional with Service Pack 21 with Data
Execution prevention support.
„ Microsoft Windows 2000 Operating System, with Service Pack 4 or
later
„ Microsoft Internet Explorer version 4.0 or later for viewing on-line help

Note: In addition to the requirements listed here, the Values to XML


module also requires Microsoft Internet Explorer 5.01 with Service Pack
1 or later installed on the same workstation as Values to XML.

In addition to the requirements listed above, attended InputAccel client


modules must be run on a workstation whose monitor has a minimum screen
resolution of 1024 x 768.

1. InputAccel client modules are supported by Microsoft Windows XP Service Pack 2 with Data Execution
prevention support. InputAccel client software cannot be installed on Windows XP Home Edition.

12
Chapter 1: System requirements and recommendations

InputAccel module recommendations


All version 5.3 InputAccel modules should be run on the InputAccel Server
version 5.3 or higher. Although the version 5.3 modules may operate without
error on earlier versions of the InputAccel Server, we have not tested, nor do
we support, this type of configuration. We strongly recommend that you
upgrade your InputAccel Server to version 5.3 before you install and run any
version 5.3 InputAccel modules.
The recommendations provided below can be used to assist you in specifying
new systems for purchase. If you will be using existing computers as
InputAccel client workstations, then each must meet or surpass the minimum
supported configuration: 300 MHz Pentium, 64 MB of RAM, 300 MB of
available disk space, Windows 2000 SP4, Windows XP Professional SP2, or
Windows Server 2003 SP1.
The tasks that InputAccel modules perform are categorized into CPU-
intensive and less CPU-intensive groups to help you properly match computer
power to module tasks.

CPU-Intensive modules
The following tasks and modules are CPU-intensive:
„ Scanner control (Scan and Rescan)
„ Image Enhancement
„ Optical Character Recognition (PrimeOCR for InputAccel, Scansoft®
OCR for InputAccel)
„ Automatic Quality Assurance
Unattended modules can scale to single or multiple processor systems. Most
of these scale by allowing multiple copies of the module to run at once which
can take advantage of extra processors on a single workstation. Other
modules, like PrimeOCR for InputAccel, can be licensed so that a single copy
can take advantage of multiple CPUs.
Single-processor computer recommendations
„ 3.06 GHz Pentium® 4 or equivalent/better

13
Installation and Configuration Guide

„ 256 - 512 MB RAM


„ Minimum 300 MB of free disk space
„ High speed video controller
„ CD-ROM drive
Multiple-processor computer recommendations
„ 2.0 GH or equivalent/better quad processor system
„ 1 - 2 GB RAM
„ Minimum 500 MB of free disk space
„ CD-ROM drive
Note: Most InputAccel client modules receive images and data from the
InputAccel Server and process this data without using the file system of the
client computer. Therefore, it is usually not necessary to purchase high
performance disk controllers or hard drives to get excellent performance on
client computers.

Less CPU-Intensive tasks


The following tasks and modules are less CPU-intensive:
„ Exporting1
„ Indexing
„ Image Quality Assurance
„ PDF verification
„ Administrator module
We recommend the following for the computers running less CPU-intensive
modules:
„ 1.7 GHz Pentium Celeron or equivalent/better
„ 128 MB1 RAM, minimum
„ Minimum 300 MB of free disk space

1. The IBM Content Manager for Multiplatforms Compatible Advanced Export module, requires 256MB
RAM, minimum.

14
Chapter 1: System requirements and recommendations

„ CD-ROM drive.

Additional Scan module requirements


In addition to the standard software and hardware required for all InputAccel
client modules, there are additional system requirements that you must
consider for a scanning workstation. The throughput of the scanning device
that is used with InputAccel should be taken into account when matching it to
the host Scan client. We recommend that you use the table below as a
guideline for minimum hardware requirements for the system. If you will be
importing images from file only, then estimate at what rate you expect to
import the files and match that to the system requirements in the table.

Note: For information about the scanners and SCSI adapters that we support, see
out Pixel Translations web site at: www.pixtran.com.

Table 2: Minimum requirements for scanning workstations

ISIS Driver Throughput (IPM, Minimum Minimum


Level images per minute) Pentium CPU RAM
Level 1 up to 20 IPM (binary) 300 MHz 64 MB

Level 1 up to 20 IPM (color) 450 MHz 96 MB

Level 2 up to 50 IPM (binary) 300 MHz 64 MB

Level 2 up to 50 IPM (color) 900 MHz 128 MB

Level 3 up to 100 IPM (binary) 450 MHz 64 MB

Level 3 up to 100 IPM (color) 1.2 GHz 256 MB

Level 4 over 100 IPM (binary) 600 MHz 96 MB

Level 4 over 100 IPM (color) 2.4 GHz 512 MB

15
Installation and Configuration Guide

ECM Web Service requirements and


recommendations
If you will be using the ECM Web Service Importer module (for example to
route rescan requests from a Documentum Server back to InputAccel), you
must install Microsoft Internet Information Services (IIS) on the system that
will host the web service. In general, you will need only one web server per
InputAccel installation, regardless of the number of servers and client
workstations in use.
The IIS installation that hosts the ECM Web Service Importer module may be
installed on a separate workstation or on the same computer that is hosting an
InputAccel Server or any InputAccel clients. However, because the
InputAccel Client libraries must also be installed on the same system as IIS,
you must install IIS on one of the supported systems. See “InputAccel Server
requirements and recommendations” on page 8 and “InputAccel client
module requirements and recommendations” on page 12 for a list of system
requirements.) Refer to Microsoft IIS documentation to determine its system
requirements and recommendations.
In most cases, you can install IIS on an existing system by choosing Add or
Remove Programs from Windows Control Panel and then selecting the
Add/Remove Windows Components button.

Notes:
„ IIS must be installed and running before you can install the ECM Web Service
Importer module. In addition, support for ASP pages must be enabled on IIS.
„ The workstation(s) that will be used to configure the ECM Web Service
Importer module must have Microsoft Internet Explorer version 5.5 or higher.

After completing installation of the ECM Web Service Importer module,


additional work is necessary before it can be used. Unless you are using this
module with Documentum Client version 5.3 SP3 which includes the required
functionality, you must design a client application that can communicate via
Web Service Description Language (WSDL) to the ECM Web Service
Importer to pass the necessary information to InputAccel for processing.

16
Chapter 1: System requirements and recommendations

More information on how to do this can be found in the ECM Web Service
Importer Help (iaws.chm)

Network recommendations
Most InputAccel client modules move images and data across network
connections to and from the InputAccel Server. Depending on the number of
workstations you have installed and the number of images you are processing,
the network bandwidth required can be significant. Your goal should be to
design a network that keeps your particular InputAccel implementation
working at peak throughput. We recommend that you consider the following
when determining how much bandwidth you need:
„ Size of image files being transferred. The size of each image
transferred depends on many things: Color depth, compression format,
width and height of the image, resolution, and image content (because
content dictates actual compression factors).
„ Number of image files being transferred per unit of time. If you
have one Scan workstation, three Index workstations, two OCR
workstations, and an Export workstation, then you need to consider that
each image file goes from Scan to the InputAccel Server, then from the
InputAccel Server to an Index module (usually only one Index module
per image unless you have a multi-stage indexing workflow), and
perhaps from each Index module back to the InputAccel Server (if the
operator modifies the image by, for example, rotating it). Next, each
image file is routed from the InputAccel Server to one of the OCR
modules and the resulting document file (but not the image) is routed
back to the InputAccel Server. Finally the images and OCR’d text, plus
the data values that have been collected during processing are sent from
the InputAccel Server to the Export module. You must therefore
multiply your network bandwidth requirements by a factor of 3 or 4, or
more (depending on your workflow), to accommodate the image data
that needs to be transferred, and consider how this bandwidth will affect
the throughput of each module.

17
Installation and Configuration Guide

„ Network overhead. A 100 megabit-per-second network connection


does not transfer 100 megabits of user data per second, because
networks do not simply transfer raw data. The net throughput is
somewhat less after factoring in packaging, addressing, framing, start
and stop bits, and error correction, plus such things as dealing with
collisions on transmissions and the background communication that is
always occurring between network nodes. All of this overhead reduces
the actual data throughput by 20% and sometimes more.
„ Network adapter auto-configuration. Some network cards and many
routers and switches, as well as other networking equipment, are “auto-
sensing” and automatically configure themselves to the lowest-speed
device on the network. For example, if you have an auto-sensing
network card in your workstation and a 10 Mbit/second print sever, then
the network card will most likely configure itself to the 10 Mbit/second
speed. To ensure you are getting the throughput you paid for, you
should not use this auto-sensing configuration. Go to Windows Device
Manager, find your Network Adapter, and check its Link Speed and
Duplex settings in the Advanced tab. You should select the highest
speed and full duplex operation to achieve the highest throughput.
Because of the cost/benefit ratio and the relative low cost of network
hardware (compared with the cost of other system components and the labor
associated with using a document capture system), you should install a 1000
Mbit/second (1 GB/second) network for high-volume applications. (If you are
using InputAccel Express or InputAccel Capture for Documentum, or
otherwise have a system throughput of less than 50,000 pages per day, then a
100 Mbit/second network should be more than sufficient.)
The following network configuration is recommended for use with
InputAccel Servers:
„ Protocol
Microsoft TCP/IP Protocol included with the Windows 2000/XP/Server
2003 operating system. Both server and client software are compatible
with Dynamic Host Configuration Protocol (DHCP) services.

18
Chapter 1: System requirements and recommendations

„ System traffic
We recommend that you set up the InputAccel system as a discrete sub-
network isolated from other Local Area Network (LAN) applications
and traffic, particularly if you have a high volume environment together
with high network utilization. In these cases, connect the InputAccel
network to your main network through a switching hub or a router.
Segmenting InputAccel from the rest of your network prevents the rest
of your network from causing InputAccel performance problems and
vice versa.

Note: Use static IP addresses with your InputAccel Server computer(s) to reduce
the chances of unresolved machine names that can occur when dynamic IP
addresses are used.

Note: If any workstations in your InputAccel system are running Microsoft


Windows XP, then they must be configured to use “classic file sharing.” If they are
configured to use “Simple File Sharing” user interface, then client logons become
unreliable and the Point.Click.Scan! interface of the Scan module will not function
properly.

Note: Because InputAccel Servers exchange information with modules via


TCP/IP, you do not need to configure the InputAccel Servers as file servers.

19
Installation and Configuration Guide

20
2
Chapter

Upgrading InputAccel
If you already have an earlier version of InputAccel, InputAccel Express, or
InputAccel Capture for Documentum® running in your organization, then
you should read this chapter to determine the best way to upgrade your
installation to the latest version of InputAccel. If you installing InputAccel for
the first time, then you should skip this chapter and proceed to Chapter 3,
“Installing the InputAccel Server,” on page 39.
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
An InputAccel Upgrade Plan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
InputAccel Server Upgrade Procedure . . . . . . . . . . . . . . . . . . . . . . . . 26
InputAccel Client Upgrade Procedure. . . . . . . . . . . . . . . . . . . . . . . . . 28
InputAccel Server Rollback Procedure . . . . . . . . . . . . . . . . . . . . . . . . 31
InputAccel Client Rollback Procedure . . . . . . . . . . . . . . . . . . . . . . . . 35
In addition to the upgrade procedures, this chapter:
„ Provides rollback procedures to assist you with removing the latest
version and reverting back to the version you are currently using.
„ Includes a suggested upgrade plan to help you organize, prepare, and
implement your InputAccel upgrade in a careful and methodical
manner.

21
Installation and Configuration Guide

Overview
The intent of the following upgrade plan is to provide you with a realistic
procedure that takes into account unexpected problems or difficulties in a
manner that can help minimize the impact on your operations. Though EMC
Captiva has focused considerable attention to assuring that this latest version
of InputAccel upgrades your existing configuration without error, unexpected
problems may still occur.

Note: Mixing modules from different versions of InputAccel, InputAccel Express,


InputAccel Capture for Documentum, or Documentum DocInput is not
recommended or supported. For example, you should not run Image Enhancement
version 4.0 and Image Enhancement version 5.3 within the same InputAccel
system, either on the same or on different workstations. Specifically, we do not
support upgrading from the previous release of the full InputAccel product to
InputAccel Express 5.3, since this will leave older modules that have not been
tested with the latest Runtime and PixTools DLLs. If you currently are
running the full InputAccel product in your organization, then we
recommend that you install InputAccel Express on separate workstations that
do not contain the full InputAccel product.
To help ensure that all client modules have been upgraded, you can set the
RequireLatestClient registry value to 1 on the InputAccel Server. This will
prevent modules from previous versions of InputAccel from connecting to the
InputAccel Server. See page 211 for more information on this registry value.

Definitions
The following definitions are used in this chapter:
„ InputAccel Server
Any name for the InputAccel Server that has been used in earlier
versions, such as InputAccel Express Server, Documentum DocInput
Server, InputAccel Enterprise Server, or InputAccel Capture Server for
Documentum.

22
Chapter 2: Upgrading InputAccel

„ IAS
The default name of the InputAccel Server directory. This is the
location of your processes, batches, and other special InputAccel files.
Note: The user account that runs the InputAccel Server must have
Administrator rights to this directory.
„ IAS.EXE
The name of the executable program that runs the InputAccel Server.
This executable file is always installed in the C:\Program Files\
InputAccel\Server\Binnt directory.
Note: Before attempting to install InputAccel 5.3, you must manually
uninstall version 4.0 and below server installers by using the Add /
Remove Programs utility in the Control Panel.
„ Major Base version
The number in the first field of a version number. For example, if the
version number for a component was 5.3.37, then “5” is the major base
version number.
„ Minor Base version
The number in the second field of a version number. For example, if the
version number for a component was 5.3.37, then “3” is the minor base
version number.

An InputAccel Upgrade Plan


The goal of this plan is to help assure that your upgrade of InputAccel or
InputAccel Capture for Documentum is successful and minimizes risk to your
operations. To further ensure success, the Professional Services Group at
EMC Captiva is available to provide onsite assistance with product upgrades.
The suggested plan has four main phases:
1. Pre-production testing and acceptance
2. Upgrading the InputAccel Server

23
Installation and Configuration Guide

3. Upgrading the InputAccel clients


4. Learning about and taking advantage of the new features in the upgraded
software

Upgrade Phase 1: Preproduction Testing and Acceptance


Upgrade your InputAccel test environment first. Run your acceptance tests
using your existing InputAccel processes and documents. Proceed to the next
step in the plan only when you achieve the expected results from your existing
processes and documents.

Upgrade Phase 2: Upgrading InputAccel Server


Prepare for this phase of your production upgrade by:
1. Carefully selecting the day of the week to perform your production
InputAccel Server upgrade.
For example, if your production shifts normally run five days a week,
then you may want to consider upgrading your InputAccel Server the
night before the last production day of the week. This will give you a full
day of production load on the new software with two days of non-
production recovery time to resolve any problems that occur.
2. Preparing for a rollback by making sure the installation media for all
InputAccel software currently being used in production is readily
available in case a reinstall becomes necessary.
3. Shutting down your InputAccel operations immediately before the
upgrade and making a backup of the \IAS directory or the whole system.
Upgrade only your InputAccel Server by following the “InputAccel Server
Upgrade Procedure” on page 26. Continue production without upgrading the
clients. If you encounter a serious problem, then immediately contact
InputAccel Support before you decide to abort the upgrade. It is likely they
may already have a solution for your problem. You can also check EMC
Captiva’s online resources for assistance.

24
Chapter 2: Upgrading InputAccel

If your InputAccel Server is still not operating reliably, then follow the
“InputAccel Server Rollback Procedure” on page 31, abort the upgrade plan,
and be sure to inform InputAccel Support of your problem.

Upgrade Phase 3: Upgrading InputAccel clients


Prepare for the third phase of your production upgrade by:
1. Carefully selecting the day of the week to perform your production
InputAccel Client upgrade.
2. Preparing for a rollback by making sure the installation media for all the
InputAccel software being used in production is readily available in case
a reinstall becomes necessary.
3. Confirming that the upgraded InputAccel Server is working as expected
in production.
Upgrade all of your InputAccel client workstations at one time by following
the “InputAccel Client Upgrade Procedure” on page 28. Upgrading some
clients and not others may cause inconsistent results in processing. For
example, the upgrade may provide an improved OCR algorithm in a module
you are using on several client workstations. If you only upgrade some of
these, then the results of processing a given image may depend on which
workstation happened to receive the task.
If you encounter problems with upgraded client workstations, then be sure to
contact InputAccel Support to report the issue and seek assistance. If you
continue to have problems that may seriously affect production, then follow
the “InputAccel Client Rollback Procedure” on page 35 and inform
InputAccel Support of your problem.

Note: After upgrading from any version of InputAccel, new exporters or modules
are not installed. To install any new exporter or module, you must run the installer
again and select Modify/Repair the InputAccel Client Install.

25
Installation and Configuration Guide

Upgrade Phase 4: Taking Advantage of New Product


Features
This phase of your upgrade enables you to begin taking advantage of new
product features in your upgraded InputAccel software. Prepare for this final
stage of your production upgrade by:
1. Learning about the new features in the upgrade.
2. Training administrators and operators to correctly use the features either
through reading the user documentation or taking formal product
refresher courses from EMC Captiva. The InputAccel Refresher course
provides hands-on training for new product features.
3. Incorporating and testing the new features in your InputAccel Test
environment.
4. Confirming that the fully upgraded production InputAccel system is
working acceptably and that the likelihood of performing a rollback
procedure appears to be minimal.
Taking advantage of new functionality in the upgraded version should be the
last objective of your upgrade plan. Implementing this phase will most likely
introduce changes to your InputAccel environment that are were not
supported in your previous version. Processes that use new functionality and
batches based on those processes will not be compatible with earlier versions
of InputAccel and will make the rollback process more difficult and
complicated.

InputAccel Server Upgrade Procedure


Follow the steps in this procedure to upgrade your InputAccel Server,
InputAccel Express Server, Documentum DocInput Server, or InputAccel
Capture Server for Documentum.

26
Chapter 2: Upgrading InputAccel

Step1: Record the InputAccel Server version number


Using Windows Explorer, find IAS.EXE in the <Windows>\system32
directory on the server system for InputAccel version 5.1 and below. Select
this file and display its Properties dialog. On the Version tab, note the File
Version number in case it is needed at a later time for the rollback procedure.
This will be a number such as 5.1.19.2.

Step 2: Gracefully disconnect all client modules


Use the Administrator or Supervisor module to view the InputAccel Server
Connection List. After all client modules have disconnected, proceed to the
next step.

Step 3: Stop the InputAccel Server


If the InputAccel Server is running as a Windows Service, then stop the
service as follows:
1. Open a Command Prompt window: Start > Run: cmd.exe
2. At the command prompt, type: net stop inputaccel
3. After a number of seconds, the command displays the following message:
“The InputAccel service was stopped successfully”
4. Type exit at the command prompt to close the Command Prompt window.
If the InputAccel Server is running as an interactive console application, then
stop it by switching to its window and typing:
quit

Step 4: Install the new InputAccel Server


Follow the instructions in the Chapter 3, “Installing the InputAccel Server,”
on page 39 to install the InputAccel Server software.

27
Installation and Configuration Guide

InputAccel Client Upgrade Procedure


Follow the steps in this procedure to upgrade all of your InputAccel,
InputAccel Express, Documentum DocInput, or InputAccel Capture for
Documentum client modules.

Note: You must be logged on as an administrator or a member of the


Administrators group in order to successfully install the client software.

Step 1: Ensure the InputAccel Server has been upgraded


With the exception of the Administrator module, running InputAccel modules
that have higher major and minor base version numbers than the major and
minor base version numbers of the InputAccel Server is not recommended or
supported. “InputAccel Server Upgrade Procedure” on page 26 provides a
recommended procedure for upgrading the InputAccel Server.

Step 2: Stop and close all InputAccel software running on the


workstation
1. Stop and close all InputAccel client modules that are running on the
workstation you are upgrading.
2. If you are also running your InputAccel Server on the same computer,
then follow steps 2 and 3 in the “InputAccel Server Upgrade Procedure”
on page 26 to stop the InputAccel Server.

Step 3: Install the new InputAccel client software


Follow the instructions in the Chapter 4, “Installing client modules,” on
page 93 to install the desired InputAccel client modules.

28
Chapter 2: Upgrading InputAccel

Upgrading Scan workstations


When you update your Scan workstations to the latest version of InputAccel,
note that the setup program does not automatically install new versions of
your existing scanner drivers. To update an existing scanner driver with the
newest version, or to install a new scanner driver at any time:
1. Insert the InputAccel CD and wait until after the main setup screen
appears. (If it doesn’t appear, then run setup.exe in the root directory of
the CD.)
2. Select Add a Scanner Driver. The Pick Scanner dialog appears.
3. Scroll down the list to find the desired scanner and select it. If desired,
you can use standard Windows key combinations to select multiple
scanners.
4. Select the OK button. If you selected multiple scanners, then the Pick
Default Scanner dialog appears. Select this scanner you normally want to
use on this workstation, then select OK. (If you only selected one scanner,
then the Pick Default Scanner dialog does not appear.)
5. If you see a message box displaying information about the scanner driver
being successfully installed, then select OK.

Upgrading FileNet Panagon IS/CS Compatible Export


If you are using the FileNet Export module from an InputAccel release prior
to 4.0, then you must follow these additional steps to use the newer version of
the module.

Note: The FileNet Panagon IS/CS Export module executable was renamed
when the new version was released to avoid interfering with processes and
batches based on the old version. The old version was named iaexfnet.exe;
the new version is named iaxfnet2.exe.

Follow these steps to upgrade any processes that include FileNet Export:
1. If you haven’t already done so, obtain and install a license for iaxfnet2.

29
Installation and Configuration Guide

2. Change your IPPs to include an instance of iaxfnet2.mdf in place of each


instance of iaexfnet.mdf.
3. Recompile and install the process.
4. Set up the new process. You can copy the instance settings from the old
process for all module instances except FileNet Export. You will need to
set up the new FileNet Export module from scratch.
5. Create new batches based on the new process and process those batches
using the new FileNet Panagon IS/CS Export module.

Upgrading Documentum Server Compatible Export


If you are upgrading an existing Documentum Server Compatible Export
workstation, you should be aware of the following important points:
„ InputAccel version 5.3 deploys a new version of EMC Documentum
Server Export (previously known as Documentum e_Content Server
Compatible Export).
„ This new version requires that you install Documentum Client version
5.3 SP1, SP2, or SP3 prior to installing the Documentum Server Export
module. If you do not update the Documentum Client software, the
InputAccel Client Setup program will not update the Documentum
Server Export module.
„ The new version of the Documentum Server Export module is
completely compatible with your existing InputAccel processes and
batches, and it has an identical user interface. No changes in your
workflow are needed.
„ The new version of the Documentum Server Export module adds native
support for Documentum Business Processes created by Documentum’s
Business Process Manager (BPM).
„ The new version of the Documentum Server Export module can process
“rescan” tasks. These are documents that have been flagged for
rescanning within the Documentum workflow after they have been
exported from the InputAccel Server. Rescan tasks are routed back to
InputAccel by the ECM Web Service Importer module. Unless you are
using Documentum Server v. 5.3 SP3, you must design your own client

30
Chapter 2: Upgrading InputAccel

application to communicate with the ECM Web Service Importer


module.
„ The workstation(s) that will be used to configure the ECM Web Service
Importer module must have Microsoft Internet Explorer version 5.5 or
higher.

InputAccel Server Rollback Procedure


Follow the steps in this procedure to remove an upgraded InputAccel Server
and revert to a previously installed version of InputAccel Server, InputAccel
Express Server, Documentum DocInput Server, or InputAccel Capture Server
for Documentum. This procedure will completely remove the InputAccel
Server and all previous versions from the system while leaving your
InputAccel files and data intact. You will then reinstall the earlier version.

Step 1: Clear incompatible batches and processes


Before reverting to an earlier version of InputAccel Server, you must remove
any batches or processes that may be incompatible with the earlier version. To
determine whether or not a batch or process might be incompatible, use the
following tests:
„ Was the process recompiled using the Process Developer from the new
client version?
„ Were instances in the process set up with modules from the new client
version?
„ Was the batch based on a process that met either of conditions above?
„ Were any instances in the batch set up with modules from the new client
version?
If you answered “yes” to any of these questions, then the affected batch or
process should be cleared by completing its processing (if possible) and
deleting it before proceeding.

31
Installation and Configuration Guide

Step 2: Remove the InputAccel Server from a ScaleServer group


If the InputAccel Server you are rolling back has been added to a
ScaleServer™ group of servers, and if the rollback version base number is
lower than that of the other InputAccel Servers in the ScaleServer group, then
remove the server from the group before uninstalling it. Use the Administrator
module to remove the server from the ScaleServer group. Refer to the
Administrator Module Online Help (iaadmin.chm) and the ScaleServer
Overview (sclsvovr.chm) for more information.

Step 3: Ensure client modules will be compatible with the earlier


InputAccel Server
The InputAccel Server base versions must always be the same or higher than
the InputAccel client module base versions. The only exception is the
Administrator module. If you have upgraded your InputAccel clients, then
you must rollback your client modules to base versions that are compatible
with the earlier InputAccel Server prior to performing the next step. See
“InputAccel Client Rollback Procedure” on page 35 for more information.

Step 4: Gracefully disconnect all client modules


Use the Administrator or Supervisor module to view the connection list to the
InputAccel Server. After all client modules have disconnected, proceed to the
next step.

Step 5: Stop the InputAccel Server


If the InputAccel Server is running as a Windows Service, then stop the
service as follows:
1. Open a Command Prompt window: Start > Run: cmd.exe
2. At the command prompt, type: net stop inputaccel
3. After a number of seconds, the command displays the following message:
“The InputAccel service was stopped successfully”
4. Type exit at the command prompt to close the Command Prompt window.

32
Chapter 2: Upgrading InputAccel

If the InputAccel Server is running as an interactive console application, then


stop it by switching to its window and typing:
quit

Step 6: Back up modified sample process files


When you uninstall the current InputAccel Server, the uninstaller will remove
any sample process files (*.iap) files that it installed. (Process files you
created will not be removed.) If you need to preserve any modified sample
process files, then copy those files to a backup directory before continuing.
See Table 3 on page 37 for more information.

Step 7: Back up other InputAccel Server data


Although this procedure has been verified to not delete batches or batch data,
if you have mission-critical InputAccel data on this system, then you make a
full or InputAccel-specific backup of the system before continuing to the next
step. For more information on identifying files that should be backed up, see
Table 3 on page 37. Back up the items in this table that are identified as being
used by the Server.

Step 8: Uninstall the InputAccel Server


Follow the instructions in “Removing Installations” on page 123 to remove
the InputAccel Server.

Step 9: Uninstall earlier InputAccel Servers


After completing Step 8, uninstall any remaining InputAccel Servers that may
still be present from earlier installations. Find these by checking the list of
installed applications in the Add/Remove Programs applet of the Windows
Control Panel.

Note: Check for and remove any applications with the following names:
InputAccel Server, InputAccel Express Server, Documentum DocInput Server,
InputAccel Enterprise Server, or InputAccel Capture Server for Documentum.
Remove them in the reverse order they were installed.

33
Installation and Configuration Guide

Step 10: Reinstall the earlier InputAccel Server version as well as


patches and service packs
Reinstall the previous InputAccel Server version by following the installation
instructions included with the software. In most cases, these instructions will
be found in the Installation and Configuration Guide included with the
software.
Complete the installation by installing any InputAccel Server patches or
service packs.
Confirm you have installed the correct InputAccel Server by comparing the
InputAccel Server version number that you recorded in Step 1 of the
“InputAccel Server Upgrade Procedure” on page 26.

Step 11: Restore original registry settings


Locate the file in the \IAS directory named Reg_date_time.txt, where date
specifies the date you upgraded the InputAccel Server you just removed, and
where time specifies the approximate time you upgraded. This is a backup file
the setup program created to document the original registry settings before the
installation.

Note: There may be multiple copies of this file if you have installed InputAccel
Server more than once—make sure you select the correct one.

Use REGEDIT.EXE to restore the InputAccel Server registry parameters to


the indicated value. You will find these registry keys in:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
Services\InputAccel\Parameters
For more information on how to modify InputAccel Server registry values,
see Appendix B, “InputAccel Server registry values,” on page 199.

Step 12: Start or restart the InputAccel Server


The InputAccel Server is now ready to be used. If the InputAccel Server was
already running when you modified the registry settings, then you must stop
and restart it to make those settings take affect.

34
Chapter 2: Upgrading InputAccel

InputAccel Client Rollback Procedure


Follow the steps in this procedure to remove a newer installation of the
InputAccel client modules and revert to a previously installed version of the
InputAccel, InputAccel Express, Documentum DocInput, or InputAccel
Capture for Documentum client modules.

Step 1: Stop and close all InputAccel software running on the


workstation
1. Stop and close all InputAccel client modules that are running on the
workstation you are upgrading.
2. If you are also running your InputAccel Server on the same computer,
then follow steps 2 and 3 in the “InputAccel Server Upgrade Procedure”
on page 26 to stop the InputAccel Server.

Step 2: Back up InputAccel client data.


Although this procedure has been verified to not remove user modified
InputAccel files, if you have mission-critical InputAccel data on this system,
then you make a full or InputAccel-specific backup of the system before
continuing to the next step. For more information on identifying InputAccel
files that should be backed up, see Table 3 on page 37. Back up the items in
this table that are identified as being used by the Client.

Step 3: Uninstall the InputAccel client modules


Follow the instructions in “Removing Installations” on page 123 to remove
the InputAccel client modules.

Step 4: Complete client removal by running CLEANIA.BAT


Note: Skip this step if you are running the InputAccel Server on this system,
otherwise you will need to repair the InputAccel Server installation after using
CLEANIA.BAT.

Use CLEANIA.BAT (CDROM:\utils\cleania.bat) from the command


prompt to ensure that all newer InputAccel files are removed before you

35
Installation and Configuration Guide

continue. Run CLEANIA.BAT with no command-line parameters to display


information on how to use it.

Note: Run CLEANIA.BAT from a command prompt window, not by double-


clicking it in Windows Explorer. Display a command prompt window, then switch
to the drive where your installation media is located (typically, your CD-ROM
drive). Then change to the Utils directory and type:
cleania ClientDirectory
For example, if you installed to the default directory (C:\Program
Files\InputAccel\Client), then at a command prompt you would type:
cleania “c:\program files\inputaccel\client”

Step 5: Reinstall earlier InputAccel client software, patches, and


service packs
Reinstall the previous InputAccel client software (including InputAccel
Express, Documentum DocInput, or InputAccel Capture for Documentum) by
following the installation instructions included with the software. In most
cases, these instructions will be found in the Installation and Configuration
Guide included with the software.
Complete the installation by installing any InputAccel client patches or
service packs.

36
Chapter 2: Upgrading InputAccel

Table 3: Irreplaceable InputAccel Files and Data


InputAccel file types and data that may change during the use of the product. These are the files
and data that you should back up, because they are irreplaceable if lost.

Data Type Used By Default File Location Description


Activation files Server \ias\activation\*.* Files used by activation
file

Module Client \program May be modified by


Definition Files (Process files\inputaccel\client\src\ipp\*. process writers.
Developer) mdf
\program
files\inputaccel\client\pcf\*.mdf

Integrated Client \program Typically created or


ProcessFlow (Process files\inputaccel\client\src\ipp\*.i modified by process
Projects Developer) pp writers.

Index Client \program May be modified to


Validation files\inputaccel\client\src\iaidxv customize how the Index
Source al\*.* module populates and
queries index fields.

Process Client \program InputAccel version 3.0


Configuration files\inputaccel\client\pcf\*.pcf and earlier may have
Files process files written in
the old PCF language.

WIN.INI Client <windows>\win.ini May be modified to tune


module behavior.

Batches and Server \ias\batches\*.* All in-process data


Stage files (images, intermediate
files, and other batch
data). Be aware that there
may be a large amount of
data.

37
Installation and Configuration Guide

Table 3: Irreplaceable InputAccel Files and Data (continued)


InputAccel file types and data that may change during the use of the product. These are the files
and data that you should back up, because they are irreplaceable if lost.

Data Type Used By Default File Location Description


Processes Server \ias\process\*.iap All processes that have
been used to create
batches. Users will have
installed their own
processes as well as
modified included
sample processes.

Supplemental Server \ias\modules\*.* Some client modules


Module store shared
Configuration configuration files such
Files as templates, reference
images, or other data files
in this location on the
InputAccel Server.

Registry Server HKEY_LOCAL_MACHINE\S Users may have modified


Parameters YSTEM\CurrentControlSet\ the InputAccel Server
Services\InputAccel\ registry settings to tune
Parameters server side operation.

Global Server Server \ias\values.idx Not applicable


Database

38
3
Chapter

Installing the InputAccel


Server
This chapter explains how to install a single InputAccel Server as well as
multiple InputAccel Servers configured as a ScaleServer group
To install InputAccel features, insert the CD-ROM into your computer. (If you
downloaded InputAccel, then run setup.exe in the top-level installation
directory where you unzipped the files.)
The installation program starts and displays the main setup window, similar to
the one shown in Figure 1 on page 40. This window displays links to various
installation programs that install the InputAccel features.

Note: To upgrade from, or downgrade to a previous version of InputAccel, see


Chapter 2, “Upgrading InputAccel,” on page 21.

39
Installation and Configuration Guide

Figure 1: InputAccel main setup window

Depending on which InputAccel features you wish to install, select one of the
product links, then follow the instructions that are provided by the program
and in the following sections of this guide:
Understanding installer concepts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Installing the InputAccel Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Installing a ScaleServer group of InputAccel Servers. . . . . . . . . . . . . 52
Setting up InputAccel in an MSCS cluster . . . . . . . . . . . . . . . . . . . . . 77
Installing Audit Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Modifying server installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Removing server installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Repairing server installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Viewing server installation log files . . . . . . . . . . . . . . . . . . . . . . . . . . 89

40
Chapter 3: Installing the InputAccel Server

Understanding installer concepts


InputAccel uses InstallShield® to perform certain setup operations and to
launch the Microsoft Installer (msiexec.exe), which installs, modifies,
removes, and repairs the InputAccel Server. The installer can be used in
either:
„ Standard mode - displays the full user interface (see “Installing
InputAccel Server interactively” on page 43 for more information),
„ Silent mode - uses instructions typed on a command line or as part of a
batch file and displays no user interface (see “Using the installer in
silent mode” on page 118 for more information).
You must install at least one InputAccel Server. If you are configuring
multiple InputAccel Servers into one or more ScaleServer groups, then you
must perform an InputAccel Server installation on each of the server
computers that will be a part of the group. A ScaleServer group is a group of
interconnected InputAccel Servers that have been configured to work together
as a single information capture system.

Special information for the installer


Please review the following information before using the installer in either
standard or silent installation mode to install the InputAccel Server:

Server user rights


„ The user account that runs the InputAccel Server must have
Administrator rights to the IAS directory.

Server information
„ Before attempting to install InputAccel 5.3, you must manually
uninstall version 4.0 and below server installers from by using the
Add/Remove Programs utility in the Control Panel.

41
Installation and Configuration Guide

For more general information for the installer, see “Special information for
the installer” on page 116.

USB hardware security key information


„ If you are using a USB hardware security key, then you must remove it
before running the InputAccel Server setup.exe, and then reattach it
when you finish server installation, before rebooting. The InputAccel
installation program reminds you to do both of these operations at the
appropriate times.
The USB hardware security key must be removed so that the server
setup program can install new drivers. Reattaching the hardware
security key after finishing setup causes the computer to sense the new
device and configure the new drivers.

Notes:
„ You should wait approximately 60 seconds after attaching the hardware
security key for your computer to sense the new device and perform the
necessary configuration. If Windows prompts you with multiple driver
options, then select the default option to use the driver found by
Windows.
„ It is safe to remove and reattach the USB hardware security key while
the computer is powered on.
„ You need not remove/reattach a parallel hardware security key, and can
install it either before or after server software installation.

„ Your USB hardware security key should display a green light when it is
plugged in. If your Server ID shows 0, then you may need to ensure that
your USB port is enabled.
„ USB 1.0 support may be disabled in your computer’s BIOS. If you are
using a USB 1.0 device (a USB hub, for example), then you must
enable USB 1.0 support in the BIOS before InputAccel will recognize
your hardware security key.

Silent installation mode information


See “Silent Installations” on page 117 for more information about silent
installation mode information.

42
Chapter 3: Installing the InputAccel Server

Installing the InputAccel Server

Installing InputAccel Server interactively


Standard interactive installation mode prompts you step-by-step through the
installation process. This is the default and recommended installation method
for most users.
To use the installer in this mode, run setup.exe with no command-line options
or select InputAccel Server from the InputAccel main setup window (Figure
1 on page 40), then:
1. Follow the instructions that appear to complete the installation. Informa-
tion in the sections beginning with “Removing the Hardware Security
Key” on page 43 will help you make informed decisions about how to
proceed through the installation.
2. Be sure to reboot when prompted. The InputAccel Server will not
function until after you have rebooted your computer.

Installing the InputAccel Server silently


Silent installation mode processes all instructions without displaying a user
interface.
See “Using the installer in silent mode” on page 118 for more information.

Removing the Hardware Security Key


Whether you are installing the InputAccel Server for the first time or
upgrading your existing InputAccel Server, the setup program will remind
you that you must remove a USB hardware security key before continuing.

43
Installation and Configuration Guide

Disregard this instruction if you have a parallel port hardware security key
installed, if you have not yet attached any hardware security key, or if you will
be using an InputAccel Captiva Activation File (.caf).
If you are using a hardware security key, then the InputAccel Server requires
that you attach either a parallel port or USB port hardware security key to run.
However, during setup the USB port hardware security key must be removed;
otherwise necessary drivers will not be properly installed or updated.

Figure 2: Identifying parallel (background) and USB (foreground) hardware security keys

Upgrading an existing InputAccel Server


If you are not upgrading your InputAccel Server from a previous version, then
the instructions in this section do not apply to you. Proceed to “Installing on
an NTFS vs. FAT partition” on page 47.
If you are upgrading the InputAccel Server from a prior version, then you can
choose how you would like to handle the system registry settings that the
InputAccel Server uses during processing. The dialog appears when necessary

44
Chapter 3: Installing the InputAccel Server

and prompts you to select one of three options for optimizing your registry
settings.

Note: Before Setup changes any registry settings, the current settings are saved to
a text file in the IAS directory. The name of the file includes the date (mdyyyy
format) and the time (hhmmss format) the file was created (e.g.,
reg_9102003_075245.txt).
If you want to revert to your old registry settings, then you can use the information
provided by this file to manually change your registry settings. For more
information about manually changing your registry settings, see “Adding or
modifying server registry values” on page 199.

Note: Before upgrading your InputAccel Server, we strongly urge you to read and
follow the procedures in Chapter 2, “Upgrading InputAccel,” on page 21.

„ Optimize settings (recommended)


This recommended option enables Setup to adjust your current registry
settings in order to enhance performance with this version of the
InputAccel Server.
„ Use new default settings, where applicable
This option to allows Setup to reset all of the registry settings to their
new default values. Any settings that you have changed from the default
values will be reset. For more information about default settings for
registry values, see “Server registry values” on page 202.
„ Preserve old settings, where possible
This option instructs Setup maintain your current registry settings
except the mandatory settings needed for this version of the InputAccel
Server. In this case the registry value DiskReserveK will be increased to
a new higher minimum as needed. If the Flags registry value has not
been set, then it will be set to the default value (2097153/0x200003). If
Flags is presently set in the registry, then Setup will add the “no
compact” value (2097152/0x200000) to the current value. (For more
information about the new default value for DiskReserveK, see
“DiskReserveK” on page 208. For more information about the Flags
registry value, see “Flags” on page 210.)

45
Installation and Configuration Guide

Updated registry values


The following table lists each registry value that may be affected by a server
upgrade, the new default setting for the registry value, the value set during a
new InputAccel Server installation, and the recommended changes to the
registry value during a server update.

Registry value New installation Updated installation

BatchGrowSizeK Not set No change

DiskReserveK 153,600 KB If less than 153,600 KB, then overwrite


with 153,600 KB.
If already 153,600 KB or greater, then no
change.
Flags 0x200003 Add (OR) in 0x200000.

BatchMaxLoaded 65 (batches) Update to 65 (batches).


If already 65 or greater, then no change.
EventLogLevel 0x93 Updated only if you choose to use new
default settings.
„ DiskReserveK
As of InputAccel Server version 4.0.102, the BatchGrowSizeK registry
value has been eliminated and the DiskReserveK registry value now
specifies the amount of disk space reserved for batches.
During testing, we discovered that even during the most robust tests,
batches grew by no more than 100 MB. Therefore, setting the
DiskReserveK registry value to 150 MB allows for very large batches
without taxing the system.

Note: You can manually set the DiskReserveK registry value to greater than
the 150 MB default value. See “Adding or modifying server registry values”
on page 199 for more information.

„ Flags
If it hasn’t already been updated, then the Flags registry value is
changed to add the “no compact” value (2097152 / 0x200000) to the
“trigger if empty” value (1 / 0x01) to produce the new default value
(2097153 / 0x200003). This change significantly reduces server startup

46
Chapter 3: Installing the InputAccel Server

time. See “Server registry values” on page 202 for more information
about this registry value.
„ BatchMaxLoaded
Because the InputAccel Server can more efficiently create smaller
batches than in earlier version, more batches can be processed without
impacting the performance of the server. The default for the
BatchMaxLoaded registry value is now 65 batches. This, along with the
other enhancements to the InputAccel Server, enables you to have up to
65 batches loaded at any time without degrading system performance.
Note that if you manually tuned your registry values (see “Adding or
modifying server registry values” on page 199 for more information)
and have set the BatchMaxLoaded registry value to be greater than 65,
then Setup will not alter this setting.
„ EventLogLevel
Previously, Error, Warning, and Success events were logged by default.
Beginning with version 5.0, the default setting includes Audit Failure
events as well, primarily to catch repeated login failures when an
unattended module is attempting to connect to one or more servers
unsuccessfully. Such errors may be due to improperly-specified user
credentials in the module startup command parameters.

Installing on an NTFS vs. FAT partition


One of the first things the InputAccel Server setup program checks during a
new installation is whether or not you are installing on an NTFS partition.
NTFS is the native file system for Windows 2000/XP/2003. It is more robust,
reliable, and secure than FAT or FAT32 (the native file systems for Windows
95/98/Me); however, Windows 2000/XP/2003 lets you choose to configure
each partition of your disk drives with either NTFS or FAT32.
If the InputAccel Server setup program detects that you are installing on a
non-NTFS partition, then it displays a warning. Although you are not required
to install your InputAccel Servers on an NTFS partition, we highly
recommend that you do. NTFS is essential to many of the security features of
the InputAccel Server. In the Destination Folders setup dialog, select
Change to choose a different installation location, if desired.

47
Installation and Configuration Guide

To determine which, if any, of your disk partitions are using NTFS, use the
Disk Management snap-in of the Computer Management dialog in the
Microsoft Management Console. (Refer to your operating system
documentation for instructions on how to display Disk Management.)
The Disk Management snap-in displays information for each partition of each
of your disks, including whether that partition is using NTFS or FAT32. (For
NTFS installation and disk partitioning instructions, refer to your Windows
Server Installation Guide or Help system.)

Note: It is possible to mount a non-NTFS partition so that it appears to be a


directory on an NTFS partition. If you install InputAccel Server (specifically the
IAS folder and all of its subfolders) to a non-NTFS partition that has been
mounted as an NTFS directory, then the setup program will not detect this and will
not display a warning. The installation will proceed normally; however, when
using the resulting installation, NTFS security features will not be available in the
InputAccel system. If you need the additional NTFS features, then be sure you are
installing the InputAccel Server on a true NTFS partition.
Regardless of where you locate the IAS folder, the user account that runs the
InputAccel Server must be granted Administrator rights to the IAS folder.

Selecting the type of installation


Next the InputAccel Server setup program prompts you to select the type of
installation you want. Select Complete if you want to install all server
features; select Custom if you want to choose among the server software,
documentation, sample processes, and the default performance monitor snap-
in. Follow the appropriate prompts to continue.

48
Chapter 3: Installing the InputAccel Server

Granting the “Act as part of the operating system” right


To run the InputAccel Server as an application (see “Enabling automatic
server startup” on page 49), you must log in as a user that has been granted the
“Act as part of the operating system” user right.
As setup proceeds, you can grant “Act as part of Operating System” user right
to:
„ Only the user installing InputAccel Server now
„ All users that are allowed to logon to this system
Choose whether to grant this right only to yourself or to all users who are
allowed to log into this computer, as desired.

Note: The users account(s) that run the InputAccel Server either as a service or as
an application must be granted Administrator rights to the IAS directory.

Note: We recommend that you grant this right to all users or at least to all users
who may need to be able to log into and interact with the InputAccel Server
workstation. If desired, you may grant this right after installation by following the
instructions in “Granting the “Act as part of the operating system” right” on page
157.

Enabling automatic server startup


The InputAccel Server can be run as either a service or an application. In most
cases, you should run the InputAccel Server as a service that automatically
starts when Windows is started. Generally, you will only want to run
InputAccel Server as an application when you are working with an
InputAccel Support Engineer to solve a problem.
As setup proceeds, the Start Service Automatically dialog will appear. In this
dialog, you can select if you want the InputAccel Server to be started as a
service automatically when the system starts.

49
Installation and Configuration Guide

In most cases, you should select Yes to enable automatic startup. You will still
be able to run the server manually if necessary by stopping the InputAccel
Server service and using a command prompt to run InputAccel Server as an
application.

Note: For more about running the InputAccel Server as a service vs. an
application, see “Choosing an InputAccel Server startup mode” on page 147.

Proceeding with InputAccel Server setup


After you have responded to all of the prompts, the setup program displays the
Ready to Install the Program dialog. Select Install to proceed, then wait while
files are copied and system settings are configured. When it finishes, the
InstallShield Wizard Completed dialog appears. If you want to view the
release notes (recommended), then select the Show the Readme check box;
clear the check box to skip this step.

Attaching the hardware security key


As a final step, the InputAccel Server setup program displays a dialog
reminding you that you may need to attach your security key if you haven’t
yet done so (or if you removed it as instructed when you started setup). If you
are using a Captiva Activation File (.caf) or a demonstration license, you do
not have to attach a security key. Otherwise, you must now attach the USB or
parallel port security key.

50
Chapter 3: Installing the InputAccel Server

Note:
If you are installing a USB hardware security key, then you must wait until after
you complete InputAccel Server setup before attaching it to the server; otherwise,
the USB security key drivers may not install properly. When prompted by the
message, attach the USB hardware security key to a free USB port. In a few
moments, Windows will detect the new device and locate the drivers that the setup
program installed.
If you are using a parallel hardware security key, then no special drivers are
needed-you can attach it either before or after server setup.
If you are using activation files within a ScaleServer group, then you should make
a note of which Server IDs correspond to which InputAccel Servers, because the
licenses on each server must correspond to its Server ID.

For complete instructions on the various ways to license and activate your
InputAccel Servers, see Chapter 5, “Activating the InputAccel Server,” on
page 109.
InputAccel Server installation is now complete.

Modifying the InputAccel Server TCP port assignment


The Services file contains Windows TCP (Transmission Control Protocol)
port assignments for your computer. For information about modifying the
services file, see “Modifying the Services file” on page 122.

Firewall settings
Some versions of Microsoft Windows enable the Windows Firewall by
default. You must either disable the Windows Firewall on the InputAccel
Server system or unblock the Windows Security Alert dialog.
„ To disable the Windows Firewall, refer to your operating system
documentation.
„ To maintain the Firewall but allow InputAccel to run, when InputAccel
Server starts, select Unblock in the Windows Security Alert dialog.

51
Installation and Configuration Guide

Installing a ScaleServer group of InputAccel


Servers
A ScaleServer group of InputAccel Servers consists of two or more individual
InputAccel Servers connected to the same network, and licensed and
configured to work together as a single information capture system.

Overview
ScaleServer™ is the EMC Captiva technology that combines multiple
InputAccel Servers into a single information capture system. ScaleServer
technology enables you to distribute your capture processing among two,
three, four, … up to eight InputAccel Servers.
To understand why ScaleServer technology is important, consider how a
single-server InputAccel system captures documents:

The single-server capture model


Without ScaleServer technology, a single InputAccel Server creates batches
and sends tasks from those batches to each InputAccel client module, as
specified by instructions encoded in the batch. As each module completes its
work, it sends the resulting data back to the InputAccel Server where it waits
until the appropriate module signals that it is available to perform the next
step of the document capture operation.
In this asynchronous, task-at-a-time environment, multiple copies of duplicate
modules can run on multiple client workstations providing scalability,
redundancy, and high peak throughput.
For example, if your scan, index, and image enhancement steps take one
fourth the time per task as your OCR step, then you can run four copies of the
OCR module on four separate client workstations to avoid getting behind on
the OCR step. Whenever an OCR client finishes its current task, the
InputAccel Server sends it another task. (Actually, the InputAccel Server

52
Chapter 3: Installing the InputAccel Server

usually sends several tasks to an available machine so that it has a queue of


tasks ready to process without waiting for network transfers.)
This single-server model provides a robust information capture system on the
client side, but leaves the server side of the system dependent on just one
InputAccel Server. This single InputAccel Server must remain on line and
must handle both the storage requirements and processing requirements of the
entire information capture workload because, without ScaleServer
technology, there is no way to expand the server side of an InputAccel system.
If the hardware or software of the InputAccel Server fails, or if a server needs
to be intentionally taken off-line to perform backups, maintenance, or
upgrades, then the entire work flow must come to a stop.

The ScaleServer capture model


With ScaleServer technology, two, three, or more InputAccel Servers work
together, sharing the work load in a single information capture system. For the
5.3 release of InputAccel, up to eight InputAccel Servers can be configured to
work together.
Each server manages its own batches and each client machine requests tasks
from all available servers. When a module finishes with a task, it sends the
task back to the InputAccel Server that “owns” it.
Multiple InputAccel Servers that are connected via ScaleServer technology
provide many benefits. Here are just a few:
„ Increased robustness - With its increased availability, an InputAccel
system that uses multiple servers can continue operating when a server
fails or is intentionally taken off line for maintenance or upgrades.
Client modules can log onto InputAccel Servers even when those
servers are not currently available. No longer is an unavailable
InputAccel Server a terminating issue for a client module.
„ Higher productivity - With tasks being sent to client workstations
from multiple InputAccel Servers, module wait time between arriving
tasks can be minimized providing a higher duty cycle for unattended
modules and less idle time for attended-module operators.
„ Real-time scalability - Bringing additional InputAccel Servers on-line
without stopping the entire document capture system keeps both
modules and their operators working productively at all times.

53
Installation and Configuration Guide

„ Load balancing - By allocating batches across multiple InputAccel


Servers, you can keep the load balanced across all servers.
„ Central control - By using the Administrator module, the InputAccel
system administrator can access and set up all modules, processes,
batches, and tasks on all InputAccel Servers.
Note: ScaleServer technology does not comprise a redundant or fail-
over system. Because a given batch may reside on only a single
InputAccel Server at any time, ScaleServer technology provides data
and process sharing, not data redundancy.

Configuring a ScaleServer system


When your InputAccel ScaleServer system is set up, multiple InputAccel
Servers are installed and connected within the same physical network. The
installation process for each InputAccel Server is exactly the same as if you
were installing a single InputAccel Server.
Then, to enable your individual InputAccel Servers to take advantage of
ScaleServer technology, they are configured as a ScaleServer group. A
ScaleServer group is two or more InputAccel Servers that have been licensed
and configured to operate together in a single information capture system.
You configure a ScaleServer group by using the Administrator module to set
up special server and client license feature codes and to make other
configuration settings, as explained in ScaleServer licensing.
Figure 3 on page 55 shows an example of how multiple InputAccel Servers
might be used in a typical ScaleServer configuration. (There are many other
ways to configure a ScaleServer group.) In this example, Scan modules (and
other non-ScaleServer-compatible modules) connect to InputAccel Servers
one at a time. Modules that are ScaleServer-compatible connect to all

54
Chapter 3: Installing the InputAccel Server

available InputAccel Servers in the ScaleServer group and receive tasks from
batches on each server.

ScaleServer group
InputAccel InputAccel InputAccel
Server 1 Server 2 Server 3

Operator alternates Operator


scanning between always scans
Server 1 and Server 2 to Server 3

Scan 1 Scan 2
ScaleServer-compatible
InputAccel client
workstations

Figure 3: Overview of typical ScaleServer configuration

ScaleServer-compatibility
As of InputAccel release 5.3, the modules listed in “ScaleServer-compatible
client modules” on page 56 have been tested and confirmed to be ScaleServer-
compatible. To an InputAccel operator running modules in production mode,
these modules work almost exactly as they have in previous releases: the
operator logs in, receives tasks, and processes them. The noticeable
differences include:
„ Multiple InputAccel Server names can be specified in the login dialog
or in a command-prompt login command. Operators will log into all
InputAccel Servers using a single user name and password.
„ An alert will appear if one or more of the specified InputAccel Servers
is unavailable when logging in, and the operator can choose to change
the server name list (in case a name was incorrectly typed) or proceed

55
Installation and Configuration Guide

(accepting tasks from the remaining servers and automatically


connecting to missing servers if and when they become available).
Other than these slight differences in connecting to InputAccel Servers,
operators will still receive tasks just as before—they need not be concerned
with which InputAccel Server sent them. When the task is finished, the
InputAccel system automatically sends it back to the same server that
originally sent it. Tasks are separated by unique BatchID, as explained in
“Ensures existing processes and batches are unique within the ScaleServer
group” on page 63.

Note: If one or more InputAccel Servers within a ScaleServer group


become unavailable—intentionally taken off-line for maintenance or
upgrades, or unintentionally taken off-line due to hardware or software
failure—then an operator who happens to be processing a task that was sent
from the now-unavailable server will finish the task, and the module will
silently discard the data that it cannot return to the server. When the server
again becomes available, the unfinished task is sent to the first available
module that can process it (assuming that the batch was not removed from
the server while it was off-line). The result is that an operator may realize
that he or she has processed the same task more than once.

ScaleServer-compatible client modules


For InputAccel version 5.3 and above, the following modules and utilities are
ScaleServer-compatible:
„ Image Enhancement
„ Index
„ Automatic Quality Assurance
„ Archive Export
„ Documentum® Server Compatible Export
„ EMC Documentum ApplicationXtender Compatible Export
„ FileNet® Content Manager Compatible Export
„ IBM® Content Manager ImagePlus® for OS/390® Compatible Export
„ IBM Content Manager ImagePlus for OS/390 Compatible Index

56
Chapter 3: Installing the InputAccel Server

„ IBM Content Manager CommonStore for SAP Comaptible Export


„ IBM CM Advanced Export
„ Image Export
„ iManage® WorkSite™ Server Compatible Export
„ Microsoft® SharePoint™ Portal Server 2003 Compatible Export
„ ODBC Export
„ Open Text® Livelink® Compatible Advanced Export
„ Page Registration
„ ScanSoft® OCR for InputAccel
„ Timer utility
„ Multi utility
„ Image utility

Non-ScaleServer-compatible client modules


InputAccel modules that are not ScaleServer-compatible function perfectly in
a ScaleServer group—by connecting to one InputAccel Server at a time.
For example, the Scan module is not ScaleServer-compatible. It can only
connect to a single InputAccel Server at a time. You can use the Scan module
in a ScaleServer system in two different ways:
„ Periodically connect to a different InputAccel Server to create batches
on each server in the ScaleServer group.
„ Use multiple Scan workstations, each connected to an individual server
in the ScaleServer group.
In Figure 3 on page 55, you can see an example of both types of connectivity.
The operator of the Scan 1 machine alternates between creating batches and
scanning to each of InputAccel Server 1 and InputAccel Server 2, while the
Scan 2 operator remains connected to InputAccel Server 3 at all times.
Other InputAccel client modules that are not ScaleServer compatible can be
used in a similar way as Scan, either dedicated to a single InputAccel Server
or alternating connections among multiple InputAccel Servers in the
ScaleServer group.

57
Installation and Configuration Guide

Note: Only modules that are ScaleServer compatible and that have the
proper client license feature code can connect to multiple InputAccel
Servers in a ScaleServer group. If you specify multiple InputAccel Servers
when starting a module that is not ScaleServer compatible, then the module
will return error -6148: “This module is not supported in a multi-server
environment.”

ScaleServer licensing
ScaleServer uses a combination of licensing, server configuration parameters,
and technology in the InputAccel Servers themselves.

Note: InputAccel client modules cannot connect to multiple arbitrary


InputAccel Servers—they can only connect to multiple servers that have
been configured together as a ScaleServer group.

To configure a ScaleServer group, you must obtain server and client licenses
that enable the ScaleServer technology.

ScaleServer feature codes


Each InputAccel Server that is to become a part of a ScaleServer group must
have a license that uses feature codes to specify a number called the
ClusterBase. All InputAccel Servers that are to be configured within the same
ScaleServer group must have the same ClusterBase number, and this number
must be greater than or equal to the number of individual InputAccel Servers
to be included in the group. For example, if you want to configure four
InputAccel Servers within a single ScaleServer group, then ClusterBase must
be 4 or higher.
The ClusterBase number is set using server feature codes C through F as a
binary number, where F is the least-significant digit, as Table 4 on page 59
illustrates.

58
Chapter 3: Installing the InputAccel Server

Table 4: Feature codes to establish the ClusterBase value

ClusterBase Feature Codes that must be enabled


1 - - - - F

2 - - - E -

3 - - - E F

4 - - D - -

5 - - D - F

6 - - D E -

7 - - D E F

8 - C - - -

Note: A ClusterBase value of 1 is not useful--it enables a single InputAccel Server


in the ScaleServer group. This is equivalent to using a standalone InputAccel
Server.

Contact your authorized InputAccel sales or support representative to obtain


the required server licenses.

Note: Server feature codes are integral to the server license code. You cannot
arbitrarily change feature codes. If you need to change the ClusterBase number,
then you must contact your EMC Captiva sales or support representative to obtain
new license codes for each of your servers.

Client licenses
Each InputAccel client module that you want to use with multiple server
connections must have a license that specifies feature code X. (Each module
also must be one that is ScaleServer-compatible. ScaleServer-compatible
modules are listed in “ScaleServer-compatible client modules” on page 56.)

59
Installation and Configuration Guide

Contact your authorized InputAccel sales or support representative to obtain


the required module licenses.

Note: Module feature codes are integral to the module license codes. You cannot
arbitrarily change feature codes. If you do not have the proper licensing for
connecting your modules to multiple InputAccel Server in a ScaleServer group,
then you must contact your EMC Captiva sales or support representative to obtain
new license codes for the affected modules.

Note: No special licensing is required for modules that only connect to a single
server at a time, regardless of whether or not the modules are ScaleServer
compatible.

ScaleServer registry configuration


After you have installed all of your InputAccel Servers and configured them
with identical ClusterBase values through the server license feature codes,
you next must assign the servers to a ScaleServer group. You do this by using
the Administrator module. For details, refer to “Configuring ScaleServer
Groups” in Administrator Help.
Even though you use the Administrator module to configure ScaleServer
registry values, it can sometimes be important to know which registry values
are being set and what they mean; these issues are explained in the following
sections.

Registry values
There are two registry values associated with ScaleServer configuration:
Cluster and ClusterNumber.
„ Cluster
Making a ScaleServer group involves connecting to each of the
InputAccel Servers that are to be a part of the group, designating a
Group Name, and then adding each of the InputAccel Servers to the
group. The Administrator module writes a string value to the Windows
registry on each of the InputAccel Servers being configured named
“Cluster” that contains a semicolon-separated list of these items.

60
Chapter 3: Installing the InputAccel Server

GroupName;Server1;Server2;Server3;Server4
„ ClusterNumber
In addition to the “Cluster” value, each InputAccel Server in a
ScaleServer group must have a unique “ClusterNumber” registry value
greater than or equal to 0 and less than the ClusterBase established by
the servers’ license feature codes. The Administrator module also takes
care of this detail by ensuring that the ClusterNumber value is unique,
and by preventing you from adding more servers than your ClusterBase
allows.

Registry value location


The two registry values required by a ScaleServer group are stored in the
following key:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\
InputAccel\Parameters
Example:
Registry values for each of three InputAccel Servers that are to be part of the
ScaleServer group named “Eng”:
EngServer1
„ Cluster: Eng;Eng_Server1;Eng_Server2;Eng_Server3
„ ClusterNumber: 0
EngServer2
„ Cluster: Eng;Eng_Server1;Eng_Server2;Eng_Server3
„ ClusterNumber: 1
EngServer3
„ Cluster: Eng;Eng_Server1;Eng_Server2;Eng_Server3
„ ClusterNumber: 2
In addition, the ClusterBase value encoded in the license feature codes of each
server must be 3 (feature codes E and F) or higher.

61
Installation and Configuration Guide

Note: After you create or modify a ScaleServer group, all InputAccel


Servers that are a part of the group must be stopped and restarted before
your changes take effect.

ScaleServer functionality
ScaleServer technology uses several techniques to ensure maximum
productivity from your multi-server information capture system. This section
discusses the following points related to ScaleServer functionality:
Ensures existing processes and batches are unique within the ScaleServer
group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Ensures new processes and batches are unique . . . . . . . . . . . . . . . . . . 63
Ensures that batch values are unique . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Automatically duplicates non-batch-specific values . . . . . . . . . . . . . . 65
Enables modules to connect to multiple servers . . . . . . . . . . . . . . . . . 65
Permits connecting to unavailable servers. . . . . . . . . . . . . . . . . . . . . . 66
Facilitates command-line login to multiple servers. . . . . . . . . . . . . . . 67
Provides silent operation for unattended modules. . . . . . . . . . . . . . . . 67
Silently reconnects to disconnected servers . . . . . . . . . . . . . . . . . . . . 67
Requeues incomplete tasks when a server reappears . . . . . . . . . . . . . 68
Operates transparently in Run All Batches mode . . . . . . . . . . . . . . . . 69
Operates transparently in Run Single Batch and Open Batch modes . 69
Prefetches additional tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Ensures proper handling of IA Values . . . . . . . . . . . . . . . . . . . . . . . . . 70
Provides ScaleServer information in IA Values . . . . . . . . . . . . . . . . . 71
Handles licenses in a reasonable manner. . . . . . . . . . . . . . . . . . . . . . . 72

62
Chapter 3: Installing the InputAccel Server

Ensures existing processes and batches are unique within the


ScaleServer group
Each time you start an InputAccel Server that is part of a ScaleServer group,
the server performs a self-check for process and batch integrity. An existing
process or batch can only exist on one server, so the server checks its
ProcessIDs and BatchIDs and changes the IDs that do not follow the pattern
of:
n * ClusterBase + ClusterNumber
(where n is a positive integer)
Example
When you start up a server whose ClusterBase is 10 and whose
ClusterNumber is 3, its processes and batches will have IDs of 3, 13, 23, 33,
43, …
Example
When you start up a server whose ClusterBase is 4 and whose ClusterNumber
is 2, its processes and batches will have IDs of 2, 6, 10, 14, 18, 22, 26, …
The ScaleServer process and batch identification system not only ensures
processes and batches are unique, it also provides a mechanism to ensure that
tasks from each batch are returned to the InputAccel Server that “owns” them.

Note: BatchID is unique across multiple InputAccel Servers within a ScaleServer


group, but batch name may not be unique. When a batch is moved to another
InputAccel Server, its BatchID is changed to match the corresponding ClusterBase
and ClusterNumber.

Ensures new processes and batches are unique


New processes and batches must always be created on a single InputAccel
Server.
When you create a new process, you should install it on one InputAccel
Server, set it up as desired, and then copy it and its settings to every other
InputAccel Server in the ScaleServer group. The process will then be

63
Installation and Configuration Guide

consistent and available across all servers in the group to create new batches
on each InputAccel Server.
The Administrator module has commands that facilitate copying a process
easily to all servers in a ScaleServer group. When you copy a process, each
server changes its ID to conform to the ScaleServer naming conventions
explained in the previous section, so even though the processes can be
identical, they are still unique because their IDs are different.
When you create a new batch, you can do so in various ways:
„ By using the Administrator module, which is aware of multiple servers
but ensures that a new batch is created on a single server only
„ By using a module that initiates processing, such as the Scan module, or
by an older administrative module such as Supervisor. These modules
are not ScaleServer-compatible, and therefore must connect to a single
server at a time. Connecting to a single server guarantees that a new
batch will only be created on that server.
You cannot have multiple copies of a batch because, unlike processes, batches
contain data that must exist on a single server at a time. However, the
Administrator module enables you to move batches from one server to
another.

Ensures that batch values are unique


Batch values are batch-specific; that is, they apply only to the tasks contained
within the current batch. Batch values include instance settings (values that
set up a module to process a task), nodal data (values stored with particular
nodes in the InputAccel hierarchy), file values (pointers to the stage files that
most modules writer to the InputAccel Servers) and permissions (which users
have rights to create, modify, rearrange, and delete the batch). These values
(and the batch itself) can only reside on a single InputAccel Server in a
ScaleServer group. When that server is not on-line, this data is not available to
any modules.

64
Chapter 3: Installing the InputAccel Server

Automatically duplicates non-batch-specific values


When a module writes a new non-batch-specific value, the value is written to
all connected InputAccel Servers in the ScaleServer group. If a server in the
group is not connected at the time a value is written, then it will not be
updated later. When a module reads a non-batch-specific value, it gets it from
one of the servers in the ScaleServer group. The module has no control over
or knowledge of which server the value comes from.
Non-batch-specific values include values that are related to user preferences,
hardware configurations, machine names, and security, including the
currently logged-in user, the current module, the current screen resolution,
and the name of the current machine. In most cases, non-batch-specific values
are not very important to the successful processing of batches, so the fact that
all servers in a ScaleServer group may not have identical values stored is not a
problem.
Server values are, by definition, specific to a particular InputAccel Server.
Server values contain information such as the amount of remaining disk
space, licensing parameters, and process directories, and are generally read-
only from the point-of-view of the module.

Note: Only a few modules, such as the Administrator module, have the ability to
select a particular InputAccel Server in a ScaleServer group. Therefore, when a
module reads a server value from a group of servers, it is not possible to specify or
determine which server the value is from. If you are using a module that requires
server values from a specific InputAccel Server, then you should connect to that
server only.

Enables modules to connect to multiple servers


Within an established ScaleServer group, ScaleServer-compatible modules
running in production mode can connect to all or any subset of the InputAccel
Servers in the group. To connect to multiple servers, the operator simply types
each server name, in any order, separated by semicolons.
Non-ScaleServer-compatible modules can continue to be used in a
ScaleServer group—they connect as usual, specifying one server only when
logging in. As previously mentioned, you can use non-ScaleServer-
compatible modules either by dedicating a separate copy of the module to

65
Installation and Configuration Guide

each server in the ScaleServer group, or by instructing the operator to exit and
restart the module periodically, connecting to a different server each time in a
rotation pattern to ensure all tasks are processed.
Example
If there are five InputAccel Servers in a ScaleServer group, then the operator
of a ScaleServer-compatible client module could connect to all five servers.

Notes
„ Modules cannot connect to multiple servers that are not part of the same
ScaleServer group.
„ In the example above, it is also valid to specify, for example,
server2;server3;server5
In other words, it is not necessary to specify all servers in the ScaleServer
group when connecting.

Permits connecting to unavailable servers


ScaleServer technology provides the ability to specify unavailable servers
when starting the module. If any specified servers are not available during
module startup, then a dialog appears that offers two choices:
„ Ignore - Proceed to start the module with the specified list of servers.
Use this option if you want to automatically connect to the unavailable
server(s), if and when they become available, and silently begin
accepting tasks from them.
„ Cancel - Go back and re-enter the list of servers. Use this option if you
think you incorrectly typed the server name or if you do not want to
include the unavailable server in the connection attempt.
The Failed to Connect dialog appears for any module that was started with
multiple servers specified, as well as for ScaleServer-compatible modules that
were started with the -autoreconnect command-line parameter specified.

Note: For unattended modules, you may want to use the -noconnecterror
command-line parameter to suppress this dialog. See “Provides silent operation for
unattended modules” on page 67 for more information.

66
Chapter 3: Installing the InputAccel Server

Facilitates command-line login to multiple servers


To make multi-server connections easier for operators, administrators can set
up shortcut icons to start modules with the required server connections pre-
configured. To do this, you use the existing -login command line parameter as
follows:
module.exe -login:domain\username,password@server1;
server2;server3;server4;server5

Provides silent operation for unattended modules


ScaleServer technology adds the -noconnecterror command line parameter to
suppress the Failed to Connect dialog that appears if a specified server is not
available. When you specify -noconnecterror parameter, the module will
silently accept the list of servers specified during module startup, whether or
not those servers are available.
When combined with the -login: and -autostart command line parameters, the -
noconnecterror parameter enables administrators to configure shortcut icons or
batch files to automatically start modules in Run All Batches mode without a
need to handle interactive messages the module would normally display.

Silently reconnects to disconnected servers


If a module is started with multiple servers specified, and during production
one or more of those severs disconnects, then the operator will not be aware of
any change. If the disconnected server later becomes available again, then the
module silently reconnects and begins receiving any tasks that may be
available.

67
Installation and Configuration Guide

Note: By default, modules will attempt to reconnect to an unavailable InputAccel


Server every 10 seconds. If desired, you can change this value by adding the
following key to the [InputAccel] section of the win.ini file on each client machine:
ReconnectTime=nnnn
where nnnn is the number of milliseconds between reconnection attempts. For
example, if you want to attempt to reconnect once every two minutes, then add the
following line to the win.ini file on the client workstation:
ReconnecTime=12000
The minimum value for ReconnectTime is 5000 (5 seconds).

Note: ScaleServer-compatible modules that were started with a single server


connection specified do not, by default, automatically attempt to reconnect to an
InputAccel Server that has disconnected. By specifying the -autoreconnect
command-line parameter, any ScaleServer-compatible module will automatically
attempt to reconnect to the unavailable server periodically.

Requeues incomplete tasks when a server reappears


If a server disconnects, then modules that were started with multiple server
connections, as well as ScaleServer-compatible modules that were started
with the -autoreconnect parameter, will not notice the event. If an operator
running a module in Run All Batches mode and is processing a task from a
batch on a server that disconnects, then the operator will complete the task
normally, unaware of the missing server. Because the server that “owns” the
tasks is no longer available, the data from the task is discarded. From the
point-of-view of the disconnected server, the task was not finished. From the
point-of-view of the operator, the only difference is that no more tasks will be
sent from the disconnected server. Assuming other servers are sending tasks,
the operator will probably never know that the server disconnected.
When the disconnected server reconnects, modules will silently resume
requesting tasks from it. If the interrupted batch still exists, then the server
will requeue the unfinished task that occurred during the disconnection and
send it to an available module instance. In this case, it is possible that the
same operator will see the task a second time and recognize it as one that was

68
Chapter 3: Installing the InputAccel Server

already completed. Explaining why repeated tasks sometimes occur may be


the only operator training required to implement a ScaleServer system.

Operates transparently in Run All Batches mode


Most InputAccel operators run modules in Run All Batches mode. In this
mode, the module receives tasks from all connected servers in a ScaleServer
group as soon as tasks are available. The order in which a module receives
tasks is determined by the following conditions:
„ The priority setting of the batch from which the task is being sent.
„ Among tasks from batches of the same priority, the order in which the
task was received by the machine client. (Note that the InputAccel
Servers within a ScaleServer group do not coordinate among
themselves to send tasks in any particular order.)
Modules will continue to receive tasks as long as at least one InputAccel
Server is connected and has tasks available for processing. If all servers
disconnect (or if the only server disconnects when the module is started with
the -autoreconnect command line parameter), then the module will silently
wait for tasks until after a server reconnects and tasks become available.

Operates transparently in Run Single Batch and Open Batch


modes
In Single Batch mode, operators select the batch they want to process, and
then automatically receive tasks from that batch alone. In Open Batch mode,
operators select from among all batches regardless of whether or not the
batches include an instance of the module being used.
In either Run Single Batch or Open Batch mode, the Open Batch dialog
displays a list of batch names only—no BatchID or other information
indicates which server “owns” the batch. If in your information capture
environment it is important for operators to be able to identify the particular
server that owns a batch, then you must take steps to use a batch naming
convention that identifies the host server.

69
Installation and Configuration Guide

Prefetches additional tasks


Internal module code determines how many tasks a module can prefetch.
Prefetching tasks enables the module to have one or more additional tasks
waiting to be processed, so the module does not have to wait for the
InputAccel Server and the network to transfer data each time it needs another
task to process.
Most modules will request a total of three tasks when connected to a single
server—the current task plus two more that are ready to be processed. The
number of prefetched tasks cannot be configured by either the user or the
administrator—it is built into the module design. Only the Index module
enables you to turn prefetching on and off as a way of providing more control
in a work flow with multiple Index modules.
When a module is connected to multiple servers, ScaleServer technology
limits the number of tasks a module receives per server connection to:

number of tasks the module would prefetch from a single server


number of connected servers

rounded-up to the next whole number. This means that in some cases, a
module may prefetch one additional task when connected to multiple servers
that it would not prefetch when connected to a single server.

Ensures proper handling of IA Values


When working with a group of InputAccel Servers, ScaleServer technology
takes special care to route various types of IA Values appropriately, according
to the type of information they contain.
„ Task values - These are IA Values that are received for each task.
Within a ScaleServer group, task values are stored only on the server
that owns the batch from which the tasks originated.
„ Batch values - These are IA Values that are related specifically to a
batch as well as global module setup parameters. Within a ScaleServer
group, batch-specific values are stored only on the server that owns the
batch; global module setup parameters are stored on all connected

70
Chapter 3: Installing the InputAccel Server

servers. Servers that are not connected are not automatically updated
when they reconnect.
„ System values - These are IA Values that are related to a particular
user, module, computer, screen resolution, or a combination thereof.
This includes user preferences, hardware configurations, machine
names, security, and other system parameters. Within a ScaleServer
group, system values are stored on all connected servers unless they are
server-specific values (for example, licensing data, disk space data, and
so forth). Servers that are not connected are not automatically updated
with these values when they reconnect.
„ Dynamic values - These are IA Values of type String that are created
“on the fly,” either from an IPP or from a client module that was
designed to create them. Using standard Visual Basic syntax, you create
dynamic values in an IPP simply by setting their variables. If a variable
does not already exist, then the InputAccel Server from which a task
was sent creates the variable during task processing. You do not need to
declare the dynamic values—just reference them to make an InputAccel
Server create them.
After the dynamic values are created, they behave almost exactly like IA
Values that have been declared in an Module Definition File. Within a
ScaleServer group, dynamic values are stored only on the server that owns the
batch that defines them.

Provides ScaleServer information in IA Values


If you are writing your own Integrated ProcessFlow Projects (IPPs), then you
can use the IA Values listed in the ScaleServer IA Values table to reference
ScaleServer information as desired.

Table 5: ScaleServer IA Values


IA Values that contain information about a ScaleServer group.

IA Value Description Example


$module=Server “Cluster” value from the Production;PServer_1;
/ Cluster InputAccel Server PServer_2; BUServer_1;...
registry.

71
Installation and Configuration Guide

Table 5: ScaleServer IA Values


IA Values that contain information about a ScaleServer group.

IA Value Description Example


$module=Server “ClusterBase” value as 5
/ ClusterBase configured by the server (Established by license feature
license. codes. Maximum value for v5.3
is 8.)

$module=Server “ClusterNumber” value 1


/ ClusterNumber from the InputAccel (Must be > 0 and <
Server registry. ClusterBase)

$user The name of the While this is not a ScaleServer-


connected user. specific value, note that within a
ScaleServer group, only one
UserName exists for each user.

Handles licenses in a reasonable manner


ScaleServer technology changes the way module licensing works when
modules connect to multiple InputAccel Servers.
„ When a module connects to a ScaleServer group, only a single
connection is consumed per machine running a module even though the
module can connect to multiple servers.
„ The module connection to any InputAccel Server in a ScaleServer
group will succeed if anyone of the InputAccel Servers in the group has
a valid connection license.
„ When a module connects to a ScaleServer group, the first connected
InputAccel Server queries the other InputAccel Servers in the group to
check if a connection license for that module is already consumed. If
found, then it does not consume a connection license for that module. If
not found, then it tries to consume the connection license locally if
available. If it does not have any valid connection license locally, then it
will query all the other InputAccel Servers in the ScaleServer group to
see if they have a valid connection license and if so, “borrow” it. If it

72
Chapter 3: Installing the InputAccel Server

cannot borrow it, then the connection to the module is denied with a
licensing error.

Setting up a ScaleServer group


To set up a ScaleServer group, perform the following steps:
1. Configure each InputAccel Server that is to be used in the ScaleServer
group by installing the required hardware and software on each server
computer. See “InputAccel Server software requirements” on page 8.
2. Install the InputAccel Server software on each server computer. See
“Installing the InputAccel Server” on page 43. For each InputAccel
Server you install, be sure to install and activate your InputAccel Captiva
Activation File (.caf) as explained in “Activating the InputAccel Server”
on page 109 or attach your hardware security key as explained in
“Attaching the hardware security key” on page 50.
3. Install valid ScaleServer licenses/feature codes on each InputAccel Server
that is to be part of the ScaleServer group.
Note: Each InputAccel Server that is to be a part of a ScaleServer group must
have the same ClusterBase value encoded in its license feature codes. Feature
codes are established when you install InputAccel Server licenses. For details
on server feature codes, see “ScaleServer feature codes” on page 58

4. Configure the same set of users and passwords on all InputAccel Servers
in the ScaleServer group. You may want to consider configuring one of
your servers as a domain controller to simplify user account maintenance.
See “Defining users and groups” on page 146 for more information.
5. Install at least one set of client modules on a workstation that is connected
to all the InputAccel Servers in the ScaleServer group. This is required so
that all instances of modules in processes and batches on all InputAccel
Servers can be run in setup mode from the Administrator module.
6. Run the Administrator module to specify a ScaleServer group name and
configure a list of servers in the group. Refer to “Configuring a

73
Installation and Configuration Guide

ScaleServer Group” in Administrator Module Help for detailed


configuration information.

Note: You must specify the InputAccel Server machine name, not “localhost”,
when connecting to a ScaleServer group

ScaleServer group installation is now complete. All commands for


maintaining and reconfiguring a ScaleServer group are located in the
Administrator module and are explained in the Administrator Help installed
with it.

Don’t forget to restart the servers


Each time you make changes to a ScaleServer group, including the first time
you create a ScaleServer group, you must stop and restart each InputAccel
Server in the group. This applies whether you use the Administrator module
to make the changes or edit the registry settings of each InputAccel Server
manually.

Setting up multiple ScaleServer groups


If desired, you can set up multiple ScaleServer groups on the same network.
To do so, you must create each group using a different Group Name and you
must add InputAccel Servers that do not already belong to another group.
The only other requirement is that all servers in all groups have feature codes
in their licenses that enable the maximum number of servers that will exist in
the biggest group. For example, if you have one group of three servers and
one group of five servers, then ClusterBase must be 5 (DF) or higher.
See Table 4 on page 59 for a list of server feature codes that enable the various
ClusterBase values.

74
Chapter 3: Installing the InputAccel Server

Synchronizing ScaleServer registry entries


ScaleServer operation depends on each member of a given ScaleServer group
containing information about itself as well as all other members of the group.
The individual InputAccel Servers in the group communicate with one
another periodically to ensure that this information is consistent and correct.
The Create/Modify Server Group dialog of the Administrator module
provides a convenient way to configure the members of a ScaleServer group;
however, it is not foolproof. It assumes that ScaleServer is either not present
(in the case of a server that has not yet been added) or consistent and correct
(in the case of a server that has already been added).
Even though the Administrator module may show you the current connection
status of each server in the current group, it is possible for a server disconnect
to occur between the time when you start an Add Server to Group operation
and the time when the registry settings of all servers in the group are updated.
Also, if you uninstall an InputAccel Server that is a member of a ScaleServer
group, then other InputAccel Servers in the group are not notified. They
continue to communicate information that indicates the server should still be
present. If you do not remove the server from the group before uninstalling, or
if the registry values of the members of a group get out of sync in any other
way, then you may not be able to reconfigure the ScaleServer group using the
Administrator module until after the registry entries are manually corrected.
To manually fix out-of-sync registry values, follow these steps:
1. Gather information. Use the Administrator module to determine the cor-
rect registry settings. You need to know:
„ Group Name
„ Name of each server in the group
„ Group Number (ClusterNumber) that has been assigned to each server
in the group.
2. Run Regedit on each server. One at a time, go to each server that is or
was in the ScaleServer group in question and using the Run command in
the Windows Start menu or a command prompt, start regedit.exe.

75
Installation and Configuration Guide

3. Locate the registry keys. In the Regedit window, navigate to


HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\
InputAccel\Parameters.
4. Examine the registry parameters. For each InputAccel Server in a
ScaleServer group, examine the list of registry values in the right pane.
Your registry settings will vary, but should look similar to the following
figure.

Cluster string must be identical


on all servers in the group

ScaleServer values that


should be present

ClusterNumber must be unique


on every server in the group

Current registry key

Figure 4: Typical registry values for the InputAccel\Parameters key

5. Select one of the following:


„ If the server should be in the ScaleServer group:
„ Be sure the registry contains the “ClusterNumber” value name, that
the “ClusterNumber” value is unique among all servers in the
group, greater than or equal to 0, and less than the ClusterBase
value established by the license feature codes (see Table 4 on

76
Chapter 3: Installing the InputAccel Server

page 59). If the registry does not contain this value, then add a new
DWORD value and type a valid number.
„ Be sure the registry contains the “Cluster” value name and that it is
identical to the “Cluster” values on every other server in the
ScaleServer group. If the registry does not contain this value, then
add a new STRING value and specify the correct string, as
explained in “Registry value location” on page 61.
Note: The “Cluster” value must not only contain identical
information, the order of the Group Name and each semicolon-
separated server name must be identical.
„ If the server should not be part of a ScaleServer group:
„ Be sure the registry does not contain a “ClusterNumber” value
name. If it does, then delete it.
„ Be sure the registry does not contain a “Cluster” value name. If it
does, then delete it.
Note: Servers that do not have cluster values defined in their
registry will behave as stand-alone InputAccel Servers.
6. Stop and restart each InputAccel Server whose registry you have
modified.
7. Use the Administrator module to connect to the group and make sure it
appears consistent and correct. Refer to “Configuring a ScaleServer
Group” in Administrator Module Help for detailed configuration
information.

Setting up InputAccel in an MSCS cluster


This section explains how InputAccel can work within a Microsoft Cluster
Server (MSCS) cluster of Windows servers. You must separately configure
two parts of InputAccel: the InputAccel Server and the EMC Captiva Input
Management Console (if used).

77
Installation and Configuration Guide

An MSCS cluster uses an active server and a passive server. If the active
server experiences a fault, the passive server takes over as the active server,
and the previously active server becomes the passive server.
For more information about Microsoft Cluster Server, see Microsoft Cluster
Server General Questions on the Microsoft Web site.
InputAccel works with Microsoft Windows Server 2003 in a cluster
configuration. EMC Captiva Input Management Console v. 2.7 and later also
supports this cluster configuration.
The advantage of using MSCS clustering is automatic failover in the event of
a hardware failure. For example, if an active server experiences a hardware
failure, then a passive server automatically takes over to process tasks that
were previously being processed by the failed server. The passive server
“shadows” the activity on the active server so that your batches remain
synchronized.
When a hardware failure occurs on an active server, MSCS initiates the
following actions:
„ Switches the ID of the Storage Area Network (SAN) drive from the
failed server to the active (formerly passive) server.
„ Changes the IP address and hostname of the active (formerly passive)
server to that of the failed server.
„ Starts the InputAccel Server service.

Note: Any batches that are interrupted by a failover operation that have not
already been synced must be rescanned or resubmitted in their entirety. The
interval for performing batch sync operations is specified by the BatchSync registry
value, which by default is set to 300 seconds (5 minutes).

Setting up InputAccel Server in an MSCS cluster


This section explains how to set up InputAccel Server in a clustered server
configuration.

78
Chapter 3: Installing the InputAccel Server

Prerequisites
Before configuring InputAccel Server in a Microsoft server cluster, you must
make sure your environment meets the following prerequisites:
„ Microsoft Distributed Transaction Coordinator (MSDTC) must be
installed and DTC access must be enabled before the cluster is
configured.
„ Windows Server 2003 must be set up in a clustering configuration on
multiple (at least two) separate hardware platforms.
„ Your Microsoft Server Cluster must include a Storage Area Network
(SAN) device. When you install InputAccel in the following steps, you
must locate the IAS folder on the SAN.
„ When you install InputAccel in the following steps, each server must be
configured to use an activation (.caf) file. (You cannot use a hardware
security key (dongle) on the InputAccel Servers in a Microsoft server
cluster.)

Installing InputAccel Server


Follow these steps to install InputAccel Server in a Microsoft Cluster Server:
1. Run the InputAccel setup program to install InputAccel Server on each
node of the Microsoft Cluster Server.
2. When the Destination Folder panel appears, under Install InputAccel
Server Data Files To, select Change. Change the destination folder to
specify a folder named IAS on the SAN. (Do not change the location of
the InputAccel Server application files to the SAN.)
3. Continue following the InputAccel Server setup wizard to complete the
installation.
4. Repeat these steps to install InputAccel Server on all nodes of the
Microsoft Cluster Server.

Completing the Cluster Application Wizard


At this point, your Microsoft Cluster Server should be configured and
InputAccel Server should be installed on each node of the cluster with a
common IAS folder located on the SAN.

79
Installation and Configuration Guide

Follow these steps to complete the Cluster Application Wizard to enable the
InputAccel Server to work in the clustered environment:
1. Open Cluster Administrator. Select Start > Programs > Administrative
Tools, then select Cluster Administrator. Connect to the cluster hosting
your InputAccel Server.
2. Select Configure Application. The Cluster Application Wizard starts.
3. In the Application Resource Type panel, select Generic Service in the
Resource Type field, then select Next.
4. In the Application Resource Name And Description panel, type a user-
defined name in the Name field. If desired, type a description of the
cluster resource in the Description field.
5. Select Advanced Properties and navigate to the Dependencies tab.
Select Modify. The Modify Dependencies dialog appears.
6. Under Available Resources, select your Cluster Name, Cluster IP, and
your SAN drive (s)1. Then select the right arrow button to move your
selection to the Dependencies column.
7. Select OK. The Cluster Application Wizard populates the Resource
Dependencies section of the Advanced Resource Properties dialog.
8. Select OK. Select Next. In the Generic Service Parameters panel, type
“InputAccel”. (This is the name of the InputAccel service.) Do not
specify any start parameters.
9. In the Registry Replication panel, select Next. (Do not make any
modifications.)
10. In the Completing Application Wizard panel, select Finish.
11. Bring the application on line by using the Cluster Administrator.
See “Activating an InputAccel Server on an MSCS Cluster using an
activation file” on page 111 for more information.

1. Your SAN drive name is the resource name you assigned to the SAN when you created your server
cluster.

80
Chapter 3: Installing the InputAccel Server

Setting up a ScaleServer group with MSCS clustered


servers
If you are installing a ScaleServer group of InputAccel Servers, you must
separately configure an active and passive server for each ScaleServer node
that needs redundancy. (You may choose to implement an MSCS cluster on a
subset of your ScaleServer servers, if desired.) Each server in an MSCS
cluster must be able to participate in the ScaleServer group, and so must be
configured with the required ScaleServer registry values:
„ Group Name
„ Name of each server in the group
„ Group Number (ClusterNumber) that has been assigned to each server
in the group.
You can configure the active server by using the Administrator module;
however, you will generally need to configure the passive server by editing its
registry settings, because the Administrator module cannot connect to a
passive server. For complete details of editing the ScaleServer registries
entries, see “Synchronizing ScaleServer registry entries” on page 75.
After configuring all servers in the clusters for each ScaleServer node, you
should verify that each combination of servers can participate as a
ScaleServer server by testing each combination of active and passive cluster
servers. (You need to make each passive server active, in turn, and make sure
that each active server can participate with every other server when that server
becomes active. In a large system, there will be a large number of
configurations to test.)

Setting up the EMC Captiva Input Management Console


in an MSCS cluster
This section explains how to set up the Input Management Console in a
clustered server configuration. You would typically use this configuration to
monitor and control an InputAccel Server that has also been configured in an
MSCS cluster.

81
Installation and Configuration Guide

Prerequisites
Before configuring the Input Management Console in a Microsoft server
cluster, you must make sure your environment meets the following
prerequisites:
„ Microsoft Distributed Transaction Coordinator (MSDTC) must be
installed and DTC access must be enabled before the cluster is
configured.
„ Windows Server 2003 must be set up in a clustering configuration on
multiple (at least two) separate hardware platforms. IIS must be
installed and running on each of these platforms, and must be
configured to Allow ASP. In addition, you must set the necessary
permissions on your Web folders for each of these nodes.
„ Your Microsoft Server Cluster must include a Storage Area Network
(SAN) device. When you install the Input Management Console, its
database (usually Microsoft Access) must be installed on the SAN.

Installing the EMC Captiva Input Management Console


Follow these steps to install the Input Management Console in a Microsoft
Cluster Server:
1. Run the EMC Captiva Input Management Console setup program from
the InputAccel distribution to install Input Management Console on each
node of the Microsoft Cluster Server.
2. When setup completes, create the necessary database (Microsoft Access,
by default) on the SAN.
3. Configure the database connectivity for the Input Management Console to
use the database you created on the SAN.

Completing the Cluster Application Wizard


At this point, your Microsoft Cluster Server is configured and the InputAccel
Server and the Input Management Console is installed on each node of the
cluster.

82
Chapter 3: Installing the InputAccel Server

Follow these steps to complete the Cluster Application Wizard to enable the
InputAccel and Input Management Console to work in the clustered
environment:
1. Open Cluster Administrator. Select Start > Programs > Administrative
Tools, then select Cluster Administrator. Connect to the cluster hosting
your InputAccel Server.
2. Select Configure Application. The Cluster Application Wizard starts.
3. In the Select Or Create A Virtual Server panel, select Use an existing
virtual server, then select Next.
4. In the Create Application Cluster Resource panel, select Yes, create a
cluster resource for my application now, then select Next.
5. In the Application Resource Type panel, select Generic Service in the
Resource Type field, then select Next.
6. In the Application Resource Name And Description panel, type a user-
defined name in the Name field. If desired, type a description of the
cluster resource in the Description field.
7. Select Advanced Properties and navigate to the Dependencies tab.
Select Modify. The Modify Dependencies dialog appears.
8. Under Available Resources, select your Cluster Name, your SAN
drive(s)1, your InputAccel Server, and your MSDTC Resource. Then
select the left arrow button to move your selections to the Dependencies
column.
9. Select OK. The Cluster Application Wizard populates the Resource
Dependencies section of the Advanced Resource Properties dialog.
10. Select OK. In the Generic Service Parameters panel, type “RevMonSvc”.
(This is the name of the Reveille monitor service.) Do not specify any
start parameters.
11. In the Registry Replication panel, select Next. (Do not make any
modifications.)
12. In the Completing Application Wizard panel, select Finish.

1. Your SAN drive name is the resource name you assigned to the SAN when you created your server
cluster.

83
Installation and Configuration Guide

Completing the Input Management Console InputAccel Wizard


Now you must run the Input Management Console InputAccel wizard to
complete the configuration. Follow these steps:
1. Start the Input Management Console and either create a new monitor or
view and existing monitor
2. Select File > Run Setup Wizards to display the Resource Function Setup
Wizards dialog.
3. Select InputAccel Wizard from the list of wizards, then select the OK
button.
4. In the second panel of the wizard, in the Web Server field, type the
MSCS cluster name that you are using for your Web server and
InputAccel Server.
Note: Your Web server and InputAccel Server both must be running on an
MSCS clustered server.

5. In the InputAccel Server field, type your user name as


DomainName\Username. Do not type anything in the Domain field.
Notes:
„ If you receive permissions errors when you start the Reveille monitor
service, then double-click the object causing the error and type your login
credentials as DomainName\Username in the Username field, then type
your password. You may need to do this for multiple objects in the
monitor.
„ You may need to change the logon parameters for the Input Management
Console monitor service.

Installing Audit Extensions


The Audit Extensions installer provides the ability to audit activity by running
SQL queries against a database created for you during installation.
The following are prerequisites for installing Audit Extensions:

84
Chapter 3: Installing the InputAccel Server

„ The IAS folder must reside on an NTFS drive.


„ Windows 2000 Professional or later is required to support Encrypting
File System (EFS).
To install Audit Extensions, perform the following steps. The Audit
Extensions installer must be run on the InputAccel server machine.
1. Install Audit Extensions on your machine by selecting the Audit Exten-
sions option on the InputAccel main setup window or invoke the Audit
Extensions installer directly through Windows Explorer.
2. In the Welcome to the InstallShield Wizard for Audit Extensions for
InputAccel dialog, select Next.
3. In the Choose Destination Location dialog, select Browse to navigate to
the destination folder to which you want to install the files associated with
Audit Extensions.
Note: The default location is the IAS\Audit Extensions for InputAccel
folder on the local machine if an IAS folder is located in the registry. If no
IAS folder is located in the registry, then the FormWare folder is used if
one is found in the environment. If no IAS or FormWare folders are
found, then no default is provided and you must select Browse.
4. In the Create LogDB dialog, select the Allow setup to create database
check box if you want the log database to be created during installation.
5. In the Log Database Configuration dialog, type values into the Database
Server and Database Name fields. If you have selected the Allow setup
to create database check box on the previous dialog, then the Database
Username, Password, and Confirm Password fields are enabled. This
information creates or populates the audit logging database. Select Test to
test the configuration. Select Next to proceed.
6. In the Start Copying Files dialog, select Next to copy the program files.
Select Back to change your settings.
7. In the InstallShield Wizard Complete dialog, select Finish.

85
Installation and Configuration Guide

Configuring InputAccel to enable auditing functionality


Perform the following steps to configure the audit functionality registry
setting for log output.
1. In Administrator, open the Server Settings dialog by selecting Server >
Change Server Settings and select the Change Settings in Registry
check box.
2. Set the AuditLogging registry setting to control which entries are logged:
„ 0/0x00 (default) - Logging is disabled
„ 1/0x01 - Image Read (User action 1) Image was viewed by user
„ 2/0x02 - Image Write (User action 2) Image was modified or created
by user
„ 4/0x04 - Create Node (User action 3) Node was created by user
„ 8/0x08 - Delete Node (User action 4) Node was deleted by user
„ 16/0x10 - Value Read (User action 5) IA Values was read by user
„ 32/0x20 - Value Write (User action 6) IA Value was modified by user
„ 64/0x40 - Create Batch (User action 7) Batch was created by user
„ 128/0x80 - Delete Batch (User action 8) Batch was deleted by user
„ 256/0x100 - Send Task (User action 9) Task was sent to a module
„ 512/0x200 - Finish Task (User action 10) Task was finished
„ 65535/0xFFFF - All All entries
Note: To log multiple user actions, add the values for each level
together.
3. Select OK to save your work.

Information logged by the InputAccel server


The InputAccel server records information and stores it into a database
created for you during installation. Only nodal operations are logged, so batch
and node information is always recorded.

86
Chapter 3: Installing the InputAccel Server

You can run SQL queries against your database to retrieve the following
information:
„ User login name
„ Date and time the image is sent from the InputAccel server
„ Image name
„ Batch ID
„ Node ID
„ Module name for the module doing the operation
„ IA value
„ User action - Image viewing, image modification or creation, node
creation, node deletion, IA value viewing, IA modification. This
information is recorded as a number. The following table describes the
actions and associated numbers that are recorded by the InputAccel
server.
Actions recorded by the InputAccel server
Action ID Extra Information Example of Extra Information
Get File 1 File name that is sent 14d.1
Write File 2 File name that is 14d.1
received
Insert Node 3 Number of the node 123
before the insertion.
Might be a parent node
or might be a sibling.
Delete Node 4 Parent node number 123
Get Value 5 Value name, including Scan.ScanTime
instance
Set Value 6 Value name, including Scan.ScanTime
instance
Create Batch 7 Process ID, then ‘:’, then 123:My Batch
batch name
Delete Batch 8 Batch name My Batch
Sent Task 9 Instance name Index
Finish Task 10 Instance name Index

87
Installation and Configuration Guide

Modifying server installations


There are two ways to initiate the modification process on your server.
See “Modifying Installations” on page 123 for more information.

Modifying server installations interactively


To continue modifying the base installation:
1. Select Next. The Program Maintenance dialog appears.
2. Select Modify and then select Next.
3. Follow the instructions as they appear to modify the installation.

Note: The Installing InputAccel Server dialog appears and shows the
progress of the modifications, even if you are removing a feature.

4. Repair your installation. See “Repairing Installations” on page 124 for


further details.

Modifying server installations silently


You can modify your installation by adding or removing features.
See “Silent Installations” on page 117 for more information.

Removing server installations


If the InputAccel Server you are removing has been added to a ScaleServer
group of servers, then remove the server from the group before uninstalling it.
Use the Administrator module to remove the server from the ScaleServer

88
Chapter 3: Installing the InputAccel Server

group. Refer to the Administrator Module Online Help and the ScaleServer
Overview (sclsvovr.chm) for more information.
See “Removing Installations” on page 123 for more information.

Repairing server installations


Repairing an InputAccel Server installation replaces missing files and makes
sure all versions of installed files are the required versions or later.
See “Repairing Installations” on page 124 for more information.

Viewing server installation log files


Although no InputAccel-specific log file is generated when you install the
base server, you can create a Microsoft Installer-specific log file using the /l*v
switch and parameters.
See “Viewing Log Files” on page 125 for more information.

How to read the log file


The verbose log includes an entry for each feature and component the
installation package may install.
See “Reading Log Files” on page 126 for information about log files.

89
Installation and Configuration Guide

Additional security for the InputAccel


Server
Performing the following security measures for the InputAccel server helps
you to meet the standards of Health Insurance Portability and Accountability
Act of 1996 by enabling you to control access to health data about individuals
using the following methods:
„ Login and password control - Create departments in Administrator
and set permissions for a user or group to run a specific module against
a specific process or batch. See Administrator online help for more
information.
„ Image data access control - Restrict access to files on the InputAccel
Server to only users with specific administrative rights.
„ Automatic shutdown of applications - It is recommended that you use
the standard Windows screensaver to lock the workstation after a
specified period of time on attended modules. A user login is required
to bring the data back into view.
„ Secure data transmission - Configure HTTP distributed processing
over a non-secure network (for example, the Internet) to use standard
SSL. Any other remote data access using IACopy or other client
modules should be configured over leased lines or secure Virtual
Private Network (VPN).
„ Secure data storage on the InputAccel Server - Set Windows
encryption on the IAS folder. Run the InputAccel service as the same
user that set the encryption on the server by using the RunAs tool. You
must switch IAS to run as a different security principle (not the default
localsystem account) using Microsoft Management Console (MMC)
Services snap-in to remove the ability to configure the InputAccel
Server to interact with the desktop.
Perform the following to provide extra security for the server:
1. In Administrator, open the Department dialog by selecting Department >
Add Department. Create departments. For each department that you
define, the server creates an access control list (ACL) that prevents tasks

90
Chapter 3: Installing the InputAccel Server

from being sent to workstations without permission for certain depart-


ments.
Note: It is not mandatory for you to create and use departments.
2. In Administrator, open the Server Settings dialog by selecting Server >
Change Server Settings and select the Change Settings in Registry
check box.
Note: Some changes to user access rights (for example, a group
member being added or deleted) will not take effect immediately.
3. Set the DeptPermissionsTimeout registry setting to determine the length
of time user access data is cached by the InputAccel server. You might
need to experiment to set an appropriate default value. The default value
is 10000 milliseconds.
4. In Administrator, open the Security dialog and create security permissions
by modifying department access control lists (ACLs). Open the Security
dialog as follows:
„ Server > Default Department - Opens the Security dialog and allows
you to set security for the default department for the selected server
„ Departments > Selected Departments - Opens the Security dialog and
allows you to set security for the selected departments
„ Departments > Apply Default Security - Sets the security of the
selected departments to the default security of the department's server
Note: To set security for all departments from the Department dialog,
select Edit > Select All > Security > Departments > Selected
Departments.
5. In Administrator, use the Security menu to set administrator rights to
restrict user browsing to images and data that are stored on the InputAccel
server.
Note: Restrict all non-administrative users (for example, completion
operators) from accessing the InputAccel server. FormWare for
InputAccel modules are specified to run in Copy Images mode so that
users logged into FormWare client machines will not be able to access
images on the InputAccel server through Windows Explorer. Images

91
Installation and Configuration Guide

are pushed to the client by the InputAccel server, and access permission
from the client to the server is not required.
6. Configure InputAccel to use standard Secure Sockets Layer (SSL). See
Securing connections with SSL for more information if you are using
Windows 2000 Advanced Server.
7. Set windows encryption on the IAS folder by running the InputAccel
service as the same user as the user who set the encryption on the server.
8. Change the default installation of your InputAccel Server from running as
a local system account to a different security principle using the Microsoft
Management Console (MMC) Services snap-in. For more information
about the Microsoft Management Console (MMC) Services snap-in, see
Microsoft Management Console: Overview.

Note: If the IPP attempts to display a dialog, then you will not be able to see it or
interact with it, and this results in a hung server.

92
4
Chapter

Installing client modules


InputAccel uses the Microsoft Installer (MSI) to install, modify, remove, and
repair InputAccel client modules. With this installer, you have the option to
perform installation processes using either the standard user interface or by
typing instructions on a command line.
The following sections provide important information about how to launch
and use the standard interactive installer and how to use command-line
instructions to install and modify InputAccel features.
Before installing InputAccel modules . . . . . . . . . . . . . . . . . . . . . . . . . 94
Understanding client installer concepts . . . . . . . . . . . . . . . . . . . . . . . . 96
Installing InputAccel client modules . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Installing third-party software used by InputAccel . . . . . . . . . . . . . . 104
Modifying client installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Removing client installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Repairing client installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Automating silent installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Viewing client installation log files . . . . . . . . . . . . . . . . . . . . . . . . . . 107

93
Installation and Configuration Guide

Before installing InputAccel modules


Before installing InputAccel modules, please review the concepts described in
the following sections.

Note: You must be logged on as an administrator or a member of the


Administrators group in order to successfully install the client software.

Note: To upgrade from, or downgrade to a previous version of InputAccel, see


Chapter 2, “Upgrading InputAccel,” on page 21.

Installing the InputAccel Server first


You should install the InputAccel Server before installing the client modules.
This enables you to perform a test during client installation to ensure that the
client workstation can communicate with the InputAccel Server computer.

Installing scanner drivers


Use caution when installing scanner drivers. You should not install a scanner
driver unless the corresponding scanner is already connected. If you do, then
an error message may appear when you later launch the Scan module.

94
Chapter 4: Installing client modules

Note: InputAccel 5.3 includes the PixTwain Configuration Wizard (the


Configurator) which enables you to use TWAIN drivers with an ISIS overlay. The
Configurator creates a profile of how the TWAIN driver works by recording its
actions during a guided set of configuration steps. After a configuration profile is
created, you should test the profile using the PixView Demo application that can
be run from Start > Program Files > InputAccel > Utilities.
The InputAccel installation program installs two executable files in the
<windows>\Pixtran directory of each Scan or Rescan workstation: the
Configurator (pixconfg.exe) and a support program (runtwain.exe) that handles
TWAIN commands and attempts to determine what the TWAIN driver is trying to
do. All instructions for using the Configurator are incorporated within the user-
interface.
In most cases, you should use scanners with a TWAIN driver only for occasional
document capture tasks with InputAccel. For production-level performance and
stability, you should always use an ISIS driver for your scanner if one is available.
See www.scannerdrivers.com for a list of available ISIS drivers.

Modifying the Services file


The Services file contains Windows TCP (Transmission Control Protocol)
port assignments for your computer. For information about modifying the
services file, see “Modifying the Services file” on page 122.

Updating your InputAccel shortcuts


If you have existing InputAccel shortcuts in your Windows Start menu that
are in a folder other than InputAccel (for example, InputAccel 4.0), then the
installer will remove the old shortcuts and add new ones. All new and
upgraded client modules and features will then be available from the Start >
Programs > InputAccel group. The only old shortcuts that will remain will
be those for discontinued, third-party, or custom modules and documentation.
If you previously created any of your own desktop icons, then you may need
to update them.

95
Installation and Configuration Guide

Installing modules on the Administrator workstation


If you are installing the Administrator or Supervisor module, then you must
install each module that you plan to configure using Administrator on the
same workstation. The Administrator module must have direct access to each
of the modules it is configuring. (Exception: the ECM Web Service Importer
module.)
If you are setting up a ScaleServer group of InputAccel Servers, then this
Administrator workstation must be able to connect to all servers in the group,
so that it can run modules in setup mode from any process or batch instance
on any server in the ScaleServer group.

Understanding client installer concepts


InputAccel uses the InstallShield installer to as a “front-end” to the Microsoft
Windows Installer to install, modify, remove, and repair InputAccel client
modules. The installer can be used in either:
„ Standard mode - displays the full user interface (see “Using the installer
in standard interactive mode” on page 97 for more information),
„ Silent mode - uses instructions typed on a command line or as part of a
batch file. See “Automating silent installation” on page 106 for more
information.

Special information for the client installer


Please review the information for the installer before using the installer in
either standard or silent installation mode to install either the base client
modules.

96
Chapter 4: Installing client modules

For more general information for the installer, see “Special information for
the installer” on page 116.

Silent installation mode information


See “Silent Installations” on page 117 for more information about silent
installation mode information.

Using the installer in standard interactive mode


Standard interactive installation mode displays all user interface dialogs as
you step through the installation process. This is the default installation mode
and is the recommended installation method for most installations. To use the
installer in this mode, run setup.exe with no command-line options or select
Client Modules from the InputAccel main setup window (Figure 5 on page
97).

Figure 5: InputAccel main setup window

97
Installation and Configuration Guide

Using the installer in silent mode


Silent installation mode processes all instructions without displaying a user
interface.
See “Using the installer in silent mode” on page 118 for more information.

Installing InputAccel client modules

Installing InputAccel client modules interactively


To install InputAccel modules in standard (interactive) mode:
1. Place the InputAccel installation CD in your CD-ROM drive. The main
setup window appears.
2. Select Client Modules 5.3 in the main setup window.
3. Follow the instructions that appear to complete the installation.
Information in the following sections will help you make informed
decisions about how to proceed through the installation.

Notes:
1. These instructions do not show all setup screens that appear, only those
that require you to supply additional information that may not be obvious.
2. If you already have a previous version of InputAccel installed, then skip
to “Upgrading your InputAccel client installation” on page 102

3. Be sure to reboot if you are prompted to do so.

Specifying an InputAccel Server


After accepting the terms of the Software License Agreement and setup
proceeds, the InputAccel Server Name dialog will appear.

98
Chapter 4: Installing client modules

„ If desired, type the machine name of a computer running the InputAccel


Server software. If you type a name here, then each module that this
workstation runs will initially have its Server field filled in with this
name.
„ If you specified a server name above, then select the check box if you
want to make sure your client workstation can communicate with the
server. If you select this check box, then the setup program attempts to
communicate with the server you specified and informs you of the
result, after which you can continue or go back and change the Server
name until you specify a name that results in a valid connection.

Note: If communication with an InputAccel Server is not established during


installation, then modules that can run as services are installed as standard
InputAccel modules, not as services. For more information, see “Running client
modules as services” on page 150.

Choosing an installation location


Next you will be prompted to confirm or change the recommended
installation location.
If you want to change the installation location, then select Change and select
a new location in the dialog that appears.
With the desired installation location displayed, select Next to proceed.

Choosing complete vs. custom installation


As setup proceeds, the Setup Type dialog will appear:
„ Select Complete if you want to install all possible modules. The setup
program first checks for custom export modules that require a third-
party client module to be installed first. If the necessary third-party
modules are not present on the workstation, then the setup program
displays a list of those modules explaining their requirements and
removes them from the set of modules it installs. After installing any
required third-party software, you can run client setup again to modify
the installation and install the desired module(s). Skip the section
below.
„ Select Custom if you want to select the individual features to install.

99
Installation and Configuration Guide

Performing a custom installation


If you selected Custom in the dialog above, then you now must select the
modules and other features you want to install. You do so in the Custom
Setup dialog. When this dialog initially appears, none of the features are
selected—you must select each feature you want to install.
„ Select the desired features to install by selecting their icons and
selecting the appropriate choice from the pop-up menus that appear.
„ (Optional) Expand each item by selecting the + to view and select
individual subfeatures of each module.
„ If you need help with the meaning of the icons displayed in this dialog,
then select Help.
Select Next to continue.

Reviewing module requirements


If you selected a complete installation or if you selected a custom installation
with modules requiring third-party features, then one or two dialogs will
appear explaining these requirements. One dialog lists any selected modules
that cannot be installed until the listed requirements have been met. The other
dialog lists selected modules that will be installed but may not function
properly until the listed requirements have been met.
For example, the setup program will not install the IBM Content Manager
Advanced Compatible Export module unless a required IBM Content
Manager client is detected on the target system.
After carefully reviewing the list, select Next if you want to continue or
Cancel if you want to stop the installation so that you can complete any
prerequisite steps.

Selecting a scanner
As setup proceeds, the Scanner Selection dialog appears unless you are not
installing the Scan or Rescan module on this workstation:
Select your scanner make and model from this list. If your scanner does not
appear in this list, then select one of the following:

100
Chapter 4: Installing client modules

Figure 6: Selecting a scanner

„ (No scanner, file import only)


Enables you to use the Scan or Rescan module to import image files
from disk.
„ TWAIN scanner support
Enables you to use the PixTWAIN Configuration wizard to configure a
TWAIN scanner for use with InputAccel.
See “Installing scanner drivers” on page 94 for additional important
information.

Proceeding with client installation


Setup now has enough information to proceed with the installation, and the
Ready to Install the Program dialog appears. Select Install to start the actual
installation process, then wait while files are copied and the configuration of
your workstation is updated.

101
Installation and Configuration Guide

Upgrading your InputAccel client installation


If you already have a previous version of InputAccel installed on the
workstation, then the installation program automatically determines which
components you have installed and updates them for you. When you run the
client installation program, the Updated Installed Features dialog appears.
To proceed, select Install. Wait while the installation program updates your
current installation. When it finishes, your workstation will contain updated
versions of the modules that were already installed.
When the installation process completes, be sure to reboot your system if
instructed to do so.
If you want to add or remove modules or customize the installation in any
way, then you must first complete this automatic update and then run the
client installation program again. This time when the installer runs, follow the
instructions in “Modifying client installations” on page 105.

Installing base InputAccel modules silently


To silently install the base InputAccel client modules, you must always
include the following on a command line or in a batch file.
„ Executable name of the installer (setup.exe)
„ InstallShield arguments (for example, /V)
„ Microsoft Installer arguments enclosed in quotes (for example,
"/l*v...")
„ User interface level (for example: /qn)
„ Installer action (for example: /i)
„ Features to install
See “Supported InstallShield switches” on page 182 and “Supported MSI
properties” on page 186 for complete descriptions of the supported switches,
properties and their associated parameters.
It is a good idea, but not a requirement, to create a log file for your
installation. Include the following switch and path information if you want to

102
Chapter 4: Installing client modules

create a log file (see “Viewing client installation log files” on page 107 for
more information about creating log files):
„ (Optional) Log file switch and path (for example: setup.exe /V"/l*v
c:\logfile.txt")
In addition to the required and optional commands described above, you may
append the following:
„ Installation directory (for example: INSTALLDIR=D:\IAClient)
You may specify the directory where the InputAccel modules will be
installed by typing INSTALLDIR= followed by the directory. If you do
not specify a directory, then the installer will use the default directory
C:\Program Files\InputAccel\Client.
Note: If you use the INSTALLDIR parameter, then do not type a space
before or after the equals sign (=). If the path name contains spaces, a
complete path name must be specified (beginning at the root directory) and
enclosed in quotes.
Example: INSTALLDIR="D:\IA Client Files"
If the setup command line requires quotes in addition to the quotes required
for a path name with spaces, then the nested quotes must be escaped with
back slash characters (\"path name with spaces\").

For example, consider the following silent installation command. (Remember


that the entire command must be typed on one command line.)
setup.exe /V"/qn INSTALLDIR=\"D:\IA Client With Spaces\"/l*v
D:\temp\logfile.txt"
This command will execute the Windows installer (msiexec.exe) without a
user interface (/qn). It will perform an installation as specified by the
InputAccel installation file (InputAccel Client 5.3.msi). The InputAccel
components will be installed in the D:\IAClient directory of the computer
where the command is invoked (INSTALLDIR="D:\IA Client With
Spaces"). An installation log file will be written to the d:\temp directory
(/l*v d:\temp\logfile.txt).

103
Installation and Configuration Guide

Connecting to an InputAccel Server Running


Microsoft XP SP2 with Firewall
In order for clients to connect to the InputAccel server running Microsoft XP,
Service Pack 2 that has the Firewall enabled, they must either:
„ Specify the IP address in Server Name field of the login dialog
„ Modify the hosts file on the InputAccel client system and add the IP
address and machine name of the InputAccel Server

Installing third-party software used by InputAccel


Several third-party products from Adobe and Microsoft and used by
InputAccel can be installed directly from the InputAccel installation media.
InputAccel has been tested with the versions provided. Although later
versions may be available, you should use the versions provided with
InputAccel to ensure compatibility.

Microsoft products
Use the following options on the main setup window as required by your
situation:
„ Microsoft Data Access Components (MDAC)
MDAC provides a standard database interface for Windows. It has been
included with Microsoft Windows since Windows 2000. Install the
MDAC included with InputAccel if you will be exporting to ODBC
databases and if your system does not already have the latest version.
„ Microsoft Jet
Jet is a database engine that enables interacting with Microsoft Access,
Microsoft Excel, Borland Paradox, dBase, and plain text files. Install
Jet if you will be exporting to any of these database types. MDAC must
be installed prior to installing Jet.

104
Chapter 4: Installing client modules

Modifying client installations


There are two ways to initiate the modification process on your workstation.
See “Modifying Installations” on page 123 for more information.

Modifying base client installations interactively


To continue modifying the base installation from the main setup window:
1. Select Next. The Program Maintenance dialog appears. You can select
Modify to change with features are installed, Repair to repair installation
errors in the program, or Remove to remove InputAccel Client 5.3 from
your computer.
2. Select Modify and select Next.
3. Follow the instructions as they appear to modify the installation.

Note: The Installing InputAccel Client 5.3 dialog appears and shows the
progress of the modifications, even if you are removing a feature.

4. Repair your installation. See “Repairing Installations” on page 124 for


further details.

Modifying base client installations silently


You can modify your installation by adding or removing modules.
See “Modifying Installations” on page 123 for more information.

105
Installation and Configuration Guide

Removing client installations


Before you remove a base installation, you should remove all service packs in
the reverse order (i.e., remove service pack 3, then remove service pack 2,
then remove service pack 1).
After you have removed all service packs, you can then remove the base
installation.
See “Removing Installations” on page 123 for more information.

Repairing client installations


Repairing an InputAccel client installation replaces any missing files and
makes sure all existing files are the required version or later.
See “Repairing Installations” on page 124 for more information.

Automating silent installation


If desired, you can specify multiple silent installation command lines in a
batch file to automate silent installation. The following example shows three
commands contained within one batch file (irr_sp1.bat). The first process
installs the entire InputAccel 5.3 release. The second process removes
selected features of the installation. The third process repairs the features
removed by the second process. Each of the three processes generates a
separate log file.

//Begin contents of irr_sp1.bat batch file


//Install Service Pack 1 and write log file
setup.exe /V"/qn /l*v C:\logs\sp1_install.log"

106
Chapter 4: Installing client modules

//Remove WATCH and CAPCON features and write a log file


setup.exe /V"/qn REMOVE=WATCH,CAPCON /l*v
C:\logs\sp1_remove.log"
//Write log file
setup.exe /V"/qn /vomus /l*v C:\logs\sp1_repair.log"
//End contents of irr_sp1.bat batch file

If you have several workstations that each have a different set of modules
installed, then you can create one batch file that will upgrade only those
features that a workstation currently contains. Because a feature cannot be
upgraded if it is not present on a workstation, only those features that are
found by the installer will be upgraded.
You can either use just the defaults (as in Example 1, below), or you can use
the ADDLOCAL property set to ALL (as in Example 2).

Example 1
setup.exe /V"/qn /l*v C:\logs\sp1_all.log"

Example 2
setup.exe /V"/qn ADDLOCAL=ALL /l*v C:\logs\sp1_all.log"

Viewing client installation log files


Although no InputAccel-specific log file is generated when you install the
base client modules, you can create an MSI-specific log file using the /l*v
argument.

107
Installation and Configuration Guide

Viewing the user-specified log file


The information written to this log file depends on the parameters you specify
with the /l switch.
See “Viewing Log Files” on page 125 for more information.

How to read the log file


The verbose log includes an entry for each feature and component the
installation package may install.
See “Reading Log Files” on page 126 for information about log files.

108
5
Chapter

Activating the InputAccel


Server
After installing the InputAccel Server and client modules, you must activate
the InputAccel Server before you can install your license codes.
When you launch Administrator for the first time after installing the client
modules, you will be prompted to activate the InputAccel Server with an
activation file through a wizard.

Note: You can launch this wizard manually from the Administrator module by
selecting Server > Install/Activate Activation File.

You can activate an InputAccel Server with two types of keys:


„ Activation file. You can use a Captiva Activation File (.caf).
„ Hardware key. If you are upgrading from a previous version of
InputAccel and currently use a USB or parallel port hardware key
(Figure 2 on page 44), or if your InputAccel license included a
hardware security key, you may use it instead of using an activation file.

109
Installation and Configuration Guide

For more information, see the Administrator Help.


If you are upgrading from a previous version of InputAccel and are already
using a hardware key to activate your server, you can do one of the following:
„ Continue to use the hardware key. If you would like to continue using
your USB or parallel port hardware key, you can cancel this wizard and
proceed to install your license through Administrator.
„ Switch to activation file. If you would like to activate your InputAccel
Server with an activation file instead of a hardware security key, see
Chapter 5, “Switching to an activation file,” on page 111.

Activating the InputAccel Server on a single computer


using an activation file
Obtaining activation key
You can activate the InputAccel Server using an activation file and activation
key provided by EMC Captiva.
1. At the end of the InputAccel Client installation, leave the Launch the
InputAccel Administration module check box selected and select Fin-
ish.
2. Log into Administrator. The Server Activation Status dialog appears.
Select Yes to activate the InputAccel Server.
3. In the Install Activation File/Activate Server dialog, select the I want to
load an activation file check box to enable the Browse button.
4. Browse to the location of the CAF file you received from EMC Captiva,
and then select Next to install it. Do not install it by manually copying it
into the \IAS directory.
5. Write down the server ID and profile ID.
6. Select the link on the dialog and follow the instructions to obtain an
activation key from EMC Captiva. Select Cancel to exit the wizard. A
message displays indicating that you are now activated in a grace period.
The grace period provides fully functional operations for a limited time
until you obtain an activation key.

110
Chapter 5: Activating the InputAccel Server

Activating after you receive a key


1. Restart Administrator and reenter the wizard by selecting Server >
Install/Activate Activation File from the menu.
2. Select Next to skip .caf file installation to get to the activation key entry
dialog.
3. Type in your activation key, then select Finish.
Note: If your activation key is rejected when you select Finish, you may have
mistyped it, or the Server ID or Profile ID may have changed since you
requested the key. The Profile ID value is computed based on a hardware
profile snapshot of the machine at the time that you run the wizard.
4. Select OK through the remaining dialogs.

Switching to an activation file


If you would like to activate your InputAccel Server with an activation file
instead of a hardware security key, proceed with the activation process as
described in Chapter 5, “Activating the InputAccel Server on a single
computer using an activation file,” on page 110.
When exiting the activation key entry dialog, make sure to remove your
hardware security key as prompted and follow the upgrade instructions at the
EMC Captiva Product Activation Portal
(http://activation.captivasoftware.com).

Activating an InputAccel Server on an MSCS Cluster


using an activation file
You can activate an InputAccel Server on an MSCS Cluster using an
activation file and activation key provided by EMC Captiva. You must request
an activation key for each node.
Ensure that each cluster node is running the Microsoft Cluster Service.

111
Installation and Configuration Guide

Obtaining activation keys


First Node
For the first node:
1. At the end of the InputAccel Client installation, leave the Launch the
InputAccel Administration module check box selected and select Fin-
ish.
2. Log into Administrator. The Server Activation Status dialog appears.
Select Yes to activate the InputAccel Server.
3. In the Install Activation File/Activate Server dialog, select the I want to
load an activation file check box to enable the Browse button.
4. Browse to the location of the .caf file you received from EMC Captiva,
and then select Next to install it. Do not install it by manually copying it
into the \IAS directory.
5. Write down the server ID and profile ID values and your node name.
Select Cancel to exit the wizard. A message displays indicating that you
are now activated in a grace period. The grace period provides fully
functional operations for a limited time until you obtain an activation key.
Remaining nodes
For each node except the first node:
1. Run Administrator to connect to the cluster node. Ignore any grace period
warning messages.
2. Select Server > Install/Activate Activation File from the menu. Select
Next to skip the .caf file install.
3. Write down the server ID and profile ID values for this node.
4. If this is the last node, select the link on the dialog and follow the
instructions to obtain activation keys from EMC Captiva using the server
ID and profile IDs you have collected.
5. Select Cancel to exit the wizard. A message displays indicating that you
are now activated in a grace period. The grace period provides fully
functional operations for a limited time until you obtain the activation
keys.

112
Chapter 5: Activating the InputAccel Server

Activating after you receive keys


For each node:
1. Run Administrator to connect to the cluster node. Ignore any grace period
warning messages.
2. Select Server > Install/Activate Activation File from the menu. Select
Next to skip the .caf file install.
3. Type in your activation key using a key that was generated from the
displayed profile ID, then select Finish. Note keys are different for each
node because they depend on the profile ID.
Note: If your activation key is rejected when you select Finish, you
may have mistyped it, or the Server ID or Profile ID may have changed
since you requested the key. The Profile ID value is computed based on
a hardware profile snapshot of the machine at the time that you run the
wizard.
4. Select OK through the remaining dialogs.

113
Installation and Configuration Guide

114
6
Chapter

Common Installation
Topics
There is some installation information common among both client installation
and server installation.
Review the following information applicable to both client and server
installation:
Special information for the installer . . . . . . . . . . . . . . . . . . . . . . . . . 116
Silent Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Modifying the Services file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Modifying Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Removing Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Repairing Installations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Viewing Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Reading Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

115
Installation and Configuration Guide

Special information for the installer


„ The installer must be run on the workstation where features are being
installed, removed or repaired.
„ If you copy the InputAccel installation CD, then the volume name of
the copied CD must match the volume name of the original CD. You
will be able to install and remove with a copied CD whose volume
name does not match the volume name of the original CD, but you will
not be able to modify or repair with it.
„ If you copy the InputAccel installation media to a network drive and
install from that drive, then you must indefinitely retain the .msi and
data1.cab files in that location or you will only be able to remove the
installation. The .msi file is the Microsoft installer package used by the
InputAccel setup program to install InputAccel and InputAccel Server.
„ If you are installing the InputAccel Server from setup files that are
located on a network or mapped network drive, then you may see a File
Download dialog warning you that the files may not be safe and
prompting you for an action. This dialog is the result of security
enhancements in the Microsoft Windows operating system. The setup
files are safe to open. You can handle this message in either of the
following ways:
„ Select Open in the File Download dialog to proceed.
„ Before starting server setup, change the Privacy settings of Internet
Explorer to add setup.exe to the list of Trusted Sites.

116
Chapter 6: Common Installation Topics

Silent Installations

Silent installation mode information


„ EMC Captiva has tested and supports only a sub-set of the standard
Microsoft Installer command-line switches and properties. We
recommend that you use only those switches, parameters and properties
that are described in this guide. See “Command-line instructions” on
page 181 for more information.
„ Installer switches and parameters are case sensitive and must be typed
in the case shown in the examples.
„ Installer properties are case sensitive.
„ InputAccel features are case sensitive and all letters must be uppercase.
„ Silent installation will not install .NET version 1.1. To install .NET,
install InputAccel Client interactively to run the installer again after
your silent installation. You can cancel the interactive installation after
you have installed .NET. You must install .NET on client workstations
that use .NET functionality. Alternatively, you can download .NET
from the Microsoft web site.
„ Silent installation will not install VBA64 unless you use ADDLOCAL
= ALL. This installs the VBA6.4 installation files to Program
Files\VBA and Program Files\VBA\[locale]. You are responsible for
installing these files after the client installation has completed. Note:
There are two VBA64 installation files. You must run both installers for
both InputAccel Client and InputAccel Server.

117
Installation and Configuration Guide

Using the installer in silent mode


Silent installation mode processes all instructions without displaying a user
interface.
From a command prompt or batch file, and through MSI commands, you
specify the features you want to install, remove, or repair, and MSI executes
your instructions without further interaction on your part.
„ Type your commands in a command prompt window (or use the Run
command on the Start menu)
„ Create a batch file that contains the desired instructions.
See “Supported InstallShield switches” on page 182, and “Supported MSI
properties” on page 186, for complete descriptions of the supported switches,
properties and their associated parameters.

Note: There is a setup.exe in the root installation directory that runs a “master”
installer from which the InputAccel Server, client software, and other programs
may be installed. This setup.exe does not accept parameters or switches when run
from a command prompt. The instructions for performing command line
installations uses the setup.exe located in the D:\IAServer subfolder for server
installation and C:\IAClient subfolder for client installation.

The InputAccel client and server installers enable you to perform silent
installations of InputAccel server and modules. Silent installations (also
known as a command line installations) require no user interaction in order
for the installation to complete after the installation process begins.

Note: You must manually install client versions of .NET and client and server
versions of VBA64 if you perform a silent installation.

Required Windows Installer commands


Note: All command-line examples in these instructions must be typed on one
command line (which may wrap to multiple lines in a command prompt window).

To perform a silent installation of InputAccel server or modules, you must


always include the following on the command line or in a batch file
(separating each switch or parameter with a space):

118
Chapter 6: Common Installation Topics

„ Executable name of the installer (setup.exe)


You must type the InstallShield executable name (setup.exe). If you are
writing a batch file, then you may place other non-InstallShield-specific
commands on lines preceding this command, but this command starts
the installer.
„ InstallShield command line arguments
Next, type any InstallShield command line arguments you wish to use.
These must precede any msiexec command line arguments you wish to
use.
„ Type /V followed by msiexec command line arguments in quotes
Next, provide the desired Microsoft msiexec command line arguments
by enclosing the entire set of arguments in quotation marks
("arguments"), including any special characters required by the
arguments. For example, enable logging of installer messages to the file
c:\logs\IASlog.txt as follows:
setup.exe /V"/l*v c:\temp\logfile.txt"
Note that the “/V” is an InstallShield argument and the “/l*v” are
msiexec arguments.
„ Installer interaction level
Within the Microsoft Installer arguments, indicate the type of
interface (if any) that should be shown during installation. The /q
and /qn switches both indicate that no user interface or message
boxes should be shown during the installation process.
„ Installer action (for example: /i)
Within the Microsoft Installer arguments, specify whether features
should be installed (/i). The repair (/f) and remove (/x) arguments
should not be used. Note that you need not specify the “install”
argument (/i) because this is the default. (For more details about each
of these options, see “Supported InstallShield switches” on
page 182.
Note: Unlike previous InputAccel installers, you no longer specify the
installation file. If you have existing scripts for installing InputAccel,
then you must remove this parameter from them before installing the 5.3
release.

119
Installation and Configuration Guide

Optional Microsoft Installer commands


„ Log file
Because a silent installation displays no dialogs, we recommend that
you use the optional /l switch to specify a Microsoft Installer (MSI) log
file, as follows:
setup.exe /V"/l*v c:\temp\logfile.txt"
We recommend that you include the “*” wildcard parameter
(encompasses all parameters except the verbose parameter) along with
the “v”, or verbose, parameter, to create a detailed log of the
installation. See “Reading Log Files” on page 126 for more
information.
Note: The log file directory and name must be within the quotation marks
that delimit the Microsoft Installer arguments (for example, "/l
d:\temp\logfile.txt").

„ Feature names
You can control a silent InputAccel installation by specifying feature
names with the ADDLOCAL, REMOVE, REINSTALL,
ADDDEFAULT, and REINSTALLMODE properties. See “InputAccel
client feature names” on page 192 for more information.)

Modifying silent installations


Adding features and modules
To add a feature or a list of features, use the ADDLOCAL property. (See
“Supported MSI properties” on page 186 for more information.) For example,
if you want to modify your installation by adding the base .iap files, then the
command-line would be:
setup.exe /V"/qn ADDLOCAL=BASE_IAP_FILES /l*v
C:\logs\modify.log"
If you want to modify your installation by adding the IMAGE and INDEX
features, then the command-line would be:

120
Chapter 6: Common Installation Topics

setup.exe /V"/qn
ADDLOCAL=IMAGE,INDEX,COM_RUNTIME,VBA64 /l*v
C:\logs\modify.log"

Note: Whenever you specify adding an individual features (such as the Scan
module in the command line above), you must also specify two additional features
as shown: COM_RUNTIME and VBA64

Removing features and modules


To modify your installation by removing a feature or a list of features, you use
the REMOVE property also in conjunction with the /i switch. (See
“Supported InstallShield switches” on page 182 for more information.) The
following example will remove the base .iap files while providing a log of the
procedure:
setup.exe /V"/qn REMOVE=BASE_IAP_FILES /l*v C:\logs\remove.log"
After removing features, repair your installation. See “Repairing
Installations” on page 124 for further information.
To modify your installation by removing a feature or a list of features, use the
REMOVE property. The following example will remove the WATCH and
COPY modules while providing a log of the procedure:
setup.exe /V"/qn REMOVE=WATCH,COPY /l*v C:\logs\remove.log"

121
Installation and Configuration Guide

Modifying the Services file


The Services file contains Windows TCP (Transmission Control Protocol)
port assignments for your computer. During InputAccel Server installation,
the setup program checks your Services file to determine whether or not it
contains the correct port assignments.If the setup program determines that the
port assignments are not correct, then it prompts you to modify the Services
file.

Note: If you do not modify your Services file with the correct port assignments,
then the InputAccel features will not work. Therefore, we recommend that you
allow the installation program to modify this file.

If you would rather not let the setup program modify the Services file, then
you can edit the file to manually change the default port assignments
(inputaccel 10099/tcp and inputaccel_rev 29479/tcp), but the server and all
clients must be assigned the same ports to communicate. Be sure to back up
the Services file before making manual changes.

Note: The port specification requires a compatible pair of TCP ports. To compute
a compatible pair of ports for the inputaccel and inputaccel_rev assignments:
1. Determine a decimal port number for the inputaccel port. (Example: 5040)
2. Convert this value to hexadecimal. (Example: 13B0)
3. Swap the most-significant and least-significant bytes (Example: B013)
4. Convert the new value back to decimal. (Example: 45075)
5. Specify the original value (5040) for the inputaccel port and the derived value
(45075) for the inputaccel_rev port.

Note: If you install using silent mode, then the Services file is automatically
modified with the correct port assignments.

122
Chapter 6: Common Installation Topics

Modifying Installations
There are two ways to initiate the modification process on your server or
workstation.
„ Select Add/Remove Programs from the Control Panel, highlight the
InputAccel Server item or InputAccel Client item and select the
Change button.
„ Run the InputAccel 5.3 setup program and select the InputAccel
Server 5.3 InputAccel Server item or the Client Modules 5.3 item in
the main setup window.
Either of these methods displays the InputAccel Server installation welcome
dialog.

Note: If for any reason you create a batches folder in a location different than the
default (IAS\batches), then you must ensure that it has read and write permissions
to the InputAccel Server process or the user running the server as an application.

Removing Installations
This section provides information about removing InputAccel features from
your computer.

Note: Some files may be used by applications other than InputAccel; these files
may not be removed from your system. This behavior is normal for shared files
and should cause no problems to your InputAccel installation or to your other
installed applications.

123
Installation and Configuration Guide

Removing the InputAccel Server and client modules


interactively
To remove the InputAccel Server or client modules from a system:
1. Open Control Panel and start the Add/Remove Programs applet.
2. Scroll down Add/Remove Programs Properties list and select
InputAccel Server 5.3 or InputAccel Client 5.3, then select Change.
The installation welcome dialog appears for the server or client modules,
depending on your selection.
3. Select Next.The Program Maintenance screen appears.
4. Select Remove and select Next. Follow the instructions as they appear to
complete the removal process.
Note: If you are uninstalling client modules that are running as services, then you
may be prompted to stop those services before you can continue.

Repairing Installations

Repairing the InputAccel Server and client modules


interactively
To repair InputAccel Server 5.3 after removing a feature, you must use the
same InputAccel Server 5.3.msi file you used to install the original server.
To repair your InputAccel Client 5.3 system after removing selected modules
or an entire service pack you must use the same InputAccel Client 5.3.msi
file you used to install the original system. If you installed from a CD, then
you need to use the same CD (or a copy of the CD with the same volume
name) to repair. If you copied the original InputAccel 5.3 installation files to a
network drive and installed the server from there, then use the same network
drive to repair:

124
Chapter 6: Common Installation Topics

1. If you are repairing the server from a network drive, then double-click
setup.exe in the top-level installation folder. If you are repairing from
CD, then place the CD in the CD-ROM drive. The main setup window
appears.
2. Select InputAccel Server 5.3. The server installation setup program
starts and the welcome dialog appears.
3. If you are repairing client modules from a network drive, then double-
click setup.exe in the Program Files\InputAccel\Client directory. If you
are repairing from CD, then place the CD in the CD-ROM drive. The
main setup window appears.
4. Select Client Modules 5.3. The client installation setup program starts
and the welcome dialog appears.
The following steps apply to both server and client module repairs:
5. Select Next. The Program Maintenance dialog appears.
6. Select Repair and select Next.
7. Follow the instructions as they appear to complete the repair process.

Viewing Log Files


The information written to a log file depends on the parameters you specify
with the /l switch. You should use the ‘*’ (wildcard) parameter along with the
‘v’ (verbose) parameter so that the log file provides detailed installer
information.
Along with the switch and parameters, you must also specify the path and
name for the log file (e.g., setup.exe /V"/l*v C:\sp1_install.log").

125
Installation and Configuration Guide

Reading Log Files


How to read the log file
The verbose log includes an entry for each feature and component the
installation package may install. The log tells the state of that feature or
component prior to the installation, the request state for the installation, and
the state in which the installer left the feature or component. Feature and
component entries in the log appear as follows:
Server:
MSI (c) (F9:F9): Feature: IASPMDLL_DLL; Installed: Absent;
Request:Local; Action: Local
This log entry indicates that the installation state of the Performance Monitor
feature and component was absent before running the package (Installed:
Absent;), that the package requested a local installation (Request:Local;),
and that the feature and component were both left in the locally installed state
after running the package (Action: Local).
The verbose log has an entry for each file that may be installed by the
package. The log tells what was done to the file and provides some
explanation.
The following shows some examples of log file entries along with a short
description:
MSI (c) (F9:F9): File: C:\Program
Files\InputAccel\Server\binnt\iaspmdll.dll; Overwrite; Existing file is a
lower version
This log entry indicates that the installer will overwrite the existing
iaspmdll.dll file because the version of the existing file is the lower than the
version being installed.
The verbose log includes an entry for the properties of features and
components the installation package may install. The following examples
show custom properties created for installing InputAccel products:

126
Chapter 6: Common Installation Topics

Property(C): BACKUP_DIR = C:\Program


Files\InputAccel\Server\backup\5.3.1.0\
The example above shows the directory in which some files may be backed
up.
Feature and component entries in the log appear as follows:
Client modules:
MSI (c) (F9:F9): Feature: COPY; Installed: Absent; Request:Local;
Action: Local
This log entry indicates that the installation state of the COPY feature and
component was absent before running the package (Installed: Absent;), that
the package requested a local installation (Request:Local;), and that the
feature and component were both left in the locally installed state after
running the package (Action: Local).
The following shows some examples of log file entries along with a short
description:
MSI (c) (F9:F9): File: C:\Program Files\InputAccel\Client\binnt\iacopy.exe;
Overwrite; Existing file is a lower version
This log entry indicates that the installer will overwrite the existing
iacopy.exe file because the version of the existing file is the lower than the
version being installed.
The verbose log includes an entry for the properties of features and
components the installation package may install. The following examples
show custom properties created for installing InputAccel products:
Property(C): BACKUP_DIR = C:\Program
Files\InputAccel\Client\backup\5.3.1.0\
The example above shows the directory in which some files may be backed
up.
Property(C): FOUND_IPI =
C:\ProgramFiles\InputAccel\Client\BINNT\iaipi.exe

127
Installation and Configuration Guide

The example above shows that the executable file of the IPI feature,
regardless of its version, was found in C:\Program
Files\InputAccel\Client\BINNT\iaipi.exe.
Property(C): FOUND_CURR_IPI = 0
The example above shows that the version of the IPI feature that was found is
not current to or greater than the upgraded IPI feature the service pack is
attempting to install.

128
7
Chapter

Licensing InputAccel
InputAccel uses a licensing system that enables EMC Captiva as well as third-
party module developers to regulate how their software is used in an
InputAccel installation. Licensing works by installing a set of license codes
on the InputAccel Server. The license codes are uniquely keyed to the Server
ID that the InputAccel Server retrieves from the its security key. This security
key can be a hardware security key, or an InputAccel Captiva Activation File.
Each license code can specify a single module and regulate how many copies
of the module can connect to the InputAccel Server at once, how many pages
it is allowed to process, how long the license is allowed to work, and what
extra features are enabled.
The Administrator module is one of the primary tools you can use to install,
update, and view InputAccel licenses. This section describes InputAccel
licensing and how you can use the Administrator module to administer
licenses.

129
Installation and Configuration Guide

Installing license codes


When you receive your InputAccel product package, it should include license
codes in the form of a text file named ServerID.lic, where ServerID is the
InputAccel Server identification number stored in your hardware key or
activation file.
You can install your license codes through the Administrator module in two
different ways:
„ Import license codes from a file - Use a wizard to automatically install
license codes from your license file (.lic). For details, see “Importing
license codes from a file” in the Administrator Module Online Help
installed with the module.
„ Manually type license codes - Use a form to type your license codes
manually. This method requires that you have a printout or a screen shot
of your license file. For details, see “Manually entering license codes”
in the Administrator Module Online Help installed with the module.

ScaleServer licensing
To configure a ScaleServer group, you must obtain server and client licenses
that enable the ScaleServer technology.

Server licenses
Each InputAccel Server that is to become a part of a ScaleServer group must
have a license that uses feature codes to specify a number called the
ClusterBase. All InputAccel Servers that are to be configured within the same
ScaleServer group must have the same ClusterBase number, and this number
must be greater than or equal to the number of individual InputAccel Servers

130
Licensing InputAccel

to be included in the group. For example, if you want to configure four


InputAccel Servers within a single ScaleServer group, then ClusterBase must
be 4 or higher.
The ClusterBase number is set using server feature codes B through F as a
binary number, where F is the least-significant digit.

Table 6: Server feature codes for ClusterBase


Server license feature codes B through F establish the ClusterBase from 1 through 16

ClusterBase Feature code


1a - - - - F

2 - - - E -

3 - - - E F

4 - - D - -

5 - - D - F

6 - - D E -

7 - - D E F

8 - C - - -
a. A ClusterBase value of 1 is not useful—it enables a single InputAccel Server in the
ScaleServer group. This is equivalent to using a standalone InputAccel Server.

Contact your authorized InputAccel sales or support representative to obtain


the required server licenses.

Note: Server feature codes are integral to the server license code. You cannot
arbitrarily change feature codes. If you need to change the ClusterBase number,
then you must contact your EMC Captiva sales or support representative to obtain
new license codes for each of your servers.

131
Installation and Configuration Guide

ScaleServer Client licenses


Each InputAccel client module that you want to use with multiple server
connections must have a license that specifies feature code X. (Each module
also must be one that is ScaleServer-certified. ScaleServer-certified modules
are listed in the ScaleServer Overview.)
Contact your authorized InputAccel sales or support representative to obtain
the required module licenses.

Note: Module feature codes are integral to the module license codes. You cannot
arbitrarily change feature codes. If you do not have the proper licensing for
connecting your modules to multiple InputAccel Server in a ScaleServer group,
then you must contact your EMC Captiva sales or support representative to obtain
new license codes for the affected modules.

Note: No special licensing is required for modules that only connected to a single
server at a time, regardless of whether or not the modules are ScaleServer certified.

ScaleServer registry configuration


After you have installed all of your InputAccel Servers and configured them
with identical ClusterBase values through the server license feature codes,
you next must assign the servers to a ScaleServer group. You do this by using
the Administrator module.

Registry values
Even though you use the Administrator to configure ScaleServer registry
values, it can sometimes be important to know which registry values are being
set and what they mean. See also “Server registry values” on page 202 for
more information on these and other server registry values.

Cluster
Making a ScaleServer group involves connecting to each of the InputAccel
Servers that are to be a part of the group, designating a Group Name, and then
adding each of the InputAccel Servers to the group. The Administrator

132
Licensing InputAccel

module writes a string value to the Windows registry on each of the


InputAccel Servers being configured named “Cluster” that contains a
semicolon-separated list of these items.
GroupName;Server1;Server2;Server3;Server4

ClusterNumber
In addition to the “Cluster” value, each InputAccel Server in a ScaleServer
group must have a unique “ClusterNumber” registry value greater than or
equal to 0 and less than the ClusterBase established by the servers’ license
feature codes. The Administrator module also takes care of this detail by
ensuring that the ClusterNumber value is unique, and by preventing you from
adding more servers than your ClusterBase allows.

Registry value location


The two registry values required by a ScaleServer group are stored in the
following key:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\InputAccel\
Parameters

Example
Registry values for each of three InputAccel Servers that are to be part of the
ScaleServer group named “Eng”:
EngServer1
„ Cluster: Eng;Eng_Server1;Eng_Server2;Eng_Server3
„ ClusterNumber: 0
EngServer2
„ Cluster: Eng;Eng_Server1;Eng_Server2;Eng_Server3
„ ClusterNumber: 1
EngServer3
„ Cluster: Eng;Eng_Server1;Eng_Server2;Eng_Server3
„ ClusterNumber: 2

133
Installation and Configuration Guide

In addition, the ClusterBase value encoded in the license feature codes for
each InputAccel Server must be 3 (EF) or greater.

Note: After you create or modify a ScaleServer group, all InputAccel Servers that
are a part of the group must be stopped and restarted before your changes take
effect.

Understanding license fields


If you view your licensing information in Administrator (or if you need to
type your license codes manually in Administrator), then you will notice that
there are several fields that control InputAccel licensing.
Each of the licensing fields is described briefly below.
„ Order
Ordinal indicating the order the license codes were installed on the
server.
„ Name
Specifies the module, group, or server to which the remaining licensing
fields are applied.
„ Connections
Specifies the number of simultaneous connections that are allowed for
the module or group. Or, in the case of the Server, this value indicates
the total number of modules that are permitted to connect to the system
at once. If this value is 0 or says unlimited, then an unlimited number of
connections is allowed.
Note: If a module or group is permitted an unlimited number of
connections, but the Server is not, then the Server limitation prevails.

„ Pages
Specifies the number of pages or transactions that the module or group
is permitted to process. Or, in the case of the Server, this value indicates

134
Licensing InputAccel

the total number or pages or transactions that may be imported or


scanned into the system. A value of 0 or unlimited indicates there is an
unlimited number of transactions permitted.
Note: In some cases, the actual number of pages permitted is determined by
multiplying Connections times Pages.

„ Valid Until
Specifies the last date the license code is allowed to work. The format
of the date is YYMMDD where any YY value less than 95 is treated as
2000+YY and values greater than or equal to 95 are treated as
1900+YY. If this field is blank, contains only a “-”, contains only a 0, or
says unlimited, then the license code does not expire.
„ Enter by
Specifies the last date by which the license code must be entered into
the system. Entering the license code into the system after this date will
result in “Entered Too Late” status in the License window. The format
of the date is YYMMDD where any YY value less than 95 is treated as
2000+YY and values greater than or equal to 95 are treated as
1900+YY. If this field is blank, contains only a “-”, contains only a 0, or
says unlimited, then the license code is a daily license and does not need
to be entered on or before any particular date.
„ Features
Specifies any special features that are enabled for the module or group.
Each character displayed in the Features field will represent an enabled
feature in the module. For example, the Image Enhancement module
may have the “D” feature code to enable the Extended Bar Code
Detection filter. All modules can support a special feature “Y” which
indicates the module is only permitted to run on the same physical
computer as the server.
„ Issue Date
Specifies the date the license code was issued or generated. The format
of the date is YYMMDD where any YY value less than 95 is treated as
2000+YY and values greater than or equal to 95 are treated as
1900+YY.

135
Installation and Configuration Guide

„ Disables
Specifies the license codes, modules, or issue dates that must be
disabled in order to enable the current license code. An entry in this
field will result in the server automatically identifying and disabling all
other licenses that this license specifies in its disables field. If the field
is blank, then no other licenses are disabled by this license.
„ License code
Specifies the unique license code number that activates all of the fields
for the license.
„ Status
Specifies the usability status of the license code.
„ Server
Specifies the name of the server where the license code is installed.

Understanding license types


InputAccel allows for many types of licensing, depending on your processing
needs, including daily (page 136), group (page 138), periodic (page 139),
service bureau (page 139), and universal client licenses (page 140).

Daily licenses
A daily license enables a given number of pages to be processed per day. Each
night at midnight, the number of pages processed is reset to zero; and the
system can then process up to (but not exceeding) the given amount of pages
until the next day when the count is set back to zero again.

136
Licensing InputAccel

The total amount of pages that can be processed per day is determined
differently for individual modules vs. the InputAccel Server:
„ Module daily licensing
The number of pages that an individual module is licensed to process
per day equals the number of pages allowed in your license multiplied
by the number of module connections allowed (Pages x Connections).
„ Server daily licensing
The total number of pages that the InputAccel Server is licensed to
process per day equals the total number of pages that can enter the
system in one day, regardless of how many modules are allowed to
connect to the Server.
The following example is of a part of a license printout. It helps illustrate the
differences between module licensing and InputAccel Server licensing:

Module Connections Pages Val Until Entr by Issued Codes

IASCAN 5 500 Unlimited - 011104 23806-51049

Server 10 2500 Unlimited - 011104 23806-51049

In this example, the Scan module (“IASCAN”) is licensed for 5 connections


and 500 pages. This basically means that up to 5 Instances of Scan may
connect to the InputAccel Server at once, and each Instance may process an
average of 500 pages each. Overall, this license allows up to 5 Instances of
Scan to process 2,500 (5 x 500) pages a day.
The InputAccel Server (“Server”) is licensed for 10 connections and 2500
pages. Unlike with IASCAN, however, these numbers are not multiplied to
determine the number of pages the InputAccel Server can process. The
InputAccel Server can only 2,500 pages a day total, regardless of how many
modules connect.

137
Installation and Configuration Guide

Group Licenses
A group license pools page counts and/or connections amongst various
modules. Individual modules reference the group license to determine the
number of pages they can process and/or the number of module Instances that
can connect to the InputAccel Server.
The following example is of a part of a license printout. It helps illustrate how
group licenses are distributed:

Module Connections Pages Val Until Enter by Issued Codes

GROUP1 10 10000 081104 071105 061021 3471-81698

SSOCR GROUP1 GROUP1 Unlimited - 061021 11409-88882

IAINDEX GROUP1 GROUP1 Unlimited - 061021 10879-21074

In this example, the group license (“GROUP1”) is licensed for 10 connections


and 10,000 pages. The ScanSoft OCR module (“SSOCR”) and Index module
(“IAINDEX”) are both members of the group. This means that up to 10
Instances of SSOCR and Index may connect to the InputAccel Server at once,
and process a total of 10,000 pages between them before the expiration date of
the group.
With group licenses, as with all non-daily licenses, page counts are not reset
every night. Instead, the modules in the group may continue processing until
the specified page limit or “Valid Until” date is reached (whichever comes
first). After the this limit is reached, the license becomes invalid and a new
license must be issued.

Note: As with all non-daily licenses, group licenses have an “Enter By” date (in
the example above it is November 5, 2007). If the non-daily license is not installed
on or before this date, then the InputAccel Server will consider the license invalid.

138
Licensing InputAccel

Periodic licenses
A periodic license is a type of group license. It is generated in a manner
similar to most non-daily licenses except that its page count is reset to zero on
a regular basis (generally monthly or annually).
The following example is of a part of a license printout. It helps illustrate how
periodic licenses are distributed:

Module Connections Pages Val Until Entr by Issued Codes

ANNUAL Unlimited 1000000 Unlimited 071105 061021 8053-11137/A

Server Unlimited ANNUAL Unlimited - 061021 36433-98777

In this example, the InputAccel Server (“Server”) is part of the group called
“ANNUAL.” This means that the number of pages that the Server can process
is dependent on the Annual license (which in this case, can process 1,000,000
per year).
As with daily licensing, after the expiration date is reached, the number of
pages processes is reset to zero; and the system can then process up to (but not
exceeding) the given amount of pages until the next period end is reached and
the count is set back to zero again. No new license needs to be created.

Note: Even though the Valid Until date is unlimited in the example above, this
license does have an expiration date. The “/A” in the Annual license Code number
for the group indicates that the license is only valid for one year. Similarly, a “/B”
in the code number would indicate that the license was only good for half a year
(bi-annual) and“/M” indicates a month. The date used to reset the page count is
based on the “Issued” date of the license.

Service bureau licenses


The service bureau license package is a special type of group license designed
for customers who perform contract information capture and require licensing
based on their contract size. The service bureau group license name begins
with “GROUP,” such as “GROUP1” and “GROUP2.” The customer can
process pages using any or all modules, as long as they are licensed under the

139
Installation and Configuration Guide

service bureau group license. With a service bureau license, all export
modules have unlimited page counts and the InputAccel Server license uses
the service bureau group license to set its page count.
The following example is of a part of a license printout. It helps illustrate how
service bureau licenses are distributed:

Module Connections Pages Val Until Entr by Issued Codes

GROUP1 10 1000000 081104 071105 061021 10769-43491

IAAQA GROUP1 GROUP1 Unlimited - 061021 11409-88882

IAIPI GROUP1 GROUP1 Unlimited - 061021 10879-21074

IAEXIMG GROUP1 Unlimited Unlimited - 061021 19890-28832

Server 10 GROUP1 Unlimited - 061021 23116-88825

In this example, the InputAccel Server can have 10 module connections at any
one time, and all 10 of those connections can be simultaneously used by the
IAAQA, IAIPI, and/or IAEXIMG modules. The InputAccel Server, IAAQA
module, and IAIPI module can process up to 1,000,000 transactions combined
before November 5, 2008.

Universal client license


The universal client license package is a special type of group license that
controls the amount of pages processed through the InputAccel Server (as
opposed to through the individual modules). Page counts track the number of
pages that enter the system, regardless of which or how many modules
process the page. Module page counts, therefore, are set to “Unlimited.”
In contrast to the page count, the InputAccel Server connections are
controlled through the universal client group license. The Server contains one
connection that all universal client modules must share. If you try to run more
than one module from one universal client at once, then you will receive a
“License Exceeded” error. For this reason, most customers purchase more
than one universal client license. For each universal client license you buy,
you may connect one universal client module.

140
Licensing InputAccel

The universal client license comes with a standard set of InputAccel modules,
all of which are licensed under a non-daily group license. It is possible,
however, to buy additional licenses outside of the pre-defined module set.
These additional modules usually have an unlimited page count and are
licensed on a daily basis. (For example, the Scan module must be purchased
separately, since its license is based on the type of scanner being used and the
features it supports. Custom export modules are also frequently licensed
outside of the standard universal client license.)
When a daily or periodic InputAccel Server license is purchased, it is
typically bundled with a universal client package and one export module of
the customer’s choice.
The following example is of a part of a license printout. It helps illustrate how
universal client licenses are distributed. Note that the highlighted sections
indicate a universal client license whose modules are licensed under the group
license, “GROUP1.”

Module Connections Pages Val Until Entr by Issued Codes

Server 20 100000 070930 - 061001 23116-888825

GROUP1 1 Unlimited Unlimited 061101 061001 8782-85458

Module Connections Pages Val Until Features Issued Codes

IAAQA GROUP1 GROUP1 Unlimited 061001 14186-64834

IAINDEX GROUP1 GROUP1 Unlimited 061001 2723-23298

IAIPI GROUP1 GROUP1 Unlimited BD 061001 18169-43603

IAIQA GROUP1 GROUP1 Unlimited 061001 17579-91651

SSOCR GROUP1 GROUP1 Unlimited 061001 5479-37218

IARESCAN GROUP1 GROUP1 Unlimited D 061001 16115-84211

IAEXIDX 4 Unlimited Unlimited 061001 12081-92731

IAEXIMG 4 Unlimited Unlimited 061001 763-72882

IAEXPDF 4 Unlimited Unlimited 061001 2149-65186

IAEXFAF 1 Unlimited Unlimited 061001 8-91590

IASCAN 2 Unlimited Unlimited D 061001 674-76146

141
Installation and Configuration Guide

In this example, the following modules have been individually licensed


outside of the universal client GROUP1 license: the InputAccel Server,
IAEXIDX, IAEXIMG, IAEXPDF, and IASCAN. Only one of the universal
client modules are allowed to connect to the InputAccel Server at one time,
but the InputAccel Server can accept up to 19 more connections from the non-
universal client modules combined. All modules are allowed to process as
many images as desired, but the InputAccel Server license limits the amount
of pages that can be scanned into the system to 100,000 pages a day. Also note
that up to two IASCAN modules can connect to the InputAccel Server at
once.

Calculating page counts


When calculating how your page count will be decremented, you must
consider what type of license you are using:
„ Server licenses
A server license only decrements your page count when a page enters
the system. For example, if you a scan a page into a Batch using the
Scan module, then the page count of the InputAccel Server is
decremented. If that same page is then routed to Image Enhancement
and Image Export, then the page count of the InputAccel Server is not
decremented, because the page is already in the system. Pages may
enter the InputAccel system (and decrement your server page count) via
any of the following modules:
„ Scan
„ Rescan
„ ECM Web Service Importer
„ Ricoh GlobalScan plug-in
„ Watch

142
Licensing InputAccel

To view the number of transactions processed by each module, group, or


server, use Modules window in the Administrator module. (For more
information, see “Modules window” in the Administrator Module Help
installed with the module.)

Note: Your page count will not be decremented in the following cases:
„ If a Task is not completed with a Success (0) status, then the page count of the
corresponding license will not be decremented. With most modules, this means
that if the Task encounters an error during processing or is cancelled, then the
pages in that Task will not decrement your page count.a
„ If you have the Discard Page option selected for an event (such as a blank
page or patch code) in the Scan or Rescan Scanner Event Actions tab, then
that type of event page will not affect your page count. For example, if you
configure Scan to detect and discard blank pages, then the page count of the
Scan module will not be decremented when a blank page is scanned into the
system.
a. Note that some export modules always return a Success status, even if an error occurs during
processing. With these modules, the page count will be decremented, even if an “error” occurs.
See the help for the individual export module for more information.

143
Installation and Configuration Guide

144
8
Chapter

Configuring InputAccel
This chapter includes the following instructions for configuring the
InputAccel environment:
Defining users and groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Choosing an InputAccel Server startup mode . . . . . . . . . . . . . . . . . . 147
Choosing a startup mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Running the InputAccel Server manually . . . . . . . . . . . . . . . . . . . . . 149
Running client modules as services. . . . . . . . . . . . . . . . . . . . . . . . . . 150
Granting the “Act as part of the operating system” right . . . . . . . . . 157

145
Installation and Configuration Guide

Defining users and groups

The InputAccel Server is tightly integrated with Windows. The InputAccel


Server queries Windows to authenticate user logon names and passwords and
to determine who can access batch and process files. To define permissions,
create users and groups using the Local Users and Groups snap-in of the
Computer Management dialog in the Microsoft Management Console. Refer
to Windows Help for instructions on how to display Local Users and Groups.
Then, use the Administrator module to define InputAccel access permissions
for those users and groups.
The InputAccel Server also supports domains, which means you can create a
single user list that shares user name and password information among several
InputAccel Servers. To take advantage of domains, create a single global
group containing all InputAccel users. Add this global group to a local group
on each InputAccel Server computer. Then, use the Administrator module to
set permissions for each local group. When a user and an InputAccel client
workstation logs on to any InputAccel Server, the domain controller will be
searched to validate the user name and password and determine the access
permissions of the user based on the permissions set with the Administrator
module.
If you are installing a ScaleServer group, then be sure each InputAccel Server
in the group defines the same set of InputAccel user names and passwords.
Each user who logs into a ScaleServer group must be able to log into all
InputAccel Servers using the same credentials.

146
Chapter 8: Configuring InputAccel

Note: When creating local users and groups, note that:


„ If you install the InputAccel Server on a Primary Domain Controller (PDC) or
Backup Domain Controller (BDC), then you must grant the ‘Log on Locally’
user right to all users and groups who plan to connect to the InputAccel Server
on the PDC or BDC. Grant this user right through the InputAccel installer, the
Windows Disk Management application.
„ Do not enable the guest account, which is disabled by default. If you do, then
anyone may be able to log into the InputAccel Server, even if they do not have
a valid user name or password.
„ You can only control permissions for local users and groups through the
Administrator module. You cannot use it to control global group permissions.
„ See instructions in the individual module user guides for information on
logging on to a client module using domain, department, user name, and
password information.
„ For information about defining users and groups with Active Directory, see
your Windows documentation.

Choosing an InputAccel Server startup


mode
The InputAccel Server setup program requires you to choose whether you
want to configure the workstation to run the InputAccel Server as a service
automatically when Windows starts. The following information describes the
difference in more detail:
„ Running InputAccel Server as a service
When running as a service, you cannot interact with the InputAccel
Server. The InputAccel Server executes as a background task, starting
automatically when you start Windows. If you selected this option by
choosing Yes during installation, then you have no choice—InputAccel
Server always runs as a service, and by default is set to automatically
start when the computer starts. If desired, you can stop the InputAccel
Server service and run the InputAccel Server as an application.

147
Installation and Configuration Guide

„ Run InputAccel Server as an application


To run the InputAccel Server as an application, you must be logged in
with a user account that has the “Act as part of the operating system”
right. You can grant this right during installation or using the
instructions in “Granting the “Act as part of the operating system”
right” on page 157. If the InputAccel Server is already running as a
service, then you must stop it by using the Control Panel Services
applet. Only then can you run InputAccel Server as an application.
When running as an application, you can interact with the InputAccel
Server through a command prompt. In this mode, you must start the
InputAccel Server manually.
This section includes instructions for changing the startup mode for the
InputAccel Server after it is installed. It also contains instructions for starting,
stopping, and pausing the InputAccel Server when it is running as a service.

Note: If you must pause anInputAccel Server for any reason, then be sure to stop
scanning before you pause the server.

Choosing a startup mode


Use the Services snap-in of the Microsoft Management Console to choose an
InputAccel Server startup mode. Refer to Windows Help for instructions on
how to display Services. Also use Services to start, stop, and pause the
InputAccel Server when it is running as a service.

Note: If you are not logged in using an account with the “act as part of the
operating system” right, then Windows will not allow you to change your startup
mode. To change these rights, see “Granting the “Act as part of the operating
system” right” on page 157.

To choose an InputAccel Server startup mode:


1. Start the Services snap-in in the Microsoft Management Console.
2. Select InputAccel Server from the Services list. The Services snap-in
displays the following information about the current state of the
InputAccel Server:

148
Chapter 8: Configuring InputAccel

„ The Status column indicates whether the InputAccel Server is


Started, Stopped, or Paused.
„ The Startup Type column indicates whether the InputAccel Server is
configured to startup in Automatic mode (as a service) or Manual
mode (as an application).
3. From the Action menu, select Properties. The InputAccel Server
Properties dialog appears with the General tab displayed.
4. To change the current status of the InputAccel Server, select the Start,
Stop, Pause, or Resume button.
5. To change the startup mode of the InputAccel Server, select one of the
following options from the Startup type list:
„ Automatic
When running as a service, this option should already be selected by
default. Choosing this option starts the InputAccel Server
automatically every time the computer starts.
„ Manual
Select this option if you want to run the InputAccel Server as an
application. Choosing this option requires that you to start the
InputAccel Server manually from a command prompt whenever you
want to use it.

Note: Do not select the Disabled option.

6. Select OK in the InputAccel Server Properties dialog to save changes.

Running the InputAccel Server manually


In most installations, the InputAccel Server(s) will be configured to run as a
service, starting automatically when Windows is started—you will not need to
do anything to use the InputAccel Server. There are a few occasions where
you may need to manually start, stop, or pause the InputAccel Server,
however, such as during backups or when running as an application.

149
Installation and Configuration Guide

For instructions on manually starting, stopping, or pausing the InputAccel


Server when it is running as an application, see “Choosing an InputAccel
Server startup mode” on page 147.
To manually start, stop, or pause the InputAccel Server when it is running as
an application:
1. Log into the computer as an administrator to the computer where the
InputAccel Server is installed.
2. From the Windows Start menu, select Programs > InputAccel > Server
> InputAccel Server. The InputAccel Interactive Server window
appears. When the message “InputAccel Server Ready” and the IAS>
prompt appear in the window, the InputAccel Server is running.
3. (Optional) Type one of the following commands at the IAS> prompt:
„ Type pause to pause the InputAccel Server.
„ Type continue to resume the InputAccel Server after pausing it.
„ Type quit to stop the InputAccel Server.
4. Press Enter to execute the specified command.

Running client modules as services


Some InputAccel client modules can run as services, which provides the
following advantages:
„ You do not need to launch the module in production mode. It is
always running while the client computer is running.
„ The module is set to Run All Batches. If you are processing a batch
and the next module in the process is running as a service, then the
module automatically processes the batch without any actions required
by the user.
You may not want to run a module as a service in the following
circumstances:

150
Chapter 8: Configuring InputAccel

„ You want to run only specific batches from the server. A module
running as a service will run all batches as they become available
without prompting you.
„ Your batches require manual adjustments by a user. As a service,
the module will run in the background without access to the user
interface.
The following InputAccel modules can run as a service:
„ Image Enhancement
„ Automatic Quality Assurance
„ Image Export
„ Index Export
„ Values to XML
„ Documentum Server Export
„ ODBC Export
„ IBM Content Manager Advanced Export
„ Image (Utility)
„ Multi (Utility)
„ Timer (Utility)
By default, the client module services are set to Manual (off). To begin using a
module as a service, you must start the service.

Note: Do not configure modules to run as services when using Point.Click.Scan!,


InputAccel Express, or InputAccel Capture for Documentum. These versions of
InputAccel automatically start and stop each module as necessary. Running
modules as services will interfere with this operation and result in unpredictable
and undesirable behavior.

151
Installation and Configuration Guide

Starting a module as a service


After you have installed the client modules and a connection to an InputAccel
Server is established, you can start running client modules as services from
the Windows Services dialog (Figure 7).

Figure 7: Windows Services dialog

To start a module as a service:


1. Display Windows Services dialog and select the module that you want to
run as a service.
Note: If the module that you want to start as a service is installed but does not
appear in the Services dialog, then you must re-run InputAccel setup and install
the module as a service before you can continue.

2. Select Action > Start. When the Status column for this module displays
Started, the module is running as a service.

152
Chapter 8: Configuring InputAccel

Running modules as services under a specific user account


By default, modules configured to run as services are configured to log into
the InputAccel Server using the “*” login. The “*” login passes on to the
InputAccel Server the login information for the user that is logged in when the
module was started. When starting a module as an application (that is, not as a
service), the user account that is used with a “*” login typically contains the
user name, domain, and password of the user who started the module.
When Windows starts a module as a service, the “*” account is the account
under which the service is configured to run, which may or may not be the
desired user. Typically (and by default), services run under the “Local
System” account, which passes no user name to the InputAccel Server. A
module running under the Local System account will only be able to process
batches for which “Everyone” has permissions. If a batch is designated for
processing only by a specific user account or user group, then a module
connected to the InputAccel Server under the Local System account will not
be able to process its tasks.
To specify the account used by a service:
1. Display Windows Services dialog (Figure 7 on page 152) and select the
module that you want to run as a service.
2. Select Properties from the Action menu. The Properties dialog for the
selected module appears.
3. Select the Log On tab. Note that the Local System Account option is
selected.
4. Select the This Account option, then specify the desired information in
the user name and password fields. (If desired, select the Browse button
to display the Select User dialog, which can help you specify the desired
used and verify that the user you specify is valid.)
5. Select OK to close the service’s Properties dialog.
6. Restart the service whose user account you just changed. (Your changes
will not take effect until the service stops and restarts.)
The module will now connect to the InputAccel Server using the user name
and password you must specified.

153
Installation and Configuration Guide

Note: You can also achieve the same results by specifying the -login: command
line parameter for the module as explained in the next section; however, this will
store the user name and password you specify in the client system’s registry.
Therefore, if security is an issue, you should use the Services login option just
described.

Installing a module as a service


InputAccel modules that can run as services are installed as services by
default1. However, you may need to install the services manually, such as in
the following circumstances:
„ You chose not to install client modules as services during the
installation process.
„ Communication with an InputAccel Server was not established during
the installation process. In this case, modules that can run as services
are installed as standard InputAccel modules, not as services.
„ The modules were uninstalled as services in order to change the login
parameters.
In any case, you must install the module as a service before you can start the
service.
To install a module as a service from a command line, type the following
command:
"c:\program files\inputaccel\client\binnt\modulename” -install -
login:*@server1

Note: Installing a program from the command line only installs the service, not the
application.

When a service installed successfully dialog appears, you are ready to start the
service.

1. Except for Documentum Server Export. For details, see Installing Documentum Server Export as a
service.

154
Chapter 8: Configuring InputAccel

Installing Documentum Server Export as a service


The Documentum Server Export module is not automatically installed as a
service during installation. In order to install this module as a service, you
must specify your Documentum username, password, and Docbase name.
To install the Documentum Server Export module as a service, type the
following in addition to the install command described in Installing a module
as a service:
-loginex:username,password@Docbase

Configuring the service wait time


For InputAccel modules that can run as services, you can modify the service
wait time, which is the maximum amount of time that Windows will try to
pause or stop a service after you select the Pause Service or Stop Service
button from the Windows Services dialog.
Since you cannot pause or stop an InputAccel client service while it is
processing a task, Windows will wait for the task to finish before pausing or
stopping the service. If the service wait time expires before the client service
finishes processing the task, then the Windows Services dialog will display an
error and the service will continue to remain on.
The default service wait time for InputAccel modules is 10 minutes. To
modify the service wait time, use the ServiceWaitTimeOut:x command. The
variable x should be replaced by the service wait time in seconds.

155
Installation and Configuration Guide

For example, to set the service wait time for the Image Enhancement module
(iaipi.exe) to 1 hour (3600 seconds), type the following command from a
command line:
“c:\program files\inputaccel\client\binnt\iaipi” -ServiceWaitTimeOut:3600

Note: You may want to pause or stop an InputAccel client service in the following
circumstances:
„ The service is causing a high strain on the processor of your client machine.
„ Instead of processing all batches in the order that they become available, you
want to process specific batches that have a higher priority.
„ An error in the process has been discovered, and you need to stop processing
all batches so that an administrator can make adjustments to the IPP.
„ You must perform system maintenance on your client machine.

Uninstalling a module as a service


If you do not want to run a client module as a service, then no action is
required because InputAccel client modules that can run as services are set to
Manual (off) by default.
However, you may want to uninstall the service from your Windows Services
dialog.
To uninstall a module as a service from a command line, type the following
command:
“c:\program files\inputaccel\client\binnt\modulename” -uninstall
When a Service uninstalled dialog appears, the module runs as a standard
InputAccel module.

Note: Uninstalling a program from the command line only uninstalls the service,
not the application.

To run this module as a service again:


1. Install the service.
2. Start the service.

156
Chapter 8: Configuring InputAccel

Granting the “Act as part of the operating


system” right
To run an InputAccel Server as an application, you must be logged in with a
user account that includes the “Act as part of the operating system” right. This
section contains instructions for granting that right to a user or group.
To grant a user or group the “act as part of operating system” right:
1. Log on to the computer running the InputAccel Server as an administra-
tor.
2. Start the Security Settings snap-in in the Microsoft Management Console.
3. Select the Local Policies > User Rights Assignments folder in the left
pane. A list of policies and their settings appear in the right pane.
4. Select Act as part of the operating system, then select Properties from
the Action menu.
5. In the properties dialog, select Add User or Group to display the Select
Users or Groups dialog.
6. Use the controls in the Select Users or Groups dialog to specify each user
or group who needs to be able to run the InputAccel Server as an
application, the select OK. Your changes take effect immediately.

157
Installation and Configuration Guide

158
9
Chapter

Maintaining InputAccel
This chapter includes the following instructions for maintaining the
InputAccel Server environment:
Testing the performance of the InputAccel Server . . . . . . . . . . . . . . 160
Reassessing the storage requirements of an InputAccel Server . 164
Tips for increasing the performance of an InputAccel Server. . . . . . 165
Backing up the InputAccel Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Backing up InputAccel clients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Troubleshooting during production . . . . . . . . . . . . . . . . . . . . . . . . . . 178
The InputAccel Server disconnects during long process times . 178
The InputAccel Server will not start . . . . . . . . . . . . . . . . . . . . . . 179

159
Installation and Configuration Guide

Testing the performance of the InputAccel


Server
Use the Windows Performance Monitor to track the performance of the
InputAccel Server and to determine whether your current hardware, software,
and network setup is sufficient to handle your document processing needs.
To test performance of the InputAccel Server:
1. Start the Performance snap-in in the Microsoft Management Console,
then select System Monitor in the left pane.
2. In the right pane, select the + icon (add) on the toolbar to display the Add
Counters dialog.
3. In the Select Counters From Computer list, select the name of the
computer running the InputAccel Server.
4. Determine which system elements you want to test (Table 7 ) and begin
running a typical information capture job. The Performance Monitor
begins graphing performance statistics.

Table 7: Tracking performance statistics


This table describes system elements you can test with the Windows Performance
Monitor and gives instructions for testing each.

Element Instructions
CPU To test CPU in the Performance Monitor:
1. Select Process from the Performance Object list.
2. Select %Processor Time under Select counters from list.
3. Select ias under Select instance from list.
4. Select Add. The Performance Monitor begins graphing
CPU statistics.
If the Performance Monitor tracks CPU performance at or near
100%, then your system is CPU bound. We recommend adding
CPU. If results are 70% or lower, then you have adequate CPU
to run the InputAccel Server.

160
Chapter 9: Maintaining InputAccel

Table 7: Tracking performance statistics (continued)


This table describes system elements you can test with the Windows Performance
Monitor and gives instructions for testing each.

Element Instructions
Disk To test disk space using diskperf and the Performance Monitor:
1. At a command prompt on the computer running the
InputAccel Server, type: diskperf -Y and restart the
computer. This enables Performance Monitors for the
disk(s).
2. Reopen the Performance Monitor.
3. Select Physical Disk from the Performance Object list.
4. Select %Disk Time under Select counters from list.
5. Select Add. The Performance Monitor begins graphing disk
statistics.
If the Performance Monitor tracks disk performance at or
near 100%, then your system is disk bound. We recommend
increasing disk space. If results are 70% or lower, then you
have adequate disk space to run the InputAccel Server.
6. When done, type: diskperf -N at a command prompt to
disable disk Performance Monitors.
Note: Disk Performance Monitors slow processing considerably.
Only enable them for a short period of time.

RAM To test RAM in the Performance Monitor:


1. Select Memory from the Performance Object list.
2. Select %Committed Bytes In Use under Select counters
from list.
3. Select Add. The Performance Monitor begins graphing
RAM statistics.
If the Performance Monitor tracks at or near100%, we
recommend increasing system RAM. If results are below 100%,
then you have adequate RAM to run the InputAccel Server.
Note: If you find that you must regularly access virtual memory
in order to run InputAccel, then you should increase your RAM.
Using virtual memory is considerably slower and less efficient
than using regular memory.

161
Installation and Configuration Guide

Table 7: Tracking performance statistics (continued)


This table describes system elements you can test with the Windows Performance
Monitor and gives instructions for testing each.

Element Instructions
Network I/O To test network I/O in the Performance Monitor:
1. Select InputAccel Server from the Performance Object
list.
2. Select Network Bytes Read/sec under Select counters
from list.
3. Select Add.
4. Select InputAccel Server from the Performance Object
list.
5. Select Network Bytes Written/sec under Select counters
from list.
6. Select Add. The Performance Monitor begins graphing
statistics.
7. Add both statistics together to calculate your network I/O in
bytes per second.
8. Multiply by 9 to convert the statistic to bits per second. (9
includes 8 bits per second plus one parity bit.)
If the calculation is more than 50% of your network speed, then
we recommend you take steps to increase your network
bandwidth to the computer running your InputAccel Server.

Virtual RAM To test the amount of virtual RAM being used by the InputAccel
Server:
1. Select Process from the Performance Object list.
2. Select ias from the Select instances from list.
3. Select Virtual Bytes from the Select counters from list.
4. Select Add. The Performance Monitor begins graphing
virtual memory statistics.
Note: If you find that virtual memory is being used regularly in
order to run the InputAccel Server, then you should increase the
amount of system RAM. Using virtual memory is considerably
slower and less efficient than using regular memory.

162
Chapter 9: Maintaining InputAccel

Table 7: Tracking performance statistics (continued)


This table describes system elements you can test with the Windows Performance
Monitor and gives instructions for testing each.

Element Instructions
InputAccel To track additional statistics in the Performance Monitor:
Server 1. Select InputAccel Server from the Performance Object
list.
2. Select Explain.
3. Select options under Select counters from list and read the
corresponding description under Counter Definition to
determine whether you want to graph the statistic.
Descriptions also include instructions for increasing system
performance.

163
Installation and Configuration Guide

Reassessing the storage requirements of an InputAccel


Server
Use the formula shown below to reassess your InputAccel Server storage
requirements. This formula requires that you understand how you will be
using InputAccel, including the size and throughput of images through the
system, as well as the type of processing the system will be doing. Apply this
information to each InputAccel Server in a ScaleServer group.

Note: This formula does not include the additional storage requirements of the
Windows Server that is hosting the InputAccel Server.

To estimate your InputAccel Server storage requirements, calculate:


Average Images Total pages (1+ error Estimated
x x x + Reserve =
image size per page in system factor) storage

1. Average image size


Determine the average size of the images you process. Image size varies
depending on the complexity, size, and resolution of your captured
images. An average 200 dpi binary letter size page typically requires 50
KB of storage. An average 300 dpi binary letter size page typically
requires 70 KB.
2. Images per page
Determine the number of images (stage files) per page stored by the
InputAccel Server. This number varies depending on the module
Instances defined in your process. For example, scanning a page creates
one image for storage; an Instance of Image Enhancement configured to
deskew images creates another, and a second Instance of Image
Enhancement configured to remove noise creates a third image.
3. Total pages in system
Determine the worst-case maximum number of pages in the InputAccel
Server at one time, keeping in mind that the InputAccel Server is not
intended for use as an archival system. You should generally delete a
batch after it is scanned, processed, and exported to keep the number of
pages in the system low. If you must keep batches online for long periods,
then the total number of pages stored by the InputAccel Server increases.

164
Chapter 9: Maintaining InputAccel

4. Error factor
Inflate storage calculations to allow for errors. We recommend inflating
your calculation by at least 30%.
5. Reserve
Add a reserve beyond the sum of installing and running all InputAccel
features. The minimum required reserve for the InputAccel Server is set
using the DiskReserveK registry value (default 150 MB), although we
recommend that you allow for a larger reserve. For a description of this
registry value, see Appendix B, “InputAccel Server registry values,” on
page 199.
For example, the following formula calculates InputAccel Server storage
requirements for processing images of an average 50 KB size, 2 images per
page, 50,000 pages in the system at one time, and using a 20% error factor and
a 1 GB reserve:
50 KB x 2 x 50,000 x (1+ .3) + 1 GB = ~ 7.2 GB

Tips for increasing the performance of an


InputAccel Server
To improve the performance of the InputAccel Server, we recommend:
„ Do not run dynamic disk defragmentation software on the Server
This type of utility can increase the risk of data corruption and decrease
performance of the InputAccel Server by slowing disk access and using
CPU time.
„ Do not run antivirus software on the IAS folder
Running antivirus software on the IAS folder and its subfolders will
drastically degrade InputAccel Server performance due to the number
of files being written to the directory structure. In addition, some anti-
virus programs intercept network traffic and can interfere with
InputAccel Server operation. In all cases, you should exclude the

165
Installation and Configuration Guide

InputAccel Server installation folder (C:\Program


Files\InputAccel\Server by default) and all of its subfolders from anti-
virus scanning.

Note: EMC Captiva has tested InputAccel Server with


Symantec/Norton Antivirus version 8.x and has found them to be
compatible, provided the antivirus software is set to exclude the
InputAccel Server directory as explained above. We have not tested
and cannot certify that other antivirus programs are compatible.

„ Do not run additional InputAccel modules on the Server


Due to the way Windows switches tasks, running additional InputAccel
modules on the same machine as the InputAccel Server can result in a
significant performance drop, even if the additional modules do not use
much CPU time.
„ Do not use screen savers that use a lot of CPU time
Suggestion: use a logon or blank screen for your screen saver.
„ Run InputAccel on a discrete sub-network
Create a separate sub-network for the InputAccel system and connect it
to your main network through a switching hub or a router. Segmenting
InputAccel from the rest of your network prevents the rest of your
network from causing InputAccel performance problems and vice
versa.
„ Minimize read and write operations in your IPP
Each time you specify in your IPP that a file must be read or written, the
system must open and close the file, which is a relatively slow
operation. You should keep these operations to a minimum.
„ Minimize looping through Nodes in your IPP
Looping through the nodes in a batch can be time-consuming because
the body of the loop is executed many times. You may be able to avoid
some loops by moving commands to a different Prepare or Finish event
handler or by adding trigger variables. (If you do create loops in your
IPP, then note that looping through all the Level 0 nodes in a Level 7
batch is worse than running and looping at Level 0.)

166
Chapter 9: Maintaining InputAccel

„ Optimize the number of images in your batches


The optimal number of images per batch will vary depending on many
factors, including the size of your images and the complexity of
operations you perform. Note, however, that a minimum of 10 pages per
batch is recommended.
Batches can contain a maximum of 28,672 pages; however, if your IPP
contains looping commands (see “Minimize looping through Nodes in
your IPP,” above) or will be read from and written to frequently (see
“Minimize read and write operations in your IPP” on page 166), then
you should not maximize the batch size.
If you allow more than 8,000 pages per batch, then some older, 16-bit
modules may not function properly. In particular, the 16-bit versions of
Text Export and Eastman Software OPEN/image v2.x Compatible
Export1 may be unstable when viewing or processing tasks containing
over 8,000 pages.
„ Delete batches when they are finished processing
After InputAccel has finished processing and exported a batch to your
back-end system, you should delete the batch from your InputAccel
Server. This reduces the amount of disk space required on the server
machine.
„ Modify your registry values
There are several InputAccel registry values which may improve
performance when properly tuned, including BatchMaxLoaded,
DiskReserveK, StringTraceLevel, FileTraceLevel, and DebugLevel. For
more information about any of these values, see Appendix B,
“InputAccel Server registry values,” on page 199.

1. These modules are no longer included in the InputAccel distribution; however, this information
continues to be provided for customers who are still using the module from an earlier release of
InputAccel.

167
Installation and Configuration Guide

Backing up the InputAccel Server


The InputAccel Server is not intended to be used as an archival system; it is
designed to quickly capture, process, and export information. Although you
can perform backups, a great deal of information may move in and out of the
system between scheduled backups.
If you choose to back up the files on an InputAccel Server, then we
recommend that you do it offline – stop the InputAccel Server and close all
client modules. If you want to do online backups, then we strongly
recommend that you pause the InputAccel Server during the backup. If you
are using multiple InputAccel Servers in a ScaleServer group, then backing up
and other maintenance operations are easy, because one InputAccel Server at
a time can be shut down without impacting the flow of new tasks to the client
workstations.

Note: If you decide to perform online backups, then be sure to stop scanning
before you pause the server.

Note: If you use the Windows Backup utility, copy critical files to another location
before running a backup. (The Windows Backup utility cannot back up open files.)
Also, if you do not pause the InputAccel Server during backups, then use a backup
program that automatically retries if a file is open for exclusive access, which
occurs for a few milliseconds during commits.

For instructions on how to stop, pause, and start the InputAccel Server when
running as a service, see “Choosing an InputAccel Server startup mode” on
page 147. When running as an application, see “Running the InputAccel
Server manually” on page 149.

The IAS directory


The IAS directory contains all the processes, batches, license files, user
settings, and images used by InputAccel. Most of the files you need to back
up are stored in this directory; however, there are files⎯most notably the files

168
Chapter 9: Maintaining InputAccel

in the batches directory⎯that you may not want to include in your daily
backups.
Since the files in the batches directory change many times during normal
production, backing up this directory on a daily basis is unnecessary and will
degrade the performance of your InputAccel Server; however, daily backups
of the process directory and, if you are using Point.Click.Scan! or certain
other InputAccel modules, the modules directories are very important.

The IAS executable and support files


The ias.exe file is found in the C:\Program Files\InputAccel\Server directory
on the computer where you installed the InputAccel Server. Several support
files, located in the same directory and listed below, enable ias.exe to run
IPPs.
The following table lists important files in the <%windir%>\system32
directory.

Table 8: The IAS executable and support files

File Use
iacomdll.dll Library file used to store IPP templates

iaclnt32.dll Common components for and server interface to


InputAccel modules.

The following table lists important files in the C:\Program


Files\InputAccel\Server directory.

Table 9: The IAS executable and support files

File Use
ias.exe The InputAccel InputAccel Server executable file

ias.ini Windows Performance Monitor strings for ias.exe

169
Installation and Configuration Guide

Table 9: The IAS executable and support files(continued)

File Use
iaspfc.dll Library file for use with PCF InputAccel process
language

iaspfcb.dll Library file for backward compatibility with PCF


InputAccel process language

iaspmdll.dll Library used by Windows Performance Monitor to extract


ias.exe information

iaspmsym.h Windows Performance Monitor offsets

The values.idx file


The values.idx file contains the embedded licenses, user module preferences,
and some of the security settings for processes and batches. When you restore
this file to the server with a matching hardware security key, your licensing
and preferences will also be restored so the end-user may not notice any
difference from previous sessions.
If the values.idx file is corrupted or not found in the IAS root directory when
the InputAccel InputAccel Server is started, then a new file containing default
settings will be created.
By default, the server backs up the values.idx file once every hour. The rate at
which this file is backed up is determined by the registry setting:
ValuesBackupTime (see Appendix B, “ValuesBackupTime,” on page 212).
Each time a preference is saved in a module or new licenses, license changes
are introduced, or changes to security made, this file is updated. If this file is
missing or becomes damaged or corrupted, then you will lose all your licenses
and the InputAccel System will not run.
To recover from a damaged values.idx, delete the damaged file and rename
the values.bak to values.idx, and then restart your server. If values.idx is
missing, then copy the values.bak and rename the copy to values.idx, and
then restart the server. If the values.bak is also damaged or missing, then you
need to reinstall the license and add your security setting to the processes,
modules, and batches you had before. Although the installation does not take

170
Chapter 9: Maintaining InputAccel

long, EMC Captiva highly recommends that you record your security settings
in a specification for your process.
If the InputAccel InputAccel Server was unable to read or load the current
values.idx file, then it will create a new values.idx file using default settings.
The InputAccel Server will save a backup of the values.idx file it could not
read or load as a valuesbad.00n file (where the number represented by “n” is
incremented each time a new backup file is created). These files are not
critical to restore your system, however you can use them in an emergency.

The IAS\batches directory


The InputAccel InputAccel Server is able to start without a batches directory;
however, if the server can not find the directory on startup, then a new
directory will be created automatically.
The batches directory is perhaps the most volatile directory in an InputAccel
System. It contains all batches (IAB files) currently in the InputAccel System.
These contain all the IAValues, task settings, triggers, tree structure, batch and
task values, IPP coding, and node ID's for all the images.
The batches directory contains sub-directories known as stage file directories.
These directories store image and other output files (stage files) used and
created by the InputAccel modules for this InputAccel InputAccel Server.
IAB files will have the same names as the actual batch names (along with the
.iab extension) you see in the Administrator module, or when you use the
Open Batch button in an InputAccel module. The corresponding stage file
folder contains all the image files and other output files created by InputAccel
modules.
In a stage file directory, you will see many files with odd file names and
numbered extensions. The file names are made from the hexadecimal node ID
number. The file extensions used with these files are called Stage Numbers
and they correspond to the order the modules are listed in the IPP in the
#Include statements and $Instance statements, or in the Modify Instance
dialog in the Process Developer Module.

171
Installation and Configuration Guide

Stage files differ in file format depending on the module used to produce the
output. Some common formats created by InputAccel modules include TIFF,
PDF, ACD, PDA, XML, or TXT. Third party modules may produce other file
formats.

The IAS\activation directory


The activation directory contains files used by the InputAccel Server’s
activation file feature.

The IAS\process directory


As with the batches directory, if the process directory is missing on startup,
then the InputAccel InputAccel Server will create a new one. In some respects
the process directory is more important for your production than the batches
directory, since new batches cannot be created without an associated process.
The process directory contains all your InputAccel processes. These IAP files
are compiled IPPs that have been installed on the server and they contain
everything batch files (IAB) do minus the image content and process data
(i.e., image thumbnails, tree views or node IDs). When you install a process,
the Administrator module copies the process file from your development
environment to the process directory. It then updates the process list on the
server and in Administrator.
Since you can associate permissions with the processes you develop, you need
to remember that some of the process and batch level permissions, such as
rights to create batches with a given process, are stored in the values.idx file
(see page 170 for a detailed explanation of this file). If the values.idx file is
missing on startup, then the InputAccel InputAccel Server will create a new
one containing default settings and you may be unable to use your processes.
Windows NTFS permissions are also used and are maintained by the
Windows file system.

172
Chapter 9: Maintaining InputAccel

The IAS\modules directory


The modules directory should be included in regular backup routines because
it contains module-specific information that is applied throughout the
InputAccel System including:
„ settings used by the Point.Click.Scan! interface of the Scan module,
„ settings for the WatchDog feature (iawatch.txt),
„ page templates,
„ settings used by some EMC Captiva Technical Partners third-party
modules,
„ and Values to XML support files.

The registry
If you have made changes to the InputAccel registry (see Appendix B,
“InputAccel Server registry values,” on page 199), then you may want to
export that portion of the registry to a file and save it in your IAS directory.
You can then restore those settings after you restore the IAS directory from
backup.

Note: Most sites may find this unnecessary as adjustments to the Windows
Registry are often not necessary.

License files
InputAccel licenses have two components: the security key, which can be a
hardware key or an activation file (.caf), and the .lic file (including a hard
copy of this file for your records.)
The security key, among other attributes, contains the server ID for the
InputAccel Server. This Server ID will be specific to the system where the
InputAccel Server is running.

173
Installation and Configuration Guide

The .lic file, a text file with semi-colon delimited fields, contains the
InputAccel license codes and it is named with the ID number of the
InputAccel Server (for example, 531927.lic). This file is uploaded by the
Administrator module to the InputAccel Server. Using a decrypting
algorithm, the InputAccel Server checks to verity that the license codes are
valid for the server ID in the security key. If the license code matches the
server ID in the hardware key or activation file, then the Status field for the
license code shows the status as OK.
When restoring license codes, you can type in each license code through the
Administrator module, however, this is a time consuming and error-prone
process. EMC Captiva recommends that you import the license codes from
the .lic file. Furthermore, EMC Captiva recommends you store a copy of your
.lic files in a safe location. Saving the file in the IAS directory assures that it
will be backed up with the rest of the InputAccel Server and that when you
restore from backup, a copy of your license codes is readily available.
From time to time you may receive updates to your license. EMC Captiva
usually sends the full license unless there are special circumstances
documented in the notification message. Although you should always have
the current license available for reloading in case of emergencies, you can
always call InputAccel Support to get your latest license in .lic file format.

Backing up InputAccel clients


InputAccel clients have few customizations that are not stored in the IAS
directory on the InputAccel Server. Customizations not stored in the IAS
directory are stored in the win.ini file, documented in the WIN.INI
Parameters help file (winini.chm) (available from the Start > Programs >
InputAccel > Documentation path). Other customizations are stored as
parameters in the shortcut (.lnk file) to the module's executable file.

The win.ini file


All modules look in their host workstation win.ini file in the Windows or
Winnt directory for the last user ID logged in and the last InputAccel Server

174
Chapter 9: Maintaining InputAccel

or ScaleServer group connected to. Since you may not have a backup of the
win.ini file, your end users will likely need to type in the server name(s) when
they log in after an emergency restoration. The win.ini file also stores
network, debug, and localization settings (as described in the WIN.INI
Parameters help).

Note: In a ScaleServer group, the win.ini file on each client workstation stores the
list of InputAccel Servers to which the workstation connects. If the win.ini file is
lost and not restored, the operator will need to re-enter the entire list of servers in
the ScaleServer group.

Some individual modules also store settings in the win.ini file. For instance,
the Scan and Rescan modules may store settings to help detect blank pages
better or to help detect patch codes. Other modules that may store settings in
the win.ini file include:
„ Index
„ IBM CMIP/390 Index (also known as “FAF Index”)
„ OCR
„ Image Enhancement
„ Copy
„ Point.Click.Scan!
„ Open Text Livelink Export *
„ Index Export *
For more information about the settings each of these modules stores in the
win.ini file, see the WIN.INI Parameters Help, winini.chm. For modules that
are shown with an asterisk (*) in the list above, you may find detailed
information in that module's individual user guide.
Also, please note that the PrimeOCR for InputAccel module stores settings in
the primeocr.ini and prlexica.ini files (as described in the PrimeOCR for
InputAccel Help, procria.chm) and the Open Text Livelink module uses
settings in the opentext.ini file (as described in the Open Text Livelink Export
Help, exll2.chm).
Third-party vendors of InputAccel modules may have their own special
settings that you may want to backup and store.

175
Installation and Configuration Guide

The Index module's validation DLL and ActiveX DLLs


If you have altered the iaidxv32.dll source code or have written any auxiliary
ActiveX DLLs, then you need to make special arrangements to have these
installed after you have reinstalled the InputAccel module on your client
machines.

Modified process source code


The sources for InputAccel process files (.ipp and .mdf) should also be
backed up. IPPs are the source code and MDFs (Module Definition Files) are
value declaration files that are used to create InputAccel process files (.iap). If
you want to do more development work, then you will need these files. Some
developers add extra values that they want to use in their IPPs into existing
MDFs. Developers will sometimes also create new MDFs during the
development process containing extra values to include in IPPs.

Scanner drivers
For most systems, the scanner driver is stored on the InputAccel installation
CD. If your scanner drivers were installed from the installation CD, then there
is no need to back up the installed drivers.
If you installed a patched driver or have a scanner driver that was released
after the CD was published, then you should back up those drivers.
Remember that some scanner drivers require supporting DLLs and you may
have to use a special installation program to install those drivers. To help you
plan for a smooth recovery, InputAccel Support can provide a copy of most
drivers and any associated installation programs.

Note: When you restore a Scan workstation, the scanner operator should perform a
routine scanner calibration to make sure scanned images are clear and that they
have the correct settings for brightness, contrast and so on. These settings are
unique to each workstation and are not stored in the batch or process file.

176
Chapter 9: Maintaining InputAccel

PSG customizations
If you have taken advantage of EMC Captiva's Professional Services Group
(PSG), then you may have customized InputAccel modules that will not be
reinstalled from your InputAccel CD. These customized modules need to be
restored from the original customized files. Make sure to back up any
customized files and store them with the rest of your backed up files.

Shortcut Parameters
If you want to automatically perform an action when a module is started, then
you must add the appropriate parameter to the Target property of the
Windows shortcut or .lnk file associated with the module's executable. Make
sure to add any shortcut files that contain shortcut parameters or command-
line switches to your backup routine.
Some examples of shortcuts you should back up:
„ Automatic module login - Some shortcuts contain parameters that
make it possible for the user to automatically log in to the module using
the correct domain, user ID and password.
„ Automatic backend login - Some Export modules, like InputAccel's
FileNet Panagon IS/CS Export module, may have additional command-
line switches that enable automatic login to backend systems. Make
sure to save these parameters and understand how they work when you
test your recovery plan.
„ Department routing - Other shortcuts contain command-line switches
that invoke Department routing to target the tasks of a given batch to a
particular workstation. If you have tasks or images that only certain
individuals can work on or have authority to look at, then Department
routing can be used to accomplish this.

177
Installation and Configuration Guide

Troubleshooting during production


This section provides solutions to problems that may arise when using
InputAccel.

The InputAccel Server disconnects during long process


times
If a client workstation does not respond to pings sent by the InputAccel
Server, then the server may assume that the workstation is down and
disconnect it. Generally, if a client can’t respond to the pings request from an
InputAccel Server, then you should call InputAccel Support to locate the
problem. (For instance, you may be running an untested third-party module
that is encountering an infinite loop.) In a few cases, however, the client may
not be able to respond for legitimate reasons. For instance, it may be
processing a particularly complicated task, or your network response may be
slow. In these cases, you can increase the values of the ClientPing and
ClientTimeout registry values to allow for longer processing times. Do not
change these values, however, unless you are familiar with the implications of
changing network timings.
To modify the ClientPing and ClientTimeout registry values, use the
instructions in Appendix B, “InputAccel Server registry values,” on page 199.

Note: When modifying the ClientPing and ClientTimeout registry values, do not
specify zero – it may cause the system to lose images from your batches. It is also
important to note that if you set ClientPing and ClientTimeout to the same value, then
the InputAccel Server will drop its connection to the client.

178
Chapter 9: Maintaining InputAccel

The InputAccel Server will not start


If you are unable to start the InputAccel Server, then you may have a corrupt
values.idx file, batch, process, or InputAccel Server installation. To
determine if one of these is corrupt:
1. Test if the installation of the InputAccel Server is corrupt:
Save the values.idx file and the batches and process directories, which
are located in the IAS directory, to a different location. Then delete the
them from the original directory and try to restart the InputAccel Server.
„ If the InputAccel Server does not start, then your installation is corrupt
and you must reinstall the InputAccel Server.
„ If the InputAccel Server starts, then your values.idx file or one of your
batch or process files is probably corrupt.
2. Test if the values.idx or values.bak file is corrupt:
Move the values.idx file back to the IAS directory and try to restart the
InputAccel Server.
„ If the InputAccel Server does not start, then the values.idx file is
corrupt. Delete this file. The next time you start the InputAccel Server,
a new values.idx will be automatically built from values.bak. If you
are still having problems, then values.bak may also be corrupt. In this
case, delete both values.idx and values.bak.The next time you start
the InputAccel Server, both will be rebuilt. Note that you will need to
reinstall your licenses and reset your module screen positions, since
these settings are saved in the values.idx and values.bak files.
„ If the InputAccel Server starts, then one of your batch or process files
is probably corrupt.
3. Test if one of your process files is corrupt:
Move the process directory back to the IAS directory and try to restart the
InputAccel Server.
„ If the InputAccel Server does not start, then one of the process files is
corrupt. Move all the process files out of the process directory and add
them back in one at a time. Try to restart the InputAccel Server each
time you add a file until you find the file that prevents the InputAccel
Server from starting.

179
Installation and Configuration Guide

„ If the InputAccel Server starts, then one of your batches is probably


corrupt.
4. Test which batch file is corrupt:
Move the batches directory back to the IAS directory without the batch
files and subdirectories. Add each batch file and its corresponding
subdirectory back to the IAS directory in matched pairs. Try to restart the
InputAccel Server each time you add a pair until you find the batch that is
prevents the InputAccel Server from starting.

180
A
Appendix

Command-line instructions
This appendix contains descriptions and usage rules for the following
supported installer switches and properties:
Supported InstallShield switches. . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
/L switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
/V switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
/x switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Supported MSI switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
/i switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
/l switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
/q switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Usage rules for switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Supported MSI properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
ADDLOCAL property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
REMOVE property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
REINSTALL property. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
ADDDEFAULT property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
REINSTALLMODE property . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
ARPSYSTEMCOMPONENT property . . . . . . . . . . . . . . . . . . . 188
ARPNOMODIFY property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
ARPNOREMOVE property . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
REBOOT property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
LIMITUI property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
INSTALLDIR parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
LICENSEMODE parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Usage rules for MSI properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
InputAccel client feature names . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

181
Installation and Configuration Guide

Supported InstallShield switches


The following is a list of InstallShield command-line switches and associated
parameters that EMC Captiva has tested and approved for use with the latest
version of InputAccel software.
The executable setup.exe is located in the C:\Program
Files\InputAccel\Server or C:\Program Files\InputAccel\Client folder.

/L switch

Parameters Numerical language code for installation program; for example,


1033 for U.S. English.

Description Specifies the language the setup program will use. The available
options are:
„ 1033 (US English)
„ 1031 (German - Germany)
„ 3082 (Spanish Traditional Sort)
„ 1036 (French)
„ 1041 (Japanese)
„ 1042 (Korean)
„ 2052 (Chinese - Simplified)

Example setup.exe /L1041

Note: This switch must be specified in upper-case and must precede the /V
switch that is used to pass MSI command switches from the InstallShield
installer to MSI.

/V switch

Parameters MSI installer switch string enclosed in quotes

Description Passes the MSI parameter switches from the InstallShield setup
command line to MSI.
Note: Do not use switch /i with switch /V.

182
Appendix A: Command-line instructions

Example setup.exe /L1033 /V"MSI switches"

Note: This switch must be specified in lower-case and must follow all
other InstallShield command-line switches. The MSI switches must be
enclosed in quotations marks and there must be no space between the /V
and the opening quotation mark.

/x switch

Parameters None.

Description Removes a product.

Example setup.exe /x

Supported MSI switches


Note: Running setup.exe is the recommended method for installing
InputAccel.
The executable setup.exe is located in the C:\Program
Files\InputAccel\Server or C:\Program Files\InputAccel\Client folder.

/i switch

Parameters None.

Description Indicates that all standard InputAccel client features should be


installed. This switch is the default and need not be specified.
Note: Do not use switch /i with switch /V.

Example setup.exe /V"/L*v C:\Logfile.txt\ ADDLOCAL=ALL"

/l switch

Parameters [i|w|e|a|r|u|c|m|p|v|+|!|*]Logfile
(server, client)

183
Installation and Configuration Guide

Description Specifies the flags to be logged and the log file name and path.
i - Status messages
w - Non-fatal warnings
e - All error messages
a - Startup of actions
r - Action-specific records
u - User requests
c - Initial user interface parameters
m - Out of memory
p - Terminal properties
v - Verbose output
+ - Appends to the existing file
! - Clears each line in the log file
* - Wildcard that logs all information, but the use of the v
parameter is not included. To include the v option, type /l*v.

Example setup.exe /V"/vomus /l*v "C:\log\installlog.log""

184
Appendix A: Command-line instructions

/q switch

Parameters [n|b|r|f|+|-]
(server, client)

Description Sets the user interface level.


n - No user interface (same as /q)
b - Basic user interface
r - Reduced user interface. A modal dialog is displayed at the
end of the process.
f - Full user interface. A modal dialog is displayed at the end of
the process.
n+ - No user interface; however, a modal dialog is displayed at
the end of the process.
b+ - Basic user interface. A modal dialog is displayed at the end
of the process. If you cancel the process, then a modal dialog is
not displayed.
b- - Basic user interface with no modal dialog.

Example setup.exe /V"/qn"

Usage rules for switches


The following rules must be followed when using InstallShield and Microsoft
Installer arguments and their parameters on a command line or as part of a
batch file:
„ setup.exe is the first command (if you are writing a batch file, then you
may place other non-installer-specific commands before this command,
but this command starts the setup process).
„ The executable setup.exe is located in the C:\Program
Files\InputAccel\Server or C:\Program Files\InputAccel\Client folder.
„ The switch /V must always follow setup.exe as the first argument.
„ The entire Microsoft Installer argument line must be enclosed in quotes
("msi arguments") immediately following the /V switch with no
spaces.
„ Each argument must be separated by a space (e.g., /q /i).

185
Installation and Configuration Guide

„ No space should separate an argument from its switch (e.g., /vomus);


however, a Package|ProductCode parameter must be separated from
its switch by a space (e.g., /i InputAccel Client 5.3.msi).
„ The switches /l and /q can be used with /i.
„ The switch /i is implied. Do not use this switch in conjunction with
setup.exe.
„ Do not use /i switch with /V switch.

Supported MSI properties


The following is a list of the MSI properties that EMC Captiva has tested and
approved for use with the latest version of InputAccel software:

ADDLOCAL property

Parameters Feature list. Separate multiple features with a comma (no spaces
(server, client) in between comma and next feature).

Description This property installs the listed features locally.

Example setup.exe
/V"ADDLOCAL=WATCH,COPY,SCAN,COM_RUNTIME,
VBA64"

Notes:
1. Whenever you install individual features using ADDLOCAL, you
must include the additional features COM_RUNTIME and VBA64.
2. You cannot install InputAccel Server features separately by using
command line parameters. For example. specifying
ADDLOCAL=SERVER does not work and causes an error to appear.
When installing the InputAccel Server from the command line, you
must use ADDLOCAL=ALL. To install a subset of server features,
you must use the user interface of the interactive installer.

186
Appendix A: Command-line instructions

REMOVE property

Parameters Feature list. Separate multiple features with a comma (no spaces
(server, client) in between comma and next feature).

Description This property removes the listed features.

Example setup.exe /V"REMOVE=WATCH,COPY,SCAN"

REINSTALL property

Parameters Feature list. Separate multiple features with a comma (no spaces
(server, client) in between comma and next feature).

Description This property reinstalls/repairs the listed features. If the


REINSTALL property is set, then the REINSTALLMODE
property should also be set to indicate the type of reinstall to be
performed. If the REINSTALLMODE property is not set, then
by default all files that are currently installed are reinstalled. Note
that even if REINSTALL is set to omus, then only those features
that were already installed previously are reinstalled. Thus, if
REINSTALL is set for a product that is yet to be installed, then
no installation action will take place at all.

Example setup.exe /V"REINSTALL=WATCH,COPY,SCAN


REINSTALLMODE=omus"

Note: When you use this property, the files in the sample processes and
other files in the client\src\ipp folder are not reinstalled.

ADDDEFAULT property

Parameters Feature list. Separate multiple features with a comma (no spaces
(server, client) in between comma and next feature).

Description List of features to be installed in their default configuration.

Example setup.exe /V"ADDDEFAULT=WATCH,COPY,SCAN"

187
Installation and Configuration Guide

REINSTALLMODE property

Parameters [p|o|e|d|c|a|u|m|s|v]
(server, client)

Description A string containing letters that specify the type of reinstallation


to perform. By default the REINSTALLMODE is “omus”.
p - Reinstalls a product only if a file is missing
o - Reinstalls a product if a file is missing or if an older version
of the file is installed
e - Reinstalls a product if a file is missing or an equal or older
version of a file is installed
d - Reinstalls a product if a file is missing or a different version
of a file is installed
c - Reinstalls a product if a file is missing or the stored checksum
value does not match the calculated value
a - Forces all files to be reinstalled
u - Rewrites all required user-specific registry entries
m - Rewrites all required computer-specific registry entries
s - Overwrites all existing shortcuts
v - Runs from the source file and re-caches the local package

Example setup.exe /V"/qn REINSTALL=WATCH,COPY,SCAN


REINSTALLMODE=pecms"

Note: When you use this property, the files in the sample processes and
other files in the client\src\ipp folder are not reinstalled.

ARPSYSTEMCOMPONENT property

Parameters [0 | 1] (see example).


(server, client)

188
Appendix A: Command-line instructions

Description Setting the ARPSYSTEMCOMPONENT property to 1 using


the command line prevents the application from being displayed
in the Add/Remove Programs list on the Control Panel. Use
this property if you want to limit the ability of the user to alter
the service pack installation.

Example setup.exe /V"/qn ARPSYSTEMCOMPONENT=1"

ARPNOMODIFY property

Parameters [0 | 1] (see example)


(server, client)

Description Setting the ARPNOMODIFY property disables Add/Remove


Programs functionality in the Control Panel that modifies the
product. This disables the Modify button for the product in Add
or Remove Programs in Control Panel. Use this property if
you want to limit the ability of the user to alter the service pack
installation.

Example setup.exe /V"/qn ARPNOMODIFY=1"

ARPNOREMOVE property

Parameters [0 | 1] (see example)


(server, client)

Description Setting the ARPNOREMOVE property disables the Add or


Remove Programs functionality in the Control Panel that
removes the product. This disables the Remove button for the
product from the Add/Remove Programs in the Control Panel.
Use this property if you want to limit the ability of the user to
alter the service pack installation.

Example setup.exe /V"/qn ARPNOMODIFY=1


ARPNOREMOVE=1"

189
Installation and Configuration Guide

REBOOT property

Parameters [Force|Suppress|ReallySuppress]
(server, client)

Description The REBOOT property suppresses certain prompts for a reboot


of the system. An administrator typically uses this property with
a series of installations to install several products at the same
time with only one reboot at the end.
Force - Always prompt for a reboot at the end of the installation.
The user interface always prompts the user with an option to
reboot at the end. If there is no user interface, then the system
automatically reboots at the end of the installation.
Suppress - This parameter prompts for a reboot at the end of the
installation. The installer still prompts the user with an option to
reboot during the installation whenever it encounters the
ForceReboot action. If there is no user interface, then the
system automatically reboots at each ForceReboot. Reboots at
the end of the installation, for example caused by an attempt to
install a file in use, are suppressed.
ReallySuppress - Suppress all reboots and reboot prompts
initiated by ForceReboot during the installation. Suppress all
reboots and reboot prompts at the end of the installation. Both
the reboot prompt and the reboot itself are suppressed. For
example, reboots at the end of the installation caused by an
attempt to install a file in use are suppressed.

Example setup.exe /V"/qn REBOOT=FORCE"

Note: The installer evaluates only the first character of these parameters, so you
may elect to use only the first character of the parameter you use.

190
Appendix A: Command-line instructions

LIMITUI property

Parameters [0 | 1] (see example)


(server, client)

Description If the LIMITUI property is set, then the user interface level is
restricted to basic.

Example setup.exe /V"LIMITUI=1"

INSTALLDIR parameter

Parameters Path to installation directory.


(client)

Description Enables command-line specification of an installation directory.


The default is "C:\Program Files\InputAccel\Client"
There must be no space between the paramter, the equal sign,
and the path specification. If the path name contains spaces, the
entire path name must be enclosed in quotes. If you enclose
quotes within quotes, the nested quotes must be escaped by
preceding them with back slashes (\"path\")

Examples setup.exe /V"/qn INSTALLDIR=D:\IAClient /l*v


D:\temp\logfile.txt"
setup.exe /V"/qn INSTALLDIR=\"D:\IA Client Files\" /l*v
D:\temp\logfile.txt"

LICENSEMODE parameter

Parameters [2 | 3] License mode value.


(server)

Description Specifies the license mode for the InputAccel Server.


2 - Do not install demonstration licenses.
3 - Install demonstration licenses.

Examples setup.exe /V"LICENSEMODE=3"


This example installs a Demo license.

191
Installation and Configuration Guide

Usage rules for MSI properties


The following rules must be followed when using MSI properties their
parameters on a command-line or as part of a batch file:
„ MSI always evaluates the following properties in the following order:
ADDLOCAL
REMOVE
ADDDEFAULT
REINSTALL
„ When using multiple switches and/or properties on a command-line or
as part of a batch file, each property should be separated by a space.
„ Feature lists must be enclosed in quotes and features must be separated
by a comma (no space).

InputAccel client feature names


Following are the supported feature names that can be specified when
installing the InputAccel client software:

Feature names
„ ADMIN
Corresponds to the Administrator sub-feature under Administrative
Modules in the Custom Setup dialog.
„ AQA
Corresponds to the Automatic Quality Assurance sub-feature under
Image Processing and Quality Modules in the Custom Setup dialog.
„ AQA_IMAGES
Corresponds to the Sample Images AQA sub-feature under Samples
Images in the Custom Setup dialog.
„ AX_EXPORT
Corresponds to the ApplicationXtender Export sub-feature under
Export Modules (Custom) in the Custom Setup dialog.

192
Appendix A: Command-line instructions

„ CMNSTORE_EXPORT
Corresponds to the IBM CSSAP Export sub-feature under Export
Modules (Custom) in the Custom Setup dialog.
„ COM_RUNTIME
Does not correspond to an individual feature or sub-feature; however
this feature is required and automatically installed during any
installation or repair.
„ COPY
Corresponds to the Copy sub-feature under Utility Modules in the
Custom Setup dialog.
„ DCTM_EXPORT
Corresponds to the Documentum Server Export sub-feature under
Export Modules (Custom) in the Custom Setup dialog.
„ DCTMWIZ52
Corresponds to the Documentum Capture 5.3 Process Wizard sub-
feature under Administrative Modules in the Custom Setup dialog.
Note that even though the version number of the module has changed to
5.3, the feature name continues to use the “52” designation.
„ ERRORMSG_PDF
Corresponds to the Error Messages online help sub-feature under
Documentation in the Custom Setup dialog.
„ EXPRWZ52
Corresponds to the Express 5.3 Process Wizard sub-feature under
Administrative Modules in the Custom Setup dialog. Note that even
though the version number of the module has changed to 5.3, the feature
name continues to use the “52” designation.
„ FAF_EXPORT
Corresponds to the IBM CMIP-390 Export sub-feature under Export
Modules (Custom) in the Custom Setup dialog.
„ FAF_INDEX_
Corresponds to the IBM CMIP-390 Index sub-feature under Indexing
Modules in the Custom Setup dialog.
„ FILE_EXPORT
Corresponds to the File System Export sub-feature under Export
Modules (Standard) in the Custom Setup dialog.

193
Installation and Configuration Guide

„ FILENET_EXPORT
Corresponds to the FileNet Panagon IS/CS Export sub-feature under
Export Modules (Custom) in the Custom Setup dialog.
„ FNCM_EXPORT
Corresponds to the FileNet Content Manager Export sub-feature under
Export Modules (Custom) in the Custom Setup dialog.
„ IAWS
Corresponds to the ECM Web Service Importer feature.
„ ICM_EXPORT
Corresponds to the IBM CM Advanced Export sub-feature under
Export Modules (Custom) in the Custom Setup dialog.
„ IMAGE
Corresponds to the Image sub-feature under Utility Modules in the
Custom Setup dialog.
„ IMAGE_EXPORT
Corresponds to the Image Export sub-feature under Export Modules
(Standard) in the Custom Setup dialog.
„ IMANAGE_EXPORT
Corresponds to the iManage Worksite Server Export sub-feature
under Export Modules (Custom) in the Custom Setup dialog.
„ INDEX
Corresponds to the Index sub-feature under Indexing Modules in the
Custom Setup dialog.
„ INDEX_EXPORT
Corresponds to the Index Export sub-feature under Export Modules
(Standard) in the Custom Setup dialog.
„ INSTALL_PDF
Corresponds to the Installation and Configuration Guide sub-feature
under Documentation in the Custom Setup dialog.
„ IPI
Corresponds to the Image Enhancement sub-feature under Image
Processing and Quality Modules in the Custom Setup dialog.
„ IQA
Corresponds to the Image Quality Assurance sub-feature under Image
Processing and Quality modules in the Custom Setup dialog.

194
Appendix A: Command-line instructions

„ LL2_EXPORT
Corresponds to the Open Text Livelink Advanced Export sub-feature
under Export Modules (Custom) in the Custom Setup dialog.
„ MODULE
Corresponds to the Module sub-feature under Utility Modules in the
Custom Setup dialog.
„ MULTI
Corresponds to the Multi sub-feature under Utility Modules in the
Custom Setup dialog.
„ ODBC_EXPORT
Corresponds to the ODBC Export sub-feature under Export Modules
(Standard) in the Custom Setup dialog.
„ PAGEREG
Corresponds to the Page Registration sub-feature under Image
Processing and Quality Modules in the Custom Setup dialog.
„ PATCH_CODE_IMAGES
Corresponds to the Patch Codes sub-feature under Sample Images in
the Custom Setup dialog.
„ PDEV
Corresponds to the Process Developer sub-feature under
Administrative Modules in the Custom Setup dialog.
„ PDF_EXPORT
Corresponds to the PDF Export sub-feature under Export Modules
(Standard) in the Custom Setup dialog.
„ PROCESS_FILES
Corresponds to the Sample Process Files sub-feature of Process
Developer under Administrative Modules in the Custom Setup dialog.
„ PROCRIA
Corresponds to the PrimeOCR for InputAccel sub-feature under PDF
Conversion and OCR Modules in the Custom Setup dialog.
„ RESCN_
Corresponds to the Rescan sub-feature under Scanning Modules in the
Custom Setup dialog.

195
Installation and Configuration Guide

„ SAPAL_EXPORT
Corresponds to the Archive Export sub-feature under Export Modules
(Custom) in the Custom Setup dialog.
„ SCAN
Corresponds to the Scan sub-feature under Scanning Modules in the
Custom Setup dialog.
„ SCAN_SOFT_OCR
Corresponds to the ScanSoft OCR for InputAccel sub-feature under
PDF Conversion and OCR Modules in the Custom Setup dialog.
„ SHRPNT2_EXPORT
Corresponds to the Microsoft SharePoint Export sub-feature under
Export Modules (Custom) in the Custom Setup dialog.
„ SPAWN
Corresponds to the Spawn sub-feature under Utility Modules in the
Custom Setup dialog.
„ STAMP
Corresponds to the Auto Annotate sub-feature under Image
Processing and Quality Modules in the Custom Setup dialog.
„ SUPV
Corresponds to the Supervisor sub-feature under Administrative
Modules in the Custom Setup dialog.
„ SYSOVER_PDF
Corresponds to the System Overview online help sub-feature under
Documentation in the Custom Setup dialog.
„ TEST_IMAGES
Corresponds to the Test Images sub-feature under Sample Images in
the Custom Setup dialog.
„ TIMER
Corresponds to the Timer sub-feature under Utility Modules in the
Custom Setup dialog.
„ VAL2XML
Corresponds to the Values to XML sub-feature under Export Modules
(Standard) in the Custom Setup dialog.
„ VBA64
Does not correspond to an individual feature or sub-feature; however

196
Appendix A: Command-line instructions

this feature is required and automatically installed during any


interactive installation or repair.
„ VI_EXPORT
Corresponds to the IBM Content Manager Export sub-feature under
Export Modules (Custom) in the Custom Setup dialog.
„ WANGNT_EXPORT
Corresponds to the eiStream WMS Export sub-feature under Export
Modules (Custom) in the Custom Setup dialog.
„ WATCH
Corresponds to the Watch sub-feature under Utility Modules in the
Custom Setup dialog.
„ WININI_PDF
Corresponds to the WIN.INI Parameters online help sub-feature under
Documentation in the Custom Setup dialog.
„ XML3
Does not correspond to an individual feature or sub-feature; however
this feature is required and automatically installed during any
interactive installation or repair. XML version 3 must be installed on the
target machine in order to manipulate the .caf.
„ P__SAMPLE_IMAGES
Corresponds to the Sample Images feature in the Custom Setup dialog.

197
Installation and Configuration Guide

198
B
Appendix

InputAccel Server registry


values
InputAccel Server registry values control how InputAccel functions. This
section describes the registry values that are automatically installed with
InputAccel and instructions for modifying them using the registry editor.

Note: Proceed with caution when modifying registry values. Incorrect


modifications can cause data loss or corruption.

Adding or modifying server registry values


To add or modify InputAccel registry values:
1. Open the Registry Editor, located at SystemRoot\regedit.exe, where Sys-
temRoot is the directory that holds your operating system (for example,
c:\winnt).

199
Installation and Configuration Guide

Figure 8: Windows Registry Editor

2. Navigate to: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\


Services\InputAccel\Parameters. The InputAccel registry parameters are
displayed in the right pane.

Figure 9: InputAccel registry values\

3. To add a value, select one of the following options from the Edit menu:
„ New > String Value adds a String (REG_SZ) value.
„ New > DWORD Value adds a DWORD (REG_DWORD) value.
An icon for the new value appears in the right display. Type the name of
the value next to the icon.
4. To specify or modify data for a value, double-click its icon. The Edit
String/DWORD Value dialog appears.

200
Appendix B: InputAccel Server registry values

5. Type information in the Value Data box and select OK.


6. Select Exit from the Registry menu to exit the Registry Editor.

Note: You may also use the Administrator module to either temporarily or
permanently change some InputAccel registry values. See the Administrator
Module Help for more information.

201
Installation and Configuration Guide

Server registry values

Table 10: InputAccel Server registry values


This table describes InputAccel Server registry values. Default values are shown in brackets [ ].

Value, type Description


AuditLogging Enable or disable the audit logging through the InputAccel
Administrator Server Setting dialog. The change takes effect
immediately.
To disable logging, set AuditLogging to 0. To enable all logging,
set the AuditLogging to 65535 (or select the Shown in
Hexadecimal check box on the dialog and type FFFF).
This should be a DWORD value. Valid values include:
„ 0/0x00 (default) - Logging is disabled
„ 1/0x01 - Image Read (User action 1) Image was viewed by user
„ 2/0x02 - Image Write (User action 2) Image was modified or
created by user
„ 4/0x04 - Create Node (User action 3) Node was created by user
„ 8/0x08 - Delete Node (User action 4) Node was deleted by user
„ 16/0x10 - Value Read (User action 5) IA Values was read by user
„ 32/0x20 - Value Write (User action 6) IA Value was modified by
user
„ 64/0x40 - Create Batch (User action 7) Batch was created by user
„ 128/0x80 - Delete Batch (User action 8) Batch was deleted by
user
„ 256/0x100 - Send Task (User action 9) Task was sent to a module
„ 512/0x200 - Finish Task (User action 10) Task was finished
„ 65535/0xFFFF - All All entries
„ Note: To log multiple user actions, add the values for each level
together.

AuditLoggingDB Connection string to the Audit Database that is set by the installer.
This should be a STRING value. This value cannot be changed in
Administrator.

202
Appendix B: InputAccel Server registry values

Table 10: InputAccel Server registry values (continued)


This table describes InputAccel Server registry values. Default values are shown in brackets [ ].

Value, type Description


BatchExt Default file name extension for batch files.1
REG_SZ [.iab]

BatchMaxAddressSpaceK Maximum amount of virtual address space that the InputAccel


REG_DWORD Server allows batches to use. If batches require address space
[1572864/0x180000] beyond this limit, then the InputAccel Server unloads other
batches to create the additional space. This value should be
approximately the value of BatchMaxLoaded multiplied by the size
of your average batch.
BatchMaxAddressSpaceK has a minimum value of
542588/0x80000.
1572864/0x180000 is the current Windows maximum, which
means larger values are treated as 0x180000.
Note: When setting the value for BatchMaxAddressSpaceK,
consider how much memory the InputAccel Server has and what
other programs may be running on it.

203
Installation and Configuration Guide

Table 10: InputAccel Server registry values (continued)


This table describes InputAccel Server registry values. Default values are shown in brackets [ ].

Value, type Description


BatchMaxLoaded Maximum number of batches that can be loaded at once. At a
REG_DWORD [65/0x41] minimum, set this value equal to the number of active batches or
connected modules (whichever is less). To determine if you should
increase the value of BatchMaxLoaded, use the Windows
Performance Monitor (see page 160) to check the batches loaded
per second statistic. If this number is greater than 0.1 per second
over sustained periods, then you may want to increase the value of
BatchMaxLoaded.
Note:
„ The limit specified by BatchMaxAddressSpaceK takes
precedence over the limit specified by BatchMaxLoaded. For
example, if BatchMaxLoaded is set to 65, and 20 batches are
loaded that reach the limit specified by
BatchMaxAddressSpaceK, then the InputAccel Server will not
load a 21st batch (even though BatchMaxLoaded is set to allow
the loading of up to 65 batches). Instead, the Server will unload
one of the 20 batches, then load another batch, keeping the total
at 20.
„ It is seldom necessary to decrease the size of BatchMaxLoaded
unless you want other programs running on the InputAccel
Server to have more memory. However, this can also be
accomplished by using BatchMaxAddressSpaceK.
„ BatchMaxLoaded can have a minimum value of 1.

BatchSync Commit interval, or the maximum number of seconds between


REG_DWORD when the InputAccel Server commits batch and process files to
[300/0x12c] disk. If the InputAccel Server must be restarted due to a power
failure, critical software failure, or other abnormal termination,
then the state of the batch is restored using information committed
to disk during the last commit.

BatchSyncMaxTime The time at which the routine will give up; it will sync batches
until this time is reached.

204
Appendix B: InputAccel Server registry values

Table 10: InputAccel Server registry values (continued)


This table describes InputAccel Server registry values. Default values are shown in brackets [ ].

Value, type Description


ClientPing Number of seconds a client must be idle before the InputAccel
REG_DWORD [60/0x3e] Server pings it.
Note: If you set ClientPing and ClientTimeout to the same value,
then the InputAccel Server will drop its connection to the client.

ClientTimeout Number of seconds a client must be idle before the InputAccel


REG_DWORD Server forcefully disconnects it. Setting this value to zero disables
[300/0x12c] ClientTimeout. Only set this value to zero for debugging.
Note: If you set ClientPing and ClientTimeout to the same value,
then the InputAccel Server will drop its connection to the client.

Cluster A semicolon-delimited string that contains the Group Name in the


REG_SZ first position followed by the machine name of each InputAccel
Server (including itself) in the ScaleServer group that has been
defined.
Note: This value does not exist until/unless a ScaleServer group is
defined that includes this server as a member.
Note: This value must be identical, including order, on every
InputAccel Server that is a member of the ScaleServer group.

ClusterReconnectTime Number of milliseconds this InputAccel Server will wait until it


attempts to reconnect to a server to which it does not have a
connection. If it fails, then it will try again in
ClusterReconnectTime.
Note: This value is not used until/unless a ScaleServer group is
defined that includes this server as a member.

205
Installation and Configuration Guide

Table 10: InputAccel Server registry values (continued)


This table describes InputAccel Server registry values. Default values are shown in brackets [ ].

Value, type Description


ClusterNumber An integer, greater than or equal to 0 and less than the ClusterBase
REG_DWORD value established by server license feature codes. The ClusterBase
value uses feature codes A-F to form a binary number, where F is
the least-significant digit. For example a ClusterBase of 5 is
established by specifying features codes DF.
Note: This value is not used until/unless a ScaleServer group is
defined that includes this server as a member.
Note: This value must be unique among all the InputAccel Server
with the ScaleServer group.

ClusterTimeout Number of milliseconds this InputAccel Server will wait for


REG_DWORD another InputAccel Server within the ScaleServer group to respond
[5000/0x1388] before giving up. The server will behave as though an operation
failed if this time is exceeded. The minimum value is 100ms.
Note: This value does not exist until/unless a ScaleServer group is
defined that includes this server as a member.

206
Appendix B: InputAccel Server registry values

Table 10: InputAccel Server registry values (continued)


This table describes InputAccel Server registry values. Default values are shown in brackets [ ].

Value, type Description


DebugLevel Error checking level for basic InputAccel Server operations. We
REG_DWORD [1/0x1] recommend using the default value of one, although setting this
value to zero may slightly increase the performance of the
InputAccel Server.
The InputAccel Server checks for errors after basic functions
occur, including locking, unlocking, allocating, and reallocating
memory and freeing disk space.
The InputAccel Server can check for errors using magic values or
checksums. Magic values are the numbers at the beginning and
end of a block of memory. Checksums is the sum of all the
numbers in the block of memory. After the InputAccel Server
performs an operation, it verifies that the magic values or
checksums are the same as when the operation was started. If they
are different, then the InputAccel Server knows that an error
occurred.
To specify the error checking level, use the following values:
„ 1/0x01 Check magic values on block
lock/unlock/allocation/reallocation/free space
„ 2/0x02 Check checksums on block
lock/unlock/allocation/reallocation/free space
„ 4/0x04 Paranoid; check all magic/checksums on any
lock/unlock/allocation/reallocation/free space
Note:
„ Using checksums for error checking is very slow. We
recommend checking magic values instead.
„ If you set the value for DebugLevel too high, then InputAccel
performance may be affected.

DeptPermissionsTimeout Length of time in milliseconds that the server caches department


permissions (default is 10000). This should be a DWORD value.
You can experiment to set an appropriate default value.

207
Installation and Configuration Guide

Table 10: InputAccel Server registry values (continued)


This table describes InputAccel Server registry values. Default values are shown in brackets [ ].

Value, type Description


DiskReserveK Specifies the number of KB of extra disk space to reserve on the
REG_DWORD volume pointed to by RootDir. The InputAccel Server will stop
[153600/0x25800] processing and send a notification to the client modules after the
available disk space on this volume falls below the amount
determined by BatchMaxAddressSpaceK or DiskReserveK.
By reserving this disk space, the InputAccel Server can assure
there is always adequate disk space to store batches that are being
processed. When the Administrator module displays the available
disk space for the InputAccel Server, it has already subtracted the
total reserved amount determined by BatchMaxAddressSpaceK or
DiskReserveK. Usually you will not need to modify the
DiskReserveK unless instructed to do so by InputAccel Support.
In a default InputAccel Server installation, 150 MB of disk space
is reserved.
DiskReserveK has a minimum value of 0x100.

EnableSuperUser Versions of InputAccel prior to 5.1 had a “super user” capability


REG_DWORD [1/0x1] that enabled modules to connect by specify a special user name.
This capability still exists in version 5.1 and later, but can now be
disabled by setting the EnableSuperUser registry value to 0. Note
that if this value is not set, then the super user login continues to
work.

208
Appendix B: InputAccel Server registry values

Table 10: InputAccel Server registry values (continued)


This table describes InputAccel Server registry values. Default values are shown in brackets [ ].

Value, type Description


EventLogLevel Levels at which events should be logged. To determine which
REG_DWORD [147/0x93] events are logged, use the following values:
„ 1/0x01 Errors
„ 2/0x02 Warnings
„ 4/0x04 Information
„ 8/0x08 Audit successes
„ 16/0x10 Audit failures
„ 128/0x80 Successes
Notes
1. To log multiple event levels, add the values for each level
together. The events selected by the default value are shown in
bold type.
2. Audit successes and Audit failures, when enabled, log module
connection successes and failures, including the user name,
module name, and machine name for all events logged.

FileTraceLevel Enables various levels of debug output logging to the


REG_DWORD [112/0x70] RootDir\debug.out file, where RootDir is the directory where
batch and process files are stored. Add the same values as for the
value StringTraceLevel to determine which strings are written to the
debug file.
Note: If you set the value for FileTraceLevel too high, then
InputAccel performance may be affected.

209
Installation and Configuration Guide

Table 10: InputAccel Server registry values (continued)


This table describes InputAccel Server registry values. Default values are shown in brackets [ ].

Value, type Description


Flags The installation process does an “or” of the “trigger” value
REG_DWORD (1/0x01) and the “no compact” value (2097152/0x200000) to
[2097153/0x200003] produce the default value for Flags. Miscellaneous settings
affecting how the InputAccel Server operates.1 Treat each bit as a
value with meanings as described below:
„ 1/0x01 Trigger if empty. When this value is set, the InputAccel
Server does two things:
1. Level (non-page) nodes are marked as being “ready” when
they are first created.
2. Empty level nodes are allowed to be triggered.
„ 2/0x02 Require logon. Modules must logon with a valid user
and password in order process tasks.
„ 4/0x04 Do not send meta keys; primarily used for testing. Meta
keys are what the iaclient.dll and iaclnt32.dll use to determine
the Levels at which IA Values exist. Normally, the InputAccel
Server sends meta keys in packages with their corresponding
IA Values.
„ 8/0x08 Send user/group id. This is not needed by current
modules; use for backwards compatibility. Sends Windows
identification information for users and groups.
„ 2097152/0x200000 Do not compact .iab, .iap, and values.idx
files. Set this flag if you are loading and unloading batches
often and have plenty of disk space. This makes the InputAccel
Server run much faster, but uses more disk space.

MaxDebugOutSizeK Maximum size, in KB, allowed for the debug.out file. After the
REG_DWORD [0/0x0] file reaches the maximum size, debug messages begin overwriting
the oldest debug messages in the file. A value of zero indicates
unlimited size for the file.

ProcessExt Default file name extension for process files.1


REG_SZ [.iap]

210
Appendix B: InputAccel Server registry values

Table 10: InputAccel Server registry values (continued)


This table describes InputAccel Server registry values. Default values are shown in brackets [ ].

Value, type Description


RamBufSize Size of the internal network buffers for the server, which are used
REG_DWORD to store messages from clients.1
[16384/0x4000]

RequireLatestClient Requires that the iaclient.dll or iaclnt32.dll version match the


REG_DWORD [0/0x0] version of the InputAccel Server that is running.
Setting this value to one disallows any client modules to connect
that use a client DLL prior to the release of the InputAccel Server.
Typically this only allows compatibility enforcement of major
product revisions, for example, require 5.3 clients with 5.3
InputAccel Server, disallow 5.0 clients on 5.3 InputAccel Server.
Setting this value to zero enables an older or current client version
to connect to the InputAccel Server.

RootDir Root directory in which to put all the InputAccel Server and
REG_SZ [c:\ias] InputAccel related files, such as batches and processes. Make sure
whatever drive you select is an NTFS drive to enable batch and
process security.

SO_RCVBUF Size, in bytes, for the TCP/IP receive buffer for the process.1
REG_DWORD
[65536/0x10000]

SO_SNDBUF Size, in bytes, for the TCP/IP send buffer for the process.1
REG_DWORD [0/0x0]

211
Installation and Configuration Guide

Table 10: InputAccel Server registry values (continued)


This table describes InputAccel Server registry values. Default values are shown in brackets [ ].

Value, type Description


StringTraceLevel Levels at which string tracing should occur. Strings are written to
REG_DWORD [116/0x74] the console if the InputAccel Server is running as an application.
Add the following values to determine which strings are written:
„ 1/0x01 Miscellaneous debugging information
„ 2/0x02 Network debugging information
„ 4/0x04 Console
„ 8/0x08 Information
„ 16/0x10 Warning messages
„ 32/0x20 Error messages
„ 64/0x40 Fatal messages
Note:
„ To trace strings at multiple levels, add the values for each level
together.
„ If you set the value for StringTraceLevel too high, then
InputAccel performance may be affected.

TimerInterval Period in milliseconds for the timer thread to run. The timer thread
REG_DWORD controls batch syncing, client timeout/ping and checking disk
[10000/0x2710] space.1

ValuesBackupTime Timing interval between automatic backup of the values.idx file


REG_DWORD on the InputAccel Server. This file is copied to values.bak. When
[3600/0xe10] the InputAccel Server next restarts, if it detects a problem with the
current values.idx, then it copies the file to valuebad.nn, copies
values.bak as values.idx, and attempts to start again.

BatchMaxVBProjectsLoade Controls the maximum number of Visual Basic projects loaded at


d once1 (default 100). The InputAccel Server loads up the projects
REG_DWORD [0x64] until this limit is reached, at which time it will free the last used
Visual Basic project.

212
Appendix B: InputAccel Server registry values

Table 10: InputAccel Server registry values (continued)


This table describes InputAccel Server registry values. Default values are shown in brackets [ ].

Value, type Description


CanPauseWhileDebugging Determines whether or not you can pause the InputAccel Server
REG_DWORD [1] while a batch is being debugged in Process Developer.1 If set to 1
(default), then you can pause during debugging. (Note, however,
that Process Developer will be disconnected from the InputAccel
Server and debugging will stop.) If set to 0, the InputAccel Server
cannot be paused during debugging.

1 These default registry values are effective even though no entry exists for them in the registry.
An entry only needs to be created if a value other than the default is desired.

213
Installation and Configuration Guide

Backing up and restoring server registry


values
To save registry values for the InputAccel Server:
1. Run regedit.exe from the server to launch the Registry Editor.
2. Navigate to
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\
InputAccel\Parameters.
3. Select Export Registry File from the Registry menu. The Export
Registry File dialog appears:

Figure 10: Save your exported registry branch to your IAS directory so that it will be
backed up regularly.

4. Give the file a unique name by typing the file name in the File name text
box.
5. Browse to the IAS directory.

214
Appendix B: InputAccel Server registry values

6. Make sure to select Selected Branch in the Export range section of the
Export Registry File dialog.
7. Select the Save button to save the selected branch to your IAS directory.
8. Select Exit from the Registry menu to exit the Registry Editor.
To restore registry values for the InputAccel Server:
1. Run regedit.exe from the server to launch the Registry Editor.
2. Navigate to
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\
InputAccel\Parameters.
3. Select Import Registry File from the Registry menu.
4. Browse to the IAS directory (or wherever you stored your backup registry
file) and select the exported registry file.
5. Select Open to import the registry file.
6. Select Exit from the Registry menu to exit the Registry Editor.

215
Installation and Configuration Guide

216
Index

A audit extenstions
configuring InputAccel, 86
Act as Part of Operating System right
granting, 157
during installation, 49 B
restriction, 148
backing up InputAccel client workstations, 174
activation
Backup Domain Controller, discussed, 147
activation file, 110
backup utility, restriction, 168
InputAccel Server on MSCS Cluster, 111
backups
Administrator module
discussed, 168
editing registry values with, 201
IAP files, 172
restriction, 96, 147
IAS directory, 168
setting permissions with, 146
IAS\activation directory, 172
annual licensing
IAS\batches directory, 171
See licensing types, periodic
IAS\modules directory, 173
Anti-Virus software, restriction, 165
IAS\process directory, 172
application
license files, 173
configuring the Server as, 157
modules, 174
running the Server as, 50, 149
opentext.ini, 175
application, running the Server as, 49
primeocr.ini, 175
audit extensions
prlexica.ini, 175
information logged by server, 86
PSG customizations, 177
installing, 84

217
Installation and Configuration Guide

registry, 173 See modules


registry values, 212 ClientTimeout registry value, 178, 205
scanner drivers, 176 Cluster registry value, 205
shortcut parameters, 177 Cluster, server registry value, 132
source code, validation, 176 ClusterBase feature codes, 130, 131
validation and ActiveX DLLs, 176 ClusterBase numbers and corresponding
values.idx, 170 feature codes, 131
win.ini, 174 ClusterNumber registry value, 206
batch files ClusterNumber, server registry value, 132
backing up, 168 ClusterReconnectTime registry value, 205
creating, silent installation mode, 106 ClusterTimeout registry value, 206
deleting, recommendation, 164, 167 command-line
discussed, 210 properties, 186–191
registry values switches, 182–186
BatchExt, 203 commit interval, changing, 204
BatchMaxAddressK, 203 Configurator
BatchMaxLoaded, 167, 204 See PixTwain Configuration Wizard
BatchMaxVBProjectsLoaded, 212 configuring, ScaleServer, 52
BatchSync, 204 controller, recommendation, 10
size recommendation, 167 CPU
testing for corruption, 180 module requirements, 13
BatchExt registry value, 203 performance
BatchMaxAddressSpaceK registry value, 203 assessing, 160
BatchMaxLoaded registry value, 167, 204 improving, 165
BatchMaxVBProjectsLoaded registry value, recommendation, 9
212

D
BatchSync registry value, 204
BDC, discussed, 147
bi-annual licensing
See licensing types, periodic daily licensing
blank page detection, discussed, 143 See licensing types, daily
data redundancy, discussed, 10
debug.out file, discussed, 210
C DebugLevel registry value, 167, 207
defragmentation software, restriction, 165
caching, recommendation, 10 departments, discussed, 147
CanPauseWhileDebugging registry value, 213 desktop icons, updating, 96
checksums, defined, 207 DHCP, restriction, 18
choosing a startup mode, 148 disk
ClientPing registry value, 178, 205 controllers, recommendation, 10
See also pinging clients defragmentation software, restriction, 165
clients space

218
Index

assessing requirements, 161, 164 guest accounts, restriction, 147


registry values, 208

H
system, recommendation, 10
diskperf, discussed, 161
DiskReserveK registry value, 167, 208
Health Insurance Portability and
domain support, discussed, 146
Accountability Act of 1996, 90
dual processor recommendations, 9
dynamic disk defragmentation software,
restriction, 165
Dynamic Host Configuration Protocol,
I
restriction, 18 IA clients
See modules

E IA Server
See InputAccel Server
IAB files
Enter By date, restriction, 138
See batch files
entering license codes
iaclient.dll, 210, 211
See licensing, installing license codes
iaclnt32.dll, 210, 211
Enterprise Server
IAP files
See InputAccel Server
See process files
error checking, 207
IAS directory, 168
EventLogLevel registry value, 209
images
export modules
See stage files
licensing, 140, 141
importing license codes
page counting, 143
See licensing, installing license codes
Index module validation DLL and ActiveX
F DLLs, 176
InputAccel
FAT32 partitions, discussed, 48 upgrading, 21
feature codes and corresponding ClusterBase InputAccel modules
numbers, 131 See modules
FileTraceLevel registry value, 167, 209 InputAccel Server
Finish event handler, recommendation, 166 backing up
Flags registry value, 210 See backups
executing as background task

G
increasing performance, 165
installing, 43, 94
interacting with
global groups, creating, 146
See application
group licensing
modifying installations, discussed, 88, 123
See licensing types, group
modifying, silent installation mode, 88
groups, creating, 146
modifying, standard installation mode, 88

219
Installation and Configuration Guide

pausing, 148, 168 fields, 134


performance page counts
See performance discussed, 142
recommendations, 9 restriction, 143
registry values for ScaleServer group page limits
configuration, 132 discussed, 137
removing, discussed, 88 ScaleServer group, 130
repairing installations, discussed, 89 types
repairing installations, standard installation daily, 136, 141
mode, 124 group, 138, 139, 140
restarting after changing ScaleServer non-daily, 138, 139
group configuration, 134 periodic, 139, 141
ScaleServer installation and configuration, service bureau, 139
52 universal client, 140
system requirements, 8 Local Area Network, recommendation, 19
troubleshooting, 178 local groups, creating, 146
upgrading, downgrading, or uninstalling, localhost, do not use with a ScaleServer group,
39, 94 74
installation log files log files
See log files discussed, 89, 107
installations reading, 126
modifying, 123 user-specified, discussed, 108, 125
removing, 123 user-specified, sample entries, 126, 127
repairing, 124 Log on Locally user right, restriction, 147
silent, 117 logging events, 209
installing logging in, restriction, 147
modules looping through Nodes, discussed, 166
See modules

M
ScaleServer, 52
interactive installation mode
discussed, 97
interactive mode magic values, defined, 207
See application MaxDebugOutSizeK registry value, 210
meta keys, discussed, 210
Internet Explorer, requirement, 12
Microsoft
IPP writing, recommendation, 166
Internet Explorer, requirement, 12
products, 104
L Windows Installer, concepts, 41, 96
Windows XP, 12
LAN, recommendation, 19 mirrored data, discussed, 10
licensing modifying service pack installations, 105
ClusterBase feature codes, 130 modules

220
Index

before installing, discussed, 94


installing, silent installation mode, 102
P
installing, standard installation mode, 98 page counting
modifying installations, discussed, 105 See licensing, page counts
modifying, silent installation mode, 105 password, sharing, 146
modifying, standard installation mode, 105 patch code detection, discussed, 143
removing, silent installation mode, 106 PDC, discussed, 147
repairing installations, discussed, 106 performance
system requirements, 12 discussed, 10
upgrading, downgrading, or uninstalling, increasing, 165, 166
39, 94 registry values, 167
monthly licensing restriction, 168
See licensing types, periodic testing, 160
msi file, defined, 116 periodic licensing
See licensing types, periodic

N permissions
See also user rights
defining, 146
network
pinging clients
I/O, assessing performance, 162
discussed, 212
recommendations, 17
instructions, 178
traffic, controlling, 165
registry values, 205
non-daily licensing
restriction, 178
See licensing types, non-daily
pixconfg.exe
notation conventions, defined, 2
See PixTwain Configuration Wizard
NTFS
PixTwain Configuration Wizard, 95
mirror sets, restriction, 10
Prepare event handler, recommendation, 166
partition
Primary Domain Controller, discussed, 147
discussed, 47, 211
process files
verifying, 48
backing up, 168
discussed, 210
O registry values
BatchSync, 204
offline backups registry values, ProcessExt, 210
See backups testing for corruption, 179
online backups ProcessExt registry value, 210
See backups processor recommendations, 9
Properties, 186
Properties, command-line
See command-line
PSG customizations, 177

221
Installation and Configuration Guide

R TimerInterval, 212
ValuesBackupTime, 212
RAID, recommendation, 10 Removing an entire service pack, 106
RAM repairing installations
assessing performance, 161 discussed, 119
recommendation, 11 RequireLatestClient registry value, 211
registry values, 211 ReserveDiskSpaceK registry value, 165
RamBufSize registry value, 211 resolution, screen, 12
read operations, restriction, 166 rights
registry See user rights
Cluster value, 132 RootDir registry value, 211
ClusterNumber value, 132 runtwain.exe
key for ScaleServer values, 133 See PixTwain Configuration Wizard
server registry key for ScaleServer valeus,
133
Registry Editor, using, 199 S
registry values
Sample log file, 108
BatchExt, 203
ScaleServer
BatchMaxAddressSpaceK, 203
installing, 52
BatchMaxLoaded, 167, 204
ScaleServer group
BatchMaxVBProjectsLoaded, 212
Cluster registry value, 132
BatchSync, 204
ClusterNumber registry value, 132
CanPauseWhileDebugging, 213
licensing, 130
ClientPing, 178, 205
localhost issue, 74
ClientTimeout, 178, 205
registry value location, 133
Cluster, 205
restarting servers after making changes,
ClusterNumber, 206
134
ClusterReconnectTime, 205
ScaleServer, registry values, 132
ClusterTimeout, 206
Scan module licensing, discussed, 141
DebugLevel, 167, 207 Scan module, system requirements, 15
DiskReserveK, 167, 208 Scanner drivers, 176
EventLogLevel, 209 scanners
FileTraceLevel, 167, 209 installing, restriction, 94
Flags, 210 screen resolution
MaxDebugOutSizeK, 210 See resolution
ProcessExt, 210 screen savers, restriction, 166
RamBugSize, 211 SCSI
RequireLatestClient, 211 adapters, discussed, 15
RootDir, 211 controller, recommendation, 10
SO_RCVBUF, 211 drives, recommendation, 10
SO_SNDBUF, 211 security, discussed, 47, 146
StringTraceLevel, 167, 212

222
Index

server server, 8
additional security, 90 software developer’s kit, 12
restarting after making ScaleServer group

T
changes, 134
Server ID, discussed, 129
service
TCP/IP
configuring the Server as, 148
registry values, 211
running the Server as, 148
requirements, 19
service bureau licensing
TimerInterval registry value, 212
See licensing types, service bureau
timing out
service packs
modifying installations, standard mode, See ClientTimeout registry value
105 triggering
removing, silent installation mode, 106 recommendation, 166
service, running client modules as, 149–156 registry values, 210
service, running the Server as, 49 TWAIN, using, 95
Services file, modifying, 122
setup.exe, discussed, 102, 119
Shortcut Parameters, 177
U
shortcuts, updating, 96 Ultra-Wide SCSI
silent installation mode controllers, recommendation, 10
defined, 41, 96 drives, recommendation, 10
discussed, 118 unattended installations, discussed, 118
optional commands, 120 universal client licensing
required commands, 118 See licensing types, universal client
SO_RCVBUF registry value, 211 upgrading InputAccel, 21
SO_SNDBUF registry value, 211 usage rules
stage file directories, 171 for command-line properties, 192
stage files, counting, 164 for command-line switches, 185
standard Installation mode user name, sharing, 146
defined, 41, 96 user rights
startup modes Act as Part of Operating System
See granting, 157
application granting during installation, 49
service restriction, 148
StringTraceLevel registry value, 167, 209, 212 Log on Locally, 147
sub-network, recommendation, 19 users, creating, 146
supported command-line switches, properties
and their parameters, 182, 183
system requirements V
modules, 12
network, 17 Validation source code, 176

223
Installation and Configuration Guide

values.bak, discussed, 179 protocol, using, 18


values.idx, 170 server
backing up, 168 recommendations, 9
discussed, 210 requirements, 8
testing for corruption, 179 storage requirements, 164
ValuesBackupTime registry value, 212 service
virtual memory, discussed, 161, 162 installing the Server as, 49
workstation requirements, 12

W
Windows NT
partitions
See NTFS
win.ini file, 174 performance monitor
Windows discussed, 11, 204
application protocol, using, 18
running the Server as, 50, 149 server
backup utility, restriction, 168 recommendations, 9
granting user rights, 157 storage requirements, 164
guest accounts, restriction, 147 service
Windows 2000 installing the Server as, 49
partitions Windows XP, discussed, 12
See NTFS write operations, restriction, 166
performance monitor write-back caching, recommendation, 10
See also performance write-thru caching, recommendation, 10
discussed, 11, 204
using, 160

224

You might also like