Saltar al contenido principal

Flujo de trabajo de la REST API

El flujo de trabajo típico de la REST API es el siguiente: Cualquier proyecto de FlexiCapture que vaya a utilizarse con una aplicación basada en la REST API debe incluir un flujo de trabajo correctamente configurado. A continuación, encontrará instrucciones paso a paso sobre cómo adaptar el flujo de trabajo del proyecto de ejemplo Banking Card Application para usarlo con la REST API (para obtener más información sobre los proyectos de ejemplo, consulte la sección ABBYY FlexiCapture sample projects). Antes de continuar con esta guía, inicie Project Setup Station y abra el proyecto de ejemplo Banking Card Application (la ubicación predeterminada es C:\Users\Public\ABBYY\FlexiCapture\12.0\Samples\FlexiCapture\English\Banking_eng\banking_eng.fcproj).

Ajustar las etapas del flujo de trabajo

La REST API siempre envía los datos para su procesamiento como tipo de lote “Predeterminado”. Por este motivo, todo el procesamiento de documentos del proyecto debe configurarse para el tipo de lote “Predeterminado”.
  1. En el menú Project, haga clic en Project Properties y luego en la pestaña Workflow. En la lista desplegable Schema, seleccione Advanced y modifique la configuración del flujo de trabajo como se muestra a continuación:
  1. Haga clic en VerificationGeneral y seleccione la opción Enable web stations. Nota: Puede omitir esta configuración si no necesita una etapa de verificación en su proyecto.
  2. Haga clic en VerificationEntry Conditions y establezca la opción Documents are admitted to stage en Always. Nota: Según los requisitos de su solución, puede que desee deshabilitar temporalmente la etapa de verificación o hacerlo de forma condicional mediante una regla basada en scripts en la pestaña Entry Conditions.
  1. Para habilitar el endpoint training/layout/{taskId}/{fileId} en su proyecto, debe exportar el archivo XML que contiene los datos del campo y el diseño. Para hacerlo:
    1. Cree una etapa de procesamiento de documentos inmediatamente anterior a la etapa de verificación:
  1. En la pestaña Entry Conditions, seleccione Always.
  1. En la pestaña Script, haga clic en el botón Edit script…. : 4. Cambie el lenguaje de script a C# .NET:
  1. Copie y pegue el siguiente fragmento de código en el panel de script:
using System;
Document.SaveXmlToFileStorage();
  1. Haga clic en OK para guardar sus cambios.
La configuración del proyecto para el ensamblado de documentos (Procesamiento de imágenes → Crear documento) no se aplica al cargar archivos mediante la REST API. Se creará un documento independiente para cada archivo.

Ajustar la configuración de exportación de datos

Una vez procesado un lote enviado a través de la REST API, la REST API recuperará los archivos exportados para ponerlos a disposición del cliente para su descarga.
ABBYY FlexiCapture Cloud almacena los archivos exportados en un almacenamiento de objetos. Por esta razón, no debe usar rutas de exportación absolutas en su proyecto de REST API.
Los proyectos de REST API no requieren ninguna estructura de carpetas especial. Puede usar una estructura de carpetas plana, con el nombre de la carpeta raíz para cada lote y los ID de los documentos como parte de los nombres de archivo. Los servicios de la REST API asignarán a cada lote enviado a través de la REST API un nombre de lote único y aleatorio. De este modo, se generarán nombres de archivo únicos al exportar datos de lotes enviados a través de la REST API. La siguiente captura de pantalla muestra la configuración de exportación original, que da como resultado una estructura de carpetas de varios niveles: La siguiente captura de pantalla muestra la configuración de exportación modificada, que da como resultado una estructura de carpetas plana:

Carga de su proyecto modificado en ABBYY FlexiCapture Cloud

  1. Haga clic en Archivo > Upload Project to Server… para cargar su proyecto en ABBYY FlexiCapture Cloud.
  2. En el cuadro de diálogo que se abre, introduzca la URL del servidor en la nube que aloja su tenant y especifique el nombre de este.
  3. Seleccione Use server authentication e introduzca las credenciales de administrador de su tenant.
  4. Haga clic en Test connection para comprobar la configuración de conexión.
  5. Haga clic en OK y espere a que se cargue su proyecto.

Próximos pasos

Una vez que haya cargado su proyecto en ABBYY FlexiCapture Cloud, esto es lo que puede probar a continuación:
  1. Cree una aplicación conectada a su proyecto. Para obtener más información sobre cómo hacerlo, consulte Creación de aplicaciones mediante la interfaz REST API de FlexiCapture.
  2. Para comprobar que ha conectado correctamente su aplicación, procese un lote de muestra.
  3. Si tiene algún problema, consulte Diagnóstico de errores de procesamiento.