Características especiales de ABBYY FlexiLayout Studio para crear FlexiLayouts adicionales

Cree FlexiLayouts adicionales para facturas con ABBYY FlexiLayout Studio: consulte conjuntos de datos con funciones como RecordOfFCDataset y use archivos de parámetros XML.

ABBYY FlexiLayout Studio incluye varias características especiales para desarrollar FlexiLayouts adicionales para proyectos de facturas:

• Puede especificar la ubicación de los elementos en relación con las regiones de campo detectadas al aplicar el FlexiLayout principal del proyecto de facturas.
• Puede usar identificadores de proveedores y unidades de negocio en solicitudes al conjunto de datos de la Definición de Document.
• Puede exportar listas de palabras clave y otros parámetros del FlexiLayout a un archivo XML. Después, puede editarlas sin modificar el FlexiLayout ni la Definición de Document.

​

Crear un FlexiLayout adicional

1. Abrir un lote en FlexiCapture

   Abra en FlexiCapture un lote que contenga facturas reconocidas.

2. Crear un proyecto de FlexiLayout Studio

   Cree un nuevo proyecto en ABBYY FlexiLayout Studio. En el menú principal, seleccione Herramientas → Export Batch to FlexiLayout Studio → Create New FlexiLayout Studio Project….

   Este comando solo está disponible para proyectos de FlexiCapture almacenados en su equipo. En una instalación distribuida, si el proyecto está almacenado en el servidor, descárguelo primero en su equipo. Para ello, haga clic en Export Project… en el menú Project.

El nuevo proyecto de ABBYY FlexiLayout Studio contiene todos los documentos del lote de FlexiCapture, así como las regiones de campo detectadas durante el reconocimiento, en forma de reference layout. El sufijo del nombre del proyecto indica la versión que tenía la Definición de Document en el momento de crear el proyecto.

Árbol	Nodo	Descripción
SearchElements	CommonBlockRegions	Contiene elementos que corresponden a todos los campos de la Definición de Document. El proyecto de ABBYY FlexiLayout Studio guarda las coordenadas de todas las regiones de bloque detectadas al aplicar los FlexiLayouts a cada documento en FlexiCapture. De forma predeterminada, las regiones con estas coordenadas se asignan a elementos con los mismos nombres que los campos de la Definición de Document. Puede usarlas para especificar las ubicaciones relativas de los elementos y para crear elementos nuevos.
SearchElements	CustomSearchElements	Contiene elementos de ejemplo, que están deshabilitados de forma predeterminada para que no interfieran al aplicar el FlexiLayout. DataSetRequestSample es un ejemplo de solicitud al conjunto de datos de proveedores y unidades de negocio almacenado en la Definición de Document. Este conjunto de datos incluye los identificadores de proveedores y unidades de negocio.

​

Cómo agregar un campo a un FlexiLayout adicional

Para agregar un campo a un FlexiLayout adicional, cree un bloque para el campo y especifique su elemento de búsqueda. Los campos de la Definición de Document deben tener nombres únicos, así que asigne un nombre al bloque según lo que desee hacer:

Para	Cree un bloque con
Definir la lógica de búsqueda de un campo nuevo	Un nombre único
Cambiar la lógica de búsqueda de un campo que ya existe en la Definición de Document	El mismo nombre que ese campo

​

Agregar páginas a un FlexiLayout adicional

Para probar los cambios realizados en un FlexiLayout adicional con imágenes nuevas, exporte lotes de FlexiCapture a un proyecto de facturas existente en ABBYY FlexiLayout Studio. Para ello, haga clic en Herramientas → Export Batch to FlexiLayout Studio → Add to Existing FlexiLayout Studio Project….

Solo puede exportar lotes de FlexiCapture a proyectos de ABBYY FlexiLayout Studio que se hayan creado con el comando Create New FlexiLayout Studio Project…. Cada lote de FlexiCapture exportado se convierte en un lote nuevo del proyecto de ABBYY FlexiLayout Studio.

​

Exportar campos agregados después de crear el proyecto

La nueva Definición de Document puede tener más campos que la que se usó en el proyecto de ABBYY FlexiLayout Studio. En ese caso, el registro de exportación incluye una advertencia por cada campo adicional. Para exportar los campos adicionales, agregue por cada uno un bloque con el mismo nombre en el nodo CommonBlockRegions del árbol SearchElements.

​

Realizar solicitudes a conjuntos de datos desde la Definición de Document

Puede encontrar una solicitud de ejemplo en el elemento DataSetRequestSample. Este elemento está deshabilitado de forma predeterminada.

​

Tipo NamedValue

Un valor con nombre.

Constructor: NamedValue( String, String )

Método	Descripción
String Name()	Devuelve el nombre de un valor con nombre.
String Value()	Devuelve el valor de un valor con nombre.

​

Tipo NamedValueArray

Un array de valores con nombre.

Constructores:

• NamedValueArray()
• NamedValueArray( NamedValue namedValue )

Método	Descripción
Int Count()	Devuelve el número total de elementos del array.
NamedValue GetAt( Int index )	Devuelve el elemento con el número de índice especificado.
Void Add( NamedValue namedValue )	Agrega un valor con nombre al array.
Void Add( NamedValueArray namedValueArray )	Agrega un array de valores con nombre a otro array de valores con nombre.
Void InsertAt( Int index, NamedValue namedValue )	Inserta el valor con nombre en la posición indicada por el índice.
Void DeleteAll()	Elimina todos los elementos de un array.
Void DeleteAt( Int index )	Elimina el elemento en la posición indicada por el índice.
Int FindByName( String name )	Devuelve la posición del valor con el nombre especificado.

​

Parámetros de la función

Parámetro	Descripción
connectionString	La cadena de conexión, con el formato "dbtype=FCDataset;fcTemplate=path_to_Document_Definition;datasetName=name_of_Data_Set;". Separe las partes de la ruta con barras invertidas dobles (\\). En ABBYY FlexiLayout Studio, para acceder al conjunto de datos se utilizan la ruta a la Definición de Document y el nombre del conjunto de datos. Una vez que se agrega un FlexiLayout compilado a una Definición de Document en FlexiCapture, solo se utiliza el nombre del conjunto de datos.
searchFields	Un array con los nombres de las columnas de las que se obtendrán los valores.
searchCriteria	Un array de pares Columna-Entrada. Si el array está vacío, se devuelven todos los valores.

Cuando una solicitud en searchCriteria contiene varios valores, combínelos con los operadores OR y AND:

La solicitud contiene	Use
Varios valores para un mismo campo	OR
Varios valores, cada uno correspondiente a un único campo	AND
Varios valores para un mismo campo y valores para varios campos	OR entre los valores de un mismo campo y AND entre los campos

​

Funciones

Función	Descripción
Logic TestAccessToFCDataSet( String connectionString )	Prueba la conexión con el conjunto de datos.
Logic TestFCDataSetSearchCriteria( String connectionString, StringArray searchFields, NamedValueArray searchCriteria )	Prueba las condiciones de búsqueda para el conjunto de datos.
StringArray FieldNamesOfFCDataset( String connectionString )	Devuelve una lista de todos los campos del conjunto de datos, ordenados de forma ascendente por sus números de índice.
StringArray FieldNamesOfFCDataset( String connectionString, StringArray searchFields )	Devuelve una lista de campos del conjunto de datos especificado, en orden ascendente de sus números de índice. Úsela junto con la función RecordOfFCDataset cuando haya columnas complejas.
Int RecordCountOfFCDataset( String connectionString, StringArray searchFields, NamedValueArray searchCriteria )	Devuelve el número de entradas del conjunto de datos que coinciden con las condiciones de búsqueda. Úsela para averiguar cuántas entradas puede devolver la función RecordOfFCDataset.
Void PrepareRecordsetOfFCDataset( String connectionString, StringArray searchFields, NamedValueArray searchCriteria, Int maxRecordsCount = DefaultMaxRecordsCount )	Prepara los datos para una consulta al conjunto de datos. Llámela para cada nuevo conjunto de condiciones de búsqueda antes de llamar a la función RecordOfFCDataset.
StringArray RecordOfFCDataset( String connectionString, StringArray searchFields, NamedValueArray searchCriteria, Int rowIndex )	Devuelve un array de valores de la entrada con el número rowIndex en los resultados de una consulta al conjunto de datos. El número de valores es igual al número de campos pasados en searchFields, incluido el caso de columnas complejas.
Quality ValidateByFCDataSet( String word, String connectionString, Int fieldIndex, NamedValueArray searchCriteria, Int maxErrors, Rational maxErrorsPart, Logic ignoreSpaces = true, Int maxRecordsCount = DefaultMaxRecordsCount )	Devuelve la calidad de la cadena word. Acepta números de índice de campos. Puede obtener los números de índice indexando la salida de la función FieldNamesOfFCDataset.
Void SearchTextFromFCDataSet( String connectionString, Int fieldIndex, NamedValueArray searchCriteria, Int maxRecordsCount = DefaultMaxRecordsCount )	Especifica condiciones de búsqueda de palabras para la función texto estático. Cada llamada reemplaza las condiciones de búsqueda existentes por otras nuevas. Acepta números de índice de campos. Puede obtener los números de índice indexando la salida de la función FieldNamesOfFCDataset.
Void RegularExpressionFromFCDataSet( String connectionString, Int fieldIndex, NamedValueArray searchCriteria, Int maxRecordsCount = DefaultMaxRecordsCount )	Especifica condiciones de búsqueda mediante expresiones regulares para la función CharString. Cada llamada reemplaza las condiciones de búsqueda existentes por otras nuevas. Acepta números de índice de campos. Puede obtener los números de índice indexando la salida de la función FieldNamesOfFCDataset.

​

Buscar en una imagen filas de una columna de una base de datos externa

1. Listar las columnas

   Use FieldNamesOfFCDataset para obtener una lista de columnas ordenadas de forma ascendente por sus números de índice.

2. Buscar el índice de la columna

   Determine el número de índice de la columna en la que necesita buscar datos.

3. Crear el filtro

   Cree un array de condiciones para filtrar datos del conjunto de datos.

4. Ejecutar la búsqueda

   Pase los números de índice de la columna y las condiciones del filtro a SearchTextFromFCDataSet (o a RegularExpressionFromFCDataSet, si necesita usar expresiones regulares).

Este código se genera automáticamente cuando se exporta un lote reconocido desde FlexiCapture.

​

Buscar entradas de varias columnas en una imagen

Cada llamada a la función SearchTextFromFCDataSet sustituye los parámetros de búsqueda, por lo que llamarla repetidamente no produce ningún efecto. Como alternativa, obtenga cadenas de una base de datos externa y páselas a la función SearchText. SearchText añade cada cadena a los parámetros de búsqueda existentes en lugar de sustituirlos.

1. Enumerar las columnas

   Cree un array con los nombres de las columnas en las que necesita buscar datos.

2. Crear el filtro

   Cree un array de condiciones de filtro para filtrar datos del conjunto de datos.

3. Contar las entradas

   Determine el número de entradas que se devuelven mediante la función RecordCountOfFCDataset.

4. Preparar la consulta

   Prepare los datos de la consulta mediante la función PrepareRecordsetOfFCDataset.

5. Leer cada registro

   Recorra todos los registros y obtenga el array de cada registro mediante el método RecordOfFCDataset.

6. Pasar los valores a SearchText

   Pase el valor de cada elemento del array a la función SearchText.

​

Columnas complejas

Una columna compleja de un conjunto de datos se almacena como varias columnas en la base de datos externa codificada. En los siguientes ejemplos, la columna compleja Name se almacena como tres columnas, por lo que los campos del conjunto de datos son {VendorId, VATID, Name, Name, Name, City}.

Función o parámetro	Comportamiento con una columna compleja
FieldNamesOfFCDataset	Devuelve el nombre de la columna compleja una vez por cada instancia de columna de la base de datos externa codificada; por ejemplo, {VendorId, VATID, Name, Name, Name, City}.
searchCriteria	Una condición definida para un campo que corresponde a una columna compleja se comprueba en todas sus instancias de columna.
searchFields	Si searchFields incluye un campo que corresponde a una columna compleja, el resultado contiene los valores de cada instancia de columna. Por ejemplo, si se solicita { VATID, Name, City}, se devuelve {VATID_value, Name_valueInColumn1, Name_valueInColumn2, Name_valueInColumn3, City_value}.

Para obtener la lista de columnas que devuelve una solicitud, pase el array searchFields a la función FieldNamesOfFCDataset.

​

Haga una solicitud a un archivo XML que contenga la configuración de FlexiLayout

Puede realizar solicitudes a un archivo XML con la configuración de FlexiLayout mediante dos funciones estándar descritas en la documentación de ABBYY FlexiLayout Studio:

StringArray ReadFromXML(String filename, String xPathQuery)
String ReadSingleStringFromXML(String filename, String xPathQuery)

Para usar este archivo al trabajar con un FlexiLayout en ABBYY FlexiLayout Studio, colóquelo en la carpeta del proyecto o en una de sus subcarpetas. La ruta del archivo es relativa al archivo de proyecto de ABBYY FlexiLayout Studio.

Si carga un FlexiLayout compilado en una Definición de Document de FlexiCapture y lo usa como FlexiLayout adicional, el archivo XML se coloca en la carpeta Templates. Puede editarlo allí. Cuando se aplica el FlexiLayout, el programa gestiona automáticamente el acceso a este archivo.