Document Understanding Process template

Overview

Document Understanding Process is a fully functional UiPath® Studio project template based on a document processing flowchart. You can use it to get started with working on either a demo, or a large-scale implementation of Document Understanding^TM.

The process provides logging, exception handling, retry mechanisms, and all the methods that should be used in a Document Understanding workflow, out of the box.

Framework

The Document Understanding Process template is preconfigured with a variety of basic document types, as well as classifiers and extractors, that are specific to an activity package. The template comes in the following project compatibility types:

• Windows – This framework uses the IntelligentOCR activity package, designed for Windows projects.
• Cross-platform – This framework uses the DocumentUnderstanding activity package, designed for Cross-platform projects.

Both template types are compatible with modern projects, making the process template a best practice sample that you can adapt to your needs.

Figure 1. Document Understanding Project Extractor in the template

Architecture

The process has an architecture decoupled from other connected automations:

• It does not matter where the files to be processed are coming from or what triggers the execution, this is the responsibility of an upstream process;
• It does not matter where the extracted information should be used, this is the responsibility of a downstream process.

The process has the same architecture for scenarios using both attended robots, and unattended robots running Document Understanding, that have human in the loop validation via Action Center.

Items are not processed in bulk. Instead, there is one job for each input file. A dispatcher is required for processing every item, but this flexible approach helps you get started, develop, debug, and scale Document Understanding processes.

Supported project language types

The Document Understanding Process template only supports Visual Basic projects.

Default dependencies

Dpending on the template type, the default dependencies in a Document Understanding Process are:

• Windows:
  • UiPath.DocumentUnderstanding.ML.Activities;
  • UiPath.Excel.Activities;
  • UiPath.IntelligentOCR.Activities;
  • UiPath.System.Activities;
  • UiPath.Testing.Activities;
  • UiPath.UIAutomation.Activities.
• Cross-platform:
  • UiPath.DocumentUnderstanding.Activities;
  • UiPath.System.Activities;
  • UiPath.UIAutomation.Activities.

How to access the process

Note:

Document Understanding Process is compatible with Studio version 21.4.4 or higher. For previous Studio versions, you can download the NuGet package from here.

You can find the Document Understanding Process template on the Official template feed. Navigate to the Templates tab and select the Document Understanding Process card.

Figure 2. Official Feed for Studio Templates

Select Use Template.

Figure 3. Use Document Understanding Process template

Enter a Name for your process and select a Location on your PC. Select Create to open the process.

User guide

The process comes with detailed documentation included in the project folder. We recommend you to read the enclosed User Guide even if you are familiar with the Document Understanding solution.

Contribute to the project

You can contribute directly to the project by making a pull request or by opening an issue in our repository here. If you want to create a new branch, please be aware of the naming conventions in the README.md file.