Getting started

To start developing an Ionic-based app using ABBYY Mobile Capture SDK features, you need to add ABBYY Mobile Capture SDK Cordova Plugin, then add target platforms to your project, and thereafter copy the ABBYY Mobile Capture SDK assets and native libraries for Android and iOS, as described below.

How to add the plugin to your Ionic project

Prerequisites

Using ABBYY Mobile Capture SDK features requires a previously created Ionic project. See the Ionic official guide to find out details on a project creation.

For the plugin work you will need an ABBYY Mobile Capture SDK library with a valid License file. If you don't have an ABBYY Mobile Capture SDK, request a trial version on the ABBYY website.

Adding Cordova Plugin

Add the plugin to your project from npm. It is recommended to add the 1.0.16 cordova-plugin-abbyy-rtr-sdk version, as it supports all up-to-date changes.

npm install cordova-plugin-abbyy-rtr-sdk@1.0.16

Run the next command to apply changes:

ionic cap sync

ABBYY MobileCapture environment setup

1. Request ABBYY Mobile Capture trial version on the ABBYY website and add it to your project:

  • Copy iOS assets directory to the project into ../assets folder
  • Copy your license into ../assets with MobileCapture.License name
  • Copy Android libs directory to the project into ../libs/android folder
  • Copy iOS libs directory to the project into ../libs/ios folder

 Important! A certain folder structure is required for the setup. Make sure to change the paths to libs, assets and license file if your folder structure differs from the following one:

assets/
  bcr/
     ...
  dictionaries/
     ...
  ...
  MobileCapture.License
libs/
  android/
     abbyy-rtr-sdk-1.0.aar
     abbyy-ui-1.0.aar
  ios/
     AbbyyRtrSDK.framework
     AbbyyUI.framework
     ...
[PROJECT_FOLDER]/
  ...

2. Proceed setup depending on the platform:

  • Android setup

  • iOS setup

02.03.2022 12:59:15

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.