Taxonomy Manager

Important: In case you use an Intel Xe GPU and Taxonomy Manager is not displayed properly, we recommend updating the graphics driver to the latest version. For more information, please visit this page.

The Taxonomy Manager can be used to create and edit a Taxonomy file specific to your current automation project. This Taxonomy file contains user-defined document types, organized in Groups and Categories.

You can further use the Taxonomy file by converting it into a .NET data type with the Load Taxonomy activity, and then passing it as input for activities such as:

• Classify Document Scope
• Train Classifiers Scope
• Train Extractors Scope
• Present Validation Station

The Taxonomy Manager can be accessed only after installing a UiPath.IntelligentOCR.Activities package higher or equal to v1.6.0 as a dependency for your project. Once the package is installed, a Taxonomy Manager button appears on the Ribbon, in the Wizards section.

Using Taxonomy Manager

The Taxonomy Manager window lets you create document types, organized by groups and categories. When opened for the first time in a project, no groups, categories, or document types are defined.

Establishing the Structure

The first step is to create a group or a document type. The difference between the two of them is that a group involves a hierarchical structure while a document type can be created as a single file. A complex project implies creating groups, categories, and document types, while a simple project can only require one or two document types.

Creating a Group

When a group is created, a category is also necessary for the document type you want to create inside the group. This is done by using the Group button. Once you have chosen a name for your group, you can save it by using the Save button or by simply hitting Enter.

Creating a Category

Once a group is defined and selected, you can create a Category and/or a Document Type within the group, by using their defined buttons.

Creating a Document Type

A Document Type can be created either by part of a group or as a single document. When created inside a group, make sure that the group is selected, then click the Document Type button.

If the Document Type is created as a single file, then make sure that no group is selected and click the Document Type button. After clicking the Document Type button, input a name for the file and click the Save button.

Selecting an already created Document Type lets you change its name, copy its unique ID to clipboard, reassign it to another group or category, or none of them. You can also input a code for the document type.

Once a document type is saved, a Document Type ID is generated for it. Opening the document for editing displays the ID next to the Document Type Name tab. The Document Type ID has a structure of the type Group.Category.Document and can be copied to the clipboard.

Creating Fields

When the Document Type is selected, the Field button becomes available for you to create a new field. Once the Field button is clicked, you can enter a name for it and select its type from the drop-down list.

The available field types are:

• Text
• Number
• Date - Choosing this type also lets you specify an expected format, which is optional.
  Note:

  If you want to add an expected format, use an MSDN-compliant format.

  This format may be used by extractors and is used by the Data Extraction Scope activity when trying to parse a Date into its constituent Day, Month, and Year parts.

• Name
• Address
• Set - Choosing this type lets you add multiple values to the field.
• Boolean
• Table - Choosing this type lets you edit the structure of the table, as you can add columns and edit their name and type.
  
  

  

  
  

After the new Field is created you can click the slider and specify whether it is multi-value (Is multi-value) or if it allows for values with no evidence in the document to be processed (Requires reference).

Created fields can be deleted by using the delete button that appears next to them or reordered by using the drag and drop function.

Retracing these steps, you can create multiple groups, categories, and document types, which you can then filter by using the Search field.

Other Options

Editing

You can Edit the name of any group, category, or document type that you have created. This can be done by selecting one of the three levels of configuration and editing the Name field.

Deleting

Groups, categories, and document types can also be deleted. This can be done by clicking on the button. A popup is displayed asking you to confirm the deleting action. Click Delete to approve the action.

Customization and Accessibility

A hotkey and color are automatically allocated to the newly created field. You can use them for better visibility and faster navigation through your taxonomy. Customize them by clicking on the hotkey or the color code field.

A customized field with color and hotkey can instruct the Validation Station and the Template Manager to use the assigned color when displaying the field and to use the assigned hotkey as a shortcut for providing values to fields. Here you can find more information about how to use the field shortcuts to assign values to a field.

Navigate through the Taxonomy Manager by using the keyboard shortcuts. Nodes can also be collapsed with only one click.

Here's a better view of all available keyboard shortcuts.

Note: The changes you make in the Taxonomy Manager are automatically saved into the taxonomy.json file specific to your project.