Intelligent Form Extractor

UiPath.IntelligentOCR.Activities.DataExtraction.IntelligentFormExtractor

Description

Importante:

The Intelligent Form Extractor activity is deprecated and out of support. It has been removed from its respective package, which means you can only use it in workflows where it was previously added before this deprecation.

While workflows that contain the Intelligent Form Extractor activity continue to function normally, you can't add the activity to any new workflows. We recommend using the Form Extractor activity instead.

Analyses, extracts, matches, and reports the required information from a document by taking into consideration the words' position, including handwritten and signed fields. This activity can be used only together with the Data Extraction Scope activity.

Observação:

Use os seguintes recursos para definir e configurar seu Intelligent Form Extractor:

• Template Manager wizard;
• Taxonomy Manager;
• Anchors setup and configuration.

Compatibilidade do projeto

Windows-Legacy | Windows

Propriedades

Painel de Propriedades

Comum

• DisplayName - O nome de exibição da atividade.

Entrada

• ApiKey - Specifies the API key of the account.
• Endpoint - The URL to UiPath® server. By default, the endpoint is https://du.uipath.com/svc/intelligentforms. For more information, visit Document Understanding Public Endpoints.
• 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).

Diversos

• Privado - Se selecionado, os valores de variáveis e argumentos não são mais registrados no nível Verbose.

  Importante:

  By using the cloud-based version of this document data extraction software with any UiPath® Community API Key, the documents processed with the software are stored and used by UiPath® along with any personal data they may contain for service monitoring. Documents processed using any UiPath® server endpoint with Enterprise API Keys are not stored by UiPath®. No documents are processed by UiPath® if the software is set up and used on your premises.

  Observação:

  Depois que um modelo é criado, a atividade pode exibir um aviso informando que o número permitido de áreas manuscritas permitidas em uma página pode ter sido excedido.

  O fluxo de trabalho ainda pode ser executado e um erro é gerado apenas se o número de áreas manuscritas tiver sido realmente excedido (mais de 60/página).

Assistente do Gerenciador de modelos

Permite criar, editar, gerenciar e exportar/importar modelos para os tipos de documentos definidos na taxonomia.

Criar um modelo

• Add an Intelligent Form Extractor activity to your workflow, within a Data Extraction Scope.

• Configure the extractor by selecting Manage Templates. The Template Manager window opens.

  Figure 1. Overview of the Template Manager wizard

  

• Select Create Template for creating a new template. Figure 2. Overview of the Create Template wizard

  

  Observação:

  If the UiPath.IntelligentOCR.Activities package has been updated to v5.1.0, then the ForceApplyOCR parameter has been replaced with the ApplyOcrOnPDF. Here is the compatibility between the old and new parameters:

  • ForceApplyOCR = True is replaced by ApplyOcrOnPDF = Yes;
  • ForceApplyOCR = False is replaced by ApplyOcrOnPDF = Auto;
  • ForceApplyOCR = Empty is replaced by ApplyOcrOnPDF = Auto;
  • ForceApplyOCR = <user-defined variable> is replaced by ApplyOcrOnPDF = Auto.

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

  Observação:

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

• 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.

• Add the document's path in the Template document field.

• Navigate to the file's path by using the Browse button.

• Select an OCR from the OCR Engine dropdown list, and configure it according to its needs.

• Select Configure to trigger the template editing. The Apply OCR on PDF option establishes if the OCR process should be applied or not to PDF documents. Three options are available in the dropdown list: True, False, and Auto. If set to True, the OCR is applied to all PDF pages of the document. If set to False, only digitally typed text is extracted. The default value is Auto, determining if the document requires to apply the OCR algorithm depending on the input document. Each OCR engine comes with its own set of custom options. Visit OCR engines for more details about all options available for each OCR engine. If you have already created a template, then it can be edited, exported, or removed. The Delete and Export options become available only when at least one template is selected. The Edit and Remove options for an individual template are always available.

Figure 3. Example of a configured template in the Template Manager wizard

Observação:

If a field is checked in both Signature and Handwritten boxes in the Template Manager of the Intelligent Form Extractor activity, then a pop-up message appears informing you that a field can be added only in one box, not both.

Configurando o processamento de campo booleano

For documents that include check boxes, you can add known synonyms for the Yes and No options, or you can start from a list compiled by us (see the Add recommended suggestions). These values are used for Boolean content interpretation, which is mapping a captured value to a Yes or No reported value.

Next to Synonym for Yes, and Synonym for No, select Add recommended to generate the suggestions.

Figure 4. Animated image showing the selection of Add recommended and generating suggestions

Observação:

The Case sensitive check box needs to be checked if the synonyms you have added are case sensitive.

Exportando e importando modelos

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 Intelligent Form Extractor, you don't need to reconfigure the templates in a new implementation.

Procedimento de exportação

Essas são as etapas que você precisa seguir para exportar um modelo:

1. Crie um ou mais modelos seguindo as etapas explicadas no início desta página.

2. Selecione os modelos que deseja exportar.

3. Select an Export option:

   1. Export with original filesExporting with original files attaches them to the export.

   2. Exportar sem arquivos originais

      Figure 5. The available Export options available in the Template Manager wizard

      

4. Salve o arquivo do modelo com o nome desejado.

5. A message is displayed once the template is saved. Select OK.

   Figure 6. The "X template(s) successfully exported" message

   

   Observação:

   If you cannot share the content of the documents you have built your templates on, then use the Export without original files option. You are still able to share and import the template archive in other projects, but you cannot edit or view them anymore.

   If you want to edit the templates once imported in a different project, make sure to use the Export with original files option when exporting and then importing them.

Procedimento de importação

Aqui estão as etapas que você precisa seguir para importar um modelo:

1. Selecionar Import.

   Figure 7. The action of selecting Import

   

2. Select an archive. The import wizard appears and presents all document types and all templates available in the selected export archive. Select the templates you wish to import and choose the right Import option:

   1. Importar com arquivos originais

   2. Import without original filesFigure 8. The available Import options in the Template Manager wizard

      

      Observação:

      • Quando os modelos são importados, os tipos de documento são criados automaticamente na Taxonomia do projeto. Se já existir um tipo de documento com o mesmo nome, outro será criado anexando uma contagem ao nome do tipo de documento.
      • Se estiver importando modelos que foram exportados sem os arquivos originais ou se optar por importar modelos sem os arquivos originais, você não terá opções de exibição ou edição para esses modelos.

Situações especiais ao importar um modelo

Quando um modelo é importado, várias situações especiais podem ocorrer. A lista a seguir explica cada tipo de importação e suas especificidades:

• New document type: If a new document type is imported, then a new field is added in the wizard configuration, informing you that a new template is to be created.

• Duplicate document type: If an identical document type is imported, then the following warning message appears: "This template already exists and it will be overwritten."

• Extended template: If a document type template that includes extra fields than the already existing one, is imported, then the following warning message appears: "This document type will be updated as follows: The following field(s) do not exist and will be created."

• Extended document type: If the user imports a document type that includes extra fields than the already existing one, then the following warning message appears: "This document type will be updated as follows: The following field(s) don't have configurations to import".

• Document type with identical name but different content: If the user imports a document type that has the same name as the existing one but different fields, then the following warning message appears: "This document type will be updated as follows":

  • "Os seguintes campos não existem e serão criados"
  • "Os seguintes campos não têm configurações para importar"

• Document type with missing table: If the user imports a document type that doesn't include a table, then the following warning message appears: "This document type will be updated as follows: The following field(s) don't have configurations to import."

• Document type with extended table: If the user imports a document type that includes a table with extra columns, then the following warning message appears: "This document will be updated as follows: The following field(s) do not exist and will be created."

• Document type with reduced table: If the user imports a document type that includes a table with missing columns, then the following warning message appears: "This document will be updated as follows: The following field(s) don't have configurations to import".

• Table template with different document types: If the user imports a document type template that includes a table with different document types, then a new template is created. If your taxonomy includes a table that has a field with a different document type, then the following message appears:

  O campo com id xyz foi localizado tanto na taxonomia importada quanto na taxonomia existente, mas seus tipos são incompatíveis (ambos ou nenhum devem ser tabelas).

Assistente do Editor de modelos

Considerações gerais

The Template Editor is built on top of the functionality present in the Validation station. To access it, select Edit for a template.

Visit Validation Station to learn about the basic usage of the Validation Station.

Besides the options available in the right part of the Validation Station screen, there are the following options in the Template Editor:

• : define o modo de seleção de âncora.
• : limpa toda a seleção de âncora

When creating a new template, an explanation text appears when first opening the Template Editor. In case you want to access the text again, go in the document view section on the right side, select More Options, and then Show explanation text.

Figure 9. The action of showing the explanation text

Configuração de âncoras

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.

Configurando campos simples

For all fields other than Tables, configuring the template consists of selecting a Custom Area and assigning it to a particular field.

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

For a field you can define one or more such Custom Areas, using the Add option. If two or more Custom Areas are defined for a single field, then at runtime, if the field is defined in the Taxonomy as Single Value, all values are concatenated into a single reported value. If the field is defined as Multi Value, then each value is reported individually.

The icon beside each field indicates the type of supported selection: Tokens or Custom area.

Figure 10. Animated image showing the types of supported selections for sample fields

Observação:

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.

Configurando tabelas

As mentioned above, there are fields where information can be added only by using Tokens (like the Page Matching Info fields) or only by using a Custom Area (like simple fields). For Table fields, you can do the following:

• Define each cell one by one, once the Table Editor is expanded, by adding Custom Area selection to each cell individually.
• Use a funcionalidade de marcação de tabela, marcando a área da tabela, separadores de linha de desenho e coluna e, em seguida, atribuindo a tabela assim marcada ao campo. Certifique-se de que a área extraída tenha o mesmo número de colunas e linhas que a área do modelo.

Para usar a funcionalidade de marcação de tabela:

1. Select More Options for the table field
2. Select Extract new table.
3. Selecione a tabela que você deseja extrair.
4. For every field above each table column, select the column name that you want it to represent. You can also choose to Extract header.
5. Lastly, select Save new table.

Figure 11. Animated image of an example using the table markup functionality

Configuração das âncoras

Um método distinto de definir os limites de uma área personalizada da qual os dados devem ser extraídos é usar âncoras no nível do campo. Isso permite direcionar a extração de dados com base em configurações de nível de campo, possibilitando assim mais flexibilidade ao definir suas regras de extração de formulário.

Consequently, at run-time, the Intelligent Form Extractor knows how to perform the following:

• identificar se um modelo de nível de página corresponde e extrair informações de acordo com a melhor correspondência de modelo de nível de página que ele reconhece;
• identificar se alguma configuração baseada em âncora corresponde e extrair informações de acordo com sua aplicação no documento a ser processado;
• calcule pontuações de confiança apropriadas para todas as correspondências possíveis para poder relatar o melhor resultado (a correspondência de maior probabilidade) de todas as opções disponíveis.

Criando uma nova configuração de âncora

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

2. Desenhe uma caixa ao redor da área de valor.

3. Selecione um Rótulo (âncora principal) para sua área de valor usando um dos seguintes métodos:

   • Selecione a primeira palavra e, em seguida, use Ctrl + Selectpara a última palavra da seleção.
   • Selecione, arraste e, em seguida, solte para capturar um intervalo de palavras.
     Observação:

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

4. Selecione qualquer âncora adicional que identificaria exclusivamente seu rótulo. O mesmo princípio de seleção se aplica.

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

   Figure 12. Example of creating multiple anchors for a field

   

   Observação:

   You can also use the previous examples from this page to learn how to create a template and define extraction areas and anchors.

Edite uma configuração de âncora existente

1. Destaque sua configuração de âncora.

2. Faça alterações (exclua quaisquer âncoras, o rótulo, até mesmo a área de valor, se desejar, adicione novos elementos, etc.).

3. Select More Options for a field anchor, and then use the Change Extracted Value option to update your field association. Figure 13. Example of changing the extracted value for a field

   

   Observação:

   • Se você excluir a área de destino, todas as âncoras serão excluídas e o processo deve ser reiniciado.
   • Se você excluir o rótulo (âncora principal), a primeira âncora na ordem em que foi criada se tornará o novo rótulo.

Excluir uma configuração de âncora existente

Para excluir uma configuração de âncora, você pode:

• Select More Options for a field anchor and use the Mark as Missing option for a saved value.

  Figure 14. Example of using the Mark as Missing option to delete an anchor setting

  

• Select More Options for a field anchor and use the Remove Value option, case of a list of anchors defined for a given field.

  Figure 15. Example of using the Remove Value option to delete an anchor setting

  

Configurações de combinação e junção

Você pode definir quantos modelos quiser para o mesmo tipo de documento. Você pode ter vários modelos de nível de página, várias âncoras para o mesmo campo, até mesmo modelos contendo âncoras de nível de página e de campo.

Observação:

• Ao definir âncoras no nível do campo, certifique-se de que seu rótulo esteja próximo à sua área de valor e seja suportado por âncoras adicionais se a mesma construção de texto puder ser encontrada em vários locais no mesmo documento.
• The bigger the length of your labels and anchors is, the more precision you get. The value area is always computed based on its relative position against your Label (main anchor). Choose your main anchors accordingly. Having field-level anchors allows fields to move within the template and still be captured, offering more flexibility in document layout changes.

Integração de Compreensão de Documentos

The Intelligent Form Extractor activity is part of the Document Understanding solutions. Visit the Document Understanding Guide for more information.