Quick Start Guide for FineReader Engine 12 for Linux

This guide explains how to install ABBYY FineReader Engine 12 for Linux, configure and activate a license, manage licenses, and run the SDK code samples. 

Before installing FineReader Engine 12 for Linux, complete the following preparations: 

  • Download the ABBYY FineReader Engine SDK to your computer. 
  • Have your serial number and corresponding Project ID available.

Installing FineReader Engine 12 for Linux

Follow these steps to install FineReader Engine 12 for Linux.

1. Run the installation archive

Type %archive_name%.sh in the command line to run the self-extracting installation archive.

  • You can run the archive without parameters to start the interactive installation. The installer prompts you to enter the required information.

  • You can also run the archive with installation options. For details about the available options, see the Distribution chapter in the FineReader Engine User Guide.

Root Privileges Required

The installation of the Licensing Service and license activation require root privileges. ABBYY recommends running the FineReader Engine installation as the root user.

To switch to the root user, use one of the following commands:

  • su root if you have the root password.
  • sudo su if you have the password for the current user.

2. Accept the End User License Agreement (EULA)

Read the End User License Agreement displayed by the installer.

Type y to accept the agreement and continue the installation.

3. Specify the installation directory

The installer prompts you to select the installation directory. The default installation directory is: /opt/ABBYY/FREngine12

  • Type y to install FineReader Engine 12 in the default directory
  • Type n to specify a different installation directory

This guide uses the default installation directory.

4. Select the installation type

  • Type 1 to select Developer installation
    • Select this option when installing FineReader Engine to develop a new application that uses the engine. See Developer installation (in our User Guide docs) for details.
  • Type 2 to select Runtime installation
    • Select this option when installing an application that uses FineReader Engine. See Runtime installation  (in our User Guide docs) for details.

5. Select the activation type

  • Type 1 to select Local server. 
    • Select this option for a standalone installation where the Licensing Service runs on the same machine as FineReader Engine 12. This applies to installations using either a Software License Key or an Online License Key.
  • Type 2 to select Remote server. 
    • Select this option for a network license where the Licensing Service runs on a different machine.

6. Configure the license parameters

Enter your Project ID when prompted.

Specify whether you are configuring an Online License Key:

  • Type n to select Software License Key
  • Type y to select Online License Key, then provide the required license parameters:
    • Password
    • Path to the activation file fre12_linux_installation_open_license_27.png

7. Select Licensing Service installation option 

Choose how to configure the Licensing Service:
  • Type 1 to install the Licensing Service and start it
  • Type 2 to start the Licensing Service without installing it
  • Type 3 to skip the Licensing Service configuration steps 

Option 2 is useful when the Licensing Service is already installed on the machine and you only need to start it.

Activating a FineReader Engine 12 license

FineReader Engine 12 supports two license types:

Follow the instructions for your license type.

Activating a Software License Key

A Software License Key requires activation after installing FineReader Engine 12.

  1. Type y to start the license activation wizard.
  2. Type your serial number.
  3. Select the connection method for the license activation:
    • Internet
      • ABBYY recommends selecting this option if the computer has an internet connection. License activation is performed automatically and typically takes a few seconds.
    • E-Mail
      • Use this method to receive activation information by email. After receiving the activation file from ABBYY, specify its path in the activation wizard.
    • Load license file
      • Select this option when you already have a license file.
  4. The activation process generates an Installation ID using information about the computer's hardware.

The Installation ID does not contain personal information about the user or the computer. The code cannot be used to identify the user.

Using an Online License Key

An Online License Key does not require license activation.

The Online License Key uses the ABBYY License Service utility to manage FineReader Engine 12 licensing. It supports distributed environments, including cloud computing and virtual environments such as Docker containers. Online licensing can also be used for on-premises installations.

Internet connection requirements

The ABBYY License Service requires a permanent internet connection to communicate with ABBYY services. Short interruptions are tolerated.

Allow connections to the following address and port:

  • Address: *.abbyy.com
  • Port: 443

You can review Online License Key parameters through the LicenseManager.Console utility.

Managing FineReader Engine 12 licenses

Use the License Manager utility to manage licenses and review license parameters.

There are two ways to open the License Manager: an interactive console interface and command-line operation. 

Method 1: Open the License Manager using activatefre.sh

  1. Run activatefre.sh without parameters.
  2. Select Manage licenses.

Method 2: Open the License Manager using LicenseManager.Console

  1. Run LicenseManager.Console without parameters.

Using FineReader Engine 12 code samples

The FineReader Engine 12 for Linux distribution package includes sample source code that demonstrates common usage scenarios and FineReader Engine technologies.

For detailed descriptions of the available samples, refer to the Code Samples Library included in the distribution package.

fre12_linux_code_samples_library.png

Finding the code samples

The code samples are stored in the Samples folder within the FineReader Engine installation directory.

The samples are provided for C++ and/or Java.

fre12_linux_samples_java.png

Running C++ code samples

Before running a C++ code sample, complete the following steps.

1. Set the LD_LIBRARY_PATH environment variable

Set the LD_LIBRARY_PATH environment variable to the full path of the Bin folder in the FineReader Engine installation directory.

For example, when using the default installation directory, run:

export LD_LIBRARY_PATH=/opt/ABBYY/FREngine12/Bin
2. Build the code sample

Navigate to the directory containing the code sample and build it using make.

For example:

cd Classification/
make
3. Run the compiled code sample

Run the compiled sample from its directory.

For example, to run the Classification sample:

./classification

Running Java code samples

To build a Java code sample, follow the instructions in the ReadMe.txt file located in the directory for that specific code sample.

Finding FineReader Engine 12 SDK usage scenarios

The FineReader Engine 12 User Guide includes a Basic Usage Scenarios Implementation chapter that describes common ways to use the SDK.

The User Guide is located in the following installation directory:

/opt/ABBYY/FREngine12/Help

The Basic Usage Scenarios Implementation chapter includes the following scenarios:

Usage scenario Description
Document Conversion Convert documents into an editable format.
Document Archiving Process paper documents for electronic archives.
Book Archiving Process books, magazines, and newspapers for electronic libraries.
Text Extraction Extract text from documents to make it searchable and retrieve useful data.
Field-Level Recognition Recognize small text fragments to capture data from document fields.
Barcode Recognition Read barcodes.
Business Card Recognition Convert business cards into electronic format.
Machine-Readable Zone Capture Extract data from a machine-readable zone and export it into electronic format.
Document Classification Assign documents to user-defined categories using a pretrained database.
Image Preprocessing Prepare images for further processing or improve their visual quality.

Each usage scenario includes a detailed description, implementation advice, and suggestions for optimizing code for specific tasks.

 

Was this article helpful?

11 out of 21 found this helpful

Have more questions? Submit a request