How to configure and use ABBYY Engine in Leapwork?

ABBYY Engine is a powerful OCR (optical character recognition) engine that converts any type of  Images and Text into a large variety of digital formats. With LEAPWORK release V2.5.918, users can now choose between Leapwork's proprietary OCR Engine and ABBYY engine for their automation needs. 

NOTE: Leapwork supports ABBYY Engine version 12 only. 

User has to perform the following steps to use ABBYY with Leapwork:

1. Download ABBYY FineReader Engine 12
2. Install ABBYY FineReader Engine 12 (Server & Client)
3. How to use ABBYY engine in leapwork

Download ABBYY FineReader Engine 12

1. For downloading please click here, and then download the ABBYY version - FineReader Engine 12 for Windows.
2. Once you download the SDK, please uninstall any previous versions of ABBYY FineReader Engine 12 before installing this version.
3. To install ABBYY FineReader Engine 12, a Serial Number is required. Please contact your Leapwork account manager to acquire a Serial Number.
4. To activate the functions of ABBYY FineReader Engine 12 on a computer an Activation file is required. Use the License Manager utility to obtain an Activation file by Internet or e-mail.
5. Unzip the downloaded .zip file, click on ABBYY FineReader Engine 12 (64 bit).msi to start the installer.
6. As per your OS configuration, select the version you want to install i.e x86 for 32-bit OS and x64 for 64-bit OS, please make sure you install it in the default location.
7. After installation, you are ready to use ABBYY in Leapwork.

Install ABBYY FineReader Engine 12

There are 2 types of installation with ABBYY

a. Standalone configuration

In this configuration, you install ABBYY FineReader12 on a designated Leapwork environment OR on the Leapwork Controller. Installing ABBYY FineReader12 on the Agent is the default and recommended configuration.

The installation is done using the Command Prompt. Please do the following:

1. Press Windows Key + S, and then type cmd, hit Enter
2. Navigate to the folder in which you have extracted the ABBYY installation files.
3. Type:
   setup.exe /qb /v INSTALLDIR="c:\Program Files\ABBYY SDK\12\FineReader Engine"
4. When the installation is completed 
5. Double-click on the License Manager i.e. LicenseManager.exe from Bin (for the 32-bit operating system) or Bin64 (for the 64-bit operating system) subfolder in C:\Program Files\ABBYY SDK\12\FineReader Engine"  and find the Activate License button 
6. Enter the license key

b. Network License configuration

This configuration allows you to run ABBYY FineReader on any number of Leapwork Environments as defined by you. ABBYY’s Networking License Server (Part of this installation guide) then manages and distributes available license resources to all instances of FineReader running in your network

You need to follow 2 steps:-

Ti) Install Network License Server

Open the “License Server” folder, find and run ABBYY SDK 12 License Server, select TCP/IP in Protocol for communication.

Continue to install on the designated to be ABBYY license server , Open License Manager app and activate the license with network license key purchased.

ii) Install FineReader Engine 12 on the client machine

The installation method is silent. Before you can install, make sure that the ABBYY installation files are available and unpacked on each machine.

Do the following:

1. With Administrator privileges, run a Windows Command prompt (Click on the Windows logo and type “cmd”)
2. Navigate to the directory containing the unpacked ABBYY files
3. Once in the right folder location, run the following command:
   setup.exe /qb /v INSTALLDIR="C:\Program Files\ABBYY SDK\12\FineReader Engine" LICENSESRV="No" SERVERNAME="XXX.XXX.XXX.XXX"
   Replace <IP ADDRESS OF YOUR NLS> with the actual IP address of the machine where you have installed the NLS.
4. Open path C:\Program Files\ABBYY SDK\12\FineReader Engine\Bin64
5. Open file LicensingSettings.xml in notepad.and check ServerAddress is correctly defined and ProtocolType="TCP/IP
6. Open path C:\Program Files\ABBYY SDK\12\FineReader Engine\Bin64Open LicenseManager.exe and confirm the license, Refresh if not visible.
7. Repeat this exercise per FineReader Engine instance needed.

 For more information please visit ABBYY's, Documentation Page.

How to Use ABBYY engine in Leapwork

Image and Text blocks now have Engine Drop-down to choose between 'OCR 1.0', 'OCR 2.0' or 'ABBYY'. User needs to choose ABBYY in the drop-down (as shown below) and execute the block to verify that integration is working.

The ABBYY engine can be used as a part of Image and Text Recognition/Mouse and Keyboard section while Adding a Building block. The blocks which have this feature are: 

For any clarification, please contact our Priority Support.