EMC Captiva InputAccel - vmware.com · EMC®Captiva® InputAccel® Version6.5 InstallationGuide...

EMC® Captiva®

InputAccel®Version 6.5

Installation Guide

EMC CorporationCorporate Headquarters

Hopkinton, MA 01748-91031-508-435-1000www.EMC.com

EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kindwith respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitnessfor a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires anapplicable software license.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarksused herein are the property of their respective owners.© Copyright 2010 EMC Corporation. All rights reserved.

Table of Contents

Chapter 1 InputAccel Overview .................................................................................... 9

Chapter 2 System Requirements and Recommendations ............................................ 11Database Server Requirements .......................................................................... 11InputAccel Server Requirements........................................................................ 13InputAccel Web Components and ClickOnce Host Requirements ........................ 14Client Machine Requirements............................................................................ 17Common Requirements for All Client Modules .............................................. 17Module-Specific Requirements ...................................................................... 19

Compatibility ................................................................................................... 23Scanning Workstation Requirements.................................................................. 24

Chapter 3 Installation Planning .................................................................................... 25General Considerations..................................................................................... 25Locale Considerations................................................................................... 26Performance and Throughput ....................................................................... 27Database Server Considerations................................................................. 27InputAccel Server Considerations.............................................................. 29Administration Console Host System Considerations ................................. 30ClickOnce Host System Considerations...................................................... 30InputAccel Remoting Server Considerations............................................... 31Web Services Subsystem Considerations .................................................... 32Client Machine Considerations .................................................................. 32Running Modules as Services ................................................................ 33

Scalability .................................................................................................... 36InputAccel Server Scalability ..................................................................... 36Client Scalability....................................................................................... 37

Security ....................................................................................................... 38Running InputAccel in a Hardened Environment ....................................... 42Running InputAccel with MinimumWindows Permissions......................... 42

Installing InputAccel across Multiple Domains............................................... 45Installing InputAccel in a Workgroup ............................................................ 45High Availability and Failover....................................................................... 46High Availability Best Practices ................................................................. 47

Disaster Planning ......................................................................................... 47Creating an InputAccel Disaster Continuation Plan .................................... 48Disaster Recovery Considerations.............................................................. 48Implementing a Disaster Continuation System ........................................... 49

Licensing and Activation............................................................................... 49ScaleServer Licensing................................................................................ 50Licensing for use in a Microsoft Cluster...................................................... 51Licensing for Disaster Recovery................................................................. 51

Sample Production Installation Configurations................................................... 51

Chapter 4 Installing InputAccel .................................................................................... 53

3

Table of Contents

Installing InputAccel on a Single Machine .......................................................... 53Installing the InputAccel Database................................................................. 54Creating a SQL Server User Account with Minimum Permissionsto Access the InputAccel Database ............................................................. 56

Installing the InputAccel Server..................................................................... 57Installing the Administration Console............................................................ 59Configuring Administration Console on Windows XP ................................ 63

Activating and Licensing InputAccel ............................................................. 65Installing the InputAccel Client Components ................................................. 65Downloading ISIS Scanner Drivers ............................................................ 68Registering the SLDRegistration Executable ............................................... 68

Setting the UI Language of InputAccel Components ....................................... 69Specifying Default UI Language Settings.................................................... 70Summary of Options for Overriding the Default UI Language ..................... 71Procedures to Override the UI Language.................................................... 72

Installing InputAccel in a Production Environment............................................. 73Additional Installation and Configuration Options ............................................. 76Installing Multiple Instances of InputAccel Servers ......................................... 76Configuring Multiple InputAccel Servers as a ScaleServer Group .................... 78Installing the InputAccel Server in a Clustered Environment ........................... 79Installing InputAccel Servers into an MSCS Cluster .................................... 81

Installing InputAccel Remoting ..................................................................... 89Deploying Modules with the ClickOnce Deployment Utility ........................... 92Unattended Installations ............................................................................... 97Understanding Installation Command Line Arguments .............................. 97Command Line Considerations ................................................................. 99Installing InputAccel from a Command Line .............................................. 99Automating Unattended Installations ...................................................... 100Modifying Unattended Installations ........................................................ 100

Manually Registering a Client Module to Run as a Service ............................ 101Unregistering Client Modules that are Registered as Services .................... 103

Installing Additional Components ................................................................... 104Installing InputAccel Reports Designer ........................................................ 104Installing the Connector for eCopy ShareScan .............................................. 105

Chapter 5 Upgrading InputAccel ............................................................................... 107Upgrade Planning .......................................................................................... 107Upgrade Paths............................................................................................ 108Understanding Compatibility among InputAccel Components...................... 108Understanding Locale Considerations before Planning the Upgrade .............. 110Identifying Irreplaceable Files ..................................................................... 112Automatic Backup during Upgrade ............................................................. 115Identifying New System Requirements ........................................................ 116Understanding the Upgrade Process ............................................................ 116InputAccel Database ............................................................................... 117InputAccel Servers.................................................................................. 117Administration Console .......................................................................... 118Licenses, Activation Files, and Security Keys ............................................ 119InputAccel Clients .................................................................................. 119New Client Modules............................................................................... 125

Permissions................................................................................................ 126Performing Pre-Production Testing and Acceptance...................................... 127Scheduling Upgrade Phases ........................................................................ 128

Upgrading from InputAccel 5.3 SP3/SP4 to InputAccel 6.5................................. 128Upgrading from InputAccel 6.0 SP1/SP2 to InputAccel 6.5................................. 130Upgrade Procedures ....................................................................................... 131

4

Table of Contents

Upgrading the InputAccel Database ............................................................ 132Upgrading the InputAccel Server ................................................................ 133Rolling Back to a Previously Installed Version of the InputAccelServer .................................................................................................... 134

Upgrading the Administration Console ....................................................... 135Installing the Backward Compatibility Pack ................................................. 135Upgrading Client Modules.......................................................................... 136Rolling Back to a Previous InputAccel Client Release ................................ 137

Upgrading ClickOnce-Deployed Applications .............................................. 137Installing New Functionality ....................................................................... 138Assigning InputAccel Permissions ............................................................... 139Upgrading Existing XPP-Based Processes..................................................... 139Upgrading Existing Processes and Customizations ....................................... 140Upgrading Audit Extensions ....................................................................... 140Upgrading Custom Scan Callback Functionality ........................................... 141Upgrading Index Validation Functionality ................................................... 141Upgrading Documentum Advanced Export Client-Side Scripting.................. 142

Sample Upgrade Scenarios .............................................................................. 142Sample Scenario: Simple Upgrade from InputAccel 5.3 SP3/SP4 .................... 143Sample Scenario: Upgrade from InputAccel 5.3 SP3/SP4 whilecontinuing to use 5.3 Modules ..................................................................... 145Sample Scenario: Upgrade from InputAccel 6.0 ........................................... 147

Chapter 6 Modifying, Repairing, and Removing InputAccel ...................................... 151Modifying an InputAccel Installation............................................................... 151Repairing an InputAccel Installation ................................................................ 152Removing an InputAccel Components ............................................................. 152

Chapter 7 Troubleshooting ........................................................................................ 153Installation Failures ........................................................................................ 153Installation Errors....................................................................................... 154Command-line Installation Failures ............................................................. 155Syntax Errors ......................................................................................... 155Common Command-Line Installation Errors ............................................ 156

Third-party Component Issues ........................................................................ 157Post-installation issues .................................................................................... 158Database Issues .......................................................................................... 158ScaleServer Issues ....................................................................................... 159Other Issues ............................................................................................... 160

Appendix A Prerequisite Software Installed by the InputAccel Setup Program ............ 165

Appendix B InputAccel Client Modules ........................................................................ 167

Appendix C Languages Supported ............................................................................... 177

Appendix D Ports Used ................................................................................................. 179

Appendix E Running the Create Database Utility ......................................................... 181Running the Create Database Utility in Silent Mode.......................................... 182Create Database Utility Command-line Examples ......................................... 182

Appendix F Command-line Arguments for Installing InputAccel .................................. 183Supported InstallShield Switches..................................................................... 183

5

Table of Contents

Supported MSI Switches ................................................................................. 184Supported Windows Installer Properties .......................................................... 184InputAccel Installer Properties and Feature Names........................................... 184InputAccel Database Installer Properties ...................................................... 185InputAccel Database Installer Command-line Examples............................ 186

InputAccel Server Components Installer Properties ...................................... 187InputAccel Server Installation Features .................................................... 191InputAccel Server Installer Command-line Examples................................ 191

InputAccel Web Components Installer Properties ......................................... 193InputAccel Web Components Installer Command-line Examples ............... 195

InputAccel Client Components Installer Properties ....................................... 196InputAccel Client Components Installation Features ................................. 198InputAccel Client Components Installer Command-line Examples ............ 201

Installing the Backward Compatibility Pack from a Command Line ............... 201

6

Table of Contents

List of Tables

Table 1. Database Server Requirements .............................................................................. 11Table 2. InputAccel Server Requirements............................................................................ 13Table 3. InputAccel Web Components and ClickOnce Host Requirements ............................ 15Table 4. Common Client Module Requirements .................................................................. 17Table 5. Module-specific Requirements .............................................................................. 19Table 6. Scanning Machine Requirements ........................................................................... 24Table 7. Planning Considerations for an InputAccel Installation ........................................... 25Table 8. Security Considerations for an InputAccel Installation ............................................ 38Table 9. High Availability and Failover Technologies Used in InputAccel ............................. 46Table 10. Production Installation Configurations of an InputAccel System.............................. 52Table 11. Development or Demonstration Installation ........................................................... 53Table 12. Globalization and UI Language Settings for InputAccel Components....................... 69Table 13. Production Installation of an InputAccel System..................................................... 74Table 14. InputAccel Installation Command Line Arguments ................................................ 98Table 15. InputAccel Client Upgrade Compatibility ............................................................ 109Table 16. Irreplaceable InputAccel Files and Data ............................................................... 112Table 17. Automatic Backup Locations during an Upgrade.................................................. 115Table 18. Client Module Upgrade Issues ............................................................................ 119Table 19. Common Installation Problems ........................................................................... 154Table 20. Common Installation Problems ........................................................................... 156Table 21. Common Database-Related Problems .................................................................. 158Table 22. Other Problems during InputAccel Setup ............................................................. 160Table 23. InputAccel Modules ........................................................................................... 168Table 24. Languages Supported in InputAccel .................................................................... 177Table 25. Ports Used ......................................................................................................... 179Table 26. Explanation of Command-line Arguments used to Install the Create

Database Utility.............................................................................................. 182Table 27. Supported InstallShield Switches......................................................................... 183Table 28. Supported InputAccel Database Installer Properties.............................................. 185Table 29. Supported InputAccel Server Installer Properties.................................................. 188Table 30. Supported InputAccel Server Installation Features................................................ 191Table 31. Supported InputAccel Web Component Installer Properties .................................. 193Table 32. Supported InputAccel Client Components Installer Properties .............................. 196Table 33. Supported InputAccel Client Components Installation Features ............................ 198

7

Table of Contents

8

Chapter 1InputAccel Overview

This guide explains how to install an InputAccel document capture system. This section provides aquick overview intended for those who actually install InputAccel. For a comprehensive descriptionof how InputAccel works, refer to the System Overview Guide.

InputAccel is a client/server document capture system that can capture documents from scanners,fax servers, email servers, and file systems. In addition, InputAccel can capture documents fromthird-party systems using web services. InputAccel is optimized for capturing documents, not storingthem for long-term access. Typically, documents remain in an InputAccel system for a few hours to afew days, until they are exported to a content repository or other back-end system.

InputAccel is modular and scalable; therefore, installation complexity depends on the businessrequirements of each organization. Various system configuration examples are provided in SampleProduction Installation Configurations, page 51. Different InputAccel components have differenthardware and software requirements, as explained in detail in Chapter 2, System Requirements andRecommendations. All installations require an InputAccel Database hosted by Microsoft SQL Server,as well as the InputAccel Administration Console web application installed on a server runningMicrosoft Internet Information Services (IIS).

Installing InputAccel requires proceeding logically through several phases. The following is a brieflist of general installation steps. For detailed installation planning, refer to Chapter 3, InstallationPlanning.• InputAccel Database: Required component. Only Microsoft SQL Server is supported. Workflowand configuration settings are stored in the database. Install one instance of the InputAccelDatabase on a machine running Microsoft SQL Server.

• InputAccel Server: Required component. The InputAccel Server is the workflow server thatmanages and distributes tasks to the client processing modules. Install at least one instance;more for a ScaleServer or cluster configuration.

• Administration Console: Required component. This component is hosted by IIS and is required toperform InputAccel system administration. Install one instance.

• InputAccel Remoting: Optional component. This component is hosted by IIS and required tosupport remote operators connecting to the InputAccel system over the Internet. Install oneinstance only if supporting operators that are connecting from a remote location over the Internet.

• InputAccel clients: Install specific client modules on attended and unattended machines. Installmultiple instances of modules that are identified as potential bottlenecks. Most unattendedmodules can optionally run as services. Certain attended modules can be deployed by ClickOnceand configured to connect by HTTP.

9

InputAccel Overview

• InputAccel Web Services subsystem: Optional component. Install if using InputAccel as a webservices provider or requester.

• ClickOnce deployment: Optional component. Hosted on IIS or available through a file share.Deploy certain attended modules to local or remote operators. Installed as part of the clientinstallation phase. Configure after installation is complete.

Related Topics —

Chapter 2, System Requirements and RecommendationsChapter 3, Installation PlanningChapter 5, Upgrading InputAccel

10

Chapter 2System Requirements andRecommendations

This chapter includes the following sections outlining the system requirements and recommendationsfor running InputAccel components:

• Database Server Requirements, page 11

• InputAccel Server Requirements, page 13

• InputAccel Web Components and ClickOnce Host Requirements, page 14

• Client Machine Requirements, page 17

• Scanning Workstation Requirements, page 24

Database Server RequirementsThis section lists the system requirements and recommendations for the machine running theInputAccel Database.

Table 1. Database Server Requirements

Item Recommended Minimum

Hardware requirements

CPU 2.0 GHz Pentium (orcompatible) 2 cores

2.0 GHz Pentium (orcompatible) 2 cores

Hard drive 10 GB Free 10 GB Free

RAM 4 GB – 8 GB 2 GB

DVD-ROM Optional Optional

Network card Platform compatible withTCP/IP with transmission rateof 1000 MBit/sec

Platform compatible withTCP/IP with transmission rateof 100 MBit/sec

Display 1024 x 768, 256 colors 1024 x 768, 256 colors

11

System Requirements and Recommendations


Software requirements

Operating system • Windows Server 2008 R2- Standard, Datacenter, orEnterprise edition (64-bit)

• Windows Server 2008 SP1orSP2 - Standard, Datacenter,or Enterprise edition (64-bit)

• Windows Server 2003 SP2,R2, or R2 SP2 - Standard,Datacenter or Enterpriseedition (64-bit)

Note: Windows 7, WindowsXP Professional, and WindowsVista, while supported, are notrecommended for medium tohigh volume deployments.

• Windows Server 2008 R2- Standard, Datacenter, orEnterprise edition (64-bit)

• Windows Server 2008 SP1, orSP2 - Standard, Datacenter,and Enterprise edition(32-bit)

• Windows Server 2003 SP2,R2, or R2 SP2 - Standard,Datacenter, or Enterpriseedition (64/32-bit)

• Windows 7 - Professional,Enterprise, or Ultimateedition (64/32-bit)

• Windows XP ProfessionalSP2 or SP3 (64/32-bit)

• Windows Vista, WindowsVista SP1 or SP2 -Enterprise or Businessedition (64/32-bit) or SP2 -Enterprise, Business, andUltimate edition (64/32-bit)

SQL Server • Microsoft SQL Server 2008R2 - (64/32-bit)

• Microsoft SQL Server 2008or 2008 SP1 - (64/32-bit)

• Microsoft SQL Server 2005SP1, SP2, or SP3 - (64/32-bit)

• Microsoft SQL Server 2008R2 Express - (64/32-bit)

• Microsoft SQL ServerExpress 2008 or 2008 SP1 -(64/32-bit)

• Microsoft SQL ServerExpress 2005 SP1, SP2, orSP3 - (64/32-bit)

Note: Due to limitations(documented in DatabaseServer Considerations, page27), use SQL Server Expresseditions only for low pagevolume deployments and withminimal reporting and logging.

12


Related Topics —

Database Server Considerations, page 27Installing the InputAccel Database, page 54

InputAccel Server RequirementsThis section lists the system requirements and recommendations for the machine running theInputAccel Server.

Table 2. InputAccel Server Requirements

Item Recommended Minimum1


CPU 2.0 GHz Pentium (orcompatible) 4 or more cores

2.0 GHz Pentium (orcompatible) 2 cores


RAM 4 GB 2 GB







• Windows Server 2008 SP1, orSP2 - Standard, Datacenter,or Enterprise edition (64-bit)



• Windows Server 2008 SP1, orSP2 - Standard, Datacenter,or Enterprise edition (32-bit)

• Windows Server 2003 SP2,R2, or R2 SP2 - Standard,Datacenter, or Enterpriseedition (32-bit)

1. Use only in low volume deployment.

13


Item Recommended Minimum1

Operating system (continued) Note:• Windows 7, Windows XPProfessional, and WindowsVista, while supported,are not recommended formedium to high volumedeployments.

• Datacenter or Enterpriseeditions of Windows Server2008 R2, Windows Server2008, or Windows Server2003 R2 are required forsetting up InputAccelServers in a Microsoftclustered environment.

• Windows 7 - Professional,Enterprise, or Ultimateedition (64/32-bit)

• Windows XP ProfessionalSP2 or SP3 (64/32-bit)

• Windows Vista, WindowsVista SP1 or SP2 -Enterprise and Businessedition (64/32-bit) or SP2- Enterprise, Business, orUltimate edition (64/32-bit)

Note: Datacenter or Enterpriseeditions of Windows Server2008 R2, Windows Server2008, or Windows Server2003 R2 are required forsetting up InputAccel Serversin a Microsoft clusteredenvironment.

Additional software Adobe Reader: Required toview documentation that is inPDF format.

Adobe Reader: Required toview documentation that is inPDF format.

Note:• 64-bit edition is required to enable the InputAccel Server to use up to 4 GB RAM

• On a 64-bit operating system, InputAccel functions as a 32-bit application usingWindows-on-Windows 64-bit (WOW64). Refer to the Microsoft website for details about WOW64.

Related Topics —

InputAccel Server Considerations, page 29InputAccel Server Scalability, page 36Installing the InputAccel Server, page 57Upgrading the InputAccel Server, page 133ScaleServer Issues, page 159

InputAccel Web Components and ClickOnceHost RequirementsThis section lists the system requirements and recommendations for the machine running theInputAccel web components and the machine hosting the ClickOnce packages. InputAccel webcomponents include Administration Console and InputAccel Remoting.

14

http://www.microsoft.com/


Caution: Administration Console and InputAccel Remoting must not be installed on the samemachine. Also, InputAccel Remoting can only be installed on a web server that has IIS 6.0,IIS 7.0, or IIS 7.5 installed.

Table 3. InputAccel Web Components and ClickOnce Host Requirements



CPU 2.0 GHz Pentium 2.0 GHz Pentium (or compatible)


RAM 1 GB 512 MB


Network card Platform compatible with TCP/IPwith transmission rate of 1000MBit/sec

Platform compatible with TCP/IPwith transmission rate of 100MBit/sec




• Windows Server 2008 SP1, orSP2 - Standard, Datacenter, orEnterprise edition (64-bit)

• Windows Server 2003 SP2, R2, orR2 SP2 - Standard, Datacenter orEnterprise edition (64-bit)

• Windows 7 - Professional,Enterprise, or Ultimate edition(64-bit)

• Windows XP Professional SP2 orSP3 (64-bit)

• Windows Vista, Windows VistaSP1 or SP2 - Enterprise orBusiness edition (64-bit), andWindows Vista SP 2 - Enterprise,Business, or Ultimate edition64-bit)


• Windows Server 2008 SP1, orSP2 - Standard, Datacenter, orEnterprise edition (32-bit)

• Windows Server 2003 SP2, R2, orR2 SP2 - Standard, Datacenter, orEnterprise edition (32-bit)

• Windows 7 - Professional,Enterprise, or Ultimate edition(32-bit)

• Windows XP Professional SP2 orSP3 (32-bit)

• Windows Vista, Windows VistaSP1 or SP2 - Enterprise orBusiness edition (32-bit) or SP2 -Enterprise, Business, or Ultimateedition (32-bit)

15



Web server • IIS 7.5 (with Windows Server2008 R2 or Windows 7)

• IIS 7.0 (withWindows Server 2008orWindows Vista): Make sure IIS6.0 Management Compatibility isrun before installing InputAccelWeb Components.

• IIS 6.0 (with Windows Server2003)

• Internet Information Services(IIS) 5.1 (with Windows XPProfessional)

Note:• Make sure IIS isolation mode isdisabled to enable applicationpooling.

• It is recommended not to installIIS on a Domain Controller.

• IIS 7.5 (with Windows Server2008 R2 or Windows 7)

• IIS 7.0 (with Windows Server2008 or Windows Vista): Makesure IIS 6.0 ManagementCompatibility is run beforeinstalling InputAccel WebComponents.

• IIS 6.0 (with Windows Server2003)

• Internet Information Services(IIS) 5.1 (with Windows XPProfessional)

Note:• Make sure IIS isolation mode isdisabled to enable applicationpooling.

• It is recommended not to installIIS on a Domain Controller.

Additional software • Microsoft .NET [Framework] 3.5

• Microsoft ASP .NET (must beregistered)

• Microsoft .NET [Framework] 3.5

• Microsoft ASP .NET (must beregistered)

AdministrationConsole

web-based module

• Microsoft Internet Explorer 7.0 or8.0.

• Adobe Reader must be installedon the same machine usedto connect to AdministrationConsole to view and save reportsin PDF format.

• Microsoft Internet Explorer 7.0or 8.0.

• Adobe Reader must be installedon the same machine usedto connect to AdministrationConsole to view and save reportsin PDF format.

Note: On a 64-bit operating system, InputAccel functions as a 32-bit application usingWindows-on-Windows 64-bit (WOW64). Refer to the Microsoft website for details about WOW64.

Related Topics —

Chapter 3, Installation PlanningInstalling the Administration Console, page 59Administration Console Host System Considerations, page 30ClickOnce Host System Considerations, page 30InputAccel Remoting Server Considerations, page 31Installing InputAccel Remoting, page 89

16



Client Machine RequirementsThis section lists the hardware and software requirements and recommendations that are commonfor all client machines running InputAccel client modules. It also lists specific requirements forspecific InputAccel client modules.

Topics in this section include:• Common Requirements for All Client Modules, page 17

• Module-Specific Requirements, page 19

Common Requirements for All Client Modules

This section lists the common system requirements for all InputAccel client modules.

Table 4. Common Client Module Requirements



CPU CPU-intensive tasks such asscanning, image enhancement,and optical characterrecognition:

• Dedicated 2.0 GHz Pentium(or compatible), 2 cores.

Less CPU-intensive taskssuch as exporting, indexing,image quality assurance, dataverification and validation, andInputAccel administration:• 2.0 GHz Pentium (orcompatible).

2.0 GHz Pentium (orcompatible)

Hard drive 2 GB free 2 GB free





17



RAM • Windows Server 2008 R2: 3GB

• Windows Server 2008: 3 GB


• Windows 7: 3 GB

• Windows Vista: 3 GB

• Windows XP Professional: 1GB

• Windows Server 2008 R2: 2GB



• Windows 7: 2 GB

• Windows Vista: 2 GB

• Windows XP Professional:512 MB



• Windows Server 2008 SP1 orSP2 - Standard, Datacenter,or Enterprise edition (64-bit)


• Windows 7 - Professional,Enterprise, or Ultimateedition (64-bit)

• Windows XP ProfessionalSP2 or SP3 (64-bit)

• Windows Vista, WindowsVista SP1 or SP2 - Enterpriseor Business edition (64-bit),and Windows Vista SP 2- Enterprise, Business orUltimate edition (64-bit)


• Windows Server 2008 SP1 orSP2 - Standard, Datacenter,or Enterprise edition (32-bit)

• Windows Server 2003 SP2,R2, or R2 SP2 - Standard,Datacenter, or Enterpriseedition (32-bit)

• Windows 7 - Professional,Enterprise, or Ultimateedition (32-bit)

• Windows XP ProfessionalSP2 or SP3 (32-bit)

• Windows Vista, WindowsVista SP1 or SP2 - Enterpriseor Business edition (32-bit)or SP2 - Enterprise, Business,or Ultimate edition (32-bit)

Additional software Adobe Reader: Required toview documentation that is inPDF format.

Adobe Reader: Required toview documentation that is inPDF format.

Note: On a 64-bit operating system, InputAccel functions as a 32-bit application usingWindows-on-Windows 64-bit (WOW64). Refer to the Microsoft website for details about WOW64.

18



Related Topics —

Client Machine Considerations, page 32Client Scalability, page 37Installing the InputAccel Client Components, page 65Upgrading Client Modules, page 136

Module-Specific Requirements

This section lists the additional requirements for specific InputAccel client modules. Theserequirements and the Common Requirements for All Client Modules, page 17 are required beforeinstalling these client modules.

Table 5. Module-specific Requirements

Module MicrosoftInternetExplorer

Additional Requirements

.NET Code Module - • Microsoft Visual Studio 2008, Microsoft VisualStudio 2005, Microsoft Visual Studio 2008Express, or Microsoft Visual Studio 2005 ExpressSee footnote.

• Microsoft .NET [Framework] 3.5

ApplicationXtender Export - • EMC ApplicationXtender 6.0 or 6.5

• EMC ApplicationXtender Workflow Manager6.0 or 6.5

• EMC ApplicationXtender Workflow Server 6.0

Archive Export - • SAP ERP Central Component (ECC) 5.0

• ECC 6.00 / SAP NetWeaver 7.0

eCopy Connector - eCopy ShareScan 4.2

FileNet Content ManagerExport

- • IBM FileNet P8 Content Manager 3.5, 4.0.1, or 4.5

• IBM FileNet Enterprise Manager

Note: Verify the compatible FileNet EnterpriseManager release with IBM support.

FileNet Panagon IS/CS Export - • IBM FileNet Panagon Content Services 5.5

• IBM FileNet Panagon Image Services 4.1 or 4.0.5

Global 360 Export - Execute360 10.0 or 9.2.1

19




Documentum AdvancedExport

- • EMC Documentum Content Server 6.0 SP1, 6.5,6.5 SP1/SP2/SP3, or 6.6

• EMC Documentum Foundation Classes (DFC)6.5 or 6.0 SP1 run time environments:— Install the DFC hotfix if it is exists for theversion that is installed to use the Usewindows login option during DocumentumAdvanced Export setup.

— DFC uses the C:\Documentum directoryto store client data. The Documentumadministrator must grant write permissionsfor this directory to Documentum AdvancedExport operators.

— DFC creates a unique “dmcl” directorywherethe module or client-side script is running.Members of non-administrator groups needwrite permissions to this directory and itssubdirectories for DFC to work correctly.The Documentum administrator must grantmodule operators write permissions to eachinstance of the dmcl directory.

• Visual Studio 2008, Visual Studio 2005, VisualStudio 2008 Express, or Visual Studio 2005Express (recommended to write scripts) Seefootnote.

IBM CSSAP Export - IBM DB2 Content Manager CommonStore for SAP8.3

IBM CMIP-390 Export - IBM DB2 Content Manager ImagePlus for z/OS(OS/390) 3.1

IBM CM Advanced Export - Requires one of the following:• IBM DB2 Content Manager for z/OS® 8.3 SP5,8.4.1, or 8.4.2

• IBM DB2 Content Manager for z/OS 8.3 clientwith IBM DB2 Content Manager for z/OS 8.4server

• IBM DB2 Content Manager for iSeries 5.3 V5r1

20




Image Converter 7.0 or 8.0:To processHTMLdocuments

Microsoft Office 2003 or 2007: To process MicrosoftOffice documents

IndexPlus 6.0, 7.0, and8.0

• Visual Studio 2008, Visual Studio 2005, VisualStudio 2008 Express, or Visual Studio 2005Express (recommended to write scripts)

• Adobe Reader: To view PDF files in the ImageView pane

• Microsoft Excel: To view XLS files in the ImageView pane

The ODBC functions that are accessed through theLegacyValidation script are compatible withthe databases listed for the ODBC Export module.

MS SharePoint Export - Requires one of the following:• Microsoft Office SharePoint Portal Server 2003SP1, SP2 or SP3

• Microsoft Office SharePoint Server 2007 or 2010

NuanceOCR - Visual Studio 2008, Visual Studio 2005, VisualStudio 2008 Express, or Visual Studio 2005 Express(recommended to write scripts) See footnote.

ODBC Export - Supports the following databases:• Oracle 11g

• Oracle 10g

• IBM - DB2 9.5

• Microsoft SQL Server 2000 SP4

• SQL Server 2008 R2

• SQL Server Express 2008 R2

• SQL Server 2008 or 2008 SP1

• SQL Server Express 2008 or 2008 SP1

• SQL Server 2005 SP1, SP2, or SP3

• SQL Server Express 2005 SP1, SP2, or SP3

21




Open Text Livelink AdvancedExport

- Connects to Livelink Server 9.5, 9.7, or 9.7.1

RescanPlus 6.0, 7.0, or8.0

• Visual Studio 2008, Visual Studio 2005, VisualStudio 2008 Express, or Visual Studio 2005Express (recommended to write scripts) Seefootnote.



ScanPlus 6.0, 7.0 and8.0

• Visual Studio 2008, Visual Studio 2005, VisualStudio 2008 Express, or Visual Studio 2005Express (recommended to write scripts) 2



Values to XML 6.0, 7.0, or8.0

-

Related Topics —

Chapter 3, Installation PlanningCommon Requirements for All Client Modules, page 17Appendix B, InputAccel Client ModulesInstalling the InputAccel Client Components, page 65Upgrading Client Modules, page 136

2. Visual Studio Express has limited capabilities with some tasks such as debugging. Refer to Microsoft documentation for acomplete list of limitations. If you intend to create a lot of custom .NET code for InputAccel, EMC recommends developingit with Visual Studio Professional or Visual Studio Standard.

22


CompatibilityInputAccel is compatible with the following:• VMware support: InputAccel can be run within the following VMware products:

— VMware Workstation 6.5, 6.5.1, 7.0

— VMware Server 1.0 or 2.0

— VMware ESX Server 3.5, 4.0, and 5.0

— VMware VMotion (enabling VMotion is transparent to InputAccel components)

• Microsoft Hyper-V Server support: InputAccel can be run in a Microsoft Hyper-V Serverenvironment on Windows Server 2008 R2, SP1, and SP2 - Standard, Datacenter, and Enterpriseedition (64/32-bit)

• Citrix support: InputAccel client components are compatible with the following Citrix products:

— Citrix MetaFrame Presentation Server 4.5

— Citrix XenApp 5.0

— Citrix XenApp Feature Pack 5.0

— Citrix Web Interface 3.0 or 4.5

— Citrix Client 10.0

Typically customers use Citrix to host IndexPlus for a large group of index operators.

• IPv6: InputAccel supports Internet Protocol version 6 (IPv6) and version 4 (IPv4).— InputAccel Servers and clients: IPv6 and IPv4 is supported on all the operating systemsthat InputAccel Server and clients can be installed on. (IPv6 protocol must be installed forWindows Server 2003 and Windows XP.)

Additional information for installing the IPv6 protocol for Windows Server 2003 and Windows XPcan be found on the Microsoft TechNet website.

Note: When installing the Administration Console in an IPv6 environment, do not specify aspecific IP address. You must select (All Unassigned) in the IP address to use for this web sitefield in the InputAccel Web Components setup window.

• Section 508: InputAccel adheres to Section 508 of the Disabilities Act. For additional informationon compliance standards, you can request the InputAccel 6.0 Voluntary Product AccessibilityTemplate (VPAT) through EMC Support Services.

• The Federal Information Processing Standard (FIPS) provides the best practices for implementingcryptographic software. The InputAccel Server is designed to operate with Microsoft operatingsystems that use FIPS-compliant algorithms for encryption, hashing, and signing.

Related Topics —

Chapter 2, System Requirements and RecommendationsChapter 3, Installation PlanningChapter 5, Upgrading InputAccel

23


Scanning Workstation RequirementsIn addition to the standard software and hardware required for all InputAccel client modules, thereare additional system requirements for a scanning workstation. The throughput of the scanningdevice that is used with InputAccel should be taken into account when matching it to the hostScanPlus client. EMC recommends using these guidelines for minimum hardware requirementsfor the system.

Note: For information about supported scanners and SCSI adapters, refer towww.scannerdrivers.com.

Table 6. Scanning Machine Requirements

ISIS Driver Level Throughput (IPM,images per minute)

Minimum PentiumCPU

Minimum RAM

Level 1 Up to 20 IPM (binary) 300 MHz 64 MB

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


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


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


Level 4 Up to 100 IPM (color) 2.4 GHz 512 MB

Related Topics —

Chapter 3, Installation PlanningCommon Requirements for All Client Modules, page 17

24

https://www.scannerdrivers.com/index.asp

Chapter 3Installation Planning

A successful InputAccel installation depends on having a good installation plan. There are severalconsiderations to understand before installing InputAccel. Topics in this section include:• General Considerations, page 25

• Sample Production Installation Configurations, page 51

General ConsiderationsCarefully planning an InputAccel installation requires attention to many aspects, including:hardware, software, locale, networking, security, system availability, backup, recovery, and more. Thefollowing table summarizes many of these issues and directs you to more information.

Table 7. Planning Considerations for an InputAccel Installation

Item Planning activity

Localeconsiderations

Carefully consider the locale and code page requirements of all InputAccelcomponents. This is especially important in a distributed capture system. (LocaleConsiderations, page 26)

Performance An enterprise document capture system should be able to keep up not only withthe data coming into the system, but also the data being processed through thesystem. (Performance and Throughput, page 27.)

Scalability Decide whether to install the entire system at once or start with a small system andthen expand. InputAccel supports both server and client scalability. (Scalability,page 36.)

Security Carefully consider the security implementation. The plan should cover thesecurity providers relative to local and remote administrators, local and remoteoperators, the SQL Server that hosts the InputAccel Database, and security withinIIS and Internet Explorer. (Security, page 38.)

Networkconfiguration

Determine how InputAccel fits into your network topology. InputAccel canbe deployed to a single domain, multiple domains, or to a single, standalonemachine. (Installing InputAccel across Multiple Domains, page 45.)

25

Installation Planning

Item Planning activity

Highavailabilityand failover

Perform an appropriate level of planning to keep your document capture systemonline and productive at all times. This might be as simple as an extra InputAccelServer configured as part of a ScaleServer group to provide load balancing, or ascomplex as configuring a Microsoft Cluster Service (MSCS) cluster sharing aStorage Area Network (SAN) to provide an automated response to hardwarefailures. (High Availability and Failover, page 46.)

Disasterrecovery

Prepare a disaster plan with attention to restoring your document captureoperation and keeping the organization productive after various types ofdisasters. This may be as simple as routine backups with offsite storage or ascomplex as multiple MSCS clusters in both local and remote locations withreplicated Storage Area Networks to provide an automated response to hardwarefailures. This provides ongoing and uninterrupted production at all times.(Disaster Planning, page 47.)

Licensing andactivation

EMC offers many different licensing plans to meet the needs of different typesof customers. Obtain license codes for each InputAccel Server and use either ahardware security key attached to each of your InputAccel Servers or a softwareactivation file issued by EMC. (Licensing and Activation, page 49.)

Compatibility Consider the various technologies you can use when deploying InputAccel.InputAccel is designed and tested for VMware support, Citrix Delivery Centercompatibility, support for IPv6 and IPv4, and support for assistive technologyaccording to the requirements of Section 508 of the Rehabilitation Act of 1973.(Compatibility, page 23.)

Locale Considerations

InputAccel supports multiple languages within an InputAccel deployment, thereby enabling globaldocument processing. Multiple language support enables InputAccel batches and tasks to processdata in multiple languages and use multiple locale settings. Refer to the Administration Guide tounderstand the multiple language feature in InputAccel.

Locale considerations that are important before you install:

• User-specified information entered in the InputAccel setup program must only include valuesfrom the code page of the machine running the installer. Non-code page values will result indata corruption.

• On machines running client modules and the InputAccel Server, the language specified by thelocale setting must be supported by the code page selected on that machine.

• For generating reports with characters in the supported languages (except Russian, Chinese, orKorean), set the language of the Administration Console web browser to the language required tobe displayed in the report.


26


• For generating reports with Russian, Chinese, or Korean characters, you must use the followingsettings:— The Region and Language settings on the Administration Console Web Server machineand the Administration Console web browser machine (format, language, keyboard andlanguages, and administration information settings) must be set to Russian (for reports withRussian characters), Chinese (for reports with Chinese characters), or Korean (for reportswith Korean characters).

— Administration Console web browser language must be set to Russian (for reports withRussian characters), Chinese (for reports with Chinese characters), or Korean (for reportswith Korean characters).

• On Windows XP and Windows Server 2003 machines running client modules that process EastAsian characters (for example, Chinese and Korean), you must make sure the fonts for East Asianlanguages is installed to enable proper rendering of these characters.

Performance and Throughput

Maximizing performance and throughput are key objectives when designing an InputAccel system.Many factors affect performance and throughput, but at the top of the list are the server processors,their disk systems, and the network to which they connect. This is the InputAccel infrastructure andgood infrastructure planning results in taking full advantage of InputAccel modularity.

InputAccel modularity enables you to adjust the InputAccel configuration to meet production needsafter observing the system in production mode for a period of time. Add more modules, moremachines, more InputAccel Servers, and more operators as needed to meet your production goals.

To maximize the performance and throughput at all points in the InputAccel system, consider each ofthe following components individually:

• Database Server Considerations, page 27.

• InputAccel Server Considerations, page 29.

• Administration Console Host System Considerations, page 30.

• ClickOnce Host System Considerations, page 30.

• InputAccel Remoting Server Considerations, page 31.

• Web Services Subsystem Considerations, page 32.

• Client Machine Considerations, page 32.

Database Server Considerations

Every InputAccel installation requires a single InputAccel Database. In a ScaleServer environmentonly one database is allowed.

The machine that hosts the InputAccel Database must service queries and store batch and task datafrom each InputAccel Server, each client module, and each running instance of the AdministrationConsole. In addition, it must process every transaction related to reporting and logging, and storethese results until they are purged, either by a manual or scheduled job.

27


In high volume environments, install the InputAccel Database server on a fast multi-CPU machinewith as much RAM as the operating system supports. Consider using a 64-bit operating system toprovide access to additional memory. (32-bit Windows limits usable memory to 3 GB.)

When Database storage requirements become very large, due to process volumes and enabledlogging and reporting rules, high throughput becomes critical to maintaining production volumes.Choose the latest high-speed technology from among available disk storage systems. The networkconnection between the InputAccel Server and the InputAccel Database must have high bandwidth(about 1 GB per second) and low latency. For the InputAccel Database data directory, configuremultiple identical disk drives in a RAID configuration to achieve the required reliability and failureprotection. Use trusted and reliable disk drives with high performance and high capacity ratings.Connect the drives to disk controllers that provide hardware-level support for RAID 0+1 or RAID1+0. (RAID 0+1 and RAID 1+0 are recommended, RAID 0 is also acceptable, and the minimumrequirement is for RAID 5.) In addition, the disk drives should have on-board disk caching of at least32 MB, write-back caching (write to RAM), read-ahead optimization, and battery backup for theon-board cache. Disk controllers that are integrated into motherboards typically do not provide thefeatures, performance, or reliability that an enterprise platform demands.

Additional considerations when setting up the InputAccel Database:• Make sure that the SQL Server that hosts the InputAccel Database has sufficient connectionsavailable to accommodate your InputAccel system. Each InputAccel Server, AdministrationConsole web server, client module, and web service instance consumes one connection.

• In a typical deployment, only a small amount of processing time is consumed interacting with theInputAccel Server and clients. Reports that issue complex queries put a much greater load on thedatabase. An InputAccel installation has only one InputAccel Database instance; therefore, toincrease database performance, increase the performance of the server that hosts the InputAccelDatabase. You cannot increase performance by adding more instances of the InputAccel Database.

• If SQL Server has the necessary performance, then multiple InputAccel Databases (each with adifferent name) can be installed on a single instance of SQL Server. However, each InputAccelServer requires only one InputAccel Database. If you have multiple, independent InputAccelServers, then they can share the same InputAccel Database, or they can have independentInputAccel Database.

• The machine hosting the InputAccel Database should have the highest-speed network connectionwith low latency available to ensure maximum throughput.

• A ScaleServer group can have a single InputAccel Database. All InputAccel Servers within theScaleServer group must access the same InputAccel Database. Within an InputAccel deployment,independent InputAccel Servers not configured as a ScaleServer group may access the sameInputAccel Database or separate InputAccel Databases based on business requirements.

• Multiple InputAccel deployments that are completely separate and should be kept separate,require separate InputAccel Databases.

• The amount of data written to the InputAccel Database is related to the logging and reportingconfiguration. Enabling Audit Logging and Reporting writes significant amounts of data tothe InputAccel Database.

• By default,SQL Server Express does not accept connections over the TCP/IP protocol. EnableTCP/IP connections before installing the InputAccel Database. In SQL Server ConfigurationManager, SQL Server Express must be configured to allow TCP/IP protocol access over port 1433.Enable TCP/IP protocol for each IP address used by the system, make sure that TCP Port field is

28


blank, and then restart the SQL Server Express service. Connection errors can occur if SQL ServerExpress is not configured to allow for TCP/IP access.

• SQL Server Express editions must only be used in low page volume deployments with minimalreporting and logging due to the following limitations:— Databases are limited to a maximum of 4 GB. When the database reaches this size, you mustmanually purge batches and other data before you can continue to use InputAccel.

— 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 multipleCPUs, SQL Server Express uses only one from those available.

— By default, SQL Server Express creates a named instance. Named instances require specifyingthe instance name in all database connection strings. To avoid this issue, create an unnamedinstance during SQL Server Express installation.

— Microsoft SQL Server Management Studio Express is not automatically installed with allversions of SQL Server Express, but it is available as a separate installation from Microsoft.

Related Topics —

Chapter 3, Installation PlanningDatabase Server Requirements, page 11Installing the InputAccel Database, page 54Database Issues, page 158

InputAccel Server Considerations

The InputAccel Server is memory intensive. The server stores multiple copies of each processedimage, often one or more for each step in a process. Also, the image data being processed requiressignificant processing and space on the server. For this reason, there are some important factors toconsider related to the InputAccel Server.

• Use high-speed dual or quad-core machines with 32- or 64-bit operating systems. More availablememory enables the InputAccel Server to handle higher volumes more efficiently.

• Even though the InputAccel Server is a 32-bit application, we strongly recommend installing itunder 64-bit Windows where it can access the full 32-bit memory space (4 GB). Under 32-bitWindows, maximum memory is limited to 3 GB, no matter how much physical memory isavailable.

• Use the same performance considerations as for the InputAccel Database (described in DatabaseServer Considerations, page 27) for selecting a network connection and a disk system for theInputAccel Server data directory (C:\IAS by default). Also, do not locate the InputAccel Serverdata directory and the Windows paging file on the same physical disk drive.

• Another option for improving performance is to install multiple InputAccel Server instances asdescribed in Installing Multiple Instances of InputAccel Servers, page 76. Each InputAccel Serverinstance should have 4 GB RAM and should have its data directory on a separate disk drive.

• The InputAccel 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 InputAccel Server main directory can be located on a non-NTFS file system, such

29


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.

• Be aware that even though the InputAccel Server will run under a VMware ESX Server, doing sowill degrade the InputAccel Server performance by approximately 20%.

Caution: The machine name of the InputAccel Server must not be longer than 15 bytes;otherwise, client machines will be unable to connect.

Related Topics —

InputAccel Server Requirements, page 13Installing the InputAccel Server, page 57Upgrading the InputAccel Server, page 133ScaleServer Issues, page 159

Administration Console Host System Considerations

The Administration Console is hosted by IIS and has a minimal performance impact. Unless thesystem that hosts the Administration Console is being shared with other InputAccel components, nospecial performance or throughput considerations are required for this machine.

Note:• Disable IIS isolation mode. This enables the use of the IIS application pool.

• Specify a unique port in the Administration Console setup program. The AdministrationConsole setup program checks for other ports already used by IIS; however, it does not checkother applications for port conflicts. If another application is using the port, the AdministrationConsole will not be accessible.

• The Administration Console and InputAccel Remoting must be installed on separate machines.

• It is recommended not to install IIS on a Domain Controller.

Related Topics —

InputAccel Web Components and ClickOnce Host Requirements, page 14Installing the Administration Console, page 59

ClickOnce Host System Considerations

Several InputAccel client modules can be distributed by using Microsoft ClickOnce deploymenttechnology. ClickOnce can be accomplished either by deploying applications from a file share orfrom an IIS web server. In either case, installations are relatively infrequent and have minimalperformance impact. Unless the system that hosts ClickOnce is being shared with other InputAccelcomponents that have special needs, no special performance or throughput considerations arerequired for this machine.

30


Before deploying modules using ClickOnce, ClickOnce publishing skills or a minimal understandingof ClickOnce technology is recommended. Be sure to read the articles about ClickOnce technologyavailable on the Microsoft MSDN website.

Note:• Command-line parameters (such as -department) cannot be specified when a module isdeployed by ClickOnce from a file share, because the shortcut icon does not reference an actualmodule that can accept command-line arguments. If operators must specify departments or othercommand-line arguments when starting modules, deploy the modules from an IIS web server.

• Due to the way ClickOnce-deployed modules are registered, they are unable to write completemodule information to the Windows Event Log. Therefore, message descriptions in the WindowsEvent Log will not exactly match messages displayed in the Administration Console.

Related Topics —

Chapter 3, Installation PlanningInstalling the Administration Console, page 59InputAccel Web Components and ClickOnce Host Requirements, page 14Installing InputAccel Remoting, page 89

InputAccel Remoting Server Considerations

To use distributed client machines that do not have direct access to the InputAccel network, set up anInputAccel Remoting server. This server enables remote client machines to use the Internet to connectand authenticate with an InputAccel system.

Note:• Publish ClickOnce modules on any server configured according to Microsoft ClickOncerequirements. As an option, consider ClickOnce publishing under the InputAccel Remotingwebsite. To do so, install an InputAccel Remoting website first, and then create a ClickOnceweb directory under it.

• Specify a unique port in the InputAccel Remoting setup program. The InputAccel Remoting setupprogram checks for other ports already used by IIS; however, it does not check other applicationsfor port conflicts. If another application is using the port, the InputAccel Remoting service willnot be accessible.

• Logging into a remote module that is connecting through the InputAccel Remoting host takesconsiderably longer than modules that are logging in locally, because in addition to authenticatingand authorizing the user, the module also downloads configuration information, client sidescripts, and processing information.

Caution: EMC recommends you disable application pool worker process recycling for the IISserver that is hosting InputAccel Remoting. By default, recycling is enabled and set to 29 hours.Remote operators will be disconnected from the InputAccel system and potentially lose data ifthe IIS instance that hosts InputAccel Remoting recycles its worker processes.

Related Topics —

Chapter 3, Installation Planning

31


Installing the Administration Console, page 59InputAccel Web Components and ClickOnce Host Requirements, page 14Installing InputAccel Remoting, page 89

Web Services Subsystem Considerations

To use the InputAccel Web Services subsystem, consider setting up one or more dedicated WebServices Hosting servers. A single server may be adequate; however, many enterprises have a need tohandle both internal and external web service requests and responses, and so you may want to haveone instance of Web Services Hosting openly accessible from the local network and another instanceaccessible from the Internet through a firewall.

A single instance of Web Services Coordinator handles requests from all instances of Web ServicesHosting. Web Services Coordinator communicates directly with the InputAccel Database, and shouldtherefore be installed on a secure server with a high-speed network connection to the InputAccelDatabase 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 Hostinginstance or may require a separate, dedicated machine.

Note: Although you can install multiple instances of Web Services Hosting, this component doesvery little processing. Typically the only reason to install multiple instances is to separate internalfrom external request/response traffic. In any case, an InputAccel system may have only one WebServices Coordinator instance.

Before attempting to use Web Services Input be sure that the Web Services Hosting and Web ServicesCoordinator services are started.

Related Topics —

Chapter 3, Installation PlanningInputAccel Remoting Server Considerations, page 31Installing InputAccel Remoting, page 89

Client Machine Considerations

InputAccel provides operator-attended client modules and unattended client modules. TheInputAccel Client setup program supports installation of any combination of InputAccel modules ona single machine. Use the information in Chapter 2, System Requirements and Recommendations, toconfigure your client machines.

It is recommended that the network connection between the InputAccel Server and the client moduleshave 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 taskswhenever they are received from the InputAccel Servers. Unattended modules are server-gradeapplications that should be installed on IT-managed servers and, if supported, run as Windowsservices. (Refer to Table 23, page 168 for a list of modules that run in unattended mode and that run

32


as services.) For unattended modules that run as services, no operator intervention is required. Whenrunning 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 tasksintermittently. Several modules using minimal processing power can be hosted by a single computerwithout 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 keepup with the number of tasks being generated for them. Modules of this type typically should havededicated computer with dual cores and, in some cases, multiple instances of a module may beneeded, each running on a separate computer.

To determine the actual number of module instances required, use client balancing to observe thesystem in typical production operation, find the bottlenecks, and add module instances until thethroughput is satisfactory. Client balancing and is accomplished by bringing one module instance online at a time until the average number of new tasks being generated for the module is less than thenumber of tasks being processed by all module instances.

Note: When performing client balancing, it may not be necessary to install multiple moduleinstances on separate physical machines. For example, if using high-performance, multiprocessormachine systems, you may be able to install multiple instances of a page recognition or imageprocessing module on one machine. Or install a combination of processor-intensive modules andnon-processor-intensive modules on one machine. Table 23, page 168 provides a list of modules thatcan run as services as well as modules for which multiple instances can be configured to run asservices on a single machine. Manually Registering a Client Module to Run as a Service, page 101explains how to configure modules that have already been installed to run as services.

For modules that support multiple services instances (as listed in Appendix B, InputAccel ClientModules), consider installing multiple instances on a single multi-core machine to achieve clientbalancing and scalability as needed. For modules that do not support multiple service instances,consider running multiple instances in separate virtual machines on the same physical, multi-coremachine. In all cases, you must ensure that the machine has sufficient processing capacity to runmultiple instances.

Related Topics —

Running Modules as Services, page 33Appendix B, InputAccel Client ModulesCommon Requirements for All Client Modules, page 17

Running Modules as Services

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 InputAccel Server

3. InputAccel permissions

33


Choosing a “run-as” accountYou can choose to run modules as services under a user account or under the Network Serviceaccount.

• User account: Modules connect to the InputAccel Server in the same way as if they were runningas applications—by authenticating with a specific domain user name and password. This is therecommended way to configure modules as services, because it simplifies configuration as wellas ongoing account maintenance.

Note: The user account under which modules run must be granted the “Log on as a service” userright. This right is granted automatically when the module is installed to run as a service under auser account and is updated automatically if the user account is changed through the WindowsService Control Manager. This right is managed in the User Rights Assignment branch of themachine’s Local Security Settings.

• Network Service account: InputAccel supports the use of the Network Service account in caseswhere customers cannot use a user account to run modules as services. There are multiple ways toconfigure a module running under Network Service to authenticate with the InputAccel Servermachine. We recommend that you enable and configure Kerberos authentication, as explained inConfiguring InputAccel to use Kerberos authentication, page 35

Note:— All modules that are installed during a single execution of the client setup program to run asservices 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 runas services under a user account are configured to use the same user name, password, anddomain name. (These settings can be changed later by using the Services application of theMicrosoft Management Console).

— User accounts must be domain accounts except when all InputAccel components are installedon a single machine. When all components are installed on a single machine, there are noissues with using the Network Service account, because the machine already has the ability tolog into itself.

Enabling the “run-as” account to log into the InputAccel ServerRegardless of whether a module runs under a user account or Network Service, that account musthave the ability to log into the InputAccel Server machine. This ability is automatically configuredwhen using a domain user account—members of the Domain\Users group are added to theInputAccel 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 theInputAccel Server (unless the module is running on the same machine as the InputAccel Server). Thisability 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 InputAccel Server machine.

34


Configuring InputAccel PermissionsUse the Administration Console to assign appropriate permissions to the group to which the useraccount belongs.

• If the module is running as a service under a user account, configuring permissions consists ofassigning one or more groups to one or more permission roles, possibly adding new roles ormodifying existing roles to provide the necessary permissions.

• If the module is running as a service under the Network Service account, configuring permissionsconsists of assigning the Network Service account to one or more permission roles, possiblyadding new roles or modifying existing roles to provide the necessary permissions. The onlydifference is that when adding the account to a role in the Select User or Group window, youmust add the machine account for the modules running under Network Service in the form ofdomain\machinename$.

Tip: Consider adding all such machine accounts to a domain group and then adding that group tothe role. This will simplify ongoing permissions maintenance of InputAccel modules runningas services under Network Service.

The Using Administration Console section in the Administration Guide provides more information aboutadding users and groups to permission roles.

Configuring InputAccel to use Kerberos authenticationTo configure authentication using Kerberos in your InputAccel system, Kerberos protocol must beenabled on both client and server machines, and the correct service principal name (SPN) must beset for the InputAccel Server.

Note:• Each InputAccel Server must have its own, unique SPN.

• The default SecurityPackage authentication setting for the InputAccel Server and allInputAccel clients is “Negotiate”. Kerberos authentication will work with this default setting.

To configure InputAccel to use Kerberos authentication:

1. On the client machine, set the SecurityPackage key in the settings.ini file to “Negotiate”or “Kerberos”.

2. On the InputAccel Server machine, set SecurityPackage to “Negotiate” or “Kerberos”.

Note: If any client machine is set to “Negotiate”, then the InputAccel Server must be set to“Negotiate”.

3. Set a service principal name (SPN) for the InputAccel Server by using the Microsoft Windowssetspn.exe utility program to set the InputAccel Server SPN as follows:setspn -A ServiceClass/Host:Port [AccountName]

where:• ServiceClass: Must be IAServer.

• Host: Fully qualified host name of the InputAccel Server machine. This can be afully-qualified DNS name or a NetBIOS name. Be aware that NetBIOS names are notguaranteed to be unique in a forest, so an SPN that contains a NetBIOS name may not beunique.

35


• Port: The port the InputAccel Server is listening on (default: 10099).

• AccountName: The optional Windows account used to run the InputAccel Server service.This is not required when a account such as Local Service is used to run the InputAccelServer service.

Examples —setspn -A IAServer/prodserver.bigcorp.com:10099setspn -A IAServer/prodserver.bigcorp.com:10099 Bob

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 InputAccel Server.

Related Topics —

Appendix B, InputAccel Client ModulesCommon Requirements for All Client Modules, page 17Installing the InputAccel Client Components, page 65

Scalability

The modularity that is built into InputAccel enables customers to configure and reconfigure theirInputAccel system to meet their changing needs. Both server and client subsystems of InputAccel aremodular and scalable.

Topics in this section include:• InputAccel Server Scalability, page 36

• Client Scalability, page 37

InputAccel Server Scalability

When the document capture workload exceeds the capabilities of a single InputAccel Server, scale upthe system by adding more InputAccel Servers and creating a ScaleServer group. A ScaleServer groupcombines multiple InputAccel Servers into a single information capture system. Both attended andunattended modules can connect to the servers in a ScaleServer group, after which they can receiveand process tasks from all connected servers. In addition to expanding the workload capacity over asingle InputAccel Server, ScaleServer groups can also help to ensure that client modules and theiroperators spend less idle time waiting for new tasks to arrive. Adjust the number of client modulesand InputAccel Servers to achieve the required balance of throughput. The ideal scenario is to haveenough server capacity to process as many incoming batches as necessary while having enough clientcapacity 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 InputAccel Servers inthe group simultaneously. Modules that are not ScaleServer compatible can connect to any oneInputAccel Server in the ScaleServer group at a time. (No module can connect to multiple arbitraryInputAccel Servers - only to multiple servers that have been configured as a ScaleServer group.)

36


Appendix B, InputAccel Client Modules provides a table of InputAccel client modules that indicateswhich modules are ScaleServer compatible.

Additional InputAccel Servers can be added to a ScaleServer group when the InputAccel system isinitially configured or at any later time. For more information on managing and licensing ScaleServergroups, refer to the Using Administration Console section in the Administration Guide. For instructionson installing a ScaleServer group, refer to Configuring Multiple InputAccel Servers as a ScaleServerGroup, page 78.

Note: A ScaleServer group is not a redundant or failover system. ScaleServer technology providesdata and process sharing as well as load balancing capabilities; it does not provide data redundancy.

The InputAccel Server is also scalable by virtue of its side-by-side installation capability. If usinghigh-end server hardware with multiple cores, take advantage of the additional processing powerby installing multiple side-by-side instances of the InputAccel Server. This configuration mayenable better parallel execution of batches when running on multi-processor machines. The actualperformance benefit depends on the task load and the types of tasks you are processing.

Side-by-side installation also enables multiple instances of the InputAccel Server to be installed in anActive/Active MSCS Cluster, as explained in High Availability and Failover, page 46.

Related Topics —

InputAccel Server Requirements, page 13Installing the InputAccel Server, page 57Upgrading the InputAccel Server, page 133ScaleServer Issues, page 159

Client Scalability

InputAccel client modules process tasks sent to them from InputAccel Servers. A task is a unit ofwork whose size is determined by the design of the process being used, and can be a single page,multiple pages, an entire document, or an entire batch (perhaps thousands of pages). InputAcceldesign enables multiple modules to simultaneously process different tasks from all in-processbatches. This means that production bottlenecks caused by slow modules can be resolved by addingmore instances of those modules. There are several factors to consider when planning the number ofeach module required:

• The volume of incoming paper that must be processed. For example, a high-speed scanner with askilled operator may be able to scan 20,000 pages per shift, but you may need to process 200,000pages per 24-hour period. InputAccel 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 requiresmuch more time to process a task (recognize a page of text) than an export module requires toexport the same page of text. InputAccel enables adding as many OCR modules as necessary tokeep up with the system workload.

• The amount of time an operator requires to process a task. For example, manual indexinginvolving many fields that must be manually keyed by an operator takes more time than simpleindexing tasks. Also, operator skill and other external factors affect the time required to process

37


each task. InputAccel enables adding as many IndexPlus machines as needed to keep up with theindexing workload.

Additional client modules can be added to the InputAccel system at any time after the initialinstallation without negatively impacting production. If using machines with multiple processors,multiple instances of certain modules can be installed as services on a single machine. AppendixB, InputAccel Client Modules provides a table of InputAccel client modules that indicates whichmodules may be installed and run as multiple service instances. Manually Registering a ClientModule to Run as a Service, page 101 explains how to install modules as services using theserviceName command-line argument.

Related Topics —

Appendix B, InputAccel Client ModulesCommon Requirements for All Client Modules, page 17

Security

Various security providers interact with InputAccel at various levels. Planning must includeconsiderations for security and how it affects and secures an InputAccel system.

The following table explains major security considerations.

Table 8. Security Considerations for an InputAccel Installation

Element Security considerations

SQL Server InputAccel supports only SQL Authentication. Therefore, SQL Server andWindows Authentication modemust be enabled in the SQL Server and a validSQL Server login ID is required to connect to the SQL Server that hosts theInputAccel Database.

A login ID having a SQL Server sysadmin role must be specified to create theInputAccel Database during the InputAccel Database installation.

InputAccelDatabase

The InputAccel Database must have the database role membership set to Public.InputAccel does not use user-based authentication or authorization for databaseaccess; therefore, there is no need to create database users and groups. Chooseany of the following options for database access:• Create a SQL Server user account with SQL Authentication enabled. Grantthe following permissions to the account: Connect, Delete, Execute, Insert,Select, and Update. Use this account to access the InputAccel Database. Thisis the recommended approach.

• Use the “sa” (system administrator) account. This is generally notrecommended, because it gives unrestricted access to the entire SQL Serverand all of the data it contains.

38



InputAccelServer

• The InputAccel Server supports the least-privileged user account (LUA)approach in which users, programs, and services are granted only theminimum rights required to carry out assigned tasks. Configuring LUAfor the InputAccel Server is done automatically by the InputAccel Serverinstallation program. If this setup needs to be repeated (for example, dueto the deletion of the special LUA group created by the setup program),instructions are provided in Other Issues, page 160.

• The Federal Information Processing Standard (FIPS) provides best practicesfor implementing cryptographic software. The InputAccel Server is designedto operate with Microsoft operating systems that use FIPS-compliantalgorithms for encryption, hashing, and signing.

Authentication InputAccel uses Microsoft Windows user accounts for authentication andauthorization. Except when installed on a single machine for development ordemonstration purposes, these user accounts must be domain accounts and mayuse any of the authentication security providers used by Windows: NTLM,Kerberos, or Negotiate.

In a multiple-domain environment, create trusts between the differentdomains so that cross-domain authentication can succeed. The minimum trustrelationship required is “Nontransitive One-Way External Trust” from thedomain with clients that need to authenticate to the domain that has serverswhich must perform the authentication.

Client privileges Client software can run under individual domain user accounts or the NetworkService account. If client modules are run as services under theNetwork Serviceaccount, the client machine name must be added to the Module Operators role.

Access to client modules can be controlled by using InputAccel user roles andfurther refined by employing InputAccel ACLs. User roles and ACLs aremanaged in the Administration Console. In addition, InputAccel licensingglobally restricts which components can run and how many components canconnect to an InputAccel Server at one time.

Webcomponents

• The following components are hosted by IIS, which should be configured touse Secure Sockets Layer (SSL) to ensure that user credentials and data trafficare encrypted between the hosts and their clients:— Administration Console

— ClickOnce deployment

— InputAccel Remoting

• Access to these components is controlled by several security providers,including the web server that is hosting the component, Windowsuser permissions (ACLs), InputAccel licensing, and AdministrationConsole-assigned user roles.

39



User accounts Consider using matching Windows user groups and InputAccel roles for usersto simplify permissions control.

After installation of the Administration Console, one user group, the IISMachine Administrators group, is created by default and is listed in theAdministration Console Administrators role. The members of this group areall the users in the Windows Administrators group on the machine where theAdministration Console Web Server is running. One of these users must createand configure the roles and permissions needed in Administration Console, andthen add users to these roles.

Note: The Administration Console web application must run under an accountthat is a member of the local Administrators group on the machine hostingthe Administration Console.

Caution: Remove the IIS Machine Administrators account as soon asyou set up the required accounts for accessing InputAccel. Leaving thisaccount active enables any member of the group access to the web servermachine to log in as an InputAccel Administrator. Once you removethe IIS Machine Administrators account, use Administration Consoleto add the Windows domain user account specified when you installedAdministration Console to the Administrators role.

Consider creating an “InputAccel Supervisors” role with members havingspecific Administration Console permissions and full permissions to runclient modules, and an “InputAccel Operators” role with members having noAdministration Console permissions but full permissions to run client modules.Depending on security requirements, break down these roles into additionalroles with finer divisions of permissions and/or members.

InputAccel requires that user accounts have passwords. Blank passwords arenot supported in any scenario, even on a single-machine installation.

Note: Default version of these roles with associated permissions are predefinedin Administration Console. Examine these default roles and change thepermissions and then add new roles as required.

Passwords must not contain “@” symbols because this symbol is used as adelimiter in InputAccel command line arguments.

Servers and client modules running as services can be configured to run under aspecific user account or a built-in machine account.

As with most software applications, the user installing InputAccel componentsmust be a member of the machine’s local Administrators group.

In addition to user credentials and Windows permissions, all InputAccelmodules require that users be assigned to roles to which necessary permissionshave been granted. These InputAccel security roles are managed through theAdministration Console.

40



Firewalls The customer is responsible for configuring firewall software in a compatiblemanner, as follows:

• Ensuring that all InputAccel components (InputAccel Servers, AdministrationConsole, all directly-connected client modules, and the InputAccel Remotingserver, if used) can communicate with the InputAccel Database. Firewallsin the path of the SQL Server that hosts the InputAccel Database must beconfigured to pass network traffic on the TCP port 1433.

Note:• Client modules read and write data to the InputAccel Database for logging.All log rules are stored in the database. Client modules, upon startup andthen at intervals of 5 minutes, read the logging rules to determine the logrules requirements for the module.

• Clients connecting through HTTP using InputAccel Remoting are anexception—they do not typically need firewall configuration.

• Ensuring that all InputAccel components (InputAccel Servers, AdministrationConsole, all directly-connected client modules, and the InputAccel Remotingserver, if used) can communicate with the InputAccel Database. Firewallsin the path of the SQL Server that hosts the InputAccel Database must beconfigured to pass network traffic on the TCP port 1433.

Note:— Client modules read and write data to the InputAccel Database forlogging. All log rules are stored in the database. Client modules, uponstartup and then at intervals of 5 minutes, read the logging rules todetermine the log rules requirements for the module.

— Clients connecting through HTTP using InputAccel Remoting are anexception—they do not typically need firewall configuration.

• Web Services Coordinator receives calls from Web Services Hosting through.NET Remoting on TCP port 40571. The Web Services Input modulesreceive calls from Web Services Coordinator (TCP port 12007 by default)through .NET Remoting. The Administration Console also communicateswith Web Services Coordinator using TCP port 12007. Any firewall in thecommunication path among these components must be configured to passnetwork traffic on these ports.

• Ensuring that the InputAccel client modules are able to communicate withthe InputAccel Servers and the InputAccel Remoting server, if used. Thisrequires that any firewall between the client modules and the InputAccelServers be configured to pass network traffic on the required port (port 10099,by default). The InputAccel Server setup program offers to automaticallyconfigure Windows Firewall as needed; however, the customer is responsiblefor configuring any other third-party firewall.

41



Firewalls(continued)

Note: When installing an InputAccel Server, you can change the port on whichit listens for network traffic. The default port is 10099. Specify a different portafter installation by specifying the TcpIpPort server parameter in the ServerSettings pane in Administration Console.

• Ensuring that HTTP traffic for the specified Administration Console port(port 80, by default) is not blocked by firewall configuration.

Remote access Remote access to InputAccel is facilitated by the InputAccel Remotingcomponent, which establishes a proxy server hosted by IIS. This componentshould be installed only if operators need to connect to the InputAccel Serverfrom remote locations over the Internet.

Other security considerations include:• Running InputAccel in a Hardened Environment, page 42

• Running InputAccel with Minimum Windows Permissions, page 42

Running InputAccel in a Hardened Environment

Microsoft publishes documentation about running its server products in a secure, or hardened,environment. Hardening machines means establishing security policies, applying all of the latestoperating system security patches, disabling redundant services, enabling firewalls, blocking unusedports, and all the other details of configuring an IT infrastructure to block unwanted access.

InputAccel is intended to run in a hardened environment and has been tested with some commonbut not all possible hardened configurations and components.

Related Topics —

Chapter 1, InputAccel OverviewChapter 3, Installation Planning

Running InputAccel with Minimum Windows Permissions

Good security practice includes setting up machines to run applications with the minimum possiblepermissions. The following are the minimum Windows permissions required for InputAccelcomponents:

• InputAccel Database:— User: A SQL Server user account with SQL Authentication enabled and these permissionsenabled: Connect, Delete, Execute, Insert, Select, and Update.

• InputAccel Servers:

— User: Must be a member of the InputAccel_Server_admin_group group on the local machine.This group is created by the InputAccel Server setup program and is granted the following

42


privileges and permissions, which are the only rights required for the InputAccel Server tofunction:

— Impersonate a client after authentication

— Load and unload device drivers

— Create global objects

— Full permissions on the InputAccel Server root directory (c:\ias, by default) and allof its subfolders and files.

— Full permissions on the IAS registry key underMACHINE\SYSTEM\CurrentControlSet\Services\.

— Programs:

— InputAccel Server (ias.exe) writes both the InputAccel_Server_admin_group SIDand the Administrator (SECURITY_NT_AUTHORITY) SID on the ACL of all processes,batches, and other InputAccel objects.

— InputAccel Performance Counters (iaspmdll.dll) uses shared memory with explicitpermissions to read and write for authenticated accounts.

• Administration Console:— User: The “run-as” account for Administration Console must be a member of the localAdministrators group on the machine hosting the Administration Console.

— Users of Administration Console: On the Administration Console web server, add a group ofusers that will access Administration Console. Grant the “Access this machine from network”local security setting to the group. Also, make sure that the group is not denied network accessto the Administration Console web server by ensuring the group is not associated with the“Deny access to this machine from the network” security setting.

— Directories: Must have Read/Write access to c:\Windows\Microsoft.NET\Framework\v2.0.50727\Temporary ASP.NET Files and to theAdministrationConsole directory and its subdirectories (located inC:\Inetpub\wwwroot\AdministrationConsole, by default). The AdministrationConsole installer assigns this access by default.

• All modules:

— User: Client machines must be members of the local Users group. All users must have Readaccess to the InputAccel Server (IAS) data directory (c:\IAS by default) on each of theInputAccel Servers.

In addition, modules that create batches (for example: ScanPlus, Email Import,WS Input)need Write access to the same folder.

— Directories:— Windows XP and Windows Server 2003 operating systems: Must have Read/Writeaccess to c:\Documents and Settings\All Users\ApplicationData\EMC\InputAccel\settings.ini

— All supported operating systems except Windows XP and WindowsServer 2003 operating systems: Must have Read/Write access toc:\ProgramData\EMC\InputAccel\settings.ini

43


— All operating systems: Modules listed as “Available Prior to 6.0” in Table 23, page 168 musthave Read/Write access to c:\Windows\win.ini.

— Registry: Modules must have Read/Write access to the Registry to enable the logging library toreport performance counter information. Without this access, modules will run but will notreport performance data.

• All modules listed as “New in 6.0 or later” in Table 23, page 168:— User: Client machines must be members of the local Users group. Ensure that “Run-as” usershave access to the network. To use command-line arguments to install, remove, or changeservice settings, the user must be a member of the Administrators group. The account thatis assigned to the service through the command line is automatically granted the ServiceLogon right.

— Directories: The account running the module must have Read access to the .NET configdirectory and to other common Windows directories such as c:\Windows\System32.

• All ClickOnce modules:

— User: Client machines must be part of the localUsers group. To install ClickOnce prerequisites,the user must be a member of the Administrators group.

• ScanPlus and Image Converter modules:

— Directories: The account running the module must have Read/Write access to the systemTemp directory.

• Multi-Directory Watch:

— User: Must run as a named user (not a machine or built-in user). This user must haveadministrative rights.

— Directories: The user account must have Read access to watched directories, and must haveWrite access to watched directories if the files they contain are to be moved or deleted afterthey are imported.

• Email Import:

— Directories: The account running the module must have Read/Write access to the directory towhich emails are copied.

• Documentum Advanced Export:

— Directories: The account running the module must have Read/Write access to the Documentumuser 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 accountwith administrative rights simplifies the configuration.

— Ports: If run under a non-Administrator account, the Administrator should reserve the portsused 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 ofthe InputAccel installation directory to reserve these ports.

44


• ClickOnce Deployment Utility (CODU):— User: To write deployment packages to a web host, the user must be a member of theAdministrators group on the target web server machine.

— Directories: The user who is create deployment packages must have Write permissions forthe directory where the deployment packages are written.

Related Topics —

Chapter 1, InputAccel OverviewChapter 3, Installation Planning

Installing InputAccel across Multiple Domains

The InputAccel setup program is optimized for deploying the servers and clients within a singledomain. In this environment, the setup program performs most or all of the required configurationautomatically. However, InputAccel also works in a multi-domain environments.

In a multi-domain environment, configure the network to create trusts between the affected domains.Every time InputAccel performs a cross-machine communication, a security check is made. Thesesecurity 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 toperform the authentication. Creating these trusts is an IT responsibility that uses operating systemtools, and is beyond the scope of this guide.

The relevant access rights for these trusts are as follows:

• Any user who logs into an InputAccel Server must have the “Windows Login” privilege onthe machine hosting the InputAccel Server.

• Any user who logs into the Administration Console must have the “Windows Login” privilege onthe machine that hosts the Administration Console web server.

To assign users or groups from other domains to InputAccel security roles, either the account underwhich the Administration Console runs must have the privileges necessary to browse the otherdomains, or the users from the other domain must be added to Windows groups in the domainwhere the InputAccel system is running.

Related Topics —

Running InputAccel with Minimum Windows Permissions, page 42Installing InputAccel in a Workgroup, page 45

Installing InputAccel in a Workgroup

Installing InputAccel in a workgroup is supported only in a development or demonstration system;that is, when all components are installed on a single machine. A machine in a Microsoft Windowsworkgroup must maintain its own list of users and groups, because it does not use the central securitydatabase of a domain. A “local user” is a user that has a security account on the local machine.

45


Even though it is running on a single machine, InputAccel still requires users to log in with a validMicrosoft Windows user name and password. Blank passwords are not allowed. Refer to InstallingInputAccel on a Single Machine, page 53 for detailed instructions.

Note: When logging into InputAccel from a client module or from the Administration Console,specify a domain. If running InputAccel on a single machine without a domain controller, specify “.”or “localhost” in the Domain field of the Login window.

Related Topics —

Running InputAccel with Minimum Windows Permissions, page 42Installing InputAccel across Multiple Domains, page 45

High Availability and Failover

InputAccel uses several technologies to ensure high availability and failover protection.

Table 9. High Availability and Failover Technologies Used in InputAccel

Technology Description

ScaleServergroups

If an InputAccel Server becomes unavailable due to a planned or unplannedinterruption, other InputAccel Servers in the same ScaleServer groupautomatically continue sending tasks to and accepting tasks from client modules.ScaleServer groups provide high availability during hardware and softwarefailures; however, they do not provide failover, because the tasks on theinterrupted server are not rerouted and cannot be processed until the serveragain becomes available.

Refer to Configuring Multiple InputAccel Servers as a ScaleServer Group, page78 for instructions on installing and configuring ScaleServer groups.

Generalconsiderations

Part of high availability includes choosing components and best practicesdesigned to deal with faults. Examples include:

• High-performance RAID arrays for data storage redundancy and hot-swapcapabilities.

• Key system components installed on datacenter style rack mount or bladeserver hardware using redundant power supplies.

• Battery backup/power protection systems to keep systems running or toperform an orderly shutdown in the event of a power outage.

• Remote monitoring and tuning software.

46


Technology Description

Generalconsiderations(continued)

• VMware VMotion in lieu of clustering, enabling movement of virtual machinesfrom one host to another in the event of a system failure.

• Offsite storage for short term, rotating backup of paper that has been scannedin addition to media containing backups of irreplaceable files.

Modularclients

Client modules can be brought online to supplement or replace existing clientmodules without disrupting production. Refer to Installing the InputAccel ClientComponents, page 65 for client installation instructions.

High Availability Best Practices

In addition to the high availability and failover mechanisms designed into InputAccel, werecommend the following best practices for other critical system components when InputAccel isused in mission-critical applications:• At a minimum, connect the InputAccel Server machine and the InputAccel Database machine toan 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 InputAccel Servers for high availability by using ScaleServer groups andconfiguring them in an Active/Passive or Active/Active MSCS cluster. Refer to ConfiguringMultiple InputAccel Servers as a ScaleServer Group, page 78 and Installing the InputAccel Serverin a Clustered Environment, page 79 for instructions.

• Run unattended client modules as services and configure those services for high availability byenabling automatic restart on failure. Refer to Manually Registering a Client Module to Run as aService, page 101 for the necessary settings.

• Configure the Administration Console web server for high availability. Refer to Microsoft IIS highavailability best practices for recommendations and instructions.

Disaster Planning

Disaster planning is important for any business-critical application. The extent to which you planfor disaster and disaster recovery depends on your needs, your budget, and the importance of yourdocument capture system to the continuation of your business. At one end of the spectrum isplanning for routine backups of critical data, perhaps with offsite storage. At the other end of thespectrum, you might consider having multiple MSCS clusters in both local and remote locations, eachwith its own Storage Area Network (SAN), with automatic, real-time SAN replication. Some commonthemes 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 notcurrently available.

47


• 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 theevent of a disaster.

EMC offers disaster recovery pricing that provides licensing and activation for periodic testing andone-time use of a disaster continuation system.

Topics in this section include:• Creating an InputAccel Disaster Continuation Plan, page 48

• Disaster Recovery Considerations, page 48

• Implementing a Disaster Continuation System, page 49

Creating an InputAccel Disaster Continuation Plan

Disaster recovery planning should include a written plan describing exactly how to restore InputAccelproduction after a disastrous event. When writing the plan, consider the following questions:

• Who are the key personnel responsible for rebuilding the InputAccel system and restoringproduction?

• 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 Considerations

Disaster recovery can encompass much more than simple backups and redundancy. If planning toput in place a simple backup plan, consider making both local and off-site backups of the followingcritical components:• Directory trees from each of your InputAccel Server IAS directories

• InputAccel Database from SQL Server

• Scanner drivers

• License files

• Patches

• Custom server and client software (from your developers or EMC Consulting)

• Custom client desktop shortcuts

48


• Client side script source code

• Client win.ini and settings.ini files

Table 16, page 112 provides a detailed list of files that should be backed up together with their defaultlocations on server and client machines.

Related Topics —

Disaster Planning, page 47Implementing a Disaster Continuation System, page 49Installing the InputAccel Server in a Clustered Environment, page 79

Implementing a Disaster Continuation System

Implementing a robust Disaster Recovery system is complicated, detailed and specific to eachcustomer’s environment. Contact EMC Consulting Services for help in planning, implementing,and testing a Disaster Recovery environment.

Related Topics —

Disaster Planning, page 47Disaster Recovery Considerations, page 48Installing the InputAccel Server in a Clustered Environment, page 79

Licensing and Activation

InputAccel uses a server-based licensing system that enables EMC as well as third-party moduledevelopers to regulate how their software is used in an InputAccel installation. Licenses are installedon each InputAccel Server. When a client module connects, the InputAccel Server checks for avalid license before letting the module operate.

License codes are uniquely keyed to the Server ID that the InputAccel Server retrieves from itssecurity key. Each license code specifies a single module and regulates how many copies of themodule can concurrently connect to the InputAccel Server, how many pages the module is allowed toprocess, how long the license is allowed to work, and what extra features are enabled.

The InputAccel Server can use either a hardware security key or an InputAccel activation file. Bothtypes of security keys control the licensing of the InputAccel system. If using hardware security keys,both parallel port and USB versions are available.

If using activation files, be aware that each InputAccel Server requires a one-time Internet activationstep. Perform the activation step in the Server Activations pane of the Administration Console,where you can link directly to the EMC Captiva Activation Portal. You can also access the ActivationPortal from http://activation.captivasoftware.com

The Activation Portal, 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.

49

http://activation.captivasoftware.com


• Obtain an Enter By extension.

• Initiate a Server ID migration when moving an InputAccel Server to a different machine.

• Request conversion from using a hardware security key to a software activation file.

Note: Use activation file (software) security keys with side-by-side InputAccel Server installations.Side-by-side configurations are not compatible with hardware security keys. For more informationon side-by-side installations, refer to Installing Multiple Instances of InputAccel Servers, page 76.

To install and manage license codes, and to activate InputAccel Servers using activation files, use theAdministration Console. You will typically receive a file from EMC containing all of your licensecodes, which you can import to your InputAccel Server in a single step. You can also manually typelicense codes one at a time. For more information on licensing and activation, refer to the UsingAdministration Console section in the Administration Guide.

Topics on licensing and activation include:• ScaleServer Licensing, page 50

• Licensing for use in a Microsoft Cluster, page 51

• Licensing for Disaster Recovery, page 51

ScaleServer Licensing

InputAccel licensing for ScaleServer enables multiple InputAccel Servers to be configured so that allmodules can connect to them. ScaleServer groups are defined and managed in the AdministrationConsole. Each InputAccel Server that is to be a part of a ScaleServer group must have license codesthat enable it to participate in the group and to enable the client modules to connect to the group.

The InputAccel Servers within a ScaleServer group share page count licenses to facilitate loadbalancing.

A ScaleServer license is included with certain levels of InputAccel licensing and is an availableoption in other license levels. Contact your account manager if unsure about the features includedwith your license.

Example —• Server 1 and Server 2 are each licensed to process 50,000 pages/day, for a total ScaleServer capacityof 100,000 pages/day.

• Three hours before the end of the day, Server 1 has reached its 50,000 page limit, but Server2 has processed only 25,000 pages.

• Server 1 automatically transfers from the Server 2 license enough page capacity to continueworking either until the end of the day or until 100,000 pages have been processed by theInputAccel system in that day.

This is a simple example, but the logic applies to more complex scenarios, where you may have eightInputAccel 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 UsingAdministration Console section in the Administration Guide.

50


Related Topics —

Licensing for use in a Microsoft Cluster, page 51Licensing for Disaster Recovery, page 51

Licensing for use in a Microsoft Cluster

InputAccel licensing for clustering enables multiple InputAccel Servers to be configured in an MSCSActive/Passive or Active/Active cluster. A standard InputAccel Server license does not enable theserver to run as part of a cluster.

For detailed information on configuringmultiple InputAccel Server instances in anMSCS cluster, referto Installing the InputAccel Server in a Clustered Environment, page 79. For instructions on installingand managing licenses, refer to the Using Administration Console section in the Administration Guide.

Related Topics —

Licensing for Disaster Recovery, page 51

Licensing for Disaster Recovery

Certain levels of InputAccel licensing include licenses for implementing, testing, and using a disasterrecovery system. If unsure about whether your licensing level includes a disaster recovery system,contact your account manager. For information on setting up a disaster recovery system, refer toDisaster Planning, page 47. For instructions on installing and managing licenses, refer to the UsingAdministration Console section in the Administration Guide.

Related Topics —

ScaleServer Licensing, page 50Licensing for use in a Microsoft Cluster, page 51

Sample Production Installation ConfigurationsThe following table shows the InputAccel configurations that can be used in a small volumedeployment, a high volume deployment, and a high-availability deployment.

Note: A complex enterprise installation scenario is discussed in detail in Installing InputAccel in aProduction Environment, page 73.

51


Table 10. Production Installation Configurations of an InputAccel System

Server/Machine Small Volume High Volume High Availability

Machine 1 InputAccel Databasehosted by SQL Server

InputAccel Databasehosted by SQL Server

InputAccel Databasehosted by SQL Serverinstalled in a MicrosoftCluster

Machine 2 InputAccel Server InputAccel Server InputAccel Databasehosted by SQL Serverinstalled in a MicrosoftCluster

AdministrationConsole web server


Web Services Hosting Web Services Hosting

Machine 3

Web ServicesCoordinator


InputAccel Serverinstalled side-by-sideand configured ina Microsoft ClusterServer (MSCS)Active/Active cluster

ScanPlusMachine 4

IndexPlus

ScanPlus InputAccel Serverinstalled side-by- sideand configured ina Microsoft ClusterServer (MSCS)Active/Active cluster


Web Services Hosting

Machine 5 Other client modules IndexPlus


Machine 6 - Other client modules ScanPlus

Machine 7 - Other client modules IndexPlus

Machine 8 (multiple) - - Other client modules

52

Chapter 4Installing InputAccel

This section explains how to install InputAccel for the first time.

Topics on installing InputAccel include:• Installing InputAccel on a Single Machine, page 53

• Installing InputAccel in a Production Environment, page 73

• Additional Installation and Configuration Options, page 76

• Installing Additional Components, page 104

Installing InputAccel on a Single MachineThis section describes an InputAccel installation where all InputAccel components are installed on asingle machine. Typically, a single machine deployment is used for development, demonstration,and low volume production.

The following table summarizes the configuration for a single machine installation:

Table 11. Development or Demonstration Installation

Machine Component to install User Account

InputAccel Database hosted bySQL Server

N/A

InputAccel Server User in the local InputAccel_Server_admin_group group

Administration Console webserver

Domain user in the localAdministrators group

Unattended InputAccel clientmodules

Network Service or domainuser

Machine 1

Attended InputAccel clientmodules

Domain user

53

Installing InputAccel

To install InputAccel on a single machine:

1. Make sure the machine meets the system requirements detailed in Chapter 2, SystemRequirements and Recommendations.

2. Make sure the locale, globalization, and code page settings are specified as detailed in LocaleConsiderations, page 26.

3. Install the InputAccel Database components.

4. Create a SQL Server user account with minimum permissions to access the InputAccel Database.

5. Install the InputAccel Server components.

6. Install the Administration Console from the InputAccel Web Components.

7. Activate the InputAccel Server and install the InputAccel licenses.

8. Install the InputAccel client components.

9. Set the UI language for InputAccel components.

Installing the InputAccel Database

InputAccel uses a SQL Server database to store information such as configuration settings and datarelated to batches. This installation creates the InputAccel Database.

Before installing the InputAccel Database components, obtain and install your own copy of SQLServer to host the database. SQL Server must be configured with the following settings:• Have a user account that is part of the SQL Server sysadmin role.

• Be a member of the local Administrators group on the machine from which you are runningthe setup program.

• Allow TCP/IP protocol access through the default port 1433. In most Enterprise editions, TCP/IPprotocol is enabled by default; in other editions (for example, SQL Server Express 2005 SP1), itmay be disabled by default. Configure SQL Server Express in the SQL Server ConfigurationManager to allow TCP/IP protocol access through the default port 1433. Enable TCP/IP protocolfor each IP address used by the system, make sure that TCP Port field is blank, and then restart theSQL Server Express service. Not configuring the SQL Server Express to allow for TCP/IP accesswill lead to connection errors when installing the InputAccel Database.

• Enable SQL Server and Windows Authenticationmode in SQL Server Management Studio, andthen restart the SQL Server service.

Caution: EMC recommends disabling antivirus software and Data Execution Prevention (DEP),and to close any open programs before installing the InputAccel Database.

Note: The InputAccel Database supports installation on a case-sensitive and case-insensitive SQLServer. The InputAccel Database, however, is case insensitive. This means that upper and lower casecharacters are not differentiated and instead are treated the same way when performing searches orusing the reports functionality in InputAccel.

Chapter 2, System Requirements and Recommendations provides more information about supportedversions of SQL Server.

54


Note: Due to limitations built into SQL Server Express, it should only be used in low page volumedeployments with minimal reporting and logging.

To install the InputAccel Database:

1. Start the InputAccel setup program from the installation media. If the setup program does notstart automatically after a few seconds, or if running the installation from a local disk or networkshare, open the file autorun.exe to begin.

2. From the InputAccel Products list, select Install Products.

3. From the Installation Choices list, select Step 1 - Install the InputAccel Database.

4. If prompted to install prerequisite applications, click Install. After the prerequisite software forthe InputAccel Database is installed, click Next.

5. Accept the license agreement and click Continue.

6. In the Destination Folder window, click Next to install the Create Database Utility and scripts tothe default destination folder or click Change to select a new location.

7. In the Configure InputAccel Database window, select the Create InputAccel Database option,specify the SQL Server administrative login credentials for the SQL Server, and then click Next.

Caution: Use of non-code page Unicode characters in the InputAccel setup program maycause data corruption and installation failure. Only specify characters from the code page ofthe machine running the setup program.

Note:• InputAccel supports only SQL Authentication; therefore, specify a SQL Server login ID toconnect to the SQL Server. Futhermore, the account specified when installing the InputAccelDatabase must have the sysadmin role.

• If the Create the InputAccel Database checkbox is selected, the local Database Server, SQLServer Port, and Database name must be specified. (The default SQL Server port is 1433. Forall SQL Server versions, including the Express editions, make sure TCP/IP is enabled and aport is set before InputAccel Database installation.)

• If using a named instance for the SQL Server, be sure to specify the Database Server inthe format, [machine_name]\[instance_name]. For SQL Server Express, the defaultinstance name is SQLExpress.

• If the Copy Script Only option is selected, the CreateDB executable and scripts are copied tothe target machine but the InputAccel Database is not created. The CreateDB executable mustbe manually run to create the database. Appendix E, Running the Create Database Utilityprovides instructions for manually creating the InputAccel Database.

8. Click Install and then click Finish.

Note: The InputAccel Database cannot be installed onto a compressed drive.

9. To verify a successful installation of the InputAccel Database, run SQL Server ManagementStudio, and expand the Databases folder in the Object Explorer pane. The InputAccel Database(default name: IADB) should appear in the list of databases.

55


10. Create a new user account for SQL Server and set permissions for this user account to run theInputAccel Database. Creating a SQL Server User Account with Minimum Permissions to Accessthe InputAccel Database, page 56 provides the appropriate settings.

Related Topics —

Database Server Requirements, page 11Database Server Considerations, page 27Chapter 3, Installation PlanningDatabase Issues, page 158

Creating a SQL Server User Account with Minimum Permissions toAccess the InputAccel Database

Before installing the InputAccel Server and Web components, a SQL Server user account withrestricted access must be created. This user account must be specified for the DAL registrationduring the InputAccel Server and InputAccel Web Components installation. At no time should asystem administration account be used in production environments for DAL registration. Using anaccount with full permissions is a security risk.

The production SQL Server user account must be configured with the following:• The user account must use SQL Server authentication.

• The Default database must be set to the InputAccel Database.

• The user account must be mapped to the InputAccel Database and the database role membershipmust be set to Public.

• Grant the following permissions to the InputAccel Database:

— Connect

— Delete

— Execute

— Insert

— Select

— Update

Related Topics —

Database Server Requirements, page 11Database Server Considerations, page 27Chapter 3, Installation PlanningInstalling the InputAccel Database, page 54Database Issues, page 158

56


Installing the InputAccel Server

The InputAccel Server is an open integration platform that manages and controls the documentcapture process by routing document pages along with processing instructions to the appropriateclient modules.

Caution:• The machine name of the InputAccel Server must not be longer than 15 bytes; otherwise,client machines will be unable to connect.

• EMC recommends disabling antivirus software and Data Execution Prevention (DEP), andto close any open programs before installing the InputAccel Server.

This procedure installs the InputAccel Server, sample process files, and documentation.

To install the InputAccel Server:



3. From the Installation Choices list, select Step 2 - Install the InputAccel Server.

4. If prompted to install prerequisite applications, click Install. The prerequisite software for theInputAccel Server is installed.

5. Remove the USB security key, if used, and then click Continue and then click Next.


7. Select one of the following setup types, and then click Next:• Typical: Performs the default installation on the default C:\ drive.

• Custom: Enables you to select the features and the drive to install the InputAccel Serverapplication files (InputAccel program files) and the InputAccel Server data files (InputAcceldata files).

8. In the InputAccel Service Accounts window, select one of the following to specify a user accountwhen logging in to the InputAccel Server:• Use the built-in Local System account: Uses the credentials for the local machine’s Windowsaccount.

• Specify a user account: Uses the credentials entered in the Username, Password, andDomain fields.

The setup program automatically adds the specified local or domain user to the LUAgroup: InputAccel_Server_admin_group, enabling the InputAccel Server to operate witha least-privileged user account. Details of the LUA configuration can be found in RunningInputAccel with Minimum Windows Permissions, page 42.

57



9. Select Automatically start the “InputAccel Server” service when the system starts if you wantthe InputAccel Server to be started as a service automatically when the system starts, and thenclick Next.

10. In the Data Access Layer Registrationwindow, specify the login credentials for connecting to theSQL Server. This is the SQL Server user account created that provides permissions to access theInputAccel Database. Click Next.

Note: If the machine where the InputAccel Server is installed also has SQL Server installed, thenby default Register the Data Access Layer with the InputAccel database is selected and the localdatabase server, default SQL Server port 1433, and Database name are specified.

11. If the Windows Firewall is running and enabled, the Configure Windows Firewall windowdisplays. By default, Let setup configure the Windows Firewall is selected. This optionconfigures the Windows Firewall to pass network traffic on the necessary ports. Clear thecheckbox to configure the firewall manually. Click Next.

12. If the machine on which you are installing the InputAccel Server belongs to a domain, theAdministration Console User window is displayed. In the Username and Domain fields, enterthe name and domain name of the account that will host the Administration Console, click Next,and then click Install. The Administration Console user account created through the installer willbe added to the InputAccel_Server_admin_group.

Note: If the Administration Console user account credentials are not provided during InputAccelServer installation, then the user account under which the Administration Console servicemust run needs to be added manually to the InputAccel_Server_admin_group group on theInputAccel Server machine.

13. By default, Start the InputAccel Server service when setup completes is selected. Clear thecheckbox if you want to start the InputAccel Server service manually when setup completes.Click Next.

14. Click Finish. If used, install the USB security key.

15. To verify that the InputAccel Server has been successfully installed, open the Microsoft Serviceswindow (click Start > Programs > Administrative Tools > Services) and start the InputAccelServer service.

Caution:• The InputAccel Server closes unexpectedly if the InputAccel Server is running withMicrosoftData Execution Prevention (DEP) feature enabled. Make sure the DEP featureis disabled on the machine where InputAccel Server is running.

Note: The Language Pack files for .NET Framework 3.5 are not installed by InputAccel. To view.NET Framework 3.5 messages in your required language, obtain the relevant language packfrom the Microsoft.

Caution: If a machine running the InputAccel Server service is shut down before stopping theInputAccel Server service, unsynchronized batches may lose data.

58


To avoid this issue:• Manually stop the InputAccel Server service before shutting down or restarting the machine.

• Increase the value of the following registry key that controls the duration that theService Control Manager waits before terminating services at machine shutdown:HKLM\SYSTEM\CurrentControlSet\Control\WaitToKillServiceTimeout. Notethat the value specified for this key is in milliseconds and should be set to the amount oftime needed by the slowest application to shutdown gracefully. So, if the InputAccel Servertakes five minutes to shutdown, set this value to a minimum of 300000.

To understand the issues of shutting down the InputAccel Server in a clustered environment,refer to InputAccel Server Shutdown in a Clustered Environment in the Installation Guide.

Related Topics —

InputAccel Server Requirements, page 13InputAccel Server Considerations, page 29Upgrading the InputAccel Server, page 133

Installing the Administration Console

The InputAccel Web Components setup program installs the Administration Console. TheAdministration Console module is a web-based module that monitors and administers an InputAccelsystem.

This component can also install InputAccel Remoting features, which enable remote client modulesto access the InputAccel Server and InputAccel Database, but the Administration Console andInputAccel Remoting cannot be installed on the same machine. For information on installingInputAccel Remoting, refer to Installing InputAccel Remoting, page 89.

Caution: EMC recommends disabling antivirus software and Data Execution Prevention (DEP),and to close any open programs before installing the Administration Console.

Prerequisites before Installing Administration ConsoleGeneral Prerequisites• Verify the minimum permissions to install and run Administration Console.

• Review the Administration Console Host System Considerations, page 30.

• Make sure the IIS isolation mode is disabled on the machine hosting the Administration Console.

• It is recommended not to install IIS on a Domain Controller.


• For generating reports with Russian, Chinese, or Korean characters, you must use the followingsettings:— The Region and Language settings on the Administration Console Web Server machineand the Administration Console web browser machine (format, language, keyboard andlanguages, and administration information settings) must be set to Russian (for reports with

59


Russian characters), Chinese (for reports with Chinese characters), or Korean (for reportswith Korean characters).

— Administration Console web browser language must be set to Russian (for reports withRussian characters), Chinese (for reports with Chinese characters), or Korean (for reportswith Korean characters).

• Make sure the Arial Unicode MS font is installed on the Administration Console Web Server inthe \WINDOWS\Fonts\ directory. This is required for Chinese or Korean characters to displaycorrectly in reports that are generated in Administration Console and exported as PDF files.

• If the machine from where Administration Console is accessed does not have IPv6 enabled, usersare presented with the interface to enter their Windows credentials when they attempt to log in toAdministration Console. If you want to avoid this issue, either disable IPv6 on the AdministrationConsole web server machine or enable IPv6 on the Administration Console browser machine. Ifthese options are not acceptable, continue entering your Windows credentials each time you login to the Administration Console.

IIS 5.1 Prerequisites on Windows XPIf installing Administration Console on a machine running Windows XP, make sure that IIS 5.1 isinstalled before installing Administration Console.

IIS 6.0 Prerequisites on Windows Server 2003There are no prerequisites for installing Administration Console on a machine running WindowsServer 2003 with IIS 6.0.

IIS 7.0 Prerequisites on Windows Server 2008 or Windows VistaIf installing Administration Console on a machine running Windows Server 2008 or Windows Vista:• Make sure IIS 6.0 Management Compatibility is run before installing InputAccel Web Components

• In addition to the security settings enabled for a standard IIS 7.0 configuration, enable theseadditional role services security settings:— Basic Authentication

— Windows Authentication

— IIS Client Certificate Mapping Authentication

IIS 7.5 Prerequisites on Windows Server 2008 R2 or Windows 7If installing Administration Console on a machine running Windows Server 2008 R2 or Windows 7:In addition to the settings that enabled for a standard IIS 7.5 configuration, enable these additionalrole services settings:• Application Development

— ASP.NET

— .NET Extensibility

60


— ISAPI Extensions

— ISAPI Filters

• Security— Basic Authentication



• IIS 6 Management Compatibility— IIS 6 Metabase Compatibility

— IIS 6 WMI Compatibility

— IIS 6 Scripting Tools

— IIS 6 Management Console

Note: Make sure that Common HTTP Features andManagement Service features are also enabled ifthey are not enabled by default.

To install the Administration Console:

1. Review and make sure you meet the Prerequisites before Installing Administration Console,page 59.



4. From the Installation Choices list, select Step 3 - Install the InputAccel Web Components.

5. If prompted to install prerequisite applications, click Install. The prerequisite software forInputAccel Web Components is installed. Click Next.


7. Select Administration Console as the feature to install, and then click Next.

Note: The Administration Console and InputAccel Remoting features cannot be installed on thesame machine because they are incompatible.

8. ClickNext to install to the default destination directories or click Change to select a new location.

9. In the Data Access Layer Registration window, specify the login credentials for connecting tothe SQL Server, and then click Next.


Note: If SQL Server is installed on the same machine where you are installing AdministrationConsole, then by default, Register the Data Access Layer with the InputAccel database isselected and the local database server, default SQL Server Port 1433, and Database name arespecified.

61


10. In the InputAccel Web Site User Accountwindow, provide the login credentials for the Windowsuser account that will run the InputAccel Web Components website (must be a member of theWindows Administrators group), then click Next.

11. In the InputAccel Web Components window:

a. Provide the InputAccel web site description.

b. From the IP address to use for this web site list, select the appropriate IP address.

c. In the TCP port this web site should use field, enter the port number to assign to thewebsite, and then click Next. Be sure to mark down the IP address and port assignmentfor the Administration Console. You will need this information to test the installation insubsequent steps.

Note: By default, Administration Console uses port 80.

12. If the selected port is already in use, the TCP Port Conflict window displays. Disable the websitecurrently assigned to the port and click Next.

13. Click Install and then click Finish. The installer creates a Startmenu shortcut to AdministrationConsole on the machine where Administration Console is installed.

14. If Administration Console is installed on a machine running Windows XP, then configure the webserver manually as detailed in Configuring Administration Console on Windows XP, page 63.None of the other operating systems require post configuration.

15. Verify the installation:

a. Ensure that JavaScript is enabled in the web browser of the machine used to accessAdministration Console.

b. Start Internet Explorer and browse to the URL of the Administration Console server.• For all operating systems except for Windows XP: Typically, this is similar to“http://<hostname>:<port_number>”. (The hostname and port number areestablished when the Administration Console web components is installed.)

• For Windows XP: http://<hostname>/AdministrationConsole/login.aspx

Note: To use an IP address rather than a hostname in the Administration Console URL, addthe IP address to the list of valid sites in your Local Intranet zone.

c. Type the credentials of the user logging into the Administration Console.

Note: You can specify a localhost or a period (.) in the Domain field to indicate a user fromthe local machine.

d. Click Logon. The Administration Console window displays in a browser.

Note:• You may fail to connect to Administration Console and see a “Failed to access IIS metabase” error.This may happen when IIS is installed after installing .NET Framework. To resolve this issue, runC:\WINDOWS\Microsoft.NET\Framework\v2.0.50727>aspnet_regiis -i

• If Administration Console fails to connect to the InputAccel Server, it may be due to permissionissues. Make sure you add the Windows domain user account specified when you installedAdministration Console to the Administrators role in Administration Console.

• If the Administration Console user account credentials were not provided during InputAccelServer installation, then the user account under which the Administration Console service

62


is running must be added manually to the InputAccel_Server_admin_group group on theInputAccel Server machine. In order to secure access to the Administration Console, IIS shouldbe configured to use SSL.

• In a production environment, use the Administration Console to create roles and grantpermissions to users of the InputAccel system.

• The Language Pack files for .NET Framework 3.5 are not installed by InputAccel. To view .NETFramework 3.5 messages in your required language, obtain the relevant language pack from theMicrosoft.

Configuring Administration Console on Windows XP

If Administration Console is installed on a machine running Windows XP with IIS 5.1, then the webserver must be configured manually.

To configure Administration Console on Windows XP

1. Configure ASP.NET to run under the specific user account. This enables Administration Consoleto access the network.

a. Open the machine.config file on the machine where IIS 5.1 is installed. By default, thelocation is C:\WINDOWS\Microsoft.NET\Framework\v2.0.5.727\CONFIG. This filecontains a processModel section with information similar to:<processModelenable="true"timeout="Infinite"idleTimeout="Infinite"shutdownTimeout="0:00:05"requestLimit="Infinite"requestQueueLimit="5000"restartQueueLimit="10"memoryLimit="60"webGarden="false"cpuMask="0xffffffff"userName="it\machine"password="AutoGenerate"logLevel="Errors"clientConnectedCheck="0:00:05"comAuthenticationLevel="Connect"comImpersonationLevel="Impersonate"responseDeadlockInterval="00:03:00"maxWorkerThreads="20"maxIoThreads="20"/>

Note: The userNamemust be in the format of “<Domain>\<User Name>” where <Domain>must be replaced with the domain name of the user and <User Name>must be replaced withthe Administration Console user’s user name. The domain name and user name must also bethe same as provided during Administration Console installation.

b. In the processModel section, change the userName and password attributes to thelogin credentials provided in the InputAccel Web Site User Account window during theAdministration Console installation.

63


The processModel section may list a single line similar to <processModelautoConfig="true">. In this situation, replace the line with the processModel sectiondetailed in the previous step and then change the userName and password attributes.

c. Optional. These steps are required to set an encrypted user name and password in themachine.config file for security reasons.

i. Download the aspnet_setreg.exe utility from http://support.microsoft.com/kb/329290 to your local drive.

ii. In the command window, type this command and press Enter:<install_location_aspnet_setreg.exe>>aspnet_setreg.exe -k:SOFTWARE\MY_SECURE_APP\identity-u:<yourdomainname>\<username>" -p:"<password>"

Replace:• <install_folder_aspnet_setreg.exe> with the location of aspnet_setreg.exe:

c:\Tools, for example

• <yourdomainname> with the domain of the user: corp, for example

• <username> with the name of the user: machine, for example

• <password> with the user password: AutoGenerate, for example

Using these parameters, an example of the command isc:\Tools>aspnet_setreg.exe -k:SOFTWARE\MY_SECURE_APP\identity-u:it\machine" -p:"AutoGenerate"

This command encrypts the user name and password attributes, and stores the attributesin the registry keys.

iii. This command generates output similar to the following:userName="registry:HKLM\SOFTWARE\MY_SECURE_APP\identity\ASPNET_SETREG,userName"

password="registry:HKLM\SOFTWARE\MY_SECURE_APP\identity\ASPNET_SETREG,password"

Copy these lines and replace the userName and password lines of the <processmodel>section in the machine.config file.

d. Save the machine.config file.

e. Open a command window and type the iisreset command to restart IIS.

2. Configure IIS 5.1 for the Administration Console.

a. Navigate to Control Panel >Administrative Tools and double-click Internet InformationServices.

b. In the Internet Information Services window, expand local computer >Web Sites > DefaultWeb Site.

c. Right-click AdministrationConsole and select Properties to display theAdministrationConsole Properties window.

d. On the Directory tab, make sure the Script source access checkbox is selected and thenclick Create. The Application Settings area is populated with information that defines

64

http://support.microsoft.com/kb/329290

http://support.microsoft.com/kb/329290


Administration Console as an IIS web-based application by the directory structure in which itis located. Do not make any changes to this section.

e. On the Directory Security tab, click Edit in the Anonymous access and authenticationcontrol area. The Authentication Methods window displays.

f. Clear the Anonymous access checkbox and select the Integrated Windows authenticationcheckbox. Click OK.

g. On the ASP.NET tab, verify that 2.0.50727 is selected for the ASP.NET version. Click OK.

h. Select local computer >Web Sites >Default Web Site. Right-click and select Start to start theAdministration Console web site.

Related Topics —

Administration Console Host System Considerations, page 30ClickOnce Host System Considerations, page 30InputAccel Remoting Server Considerations, page 31Installing the Administration Console, page 59

Activating and Licensing InputAccel

After installing the InputAccel Server and Administration Console, install security key or activationfile, install licenses, and begin the activation process.

Refer to the Administration Guide for details on the server and client licenses required for specificfeatures. Refer to the Using Administration Console section of the Administration Guide for instructionson security keys and licenses and activating InputAccel Servers. You can proceed to install InputAcceland start using it for a limited time while waiting for a response to the activation request.

Related Topics —

ScaleServer Licensing, page 50Licensing for use in a Microsoft Cluster, page 51Licensing for Disaster Recovery, page 51

Installing the InputAccel Client Components

InputAccel client components are software modules that perform specific information capture taskssuch as scanning images, enhancing images, performing OCR, indexing data, or exporting imagesand data. InputAccel also supports third-party InputAccel certified modules. All modules running onclient machines use TCP/IP to connect to the InputAccel Server. ScanPlus, RescanPlus, and IndexPlusmodules can also connect to the InputAccel Server using HTTP, through InputAccel Remoting.

This procedure installs InputAccel client modules and the following additional features:• CaptureFlow Designer and Process Developer

• .NET Code module

• InputAccel Scripting Libraries

65


• Web services modules and components

• Sample images

Note: Before client modules can run in production mode, the users that run the Client modules(or groups to which these users belong) must be assigned appropriate permissions through theAdministration Console. Otherwise, users will be unable to log in and process tasks. Refer to theUsing Administration Console section of the Administration Guide for additional information.

Caution: EMC recommends disabling antivirus software and Data Execution Prevention (DEP),and to close any open programs before installing the Client Components.

To install InputAccel Client Components:



3. From the Installation Choices list, select Step 4 - Install the InputAccel Client Components.

4. If prompted to install prerequisite applications, click Install. The prerequisite software for theclient modules is installed. Click Next.

5. Accept the license agreement and then click Continue.

6. Select one of the following setup types, and then click Next:• Complete: Installs all InputAccel client features

• Custom: Enables you to select the features to install

7. If selecting features that require third-party software that is not already installed on the system,theMinimum Feature Requirements window displays and those modules are not installed.After the required third-party software is installed, run the InputAccel client installer again toinstall the appropriate modules. Click Next to continue.

8. The Required Third-party Software window displays if third-party software that is requiredto run the client modules is not already installed. Click Next to continue. The specified clientmodules are installed, but will not run until the required third-party software is installed.

9. Click Next to install to the default destination directory or click Change to select a new location.

10. Select one of the following to specify a user account to use when logging in to the InputAccelServer:• Use the built-in Network Service account: Uses the credentials for the local machine’sWindows Network Service account

Note: If you select Use the built-in Network Service account, unless all InputAccelcomponents are installed on a single system or the InputAccel Server has been configuredto allow anonymous access, you must configure the InputAccel system to use Kerberosauthentication, as explained in Configuring InputAccel to use Kerberos authentication, page 35

• Specify a user account: Uses the credentials specified

66



11. Select Install services for all selected modules that can run as services to install the InputAccelclient modules as services.

12. Select Automatically start all services when the system starts if you want the InputAccel clientmodules to be started as a service automatically when the system starts, and then click Next.

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.

13. In the InputAccel Server Connection Information window, specify the Server name andServer port of the InputAccel Server to connect to. By default, Try to contact the server duringthis installation is selected. This option enables the setup program to attempt to establish aconnection with the InputAccel Server. Click Next.

Caution: If the InputAccel Server host name contains Unicode characters from a code pageother than the code page of the client machine, do not specify that name in the InputAccelServer Connection Information window. The non-code page characters may causeinstallation errors. Instead, proceed as follows:

• Go back to the previous panel and clear the Install services for all selected modulesthat can run as services check box.

• Return to the InputAccel Server Connection Information window and for the ServerName specify the InputAccel Server machine’s IP address.

• Proceed with the client installation. The first time you run each client module, specifythe correct InputAccel Server name when logging in.

• If you want to configure modules to run as services, use the instructions provided inManually Registering a Client Module to Run as a Service, page 101.

14. If the connection succeeds, click Next. If the attempt fails, verify that the InputAccel Serverservice is started.

15. Click Install and then Finish.

16. If prompted to restart Windows, click Yes.

17. Verify that the InputAccel Server service is started on the machine where the InputAccel Server isinstalled.

18. Verify that the InputAccel client modules have been installed successfully. Start a client moduleby clicking Start > Programs > InputAccel and then selecting the module. The module loginwindow displays.

19. Type your InputAccel Server login credentials, and click OK.

Note: The Language Pack files for .NET Framework 3.5 are not installed by InputAccel. To view .NETFramework 3.5 messages in your required language, obtain the relevant language pack from theMicrosoft.

67


Related Topics —

Client Machine Considerations, page 32Client Scalability, page 37Upgrading Client Modules, page 136

Downloading ISIS Scanner Drivers

Attended client modules, ScanPlus and RescanPlus require scanner drivers. ScanPlus and RescanPlusoperators can download ISIS scanner drivers from the Powerlinkwebsite (http://powerlink.EMC.com).The Powerlink website provides access to https://EMC.subscribenet.com/control/dctm/index, whichprovides a complete listing of the ISIS drivers available for download.

Related Topics —

Client Machine Requirements, page 17Scanning Workstation Requirements, page 24

Registering the SLDRegistration Executable

The Archive Export client module connects to and populates an SAP ECC or SAP NetWeaversystem with administrative data and content. The SAP System Landscape Directory (SLD) containsinformation about installed SAP components. This information facilitates the maintenance of complexSAP system landscapes. To connect to the SLD and provide details of the SAP system used withArchive Export, run the SLDRegistration.exe executable from the InputAccel\client\binntdirectory and register information about the Host, Port, and user credentials of the SAP system.

68

http://powerlink.EMC.com

https://emc.subscribenet.com/control/dctm/index

Setting the UI Language of InputAccel Components

After successful installation of InputAccel, you may want to set the user interface (UI) languagefor the various InputAccel components. Depending on the InputAccel component, the default UIlanguage is determined by the user’s regional settings or language of the operating system. Thedefault UI language can be overridden so that the user interface is displayed in a language otherthan the default UI language.

Refer to Appendix C, Languages Supported for a list of languages supported in InputAccel, theirlanguage codes, and locale IDs.

Note:• Performance counters are installed on the InputAccel Server machine and are available in thelanguage of the operating system where they are installed or English.

• Windows Event Log typically displays event logs in the language of the operating system wherethey are viewed.

This table summarizes how to set the default globalization settings and UI language, and the optionsto override the default UI language for each InputAccel component:

Table 12. Globalization and UI Language Settings for InputAccel Components

InputAccelcomponent

Globalization settings(e.g. date, number,currency formatting)determined by

Default UI languagedetermined by

Default UI languageoverridden by

InputAccel Server User’s regional settings User’s regional settings Specifying the UIlanguage in the:

• Win.ini file

• Setscan.ini file

Client modules thatwere available priorto InputAccel 6.0 (Modules listed as“Available Prior to 6.0”in Table 23, page 168)Table 23, page 168)except Multi DirectoryWatch

User’s regional settings User’s regional settings Specifying the UIlanguage in the:

• Win.ini file


69

Preface

InputAccelcomponent

Globalization settings(e.g. date, number,currency formatting)determined by

Default UI languagedetermined by

Default UI languageoverridden by

Client modules thatare new in releasesof InputAccel 6.0 and6.5 (Modules listed as“New in 6.0 or later” inTable 23, page 168) andMulti Directory Watch

Regional settings ofthe operating system

Language of theoperating system

Specifying the UIlanguage through:

• Command lineargument

• settings.ini file


• Multilingual UserInterface (MUI)Pack

Note: Although the Multi Directory Watch module was available prior to InputAccel 6.0, its UIlanguage is determined the same way as for modules available since InputAccel 6.0.

Topics in this section include:• Specifying Default UI Language Settings, page 70

• Summary of Options for Overriding the Default UI Language, page 71

• Procedures to Override the UI Language, page 72

Specifying Default UI Language Settings

The procedure for setting the default UI language differs for client modules available prior toInputAccel 6.0 and for client modules new in version 6.0 and later.

To specify the default UI language for InputAccel Server and for client modulesavailable prior to InputAccel 6.0:

This procedure applies to setting the default UI language on a machine running Windows XPoperating system.

1. Run the Control Panel on the machine running the InputAccel Server or any client moduleavailable prior to InputAccel 6.0. (Modules listed as “Available Prior to 6.0” in Table 23, page 168)

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 formatof date, number, currency, and so on. The Samples area displays the formatting based on thelocale selected. Click Customize to make changes.

4. On the Advanced tab, select a language drop-down list box. Choose from the Appendix C,Languages Supported in InputAccel. This sets the code page that the InputAccel Server andclient modules will use. It must be an appropriate code page for the locale set in the RegionalOptions tab. Typically, the locale specified in the Regional Options tab and language specifiedon the Advanced tab must match.

70

Preface

5. On the Advanced tab, select the Default user account settings checkbox. This ensures thatthe changed settings apply for all accounts that are used to run the InputAccel Server or clientmodules as a service.

To specify the default UI language for client modules new in InputAccel 6.0 and later:

Client modules new in InputAccel 6.0 versions (modules listed as “New in 6.0 or later” in Table 23,page 168) use the language of the operating system as the default UI language. These modules usethe locale set on the Regional Options tab (Control Panel > Regional and Language Options) tocontrol the format of date, number, currency, and so on.

The default UI language settings for the InputAccel Server and client modules can be overriden. Referto Summary of Options for Overriding the Default UI Language, page 71 for details.

Summary of Options for Overriding the Default UI Language

The default UI language for the InputAccel Server or client modules can be overriden as summarizedin this section.

Note: This section summarizes the various options available to override the default UI languageof various InputAccel components. Steps for each override option is described in Procedures toOverride the UI Language, page 72.

For the InputAccel Server, the default UI language can be overriden by: —• win.ini file if setscan.ini file does not specify the UI language.

• User’s regional settings, if the above is specified.

For modules introduced in InputAccel 6.0, the default UI language can be overriden by: —• Command line argument, if specified.

• settings.ini file, if the command line argument for language is not specified.

• setscan.ini file, if the command line argument and settings.ini do not specify the UIlanguage.

• MUI pack setting for language, if the command line argument, settings.ini, andsetscan.ini do not specify the UI language.

• Language of the operating system, if none of the above is specified.

For modules available prior to the InputAccel 6.0 release, the default UI language can be overridenby: —• win.ini file, if specified.

• setscan.ini file, if the win.ini file does not specify the UI language.

• User’s regional settings, if none of the above is specified.

71

Preface

Procedures to Override the UI Language

This section details the steps involved in overriding the default UI language of the InputAccelServer and client modules.

Prerequisites for successfully overriding the default UI language:• Make sure new UI language is supported by the Windows code page specified in the Advancedtab of the Regional and Language Options window of the Control Panel.

• Make sure the Regional Options tab lists the appropriate locale. This is required to display thecorrect format of date, number, currency, and so on.

To specify a command line argument to set the UI language:

1. On the client machine where a module new in version 6.0 and later is installed, add the followingparameter to the command line arguments used to start the module:-language:<languagecode>

where <language code> represents a language code for the languages supported in InputAccel.Examples (where the ScanPlus module is installed at the default location):• "C:\Program Files\InputAccel\Client\binnt\QuickModuleHost.exe"

-modulename:Emc.InputAccel.Scan -language:en-us (Starts the ScanPlus modulewith the UI language set to English-United States)

• "C:\Program Files\InputAccel\Client\binnt\QuickModuleHost.exe"-modulename:Emc.InputAccel.Scan -language:pt-br (Starts the ScanPlus modulewith the UI language set to Portuguese-Brazil)

• "C:\Program Files\InputAccel\Client\binnt\QuickModuleHost.exe" -modulename:Emc.InputAccel.Scan-login:honor\johndoe,password99@Baltimore1;bermuda -language:pt (Startsthe ScanPlus module for production connecting to InputAccel Servers “Baltimore1” and“bermuda” with the domain name “honor”, the user name “johndoe”, the password“password99”, and the UI language set to Portuguese).

To specify the UI language in the settings.ini file:

1. On the client machine where a module new in version 6.0 and later is installed, openthe settings.ini file. The default location is c:\Documents and Settings\AllUsers\Application Data\EMC\InputAccel.

2. In the [INPUTACCEL] section, specify the UI language in the format:language=<languagecode>

where <language code> represents a language code for the languages supported in InputAccel.Examples:• language=en-us (to set the UI language to English-United States)

• language=pt-br (to set the UI language to Portuguese-Brazil)

• language=pt (to set the UI language to Portuguese)

72

Preface

To specify the UI language in the setscan.ini file:

1. On the machine where the InputAccel Server or any InputAccel client module is installed, openthe setscan.ini file. The default location is c:\windows.

2. In the [OPTIONS] section, specify the UI language in the format: iLanguage=<Locale ID>

where <Locale ID> represents the locale ID for the languages supported in InputAccel.Examples:• iLanguage=1033 (to set the UI language to English-United States)

• iLanguage=1046 (to set the UI language to Portuguese-Brazil)

To specify the UI language in the win.ini file:

1. On the machine where the InputAccel Server or a client module available prior to the InputAccel6.0 release is installed, open the win.ini file. The default location is c:\windows.

2. In the [INPUTACCEL] section, specify the UI language in the format: Locale=<Locale ID>

where <Locale ID> represents the locale ID for the languages supported in InputAccel.Examples:• Locale=1033 (to set the UI language to English-United States)

• Locale=1046 (to set the UI language to Portuguese-Brazil)

To specify the UI language using the Windows MUI Pack:

AMUI Pack is available in the English version of Microsoft Windows XP Professional and MicrosoftWindows 2000 family of operating systems. The MUI Pack will not install on non-English versions ofthe operating system. Refer to Microsoft documentation on how to install the MUI Pack.

Note: This procedure assumes you are running the English version of the Windows XP operatingsystem and have installed the MUI Pack.

1. Run the Control Panel on the machine running the any client module new in InputAccel version6.0 and later. (Modules listed as “New in 6.0 or later” in Table 23, page 168)

2. Double-click Regional and Language Options.

3. On the Languages tab, select the required language from the Language used in menus anddialogs list box.

Related Topics —

Appendix C, Languages SupportedTable 23, page 168

Installing InputAccel in a ProductionEnvironmentThis section explains how to install InputAccel into a typical production environment and alsopresents some complex installation scenarios. This installation includes the option of installing theInputAccel Servers in a clustered environment to ensure high availability.

73

Preface

Table 13. Production Installation of an InputAccel System

Server/Machine Component to install User Account Runs as

Server 1 InputAccel Databasehosted by SQL Server.Configuring SQLServer in a clusteredenvironment forhigh availability isrecommended.

N/A N/A

Server 2a InputAccel Server User in the localInputAccel_Server_admin_group group

Service

Server 2b InputAccel Server User in the localInputAccel_Server_admin_group group

Service

Server 3 AdministrationConsole webcomponent

Domain user in thelocal Administratorsgroup

Service

Server 4 • (Optional)ClickOnce packages

• ClickOnceDeployment Utility

Domain user in thelocal Administratorsgroup

N/A

Machine 5 ScanPlus Domain user Application

Machine 6 RescanPlus Domain user Application

Machine 7 IndexPlus Domain user Application

Machine 8 (multiple)

Note: Web ServicesCoordinator canonly be installed ona single machine in theInputAccel system.

• Web ServicesCoordinator

• Web ServicesHosting

• Web Services Input

• Web ServicesOutput

Domain user Service only

Machine 9 • Image Enhancement Network Service Service

Machine 10 NuanceOCR Network Service Service

Machine 11 DocumentumAdvanced Export

Network Service Service

Machine 12 • Multi

• Image Converter


Machine 13 Multi-Directory Watch Network Service Service

74

Preface

Server/Machine Component to install User Account Runs as

Machine 14 Email Import Network Service Service

Machine 15 (multiple) Other unattendedclient modules


To install InputAccel in a typical production environment:

1. Make sure the servers and machines meet the system requirements outlined in Chapter 2, SystemRequirements and Recommendations.

2. Install InputAccel Database on Server 1. Refer to Installing the InputAccel Database, page 54 forinstructions on installing the InputAccel Database.

3. Install the InputAccel Server. You have the following options:• Install the InputAccel Server on a single machine, Server 2. Refer to Installing the InputAccelServer, page 57 for instructions.

• Install multiple instances of the InputAccel Server on a single machine, Server 2. Refer toInstalling multiple instances of the InputAccel Server for instructions.

• Install the InputAccel Server on multiple machines, Server 2a and Server 2b, and optionallyconfigure them as a ScaleServer group.

• Install the InputAccel Servers in a clustered environment and then configure them as aScaleServer group. Refer to Installing the InputAccel Server in a Clustered Environment, page79 for instructions on installing InputAccel Servers in an Active/Passive or Active/Activeclustered environment.

4. Install the Administration Console web component on a web server, Server 3. Refer to Installingthe Administration Console, page 59 for instructions.

5. Install attended client modules, ScanPlus, IndexPlus, and RescanPlus as applications on eachmachine designated for these modules according to the installation plan. Refer to Installing theInputAccel Client Components, page 65 for instructions.

Note: The ScanPlus, RescanPlus, and IndexPlus modules may optionally be deployed using theClickOnce Deployment Utility. Users can then download these modules through a web server ornetwork file share. Refer to step 7 for instructions.

6. (Optional. This step is required only if ScanPlus, RescanPlus, and IndexPlus are deployed usingthe ClickOnce Deployment Utility). Install ScanPlus ClickOnce Package, RescanPlus ClickOncePackage, and IndexPlus ClickOnce Package. Follow the same steps involved in installing clientmodules. Also, deploy the ClickOnce packages on a web server or network file share by runningthe ClickOnce Deployment Utility on the same machine.

7. (Optional. This step is required only if the client modules must access the InputAccel Serverremotely.) Install the InputAccel Remoting web component on a web server other than theone where Administration Console is installed, Server 4. Make sure the server is running inthe network’s demilitarized zone (DMZ) to enable access from the Internet. Refer to InstallingInputAccel Remoting, page 89 for instructions.

Note: Administration Console and InputAccel Remoting must be installed on separate servers.

8. (Optional) Install Web Services Coordinator, Web Services Hosting, Web Services Input, and WebServices Output client modules on a separate machine.

75

Preface

9. Install the other unattended client modules as services on each machine designated for thesemodules according to the installation plan.

Note: For a list of client modules that can be run in unattended mode and as services, referto Table 23, page 168.

10. (Optional) Set the UI language for the different InputAccel components.

11. Run the Administration Console from any machine on the network. Add the Windows domainuser account specified when you installed Administration Console to the Administrators role.Configure the Web Services Coordinator and Web Services Hosting components. Refer to theUsing Administration Console section in the Administration Guide for details.

Additional Installation and ConfigurationOptionsThis section discusses additional installation and configuration options for the InputAccel system.Topics in this section include:• Installing Multiple Instances of InputAccel Servers, page 76

• Configuring Multiple InputAccel Servers as a ScaleServer Group, page 78

• Installing the InputAccel Server in a Clustered Environment, page 79

• Installing InputAccel Remoting, page 89

• Deploying Modules with the ClickOnce Deployment Utility, page 92

• Unattended Installations, page 97

• Manually Registering a Client Module to Run as a Service, page 101

Installing Multiple Instances of InputAccel Servers

Multiple instances of the InputAccel Server can be installed on a single machine (also called aside-by-side installation). A maximum of eight instances of InputAccel Server can be installed;although in typical installations, one InputAccel Server per four or eight cores is optimal. Variationsin how systems are configured, the types of hardware used, and customer-specific batch processingneeds make each situation unique, requiring experimentation to find the best balance betweennumber of processors per instance of the InputAccel Server.

Performance benefits of side-by-side installation include:• Each InputAccel Server instance runs its VBA engine within its server process, enabling betterparallel execution of batches when running on multi-processor machines.

• Enables InputAccel to be installed in an Active/Active clustered environment.

76

Preface

Note:• Side-by-side installation is required when installing the InputAccel Server in an Active/Activeclustered environment.

• Side-by-side InputAccel Server installations are not compatible with a hardware security key.

• ScaleServer groups normally provide some degree of business continuation in the event of aserver failure. However, if all members of a ScaleServer group are installed on the same physicalmachine, then a single point of failure will take out the whole system. So, do not install allmembers of a ScaleServer group on a single machine if the intent is to ensure high availability.

To install multiple instances of InputAccel Servers:

1. From the Installation Choices list of the InputAccel setup program, select Step 2 - Install theInputAccel Server. Click Next.

2. Choose a custom installation and click Next.

3. Select the number of InputAccel Server instances to install, and then click Next.

4. For each instance, click Change to specify a unique location for data files for each InputAccelServer, and then click Next.

Note: Each instance of the InputAccel Server must have its own principal folder. Each instanceis installed on its own directory. EMC recommends that for best performance the specifieddirectories be on separate physical hard disks and the directories reside on an NTFS partition.

5. Specify whether the server instances will be used in an Active/Active clustered configuration.

6. In the TCP/IP Settings window:• If multiple instances of the InputAccel Server are used in a clustered configuration, specify theIP address and Port for each server instance. To simplify client module connections, EMCrecommends using the default port for all server instances.

• If multiple instances of the InputAccel Server will not be used in a clustered configuration,specify a unique Port for each server instance.

7. The InputAccel 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 theInputAccel Server to be started as a service automatically when the system starts.

8. Click Install and then click Finish to complete the installation.

Note:• If you choose to start the InputAccel Server as a service automatically when the system starts,the setup program configures only the first InputAccel Server instance to automaticallystart. All other instances of the InputAccel Server are configured to run as services but arenot configured to start automatically. Use the Service Control Manager to configure theseadditional instances to start automatically.

• Before running the other instances, license the servers for a side-by-side operation. Withoutthe proper feature code, multiple servers will not startup on the same machine.

• With multiple instances of the InputAccel Server installed in an Active/Active clusteredconfiguration, you will not be able to run both of them on the same node at the same time.You must run both the InputAccel Servers on separate nodes until after you have licensedthem. If you attempt to run both servers on the same node at the same time, one of them will

77

Preface

not start (due to a lack of a server license containing feature code S) and the cluster serviceswill automatically move the resources for that server to the other node and start it up there.

9. Activate and license all installed instances of the InputAccel Servers.

10. To verify that multiple instances of the InputAccel Server are installed correctly:

a. Start any module in production mode.

b. When logging on, specify one of the InputAccel Servers and make sure the module connects.

c. Repeat these steps for each InputAccel Server instance.

Related Topics —

InputAccel Server Requirements, page 13InputAccel Server Considerations, page 29InputAccel Server Scalability, page 36Upgrading the InputAccel Server, page 133

Configuring Multiple InputAccel Servers as aScaleServer Group

A ScaleServer group of InputAccel Servers consists of two to eight InputAccel Servers connected tothe same network, and licensed and configured to work together as a single information capturesystem. The installation process for each InputAccel Server is the same as when installing a singleInputAccel Server.

ScaleServer technology uses a combination of licensing, server configuration parameters, andtechnology in the InputAccel Servers themselves. To configure a ScaleServer group, obtain a serverlicense that enables the ScaleServer technology. Refer to the Administration Guide to learn more aboutthe licensing feature codes for ScaleServer groups.

Note:• InputAccel client modules cannot connect to multiple independent InputAccel Servers—they canonly connect to multiple servers that are part of a ScaleServer group. For a list of client modulesthat are ScaleServer compatible, refer to Table 23, page 168.

• All InputAccel Servers within a ScaleServer group must access the same InputAccel Database.

To configure a ScaleServer group:

1. Install the required hardware and software on each InputAccel Server machine. Refer to Chapter2, System Requirements and Recommendations for details.

2. Install the InputAccel Server software on each server machine.

3. Install the Administration Console on a web server.

4. Run the Administration Console module and do the following to configure the ScaleServer group:

a. For each installed InputAccel Server, be sure to install and activate the Activation File (CAFfile) or attach the hardware security key.

78

Preface

b. Install valid ScaleServer licenses/feature codes on each InputAccel Server that is to be partof the ScaleServer group.

Note: Feature codes are established when the InputAccel Server license codes are installed.For details on server feature codes, refer to the Administration Guide.

c. Specify a ScaleServer group name and add a list of InputAccel Servers in the group.

d. Make sure the same users are in the InputAccel_Server_admin_group group on allInputAccel Servers in the ScaleServer group.

Refer to the Using Administration Console section in the Administration Guide for information onactivating InputAccel Servers, installing license codes, adding users and groups, and specifyinga ScaleServer group.

Note: When users running client modules connect to a ScaleServer group, they must specify theInputAccel Server machine name, not “localhost” or an IP address.

5. To verify that the ScaleServer group is functioning correctly:

a. Start a ScaleServer-compatible module in production mode. Refer to Table 23, page 168 for alist of modules that are ScaleServer-compatible.

b. When logging on, select the Connect to server group checkbox.

c. Run the Administration Console and verify that the client module is logged into all servers inthe ScaleServer group. Refer to the Using Administration Console section in the AdministrationGuide for details.

Related Topics —

InputAccel Server Requirements, page 13InputAccel Server Considerations, page 29InputAccel Server Scalability, page 36High Availability and Failover, page 46Upgrading the InputAccel Server, page 133ScaleServer Issues, page 159

Installing the InputAccel Server in a ClusteredEnvironment

This section explains how to install InputAccel within a Microsoft Cluster Server (MSCS) clusterof Windows servers.

Supported Operating SystemsSupported operating systems are the Enterprise or Datacenter editions of

• Windows Server 2008 R2

• Windows Server 2008

• Windows Server 2003 R2

79

Preface

Note:• InputAccel has been tested on an MSCS cluster of two nodes. Other configurations may work, butare not officially supported.

• InputAccel supports one InputAccel Server running in an Active/Passive mode, or two serversrunning in an Active/Active mode. When two InputAccel Servers are used, they can be configuredas a ScaleServer group or they can be used independently.

• For more information about Microsoft Cluster Server, refer to the Microsoft Cluster Server GeneralQuestions on the Microsoft website.

• Administrators must run the MSCS Cluster Administrator for all cluster configuration tasks,including defining each virtual server and its failover/failback rules. Refer to Microsoftdocumentation for more information on the MSCS Cluster Administrator.

• Make sure the InputAccel Server is shut down gracefully in a cluster. Refer to InputAccel ServerShutdown in a Clustered Environment, page 88.

General PrerequisitesBefore configuring InputAccel Server in a Microsoft server cluster, make sure your environmentmeets these requirements:

• The supported Windows Server version must be set up in a clustering configuration on multiple(minimum of two) separate hardware platforms.

• The Microsoft Server Cluster must include a Storage Area Network (SAN) device.

InputAccel Server PrerequisitesBefore configuring InputAccel Server in a Microsoft server cluster, you must make sure that eachInputAccel Server configured to run in the cluster has the following dedicated resources:

• Cluster disk for locating the \IAS folder

• Static IP address by which clients will access the InputAccel Server as a clustered application.— Windows Server 2008 and 2008 R2: When both IPv4 and IPv6 protocols are enabled, only asingle static IPv4 address is required, and the cluster automatically creates the correspondingIPv6 address.

— Windows Server 2003 R2: Only a single IPv4 address is supported for the InputAccel Server inthe cluster. IPv6 cannot be configured within MSCS on Windows Server 2003 R2.

Requirements of the Cluster Environment:• Create a cluster environment according to Microsoft best practices. Refer to the Microsoft websiteto find resources relating to server clusters.

• All machines are members of the same domain.

• Two identically configured node machines are running on a supportedWindows Server OperatingSystem.

• If the domain user account used to run the InputAccel Server service is not a local administratoron each cluster node, then grant this account Full Permissions to access the cluster. This can bedone in Failover Cluster Manager or Cluster Administrator. Access the Properties panel forthe cluster and select the Cluster Permissions tab (in Failover Cluster Manager) or Securitytab (in Cluster Administrator) and add the domain user with Full Control permission. Restartthe cluster nodes after making this change.

80



Preface

Topics in this section include:• Installing InputAccel Servers into an MSCS Cluster, page 81

Installing InputAccel Servers into an MSCS Cluster

These instructions are primarily oriented for the installation of two InputAccel Servers into anActive/Active cluster. For installation of a single InputAccel Server into an Active/Passive cluster,ignore references to the second server instance, second application group, or second cluster disk. Anysignificant differences between Active/Active cluster and Active/Passive cluster installation stepsare specifically mentioned.

To install InputAccel Servers into an MSCS Cluster:

1. Set up the cluster environment as detailed in Requirements of the cluster environment.

2. Define the cluster resources for InputAccel running in a cluster.

3. Verify that both InputAccel Server cluster drives are accessible from the first cluster node.

4. Install InputAccel Server on the cluster nodes.

5. Register the InputAccel Server cluster resource DLLs with the cluster.

6. Move both cluster disks to second node and install the InputAccel Server on the second clusternode.

7. Complete the InputAccel Server cluster application configuration.

8. Complete additional configuration of server parameters in Administration Console.

9. Activate and license the InputAccel Server in an Active/Active cluster.

To define the initial cluster resources for InputAccel running in a cluster:

1. Using MSCS Cluster Administrator or Failover Cluster Manager, define the initial clusterresources for InputAccel running in a cluster.

2. Create preliminary application resource groups for each InputAccel Server installed into thecluster. As a best practice, create these cluster applications with a single disk resource allocated,then install the InputAccel Server on both nodes, and finally complete the remainder of thecluster application configuration by adding the remaining resources of IP Address, DNS Name,and InputAccel Server Resource Type.

a. For Windows Server 2008 or Windows Server 2008 R2:

i. Connect to the cluster using Failover Cluster Manager snap-in.

ii. In the Failover Cluster Manager console tree in the left pane, click Storage. The availablecluster drives are displayed under Available Storage.

iii. Right-click Services and applications, then selectMore Actions > Create Empty Serviceor Application. A new application named New Service or Application is created.

iv. Rename the application to indicate that it is the first InputAccel Server. This name is usedonly for display purposes in the cluster administration user interface.

81

Preface

v. Repeat steps iii and iv to create a second application (for Active/Active cluster) andrename it to indicate it is the second InputAccel Server.

vi. Edit the Properties of these new applications to define the preferred owners on eachapplication. Typically the first InputAccel Server should have preferred owner of Node 1,and the second InputAccel Server a preferred owner of Node 2.

vii. Add storage to each of these applications by adding the appropriate cluster diskresource to each application. Under Service and applications, select the application,right-click and select Add Storage, and select the checkbox for the first InputAccel Servercluster disk (for example, drive R). Repeat the process for the second InputAccel Serverapplication if creating an Active/Active cluster (for example, add drive S as the storageon the second InputAccel Server application).

viii.Move both applications to the first cluster node so they are owned by the first clusternode.

Note: In Active/Passive cluster, there is only one application and it should be owned byfirst cluster node).

b. For Windows Server 2003 R2: Create Resource Groups for each InputAccel Server installedinto the cluster

i. Connect to the cluster using Cluster Administrator utility.

ii. Typically, there are default resource groups created for each cluster drive when thecluster service is initially installed. Most commonly, you will find a group named “Group0” that contains the first InputAccel Server cluster disk resource, and a group named“Group 1” that contains the second InputAccel Server cluster disk resource. In the case ofActive/Passive cluster, there will only be a single resource group.If the groups are not created correctly, manually create a new group. Select Groups,right-click and select New > Group and enter a new group name. Move the cluster diskresources into the appropriate groups. The first InputAccel Server group should containthe first InputAccel Server cluster disk, and the second InputAccel Server group shouldcontain the second InputAccel Server cluster disk.

iii. Rename each resource group to indicate which InputAccel Server it represents. Thisname is used only for display purposes in the cluster administration user interface.

iv. Edit the Properties of these resource groups and define the preferred owners for eachgroup. Typically Node 1 would be preferred owner for first InputAccel Server, and Node2 would be preferred owner for second InputAccel Server.

v. Move both groups to the first cluster node so they are both owned by the first cluster node.

Note: In Active/Passive cluster, there is only one group and it should be owned by firstcluster node.

To verify that both InputAccel Server cluster drives are accessible from the firstcluster node:

1. Start Windows Explorer.

2. Verify that both InputAccel Server cluster drives are accessible from the first cluster node. In thecase of Active/Passive cluster, there is only be one InputAccel Server cluster drive.

82

Preface

To install InputAccel Server on the first cluster node:

1. On the first cluster node, start the InputAccel setup program from the installation media. If thesetup program does not start automatically after a few seconds, or if running the installation froma local disk or network share, open the file autorun.exe to begin.


3. From the Installation Choices list, select Step 2 - Install the InputAccel Server.

4. If prompted to install prerequisite applications, click Install. The prerequisite software for theInputAccel Server is installed.

5. Remove the USB security key, if used, and then click Continue and then click Next.

6. Accept the license agreement.

7. Select Custom installation.

8. Select all features.

9. Select two server instances (for Active/Active cluster), or one server instance (for Active/Passivecluster).

10. Accept the default location of Application files or select a different local location. Do not installapplication files onto the clustered disk.

11. Specify the \IAS folder for the Data files on the cluster disks. The data directories must belocated on a cluster disk and not a local drive.

12. For installing into an Active/Active cluster.

a. Select Yes when asked if these disks are required in an MSCS Active/Active environment.

b. Enter two IPv4 addresses and two port numbers.• If using IPv4 protocol, enter the two IPv4 addresses designated for use by the 2 InputAccelServers in the cluster.

• If using IPv6 protocol in addition to IPv4 protocol, (in dual-listening mode), enter the IPv6addresses at a later time through the Administration Console.

• If using only IPv6 protocol, enter placeholder IPv4 addresses and delete them laterthrough the Administration Console. You can then enter the IPv6 addresses.

• For the port numbers, use the same default value of 10099 for both of your InputAccelServers.

13. Specify the user account under which the InputAccel Server service will run. This can beconfigured for Local System or for a domain user account. The domain account can be any regulardomain user and does not have to be a member of the Administrators group on the machine.

Caution: If the domain account is not a local administrator on the cluster nodes, it must beadded to the cluster permissions as described in Requirements of the Cluster Environment:,page 80.

14. Clear the Automatically start the InputAccel Server service when the system starts checkbox.The service startup mode for the InputAccel Server services must be set toManualwhen runningit in a cluster.

15. Enter the database credentials for the InputAccel Database previously installed.

83

Preface

16. Specify the user account name and domain for the account that will run the AdministrationConsole during theWeb Components installation.

17. When the installation completes, clear the Start the InputAccel Server service when setupcompletes checkbox.

To register the InputAccel Server cluster resource DLLs with the cluster:

1. Open a command window and navigate to the first InputAccel Server executable folder. Bydefault, this folder is C:\Program Files\InputAccel\Server\Server\binnt.

2. Execute the CreateIAResType.bat batch file. A confirmation message displays.

3. If you installed two InputAccel Server instances, then navigate to the second IA Server executablefolder and execute the CreateIAResType.bat file again.

To move both cluster disks to second node and install the InputAccel Server onthe second cluster node.

1. Move the InputAccel Server applications or resource groups to the second cluster node. There isonly one application/resource group for Active/Passive cluster).

2. Repeat steps To install InputAccel Server on the first cluster node:, page 83 to install InputAccelServer on the second cluster node.

To complete the InputAccel Server cluster application configuration:

1. Complete the cluster application or cluster resource groups configuration.

a. For Windows Server 2008 or Windows Server 2008 R2. Perform these steps on eachInputAccel Server cluster application:

i. Connect to the Failover Cluster Manager snap-in.

ii. Add a Client Access Point resource. This resource enables you to define both the IPaddress and Network Name by which this InputAccel Server is accessed over thenetwork. Under the console tree in the left pane, under Services and applications,right-click the InputAccel Server application and select Add a resource > Client AccessPoint. Enter the following information:• Name: The Network Name (hostname) by which this InputAccel Server is accessedover the network by client modules and the Administration Console.

• Address: Enter the static IPv4 address that is used to access this InputAccel Server.This is the address which is registered with the DNS for the name you just entered. IfIPv6 protocol is enabled, an IPv6 address is automatically generated by the cluster.

• Verify that the resource can be brought online.

iii. Right-click on the InputAccel Server application and select Add a resource > Moreresources… > Add InputAccel. Do not bring this resource online yet. This adds theInputAccel Server into the clustered application. To add a second InputAccel Server,right-click on the second InputAccel Server application and select Add a resource > Moreresources… > Add InputAccel2.

Caution: A message “The resource type Add InputAccel is notconfigured on all nodes. Do you wish to continue and create

84

Preface

the resource? indicates the InputAccel Server is not installed onto both clusternodes.

iv. Edit the Properties of the New InputAccel resource:1. Under the General tab, change the name to InputAccel. For the second server,

change the name to InputAccel2.

2. Under the Dependencies tab, insert two dependent resources: The Cluster disk andthe Name resource for this InputAccel Server.

3. Under the Policies tab, select the required settings.

Note: Until the InputAccel Server is fully licensed and operational, we recommendchanging the setting of Response to resource failure to If resource fails, do notrestart. This setting can be reconfigured later as required.

4. Under the Advanced Policies tab, ensure that both cluster nodes are enabled aspossible owners.

v. Attempt to bring the InputAccel resource online. In an Active/Active cluster, it shouldcome online successfully. In an Active/Passive cluster, it will fail to come online initially,but will come online successfully once the TcpIpAddress parameter is configuredin the Administration Console.

Note: It is necessary to make at least one attempt to bring the InputAccel resource onlinebefore editing the parameters in the Administration Console.

vi. In an Active/Active cluster installation, repeat all steps (ii - v) to configure the secondInputAccel Server. Use a different name and static IP address, and select the resourcetype as InputAccel2.

vii. Verify you can successfully move each InputAccel Server application back and forthbetween nodes.

Note:• In an Active/Passive cluster, this can be accomplished after the TcpIpAddressparameter is configured in the Administration Console.

• In the case of Active/Active cluster installation, until you have installed the CAF filesand correctly licensed these servers, you will not be able to bring both InputAccelServer resources online on the same node at the same time. You can bring them bothonline simultaneously as long as they are on different nodes. Once they are licensed,this restriction will no longer apply and both can run on same node.

b. For Windows Server 2003 R2. Perform these steps on each InputAccel Server clusterapplication:

i. Connect to the Cluster Administrator and configure the preliminary virtual serverapplications. The existing resource groups which contain only a disk need to be fullyconfigured with both the IP address and Network Name by which this InputAccel Serveris accessed over the network

ii. Right click on the first InputAccel Server group and select Configure Application. TheCluster Application Wizard starts.

iii. Click Next, then select Create a new virtual server and click Next.

85

Preface

iv. Select Use an existing resource group, select from the list the resource group names toconfigure, then click Next.

v. Provide a descriptive name for the group.

vi. Enter the Network name used to access the InputAccel Server over the network by clientmodules and the Administration Console.

vii. In the IP Address field, enter the static IPv4 address used to access this InputAccelServer application. This is the address which is registered with the DNS for the namespecified. Click Next.

viii. In the Advanced Properties window, edit properties of these newly defined resourcesif required. Click Next.

ix. Select Yes, create a cluster resource for my application now and click Next.

x. If configuring the first InputAccel Server resource group, select InputAccel from the list.If configuring the second InputAccel Server, select InputAccel2. Click Next.

xi. Provide the InputAccel Server resource a descriptive name, and then click AdvancedProperties.

xii. Under Advanced Resource Properties, make the following configurations:• General: Ensure that both cluster nodes are possible owners.

• Dependencies: ClickModify and add both the Physical Disk and Network Nameresources as dependencies.

• Advanced: Edit if required.

Note: Until the InputAccel Server is fully licensed and operational, we recommendthe failure setting be changed to Do not restart. This setting can reconfigured later asrequired.

xiii. Click Next and then Finish.

xiv. Attempt to bring the InputAccel resource online. In an Active/Active cluster, it shouldcome online successfully. In an Active/Passive cluster, it will fail to come online initially,but will come online successfully once the TcpIpAddress parameter is configuredin the Administration Console.

Note: It is necessary to make at least one attempt to bring the InputAccel resource onlinebefore editing the parameters in the Administration Console.

xv. In an Active/Active cluster installation, repeat all steps (steps ii — xiv) to configure thesecond InputAccel Server. Use a different name and static IP address, and select theresource type as InputAccel2.

xvi. Verify you can successfully move each InputAccel Server application back and forthbetween nodes.

Caution: In the case of Active/Active cluster installation, until you have installedthe CAF files and correctly licensed these servers, you will not be able to bringboth InputAccel Server resources online on the same node at the same time. Youcan bring them both online simultaneously as long as they are on different nodes.Once they are licensed, this restriction will no longer apply and both can run onsame node.

86

Preface

To complete additional configuration of server parameters in Administration Console:

1. Install the Administration Console on a separate web server, using the InputAccel WebComponents installer.

2. Bring both InputAccel Servers online simultaneously on different nodes. In the case ofActive/Passive cluster, bring the InputAccel Server online on either node.

3. Log into the Administration Console web application. Navigate to the Licensing / Security pane.

4. Click View Roles, then double-click on the Administrators role to open its settings.

5. Under Selected Members, add the account under which the Administration Console runs tothe Administrators role. This is the account you specified during the installation of the WebComponents.

6. Navigate to the Systems pane and click on View Servers. You should see the two InputAccelServers (or in the case of Active/Passive cluster, just one InputAccel Server) listed here. Thenames of these servers should match the Network Name that was configured for each server inthe cluster. Delete additional machine names for either of the cluster nodes.

7. Double-click on each of the InputAccel Server names to bring up the Server Settings screenfor that server. Enter the following values under the Startup Setting column and click OKafter making all the changes to these values.• Ensure the TcpIpPort value is set to the default value of 10099 (on both servers) unless there isa specific need to use a different port.

• The TcpIpAddress value should contain the static IPv4 address resource assigned to thisInputAccel Server in the cluster. If you installed only one InputAccel Server instance (forActive/Passive), this value is initially blank. Enter the IPv4 address. If not using IPv4 protocolat all, then leave this value blank.

• The TcpIpv6Address is initially blank. To use IPv6 protocol (whether as an alternative to IPv4,or in addition to IPv4), enter the static IPv6 address assigned to this InputAccel Server in thecluster. If this address was generated automatically by the cluster configuration, review the IPaddress properties for this resource in the Failover Cluster Manager snap-in. If you manuallyentered the IPv6 address during cluster configuration, enter the same address.

• The DisableIPv4 value must be 0, unless required to disable IPv4 protocol.

• The DisableIPv6 value must be 0 if you intend to use IPv6 protocol and 1 otherwise.

• In a two InputAccel Servers installation into an Active/Active cluster, enter the appropriatevalues for both servers.

8. Restart all InputAccel Servers.

9. Verify that the server settings values are as specified in the Startup Settings column and theActive Setting column.

To activate and license the InputAccel Servers on both cluster nodes:

To activate and license the InputAccel Server in a cluster, you must activate each InputAccel Servertwice, once for each node in the cluster using the Activation IDs received from EMC.

1. Run Administration Console.

2. From the navigation panel, select Licensing / Security, and then select View Server Activations.The Server Activations pane displays all InputAccel Servers listed with their network names

87

Preface

followed by their service names, for instance IASERVER1 (InputAccel) and IASERVER2(InputAccel2). The Server ID is displays 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 tothe 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 InputAccelServers display an activation state of Initial Grace Period.

Note: You cannot use the same CAF file for both servers.

To activate the servers, you need one Server ID and four Profile IDs and each InputAccel Serverin the cluster. To obtain these Profile IDs, each InputAccel Server must be run on each clusterednode, as the Profile ID is different on each node.

5. Import license codes for both servers. Do this before continuing with activation and movingservers between nodes.

6. Run the Failover Cluster Manager or Cluster Administrator and start IASERVER1 on Node 1and IASERVER2 on Node 2.

7. Run Administration Console and navigate to the Server Activations page.

8. Select IASERVER1, and then click Activate Server. Note the Server Serial Number and ProfileID. Repeat for IASERVER2 (for an Active/Active cluster).

9. Use Cluster Administrator to move each InputAccel Server to the other node. Now repeat steps6–7 and obtain the second set of Serial Numbers and Profile IDs.

10. In the Server Activations page in Administration Console, select the Online InputAccel ServerActivation link, or go to http://activation.captivasoftware.com and request activation keys for thefour Profile IDs. For each profile ID, provide the Server Serial Number.

11. When you receive the activation keys from EMC, you can activate the InputAccel Server for eachnode. Run Administration Console 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 InputAccel Server Profile ID, and then click OK. The Statecolumn for the server displays “Activated”.

14. Repeat steps 12–13 for the second InputAccel Server.

15. Run Failover Cluster Manager or Cluster Administrator to move each InputAccel Server tothe other node.

16. Repeat steps 10–14 to activate the InputAccel Servers on the other node.

17. Use the Failover Cluster Manager or Cluster Administrator to move the InputAccel Serverapplications to the other node again and verify that they remain activated in AdministrationConsole. In Active/Active cluster, move the InputAccel Server applications so that both serversare running on Node 1, verify they are activated, then move both applications to Node 2, andverify again they are activated.

InputAccel Server Shutdown in a Clustered EnvironmentFor users installing InputAccel Server in a MSCS on Windows Server 2003 R2 or Windows Server2008: EMC recommends upgrading to Windows Server 2008 R2. If the InputAccel Server is installedin a MSCS environment on Windows Server 2003 R2 or Windows Server 2008, make sure to manually

88

http://activation.captivasoftware.com

Preface

stop the InputAccel Server service before shutting down or restarting the machine. Otherwise,unsynchronized batches may lose data.

For users installing the InputAccel Server in a MSCS on Windows Server 2008 R2: The InputAccelServer installer updates the ShutdownTimeoutInMinutes cluster property to provide theInputAccel Server with 20 minutes for graceful shutdown. If required, modify this configuration toincrease the shutdown time and allow the InputAccel Server adequate time to shutdown. Typicallythe InputAccel Server shuts down within 30 seconds, but depending on server load, it may take 20minutes or more. The MSCS terminates services that take longer to shut down than the time specifiedby ShutdownTimeoutInMinutes, which may result in unsynchronized batches losing data.

To verify the value of the ShutdownTimeoutInMinutes cluster property, use the command:cluster /properties.

To set the value of ShutdownTimeoutInMinutes to the time required by theInputAccel Server to gracefully shutdown, use the command: cluster /propertiesShutdownTimeoutInMinutes=N

where

where N is the maximum number of minutes required by the slowest service running in the cluster togracefully shutdown. For example: cluster /properties ShutdownTimeoutInMinutes=30

Installing InputAccel Remoting

The InputAccel Remoting web component must be installed on a web server if the ScanPlus,RescanPlus, and IndexPlus client modules need to access the InputAccel Server remotely over anHTTP connection.

Note:• If installing on a machine running IIS 7.0 (with Windows Server 2008) or IIS 7.5 (with WindowsServer 2008 R2), make sure you first run IIS 6.0 Management Compatibility before installingInputAccel Remoting.

• InputAccel Remoting can only be installed on a web server that has IIS 6.0, IIS 7.0,or IIS 7.5installed.

LimitationsWhen using InputAccel Remoting with a ScaleServer group, note the following limitations:• Automatic group name resolution does not work. This means that you cannot use the Connect ToServer Group check box in the Logon window of a remote client.

• The configuration of ScaleServer group members cannot be dynamically modified while clientmachines are connected to one or more InputAccel Servers through InputAccel Remoting.

89

Preface

Prerequisites before Installing InputAccel RemotingIIS 7.0 Prerequisites on Windows Server 2008 or Windows VistaIf installing InputAccel Remoting on a machine running Windows Server 2008 or Windows Vista:• Make sure IIS 6.0 Management Compatibility is run before installing InputAccel Web Components

• In addition to the security settings enabled for a standard IIS 7.0 configuration, enable theseadditional role services security settings:— Basic Authentication



IIS 7.5 Prerequisites on Windows Server 2008 R2 or Windows 7If installing InputAccel Remoting on a machine running Windows Server 2008 R2 or Windows 7:In addition to the settings that enabled for a standard IIS 7.5 configuration, enable these additionalrole services settings:• Application Development

— ASP.NET

— .NET Extensibility

— ISAPI Extensions

— ISAPI Filters

• Security— Basic Authentication



• IIS 6 Management Compatibility— IIS 6 Metabase Compatibility

— IIS 6 WMI Compatibility

— IIS 6 Scripting Tools

— IIS 6 Management Console

Note: Make sure that Common HTTP Features andManagement Service features are also enabled ifthey are not enabled by default.

To install InputAccel Remoting:

1. From the Installation Choices list of the InputAccel setup program, select Step 4 - Install theInputAccel Web Components.

2. If prompted to install prerequisite applications, click Install. The prerequisite software forInputAccel Web Components is installed.

3. Click Next.

4. In the License Agreement window, select I accept the terms in the license agreement, andthen click Continue.

90

Preface

5. In the Custom Setup window, select InputAccel Remoting as the feature to install, and thenclick Next.

Note: The Administration Console and InputAccel Remoting features cannot be installed on thesame machine.

6. In the Destination Folder window, click Next to install to the default destination directories.Otherwise, click Change to select a new location.


7. In the Data Access Layer Registration window, enter the Login ID and Password credentialsfor connecting to the SQL Server, and then click Next. By default, Register the Data AccessLayer with the InputAccel database is selected and the local Database server on Port 1433, andInputAccel Database are specified.

8. In the InputAccel Web Site User Account window, specify the Username, Password, andDomain credentials for the Windows user account that will run the InputAccel Web Componentswebsite.

9. In the InputAccel Web Components window, specify the following:

a. In the InputAccel web site description field, enter a description for the web componentswebsite.

b. From the IP address to use for this web site list, select the appropriate IP address.

Note: Each InputAccel Server to be configured for access through InputAccel Remoting musthave its own URL. Using a single web server, this can be accomplished by creating a separatevirtual directory with IIS for each InputAccel Server. Each virtual directory is identicalexcept that its Network.Hostname parameter in the web.config file points to a uniqueInputAccel Server.

c. In the TCP port this web site should use field, enter the port number and then click Next.

Note: If the selected port is already in use, the TCP Port Conflict window displays. Todisable the website currently assigned to the port, select Stop the web site. It will no longerbe available unless you reconfigure it.

10. In the InputAccel Server Connection Information window, specify the Server name and Serverport of the InputAccel Server to which the InputAccel Remoting component must connect to.Click Next.

11. In the InputAccel remote Access window, specify a virtual web directory, which by defaultis named InputAccelRemoting. This directory is used to enable client modules access to theInputAccel Server and the InputAccel Database. Click Next.


13. To verify that InputAccel Remoting is installed correctly:

a. Start ScanPlus, RescanPlus, or IndexPlus in production mode.

b. Specify the URL of the InputAccel Remoting server in the Server name field.If you used the default virtual web directory, then an example of the URL is:http://hostname:port/InputAccelRemoting.

91

Preface

c. Confirm that the module connects to the InputAccel system.

Related Topics —

Chapter 3, Installation PlanningInputAccel Remoting Server Considerations, page 31Installing the Administration Console, page 59

Deploying Modules with the ClickOnce DeploymentUtility

InputAccel includes these web-deployable client modules: ScanPlus, RescanPlus, and IndexPlus.InputAccel also includes a ClickOnce Deployment Utility that provides administrators with analternate method to deploy these modules. The utility copies the necessary programs and applicationfiles to the web server or network file share based on the environment. Depending on the parametersset by the administrator, prerequisite software is installed on the client machine during deployment,and updates are automatically downloaded and installed as necessary. This enables administrators toinstall and maintain software for users in distributed locations.

Prerequisites• Acquire a valid SSL certificate in PFX format for the application that is deployed using theClickOnce Deployment Utility. Administrators can use any authorized Signing Authority(VeriSign, for instance) for acquiring the SSL certificate.

• You must have ClickOnce publishing skills and ClickOnce technology know-how before choosinga ClickOnce deployment strategy.

• If the ClickOnce application is to be deployed to a website and downloaded using a URL, usethe IIS Manager snap-in feature of the Microsoft Management Console to configure the webserver as follows for each installation package:

— For each installation package, deployed through ClickOnce, create a virtual directory underthe InputAccel Web Components website.

— For each of the virtual directories created, set the Virtual Directory Access Permissions to“Read”, “Run Scripts (such as ASP)”, and “Write”. Do not enable “Execute” permissions.

— For each of the virtual directories created, configure the Security settings so that the connectinguser (for example, the Internet Guest Account user) has Read, Write, and Modify permissionsset to “Allow.”

— Under IIS Web Service Extensions, change the WebDAV Service Extension Status field fromProhibited to Allowed.

Note:• If configuring Microsoft IIS 7.0/ 7.5 for ClickOnce deployment, you cannot deploy the applicationsdirectly by HTTP protocol. Instead, deploy these modules to a Windows network file shareusing the procedure described in Workaround for Deploying ClickOnce Modules on IIS 7.0 and7.5, page 96.

• If deploying ScanPlus, RescanPlus, or IndexPlus on a 64-bit operating system, use the proceduredescribed in Workaround for Deploying ClickOnce Modules on a 64–bit Operating System,page 96.

92

Preface

To deploy modules with the ClickOnce utility:

1. Install the ScanPlus ClickOnce Package, RescanPlus ClickOnce Package, and IndexPlus ClickOncePackage from the client installer.

2. Select Start > Programs > InputAccel > ClickOnce Deployment Utility to run the ClickOnceDeployment Utility on the machine where the packages have been installed. The DeployInputAccel Application window displays.

3. Select an application to deploy, and supply a URL where application support can be obtained:

a. Select Application from the navigation panel. The Application Options pane displays.

b. Select the ClickOnce application to deploy from the Select an application to deploy list box.

c. Under Provide application deployment options, select the options appropriate for thedeployment. Also, accept the default values for the options selected or provide the valuesapplicable:• Publish version: Version of the deployed application.

• Publisher: Name of the organization deploying the module.

• Product: The name of the deployed module.

Support URL: The URL where support information for the module resides. The defaultlocation is http://www.emc.com/captiva

4. Set the parameters for deployment:

a. Select Deployment from the navigation panel to display the Deployment Options pane.

b. Under General deployment options, select the options appropriate for the deployment.Also, accept the default values for the options selected or provide the values applicable:• Application URL: The URL or network file share that is used to access the ClickOnceapplication. The URL should not include the deployment manifest name. For example,if the URL is set to http://server/virtualdirname for the ScanPlus application,the ClickOnce utility writes http://server/virtualdirname/ScanPlus.application to the deployment manifest.

• Installation URL: The URL or network file share where the application files are copied. Ifthis parameter is not specified, the files are copied to the Application URL.

• Use a “.deploy” file name extension: Select to add a “.deploy” extension to applicationfiles. This value is set to Yes by default.

• Allow URL parameters to be passed to the application: Select to enable query stringsto be passed to the application. This parameter is set to Yes by default. This parameterensures that the deployed application (accessed by the application URL) can be run byusers in setup mode.

Caution: Setting this parameter to No prevents the application from running insetup mode or passing login information.

93

http://www.emc.com/captiva

Preface

c. Under Choose installation mode, select the options appropriate for the installation of theapplication. Also, accept the default values for the options selected or provide the valuesapplicable:• The application is only available online: Select to make the application available fromthe location specified in the Application URL field.

• The application should be installed locally: Select to make the application available fromthe Windows Start menu. The application can then be uninstalled from the WindowsControl Panel.

5. (Optional) Specify options that determine how often the module checks for updates, the locationwhere updates can be obtained, and the base version of the application to use when checkingfor available updates:

Note:• Automatic updates can only be scheduled for local installations.

• If the automatic update feature is enabled, the ClickOnce application periodically reads itsdeployment manifest file to check for updates. If an update is available, the new versionof the application is downloaded.

a. Select Update from the navigation panel. The Update Options pane displays.

Note: The Update Options pane is available only when an application is deployed locally. Ifthe installation mode is set to The application is only available online on the DeploymentOptions pane, a warning displays aModify deployment options... link. Click this link toreturn to the Deployment Options pane. Select The application should be installed locallyoption to enable the Update Options pane.

b. From the Update Options pane, select the options appropriate for the deployment.• The application should check for updates: Select to ensure that the application checksfor updates based on the frequency and version specified.

• Choose when the application should check for updates: Select the appropriate option sothe module checks for updates either before or after starting.

• Choose how often the application should check for updates: Specify how often themodule should check for updates.

• Specify URL from which the application updates should be downloaded:Type the complete URL where the application resides and where updates can beobtained. The URL should include the deployment manifest name. For example,http://server/virtualdir/ScanPlus.application for the ScanPlus module.

• Specify a minimum required version for the application which can updated: Specify abase version of the application to be used for updates. You must enter a minimum versionnumber which is a version number higher than the version currently installed.

6. (Optional) Create a bootstrap installation program for installing prerequisites required by themodule being deployed. This is selected by default. This enables automatic installation of moduleprerequisites as part of the deployment process:

a. Select Prerequisites from the navigation panel. The Prerequisites and Bootstrap Optionspane displays.

94

Preface

b. Select the options appropriate for the deployment:• Create setup program to install prerequisite components: Select to create a bootstrapinstallation program that installs prerequisite components as part of the deploymentprocess.

• Specify the install location for prerequisites: Select a location where the prerequisitecomponents reside. This location can be a vendor’s website, the same location as theapplication being deployed, or any other accessible location. To specify a URL or file path,select the Download prerequisites from this location option, and type a valid path inthe associated field.

Note:• Administrator rights may be needed for users to install prerequisites.

• If the client machine does not have the Visual C++ Runtime prerequisite installed, themodule fails to connect to the InputAccel Server.

7. Specify how the application should sign the deployment manifest. Signing can be done from apassword protected file, or from a stored certificate, and can be associated with a timestamp toreduce issues that might be encountered if a certificate used for signing has expired.

a. Select Signing from the navigation panel. The Deployment Manifest Signing Optionspane displays.

b. Under Choose how to sign the deployment manifest area, select from the following options:• Sign the deployment manifest with this certificate file

— In the File field, type the file name and location for the certificate file, or click theBrowse button to browse to the correct file.

— In the Password field, type the password for the certificate file, if necessary.

• Sign the deployment manifest with a stored certificate:

— In the Certificate: field, type the name and path of the stored certificate, or click theSelect button to select a certificate stored on the local system.

c. In the Timestamp URL: field, type the URL of a supported time stamping service to populatethe certificate with a current time and date during the publishing process. When a publishedapplication’s certificate expires, the time stamp service can be called upon by the client toverify whether the application was signed while the certificate was still valid, enabling theexpired certificate to remain in use.

8. If the ClickOnce application is deployed to a website and downloaded using a URL, be sure thenecessary prerequisites and permissions have been configured as explained under Prerequisites,page 92.

9. Click the Deploy button to deploy the selected application with the selected settings.

10. Provide the URLs, IP addresses, or Share name of the deployment that users need to install theapplications. Examples of the URL that user should run to install ClickOnce applications:• http://server/virtdir/ScanPlus.application (in case no bootstrap installer wascreated)

• http://server/virtdir/ScanPlusSetup.exe (in case bootstrap installer was created)

• \\server\dirname\IndexPlus.application (in case of deployment to network share)

95

Preface

11. To verify that the ClickOnce modules are deployed correctly, click the link provided in theDeployment successfully finished window.If the deployment fails, the ClickOnce Deployment Utility displays a message indicating the errorthat occurred. The following most likely errors are due to incorrect configuration of items listedin Prerequisites, page 92:• (401) Unauthorized: This error will occur if the virtual directory permissions are not setcorrectly.

• (404) Not Found: This error will occur if the virtual directory properties grant the user fullExecute permissions. Change the permissions to Execute Scripts Only.

• (501) Not Implemented: This error will occur if the WebDAVWeb Service Extension is not setto “Allowed.”

• (503) Server Unavailable: This error will occur if deployment is performed onto a machinewith the 64-bit operating system. See Workaround for Deploying ClickOnce Modules on a64–bit Operating System, page 96 for a workaround.

Workaround for Deploying ClickOnce Modules on IIS 7.0 and 7.5Deploying ScanPlus, RescanPlus, or IndexPlus directly by HTTP protocol to a Microsoft IIS 7.0 orIIS 7.5 web server is not supported. Instead, deploy these modules to a Windows network file shareusing the ClickOnce Deployment Utility.

To deploy ClickOnce modules to a Windows network fileshare:

1. On the web server, create a Windows network file share and a virtual directory.

2. When deploying the modules using the ClickOnce Deployment Utility, specify the virtualdirectory HTTP path in the Application URL field. This is the URL required to access themodules.

3. Specify the Windows network file share in the Installation URL field. This is the location wherethe application files are copied.

4. Complete the remaining deployment steps previously listed in Deploying Modules with theClickOnce Deployment Utility, page 92.

Related Topics —

ClickOnce Host System Considerations, page 30Installing InputAccel Remoting, page 89

Workaround for Deploying ClickOnce Modules on a 64–bitOperating SystemIf deploying ScanPlus, RescanPlus, or IndexPlus on a 64-bit operating system, either make sure youdeploy the modules to a Windows network file share or that you configure IIS to start 32-bit workerprocesses.

To configure IIS to start 32-bit worker processes:

1. Open a command window and type CSCRIPT%SYSTEMDRIVE%\Inetpub\AdminScripts\adsutil.vbs SETW3SVC/AppPools/Enable32bitAppOnWin64 1.

96

Preface

2. Restart the Application Pool.

3. Complete the remaining deployment steps previously listed in Deploying Modules with theClickOnce Deployment Utility, page 92.

Related Topics —

ClickOnce Host System Considerations, page 30Installing InputAccel Remoting, page 89

Unattended Installations

The InputAccel installers enable unattended and silent installations of InputAccel. Unattendedinstallations are performed without user interaction during its progress. It also enables users toperform remote installations of InputAccel. A silent installation does not display messages orwindows during its progress. A command line is used to specify the InputAccel features to install andthe 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 propertiesare simple key/value pairs specified with PROPERTY=VALUE syntax.

Install InputAccel components in the following order when performing a silent installation:1. InputAccel Database

2. InputAccel Server

3. InputAccel web components

4. InputAccel client components

Refer to the Command line instructions section for examples of command lines that silently installInputAccel.

This section includes the following topics:• Understanding Installation Command Line Arguments, page 97

• Command Line Considerations, page 99

• Installing InputAccel from a Command Line, page 99

• Automating Unattended Installations, page 100

• Modifying Unattended Installations, page 100

Understanding Installation Command Line Arguments

The following command line arguments are available when installing InputAccel features inunattended or silent mode:

97

Preface

Table 14. InputAccel Installation Command Line Arguments

Argument Description

Setup.exe Use the Setup.exe installation executable located on theinstallation media. Access these directories where the InputAccelMicrosoft Installer (MSI) files reside:• Databases\setup.exe: Installs the SQL database.

• Server\setup.exe: Installs the InputAccel Server.

• Clients\setup.exe: Installs the InputAccel client modules.

• WebComponents\setup.exe: Installs Administration Consoleand InputAccel Remoting.

/s InstallShield argument that executes a silent setup.

/v InstallShield argument that passes command line options andvalues of public properties to msiexec.exe.

The entire MSI argument line must be enclosed in quotesimmediately following the /v switch. For example, enable loggingof installer messages to the file c:\temp\logfile.txt asfollows:

setup.exe /v"/l*v "c:\temp\logfile.txt""

/v is an InstallShield argument and the /l*v are msiexec.exearguments. Include the “*” wildcard parameter (encompasses allparameters except the verbose parameter) along with the v, orverbose, parameter to create a detailed log of the installation.

/l InstallShield argument that creates a log file that can be used totroubleshoot installation issues.

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 bespecified.

Windows Installer properties Specifies an installer action.

Features to install Installs the specified InputAccel features. For example, thefollowing command line installs an InputAccel Server:

setup.exe /s /v"/qn ADDLOCAL="ALL" SERVER_INSTANCES="1" IA_SERVICES_RUNAS_LOCAL_SYSTEM="1"/promptrestart"

Related Topics —

98

Preface

Supported InstallShield Switches, page 183Supported MSI Switches, page 184Supported Windows Installer Properties, page 184

Command Line Considerations

There are some important issues to consider when installing InputAccel from a command line.

Escape CharactersWhen creating the installation command line, some installer properties and characters must beescaped (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. For example:

SCANNERNAME=\"Canon DR-4580U ^& DR-5580U\"

Maximum LengthThe maximum number of characters that can be entered on the command line is 1066. If morecharacters are entered, setup.exe launches and then quits.

Related Topics —

InputAccel Installer Properties and Feature Names, page 184Command-line Installation Failures, page 155

Installing InputAccel from a Command Line

Use the InstallShield and Windows Installer command line arguments to create instructions to installInputAccel software:

To install InputAccel from a command line:

1. From the Command Prompt or Start > Run, browse to setup.exe in the installation programdirectory, which includes the Clients, Databases, Server, andWebComponents directories.

2. Type a customized installation command in one line to add, modify, repair or remove InputAccelfeatures. For example, to install one InputAccel Server type:setup.exe /s /v"/qn ADDLOCAL="ALL" SERVER_INSTANCES="1" IA_SERVICES_RUNAS_LOCAL_SYSTEM="1" /promptrestart"

99

Preface


Note: You can automatically install InputAccel features using a batch file that contains silentinstallation command line instructions.

Related Topics —

Command-line Installation Failures, page 155Supported InstallShield Switches, page 183Supported MSI Switches, page 184Supported Windows Installer Properties, page 184InputAccel Installer Properties and Feature Names, page 184

Automating Unattended Installations

You can specify multiple installation command lines in a batch file to automate an unattendedinstallation. The following example shows three commands contained within one batch file thatgenerate a log file://Begin contents of irr_sp1.bat batch file//Install Service Pack 1 and write log filesetup.exe /s /v"/qn ADDLOCAL="ALL" IA_SERVICES_RUNAS_LOCAL_SYSTEM="1" /l*v"C:\logs\sp1_install.log""

//Remove COPY features and write a log filesetup.exe /v"/qn REMOVE=COPY /l*v "C:\logs\sp1_remove.log""

//Repair features and write log filesetup.exe /v"/qn /fvomus /l*v "C:\logs\sp1_repair.log""//End contents of irr_sp1.bat batch file

• The first command line argument installs the entire InputAccel Clients directory.

• The second command line argument removes selected features of the installation.

• The third command line argument repairs the features removed by the second command lineargument.

Related Topics —

Command-line Installation Failures, page 155Supported Windows Installer Properties, page 184InputAccel Installer Properties and Feature Names, page 184

Modifying Unattended Installations

From the directory location of the base InputAccel MSI files, you can modify unattended installationsby:• Adding features and modules: To add a feature or a list of features, use the ADDLOCAL property.For example, to add the base process (IAP) files and create a log file, the command line is:

100

Preface

setup.exe /v"/qn ADDLOCAL=BASE_IAP_FILES /l*v "C:\logs\modify.log""

Refer to the examples detailed in the Supported InputAccel feature properties and names section.

• Removing features and modules: Use the REMOVE property to remove a feature or a list offeatures. After removing features, repair the installation. The following example removes theCOPY 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, orWebComponentsdirectories. For example, from a Command Prompt window, navigate to the Clients directoryon the InputAccel installation media. At the command prompt, type the following command lineto remove the Clients directory and write a log to the specified directory:

setup.exe /v"/qn /x /l*v "C:\logs\remove.log""

Note: Use the Administration Console module to delete an InputAccel Server or remove anInputAccel Server from a ScaleServer group before removing the server. Refer to the UsingAdministration Console section in the Administration Guide for additional information.

• Repairing an InputAccel installation: Use the /f MSI switch to repair an installation. Thefollowing 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 183Supported MSI Switches, page 184Supported Windows Installer Properties, page 184InputAccel Installer Properties and Feature Names, page 184Command-line Installation Failures, page 155

Manually Registering a Client Module to Run as aService

By default, InputAccel client modules that can run as services are installed as services.• The client module was installed as an application during the installation process.

• The modules were uninstalled as services in order to change the login parameters.

Not all modules can run as services. For a list of client modules that can run as services, referto Table 23, page 168.

To manually register a client module to run as a service:

1. Open a command window on the machine where the client module is installed.

2. In the command window, switch to the directory where the module executable files are installed.By default, this is C:\Program Files\InputAccel\Client\binnt. Alternatively, use fullpath names for each file name specified in the following commands.

101

Preface

3. Enter one of the following commands, according to the type of module you are configuring. Thisis the same command line that is entered to run the module, but with the -install argumentappended:

Note: Optional parameters are offset in [ ] brackets. Do not include the brackets when typingthe parameters.

• Modules that are listed as “New in 6.0 or later” in Table 23, page 168, except custom exporters:

quickmodulehost.exe -modulename:modulename-login:username,password@servername -install[:serviceName]

• Export modules that are listed as “New in 6.0 or later” in Table 23, page 168 (includingDocumentum Advanced Export):

quickmodulehost.exe -modulename:modulename-login:username,password@servername-loginex[:username,password@repository] -install[:serviceName]

• Modules that are listed as “Available Prior to 6.0” in Table 23, page 168:

modulename.exe -login:username,password@servername -install

where:• modulename is the full module name. In the case of modules that are “New in 6.0 or later”,

modulename includes the namespace; for example, Emc.InputAccel.ImageDivider. Donot include the .dll extension of the module namespace. In the case of DocumentumAdvanced Export, the full modulename is DocumentumAdvancedExport. For other modules,modulename is the executable name of the module; for example, iaeximg for Image Export.

• -login:username,password@servername are the credentials to log into the InputAccelServer. For security reasons, we recommend not specifying an actual user name and passwordin the command line because doing so also stores these items as encrypted text in the registry.Instead, use the “run-as” account specified in the Log On tab of the Windows Service ControlManager window. To do this, specify * for the username,password argument; for example...-login:*@servername... servername is the name of machine hosting the InputAccel Server towhich the module should connect when running as a service. The topic Running Modules asServices, page 33 provides more information on how to configure modules to run as services.

• serviceName is the name by which the service is registered and listed in the Service ControlManger. Omit this argument to register the service using its default module name. Specifyingthis parameter enables running multiple instances of the same module, each as a separateservice. This is not supported for modules that are listed as “Available Prior to 6.0” in Table 23,page 168.

• -loginex:username,password@repository are the credentials used by a custom exportmodule to log into a third-party repository.

Note:• Registering a module as a service from the command line configures the module to run as aservice; it does not install or run the module.

• Registering a module as a service when it is already registered overwrites itspreviously-registered properties with the new properties.

• Only modules listed as “New in 6.0 or later” in Table 23, page 168 support the serviceNameattribute. When specified, this argument enables configuration of multiple instances of a

102

Preface

single module to run as a service, each with a unique service name. When a module isregistered as a service, parameters such as a user name or account name can be specified. Ifthe service is reregistered, the newly specified parameters, or default parameters if none arespecified, overwrite the existing ones. To register another instance of a client module asa service on the same machine, run the command with a unique serviceName to avoidoverwriting the previously installed service.

• To configure a module registered as a service for high availability, configure the Recovery tabin the Windows Service Control Manager. The InputAccel Client setup program does thisautomatically when it registers a module as a service; however, you must configure thisoption when manually registering a module as a service. To match the configuration used bythe InputAccel Client setup program configure the following settings:— First failure list: select Restart the Service

— Second failure list: select Restart the Service

— Subsequent failures list: select Restart the Service

— Reset fail count after field: Enter 1 days

— Restart service after field: Enter 1 minutes

Caution: When configuring a module to run as a service, do not enable Allow service tointeract with desktop. When a module runs as a service, it suppresses its user interface anddoes not run properly when configured to interact with the desktop.

Related Topics —

Module-Specific Requirements, page 19Chapter 3, Installation PlanningClient Machine Considerations, page 32Client Scalability, page 37Installing the InputAccel Client Components, page 65Upgrading Client Modules, page 136Appendix B, InputAccel Client Modules

Unregistering Client Modules that are Registered as Services

InputAccel client modules that are registered as services can be unregistered.

To unregister a client module that is registered as a service:

1. Open the command window on the machine where the client module is registered as a service.

2. In the command window, switch to the directory where the module executable files are installed.By default, this is C:\Program Files\InputAccel\Client\binnt. Alternatively, use fullpath names for each file name specified in the following commands.

3. Enter one of the following commands, according to the type of module you are configuring. Thisis the same command line entered to run the module, but with the -uninstall argumentappended:• Modules that are listed as “New in 6.0 or later” in Table 23, page 168:

103

Preface

quickmodulehost.exe -modulename:modulename -uninstall[:serviceName]

• Modules that are listed as “Available Prior to 6.0” in Table 23, page 168:

modulename.exe -uninstall

where:• modulename is the full module name. In the case modules that are “New in 6.0 or later”,

modulename includes the namespace; for example, Emc.InputAccel.ImageDivider. Donot include the .dll extension of the module namespace. In the case of DocumentumAdvanced Export, the full modulename is DocumentumAdvancedExport. In the case oftraditional executable modules, modulename is the executable name of the module; forexample, iaeximg for Image Export.

• serviceName is the name by which the service was registered. Omit this argument if theservice was registered under its default service name.

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, andthe Web Services Input and Web Services Output modules, can only run as services, not asapplications.)

Note: Uninstalling a client module that was installed as a service only unregisters the service. It doesnot the remove application.

Related Topics —

Module-Specific Requirements, page 19Chapter 3, Installation PlanningClient Machine Considerations, page 32Installing the InputAccel Client Components, page 65Upgrading Client Modules, page 136Appendix B, InputAccel Client Modules

Installing Additional ComponentsThe InputAccel setup program enables installing the following additional components:• Installing InputAccel Reports Designer, page 104

• Installing the Backward Compatibility Pack, page 135

• Installing the Connector for eCopy ShareScan, page 105

Installing InputAccel Reports Designer

The InputAccel Reports Designer setup program installs Crystal Reports 2008. This software is usedto design custom reports to view InputAccel statistics. Each purchased InputAccel Server includesa full version of the Reports Designer, and this license key is provided by EMC Licensing. TheInputAccel setup program includes a 30-day demonstration product key. If you already own a

104

Preface

Crystal Reports license, enter your own product key. Only one copy of this program is allowed perlicensed copy of the InputAccel Server.

To install InputAccel Reports Designer:

1. Start the InputAccel setup program from the installation media by opening the file autorun.exe.

2. From the Additional Productsmenu, select InputAccel Reports Designer.

3. Follow the instructions in the installation wizard to complete the installation.

Installing the Connector for eCopy ShareScan

This section explains how to install the Connector for eCopy ShareScan.

Prerequisites: Install InputAccel and eCopy ShareScan before installing the eCopy Connector.

To install the Connector for eCopy ShareScan:

1. Start the InputAccel setup program from the installation media. If the disc menu does not appearautomatically after a few seconds, or if you are running the installation from a local disk ornetwork share, open the file autorun.exe to begin.

2. From the Additional Productsmenu, select InputAccel Connector for eCopy ShareScan. ClickNext

3. Click Install in the Ready to Install the Program window and then click Finish. The Connectorfor eCopy ShareScan is installed.

Note: Instructions on how to configure connector profiles are available in the InputAccel Connectorfor eCopy ShareScan User Guide.

105

Preface

106

Chapter 5Upgrading InputAccel

This section explains how to upgrade an InputAccel system to InputAccel 6.5.

Topics in this section include:• Upgrade Planning, page 107

• Upgrading from InputAccel 5.3 SP3/SP4 to InputAccel 6.5, page 128

• Upgrading from InputAccel 6.0 SP1/SP2 to InputAccel 6.5, page 130

• Upgrade Procedures, page 131

• Sample Upgrade Scenarios, page 142

Upgrade PlanningUpgrading InputAccel requires careful planning and execution. This section explains how to planfor an upgrade.

Upgrade planning includes the following:• Understanding the valid upgrade paths (Upgrade Paths, page 108).

• Understanding the compatibility between the various InputAccel components (UnderstandingCompatibility among InputAccel Components, page 108).

• Understanding the locale considerations before planning an upgrade (Understanding LocaleConsiderations 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 (IdentifyingNew System Requirements, page 116).

• Understanding the upgrade process (Understanding the Upgrade Process, page 116).

• Granting permissions so users can use the upgraded system (Permissions, page 126).

• Performing pre-production testing and acceptance (Performing Pre-Production Testing andAcceptance, page 127).

• Scheduling upgrade phases (Scheduling Upgrade Phases, page 128).

107

Upgrading InputAccel

Upgrade Paths

Customers can upgrade to InputAccel 6.5 from the following versions only. To upgrade from anyother versions, first upgrade to the latest applicable supported version (5.3 SP4 or 6.0 SP2) andthen perform the 6.5 upgrade; alternatively, perform a new installation as explained in Chapter 4,Installing InputAccel.• InputAccel 5.3 SP4

• InputAccel 5.3 SP3



Note:• InputAccel supports rolling upgrades of client modules; that is, customers may upgrade clientmachines gradually—or not at all—while connecting to InputAccel Database version 6.5 andInputAccel Server version 6.5. However, only the upgradable client module versions listed aboveare allowed to connect. The InputAccel Server refuses connections from clients of any otherversion. The InputAccel Client Upgrade Compatibility table provides detailed information onsupported upgrade configurations.

• InputAccel version 6.5 client modules do not connect to InputAccel Servers from previousreleases. Upgrade the InputAccel Database, InputAccel Server, and InputAccel Web Componentsprior to beginning client module upgrades.

Related Topics —

Identifying New System Requirements, page 116Understanding the Upgrade Process, page 116Understanding Compatibility among InputAccel Components, page 108

Understanding Compatibility among InputAccelComponents

Before planning an upgrade, it is important to understand the version compatibility among variousInputAccel components. The InputAccel Client Upgrade Compatibility table in this section providescompatibility information related to the various InputAccel components and can help plan anupgrade scenario for your specific environment.

Note:• The InputAccel Database, InputAccel Server, InputAccel web components, and all fourcomponents of the InputAccel Web Services subsystem (WS Input, WS Output, WS Coordinator,and WS Hosting) must all be the same version. You cannot mix versions for these corecomponents. When upgrading to InputAccel 6.5, these components must be installed or upgradedto InputAccel 6.5 before connecting any client modules.

• All client modules that are installed on a single machine (including modules deployed using theClickOnce Deployment Utility) must be the same version. For example, InputAccel 6.0 SP1 clientand InputAccel 6.5 client modules cannot run together on the same machine.

108


• The InputAccel 6.5 Backward Compatibility Pack (BCP) enables you to continue using existingInputAccel 5.3 SP3 and SP4 client modules, processes, batches, values, and customizations with anupgraded InputAccel Server and InputAccel Database. The BCP does not apply to InputAccel 6.0SP1 and SP2 client modules—they continue to connect and function without any modifications.However, the InputAccel 6.0 BCP is not supported. Therefore, if you have any InputAccel5.3 client modules with the InputAccel 6.0 BCP installed, either install the InputAccel 6.5 BCPor upgrade the modules to InputAccel 6.5 modules. In any case, you cannot install modules ofdifferent versions on the same physical machine.

• Understanding Locale Considerations before Planning the Upgrade, page 110 providesinformation regarding the locale, globalization, and code page settings to consider when planningan upgrade.

Caution: You must not perform any module setup using InputAccel version 6.5 modules orcreate any new version 6.5 processes until all components have been upgraded to InputAccelversion 6.5. Furthermore, if you modify a process with version 6.5 setup data, or create a newversion 6.5 process, you can only use this process with InputAccel version 6.5 modules. Youcannot use this process with any InputAccel version 6.0 modules in either setup or productionmode.

Table 15. InputAccel Client Upgrade Compatibility

InputAccel Clientversion

Connects toInputAccel Serverversion 6.5?

Supports installationof version 6.5 BCP?

Can be upgraded toversion 6.5?

Pre-5.3

5.3

5.3 SP1/SP2

No No No3

5.3 SP3/SP4 No Yes Yes

5.3 SP3/SP4 with 6.0BCP

No Yes Yes

5.3 SP3/SP4 with 6.0SP1/SP2 BCP

Yes4 Yes Yes

5.3 SP3/SP4 with 6.5BCP

Yes N/A Yes

6.0 No N/A No5

6.0 SP1/SP2 Yes6 N/A Yes

3. Must first be upgraded to version 5.3 SP4. Refer to upgrade documentation supplied with that version.4. Clients can process data within their specified single- or double-byte code page. Tasks and pages can contain multiple

languages provided that all the languages are within the module’s code page.5. Must first be upgraded to version 6.0 SP2. Refer to upgrade documentation supplied with that version.6. Server and client must be in the same locale and use the same single-byte code page. (East Asian code pages are not

supported.)

109


Understanding Locale Considerations before Planningthe Upgrade

A pure InputAccel version 6.5 system (all components and modules upgraded to version 6.5) canoperate across multiple languages, multiple code pages, and multiple regional settings. Dependingon decisions made during the InputAccel system upgrade, certain language and code pagerestrictions may apply.

• To process multiple languages from different code pages in the same task or use different regionalsettings among client modules and InputAccel Servers, upgrade the client modules to version 6.5.

• To continue using InputAccel 6.0 SP1/SP2 client modules, those modules can only process taskscontaining multiple languages within the single-byte (non East Asian) code page of their hostmachine. Furthermore, the InputAccel Server refuses connections from 6.0 SP1/SP2 client modulesthat are not set to the same locale, globalization, and code page settings as the InputAccel Server.

• To continue using InputAccel 5.3 SP3/SP4 client modules that have been upgraded with theInputAccel 6.0 SP1/SP2 BCP, those modules can only process tasks containing multiple languageswithin the single-byte (non East Asian) code page of their host machine. Furthermore, theInputAccel Server will refuse connections from client modules that are not set to the same locale,globalization, and code page settings as the InputAccel Server.

• To continue using InputAccel 5.3 SP3/SP4 client modules by installing the InputAccel 6.5 BCP,those modules can process tasks containing multiple languages within the single- or double-bytecode page of their host machine. However, unlike modules that have been upgraded with the 6.0SP1/SP2 BCP, the client machines hosting these modules and the InputAccel Servers to which theyconnect may be configured to use different locale, globalization, and code page settings. You canprocess multiple languages from different code pages in a single batch by using departments toroute tasks to modules according to their code page setting; however, each task must contain onlylanguages within a single code page.

Exception: The Copy and Multi modules can process multiple languages from different codepages in the same task.

• If using modules that were developed by your own software developers or EMC Consulting, beaware that they are most likely not designed for double-byte characters. Unless these modules areupdated to handle double-byte characters, they can only process tasks that contain single-byte(non-East Asian) data values. Furthermore, because InputAccel has changed the way in which ithandles date and number formatting for multiple locales, if these custom modules read and writedate and number values, data may become corrupted if the module connects to an InputAccelServer that is using different locale formatting than the client. To successfully continue usingcustom modules, be sure that they connect to an InputAccel Server that is using the same locale,globalization, and code page settings.

• Process Developer is code page-based; therefore you must obey the following restrictions whendeveloping processes that support multiple languages and code pages:

— Choose a single code page and use it as the system code page across all machines runningProcess Developer. If you choose not to heed this restriction, then you must use only ASCIIcharacters for process names, step names, IA Value names, variable names or Visual Basiccode. This means, for example, that you cannot use non-ASCII characters in direct literalassignments or in local variable names. (Although Process Developer allows you to usenon-ASCII characters for these items, the InputAccel Server does not allow you to install

110


a process containing non-ASCII characters if it detects that the process was compiled on amachine having a different code page.)

Caution: The InputAccel Server cannot detect whether it is code page-compatible withpre-6.5 processes. Data corruption or server exceptions may occur if your processes werecompiled on a pre-6.5 system that had a different code page setting than the InputAccelServer. Therefore, you should recompile and reinstall all processes that are being used ina mixed code page environment.

These restrictions do not apply to department names or to the default values of IA Valuesdefined in MDFs using UTF-8 encoding. In other words, Unicode characters are supportedin dynamic IA Value names. Also, none of these restrictions apply if the Process Developermachine and the InputAccel Server are using the same code page.

— Use a UTF-8 editor (for example, Windows Notepad) to define a custom data-only MDF tohold 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 fromlanguages that are not included in the specified system code page. The variable namesthemselves must use characters from the system code page only; however, the values may bein any language present in the system. For example, if the Process Developer system codepage 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 otherlanguages, 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 machineon which the process was defined, do not use any literal strings that contain non-ASCIIcharacters in your VBA code. (If your environment has only a single code page, VBA literalstrings can be defined without this restriction.)

When IPPs are designed following these recommendations, batches from the resulting compliedprocess can be run on InputAccel Servers and client machines using any combination of codepages and regional settings (subject to the upgrade considerations described in this section).

To ensure seamless multiple language/multiple code page compatibility, use CaptureFlowDesigner instead of Process Developer to create your IPPs.

Note: Refer to the Administration Guide for details of the multiple language feature in InputAccel.

Related Topics —

Upgrade Paths, page 108Understanding Compatibility among InputAccel Components, page 108Identifying New System Requirements, page 116Understanding the Upgrade Process, page 116

111


Identifying Irreplaceable Files

Certain files should be archived before performing any upgrades. Creating an archive is importantwhen:• Re-implementing custom index validation code after upgrading.

• Rolling back the InputAccel system to the previous version.

• Preserving previously-customized processes in case you need to roll back the InputAccelinstallation.

• Preserving special patches and module customizations in case you need to roll back yourInputAccel installation.

The upgrade process automatically backs up certain key files and settings on servers and clientmachines. However, making copies of the following files and data, and store them in a safe placeis a recommended practice.

Table 16. Irreplaceable InputAccel Files and Data

DataType

Hostlocation

Default File Location Notes

Activa-tion files

In-putAc-celServers

\ias\activation\*.* Files used by softwaresecurity key activation (CAF)files. Retain these files incase reactivation becomesnecessary. Identify eachactivation file according tothe server from which it wasarchived.

ModuleDefini-tion Files

ProcessDevel-oper ma-chines

\program files\inputaccel\client\src\ipp\*.mdf\

program files\inputaccel\client\pcf\*.mdf

Your developers or EMCConsulting may havecustomized MDF files.Retain these files for futuremaintenance.

Inte-gratedProcess-FlowProjectsourcefiles

ProcessDevel-oper ma-chines

\program files\inputaccel\client\src\ipp\*.ipp

Your developers or EMCConsulting may have createdor customized IPP files.Retain these files for futuremaintenance.

112


DataType

Hostlocation


Indexvali-dationsourcecode andbinaryfiles

Devel-opmentsys-tem andIndexmod-ule ma-chines

\program files\inputaccel\client\src\iaidxval\*.*

For customers upgradingfrom InputAccel 5.3 SP3/SP4,your developers or EMCConsulting may have createdcustom index validation andpopulation code. Retain thesefiles for future maintenance.

If using customized validationcode, retain the compiledDLL files for continued usewith the Index module untilyou are able to implementthe preferred behavior withclient-side scripting.

win.ini Clientma-chines

\<windows>\win.ini Contains an [InputAccel]section for tuning modulebehavior. May havebeen customized on aclient-by-client basis;therefore, identify eachwin.ini file according tothe client machine fromwhich it was archived. Thisfile contains settings formodules that were includedin InputAccel 5.3 SP3/SP4(modules that are listed as“Available Prior to 6.0” inTable 23, page 168).

set-tings.ini

Clientma-chines

Windows XP: C:\Documents andSettings\All Users\ApplicationData\EMC\InputAccel\Settings.ini

Windows Vista/Windows 7: C:\Pro-gramData\EMC\ InputAccel\Set-tings.ini

Contains settings for tuningmodule behavior. Mayhave been customized ona client-by-client basis;therefore, identify eachsettings.ini file accordingto the client machine fromwhich it was archived. This filecontains settings for modulesthat are listed as “New in 6.0or later” in Table 23, page 168.

113


DataType

Hostlocation


Batchesand stagefiles

In-putAc-celServers

\ias\batches\*.* All in-process data (images,intermediate files, and otherbatch data). Each InputAccelServer has a unique set ofbatches; therefore, identifyeach data set according tothe server from which it wasarchived. Be aware that theremay be a large amount of data.

Processes In-putAc-celServers

\ias\process\*.iap Compiled versions of .ippfiles that are used in dailyproduction. They are typicallybased on customized sourcefiles. All InputAccel Serverswithin a ScaleServer groupshould contain an identicalset of processes; therefore,archiving a single servershould be sufficient.

Globalserverdatabase

In-putAc-celServers

\ias\values.idx For customers upgrading fromInputAccel 5.3 SP3/SP4. The\ias\values.idx containslicense data, user modulepreferences, and process/batchsecurity settings. This datais automatically migratedinto the InputAccel Databasewhen each InputAccel Serveris upgraded; however, this filewill be needed if you roll backto InputAccel 5.3 SP3/SP4.Each InputAccel Server hasa unique values.idx file;therefore, identify each fileaccording to the server fromwhich it was archived.

114


DataType

Hostlocation


Supple-mentalmoduleconfig-urationfiles

In-putAc-celServers

\ias\modules\*.* Some client modules storeshared configuration filessuch as templates, referenceimages, or other data filesin this location. Check eachserver to determine if multiplearchives are necessary.

Registryparame-ters

In-putAc-celServers

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\InputAccel\Parameters

You or EMC Consultingmay have modified serverregistry values to tuneperformance. Check eachserver to determine if multiplearchives are necessary.

Automatic Backup during Upgrade

For users upgrading InputAccel 5.3 SP3/SP4 or 6.0 SP1/SP2: When upgrading the InputAccel Serverand client machines, the setup programs automatically create backup directories containing copiesof key files so that you can restore the previous version. Maintain these backup directories untilyou are certain that the updated system is functioning as expected and that there is no possibilityof returning to the previous version.

Table 17. Automatic Backup Locations during an Upgrade

Location Automatic backup directory Contents

c:\Program Files\InputAccel\Server

$InputAccelServer5.3.3$




Files necessary to restorethe previous version of theInputAccel Server, includingvalues.idx and importantregistry keys.

c:\Program Files\InputAccel\Server

backup Files that were used in previousversions of InputAccel to restorea previous version of InputAccelServer files.

115


c:\Program Files\InputAccel\Client





Files necessary to restorethe previous version of theInputAccel client installation asit existed on the machine priorto upgrade. Included are thecontents of the src directorycontaining all process source files(IPP) and module definition files(MDF).

c:\Program Files\InputAccel\Client

backup Files that were used in previousversions of InputAccel to restorea previous version of InputAccelclient files.

Related Topics —

Upgrade Paths, page 108Understanding Compatibility among InputAccel Components, page 108Identifying New System Requirements, page 116Understanding the Upgrade Process, page 116

Identifying New System Requirements

Many existing InputAccel components have new system requirements and some new componentshave been added. In some cases, the hardware and software hosting your current InputAccelsystem may not be suitable for InputAccel 6.5. Carefully check the information in Chapter 2, SystemRequirements and Recommendations to be sure you are upgrading on supported platforms.

Related Topics —

Identifying Irreplaceable Files, page 112Understanding the Upgrade Process, page 116Performing Pre-Production Testing and Acceptance, page 127Scheduling Upgrade Phases, page 128Upgrading from InputAccel 5.3 SP3/SP4 to InputAccel 6.5, page 128Upgrading from InputAccel 6.0 SP1/SP2 to InputAccel 6.5, page 130

Understanding the Upgrade Process

When upgrading to InputAccel 6.5, install or upgrade the following components in this order:1. InputAccel Database hosted by SQL Server (InputAccel Database, page 117)

2. InputAccel Server(s) (InputAccel Servers, page 117)

3. Administration Console web server hosted by IIS (Administration Console, page 118)

116


4. New security keys, licenses, and activation files, as needed (Licenses, Activation Files, andSecurity Keys, page 119)

5. Backward Compatibility Pack, to continue using existing InputAccel 5.3 SP3/SP4 client modules(InputAccel Clients, page 119)

6. Upgraded client modules (InputAccel Clients, page 119)

7. New client modules (New Client Modules, page 125)

InputAccel Database

InputAccel 5.3 SP3/SP4 used various file system mechanisms to store settings, values, states, log data,and other system information. InputAccel 6.0 introduced a centralized database hosted by SQLServer. With the exception of development and demonstration systems, the InputAccel Databaseshould be installed on a dedicated server that meets or exceeds the performance criteria to keep theInputAccel system at peak production capacity. System requirements and recommendations for theInputAccel Database host system can be found in Database Server Requirements, page 11. Users ofInputAccel 5.3 SP3/SP4 must install the InputAccel Database, and users upgrading from InputAccelSP1/SP2 must upgrade their version of the InputAccel Database.

Related Topics —

Database Server Requirements, page 11Installing the InputAccel Database, page 54Database Issues, page 158

InputAccel Servers

Regardless of which version you are upgrading, InputAccel Servers must be upgraded to version 6.5.Furthermore, customers upgrading from InputAccel 5.3 SP3/SP4 must ensure that the InputAccelServer machines meet or exceed the system requirements listed in InputAccel Server Requirements,page 13.

Caution: For InputAccel 5.3 SP3/ SP4 customers upgrading to InputAccel 6.5, be aware thatInputAccel 6.5 hardware requirements have increased. To achieve similar or better performancefor all but low volume deployments, InputAccel 6.5 requires a dedicated machine with atleast 4 cores, 4 GB RAM, and high speed RAID 1+0 or 0+1 disks. Refer to InputAccel ServerConsiderations, page 29 for more information related to performance.

For all upgrade scenarios, if you have configured multiple InputAccel Servers as a ScaleServer group,the ScaleServer group is maintained during the upgrade procedure. Upgrade each InputAccel Serverin the ScaleServer group, and then confirm that it is configured as needed by using the AdministrationConsole. Refer to the Using Administration Console section in the Administration Guide for details.

Note:• When upgrading a ScaleServer group, if the setup program detects that theWindowsManagementInstrumentation (WMI) service is running, it displays a message indicating that WMI will be

117


stopped before proceeding. Allow the setup program to stop WMI to upgrade a ScaleServergroup. After the upgrade completes, the setup program restarts the WMI service.

• The name of the InputAccel 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 namedInputAccel_Server_admin_group and then adds the specified local or domain user account thatis used to run the InputAccel Server to this group, enabling the InputAccel Server to operate witha LUA. Details of the LUA configuration can be found in Running InputAccel with MinimumWindows Permissions, page 42

Caution: When upgrading a ScaleServer group that has one or more InputAccel Serversinstalled on the same machine as the SQL Server, stop all SQL Server instances and close allService Control Manager windows before starting the upgrade.

Related Topics —

InputAccel Server Considerations, page 29InputAccel Server Scalability, page 36Installing the InputAccel Server, page 57

Administration Console

When upgrading InputAccel 5.3 SP3/SP4, the Administration Console replaces the Administratormodule. Unlike the Administrator module, which is a standalone application, the AdministrationConsole is a web application hosted by a web server. Customers must install the AdministrationConsole on a web server that meets the system requirements listed in InputAccel Web Componentsand ClickOnce Host Requirements, page 14. Administrators access the Administration Console byusing the web browser on their machine from any location that can access the hosting web server.

Customers upgrading from InputAccel 6.0 SP1/SP2 must upgrade to Administration Console version6.5.

Note: Use the Administration Console to perform all administrative tasks. Although theAdministrator module from previous versions of InputAccel may continue to work for someadministrative tasks, it does not support the new features and capabilities of InputAccel version 6.5.For example, use the Administration Console to define InputAccel roles and permissions and to takeadvantage of the reporting and logging functionality.

Related Topics —

Administration Console Host System Considerations, page 30ClickOnce Host System Considerations, page 30InputAccel Remoting Server Considerations, page 31Installing the Administration Console, page 59Installing InputAccel Remoting, page 89

118


Licenses, Activation Files, and Security Keys

InputAccel uses the same licensing mechanism as previous versions. Your licensing mechanism mayuse a hardware security key (USB or parallel), or a software security key (CAF file). You can continueto use the hardware security key from a previous release, but must obtain and install new licensesand new activation codes after upgrading. If, as part of the upgrade process, the InputAccel Server isadded to a new domain, obtain a new activation code.

The process for activating InputAccel Servers is provided in the Using Administration Console sectionof the Administration Guide.

Note: Use a software security key (CAF file) if performing a side-by-side installation of multipleInputAccel Servers on a single machine. Hardware security keys are incompatible with side-by-sideinstallations.

Related Topics —

ScaleServer Licensing, page 50Licensing for use in a Microsoft Cluster, page 51Licensing for Disaster Recovery, page 51

InputAccel Clients

For users of InputAccel 5.3 SP3/SP4, InputAccel 6.5 includes most of the client modules from theprevious release, updated to work with the new system architecture. If you are not ready to upgradeall client modules, or if using custom modules that were designed for a previous version, you cancontinue to use the existing client modules by installing the InputAccel Backward CompatibilityPack (BCP) on each client machine. The BCP installs the necessary foundation and client softwareto communicate with the version 6.5 InputAccel Database and InputAccel Servers. You then canupgrade to the InputAccel version 6.5 client modules at any later time.

For users of InputAccel 6.0 SP1/SP2 client modules: The BCP does not apply in this scenario. The 6.0SP1/SP2 client modules will continue to work within an upgraded system (with certain restrictionsthat are described in Understanding Locale Considerations before Planning the Upgrade, page 110).

InputAccel 6.5 provides new client modules as well as replacements for some of the previous clientmodules. The following table lists modules that require special upgrade considerations.

Table 18. Client Module Upgrade Issues

Module Upgrade issue

ScanSoft OCR from version5.3 SP3/SP4 upgrades toNuanceOCR

After the upgrade completes, only the new module resides on themachine. The new module has the same Module ID as the moduleit replaces. The same MDF file, processes, and batches can be used.To use new features and new IA Values in the module, use ProcessDeveloper to open the IPP file, change the included MDF, andthen recompile and reinstall the modified process. Then set up themodule steps in the resulting processes and batches.

119



Scan and Rescan from version5.3 SP3/SP4 upgrade toScanPlus and RescanPlusversion 6.5

After the upgrade completes, both the Scan and ScanPlus modulesand Rescan and RescanPlus modules reside on the machine.Continue to use the old module while preparing to use the newmodule. Preparing to use the new module requires that you:• Work with EMC Licensing to understand the licensingimplications of upgrading and using the new modules.

• Revise your processes (IPP files) to include the new moduleand its MDF file.

• Check and update the IA Values you are using in your processesto match the IA Values declared in the new module’s MDF file.

• Compile and install the new processes, and then set upScanPlus/RescanPlus module steps as required for each process.

• Write client-side script code to handle any custom behaviors,including those that may have been implemented with ScanCallback functionality in the Scan module.

Modules deploying usingClick Once DeploymentUtility

If you enabled automatic updates through the Update Optionsfeature and created a bootstrap installation program for installingprerequisites required by the ScanPlus, RescanPlus, or IndexPlusmodules during an InputAccel 6.0 SP1/SP2 CODU deployment,note the following:

When you redeploy these modules due to an upgrade to InputAccel6.5:• New prerequisites are not downloaded and installed whenClickOnce automatically asks you to upgrade the modules toInputAccel 6.5.

• ClickOnce upgrades only the modules themselves, and not theprerequisites.

• You must manually start the upgraded bootstrapper utilityto download and install the updated prerequisites.right nowlooking

EMC Consulting ServicesABBYYOCR

Although not an upgrade, the East Euro / APAC OCR includedwith InputAccel 6.5 is recommended in all new processes forcustomers who need Eastern European and Asia Pacific OCR.

Note: If you are currently using the EMC Consulting ServicesABBYYOCR module, be aware that the East Euro / APAC OCRmodule is not directly compatible. It uses a different module ID,different MDF file, and different setup configuration. Therefore,using existing processes with the new module requires the existingprocesses to be modified, recompiled, and reinstalled, and setup tobe performed on the affected module steps.

120



Documentum Server Exportfrom version 5.3 SP3/SP4upgrades to DocumentumAdvanced Export version 6.5

After the upgrade completes, only the new module resides on themachine. The new module has the same Module ID as the moduleit replaces. The same MDF file, processes, and batches can be used.However, after upgrading the module, the Documentum logincredentials are not retained. This means that existing batches andprocesses will not connect to the Documentum Content Server.Therefore:• When running the module as an application, specify theDocumentum Content Server login credentials again by runningthe module in setup mode.

• When running the module as a service, specify the -loginexparameter when configuring the service instance. Commandline parameters are explained in the Documentum AdvancedExport guide.

There are some restrictions after upgrading the module:• Documentum Advanced Export does not support certainDocumentum Server Export features, in particular, the routingfeature. If routing is set up in Documentum Server Export, afterthe upgrade Documentum Advanced Export ignores it and logsa warning.

• If custom code was specified in the process which reads/writesdirectly to the setup values for Documentum Server Exportmodule, users have to modify their custom process code beforeprocessing with the Documentum Advanced Export.

To use new features and new IA Values in the module, use ProcessDeveloper to open the IPP file, change the included MDF to newone supplied with Documentum Advanced Export, and thenrecompile and reinstall the modified process. Set up the modulesteps in the resulting processes and batches.

The new module has different options for handling errors. Whenthe InputAccel Server starts up for the first time, it upgrades allbatches that contain steps of Documentum Server Export to use anappropriate new option. In particular:• The options Continue current task and keep accepting tasksand Continue current task, then stop accepting tasks are bothchanged to Automatically abort entire task.

121



Index from version 5.3SP3/SP4 upgrades toIndexPlus

After the upgrade completes, both the Index and IndexPlusmodules reside on the machine. Continue to use the older modulewhile preparing to use the new module. Preparing to use the newmodule requires that you:• If using IndexPlus, revise your processes (IPP files) to includethe new module and its MDF file.

• Check and update the IA Values used in your processes to matchthe IA Values declared in the new module’s MDF file.

• Compile and install the new processes, and then set upIndexPlus module steps as required, redefining index fields,index zones, and other configuration details.

• Write client-side script code to handle any custom behaviorspreferred, including validation and population functionality thatwas implemented with the Index module by using one of thevalidation DLL files. If preferred, continue to use the standardvalidation methods in iaidxv32.dll from previous versionsby using the included client-side script, LegacyValidationto call them; however, you cannot use a customized version ofiaidxv32.dll.

Note:— Work with EMC Licensing to understand the licensingimplications of upgrading and using the new module.

— InputAccel no longer includes the source code for thevalidation library, iaidxv32.dll. If you have used thesource code provided in a previous release to customizevalidation and population behavior, you can continue touse it only by continuing to use the Index module from thecorresponding previous release.

Client Script Engine fromversion 6.0 SP1/SP2 upgradesto .NET Code version 6.5

After the upgrade completes, both Client Script Engine and .NETCode reside on the machine. Continue to use the old modulewhile preparing to use the new module. Preparing to use the newmodule requires that you:• Obtain and install a license for the .NET Code module.



• Compile and install the new processes, and then set up .NETCode module steps as required for each process.

122



Client Script Engine fromversion 6.0 SP1/SP2 upgradesto .NET Code version 6.5(continued)

• Refactor any client-side scripts used with the Client ScriptEngine module so that they provide equivalent functionality inthe .NET Code module.

Image Divider from version6.0 SP1/SP2 upgrades toImage Converter version 6.5

After the upgrade completes, both Image Divider and ImageConverter reside on the machine. Continue to use the old modulewhile preparing to use the new module. Preparing to use the newmodule requires that you:• Work with EMC Licensing to understand the licensingimplications of upgrading and using the new module.



• Compile and install the new processes, and then set up ImageConverter module steps as required for each process.

Note: Unlike Image Divider, Image Converter does not includeclient-side scripting capabilities. Continue to use the Image Dividermodule from a previous version to continue to use client-sidescripts.

Automatic Quality Assurance

Client Script Engine

Documentum Server Export

ECM Web Services ImporterConfiguration

Excel Graphing

IBM Content Manager Export

Image Divider

iManage WorkSite ServerExport

PrimeOCR Plus

These modules are not included with InputAccel 6.5. If upgradingfrom version 6.0 SP1/SP2, continue to use the modules with nochanges. If upgrading from version 5.3 SP3/SP4, continue to use themodules either by running the InputAccel Client setup programor by installing the BCP. Either of these options performs thenecessary client upgrade procedure.

Note: Image Divider has been replaced by Image Converter.Documentum Server Export has been replaced by DocumentumAdvanced Export, IBM Content Manager Export has been replacedby IBM CM Advanced Export, and Client Script Engine has beenreplaced by .NET Code.

123



Copy

PDF Export

FileNet Panagon IS/CS Export

In previous releases of InputAccel, these modules had a setupoptions that enable interacting directly with files in a sharedInputAccel Server folder; that is, the C:\IAS folder on theInputAccel Server machine that has been shared using Windowsfile sharing.

Beginning with the 6.0 release of InputAccel, the InputAccel Serverfolder cannot be shared due to enhanced security. Therefore, thesetup mode user interface of these modules has been changed toprevent writing to or reading from a shared InputAccel Serverfolder. Any workflows that depend on this feature must bemodified accordingly.

Custom modules and processcode

InputAccel Server 6.5 handles IA Values in a way that is, in certainspecific cases, incompatible with previous versions. The specificcases have to do with changes made for Unicode compatibility andaffects the way binary values are interpreted. After an upgrade, theInputAccel Server automatically reconfigures existing batches withrespect to EMC-branded modules when it initially starts.

The automated upgrade process correctly upgrades batches thatuse only EMC-branded modules. However, processes and custommodules present three potential issues:

• Batches that were created in a previous release and use custommodules may fail when attempting to complete them afterupgrading if those custom modules read or write binary IAValues. Complete and clear all such batches prior to upgrading.

• Processes that use a custom module that reads or writers binaryIA Values are not automatically converted by the InputAccelServer following an upgrade. Process code should be reviewedto ensure that it does not incorrectly copy a binary IA Value toanother IA Value.

• Custom modules may not handle binary values correctlyaccording to the requirements of InputAccel 6.5. These modulesshould be reviewed to ensure that they follow proper datahandling rules: always use IAValueGetBinary( ) to readvalues that are written by IAValueSetBinary( ) and alwaysuse IAValueGetAscii( ) to read values that are written byIAValueSetAscii( ).

• Custommodules using the IDateTime class and the IADateTimeMDF Value must be modified to use the .NET DateTime objectand recompiled. The MDFs for these modified modules must bemodified to use the DateMDF type in place of the IADateTime.

124



Custom modules and processcode (continued)

These constructs were both deprecated in the 6.0 SP2 release andare completely removed in the 6.5 release. No EMC-suppliedmodules are affected by this change; the only potential impact isto custom modules that were designed with InputAccel SoftwareDevelopment Kit (SDK) release 6.0 SP1/SP2.

Previous releases ofDispatcher for InputAccelmust be simultaneouslyupgraded to Dispatcher forInputAccel 6.5.

You can continue to use Dispatcher for InputAccel 6.0 Service Packswith InputAccel 6.5. However, when you upgrade to Dispatcherfor InputAccel 6.5, you must upgrade all of your Dispatcher clientmachines at the same time, because the Dispatcher Project File(DPP) is automatically upgraded when it is opened for the firsttime, and is no longer supported by earlier versions.

Dispatcher for InputAccel releases prior to 6.0 are not supported inan InputAccel 6.5 system.

Appendix B, InputAccel Client Modules identifies key characteristics of each InputAccel module,including whether it runs in attended mode and unattended mode, whether it is ScaleServercompatible, whether it can run as a service, and whether it features a client-side scripting interface.

Related Topics —

Client Machine Requirements, page 17Module-Specific Requirements, page 19Client Machine Considerations, page 32Client Scalability, page 37Upgrading Client Modules, page 136

New Client Modules

After upgrading existing client machines, you may want to install new client modules. Thesemodules can be installed on existing client machines or on new machines. To install a module on anexisting client machine, you must run the InputAccel Client setup program and choose theModifyoption, then select the modules to install. However, before choosing theModify option, complete anupgrade. The upgrade process proceeds automatically when the InputAccel Client setup programdetermines that the installed version is older than the current version.

InputAccel includes the following new modules that are not automatically installed as part of theupgrade process

Upgrading from version 5.3 SP3/SP4:• Web Services Input: Imports images and data from third-party data providers using web servicesinterconnectivity standards. Refer to theWeb Services Guide for more information.

• Web Services Output: Exports images and data from InputAccel to third party data consumersusing web services interconnectivity standards. Refer to the Web Services Guide for moreinformation.

• Email Import: Imports images and data from email and email attachments into an InputAccelsystem. Refer to the Email Import Guide for more information.

125


• Multi-Directory Watch: Watches specified directories for new files, and then automatically createsbatches and imports the files.

• East Euro APAC OCR: Performs optical character recognition, including multiple languageswithin a single page, in one pass, and can output recognized text in more than 25 different wordprocessing and text formats.

• Image Converter: Recognizes various imported non-image file types and converts these files intoimage files to prepare them for processing by subsequent steps in an InputAccel process.

Note: When installing new client modules on a machine that has the Backward Compatibility Pack(BCP) installed, the InputAccel Client setup program updates all client components on the machine.To install additional components, run the InputAccel Client setup program again. Doing so displaysthe ProgramMaintenance window where you can modify, repair, or delete your installation. ChooseModify to select new client modules to install.

Upgrading from version 6.0 SP1/SP2:• East Euro APAC OCR: Performs optical character recognition, including multiple languageswithin a single page, in one pass, and can output recognized text in more than 25 different wordprocessing and text formats.

Related Topics —

Client Machine Requirements, page 17Module-Specific Requirements, page 19Client Machine Considerations, page 32Client Scalability, page 37Upgrading Client Modules, page 136Appendix B, InputAccel Client Modules

Permissions

New for users upgrading from InputAccel 5.3 SP3/SP4, only users who have been granted theproper permissions can access InputAccel or any of its modules. For configuration purposes, theIISMachine Administrator group for the machine hosting the Administration Console is grantedall InputAccel permissions. All other users must be explicitly granted permissions before they canuse the system. A user belonging to the IISMachine Administrator group should first create anInputAccel Administrator role and grant all permissions to that role, and then add at least oneperson—the designated InputAccel administrator—to that role.

Caution:• After designating at least one InputAccel Administrator, deactivate the IISMachineAdministrator group to protect this InputAccel from unauthorized use. Otherwise, anymember of the group has unrestricted access to your InputAccel system.

• Permissions for sample processes are overwritten when upgrading the InputAccel Server.When the upgrade installs new sample processes with the same file names as sampleprocesses from previous versions, the new version resets process permissions to their defaultvalues (Read/Write permission assigned to the group “Everyone”). Use the Administration

126


Console to assign new ACLs to processes. For instructions, refer to the Using AdministrationConsole section in the Administration Guide.

The InputAccel administrator should then define additional user roles, possibly additionalAdministrator roles, and assign appropriate users to each of those roles. The minimum InputAccelpermissions 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 thanprocessing batches) require special permissions. Refer to the Using Administration Console section inthe Administration Guide for more information about permissions and user roles.

Related Topics —

Security, page 38Understanding the Upgrade Process, page 116Scheduling Upgrade Phases, page 128

Performing Pre-Production Testing and Acceptance

If possible, perform an upgrade in an InputAccel test environment before upgrading in a productionenvironment. Follow all appropriate upgrade steps, install new functionality and integratereplacement modules, and update processes, settings and custom behaviors. Then run acceptancetests using typical documents and also test for performance and throughput.

Proceed to upgrade your production environment only after you achieve the expected results fromthe test upgrade.

Migrating configurations and settings stored in the InputAccel Database from a test environment to aproduction environment requires the use of a special IAMigrate application. Information on usingthis tool is provided in the Administration Guide.

Related Topics —

Identifying Irreplaceable Files, page 112Understanding the Upgrade Process, page 116Upgrading from InputAccel 5.3 SP3/SP4 to InputAccel 6.5, page 128Upgrading from InputAccel 6.0 SP1/SP2 to InputAccel 6.5, page 130

127


Scheduling Upgrade Phases

After completing upgrade testing and acceptance, carefully schedule each phase of the productionsystem upgrade. Consider each of the following recommendations:• Determine which components you will upgrade in each phase.

• Locate all installation media for the current InputAccel system prior to beginning the upgrade.You will need these items if unexpected upgrade issues require rolling back the upgrade to theprevious version.

• Choose the best day of the week to upgrade, taking advantage of both production andnon-production time.

For example, if production normally operates five days per week, consider upgrading the nightbefore the last production day of the week. You then will have a full day of production loadfollowed by two days of non-production, allowing time to resolve any issues.

• Shut down InputAccel immediately before the upgrade and make a backup copy of the \IASdirectory tree. This creates a snapshot of the system state immediately before upgrade.

• If you encounter major issues during upgrade, contact EMC Support.

Related Topics —

Identifying Irreplaceable Files, page 112Understanding the Upgrade Process, page 116Upgrading from InputAccel 5.3 SP3/SP4 to InputAccel 6.5, page 128Upgrading from InputAccel 6.0 SP1/SP2 to InputAccel 6.5, page 130

Upgrading from InputAccel 5.3 SP3/SP4 toInputAccel 6.5The InputAccel Server and InputAccel client modules from version 5.3 SP3/SP4 can be upgraded toInputAccel 6.5. The upgrade only affects the existing features that are installed on the user’s machine.Features that are new in InputAccel version 6.5 must be installed separately.

Note: Uninstalling an upgraded component removes the component from the machine; it does notrestore to the earlier version of the component.

To upgrade from InputAccel 5.3 SP3/SP4 to InputAccel 6.5:

1. If either of the following applies, you must complete all tasks from in-process batches through theaffected modules prior to upgrading:• After upgrading, one or more modules will use a different code page.

• You are using a custom module that reads or writes binary IA Values.

2. Stop all client modules and then stop all instances of the InputAccel Server.

3. Archive irreplaceable files and data. Refer to Identifying Irreplaceable Files, page 112 for adetailed list of the files and data that must be archived.

128


4. Install the InputAccel Database. Refer to Installing the InputAccel Database, page 54 forinstructions.

5. Upgrade the InputAccel Server. Refer to Upgrading the InputAccel Server, page 133 forinstructions.

6. Install the Administration Console. Refer to Installing the Administration Console, page 59for instructions.

7. Upgrade the client modules. Choose from the following options:• Install the Backward Compatibility Pack on client machines to use the current installedversions of InputAccel client modules with the upgraded architecture. Refer to Installing theBackward Compatibility Pack, page 135 for instructions.

• Upgrade currently installed versions of InputAccel client modules. Refer to Upgrading ClientModules, page 136 for instructions.

These steps upgrade the previous installation of InputAccel to the latest version. The followingsteps add new functionality and ensure that all customizations made to the previous version ofInputAccel are carried over to the upgraded version.

8. Modify the installation to install additional client modules as needed. To install additionalfunctionality, the client components already installed on the machine must first be upgraded toInputAccel 6.5. Refer to Installing New Functionality, page 138 for instructions.

9. Assign permissions to users of the upgraded modules or new modules. Refer to AssigningInputAccel Permissions, page 139 for instructions.

10. Upgrade existing processes and customizations. This step applies to modules that are replaced aspart of the upgrade. Refer to Upgrading Existing Processes and Customizations, page 140 for alist of modules that are replaced and the steps involved in upgrading existing processes.

11. Upgrade the Audit Extensions package. Refer to Upgrading Audit Extensions, page 140 forinstructions.

12. If the Scan module is upgraded to ScanPlus or the Rescan module is upgraded to RescanPlus:Use the client scripting functionality in ScanPlus or RescanPlus to upgrade the custom ScanCallback functionality. Refer to Upgrading Custom Scan Callback Functionality, page 141 forfurther details.

13. If the Index module is upgraded to IndexPlus: Upgrade the IndexValidation DLL to implementLegacy Validation functionality. Refer to Upgrading Index Validation Functionality, page 141for additional details.

14. Set the UI language for the various InputAccel components. Refer to Setting the UI Languageof InputAccel Components, page 69 for detailed information.

Note: Beginning with InputAccel 6.0, per-module settings are shared among all InputAccelServers that share the same InputAccel Database, regardless of whether they are in the sameScaleServer group. (Previously, per-module settings were stored separately on each InputAccelServer in a file named values.idx.) Therefore, if your InputAccel 5.3 SP3/SP4 installation haddifferent per-module settings for multiple InputAccel Servers, then after upgrading, only onesetting of each per-module value is copied into the shared settings in the InputAccel Database.

129


Related Topics —

Identifying New System Requirements, page 116Understanding the Upgrade Process, page 116Understanding Compatibility among InputAccel Components, page 108Upgrade Paths, page 108Upgrading from InputAccel 6.0 SP1/SP2 to InputAccel 6.5, page 130

Upgrading from InputAccel 6.0 SP1/SP2 toInputAccel 6.5The InputAccel Database, InputAccel Server, InputAccel Web Components, and InputAccel clientmodules from InputAccel 6.0 SP1/SP2 can be upgraded to InputAccel 6.5. If you do plan to upgrade,then the InputAccel Database, InputAccel Server, and InputAccel Web components must all beupgraded to 6.5. The upgrade only affects the existing features that are installed on the each machinein the InputAccel system. Features that are new in InputAccel 6.5 must be installed separately.

Note: Uninstalling an upgraded component removes the component from the machine; it does notrestore to the earlier version of the component.

To upgrade from InputAccel 6.0 SP1/SP2 to InputAccel 6.5:

1. If either of the following applies, you must complete all tasks from in-process batches through theaffected modules prior to upgrading:• After upgrading, one or more modules will use a different code page.

• You are using a custom module that reads or writes binary IA Values.

2. Stop all client modules that are run as applications and services.

3. Stop the Administration Console web server.

4. Stop all instances of the InputAccel Servers.

5. Stop the InputAccel Database.

6. Archive irreplaceable files and data. Refer to Identifying Irreplaceable Files, page 112 for adetailed list of the files and data that must be archived.

7. Upgrade the InputAccel Database. Refer to Upgrading the InputAccel Database, page 132 forinstructions.

8. Upgrade the InputAccel Server. Refer to Upgrading the InputAccel Server, page 133 forinstructions.

9. Upgrade the Administration Console. Refer to Upgrading the Administration Console, page135 for instructions.

10. Upgrade the InputAccel Remoting Server if using it.

11. Optionally upgrade the InputAccel client modules. Choose from the following options:• If the current installation has version 5.3 SP3/SP4 client modules with the 6.0 SP1/SP2 BCPinstalled, these client modules will work with the upgraded InputAccel components, subject

130


to the considerations explained in Understanding Locale Considerations before Planning theUpgrade, page 110.

• If the current installation has 6.0 SP1/SP2 client modules installed, these client modules willwork with the upgraded InputAccel components, subject to the considerations explained inUnderstanding Locale Considerations before Planning the Upgrade, page 110.

Depending on the upgrade option you choose, refer to Installing the Backward CompatibilityPack, page 135 or Upgrading Client Modules, page 136 for instructions.

Note: These three Web Services components must be the same version. Therefore, whenupgrading client modules, make sure these web services components are upgraded to InputAccel6.5. These client components are:

• WS Input

• WS Coordinator

• WS Hosting

At this point, the existing InputAccel components have been upgraded to the latest version. Thefollowing steps add new functionality and ensure that all customizations made to the previousversion of InputAccel are carried over to the upgraded version.

12. Modify the installation to install additional client modules as needed. To install additionalfunctionality, the client components already installed on the machine must first be upgraded toInputAccel 6.5. Refer to Installing New Functionality, page 138 for instructions.

13. Set the UI language for the various InputAccel components. Refer to Setting the UI Languageof InputAccel Components, page 69 for detailed information.

14. Assign permissions to users of the upgraded modules or new modules. Refer to AssigningInputAccel Permissions, page 139 for instructions.

Related Topics —

Identifying New System Requirements, page 116Understanding the Upgrade Process, page 116Understanding Compatibility among InputAccel Components, page 108Upgrade Paths, page 108Upgrading from InputAccel 5.3 SP3/SP4 to InputAccel 6.5, page 128

Upgrade ProceduresThis sections describes the procedures to upgrade each InputAccel component. Topics in thissection include:• Upgrading the InputAccel Database, page 132

• Upgrading the InputAccel Server, page 133

• Upgrading the Administration Console, page 135

• Installing the Backward Compatibility Pack, page 135

• Upgrading Client Modules, page 136

131


• Upgrading ClickOnce-Deployed Applications, page 137

• Installing New Functionality, page 138

• Assigning InputAccel Permissions, page 139

• Upgrading Existing Processes and Customizations, page 140

• Upgrading Audit Extensions, page 140

• Upgrading Custom Scan Callback Functionality, page 141

• Upgrading Index Validation Functionality, page 141

• Upgrading Documentum Advanced Export Client-Side Scripting, page 142

Upgrading the InputAccel Database

Upgrading the InputAccel Database involves replacing the current version of the InputAccelDatabase with the new version. This procedure is applicable for users upgrading from InputAccel6.0 SP1/SP2 to InputAccel 6.5. This procedure does not apply for customers upgrading fromInputAccel 5.3 SP3/SP4—they must install the InputAccel Database using instructions in Installingthe InputAccel Database, page 54.

Caution: Before attempting an upgrade of the InputAccel Database in a productionenvironment, we recommend creating a backup of the InputAccel Database, copying thebackup to a separate development or test environment, and then testing the upgrade steps. Ifthe database fails to upgrade, restore the original backup into the development environment,identify and resolve the errors, and attempt to upgrade again. After a successful upgrade on thedevelopment environment, perform the upgrade on the production environment.

To upgrade the InputAccel Database:

1. Create a backup of the InputAccel Database and copy the backup to a separate developmentor test environment.

2. Shut down all client modules and then the Administration Console web server and theInputAccel Remoting Server.

3. Shut down all InputAccel Servers connected to the InputAccel Database.

4. Log off any other applications running against the database.

5. Install any SQL Server service packs or upgrades as required in Database Server Requirements,page 11, then make sure the SQL Server service is started.

6. Log into the account that has been assigned the sysadmin Server Role.

7. Migrate the InputAccel Database to the SINGLE_USER mode.

8. From the Installation Choices list of the InputAccel setup program, select Step 1 - Install theInputAccel Database.

9. A message appears, verifying that the database components installed on the machine must beupgraded to the latest version. Click Yes to upgrade.

132


10. If prompted to install prerequisite applications, click Install. The prerequisite software for theInputAccel Database is installed. Click Next.


12. In the Destination Folder window, click Next to install the Create Database Utility and scripts tothe default destination folder or click Change to select a new location.

13. In the Configure InputAccel Database window, select the Upgrade InputAccel Database option,specify the sysadmin account login credentials for SQL Server, and then click Next.

14. If the specified database exists, a message prompts you to confirm the upgrade. Click Yes.


16. Migrate the InputAccel Database to MULTI_USER mode.

17. Create a SQL user account with minimum permissions to access the InputAccel Database.

Upgrading the InputAccel Server

Upgrading the InputAccel Server involves replacing current versions of all InputAccel Servers withthe new version.

Caution: For InputAccel 5.3 SP3/ SP4 customers upgrading to InputAccel 6.5, be aware thatInputAccel 6.5 hardware requirements have increased. To achieve similar or better performancefor all but low volume deployments, InputAccel 6.5 requires a dedicated machine with atleast 4 cores, 4 GB RAM, and high speed RAID 1+0 or 0+1 disks. Refer to InputAccel ServerConsiderations, page 29 for more information related to performance.

ow canThis procedure is required for all upgrade scenarios.

To upgrade the InputAccel Server:

1. Make sure the server machine meets the InputAccel Server requirements as outlined in Chapter 2,System Requirements and Recommendations. If it does not, perform the necessary upgrades orselect a different machine.

2. Record the version numbers of the InputAccel Servers on the system. The version number isdisplayed in the Properties window of the InputAccel Server executable. The version number isneeded if the server upgrade is rolled back.

3. Disconnect all client modules. Use the Administrator module or the Administration Console toview the list of InputAccel Server connections and then disconnect all client modules.

4. Stop the InputAccel Servers. If the InputAccel Server is running as a service, then stop the service.

5. Install (for users of InputAccel 5.3 SP3/SP4) or upgrade (for users of InputAccel 6.0 SP1/SP2) theInputAccel Database before upgrading the InputAccel Server.

6. Run the InputAccel setup program with an account that has Administrative privileges. From theInstallation Choices list of the InputAccel setup program, select Step 2 - Install the InputAccelServer.

133


7. Upgrade the InputAccel Servers. Refer to Installing the InputAccel Server, page 57 forinstructions.

Note: These notes apply for users upgrading InputAccel Server 5.3 SP3/SP4:

• After an upgrade from 5.3 SP3/SP4, the existing batches and processes on the InputAccelServer are renumbered when the InputAccel Server starts up. While the batches and processesare being renumbered, warning messages may be displayed or logged to the Event Log.These messages are expected and benign. The warning messages stop when all batches andprocesses have been renumbered.

• The services file is no longer used to store the TCP/IP port location for the InputAccel Server.When upgrading the InputAccel Server, the services file is parsed to locate the TCP/IP portused for the previous version of the InputAccel Server, and if found, the port is updated.

8. Activate the InputAccel Server and install new license codes.

Related topics —

InputAccel Server Considerations, page 29InputAccel Server Scalability, page 36Installing the InputAccel Server, page 57ScaleServer Issues, page 159

Rolling Back to a Previously Installed Version of the InputAccelServer

In some situations, you may want to revert to a previously installed version of InputAccel Server.This involves completely removing the InputAccel Server and all previous versions from the systemwhile leaving the InputAccel files and data intact and then reinstalling the earlier version.

To roll back to a previously installed version of the InputAccel Server:

1. Remove the InputAccel Server from any ScaleServer group, if applicable.

2. Ensure client modules are compatible with the earlier InputAccel Server. If you have upgradedthe InputAccel client modules, then roll back these client modules to versions that are compatiblewith the earlier InputAccel Server.

3. Stop the InputAccel Server.

4. Uninstall the latest InputAccel Server.

5. Uninstall remaining InputAccel Servers from prior installations.

6. Reinstall the earlier InputAccel Server version as well as patches and service packs as needed.

7. (For users upgrading from InputAccel 5.3 SP3/SP4) The Server setup program creates a backupdirectory named $InputAccelServerprevious_version$ inside the current installationdirectory. Copy the Server directory from the backup directory.

8. (For users upgrading from InputAccel 5.3 SP3/SP4) Restore original registry settings. AnInputAccelServerRegistryBackup_current_date.reg file is created to back up theregistry values in the backup directory where current_date is the actual date of the upgrade.Double-click the REG file to restore original settings.

134


Note:• There may be multiple copies of this file if you have installed InputAccel Server more thanonce. Be sure to select the correct one.

• Use REGEDIT.EXE to restore the InputAccel Server registry parameters to the indicatedvalue. Find these registry keys in HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\InputAccel\Parameters.

9. Restart the InputAccel Server.

Related Topics —

Upgrading the InputAccel Server, page 133InputAccel Server Considerations, page 29InputAccel Server Scalability, page 36Installing the InputAccel Server, page 57ScaleServer Issues, page 159

Upgrading the Administration Console

Upgrade to the latest version of Administration Console after upgrading the InputAccel Databaseand the InputAccel Server. This procedure is required for customers upgrading from InputAccel 6.0SP1/SP2 to InputAccel 6.5. This procedure does not apply for customers upgrading from version5.3 SP3/SP4—they must install the Administration Console using instructions in Installing theAdministration Console, page 59.

To upgrade Administration Console:

1. Make sure the InputAccel Database and the InputAccel Server are upgraded to InputAccel 6.5.

2. Log in to the web server machine that is hosting the Administration Console as a user withadministrative rights.

3. Stop all InputAccel software running on the machine you are upgrading.

4. From the Installation Choices list of the InputAccel setup program, select Step 3 - Install theInputAccel Web Components.

5. A message appears, verifying that the client components installed on the machine must beupgraded to the latest version. Click Yes to upgrade.

Installing the Backward Compatibility Pack

You can continue to use the existing InputAccel 5.3 SP3/SP4 client modules, processes, batches,values, and customizations with the upgraded InputAccel Server and InputAccel Database, but onlyif you install the Backward Compatibility Pack (BCP). Do not install the BCP if you do not plan tocontinue using modules from your existing 5.3 SP3/SP4 installation.

Install the InputAccel 6.5 BCP on machines where you want to continue using InputAccel 5.3 SP3/SP4client modules.

135


Note: Machines with InputAccel 6.0 SP1/SP2 client modules do not need, and will not allow theinstallation of, the BCP. Client modules from version 6.0 SP1/SP2 can connect to the upgradedInputAccel Server without any changes, subject to the considerations described in UnderstandingLocale Considerations before Planning the Upgrade, page 110. Refer to Understanding Compatibilityamong InputAccel Components, page 108 for more information.

Caution: Client modules on the machine where you install the BCP are no longer compatiblewith the previous version of the InputAccel Server. However, uninstalling the BCP restores theclient modules to their previous state, and those modules then can be used with the previousversion of the InputAccel Server.

To install the Backward Compatibility Pack:

1. On each machine that will continue to run InputAccel 5.3 SP3/SP4 client modules, log in asa user with administrative rights.

2. Stop all InputAccel modules that are running, including any modules running as services.

3. From the InputAccel setup program, select InputAccel 6.5 Backward Compatibility Pack underAdditional Products.The existing version of client modules on the system where you installed the BCP will nowwork within an InputAccel 6.5 system.

Related Topics —

Client Machine Requirements, page 17Module-Specific Requirements, page 19Appendix B, InputAccel Client Modules

Upgrading Client Modules

For users upgrading from InputAccel 5.3 SP3/SP4: You can upgrade to the latest version of InputAccelclient modules at any time after installing the InputAccel Database, upgrading the InputAccel Server,and installing the Administration Console.

For users upgrading from InputAccel SP1/SP2: You can upgrade to the latest version of InputAccelclient modules at any time after upgrading the InputAccel Database, the InputAccel Server, andthe Administration Console.

To upgrade InputAccel client modules:

1. Make sure the InputAccel Database, InputAccel Servers, and the Administration Console havebeen upgraded to version 6.5.

2. Log in to each client machine as a user with local administrative rights.

3. Stop all InputAccel server and client software running on the machine you are upgrading.

4. From the Installation Choices list, select Step 4 - Install the InputAccel Client Components.

5. A message appears, verifying that the client components installed on the machine must beupgraded to the latest version. Click Yes to upgrade.

136


6. Upgrade client modules by following the procedure described in Installing the InputAccelClient Components.

Related Topics —

Client Machine Requirements, page 17Client Machine Considerations, page 32

Rolling Back to a Previous InputAccel Client Release

Rolling back to a previous InputAccel client release removes the latest installation of the InputAccelclient modules and reverts to a previously installed release of the InputAccel client modules.

To roll back to a previously installed client release:

1. Stop and close all InputAccel client modules that are running on the machine you are upgrading.

2. Back up InputAccel client data.

3. Uninstall the InputAccel client modules.

4. Reinstall earlier InputAccel client software, patches, and service packs.

Related Topics —

Module-Specific Requirements, page 19Appendix B, InputAccel Client Modules

Upgrading ClickOnce-Deployed Applications

This section applies to users upgrading from InputAccel 6.0 SP1/SP2. Applications deployed usingthe ClickOnce Deployment Utility must be upgraded so that remote users accessing the applicationsget the latest upgraded software. Users will have access to the upgraded software only if theprevious version of the application was deployed with the Automatic Update feature enabled. If theClickOnce applications are not upgraded, then certain compatibility restrictions apply as detailed inUnderstanding Compatibility among InputAccel Components, page 108.

To upgrade ClickOnce-deployed applications:

1. Install the upgraded ScanPlus ClickOnce Package, RescanPlus ClickOnce Package, and IndexPlusClickOnce Package. Refer to Upgrading Client Modules, page 136 for instructions.

2. Select Start > Programs > InputAccel > ClickOnce Deployment Utility to run the ClickOnceDeployment Utility. The Deploy InputAccel Application window displays.

3. Follow the instructions in Deploying Modules with the ClickOnce Deployment Utility, page 92) todeploy the applications using the ClickOnce Deployment Utility. Make sure the Publish versionis set to a version greater than the version specified in the previously-deployed application.

137


Note:• If the application was initially deployed with the Automatic Update option enabled and theupgraded application is deployed to the same location as its previous version, then the modulechecks for an upgraded version, and the user can upgrade the module with a single click.

• If the upgraded application is deployed to a different location than its previous version, the usercan have access to the upgraded application by clicking the new deployment location.

Related Topics —

Client Machine Requirements, page 17Client Machine Considerations, page 32Client Scalability, page 37Module-Specific Requirements, page 19Upgrading Client Modules, page 136Appendix B, InputAccel Client Modules

Installing New Functionality

After performing an upgrade, run the installer again to install new functionality.

To install new functionality:

1. Run the InputAccel setup program and select Install Products.

2. Select the InputAccel component to install and then click Next. The Program Maintenancewindow displays.

3. Select theModify option and then click Next. The Custom Setup window displays. The leftpane of the window displays the features of the component selected. Expand the feature toview its sub-features.

4. Click the down arrow situated next to the feature name and select from the options displayed toinstall additional functionality and then click Next, Next, and then Install.New functionality is now installed.

Related Topics —

Identifying Irreplaceable Files, page 112Understanding the Upgrade Process, page 116Scheduling Upgrade Phases, page 128Upgrading from InputAccel 5.3 SP3/SP4 to InputAccel 6.5, page 128Upgrading from InputAccel 6.0 SP1/SP2 to InputAccel 6.5, page 130Permissions, page 126

138


Assigning InputAccel Permissions

This section applies to users upgrading from InputAccel 5.3 SP3/SP4. After installing theAdministration Console and upgrading client modules, permissions must be assigned to enableusers to run the modules.

To assign InputAccel permissions, refer to the Using Administration Console section in theAdministration Guide.

Note: To initially assign permissions, you must be a member of the Administrators group on theAdministration Console host machine. Use the Administration Console to create a new InputAccelAdministrators role and then add the user designated as the InputAccel administrator to thisInputAccel Administrators role. The InputAccel administrator can then create additional roles, eachwith appropriate user permissions, and assign users to those roles.

Related Topics —

Identifying Irreplaceable Files, page 112Understanding the Upgrade Process, page 116Security, page 38Permissions, page 126

Upgrading Existing XPP-Based Processes

This section applies to users upgrading from InputAccel 6.0 SP1/SP2. If you have used CaptureFlowDesigner 1.0 to create XPP files, be aware that CaptureFlow Designer 6.5 replaces certainautomatically-inserted steps with equivalent steps of a different module. CaptureFlow Designer 1.0automatically 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

When opening an XPP file with CaptureFlow Designer 6.5, the process flow is automatically updatedto use the Synchronize module in place of some Multi module steps. After saving an updated XPPfile and then compiling and installing it on the InputAccel Servers, you would normally copyall the settings in a single copy/paste operation from the previous version of the process to thenewly-installed one. However, this will not work because the names of the module steps havechanged. The workaround in this case (and in any other case where module step names havechanged) is to copy and paste settings for individual steps, one step at a time.

139


Upgrading Existing Processes and Customizations

This section applies to users upgrading from InputAccel 5.3 SP3/SP4. After upgrading the clientmodules, upgrade existing processes and customizations for replaced modules. Replaced clientmodules include:

• Replaced modules that require processes and customizations to be upgraded

— ScanPlus (replaces Scan)

— RescanPlus (replaces Rescan)

— IndexPlus (replaces Index)

— Image Converter (replaces Image Divider)

— .NET Code (replaces Client Script Engine)

• Replaced modules for which upgrading processes and customizations is recommended

— NuanceOCR (replaces ScanSoft OCR)

— Documentum Advanced Export (replaces Documentum Server Export)

To upgrade existing processes and customizations

1. Open the IPP process file in Process Developer.

2. Include the new MDF file.

3. (For ScanPlus, RescanPlus, IndexPlus, Image Converter, and .NET Code): Rewrite the IPP toinclude the new executable names.

4. Recompile and reinstall the IPPs using Process Developer.

5. Run the modules in setup mode to configure them as needed. Refer to the module-specific guidefor information on running the module in setup mode.

Related Topics —

Identifying Irreplaceable Files, page 112Understanding the Upgrade Process, page 116

Upgrading Audit Extensions

For users upgrading from InputAccel 5.3 SP3/SP4. Audit Extensions are still supported, but nolonger installed for this release. The InputAccel Server now logs data to the InputAccel Database.InputAccel also includes new reporting and logging functionality which can be configured throughAdministration Console.

To upgrade Audit Extensions:

1. Navigate to the InputAccel\client\binnt directory.

2. Double-click dalconfig.exe to run the utility for database settings.

3. Select Legacy Audit Database from Data Source ID.

140


4. In the Data Source (Server) field, enter the machine name of the machine that hosts the databasefrom the previous version of InputAccel.

5. In the Catalog field, enter the name of the database from the previous version of InputAccel.

6. Enter the User and Password credentials to connect to the database from the previous version.

7. Click Test Connection to test the connection to the previous connection and then click Done.

Note: Beginning with InputAccel version 6.0, the Audit Extensions logs all IAValueSet events,those that occur inside modules and those that occur in the process code between module steps. Thestored procedures that handle these events do not allow a NULL or empty User Name or ModuleName value; therefore, these events substitute the following for these values in the cases where thereis no User Name or Module Name value to store:

• User Name is replaced with Process Name, or if empty, the word “Server”.

• Module Name is replaced with the current module step name, or if empty, the word “IAP”.

Related Topics —

Database Server Requirements, page 11Installing the InputAccel Database, page 54Database Issues, page 158Appendix E, Running the Create Database Utility

Upgrading Custom Scan Callback Functionality

For users upgrading from InputAccel 5.3 SP3/SP4. The ScanPlus and RescanPlus modules donot support the Scan Callback DLL. Therefore, if you upgraded to the ScanPlus or RescanPlusmodule and had custom functionality implemented using the Scan Callback DLL, use ScanPlusand RescanPlus client-side scripting to implement the equivalent custom functionality. The ClientScripting Guide and the Programming Reference sections of the ScanPlus Guide and the RescanPlus Guideprovide information on using and implementing client-side scripts.

Related Topics —

Upgrading Client Modules, page 136Appendix B, InputAccel Client Modules

Upgrading Index Validation Functionality

For users upgrading from InputAccel 5.3 SP3/SP4. The IndexPlus module does not directlysupport the Index Validation DLL functionality that you may have used with the Index module.Therefore, if you upgraded to IndexPlus and had validation and population functionalityimplemented using the Index Validation DLL, use IndexPlus client-side scripting to implementsimilar functionality. However, it is not necessary to re-implement the Index Validation DLLfunctionality from scratch. Instead, use the sample script, LegacyValidation located inclient\src\scripts\samples\IndexPlus\LegacyValidation.dll that is installed on

141


IndexPlus machines. This client-side script enables you to continue using the Index Validation DLLby mapping field events in IndexPlus to the functions in the Index Validation DLL.

Note: InputAccel no longer includes the source code for the validation library, iaidxv32.dll.If you have used the source code provided in a previous release to customize validation andpopulation behavior, you can continue to use it only by continuing to use the Index module fromthe corresponding previous release.

The Client Scripting Guide and the Programming Reference section of the IndexPlus Guide provideinformation on using and implementing client-side scripts.

Related Topics —


Upgrading Documentum Advanced Export Client-SideScripting

The following issue is for users of InputAccel 6.0 SP1/SP2 who are upgrading to the DocumentumAdvanced Export 6.5. This issue does not require you to modify or recompile your processes;however, you must recompile processes to take advantage of new capabilities introduced in version6.5.

Documentum Advanced Export client-side scripting has changed to use DFC functionality for .NETinteroperability, in part because DFC PIA support has been deprecated within the Documentumproduct family. Therefore, client-side scripts that were developed in earlier versions of InputAccelwill not work with Documentum Advanced Export version 6.5. These scripts must be updated bysomeone familiar with both the PIA and Documentum Advanced Export scripting APIs.

Note: Documentum Advanced Export steps that do not use client-side scripting will continue towork without changes after upgrading.

Sample Upgrade ScenariosUpgrading InputAccel requires thoughtful planning and careful execution. This section providesupgrade scenarios for typical situations to help understand the considerations unique to yourenvironment.• Sample Scenario: Simple Upgrade from InputAccel 5.3 SP3/SP4, page 143

• Sample Scenario: Upgrade from InputAccel 5.3 SP3/SP4 while continuing to use 5.3 Modules,page 145

• Sample Scenario: Upgrade from InputAccel 6.0 , page 147

142


Sample Scenario: Simple Upgrade from InputAccel 5.3SP3/SP4

This scenario is a straightforward upgrade from InputAccel 5.3 SP3/SP4 with the followingcharacteristics:• One or more InputAccel Servers.

• One or more Scan machines and one or more Index machines.

• Version 5.3 Audit Extensions are used and will continue to be used after upgrading.

• No custom modules and no special customizations by the customer or EMC Consulting.

• The following modules are not used:— Watch

— Excel Graphing

— Automatic Quality Assurance

— IBM Content Manager Export

— iManage WorkSite Server Export

— Administrator Module

— Supervisor Module

• No new functionality is used (such as Web Services, ClickOnce deployment, or InputAccelRemoting).

When this upgrade scenario is complete, you can process tasks in multiple languages and locales asexplained in the Administration Guide.

To upgrade this InputAccel system:

1. Archive irreplaceable system files in the event that you need to roll back to version 5.3 SP3/SP4.Irreplaceable system files are listed in Identifying Irreplaceable Files, page 112.

2. Install the InputAccel Database on a new server machine. Refer to Installing the InputAccelDatabase, page 54.

3. Disconnect all client modules and stop all InputAccel Servers.

4. Run the InputAccel Server setup program on each InputAccel Server machine to automaticallyupgrade this component. When finished, make sure the InputAccel Server service is started.Detailed instructions are provided in Upgrading the InputAccel Server, page 133.

5. Install the Administration Console and then install new license codes and, if applicable,activate the product. Installing the Administration Console, page 59 describes how to installthe Administration Console. Licensing and Activation, page 49 explains how to install licensecodes and activate InputAccel.

6. Upgrade the Audit Extensions package. Refer to Upgrading Audit Extensions, page 140 forinstructions.

7. Run the InputAccel Client setup program on each client machine to automatically upgrade theinstalled components. Be sure to include the machines on which you run Process Developer.

143


Instructions for using the InputAccel Client setup program are provided in Upgrading ClientModules, page 136.Note the following:• When upgrading Scan and Rescan machines, the setup program installs the ScanPlus andRescanPlus modules, leaving the Scan and Rescan modules from the earlier version in place.If needed, continue to use the Scan or Rescan module until ready to upgrade your processes.Before using the new modules, upgrade your processes and set up each ScanPlus andRescanPlus module step in every upgraded process. In addition, any custom Scan Callbackfunctionality that was used with the Scan or Rescan module must be re-implemented by usingthe client-side scripting capability of the ScanPlus or RescanPlus module.

• When upgrading Index machines, the setup program installs the IndexPlus module, leavingthe Index module from the earlier version in place. If needed, you can continue to use theIndex module until you are ready to upgrade your processes and workflow. You mustupgrade your processes and set up each IndexPlus module step in every upgraded process(including all index fields, index zones, default values, and population and validationbehavior) before using the new module. By using index families, you can often combine indexfields from multiple Index steps into a single IndexPlus step, simplifying future maintenance.Information on defining and using index families is provided in the IndexPlus Guide.

• When you upgrade other client machines, a new version of each installed module replaces themodule from the earlier release. Although the new version of the module may have additionalcapabilities, it continues to function without changes in your current processes and batches.This is true even though some of the modules have new names:

— Documentum Server Export is updated to Documentum Advanced Export

— ScanSoft OCR is updated to NuanceOCR

• PrimeOCR is no longer supplied with InputAccel. However, you may continue to usePrimeOCR by running the 6.5 InputAccel Client setup program, which upgrades the othercomponents on the machine to version 6.5.

As you begin production with the upgraded system, consider using the Scan and Index modules fromthe earlier version. As time allows, upgrade your processes to use the new ScanPlus and IndexPlusmodules and the new features of NuanceOCR, DocumentumAdvanced Export, and Image Converter.Also consider consolidating your processes by using the new index family feature of IndexPlus.

Using the new modules to their full potential requires upgrading your process source files (IPPs) toinclude the new module executables and corresponding Module Definition Files (MDFs), compilingand reinstalling the resulting production processes (IAPs) on your InputAccel Server, and then settingup each module step appropriately. For detailed instructions, refer to the Process Developer Guide andto the Designing section in each module’s guide.

Note: EMC recommends that after upgrading, you install CaptureFlow Designer on your ProcessDeveloper machines. CaptureFlow Designer enables you to visually design processes ratherthan writing code in Visual Basic. The CaptureFlow Designer Guide provides instructions on usingCaptureFlow Designer.

All modules that are upgraded to version 6.5 have the ability to process tasks containing data inmultiple languages and multiple code pages. More information on InputAccel’s multiple languagecapabilities can be found in the Administration Guide.

Related Topics —

144


Identifying Irreplaceable Files, page 112Understanding the Upgrade Process, page 116Scheduling Upgrade Phases, page 128Upgrading from InputAccel 5.3 SP3/SP4 to InputAccel 6.5, page 128

Sample Scenario: Upgrade from InputAccel 5.3SP3/SP4 while continuing to use 5.3 Modules

This scenario upgrades from InputAccel 5.3 SP3/SP4 while continuing to use modules from the 5.3SP3/SP4 release. This scenario is similar to the previous scenario, but has the following additionalcharacteristics:• Existing functionality is needed from any or all of the following modules from the previousversion:— Excel Graphing

— Automatic Quality Assurance

— IBM Content Manager Export

— iManage WorkSite Server Export

— PrimeOCR

• New functionality is needed from any or all of the following new components:

— .NET Code module

— Image Converter module

— East Euro APAC OCR module

— ClickOnce deployment

— InputAccel Remoting

— Web Services

— Audit Extensions from version 5.3 are to be replaced with version 6.5 reports.



1. Perform steps 1–5 in the previous procedure.

2. Use the upgraded Administration Console to configure reports to capture the required auditingdata. Administration Guide explains how to configure InputAccel reports and logs.

3. For each client machine where you want to continue to use modules from the 5.3 SP3/SP4InputAccel version, run the main InputAccel setup program, and select InputAccel 6.5 BackwardCompatibility Pack. Installing the Backward Compatibility Pack, page 135 provides additionaldetails of working with the BCP.

145


Note:• If you want to install new modules and retain modules from a previous release on the sameclient machine, you may do so with certain exceptions. To configure a machine in this way,do not install the BCP. Instead, upgrade the machine using the InputAccel Client setupprogram. This installs the necessary components to enable the old module to function withinthe new InputAccel system and also upgrades any modules that are already installed withtheir new versions, if applicable.

When detected by the InputAccel Client setup program, the following modules are automaticallyreplaced with the corresponding updated modules. Each of the new modules continues tofunction in your existing processes and batches in the same manner as the module it replaces.However, each of these modules has new features that can only be used if you update yourprocesses to include the new Module Definition File (MDF), and then recompile and reinstall theprocesses.• Documentum Server Export: If detected during upgrade, this module is replaced with theDocumentum Advanced Export module. The new module continues to function in place ofthe Documentum Server Export module using your existing processes and setup.

• ScanSoft OCR: If detected during upgrade, this module is replaced with the NuanceOCRmodule. The new module continues to function in place of ScanSoft OCR using your existingprocesses and setup.

4. For each client machine you want to upgrade to the new module versions, run the InputAccelClient setup program to automatically upgrade the installed components. Be sure to include themachines on which you run Process Developer. Upgrading Client Modules, page 136 providesadditional details about using the Upgrade feature of the setup program.

5. To install new functionality on an existing client machine, run the InputAccel Client setupprogram again (after upgrading) to display the Program Maintenance window. Then select theModify option and click Next. In the Custom Setup window, select the components to install.Modifying an InputAccel Installation, page 151 provides more information on using the Modifyfeature of the setup program.

6. To install new functionality on an existing client machine, run the InputAccel Client setupprogram. ChooseModify, then click Next to display the Custom Setup window and select thecomponents to install. Refer to Installing the InputAccel Client Components, page 65.

7. To install new functionality other than client modules (such as ClickOnce deployment andInputAccel Remoting), refer to the appropriate section of this guide for installation instructions.

8. Edit or create new processes to use the new client functionality that you have added, and thencompile and install them on your InputAccel Servers. Process Developer Guide provides detailedinstructions on editing, compiling, and installing processes.

As you begin production with the upgraded system, consider using the Scan and Index modules fromthe earlier version. As time allows, upgrade your processes to use the new ScanPlus and IndexPlusmodules and the new features of NuanceOCR, DocumentumAdvanced Export, and Image Converter.Also consider consolidating your processes by using the new index family feature of IndexPlus.

Using the new modules to their full potential requires upgrading your process source files (IPPs) toinclude the new module executables and corresponding Module Definition Files (MDFs), compilingand reinstalling the resulting production processes (IAPs) on your InputAccel Server, and then settingup each module step appropriately. For detailed instructions, refer to the Process Developer Guide andto the Designing section in each module’s guide.

146


Note:• EMC recommends that after upgrading, you install CaptureFlow Designer on your ProcessDeveloper machines. CaptureFlow Designer enables you to visually design processes rather thanwriting code in Visual Basic. The CaptureFlow Designer Guide provides instructions on usingCaptureFlow Designer.

• For the 5.3 SP3/SP4 client modules you continue to use with your InputAccel 6.5 system (thosefor which you have installed the 6.5 BCP), be aware that these modules can only process taskscontaining multiple languages within the single- or double-byte code page of their host machineand that InputAccel Servers will refuse connections from these non-upgraded client modules ifthey are not set to the same locale, globalization, and code page settings as their InputAccelServers.

Related Topics —


Sample Scenario: Upgrade from InputAccel 6.0

This scenario is an upgrade from a release that the 6.5 upgrade software does not directly support,InputAccel 6.0. This scenario has the following characteristics:• Existing 6.0 InputAccel Database.

• One or more 6.0 InputAccel Servers.

• Existing 6.0 Administration Console.

• No custom modules and no special customizations by the customer or EMC Consulting.



1. Upgrade the entire InputAccel system to version 6.0 SP1 or SP2 by following the upgradeinstructions provided with those releases. After you complete this step, you are upgrading oneof the supported releases.

2. Archive irreplaceable system files in the event that you need to roll back to version 6.0 SP1/SP2.Irreplaceable system files are listed in Identifying Irreplaceable Files, page 112.

3. Disconnect all client modules and stop all InputAccel Servers.

4. Run the InputAccel Database setup program on your InputAccel Database machine toautomatically upgrade this component. Installing the InputAccel Database, page 54 providesstep-by-step instructions.

Note: The system requirements for the InputAccel Database have changed somewhat for version6.5. Be sure your SQL Server installation meets or exceeds the new requirements.

147


5. Run the InputAccel Server setup program on each of your InputAccel Server machines toautomatically upgrade this component. When finished, make sure the InputAccel Server serviceis started. Detailed instructions are provided in Upgrading the InputAccel Server, page 133.

6. Run the Administration Console setup program on its host machine to automatically upgradethis component. After upgrade is complete, use the Administration Console to install your newlicense codes and, if applicable, activate the product. Installing the Administration Console,page 59 describes how to install the Administration Console. Licensing and Activation, page 49explains how to install license codes and activate InputAccel.At this point, you may continue to use version 6.0 SP1/SP2 client modules with no furtherupgrades, subject to the conditions listed in Understanding Locale Considerations beforePlanning the Upgrade, page 110. Or you may proceed with the following steps and upgradesome or all client modules to version 6.5.

Note: For the 6.0 SP1/SP2 client modules you continue to use with your InputAccel 6.5 system,be aware that these modules can only process tasks containing multiple languages within thesingle-byte code page of their host machine and that InputAccel Servers will refuse connectionsfrom these non-upgraded client modules if they are not set to the same locale, globalization, andcode page settings as their InputAccel Servers.

7. For each client machine you want to upgrade to new module versions, run the InputAccelClient setup program on each existing client machine to automatically upgrade the installedcomponents. Be sure to include the machine(s) on which you run Process Developer, ClickOncedeployment, and the Web Services subsystem. Instructions for using the InputAccel Client setupprogram are provided in Upgrading Client Modules, page 136.Note the following:• PrimeOCR Plus is no longer supplied with InputAccel. You may continue to use PrimeOCRPlus by running the 6.5 InputAccel Client setup program, which upgrades the othercomponents on the machine to version 6.5.

• When you upgrade Image Divider machines, the setup program installs the Image Convertermodule, leaving the Image Divider module from the earlier version in place. If needed, youcan continue to use the Image Divider module until you are ready to upgrade your processesto use Image Converter. Before using the new module, you must upgrade your processes andset up each Image Converter step in every upgraded process.

Note: Unlike Image Divider, Image Converter does not include client-side scriptingcapabilities. You must continue to use the Image Divider module from the earlier version tocontinue to use client-side scripts.

8. To install new functionality on an existing client machine, run the InputAccel Client setupprogram again (after upgrading) to display the Program Maintenance window. Then select theModify option and click Next. In the Custom Setup window, select the components to install.Modifying an InputAccel Installation, page 151 provides more information on using the Modifyfeature of the setup program.

9. Edit or create new processes to use any new client functionality that you have added (ImageConverter or East Euro APAC OCR, for example), and then compile and install them on yourInputAccel Servers. Process Developer Guide provides detailed instructions on editing, compiling,and installing processes.

Note: EMC recommends that after upgrading, you install CaptureFlow Designer on your ProcessDeveloper machines. CaptureFlow Designer enables you to visually design processes rather

148


than writing code in Visual Basic. The CaptureFlow Designer Guide provides instructions on usingCaptureFlow Designer.

Related Topics —


149


150

Chapter 6Modifying, Repairing, and RemovingInputAccel

An InputAccel 6.5 installation can be modified, repaired, or uninstalled. Topics in this section include:• Modifying an InputAccel Installation, page 151

• Repairing an InputAccel Installation, page 152

• Removing an InputAccel Components, page 152

Modifying an InputAccel InstallationThe current installation of InputAccel can be modified. Modifying the installation of lets you installfeatures that are not currently installed and remove features that were installed.

To modify an InputAccel installation:

1. Stop the InputAccel component that you want to modify.


3. Select the InputAccel component to modify and then click Next. The Program Maintenancewindow displays.

4. Select theModify option and then click Next. The Custom Setup window displays. The leftpane of the window displays the features of the component selected. Expand the feature toview its sub-features.

5. Click the down arrow situated before the feature name and select from the options displayed tomodify the installation of the selected feature and then click Next, Next, and then Install.The InputAccel installation is modified.

Related Topics —

Repairing an InputAccel Installation, page 152Removing an InputAccel Components, page 152

151

Modifying, Repairing, and Removing InputAccel

Repairing an InputAccel InstallationThe InputAccel installation repair functionality is useful if you have removed a feature or if theprogram becomes corrupted.

To repair the InputAccel Server after removing a feature, use the same InputAccel Server.msifile used to install the original server. To repair an InputAccel Client installation after removingselected modules or an entire service pack you must use the same InputAccel Client.msi fileused to install the original system.

To repair InputAccel installations:

1. Stop the InputAccel component that you want to repair.


3. Select the InputAccel component to repair and then click Next. The Program Maintenancewindow displays.

4. Select the Repair option and then click Next. The Ready to Repair the Program windowdisplays. Click Install.

Removing an InputAccel ComponentsInstalled InputAccel components can be removed. When you remove a component, the entirecomponent is removed from the machine. For instance, removing the client installation removesall the client modules installed on the machine.

To remove InputAccel components:

1. Stop the service for the InputAccel component that you want to remove. For instance, stop theInputAccel Server service before removing the InputAccel Server.

2. (When removing the InputAccel Server) From the Administration Console module, navigate tothe Servers pane and delete the InputAccel Server to remove.

3. Run the InputAccel setup program on the machine where you want to remove the componentand select Install Products.

4. Select the InputAccel component to remove and then click Next. The Program Maintenancewindow displays.

5. Select the Remove option and then click Next. The Remove the Program window displays. ClickRemove. The InputAccel component is removed completely from the machine.

152

Chapter 7Troubleshooting

This section provides information to help you troubleshoot installation problems. Topics in thissection include:• Installation Failures, page 153

• Installation Errors, page 154

• Third-party Component Issues, page 157

• Post-installation issues, page 158

Installation FailuresWhen an InputAccel component fails to install correctly, the setup program performs a rollbackoperation 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 enablelogging when starting the setup program by including a command-line parameter of /l.

For example, you could start the InputAccel Client setup program (or any of the other setupprograms) 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 specifiedfile. After the installation completes (or fails and rolls back), you can examine the log file to helpdetermine the cause of the problem.

Note: Wait until the setup program closes before opening the log file to ensure that all log entrieshave 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. Thelog file can become quite large (20 MB or more) depending on the particular setup program andthe specified logging level.

153

Troubleshooting

Setup programs write entries to the log file as events occur. In some cases, one error might lead toanother. It is important to find the first error in the chain in order to properly troubleshoot an issue.

Both errors and non-error information may be written to the log file. A return value of 3 indicates anerror or failure entry in the log. You can save time by searching for the string “return value 3”. Thefollowing 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. Thepreceding lines in the log file indicate the problem. Most installation errors are written to the logwith a specific error code and, when available, an error message. These errors often provide enoughinformation to enable you to resolve the issue. If not, a setup program log file will help your customersupport representative quickly evaluate the problem.

Topics in this section include:• Installation Errors, page 154

• Command-line Installation Failures, page 155

Installation Errors

Errors discussed here occur during installation and do not cause the setup program to perform arollback operation. Most can be corrected and then the installation completed. The following tablelists common installation errors.

Table 19. Common Installation Problems

Problem Possible cause

While installing any component, the setupprogram indicates that you have supplied aninvalid password when in fact the password iscorrect.

An authentication problem occurs when the useris logged into a machine without the necessaryaccess rights to query the Windows domain.This happens when both of the followingconditions are true:• The user is logged into a local user accountwhile running the setup program.

• The credentials causing the authenticationfailure are domain credentials.

154

Troubleshooting


Client installation fails with error 1330: A filethat is required cannot be installed because thecabinet file has an invalid digital signature.

The InputAccel Client setup program is suppliedin a large .cab file whose contents cannotbe extracted on a Windows XP or WindowsServer 2003 machine until Windows UpdateKB938759 is installed. This language-specificupdate is installed automatically by the Clientsetup program only when the default operatingsystem language is one of the following: Chinese(CHS), German (DEU), English (ENU), Spanish(ESN), French (FRA), Italian (ITA), Japanese(JPN), Korean (KOR), Portuguese (PTG),Brazilian Portuguese (PTB), Russian (RUS).

If you are installing the InputAccel Clientsoftware on an XP or Server 2003 machinewhose default language is not listed here, youmust obtain this update from Microsoft inthe language of the target machine’s defaultoperating system and install it prior to installingany InputAccel client software.

Command-line Installation Failures

Command-line installation failures include:• Syntax Errors, page 155

• Common Command-Line Installation Errors, page 156

Syntax Errors

Unattended Installations, page 97 explains how to install InputAccel from command-line instructions.When using this method, the command line can become very long due to the number of InputAccelfeatures and options.

Many command-line errors occur because the command line contains syntax errors or incompleteinformation.

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 exampleshows one quoted parameter correctly nested within another quoted parameter. A common error isto omit or misplace one or more quote marks.

The best way to troubleshoot command line installation issues is to examine the setup program logfiles, as explained in Installation Failures, page 153.

155

Troubleshooting

Common Command-Line Installation Errors

The following table lists some of the more common errors that customers experience when runningsetup programs from the command line.

Table 20. Common Installation Problems


Installation does not occur silently—the userinterface displays and waits for a response.

A space character was typed between /v andthe first open quote symbol.

The message “Please go to the ControlPanel to install and configuresystem components” is displayed.

The setup command was not executed from thedirectory containing the setup.exe program.

Windows restarts automatically after setupcompletes.

If the setup program determined that a restartwas necessary to complete the installation, itperforms an automatic restart. This behavior canbe changed by including one of the followingrestart options:

/norestart: Do not restart after setupcompletes.

/promptrestart: Prompt the user to restart ifnecessary.

/forcerestart: Always restart after setupcompletes, regardless of whether the setupprogram determines that a restart is necessary.

(For users upgrading from InputAccel 5.3SP3/SP4) client installation requires 1024 x 768display resolution.

Regardless of whether you are running modulesas applications or as services, and regardless ofwhether you are installing on a physical machineor in a VMware image, your client machine musthave its screen resolution set to a minimum of1024 x 768. If set to a lower resolution, the setupprogram will not allow you to proceed.

Installation does not occur. The command line exceeds the maximumallowable length of 1066 characters. You canverify this problem by observing the WindowsTaskManager and noting that the setup programstarts and then exits before installation occurs.

156

Troubleshooting


Miscellaneous installation errors. Syntax issues can cause various errors whenattempting a command-line installation. Notethe following rules:• Properties containing spacesmust be enclosedin quotation marks that have been escapedwith a backslash character (\). Example:

INSTALLDIR=\"c:\Program

Files\InputAccel\Client\"

• Properties containing the reserved characters\, &, |, >, <, and ^ must escape thosecharacters with a caret character (^).Example:

SCANNERNAME=\"Canon DR-4580U ^&

DR-5580U\"

Third-party Component IssuesCertain InputAccel client modules rely on third-party components provided by the company thatproduces the application to which they connect. There are two categories of modules with this issue:those that will not install without the required third-party components, and those that will install, butnot run, without the required third-party components.

• Modules that will not install until third-party components are installed:

— ApplicationXtender Export

— IBM CM Advanced Export

• Modules that install but will not run until third-party components are installed:

— Documentum Advanced Export

— FileNet Panagon IS/CS Export

— Global 360 Export

— IBM CMIP-390 Export

— IBM CMIP-390 Index

— IBM CSSAP Export

— ODBC Export

— Open Text Livelink Advanced Export

For a detailed list of additional software requirements for client modules, refer to Module-SpecificRequirements, page 19.

157

Troubleshooting

Post-installation issuesThis section provides troubleshooting tips for issues that can occur after a successful installation,including:• Database Issues, page 158

• ScaleServer Issues, page 159

• Other Issues, page 160

Database Issues

The InputAccel Database is a required component of an InputAccel system that resides in an instanceof Microsoft SQL Server. SQL Server must be configured to enable the InputAccel system to connectand communicate with the InputAccel Database. Following are some common problems that canoccur.

Table 21. Common Database-Related Problems


InputAccel Database setup programcannot create the InputAccel Database.

• SQL Server is not running. On the SQL Server hostmachine, use the Windows Service Control Managerto locate the SQL Server service and make sure it isstarted.

• Inadequate SQL Server permissions. DuringInputAccel Database setup, the account specified tocreate the InputAccel Database must be assignedthe sysadmin Server Role. Typically, you wouldenable the “sa” (system administrator) account loginand assign it a password within SQL Server andthen specify this account to install the InputAccelDatabase.

InputAccel components cannot connectto SQL Server.

• TCP/IP protocol is disabled within SQL Server.Consult the SQL Server documentation forinstructions on enabling the TCP/IP protocol. Restartthe SQL Server service after changing this setting.

• The SQL Server is not listening on the expected port.(The default SQL Server port is 1433. These may havebeen changed during SQL Server configuration.)Specify the correct port in the connection informationduring InputAccel setup.

158

Troubleshooting


InputAccel components cannot log intoSQL Server

• SQL Server Authentication mode is notenabled. InputAccel does not support Windowsauthentication. You must specify a SQL Server username and password to connect. Consult SQL Serverdocumentation for instructions on enabling SQLServer and Windows Authentication mode.

• When enabling SQL Server Authentication mode, theUser must change password at next login checkboxwas selected. The first time an InputAccel componentattempts to connect to the InputAccel Database, SQLServer attempts to prompt for a password change.Because the InputAccel component has no userinterface to support changing the password, it cannotconnect. You must ensure that SQL Server does notprompt for a password change.

• SQL Server is using a named instance. Whenspecifying a connection string to the SQL Server, youmust include the instance name as follows:

hostname\instancename

InputAccel components cannot accessthe InputAccel Database.

• Insufficient access rights. The account specifiedduring InputAccel component installation to connectto these databases must have the database rolemembership set to public and must have beengranted the Connect, Delete, Execute, Insert, Select,and Update permissions.

• The InputAccel Database is renamed or the servicewas stopped. If the database is renamed, allInputAccel components must be reconfigured toconnect to the database using the new name. If theservice was stopped, it must be restarted.

Batches from previous versions thatcontain Documentum Server Exportsteps cause batch errors when run byDocumentum Advanced Export.

• Login credentials are not retained when upgradingand must be specified again.

ScaleServer Issues

When InputAccel Servers are configured as a ScaleServer group, client modules must connect to oneof the InputAccel Servers in the ScaleServer group by using the machine name of the machine hostingthe InputAccel Server. If an IP address or the name “localhost” is used in the Server name field of theconnection string, the connection to the server will fail.

159

Troubleshooting

Other Issues

This section explains some common issues that may occur during InputAccel setup.

Table 22. Other Problems during InputAccel Setup


InputAccel Server fails to start The account used to run the InputAccel Server may nothave the necessary rights and permissions. Add the useraccount specified for the InputAccel Server service tothe local LUA group that is created when the InputAccelServer is installed: InputAccel_Server_admin_group.If the LUA group has been deleted, follow theseinstructions to recreate it:1. Stop all instances of the InputAccel Server service

on the machine on which the group is to be created.

2. Open a command prompt window on theInputAccel Server machine.

3. Type the following command line:

ias.exe -repair -r rootdir -s

servicename [-a1 account1] [-a2

account2]

where:• rootdir is the name of the root InputAccel Serverfolder (default: C:\IAS).

• servicename is the instance name of the servicethat runs the InputAccel Server (default:"InputAccel Server").

• a1, a2 are accounts to add to the LUAgroup. If not specified, an emptyInputAccel_Server_admin_group groupis added.

Note: Zero to two accounts may be added usingthe command line. Additional accounts maybe added by using the Microsoft ManagementConsole. To add domain accounts, specifythe a1 and a2 arguments using the syntax:domain\account. To add local accounts, donot specify a domain.

Examples —• Create the LUA group using the defaultInputAccel Server root folder and serviceinstance name:

160

Troubleshooting


ias.exe -repair -r C:\IAS -s

"InputAccel Server"

• Create the LUA group using the defaultInputAccel Server root folder and serviceinstance name, adding one local user accountand one domain user account to the group:

ias.exe -repair -r C:\IAS -s

"InputAccel Server" -a1 dasna_o

-a2 federal\potus

4. Confirm LUA account creation by viewing LocalUsers and Groups in the Microsoft ManagementConsole.

5. Repeat this command for each instance of theInputAccel Server installed on the machine.

6. Start all instances of the InputAccel Server service.

InputAccel Server fails to start whenconfigured to run as a service

The InputAccel Database server must start before theInputAccel Server can start. The InputAccel Serverservice waits for up to ten minutes for the InputAccelDatabase to become available, and fails to start if theInputAccel Database is unavailable. To investigatethe problem, check the Application Event Log on theInputAccel Server machine for the following entry:IADBConnectionFailed, Event #2210. If thisentry is present, troubleshoot the InputAccel Databaseserver to determine why it is not starting.

Administration Console fails to connectto any InputAccel Server

Administration Console does not have the necessary“run-as” privileges. Configure the AdministrationConsole to use a user or machine account that has localAdministrator privileges.

Attempting to login to theAdministration Console web browser,displays the Windows login credentialsuser interface

If the machine from where Administration Console isaccessed does not have IPv6 enabled, users are presentedwith the interface to enter their Windows credentialswhen they attempt to log in to Administration Console.If you want to avoid this issue, either disable IPv6 on theAdministration Console web server machine or enableIPv6 on the Administration Console browser machine.If these options are not acceptable, continue enteringyour Windows credentials each time you log in to theAdministration Console.

161

Troubleshooting


Attempting to connect to AdministrationConsole results in a “Failed to access IISmetabase” error

This error may occur when IIS is installed after installing.NET Framework. Another reason could be that whenIIS was installed, the rights of the ASP .NET userwas not set correctly. To resolve this issue, open acommand line window and run the following commandC:\WINDOWS\Microsoft.NET\Framework\v2.0.50727>aspnet_regiis -i

The following message appearswhen attempting to run a module insetup mode: “Unable to launchmodule setup. Either themodule could not be found,or the EMC LaunchModuleSetupassembly permissions need tobe re-authorized.”

Running a module in setup mode, either from theAdministration Console or from a command prompt,requires the module to be installed on the machinefrom which setup is being attempted. If the module isinstalled and still cannot be run in setup mode, do oneof the following:• Uninstall and reinstall the module.

• Re-authorize the EMCLaunchModuleSetup assemblypermissions using theMicrosoft CodeAccess SecurityPolicy Tool (Caspol). For information on fixingpermissions with Caspol, refer to information on theMicrosoft Developers Network website.

The module successfully starts in setupmode from a command prompt andsuccessfully runs in production mode.However, the followingmessage appearswhen attempting to run a module insetup mode from the AdministrationConsole: “Unable to launchmodule setup. Error: Objectdoesn’t support this propertyor method.”

Internet Explorer 8 has increased security that preventsrunning .NET assemblies from the Internet zone.Typically this error occurs when specifying an IPaddress or localhost for the Administration Consoleweb server instead of the computer’s DNS name(fully-qualified name with domain suffix). If unable touse a DNS name, one solution is to add the IP addressto the Trusted Zone in Internet Explorer. The Microsoftsupport web sites discuss additional solutions. Searchfor “.NET control no longer loads in IE8 in InternetZone.”

InputAccel client fails to connect toInputAccel Server

• InputAccel Server service is not running. On theInputAccel Server host machine, use the WindowsService Control Manager to locate the InputAccelServer service and make sure it is started.

• Client cannot communicate with server. Verify thatthe client machines and the InputAccel Server are allconfigured to communicate on the same port (10099,by default).

• Client cannot communicate with the server. If usingnon-updated client modules from version 6.0 SP1/SP2or client modules from version 5.3 SP3/SP4 with the6.5 BCP, verify whether there are differences in thelocale, globalization, or code page settings on theInputAccel Server machine and the client machine.

162

Troubleshooting


InputAccel client fails to connect toInputAccel Server (continued)

• Client cannot connect to server when running themodule as a service using a local machine account,such as Network Service. To successfully connect,you must do one of the following:— Configure the InputAccel Server machine to allowanonymous access.

— Run the client module on the same machine asthe InputAccel Server.

— Configure InputAccel to use Kerberos and setan SPN for the InputAccel Server, as explainedin Configuring InputAccel to use Kerberosauthentication, page 35.

• The machine name of the InputAccel Server is longerthan 15 bytes. Machine names longer than 15 bytesare truncated by NetBIOS software and result in aninability to connect to the InputAccel Server.

• Hostname resolution fails. If attempting to connectusing a machine name rather than an IP address,make sure the name resolves to an IP addressby using the command line ping or nslookupprogram.

• A firewall is blocking access. Make sure theInputAccel Server host machine’s firewall isconfigured to pass incoming network traffic on therequired port (10099, by default).

The error “Setup has detected that theSQL Server servername is not configuredproperly” occurs during InputAccelDatabase setup

The SQL Server host machine was renamed after SQLServer was installed. The host name registered withinSQL Server must match the host name of the machine.This is a common problem when using VMware to hostInputAccel Server. A Microsoft Knowledge Base articleprovides a SQL query that fixes this issue.

Web Services Input does not function Be sure that the Web Services Hosting service and theWeb Services Coordinator service have been started inthe Windows Service Control Manager.

Remote modules exhibit a long delaywhen logging into the InputAccelRemoting server

Logging into a remote module that is connectingthrough the InputAccel Remoting host takesconsiderably longer than modules that are logging inlocally. In addition to authenticating and authorizingthe user, the module also downloads configurationinformation, client-side scripts, and a list of batches.

163

Troubleshooting


Cannot specify -department (or othercommand-line arguments) when startinga ClickOnce-deployed module

Command-line arguments are not supported whenClickOnce packages are deployed from a file share.Deploy modules from a URL to specify command-linearguments. Furthermore, the command-line argumentshave a different syntax when specified as part of a URL.This syntax is explained in each applicable moduleguide.

When using IPv6, the AdministrationConsole does not run when you enteredits URL in Internet Explorer

When the Administration Console web component wasinstalled, a specific IP address was specified in the IPaddress to use for this web site field. To fix the issue,uninstall and reinstall the Administration Console webcomponent, and this time specify (All Unassigned) inthis field.

InputAccel Server cannot be activatedbecause the Activate Server and Browsebuttons are disabled in AdministrationConsole.

On the machine hosting the Administration Console, IISis configured in isolation mode. Disable IIS isolationmode to enable application pooling.

In some cases, a notebook machine thatdoes not have a parallel port encountersa STOP error (displays a blue screenwith an error message and shuts down)after being undocked from a dockingstation that has a parallel port (whenthe notebook machine is running theInputAccel Server).

The Sentinel driver that is installed for use with aparallel port hardware security key is causing the issue.To prevent this problem, use Windows Device Managerto disable the Sentinel driver (found under “Non-PlugAnd Play Drivers.”) in all hardware profiles.

To verify differences in the locale, globalization, and code page settings on theInputAccel Server and client machines:

1. On the machine where a client module is installed, open the settings.ini file.The default location is c:\Documents and Settings\All Users\ApplicationData\EMC\InputAccel.

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 clientlocale settings with all client module settings. Search for the diff string. This section liststhe 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 InputAccelServer machine and the client module machine, change the regional settings so that these settingson the InputAccel Server and client machines are identical.

164

Appendix A

Prerequisite Software Installed by theInputAccel Setup Program

The InputAccel setup program installs prerequisite software if the software is not already installed.The prerequisite software varies depending on the InputAccel component that is installed. Thissection lists the prerequisite software installed for each InputAccel component.

Note: Depending on the language of the operating system and the presence of MUI packs, multiplelanguage versions of some of the prerequisite files are installed on the target machine.

Prerequisite Software Installed with theInputAccel Database• Microsoft Windows Installer 4.5

• Update for Microsoft Windows Installer 4.5

• .NET Framework 3.5 SP1

• SQL Server 2005 Backward Compatibility

Prerequisite Software Installed with theInputAccel ServerThe following prerequisite software is installed with the InputAccel Server:• Microsoft Windows Installer 4.5


• Microsoft .NET Framework 3.5 SP1

• Microsoft Visual Basic for Applications Core

• Microsoft Visual JSharp .NET v2.0 Redistributable

Prerequisite Software Installed with InputAccelWeb Components• Microsoft Windows Installer 4.5



165

Prerequisite Software Installed by the InputAccel Setup Program

• Microsoft Internationalized Domain Names (IDN) Migration APIs 1.1


• Microsoft WSE 3.0

• Crystal Reports runtime 10.5 for .NET Framework 2.0

Prerequisite Software Installed with theInputAccel Client Modules• Microsoft Windows Installer 4.5


• Microsoft .NET Framework 1.1


• Microsoft Internationalized Domain Names (IDN) Migration APIs 1.1

• Microsoft Hotfix KB938759

• Microsoft Visual Basic for Applications Core


166

Appendix B

InputAccel Client Modules

The following table lists all InputAccel client modules and their capabilities.

Note: The client setup program installs additional applications that are not client modules. Thisincludes the following applications:• CaptureFlow Designer

• Process Developer

• Web Services Coordinator

• Web Services Hosting

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 ofmodules that you can safely run as multiple application or service instances.

167


Table 23. InputAccel Modules

Mod-ulesNew in6.0 orlater7

Mod-ulesAvail-ablePrior to6.08

Executablename9

DBCS10 Scale-Server11

At-tended12

Unat-tended13

Appli-cation14

Multi-appli-cationin-stances15

Ser-vice16

Multi-ser-vice17

CSS18

.NETCodeMod-ule

Emc.In-putAccel.Code.dll

Yes Yes Yes No Yes Yes Yes Yes Yes

19

Ap-plica-tionX-tenderExport

exax.exe Yes Yes Yes Yes Yes Yes No No No

ArchiveExport

exsapal.exe

Yes Yes Yes Yes Yes Yes No No No

7. Indicated modules were introduced in InputAccel 6.0 or later.8. Indicated modules were introduced prior to InputAccel 6.0.9. Executable name of the module.10. Can process tasks that include double-byte character values, such as Korean and Chinese.11. Can connect to multiple InputAccel Servers that are configured as a ScaleServer group.12. Can be operated in attended production mode, displaying an interactive user interface.13. Can be operated in unattended production mode, without any user interaction.14. Can be run as an application.15. Multiple application instances can safely be run on a single machine.16. Can be configured to run as Windows services.17. Multiple instances can safely be run as Windows services on a single machine.18. Can use client-side scripting.19. .NET Code Module provides a separate programming interface that is independent of the client-side scripting interface used by other modules. The .NET

Code Module Guide provides configuration and reference information.

168




Executablename9


At-tended12

Unat-tended13

Appli-cation14


Ser-vice16

Multi-ser-vice17

CSS18

AutoAnno-tate

iastamp.exe

No No Yes Yes Yes No No No No

Copy iacopy.exe Yes No Yes Yes Yes No No No No

DLLViewer

pixloadd.exe

No No Yes No Yes Yes No No No

Docu-men-tumAd-vancedExport

Documentu-mAdvanced-Export.dll

Yes Yes Yes Yes Yes Yes Yes Yes Yes

EastEuro /APACOCR

EastEuroA-PACOCR.dll

Yes Yes Yes Yes Yes Yes Yes Yes No

EmailImport

EmailImport.exe

Yes Yes Yes Yes Yes No Yes No No

169




Executablename9


At-tended12

Unat-tended13

Appli-cation14


Ser-vice16

Multi-ser-vice17

CSS18

FileNetCon-tentMan-agerExport

exfncm.exe Yes Yes Yes Yes Yes Yes No No No

FileNetPanagonIS/CSExport

iaxfnet2.exe

Yes No Yes Yes Yes Yes

20

No No No

FileSystemExport

exfile.exe Yes No Yes Yes Yes Yes No No No

20. FileNet IS/CS Export allows running multiple application instances, but multiple connections may be restricted by the repository.

170




Executablename9


At-tended12

Unat-tended13

Appli-cation14


Ser-vice16

Multi-ser-vice17

CSS18

Global360Export(for-merlyknownaseiStreamWMSExport)

iaexwnt.exe

No No Yes Yes Yes Yes No No No

IBMCMAd-vancedExport

exicm.exe Yes Yes Yes Yes Yes Yes Yes No No

IBMCMIP-390Export

iaexfaf.exe

No Yes Yes Yes Yes Yes No No No

IBMCMIP-390Index

iafafidx.exe

No Yes Yes Yes Yes Yes No No No

171




Executablename9


At-tended12

Unat-tended13

Appli-cation14


Ser-vice16

Multi-ser-vice17

CSS18

IBMCSSAPExport

excssap.exe


Image iaimage.exe

Yes Yes Yes Yes Yes Yes Yes No No

ImageCon-verter

ImageCon-verter.dll


Im-age En-hance-ment

iaipi.exe Yes Yes Yes Yes Yes Yes Yes No No

ImageExport

iaeximg.exe


172




Executablename9


At-tended12

Unat-tended13

Appli-cation14


Ser-vice16

Multi-ser-vice17

CSS18

ImageQualityAssur-ance

iaiqa.exe Yes No Yes No Yes No No No No

Index-Plus

Emc.In-putAc-cel.In-dex.dll

Yes Yes Yes No Yes Yes No No Yes

IndexExport

iaexidx.exe

Yes No Yes Yes Yes Yes Yes No No

MSShare-PointExport

exshrpt2.exe


Multi iamulti.exe


Multi-Direc-toryWatch

MultiDi-rectory-Watch.exe


Nu-anceOCR

NuanceOCR.dll

Yes Yes Yes Yes Yes Yes Yes Yes Yes

173




Executablename9


At-tended12

Unat-tended13

Appli-cation14


Ser-vice16

Multi-ser-vice17

CSS18

ODBCExport

iaxodbc2.exe


OpenTextLivelinkAd-vancedExport

exll2.exe Yes Yes Yes Yes Yes Yes No No No

PageRegis-tration

pagereg.exe


PDFExport

iaexpdf.exe


Pixview iademon.exe

No No Yes No Yes Yes No No No

Res-can-Plus

Emc.In-putAc-cel.ReS-can.dll

Yes Yes Yes - Yes Yes No No Yes

Scan-Plus

Emc.In-putAccel.Scan.dll

Yes Yes Yes No Yes Yes No No Yes

174




Executablename9


At-tended12

Unat-tended13

Appli-cation14


Ser-vice16

Multi-ser-vice17

CSS18

Spawn iaspawn.exe

No No Yes Yes Yes Yes No No No

Timer iatimer.exe

No Yes Yes Yes Yes Yes Yes No No

Valuesto XML

val2xml.exe

Yes No Yes Yes Yes No Yes No No

WSInput

WebSer-vicesIn-put.dll

Yes Yes No No No No Yes Yes Yes

WSOutput

WebSer-vicesOut-put.dll

Yes Yes No No No No Yes Yes Yes

175


176

Appendix C

Languages Supported

InputAccel supports the following languages:

Table 24. Languages Supported in InputAccel

Language Windows code page Language code Locale ID (LCID)

Chinese (Simplified) 936 zh-cn 2052

English (United States) 1252 en-us 1033

French (France) 1252 fr-fr 1036

German (Germany) 1252 de-de 1031

Italian (Italy) 1252 it-it 1040

Korean 949 ko-kr 1042

Portuguese (Brazil) 1252 pt-br 1046

Russian (RussianFederation)

1251 ru-ru 1049

Spanish (Spain) 1252 es-es 1034

177

Languages Supported

178

Appendix D

Ports Used

The following table lists the ports used by the various components of the InputAccel application.

Table 25. Ports Used

Port Used for

1433 The SQL Server default port.

40571 The TCP port that enables Web Services Hosting to receive connections fromWeb Services Coordinator and transmit web calls to it through .NET Remoting.

12007 The TCP port that enables Web Services Coordinator to receive connections fromAdministration Console and the WS Input module.

10099 The default TCP port that enables InputAccel client modules to communicatewith the InputAccel Servers and the InputAccel Remoting server, if used. Thiscan be changed during installation and may be different for each InputAccelServer in a side-by-side installation.

80 The following may be changed during installation of these components:• The Administration Console default port for web browser connections.

• The InputAccel Remoting default port for client connections.

179

Ports Used

180

Appendix E

Running the Create Database Utility

The Create Database Utility creates a SQL Server database. By default, the InputAccel Databasesetup program creates the InputAccel Database automatically. Use the Create Database Utility inthe following circumstances:• You disabled the default setting to create the InputAccel Database when running the InputAccelDatabase setup program.

• You have been directed by support personnel to update your InputAccel Database with scriptsprovided to you.

To run the Create Database Utility:

1. From the Startmenu, click Programs > InputAccel > Create Database Utility.

2. From the Server list, type or select the name of the SQL Server on which you want to create theInputAccel database. If your SQL Server is using a named instance, append the instance namein this field, separated by a backslash (“\”).

3. In the Database field, type the name of the database that you want to create.

4. Under Authentication Mode, type the login credentials for the SQL Server.

5. In the Path to database scripts field, type the root path to the list.txt file, whichspecifies all of the SQL scripts that need to be executed. Alternatively, click Browse tonavigate to list.txt. The default installation scripts are installed in C:\ProgramFiles\InputAccel\Databases\DBScripts. The top-level lists.txt file also can befound here.

6. Select the Update existing database checkbox to update the InputAccel Database for a patch orupgrade. If you are creating the database for the first time, clear the checkbox.

7. Click OK to save your settings, run the utility, and exit.

181

Running the Create Database Utility

Running the Create Database Utility in SilentModeThe Create Database Utility program is used to silently create the InputAccel Database. It is runfrom a command prompt window.

Create Database Utility syntax:

All arguments are required and must be specified in this exact order:

CreateDbConsole <DBServer> <DBName> <DBUserID> <DBPassword> <DBScriptDir>

Table 26. Explanation of Command-line Arguments used to Install the Create Database Utility

Command line argument Description

CreateDbConsole Runs the Create Database Utility.

DBServer Name of the SQL Database Server.

DBName Name of the database that you want to create and populatewith database scripts.

DBUserID User name for the SQL Server login screen, the databaseaccount, and the scripts to be executed.

DBPassword Password for the specified user name.

DBScriptDir Root path to the list.txt file, which specifies all of the SQLscripts that need to be executed.

Create Database Utility Command-line Examples

The following is a sample command line that would create the database on a server called “jsmith”. Itspecifies a username of “sa” (system administrator) and a password of “pwd”:

CreateDbConsole jsmith IADB sa pwd C:\EIM\Emc.InputAccel\Data.Databases\

182

Appendix F

Command-line Arguments for InstallingInputAccel

InputAccel supports a subset of the standard InstallShield and Windows Installer command linearguments. All command line examples must be typed on one command line which may wrap tomultiple lines in a command prompt window. The Windows Installer switches and InputAccelfeatures and properties are case sensitive. Use the examples as they are shown. The topics in thissection describe the supported command line instructions:

• Supported InstallShield Switches, page 183

• Supported MSI Switches, page 184

• Supported Windows Installer Properties, page 184

• InputAccel Installer Properties and Feature Names, page 184

Supported InstallShield SwitchesThe following table describes the supported InstallShield switches:

Table 27. Supported InstallShield Switches

Switch Description

/v Passes the MSI parameter switches from the InstallShield setupcommand line to MSI.

/x Removes a product.

For more information on the supported InstallShield switches, search the Internet for “Setup.exeand Update.exe Command-Line Parameters.”

Related Topics —

Supported MSI Switches, page 184Supported Windows Installer Properties, page 184

183

Command-line Arguments for Installing InputAccel

Supported MSI SwitchesInputAccel supports the Windows Installer version 3.1 command line parameters that enable you toinstall, display, restart, log information, update, and repair InputAccel installations. Msiexec.exe isthe Windows Installer executable program that interprets packages and installs products.

Type msiexec.exe /? at a command prompt to view a complete list of the Windows Installercommand line arguments.

Related Topics —

Supported InstallShield Switches, page 183InputAccel Installer Properties and Feature Names, page 184

Supported Windows Installer PropertiesThe ADDLOCAL Installer property is the most commonly used property. It locally installs a list offeatures, that are delimited by commas.

Refer to theMSDN Library Windows Installer Property Reference on the Internet for additionalinformation regarding Installer properties.

InputAccel Installer Properties and FeatureNamesTo perform a silent installation, use InstallShield and MSI command-line parameters in conjunctionwith the InputAccel feature names and properties. You perform silent installations on the appropriatemachines to create the InputAccel Databases, InputAccel Server, InputAccel client modules, andInputAccel web components, which include the Administration Console and the Web Servicescomponents. The topics in this section describe installer properties and feature names:• InputAccel Database Installer Properties, page 185

• InputAccel Server Components Installer Properties, page 187

• InputAccel Web Components Installer Properties, page 193

• InputAccel Client Components Installer Properties, page 196

• Installing the Backward Compatibility Pack from a Command Line, page 201

184


InputAccel Database Installer Properties

You can install the InputAccel Database in unattended mode using command line arguments. Forexample:

setup.exe /s /v"/qn property=value /promptrestart"

where “property = value” is a list of installer properties to be passed into the setup program.

At a minimum you must specify the ADDLOCAL property. For example:

setup.exe /s /v"/qn ADDLOCAL="ALL" /promptrestart"

CreateDbConsole.exe only runs when the CREATE_DATABASE installer property is set to a valueof 1. This is the default value. In addition, the following installer properties must be specified:• SQL Server name

• SQL Server port

• SQL Server username

• SQL Server password

• Database name

The CreateDbConsole.exe application must not be run in interactive mode during an unattended(or silent) installation.

The SQL Server port has a default value of 1433. This means that if this installer property is notpassed in, 1433 is used.

Note: SQL Server validation is not possible during a silent installation. It is the responsibility of theuser to pass the correct information to CreateDbConsole.exe.

The following table lists the installer properties that can be specified when installing the InputAccelDatabase:

Table 28. Supported InputAccel Database Installer Properties

Installer property Value Description

ADDLOCAL Features toinstall

A comma delimited list of the features toinstall. Since there is only one feature in thiscomponent to install, users should specifyALL.

CREATE_DATABASE 0/1/2 • 0: Do not install the InputAccel database.Only the database scripts are installed.

• 1: Install the InputAccel database.

• 2: Upgrade the InputAccel database.

A default value of 1 is used when thisproperty is not specified.

185



DB_SERVER Hostname Hostname of the SQL Server. You can use(local) or localhost if you want to use thelocally installed SQL Server.

DB_PORT TCP port number This is the TCP port on which the SQL Serverlistens for connections.

The default value is 1433.

DB_NAME Database name The name of the configuration SQL database.

The database name has the followingrestrictions:• The database name can have a maximumof 122 characters.

• The database name can only contain thecharacters 0–9, A–Z, an underscore, $, #, @and must begin with a number, a letter, oran underscore.

A default value of “IADB” is used if thisproperty is not specified.

DB_USER SQL user name The name of the SQL Server user name toconnect to SQL Server.

DB_PASS SQL password The password for the SQL Server that theuser specified in the DB_USER property.

INSTALLDIR Path The destination directory for the databaseapplication files.

A default value of %ProgramFiles%\In-putAccel\Database is used when thisproperty is not specified.

InputAccel Database Installer Command-line Examples

• This example installs CreateDB.exe, CreateDbConsole.exe, and the database scripts intothe default installation directory. CreateDbConsole.exe is executed to install the InputAccelDatabase on the locally installed SQL Server which listens for connections on the default port of1433. The default InputAccel Database name is used.

setup.exe /s /v"/qn ADDLOCAL=ALL DB_SERVER="(local)" DB_USER="sa"DB_PASS="password" /promptrestart"

186


• This example installs CreateDB.exe,CreateDbConsole.exe, and the database scripts intothe directory specified by INSTALLDIR. CreateDbConsole.exe is executed to install theInputAccel database to the remote SQL Server named “CORP-SQL” which listens for connectionson the default port of 1433. The default InputAccel database name is used.

setup.exe /s /v"/qn ADDLOCAL=ALL INSTALLDIR=\"c:\ProgramFiles\InputAccel\Databases\" CREATE_DATABASE=1 DB_SERVER=CORP-SQLDB_USER=sa DB_PASS=password /promptrestart"

Related Topics —

InputAccel Server Components Installer Properties, page 187InputAccel Client Components Installer Properties, page 196InputAccel Web Components Installer Properties, page 193Installing the Backward Compatibility Pack from a Command Line, page 201

InputAccel Server Components Installer Properties

You can install the InputAccel Server in unattended mode using command line arguments. Forexample:



At a minimum, you must specify the ADDLOCAL and IA_SERVICES_RUNAS_LOCAL_SYSTEMproperties. For example:

setup.exe /s /v"/qn ADDLOCAL="ALL" IA_SERVICES_RUNAS_LOCAL_SYSTEM="1"/promptrestart"

Note:• The root directories for each InputAccel Server must be specified when more than one instance isbeing installed. Each root directory must be unique and should be on its own hard disk drive.The properties for these instances are IAS1_ROOT_DIR, IAS2_ROOT_DIR, IAS3_ROOT_DIR,and so forth.

• The character limit on setup command line length is 1066 characters.

The following table lists the installer properties that can be specified when installing the InputAccelServer.

187


Table 29. Supported InputAccel Server Installer Properties



Features to install. The following features areavailable:• IASERVER: InputAccel Server

• BASE_IAP_FILES: Standard and compiledInputAccel process files.

• SERVER_DOCS: Documentation to assistwith the installation process.

INSTALLDIR Path The destination directory for the Serverapplication files.

A default value of %ProgramFiles%\In-putAccel\Server is used when thisproperty is not specified.

SERVER_INSTANCES 1 – 8 The number of InputAccel Server instancesto install.

A default value of 1 is usedwhen this propertyis not specified.

REGISTER_DATABASE 0/1 • 0: Do not perform DAL registration for theInputAccel Database.

• 1: Perform DAL registration for theInputAccel Database.

A default value of 1 is usedwhen this propertyis not specified.

DB_SERVER Hostname Hostname or machine name of the SQLServer. You can use (local) or localhost if youwant to use the locally installed SQL Server.

DB_PORT TCP port The TCP port number to use to connect to theSQL Server.


DB_NAME Database name The name of the InputAccel Database. Adefault value of “IADB” is used if thisproperty is not specified.

DB_USER SQL user name The name of the SQL Server user namerequired to connect to the SQL Server.

DB_PASS SQL password The password of the SQL Server user specifiedin the DB_USER property.

188



AC_MACHINE_USER_NAME

Username The user account specified as the “Run-as”user for the Administration Console. Thisproperty is only valid when the InputAccelServer is installed on machines that aremembers of a Windows domain.

AC_MACHINE_DOMAIN_NAME

Domain name The domain name of the user accountspecified as the “Run-as” user for theAdministration Console. This property is onlyvalid when the InputAccel Server is installedon machines that are members of a Windowsdomain.

CONFIGURE_WINDOWS_FIREWALL

0/1 This property is only valid when theMicrosoftWindows Firewall is running and enabled.• 0: Do not make configuration changes tothe Windows Firewall.

• 1: Allow setup to configure the WindowsFirewall. This is the default setting whenthe property is not passed in.

IAS_SERVICES_AUTOSTART

0/1 Automatically starts the InputAccel Serverservice for the first instance when Windowsstarts.• 0: Manual. Do not start automatically.

• 1: Automatically start the InputAccelServer service for the first instance whenWindows starts. The default value is 1unless otherwise specified.

IAS<#>_ROOT_DIRwhere <#> is anumber from 1through 8. Example:IAS1_ROOT_DIR

Path The destination directory for the root directoryused by the InputAccel Server instance that isdetermined by <#>. You can have instancesfrom 1 through 8.

A default path of WINDRIVE\IAS is usedwhen this property is not specified. Forexample, the path is C:\IAS when Windowsis installed on the C: drive.

Caution: The path length must not begreater than 109 characters and cannotbe the same as the root directory for anyother InputAccel Server instance.

189



ACTIVE_ACTIVE_CLUSTER

0/1 Determineswhether the InputAccel Server canbe configured to be used in an Active/Activecluster.• 0: The InputAccel Server will not beconfigured for use in a Active/Activecluster. This is the default value when theproperty is not specified.

• 1: The InputAccel Server will be configuredfor use in an Active/Active cluster. The IPaddress for each InputAccel Server instancebeing installed must be specified when thevalue of this property is 1.

IAS<#>_IP_ADDR where<#> is a number from1 through 8. Example:IAS1_IP_ADDR

IP address The IP address that the specified instance(determined by <#>) of InputAccel Serverlistens to for network connections. Thisparameter should only be used when theproperty ACTIVE_ACTIVE_CLUSTER has avalue of 1.

IAS<#>_TCP_PORTwhere <#> is anumber from 1through 8. Example:IAS1_TCP_PORT

TCP port The specified InputAccel Server instance(determined by <#>) listens to the specifiedTCP port number. The default value is 10099when this value is not specified.

IA_SERVICES_RUNAS_LOCAL_SYSTEM

1/2 • 1: The InputAccel Server service runs usingthe Local System account.

• 2: The InputAccel Server service runswithout using the Local System account.When this option is selected, you mustspecify a username and password.

IA_SERVICES_RUNAS_USER_ACCT

Domain\Username The InputAccel Server service uses thisaccount when running. When specifying alocal account, use a “.\” (without quotes) infront of the user name. When specifying adomain account, use domain\username.

This option is only used when the installerproperty IA_SERVICES_RUNAS_LOCAL_SYSTEM is passed in with a value of 2indicating that the installer uses a specificuser account and not the built-in local systemaccount.

190



IA_SERVICES_RUNAS_PSWD

Password The InputAccel Server service uses thispassword with the user account specified forrunning this service.

This option is only used when the installerproperty IA_SERVICES_RUNAS_LOCAL_SYSTEM is passed in with a value of 2indicating that the installer uses a specificuser account and not the built-in local systemaccount.

Topics in this section include:• InputAccel Server Installation Features, page 191

• InputAccel Server Installer Command-line Examples, page 191

InputAccel Server Installation FeaturesNote: Multiple features can be specified by delimiting each feature with a comma.

The following are supported feature names that can be specified when installing the InputAccelServer:

Table 30. Supported InputAccel Server Installation Features

Feature name Description

IASERVER Installs the InputAccel Server sub-features that manageall client module activity and acts as the repository for allInputAccel batches, processes and other data.

BASE_IAP_FILES Installs the standard InputAccel process files (IAP)only. These files are installed to a default location of[WindowsVolume]\IAS.

SERVER_DOCS Installs documentation to assist with the installation process.

Related Topics —

InputAccel Server Components Installer Properties, page 187InputAccel Server Installer Command-line Examples, page 191

InputAccel Server Installer Command-line Examples

• This example installs one instance of the InputAccel Server into the directory specified byINSTALLDIR. The service is installed and runs under the built-in Local System account. It doesnot configure the Windows Firewall (if it is installed and running). The installer performs DALregistration against the InputAccel Database on the SQL Server installed on the same machine,

191


which listens for connections on the default port of 1433. The system automatically restarts ifa reboot is required.

setup.exe /s /v"/qn ADDLOCAL="ALL" INSTALLDIR=\"c:\ProgramFiles\InputAccel\Server\" IA_SERVICES_RUNAS_LOCAL_SYSTEM=1CONFIGURE_WINDOWS_FIREWALL=0 DB_SERVER="(local)" DB_USER="sa"DB_PASS="password""

• This example installs eight instances of the InputAccel Server into the directory specified byINSTALLDIR. All eight instances of the InputAccel service use the local Administrator useraccount (which has a password of “password”) as the “run-as” credentials. The root directoryfor each InputAccel Server instance is specified by the properties IASn_ROOT_DIR, where n isthe number of the specific instance. The TCP port used by each InputAccel Server instance isspecified by the properties IASn_TCP_PORT, where n is the number of the specific instance. Theinstaller performs DAL registration against the InputAccel Database on the SQL Server installedon a different machine (“CORP-SQL”), which listens for connections on the NON-default port of3999. The NON-default InputAccel Database name is “CORP_IADB”. The system automaticallyrestarts if a reboot is required.

setup.exe /s /v"/qn ADDLOCAL="ALL" INSTALLDIR=\"c:\ProgramFiles\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=10101IAS4_TCP_PORT=10102 IAS5_TCP_PORT=10103 IAS6_TCP_PORT=10104IAS7_TCP_PORT=10105 IAS8_TCP_PORT=10106 IA_SERVICES_RUNAS_LOCAL_SYSTEM=2IA_SERVICES_RUNAS_USER_ACCT=".\Administrator" IA_SERVICES_RUNAS_PSWD="password" DB_SERVER="CORP-SQL" DB_PORT=3999 DB_NAME="CORP_IADB"DB_USER="sa" DB_PASS="password""

• Install sample process files to local IAS directory (C:\IAS): This example installs only the sampleprocess files (IAP) to the C:\IAS directory.

setup.exe /s /v"/qn ADDLOCAL=BASE_IAP_FILES"

Related Topics —

InputAccel Server Components Installer Properties, page 187InputAccel Client Components Installer Properties, page 196

192


InputAccel Web Components Installer Properties

You can install InputAccel Web components in unattended mode using command line arguments.For example:


where “property = value” is a list of installer properties to be passed into the setup program.The list of properties is available in the table below. At a minimum you must specify the ADDLOCAL,WEB_SITE_RUNAS_USER, AC_WEB_SITE_RUNAS_USER, andWEB_SITE_RUNAS_PSWD properties.For example:

setup.exe /s /v"/qn ADDLOCAL="ADMINISTRATION_CONSOLE" WEB_SITE_RUNAS_USER="Administrator" WEB_SITE_RUNAS_PSWD="password" /promptrestart"

Note: In a silent installation, SQL Server validation cannot be performed.

The following table lists the installer properties that can be specified when installing the InputAccelweb components:

Table 31. Supported InputAccel Web Component Installer Properties



This is a comma delimited list of the features toinstall. The following features are available forinstallation:• ADMINISTRATION_CONSOLE: Installs theAdministration Console

• IA_REMOTING: Enables remote client modulesaccess to the InputAccel Server and databases.

Note: Only one of these features can be specified.The two features cannot be installed on the samemachine.

REGISTER_DATABASE

0/1 • 0: Do not perform DAL registration for theInputAccel Database.

• 1: Perform DAL registration for the InputAccelDatabase.

A default value of 1 is used when this property isnot specified.

DB_SERVER Hostname Hostname or machine name of the SQL Server. Youcan use (local) or localhost if you want to use thelocally installed SQL Server.

DB_PORT TCP port number The TCP port to use to connect to SQL Server. Adefault value of 1433 is used if this property is notspecified.

193



DB_NAME Database name The name of the InputAccel Database.

A default value of “IADB” is used if this propertyis not specified.

DB_USER SQL user name The name of the SQL Server user to use forconnecting to SQL Server.

DB_PASS SQL password The password of the SQL Server user specified inthe DB_USER property.

WEB_SITE_DESCRIPTION

Websitedescription

This is the description of the InputAccel WebComponents IIS website. The default value“InputAccel Web Components” is used when thisproperty is not specified.

WEB_SITE_IP_ADDRESS

IP address This is the IP address the InputAccel WebComponents IIS website should listen to foravailable connections. The default value of “ (AllUnassigned)” is used when this property is notspecified.

WEB_SITE_TCP_PORT

Website TCPport number

This is the TCP port on which the InputAccel WebComponents IIS website listens for connections.The default value of 80 is used when this propertyis not specified. The InputAccel Web Componentswebsite will not function properly if the specifiedTCP port is in use by an existing IIS website. Forexample, the built-in IIS default website.

WEB_SITE_RUNAS_USER

Username The user account under which the InputAccel WebComponents run.

Note: This is a required property. The silentinstallation quits if this property is not passed inthe command-line argument.

WEB_SITE_RUNAS_PSWD

Password The password of the user account specified in theinstaller property WEB_SITE_RUNAS_USER. Donot specify this value if the user account has a blankpassword.

WEB_SITE_RUNAS_DOMAIN

Domain name The domain the user account specified in theinstaller property WEB_SITE_RUNAS_USER. Donot specify this value if the user is a local user andnot a domain user.

INPUT_ACCEL_SERVER_NAME

Hostname or IPaddress

The hostname or IP address of the InputAccelServer to which the IIS Client Remoting featureconnects. This property is only used whenthe feature IA_REMOTING is specified for theADDLOCAL property.

194



INPUT_ACCEL_SERVER_PORT

TCP port The TCP port of the InputAccel Server to whichthe IIS Client Remoting feature connects. A defaultvalue of 10099 is used when this property is notspecified. This value must be a number from 1 to65535. This property is only used when the featureIA_REMOTING is specified for the ADDLOCALproperty.

IA_REMOTING_VIRTUAL_DIR_NAME

Virtualdirectory name

The name of the virtual directory used byInputAccel Remoting. This name must be specifiedin the URL used by remote InputAccel clientsto connect to the InputAccel Server throughInputAccel Remoting.

This section includes the following topic:• InputAccel Web Components Installer Properties, page 193

InputAccel Web Components Installer Command-line Examples

• This command installs the Administration Console to run on TCP port 8080. It performs DALregistration against the InputAccel Database on the SQL Server installed on the same machinewhich listens for connections on the NON-default port of 2000. The default InputAccel Databasename is used. The InputAccel Web Components website runs under the domain user account“CORP\CorpServices” which has a password of “password”.

setup.exe /s /v"/qn ADDLOCAL="ADMINISTRATION_CONSOLE" DB_SERVER="(local)" DB_PORT=2000 DB_USER="sa" DB_PASS="password"WEB_SITE_TCP_PORT=8080 WEB_SITE_RUNAS_USER="CorpServices"WEB_SITE_RUNAS_PSWD="password" WEB_SITE_RUNAS_DOMAIN="CORP""

• This command installs InputAccel Remoting. The installer performs DAL registration against theInputAccel Database on the SQL Server installed on a different machine, “CORP-SQLSERVER”,which listens for connections on the default port of 1433. The default InputAccel Database nameis used. InputAccel Remoting is configured to connect to the InputAccel Server running on adifferent machine, “IA-PRODUCTION”. The InputAccel Web Components website runs underthe local Administrator account which has a password of “password”. The system automaticallyrestarts if a reboot is required.

setup.exe /s /v"/qn ADDLOCAL="IA_REMOTING" DB_SRVR="(local)"DB_SERVER="CORP-SQLSERVER" DB_USER="sa" DB_PASS="password" INPUT_ACCEL_SERVER_NAME="IA-PRODUCTION" WEB_SITE_RUNAS_USER="Administrator"WEB_SITE_RUNAS_PSWD="password""

Related Topics —

Installing the Administration Console, page 59InputAccel Web Components Installer Properties, page 193

195


InputAccel Client Components Installer Properties

You can install the InputAccel client components in unattended mode using command linearguments. For example:



At a minimum, you must specify the ADDLOCAL=ALL and IA_SERVICES_RUNAS_NAMED_ACCTproperty. 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 therequired Documentum software has been installed.

The following table lists the installer properties that can be specified when installing the InputAccelclient components:

Table 32. Supported InputAccel Client Components Installer Properties



This is a comma delimited list ofthe features to install. Refer to thefeatures and components section of thisdocument for a list of features.

IASERVERNAME Hostname or IPaddress

The hostname or IP address of theInputAccel Server that the InputAccelclient services connect to.

Note: Some InputAccel client moduleswill not start if this property is notspecified during the silent installation.

IASERVERPORT TCP port number The TCP port number of the InputAccelServer that the InputAccel clientservices connect to. The default valueis 10099 unless otherwise specified.This value must be a number from 1 to65535.

IA_SERVICES_AUTOSTART 0/1 • 0: InputAccel client services will notbe set to start when Windows start.

• 1: All InputAccel client services willbe set to start when Windows start.


196



INSTALL_CLIENT_APPS_AS_SERVICES

0/1 • 0: Do not install compatible clientapplications as services.

• 1: Install compatible clientapplications as services.


Note: The InputAccel Web Servicescomponents always install as Windowsservices regardless of this settingbecause these modules cannot run asapplications.

IA_SERVICES_RUNAS_NAMED_ACCT

0/1 • 0: All InputAccel client services runusing the Network Service account.

• 1: All InputAccel client servicesnot run using the Network Serviceaccount. When this option isselected, you must specify ausername and password.

The properties IA_SERVICES_RUNAS_USER_ACCT andIA_SERVICES_RUNAS_PSWDmust bespecified when the value 1 is passed in.


IA_SERVICES_RUNAS_USER_ACCT

Domain\Username All InputAccel client services use thisaccount to run the services. Whenspecifying a local account, use a “.\”(without quotes) in front of the username. When specifying a domainaccount, use domain\username. Thisoption is only used when the servicesare set to “run as” the user account andnot the Network Service account.

IA_SERVICES_RUNAS_PSWD Password All InputAccel client services usethis password with the user accountspecified for running the services. Thisoption is only used when the servicesare set to “run as” the user account andnot the Network Service account.

197



INSTALLDIR Path The destination directory for the Clientapplication files.

A default value of %Program-Files%\InputAccel\Client isused when this property is not speci-fied.

SKIP_SCANNER_INSTALL 0/1 • 0: Installs a scanner driver duringthe installation.

• 1: Skip the installation of a scannerdriver.

A default value of 0 is used when thisinstaller property is not specified.

SCANNERNAME Scanner drivername

The nameof the scanner driver to install.The available drivers can be found in the\Clients\drivers\DRIVRMAP.TXTfile on the InputAccel installationmedia.

Topics in this section include:• InputAccel Client Components Installation Features, page 198

• InputAccel Client Components Installer Command-line Examples, page 201

InputAccel Client Components Installation Features

Each feature listed in this table can be used to install its component during a silent installation byspecifying its name as the ADDLOCAL property. You can specify more than one feature to installby separating the feature names with commas.

The following are supported feature names that can be specifiedwhen installing the InputAccel Client:

Table 33. Supported InputAccel Client Components Installation Features

Feature name Installs

AX_EXPORT The ApplicationXtender Export module.

CMNSTORE_EXPORT The IBM CSSAP Export module.

CAPTUREFLOW_DESIGNER The CaptureFlow Designer and Process Developer, whichenables administrators to design, debug, and compileInputAccel processes.

198



COPY The Copy module.

DCTM_ADVANCED_EXPORT The Documentum Advanced Export module.

DOTNETCODE_MODULE The .NET Code Module.

EASTEURO_APAC_OCR The East Euro / APAC OCR module.

EMAIL_IMPORT The Email Import module.

FAF_EXPORT The IBM CMIP-390 Export module.

FAF_INDEX_ The IBM CMIP-390 Index module.

FILE_EXPORT The File System Export module.

FILENET_EXPORT The FileNet Panagon IS/CS Export module.

FNCM_EXPORT The FileNet Content Manager Export module.

ICM_EXPORT The IBM CM Advanced Export module.

IMAGE The Image module.

IMAGE_CONVERTER The Image Converter module.

IMAGE_EXPORT The Image Export module.

INDEX_APPLICATION The IndexPlus module.

199



INDEX_CLICKONCE The ClickOnce deployable package of IndexPlus.

INDEX_EXPORT The Index Export module.

IPI The Image Enhancement module.

IQA The Image Quality Assurance module.

LL2_EXPORT The Open Text Livelink Advanced Export module.

MULTI The Multi module.

MULTIDIRECTORY_WATCH The Multi-Directory Watch module.

NUANCE_OCR The NuanceOCR module.

ODBC_EXPORT The ODBC Export module.

P_DOCUMENTATION User guides and other relevant InputAccel documentation.

PAGEREG The Page Registration module.

PATCH_CODE_IMAGES Sample Patch code II, III, and T pages that users can print andthen use when scanning batches.

PDEV The Process Developer, which enables administrators todesign, debug, and compile InputAccel processes.

PDF_EXPORT The PDF Export module.

PIXVIEW The Pixview module.

PROCESS_FILES Sample InputAccel process files (IAP) that can be modifiedwith the Process Developer.

RESCAN_APPLICATION The RescanPlus module.

RESCAN_CLICKONCE The ClickOnce deployable package of the RescanPlus module.

SAPAL_EXPORT The Archive Export module.

SCAN_APPLICATION The ScanPlus module.

SCAN_CLICKONCE The ClickOnce deployable package of the ScanPlus module.

SCRIPTING_LIBRARIES Libraries and documentation used for writing customclient-side scripts.

SHRPNT2_EXPORT The MS SharePoint Export module.

SPAWN The Spawn module.

STAMP The Auto Annotate module.

TEST_IMAGES Sample test images.

TIMER The Timer module.

VAL2XML The Values to XML module.

200



WANGNT_EXPORT The Global 360 Export module.

WEB_SERVICES_COORDINATOR The Web Services Coordinator component.

WEB_SERVICES_HOSTING The Web Services Hosting component.

WEB_SERVICES_INPUT The Web Services Input module.

WEB_SERVICES_OUTPUT The Web Services Output module.

Related Topics —

InputAccel Client Components Installer Command-line Examples, page 201InputAccel Client Components Installer Properties, page 196

InputAccel Client Components Installer Command-line Examples

• This command installs all client components into the default installation directory. The InputAccelservices are installed and use a specific Windows user account as the “run-as” user account. Theinstalled InputAccel client services connect to the InputAccel Server “PROD-IASERVER” whenstarted. The services start automatically when Windows starts. The system does not restartafter installation even if a reboot is required.

setup.exe /s /v"/qn ADDLOCAL="ALL" IA_SERVICES_AUTOSTART=1INSTALL_CLIENT_APPS_AS_SERVICES=1 IA_SERVICES_RUNAS_NAMED_ACCT=1IASERVERNAME="PROD-IASERVER" IA_SERVICES_RUNAS_USER_ACCT=".\Administrator" IA_SERVICES_RUNAS_PSWD="password" /norestart"

• This command installs ScanPlus into the default installation directory. The scanner driver CanonDR-4580U is installed during the installation. The system automatically restarts if a reboot isrequired.

setup.exe /s /v"/qn ADDLOCAL="SCAN_APPLICATION" SCANNERNAME=\"CanonDR-4580U\""

Related Topics —

InputAccel Client Components Installation Features, page 198InputAccel Client Components Installer Command-line Examples, page 201

Installing the Backward Compatibility Pack from aCommand Line

The following command line enables InputAccel client modules version 5.3.3 or 5.3.4 to run in anInputAccel 6.0 environment:

To run the Backward Compatibility Pack:

1. Open a Command Prompt window.

201


2. At the command prompt, navigate to the DLLOnly subdirectory of the installation media.

3. Type setup.exe /s /v"/qn".

Related Topics —


202

Index

64-bit recommendations, 27, 29

Aaccessibility, 26ACL, 39activating, 49

after upgrading with a newdomain, 119

and side-by-side installation, 50considerations, 26file, 49InputAccel Server, 65portal, 49upgrade considerations, 119

Active/Active cluster, 81Administration Console, 118

and InputAccel Remoting, 30and security, 39host system considerations, 30installing, 59port, 30port assignment, 62specifying the domain on a single

machine installation, 46application pool worker process

recycling, 31ApplicationXtender Export

system requirements, 19arbitrary SPN, 35Archive Export

system requirements, 19attended modules, 32Audit Extensions, upgrading, 140Audit Logging, 28authentication, 39automatic

backup during upgrade, 115

BBackward Compatibility Pack, 126

command-line installation, 201installing, 135

balancing client machines, 33, 37best practices

for cluster configuration, 80for high availability, 47for running modules as services, 33

CCaptureFlow Designer

updgrading XPP-based processes, 139Citrix, 23, 26ClickOnce

and command-line arguments, 31and InputAccel Remoting, 31and security, 39deploying modules with, 92deployment prerequisites, 92Deployment Utility, 92host system considerations, 30SSL certificate requirement, 92system requirements, 14

client machinemachine considerations, 32

client modulebalancing, 37

client modulesand high availability, 47balancing, 33client machine system requirements

and recommendations, 17command-line examples, 201installer properties, 196, 198installing, 65permissions, 66privileges, 39table of, 167upgrade considerations, 119

203

Index

upgrading, 136clustering

Active/Active, 81for disaster continuation, 47installing InputAccel Server for, 79licensing, 51

CODU. See ClickOnce Deployment Utilitycommand-line arguments

and ClickOnce deployment, 31Backward Compatibility Pack, 201client module installer properties, 196InputAccel Database installer

properties, 185InputAccel installer properties and

feature names, 184InputAccel Server installer

properties, 187InputAccel web components installer

properties, 193installer, list of, 97, 99InstallShield switches, 183/l, 98MSI switches, 184msiexec.exe, 98/s, 98serviceName, 102setup.exe, 98/v, 98Windows Installer properties, 184

command-line arguments for installingInputAccellist of, 183

common system requirements for all clientmodules, 17

compatibilityCitrix, 23IPv6, 23Section 508 compliance, 23VMotion, 23VMware, 23

configuringIIS application pool, 31ScaleServer group, 78

considerationsactivating, 26Audit Logging, 28disaster continuation, 26, 48failover, 26high availability, 26licensing, 26

network configuration, 25performance, 25scalability, 25

Create Database Utility, 181command-line examples, 182silent mode, 182

Crystal Reports, 104customizations

upgrading, 140

Ddata sharing, 37database

Create Database Utility, 181operating system, 12 to 13, 15, 18server considerations, 27

database serversystem requirements, 11

demonstration installation, 45development installation, 45disaster continuation

considerations, 26, 48creating a plan, 48implementing a system, 49licensing, 51planning, 47

Documentum Advanced Exportsystem requirements, 20

Documentum Server Export,upgrading, 121

domainand activation codes, 119installing InputAccel in a

workgroup, 45multiple, 39, 45troubleshooting, 154

dongle. See security key

EEmail Import, 125EMC Captiva Activation Portal, 49escape characters for command-line

setup, 99

Ffailover, 46

considerations, 26general considerations, 46

204

Index

FileNetContent Manager Export system

requirements, 19Panagon IS/CS Export system

requirements, 19firewall

and Web Services, 32configuring, 41ports to open, 41troubleshooting, 162

Ggeneral considerations

high availability/failover, 46installation, 25

Global 360 Export system requirements, 19

Hhardened environment, 42high availability, 46

best practices, 47considerations, 26general considerations, 46modular clients, 47ScaleServer group, 46

https, 39, 92

Iiaidxv32.dll, 141IBM

CSSAP Export systemrequirements, 20

identifying system requirements forupgrading, 116

IISconfiguration, 31disabling Machine Administrators

account, 40Index module, upgrading, 122Index Validation DLL, upgrading, 141IndexPlus

system requirements, 21InputAccel, 184

activating, 65installing, 53installing a production system, 73installing on a single machine, 53Internet access, 31

licensing, 65list of ports used by, 179modules table, 167upgrading, 107, 128, 130

InputAccel Databaseinstaller command-line examples, 186installer properties, 185installing, 54security, 38upgrade considerations, 117

InputAccel Remotingand Administration Console, 30and ClickOnce, 31and security, 39, 42host system considerations, 31installing, 89port assignment, 31

InputAccel Serveractivating, 65anonymous access, 162installation features, 191installer command-line examples, 191installer properties, 187installing, 57installing in a cluster, 79installing multiple instances of, 76scalability, 36server considerations, 29system requirements and

recommendations, 13upgrade considerations, 117upgrading, 133

InputAccel web componentsinstaller command-line examples, 195installer properties, 193

InputAccel_Server_admin_group, 42, 53,57, 117

install planning, general considerations, 25installation

maximum length of command line, 99networking considerations, 26troubleshooting command-line

errors, 156troubleshooting command-line

failures, 155troubleshooting database issues, 158troubleshooting errors, 154troubleshooting failures, 153troubleshooting other issues, 160troubleshooting ScaleServer issues, 159

205

Index

troubleshooting syntax errors, 155troubleshooting third-party component

issues, 157installation planning

Administration Console hostsystem, 30

ClickOnce host system, 30client machine considerations, 32client scalability, 37compatibility, 23configuring multiple domains, 45database server, 27development/demonstration

system, 45disaster continuation, 47failover, 46hardened environment, 42high availability (HA), 46InputAccel Remoting, 31InputAccel Server, 29InputAccel Server scalability, 36licensing and activation, 49minimumWindows permissions, 42performance and throughput, 27running modules as services, 33sample configurations, 51scalability, 36security, 38Web Services subsystem, 32workgroup installation, 45

installer properties and feature names, 184installing, 65

Administration Console, 59automating silent installations, 100automating unattended

installations, 100Backward Compatibility Pack, 135clients, 65command-line arguments, 97command-line arguments, list of, 183command-line considerations, 99command-line escape characters, 99Crystal Reports, 104InputAccel, 53InputAccel Database, 54InputAccel Remoting, 89InputAccel Server, 57InputAccel Servers in a clustered

environment, 79modules as services, 101

multiple instances of InputAccelServers, 76

new functionality after upgrading, 138on a single machine, 53planning for, 25Process Developer, 65production system, 73Reports Designer, 104silent installations, 97unattended, 97Web Services subsystem, 65

InstallShield switches, 183Internet access to InputAccel, 31IPv6

Administration Consoleconsiderations, 59, 90

support for, 23irreplaceable files, preserving during

upgrade, 112ISIS scanner drivers, 24

KKerberos protocol, 35, 162

L/l command-line argument, 98least-privileged user account (InputAccel

Server), 39, 42, 57, 117licensing, 49

clustering, 51considerations, 26disaster recovery, 51InputAccel, 65ScaleServer, 50upgrade considerations, 119

load balancing, 37locale considerations, 26localhost, 46LUA, 39, 42, 57, 117

Mmaximum length of installer command

line, 99minimum

cross-domain trust relationship, 45permissions, 42

modifyingan InputAccel installation, 151

206

Index

unattended installations, 100modules

attended, 32multiple service instances, 102running as service, 33table of, 167unattended, 32unregistering a service instance, 103

MS SharePoint Exportsystem requirements, 21

MSCS cluster. See clusteringMSI switches, 184msiexec.exe, 98Multi module

upgrading to Synchronize, 139Multi-Directory Watch, 126multiple

domains, 45service instances, 102

NNetwork Service account issues, 162networking

configuration considerations, 25

OODBC Export

system requirements, 21Open Text Livelink Advanced Export

system requirements, 22operating system

database, 12 to 13, 15, 18

Ppage count sharing in a ScaleServer

group, 50performance, 27

considerations, 25permissions

assigning after upgrading, 139assigning to client modules, 66minimum, 42upgrade considerations, 126

planninginstallation, 25upgrading, 107

portsAdministration Console, 30, 62

and firewalls, 41InputAccel Remoting, 31SQL Server, 55table of, 179

pre-production testing and acceptance afterupgrading, 127

processsharing, 37upgrading, 140

Process Developer, installing, 65

Rrecommendations, 11

64-bit, 27, 29disaster recovery implementation, 49RAID, 27

removing an InputAccel installation, 152repairing an InputAccel installation, 152Reports Designer, installing, 104requirements, 11Rescan module, upgrading, 120RescanPlus

system requirements, 22rolling back

client machines, 137InputAccel Server, 134

running InputAccel with minimumWindows permissions, 42

S/s command-line argument, 98sample

configurations, 51images, 65images, installing, 65scripting libraries, 65

SANand automatic real-time replication, 47

scalability, 36client modules, 37considerations, 25InputAccel Server, 36

ScaleServer group, 36and load balancing, 37and process sharing, 37compatibility, 36configuring, 78high availability, 46

207

Index

licensing, 50page count sharing, 50troubleshooting issues, 159

Scan Callback DLL, upgrading, 141Scan module, upgrading, 120scanner drivers, 24scanning workstation system

requirements, 24ScanPlus

system requirements, 22ScanSoft OCR, upgrading, 119scripting libraries, installing, 65SCSI adapter, 24Section 508, 23, 26security, 38 to 39

ACL, 39Administration Console, 39authentication, 39ClickOnce, 39client privileges, 39considerations, 25disabling the IIS Machine

Administrators account, 40firewalls, 41hardened environment, 42InputAccel Database, 38InputAccel Remoting, 39, 42list of ports used by InputAccel, 179SQL Server, 38user accounts, 40user roles, 39web components, 39

security key, 49and side-by-side installation, 50upgrade considerations, 119

service principal name, 35ServiceClass, 35serviceName argument, 102services

installing modules to run as, 101multiple instances, 102running modules as, 33unregistering modules running as, 103

setspn.exe, 35setting UI language, 69setup.exe, 98side-by-side installations, 76

and port assignments, 179and scalability, 37and security keys, 50, 119

silent installation, 97SPN, 35SQL Server, 54

port assignment, 55system requirements, 11

SSL certificatefor use with ClickOnce deployment, 92

Synchronize moduleupgrading from Multi, 139

system requirementsApplicationXtender Export, 19Archive Export, 19ClickOnce host, 14client workstation, 17common for all client modules, 17database server, 11Documentum Advanced Export, 20FileNet Content Manager Export, 19FileNet Panagon IS/CS Export, 19Global 360 Export, 19IBM CSSAP Export, 20IndexPlus, 21InputAccel Server, 13module-specific, 19MS SharePoint Export, 21ODBC Export, 21Open Text Livelink Advanced

Export, 22RescanPlus, 22scanning workstation, 24ScanPlus, 22Values to XML, 22web components, 14

system requirements andrecommendations, 11

Tthroughput, 27troubleshooting, 153

command-line installation errors, 156command-line installation failures, 155database issues, 158domain authentication problems, 154firewalls, 162installation errors, 154installation failures, 153other issues, 160ScaleServer issues, 159setting the UI language, 69

208

Index

syntax errors, 155third-party component issues, 157

UUI language

setting, 69unattended installation, 97

automating, 100modifying, 100

unattended modules, 32upgrade planning, 107

Administration Console, 118and permissions, 126automatic backup, 115Backward Compatibility Pack, 126client modules, 119considerations, 118Documentum Server Export, 123Documentum Server Export to

Documentum AdvancedExport, 121

Excel Graphing utility, 123IBM Content Manager Export, 123identifying irreplaceable files, 112identifying new system

requirements, 116iManage WorkSite Server Export, 123Index to IndexPlus, 122InputAccel Database, 117InputAccel Servers, 117licenses, activation files, and security

keys, 119new client modules, 125performing pre-production testing and

acceptance, 127Rescan to RescanPlus, 120Scan to ScanPlus, 120Scansoft OCR to NuanceOCR, 119scheduling upgrade phases, 128understanding the upgrade

process, 116upgrading

assigning InputAccel permissions, 139Audit Extensions, 140client modules, 136custom Scan Callback

functionality, 141exiting processes and

customizations, 140

index validation functionality, 141InputAccel, 107, 128, 130InputAccel Server, 133installing new functionality, 138rolling back to a previous InputAccel

Client version, 137rolling back to a previous InputAccel

Server version, 134sample upgrade scenarios, 142using the Backward Compatibility

Pack, 135XPP-based processes, 139

user account, 40user roles, 39

V/v command-line argument, 98Values to XML

system requirements, 22VMware, 26

and high availability/failoverhe last, 46support for, 23VMotion, 23

Voluntary Product AccessibilityTemplate, 23

Wweb components

and security, 39system requirements and

recommendations, 14Web Services

Coordinator, 32Hosting, 32Input module, 125Output module, 125subsystem, considerations, 32subsystem, installing, 65

Windows Installer properties, 184worker process recycling, 31workgroup

installing InputAccel in, 45

XXPP

upgrading XPP-based processes, 139

209

Date post:	18-Jan-2019
Category:	Documents
Upload:	lamthu
View:	471 times
Download:	6 times