ABBYY FlexiCapture 10 System Administrator’s Guide © 2011 ABBYY. All rights reserved.
© 2011 ABBYY. All rights reserved. ABBYY, the ABBYY logo, FlexiCapture, FlexiLayout, FormReader, FineReader are either registered trademarks or trademarks of ABBYY Software Ltd. © 1984-2007 Adobe Systems Incorporated and its licensors. All rights reserved. Protected by U.S. Patents 5,929,866; 5,943,063; 6,289,364; 6,563,502; 6,639,593; 6,754,382; Patents pending.
Table of Contents Installing ABBYY FlexiCapture 10 ....................................................................... 5 Standalone Installation ............................................................................................................................................................................................................................ 5 System Requirements........................................................................................................................
License properties..................................................................................................................................................................................................................................... 56 License statuses...........................................................................................................................................................................................................................................
Installing ABBYY FlexiCapture 10 Before purchasing the product, analyze your document processing needs and select either the local or the distributed version. If you plan to process moderate amounts of documents (approximately 5,000 pages per day), employ one or two operators for the job, and do not require any sophisticated batch routing, then Standalone Installation is the best choice.
2. Select a setup language. The setup program will compare the locale of your system and the selected language. If the languages are incompatible, a warning message is displayed. 3. Next, the setup program checks the version of your operating system and the availability of the administrative permissions. If the version of the operating system is not supported by the program or you do not have the administrative permissions, a warning message is displayed and the setup program is terminated. 4.
2052 Chinese simplified 1040 Italian 1034 Spanish 2074 Serbian 1029 Czech 1038 Hungarian 1045 Polish 1046 Portuguese (Brazilian) 1042 Korean /V passes the specified command line directly to msiexec.exe. The string can be replaced with the following commands: INSTALLDIR="" – the path to the folder where ABBYY FlexiCapture 10 is to be installed. SETUPTYPE_CMD="" – available installation modes.
o Internet Explorer 7, 8, 9 or 10 FlexiCapture Authentication Module o Internet Information Server 7 or later o Microsoft .NET Framework 4.0 (4.5 if running under Windows Server 2012) For operation of Web Module for login and registration: o Microsoft Internet Explorer version 7, 8, 9 or 10 (Internet Explorer 10 for desktop is only supported under Windows 8 and Windows Server 2012).
• Microsoft .NET Framework 3.5 SP1 Processing Station • PC with Intel® Pentium®/Celeron®/Core™2 Duo/Quad/Xeon®/Core™ i3/Core™ i5/Core™ i7, AMD K6/Turion™/Athlon™/Duron™/Sempron™ with a minimum clock speed of 2 GHz.
Security settings for Mozilla FireFox: Java scripting = Enable FireFox will Remember History (Options -> Privacy) = Disable Data Verification Stations Data Verification Station o PC with Intel® Pentium®/Celeron®/Core™2 Duo/Quad/Xeon®/Core™ i3/Core™ i5/Core™ i7, AMD K6/Turion™/Athlon™/Duron™/Sempron™ with a minimum clock speed of 2 GHz.
o Operating system: Windows XP SP3, Windows Vista SP2, Windows 7 SP1, Windows 8, Windows Server 2003 SP2, Windows Server 2008 SP2+ Desktop Experience, Windows Server 2008 R2 SP1+ Desktop Experience, Windows Server 2012 + Desktop Experience (for localized interfaces, corresponding language support is required) o Memory: 1 GB o Hard disk space: 1 GB (including 90 MB for installation and space for scanned images). The size of downloadable file is 41 MB.
Windows Vista SP2, Windows Server 2008 SP2 Administrator User yes 3 3 no 3 3 2 3 yes The administrator password will be required no 3 3 Internet Explorer 8 or higher is required Windows 7 SP1, Windows Server 2008 R2 SP1 Administrator User recommended 3 3 no 3 3 2 3 recommended The administrator password will be required Windows 8 Administrator User no 3 3 recommended 3 3 no 3 3 2 3 recommended The administrator password will be required no 2 © 2011 ABBYY.
Windows Server 2012 Administrator 3 recommended 3** Installation is forbidden by default 3 no 3** Installation is forbidden by default User 2 2** The administrator password will be required The administrator password will be required recommended no 2 3** Installation is forbidden by default *Note: To allow user installation of ABBYY Scanning Plugin, you should enable the setting Disable Windows Installer (Computer Configuration -> Administrative Templates -> Windows Components -> Windows In
Supported virtual machines The following virtual machines are supported: • VMware Server 2.0 (this platform is no longer supported by the manufacturer) • VMware Workstation 6.5 - 9.0 • VMware ESXi 4.1.0 (server component of VMware vSphere) • Hyper-V 6.0, 6.1 or 6.2 (Hyper-V version corresponds to the version of the Operating system. Under Windows Server 2008, Hyper-V 6.0 is used) Note: Hyper-V virtual machines do not work with USB devices.
Management Tools IIS Management Console IIS 6 Management Compatibility IIS 6 Metabase Compatibility IIS 6 WMI Compatibility IIS 6 Scripting Tools You may also install other components of the IIS, for example, full installation may be performed. Preparing the Application Server for installation on Windows Server 2008 R2 This instruction can also be used when installing the Application Server on Windows 2008, Windows 7 and Windows Vista.
This component can be installed by selecting Install External Components in the Autorun menu. Note: You can find information about the installed versions of Net.Framework in the registry. For more information, please refer to the Microsoft web-site. • IIS (Internet Information Services) The Application Server can only be installed on a computer on which Microsoft Internet Information Server 5.1 or later is installed.
3. 4. During installation, Windows may ask for the source distribution files, so you need to have Windows installation CD. Enable installation of the following IIS internal components: -> Web Management Tools -> IIS Management Console -> IIS 6 Management Compatibility -> IIS 6 Metabase and IIS 6 configuration compatibility -> IIS 6 Scripting Tools -> World Wide Web Services -> Application Development Features -> ASP.
Other IIS components can be installed according to user preferences, e.g., perform a complete installation of IIS. Preparing the Application Server for installation on Windows 2003 This instruction can also be used when installing the Application Server on Windows XP. The following components must be installed on your computer before you can install the Application Server: • Net Framework 4.
© 2011 ABBYY. All rights reserved.
During installation, Windows may require files from the setup disk, therefore be sure to have the Windows disk ready at hand. If any of the components is missing on your computer, the setup program will display a warning message and the installation of the Application Server will stop. Once the installation is complete, open the Administrator Console and make sure that the IIS service is running. Important! In Windows 2003 ASP.NET is disabled by default for security reasons.
This service extension will appear in the list only after you install NET Framework 4.0. If ASP.net was installed before installation of IIS, registration of ASP.net must be performed: %systemdrive%\Windows\Microsoft.NET\Framework\v4.0.30319\aspnet_regiis.exe –i If your computer runs Windows 2003 (64-bit) or Windows XP (64 bit), do the following: 1. Execute the following command from the command line: cscript %systemdrive%\Inetpub\AdminScripts\adsutil.
3. Execute the following command from the command line: %systemdrive%\Windows\Microsoft.NET\Framework\v4.0.30319\aspnet_regiis.exe –i 4. The list of IIS service extensions (see below) will now include an entry for the 32-bit version of ASP.Net. Change its status to allowed: Installing the servers Once you have made the preparations for installing the Application Server, install the servers. By default, all servers are installed on the same computer.
4. If all the checks are passed successfully, the end-user license agreement will be displayed. Read the license agreement carefully and if you agree with the terms of the agreement, select the corresponding option and click Next. 5. A dialog box will open prompting you to enter some information about yourself. Enter the required information and continue with the installation. 6. Next, select the servers to install. You can also specify a destination folder.
If the server is stopped, in the Manage Server menu, choose Start. Similarly, check whether Default Web Site is running. IMPORTANT! The Application Server should be available on the Internet if you wish to use the remote stations over the Internet. Removing ABBYY FlexiCapture servers in silent mode msiexec /x {FC100000-0006-0000-0000-074957833700} External components required for the correct operation of the system • Ikey driver This component is required if you are going to use a USB key license.
System components in IIS and their configuration This section describes the IIS configuration which is necessary for the operation of FlexiCapture. This configuration is configured automatically during installation and required no manual configuration. However, in case of errors this section can help you to check the settings specified in IIS.
3. Choose a desired pool from the list. In the Actions menu, select Advanced Settings… The value of Enable 32-Bit Application must be True. It means that the pool works in 32-bit mode. Besides, the installer adds the following applications to Default Web Site (the set of applications depends on the configuration selected during the installation): Default Web Site\FlexiCapture10 – the Administration and Monitoring Console Default Web Site\FlexiCapture10\Server – the Application Server, in particular: © 20
Default Web Site\FlexiCapture10\Server\WebServices.dll – a web service of the Application Server which supports both Windows and Basic authentication. Default Web Site\FlexiCapture10\Server\WebServicesExternal.dll – a web service of the Application Server which supports authentication by means of the FlexiCapture Authentication Module (will be added if FlexiCapture Authentication Module was selected during the installation of ABBYY FlexiCapture 10 Servers). Default Web Site\Login – a web-based interface for
To access ABBYY FlexiCapture 10 applications, different authentication types are used: Windows authentication – a user tries to login to the server using the same credential under which the user browser runs. (Using UTF-8-encoded characters in the user name and the password may be not supported.) To pass Windows authentication, the user must be either a local user of the computer or a user of the domain which includes this computer.
Default Web Site\FlexiCapture10\Server (Application Server) - both Windows authentication and Basic authentication are enabled: Default Web Site\DataVerification (Web Data Verification Station) - only Anonymous authentication is enabled: © 2011 ABBYY. All rights reserved.
Default Web Site\Verification (Web Verification Station) - only Anonymous authentication is enabled. Default Web Site\Scanning (Web Scanning Station) - only Anonymous authentication is enabled. Default Web Site\Capture (Web Capture Station) - only Anonymous authentication is enabled. If FlexiCapture Authentication Module was installed, the following authentication settings are specified in IIS: Default Web Site\FlexiCapture10 (Administration and Monitoring Console) - only FlexiCapture authentication is enab
For correct operation of the Application Server, the installer creates a mapping «ABBYY FlexiCapture WebService» with the following parameters: Request path = «*.dll» Executable = «C:\inetpub\wwwroot\FlexiCapture10\Server\WebServicesIsapi.dll» Access = «Script» («Scripts and Executable» on IIS 6) © 2011 ABBYY. All rights reserved.
Note: It may happen that a third-party application is installed on the same computer as the Application Server, and it can intercept requests of ABBYY FlexiCapture 10. In this case, the following error message will occur when starting the Administration and Monitoring console: A runtime error occurred: Cannot get file storage path Details: Description Client found response content type of 'text/html; charset=utf-8', but expected 'text/xml'.
«FlexiCapture 10 Web Services» extension (path «C:\inetpub\wwwroot\FlexiCapture10\Server\WebServicesIsapi.dll») must be allowed. Checking the operation of IIS To check the operation of IIS, start IIS by selecting StartÆControl PanelÆAdministrative ToolsÆInternet Information Services. If a problem occurs when starting IIS, the following message will be displayed: “Unexpected error 0x8ffe2740 occurred” for v. 5.
database is performed must work in the same bit mode as both the pool of Administration and Monitoring console (FlexiCapture 10 Monitoring) and the pool of Application Server. If you switch the pool of Administration and Monitoring console to 64-bit mode, it will work in a different mode than the Application Server pool (which works in 32-bit mode). A possible solution is to install two identically configured Oracle clients one of which works in 32 bit mode and the other in 64 bit mode.
3. From the list of pools, choose FlexiCapture 10 Monitoring and in the Actions menu, select Advanced Settings… The value of Enable 32-Bit Application parameter must be False. It means that the Administration and Monitoring console works in 64-bit mode. In addition, check if using of 64-bit version of ASP.net is allowed in IIS settings. For this, open the IIS Manager console and choose the IIS server. From the menu on the right, select ISAPI and CGI Restrictions. © 2011 ABBYY. All rights reserved.
Allow using ASP.NET v4.0.30319 for Framework 64-bit (path C:\Windows\ Microsoft.NET\ Framework64\ v2.0.50727\ aspnet_isapi.dll) Database server SQL • For the Application Server to work, MS SQL Server is required (for the supported versions, see System Requirements). On the server, the "Mixed Mode" ("SQL server and Windows authentication") must be enabled for authentication. The installation © 2011 ABBYY. All rights reserved.
CD contains MS SQL Server 2005 Express. It can be used for demonstrative purposes and small projects. This version has a limitation on the database size of 4GB. If you already have an installed copy of MS SQL Server 2005 or 2008, you can use it. Oracle • Instead of SQL Server, the Oracle Server can be used as a database server (for the supported versions, see System Requirements). For this, a 32bit client for the Oracle database must be installed.
• manually (interactive installation) • from the command line • using Active Directory • using Microsoft Systems Management Server (SMS) The automated installation methods give you speed and flexibility when installing ABBYY FlexiCapture 10 on a local area network, as you do not have to install the program manually on each individual workstation. Manual (interactive) installation To install ABBYY FlexiCapture stations: 1. In the Autorun menu, select Distributed Installation. 2.
The program icon will appear in the Start menu of the workstation. Clicking this icon automatically installs the program in default configuration. Silent installation In the case of silent installation, no setup dialog boxes are displayed and the program is installed in default configuration. Setup.exe /qn Change “/qn” to “/qb” if you want an installation progress bar to be displayed. No other dialog boxes will be displayed.
The Publish to User and Assign to User methods are not supported. When deploying ABBYY FlexiCapture 10 using Active Directory®, the account of the computers in the Domain Computers domain must have read right to the administrative installation folder. Example: Deploying ABBYY FlexiCapture 10 using Active Directory The program is installed on one domain computer or on a group of domain computers: 1. During Server Installation, install the Station Installer.
4. On the shortcut menu, select Properties and click the Group Policy tab: 5. Click New, enter a descriptive name, and click OK. 6. Right-click the Group Policy Object you have created and select Edit... 7. In the Group Policy window, right-click Computer Configuration/Software Settings/Software Installation. 8. On the shortcut menu, select New/Package. © 2011 ABBYY. All rights reserved.
9. Provide the path to the file ABBYY FlexiCapture 10 Stations.msi, which is located in the administrative installation folder on the server. 10. Select the Advanced deployment method. 11. In the dialog box that opens, click the Modifications tab and then click the Add button. © 2011 ABBYY. All rights reserved.
12. Select the interface language to be used in ABBYY FlexiCapture 10. The language files are located in the administrative installation folder on the server. The list of available files and their corresponding languages: 1033.mst English 1049.mst Russian Using SMS Microsoft Systems Management Server automates software deployment and eliminates the need to go directly to the locations where the software is to be installed (computers, groups, or servers).
4. In the Package Properties dialog box, fill out the required fields. © 2011 ABBYY. All rights reserved.
5. Click the Data Source tab. 6. Make sure that This package contains source files is cleared and click OK. 7. Expand the node of the newly created package and select Programs. 8. In the Action menu, select New/Program. 9. In the Program Properties dialog box, click the General tab and on this tab: • In the Name field, type a descriptive name of the program • In the Command Line field, type setup.
Important! You cannot create Distribution Points. Installing Remote Stations Using Remote Stations allows you to connect to the Licensing Server from the computers which are not part of the LAN. Remote Stations include the Data Verification and Scanning stations. The Verification station can be both regular and remote. Remote Stations can connect to the Application Server via HTTP. To install Remote Stations: 1. Select Distributed Installation. 2.
Updating your earlier ABBYY FlexiCapture 10 releases to Release 6 ABBYY FlexiCapture 10 R5 supports projects created in ABBYY FlexiCapture 10 and ABBYY FlexiLayout Studio 10 and will also work with FlexiLayouts created in the previous version. Distributed installation Before updating: - Stop the Processing Server using the Processing Server Monitor Close all the stations, making sure that the background applications FlexiBR.exe, FlexiEx.exe, and ScanStationBR.exe are no longer running.
Important! Both database and a project will be converted to new format and it will be impossible to use them in ABBYY FlexiCapture 9.0 again. If you need to have a Database backup or to work with both ABBYY FlexiCapture 9.0 and ABBYY FlexiCapture 10 databases at the same time please follow the instruction below. If it is not necessary go to the 1-st item of the instruction about upgrade. To create a Database backup: - Create a FlexiCapture 9.0 Database backup by MS SQL Server means.
Upgrading from ABBYY FlexiCapture 8.0 Professional If you are installing ABBYY FlexiCapture 10 as an upgrade from version 8.0 you can use ABBYY FlexiCapture and ABBYY FlexiLayout projects as well as FlexiLayouts from the previous version. Using ABBYY FlexiCapture 8.0 Professional projects (*.fcproj) All ABBYY FlexiCapture 8.0 Professional projects (.fcproj) can be opened and used in ABBYY FlexiCapture 10 (both Standalone and Distributed). Please note the following: - It is impossible to open an .
If the element had a name which was allowed in version 8.0 but prohibited in ABBYY FlexiLayout Studio 10, and there was a reference to this element using a short name in the AdvancedCode, this element will be re-named during conversion, but the short name in the AdvancedCode is not changed. So, in the advanced code, there will be a reference to the element which doesn’t exist. In AdvancedCode, the element should be re-named manually. The structure like this is now prohibited: Let e = SearchElements.
Importing templates from ABBYY FormReader 6.5 batches (*.frm) All ABBYY FormReader 6.5 templates can be imported to ABBYY FlexiCapture 10. You must specify from which FormReader 6.5 batches (*.frm) you want to import templates. Note: Batches created in versions earlier than 6.5 cannot be imported. Conversion scenario 1. Open the ABBYY FlexiCapture 10 Project Setup Station for Distributed installation or the Administrator Station for Standalone installation. 2. Create a new project (File > New Project…).
Document and batch structure If the Document Definition imported from ABBYY FormReader 6.5 contains a custom structure which is not supported in ABBYY FlexiCapture 10, a set of one-page Document Definitions will be imported. 1. Document templates with predefined structure (one-page document, multi-page documents, sequence of pages) are correctly converted into the document definitions for ABBYY FlexiCapture 10 with the same structure. 2. Custom document structure is not supported in ABBYY FlexiCapture 10.
Problem An error occurred during import: Import failed. Error: Unable to define fixed layout inside flexible. Comment This bug occurred when a field was absent in an original FlexiLayout, but the compiled layout contained it. Workaround Open the *.fsp project in ABBYY FlexiLayout Studio 10 first to check that there are no errors, and re-compile it. Images do not match the converted fixed Document Definition, although the same images matched the template before conversion.
If the Flexible Description cannot be compiled, you will see the corresponding message during templates conversion. Open the *.fsp project in FlexiLayout Studio 10. Some of the elements may be invalid and have error description on the Errors tab. It is also possible that the FlexiLayout is successfully compiled, but some errors occur during matching. If you have such problems after conversion, please check if it happened due to one of the errors described below.
Managing Your Licenses After you install the program, you need to activate your serial number. This section describes the use of ABBYY FlexiCapture 10 License Manager, the license management utility supplied with ABBYY FlexiCapture 10. Overview ABBYY FlexiCapture 10 License Manager is a license management utility. It is installed on the Licensing Server when the server are installed.
License properties • General – the serial number, expiration date, licensing method, ability to use a virtual machine • License purpose – type of license (software or hardware), ability to provide document processing services • Work stations, Tools – restrictions on the number of stations in the system and the use of development tools (FlexiLayout Studio, FormDesigner). • Productivity – restrictions on the use of ABBYY FlexiCapture 10.
• Expired (the license had expired or the page limit has been reached) The current (i.e. active) license has a 3 next to it and is highlighted in bold. Buttons • Hide License Parameters<< (License Parameters>>) – hides (shows) the detailed information about the selected license • Activate License… - launches the ABBYY FlexiCapture Activation Wizard • Update License… - refreshes the information about the activated license • Select - makes the selected license current (i.e.
The address of the server is specified in the ServerAddress tag of the MainNetworkLicenseServer attribute. To enable a station to access a new Licensing Server, simply change the old name to the name of the computer where the Licensing Server is installed. The same applies to the standalone version of ABBYY FlexiCapture 10. If you have one license and several operator stations, specify the address of the computer where the license is stored in the LicensingSettings.xml files on the workstations.
Setting Up FlexiCapture 10 Distributed Installation Quick setup of FlexiCapture for demonstration installations This paragraph briefly describes a fast minimal set-up of FlexiCapture which can be used for demonstration installations.
This method requires minimal configuration and is suitable for scenarios where all FlexiCapture components and users are in the same domain. If the whole system or some of its components are outside of the domain, then a pass-through authentication should be used for the standard IIS authentication.
2. 3. Click the Create New Database button. Note: If you are already connected to another database, you will need to close existing sessions prior to creating a new database. If for some reason it is not possible, add the following key in the web.config file which is located at \: In this case, a new database will be created without a warning about existing ses
d) e) Note: If MS SQL server is installed on a different computer than the Application Server, then DataBase Server Authentication must be used to connect to a database server. Note: If MS SQL Server is used, then for communication with the database server, it is recommended to use TCP/IP protocol instead of Named Pipes (protocol is specified when configuring MS SQL Server Client which is installed on the computer with the Application Server).
2) 4. 5. In case of MS SQL, a new user account, under which the FlexiCapture 10 Web Services pool of the Application Server web-service is running, is added to the database server (by default the pool of the Application Server is started under the user account Network Service). 3) db_owner rights to the FlexiCapture database created in step 1 are assigned to the new user account created in step 2 (if MS SQL is used).
• Open a sample project (sample projects are located at %public%\ABBYY\FlexiCapture\10\Samples for Microsoft Windows Vista and later versions or %allusersprofile%\Application Data\ABBYY\FlexiCapture\10\Samples for other version of Microsoft Windows). • Open your own project created in an earlier version of ABBYY FlexiCapture. Create a new project and import a batch created in FormReader 6.5 DE or EE.
Note: If the Reset Password button is missing, it means that the user password has already been changed to a default password password. Self-registration of users through the web interface This method of adding users applies when a large number of users are remote operators (e.g. working through a web-based interface) and do not belong to the domain where the Application Server is installed. To use this method, the Authentication Module feature must be installed.
Request for assigning roles and granting access rights are processed by the administrator on the Permissions -> Requests page of the Administration and Monitoring Console. To process the request, the administrator must click on the Go to user permissions link, assign necessary roles and grant access rights to the user, then return to the Permissions -> Requests page and click Complete.
The administrator can assign roles to the user (scanning operator, verification operator, etc.) and grant access rights to projects and individual batch types within the assigned role. The roles of Administrator, Processing Server and Monitoring Operator are assigned for all projects at once. The role of the Processing Server should be assigned only to the user under whose account the Processing Server is running (see. Configuring the Processing Server).
ing Console. If the service of the Processing Server is started under a different user, it is necessary to assign the role to this user. 2. Start the Processing Server Monitor (StartÆABBYY FlexiCapture 10 ServersÆProcessing Server) for further configuration. 3. In the Processing Server Monitor, select the menu item ActionsÆProperties and in the dialog box that opens, specify the address of the Application Server (e.g, http://ApplicationServer).
7. If necessary, in the Project Setup Station, specify processing settings for the project (specified settings will apply to batches of the Default type). To configure processing settings, choose the menu item ProjectÆProject Properties… and open the Workflow tab. If the project contains batch types, specify workflow settings for each of them. For this, choose the menu item ProjectÆBatch Types…, then select a desired type, click Edit… and in the dialog box that opens go to the Workflow tab.
- Make sure that the World Wide Web Publishing service is running in 32-bit mode: 2. In Oracle DBMS create a user, e.g. FCUSER, and assign the CONNECT and DBA roles to this user. One FlexiCapture database corresponds to one user. If several FlexiCapture databases running under Oracle DBMS are required, create a user for each database. Note: If, for security reasons, you do not want to have a user with the DBA role, then after creating the database you can revoke the DBA role from the user.
Web-stations settings Web-stations are installed together with the Application Server, if Web-stations feature is selected in the Custom Setup dialog box. Description of possible Web-stations settings For each web-station located at \, there is a web.
2. In the console that opens, choose File->Add/Remove Snap-in. in the window that opens, click Add and from the list of available modules choose Certificates. Click Add. 3. In the window that opens, choose “Computer account” and click Next. In the next window, choose Local Computer and click Finish. Add the certificate to the Personal folder. On Windows XP, you can obtain a certificate in the following ways: 4. • Import an existing certificate from file.
After you choose a certificate, you can enable the option which allows only https connections to the Internet for a selected site or for Default Web Site. For this: 1. Open the Security tab of the site properties. 2. In the Secure Communications section click Edit. 3. In the window that opens select the option “Require secure channel (SSL)”. © 2011 ABBYY. All rights reserved.
Connecting certificate in IIS on Windows 7 In IIS settings, connect HTTPS protocol for Default Web Site. For this: 1. Run IIS Manager Console from the Control Panel. 2. Choose Default Web Site and on the Actions panel, click the Bindings link. 3. 4. In the dialog box that opens click Add and select “https” protocol from the “Type” drop-down list. From the “SSL Certificate” drop-down list, select a desired certificate and click Ok. 5.
This requires in the following cases: 1) When specifying address of the Application Server on the Processing Server. To specify the address, do the following: - start the Processing Server Monitor; - in the Processing Server local menu, select the «Change Application Server» item; - in the dialog that opens, specify the address: https://.
To get a relatively accurate estimate of the file storage size, you can upload 10 typical images to FlexiCapture and view the size of a file storage folder, in which the batch (\\project_\0000-0999\) is stored. Estimates for the file storage obtained during testing are as follows: for 1 image, 3-6 times more space in the file storage than the image size is needed.
For FlexiCapture 10 Web Services, the Application Server pool, it is necessary to specify Recycling settings, that is to enable cleanup of the pool when it reaches a certain threshold of consumed memory. The threshold is determined based on the amount of available memory in the system: when IIS consumes maximum memory, there must remain enough memory for normal functioning of the operating system and other applications that can be installed on the same computer.
Configuring FlexiCapture input and output Frequently, the bottleneck that limits performance of the system is the input (import) or the output (export). Below are the two ways to increase performance in bottlenecks of FlexiCapture: 1. If it is assumed that a large number of Processing Stations will simultaneously import files from a hot folder or export files to file system, then the hot folder and/or the export target must be located on the computer with the server edition of the operating system.
3. Check the state of the PerformanceCounting parameter with the “view” command. 4. Quit the Processing Server Manager console using the “quit” command. Note: To view help on the Processing Server Manager console, use the “help” command. . Description of counters: 1. ASCT Count – Application Server Communication Threads count. The number of running threads used for interaction with the Application Server. By default, takes values from 1 to 3. Each thread opens its session.
7. Pending Tasks – the number of tasks taken into processing by the Processing Server, but not yet assigned to a Processing Station. Such tasks are displayed in the Processing Server Monitor in a Pending state. Note that this number is not the number of tasks queued in the Processing Server. This number may be proportional to the total number of cores in the system, but it should not be increased indefinitely. Admissible value: up to 2 tasks per 1 core. 8.
Identify processes that occupy more than 80% of CPU time. If the length of the queue is more than 2 threads, the bottleneck in operation of the system is probably caused by this process. 1. System: % Processor Time: _Total – time (in percentage of the whole working time) during which all processors were busy. For one processor, it is equal to the counter Processor: % Processor Time. For multiple processors, an average counter value is used.
it means that SQL Server has enough memory. However, if the value of this counter is smaller, it means that more available memory is needed to optimize performance of SQL Server. © 2011 ABBYY. All rights reserved.
Logging Administration and Monitoring Console logs The event and error logs available in the Administration and Monitoring Console are the main logs that register errors that occur in the system in general. These logs record all errors that occur during document processing and affecting the processing and all events that occur during document processing. To view the logs, select MonitoringÆEvent Log and MonitoringÆError Log in the Administration and Monitoring Console.
Working with Clusters ABBYY FlexiCapture 10 supports clusters. There are two important benefits of using clusters: • Fault tolerance: in case of failure of one of the servers, the request will be executed by another server. • Distributed workloads: query processing is distributed among cluster nodes. This improves performance and increases fault tolerance.
Basic Configuration of the Failover Cluster In this example, the processing server is deployed on a FOC cluster (FOC.cluster2008r2.ru). The cluster uses a network with the address 192.168.0.0/24 and the domain cluster2008r2.ru. The cluster consists of two nodes: Node1 and Node2. Addressing in the Cluster The Node1 and Node2 nodes have two network interfaces: one interface belongs to the 192.168.0.0/24 network, the other may belong to your local area network (for example 10.0.0.0/16).
Important! These user accounts will only be used for working with ABBYY FlexiCapture in a failover cluster to ensure correct usage of shared network resources. Important! Clustering requires the use of domain accounts. It is not possible to work under a local user account. Adding the ABBYY FlexiCapture 10 Service to the Cluster Install ABBYY FlexiCapture on Node1 and Node2, then create a network folder for the FlexiCapture service. Creating the Service Complete the following steps to create the service: 1.
3. Choose ABBYY FlexiCapture 10 Processing Server from the list of available services and click Next. 4. Enter the name of the service (FC10ProcServer in this example) to be used by clients and choose an address (192.168.0.2 in this example). Click Next. © 2011 ABBYY. All rights reserved.
5. Choose the shared drive you created for centralized storage and click Next. 6. Specify the registry key: • HKEY_LOCAL_MACHINE\SOFTWARE\ABBYY\FlexiCapture\10 – for x32 systems © 2011 ABBYY. All rights reserved.
• HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ABBYY\FlexiCapture\10 – for x64 systems (see the screenshot below) 7. Click Next to confirm the settings. 8. To complete the creation of the service in the cluster, click Finish. © 2011 ABBYY. All rights reserved.
Creating a Shared Folder for the Processing Server Service 1. The cluster nodes Node 1 and Node 2 need a shared folder where to store their temporary files. To create a shared folder for the nodes, right-click the service you created (in this case FC10ProcServer) and choose Add a Shared Folder. In this example, the shared drive H:\ was used (this drive was earlier created at the Storage computer). In the Location field, enter the name of the folder you want to share, for example H:\Cluster Temp.
2. To edit access permissions, select the Yes, change NTFS permissions option and click the Edit Permissions… button. © 2011 ABBYY. All rights reserved.
3. To add new users, click Add… The Select Users, Computers, Service Accounts, or Groups dialog box will open. Add the two previously created users from the cluster2008r2 domain and click OK. 4. Give full access permissions for the folder \\FC10ProcServer\ClusterTemp to the users node1admin and node2admin. © 2011 ABBYY. All rights reserved.
5. Choose SMB as the protocol over which users will access the folder. © 2011 ABBYY. All rights reserved.
6. In the Description field, provide a description for the folder which will help you with support and maintenance in the future. Click the Advanced… button to edit access permissions for SMB-based access. © 2011 ABBYY. All rights reserved.
7. Click Add… The Permissions for ClusterTemp window will open. Add the two previously created users from the cluster2008r2 domain and click OK. Give the users node1admin and node2admin full access permissions for \\FC10ProcServer\ClusterTemp. © 2011 ABBYY. All rights reserved.
8. If you want to publish the SMB share to a DFS namespace, select the corresponding option and click Next. © 2011 ABBYY. All rights reserved.
9. Check your settings and click Create to create the shared folder. © 2011 ABBYY. All rights reserved.
10. Click Close to complete the creation of the shared folder. © 2011 ABBYY. All rights reserved.
© 2011 ABBYY. All rights reserved.
Setting Up the Cluster Nodes Next you must set up the cluster nodes Node1 and Node2. The instructions below apply to Node1. The other nodes are set up identically. Setting Up the ABBYY FlexiCapture 10 Processing Server Local Service To set up the service, complete the following steps: 1. Enter the following command in the command line (cmd.exe): sc config ABBYY.ProcServer.FlexiCapture.10 binpath= "%systemdrive%\Program Files (x86)\ABBYY FlexiCapture 10 Servers\FlexiBRSvc.exe \service -stationType:server -in
4. Go to the Log On tab. For Node1, change the user NetworkService to node1admin. For Node2, change the user NetworkService to to node2admin. Click OK. © 2011 ABBYY. All rights reserved.
Changing the variable %appdata% The service ABBYY.ProcServer.FlexiCapture.10 creates and stores session data in the location referenced by the variable %appdata%. The users node1admin and node2admin must have the same folder specified for %appdata% in order for the service to switch between cluster nodes. Important! For the user cluster2008r2\node1admin, the variable %appdata% must be changed on Node1. For the user cluster2008r2\node2admin, the variable %appdata% must be changed on Node2.
Setting Up the Licensing Server The Licensing Server service can be added to the cluster identically to the Processing Server service. The same serial number should be activated (the serial number must support at least two activations). The serial number must not change depending on the node provided by the Licensing Server. The stations must be restarted after the service switches between the cluster nodes. The Processing Server stops and automatically starts in 5 minutes.
The choice between the Unicast and Multicast methods depends on your network configuration. A detailed description of the two methods can be found on the Microsoft website. Balancing Workloads in the Cluster, Setting Up Hosts You can set up cluster traffic to be balanced and filtered by ports. ABBYY FlexiCapture 10 requires the TCP protocol for its operation. There are two filtering modes: Single Host and Multiple Host. • Single host This mode provides fault tolerance, but does not allow load balancing.
Technical Support Should you have any questions regarding the installation and use of ABBYY FlexiCapture 10, please contact the ABBYY technical support service or the technical support service of the ABBYY partner from which you obtained the software. For contact details, see the Technical Support section of the ABBYY website at www.abbyy.com. © 2011 ABBYY. All rights reserved.