UiPath Activities

The UiPath Activities Guide

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.

πŸ“˜

Note:

The Present Validation Station activity spawns two new processes, UiPath.SmartData.OutOfProcessUi.Host.WCF.exe and CefSharp.BrowserSubprocess.exe, necessary for displaying the Validation Station for human document validation and which, by default, are located in the user's profile, in the NuGet packages cache.

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

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output

  • ValidatedExtractionResults - The extraction results of the human validation process, stored in an ExtractionResult variable.

Using the Validation Station

The Validation Station is a powerful tool that enables users to make real-time CRUD (Create, Read, Update, and Delete) operations on digitized documents. The Validation Station wizard can be accessed by using the Present Validation Station activity.

πŸ“˜

Note:

The Validation Station can also be used in an Orchestration Process for a document validation action in combination with the Create Document Validation Action and Wait for Document Validation Action and Resume activities.
More information here about using the document validation action in Orchestrator.

Running the workflow opens the Validation Station:

You can customize all the selection fields from Validation Station by defining your own Taxonomy. More information about how to use the taxonomy can be found here.

πŸ“˜

Note:

If no variable is provided in the AutomaticExtractionResults property field, or if no classification is published in the provided variable, the Validation Station opens in full manual processing mode.

Data Fields

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

toggletoggle

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

zoomInzoomIn

Zooms in on the document.

resizeresize

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

zoomOutzoomOut

Zooms out on the document.

rotaterotate

Rotates the current page clockwise.

searchsearch

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

keyboardkeyboard

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

Here is an example of how to use the Toggle, 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:

The next example explains how to use the Search option:

Here is the list with all keyboard shortcuts. We encourage you to use them as much as possible.

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 or Exits table selection mode (for Table Selection)

DEL

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

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

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 DEL

Removes the selected cell

s

Moves the selected line to the left

s

Moves the selected line to the right

s

Moves the selected line up

s

Moves the selected line down

s d

Duplicates the selected line

s v

Selects vertical lines

s f

Selects horizontal lines

s a

Auto-detects lines by mouse movement

s t

Hand tool selection - moves and deletes lines

?

Opens the keyboard shortcuts list

!

Reports the document as an exception

CTRL Enter

Saves all data

CTRL DEL

Discards all current changes

1 2 3 4 5 6 7 8 9 q w e r y u i o a g h j k l b m @ # $ % ^ & * ( ) [ ] { }

Assigns values to a field
Selects the corresponding field

Visualize the available keyboard shortcuts:

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.

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 in accordance with the color of the selected field.

πŸ“˜

Note:

The Document Type field is influenced by the Taxonomy and it provides you with three possible situations:
If the classification information is provided then the type of the document is displayed and no action is required for this field.
If there is no classification information provided and only one document type is available, then that document type is automatically selected but needs evidencing.
If there is no classification information provided and you have more than one document type, then you have to manually select the desired document type.

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

The menumenu 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 Mode

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:
    • Tokens keyboardkeyboard - Selects all words in the selected area.
    • Custom area keyboardkeyboard - Captures only the area and not the words in it.

Area selection can be observed below:

Other Options

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.

The undoundo 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.

The addbuttonaddbutton 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 emptyCheckboxemptyCheckbox option - Confirms the information included into the field. Once confirmed, the check box turns blue, like this checkboxMarkedcheckboxMarked.

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.

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

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

Table Fields - Cell Level Processing

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

Icon

Description

tableMenutableMenu

Indicates the table's area in the document.

menumenu

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.

checkboxEmptycheckboxEmpty

When selected, confirms the data accuracy.

plusplus

Enabled when the field's value is missing.

revertrevert

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

removeValueremoveValue

Removes the value, in this case, the existing table.

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:

  • Make it the table header - 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.
  • Insert row above - Allows you to add a new 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. An example of how to use this option is illustrated below:
  • Insert row below - 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.
  • Delete row - Deletes the selected row.

You can define the table header when using the Extract new table option by enabling the Extract header function, by selecting the information from the document, or by transforming one of the existing rows into the table's header.

  • Extract the table with a defined header by enabling the Extract header function once the Extract new table option is active.
  • Confirm the table's header by positioning yourself on the header and selecting its equivalent from the table. Once the value is selected, click the Change extracted value from the drop-down menu.
  • Transform existing row into table's header by positioning yourself on one of the rows and selecting from the drop-down menu the Make it the table header option.

Table Fields - Table Level Processing

A table can manually be 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:

Both Extract new table and Extract Rows from here options are using the same functionality and are enabling you to define new values.

  • Extract new table - 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.
  • Extract rows from here - Enables the custom selection tool and offers you the possibility to manually select new rows and add them below the currently selected one. Once the area of the new rows is selected, you must define each column. You can do this by using the available options presented in the table below.
  • Highlight row - Highlights in the table the selected row.
  • Highlight table - Highlights the entire extracted table area.
  • Delete all rows - Deletes the existing table.

Icon

Function

removeAllLinesremoveAllLines

Removes all lines visible in the selection.

removeSelectedLineremoveSelectedLine

Removes only the selected line from the selection.

horizontalLinehorizontalLine

Enables horizontal lines in the selection.

vericalLinevericalLine

Enables vertical lines in the selection.

autoDetectautoDetect

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

handToolhandTool

Enables the selection, rearrangement, and removal of lines.

Below you can see an example of how to extract a new table row and how to use the available options. The Extract header function is not available when appending rows.

πŸ“˜

Note:

It is recommended to select the desired area and position the columns and rows so that they are corresponding with the existing taxonomy.

Here is how you can extract a new table by using the Extract new table option:

You can click the Save new table button to automatically confirm all fields or you can deny the operation by clicking the No 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 formatted parts are as follows:

Field Type

Editable Formatted Parts

Number

Value

Date

Day
Month
Year

Address

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

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 languagelanguage 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. 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:

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

languagelanguage

Displays and allows users to correct the automatically detected prevalent language within the document.

VS-025VS-025

Saves the confirmed fields.

VS-023VS-023

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

reportButtonreportButton

Reports the document as being an exception.

VS-026VS-026

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

VS-022VS-022

Enabled when no change has been done to the table.

dismissdismiss

Enabled after a change has been done to the table.

 

Validation Station

The Validation Station is a powerful tool that enables users to make real-time CRUD (Create, Read, Update, and Delete) operations on digitized documents. The Validation Station wizard can be accessed by using the Present Validation Station activity.

Prerequisites for Using the Validation Station

The Present Validation Station has four mandatory fields required to access the Validation Station:

  • DocumentObjectModel - The Document Object Model (DOM) of a document can be acquired from the Digitize Document activity or from a Prepare Validation Station Data activity by using the .Dom property.
  • DocumentPath - The path to the file you want to analyze by using the Validation Station. It is recommended to use the full file path.
  • DocumentText - The text of the document, extracted via an OCR activity and stored in a string variable. The Digitize Document activity extracts the text of the document and stores it in a String variable. The text can also be acquired from a Prepare Validation Station Data activity by using the .RawText property.
  • Taxonomy - The Taxonomy file against which you want to process the document. The Taxonomy can be acquired from a Prepare Validation Station Data activity by using the .Taxonomy property. The Taxonomy file can contain:
    • Single-value fields of the following types: Text, Name, Address, Number, Date, Boolean, Set, Table.
    • Multi-value fields of the following types: Text, Name, Address, Number, Date, Boolean, Set.
    • Tables with columns defined as single-value fields of the following types: Text, Name, Address, Number, Date.

Once all of these prerequisites are met, running the workflow opens the Validation Station:

Using the Validation Station

The right area of the Validation Station contains an interactive version of the original document, in which text 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 pages, searching through the document, or switching to text view.

The upper left area of the Validation Station enables you to navigate through the groups, categories, types and languages defined in your Taxonomy file. These enable you to select the document type from the provided Taxonomy.

If no variable is provided in the AutomaticExtractionResults property field, or if no classification is published in the provided variable, the Validation Station opens in full manual processing mode.

If the Taxonomy only contains one document type, it is selected by default - otherwise, you should manually pick the right document type pertaining to the document to be processed.

The lower 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. It also states what fields are mandatory, enables you to save the extracted data or report the document as an exception, for separate processing.

Note:

Mandatory fields have blue or orange background color.

The Document Type field is always mandatory and the processed data cannot be submitted without providing it.

Once a value from the document is selected for a field, either manually or automatically, an editing menu for the field is opened, having the following options:

  • Edit value - You can edit the value selected for the field, adding or removing information.
  • Remove value - You can delete the value selected for the field, if it was selected incorrectly or by mistake.
  • Extracted value confidence - The confidence level for the selected value, expressed as a percentage.
  • Change extracted value - You can replace the value for the current field with another selection from the document.
  • Undo to previous value - If a value replacement has been performed, returns to the initial value.

If fields do not have a value that can be extracted from the document, they must be marked as missing by using the missing button.

Note:

All fields must be processed before the final data can be submitted.

Editing Fields

Fields can be edited according to the datatype that they contain:

  • Text, Number, Date, Name, Address fields - The textual value and, if applicable, the derived parts, can be edited.
  • Set fields - An option from the set that you want to report as final value can be chosen.
  • Boolean - Yes or No values can be chosen.

Tables are also supported and fully customizable in the Validation Station wizard. You can select an area in the document and then manually specify the columns and rows. This functionality can be accessed by clicking the new value button situated next to the defined table in your taxonomy, and then clicking the Mark table button.

You can manually add, remove, or move rows and columns in tables:

  • To add a row, click inside the marked area.
  • To add a column, Ctrl + click in the marked area.

Once you have assigned the rows and columns, the columns must be named. To do so, select a name for each column from the drop-down lists above them.

Note:

The column names that are available are the ones specified in the taxonomy file.

Once you have finished making a selection, clicking the confirmation button saves the selected table.

Note:

You cannot confirm a table without specifying names for all the columns it contains.

Table fields can also be automatically identified. You can do this by selecting the area in which the table is situated and clicking the cogwheel button.

Note:

Pressing Esc during the process of selecting values for fields or marking tables cancels the action.

Field Descriptions for the Validation Station

Field
Description

Select a document group

Enables you to select one of the document groups defined in the Taxonomy file.

Select a document category

Enables you to select one of the document categories defined in the Taxonomy file.

Select a document type

Enables you to select one of the document types defined in the Taxonomy file.

Select a document language

Enables you to select one of the document languages defined in the Taxonomy file.

Extract selection as value for this field
extract

Sets anything that is selected in the document as a value for this field.

Extract manual token as reference for this field
manual token

Enables selecting an area in the document as a value for this field. Can be used in cases where the OCR process did not correctly identify the value in the document or when other values from the document are to be indicated, such as a stamp or signature.

When this feature is used, the value of the referenced data must be entered manually.

Mark this field as missing from document
missing

Marks field as missing. Mandatory fields cannot be marked as missing.

Add table value
new value

In the case of a multi-value field, enables you to select an additional value for the field.

In the case of a table, enables you to specify the structure of the table and then assign values to each cell.

Mark all remaining fields as missing from the document

Once all mandatory fields are completed, this option enables marking all fields that have not been completed as missing. Doing this enables ending the validation process.

Save extracted data

Once all fields are either specified or marked as missing, clicking this button ends the validation process, closes the Validation Station and saves the result in the variable specified in the ValidatedExtractionResults field.

Report it here

Can close the validation session immediately, reporting the document as an exception. Doing this throws an exception.

Zoom out
zoomout

Zooms out the document.

Fit
fit

Resets to default zoom level.

Zoom in
zoomin

Zooms in the document.

Page

Specifies which page of the document to be displayed. Can also navigate through the pages by using the up and down arrow buttons.

Search

Searches in the original document. Hotkey: Ctrl + Q

View as text

Displays the text version of the document extracted by the OCR Engine.

Updated 15 days ago


Present Validation Station


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.