Quick Start Guide for ABBYY FineReader Engine 12

Language:
EN
Product-Line:
FineReader Engine
Version:
12
Type:
Knowledge Base & Support
Category:
General Features
KB-Type:
Tips & How to Information

Before you start: Download ABBYY FineReader Engine SDK on your computer using the link from the initial email.

SDK Installation

1. Run product installation

2. Read and Accept the End-User License Agreement

3. Select the program features you want installed. You have a choice to install files for integrating into 32-bit and/or 64-bit applications.

4. Enter Your Installation Folder

5.For the Trial License you can use either the Standalone or Cloud (New!) licensing mechanism, please, DO NOT specify any License Server details and move forward.

6. Please enter your Customer ProjectID

For non-Cloud type of license , please, enter your Customer Project ID only:

For Cloud license, please, enter your Customer Project ID, a Full path to Cloud Activation Token and a license Password:

7. Finish installation and move to the product activation.

License Activation

  • Regular (non-Cloud type) license
  • Cloud license (New!)

Regular (non-Cloud type) license

Activation is carried out with the help of an Activation Wizard. This wizard is built into the License Manager utility.

Activation information is sent as a code (Installation ID) which is generated on the basis of information about the computer on which the program is being installed. No personal information about the user or computer is used for generating this code and this code cannot be used for identifying the user.

If you have an Internet connection, we recommend to choose ‘Via the Internet’ method. In this case an activation is carried out automatically and takes only a few seconds.

But in case you choose either ‘By e-mail’ or ‘By e-mail from another computer’ (your computer doesn’t have an Internet connection) you need to enter the path to the Activation File received from ABBYY in the corresponding field of the Activation Wizard.

Once the activation is complete, the program can be used.

New: Cloud license

This new license mechanism has to be used for installations on cloud and virtual environments in order to ensure uninterrupted operation of FRE 12. Please note that a permanent internet connection is necessary for connecting to an ABBYY licensing server.

a) License activation is not required. Close License Manager in case it was launched right after the installation

b) Important: Verify that you allow connections to *.abbyy.com on ports 80 and 443

c) How to use Cloud license:

  1. Place an activation token file to a folder on a customer choice. Usually it is a folder where FREngine.dll resides.
  2. Call InitializeEngine function with the following parameters:
    • Customer Project ID;
    • Full path to Cloud ActivationToken;
    • Password to your license;
    • [Optional, may be an empty string] Path to the folder, in which ABBYY FineReader Engine should store user-specific data. By default, it is the FineReader Engine data folder (%ProgramData%\ABBYY\SDK\12\FineReader Engine for automatic installation;
    • [Optional, may be an empty string] Path to the folder for ABBYY FineReader Engine temporary files. By default, it is %TEMP%\ABBYY FineReader Engine 12 folder;
    • [Optional] A Boolean value that specifies whether the CPU cores should be used in shared mode;
    • Output variable for Engine object.

Configuration file will look like (All data will be inserted automatically during an installation):

Sample code in C#:

Application Development

ABBYY FineReader Engine distribution pack contains a set of sample source code showing how to use Engine in different scenarios so you can get started faster. This section contains a short description of these samples. A detailed description of the samples can be found in the Code Samples Library provided with this distribution pack (Start > Programs > ABBYY FineReader Engine 12 > Code Samples Library).

Please note: In case you use the new Cloud license the precompiled samples will not work in most cases. Please check if in the respective sample code the Engine object is created using the GetEngineObject() function and replace this function with GetEngineObjectEx() as it is stated in ‘How to use Cloud license’ above and recompile the sample.

We recommend trying these two samples:

1. Convert a document (Hello) sample shows all the steps you need to perform to make your ABBYY SDK work for you. This sample application recognizes and exports an image file using the basic objects and methods of ABBYY FineReader Engine. It is a great example of a basic code to start development of your application.

This video shows how to run ABBYY FineReader Engine 11. ABBYY FineReader Engine 12 uses the same principle.


2. Engine Predefined Processing Profiles sample shows how you can easily configure ABBYY FineReader Engine with predefined processing profiles. All you need is to select the profile suitable for your task before processing and FineReader Engine will choose the best settings automatically. The sample application processes document images from the specified folder using two different predefined processing profiles so you can compare results.

This video was created for ABBYY FineReader Engine 11. ABBYY FineReader Engine 12 uses the same principle.


NOTE: Most of the samples show the basic method to load the Engine object: Loading FREngine.dll manually using the “naked” interface. There are two more ways to load the Engine object in ABBYY FineReader Engine. Each of the loading methods has its own specifics, affecting the use of the object in different circumstances.

You can find more details about ways to load the Engine Object as well as code samples in SDK Help File: Start > Programs > ABBYY FineReader Engine 11 > Developer’s Help > Guided Tour: Advanced Techniques > Different Ways to Load the Engine.

SDK Usage Scenarios

Before you start with your application development, please read the Basic Usage Scenarios Implementation chapter in the SDK Help File: Start > Programs > ABBYY FineReader Engine 12 > Developer’s Help > Guided Tour. It describes the most common usage scenarios for ABBYY FineReader Engine. Each article contains a detailed description of the scenario, implementation advice, and suggestions on optimizing the code for specific tasks.

Support and Additional Information

Here are some more resources to get you started:

This website uses cookies which enable you to see pages or use other functions of our websites. You can turn off such cookies in your browser’s settings. If you continue to use these pages, you consent to the use of cookies.