ABBYY FlexiCapture Connect - ABBYY Documentation

ABBYY FlexiCapture Connect se ejecuta como un servicio de Windows y permite a los usuarios importar documentos en proyectos de ABBYY FlexiCapture Cloud, exportar documentos desde proyectos de ABBYY FlexiCapture Cloud y sincronizar conjuntos de datos.

Diagrama que muestra ABBYY FlexiCapture Connect ejecutándose en un servidor Windows y conectándose a ABBYY FlexiCapture Cloud a través de un firewall por el puerto 443.

Requisitos del sistema

Requisito	Details
Sistema operativo	Windows 10, Windows 11 o Windows Server 2012, 2012 R2, 2016, 2019, 2022 o 2025 (cada uno con Desktop Experience).
RAM	Se recomienda un mínimo de 2,5 GB para un conjunto de datos que contenga aproximadamente 500.000 proveedores.
Compatibilidad de software	ABBYY FlexiCapture Application Server Release 3 o posterior; .NET Framework 4.6.1 o posterior.

Instalar y configurar ABBYY FlexiCapture Connect

Utilice su cuenta de servicio para instalar y configurar ABBYY FlexiCapture Connect.

Descargue y ejecute el instalador

Si ABBYY FlexiCapture Connect ya está instalado y va a actualizar una versión existente, primero cree una copia de seguridad del archivo config.json, ubicado en C:\Program Files (x86)\ABBYY FlexiCapture Connect\config.json.Descargue y ejecute el archivo FlexiCapture_Connect_Installer_*.msi desde https://www.abbyy.com/flexicapture-downloads/cloud/.

Modifique el archivo de configuración

Modifique el archivo config.json según sus necesidades. Para obtener más información, consulte Referencia del archivo de configuración.

Pruebe la nueva configuración

Pause el servicio ABBYY FlexiCapture Connect.
Ejecute el archivo ABBYY.FlexiCapture.Connect.exe. Se abrirá una ventana de consola con un registro detallado.

Reinicie el servicio

Reinicie ABBYY FlexiCapture Connect.

Referencia del archivo de configuración

Este archivo config.json de ejemplo importa documentos a un proyecto, exporta los resultados del procesamiento y sincroniza un conjunto de datos.

{
  "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" ]
            }
          ]
        }
      ]
    }
  ]
}

Configuración general

Las propiedades de nivel superior identifican el tenant y la cuenta de servicio.

Propiedad	Descripción
`url`	La URL del tenant (por ejemplo, `https://europe.flexicapture.com`).
`tenant`	El nombre del tenant.
`user`	El nombre de usuario de la cuenta de servicio.
`password`	La contraseña de la cuenta de servicio.
`projects`	Contiene la configuración de proyectos individuales, como los parámetros de importación y exportación de documentos, y los parámetros de sincronización de conjuntos de datos.

Para importar y exportar documentos, configure la cuenta del tenant como External User. Para sincronizar conjuntos de datos, la cuenta del tenant necesita el rol Administrator o ambos roles Project Settings Editor y External User. De forma predeterminada, la cuenta del tenant tiene acceso a todos los proyectos. Para cambiarlo, ajuste los permisos de acceso otorgados a roles de usuario específicos. Para obtener más información, consulte Configurar roles de usuario y permisos de acceso.

Configuración del proyecto

Cada objeto del array projects define un proyecto.

Propiedad	Descripción
`name`	Nombre del proyecto.
`import`	Configuración de la importación de documentos.
`export`	Configuración de la exportación de documentos.
`templates`	Configuración de la sincronización de conjuntos de datos.

Configuración de importación

El objeto import de un proyecto define cómo y cuándo se importan los documentos.

Propiedad	Descripción
`directory`	La ruta de la carpeta desde la que se importan los documentos.
`fileMask`	Un filtro de archivos y carpetas. Se admiten los comodines `*` y `?`.
`settings`	Parámetros de registro del lote.
`createDocument`	Los valores posibles son `ForEachFile` (crea un documento independiente por cada archivo importado) o `Automatically` (utiliza los parámetros del proyecto). Para usar `Automatically`, seleccione primero la opción Automatically when Document Definition is applied en el proyecto de ABBYY FlexiCapture.
`period`	Frecuencia con la que se inicia la tarea. Por ejemplo, `"period": "00:02:30"` inicia la tarea cada dos minutos y medio. Puede configurar `period` y `schedule` de forma independiente.
`schedule`	Horas a las que se inicia la tarea. Por ejemplo, `"schedule": [ "09:00:00", "19:00:00" ]` inicia la tarea todos los días a las 9:00 y a las 19:00.

Cada vez que se importan archivos, se crea un lote nuevo. El nombre del lote incluye la fecha y la hora actuales.

Configuración de exportación

El objeto export de un proyecto define dónde y cuándo se exportan los resultados del procesamiento.

Propiedad	Descripción
`directory`	La ruta de la carpeta donde se almacenan los archivos exportados.
`period`	Frecuencia con la que se inicia la tarea de exportación, en el mismo formato que para la importación. Puede establecer `period` y `schedule` de forma independiente.
`schedule`	Horas a las que se inicia la tarea de exportación, en el mismo formato que para la importación.

Cuando se exportan los documentos, se crea una carpeta para cada lote del proyecto que se encuentra actualmente en la etapa Procesado. Estas carpetas de destino tienen los mismos nombres que sus respectivos lotes y contienen todos los resultados del procesamiento. Si se elimina una carpeta de destino, el programa crea una nueva con el mismo nombre y coloca allí los resultados del procesamiento.

Configuración de Definición de Document

Cada objeto del array templates identifica una Definición de Document y sus conjuntos de datos.

Propiedad	Descripción
`name`	El nombre de la Definición de Document relacionada con esta sección.
`datasets`	Los parámetros de sincronización de conjuntos de datos para la Definición de Document.

Configuración de sincronización del conjunto de datos

Cada objeto del array datasets define un conjunto de datos que se va a sincronizar.

Propiedad	Descripción
`name`	El nombre del conjunto de datos.
`file`	La ruta del archivo CSV que contiene los datos maestros exportados desde el sistema ERP. La primera línea del archivo CSV debe contener los nombres de los campos del conjunto de datos separados por comas. Cualquier valor que contenga comas debe ir entre comillas dobles.
`period`	Frecuencia con la que se inicia la tarea de sincronización, en el mismo formato que para la importación. Puede establecer `period` y `schedule` de forma independiente.
`schedule`	Horas a las que se inicia la tarea de sincronización, en el mismo formato que para la importación.

La sincronización sustituye los conjuntos de datos actuales por los nuevos. Los registros existentes modificados por un operador de verificación (mediante la edición, adición o eliminación de valores) se guardan y sincronizan. Los nuevos registros agregados manualmente se eliminan y no se sincronizan. En el caso de conjuntos de datos muy grandes, la sincronización puede tardar varias horas. En este archivo CSV de ejemplo de un conjunto de datos Vendors, el primer proveedor tiene varios 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

Almacenar las credenciales de la cuenta de servicio en Windows Vault

Las credenciales de la cuenta de servicio pueden almacenarse en el archivo config.json del directorio del servicio ABBYY FlexiCapture Connect o, de forma más segura, en Windows Vault. Para obtener más información, consulte la documentación de Microsoft sobre Credential Manager y cmdkey.

Agregar credenciales a Windows Vault

Para permitir que ABBYY FlexiCapture Connect recupere las credenciales de la cuenta de servicio desde Windows Vault, regístrelas con cmdkey y ejecute el servicio con la misma cuenta de Windows.

Crear o elegir una cuenta de Windows

Cree una nueva cuenta de Windows o elija una cuenta existente.

Registrar las credenciales con cmdkey

Inicie cmd.exe con esa cuenta de Windows y ejecute este comando cmdkey. En el comando, https://europe.flexicapture.com#tenant es una combinación de la URL de ABBYY FlexiCapture y el nombre del tenant.

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

Eliminar las credenciales del archivo de configuración

Elimine el nombre de usuario y la contraseña del archivo config.json, ubicado en el directorio del servicio ABBYY FlexiCapture Connect.

Ejecutar el servicio con la cuenta de Windows

Configure ABBYY FlexiCapture Connect para que se inicie con la misma cuenta de Windows que utilizó para ejecutar cmdkey.

Ejecute Windows Service Manager (services.msc).
En las propiedades de Services, abra ABBYY FlexiCapture Connect.
En la pestaña Log On, seleccione This account e introduzca las credenciales de su cuenta de Windows.

Captura de pantalla de la pestaña Log On en las propiedades del servicio ABBYY FlexiCapture Connect, con This account seleccionado y las credenciales de la cuenta de Windows introducidas.

Eliminar credenciales de Windows Vault

Abrir Credential Manager

Abra Credential Manager.

Eliminar la credencial

En la pestaña Windows Credentials, expanda la credencial que desea eliminar y haga clic en Remove.

Captura de pantalla de la pestaña Windows Credentials en Credential Manager, con una credencial expandida y la opción Remove disponible.

Configurar las rutas de exportación del proyecto

Para usar ABBYY FlexiCapture Connect para exportar archivos desde ABBYY FlexiCapture Cloud, ajuste las rutas de exportación del proyecto.

Borre la ruta raíz de exportación

En la pestaña General del cuadro de diálogo Propiedades de <project>, asegúrese de que el campo Ruta raíz de exportación esté vacío. Para obtener más información, consulte Propiedades del proyecto.

Captura de pantalla de la pestaña General del cuadro de diálogo Propiedades del proyecto, con el campo Ruta raíz de exportación vacío.

Especifique una ruta de exportación relativa

En el cuadro de diálogo Configuración de exportación, especifique la ruta de exportación relativa a la ruta raíz indicada en la pestaña General del cuadro de diálogo Propiedades de <project>. Como esta ruta raíz está vacía, especifique el directorio sin la ruta raíz exacta.

Captura de pantalla del cuadro de diálogo Configuración de exportación, con la ruta de exportación especificada en relación con una ruta raíz vacía.

La opción If file exists se ignora. Cuando los archivos se exportan desde ABBYY FlexiCapture Cloud mediante ABBYY FlexiCapture Connect, se crea un archivo nuevo para cada documento nuevo.

Limitaciones de ABBYY FlexiCapture Connect

Solo se pueden sincronizar conjuntos de datos de hasta aproximadamente 500 000 registros.
Mientras se actualiza un conjunto de datos, los usuarios no pueden buscar proveedores en las estaciones web.
ABBYY FlexiCapture Connect no reconoce perfiles de importación de Hot Folder basados en la configuración del proyecto.
ABBYY FlexiCapture Connect exporta documentos de todos los lotes disponibles en el servidor. La configuración del proyecto no afecta al nombre del directorio de destino, que siempre tiene el mismo nombre que el lote de origen.
ABBYY FlexiCapture Connect solo puede exportar un lote completo. Si desactiva la opción Esperar a que estén todos los documentos en un lote en la configuración del flujo de trabajo del proyecto, los documentos siguen sin exportarse por separado.
ABBYY FlexiCapture Connect no puede exportar los resultados de todos los documentos de un lote a un único archivo. Se crea un archivo independiente en el directorio de exportación para cada documento del lote.
ABBYY FlexiCapture Connect no puede exportar los resultados de todos los lotes a un único archivo. Se crea un archivo independiente en el directorio de exportación para cada documento de cada lote.
El tamaño de los archivos importados y exportados está limitado a 199 MB.
No se admiten servidores proxy.

Solución de errores de ABBYY FlexiCapture Connect

Si encuentra un error, primero revise el archivo de registro, que puede encontrar en %LocalAppData%\ABBYY\FlexiCapture\Connect\Logs. Los errores también pueden deberse a ajustes incorrectos o incompletos especificados en el archivo de configuración, así que revise el archivo config.json por si hubiera alguna inconsistencia u omisión. Si el error persiste, póngase en contacto con el soporte técnico de ABBYY. Es posible que el soporte técnico le solicite tanto el archivo config.json como el archivo de registro.

​Requisitos del sistema

​Instalar y configurar ABBYY FlexiCapture Connect

​Referencia del archivo de configuración

​Configuración general

​Configuración del proyecto

​Configuración de importación

​Configuración de exportación

​Configuración de Definición de Document

​Configuración de sincronización del conjunto de datos

​Almacenar las credenciales de la cuenta de servicio en Windows Vault

​Agregar credenciales a Windows Vault

​Eliminar credenciales de Windows Vault

​Configurar las rutas de exportación del proyecto

​Limitaciones de ABBYY FlexiCapture Connect

​Solución de errores de ABBYY FlexiCapture Connect