Installing the ABBYY FlexiCapture SDK Library

The first step of distribution of applications using the ABBYY FlexiCapture SDK library is installation of the application and the ABBYY FlexiCapture SDK library on the local disk of the workstation.

After installing your application on a workstation, you should install the ABBYY FlexiCapture SDK library.

Prerequisites

On the workstation, Microsoft® Internet Explorer 5.0 or higher should be installed:

The following registry branches should be accessible from the workstation:

  • "HKEY_CURRENT_USER\Software\ABBYY\SDK\12\FlexiCapture SDK" — full control
  • "HKEY_CURRENT_USER\Software\ABBYY\SDK\12" — full control for installation only
  • "HKEY_LOCAL_MACHINE\Software\ABBYY\SDK\12" — full control for installation only

The following folders should be accessible from the workstation:

  • Folder with ABBYY FlexiCapture SDK binary files — access for reading
  • %TEMP% folder — full control access
  • folder %ProgramData%\ABBYY\FCSDK\12\FlexiCapture SDK – full control access;
  • folder %ProgramData%\ABBYY\FCSDK\12\Licenses – full control access

Important! Never redistribute the files with ABBYY FlexiCapture SDK API description (FCEngine.h, FCEngine_i.c).

Installation

Runtime installation works from command line in silent mode. Run the ABBYY FlexiCapture SDK 12 Runtime (x64).exe file from the installation DVD-ROM with the command line options described below.

Option Default Value Description
INSTALLDIR="<destination path>"

The path to the folder where the ABBYY FlexiCapture SDK library will be installed.

Important! This parameter is required.

DeinstallRuntime=Yes | No No Specifies if the existing runtime installation of the library must be uninstalled.
OFFICECONVERTERS=Yes | No No Specifies if the modules for working with Office document formats should be installed.
PDF=Yes | No Yes Specifies whether the modules for PDF opening should be installed.
WIBUDR=Yes | No No Specifies whether hardware key drivers (CodeMeter) must be installed.
LICENSESRV=Yes | No Yes

Specifies whether Licensing Service must be installed. If WIBUDR=Yes, the Licensing Service is installed automatically and cannot be excluded from the installation. The Licensing Service is installed into the %ProgramFiles(x86)%\Common Files\ABBYY\FCSDK\12\Licensing folder.

Important! Licensing Service is required for working with ABBYY FlexiCapture SDK library, and for correct installation you must do one of the following:

  • If you have a Standalone or an Online license, you should install the Licensing Service on the same computer on which ABBYY FlexiCapture SDK is installed. Set this parameter to Yes.
  • In the case of Network license, you should install the Licensing Service beforehand on a network server — a computer which will manage and distribute licenses among workstations in a network. Set this parameter to No and specify the address of the server in the SERVERNAME parameter during installation on your workstation. If you set this parameter to No and omit the server address, an error will be returned and installation will not be completed.
SERVERNAME=<the DNS name or IP address> The DNS name or IP address of the computer where the Licensing Service is installed.
RegisterCOM=Yes | No | Force Yes

Specifies whether the COM wrappers should be registered. The registration is performed by calling the DllRegisterServer function from FCEngine.dll. If the library is already registered with the different path:

  • if this option is set to Yes, an error is returned;
  • if this option is set to Force, the library is re-registered to the new path and the installation is continued.
/v Indicates the beginning of the list of installation parameters.
/q Silent mode. This is mandatory option because the runtime installation can be performed only in silent mode. Use the /qb option if you want a progress bar to be displayed during the installation. No other dialog boxes will be displayed.

Note: When you use silent mode, the /q option must precede the /v option, for example: "ABBYY FlexiCapture SDK 12 Runtime (x64).exe"  /q /v or "ABBYY FlexiCapture SDK 12 Runtime (x64).exe" /qb /v

For example

"ABBYY FlexiCapture SDK 12 Runtime (x64).exe" /q /v WIBUDR=Yes INSTALLDIR="C:\MyFolder"
    

This command line will install (in silent mode) ABBYY FlexiCapture SDK into the C:\MyFolder folder. The hardware key drivers will be installed.

"ABBYY FlexiCapture SDK 12 Runtime (x64).exe" /qb /v INSTALLDIR="C:\MyFolder"
    

This command line will install (in silent mode) all library modules into the C:\MyFolder folder, a progress bar will be displayed.

"ABBYY FlexiCapture SDK 12 Runtime (x64).exe" /q /v SERVERNAME=MyServer INSTALLDIR="C:\MyFolder" LICENSESRV=No
    

This command line will install all library modules into the C:\MyFolder folder in silent mode. License Service will not be installed and ABBYY FlexiCapture SDK will be configured to use Network Licenses from the server located on the MyServer computer.

See also

Distribution

Modules

Licensing

15.08.2023 13:19:30

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.