Integrate with ABBYY for OCR

Introduction

Integrating ABBYY Optical Character Recognition (OCR) with Joget allows you to automate text extraction from images or documents. This integration streamlines workflows where document processing is required, such as invoice processing, data entry, or document archiving. In this guide, you will learn how to set up a demo app in Joget that integrates with ABBYY's OCR service, allowing you to upload documents, process them through ABBYY, and retrieve the extracted text.

How does it work?

Integration with ABBYY is achieved through API calls that allow Joget to communicate with ABBYY’s Cloud OCR SDK. In this demo, you will perform the following steps, referring to the documentation on how to work with the Cloud OCR SDK.

Process flow / integration points

1. Upload a file from Joget to ABBYY using ABBYY's processImage method.
2. Perform a call from Joget to ABBYY using ABBYY's getTaskStatus method to retrieve the task status of the previous call.
3. Perform a call from Joget to ABBYY to retrieve the processed file using the path retrieved in the previous step. This is the result of processImage in step 1.

Setting up the demo app

1. Prepare the following:-
   - ABBYY Application ID (example: c80764b7-94f4-aaaa),
   - ABBYY Application Password (example: Rad#sfewfwc/5), and
   
   The parameters can be found in your account dashboard.
2. You can also compute the basic auth header (Authorization) value using the values above. (example: Basic Yzg2wNzvY034aYjvc5tOTvR556m)
3. Obtain and install the plugins listed in this article.
4. Import the attached Joget app in this article into your copy of Joget.
5. Go to App Variables and set the value into variable auth prepared in step 2.
   
6. Click on Versions at the top to publish the app. Select version 1 and publish.
   
7. Launch the app.
   
8. You are now ready to run the demo.

Running the demo app

1. Click the New button, key in a title, and upload the document to be sent for OCR.
   
   Submitting the form will trigger the first API to ABBYY - processImage Method.
2. Once submitted, you will be redirected to the listing. Upon successful API calls, a task ID will be assigned to the document.
   
   Click Step 2 - Fetch to retrieve the task result. This will make a call to getTaskStatus Method.
3. The result URL column will then be populated.
   
   You can then click Step 3 - Download to download the processed file/result.
4. You can click the link in the Downloaded column to download the processed file/result.
   

Related documentation

• Enhanced JSON Tool 7.0.2
• Form Update Process Tool Datalist Action 7.0.3
• File Link Datalist Formatter

Download sample app