ABBYY FlexiCapture Connect - ABBYY Documentation

ABBYY FlexiCapture Connect s’exécute en tant que service Windows et permet aux utilisateurs d’importer des documents dans des projets ABBYY FlexiCapture Cloud, d’exporter des documents à partir de projets ABBYY FlexiCapture Cloud et de synchroniser des jeux de données.

Schéma montrant ABBYY FlexiCapture Connect s’exécutant sur un serveur Windows, se connectant à ABBYY FlexiCapture Cloud via un pare-feu sur le port 443.

Exigences système

Exigence	Details
Système d’exploitation	Windows 10, Windows 11 ou Windows Server 2012, 2012 R2, 2016, 2019, 2022 ou 2025 (tous avec Desktop Experience).
RAM	Il est recommandé de disposer d’au moins 2,5 Go pour un jeu de données contenant environ 500 000 fournisseurs.
Compatibilité logicielle	serveur d’applications ABBYY FlexiCapture Release 3 ou version ultérieure ; .NET Framework 4.6.1 ou version ultérieure.

Installer et configurer ABBYY FlexiCapture Connect

Utilisez votre compte de service pour installer et configurer ABBYY FlexiCapture Connect.

Télécharger et exécuter le programme d’installation

Si ABBYY FlexiCapture Connect est déjà installé et que vous mettez à jour une version existante, créez d’abord une copie de sauvegarde du fichier config.json, situé dans C:\Program Files (x86)\ABBYY FlexiCapture Connect\config.json.Téléchargez et exécutez le fichier FlexiCapture_Connect_Installer_*.msi à l’adresse https://www.abbyy.com/flexicapture-downloads/cloud/.

Modifier le fichier de configuration

Modifiez le fichier config.json selon vos besoins. Pour plus d’informations, consultez Référence du fichier de configuration.

Tester la nouvelle configuration

Mettez en pause le service ABBYY FlexiCapture Connect.
Exécutez le fichier ABBYY.FlexiCapture.Connect.exe. Une fenêtre de console contenant un Log détaillé s’ouvre.

Redémarrer le service

Redémarrez ABBYY FlexiCapture Connect.

Référence du fichier de configuration

Cet exemple de fichier config.json importe des documents dans un projet, exporte les résultats du traitement et synchronise un jeu de données.

{
  "url": "https://europe.flexicapture.com/",
  "tenant": "testtenant",
  "user": "user1",
  "password": "password1",
  "projects": [
    {
      "name": "project1",
      "import": {
        "directory": "C:\\HotFolder\\Import",
        "fileMask": "*",
        "settings": {
          "region": "US",
          "verification_type": "NoVerification",
          "export_format": "Xml"
        },
        "createDocument": "ForEachFile",
        "period": "00:01:00",
        "schedule": [ "12:00:00", "06:00:00" ]
      },
      "export": {
        "directory": "C:\\HotFolder\\Export",
        "period": "00:01:00",
        "schedule": [ "12:00:00" ]
      },
      "templates": [
        {
          "name": "template",
          "datasets": [
            {
              "name": "DataSet",
              "file": "C:\\HotFolder\\DataSets\\DataSet.csv",
              "period": "00:01:00",
              "schedule": [ "12:00:00" ]
            }
          ]
        }
      ]
    }
  ]
}

Paramètres généraux

Les propriétés de premier niveau identifient le tenant et le compte de service.

Propriété	Description
`url`	L’URL du tenant (par exemple, `https://europe.flexicapture.com`).
`tenant`	Le nom du tenant.
`user`	Le nom d’utilisateur du compte de service.
`password`	Le mot de passe du compte de service.
`projects`	Contient les paramètres propres à chaque projet, tels que les paramètres d’importation de documents, les paramètres d’exportation et les paramètres de synchronisation des jeux de données.

Pour importer et exporter des documents, configurez le compte du tenant en tant qu’External User. Pour synchroniser les jeux de données, le compte du tenant doit disposer soit du rôle Administrator, soit des rôles Project Settings Editor et External User. Par défaut, tous les projets sont accessibles au compte du tenant. Pour modifier ce comportement, ajustez les droits d’accès accordés à des rôles d’utilisateur spécifiques. Pour plus d’informations, consultez Configurer les rôles utilisateur et les droits d’accès.

Paramètres du projet

Chaque objet du tableau projects définit un projet.

Propriété	Description
`name`	Nom du projet.
`import`	Paramètres d’importation des documents.
`export`	Paramètres d’exportation des documents.
`templates`	Paramètres de synchronisation des jeux de données.

Paramètres d’importation

L’objet import d’un projet définit comment et quand les documents sont importés.

Propriété	Description
`directory`	Chemin d’accès au dossier depuis lequel les documents sont importés.
`fileMask`	Filtre de fichiers et de dossiers. Les caractères génériques `*` et `?` sont pris en charge.
`settings`	Paramètres d’enregistrement du lot.
`createDocument`	Valeurs possibles : `ForEachFile` (crée un document distinct pour chaque fichier importé) ou `Automatically` (utilise les paramètres du projet). Pour utiliser `Automatically`, sélectionnez d’abord l’option Automatically when Document Definition is applied dans le projet ABBYY FlexiCapture.
`period`	Fréquence de démarrage de la tâche. Par exemple, `"period": "00:02:30"` lance la tâche toutes les deux minutes et demie. Vous pouvez définir `period` et `schedule` indépendamment l’un de l’autre.
`schedule`	Heures de démarrage de la tâche. Par exemple, `"schedule": [ "09:00:00", "19:00:00" ]` lance la tâche tous les jours à 9 h et à 19 h.

Un nouveau lot est créé à chaque importation de fichiers. Son nom contient la date et l’heure actuelles.

Paramètres d’exportation

L’objet export d’un projet définit où et quand les résultats du traitement sont exportés.

Propriété	Description
`directory`	Le chemin d’accès au dossier où sont stockés les fichiers exportés.
`period`	Fréquence de démarrage de la tâche d’exportation, au même format que pour l’importation. Vous pouvez définir `period` et `schedule` indépendamment l’une de l’autre.
`schedule`	Heures de démarrage de la tâche d’exportation, au même format que pour l’importation.

Lors de l’exportation des documents, un dossier est créé pour chaque lot du projet actuellement à l’étape Traité. Ces dossiers de destination portent le même nom que les lots correspondants et contiennent tous les résultats du traitement. Si un dossier de destination est supprimé, le programme en crée un nouveau portant le même nom et y place les résultats du traitement.

Paramètres de la Document Definition

Chaque objet du tableau templates identifie une Document Definition et ses jeux de données.

Propriété	Description
`name`	Le nom de la Document Definition liée à la section concernée.
`datasets`	Les paramètres de synchronisation des jeux de données pour la Document Definition.

Paramètres de synchronisation du jeu de données

Chaque objet du tableau datasets définit un jeu de données à synchroniser.

Propriété	Description
`name`	Le nom du jeu de données.
`file`	Le chemin du fichier CSV contenant les données de référence exportées depuis le système ERP. La première ligne du fichier CSV doit contenir les noms des champs du jeu de données séparés par des virgules. Toute valeur contenant une virgule doit être placée entre guillemets doubles.
`period`	La fréquence de démarrage de la tâche de synchronisation, au même format que pour l’importation. Vous pouvez définir `period` et `schedule` indépendamment l’un de l’autre.
`schedule`	Les heures de démarrage de la tâche de synchronisation, au même format que pour l’importation.

La synchronisation remplace les jeux de données actuels par les nouveaux. Les enregistrements existants modifiés par un opérateur de vérification (par modification, ajout ou suppression de valeurs) sont enregistrés et synchronisés. Les nouveaux enregistrements ajoutés manuellement sont supprimés et ne sont pas synchronisés. Pour les très grands jeux de données, la synchronisation peut prendre plusieurs heures. Dans cet exemple de fichier CSV pour un jeu de données Vendors, le premier fournisseur possède plusieurs IBAN.

Id,Name,Street,City,ZIP,CountryCode,VATID,IBAN,IBAN,BusinessUnitId
1,MacWay,9 Route d'Eschau,Illkirch-Graffenstaden,67411,FR,1A345678901,FR1420041010050500012M02606,FR7630006000011234567890189,1
2,Bottled Water Ltd,Mary Ann St,Cardiff,CF102EN,GB,123456789,GB29NWBK60161331926819,,2
3,CCcompany Ltd.,2 Wilkins Grove,Welwyn Garden City,AL86JS,GB,234567890,GB27BOFI90212729823529,,3
4,MANZANA solutions,"Calle de la Botanica, 15",Madrid,28000,ES,E73895722,ES9121000418450200051332,,4

Stocker les identifiants du compte de service dans Windows Vault

Les identifiants du compte de service peuvent être stockés soit dans le fichier config.json situé dans le répertoire du service ABBYY FlexiCapture Connect, soit, de façon plus sécurisée, dans Windows Vault. Pour plus d’informations, consultez la documentation Microsoft sur Credential Manager et cmdkey.

Ajouter des identifiants à Windows Vault

Pour permettre à ABBYY FlexiCapture Connect de récupérer les identifiants du compte de service depuis Windows Vault, enregistrez-les avec cmdkey et exécutez le service sous le même compte Windows.

Créer ou choisir un compte Windows

Créez un nouveau compte Windows ou choisissez un compte Windows existant.

Enregistrer les identifiants avec cmdkey

Exécutez cmd.exe sous ce compte Windows, puis exécutez la commande cmdkey suivante. Dans cette commande, https://europe.flexicapture.com#tenant correspond à la combinaison de l’URL ABBYY FlexiCapture et du nom du tenant.

cmdkey /generic:https://europe.flexicapture.com#tenant /user:userName /password:p@ssword

Supprimer les identifiants du fichier de configuration

Supprimez le nom d’utilisateur et le mot de passe du fichier config.json situé dans le répertoire du service ABBYY FlexiCapture Connect.

Exécuter le service sous le compte Windows

Configurez ABBYY FlexiCapture Connect pour qu’il s’exécute sous le même compte Windows que celui utilisé pour exécuter cmdkey.

Lancez Windows Service Manager (services.msc).
Dans Services, ouvrez les propriétés de ABBYY FlexiCapture Connect.
Dans l’onglet Log On, sélectionnez This account et saisissez les identifiants de votre compte Windows.

Capture d’écran de l’onglet Log On dans les propriétés du service ABBYY FlexiCapture Connect, avec This account sélectionné et les identifiants du compte Windows saisis.

Supprimer des identifiants de Windows Vault

Ouvrir Credential Manager

Ouvrez Credential Manager.

Supprimer l’identifiant

Dans l’onglet Windows Credentials, développez l’identifiant à supprimer, puis cliquez sur Remove.

Capture d’écran de l’onglet Windows Credentials dans Credential Manager, avec un identifiant développé et l’option Remove disponible.

Configurer les chemins d’export du projet

Pour utiliser ABBYY FlexiCapture Connect afin d’exporter des fichiers depuis ABBYY FlexiCapture Cloud, modifiez les chemins d’export de votre projet.

Vider le chemin d’export racine

Dans l’onglet Général de la boîte de dialogue Propriétés de <project>, assurez-vous que le champ chemin d’export racine est vide. Pour plus d’informations, consultez Propriétés du projet.

Capture d’écran de l’onglet Général de la boîte de dialogue Propriétés du projet, avec le champ chemin d’export racine vide.

Spécifier un chemin d’export relatif

Dans la boîte de dialogue paramètres d’exportation, spécifiez le chemin d’export par rapport au chemin racine indiqué dans l’onglet Général de la boîte de dialogue Propriétés de <project>. Comme ce chemin racine est vide, indiquez le répertoire sans inclure le chemin racine complet.

Capture d’écran de la boîte de dialogue paramètres d’exportation, avec le chemin d’export spécifié par rapport à un chemin racine vide.

L’option If file exists est ignorée. Lorsque des fichiers sont exportés depuis ABBYY FlexiCapture Cloud via ABBYY FlexiCapture Connect, un nouveau fichier est créé pour chaque nouveau document.

Limitations d’ABBYY FlexiCapture Connect

Seuls les jeux de données contenant environ 500 000 enregistrements au maximum peuvent être synchronisés.
Pendant la mise à jour d’un jeu de données, les utilisateurs ne peuvent pas rechercher de fournisseurs sur les stations Web.
ABBYY FlexiCapture Connect ne reconnaît pas les profils d’importation Hot Folder basés sur les paramètres du projet.
ABBYY FlexiCapture Connect exporte les documents de tous les lots disponibles sur le serveur. Les paramètres du projet n’ont aucun effet sur le nom du répertoire de destination, qui porte toujours le même nom que le lot source.
ABBYY FlexiCapture Connect ne peut exporter qu’un lot entier. Si vous désactivez l’option Wait for all documents in a batch dans les Workflow Settings du projet, les documents ne sont toujours pas exportés séparément.
ABBYY FlexiCapture Connect ne peut pas exporter les résultats de tous les documents d’un lot dans un seul fichier. Un fichier distinct est créé dans le répertoire d’exportation pour chaque document du lot.
ABBYY FlexiCapture Connect ne peut pas exporter les résultats de tous les lots dans un seul fichier. Un fichier distinct est créé dans le répertoire d’exportation pour chaque document de chaque lot.
La taille des fichiers importés et exportés est limitée à 199 Mo.
Les serveurs proxy ne sont pas pris en charge.

Résoudre les erreurs d’ABBYY FlexiCapture Connect

Si vous rencontrez une erreur, consultez d’abord le fichier Log, que vous trouverez dans %LocalAppData%\ABBYY\FlexiCapture\Connect\Logs. Les erreurs peuvent également être dues à des paramètres incorrects ou incomplets définis dans le fichier de configuration, alors vérifiez le fichier config.json pour repérer toute incohérence ou omission. Si l’erreur persiste, contactez le support d’ABBYY. Le support pourra vous demander votre fichier config.json ainsi que le fichier Log.

​Exigences système

​Installer et configurer ABBYY FlexiCapture Connect

​Référence du fichier de configuration

​Paramètres généraux

​Paramètres du projet

​Paramètres d’importation

​Paramètres d’exportation

​Paramètres de la Document Definition

​Paramètres de synchronisation du jeu de données

​Stocker les identifiants du compte de service dans Windows Vault

​Ajouter des identifiants à Windows Vault

​Supprimer des identifiants de Windows Vault

​Configurer les chemins d’export du projet

​Limitations d’ABBYY FlexiCapture Connect

​Résoudre les erreurs d’ABBYY FlexiCapture Connect