Table f Cntents Intrductin... 2 Installing the ABBYY FineReader Engine Library... 3 Wrkstatin Requirements... 3 Installing the Library in Autmatic Mde... 5 Installing the Library in Manual Mde... 6 Activating the ABBYY FineReader Engine Library with the Runtime License... 8 General... 8 Changing the Type f the Prtectin Key... 8 Installing the License Service... 9 Installing in manual mde... 9 Uninstalling in manual mde... 10 Wrking with the LicensingSettings.xml File... 10 Changing the Licensing Service settings... 10 Descriptin f Tags... 11 Installing the Hardware Key Drivers... 13 Syntax... 13 Installatin Lg File Frmat... 13 License Manager Utility... 14 ABBYY SDK 10 License Manager dialg bx... 14 License Parameters... 16 License Activatin... 16 Hw is activatin carried ut?... 17 Activatin methds:... 17 Reactivatin... 17 Deactivatin... 17 License update... 17 Wrking with the License Manager frm the Cmmand Line... 18 Technical Supprt... 19
ABBYY FineReader Engine 10 System Administratr s Guide Intrductin Applicatins which use the ABBYY FineReader Engine 10 library can wrk either lcally n a single cmputer r in a netwrk. Fr crrect peratin f applicatins n a lcal cmputer, yu must have a Standalne Runtime License. If yur applicatins wrk in a netwrk, yu will need a Netwrk Runtime License. The ABBYY FineReader Engine distributin kit includes the License Manager utility which is used fr activatin f the licenses f all types. Distributin f applicatins which use the ABBYY FineReader Engine 10 library includes tw steps: 1. Installing the applicatin and the ABBYY FineReader Engine library n the lcal disk f a wrkstatin; 2. Activating the ABBYY FineReader Engine Library with the Runtime License. 2
ABBYY FineReader Engine 10 System Administratr s Guide Installing the ABBYY FineReader Engine Library The first step f distributin f applicatins using the ABBYY FineReader Engine library is installatin f the applicatin and the ABBYY FineReader Engine library n the lcal disk f the wrkstatin. After installing yur applicatin n a wrkstatin, yu shuld install the ABBYY FineReader Engine library. It may be installed in autmatic r manual mde. Wrkstatin Requirements PC with x86-cmpatible prcessr (1 GHz r higher). Operating system: Windws Server 2008 R2 (64-bit) Windws 7 (32-bit and 64-bit) Windws Server 2008 SP1-SP2 (32-bit and 64-bit) Windws Vista SP1-SP2 (32-bit and 64-bit) Windws Server 2003 SP1-SP2, R2 (32-bit and 64-bit) Windws XP SP1-SP3 (32-bit and 64-bit) Windws 2000 SP4 (32-bit) ABBYY FineReader Engine has been tested in the fllwing virtual envirnments: Memry: Micrsft Virtual PC Micrsft Hyper-V (nly with sftware prtectin key) Oracle VM VirtualBx 3, 4 Parallels Desktp 4 Parallels Virtuzz Cntainers 4 VMware Server 2 VMware Wrkstatin 7 VMware Player 3 fr prcessing ne-page dcuments minimum 400 MB RAM, recmmended 1 GB RAM; fr prcessing multi-page dcuments minimum 1 GB RAM, recmmended 1,5 GB RAM. Hard disk space: 800 MB fr library installatin and 100 MB fr prgram peratin plus additinal 15Mb fr every prcessing page f a multi-page dcument. 100% TWAIN-cmpatible scanner, digital camera, r fax mdem fr scanning nly. Vide card and mnitr (min. reslutin 1024*768 fr pattern training, dictinary editing, scanning with a GUI displayed) Keybard, muse r ther input device The fllwing registry branches shuld be accessible frm the wrkstatin: "HKEY_CURRENT_USER\Sftware\ABBYY\SDK\10\FineReader Engine" full cntrl "HKEY_CURRENT_USER\Sftware\ABBYY\SDK\10" full cntrl fr installatin nly "HKEY_LOCAL_MACHINE\Sftware\ABBYY\SDK\10" full cntrl fr installatin nly The fllwing flders shuld be accessible frm the wrkstatin: Flder with ABBYY FineReader Engine binary files access fr reading %TEMP% flder full cntrl access Fr Windws 2000, Windws XP, Windws Server 2003: flder %ALLUSERSPROFILE%\Applicatin Data\ABBYY\SDK\10\FineReader Engine full cntrl access; flder %ALLUSERSPROFILE%\Applicatin Data\ABBYY\SDK\10\Licenses full cntrl access Fr Windws Vista, Windws Server 2008, Windws 7: The fllwing cmpnents shuld be installed: Micrsft Internet Explrer 5.0 r higher flder %PrgramData%\ABBYY\SDK\10\FineReader Engine full cntrl access; flder %PrgramData%\ABBYY\SDK\10\Licenses full cntrl access 3
ABBYY FineReader Engine 10 System Administratr s Guide If yur applicatin uses pattern training, dictinary editing, scanning with a GUI displayed, Windws Cmmn Cntrls must have versin 5.80 r later and Rich Edit Cntrl must have versin 3.0 r later 4
ABBYY FineReader Engine 10 System Administratr s Guide Installing the Library in Autmatic Mde The runtime installatin f the ABBYY FineReader Engine library in autmatic mde can be perfrmed nly via the cmmand line in silent mde. Run the setup.exe file frm the installatin DVD-ROM with the cmmand line ptins described belw. Optin Default Value Descriptin INSTALLDIR="< destinatin path>" On a 32-bit perating system: %PrgramFiles%\ABBYY SDK\10\FineReader Engine\ On a 64-bit perating system: %PrgramFiles(x86)%\ABBYY SDK\10\FineReader Engine\ The path t the flder where the ABBYY FineReader Engine library will be installed. SN=< serial number> The ABBYY FineReader Engine 10 serial number MODULES=< list f library mdules> Nne All IKEYDR = Yes N LICENSESRV = Yes N SERVERNAME=< the DNS name r IP address> BCPATTERNS=Yes /v /q All N Yes The list f library mdules that yu want t install. See the list f available mdules belw. The mdules must be separated by a cmma (,). Fr example, MODULES=ICR,PDF,BasicLang. If yu d nt want t install any f these mdules, set this ptin t Nne. If yu want t install all the mdules, set this ptin t All. Specifies whether Hardware key drivers must be installed. Specifies whether License Service must be installed. If the IKEYDR = Yes, the License Service is installed autmatically and cannt be excluded frm the installatin. The Licensing Service is installed t the %PrgramFiles%\Cmmn Files\ABBYY\SDK\10\Licensing flder n a 32-bit perating system, and %PrgramFiles(x86)%\Cmmn Files\ABBYY\SDK\10\Licensing flder n a 64-bit perating system. Imprtant! If yu have a Standalne license, yu shuld install the License Service n the same cmputer n which ABBYY FineReader Engine is installed. In the case f Netwrk license, yu shuld install the License Service n a netwrk server a cmputer which will manage and distribute licenses amng wrkstatins in a netwrk. The DNS name r IP address f the cmputer where the License Service is installed. Selects bytecde patterns fr installatin. If this ptin is nt used, standard patterns are installed. Indicates the beginning f the list f installatin parameters. Silent mde. Use the /qb ptin if yu want a prgress bar t be displayed during the installatin. N ther dialg bxes will be displayed. 5
ABBYY FineReader Engine 10 System Administratr s Guide Library mdules Each library mdule determines the license mdules which must be available in a Runtime License, and resurce files which will be installed. The license mdules and resurce files crrespnding t each library mdule are listed in the table belw: Library mdule The license mdules which must be available in a Runtime License The resurce files which will be installed ICR Index, ICR, OMR The files which are marked in the ABBYY FineReader Engine Distributin Kit as required fr recgnitin checkmarks and handprinted text. PDF PDF Opening The files which are listed in the ABBYY FineReader Engine Distributin Kit: PDF sectin. VC Scanning, User Patterns The files fr scanning and user patterns training. Training BasicLang Natural The files fr basic predefined languages, except the nes defined in special grups. DataCaptureLang Natural fr Data Capture The files fr predefined languages fr special language units. Arabic Arabic The files fr recgnitin f texts in Arabic language. Chinese Chinese The files fr recgnitin f texts in Chinese language. Japanese Japanese The files fr recgnitin f texts in Japanese language. Krean Krean The files fr recgnitin f texts in Krean language. FRXIX FineReader XIX The files fr recgnitin f texts in Old Eurpean languages. Hebrew Hebrew The files fr recgnitin f texts in Hebrew language. Thai Thai The files fr recgnitin f texts in Thai language. Vietnamese Vietnamese The files fr recgnitin f texts in Vietnamese language. Nte: When yu use silent mde, the /q ptin must precede the /v ptin, fr example: setup.exe /q /v Fr example setup.exe /q /v MODULES=PDF,ICR IKEYDR = Yes SN=XXXX-XXXX-XXXX-XXXX-XXXX This cmmand line will install (in silent mde) the PDF and ICR library mdules int the default installatin flder using the serial number XXXX-XXXX-XXXX-XXXX-XXXX f the Standalne Runtime License. The hardware key drivers will be installed. setup.exe /qb /v INSTALLDIR="C:\MyFlder" SN=XXXX-XXXX-XXXX-XXXX-XXXX This cmmand line will install (in silent mde) all library mdules int the C:\MyFlder flder using the serial number XXXX-XXXX-XXXX-XXXX-XXXX f the Standalne Runtime License, a prgress bar will be displayed. setup.exe /q /v SERVERNAME=MyServer LICENSESRV=N This cmmand line will install all library mdules int the default installatin flder in silent mde. License Service will nt be installed and ABBYY FineReadre Engine will be cnfigured t use Netwrk Licenses frm the server lcated n the MyServer cmputer. Installing the Library in Manual Mde T install the ABBYY FineReader Engine library in manual mde, please cpy the fllwing files: Files marked as "mandatry" in the table f the ABBYY FineReader Engine Distributin Kit sectin. They are system mdules and main recgnitin databases. Recgnitin databases fr handprinted text, if yu want t recgnize handprinted text. Resurce files fr interface languages that will be used in yur applicatin. 6
ABBYY FineReader Engine 10 System Administratr s Guide Dictinary supprt files fr recgnitin languages that yur applicatin will supprt. If the recgnitin languages include languages with the Latin alphabet, make sure that yu cpy the Univers.amd and Univers.amm files. Scanning mdules, scanning-specific resurces and Twain mdules if yur applicatin will perfrm scanning via the ABBYY FineReader Engine interface. Visual Cmpnents mdules and crrespnding specific resurces, if yur applicatin uses ABBYY FineReader Engine Visual Cmpnents. Register VisualCmpnentsX.dll using regsvr32.exe. Create the flder: %ALLUSERSPROFILE%\Applicatin Data\ABBYY\SDK\10\Licenses fr Windws 2000, Windws XP, Windws Server 2003; %PrgramData%\ABBYY\SDK\10\Licenses fr Windws Vista, Windws Server 2008, Windws 7. Imprtant! Never redistribute ABBYY FineReader Engine type library and files with API descriptin (FREngine.tlb, FREngine.h, FREngine_i.c). After yu have cpied all necessary ABBYY FineReader Engine library files, yu need t activate the library. 7
ABBYY FineReader Engine 10 System Administratr s Guide Activating the ABBYY FineReader Engine Library with the Runtime License General The secnd step f distributin f applicatins using the ABBYY FineReader Engine library is activatin f the library with the Runtime License. This license grants develpers the right t distribute ABBYY FineReader Engine functins inside develper s applicatins. Runtime Licenses can be used either lcally n a single cmputer r in a netwrk. Cnsequently, each ABBYY FineReader Engine license can have ne f the fllwing types: Standalne fr lcal wrk n a single cmputer; Netwrk licenses will be lcated n the server and passed dwn t wrkstatins thrugh the netwrk. Bth Standalne and Netwrk licenses supprt tw types f prtectin keys: Hardware prtectin key This is a USB dngle that cntains the license parameters. Sftware prtectin key This is an activatin file that shuld be btained frm the ABBYY server during a license activatin prcess. If yu use a Standalne Runtime License, activatin is perfrmed n the wrkstatin where the ABBYY FineReader Engine library is installed. If yu use a Netwrk Runtime License, yu shuld activate ABBYY FineReader Engine n a netwrk server a cmputer which will manage and distribute licenses amng wrkstatins in a netwrk. Yu will need t use ne f the variants described in the table belw. The selectin depends n the type f yur prtectin key and the mde f the ABBYY FineReader Engine library installatin. Prtectin Key sftware Mde f Library Installatin Autmatic 1. Run the License Manager utility. 2. Activate a license. Manual 1. 2. Install the License Service. Run the License Manager utility and activate a license. hardware License activatin is nt required. Cnnect the hardware prtectin key t the USB prt f the cmputer. Yu can view license prperties with the License Manager utility. 1. 2. 3. 4. In the case f a 32-bit system cpy the ikeydrvr.exe file int the..\usb Drivers subflder f yur applicatin rt flder, in the case f a 64-bit system cpy the ikeydrvr64.exe file int the..\usb Drivers\64 subflder. Install the Hardware Key driver (see Installing Hardware Key Drivers fr details). Install the License Service. License activatin is nt required. Cnnect the hardware prtectin key t the USB prt f the cmputer. Yu can view license prperties with the License Manager utility. Changing the Type f the Prtectin Key If yu changed a sftware prtectin key t a hardware prtectin key, yu must install the USB key driver frm the ABBYY FineReader Engine 10 installatin DVD-ROM (ABBYY FineReader Engine 10\USB Drivers\Ikeydrvr.exe in the case f a 32-bit system, r ABBYY FineReader Engine 10\USB Drivers\64\Ikeydrvr64.exe in the case f a 64-bit system) n the cmputer n which the License Service is installed. 8
ABBYY FineReader Engine 10 System Administratr s Guide Installing the License Service Fr crrect peratin f applicatins using the ABBYY FineReader Engine 10 library, the License Service (LicensingService.exe) is required. The License Service is installed autmatically during the Develper and Runtime installatin in autmatic mde. If yu use manual installatin, fllw the instructins belw. After the installatin f the License Service is cmplete, run the License Manager t manage licenses. The Licensing Service settings are prvided in the LicensingSettings.xml file. This file is generated autmatically during autmatic installatin. When installing manually, yu must specify the crrect settings in this file. The XML scheme f the settings is lcated in the LicensingSettings.xsd file. Yu can find this file in the Bin flder f the ABBYY FineReader Engine distributin package. The detailed descriptin f the settings is prvided in the Wrking with the LicensingSettings.xml File sectin. Nte: Use ABBYY FineReader Engine and License Service frm the same package. Otherwise, cmpatibility is nt guaranteed. Installing in manual mde Imprtant! Administratr access rights are necessary fr the installatin. Fr Standalne installatin: 1. Cpy the files fr the Licensing Service and the License Manager utility n the wrkstatin: AbbyyZlib.dll, FineNet.dll, FineObj.dll, FObjEventSrc.dll, msvcr90.dll, Prtectin.dll, LicensingSchema.dll, PrductLicensingSchema.dll, LicensingService.exe, LicenseManager.exe, LicensingSettings.xml, and the Micrsft.VC90.CRT flder. Cpy the resurce files PrtectinRes*.dll fr the languages yu need and PrtectinResShared.dll. See the ABBYY FineReader Engine Distributin Kit sectin in the Develper s Help fr details. Nte. Yu may nt cpy the LicensingSettings.xml file if yu d nt use hardware prtectin and need nt specify any additinal parameters. 2. Create the flder: %ALLUSERSPROFILE%\Applicatin Data\ABBYY\SDK\10\Licenses fr Windws 2000, Windws XP, Windws Server 2003; %PrgramData%\ABBYY\SDK\10\Licenses fr Windws Vista, Windws Server 2008, Windws 7. Everyne must have read and write permissins t this flder. 3. If necessary, specify parameters f the LcalLicenseServer in the LicensingSettings.xml file. 4. Run LicensingService.exe with the "/install" parameter: LicensingService.exe /install. Fr Netwrk installatin: Server Requirements PC with x86-cmpatible prcessr (1 GHz r higher). Operating system: Windws Server 2008 R2 (64-bit) Windws 7 (32-bit and 64-bit) Windws Server 2008 SP1-SP2 (32-bit and 64-bit) Windws Vista SP1-SP2 (32-bit and 64-bit) Windws Server 2003 SP1-SP2, R2 (32-bit and 64-bit) Windws XP SP1-SP3 (32-bit and 64-bit) Windws 2000 SP4 (32-bit) ABBYY SDK 10 License Server has been tested in the fllwing virtual envirnments: Micrsft Virtual PC Micrsft Hyper-V (nly with sftware prtectin key) Oracle VM VirtualBx 3, 4 Parallels Desktp 4 Parallels Virtuzz Cntainers 4 VMware Server 2 9
ABBYY FineReader Engine 10 System Administratr s Guide VMware Wrkstatin 7 VMware Player 3 25 MB f free hard-disk space Fr Windws 2000, Windws XP, Windws Server 2003: flder %ALLUSERSPROFILE%\Applicatin Data\ABBYY\SDK\10\Licenses full cntrl access Fr Windws Vista, Windws Server 2008, Windws 7: flder %PrgramData%\ABBYY\SDK\10\Licenses full cntrl access Fllw the instructins: 1. 2. 3. 4. 5. Cpy the files fr the Licensing Service and the License Manager utility n the cmputer which will be used as a license server: AbbyyZlib.dll, FineNet.dll, FineObj.dll, FObjEventSrc.dll, msvcr90.dll, Prtectin.dll, LicensingSchema.dll, PrductLicensingSchema.dll, LicensingService.exe, LicenseManager.exe, LicensingSettings.xml, and the Micrsft.VC90.CRT flder. Cpy the resurce files PrtectinRes*.dll fr the languages yu need and PrtectinResShared.dll. See the ABBYY FineReader Engine Distributin Kit in the Develper s Help fr details. Create the flder: %ALLUSERSPROFILE%\Applicatin Data\ABBYY\SDK\10\Licenses fr Windws 2000, Windws XP, Windws Server 2003; %PrgramData%\ABBYY\SDK\10\Licenses fr Windws Vista, Windws Server 2008, Windws 7. Everyne must have read and write permissins t this flder. In the LicensingSettings.xml file specify: the PrtclType attribute f the CnnectinPrtcl element f the LcalLicenseServer tag; the ServerAddress and PrtclType attributes f the MainNetwrkLicenseServer tag. Cpy the LicensingSettings.xml file with the specified settings int the Bin flder f the FineReader Engine library installatin n all the wrkstatins. Run LicensingService.exe with the "/install" parameter: LicensingService.exe /install. Uninstalling in manual mde T uninstall the Licensing Service in manual mde, run LicensingService.exe with the "/uninstall" parameter: LicensingService.exe /uninstall. Then remve the directry with the Licensing Service files. Wrking with the LicensingSettings.xml File The LicensingSettings.xml file cntains the ABBYY FineReader Engine prtectin settings. This file is necessary fr crrect wrk f the Licensing Service in the netwrk. When Licensing Service is used n a lcal cmputer, this file is required if yu use a Hardware prtectin key. The file is generated autmatically during the library installatin in autmatic mde. When installing manually, yu must specify the crrect settings in this file. The XML scheme f the settings is lcated in the LicensingSettings.xsd file. Yu can find bth these files in the Bin flder f the ABBYY FineReader Engine distributin package. Changing the Licensing Service settings The Licensing Service settings include tw main parts: the settings f the Licensing Service installed n the current cmputer, which are specified in the <LcalLicenseServer> tag, and the parameters f cnnectin with the netwrk server, where the Licensing Service is installed. These parameters are specified in the <LicensingServers>\<MainNetwrkLicenseServer> tag. If ABBYY FineReader Engine is installed n a lcal cmputer, yu shuld specify the settings nly in the <LcalLicenseServer>, if necessary. While if ABBYY FineReader Engine wrks in a netwrk, <LcalLicenseServer> parameters are specified n the server, and <LicensingServers>\<MainNetwrkLicenseServer> parameters n wrkstatins. If a cmputer is used bth as a server and as a wrkstatin, bth <LcalLicenseServer> and <LicensingServers>\<MainNetwrkLicenseServer> parameters shuld be specified. See fr details the descriptins f tags belw. T change TCP/IP prt: 10
ABBYY FineReader Engine 10 System Administratr s Guide The Licensing Service uses 3000 TCP/IP prt by default. If this prt is clsed n the cmputer where the Licensing Service is installed, the Licensing Service will nt wrk. In this case, specify an pen prt in EndPintName attribute f <LcalLicenseServer> r <LicensingServers>\<MainNetwrkLicenseServer> tag, fr example: <LcalLicenseServer> <CnnectinPrtcl PrtclType="TCP/IP" EndPintName="1025"/> </LcalLicenseServer> r <LicensingServers> <MainNetwrkLicenseServer ServerAddress="cmputername" PrtclType="TCP/IP" EndPintName="1025"/> </LicensingServers> T disable hardware prtectin keys: The Licensing Service enables using bth hardware and sftware prtectin keys by default. If yu d nt use hardware prtectin keys, yu can disable them. Set the Enable attribute f <LcalLicenseServer>\<EnableIKeyLicenses> tag t "n": <LcalLicenseServer> <CnnectinPrtcl PrtclType="<Prtcl type>" /> <EnableIKeyLicenses Enable="n" /> </LcalLicenseServer> Descriptin f Tags Tag Type Multiplicity Parent Tag Descriptin LicensingSettings LicensingSettings. Elements: LcalLicenseServer LicensingServers 1 n Prtectin settings. LcalLicenseServer LcalLicenseServerSettings. Elements: Cmplex Type. Attributes: CnnectinPrtcl EnableIKeyLicenses 0...1 LicensingSettings The parameters f the Licensing Service lcated n the same cmputer. CnnectinPrtcl PrtclType the prtcl type: LcalInterprcessCmmunicati n, NamedPipes, r TCP/IP. Nte: This is an additinal prtcl type fr the lcal Licensing Service. It is nt necessary t specify this prtcl type fr Standalne installatin, as Standalne licenses are always used with the LcalInterprcessCmmunicati n prtcl type. EndPintName (ptinal) TCP/IP prt. By default, "3000". 0...1 LcalLicenseServer The parameters f the cnnectin prtcl. EnableIKeyLicenses Cmplex Type. 0...1 LcalLicenseServer Specifies 11
ABBYY FineReader Engine 10 System Administratr s Guide Attributes: Enable specifies whether Hardware prtectin keys can be used n the cmputer (set it t "yes" r "n"). By default, "yes". whether Hardware prtectin keys can be used n the cmputer. LicensingServers Cmplex Type. Elements: MainNetwrkLicenseServer 0...1 LicensingSettings The list f netwrk servers where the Licensing Service is installed. MainNetwrkLicenseServer NetwrkServerAddress. Attributes: ServerAddress the DNS name r IP address f the cmputer where the Licensing Service is installed. PrtclType the prtcl type: LcalInterprcessCmmunicati n, NamedPipes, r TCP/IP. EndPintName (ptinal) TCP/IP prt. By default, "3000". 1 LicensingServers The parameters f the cnnectin with the main netwrk server where the Licensing Service is installed. Samples The sample belw shws a simple LisensingSettings.xml file fr a standalne installatin. Lcal inter-prcess cmmunicatin is used. Hardware prtectin keys are disabled. <?xml versin="1.0" encding="utf-8"?> <LicensingSettings xmlns="http://www.abbyy.cm/prtectin/licensingsettings"> <LcalLicenseServer> <CnnectinPrtcl PrtclType="LcalInterprcessCmmunicatin" /> <EnableIKeyLicenses Enable="n" /> </LcalLicenseServer> </LicensingSettings> The samples belw shw simple LisensingSettings.xml files fr a netwrk installatin: a file fr wrkstatins and a file fr a server. Licensing Service is lcated n the cmputer with the name "cmputername". The TCP/IP prtcl is used fr cmmunicatin between the server and wrkstatins. Fr a wrkstatin: <?xml versin="1.0" encding="utf-8"?> <LicensingSettings xmlns="http://www.abbyy.cm/prtectin/licensingsettings"> <LicensingServers> <MainNetwrkLicenseServer ServerAddress="cmputername" PrtclType="TCP/IP" /> </LicensingServers> </LicensingSettings> Fr a server: <?xml versin="1.0" encding="utf-8"?> <LicensingSettings xmlns="http://www.abbyy.cm/prtectin/licensingsettings"> <LcalLicenseServer> <CnnectinPrtcl PrtclType="TCP/IP" /> </LcalLicenseServer> </LicensingSettings> 12
ABBYY FineReader Engine 10 System Administratr s Guide Installing the Hardware Key Drivers The Hardware Key drivers must be installed befre the USB key itself is plugged t the cmputer. Imprtant! Yu must instruct yur custmers t clse any ikey-dependent applicatins befre running yur installatin prgram. If any f the ikey cmpnents are already n their cmputer and in use when the ikey installer is run, an incmplete ikey installatin may result. Yu shuld call the Ikeydrvr.exe (ikeydrvr64.exe in the case f a 64-bit system) installer prgram frm yur wn installatin prgram. The Ikeydrvr.exe is lcated in the \USB Drivers flder f yur ABBYY FineReader Engine installatin, the ikeydrvr64.exe in the \USB Drivers\64 flder. Syntax Silent installatin: ikeydrvr.exe /s ikeydrvr64.exe /S /V" /q" Lg path: ikeydrvr.exe LOGPATH=<PATH TO FOLDER NAME> LgFile=<LOGFILE NAME> ikeydrvr64.exe /v" /L* <LOGPATH>" Fr ikeydrvr64.exe <LOGPATH> refers t the name f the text file in which lgs t be stred. See Installatin Lg File Frmat fr infrmatin abut the frmat f the lg file. Uninstall: ikeydrvr.exe uninst ikeydrvr64.exe /x Installatin Lg File Frmat The lg file cntains the results and actins f the driver installatin. It allws yu t capture infrmatin abut the ikey driver installatin if the installer is running in silent r quiet mde. Status cdes can nly be retrieved if the [LOGPATH] ptin is specified. Status cdes define the status f the installatin warnings and errr messages are lgged using status cdes. Status Cde 0 The peratin cmpleted successfully. Descriptin 1 The peratin cmpleted successfully. Changes will nt be in effect until yu restart yur system 2 The peratin cmpleted successfully. A system restart is required t enable Smart Card Services. 3 The peratin cmpleted successfully. A pwer dwn f the system is required. 100 Warning: The ikey Device Driver has been installed with Smart Card Services disabled. 101 Warning: The ikey Device Driver has been installed with Smart Card Services disabled. A system restart is required t cmplete the installatin. 102 Warning: The maximum number f readers supprted by this platfrm has been exceeded. The ikey Device Driver has been installed with Smart Card Services disabled. 103 Warning: The maximum number f readers supprted by this platfrm has been exceeded. The ikey Device Driver has been installed with Smart Card Services disabled. A system restart is required t cmplete the installatin. 200 Errr: Administratin privileges are required t install this prduct. 201 Errr: This system des nt supprt USB devices. 202 Errr: The versin f this perating system is nt supprted. 203 Errr: Installatin canceled. 204 Errr: Invalid cmmand line ptin. 205 Errr: Anther vendrs NT 4.0 USB stack exists. The user must uninstall this USB stack befre installing this prduct. 13
ABBYY FineReader Engine 10 System Administratr s Guide 206 Errr: One r mre services are marked fr deletin. A system restart is required prir t installing this prgram. -1 Errr: Installatin failed. (General errr.) Actin cdes can nly be retrieved if the [LOGPATH] ptin is specified. Actin cdes define the actins yu, the develper, must take after the ikey Installers have finished. Actin Cde 0 N actin required. Descriptin 1 Insert a tken t cmplete the installatin. Windws Device Ntificatin events CANNOT be used t wait fr tken insertin. 2 Insert a tken t cmplete the installatin. Windws Device Ntificatin events CAN be used t wait fr tken insertin. 3 Re-insert the tken t cmplete the installatin. Windws Device Ntificatin events CANNOT be used t wait fr tken insertin. 4 Re-insert the tken t cmplete the installatin. Windws Device Ntificatin events CAN be used t wait fr tken insertin. 5 Must remve all tkens t install r uninstall the prduct. License Manager Utility The License Manager utility (LicenseManager.exe) allws yu t manage ABBYY FineReader Engine licenses f all types. In the ABBYY SDK 10 License Manager dialg bx yu can activate, deactivate, r update license and view the prperties f an activated license. The License Manager utility is installed autmatically during a Develper installatin r during a Runtime ABBYY FineReader Engine library installatin in autmatic mde tgether with the License Service. This utility is accessible thrugh Start > Prgrams > ABBYY FineReader Engine 10 > License Manager r in the Bin flder. This utility is distributed alng with ther ABBYY FineReader Engine 10 files allwed fr distributin and is used fr Runtime Licenses activatin. ABBYY SDK 10 License Manager dialg bx The fllwing infrmatin abut yur ABBYY FineReader Engine 10 license is available in the ABBYY SDK 10 License Manager dialg bx: Clumn Descriptin Serial number The ABBYY FineReader Engine 10 serial number. Nte: The square t the right f the serial number shws whether the license is currently in use: The license is nt in use nw, all available CPU cres are free. The license can be used fr 14
ABBYY FineReader Engine 10 System Administratr s Guide Functinality subset prcessing. The license is in use, but there are sme free CPU cres. Sme recgnitin prcesses can be run with this license. The license is in use, all available CPU cres are busy. N mre recgnitin prcesses can be run with this license. Yu can view the detailed statistics f license usage in the menu Service > License Use Statistic. The functinality subset f the license. The prtectin type: Prtectin type Sftware (File) sftware prtectin key; Hardware (ikey) hardware prtectin key. Installatin type The installatin type: Standalne the license is used n a lcal cmputer; Netwrk the license is lcated n a netwrk cmputer. Expiratin date The expiratin date. Mre details abut the license yu can find in the License Parameters table. T shw r hide license parameters, use the License Parameters/Hide License Parameters buttn. Activating, updating, r deactivating the license T activate, update, r deactivate the license, press the crrespnding buttn, r select the crrespnding item in the menu, and fllw the instructins in the dialg bx that pens. See details abut license activatin, deactivatin and update in the License Activatin sectin. Buttns License Parameters/Hide Parameters Shws r hides license prperties. Activate license... Starts the License Activatin Wizard fr ABBYY FineReader Engine 10. Update license... Starts the License Update Wizard fr ABBYY FineReader Engine 10. Refresh Updates the license list. Clse Clses the License Manager. Menu items Item Descriptin License Activate... Starts the License Activatin Wizard. Update... Deactivate... Cpy Serial Number Clse Starts the License Update Wizard fr the selected license. Starts the License Deactivatin Wizard fr the selected license. Cpies the selected license. Clses the License Manager. Service License Use Shws the statistics f license usage n the wrkstatins. Available nly fr the 15
ABBYY FineReader Engine 10 System Administratr s Guide Statistic... Refresh Netwrk licenses with the CPU cres limitatin. Updates the license list. Help Help Opens the License Manager Help. License Parameters The license parameters are displayed in the table belw the list f the licenses in the License Manager. T shw r hide license parameters, use the License Parameters/Hide License Parameters buttn in the main windw f the License Manager. The fllwing infrmatin abut yur ABBYY FineReader Engine 10 license is available: Functinality subset f the license Type f prtectin (sftware r hardware prtectin key) ABBYY FineReader Engine 10 serial number Expiratin date fr yur ABBYY FineReader Engine 10 license Perfrmance limitatin: CPU cre limit (the number f CPU Cre which can be used fr recgnitin), minimum number f CPU cres which can be used n a statin, perfrmance limit (e.g. characters per secnd) Envirnment limitatin: usage in a netwrk and n virtual machines List f features that are allwed by yur license (text types, exprt frmats, additinal mdules, etc.) License Activatin A special prtectin technlgy is used t prtect ABBYY FineReader Engine 10 prduct frm illegal cpying and distributin. This technlgy effectively excludes unauthrized use f ABBYY prducts by persns wh have nt signed a License Agreement with the sftware cpyright wner. The prtectin technlgy is implemented in the frm f 16
ABBYY FineReader Engine 10 System Administratr s Guide prtectin keys. A prtectin key binds the prduct license t the particular hardware cnfiguratin f the cmputer r USB key and therefre prevents using ne license n several cmputers at a time. ABBYY FineReader Engine must be activated befre use. If yu have a Standalne license, yu shuld activate ABBYY FineReader Engine n the same cmputer n which ABBYY FineReader Engine is installed. In the case f Netwrk license, yu shuld activate ABBYY FineReader Engine n a netwrk server a cmputer which will manage and distribute licenses amng wrkstatins in a netwrk. Hwever ABBYY FineReader Engine may be installed bth n the netwrk server and n wrkstatins. Hw is activatin carried ut? Activatin takes very little time and is carried ut with the help f an Activatin Wizard. This wizard is built int the License Manager utility. The Activatin Wizard has a friendly interface and is used fr sending the necessary activatin infrmatin t ABBYY. The same wizard is used fr entering Activatin File (*.frelf file) yu receive frm ABBYY during activatin. Activatin infrmatin is sent as a cde (Installatin ID) which is generated n the basis f infrmatin abut the cmputer n which the prgram is being installed. N persnal infrmatin abut the user r cmputer is used fr generating this cde and this cde cannt be used fr identifying the user. Activatin methds: Via the Internet Activatin is carried ut autmatically and takes nly a few secnds. An Internet cnnectin is required fr this type f activatin. By e-mail The user needs t send an e-mail message generated by the prgram and cntaining infrmatin required fr activatin. T ensure a quick reply frm the mail rbt, d nt alter the infrmatin in the message bdy r Subject field. By e-mail frm anther cmputer This methd is suitable, if yur cmputer des nt have an Internet cnnectin. The prgram will generate an e- mail message cntaining infrmatin required fr activatin and ffer yu t cpy the message and send it t ABBYY frm anther cmputer. In the case f activatin via the Internet, the whle prcess is carried ut autmatically. In the case f activatin by e-mail, the user needs t enter the Activatin File received frm ABBYY in the crrespnding fields f the Activatin Wizard. Once the activatin is cmplete, the prgram can be used. Reactivatin ABBYY FineReader Engine 10 can be reinstalled n ne and the same cmputer an unlimited number f times withut reactivatin. Hwever, if yu make majr upgrades, frmat yur hard drive, r reinstall the perating system, an additinal activatin may be required. Deactivatin ABBYY FineReader Engine 10 license can be deactivated. The deactivated license can be then activated n anther cmputer. The number f allwed deactivatins can be restricted by yur license. Deactivatin takes very little time and is carried ut with the help f a Deactivatin Wizard. This wizard is built int the License Manager utility. During the deactivatin the Activatin File (*.frelf file) which yu receive frm ABBYY during activatin is deleted. Any cpy f this file cannt be used fr activatin again. The deactivatin can be perfrmed nly via the Internet. Deactivatin is carried ut autmatically and takes nly a few secnds. An Internet cnnectin is required. Once the deactivatin is cmplete, the license can be activated n anther cmputer. License update If yu have purchased additinal mdules r an additinal amunt f pages fr ABBYY FineReader Engine 10 and yur license des nt allw yu t use them, yu need t update the license. The license update prcess is similar t the activatin prcess. The update prcess is carried ut with the help f the Update Wizard and can be perfrmed via the Internet r by e-mail. Once the update is cmplete, the newest functinality f the prgram can be used. 17
ABBYY FineReader Engine 10 System Administratr s Guide Wrking with the License Manager frm the Cmmand Line The current versin f the License Manager allws yu t activate licenses frm the cmmand line. The fllwing cmmand line parameters are supprted: Parameter /SilentActivatin /SN:<serial number> /SaveActivatinEMailTFile:<file name> /LadActivatinFile:<file name> Actin Use this parameter t activate the license that crrespnds t the serial number specified after /SN. Use this parameter t specify the serial number f the license t be activated. Specify the serial number in ne f the fllwing frmats: XXXX-XXXX-XXXX- XXXX-XXXX-XXXX r XXXXXXXXXXXXXXXXXXXXXXXX. Use this parameter t save t file the text f the message generated by the prgram and cntaining the infrmatin required fr activatin f the number specified in the /SN= parameter. Lads the ABBYY License File and activates the serial number crrespnding t this file. When launched frm the cmmand line, the License Manager may return the fllwing return cdes: Return cde Descriptin -1 N cmmand line parameters were specified. 0 N errrs. 1 Invalid serial number. 2 The serial number has been already activated. 3 Unable t activate the serial number via the Internet. Try t activate it by e-mail. 4 The license with hardware prtectin cannt be activated by e-mail. 5 The specified file has nt been fund r is unavailable. 6 Incrrect license file. 7 Unable t lad the applicatin. 8 Unable t save t file the text f the activatin request. 9 Unknwn cmmand line parameter. 11 Unable t find the USB key t activate the license with hardware prtectin. 12 Several USB keys have been fund. Please, leave nly ne USB key plugged t the cmputer. 13 Unable t cnnect t License Service. 18
ABBYY FineReader Engine 10 System Administratr s Guide Technical Supprt If yu have any questins abut hw t install and use ABBYY FineReader Engine 10 t which yu cannt find answers in this System Administratr's Guide, please cntact the ABBYY technical supprt service r ur partners. Fr cntact infrmatin, please refer t the "Supprt" sectin at www.abbyy.cm r t ABBYY FineReader Engine 10 help. 19