Activities
latest
false
Banner background image
Document Understanding Activities
Last updated 29 avr. 2024

Present Validation Station

UiPath.IntelligentOCR.Activities.ValidationStation.PresentValidationStation

Opens the Validation Station, which enables users to review and correct document classification and automatic data extraction results.

Using the Create Document Validation Action

Properties

Common
  • DisplayName - The display name of the activity.
Input
  • AutomaticExtractionResults - The automatically generated extraction results, stored in an ExtractionResult proprietary variable. If a variable is added to this field, the Validation Station displays the results of the automatic extraction, enabling you to review and modify them. If left empty, the Validation Station contains no automatically extracted data. This field supports only ExtractionResult variables.
  • DocumentObjectModel - The Document Object Model you want to use to validate the document against. This model is stored in a Document variable and can be retrieved from the Digitize Document activity or, in legacy workflows, from the Prepare Validation Station Data activity. Please see the documentation of each activity for more information on how to do this. This field supports only Document variables.
  • DocumentPath - The path to the document you want to validate. This field supports only strings and String variables.
    Note: The supported file types for this property field are .png, .gif, .jpe, .jpg, .jpeg, .tiff, .tif, .bmp, and .pdf.
  • DocumentText - The text of the document itself, stored in a String variable. This value can be retrieved from the Digitize Document activity or, in legacy workflows, from the Prepare Validation Station Data activity. Please see the documentation of each activity for more information on how to do this. This field supports only strings and String variables.
  • Taxonomy - The Taxonomy against which the document is to be processed, stored in a DocumentTaxonomy variable. This field supports only DocumentTaxonomy variables.
Misc
  • FieldsValidationConfidence % (Preview) - Set the upper limit confidence score to be used when rendering the Validation Station.
  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
  • ShowOnlyRelevantPageRange - If selected, only the page range mentioned in the extraction results is shown and the pages that are outside the range are hidden.
Output
  • ValidatedExtractionResults - The extraction results of the human validation process, stored in an ExtractionResult variable.
    Important: In case you use an Intel Xe GPU and Validation Station is not displayed properly, we recommend updating the graphics driver to the latest version. For more information, please visit this page.

Using the Validation Station

The Validation Station is a powerful tool that enables users to review and correct automatically extracted data from files, or manually process files for data extraction.

The Validation Station, once opened, presents all extracted information along with the file being processed:



The fields that are visible in the Validation Station are the ones defined in the Taxonomy used in your workflow.

Document View

The right area of the Validation Station contains an interactive version of the original document, in which text or document sections can be selected, and words can be clicked based on the output of the digitization process.

This area also contains options for zooming in and out, selecting and rotating pages, searching through the document, or switching to text view.



Here are the options available in the right part of the Validation Station screen:

Option

Description

Displays all the available keyboard shortcuts supported by the Validation Station.

- Keyboard shortcuts

- Hides the extracted tokens

- Switches the panel side from left to right

Toggles between the text view and image view of the document.

- Image view

- Text only view

- Text

Active only when the Text only view option is active

Sets the selection mode while in text view

- Text

- Tokens

Sets the selection mode while in image view

- Tokens

- Custom area

- Choose after selection

Rotates the current page clockwise.

Initiates a search between results in the document used by the Validation Station.

Resets the zoom level on the document. This option is enabled only if the document was previously zoomed in or out.

Zooms in on the document.

Zooms out on the document.

Here is an example of how to use the View mode, Zoom In, Zoom Out, and Reset Zoom options:



To zoom in or out, you can also use the CTRL+scroll mouse wheel combination: CTRL+scroll up to view a specific section of the document; CTRL+scroll down to view a larger section of the document.

The below example illustrates the Rotate option:



Note: The Rotate option is available only in Image view.

Area selection in image view can be observed below:



Correspondingly, please look at area selection in text view:



The next example explains how to use the Search option:



There are many keyboard shortcuts that can be used to optimize the human interaction with the Validation Station. We encourage you to use them as much as possible. These can be reviewed in the Keyboard Shortcuts popup.

Shortcut

Description

n

Moves to the next field

p

Moves to the previous field

f v

Marks a value as validated

f c

Changes the extracted value

f z

Reverts to the previous value

f a

Adds an additional value

f s

Toggles between suggestions

ESC

Exits edit mode (for Fields and Tables)

  • Collapses the derived parts (for Fields)
  • Deselects a line (for Table Selection)
  • Exit table selection mode (for Table Selection)
  • Do not save unconfirmed fields

DEL

  • Removes the selected value (for Fields)
  • Removes the selected line (for Table Selection)

CTRL SHIFT ENTER

Save unconfirmed fields

CTRL SHIFT S

Save data as draft

Alt p

Toggle PDF Viewer focus

d +

Zooms in

d -

Zooms out

d 0

Resets zoom

d r

Rotates the page clockwise

d t

Toggles the text mode

/

Initiates a search

d s

Changes selection mode

d a

Clears the drawn anchor selection

d h

Toggles the extracted tokens

s

Move selected line right

s

Move selected line left

s

Move selected line up

s

Move selected line down

s d

Duplicate the selected line

s v

Vertical line

s f

Horizontal line

s a

Auto detect by mouse movement

s t

Hand tool - move and delete lines

?

This screen

!

Report document as exception

CTRL ENTER

Save data

CTRL DEL

Discard all current changes

Moves to the right cell

Moves to the left cell

Moves to the top cell

Moves to the bottom cell

t v

Marks a cell as validated

t c

Changes the extracted cell

t z

Reverts to the previous cell value

t d

Discards changes in tables

t DEL

Removes the selected cell

t ESC

Close the table editor

1 2 3 4 5 6 7 8 9 q w e r y a g h j k l z x c v m @ # $ % ^ & *** ( ) [ ] {

  • Use the key associated with each field to assign values to them (letters are case insensitive)
  • Use the same key to focus on a field if no selections are made
  • The o key is reserved for the Document Type field assignment

Navigate through the Validation Station by using the keyboard shortcuts. Activate the Toggle keyboard shortcuts option to avoid accidental triggering the keyboard shortcuts.



Have a clean view panel and hide the highlights of the extracted tokens by using the Hide extracted tokens option.



Decide whether the validation panel should be on the left or the right side of the screen.



Data Extraction Section

The left area displays the document type you have selected for the current validation and enables you to select the state of each element and link it to its corresponding word or area in the document.



The confidence level of the extracted information can be displayed by OCR or Extraction.

The OCR Confidence level is given by the OCR engine used for extraction in the workflow. If the used OCR doesn't report any confidence levels, then N/A is displayed instead of percentages.

The Extraction Confidence level is given by the extractor used in the workflow.

The confidence score should be used only for guidance purposes. You can increase the confidence score by manually validating the data.

Another way of visualizing confidence levels is by filtering them depending on a threshold set by you.



The OCR confidence level changes individually, for each field, if you alter the reference of a certain field.



You can use the field shortcuts to assign values to a field or to toggle between fields. Once a value is assigned to a field, it is highlighted by the color of the selected field.



For the assigned value, there is a document crop displayed in the table field. This helps with better locating the area from which the value was extracted and it also serves as a means of double-checking the value by comparing it with the document crop.



Note:

The Document Type field is a special field that you can act upon:

  • If the extraction results contain a document type, and that document type is correct, then no action is required.
  • If the extraction results contain a document type, and that document type is incorrect, then you have to select the correct one and provide evidence for it from within the document.
  • If no extraction result is provided and only one document type exists in the taxonomy, then that document type is pre-selected but needs evidencing.
  • If no extraction result is provided and there are multiple document types in the taxonomy, then you have to manually select the desired document type and provide evidence for it.

Automatically extracted fields have a confidence level percentage that is also color-coded, meant to help you detect fields that need assistance.

There are four levels of confidence:

  • below 50%, color coded in red
  • between 50% and 85%, color coded in yellow
  • between 86% and 99%, color coded in light green
  • 100%, color coded in green

    To increase the confidence level, you can validate the information by manually selecting it, like presented in the below GIF:



All fields that contain information have an Options drop-down menu that can be accessed by clicking on the button. A drop-down list becomes visible, displaying multiple editing options.



The menu includes the following options:

  • Change extracted value - Changes the automatically extracted value with a manually selected one. This field is active only when one or multiple values are selected from the document and are different from the original value.
  • Revert to previous value - Resets the field's value to its last state. This option is active only when a value was previously altered or deleted.
  • Mark as missing - Marks a field as missing if the information is not available in the document.


Selection Modes

There are several ways of selecting text while using the Validation Station wizard. Using them allows you to quickly navigate through the entire document and easily select the desired words for validating a field.

Here is a list of all the available selection options:

  • Select one word - Click the desired word.
  • Select consecutive words - Click the first word, then SHIFT+click the last word from range.
  • Select multiple disparate words - Click the first word, then CTRL+click the rest of the desired words.
  • Combine multiple selections - Click the first word, then SHIFT+click the last word from a range for the first selection, then hold CTRL+click and SHIFT+click to add another range, until you've completed your selections.
  • Area selection - Make a selection and choose the selection type:
    • Tokensdocs image - Selects all words in the selected area.
    • Custom areadocs image - Captures only the area and not the words in it.
    • Choose after selectiondocs image - Selects the entire area, with separate words, leaving you to decide the type of selection.
Other Options
  • Notes - This is only displayed if Validator notes for that certain field were enabled in Taxonomy Manager. Depending on how it was configured, it can be:
    • A text field where you can add notes related to that field, such as why a certain value was chosen or if any extra checks should be performed.
    • A text that cannot be edited.
    • Several options in the form of radio buttons from which you can select one, depending on the situation.
    Tip: Check the ExtractionResult Class page from the UiPath.DocumentProcessing.Contracts section for more information on the two methods related to validator notes, GetFieldValidatorNotes(<fieldId>) and SetFieldValidatorNotes(<fieldId>, <validatorNote>).
  • Edit the field's value - Changes the content of a field by positioning the mouse on that field, clicking the value, and adding the desired input.


  • Thedocs image option - Reverts the field to its prior state. One-click on this option takes you one step back, meaning that if you had several changes on that field, multiple clicks might be required for returning to a certain value. This field is active only when a value was previously modified or deleted.


  • Thedocs image option - Adds a value to the field by using the Custom area or Tokens selection. The button becomes available when a selection is made in the document and differs from the one in the field. The selection can be made for multi-value fields at all times, and for single-value fields only if no value is present for that field.


  • The docs image option - Confirms the information included into the field. Once confirmed, the check box turns blue, like this docs image and a Validated tag is added to the field.

    Once a field is manually validated, you can still check the original value of that field by clicking on the extraction confidence level. This functionality is available only for Extraction confidence level.



The interface of the Validation Station is interactive, meaning that when a field is selected on the left side, the right side moves the focus on it by highlighting it.



This also applies to text view:



  • The docs image option - Enables you to select and add additional values from the document to a specific field.


  • The docs image option - Enables you to add a value to a field without requiring reference from the document.


Table Fields - Cell Level Processing

The extraction confidence level is available for each extracted cell, for both OCR and Extractor used in the workflow. Toggle between them from the upper left side of the Validation Station.

Below you can find explanations for all the options available for a table field:

Icon

Description

Indicates the table's area in the document.

Creates a new table and opens the table extraction tools.

Opens a drop-down list with the following options:

  • Revert to previous value - Returns to the previous value. It is active only if the table's data has been previously altered.
  • Remove value - Marks the table field as missing.

When selected, confirms the data accuracy.

Enabled when the field's value is missing.

Enabled when the initial extracted value had been altered or deleted. When selected, it restores the previous value.

Marks a field as missing.

All table fields have a drop-down menu with the following options:

  • Change extracted value - Selects a new value from the document and replaces the initial one. This field becomes available only when the newly selected value is different from the original selection.
  • Revert to previous value - Replaces the actual value with the previous one. This field is active only when altering the initial value.
  • Mark as missing - Marks a field as missing if the info is not available in the document.

The drop-down menu available at the end of each row has the following options:

Icon

Description

Transforms the selected row in the table's header. The row cannot be seen in the table's body anymore, but the information can be visualized any time a header's field is selected.

Highlights the selected row.

Extracts a new row and places it below the selected one. It enables the custom selection tool and offers you the possibility to manually select the new row. Once the area of the new rows is selected, you must define each column. Do this by using the available options presented in the table below.

Inserts a new empty row above the selected one. The row is automatically added to the table, except that all fields are marked as Not extracted. You have to manually select the value from the document and add it by using the Add extracted value option.

Applies the same principle as for the Insert row above option, the only difference being that the row is inserted below and not above the actual selection.

Deletes the row.

All options are explained in the below GIF:


docs image

Once a field from the table is edited or reviewed, the confirmation box changes its appearance. To confirm the data you must check the box.


docs image
Note: The overall confidence of the table is the lowest confidence from the cells within.
Table Fields - Table Level Processing

A table can be manually selected and defined, straight from the Validation Station wizard. If no table is selected, or if you are not happy with the automatic selection, then you can use the options available on the drop-down menu found at the end of the first row.

Note:
  • If the Value of a table cell is not extracted, you can manually add a value into that table cell, by going into the Selection Mode, choosing the Custom area option, and marking the table cell area.
  • Both Extract new table and Extract Rows from here options are using the same functionality and are enabling you to define new values.

Few more options are available in the table's header. You can use them for extracting a new table, highlighting the existing one, or just a row from it, or for deleting the entire table.

Icon

Description

Replaces the existing table with the new selection. You need to mark all rows and columns. Please keep in mind that the first row becomes the header of the table.

Highlights the entire extracted table area.

Highlights in the table the selected row.

Deletes the existing table.

The below GIFs explain the options mentioned in the above table.

  • Extract new table:

    docs image

Define the table header while using the Extract new table option by enabling the Extract header function. Selecting the information from the document, or transforming one of the existing rows into the table's header can also define the header.

  • Highlight table, Highlight row, and Delete all rows options :

    docs image

The Extract new table option has many useful functions that can ease your work. They are all explained in the below table.

Icon

Function

Removes all lines visible in the selection.

Removes only the selected line from the selection.

Enables horizontal lines in the selection.

Enables vertical lines in the selection.

Enables you to adjust the line's direction using the mouse.

Enables the selection, rearrangement, and removal of lines.

The GIF below explains how to use the functions available for the Extract new table option. Note that these functions are also available within the Extract rows from here option.


docs image

You can click the Save new table button to automatically confirm all fields or you can deny the operation by clicking the Close button, return to the table selection, and manually confirm each field.

Note: If you want to save a table with empty or no extracted fields, then those fields are automatically marked as missing.
Value Formatting and Language Setting

Number, date, and address fields allow you to review and correct formatted (parsed) parts of a specific value. The editable parts are as follows:

Field Type

Editable Formatted Parts

Number

Value (up to eight decimals)

Date

  • Day
  • Month
  • Year

Address

  • Address Line 1
  • Address Line 2
  • Address Line 3
  • City
  • State / County / Province
  • Country
  • Zip Postal Code

Name

  • First Name
  • Middle Name
  • Last Name

When you extract or correct a value for a field of any of these types, the Validation Station tries to automatically parse the value into its formatted components.

The language setting displays the detected prevalent language within the document, as identified during the digitization process. This enables the Validation Station to parse numbers and dates more accurately, according to the language of the document. You can change the language setting by using the drop-down menu.


docs image

By doing so, when you manually extract or change a date or number value, the Validation Station will first try to format the selected string according to the selected language, and will fallback to English US if parsing is not successful as such. The formatting function only applies to the editable formatted parts of a value, not to the original string value.

To ensure the best automatic formatted value detection, we recommend you check the detected language and correct it if necessary.

Report Exceptions

You have the option to report a document as an exception. If this situation occurs, the Present validation Station throws an exception that should be caught by the RPA workflow and treated separately. The exception message displays the Reason for Exception filled in by the user.

Here is how you can report a document as an exception:


docs image
Data Confirmation & Validation

You have the option to manually or automatically confirm all fields. For manual confirmation, you need to select the check box of each field. If a check box is not manually confirmed, then this process is automatically done when the Save button is clicked, and then the action is confirmed by clicking the Continue & save button.

The following options are available on the bottom side of the Validation Station:

Button

Function

Saves the confirmed fields.

Saves and closes the table selection area. The button is enabled only when the table field is active.

Reports the document as being an exception.

Enabled only when not all values are manually confirmed. By selecting it, all data is automatically confirmed and saved.

Enabled when no change has been done to the table.

Enabled after a change has been done to the table.

Enabled after the user clicks Dismiss. Discards all changes done to the table.

Document Understanding Integration

The Present Validation Station activity is part of the Document Understanding Solutions. Visit the Document Understanding Guide for more information.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.