Passer au contenu principal

​
Workflow de l’API REST

Le workflow type de l’API REST est le suivant :
Schéma du workflow type de l’API REST FlexiCapture Cloud, montrant les étapes allant du téléversement des fichiers et de la création d’une tâche à l’interrogation du statut, à l’obtention des résultats pour vérification, à une vérification personnalisée et à un entraînement facultatifs, puis à la suppression des fichiers d’entrée et de sortie.
Tout projet FlexiCapture destiné à être utilisé avec votre application API REST doit inclure un workflow correctement configuré. Les instructions ci-dessous montrent comment adapter le workflow du projet d’exemple Banking Card Application pour l’utiliser avec l’API REST. Pour plus d’informations sur les projets d’exemple, consultez projets d’exemple ABBYY FlexiCapture. Avant de poursuivre cette procédure, lancez Project Setup Station et ouvrez le projet d’exemple Banking Card Application (l’emplacement par défaut est C:\Users\Public\ABBYY\FlexiCapture\12.0\Samples\FlexiCapture\English\Banking_eng\banking_eng.fcproj).

​
Ajuster les étapes du workflow

L’API REST soumet toujours les données à traiter avec le type de lot “Default”. C’est pourquoi tout le traitement des documents du projet doit être configuré pour le type de lot “Default”.
1

Sélectionner le schéma de workflow Advanced

Dans le menu Project, cliquez sur Propriétés du projet, puis sur l’onglet Workflow. Dans la liste déroulante Schema, sélectionnez Advanced et modifiez les paramètres du workflow comme indiqué ci-dessous.
Capture d’écran de l’onglet Workflow dans la boîte de dialogue Propriétés du projet de ABBYY FlexiCapture Project Setup Station, montrant le schéma Advanced sélectionné avec ses étapes de workflow.
2

Activer les web stations pour la vérification

Cliquez sur Verification → General et sélectionnez l’option Enable web stations.Remarque : vous pouvez ignorer ce paramètre si vous n’avez pas besoin d’une étape de vérification dans votre projet.
3

Définir la condition d’entrée de la vérification

Cliquez sur Verification → Entry Conditions et définissez l’option Documents are admitted to stage sur Always.
Selon les exigences de votre solution, vous souhaiterez peut-être désactiver l’étape de vérification temporairement ou de manière conditionnelle à l’aide d’une règle basée sur un script dans l’onglet Entry Conditions.
Capture d’écran de l’onglet Entry Conditions d’une étape de vérification dans ABBYY FlexiCapture Project Setup Station, montrant l’option Documents are admitted to stage définie sur Always.
4

Ajouter une étape pour exporter la mise en page XML

Pour activer le point de terminaison training/layout/{taskId}/{fileId} pour votre projet, exportez le fichier XML contenant les données de champs et la mise en page. Créez une étape de traitement des documents immédiatement avant l’étape de vérification.
Capture d’écran des étapes du workflow dans ABBYY FlexiCapture Project Setup Station, avec une nouvelle étape de traitement des documents ajoutée juste avant l’étape de vérification.
5

Définir la condition d’entrée de la nouvelle étape

Dans l’onglet Entry Conditions, choisissez Always.
Capture d’écran de l’onglet Entry Conditions de la nouvelle étape de traitement dans ABBYY FlexiCapture Project Setup Station, avec la condition d’admission définie sur Always.
6

Ouvrir l’éditeur de script

Dans l’onglet Script, cliquez sur Edit script….
Capture d’écran de l’onglet Script d’une étape de traitement dans ABBYY FlexiCapture Project Setup Station, avec le bouton Edit script.
7

Définir le langage du script

Remplacez le langage du script par C# .NET.
Capture d’écran de l’éditeur de script dans ABBYY FlexiCapture Project Setup Station, avec le langage du script défini sur C# .NET.
8

Ajouter le script d’export

Copiez-collez l’extrait de code suivant dans le volet de script :
using System;
Document.SaveXmlToFileStorage();
9

Enregistrer vos modifications

Cliquez sur OK pour enregistrer vos modifications.
Les paramètres du projet relatifs à l’assemblage des documents (traitement des images → Create document) sont ignorés lors du téléversement de fichiers via l’API REST. Un document distinct est créé pour chaque fichier.

​
Ajuster les paramètres d’export des données

Une fois qu’un lot soumis via l’API REST a été traité, l’API REST récupère les fichiers exportés afin de les mettre à la disposition du client pour téléchargement.
ABBYY FlexiCapture Cloud stocke les fichiers exportés dans un stockage d’objets. C’est pourquoi vous ne devez pas utiliser de chemins d’export absolus dans votre projet API REST.
Les projets API REST ne nécessitent pas de structure de dossiers particulière. Vous pouvez utiliser une structure de dossiers plate, en reprenant le nom du dossier racine pour chaque lot et les ID des documents dans les noms de fichiers. Les services API REST attribuent à chaque lot soumis via l’API REST un nom de lot unique et aléatoire, de sorte que des noms de fichiers uniques sont générés lors de l’export des données de ces lots. La capture d’écran suivante montre les paramètres d’export d’origine, qui produisent une structure de dossiers à plusieurs niveaux :
Capture d’écran des paramètres d’export dans ABBYY FlexiCapture Project Setup Station, montrant la dénomination de fichiers d’origine qui produit une structure de dossiers à plusieurs niveaux.
La capture d’écran suivante montre les paramètres d’export modifiés, qui produisent une structure de dossiers plate :
Capture d’écran des paramètres d’export dans ABBYY FlexiCapture Project Setup Station, montrant la dénomination de fichiers modifiée qui produit une structure de dossiers plate.

​
Téléversez votre projet modifié vers ABBYY FlexiCapture Cloud

1

Ouvrir la boîte de dialogue de téléversement

Cliquez sur File > Upload Project to Server… pour téléverser votre projet vers ABBYY FlexiCapture Cloud.
2

Saisir le serveur et le tenant

Dans la boîte de dialogue qui s’ouvre, saisissez l’URL du serveur cloud qui héberge votre tenant et indiquez le nom de votre tenant.
3

Saisir vos identifiants

Sélectionnez Use server authentication et saisissez les identifiants de l’administrateur de votre tenant.
4

Tester la connexion

Cliquez sur Test connection pour vérifier vos paramètres de connexion.
5

Téléverser le projet

Cliquez sur OK et patientez jusqu’à ce que votre projet soit téléversé.

​
Vos prochaines étapes

Une fois votre projet téléversé dans ABBYY FlexiCapture Cloud, voici ce que vous pouvez faire ensuite :