Intelligent Capture 20.2 Installation Guide
Intelligent Capture 20.2 Installation Guide
Intelligent Capture 20.2 Installation Guide
Version 20.2
Installation Guide
Legal Notice
3
Table of Contents
4
Table of Contents
5
Table of Contents
Appendix G Command Line Arguments for Installing Intelligent Capture .................... 177
Supported InstallShield Switches ..................................................................... 177
Supported MSI Switches ................................................................................. 178
Supported Windows Installer Properties .......................................................... 178
Intelligent Capture Installer Properties and Feature Names ............................... 178
Intelligent Capture Database Installer Properties .......................................... 179
Intelligent Capture Database Installer Command Line Examples ............... 183
Intelligent Capture Server Components Installer Properties ........................... 183
Intelligent Capture Server Installer Command Line Examples ................... 192
Intelligent Capture Web Components Installer Properties ............................. 194
Intelligent Capture Web Components Installer Command Line
Examples ............................................................................................... 197
Client Components Installer Properties ........................................................ 197
Client Components Installation Features ................................................. 201
Client Components Installer Command Line Examples ............................ 203
6
Table of Contents
List of Tables
7
Table of Contents
8
Chapter 1
Overview
This guide explains how to install, configure, and upgrade Intelligent Capture and Intelligent
Capture Real Time Services.
Intelligent Capture
Intelligent Capture captures and processes documents from a variety of sources including scanners,
fax servers, email servers, file systems, web services, and via RESTful web services. Document
information can be stored as images, text, or both. Intelligent Capture is optimized for capturing
documents, not storing them for long-term access. Typically, documents remain in the system for a
few hours to a few days, until they are exported to a content repository or other back-end system.
Intelligent Capture is a scalable solution that optionally uses multiple servers to manage resources.
Therefore, it can process large amounts of data from throughout your enterprise. It also handles
multiple languages and system locale settings. Benefits of Intelligent Capture include:
• Reducing operating costs caused by factors such as document preparation and data entry.
• Reducing recovery costs caused by mishandled physical documents.
• Improving information quality for critical business processes.
• Accelerating business processes by providing immediate access to all information and supporting
documentation.
• Enforcing strong compliance control by storing documents and metadata electronically.
• Minimizing processing errors, improving data accuracy, and boosting productivity.
9
Overview
application authentication plugin that authenticates and maps the Intelligent Capture REST
Service Web application's callers to the appropriate Intelligent Capture user roles.
• In an Ad Hoc Service request, your application makes a request to the Intelligent Capture REST
Service Web application for Module Server services, such as classifying and extracting pages
or reading barcodes.
Intelligent Capture Real Time Services can be deployed standalone or in combination with an
Intelligent Capture system as follows:
• Standalone Intelligent Capture Real Time Services
— Document Services and Image Services licenses (on a single Intelligent Capture REST Services
system)
— (Optional) Text-searchable PDF license
— Real-Time Advanced Recognition license (also available separately)
— Two Intelligent Capture Server licenses (including an annual page count of 1 page per year) for
configuration and user authentication only in a high-availability environment
— Intelligent Capture REST Services feature code
— ScaleServer feature code
— Extraction module and Recognition Designer feature code
• Intelligent Capture Real Time Services in combination with Intelligent Capture
— Document Services and Image Services licenses (on a single Intelligent Capture REST Services
system)
— (Optional) Text-searchable PDF license
— Real-Time Advanced Recognition license (also available separately)
Related Topics —
Chapter 2, Installation Planning
Chapter 4, Upgrading Intelligent Capture
10
Chapter 2
Installation Planning
Intelligent Capture
A successful Intelligent Capture installation depends on having a good installation plan. There are
several considerations to understand before beginning with the installation. Topics in this section
include:
• General Considerations, page 11
• Sample Production Installation Configurations, page 34
General Considerations
Carefully planning the installation requires attention to many aspects, including: hardware, software,
locale, networking, security, system availability, backup, recovery, and more. The following table
summarizes many of these issues and directs you to more information.
Note: For planning considerations specific to Intelligent Capture REST Services and Intelligent
Capture Web Client, see Intelligent Capture Real Time Services, page 36.
11
Installation Planning
Locale Considerations
Intelligent Capture supports multiple languages within a deployment, thereby enabling global
document processing. Multiple language support enables batches and tasks to process data in
multiple languages and use multiple locale settings. Refer to the Administration Guide to understand
the multiple language feature.
Locale considerations that are important before you install:
• User-specified information entered in the setup program must only include values from the code
page of the machine running the installer. Non-code page values will result in data corruption.
• On machines running client modules and the Intelligent Capture Server, the language specified by
the locale setting must be supported by the code page selected on that machine.
Maximizing performance and throughput are key objectives when designing an Intelligent Capture
system. Many factors affect performance and throughput, but at the top of the list are the server
12
Installation Planning
processors, their disk systems, and the network to which they connect. Good infrastructure planning
results in taking full advantage of Intelligent Capture modularity.
Intelligent Capture modularity enables you to adjust the configuration to meet production needs after
observing the system in production mode for a period of time. Add more modules, more machines,
more Intelligent Capture Servers, and more operators as needed to meet your production goals.
To maximize the performance and throughput at all points in the system, consider each of the
following components individually:
• Database Server Considerations, page 13
• Intelligent Capture Server Considerations, page 15
• Web Services Subsystem Considerations, page 16
• Client Machine Considerations, page 17
The SQL Server hosted Intelligent Capture Database is an optional component. The database is
required only if your environment has any of the following requirements:
• Reporting functionality is required
• ScaleServer capability is required
• WS Input (Web Services) and WS Output (Web Services) must be supported
• Microsoft Failover Clustering support is required
• Side-by-side Intelligent Capture Servers are required
• You are upgrading from an Intelligent Capture 7.x environment that included the Intelligent
Capture Database
Note: In a ScaleServer environment only one database is allowed.
The machine that hosts the Intelligent Capture Database must service queries, process every
transaction related to reporting and logging, and store these results until they are purged, either by
a manual or scheduled job.
In high volume environments, install the Intelligent Capture Database server on a fast multi-CPU
machine with fast, RAID hard drives, and with as much RAM as the operating system supports.
When database storage requirements become very large, due to process volumes and enabled
logging and reporting rules, high throughput becomes critical to maintaining production volumes.
Choose the latest high-speed technology from among available disk storage systems. The network
connection between the Intelligent Capture Server and the Intelligent Capture Database must have
high bandwidth (about 1 GB per second) and low latency. For the Intelligent Capture Database data
directory, configure multiple identical disk drives in a RAID configuration to achieve the required
reliability and failure protection. Use trusted and reliable disk drives with high performance and
high capacity ratings.
Although any RAID level is supported, optimization for maximum performance and the use of fault
tolerance is highly recommended. For example, RAID 0 does not have fault tolerance and is therefore
not recommended. Also, although RAID 5 and 6 have fault tolerance, their performance is lower than
RAID 10. Therefore, RAID 10 is the recommended RAID level.
13
Installation Planning
14
Installation Planning
Server Express service. Connection errors can occur if SQL Server Express is not configured
to allow for TCP/IP access.
• SQL Server Express editions must only be used in low page volume deployments with minimal
reporting and logging due to the following limitations:
— SQL Server Express does not support configuration for failover or high availability.
— SQL Server Express supports the use of one GB of RAM, and utilizes one CPU. With multiple
CPUs, SQL Server Express uses only one from those available.
— By default, SQL Server Express creates a named instance. Named instances require specifying
the instance name in all database connection strings. To avoid this issue, create an unnamed
instance during SQL Server Express installation.
— Microsoft SQL Server Management Studio Express is not automatically installed with all
versions of SQL Server Express, but it is available as a separate installation from Microsoft.
Related Topics —
Chapter 2, Installation Planning
Installing the Intelligent Capture Database, page 45
Intelligent Capture Database Issues, page 153
The Intelligent Capture Server is memory and disk intensive. The server stores multiple copies of
each processed image, often one or more for each step in a process. Also, the image data being
processed requires significant processing and space on the server. For this reason, there are some
important factors to consider related to the Intelligent Capture Server.
• For all but low volume deployments, Intelligent Capture requires a dedicated computer for the
Intelligent Capture Server. This computer must meet the recommended hardware requirements
specified in the Release Notes (available from the Start menu of your desktop at All Programs >
OpenText Intelligent Capture > Documentation). High volume deployments may require larger
than the recommended hardware.
• Use the same performance considerations as for the Intelligent Capture Database (described in
Database Server Considerations, page 13) for selecting a network connection and a disk system
for the Intelligent Capture Server data directory (C:\IAS by default). Also, do not locate the
Intelligent Capture Server data directory and the Windows paging file on the same physical
disk drive.
•
Caution: Do not run antivirus software on the Intelligent Capture Server data directory.
Running antivirus software on the Intelligent Capture Server data directory and its
subfolders will drastically degrade Intelligent Capture Server performance due to the large
number of files being written to the directory structure. In addition, some antivirus software
intercept network traffic and can interfere with Intelligent Capture Server operation. In all
cases, you should exclude the following directories and their subdirectories from antivirus
scanning:
Intelligent Capture Server data directory (by default, C:\IAS)
15
Installation Planning
• Another option for improving performance is to install multiple Intelligent Capture Server
instances as described in Installing Multiple Instances of Intelligent Capture Servers, page
65. Each Intelligent Capture Server instance should have 4 GB RAM and should have its data
directory on a separate disk drive.
• The Intelligent Capture Server fully supports locating its main directory structure on an NTFS
file system, and uses the built-in NTFS security system (access control lists) to implement its
own security. Alternatively, the Intelligent Capture Server main directory can be located on
a non-NTFS file system, such as is used in many Network Attached Storage (NAS) and Storage
Area Network (SAN) devices. However, when installed on a non-NTFS file system, ACL-based
security is not supported. Due to the known performance issues, NAS is supported for low
volume environments only.
• Be aware that even though the Intelligent Capture Server will run under a VMware ESX Server,
doing so will degrade the Intelligent Capture Server performance by approximately 20% or more.
Related Topics —
Installing the Intelligent Capture Server, page 48
Upgrading the Intelligent Capture Server, page 125
ScaleServer Issues, page 155
To use the Web Services subsystem, consider setting up one or more dedicated Web Services Hosting
servers. A single server may be adequate; however, many enterprises have a need to handle both
16
Installation Planning
internal and external web service requests and responses, and so you may want to have one instance
of Web Services Hosting openly accessible from the local network and another instance accessible
from the Internet through a firewall.
A single instance of Web Services Coordinator handles requests from all instances of Web Services
Hosting. Web Services Coordinator communicates directly with the Intelligent Capture Database,
and should therefore be installed on a secure server with a high-speed network connection to the
Intelligent Capture Database host machine. Depending on the required performance of the Web
Services subsystem, Web Services Coordinator may share the same machine as the internal-facing
Web Services Hosting instance or may require a separate, dedicated machine.
Note: Although you can install multiple instances of Web Services Hosting, this component does
very little processing. Typically the only reason to install multiple instances is to separate internal
from external request/response traffic. In any case, an Intelligent Capture system may have only one
Web Services Coordinator instance.
Before attempting to use Web Services Input be sure that the Web Services Hosting and Web Services
Coordinator services are started.
Related Topics —
Chapter 2, Installation Planning
Intelligent Capture provides operator-attended client modules and unattended client modules.
The Client setup program supports installation of any combination of Intelligent Capture modules
on a single machine.
It is recommended that the network connection between the Intelligent Capture Server and the client
modules have high bandwidth (1 Gb per second) and low latency for optimal performance.
Typically, only the modules that will be run on a machine must be installed on that machine.
Unattended modules are configured and run continuously in a “wait for task” mode, processing
tasks whenever they are received from the Intelligent Capture Servers. Unattended modules are
server-grade applications that should be installed on IT-managed servers and, if supported, run as
Windows services. (Refer to Table 19, page 162 for a list of modules that run in unattended mode
and that run as services.) For unattended modules that run as services, no operator intervention is
required. When running modules as services, run them under a user account or a machine account.
Export modules typically use minimal amounts of processing power and only process tasks
intermittently. Several modules using minimal processing power can be hosted by a single computer
without creating a bottleneck. On the other hand, page recognition and image enhancement modules
(for example) can use all available processing power over extended periods and still may not keep
up with the number of tasks being generated for them. Modules of this type typically should have
dedicated computer with dual cores and, in some cases, multiple instances of a module may be
needed, each running on a separate computer.
To determine the actual number of module instances required, use client balancing to observe the
system in typical production operation, find the bottlenecks, and add module instances until the
throughput is satisfactory. Client balancing is accomplished by bringing one module instance on
line at a time until the average number of new tasks being generated for the module is less than the
number of tasks being processed by all module instances.
17
Installation Planning
Note: When performing client balancing, it may not be necessary to install multiple module
instances on separate physical machines. For example, if using high-performance, multiprocessor
machine systems, you may be able to install multiple instances of a page recognition or image
processing module on one machine. Or install a combination of processor-intensive modules and
non-processor-intensive modules on one machine. Table 19, page 162 provides a list of modules that
can run as services as well as modules for which multiple instances can be configured to run as
services on a single machine. Manually Registering a Client Module to Run as a Service, page 99
explains how to configure modules that have already been installed to run as services.
For modules that support multiple service instances (as listed in Appendix B, Intelligent Capture
Client Modules), consider installing multiple instances on a single multi-core machine to achieve
client balancing and scalability as needed. For modules that do not support multiple service
instances, consider running multiple instances on separate virtual machines on the same physical,
multi-core machine. In all cases, you must ensure that the machine has sufficient processing capacity
to run multiple instances.
Related Topics —
Running Modules as Services, page 18
When configuring modules to run as services, you must configure the following:
1. Windows account under which the module runs
2. Ability for this account to log into the Intelligent Capture Server
3. Intelligent Capture permissions
Note: For a list of client modules that can be run in unattended mode and as services, refer to Table
19, page 162.
18
Installation Planning
Note:
— All modules that are installed during a single execution of the client setup program to run as
services are configured to use the same type of account (user or Network Service).
— All modules that are installed during a single execution of the client setup program to run
as services under a user account are configured to use the same user name, password, and
domain name. (These settings can be changed later by using the Services application of the
Microsoft Management Console).
— User accounts must be domain accounts except when all Intelligent Capture components are
installed on a single machine. When all components are installed on a single machine, there
are no issues with using the Network Service account, because the machine already has the
ability to log into itself.
— When using the Network Service account to run client modules as services, make sure to run
the Intelligent Capture Server under the LocalSystem account.
— Make sure that the client machine running the client module as a service is added to the
Module Operator role in Intelligent Capture Administrator.
Enabling the “run-as” account to log into the Intelligent Capture Server
Regardless of whether a module runs under a user account or Network Service, that account must
have the ability to log into the Intelligent Capture Server machine. This ability is automatically
configured when using a domain user account—members of the Domain\Users group are added to
the Intelligent Capture Server machine's local Users group by default.
However, machine accounts such as Network Service do not, by default, have the ability to log into
the Intelligent Capture Server (unless the module is running on the same machine as the Intelligent
Capture Server). This ability must be granted by adding the client machine name (in the form of
domain\machinename$) to a local group (for example the local Users group) of the Intelligent
Capture Server machine.
Configuring Intelligent Capture Permissions
Use Intelligent Capture Administrator to assign appropriate permissions to the group to which the
user account belongs.
• If the module is running as a service under a user account, configuring permissions consists of
assigning one or more groups to one or more permission roles, possibly adding new roles or
modifying existing roles to provide the necessary permissions.
• If the module is running as a service under the Network Service account, configuring permissions
consists of assigning the Network Service account to one or more permission roles, possibly
adding new roles or modifying existing roles to provide the necessary permissions. The only
difference is that when adding the account to a role in the Select User or Group window of
Intelligent Capture Administrator, you must add the machine account for the modules running
under Network Service in the form of domain\machinename$.
Tip: Consider adding all such machine accounts to a domain group and then adding that group
to the role. This will simplify ongoing permissions maintenance of Intelligent Capture modules
running as services under Network Service.
The Using Intelligent Capture Administrator section in the Administration Guide provides more
information about adding users and groups to permission roles.
19
Installation Planning
Examples —
setspn -A IAServer/prodserver.bigcorp.com:10099
setspn -A IAServer/prodserver.bigcorp.com:10099 prodserver
Note:
• To add the required SPN, you must have permission to write arbitrary SPNs in your domain.
By default, only the domain administrator has this permission.
• Per domain, only one SPN may be registered for each Intelligent Capture Server.
20
Installation Planning
Related Topics —
Appendix B, Intelligent Capture Client Modules
Installing the Intelligent Capture Client Components, page 51
Scalability
The modularity that is built into Intelligent Capture enables customers to configure and reconfigure
their Intelligent Capture system to meet their changing needs. Both server and client subsystems are
modular and scalable.
Topics in this section include:
• Intelligent Capture Server Scalability, page 21
• Client Scalability, page 22
When the document capture workload exceeds the capabilities of a single Intelligent Capture Server,
scale up the system by adding more Intelligent Capture Servers and creating a ScaleServer group. A
ScaleServer group combines multiple Intelligent Capture Servers into a single information capture
system. Both attended and unattended modules can connect to the servers in a ScaleServer group,
after which they can receive and process tasks from all connected servers. In addition to expanding
the workload capacity over a single Intelligent Capture Server, ScaleServer groups can also help to
ensure that client modules and their operators spend less idle time waiting for new tasks to arrive.
Adjust the number of client modules and Intelligent Capture Servers to achieve the required balance
of throughput. The ideal scenario is to have enough server capacity to process as many incoming
batches as necessary while having enough client capacity to keep up with, but not exceed, the task
processing requirements of the workload.
Most modules are ScaleServer compatible and therefore can connect to all Intelligent Capture
Servers in the group simultaneously. Modules that are not ScaleServer compatible can connect to
any one Intelligent Capture Server in the ScaleServer group at a time. (No module can connect to
multiple arbitrary Intelligent Capture Servers—only to multiple servers that have been configured
as a ScaleServer group.) Appendix B, Intelligent Capture Client Modules provides a table of client
modules that indicates which modules are ScaleServer compatible.
Additional Intelligent Capture Servers can be added to a ScaleServer group when the Intelligent
Capture system is initially configured or at any later time. For more information on managing
and licensing ScaleServer groups, refer to the Using Intelligent Capture Administrator section in the
Administration Guide. For instructions on installing a ScaleServer group, refer to Configuring Multiple
Intelligent Capture Servers as a ScaleServer Group, page 67.
Note: A ScaleServer group is not a redundant or failover system. ScaleServer technology provides
process sharing as well as load balancing capabilities; it does not provide data redundancy.
Note: ScaleServer technology does not provide batch data sharing.
The Intelligent Capture Server is also scalable by virtue of its side-by-side installation capability. If
using high-end server hardware with multiple cores, take advantage of the additional processing
power by installing multiple side-by-side instances of the Intelligent Capture Server. This
21
Installation Planning
configuration may enable better parallel execution of batches when running on multi-processor
machines. The actual performance benefit depends on the task load and the types of tasks you
are processing.
Side-by-side installation also enables multiple instances of the Intelligent Capture Server to be
installed in an Active/Active Microsoft Failover Clustering, as explained in High Availability and
Failover, page 29.
Related Topics —
Installing the Intelligent Capture Server, page 48
Upgrading the Intelligent Capture Server, page 125
ScaleServer Issues, page 155
Client Scalability
Intelligent Capture client modules process tasks sent to them from Intelligent Capture Servers.
Intelligent Capture design enables multiple modules to simultaneously process different tasks from
all in-process batches. This means that production bottlenecks caused by slow modules can be
resolved by adding more instances of those modules. There are several factors to consider when
planning the number of each module required:
• The volume of incoming paper that must be processed. For example, a high-speed scanner with
a skilled operator may be able to scan 20,000 pages per shift, but you may need to process
200,000 pages per 24-hour period. Intelligent Capture enables installing as many ScanPlus (and
RescanPlus) machines as required to handle high workloads.
• The amount of processing power the module needs. For example, an OCR module requires much
more time to process a task (recognize a page of text) than an export module requires to export
the same page of text. Intelligent Capture enables adding as many OCR modules as necessary to
keep up with the system workload.
• The amount of time an operator requires to process a task. For example, manual indexing
involving many fields that must be manually keyed by an operator takes more time than simple
indexing tasks. Also, operator skill and other external factors affect the time required to process
each task. Intelligent Capture enables adding as many Completion machines as needed to keep up
with the indexing workload.
Additional client modules can be added to the system at any time after the initial installation without
negatively impacting production. If using machines with multiple processors, multiple instances of
certain modules can be installed as services on a single machine. Appendix B, Intelligent Capture
Client Modules provides a table of client modules that indicates which modules may be installed and
run as multiple service instances. Manually Registering a Client Module to Run as a Service, page 99
explains how to install modules as services using the serviceName command-line argument.
Related Topics —
Appendix B, Intelligent Capture Client Modules
22
Installation Planning
Security
Various security providers interact with Intelligent Capture at various levels. Planning must include
considerations for security and how it affects and secures the system.
The following table explains major security considerations.
Note: Security considerations related to SQL Server and Intelligent Capture Database are applicable
only if your configuration requires that the Intelligent Capture Database be installed.
A SQL Server login ID having a SQL Server dbcreator role must be used in
order to create the Intelligent Capture Database during the Intelligent Capture
Database installation.
Intelligent The Intelligent Capture Database must have the database role membership
Capture set to Public. Intelligent Capture does not use user-based authentication or
Database authorization for database access; therefore, there is no need to create database
users and groups. Choose one of the following options for database access:
• Create a SQL Server user account with either SQL Server or Windows
authentication enabled. Grant the following permissions to the account:
Connect, Delete, Execute, Insert, Select, and Update. Use this account to
access the Intelligent Capture Database. This is the recommended approach.
23
Installation Planning
Intelligent Capture requires that user accounts have passwords. Blank passwords
are not supported in any scenario, even on a single-machine installation.
Note: Default version of these roles with associated permissions are predefined
in Intelligent Capture Administrator. Examine these default roles and change
the permissions and then add new roles as required.
Passwords must not contain “@” symbols because this symbol is used as a
delimiter in command line arguments.
Servers and client modules running as services can be configured to run under a
specific user account or a built-in machine account.
24
Installation Planning
Microsoft publishes documentation about running its server products in a secure, or hardened,
environment. Hardening machines means establishing security policies, applying all of the latest
operating system security patches, disabling redundant services, enabling firewalls, blocking unused
ports, and all the other details of configuring an IT infrastructure to block unwanted access.
Intelligent Capture is intended to run in a hardened environment and has been tested with some
common but not all possible hardened configurations and components.
Related Topics —
Chapter 1, Overview
Chapter 2, Installation Planning
25
Installation Planning
Good security practice includes setting up machines to run applications with the minimum possible
permissions. The following are the minimum Windows permissions required for Intelligent Capture
components:
• Intelligent Capture Database (if installed):
— User: A SQL Server user account with either SQL Server or Windows authentication. These
permissions must also be enabled: Connect, Delete, Execute, Insert, Select, and Update.
• Intelligent Capture Servers:
— User: Must be a member of the InputAccel_Server_admin_group group on the server
machine. This group is created by the Intelligent Capture Server setup program and is granted
the following privileges and permissions, which are the only rights required for the Intelligent
Capture Server to function:
— Impersonate a client after authentication
— Load and unload device drivers
— Create global objects
— Full permissions on the Intelligent Capture Server data directory (c:\ias, by default)
and all of its subfolders and files.
— Full permissions on the InputAccel registry key under MACHINE\SYSTEM
\CurrentControlSet\Services\.
— Permission to activate and execute DCom objects
Note: You must set Local Security Policy > Security Settings > Local Policies > Security
Options > User Account Control: Run all administrators in Admin Approval Mode to
Disabled.
— Programs:
— Intelligent Capture Server (ias64.exe) writes both the InputAccel_Server_admin_group
SID and the Administrator (SECURITY_NT_AUTHORITY) SID on the ACL of all processes,
batches, and other Intelligent Capture objects.
— Intelligent Capture Performance Counters (iaspmdll64.dll) uses shared memory with
explicit permissions to read and write for authenticated accounts.
• All modules: (By default, the Intelligent Capture installer grants the required access to the
specified folders and directories.)
— User: All users must have Read access to the Intelligent Capture Server (IAS) data directory
(c:\IAS by default) on each of the Intelligent Capture Servers.
In addition, modules that create batches (for example: ScanPlus, Standard Import, WS Input)
need Write access to the same folder.
— Directories:
— All supported operating systems: Users must have read/write access to
the directory in which settings.ini resides, either C:\Users\<user>
26
Installation Planning
\AppData\Local\VirtualStore\ProgramData\EMC\InputAccel or
C:\ProgramData\EMC\InputAccel.
— The account running the module must have Read/Write access to directories they are
exporting to and to the location of the Recognition project.
— All operating systems: Users of modules listed as “Available Prior to 6.0” in Table 19, page
162 must have Read/Write access to c:\Windows\win.ini.
— Registry: Users must have Read/Write access to the registry to enable the logging library to
report performance counter information. Without this access, modules will run but will not
report performance data. Note that modules new in 7.x (or later) do not require access to
the logging library.
• All modules listed as “New in 6.x” and “New in 7.0 - 7.7, 16.5, 16.6, 20.2” inTable 19, page 162:
— User: Client machines must be members of the local Users group. Ensure that “Run-as” users
have access to the network. To use command-line arguments to install, remove, or change
service settings, the user must be a member of the Administrators group. The account that
is assigned to the service through the command line is automatically granted the Service
Logon right.
— Directories: The account running the module must have Read access to the .NET config
directory and to other common Windows directories such as c:\Windows\System32.
• ScanPlus and Image Converter modules:
— Directories: The account running the module must have Read/Write access to the system
Temp directory.
• Standard Import:
— Directories:
— File System type: The user account must have Read access to watched directories, and
must have Write access to watched directories if the files they contain are to be moved or
deleted after they are imported.
— Email type: The user account running the module must have Read/Write access to the
directory to which emails are copied.
• Documentum Advanced Export:
— Directories: The account running the module must have Read/Write access to the
Documentum user directory (c:\Documentum, by default) and to the system Temp directory.
• Web Services Hosting:
— User: Must run as a named user (not a machine or built-in user). Running under an account
with administrative rights simplifies the configuration.
— Ports: If run under a non-Administrator account, the Administrator should reserve the ports
used by the Hosting service for the named user to establish HTTP connections on those ports.
Use the PortReserve.exe command-line utility located in the Client\binnt directory of
the Intelligent Capture installation directory to reserve these ports.
Related Topics —
Chapter 1, Overview
Chapter 2, Installation Planning
27
Installation Planning
The Intelligent Capture setup program is optimized for deploying the servers and clients within
a single domain. In this environment, the setup program performs most or all of the required
configuration automatically. However, a multi-domain environment is also supported.
In a multi-domain environment, configure the network to create trusts between the affected domains.
Every time a cross-machine communication is performed, a security check is made. These security
checks must succeed in order for the system to function properly.
The minimum cross-domain trust relationship required is “Nontransitive One-Way External Trust”
from the domain with clients that want to authenticate to the domain that has servers that need to
perform the authentication. Creating these trusts is an IT responsibility that uses operating system
tools, and is beyond the scope of this guide.
Note:
• To assign users or groups from other domains to Intelligent Capture security roles, Intelligent
Capture Administrator must have the privileges necessary to browse the other domains, or
the users from the other domain must be added to Windows groups in the domain where the
Intelligent Capture system is running.
• Any user who logs into an Intelligent Capture Server must have the “Windows Login” privilege
on the machine hosting the Intelligent Capture Server.
• Add only domain users or users on the Intelligent Capture Server to IA roles; that is, do not
specify the local Windows user accounts on a client module machine because the Intelligent
Capture Server would not be able to access them.
Related Topics —
Running Intelligent Capture with Minimum Windows Permissions, page 25
Installing Intelligent Capture in a Workgroup, page 28
Related Topics —
Running Intelligent Capture with Minimum Windows Permissions, page 25
Installing Intelligent Capture across Multiple Domains, page 28
28
Installation Planning
Intelligent Capture uses several technologies to ensure high availability and failover protection.
Technology Description
ScaleServer If an Intelligent Capture Server becomes unavailable due to a planned or
groups unplanned interruption, other Intelligent Capture Servers in the same ScaleServer
group automatically continue sending tasks to and accepting tasks from client
modules. ScaleServer groups provide high availability during hardware and
software failures; however, they do not provide failover, because the tasks on the
interrupted server are not rerouted and cannot be processed until the server
again becomes available.
29
Installation Planning
In addition to the high availability and failover mechanisms designed into Intelligent Capture, we
recommend the following best practices for other critical system components when Intelligent
Capture is used in mission-critical applications:
• At a minimum, connect the Intelligent Capture Server machine and the Intelligent Capture
Database machine to an uninterruptible power supply.
• Configure the SQL Server for high availability by setting up database mirroring and/or clustering.
Refer to Microsoft recommendations for advice and instructions.
• Configure the Intelligent Capture Servers for high availability by using ScaleServer groups and
configuring them in an Active/Passive or Active/Active Microsoft Failover Clustering cluster.
Refer to Configuring Multiple Intelligent Capture Servers as a ScaleServer Group, page 67 and
Installing the Intelligent Capture Server in a Microsoft Failover Clustering Environment, page 68
for instructions.
• Run unattended client modules as services and configure those services for high availability by
enabling automatic restart on failure. Refer to Manually Registering a Client Module to Run as
a Service, page 99 for the necessary settings.
Disaster Planning
Disaster planning is important for any business-critical application. The extent to which you plan
for disaster and disaster recovery depends on your needs, your budget, and the importance of your
document capture system to the continuation of your business. At one end of the spectrum is
planning for routine backups of critical data, perhaps with offsite storage. At the other end of the
spectrum, you might consider having multiple Microsoft Failover Clustering clusters in both local
and remote locations, each with its own Storage Area Network (SAN), with automatic, real-time SAN
replication. Some common themes of disaster planning and recovery include:
• Determining what to do in case the current production facility cannot function in any way.
• Planning for continuing production at another facility, possibly using equipment that is not
currently available.
• Devising a way to redirect new work to the substitute production site.
• Arranging to re-process a certain quantity of work that may be lost in the event of a disaster.
• Planning for training of additional or replacement personnel to help carry out the plan.
• Periodically testing the disaster recovery plan to ensure everything functions as needed in the
event of a disaster.
Disaster recovery pricing, which provides licensing and activation for periodic testing and one-time
use of a disaster continuation system, is offered.
Topics in this section include:
• Creating an Intelligent Capture Disaster Continuation Plan, page 31
• Disaster Recovery Considerations, page 31
• Implementing a Disaster Continuation System, page 32
30
Installation Planning
Disaster recovery planning should include a written plan describing exactly how to restore Intelligent
Capture production after a disastrous event. When writing the plan, consider the following questions:
• Who are the key personnel responsible for rebuilding the Intelligent Capture system and restoring
production?
• Who will act in your place?
• Where will the documentation be kept?
• Who will provide backup for key team members that may be unavailable?
• How will you train replacement or temporary workers?
• How long will it take to restore full production throughput?
• What will happen if you need to relocate your department to another location?
Disaster recovery can encompass much more than simple backups and redundancy. If planning to
put in place a simple backup plan, consider making both local and off-site backups of the following
critical components:
• Directory trees from each of your Intelligent Capture Server IAS directories
• Intelligent Capture Database from SQL Server
• Scanner drivers
• License files
• Patches
• Custom server and client software (from your own or third-party developers/OpenText Global
Technical Services)
• Custom client desktop shortcuts
• Client side script source code
• Client win.ini and settings.ini files
Table 11, page 112 provides a detailed list of files that should be backed up together with their default
locations on server and client machines.
Related Topics —
Disaster Planning, page 30
Implementing a Disaster Continuation System, page 32
Installing the Intelligent Capture Server in a Microsoft Failover Clustering Environment, page 68
31
Installation Planning
Implementing a robust Disaster Recovery system is complicated, detailed and specific to each
customer's environment. Contact OpenText Global Technical Services at My Support for help in
planning, implementing, and testing a Disaster Recovery environment.
Related Topics —
Disaster Planning, page 30
Disaster Recovery Considerations, page 31
Installing the Intelligent Capture Server in a Microsoft Failover Clustering Environment, page 68
Intelligent Capture uses a server-based licensing system that enables Intelligent Capture as well as
third-party module developers to regulate how their software is used in an Intelligent Capture
installation. Licenses are installed on each Intelligent Capture Server. When a client module connects,
the Intelligent Capture Server checks for a valid license before allowing the module to operate.
License codes are uniquely keyed to the Server ID that the Intelligent Capture Server retrieves from
its security key. Each license code specifies a single module and regulates how many copies of the
module can concurrently connect to the Intelligent Capture Server, how many pages the module is
allowed to process, how long the license is allowed to work, and what extra features are enabled.
The Intelligent Capture Server uses an activation file, which controls the licensing of the Intelligent
Capture system. Be aware that each Intelligent Capture Server requires a separate activation step.
Contact OpenText Global Technical Services at My Support to do any of the following:
• Obtain a new activation code for a new installation.
• Obtain a new activation code after a hardware, software, or configuration change.
• Obtain an Enter By extension.
• Initiate a Server ID migration when moving an Intelligent Capture Server to a different machine.
Note: Use activation file (software) security keys with side-by-side Intelligent Capture Server
installations. For more information on side-by-side installations, refer to Installing Multiple Instances
of Intelligent Capture Servers, page 65.
To install and manage license codes, and to activate Intelligent Capture Servers using activation
files, use Intelligent Capture Administrator. You will typically receive a file containing all of your
license codes, which you can import to your Intelligent Capture Server in a single step. You can also
manually type license codes one at a time. For more information on licensing and activation, refer to
the Using Intelligent Capture Administrator section in the Administration Guide.
Intelligent Capture REST Service client (including Intelligent Capture Web Client) and Module Server
licensing is managed through the Intelligent Capture Web Client Licensing page.
For more information about the Intelligent Capture REST Services Licensing tool, see the
Administration Guide.
32
Installation Planning
ScaleServer Licensing
Intelligent Capture licensing for ScaleServer enables multiple Intelligent Capture Servers to be
configured so that all modules can connect to them. ScaleServer groups are defined and managed in
Intelligent Capture Administrator. Each Intelligent Capture Server that is to be a part of a ScaleServer
group must have license codes that enable it to participate in the group and to enable the client
modules to connect to the group.
The Intelligent Capture Servers within a ScaleServer group share page count and connection licenses
to facilitate load balancing.
Note: Page count sharing applies to both the server license and licenses used by client modules.
Client modules can share page count between different servers having the same license in a
ScaleServer group.
A ScaleServer license is included with certain levels of Intelligent Capture licensing and is an available
option in other license levels. Contact OpenText Global Technical Services at My Support if unsure
about the features included with your license.
Example —
• Server 1 and Server 2 are each licensed to process 50,000 pages/day, for a total ScaleServer capacity
of 100,000 pages/day.
• Three hours before the end of the day, Server 1 has reached its 50,000 page limit, but Server
2 has processed only 25,000 pages.
• Server 1 automatically transfers from the Server 2 license enough page capacity to continue
working either until the end of the day or until 100,000 pages have been processed by the
Intelligent Capture system in that day.
This is a simple example, but the logic applies to more complex scenarios, where you may have eight
Intelligent Capture Servers in a ScaleServer group, all having different remaining daily page counts.
For instructions on setting up ScaleServer groups and managing licenses, refer to the Using Intelligent
Capture Administrator section in the Administration Guide.
Related Topics —
Licensing for Use in a Microsoft Cluster, page 33
Licensing for Disaster Recovery, page 34
Intelligent Capture licensing for clustering enables multiple Intelligent Capture Servers to be
configured in an Microsoft Failover Clustering Active/Passive or Active/Active cluster. A standard
Intelligent Capture Server license does not enable the server to run as part of a cluster.
33
Installation Planning
For detailed information on configuring multiple Intelligent Capture Server instances in an Microsoft
Failover Clustering cluster, refer to Installing the Intelligent Capture Server in a Microsoft Failover
Clustering Environment, page 68. For instructions on installing and managing licenses, refer to the
Using Intelligent Capture Administrator section in the Administration Guide.
Related Topics —
Licensing for Disaster Recovery, page 34
Certain levels of Intelligent Capture licensing include licenses for implementing, testing, and using a
disaster recovery system. If unsure about whether your licensing level includes a disaster recovery
system, contact OpenText Global Technical Services at My Support. For information on setting up
a disaster recovery system, refer to Disaster Planning, page 30. For instructions on installing and
managing licenses, refer to the Using Intelligent Capture Administrator section in the Administration
Guide.
Related Topics —
ScaleServer Licensing, page 33
Licensing for Use in a Microsoft Cluster, page 33
34
Installation Planning
35
Installation Planning
36
Installation Planning
Scalability
For scaling the Intelligent Capture Real Time Services (including Intelligent Capture REST Service,
Intelligent Capture Web Client (as well as any other custom clients)), the following guidelines are
recommended:
• One Web server for 750 concurrent users.
• One Module Server for 20 concurrent users.
• Each Module Server should have 16 instances of each module type (Extraction, Full Page OCR,
Image Converter, Image Processor, Scripting) and have the following:
— 8 CPUs
— 24GB RAM
• For batch storage, estimate the number and sizes of the files and images in your typical batch as
well as the number concurrent users and then, to ensure reliable performance and account for
overhead, double that size. For example, the following would require 4GB:
— 200KB per image or file
— 100 images or files per batch
— 100 concurrent users
(200KB x 100 images/files x 100 concurrent users = 4GB)
Security
• The following components are hosted by IIS, which should be configured to use Secure Sockets
Layer (SSL) to ensure that user credentials and data traffic are encrypted between the hosts and
their clients:
— Intelligent Capture REST Service
— Intelligent Capture Web Client
• Access to these components is controlled by several security providers, including the web server
that is hosting the component, Windows user permissions (ACLs), licensing, and Intelligent
Capture Administrator-assigned user roles.
37
Installation Planning
The following minimum permissions are required for a user account to run the Module Server
under it.
— Log on as service.
— Replace a process level token.
— Create global objects.
— Load and unload device drivers.
— Permission to activate and execute DCom objects.
Additionally, the user account must have full permissions to the REST shared data folder.
• For each Intelligent Capture REST Service Web application's Application Pool identity, perform
the following:
— Enable Read/write/delete/create access to the shared data folder on the file system
with the shared data folder.
— Add the identity to the following Windows groups on the Web server machine:
— IIS_IUSRS
This group grants access to all the necessary resources on the computer for proper
functioning of IIS.
— Performance Log Users
Intelligent Capture REST Service works with performance counters for special tracing
and reporting purposes.
— Add the identity to the Intelligent Capture Administrators role so that it has the necessary
permissions on the Intelligent Capture Server.
— For Intelligent Capture REST Service and Intelligent Capture Web Client, configure the SSL
certificate and HTTPS binding by adding these bindings in IIS Management Console in
Actions > Bindings.
38
Installation Planning
Disaster Recovery
Disaster recovery can encompass much more than simple backups and redundancy. If planning to
put in place a simple backup plan, consider making both local and off-site backups of the following
critical components:
• Intelligent Capture REST Services shared data folder (except for the Sessions subfolder)
39
Installation Planning
40
Chapter 3
Installing Intelligent Capture
This section explains how to install Intelligent Capture and Intelligent Capture Real Time Services
for the first time.
Intelligent Capture Real Time Services uses the same installer as Intelligent Capture.
Topics on installing Intelligent Capture include:
• Installing Intelligent Capture in a Production Environment, page 41
• Additional Installation and Configuration Options, page 64
• Installing Intelligent Capture in a Development or Demonstration Environment, page 102
• Deploying Intelligent Capture to Microsoft Azure, page 103
• Deploying Intelligent Capture to Google Cloud Platform, page 104
41
Installing Intelligent Capture
• Web Services
Output
Machine 10 (multiple) (Optional) Domain user Web application
Note: Multiple • Intelligent Capture
Intelligent Capture REST Service
REST Service Web
• Your custom
machines can work
Intelligent Capture
with the same IA
REST Service
ScaleServer group.
authentication
plugin
• Intelligent Capture
Web Client
42
Installing Intelligent Capture
• Image Converter
Machine 17 Standard Import Network Service Service
Machine 18 Standard Export Network Service Service
Machine 19 (multiple) Other unattended Network Service Service
client modules
Machine 20 (multiple) Browser access to Domain user Browser application
Intelligent Capture
Web Client
Mobile Devices Your custom mobile Customer-defined Customer-defined
(multiple) capture application
Note: Custom mobile
capture applications
are developed using
the PixTools for
Mobile, which is
packaged separately
from Intelligent
Capture.
43
Installing Intelligent Capture
3. Install the Intelligent Capture Server. You have the following options:
• Install the Intelligent Capture Server on a single machine, Server 2. Refer to Installing the
Intelligent Capture Server, page 48 for instructions.
• Install multiple instances of the Intelligent Capture Server on a single machine, Server 2. Refer
to Installing multiple instances of the Intelligent Capture Server for instructions.
• Install the Intelligent Capture Server on multiple machines, Server 2a and Server 2b, and
optionally configure them as a ScaleServer group.
• Install the Intelligent Capture Servers in a clustered environment and then configure them as
a ScaleServer group. Refer to Installing the Intelligent Capture Server in a Microsoft Failover
Clustering Environment, page 68 for instructions on installing Intelligent Capture Servers in
an Active/Passive or Active/Active clustered environment.
Note: The Intelligent Capture Database is required to configure Intelligent Capture Servers as a
ScaleServer group and to install the servers in a clustered environment.
4. Install development tools, Intelligent Capture Administrator, attended client modules,
Completion, ScanPlus, RescanPlus, and Identification as applications on each machine designated
for these modules according to the installation plan. Refer to Installing the Intelligent Capture
Client Components, page 51 for instructions.
5. (Optional) Install Web Services Coordinator, Web Services Hosting, Web Services Input, and Web
Services Output client modules on a separate machine.
6. (Optional) Install the Intelligent Capture REST Service (stand-alone) and any custom applications
that use it as follows:
a. Install and configure the Intelligent Capture REST Service and your custom Intelligent
Capture REST Service authentication plugin on a separate machine.
b. Create an appropriate location for Intelligent Capture REST Service shared data storage and
specify it in the Intelligent Capture REST Service configuration tool.
c. Deploy your custom applications that use the Intelligent Capture REST Service.
7. (Optional) Install the Intelligent Capture Web Client and Intelligent Capture REST Service
as follows:
a. Install and configure Intelligent Capture Web Client, Intelligent Capture REST Service, and
your custom Intelligent Capture REST Service authentication plugin.
A custom Intelligent Capture REST Service authentication plugin provides more flexibility
for authenticating users of the Intelligent Capture REST Service. For more information,
see the Intelligent Capture Scripting Guide.
b. Create an appropriate location for Intelligent Capture REST Service shared data storage and
specify it in the Intelligent Capture REST Service configuration tool.
c. Deploy your custom applications that use the Intelligent Capture REST Service.
8. (Required for Intelligent Capture Web Client; optional, otherwise) Install the Module Server on
a separate machine.
9. Install the other unattended client modules as services on each machine designated for these
modules according to the installation plan.
44
Installing Intelligent Capture
Note: For a list of client modules that can be run in unattended mode and as services, refer
to Table 19, page 162.
10. (Optional) Set the UI language for the different Intelligent Capture components.
11. Run Intelligent Capture Administrator. Configure the Web Services Coordinator and Web
Services Hosting components. Refer to the Using Intelligent Capture Administrator section in
the Administration Guide for details.
Caution: It is recommended that you disable antivirus software and Data Execution Prevention
(DEP), and close any open programs before installing the Intelligent Capture Database.
Note: The Intelligent Capture Database supports installation on a case-sensitive and case-insensitive
SQL Server. The Intelligent Capture Database, however, is case-insensitive. This means that
upper and lower case characters are not differentiated and instead are treated the same way when
performing searches or using the reports functionality.
The Release Notes provides more information about supported versions of SQL Server. This document
is available from the Start menu of your desktop at All Programs > OpenText Intelligent Capture >
Documentation.
Note: Due to limitations built into SQL Server Express, it should only be used in low page volume
deployments with minimal logging.
Note: The installer requires an account that is a member of the local Administrators group on the
machine from which you are running the setup program.
To install the Intelligent Capture Database:
1. Start the Intelligent Capture setup program from the installation media. If the setup program
does not start automatically after a few seconds, or if running the installation from a local disk or
network share, open the file autorun.exe to begin.
2. Select Install Product and then from the Installation Choices list, select Step 1 - Install
Intelligent Capture Database and then select the language of the installation and click Next.
45
Installing Intelligent Capture
Caution: Use of non-code page Unicode characters in the setup program may cause data
corruption and installation failure. Only specify characters from the code page of the
machine running the setup program.
Note:
• The account specified when installing the Intelligent Capture Database must have the
dbcreator role.
• If the Create the Intelligent Capture Database checkbox is selected, the local Database
Server, SQL Server Port, and Database name must be specified. The Database name can only
have the following characters: a-z, 0-9, _, $, #, @, and first character may only be a-z, 0-9, or an
underscore (_). (The default SQL Server port is 1433. For all SQL Server versions, including
the Express editions, make sure TCP/IP is enabled and a port is set before Intelligent Capture
Database installation.)
• If using a named instance for the SQL Server, be sure to specify the Database Server in
the format, [machine_name]\[instance_name]. For SQL Server Express, the default
instance name is SQLExpress.
• If the Copy Script Only option is selected, the Database executable and scripts are copied to
the target machine but the Intelligent Capture Database is not created. The IADBManager
executable must be manually run to create the database. Appendix F, Running the Database
Manager Utility provides instructions for manually creating the Intelligent Capture Database.
7. Click Install and then click Finish.
Note: The Intelligent Capture Database cannot be installed onto a compressed drive.
8. To verify a successful installation of the Intelligent Capture Database, run SQL Server
Management Studio, and expand the Databases folder in the Object Explorer pane. The
Intelligent Capture Database (default name: IADB) should appear in the list of databases.
9. Create a new user account for SQL Server and set permissions for this user account to run the
Intelligent Capture Database. Creating a SQL Server User Account with Minimum Permissions to
Access the Intelligent Capture Database, page 47 provides the appropriate settings.
46
Installing Intelligent Capture
Note: You may need to change SQL Server credentials after installing the Intelligent Capture
Database. If credentials change, you must run the Data Access Layer Configuration utility,
DalConfig64.exe (default location: C:\Program Files\InputAccel\Server\Server
\binnt\DalConfig64.exe), to update the database connections on each server machine. Details
of using this utility are in the Administration Guide.
Related Topics —
Database Server Considerations, page 13
Chapter 2, Installation Planning
Intelligent Capture Database Issues, page 153
If the Intelligent Capture Database is created, a SQL Server user account with restricted access
must also be created. This user account must then be specified for the DAL registration during
the Intelligent Capture Server and Client Components installation. At no time should a system
administration account be used in production environments for DAL registration. Using an account
with full permissions is a security risk.
The production SQL Server user account must be configured with the following:
• The Default database must be set to the Intelligent Capture Database.
• The user account must be mapped to the Intelligent Capture Database and the database role
membership must be set to Public.
• Grant the following permissions to the Intelligent Capture Database:
— Connect
— Delete
— Execute
— Insert
— Select
— Update
Related Topics —
Database Server Considerations, page 13
Chapter 2, Installation Planning
Installing the Intelligent Capture Database, page 45
Intelligent Capture Database Issues, page 153
47
Installing Intelligent Capture
Caution:
• The machine name of the Intelligent Capture Server must not be longer than 15 bytes;
otherwise, client machines will be unable to connect.
• It is recommended that you disable antivirus software and Data Execution Prevention (DEP),
and close any open programs before installing the Intelligent Capture Server.
Caution:
• Although supported, specifying a UNC path for the IAS folder is not recommended
because it causes degradation in server performance. If you do install the IAS folder
48
Installing Intelligent Capture
to a UNC path, you may encounter errors. To resolve the error, refer to the UNC path
recommendations in Installation Errors, page 150.
• If the IAS folder is placed on a network shared drive, then the Intelligent Capture Server
must always run under the Local System or an Administrator account.
7. In the Configure Intelligent Capture Service Accounts window, select one of the following
to specify the credentials to run the server:
• Use the built-in Local System account: Uses the credentials of the built-in Local System
account.
• Specify a user account: Uses the credentials entered in the Username, Password, and
Domain fields.
Note: The setup program automatically adds the specified local or domain user to the LUA
group: InputAccel_Server_admin_group, enabling the Intelligent Capture Server to operate
with a least-privileged user account. Details of the LUA configuration can be found in
Running Intelligent Capture with Minimum Windows Permissions, page 25.
Caution: Local user accounts are supported only when all components are installed on
a single machine in a Workgroup instead of a Domain.
Caution: Use of non-code page Unicode characters in the setup program may cause
data corruption and installation failure. Only specify characters from the code page of
the machine running the setup program.
• Select Automatically start the Intelligent Capture Server service when the system starts if
you want the Intelligent Capture Server to be started as a service automatically when the
system starts, and then click Next.
8. (Optional. This window displays only if you specified that you are using an external MSSQL
database.) In the Data Access Layer Registration window, specify the login credentials for
connecting to the SQL Server. The login credentials are one of the following:
• The SQL Server user account created that provides permissions to access the Intelligent
Capture Database.
• Windows Authentication
The Windows user account must be a SQL Server account with the appropriate permissions on
the database. For more information, see Creating a SQL Server User Account with Minimum
Permissions to Access the Intelligent Capture Database, page 47.
Note: If the machine where the Intelligent Capture Server is installed also has SQL Server
installed, then by default Register the Data Access Layer with the Intelligent Capture database
is selected and the local database server, default SQL Server port 1433, and Database name are
specified.
9. In the Configure Intelligent Capture Administrator User window, specify the credentials of a
user you want added to the Intelligent Capture Administrator role. When the Intelligent Capture
Server starts, this user is added to the Intelligent Capture Administrator role and is granted all
the permissions to start and use all features of any Intelligent Capture component, including
Intelligent Capture Administrator and all client modules.
49
Installing Intelligent Capture
If you want to use Intelligent Capture Administrator to access the Intelligent Capture Server from
another domain, then this user account must be a domain user account—not a local Windows
account. In addition, this user account must meet the requirements in Installing Intelligent
Capture across Multiple Domains, page 28.
Note: This user does not have to be a Windows Administrator.
10. By default, Start the Intelligent Capture Server service when setup completes is selected. Clear
the checkbox if you want to start the Intelligent Capture Server service manually when setup
completes. Click Next.
11. Click Finish.
Note: A log file is written when the installer sets the LUA permission and other server
environment configurations. If there are any errors during installation, users must check this log
file, which is written to the Server\binnt\iassetenv<timestamp>.log.
12. To verify that the Intelligent Capture Server has been successfully installed, open the Microsoft
Services window (click Start > Programs > Administrative Tools > Services) and start the
Intelligent Capture Server service.
Caution:
• The Intelligent Capture Server stops unexpectedly if the Intelligent Capture Server is
running with Microsoft Data Execution Prevention (DEP) feature enabled. Make sure
the DEP feature is disabled on the machine where Intelligent Capture Server is running.
50
Installing Intelligent Capture
where:
• servicename is the name of the service that runs the Intelligent Capture Server (default:
InputAccel). This is the true name of the Intelligent Capture Server service and not its display
name.
• timeout is a numeric value, representing the maximum time allowed, in minutes, for the
Intelligent Capture Server service to shutdown.
Example: ias64 -repair -s InputAccel -t 25
5. Start the Intelligent Capture Server service.
Caution:
• It is recommended that you disable antivirus software and Data Execution Prevention (DEP),
and close any open programs before installing the Client Components.
• Make sure that there are no pending Windows updates before you start the Intelligent
Capture client installer. If there are pending Windows updates, please install them first
before starting the Intelligent Capture client installer. Additionally, ensure that the machine
does not require to be restarted before you begin the client installation.
Note:
• The installer requires an account that is a member of the local Administrators group on the
machine from which you are running the setup program.
• Intelligent Capture does not install any versions of Microsoft .NET Framework.
• Because of the limited number of printer ports, do not install Intelligent Capture client modules
and the Module Server on the same machine.
51
Installing Intelligent Capture
b. In the next dialog box, change the preselected features by expanding each available feature
and selecting features and sub-features.
Note: Features that are not selected, are marked with a red X.
Note: If third-party software that is required to run the client modules is not already installed,
then the Required Third-party Software window is displayed. The specified client modules are
installed, but will not run until the required third-party software is installed.
4. To specify a user account to use when logging in to the module, select one of the following:
• Use the built-in Network Service account: Uses the local machine's Network Service account
Note: If you select Use the built-in Network Service account, unless all Intelligent Capture
components are installed on a single system or the Intelligent Capture Server has been
configured to allow anonymous access, you must configure the Intelligent Capture system to
use Kerberos authentication, as explained in Configuring Intelligent Capture to use Kerberos
authentication, page 20
• Specify a user account: Uses the credentials specified to run client modules as services.
Caution: Use of non-code page Unicode characters in the setup program may cause data
corruption and installation failure. Only specify characters from the code page of the
machine running the setup program.
5. If you want the Intelligent Capture client modules to be started as a service automatically when
the system starts, select Automatically start all services when the system starts.
Caution: If all client modules that can run as services are installed on a single machine,
having them all start automatically will significantly impact the startup of that machine.
6. In the Intelligent Capture Server Connection Information window, specify the Server name
and Server port of the Intelligent Capture Server to connect to.
Add a semicolon (;) after the Server name to connect to a ScaleServer group.
To make sure that you have specified the connection correctly, make sure that Try to contact the
server during this installation is selected. This option enables the setup program to attempt
to establish a connection with the Intelligent Capture Server. If the attempt fails, you might
want to verify that the Intelligent Capture Server service is started. However, even if the server
connection does not succeed, you can still proceed with the installation of the client modules.
That is, restarting the server is not mandatory.
Caution: If the Intelligent Capture Server host name contains Unicode characters from a
code page other than the code page of the client machine, do not specify that name in
the Intelligent Capture Server Connection Information window. The non-code page
characters may cause installation errors. Instead, proceed as follows:
• Return to the Intelligent Capture Server Connection Information window and for the
Server Name specify the Intelligent Capture Server machine's IP address.
• Proceed with the client installation. The first time you run each client module, specify
the correct Intelligent Capture Server name when logging in.
• If you want to configure modules to run as services, use the instructions provided in
Manually Registering a Client Module to Run as a Service, page 99.
52
Installing Intelligent Capture
7. (Optional) If you have selected to install the Module Server, see Installing and Configuring
the Module Server, page 91.
8. Verify that the Intelligent Capture Server service is started on the machine where the Intelligent
Capture Server is installed.
9. (Optional) If Internet Explorer Enhanced security is enabled, then you must add 127.0.0.1
to Internet Explorer's Trusted Sites or Intranet Zones for Intelligent Capture Administrator to
work properly.
You could also change 127.0.0.1 to localhost in binnt\CaptivaAdministrator.exe
.config in the following element:
<setting name="Host" serializeAs="String">
<value>127.0.0.1</value>
</setting>
10. Ensure that the default administrator user logs in to Intelligent Capture Administrator, and then
assigns appropriate permissions to users and adds users to Intelligent Capture roles. This is
required before users can run client modules in production mode. Without this step, users will be
unable to log in and process tasks. Refer to the Using Intelligent Capture Administrator section of
the Administration Guide for additional information.
Note: An administrative user account (as specified during server installation) is added to the
Administrator role. This Administrator role is granted all the permissions to start and use all
features of any Intelligent Capture component, including Intelligent Capture Administrator
and all client modules.
11. Verify that the client modules have been installed successfully.
Start a client module by clicking Start > Programs > OpenText Intelligent Capture, selecting the
module type and then the module, and logging in with your Intelligent Capture Server login
credentials.
Related Topics —
Client Machine Considerations, page 17
Client Scalability, page 22
Upgrading Client Modules, page 129
53
Installing Intelligent Capture
To use multiple instances of Image Converter simultaneously, manually install additional instances of
the Image Converter module as a service. Each service instance can be installed with a virtual printer;
for ease of identification, the name of the printer includes the name of the service instance.
Note: When installing Image Converter, you can optionally install the Virtual Printer feature. The
virtual printer is required for the following Image Conversion profile properties:
• HTML Rendering Engine is set to Internet Explorer or Microsoft Word
• Office Documents Rendering Engine is set to Microsoft Office Engine
If any of the aforementioned properties are set to Embedded Image Converter Engine, then the
virtual printer is not required. For more information, see “Image Conversion profiles editor” in
the Intelligent Capture Designer Guide.
By default, virtual printers connect to Line Printer Terminal (LPT) ports. If all available LPT ports are
already used by other devices, then installation of the Image Converter instance is not performed
and an error message is displayed. However, you can use other available non-LPT ports to connect
virtual printers.
When installing Image Converter instance as a service, you can define the required port (for
example, one of COM ports) to connect the corresponding virtual printer using the –printerport
command-line parameter.
For example, the following command-line installs Image Converter as a service and with a virtual
printer:
imgconv_x86.exe -install:ImageConverter -login:DOM\Administrator,PASS
@XX.XX.XX.XXX -printerport:COM1
54
Installing Intelligent Capture
When run as a service, Image Converter requires the system be set up properly to be able to process
non-image files, such as Microsoft Office files, TXT files, and HTML files. If any of the requirements is
not met, the processing of these files cannot be started.
Note: If you are using the Embedded Image Converter Engine for processing Microsoft Office files,
TXT files, and HTML files, then you do not need to perform any setup. For more information about
the Embedded Image Converter Engine, see the Intelligent Capture Designer Guide.
The setup steps depend on the type of user account under which Image Converter is run as a service.
It is recommended that you run the service under an administrative user account for processing
non-image files.
Note: If the client machine has Microsoft Office 2013 installed, using an administrative user account
is a strict requirement.
Note: You must set Local Security Policy > Security Settings > Local Policies > Security Options >
User Account Control: Run all administrators in Admin Approval Mode to Disabled.
55
Installing Intelligent Capture
11. In Internet Explorer, navigate to Tools > Internet Options > Security tab and add the following
trusted sites:
• http://localhost
• https://localhost
Set Security Level to Low for the trusted sites.
Save the changes.
12. Disable Internet Explorer from using group policies.
56
Installing Intelligent Capture
The intermediate files generated while processing non-image files are stored in the temporary folder
on the local machine where Image Converter is installed.
When processing files, the path to the temporary folder is taken from the TemporaryFolder variable
in the IMGCONV.exe.config file. By default, after the Image Converter module installation, the
TemporaryFolder variable is empty and can be changed by customer to any alternate location:<add
key="TemporaryFolder" value="" />
If the TemporaryFolder value is empty, the temporary folder location is taken from the TEMP
environment variable.
Note: The default value for the TEMP environment variable is set to: %USERPROFILE%\AppData
\Local\Temp, and it grants the “full control” permissions to this folder for any user in production
who runs Image Converter on the local machine. When specifying your custom temporary folder
location in the IMGCONV.exe.config file, ensure that all users are granted the required access.
Additional Configuration Steps for Processing Files Using the Image Converter
Module
57
Installing Intelligent Capture
When importing batches containing PDF or Microsoft Office files with some security restrictions
(including password protection) and processing these batches using Image Converter module,
beware of the following:
• When merging PDF files with such restrictions, the following error can be displayed: Exception
"PDF Library Error: This operation is not permitted. Error number:
1073938472", and the task fails. The set of restrictions that can be processed by Image Converter
module depends on the operation with PDF file source (such as split or merge), and the exceptions'
messages can differ.
To resolve the issue, the input source PDF documents must not have restrictions specified in PDF
file properties (for example, not to have password protection).
• For Microsoft Office files with password protection, a pop-up window prompting to type the
password can be displayed. The pop-up window is shown only during the Conversion Timeout
time specified for the Image Conversion profile. If password has not been typed during the
specified timeout, the task fails.
If some other security restrictions apply, the task also fails.
By default, Image Converter does not display or print background colors in output MS Word
documents. Users must manually enable this feature to print backgrounds.
By default, Image Converter disables macros in an Excel file. Users must manually enable this feature
to process macros in an Excel file.
58
Installing Intelligent Capture
Attended client modules, ScanPlus and RescanPlus require scanner drivers. ScanPlus and RescanPlus
operators can download ISIS scanner drivers from each scanner manufacturer's website.
Note: Your scanner device may include many advanced features. Intelligent Capture may not
support every advanced scanner feature that is available with your scanner device.
Note: The ISIS scanner driver standard is supported as well as recommended for seamlessly
interfacing our scanning software with document scanners. Every ISIS driver must pass thousands
of rigorous tests to fully validate its performance, compatibility and reliability in order to achieve
ISIS device certification. This certification process results in fewer hardware support problems and
delivers the most solid document scanning interface available on the market. When you are ready
to purchase, choose ISIS-certified devices for all document scanners or MFPs and easily achieve
plug-n-play deployment capability. For more information on ISIS-certified devices, see ISIS Scanner
Drivers.
The Archive Export client module connects to and populates an SAP ECC or SAP NetWeaver
system with administrative data and content. The SAP System Landscape Directory (SLD) contains
information about installed SAP components. This information facilitates the maintenance of complex
SAP system landscapes. To connect to the SLD and provide details of the SAP system used with
Archive Export, run the SLDRegistration.exe executable from the InputAccel\client\binnt
directory and register information about the Host, Port, and user credentials of the SAP system.
Related Topics —
ScaleServer Licensing, page 33
Licensing for Use in a Microsoft Cluster, page 33
Licensing for Disaster Recovery, page 34
59
Installing Intelligent Capture
Caution: Licenses and field credits contained in them only apply on a per-machine basis.
You cannot share licenses and field credits across multiple machines.
60
Installing Intelligent Capture
The procedure for setting the default UI language differs between client modules that were new prior
to 6.0 and those that were new in versions 6.x or later.
Client modules new in 6.x or later versions (modules listed as “New in 6.x” and “New in 7.0 - 7.7,
16.5, 16.6, 20.2” in Table 19, page 162) use the language of the operating system as the default UI
language. These modules use the locale set on the Regional Options tab (Control Panel > Regional
and Language Options) to control the format of date, number, currency, and so on. The default UI
language settings for the Intelligent Capture Server and client modules can be overridden. Refer to
Summary of Options for Overriding the Default UI Language, page 61 for details.
To specify the default UI language for Intelligent Capture Server and for client
modules available prior to 6.0:
This procedure applies to setting the default UI language on a machine running Windows 7 operating
system.
1. Run the Control Panel on the machine running the Intelligent Capture Server or any client
module available prior to Intelligent Capture 6.0. (Modules listed as “Available Prior to 6.0”
in Table 19, page 162)
2. Double-click Regional and Language Options.
3. On the Regional Options tab, select a locale to set the default UI language and control the format
of date, number, currency, and so on. The Samples area displays the formatting based on the
locale selected. Click Customize to make changes.
4. On the Advanced tab, select a language drop-down list box. Choose from the Appendix D,
Localized Languages in Intelligent Capture. This sets the code page that the Intelligent Capture
Server and client modules will use. It must be an appropriate code page for the locale set in the
Regional Options tab. Typically, the locale specified in the Regional Options tab and language
specified on the Advanced tab must match.
5. On the Advanced tab, select the Default user account settings checkbox. This ensures that the
changed settings apply for all accounts that are used to run the Intelligent Capture Server or
client modules as a service.
The default UI language for the Intelligent Capture Server or client modules can be overridden as
summarized in this section. Steps for each override option is described in Procedures to Override
the UI Language, page 62.
61
Installing Intelligent Capture
• Win.ini file
• Setscan.ini file
Client modules that User's regional settings User's regional settings Specifying the UI
were available prior to language in the:
6.0 ( Modules listed as
“Available Prior to 6.0” • Win.ini file
in Table 19, page 162)
• Setscan.ini file
Client modules that Regional settings of Language of the Specifying the UI
are new in releases 6.x the operating system operating system language through:
or later
Note: For Intelligent • Command line
Capture Administrator argument
users: On a Windows 8
/ Internet Explorer • settings.ini file
10 system, users
must manually set • Setscan.ini file
the language to
• Multilingual User
Simplified Chinese
Interface (MUI)
for the UI to display
Pack
in that language:
Use REGEDIT.EXE,
navigate to
regedit -> HKEY
_CURRENT_USER
-> Internet Explorer
-> International ->
AcceptLanguage ->
and change the value
to zh-cn.
This section details the steps involved in overriding the default UI language of the Intelligent Capture
Server and client modules.
62
Installing Intelligent Capture
63
Installing Intelligent Capture
Examples:
• iLanguage=1033 (to set the UI language to English-United States)
• iLanguage=1046 (to set the UI language to Portuguese-Brazil)
Related Topics —
Appendix D, Localized Languages
Table 19, page 162
64
Installing Intelligent Capture
65
Installing Intelligent Capture
Note: Each instance of the Intelligent Capture Server must have its own principal folder. Each
instance is installed on its own directory. It is recommended that for best performance the
specified directories be on separate physical hard disks and the directories reside on an NTFS
partition.
6. In the TCP/IP Settings window, specify the IPV4 address and IPV6 address and Port for each
server instance. To simplify client module connections, it is recommended that you use the
default port for all server instances.
7. The Configure Intelligent Capture Service Accounts window displays, prompting the user for
the “run-as” credentials to use for new instances being installed. Click Next. Specify whether you
want the Intelligent Capture Server to be started as a service automatically when the system starts.
8. In the Data Access Layer Registration window, specify the login credentials for connecting to
the SQL Server. This is the SQL Server user account created that provides permissions to access
the Intelligent Capture Database. Click Next.
Note: If the machine where the Intelligent Capture Server is installed also has SQL Server
installed, then by default Register the Data Access Layer with the Intelligent Capture database
is selected and the local database server, default SQL Server port 1433, and Database name are
specified.
9. Click Install and then click Finish to complete the installation.
Note:
• If you choose to start the Intelligent Capture Server as a service automatically when the
system starts, the setup program configures only the first Intelligent Capture Server instance
to automatically start. All other instances of the Intelligent Capture Server are configured to
run as services but are not configured to start automatically. Use the Service Control Manager
to configure these additional instances to start automatically.
• Before running the other instances, license the servers for a side-by-side operation. Without
the proper feature code, multiple servers will not startup on the same machine.
• With multiple instances of the Intelligent Capture Server installed in an Active/Active
clustered configuration, you will not be able to run both of them on the same node at the same
time. You must run both the Intelligent Capture Servers on separate nodes until after you
have licensed them. If you attempt to run both servers on the same node at the same time,
one of them will not start (due to a lack of a server license containing feature code S) and
Microsoft Failover Clustering will automatically move the resources for that server to the
other node and start it up there.
10. Activate and license all installed instances of the Intelligent Capture Servers.
11. To verify that multiple instances of the Intelligent Capture Server are installed correctly:
a. Start any module in production mode.
b. When logging on, specify one of the Intelligent Capture Servers and make sure the module
connects.
c. Repeat these steps for each Intelligent Capture Server instance.
Related Topics —
Intelligent Capture Server Considerations, page 15
Intelligent Capture Server Scalability, page 21
66
Installing Intelligent Capture
67
Installing Intelligent Capture
Note: When users running client modules connect to a ScaleServer group, they must specify the
Intelligent Capture Server machine name, not “localhost” or an IP address.
6. To verify that the ScaleServer group is functioning correctly:
a. Start a ScaleServer-compatible module in production mode and connect to the ScaleServer
group. Refer to Table 19, page 162 for a list of modules that are ScaleServer-compatible.
b. Run Intelligent Capture Administrator and verify that the client module is logged into all
servers in the ScaleServer group. Refer to the Using Intelligent Capture Administrator section in
the Administration Guide for details.
Related Topics —
Intelligent Capture Server Considerations, page 15
Intelligent Capture Server Scalability, page 21
High Availability and Failover, page 29
Upgrading the Intelligent Capture Server, page 125
ScaleServer Issues, page 155
68
Installing Intelligent Capture
The Microsoft Failover Clustering and Intelligent Capture Server environments must meet the
requirements in this section.
General requirements
The Microsoft Failover Clustering environment must be configured according to Microsoft best
practices. For more information, see technet.microsoft.com. In particular, make sure that your
Microsoft Failover Clustering environment meets these requirements:
• The clustered servers must have passed–without errors–the Microsoft Cluster Validation Wizard.
• At least two separate and identically configured node servers with the supported Windows
Server version set up in a cluster configuration.
• The Intelligent Capture Database is installed on a server other than the Intelligent Capture Servers.
• The clustered servers include shared storage that is certified as compatible for use in Microsoft
Failover Clustering.
• All machines are members of the same domain.
• On Windows Server 2012 and Windows Server 2012 R2, in addition to the Microsoft Failover
Clustering feature, the following features in Remote server Administration Tools > Feature
Administration Tools > Failover Clustering Tools are required in order to register the Intelligent
Capture Server cluster resource DLLs with the cluster:
— Failover Cluster Automation Server
— Failover Cluster Command Interface
Intelligent Capture Server requirements
Before configuring Intelligent Capture Server in Microsoft Failover Clustering, you must make sure
that each Intelligent Capture Server in the cluster meets the following requirements:
• Cluster disk for the \IAS data directory.
• Static IP address that clients use to access the Intelligent Capture Server as a clustered application.
— Windows Server 2012, Windows Server 2012 R2: When both IPv4 and IPv6 protocols are
enabled, only a single static IPv4 address is required, and the cluster can automatically create
a corresponding IPv6 address if necessary.
• Intelligent Capture Server running under either the Local System account or a domain user
account that is a member of the local Administrators group on both cluster nodes. Use of a LUA
account for running the Intelligent Capture Server is not supported in the Microsoft Failover
Clustering environment.
• A cluster CAF file for each Intelligent Capture Server to be installed into the cluster; for example,
for two servers in an Active/Active installation, you must have two CAF files.
69
Installing Intelligent Capture
Although these instructions apply to the installation of two Intelligent Capture Servers into an
Active/Active cluster, you can still use them for the installation of a single Intelligent Capture
Server into an Active/Passive cluster. To use these instructions for installing a single Intelligent
Capture Server into an Active/Passive cluster, ignore references to the second server instance,
second application group, or second cluster disk. Furthermore, any significant differences between
Active/Active cluster and Active/Passive cluster installation steps are specifically mentioned.
Note: The installer requires an account that is a member of the local Administrators group on the
machine from which you are running the setup program.
70
Installing Intelligent Capture
7. Repeat Step 5 and Step 6 steps of the current procedure to create a second application (for
Active/Active cluster) and rename it to indicate it is the second Intelligent Capture Server.
8. Edit the Properties of these new applications/roles to define the preferred owners on each
application/role. Typically, the first Intelligent Capture Server should have a preferred owner of
node 1, and the second Intelligent Capture Server a preferred owner of node 2.
9. Add storage to each of these applications by adding the appropriate cluster disk resource to each
application/role. Under Roles (on Windows Server 2012 and 2012 R2), select the application/role,
right-click and select Add Storage, and select the checkbox for the first Intelligent Capture Server
cluster disk (for example, drive R). Repeat the process for the second Intelligent Capture Server
application/role if creating an Active/Active cluster (for example, add drive S as the storage on
the second Intelligent Capture Server application/role).
10. Move both applications/roles to the first node so they are owned by the first node.
Note: In Active/Passive cluster, there is only one application/role and it should be owned by
first node.
To verify that both Intelligent Capture Server cluster disks are accessible from the
first cluster node:
1. Start Windows Explorer.
2. Verify that both Intelligent Capture Server cluster disks are accessible from the first node. In the
case of Active/Passive cluster, there is only one Intelligent Capture Server cluster disk.
Option Action
Database and Failover Options Select the following options:Use an external
MSSQL DatabaseUse Microsoft Failover
Cluster Environment
Setup Type Select Custom.
Number of Intelligent Capture Server • For an Active/Active cluster: 2
instances
• For an Active/Passive cluster: 1
Choose Install Folder Select a local drive; that is, do not install
Intelligent Capture Server application files
onto the cluster disk.
Choose Data Files Install Folder For each Intelligent Capture Server's \IAS
data directories, select its associated cluster
disk ( do not select a local drive).
71
Installing Intelligent Capture
Option Action
Configure Cluster Settings • For an Active/Active configuration, enter
the following:
— Two IPv4 addresses and port numbers.
For the port numbers, use the same
value for both of your Intelligent
Capture Servers.
72
Installing Intelligent Capture
To register the Intelligent Capture Server cluster resource DLLs with the cluster:
1. On one node, in a command prompt (running as Administrator), execute the following file
for each Intelligent Capture Server:
C:\Program Files\InputAccel\Server\<Server#>\binnt\CreateIAResType.bat
where <Server#> is the directory for each Intelligent Capture Server.
InputAccel resource type is created for the first Intelligent Capture Server and InputAccel2
resource type is created for the second one.
Note: For more information about running CreateIAResType.bat, simply execute it.
2. To ensure that the Intelligent Capture Servers have enough time to shut down, set the
ShutdownTimeoutInMinutes cluster property.
If the ShutdownTimeoutInMinutes cluster property was set to less than 20 minutes, then
CreateIAResType.bat sets this property to 20 minutes. Typically, Intelligent Capture Server
shuts down within 30 seconds; however, depending on the server load, the shutdown process
could take 20 minutes or more. In this case, unsynchronized batches could lose data because
Microsoft Failover Clustering terminates services that take longer to shut down than the time
specified in ShutdownTimeoutInMinutes.
To verify the value of the ShutdownTimeoutInMinutes cluster property, execute the following
command:
cluster /properties
To set the value of ShutdownTimeoutInMinutes, execute the following command:
cluster /properties ShutdownTimeoutInMinutes=N
where:
• N is the maximum number of minutes required by the slowest service running in the cluster
to gracefully shutdown.
To move both cluster disks to and install the Intelligent Capture Server on the second
cluster node:
1. In Failover Cluster Manager, under Roles (on Windows Server 2012 and 2012 R2), move the
Intelligent Capture Server applications to the second node.
All Intelligent Capture Server applications in the cluster must be owned by the second node.
Note: There is only one application/resource group for Active/Passive cluster.
2. On the first node, stop the Failover Cluster Manager application.
3. To install Intelligent Capture Server on the second node, repeat the To install Intelligent Capture
Server on the first cluster node:, page 71 procedure.
73
Installing Intelligent Capture
This resource specifies the Intelligent Capture Server's IP address and Network Name.
• For Windows Server 2012 and 2012 R2, under the console tree in the left pane, select Roles,
and then right-click each Intelligent Capture Server role and select Add a resource > Client
Access Point.
Enter the following information:
• Name: The Network Name (hostname) by which this Intelligent Capture Server is accessed
over the network by client modules and Intelligent Capture Administrator.
• Address: Enter the static IPv4 address that is used to access this Intelligent Capture Server.
This is the same address which you entered during Intelligent Capture Server installation, and
will be registered with the DNS with the network name you just entered.
• Once Client Access Point resource is configured, right-click on the Name resource and select
Properties.
• Under the Dependencies tab, if there are 2 IP address resources listed (IPv4 and IPv6 address)
with an OR operator, change the operator to AND. This will ensure that the network name
resource is registered with the DNS using both IP addresses.
• Verify that the Network Name resource can be brought online.
• If IPv6 protocol was enabled, a corresponding IPv6 address was automatically generated by
the cluster. Once resources are online, you can view the value of the IPv6 address resource
that was just created. If you wish to use IPv6 protocol for the Intelligent Capture Server, write
down the address. It can be manually entered through the Intelligent Capture Administrator
module at a later time.
• Repeat these steps for the second Intelligent Capture Server if installing Active/Active.
3. Right-click on the Intelligent Capture Server application/role and select Add a resource > More
resources… > Add InputAccel, but do not make this resource online. This step adds the
Intelligent Capture Server to the clustered application/role.
To add a second Intelligent Capture Server, right-click on the second Intelligent Capture Server
application/role and select Add a resource > More resources… > Add InputAccel2.
Tab Action
General Change the name of the first and second
servers to InputAccel and InputAccel2,
respectively.
Dependencies Insert the following dependent resources for
this Intelligent Capture Server:
• Cluster disk
• Name
74
Installing Intelligent Capture
Tab Action
Policies Until the Intelligent Capture Server is fully
licensed and operational, it is recommended
that you change the setting of Response to
resource failure to If resource fails, do not
restart.
Note: This setting can be reconfigured later as
required.
75
Installing Intelligent Capture
To activate and license the Intelligent Capture Servers on both cluster nodes:
To activate and license the Intelligent Capture Server in a cluster, you must activate each Intelligent
Capture Server twice, once for each node in the cluster using Activation IDs.
Note: For an Active/Passive cluster environment, you require a single activation (CAF) file for
the single Intelligent Capture Server. For an Active/Active cluster environment, you require two
activation files for the two Intelligent Capture Servers.
1. Run Intelligent Capture Administrator and log in as the administrative user (member of
Administrators role).
2. From the navigation panel, select Licensing / Security, and then select View Server Activations.
The Server Activations pane displays all Intelligent Capture Servers listed with their network
names followed by their service names, for instance IASERVER1 (InputAccel) and IASERVER2
(InputAccel2). The Server ID is displayed as 0 and the state is set to Not Activated.
3. On the Server Activations pane, select the first server (IASERVER1 for example) and Browse to
the location of the cluster CAF file intended for the first server, and select the CAF file.
Note: A CAF file that is not intended for a cluster cannot be installed in a cluster environment.
4. Repeat the previous step for the second server (for an Active/Active cluster). The Intelligent
Capture Servers display an activation state of Initial Grace Period.
Note:
• You cannot use the same CAF file for both servers in an Active/Active cluster environment.
• To activate the Intelligent Capture Server in an Active/Passive cluster environment, you
require a single activation (CAF) file that provides the Server ID for the single Intelligent
Capture Server. You also require two Profile IDs. To activate the Intelligent Capture Servers
in an Active/Active cluster environment, you require two activation (CAF) files that provide
two Server IDs for the two Intelligent Capture Servers. You also require four Profile IDs. To
obtain these Profile IDs, each Intelligent Capture Server must be run on each clustered node,
as the Profile ID is different on each node.
5. Import license codes for both servers. Do this before continuing with activation and moving
servers between nodes.
6. From the Failover Cluster Manager, start IASERVER1 on Node 1 and IASERVER2 on Node 2.
7. From Intelligent Capture Administrator navigate to the Server Activations page.
76
Installing Intelligent Capture
8. Select IASERVER1, and then click Activate Server. Note the Server Serial Number and Profile
ID. Repeat for IASERVER2 (for an Active/Active cluster).
9. Use Failover Cluster Manager to move each Intelligent Capture Server to the other node. Now
repeat steps 6–7 and obtain the second set of Serial Numbers and Profile IDs.
10. From the Server Activations page, click the link to open OpenText My Support and request
activation keys for the four Profile IDs. For each profile ID, provide the Server Serial Number.
11. When you receive the activation keys, you can activate the Intelligent Capture Server for each
node. Run Intelligent Capture Administrator and navigate to the Server Activations page.
12. Select the Server name, and click Activate Server. The Activate Server window displays.
13. Type the activation key for the first Intelligent Capture Server Profile ID, and then click OK. The
State column for the server displays “Activated”.
14. Repeat steps 12–13 for the second Intelligent Capture Server.
15. Run Failover Cluster Manager to move each Intelligent Capture Server to the other node.
16. Repeat steps 10–14 to activate the Intelligent Capture Servers on the other node.
17. Use the Failover Cluster Manager to move the Intelligent Capture Server applications to the
other node again and verify that they remain activated in Intelligent Capture Administrator. In
Active/Active cluster, move the Intelligent Capture Server applications so that both servers
are running on Node 1, verify they are activated, then move both applications to Node 2, and
verify again they are activated.
Prerequisites —
• See IIS Roles Enabled with Intelligent Capture Web Components, page 159.
• Because WebDAV blocks the DELETE HTTP verb that Intelligent Capture Web Client uses, either
do not install the WebDAV IIS feature or remove the WebDAV module from the Intelligent
Capture Web Client web site. Otherwise, if the DELETE HTTP verb is blocked by WebDAV,
then user logout does not occur and resources, such as a license consumed by the user, are not
freed until the session expires.
77
Installing Intelligent Capture
• Intelligent Capture client applications, such as Intelligent Capture Web Client and custom
applications, require the Intelligent Capture REST Service.
• Intelligent Capture Web Client requires the following additional Intelligent Capture components:
— Intelligent Capture Server
— Module Server
See Installing and Configuring the Module Server, page 91.
Note: No load-balancing is inherently performed among multiple instances of Intelligent Capture
REST Service in a Web farm.
Procedure
If you want to configure Windows single sign-on (SSO) authentication in Intelligent Capture Web
Client, see Configuring Windows Single Sign-on (SSO) Authentication in Intelligent Capture Web
Client, page 89 before starting this procedure.
1. On the first IIS machine in the Web farm, perform the following tasks:
a. Install Intelligent Capture Web Client and Intelligent Capture REST Service by running
the Intelligent Capture setup program and, on the Installation Choices list, selecting Step
2 - Install Web Components > Intelligent Capture CWC and REST and following the
instructions.
The following are guidelines for the Configure the Intelligent Capture Web Client dialog
box.
Web site name The name of the web site used in the IIS
Server.
IP Address to use for this web site This value sets Intelligent Capture and REST
Service's Site Bindings> IP Address. See the
Microsoft IIS documentation for guidelines
on selecting an IP address.
78
Installing Intelligent Capture
Make Intelligent Capture Web Client web If you are installing Intelligent Capture
site online after installation Web Client and Intelligent Capture REST
Service in a production environment,
do not start Intelligent Capture Web
Client and the Intelligent Capture REST
Service immediately; otherwise, users
might inadvertently access an incomplete
configuration.
Public URL in absolute format The URL that users are to use to call
<http|https>://<hostname>/<path> CWC. It sets IIS Management Console
> Intelligent Capture CWC and REST
Services > Application Settings >
SaaSPublicBaseURL. The format is as
follows:
[http|https]://servername:port
79
Installing Intelligent Capture
where:
• MaxConcurrentUsers – the maximum
number of users that are logged in at any
one time. The maximum number of users
includes ones who have not logged off
even though they may not be currently
uploading image files.
Note: User sessions are cleaned up after
the user is logged off or after the session
timeout value specified for Intelligent
Capture REST Service.
b. Configure settings that apply to all Intelligent Capture REST Service Web sites in the entire
Web farm by selecting Start > OpenText Intelligent Capture> REST Service Config and
following the instructions.
Note:
• You can also run REST Service Config from the command-line. For more information, see
Running CaptivaRestServerConfig.exe From the Command-line, page 86.
• To change the current configuration settings, select the shared data folder. The current
configuration settings are loaded from the shared configuration file.
80
Installing Intelligent Capture
Intelligent Capture Server Message Valid values are between 20 – 300 seconds,
Timeout (Seconds) inclusive.
Authentication Mode Select the user authentication method as
follows:
• Windows: Use Windows authentication
on the Web server machine. For each
Intelligent Capture REST Service user
(which includes both Intelligent Capture
Web Client and custom application users)
perform the following:
— Assign a Windows user account on
Intelligent Capture REST Service's
Web server so that their Windows
access token can be used to validate
their permissions on the Intelligent
Capture Server.
81
Installing Intelligent Capture
c. At this time, you could configure this IIS instance as instructed in Step 2 before installing
and configuring Intelligent Capture Web Client and Intelligent Capture REST Service on
other IIS instances in the Web farm.
2. To configure every IIS machine–including the first one–in the Web farm, perform the following:
82
Installing Intelligent Capture
a. In the IIS Management Console, for Application Settings for the Intelligent Capture
CWC and REST Services site (default name), change CaptivaSharedDataDirectory to the
shared data folder.
Note: (Optional) You can also change the following entries:
• CaptivaRestServerName: A string that is displayed in diagnostic tracing information on
the server. It should be a unique name across all Intelligent Capture REST Service Web
sites associated with the same shared data storage. By default, Intelligent Capture REST
Service constructs a unique name for the service as a combination of the machine name
plus the Web site name.
• CaptivaAuthPlugin : The full path to your custom Intelligent Capture REST Service
authentication plugin.
• SaaSPublicBaseURL: You should specify the URL that users are to use to call CWC
in the following format:
[http|https]://servername:port
83
Installing Intelligent Capture
the Intelligent Capture setup program and on the Installation Choices list and selecting Step 2 -
Install Web Components > Intelligent Capture CWC and REST and following the instructions.
For details, see Step 1.a.
4. License Intelligent Capture Web Client and Intelligent Capture REST Service.
Intelligent Capture REST Service client (including Intelligent Capture Web Client) and Module
Server licensing is managed through the Intelligent Capture Web Client Licensing page.
For more information about the Intelligent Capture Web Client Licensing tool, see the
Administration Guide.
5. (Optional) Localize and rebrand the Intelligent Capture Web Client user interface with your own
application and company names.
For more information, see Localizing and Rebranding the Intelligent Capture Web Client User
Interface, page 87.
84
Installing Intelligent Capture
Table 7. Required Intelligent Capture Permissions for Intelligent Capture Web Client and REST Application
85
Installing Intelligent Capture
If you want to deploy the same settings to a different Web farm or environment (such as production
or testing), you can use the command line and a text file. For help on the syntax, execute the
following command:
C:\Program Files (x86)\InputAccel\WebComponents\binnt\CaptivaRestServerConfig.exe -h
(The default path is shown. You must run the command as administrator.)
In the text file, you specify the following options, which map to the corresponding REST Service
Config fields:
Option Field
IAUser Intelligent Capture Server > User
Password Intelligent Capture Server > Password
Url Intelligent Capture Server > Server
IAScaleServer Intelligent Capture Server > Connect to server
group
UserSessionTimeoutSec Web Server > Session Timeout
IAConnectionPoolSize Web Server > Maximum Intelligent Capture
Server Connections
IARequestTimeoutSec Web Server > Intelligent Capture Server
Message Timeout
AuthMode Web Server > Authentication Mode
ModuleAllocationWaitSec Web Server > Module Allocation Timeout
MinimumUserExperience Web Server > Minimize User Interaction
TaskWaitingTimeoutSec Web Server > Task Waiting Timeout
WebserverDebugTrace Web Server > Debug Tracing
FPOCR_Instance_Count Service Modules > Full Page OCR > Instance
Count
FPOCR_Recycle_In_Hours Service Modules > Full Page OCR > Recycle
in Hours
FPOCR_Debug_Tracing Service Modules > Full Page OCR > Debug
Tracing
IMGCONV_Instance_Count Service Modules > Image Converter > Instance
Count
IMGCONV_Recycle_In_Hours Service Modules > Image Converter > Recycle
in Hours
IMGCONV_Debug_Tracing Service Modules > Image Converter > Debug
Tracing
CPIMGPRO_Instance_Count Service Modules > Image Processor > Instance
Count
86
Installing Intelligent Capture
Option Field
CPIMGPRO_Recycle_In_Hours Service Modules > Image Processor > Recycle
in Hours
CPIMGPRO_Debug_Tracing Service Modules > Image Processor > Debug
Tracing
CPEXTRAC_Instance_Count Service Modules > Extraction > Instance Count
CPEXTRAC_Recycle_In_Hours Service Modules > Extraction > Recycle in
Hours
CPEXTRAC_Debug_Tracing Service Modules > Extraction > Debug Tracing
ClientNoop_Instance_Count Service Modules > Scripting > Instance Count
ClientNoop_Recycle_In_Hours Service Modules > Scripting > Recycle in Hours
ClientNoop_Debug_Tracing Service Modules > Scripting > Debug Tracing
You can localize Intelligent Capture Web Client user interface elements such as page and section titles,
menu items, button names, and tool tips as well as informational, warning, and error messages.
You can rebrand the Intelligent Capture Web Client user interface with your own application and
company names, which are displayed on the login page and at the top of every Intelligent Capture
Web Client page.
Localized and branding strings are contained in locale-specific resource files. When Intelligent
Capture Web Client is started, all resource files corresponding to the locale setting in the browser are
loaded. Third-party applications could specify the corresponding locale code in the URL's culture
query string. The default and fallback locale code is en-US.
Note: The following kinds of strings cannot be localized using the Intelligent Capture Web Client
localization mechanism:
• Messages that originate from the Cloud Capture Toolkit.
• The values displayed within fields are dependent on the language of the value.
• Form pane field names are controlled by the Document Type.
Locale-specific resource files (including US English) are packaged in Intelligent Capture Web Client
as follows:
87
Installing Intelligent Capture
Related Topics —
• Creating Resource Files, page 88
For each applicable locale, you create a locale resource file and, optionally, a branding string override
resource file, which overrides branding strings in the locale resource file. You can create a branding
string override resource file for any locale that is packaged with Intelligent Capture Web Client
or for new locale resource files that you create.
• A locale resource file
Description — This resource file contains both localized and branding key-value pairs.
Syntax — Strings that are displayed in the user interface are specified as key-value pairs. See the
default file, en-US.js, for examples of valid syntax.
Note:
— Only the key-value pairs specified in the default locale resource file, en-US.js, can be
localized using the Intelligent Capture Web Client localization mechanism.
— The fallback locale file is C:\inetpub\captiva\cp-swc\strings\en-US.js; that is, if
a key is not found in a locale file, then the key's value in the en-US.js file is displayed.
However, if the key is missing from en-US.js or the JavaScript in this file is invalid, then
[<key>=NA] (where <key> is the name of the key) is displayed instead of the key's value.
• A branding string override resource file
88
Installing Intelligent Capture
Description — This resource file contains branding key-value pairs that override
the same branding key-value pairs specified in the identically named file in
C:\inetpub\captiva\cp-swc\strings (default path).
Note: This file must have the same name as the corresponding file in C:\inetpub\captiva
\cp-swc\strings (default path).
Syntax — Strings that are displayed in the user interface are specified as key-value pairs. See the
default file, en-US.js, for examples of valid syntax.
Note: The only branding key-value pairs that can be overridden are specified in
C:\inetpub\captiva\cp-swc\branding\strings\en-US.js (default path).
You can configure Windows single sign-on (SSO) authentication (also known as “pass-through
login”) in Intelligent Capture Web Client for Windows domain users.
The following restrictions apply:
• Only Internet Explorer 11 or greater is supported.
• Only an intranet is supported.
• Proxy servers are not supported.
• All client browser machines, the IIS Web server, and Intelligent Capture Server must all be on the
same Windows domain and have full access on it.
• The hostname in the URL provided to the client browser must be the same as the one in the
Intelligent Capture REST Service's web.config file's RestServiceURL property.
Note: If you use an IP address, then the IP address must be specified in Internet Explorer's Local
intranet > site property.
• In order to provide the same security context in a Web farm with a load balancer, the load balancer
must maintain affinity with the appropriate Web server.
• The browser would not usually run in Administrator mode because of UAC. Therefore, use an
account that is different from the Windows Administrators group to grant Intelligent Capture
permissions for the Intelligent Capture Web Client browser users.
89
Installing Intelligent Capture
You can set options in the Intelligent Capture Web Client URL by using the following query string
parameters.
Note: Unless otherwise noted, these parameters can only be set for Home.aspx.
Parameter Description
appvalues Root level values (level 7) to use in the batch. The
format is a comma-delimited list of name-value
pairs (in which a colon separates the name and
value). The syntax is as follows:
appvalues
=<name1>:<value2>,<name2>:<value2>
autologout Set to true to automatically log the user
out after submitting the current batch and
immediately prior to displaying the batch
name in the batch submission status panel. By
default, the user is returned to the login page
(login.aspx). To redirect the user to a specific
URL, specify logoutret.
Note: Line-of-business applications can take
advantage of this parameter.
cptvticket A valid CPTV ticket to be used when retrieving
protected pages. If the CPTV ticket is invalid,
then the user is redirected to the login page
(login.aspx).
culture A culture code used to override the culture (for
any page, not only Capture.aspx) specified in
the Accept-Languages header.
eai The extraAuthInfo parameter (for the custom
server-side authentication plugin) in the login
call to the REST service.
logoutret The URL to which to redirect the user when
the user logs out manually or is automatically
logged out of Intelligent Capture Web Client;
however, the user is not logged out from the
REST service.
Note: Line-of-business applications can take
advantage of this parameter.
90
Installing Intelligent Capture
Parameter Description
profile Name of a capture profile.
scannerlock Set to true to lock the scanner settings so that
users cannot change them in Intelligent Capture
Web Client. For example, if you do not want
users to change the scanner settings that were
set by a capture profile, then you would use this
parameter.
Note: Setting scannerlock to true does not
reset existing scanner settings. Therefore, if a
user has already changed scanner settings, then
you might want the user to delete the entire
browser cache to remove those settings.
1. For each instance, run the Intelligent Capture setup program and on the Installation Choices list,
select Step 4 - Client Components and follow the instructions. Optionally, you could install a
virtual printer.
For Data Folder, specify the shared data folder. All instances of the Module Server and Intelligent
Capture REST Service must specify the same shared data folder. For more information, see
CWC shared data folder.
• After installation, you can change the Module Server shared data folder as follows:
— Specify the shared data folder in the dataDirectory parameter in the Module Server's
Windows Service Properties > Start parameters and restart the Module Server Windows
service. The syntax for the dataDirectory parameter is as follows:
-DataDirectory:<sharedDataDirPath>
91
Installing Intelligent Capture
C:\ProgramData\EMC\InputAccel\CPMODSRV\Config\CPMODSRV.config
(default) is created and the new path is saved in CPMODSRV.config.
Note: CPMODSRV.config is not created when the Module Server is first installed.
— After CPMODSRV.config has been created, you can change the value of the
dataDirectory parameter directly in CPMODSRV.config and restart the Module Server
Windows service.
2. (Optional) To change the defaults of the Module Server service modules, select Start > OpenText
Intelligent Capture> REST Service Config and make changes on the Service Modules tab:
• Instance Count: Maximum number of instances to run on a single machine.
Note: If you have installed virtual printers, then the maximum number of Image Converter
service instances specified in this property is overridden by the number of installed virtual
printers.
• Recycle in Hours: Number of hours after which an instance is restarted.
• Debug Trace: Whether to enable debug tracing.
For more information, see Configuring Service Modules, page 92.
3. (Optional) Virtual printers can be installed and uninstalled for the Image Converter service.
To run VirtualPrinterInstaller.exe, the Image Converter module’s Virtual Printer
feature is required.
To install or uninstall virtual printers, execute \Client\binnt\VirtualPrinterInstaller
.exe as follows:
VirtualPrinterInstaller.exe [-printerPort:<Printerport> | -uninstall]
where:
You can configure the set of service modules running under a machine’s Module Server by creating a
configuration for them. Each configuration specifies the instance count, recycle period, and debug
tracing mode of the Module Server’s service modules. If you want multiple Module Servers to all
have the same configuration settings, then you can put them into the same group.
92
Installing Intelligent Capture
1. Select Start > OpenText Intelligent Capture> REST Service Config and, on the Service Modules
tab, create configurations in the following ways:
• Add a single configuration by clicking Add > Configuration.
• Add configurations to a group by first clicking Add > Group to create a group or selecting
an existing group and then clicking Add > Configuration.
Note: You can also delete configurations.
2. To specify the machine for each configuration, in the Type field, select Name (the NetBIOS
name), IP Address, or IP Range and then specify its corresponding value in the Server Name,
Server IP Address, or IP Address Range fields.
Wildcards can be used in the Server Name and Server IP Address fields only:
Note: If a matching configuration (by name or IP address) is not found for a Module Server, then
the Default configuration is used.
3. For each configuration or group, specify values for the following.
Note: Because all configurations in a group share the same values, you can only change these
values at the group level.
• Instance Count: Maximum number of instances to run on a single machine.
Note: If you have installed virtual printers, then the maximum number of Image Converter
service instances specified in this property is overridden by the number of installed virtual
printers.
• Recycle in Hours: Number of hours after which an instance is restarted.
• Debug Trace: Whether to enable debug tracing.
93
Installing Intelligent Capture
• Korean
• Thai
Furthermore, because the following modules use the Advanced OCR/ICR engine, they can also
use the aforementioned languages:
• Completion
• Identification
• Extraction
• Classification
• Standard OCR
A compatible version of Intelligent Capture is required. For more information, see the Intelligent
Capture Release Notes.
Unattended Installations
The Intelligent Capture installers enable unattended and silent installations and upgrade of
components. Unattended installations and upgrade are performed without user interaction during
its progress. It also enables users to perform remote installations of Intelligent Capture. A silent
installation does not display messages or windows during its progress. A command line is used to
specify the features to install and the configuration settings. The command line consists of variables
known as “installer properties” which define the features to install and the configuration of the
installation. The installer properties are simple key/value pairs specified with PROPERTY=VALUE
syntax.
Install Intelligent Capture components in the following order when performing a silent installation
or upgrade:
1. (Optional) Intelligent Capture Database
2. Intelligent Capture Server
3. (Optional) Intelligent Capture Web components
4. (Optional) Module Server
5. (Optional) Intelligent Capture Web Client and Intelligent Capture REST Service
6. Intelligent Capture client components
Refer to the Command line instructions section for examples of command lines that silently install or
upgrade Intelligent Capture.
94
Installing Intelligent Capture
The following command line arguments are available when installing Intelligent Capture features in
unattended or silent mode:
Argument Description
Setup.exe Use the Setup.exe installation executable located on the
installation media. Access these directories where the Intelligent
Capture Microsoft Installer (MSI) files reside:
• Databases\setup.exe: Installs the SQL database.
95
Installing Intelligent Capture
Argument Description
Msiexec.exe arguments Specifies an installer action: For example:
• /i: Install.
• /f: Repair.
• /x: Remove.
Note: The /i argument is the default and does not need to be
specified.
Windows Installer properties Specifies an installer action.
Features to install Installs the specified Intelligent Capture features. For example, the
following command line installs an Intelligent Capture Server:
Related Topics —
Supported InstallShield Switches, page 177
Supported MSI Switches, page 178
Supported Windows Installer Properties, page 178
There are some important issues to consider when installing Intelligent Capture from a command line.
Escape Characters
When creating the installation command line, some installer properties and characters must be
escaped (by adding a “\” before the character) for the installation to succeed.
Any property containing a space must have escaped double-quotes. For example:
INSTALLDIR=\"c:\Program Files\InputAccel\Client\"
or
IA_SERVICES_RUNAS_USER_ACCT=\" CORP\My Login\"
Another issue to consider are characters that require escaping by the Windows command prompt.
The ampersand (&) symbol must be escaped using a caret (^) character.
Maximum Length
The maximum number of characters that can be entered on the command line is 1066. If more
characters are entered, setup.exe launches and then quits.
Related Topics —
Intelligent Capture Installer Properties and Feature Names, page 178
Command Line Installation Failures, page 151
96
Installing Intelligent Capture
Use the InstallShield and Windows Installer command line arguments to create instructions to install
Intelligent Capture software:
Caution: Use of non-code page Unicode characters in the setup program may cause data
corruption and installation failure. Only specify characters from the code page of the
machine running the setup program.
Note: You can automatically install Intelligent Capture features using a batch file that contains
silent installation command line instructions.
Related Topics —
Command Line Installation Failures, page 151
Supported InstallShield Switches, page 177
Supported MSI Switches, page 178
Supported Windows Installer Properties, page 178
Intelligent Capture Installer Properties and Feature Names, page 178
You can specify multiple installation command lines in a batch file to automate an unattended
installation. The following example shows three commands contained within one batch file that
generate a log file:
//Begin contents of irr_sp1.bat batch file
//Install Service Pack 1 and write log file
setup.exe /s /v"/qn ADDLOCAL="ALL" IA_SERVICES_RUNAS_LOCAL_SYSTEM="1" /l*v
"C:\logs\sp1_install.log""
97
Installing Intelligent Capture
Related Topics —
Command Line Installation Failures, page 151
Supported Windows Installer Properties, page 178
Intelligent Capture Installer Properties and Feature Names, page 178
From the directory location of the base Intelligent Capture MSI files, you can modify unattended
installations by:
• Adding features and modules: To add a feature or a list of features, use the ADDLOCAL property.
Refer to the examples detailed in the Supported Intelligent Capture feature properties and
names section.
• Removing features and modules: Use the REMOVE property to remove a feature or a list of
features. After removing features, repair the installation. The following example removes the
COPY module and creates a log file of the procedure:
setup.exe /v"/qn REMOVE="COPY" /l*v "C:\logs\remove.log""
Use the /x Install Shield switch to remove the Clients, Databases, Server, or WebComponents
directories. For example, from a Command Prompt window, navigate to the Clients directory
on the Intelligent Capture installation media. At the command prompt, type the following
command line to remove the Clients directory and write a log to the specified directory:
setup.exe /v" REMOVE="ALL" /qn /l*v "C:\delete.log""
Note: Use the Intelligent Capture Administrator module to delete an Intelligent Capture Server or
remove an Intelligent Capture Server from a ScaleServer group before removing the server. Refer
to the Using Intelligent Capture Administrator section in the Administration Guide for additional
information.
• Repairing an Intelligent Capture installation: Use the /f MSI switch to repair an installation. The
following command line example repairs the removed features:
setup.exe /v"/qn /fvomus /l*v "C:\logs\sp1_repair.log""
Related Topics —
Supported InstallShield Switches, page 177
Supported MSI Switches, page 178
Supported Windows Installer Properties, page 178
Intelligent Capture Installer Properties and Feature Names, page 178
Command Line Installation Failures, page 151
98
Installing Intelligent Capture
99
Installing Intelligent Capture
modules, moduleexecutable is the executable name of the module; for example, iatimer for
the Timer module.
• -login:username,password@servername are the credentials to log into the Intelligent
Capture Server. For security reasons, we recommend not specifying an actual user name and
password in the command line because doing so also stores these items as unencrypted
text in the registry. Instead, use the “run-as” account specified in the Log On tab of the
Windows Service Control Manager window. To do this, specify * for the username,password
argument; for example ...-login:*@servername... servername is the name of machine hosting
the Intelligent Capture Server to which the module should connect when running as a service.
The topic Running Modules as Services, page 18 provides more information on how to
configure modules to run as services.
• account specifies the account that the service will run as. If the account is not specified, then
the service is registered as LocalSystem. Allowed values are: LocalSystem, LocalService,
NetworkService, and domain\username.
• -servicePassword:password where password specifies the password for the
serviceAccount. The default value is None which is applicable only if the service account
is a named user.
• serviceName is the name by which the service is registered and listed in the Service
Control Manager. Omit this argument to register the service using its default module name.
Specifying this parameter enables running multiple instances of the same module, each as a
separate service. This is not supported for modules that are listed as “Available Prior to
6.0” in Table 19, page 162.
• -loginex:username,password@repository are the credentials used by a custom export
module to log into a third-party repository.
Note:
• Registering a module as a service from the command line configures the module to run as a
service; it does not install or run the module.
• Registering a module as a service when it is already registered overwrites its
previously-registered properties with the new properties.
• Only modules listed as “New in 6.x” in Table 19, page 162 support the serviceName
attribute. When specified, this argument enables configuration of multiple instances of a
single module to run as a service, each with a unique service name. When a module is
registered as a service, parameters such as a user name or account name can be specified. If
the service is reregistered, the newly specified parameters, or default parameters if none are
specified, overwrite the existing ones. To register another instance of a client module as
a service on the same machine, run the command with a unique serviceName to avoid
overwriting the previously installed service.
• To configure a module registered as a service for high availability, configure the Recovery tab
in the Windows Service Control Manager. The Intelligent Capture Client setup program does
this automatically when it registers a module as a service; however, you must configure this
option when manually registering a module as a service. To match the configuration used by
the Intelligent Capture Client setup program configure the following settings:
— First failure list: select Restart the Service
— Second failure list: select Restart the Service
100
Installing Intelligent Capture
Caution: When configuring a module to run as a service, do not enable Allow service to
interact with desktop. When a module runs as a service, it suppresses its user interface and
does not run properly when configured to interact with the desktop.
Related Topics —
Chapter 2, Installation Planning
Client Machine Considerations, page 17
Client Scalability, page 22
Installing the Intelligent Capture Client Components, page 51
Upgrading Client Modules, page 129
Appendix B, Intelligent Capture Client Modules
Intelligent Capture client modules that are registered as services can be unregistered.
101
Installing Intelligent Capture
After the module is unregistered as a service, it can continue to run as an application. (Exceptions:
the Web Services subsystem, including Web Services Coordinator, Web Services Hosting, and
the Web Services Input and Web Services Output modules, can only run as services, not as
applications.)
Related Topics —
Chapter 2, Installation Planning
Client Machine Considerations, page 17
Installing the Intelligent Capture Client Components, page 51
Upgrading Client Modules, page 129
Appendix B, Intelligent Capture Client Modules
The following table summarizes the configuration for a single machine installation:
102
Installing Intelligent Capture
2. Make sure the locale, globalization, and code page settings are specified as detailed in Locale
Considerations, page 12.
3. (Optional) Install the Intelligent Capture Database components and then Create a SQL Server
user account with minimum permissions to access the Intelligent Capture Database.
4. Install the Intelligent Capture Server components.
5. Install the Intelligent Capture client components.
6. Activate the Intelligent Capture Server and install the Intelligent Capture licenses.
7. Set the UI language for Intelligent Capture components.
First, you must prepare the Azure environment and then you can deploy Intelligent Capture to Azure.
103
Installing Intelligent Capture
104
Installing Intelligent Capture
105
Installing Intelligent Capture
For more information and examples, see the OpenText Intelligent Capture Google Cloud Deployment
Guide white paper on support.opentext.com. This white paper also describes migrating existing
on-premise capture processes to run on GCP.
106
Chapter 4
Upgrading Intelligent Capture
Upgrade Planning
Upgrading requires careful planning and execution. This section explains how to plan for an upgrade.
Upgrade planning includes the following:
• Understanding the valid upgrade paths (Upgrade Paths, page 108).
• Understanding the compatibility between the various components (Understanding Compatibility
among Intelligent Capture Components, Web Client, and REST Services, page 108).
• Understanding the locale considerations before planning an upgrade (Understanding Locale
Considerations before Planning the Upgrade, page 110).
• Identifying irreplaceable files to archive (Identifying Irreplaceable Files, page 112).
• Identifying new system requirements and obtaining new equipment as needed (Identifying
New System Requirements, page 115).
• Understanding the upgrade process (Understanding the Upgrade Process, page 116).
• Granting permissions so users can use the upgraded system (Permissions, page 123).
• Performing pre-production testing and acceptance (Performing Pre-Production Testing and
Acceptance, page 124).
• Scheduling upgrade phases (Scheduling Upgrade Phases, page 124).
Note: Intelligent Capture Real Time Services, including Intelligent Capture Web Client and Intelligent
Capture REST Service, cannot be upgraded from versions 16.5 or earlier. You must uninstall the
existing Intelligent Capture Web Client and Intelligent Capture REST Service Web sites and then
install 20.2. You can uninstall the previous installation and install 20.2 by using the Install Web
Components > Upgrade dialog box; however, the previous installation’s web.config settings are
107
Upgrading Intelligent Capture
not preserved. For more information, see Installing Intelligent Capture Web Client and Intelligent
Capture REST Service, page 77.
Make sure that your existing users’ permissions conform to the permissions (new as of 7.7)
requirements as described in Setting Up Required Intelligent Capture Permissions for Intelligent
Capture Web Client and REST Application Users, page 84.
Upgrade Paths
Customers can upgrade from the following versions only. To upgrade from any other version, first
upgrade to the latest applicable supported version and then perform the upgrade; alternatively,
perform a new installation as explained in Chapter 3, Installing Intelligent Capture.
• Intelligent Capture 16.6
• Intelligent Capture 16.5
• Intelligent Capture 7.7
• Intelligent Capture 7.6
• Intelligent Capture 7.5
Related Topics —
Identifying New System Requirements, page 115
Understanding the Upgrade Process, page 116
Understanding Compatibility among Intelligent Capture Components, Web Client, and REST
Services, page 108
108
Upgrading Intelligent Capture
components. These components must be at the 20.2 version level before client modules are
allowed to connect to the 20.2 server.
• All client modules that are installed on a single physical machine must be the same version. For
example, Intelligent Capture 7.7 client and Intelligent Capture 20.2 client modules cannot run
together on the same machine.
• Intelligent Capture Web Client must be the same version as the Intelligent Capture Server and the
Intelligent Capture REST Services version released with that Intelligent Capture Server.
6.5
6.5 SP1
6.5 SP2 No No No
7.0 No No No
7.1 No No No
7.5 Yes (1) Yes (1) Yes
7.6 Yes (1) Yes (1) Yes
7.7 Yes (1) Yes (1) Yes
16.5 Yes (1) Yes (1) Yes
16.6 Yes (1) Yes (1) Yes
Note:
• In-place upgrade is supported for 64-bit operating systems only because the Intelligent Capture
20.2 installer is a 64-bit application.
• The following notes correspond to the numbers in parentheses in the table:
1. Versions 7.5, 7.6, 7.7, 16.5, and 16.6 client modules can connect to a 20.2 server (upgraded
or new installation) if the 20.2 database is an external or internal database as it was in the
previous version (for example, if the 7.0 database was external, then the 20.2 database must
also be external). Furthermore, the external or internal database can be either an upgraded
or new installation.
109
Upgrading Intelligent Capture
Note: If you upgrade to Intelligent Capture 20.2, then Intelligent Capture REST Services versions 1.0
(released with Intelligent Capture 7.1) and 2.0 (released with Intelligent Capture 7.5) must also be
upgraded to version 2.1 or 2.5.
• Intelligent Capture REST Services 2.1
— Released with Intelligent Capture 7.6.
— Includes the Intelligent Capture REST Service Web application that runs on Microsoft IIS.
— Includes the Module Server Windows service.
— Customer- and partner-developed clients that use Intelligent Capture REST Services 2.1 are
completely compatible with both Intelligent Capture Servers 7.6, 7.7, 16.5, 16.6, and 20.2.
• Intelligent Capture REST Services 2.5
— Released with Intelligent Capture 7.7, 16.5, and 16.6.
— Includes the Intelligent Capture REST Service Web application that runs on Microsoft IIS.
— Includes the Module Server Windows service.
— Customer- and partner-developed clients that use Intelligent Capture REST Services 2.5 are
completely compatible with both Intelligent Capture Servers 7.7, 16.5, 16.6, and 20.2.
110
Upgrading Intelligent Capture
non-ASCII characters for these items, the Intelligent Capture Server does not allow you to
install a process containing non-ASCII characters if it detects that the process was compiled
on a machine having a different code page.)
Caution: The Intelligent Capture Server cannot detect whether it is code page-compatible
with pre-6.5 processes. Data corruption or server exceptions may occur if your processes
were compiled on a pre-6.5 system that had a different code page setting than the
Intelligent Capture Server. Therefore, you should recompile and reinstall all processes
that are being used in a mixed code page environment.
These restrictions do not apply to department names or to the default values of IA values
defined in MDFs using UTF-8 encoding. In other words, Unicode characters are supported
in dynamic IA value names. Also, none of these restrictions apply if the Process Developer
machine and the Intelligent Capture Server are using the same code page.
— Use a UTF-8 editor (for example, Windows Notepad) to define a custom data-only MDF to
hold literal text values in multiple languages. MDFs may declare Unicode (UTF-8) values.
— In the custom data-only MDF, define variables for all literal text that use characters from
languages that are not included in the specified system code page. The variable names
themselves must use characters from the system code page only; however, the values may be
in any language present in the system. For example, if the Process Developer system code
page is 1252, the variable names must use characters from the Latin alphabet (English, French,
Spanish, Portuguese, and others); however, the values may be any mixture of these or other
languages, such as Korean, Chinese, French, and Russian.
— Use only characters from the Process Developer system code page for the following:
— Process names
— IA value names
— Step names
— Variable names
— If you plan to execute your processes on machines with a different code page than the machine
on which the process was defined, do not use any literal strings that contain non-ASCII
characters in your VBA code. (If your environment has only a single code page, VBA literal
strings can be defined without this restriction.)
When processes are designed following these recommendations, batches from the resulting
complied process can be run on Intelligent Capture Servers and client machines using any
combination of code pages and regional settings (subject to the upgrade considerations described
in this section).
To ensure seamless multiple language/multiple code page compatibility, use CaptureFlow
Designer instead of Process Developer to create your process.
Note: Refer to the Administration Guide for details of the multiple language feature in Intelligent
Capture.
Related Topics —
Upgrade Paths, page 108
111
Upgrading Intelligent Capture
Understanding Compatibility among Intelligent Capture Components, Web Client, and REST
Services, page 108
Identifying New System Requirements, page 115
Understanding the Upgrade Process, page 116
112
Upgrading Intelligent Capture
113
Upgrading Intelligent Capture
114
Upgrading Intelligent Capture
Related Topics —
Upgrade Paths, page 108
Understanding Compatibility among Intelligent Capture Components, Web Client, and REST
Services, page 108
Identifying New System Requirements, page 115
Understanding the Upgrade Process, page 116
Caution: Upgrade customers may require higher performing hardware due to the new features.
Make sure you test your environment to ensure you have adequate performance.
Note: As always with any upgrade, please go to ISIS Scanner Drivers to make sure your scanner
will still be supported in the new environment.
Related Topics —
Identifying Irreplaceable Files, page 112
Understanding the Upgrade Process, page 116
Performing Pre-Production Testing and Acceptance, page 124
Scheduling Upgrade Phases, page 124
Migration Guidance, page 132
115
Upgrading Intelligent Capture
Users upgrading from 7.5, 7.6, and 7.7 versions must upgrade their version of the Intelligent Capture
Database (if installed). With the exception of development and demonstration systems, the Intelligent
Capture Database should be installed on a dedicated server that meets or exceeds the performance
criteria to keep the Intelligent Capture system at peak production capacity. System requirements
and recommendations for the Intelligent Capture Database host system can be found in the Release
Notes. For the best performance, always use the vendor's latest operating system (that Intelligent
Capture supports) for all Intelligent Capture components. Furthermore, you should always make
sure that you have applied the latest service packs and patches to your supported operating system
for all Intelligent Capture components. In addition to meeting the other recommended system
requirements, keeping your operating system up-to-date helps to ensure the best performance for
your Intelligent Capture system.
Related Topics —
Installing the Intelligent Capture Database, page 45
Intelligent Capture Database Issues, page 153
Regardless of which version you are upgrading, Intelligent Capture Servers must be upgraded.
Furthermore, upgrade customers must ensure that the Intelligent Capture Server machines meet or
exceed the system requirements listed in the Release Notes. For the best performance, always use
the vendor's latest operating system (that Intelligent Capture supports) for all Intelligent Capture
components. Furthermore, you should always make sure that you have applied the latest service
packs and patches to your supported operating system for all Intelligent Capture components. In
addition to meeting the other recommended system requirements, keeping your operating system
up-to-date helps to ensure the best performance for your Intelligent Capture system.
For more information about upgrading Intelligent Capture Servers in Microsoft Failover Clustering,
see Upgrading Intelligent Capture Server in a Microsoft Failover Clustering Environment, page 127.
116
Upgrading Intelligent Capture
Caution: For existing customers, be aware that hardware requirements have increased due to
increased functionality. Refer to Intelligent Capture Server Considerations, page 15 for more
information related to server requirements for better performance.
For all upgrade scenarios, if you have configured multiple Intelligent Capture Servers as a ScaleServer
group, the ScaleServer group is maintained during the upgrade procedure. Upgrade each Intelligent
Capture Server in the ScaleServer group, and then confirm that it is configured as needed by using
Intelligent Capture Administrator. Refer to the Using Intelligent Capture Administrator section in
the Administration Guide for details.
Note:
• When upgrading a ScaleServer group, if the setup program detects that the Windows Management
Instrumentation (WMI) service is running, it displays a message indicating that WMI will be
stopped before proceeding. Allow the setup program to stop WMI to upgrade a ScaleServer
group. After the upgrade completes, the setup program restarts the WMI service.
• The name of the Intelligent Capture Server host machine must not be longer than 15 bytes;
otherwise, client machines will be unable to connect.
• The upgrade procedure automatically creates a least-privileged user account (LUA) group named
InputAccel_Server_admin_group if none already exists and then adds the specified domain user
account that is used to run the Intelligent Capture Server to this group, enabling the Intelligent
Capture Server to operate with a LUA. Details of the LUA configuration can be found in Running
Intelligent Capture with Minimum Windows Permissions, page 25
Caution: When upgrading a ScaleServer group that has one or more Intelligent Capture Servers
installed on the same machine as the SQL Server, stop all SQL Server instances and close all
Service Control Manager windows before starting the upgrade.
The licensing mechanism uses a software security key (CAF file). You will need to obtain new licenses
for the new client modules.
Related Topics —
ScaleServer Licensing, page 33
Licensing for Use in a Microsoft Cluster, page 33
Licensing for Disaster Recovery, page 34
Existing Clients
New client modules are provided as replacements for legacy modules. Also, some modules are no
longer shipped.
The following table lists modules that require special upgrade considerations.
Note: The user Help files for legacy modules are removed after an upgrade.
117
Upgrading Intelligent Capture
Note: As always, with any recognition engine upgrade, it cannot be guaranteed that the performance,
accuracy and behavior will match the previous version. It is recommended that these changes be
tested thoroughly and settings be optimized for your environment before deploying.
• Extraction
• If you are using this module in previous releases, then the East
Euro / APAC OCR module (as well as corresponding Advanced
Recognition engine) will be available in 20.2 after upgrade.
118
Upgrading Intelligent Capture
As of 7.1, the FileNet Panagon IS/CS Export MDF file contains new
fields. Therefore, recompile pre-7.1 processes that use FileNet
Panagon IS/CS Export with the 7.5 version of the MDF file, which is
located in one of the following default paths:
C:\Program Files (x86)\InputAccel\src\ipp
\iaxfnet2.mdf
C:\Program Files\InputAccel\src\ipp\iaxfnet2
.mdf
Export for IBM Content • Export for IBM Content Manager only
Manager
As of 16.5, the Export for IBM Content Manager module has been
upgraded to use the IBM Content Manager Java API. If you want
to export to the IBM Content Manager Enterprise Edition v.8.5
(or greater), it is recommended to upgrade to the 20.2 module
because IBM no longer supports their C++ API.
• With the Legacy IBM CM C++ client libraries (for v.8.5 and
below) option
As of 16.5, you must install the Export for IBM Content Manager
with the Legacy IBM CM C++ client libraries (for v.8.5 and
below) option if you want to continue to use the pre-16.5 IBM
CM Advanced Export module (which works with the IBM Data
Server Client and IBM Content Manager Client for Windows
v.8.4) to export to the IBM Content Manager Enterprise Edition
v.8.4.
Note: Although you could also export to the IBM Content
Manager Enterprise Edition v.8.5, it is not recommended; install
only the Export for IBM Content Manager module instead.
— To enable:
regsvr32 exicm818.dll
— To disable:
119
Upgrading Intelligent Capture
regsvr32 /u exicm818.dll
Image Converter If you no longer require the virtual printer for either Image
Converter or the Module Server when upgrading from Intelligent
Capture 7.7, 16.5, or 16.6 only to Intelligent Capture 20.2, then
you must manually uninstall the virtual printer. That is, when
upgrading from the aforementioned versions, deselecting the
Virtual Printer feature does not remove the existing virtual printer
from Windows Devices and Printers. Furthermore, if you do not
want the Module Server to use the virtual printer, then the virtual
printer must be uninstalled.
However, if you require the Virtual Printer feature for either Image
Converter or the Module Server, then simply select the Virtual
Printer feature for the upgrade.
Multi-Directory Watch As of 7.7, this module is no longer shipped and is replaced with the
Standard Import module.
NuanceOCR • NuanceOCR no longer supports the following Output Format
settings: Excel 97, 2000, Microsoft Reader, Open eBook 1.0, RTF
Word ExactWord, RTF Word 6.0/95, RTF Word 97, Word 97,
and 2000, XP
120
Upgrading Intelligent Capture
Automatic Quality
Assurance
PrimeOCR Plus
121
Upgrading Intelligent Capture
Index Export
PDF Export
Values to XML
Pre-7.0 customers: As of 7.5, these modules are no longer shipped and are replaced
with Image Processor.
Image
Refer to Migrating from Image Enhancement to Image Processor,
Image Enhancement page 143 for migration guidance.
Pre-7.0 customers: As of 7.5, this module is no longer shipped and has no replacement.
Spawn
Pre-7.0 customers: As of 7.5, these modules are no longer shipped and are replaced
with Completion.
Image Quality Assurance
Refer to Migrating from Dispatcher Validation to the Completion
Index Module, page 140, Migrating from Image Quality Assurance to the
Completion Module, page 138 and Migrating from IndexPlus and
IndexPlus
Dispatcher Recognition to Completion and Extraction, page 138
Dispatcher Validation for migration guidance.
Pre-7.0 customers: As of 7.5, Dispatcher Recognition is no longer shipped and has been
replaced by Extraction.
Dispatcher Recognition
Refer to Migrating from IndexPlus and Dispatcher Recognition to
Completion and Extraction, page 138 for migration guidance.
Custom modules in If you used custom modules in a previous version of CaptureFlow
CaptureFlow Designer Designer, they will need to be added manually for them to be
available in the Steps panel. Review the Intelligent Capture Designer
Guide for more information.
122
Upgrading Intelligent Capture
Appendix B, Intelligent Capture Client Modules identifies key characteristics of each module,
including whether it runs in attended mode and unattended mode, whether it is ScaleServer
compatible, whether it can run as a service, and whether it provides scripting capabilities.
Related Topics —
Client Machine Considerations, page 17
Client Scalability, page 22
Upgrading Client Modules, page 129
While upgrading existing client machines, you may want to install new client modules. These
modules can be installed on existing client machines or on new machines.
Note: When installing new client modules, the Intelligent Capture Client setup program also updates
all client components.
Related Topics —
Client Machine Considerations, page 17
Client Scalability, page 22
Upgrading Client Modules, page 129
Appendix B, Intelligent Capture Client Modules
Permissions
There are several system Roles with permissions available after an upgrade. The Intelligent
Capture Administrator can assign users and groups to these roles without creating new ones. The
Intelligent Capture administrator may, if required, define additional user roles, possibly additional
Administrator roles, and assign appropriate users to each of those roles. The minimum Intelligent
Capture permissions needed to run a module in production mode include:
• Server.Login
• Server.Read.Module.Data
• Server.Write.Module.Data
• System.BatchRead
• System.BatchModify
• System.ProcessRead
Some modules require additional permissions to function, and certain specific tasks (other than
processing batches) require special permissions. Refer to the Using Intelligent Capture Administrator
section in the Administration Guide for more information about permissions and user roles.
Related Topics —
Security, page 23
123
Upgrading Intelligent Capture
Related Topics —
Identifying Irreplaceable Files, page 112
Understanding the Upgrade Process, page 116
Migration Guidance, page 132
Related Topics —
Identifying Irreplaceable Files, page 112
Understanding the Upgrade Process, page 116
124
Upgrading Intelligent Capture
Upgrade Procedures
This topic describes the procedures to upgrade each component. The following topics are included:
• Upgrading the Intelligent Capture Server, page 125
• Upgrading Intelligent Capture Server in a Microsoft Failover Clustering Environment, page 127
• Upgrading Client Modules, page 129
• Upgrading Processes, page 130
•
Caution: For all upgrade customers, be aware that hardware requirements have increased.
Refer to Intelligent Capture Server Considerations, page 15 for more information related
to performance.
125
Upgrading Intelligent Capture
7. Run the setup program with an account that has Administrative privileges. From the Installation
Choices list, select Step 2 - Install the Intelligent Capture Server.
8. Upgrade the Intelligent Capture Servers. Refer to Installing the Intelligent Capture Server, page
48 for instructions.
If you are installing a new Intelligent Capture Server on a different operating system, then copy
the backup of the \IAS data directory tree to the new Intelligent Capture Server before starting
the Intelligent Capture Server.
Note: To preserve the security settings on the \IAS directory, use xcopy; you can
also reset the proper security settings on the \IAS directory by running C:\Program
Files\InputAccel\Server\Server\binnt\ias64.exe -repair (default path).
You might also need to reactivate the Intelligent Capture Server and license keys. For more
information, see the Administration Guide.
Related topics —
Intelligent Capture Server Considerations, page 15
Intelligent Capture Server Scalability, page 21
Installing the Intelligent Capture Server, page 48
ScaleServer Issues, page 155
In some situations, you may want to revert to a previously installed version of Intelligent Capture
Server. This involves completely removing the Intelligent Capture Server and all previous versions
from the system while leaving the Intelligent Capture files and data intact and then reinstalling the
earlier version.
Related Topics —
Upgrading the Intelligent Capture Server, page 125
Intelligent Capture Server Considerations, page 15
Intelligent Capture Server Scalability, page 21
Installing the Intelligent Capture Server, page 48
126
Upgrading Intelligent Capture
Requirements
• Make sure that your environment meets the requirements as specified in Requirements for
Intelligent Capture Server in Microsoft Failover Clustering, page 69.
• Upgrade the Intelligent Capture Database before upgrading the Intelligent Capture Servers in
the cluster.
127
Upgrading Intelligent Capture
Automatically start the Intelligent Capture Deselect this option. The service startup
Server service when the system starts mode for the Intelligent Capture Server
services must be set to Manual when
running it in a cluster.
Start the Intelligent Capture Server service Deselect this option. The Intelligent Capture
when setup completes Server should not be started outside of the
cluster control.
b. In the Configure Intelligent Capture Service Accounts window, select the same credentials
for running the Intelligent Capture Server as the current version uses.
c. If required, restart Windows after the installation has completed.
6. Move both applications/roles to the second node.
7. Run the Intelligent Capture Server upgrade installer on the second node as in Step 5.
8. To register the Intelligent Capture Server cluster resource DLLs with the cluster, on one node, in
a command prompt (running as Administrator), execute the following file for each Intelligent
Capture Server:
C:\Program Files\InputAccel\Server\<Server#>\binnt\CreateIAResType.bat
where <Server#> is the directory for each Intelligent Capture Server.
InputAccel resource type is created for the first Intelligent Capture Server and InputAccel2
resource type is created for the second one.
Note: For more information about running CreateIAResType.bat, simply execute it.
9. To add the Intelligent Capture Servers to the cluster application/role, right-click the Intelligent
Capture Server application/role and select Add a resource > More resources… > Add InputAccel
and > Add InputAccel2.
Do not make these resources online.
Caution: If the following error message is displayed, then the Intelligent Capture Servers
are not installed on both nodes:
The resource type Add InputAccel is not configured on all nodes.
Do you wish to continue and create the resource?
Tab Action
General Change the name of the first and second
servers to InputAccel and InputAccel2,
respectively.
Dependencies Insert the following dependent resources for
this Intelligent Capture Server:
• Cluster disk
• Name
128
Upgrading Intelligent Capture
Tab Action
Policies Until the Intelligent Capture Server is fully
licensed and operational, it is recommended
that you change the setting of Response to
resource failure to If resource fails, do not
restart.
Note: This setting can be reconfigured later as
required.
129
Upgrading Intelligent Capture
Related Topics —
Client Machine Considerations, page 17
Client Components Installer Properties, page 197
Reverting to a previous client release removes the latest installation of the client modules and reverts
to a previously installed release of the client modules.
Related Topics —
Appendix B, Intelligent Capture Client Modules
Upgrading Processes
The IATaskPriority IA value was added in 7.6 P01. Therefore, if you have processes from 7.6
(unpatched) or earlier, you must recompile those processes to use this IA value.
130
Upgrading Intelligent Capture
131
Upgrading Intelligent Capture
After an upgrade, processing a batch configured to use any of these settings will fail. You
must reconfigure the batch or process to use supported settings. For more information, see
the NuanceOCR Guide.
7. (Optional) To upgrade existing client modules (including Process Developer and the Web Services
subsystem) or install new ones, run the Intelligent Capture Client installer.
For more information, see Upgrading Client Modules, page 129.
Caution:
• When you upgrade File System Export, PDF Export, Values to XML, Index Export, and
Image Export, the setup program uninstalls these modules and installs the Standard
Export module. Make sure that you maintain a machine with these modules, so that
you can continue to use them until you are ready to upgrade your processes to use
Standard Export.
Before using the Standard Export module, you must create export profiles in Intelligent
Capture Designer, upgrade your processes, and set up each Standard Export step in
every upgraded process.
Note:
• ClickOnce deployment is no longer shipped.
8. (Optional) Edit or create new processes to use any new client functionality that you have added
(for example, Completion, Standard Import, Identification, Image Processor, Image Converter),
and then compile and install them on your Intelligent Capture Servers.
Migration Guidance
This section is intended to provide IT personnel and administrators with high-level guidance
when planning the requirements and tasks involved when migrating to use the new modules and
functionality in Intelligent Capture. This section is not a step-by-step set of instructions; it provides
enough high level information to help users plan their migration effort. This section must be used as
a planning tool and it includes the most common scenarios that users may encounter.
Prerequisites:
Before users plan on migrating, they must:
• Complete the upgrade.
• Read the updated and new documentation to learn about the new functionality.
Topics in this section include:
• Migrating Processes, page 133
• Migrating from Multi-Directory Watch and Email Import to Standard Import, page 136
• Migrating from Image Quality Assurance to the Completion Module, page 138
• Migrating from IndexPlus and Dispatcher Recognition to Completion and Extraction, page 138
• Migrating from Dispatcher Validation to the Completion Module, page 140
• Migrating from Dispatcher Classification Edit to the Identification Module, page 141
132
Upgrading Intelligent Capture
Migrating Processes
To upgrade CaptureFlow-developed processes to use only the .NET runtime, you recompile and
redeploy the process to the Intelligent Capture Server. If associated batches are running on the
Intelligent Capture Server, deploy the process with a different name.
CaptureFlow Designer now compiles processes that require only the .NET runtime. In previous
CaptureFlow Designer releases, processes still required the VBA runtime. Because VBA is an old
technology, moving to .NET promotes usability and ensures the ongoing viability of processes.
Furthermore, you can now use CaptureFlow Designer to update a process (within certain restrictions)
such that after you deploy the updated process, then all of that process's existing batches use the
updated process.
This section is targeted towards users that used Process Developer to design processes but now want
to migrate to using CaptureFlow Designer for existing processes.
Note: Process Developer provided functionality to trigger module steps, assign values conditionally,
assign departments, conditional routing, and basic error handling. All these features are available in
the CaptureFlow Designer user interface. In addition, CaptureFlow Designer includes an integrated
CaptureFlow Script Editor that enables adding custom code for advanced data manipulation such as
iterating and calculating totals, string manipulations, and provides access to more advanced scripting
functions. Other benefits of using CaptureFlow Designer to design processes include:
• Processes are more maintainable and easier to understand due to the graphical user interface
• Easier to update processes
• Deployment support
• Ability to configure process steps
• CaptureFlow Designer now compiles processes that require only the .NET runtime. In previous
CaptureFlow Designer releases, processes still required the VBA runtime. Because VBA is an old
technology, moving to .NET promotes usability and ensures the ongoing viability of processes.
Furthermore, you can now use CaptureFlow Designer to update a process (within certain
restrictions) such that after you deploy the updated process, then all of that process's existing
batches use the updated process.
133
Upgrading Intelligent Capture
The Intelligent Capture Designer Guide provides detailed instructions on using CaptureFlow Designer
and CaptureFlow Script Editor. The Scripting Guide provides details on the APIs used to create
CaptureFlow scripts.
134
Upgrading Intelligent Capture
• For Tree PreNodeDelete and PreNodeMove events: There is no direct replacement for these
events. You can use the NodeDeleted event provided with Document Type Scripting.
• For setting the default values for newly inserted nodes: Use the NodeMoved and NodeAdded
events provided with Document Type Scripting. Refer to the Scripting Guide for this
information.
• For the StepNotify event: This event is no longer supported. Users should migrate to using
Completion, and modify their process so Completion is triggered at a higher level so the
affected nodes are within the task.
• For the Retrigger event: CaptureFlow Designer automatically handles step re-triggers.
Note that if a step is re-triggered, all the tasks are re-triggered.
• For the Batch_Create event: This event is no longer supported.
• For the Install event: This event provided the capability to assign initial values for the
batch. Users can use the Custom Values functionality in CaptureFlow Designer.
9. Save the redesigned process. If the redesigned process uses the same module steps as the previous
process, then save the XPP and make sure the name conforms to the XPP naming conventions.
10. Compile the CaptureFlow and then install it to the server.
11. Configure the process:
• If the redesigned process uses the same module steps as the previous process, use Intelligent
Capture Administrator to connect to the server where the old process is installed and copy the
process settings to file. Then, paste the process settings to the newly designed process.
• If the redesigned process uses some of the same module steps as the previous process and
a few different module steps compared to the previous process, then save the XPP, and
then configure the module steps that are different using CaptureFow Designer. Next, use
Intelligent Capture Administrator to connect to the server where the old process is installed
and copy the module settings for steps that are same in both the old and new process. Then,
paste the copied step settings to the newly designed process steps.
12. Upload .NET Code module assemblies and Document Type Script assemblies: Copy the
assemblies to the <solution directory>/bin directory for deployment. Then in Intelligent
Capture Designer, navigate to System > System Configuration > Other Options and enter the
names of these assemblies and the Custom.Uimscript.Dll in the DeploymentFiles field in
the File Management area.
As of 7.0, CaptureFlow Designer was no longer a standalone module but part of the integrated
development tools provided with Intelligent Capture Designer. To continue using CaptureFlow
Designer processes, do the following:
1. Rename the existing XPP to conform to the current XPP naming conventions.
2. Copy the XPP to the \GlobalData\XPP folder.
3. Open the XPP file from Intelligent Capture Designer and ensure that it opens correctly.
135
Upgrading Intelligent Capture
When opening an XPP file with Intelligent Capture Designer > CaptureFlow Designer, the
process flow is automatically updated to use the Synchronize module in place of some Multi
module steps.
If you used custom modules in a previous version of CaptureFlow Designer, they will need to
be added manually for them to be available in the Steps panel. Review the Intelligent Capture
Designer Guide for more information.
4. Connect to the server where the previously configured XPP is installed. Open an existing process
and copy the step settings to the newly created XPP file on the local development system. Save
the updated XPP file and then compile and install it on the required servers.
In 6.0 SP3, CaptureFlow Designer replaced certain automatically-inserted steps with equivalent steps
of a different module. CaptureFlow Designer 1.0 automatically inserted steps that used the Multi
module at several key points in the process flow:
• End of batch creation
• Beginning of each decision step
• End of each decision step
Your existing Process Developer processes should run as-is in Intelligent Capture 20.2.
If you want to add 20.2 modules and functionality to your existing Process Developer processes,
then follow these steps:
1. In Process Developer, add module steps for the new client modules in 20.2. Compile the process
and reinstall the process to Intelligent Capture Servers.
2. This step is required only if the new client modules added to the process use profiles. Use
Intelligent Capture Designer to create profiles and deploy the profiles to Intelligent Capture
Servers.
3. Use Intelligent Capture Administrator to configure process steps.
4. Install .NET Code module assemblies, DPP project files, and client-side scripting assemblies.
136
Upgrading Intelligent Capture
Feature Procedure
To import email from multiple email servers Create separate email connection profiles
and select all of them in the Incoming Email
Connection property.
To filter out email attachments that are missing Select the Ignore Attachments without
the file extension Extension
property.
To prevent inline attachments, such as Select the Ignore Inline Attachments
email signatures, from being imported. property.
Attachments, such as documents, are still
imported.
To import encrypted emails No configuration required; automatically
performed.
To keep emails on the email server in order for Specify a filter in the Email Filter Rule
another email profile to process them property and select the Keep Emails Excluded
by Filter property.
To import encrypted zip files in the batch Select the Unzip Files (File System profile) or
while at the same time unzipping unencrypted Unzip Attachments (Email profile) properties.
zip files
To specify an arbitrary string used to identify Select the Custom Value property (in both File
the email or file system source, for example, System and Email profiles).
HR or Finance.
3. (Optional) If customized poll scheduling or tree restructuring is required, create a custom script
and reference it in the profile.
4. Add the profile name to each Standard Import module instance by restarting each module
instance with the appropriate command-line parameters as follows:
• Email Import
-EmailProfileNames:profileName[,profileName2,profileName3,...]
• File System
-FileProfileNames:profileName[,profileName2,profileName3,...]
• A profile name configuration file.
Using a profile name configuration file is a convenient way to add multiple Email and File
System profile names to each Standard Import module instance. In addition, using a profile
name configuration file can overcome the maximum Windows command-line length.
-Profilesconfig:configFile
137
Upgrading Intelligent Capture
For more information, see Intelligent Capture Designer Guide or Intelligent Capture Module Reference.
138
Upgrading Intelligent Capture
• You may be required to map page flags to the RescanPlus step using the MatchAny function
in CaptureFlow Script Editor.
• If required, add an Image Conversion step to burn annotations into the image.
4. Port client-side scripts (if any):
• If using IndexPlus, then the Client-side scripts must be manually ported to Document Type
scripts.
• Adjust process routing to use the DocumentStatus flag.
• Write Document Type scripts and configure expressions in Intelligent Capture Designer to
handle any custom behaviors preferred, including validation and population functionality
that was implemented with the Index module by using one of the validation DLL files.
• Use any .NET IDE to write and compile Document Type scripts. Deploy the scripts to the
server.
Note: All scripting usage is documented in the Scripting Guide.
5. Remove the Dispatcher Recognition step from the process and replace with Extraction if you
are using OCR to extract zones. Configure it to use the newly created recognition project. In
addition, update the existing process to remove NuanceOCR module from the XPP if it was
used for zonal extraction.
6. Deploy document types and the recognition project using Intelligent Capture Designer.
7. Configure reporting:
• Configure the Extraction and Completion modules to export statistics to the new reports.
• Generate the Operator Productivity, Page Extraction, and Field Extraction reports. You
could also use the Template, Field, and DocType tables to create custom reports; for more
information, see the Administration Guide.
139
Upgrading Intelligent Capture
140
Upgrading Intelligent Capture
5. Deploy document types and the recognition project using Intelligent Capture Designer.
6. Configure reporting:
• Configure Completion to export statistics to the new reports.
• Generate the Operator Productivity, Page Extraction, and Field Extraction reports. You
could also use the Template, Field, and DocType tables to create custom reports; for more
information, see the Administration Guide.
• Remove the use of Dispatcher Statistics for the Validation module.
141
Upgrading Intelligent Capture
System styles do not include custom colors for even and odd pages in
the Page List View.
6. Configure system styles in Intelligent Capture Designer. Upload the configuration file to the
server. For more information, see the Intelligent Capture Designer Guide, section Defining Styles.
142
Upgrading Intelligent Capture
7. Deploy document types and the recognition project using Intelligent Capture Designer. For more
information, see the Intelligent Capture Designer Guide, section Deploying Components.
8. Configure Identification to collect statistics:
• Set up the new Identification steps to export statistics.
• Reference the Template, Field, and DocType tables from your reporting tool. For more
information, see the Administration Guide.
• Remove the use of Dispatcher Statistics for the Classification Edit module.
143
Upgrading Intelligent Capture
144
Upgrading Intelligent Capture
145
Upgrading Intelligent Capture
146
Chapter 5
Modifying, Repairing, and Removing
Intelligent Capture
An Intelligent Capture installation can be modified, repaired, or uninstalled. Topics in this section
include:
• Modifying an Intelligent Capture Installation, page 147
• Repairing an Intelligent Capture Installation, page 148
• Removing Intelligent Capture Components, page 148
Related Topics —
Repairing an Intelligent Capture Installation, page 148
Removing Intelligent Capture Components, page 148
147
Modifying, Repairing, and Removing Intelligent Capture
148
Chapter 6
Troubleshooting
This section provides information to help you troubleshoot installation problems. Topics in this
section include:
• Installation Failures, page 149
• Third-party Component Issues, page 153
• Post-Installation Issues, page 153
Installation Failures
When a component fails to install correctly, the setup program performs a rollback operation and
returns the machine to the state it was in prior to starting the installation. Troubleshooting this type
of installation issue requires examination of setup program log files. However, setup program log
files are not generated by default. To generate a log file, you must enable logging when starting the
setup program by including a command-line parameter of /l.
For example, you could start the client setup program (or any of the other setup programs) by typing
the following in a command prompt window:
setup.exe /v"/l*v logfilename"
where
/v passes the part of the command line enclosed in quotes to the Microsoft Installer package.
/l*v enables verbose logging.
logfilename is the path and file name to which to write the log data.
This command line starts the setup program and writes detailed information to the specified
file. After the installation completes (or fails and rolls back), you can examine the log file to help
determine the cause of the problem.
Note: Wait until the setup program closes before opening the log file to ensure that all log entries
have been written to the file.
A log file created in this manner is a simple text file that can be opened with any text editor. The
log file can become quite large (20 MB or more) depending on the particular setup program and
the specified logging level.
Setup programs write entries to the log file as events occur. In some cases, one error might lead to
another. It is important to find the first error in the chain in order to properly troubleshoot an issue.
149
Troubleshooting
Both errors and non-error information may be written to the log file. A return value of 3 indicates an
error or failure entry in the log. You can save time by searching for the string “return value 3”. The
following log entry is an example of a failure:
Action ended 14:04:40: InstallFinalize. Return value 3.
This message in this example is not an actual error, but an indication of where the error occurred. The
preceding lines in the log file indicate the problem. Most installation errors are written to the log
with a specific error code and, when available, an error message. These errors often provide enough
information to enable you to resolve the issue. If not, a setup program log file will help your customer
support representative quickly evaluate the problem.
Topics in this section include:
• Installation Errors, page 150
• Command Line Installation Failures, page 151
Installation Errors
Errors discussed here occur during installation and do not cause the setup program to perform a
rollback operation. Most can be corrected and then the installation completed. The following table
lists common installation errors.
150
Troubleshooting
Syntax Errors
Unattended Installations, page 94 explains how to install Intelligent Capture from command-line
instructions. When using this method, the command line can become very long due to the number of
features and options.
Many command-line errors occur because the command line contains syntax errors or incomplete
information.
Some properties require their values to be encapsulated in quotes (" "). For example:
setup.exe /s /v"/qn ADDLOCAL="ALL""
Note that every open quote character must have a matching close quote character. This example
shows one quoted parameter correctly nested within another quoted parameter. A common error is
to omit or misplace one or more quote marks.
The best way to troubleshoot command line installation issues is to examine the setup program log
files, as explained in Installation Failures, page 149.
The following table lists some of the more common errors that customers experience when running
setup programs from the command line.
151
Troubleshooting
INSTALLDIR=\"c:\Program Files\InputAccel\Client\"
• Properties containing the reserved characters \, &, |, >, <, and
^ must escape those characters with a caret character (^).
152
Troubleshooting
Post-Installation Issues
This section provides troubleshooting tips for issues that can occur after a successful installation,
including:
• Intelligent Capture Database Issues, page 153
• ScaleServer Issues, page 155
• Other Issues, page 156
153
Troubleshooting
and communicate with the Intelligent Capture Database. Following are some common problems
that can occur.
hostname\instancename
154
Troubleshooting
ScaleServer Issues
When Intelligent Capture Servers are configured as a ScaleServer group, client modules must connect
to one of the Intelligent Capture Servers in the ScaleServer group by using the machine name of the
machine hosting the Intelligent Capture Server. If an IP address or the name “localhost” is used in the
Server name field of the connection string, the connection to the server will fail.
155
Troubleshooting
Other Issues
This section explains some common issues that may occur during Intelligent Capture setup.
Examples —
• Create the LUA group using the default Intelligent Capture
Server data directory and service instance name:
ias64.exe -repair -r C:\IAS -s InputAccel
156
Troubleshooting
157
Troubleshooting
To verify differences in the locale, globalization, and code page settings on the
Intelligent Capture Server and client machines:
1. On the machine where a client module is installed, open the settings.ini file.
2. In the [INPUTACCEL] section, add IAClientDebug=1 to activate the client debug file.
3. Open the iaclient.log file (default location: c:\). This file contains a section Begin client
locale settings with all client module settings. Search for the diff string. This section lists
the server settings that are different from the client module settings.
4. If there are differences in the locale, globalization, and code page settings on the Intelligent
Capture Server machine and the client module machine, change the regional settings so that these
settings on the Intelligent Capture Server and client machines are identical.
158
Appendix A
Prerequisite Software Installed by the
Intelligent Capture Setup Program
The Intelligent Capture setup program installs prerequisite software if the software is not already
installed. The prerequisite software varies depending on the Intelligent Capture component that is
installed. This section lists the prerequisite software installed for each Intelligent Capture component.
Note: Depending on the language of the operating system and the presence of MUI packs, multiple
language versions of some of the prerequisite files are installed on the target machine.
159
Prerequisite Software Installed by the Intelligent Capture Setup Program
Note: If you cancel the installation, any prerequisite IIS roles that have been enabled are not rolled
back.
160
Appendix B
Intelligent Capture Client Modules
The following table lists all client modules and their capabilities.
Caution: Some modules may run as multiple application instances or multiple service instances,
but it may not be safe to do so as you may experience data loss. Refer to this table for the list of
modules that you can safely run as multiple application or service instances.
161
Intelligent Capture Client Modules
Modules New Modules Modules Available Executable Name3 MDF File Name DBCS4 Scale- At- Unat- Applica- Multi Service10 Multi Script-
in 7.0 - 7.7, New in 6.x 1 Prior to 6.02 Server5 tended6 tended7 tion8 -application -service11 ing12
16.5, 16.6, 20.2 in-
stances9
.NET Code CodeClient.exe code.mdf Yes Yes Yes No Yes Yes Yes Yes Yes13
Module
ApplicationXtender exax.exe exax.mdf Yes Yes Yes Yes Yes Yes No No No
Export
Archive Export exsapal.exe exsapal.mdf Yes Yes Yes Yes Yes Yes No No No
Intelligent CaptivaAdministrator.exe N/A N/A No Yes No Yes Yes No No No
Capture
Administrator
Classification Emc.InputAccel.DPCLSSF dpclssf.mdf Yes Yes Yes Yes Yes Yes Yes Yes Yes14
.dll
Collector Emc.InputAccel.DPCollec dpcollec.mdf Yes Yes Yes Yes Yes Yes Yes Yes Yes15
.dll
Completion cpdsktop.exe cpdsktop.mdf Yes Yes Yes No Yes Yes No No Yes16
(previously
known as
Intelligent
Capture
Desktop)
Copy iacopy.exe iacopy.mdf Yes Yes Yes Yes Yes No Yes No No
162
Intelligent Capture Client Modules
Modules New Modules Modules Available Executable Name3 MDF File Name DBCS4 Scale- At- Unat- Applica- Multi Service10 Multi Script-
in 7.0 - 7.7, New in 6.x 1 Prior to 6.02 Server5 tended6 tended7 tion8 -application -service11 ing12
16.5, 16.6, 20.2 in-
stances9
Documentum DocumentumAdvancedExport iaexdm.mdf Yes Yes Yes Yes Yes Yes Yes Yes Yes17
Advanced .dll
Export
Email Import EmailImport.exe emailimp.mdf Yes Yes Yes Yes Yes No Yes No No
Extraction cpextrac.exe cpextrac.mdf Yes Yes Yes Yes Yes Yes Yes Yes Yes18
FileNet Content exfncm.exe exfncm.mdf Yes Yes Yes Yes Yes Yes No No No
Manager Export
FileNet Panagon IS/CS iaxfnet2.exe iaxfnet2.mdf Yes No Yes Yes Yes Yes No No No
Export
19
163
Intelligent Capture Client Modules
Modules New Modules Modules Available Executable Name3 MDF File Name DBCS4 Scale- At- Unat- Applica- Multi Service10 Multi Script-
in 7.0 - 7.7, New in 6.x 1 Prior to 6.02 Server5 tended6 tended7 tion8 -application -service11 ing12
16.5, 16.6, 20.2 in-
stances9
Export for OpenText exll2.exe exll2.mdf Yes Yes Yes Yes Yes Yes No No No
Content Server
RescanPlus Emc.InputAccel.ReScan rescanplus.mdf Yes Yes Yes - Yes Yes No No Yes23
.dll
ScanPlus Emc.InputAccel.Scan.dll scanplus.mdf Yes Yes Yes No Yes Yes No No Yes24
Standard cpexport.exe cpexport.mdf Yes Yes Yes Yes Yes Yes Yes Yes No
Export
Standard cpimport.exe cpimport.mdf Yes Yes Yes Yes Yes Yes Yes Yes Yes25
Import
Standard OCR CPOCR.exe CPOCR.mdf Yes Yes Yes Yes Yes Yes Yes Yes No
Timer iatimer.exe iatimer.mdf No Yes Yes Yes Yes Yes Yes No No
WS Input WebServicesInput.dll wsinput.mdf Yes Yes No No No No Yes Yes Yes26
WS Output WebServicesOutput.dll wsoutput.mdf Yes Yes No No No No Yes Yes Yes27
164
Appendix C
Client Module Features
This section lists the client modules that can be installed with each feature.
Note: For more information about modules and components that are no longer shipped and legacy
modules, see the Intelligent Capture Release Notes.
• IA Migrate
Module Server • Module Server
Note: The Module Server also requires the following
features:
— Image Converter
Note: If you do not want the Module Server to use the
Virtual Printer feature, then the Virtual Printer feature
cannot be installed with the Module Server.
— Image Processor
— Extraction
— General-Use OCR
165
Client Module Features
— Classification
— Identification
— NuanceOCR
— Standard OCR
Operator Tools • Completion
• Identification
• ScanPlus
• RescanPlus
Standard Unattended Modules
• ODBC Export
• Standard Export
• Copy
• Multi
• Timer
Image Handling Modules • Image Converter
— Virtual Printer: Installs a virtual printer named
InputAccel Virtual Printer.
• Image Processor
Recognition • Extraction
• NuanceOCR
• Standard OCR
166
Client Module Features
• MS SharePoint Export
— Chinese (Traditional)
— Japanese
— Korean
— Thai
• General-Use OCR
167
Client Module Features
• WS Hosting
Advanced Recognition • Classification
• Collector
168
Appendix D
Localized Languages
Intelligent Capture is localized into the following languages. These languages for Intelligent Capture
are used to control the User Interface (UI) language displayed to the user. The UI language that
Intelligent Capture components use is independent of the languages that can be part of a batch,
task, or page.
169
Localized Languages
170
Appendix E
Ports Used
The following table lists the ports used by the various components of the Intelligent Capture
application.
12007 The TCP port that enables Web Services Coordinator to receive connections
from the WS Input module.
10099 The default TCP port that enables Intelligent Capture client modules to
communicate with the Intelligent Capture Servers. This can be changed during
installation and may be different for each Intelligent Capture Server in a
side-by-side installation.
443/80 The default HTTPS/HTTP ports for Intelligent Capture REST Service and
Intelligent Capture Web Client Web site.
50000 The TCP port that enables the Module Server (CPMODSRV.exe) to accept
incoming requests.
50010 - 50999 The TCP ports that enables hosted modules (Emc.Captiva.LccClientHost
.exe) to accept incoming requests.
171
Ports Used
172
Appendix F
Running the Database Manager Utility
By default, the database setup program creates an external, SQL Server-hosted Intelligent Capture
Database. If customers choose not to install an Intelligent Capture Database, then running the
Intelligent Capture Server setup program creates a file-based, internal database. You may be required
to update the installed external or internal database or create the database for various reasons.
Use the Database Manager utility in the following circumstances:
• You disabled the default setting to create the Intelligent Capture Database when running the
Intelligent Capture Database setup program.
• You have been directed by support personnel to update your Intelligent Capture Database with
scripts provided to you.
173
Running the Database Manager Utility
Table 23. Explanation of Command-line Arguments used to Install the Intelligent Capture Database
174
Running the Database Manager Utility
Table 24. Explanation of Command-line Arguments used to Install the File-based Database
175
Running the Database Manager Utility
176
Appendix G
Command Line Arguments for
Installing Intelligent Capture
Intelligent Capture supports a subset of the standard InstallShield and Windows Installer command
line arguments. All command line examples must be typed on one command line which may wrap
to multiple lines in a command prompt window. The Windows Installer switches and Intelligent
Capture features and properties are case sensitive. Use the examples as they are shown. The topics in
this section describe the supported command line instructions:
• Supported MSI Switches, page 178
• Supported Windows Installer Properties, page 178
• Intelligent Capture Installer Properties and Feature Names, page 178
Switch Description
/v Passes the MSI parameter switches from the InstallShield setup
command line to MSI.
/x Removes a product.
For more information on the supported InstallShield switches, search the Internet for “Setup.exe
and Update.exe Command-Line Parameters.”
Related Topics —
Supported MSI Switches, page 178
Supported Windows Installer Properties, page 178
177
Command Line Arguments for Installing Intelligent Capture
Related Topics —
Supported InstallShield Switches, page 177
Intelligent Capture Installer Properties and Feature Names, page 178
178
Command Line Arguments for Installing Intelligent Capture
179
Command Line Arguments for Installing Intelligent Capture
180
Command Line Arguments for Installing Intelligent Capture
181
Command Line Arguments for Installing Intelligent Capture
• 1
182
Command Line Arguments for Installing Intelligent Capture
• This example installs the Database Manager, CreateDbConsole.exe, and the database
scripts into the default installation directory. The Database Manager is executed to install the
Intelligent Capture Database on the locally installed SQL Server which listens for connections on
the default port of 1433. The default Intelligent Capture Database name is used.
setup.exe /s /v"/qn ADDLOCAL=ALL DB_SERVER="(local)" DB_USER="dbcreator"
DB_PASS="password" /promptrestart"
• This example installs Database Manager and the database scripts into the directory specified
by INSTALLDIR. IADBManager.exe is executed to install the Intelligent Capture Database to
the remote SQL Server named “CORP-SQL” which listens for connections on the default port of
1433. The default Intelligent Capture Database name is used.
setup.exe /s /v"/qn ADDLOCAL=ALL INSTALLDIR=\"c:\Program Files
\InputAccel\Databases\" CREATE_DATABASE=1 DB_SERVER=CORP-SQL
DB_USER=dbcreator DB_PASS=password /promptrestart"
• This example upgrades the Intelligent Capture Database using the minimum parameters.
setup.exe /s /v" /qn CREATE_DATABASE=2 DB_SERVER= "(local)"
DB_USER="dbcreator" DB_PASS="password""
Related Topics —
Intelligent Capture Server Components Installer Properties, page 183
Client Components Installer Properties, page 197
Intelligent Capture Web Components Installer Properties, page 194
183
Command Line Arguments for Installing Intelligent Capture
The following table lists the installer properties that can be specified when installing or upgrading the
Intelligent Capture Server.
184
Command Line Arguments for Installing Intelligent Capture
• IA_COMMON:
Installs common
components.
INSTALLDIR Path - The destination
directory for the Server
application files.
A default value of
%ProgramFiles%
\InputAccel
\Server is used
when this property is
not specified.
SERVER_INSTANCES 1-8 - The number of
Intelligent Capture
Server instances to
install.
A default value of
1 is used when
this property is not
specified.
INSTALLATION_TYPE Specify only if an - Available feature:
Intelligent Capture • NODB: The
Database is not and Intelligent Capture
will not be installed Database is not
installed. The
Intelligent Capture
Server installer will
install a file-based,
internal database.
185
Command Line Arguments for Installing Intelligent Capture
• 1: Perform DAL
registration for the
Intelligent Capture
Database.
A default value of
1 is used when
this property is not
specified.
DB_SERVER Hostname Yes, if the previous Hostname or machine
installation included name of the SQL
an external database Server. You can use
(local) or localhost if
you want to use the
locally installed SQL
Server.
DB_PORT TCP port - The TCP port number
to use to connect to the
SQL Server.
A default value of
1433 is used when
this property is not
specified.
DB_NAME Database name - The name of the
Intelligent Capture
Database. A default
value of “IADB” is
used if this property is
not specified.
DB_USER SQL user name Yes, if the previous The name of the SQL
installation included Server user name
an external database required to connect to
the SQL Server.
DB_PASS SQL password Yes, if the previous The password of
installation included the SQL Server
an external database user specified in the
DB_USER property.
186
Command Line Arguments for Installing Intelligent Capture
• 1
Windows
authentication is
used. DB_USER
and DB_PASS are
ignored.
AC_MACHINE_USER Username - The user account
_NAME specified as the
“Run-as” user for
Intelligent Capture
Administrator. This
property is only valid
when the Intelligent
Capture Server is
installed on machines
that are members of a
Windows domain.
AC_MACHINE_DOMAIN Domain name - The domain name
_NAME of the user account
specified as the
“Run-as” user for
Intelligent Capture
Administrator. This
property is only valid
when the Intelligent
Capture Server is
installed on machines
that are members of a
Windows domain.
187
Command Line Arguments for Installing Intelligent Capture
• 1: Allow setup
to configure the
Windows Firewall.
This is the default
setting when the
property is not
passed in.
IA_SERVICES 0/1 - Automatically starts
_AUTOSTART the Intelligent Capture
Server service for the
first instance when
Windows starts.
• 0: Manual. Do not
start automatically.
• 1: Automatically
start the Intelligent
Capture Server
service for the
first instance when
Windows starts.
The default value is
1 unless otherwise
specified.
IAS<#>_ROOT_DIR Path Yes, if upgrading more The destination
than one instance of directory for the root
where <#> is a the server on the same directory used by the
number from 1 machine Intelligent Capture
through 8. Example: Server instance that is
IAS1_ROOT_DIR determined by <#>.
You can have instances
from 1 through 8.
A default path of
WINDRIVE\IAS
is used when this
property is not
specified. For example,
188
Command Line Arguments for Installing Intelligent Capture
Caution: The
path length
must not be
greater than 109
characters and
cannot be the
same as the root
directory for any
other Intelligent
Capture Server
instance.
USE_IN_CLUSTER 0/1 - If this property is
defined, the Intelligent
Capture Server will
be configured for use
in a cluster. Do not
define this property
if you do not want to
use Intelligent Capture
Server in a cluster.
• 0: The Intelligent
Capture Server will
not be configured
for use in a cluster.
This is the default
value when the
property is not
specified.
• 1: The Intelligent
Capture Server will
be configured for
use in a cluster. The
IP address for each
Intelligent Capture
Server instance
being installed must
be specified when
the value of this
property is 1.
189
Command Line Arguments for Installing Intelligent Capture
• 2: The Intelligent
Capture Server
service runs without
using the Local
System account.
When this option is
selected, you must
specify a username
and password.
190
Command Line Arguments for Installing Intelligent Capture
191
Command Line Arguments for Installing Intelligent Capture
• This example installs one instance of the Intelligent Capture Server into the directory specified
by INSTALLDIR. The service is installed and runs under the built-in Local System account. It
does not configure the Windows Firewall (if it is installed and running). The installer performs
DAL registration against the Intelligent Capture Database on the SQL Server installed on the same
machine, which listens for connections on the default port of 1433. The system automatically
restarts if a reboot is required. Because DB_NAME is not specified, the IADB database is used.
setup.exe /s /v"/qn ADDLOCAL="ALL" INSTALLDIR=\"c:\Program
Files\InputAccel\Server\" IA_SERVICES_RUNAS_LOCAL_SYSTEM=1
CONFIGURE_WINDOWS_FIREWALL=0 DB_SERVER="(local)" DB_USER="dbcreator"
DB_PASS="password""
• This example installs one instance of the Intelligent Capture Server into the directory specified
by INSTALLDIR. The service is installed and runs under the built-in Local System account. It
does not configure the Windows Firewall (if it is installed and running). The installer installs a
file-based, internal database.
setup.exe /s /v"/qn INSTALLATION_TYPE="NODB" ADDLOCAL="ALL" INSTALLDIR=
\"c:\Program Files\InputAccel\Server\" IA_SERVICES_RUNAS_LOCAL_SYSTEM=1
CONFIGURE_WINDOWS_FIREWALL=0"
• This example installs eight instances of the Intelligent Capture Server into the directory specified
by INSTALLDIR. All eight instances of the Intelligent Capture service use the local Administrator
user account (which has a password of “password”) as the “run-as” credentials. The root directory
for each Intelligent Capture Server instance is specified by the properties IASn_ROOT_DIR, where
n is the number of the specific instance. The TCP port used by each Intelligent Capture Server
instance is specified by the properties IASn_TCP_PORT, where n is the number of the specific
instance. The installer performs DAL registration against the Intelligent Capture Database on
the SQL Server installed on a different machine (“CORP-SQL”), which listens for connections
on the NON-default port of 3999. The NON-default Intelligent Capture Database name is
“CORP_IADB”. The system automatically restarts if a reboot is required.
setup.exe /s /v"/qn ADDLOCAL="ALL" INSTALLDIR=\"c:\Program Files
\InputAccel\Server\" SERVER_INSTANCES=8 IAS1_ROOT_DIR=\"C:\IADataFiles\"
IAS2_ROOT_DIR=\"E:\IADataFiles\" IAS3_ROOT_DIR=\"F:\IADataFiles\"
IAS4_ROOT_DIR=\"G:\IADataFiles\" IAS5_ROOT_DIR=\"H:\IADataFiles\"
IAS6_ROOT_DIR=\"I:\IADataFiles\" IAS7_ROOT_DIR=\"J:\IADataFiles\"
IAS8_ROOT_DIR=\"K:\IADataFiles\" IAS1_TCP_PORT=10099 IAS2_TCP_PORT=10100
IAS3_TCP_PORT=10101 IAS4_TCP_PORT=10102 IAS5_TCP_PORT=10103
IAS6_TCP_PORT=10104 IAS7_TCP_PORT=10105 IAS8_TCP_PORT=10106 IA_SERVICES
_RUNAS_LOCAL_SYSTEM=2 IA_SERVICES_RUNAS_USER_ACCT=".\Administrator"
IA_SERVICES_RUNAS_PSWD="password" DB_SERVER="CORP-SQL" DB_PORT=3999
DB_NAME="CORP_IADB" DB_USER="dbcreator" DB_PASS="password""
• This example upgrades the Intelligent Capture Server using the minimum required parameters:
setup.exe /s /v"/qn IA_SERVICES_RUNAS_LOCAL_SYSTEM=1 DB_SERVER=
"(local)" DB_USER="dbcreator" DB_PASS="password" "
Related Topics —
Intelligent Capture Server Components Installer Properties, page 183
192
Command Line Arguments for Installing Intelligent Capture
193
Command Line Arguments for Installing Intelligent Capture
• CWC_SITE: As of
Intelligent Capture
7.7, installs both
Intelligent Capture
Web Client and
Intelligent Capture
REST Service on the
same machine.
• CRS_DCA_JOINT:
For Intelligent
Capture 7.6 and
earlier, installs both
Intelligent Capture
Web Client and
Intelligent Capture
REST Service on the
same machine.
Note: After
performing a
command-line
installation of the
Intelligent Capture
REST Service or
194
Command Line Arguments for Installing Intelligent Capture
195
Command Line Arguments for Installing Intelligent Capture
• 1: Make the
Intelligent Capture
REST Service and
Intelligent Capture
Web Client online
after installation.
CRSDCA_WEB_SITE TCP port number - The listening TCP port
_TCP_PORT of both the Intelligent
Capture REST Service
and Intelligent Capture
Web Client Web site.
The default is 80.
MODULE_SERVER Path - This folder contains
_DATA_FOLDER temporary image
capture files and other
state information
as well as a shared
configuration file. See
CWC shared data
folder.
SAASPUBLICURL URL - This value sets
Intelligent Capture
and REST Service's
Application Settings
> SaaSPublicUrl. You
should specify the
URL that users are to
use to call CWC in the
following format:
[http|https]:/
/servername:port
196
Command Line Arguments for Installing Intelligent Capture
This command installs Intelligent Capture Web Client and Intelligent Capture REST Service.
setup.exe /s /v"/qn ADDLOCAL=COMMON,CWC_SITE
CAPWEBFILESDIR=c:\inetpub\captiva\test
CRSDCA_WEB_SITE_TCP_PORT=86 CRSDCA_WEB_SITE_STARTUP_STATE=1
CRSDCA_WEB_SITE_DESCRIPTION=testing"
Related Topics —
Intelligent Capture Web Components Installer Properties, page 194
where “property=value” is a list of installer properties to be passed into the setup program.
At a minimum, you must specify the ADDLOCAL=ALL and IA_SERVICES_RUNAS_NAMED_ACCT
property. For example:
setup.exe /s /v"/qn ADDLOCAL="ALL"
IA_SERVICES_RUNAS_NAMED_ACCT=0 /promptrestart"
Note: Installing Documentum Advanced Export in unattended or silent mode does not check that the
required Documentum software has been installed.
The following table lists the installer properties that can be specified when installing the Intelligent
Capture client components:
197
Command Line Arguments for Installing Intelligent Capture
198
Command Line Arguments for Installing Intelligent Capture
199
Command Line Arguments for Installing Intelligent Capture
A default value of
%ProgramFiles%
\InputAccel\Client is
used when this property is not
specified.
200
Command Line Arguments for Installing Intelligent Capture
Each feature listed in this table can be used to install its component during a silent installation by
specifying its name as the ADDLOCAL property. You can specify more than one feature to install
by separating the feature names with commas.
The following are supported feature names that can be specified when installing the Intelligent
Capture Client:
• IMAGE_CONVERTER
• IMAGE_PROCESSOR
• EXTRACTION
• ENGINE_ADVANCED_OCR
• ENGINE_GENERALUSE_OCR
• ENGINE_WESTERN_OCR
• DIA_CLASSIFICATION
• IDENTIFICATION
• NUANCE_OCR
• STANDARD_OCR
Operator Tools
CAPTIVA_DESKTOP The Intelligent Capture Completion module.
SCAN_APPLICATION The ScanPlus module.
RESCAN_APPLICATION The RescanPlus module.
Input/Output Modules
201
Command Line Arguments for Installing Intelligent Capture
202
Command Line Arguments for Installing Intelligent Capture
Related Topics —
Client Components Installer Command Line Examples, page 203
Client Components Installer Properties, page 197
This command installs all client components into the default installation directory. The module
services are installed and use a specific Windows user account as the “run-as” user account. The
installed client services connect to the Intelligent Capture Server “PROD-IASERVER” when started.
The services start automatically when Windows starts. The system does not restart after installation
even if a reboot is required.
setup.exe /s /v"/qn ADDLOCAL="ALL" IA_SERVICES_AUTOSTART=1 IA_SERVICES
_RUNAS_NAMED_ACCT=1 IASERVERNAME="PROD-IASERVER" IA_SERVICES_RUNAS_USER
_ACCT=".\Administrator" IA_SERVICES_RUNAS_PSWD="password" /norestart"
Related Topics —
Client Components Installation Features, page 201
203