Professional Documents
Culture Documents
InputAccel 5.x Installation Guide
InputAccel 5.x Installation Guide
3 ®
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.
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
Greater than Separates cascading From the Windows Start menu, select
symbol (>) menu options. Programs > InputAccel > Scan.
Suggested reading
2
About this guide
3
Installation and Configuration Guide
4
1
Chapter
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.
7
Installation and Configuration Guide
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
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.
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
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
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
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.
Note: For information about the scanners and SCSI adapters that we support, see
out Pixel Translations web site at: www.pixtran.com.
15
Installation and Configuration Guide
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.
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
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.
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.
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.
23
Installation and Configuration Guide
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.
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
26
Chapter 2: Upgrading InputAccel
27
Installation and Configuration Guide
28
Chapter 2: Upgrading InputAccel
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
30
Chapter 2: Upgrading InputAccel
31
Installation and Configuration Guide
32
Chapter 2: Upgrading InputAccel
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
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.
34
Chapter 2: Upgrading InputAccel
35
Installation and Configuration Guide
36
Chapter 2: Upgrading InputAccel
37
Installation and Configuration Guide
38
3
Chapter
39
Installation and Configuration Guide
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
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.
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.
42
Chapter 3: Installing the InputAccel Server
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
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.
45
Installation and Configuration Guide
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.
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.)
48
Chapter 3: Installing the InputAccel Server
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.
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.
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.
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
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:
52
Chapter 3: Installing the InputAccel Server
53
Installation and Configuration Guide
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
Scan 1 Scan 2
ScaleServer-compatible
InputAccel client
workstations
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
56
Chapter 3: Installing the InputAccel Server
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.
To configure a ScaleServer group, you must obtain server and client licenses
that enable the ScaleServer technology.
58
Chapter 3: Installing the InputAccel Server
2 - - - E -
3 - - - E F
4 - - D - -
5 - - D - F
6 - - D E -
7 - - D E F
8 - C - - -
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
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.
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.
61
Installation and Configuration Guide
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
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.
64
Chapter 3: Installing the InputAccel Server
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.
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.
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
67
Installation and Configuration Guide
68
Chapter 3: Installing the InputAccel Server
69
Installation and Configuration Guide
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.
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.
71
Installation and Configuration Guide
72
Chapter 3: Installing the InputAccel Server
cannot borrow it, then the connection to the module is denied with a
licensing error.
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
Note: You must specify the InputAccel Server machine name, not “localhost”,
when connecting to a ScaleServer group
74
Chapter 3: Installing the InputAccel Server
75
Installation and Configuration Guide
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.
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).
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.)
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
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.
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
84
Chapter 3: Installing the InputAccel Server
85
Installation and Configuration Guide
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
Note: The Installing InputAccel Server dialog appears and shows the
progress of the modifications, even if you are removing a feature.
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.
89
Installation and Configuration Guide
90
Chapter 3: Installing the InputAccel Server
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
93
Installation and Configuration Guide
94
Chapter 4: Installing client modules
95
Installation and Configuration Guide
96
Chapter 4: Installing client modules
For more general information for the installer, see “Special information for
the installer” on page 116.
97
Installation and Configuration Guide
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
98
Chapter 4: Installing client modules
99
Installation and Configuration Guide
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
101
Installation and Configuration Guide
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\").
103
Installation and Configuration Guide
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
Note: The Installing InputAccel Client 5.3 dialog appears and shows the
progress of the modifications, even if you are removing a feature.
105
Installation and Configuration Guide
106
Chapter 4: Installing client modules
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"
107
Installation and Configuration Guide
108
5
Chapter
Note: You can launch this wizard manually from the Administrator module by
selecting Server > Install/Activate Activation File.
109
Installation and Configuration Guide
110
Chapter 5: Activating the InputAccel Server
111
Installation and Configuration Guide
112
Chapter 5: Activating the InputAccel Server
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
116
Chapter 6: Common Installation Topics
Silent Installations
117
Installation and Configuration Guide
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.
118
Chapter 6: Common Installation Topics
119
Installation and Configuration Guide
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.)
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
121
Installation and Configuration Guide
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
Repairing Installations
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.
125
Installation and Configuration Guide
126
Chapter 6: Common Installation Topics
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
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
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.
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
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.
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
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.
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.
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
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.
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:
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:
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:
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.
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:
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.
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.”
141
Installation and Configuration Guide
142
Licensing InputAccel
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
146
Chapter 8: Configuring InputAccel
147
Installation and Configuration Guide
Note: If you must pause anInputAccel Server for any reason, then be sure to stop
scanning before you pause the server.
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.
148
Chapter 8: Configuring InputAccel
149
Installation and Configuration Guide
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.
151
Installation and Configuration Guide
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
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.
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
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.
Note: Uninstalling a program from the command line only uninstalls the service,
not the application.
156
Chapter 8: Configuring InputAccel
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
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
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.
161
Installation and Configuration Guide
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
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
Note: This formula does not include the additional storage requirements of the
Windows Server that is hosting the InputAccel Server.
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
165
Installation and Configuration Guide
166
Chapter 9: Maintaining InputAccel
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
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.
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.
File Use
iacomdll.dll Library file used to store IPP templates
File Use
ias.exe The InputAccel InputAccel Server executable file
169
Installation and Configuration Guide
File Use
iaspfc.dll Library file for use with PCF InputAccel process
language
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.
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.
172
Chapter 9: Maintaining InputAccel
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.
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
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
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
179
Installation and Configuration Guide
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
/L switch
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)
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
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
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.
Example setup.exe /x
/i switch
Parameters None.
/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.
184
Appendix A: Command-line instructions
/q switch
Parameters [n|b|r|f|+|-]
(server, client)
185
Installation and Configuration Guide
ADDLOCAL property
Parameters Feature list. Separate multiple features with a comma (no spaces
(server, client) in between comma and next feature).
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).
REINSTALL property
Parameters Feature list. Separate multiple features with a comma (no spaces
(server, client) in between comma and next feature).
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).
187
Installation and Configuration Guide
REINSTALLMODE property
Parameters [p|o|e|d|c|a|u|m|s|v]
(server, client)
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
188
Appendix A: Command-line instructions
ARPNOMODIFY property
ARPNOREMOVE property
189
Installation and Configuration Guide
REBOOT property
Parameters [Force|Suppress|ReallySuppress]
(server, client)
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
Description If the LIMITUI property is set, then the user interface level is
restricted to basic.
INSTALLDIR parameter
LICENSEMODE parameter
191
Installation and Configuration Guide
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
197
Installation and Configuration Guide
198
B
Appendix
199
Installation and Configuration Guide
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
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
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
203
Installation and Configuration Guide
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
205
Installation and Configuration Guide
206
Appendix B: InputAccel Server registry values
207
Installation and Configuration Guide
208
Appendix B: InputAccel Server registry values
209
Installation and Configuration Guide
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.
210
Appendix B: InputAccel Server registry values
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
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
212
Appendix B: InputAccel Server registry values
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
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
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
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
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
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
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