Quick Start Guide for ABBYY FineReader Engine 12 for Linux

Installation process

To install the FineReader Engine 12 for Linux, run the self-extracting archive file %archive_name%.sh from the command line:

  • You can run the archive file without any parameters. The installation will run in an interactive mode and you will be prompted to enter the necessary information during the installation. You can as well run the archive file with certain options. For more details please refer to the User Guide of the product. The information is contained in the chapter 'Distribution'.
  • The installation of the licensing service and the license activation requires ROOT rights.
  • We recommend to run the installation of the FineReader Engine under the ROOT user.
  • To change the current user to the ROOT, use the command 'su root' (if you have a password of the ROOT) or the command 'sudo su' (the password of the current user is required).
  • You can run the archive file without any parameters. The installation will run in an interactive mode and you will be prompted to enter the necessary information during the installation. You can as well run the archive file with certain options. For more details please refer to the User Guide of the product. The information is contained in the chapter 'Distribution'.
  • The installation of the licensing service and the license activation requires ROOT rights.
  • We recommend to run the installation of the FineReader Engine under the ROOT user.
  • To change the current user to the ROOT, use the command 'su root' (if you have a password of the ROOT) or the command 'sudo su' (the password of the current user is required).
 

In the next step, read and accept the End User License Agreement (EULA):

Follow these instructions:

Continue the installation by entering 'y':
Specify the installation folder for the FineReader Engine 12:
  • If you want to use the default folder, which is /opt/ABBYY/FREngine12, enter 'y'
  • If you want to use a different folder, enter 'n' and specify your own directory.
    In this guide, we are using the default directory.
Specify the installation type:
Specify the activation type:

If you are installing the Trial License (using either the Software license key or the Online license key), select the Local License Server. (The Remote License Server is used only for a network license).
Set license parameters:
Enter the Project ID:
  • If you are installing the Software license, then enter 'n':
  • If you are installing the Online license, then enter 'y' and set the required parameters (password and path to the activation file):
Choose the option for the licensing service to install:

The option 2) may be useful, if the Licensing Service was already installed on the machine before and you do not need to install it again, just want to run it.

Activation step

A) Software license key

  1. Right after the FineReader Engine 12 installation you will be asked to activate the license:
    1. Enter your serial number:
    2. Select the connection method for the license activation:

      If you have an Internet connection, we recommend to choose ‘Internet’ method. In this case the activation is carried out automatically and takes only a few seconds.
      In the case of activation 'by e-mail', you will need to load the activation file by specifying the path to the activation file received from ABBYY.



      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 it cannot be used for identifying the user.

 

B) Online license key

This license mechanism ensures uninterrupted operation of ABBYY FineReader Engine 12 in the cloud and within virtual environments, including Docker containers, and can be as well used for on-premises installation. This Online license key does not require activation. Please note that a permanent internet connection is necessary for connecting to an ABBYY licensing server (short interruptions possible).

The parameters of the Online license can be reviewed through the License Console.
Important: Verify that you allow connections to *.abbyy.com on port 443.

How to use the Online license key

License Manager Utility

Managing the licenses is possible through an interactive console interface as well as via the command line. To enter the interactive mode, run activatefre.sh without any parameters and select the Manage licenses option:

Alternativelly, run LicenseManager.Console without any parameters:

In both cases, you will see the console interface for the License Manager utility and can manage the licenses or review the license parameters:

 

Application Development

The ABBYY FineReader Engine 12 for Linux distribution pack contains a set of sample source codes showing how to use the FineReader Engine in common scenarios and illustrating different FineReader Engine technologies. The detailed description of the samples can be found in the Code Samples Library provided with the distribution pack.

Running the Code Samples

All code samples can be found in the Samples folder of the FineReader Engine installation folder. The samples are provided for C++ and/or JAVA:

Before you can run the C++ samples, you need to:

  1. set the environment variable LD_LIBRARY_PATH to the full path to Bin folder of the distribution pack, e.g. 'export LD_LIBRARY_PATH=/opt/ABBYY/FREngine12/Bin'
  2. build the sample, e.g. 'make':
  3. run the built sample:

The build instructions for the JAVA samples you will find in the ReadMe.txt file of the particular code sample.

SDK Usage Scenarios

Before you start the development of your application, please read the Basic Usage Scenarios Implementation chapter in the User Guide of the product, which is located in /opt/ABBYY/FREngine12/Help folder. 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.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.

Recently viewed