Tutoriel pour débutant pour apprendre à exploiter ABBYY FineReader Engine 12

D’une façon synoptique, le principe de fonctionnement de ABBYY FineReader Engine se présente comme suit :

Les formats supportés nativement pour l’import sont :

• BMP, PCX, DCX, GIF, PNG, DjVu ;
• JPEG, JPEG2000, JBIG2, TIFF ;
• PDF.

Et les formats possibles en sortie sont :

ABBYY FineReader Engine existe en différentes versions disponibles pour les environnements suivants :

• les systèmes d’exploitation Windows, Linux et OS X en 32-bit et 64-bit ;
• le cloud et les environnements virtuels ;
• les systèmes intégrés.

« Online license » est un type de licence spécial pour FineReader Engine 12, qui est conçu pour être utilisé spécifiquement pour le déploiement de FineReader Engine dans des conteneurs Docker, des environnements virtuels et cloud. Il peut également être utilisé sur un autre type d’environnements disposant d'une connexion Internet permanente.

Contrairement au type de licences de logiciels communs de FineReader Engine, la licence en ligne n'est pas liée à une machine particulière et elle ne nécessite pas d'activation. Ainsi, ce type est le mieux adapté pour une utilisation dans des conteneurs Docker et les environnements virtuels dans le cloud et lorsqu'il est nécessaire d'utiliser le matériel de manière flexible afin de mettre à l'échelle et orchestrer un grand nombre de tâches pour le traitement des documents.

Aussi, la modification du stockage des données et de la puissance d'une machine virtuelle ainsi que l'ajout de nouvelles instances pour faire évoluer l'application sont entièrement pris en charge par ce type de licence.

Le type « Online Licence » est disponible soit pour compte développeur et une instance d’exécution.

Il permet de traiter un certain volume de pages pendant une période définie, par exemple un nombre de pages par an (PPY) ou par mois (PPM). Plusieurs instances de FineReader Engine peuvent partager un numéro de série et une licence. À cette fin, un serveur de licences local sur chaque instance et un serveur de licences hébergé par ABBYY se synchronisent périodiquement pour mettre à jour les informations du compteur sur Internet.

Le service de licence ABBYY tient un registre de toutes les pages traitées à partir de toutes les machines du client liées à ce numéro de série.

Pour le bon fonctionnement du type « Online license », une synchronisation entre les deux services de licences suivants est requise :

• service de licence local sur le poste de travail, sur lequel FineReader Engine est installé ;
• service de licence ABBYY sur le serveur d'ABBYY sur Internet.

II-A-2-a. Serveur de licence en ligne : hébergement et disponibilité▲

II-A-2-b. Serveur de licence local : prérequis pour la synchronisation▲

Le service de licences local envoie au service de licences ABBYY uniquement les informations nécessaires à l'identification de la licence pour le reporting des pages consommées. Les informations envoyées sont encodées par des sommes de contrôle de hachage indépendantes du matériel et ne peuvent pas être reconstruites. ABBYY reçoit des informations complètement anonymisées sur l'environnement en ligne où la licence est utilisée.

Le serveur de licence ABBYY collecte les données suivantes :

• l’ID d'instance ;
• l’ID de la machine ;
• la clef de sécurité ;
• la clef du client ;
• l’ID de la licence ;
• les informations du compteur de licences.

Les paramètres de la licence en ligne sont contenus dans un fichier protégé par mot de passe (jeton d'activation) qui est utilisé pour l’autorisation lors de la connexion aux services de licence ABBYY. Lorsque vous commandez une licence de type « Online License », vous recevrez les informations suivantes :

• l’ ID du projet client : c’est une chaîne alphanumérique utilisée pour lier les licences Developer et Runtime d'un projet, par exemple «Im8oCFCbJ4PFhhJYfnhy» ;
• le jeton de licence : c’est un fichier binaire contenant des paramètres de licence qui sont utilisés pour l'autorisation lors d’une connexion au service de licence ABBYY. Le fichier est nommé comme suit : «SWERXXXXXXXXXXXXXXXXXXXX.ABBYY.ActivationToken», où «SWERXXXXXXXXXXXXXXXXXXXX» est la clef de licence ;
• un mot de passe pour le fichier de jeton d'activation de licence.

Les paramètres et les statistiques du compteur de licence installée en local peuvent être examinés dans le gestionnaire de licences :

La bibliothèque FineReader Engine est chargée à l'aide de la fonction InitializeEngine ou de la méthode IEngineLoader :: InitializeEngine.

La syntaxe C# de la fonction InitializeEngine est :

int InitializeEngine(
  string CustomerProjectID,
  string LicensePath,
  string LicensePassword,
  string FREngineDataFolder,
  string FREngineTempFolder,
  bool IsSharedCPUCoresMode,
  ref IEngine Engine
);

Lorsque vous travaillez avec une « online license », les paramètres de la fonction InitializeEngine doivent être spécifiés comme suit :

1. l’ID du projet client ;
2. le chemin complet vers le fichier de jeton de licence ;
3. le mot de passe du fichier de jeton de licence ;
4. [Facultatif, peut être une chaîne vide] le chemin d'accès au dossier dans lequel ABBYY FineReader Engine doit stocker les données spécifiques à l'utilisateur. Par défaut, il s'agit du dossier de données FineReader Engine :% ProgramData% \ ABBYY \ SDK \ 12 \ FineReader Engine pour l'installation automatique ;
5. [Facultatif, peut être une chaîne vide] le chemin d'accès au dossier des fichiers temporaires d'ABBYY FineReader Engine. Par défaut, il s'agit du dossier % TEMP% \ ABBYY FineReader Engine 12 ;
6. [Facultatif] une valeur booléenne qui spécifie si les cœurs de processeur doivent être utilisés en mode partagé ;
7. la variable de sortie pour l'objet Engine.

Exemple de code en C# :

InitializeEngine(“Im8oCFCbJ4PFhhJYfnhy”, @“C:\Program Files\Application\
SWRT12411234123412341234.ABBYY.Cloud.ActivationToken”, “12345678”,” “, “ “, “ “, ref engine);

Pour une description détaillée de cette fonction et de ses paramètres, reportez-vous au fichier d'aide du produit.

Une licence de type « Open License » est un type spécial de licence utilisé pour les kits ABBYY Software Development.

Il s'agit d'une licence autonome sous la forme d'une clef de fichier.

Elle est fournie aux utilisateurs sous forme de fichier binaire et ne nécessite pas d'activation.

Le service de gestion de licence n'est pas donc requis pour l'utilisation d'un « Open Licence ».

L'utilisation et l'intégration d'un fichier d’une « Open License » diffèrent des méthodes standards disponibles pour les autres SDK ABBYY. Pour garantir une intégration correcte de la licence, veuillez suivre les instructions ci-dessous :

1. L'extension du fichier d’une « Open license » est «.ABBYY.LocalLicense». Veuillez vous assurer que lorsque vous commencez à travailler avec ABBYY FineReader Engine, vous utilisez le fichier de licence avec l'extension «.ABBYY.LocalLicense» ;
2. Copiez le fichier « Open License » dans un dossier de votre choix. Nous vous recommandons de le placer dans le même dossier que le fichier FREngine.dll ;
3. Pour commencer à travailler avec ABBYY FineReader Engine, vous devez d'abord créer l'objet Engine. L'objet Engine est l'objet au niveau supérieur de la hiérarchie des objets ABBYY FineReader Engine et fournit divers paramètres globaux, des méthodes de traitement sélectionnées et des méthodes de création d'autres objets. Pour charger l'objet Engine, l'API FineReader Engine fournit la méthode InitializeEngine. La syntaxe de cette méthode est :

InitializeEngine(string customerProjectId, string licensePath, string licensePassword, string
dataFolder, string tempFolder, bool isSharedCPUCoresMode, ref FREngine.IEngine engine);

• CustomerProjectID - [obligatoire] une chaîne contenant l'ID du projet client.

• LicensePath - [obligatoire] un chemin d'accès au dossier, où se trouve le fichier de licence, par exemple « C: \ Program Files \ Application \ Runtime.ABBYY.LocalLicense ». Il doit s'agir du chemin complet d'un fichier ou d'une chaîne vide. En cas de chaîne vide, un fichier de licence sera recherché dans :

  • Windows : «% ProgramData% \ ABBYY \ SDK \ 12 \ Licenses»
  • Linux : ‘/ var / lib / ABBYY / SDK / 12 / Licences’
  • Mac OS : ‘/ Library / Application Support / ABBYY / SDK / 12 / Licences’
• LicensePassword - [obligatoire] le mot de passe de la licence « Open License ».

• FREngineDataFolder - [facultatif, peut être une chaîne vide] contient le chemin d'accès au dossier, dans lequel ABBYY FineReader Engine doit stocker des données spécifiques à l'utilisateur. Par défaut, il s'agit du dossier de données FineReader Engine :

  • Windows : «% ProgramData% \ ABBYY \ SDK \ 12 \ FineReader Engine»
  • Linux : «/var / lib / ABBYY / SDK / 12 / FineReader Engine»
  • Mac OS : « / Library / Application Support / ABBYY / SDK / 12 / FineReader Engine »

• FREngineTempFolder - [facultatif, peut être une chaîne vide] contient le chemin d'accès au dossier des fichiers temporaires de ABBYY FineReader Engine. Par défaut, c'est :

  • Windows : «% TEMP% \ ABBYY FineReader Engine 12»
  • Linux : « / tmp / ABBYY FineReader Engine 12 »
  • Mac OS : «$ TMPDIR / ABBYY FineReader Engine 12»
• IsSharedCPUCoresMode :spécifie si les cœurs de processeur doivent être partagés entre tous les processus en cours d'exécution ou si le nombre de processus doit être limité par le nombre de cœurs autorisés par la licence.
• Engine - variable de sortie pour l'objet Engine.

Vous pouvez voir un exemple de code en C # ci-dessous :

// Appelle la fonction InitializeEngine
int hresult = initializeEngine (FreConfig.GetCustomerProjectId (), FreConfig.GetLicensePath (), FreConfig.GetLicensePassword (), “”, “”, false, ref engine);