Extractor de forma

UiPath.IntelligentOCR.Activities.DataExtraction.FormExtractor

Descripción

Nota:

Due to licensing purposes, the Form Extractor activity requires an Internet connection to run the robot.

El Extractor de formularios es el más adecuado para extraer, hacer coincidir y notificar información específica analizando la posición de la palabra dentro del documento o detectando una firma. Esta actividad solo se puede utilizar junto con la actividad Ámbito de extracción de datos . El texto escrito a mano también puede detectarse si la actividad Extractor de formularios se utiliza junto con la actividad UiPath Document OCR .

Compatibilidad de proyectos

Windows-Legacy | Windows

Configuración

Panel de propiedades

Común

• Nombre para mostrar: el nombre para mostrar de la actividad.

Entrada

• ApiKey - Specifies the API key of the account. The API Key field is automatically pre-populated if defined in local project settings or in the Document Understanding framework.
• Punto final : la URL del servidor UiPath®. De forma predeterminada, el punto final es https://du.uipath.com/svc/formextractor. Para obtener más información, consulta Puntos finales públicos de Document Understanding.
• MinOverlapPercentage - Specifies the minimum overlap area (in percentage) between a box in the document and a box in the template required to make an extraction. The percentage value can be set between 0 and 100. The default value is 65.
• Timeout - Specifies the amount of time (in milliseconds) to wait for a response from the server before an error is thrown. The default value is 100000 milliseconds (100 seconds).

Otros

• Privado : si se selecciona, los valores de variables y argumentos ya no se registran en el nivel Detallado.
  Nota:

  Multiple templates can be defined for one Document Type. When the activity is run, the extractor selects the best matching template based on the information found on the first page.

Asistente del Administrador de plantillas

Te permite crear, editar, gestionar y exportar/importar plantillas para los tipos de documento definidos en la taxonomía.

Crear una plantilla

1. Add a Form Extractor activity to your workflow, within a Data Extraction Scope.

2. Configura el extractor seleccionando Gestionar plantillas.

   The Template Manager window opens.

   Figura 1. Descripción general del asistente Gestor de plantillas

   

3. Selecciona Crear plantilla para crear una nueva plantilla. Figura 2. Descripción general de los campos Crear una nueva configuración de plantilla

   

   Nota:

   Si el paquete UiPath.IntelligentOCR.Activities se ha actualizado a v5.1.0, el parámetro ForceApplyOCR se ha reemplazado por el ApplyOcrOnPDF. Aquí está la compatibilidad entre los parámetros antiguos y nuevos:

   • ForceApplyOCR = True se reemplaza por ApplyOcrOnPDF = Yes;
   • ForceApplyOCR = False se reemplaza por ApplyOcrOnPDF = Auto;
   • ForceApplyOCR = Vacío se reemplaza por ApplyOcrOnPDF = Auto;
   • ForceApplyOCR = <user-defined variable> se reemplaza por ApplyOcrOnPDF = Auto.

   La opción Aplicar OCR en PDF establece si el proceso OCR debe aplicarse o no a los documentos PDF. Hay tres opciones disponibles en la lista desplegable: Verdadero, Falso y Automático. Si se establece en Verdadero, el OCR se aplica a todas las páginas PDF del documento. Si se establece en Falso, solo se extrae el texto escrito digitalmente. El valor predeterminado es Automático, que determina si el documento requiere aplicar el algoritmo OCR en función del documento de entrada. Cada motor OCR viene con su propio conjunto de opciones personalizadas. Consulta Motor OCR para obtener más información sobre todas las opciones disponibles para cada motor OCR. El motor OCR predeterminado es UiPath Document OCR.

4. Select the document type for your template from the Document Type dropdown list.

   Nota:

   All Document Types are based on the Taxonomy. Make sure to add or create a taxonomy inside the project's folder.

5. Add the name of the template in the Template name field. Choose a relevant name that reflects the version or the layout of your document.

6. Añade la ruta del documento en el campo Documento de plantilla . Navega hasta la ruta del archivo utilizando la opción Explorar .

7. Selecciona un OCR de la lista desplegable Motor OCR, y configúralo en función de sus necesidades.

8. Selecciona Configurar para desencadenar la edición de plantillas.

Si ya has creado una plantilla, puede ser editada, exportada o eliminada.Las opciones Eliminar y Exportar solo están disponibles cuando se selecciona al menos una plantilla. Las opciones Editar y Eliminar para una plantilla individual están siempre disponibles.

Figura 3. Imagen animada de la selección de las opciones Eliminar o Exportar para una plantilla

Configurar el procesamiento de campos booleanos

Para los documentos que incluyen casillas de verificación, puedes añadir sinónimos conocidos para las opciones Sí y No , o puedes empezar desde una lista compilada por UiPath® (selecciona Añadir recomendados). Estos valores se utilizan para la interpretación de contenido Boolean , que asigna un valor capturado a un valor informado Sí o No.

Figura 4. Imagen animada que muestra la sugerencia generada después de seleccionar Añadir recomendado para los campos Sinónimos para Sí y Sinónimos para No

Nota:

La casilla de verificación Distingue entre mayúsculas y minúsculas debe marcarse si los sinónimos que has añadido distinguen entre mayúsculas y minúsculas.

Exportar e importar plantillas

You can import templates created and exported from other workflows. Use these features to share templates between projects. Once a document type is configured using the Form Extractor, you don't need to reconfigure the templates in a new implementation.

Procedimiento de exportación

Estos son los pasos que debes seguir para exportar una plantilla:

1. Crea una o varias plantillas siguiendo los pasos explicados al principio de esta página.

2. Selecciona las plantillas que quieres exportar.

3. Selecciona una opción Exportar:

   1. Exportar con archivos originalesLa exportación con archivos originales los adjunta a la exportación.

   2. Exportar sin archivos originales

      Figura 5. La acción de seleccionar las opciones Exportar con archivos originales

      

4. Guarda el archivo de la plantilla con el nombre deseado.

5. Una vez guardada la plantilla, aparece un mensaje. Selecciona Aceptar.

   Figura 6. El mensaje de las plantillas "X" exportadas correctamente

   

   Nota:

   Si no puedes compartir el contenido de los documentos en los que has creado tus plantillas, utiliza la opción Exportar sin archivos originales. Podrás seguir compartiendo e importando el archivo de plantilla en otros proyectos, pero ya no podrás editarlas ni verlas.

   Si deseas editar las plantillas una vez importadas en un proyecto diferente, asegúrate de utilizar la opción Exportar con archivos originales al exportar y luego importarlas.

Procedimiento de importación

Estos son los pasos que debes seguir para importar una plantilla:

1. Seleccionar Importar.

   Figura 7. La acción de seleccionar Importar en el asistente Gestor de plantillas

   

2. Selecciona un archivo. Aparece el asistente de importación y muestra todos los tipos de documentos y todas las plantillas disponibles en el archivo de exportación seleccionado. Selecciona las plantillas que deseas importar y elige la opción de Importar deseada:

   1. Importar con archivos originales

   2. Importar sin archivos originalesFigura 8. Las opciones de importación en el asistente Gestor de plantillas

      

      Nota:

      • Cuando se importan plantillas, los tipos de documento se crean automáticamente en la taxonomía del proyecto. Si un ya existe un tipo de documento con el mismo nombre, se creará otro añadiendo un número al nombre del tipo de documento.
      • Si estás importando plantillas que han sido exportadas sin los archivos originales, o si eliges importar plantillas sin los archivos originales, entonces no dispondrás de opciones de visualización o edición para esas plantillas.

Situaciones especiales al importar una plantilla

Cuando se importa una plantilla, pueden ocurrir varias situaciones especiales. La siguiente lista explica cada situación y sus particularidades:

• Nuevo tipo de documento: si se importa un nuevo tipo de documento, se añade un nuevo campo en el configurador del asistente, informándote de que se debe crear una nueva plantilla.
• Tipo de documento duplicado: si se importa un tipo de documento idéntico, aparece el siguiente mensaje de advertencia: "Esta plantilla ya existe y se sobrescribirá".
• Plantilla ampliada: si se importa una plantilla de tipo de documento que incluye campos adicionales a los ya existentes, aparece el siguiente mensaje de advertencia: "Este tipo de documento se actualizará de la siguiente manera: los siguientes campos no existen y se creado".
• Tipo de documento extendido: si el usuario importa un tipo de documento que incluye campos adicionales a los ya existentes, aparece el siguiente mensaje de advertencia: "Este tipo de documento se actualizará de la siguiente manera: los siguientes campos no tienen configuraciones para importar".
• Tipo de documento con nombre idéntico pero contenido diferente: si el usuario importa un tipo de documento que tiene el mismo nombre que el existente pero campos diferentes, aparece el siguiente mensaje de advertencia: "Este tipo de documento se actualizará de la siguiente manera":
  • "Los siguientes campos no existen y se crearán"
  • "Los siguientes campos no tienen configuraciones para importar"
• Tipo de documento con tabla faltante: si el usuario importa un tipo de documento que no incluye una tabla, aparece el siguiente mensaje de advertencia: "Este tipo de documento se actualizará de la siguiente manera: los siguientes campos no tienen configuraciones para importar".
• Tipo de documento con tabla ampliada: si el usuario importa un tipo de documento que incluye una tabla con columnas adicionales, aparece el siguiente mensaje de advertencia: "Este documento se actualizará de la siguiente manera: los siguientes campos no existen y se crearán ".
• Tipo de documento con tabla reducida: si el usuario importa un tipo de documento que incluye una tabla con columnas faltantes, aparece el siguiente mensaje de advertencia: "Este documento se actualizará de la siguiente manera: los siguientes campos no tienen configuraciones para importar "
• Plantilla de tabla con diferentes tipos de documentos: si importas una plantilla de tipo de documento que incluye una tabla con diferentes tipos de documentos, se crea una nueva plantilla. Si tu taxonomía incluye una tabla que tiene un campo con un tipo de documento diferente, aparece el siguiente mensaje: "El campo con ID xyz se encontró tanto en la taxonomía importada como en la taxonomía existente, pero sus tipos son incompatibles ambos deben ser tablas o ninguno de ellos)."

Asistente del Editor de Plantillas

Consideraciones generales

El Editor de plantillas se basa en la funcionalidad presente en la estación de validación. Para acceder a ella, selecciona Editar para una plantilla.

Consulta Estación de validación para obtener más información sobre el uso básico de la estación de validación.

Además de las opciones disponibles en la parte derecha de la pantalla de la Estación de validación, hay dos opciones específicas para el editor de plantillas:

• : establece el modo de selección de anclaje;
• : borra toda la selección de anclaje.

Al crear una nueva plantilla, aparece un texto explicativo cuando se abre por primera vez el Editor de plantillas. En caso de que desees acceder al texto de nuevo, ve a la sección de vista de documentos en el lado derecho, selecciona Más opciones y luego Mostrar texto de explicación.

Figura 9. La acción de mostrar el texto de explicación

La información de la tabla puede modificarse en el nivel de celda o tabla. Consulta Estación de Validación Actual para obtener más información sobre cómo configurar tablas en el nivel de celda y en el nivel de tabla.

Configurar anclajes

Anchors can be defined once the Template Editor is opened from the Template Manager and can be found among the Selection Mode options.

When defining or editing a page-level template, although it is optional, the first thing that needs to be performed is the Page 1 Matching Info selection. This step is mandatory only for fixed form templates.

Situated on the left side of the screen, the Page 1 Matching Info selection requires a text input (tokens only are accepted) from the first page of the template that is always in the same position within that particular template layout and forms a unique graph of words (considering relative distances and angles between words) across all the templates defined for a particular document type.

In other words, the Page 1 Matching Info (and all other Page Matching Info fields) are "fingerprints" of a particular page and are extensively used in identifying the right matching template at runtime.

For this reason, for the Page 1 Matching Info field, it is strongly recommended to select 10 to 20 words, preferably longer, spread across the entire page area.

The other Page Matching Info fields (one for each template page) must be filled in only if you are attempting data extraction from that particular page, and do not require cross-template uniqueness anymore. If no fields need to be extracted from a particular page, defining the page-level matching info for that page is not mandatory.

Configurar campos simples

En el caso de los campos que no sean Tablas, la configuración de la plantilla consiste en seleccionar un Área personalizada y asignarla a un campo concreto.

For fixed form configurations, data fields can only be configured using Custom Area selections.

Para un campo, puedes definir una o más de tales Áreas personalizadas, utilizando el botón Añadir. Si se definen dos o más Áreas personalizadas para un único campo, en tiempo de ejecución, si el campo se define en la Taxonomía como Valor único, todos los valores se concatenan en un único valor notificado. Si el campo está definido como Varios valores, cada valor se notificará de manera individual.

El icono junto a cada campo indica el tipo de selección compatible: tokens o área personalizada.

Figura 10. Imagen animada que muestra los tipos de selecciones compatibles para campos de muestra

Nota:

If an empty area is selected, the selection is automatically set as Custom area. If text is detected inside the selected area, you are asked to choose the type of the selection between Tokens or Custom area.

Use the Validation Station selection mode feature to lock your selection between Tokens and Custom Areas.

Configurar tablas

Como ya se ha mencionado, hay campos en los que solo puede añadirse información mediante Tokens (como los campos Información de coincidencia de páginas) o solo utilizando un Área personalizada (como campos simples). Para los campos Tabla, puedes hacer lo siguiente:

• Define cada celda una a una, una vez que se expande el Editor de tabla: añadiendo la selección Área personalizada a cada celda individualmente;
• utiliza la funcionalidad de marcado de tablas que marca el área de la tabla, dibuja separadores de filas y columnas, y luego, asigna la tabla así marcada al campo. Asegúrate de que el área extraída tiene el mismo número de columnas y filas que el área de la plantilla.

Para utilizar la funcionalidad de marcado de tabla:

1. Selecciona Más opciones para el campo de tabla
2. Selecciona Extraer nueva tabla.
3. Selecciona la tabla que deseas extraer.
4. Para cada campo sobre cada columna de tabla, selecciona el nombre de la columna que deseas que represente. También puedes elegir Extraer encabezado.
5. Por último, selecciona Guardar nueva tabla.

Figura 11. Imagen animada de un ejemplo utilizando la funcionalidad de marcado de tabla

Configuración de anclajes

Un método distintivo para definir los límites de un área personalizada de la que se extraerán datos es utilizar anclajes de campo. Estos permiten orientar la extracción de datos en función de las configuraciones a nivel de campo, lo que permite una mayor flexibilidad a la hora de definir las reglas de extracción de formularios.

En consecuencia, en tiempo de ejecución, el Extractor de Formularios sabe cómo realizar lo siguiente:

• identificar si coincide una plantilla de nivel de página, y extraer información acorde con la mejor correspondencia de plantilla de nivel de página que reconozca;
• identificar si coincide alguna configuración basada en anclajes, y extraer información según su aplicación en el documento que se va a procesar;
• calcular las puntuaciones de confianza adecuadas para todas las coincidencias posibles, a fin de poder notificar el mejor resultado (coincidencia de mayor probabilidad) de todas las opciones disponibles.

Crear una nueva configuración de anclaje

1. Make sure you are in the Anchor Selection mode.

2. Dibuja un cuadro alrededor del área de valor.

3. Selecciona una etiqueta (anclaje principal) para tu área de valor utilizando uno de los siguientes métodos:

   • Selecciona la primera palabra y luego utiliza Ctrl + Select para la última palabra de la selección.
   • Selecciona, arrastra y luego suelta para capturar un rango de palabras.
     Nota:

     A Label can only contain consecutive words from the same visual line.

4. Selecciona los anclajes adicionales que identificarían de forma exclusiva tu etiqueta. Se aplica el mismo principio de selección.

5. Assign your anchor construct to the appropriate field by selecting Extract Value for that particular field.

   Figura 12. Ejemplo de creación de varios anclajes para un campo

   

   Nota:

   También puedes utilizar los ejemplos anteriores de esta página para aprender a crear una plantilla y definir áreas de extracción y anclajes.

Editar una configuración de anclaje existente

1. Selecciona la configuración de anclaje.

2. Realiza cambios en ella (borra cualquier anclaje, la etiqueta, incluso el área de valor si lo deseas, añade nuevos elementos, etc.).

3. Selecciona Más opciones para un anclaje de campo y luego utiliza la opción Cambiar valor extraído para actualizar tu asociación de campo. Figura 13. Ejemplo de cambio del valor extraído para un campo

   

   Nota:

   • Si eliminas el área de destino, se borrarán todos los anclajes y tendrás que empezar de nuevo.
   • Si eliminas la Etiqueta (anclaje principal), el primer anclaje creado se convierte en la nueva Etiqueta.

Eliminar una configuración de anclaje existente

Para eliminar una configuración de anclaje, puede utilizar una de las siguientes opciones:

• Selecciona Más opciones para un anclaje de campo y utiliza la opción Marcar como Falta para un valor guardado.

  Figura 14. Ejemplo de uso de la opción Marcar como ausente para eliminar una configuración de anclaje

  

• Selecciona Más opciones para un anclaje de campo y utiliza la opción Eliminar valor, caso de una lista de anclajes definidos para un campo determinado.

  Figura 15. Ejemplo de uso de la opción Eliminar valor para eliminar una configuración de anclaje

  

Mezclar y combinar configuraciones

Puedes definir tantas plantillas como quieras para el mismo tipo de documento. Puedes tener múltiples plantillas a nivel de página, múltiples anclajes para el mismo campo, incluso plantillas que contengan tanto anclajes a nivel de página como a nivel de campo.

Nota:

• A la hora de definir anclajes a nivel de campo, asegúrate de que tu etiqueta está próxima a tu área de valor y de que cuenta con anclajes adicionales si la misma construcción de texto puede encontrarse en varios lugares dentro del mismo documento.
• Cuanto mayor sea la longitud de tus etiquetas y anclajes, más precisión obtendrás.
• El área de valor siempre se calcula en función de su posición relativa respecto a su etiqueta (anclaje principal).Así pues, elige tus anclajes principales en consecuencia.
• Disponer de anclajes a nivel de campo permite a los campos moverse dentro de la plantilla y seguir siendo captados, lo que ofrece mayor flexibilidad en los cambios de diseño del documento.

Integración de Document Understanding

La actividad Extractor de formularios forma parte de Document Understanding Solutions. Consulta la Guía de Document Understanding para obtener más información.