Taxonomieverwaltung

Wichtig:

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:

• Dokumentbereich klassifizieren (Classify Document Scope)
• Klassifizierer-Scope trainieren
• Train Extractors Scope
• Aktuelle Validierungsstation

Auf den Taxonomiemanager kann nur zugegriffen werden, nachdem Sie ein UiPath.IntelligentOCR.Activities-Paket höher oder gleich v1.6.0 als Abhängigkeit für Ihr Projekt installiert haben. Sobald das Paket installiert ist, wird auf dem Menüband die Schaltfläche Taxonomiemanager im Abschnitt Assistenten angezeigt.

Verwenden des Taxonomiemanagers

Im Taxonomiemanager-Fenster können Sie Dokumenttypen erstellen, angeordnet in Gruppen und Kategorien. Beim ersten Öffnen in einem Projekt sind keine Gruppen, Kategorien oder Dokumenttypen definiert.

Figure 1. The Taxonomy Manager before mapping any document types or fields

Festlegen der Struktur

Der erste Schritt besteht darin, eine Gruppe oder einen Dokumenttyp zu erstellen. Der Unterschied zwischen den beiden besteht darin, dass bei einer Gruppe eine hierarchische Struktur herrscht, während ein Dokumenttyp als einzelne Datei erstellt werden kann. Ein komplexes Projekt umfasst Gruppen, Kategorien und Dokumenttypen, während ein einfaches Projekt nur einen oder zwei Dokumenttypen umfassen kann.

Erstellen einer Gruppe

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 using the Enter key.

Erstellen einer Kategorie

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. Select Save or use the Enter key to save the configuration.

Erstellen eines Dokumenttyps

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

If the Document Type is created as a single file, make sure that no group is selected and select Document Type. After selecting Document Type, enter a name for the file and select Save.

Hinweis:

When a Document Understanding Action is submitted from Orchestrator while using Studio version 2020.10, make sure that the taxonomy has no document types created without a category.

Selecting an already created Document Type lets you change its name, copy its unique ID to clipboard, or reassign it to another group or category. 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. The Document Type ID code is an optional functionality and it can be used to find your documents or map your documents to the Document Types that you define in the taxonomy.

Konfigurieren der Anzeigeeinstellungen für den Dokumenttyp

After you create the document type, you can configure its display settings. Select the document type in the Taxonomy Manager, and go to Display settings. You can change the following configurations:

• OCR confidence threshold: Set a minimum confidence threshold at the document type level. When the document is displayed in the Validation Station, both the OCR confidence level and the Extraction confidence level for a field, would have to be higher than the threshold you configure in the Taxonomy Manager. The default value for OCR confidence threshold is 90%.

• Date display format: The date format displayed for the document type.

  Der Standardwert ist YYYY-MM-DD.

• Number decimal separator: The number decimal separator you want to use for the document type.

• Number thousand separator: The number thousand separator you want to use for the document type.

Erstellen von Feldern

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

The Field category has two tabs: Details and Rules. The Details tab provides information about the selected field, such as Field Name, assigned hotkey, or field type, while the Rules tab allows you to create rules that need to be fulfilled by the extraction result for the field.

Die folgenden Feldtypen sind verfügbar:

• Text

• Nummer

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

  Hinweis:

  Wenn Sie ein erwartetes Format hinzufügen möchten, verwenden Sie ein MSDN-konformes Format (MicroSoft Developer Network).

  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 from a pre-established list.

• Boolescher

• Table - Choosing this type lets you edit the structure of the table, as you can add columns and edit their name and type.

Registerkarte „Details“

After the new Field is created, select it to view more information. By default, when you open a field, the Details tab is displayed allowing you to modify the name, color, or hotkey of the field. You can also 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). The multi-value option allows for a field to have multiple values, without being restricted to a specific list.

Weitere Informationen zum Verwenden der beiden Felder finden Sie in den folgenden Beschreibungen:

• Is Multi-Value: If a field is set as multi-value, you can have more than one value reported for that particular field. For example, you want to extract a "List of Directors" where you can have variable number of entries. Imagine a multi-value field like a single-column table.
• Requires reference: When a field requires reference, you can add a value to it only if you select something from the document you see in Validation Station. For special fields in which you want to capture values that are maybe not visible in the document, you can switch Requires Reference to Off. Effect will be that user can add a value without specifying a place in the document where that values comes from.

You can also select the Type of the field from the dropdown list, or add a Default value. Use the Default value field to define values to be populated in the Extraction Result, in case there is no value for the field identified in the document.

Validierungseinstellungen

Under Validation settings, you have the option to set an Extraction confidence threshold. This threshold is considered when validating the field in the Validation Station. To set an extraction confidence threshold, go to Extraction confidence threshold and input a value ranging from 0 to 100.

Figure 2. Overview of the Details tab of a field

You can choose to enable Validator notes from the Details tab. By setting up validator notes, human validator can add notes about the decision they have taken during validation. You can configure the following settings:

• Read-only: If enabled, the human validator can view any validator notes set on the ExtractionResult field in Validation Station, as a message. If disabled (default state), the human validator can also edit that note in Validation Station and thus communicate back to the robot information about the decision taken.
• Text: If Text is selected, the validator note is displayed as a text message (or editable text when editing is enabled) in Validation Station. The human validator can view, edit, or add a maximum of 200 characters message in Validation Station.
• Options: If you select Options, you can configure a series of radio buttons that the human validator can view and, if not read-only, select in Validation Station. You can add a maximum of 10 options.

Tipp:

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

Erstellte Felder können mit der entsprechenden Schaltfläche gelöscht werden, die daneben angezeigt wird. Sie können auch mit der Drag-and-drop-Funktion neu angeordnet werden.

A field can also be deleted from the Details window, by selecting Delete.

Durch Wiederholen dieser Schritte können Sie mehrere Gruppen, Kategorien und Dokumenttypen erstellen und dann mithilfe des Feldes Suchen filtern.

Registerkarte „Regeln“

Feldregeln helfen Ihnen, die Extraktionsergebnisse zu optimieren und sie bei der Ausführung Ihres Workflows automatisch zu validieren. Ihre Aufgabe besteht darin, die Extraktionseffizienz zu erhöhen und Ihnen dabei zu helfen, die Felder, die in der Validierungsstation überprüft werden müssen, einfach zu validieren, indem sie hervorgehoben werden. Sie können mehrere Regeln erstellen, die für ein Feld gelten.

You define a rule by setting the Evaluator type and the Criticality level.

Auswertertyp

Use the Evaluator Type to specify how the defined rules should be evaluated. There are two evaluator types that you can choose from: AND, OR.

Table 1. Table showing Evaluator types , their descriptions, and examples for them

Auswertertyp	Beschreibung	Beispiel
AND	Verwenden Sie diesen Auswertungstyp, wenn alle Regeln ausgeführt werden müssen.	Rule : Invoice Number starts with A And ends with X. Valid Result : The valid field value is A123X. Invalid Result : The valid field value is A123.
ODER	Nur eine der Regeln muss ausgeführt werden.	Rule : Invoice number starts with A OR is 123. Valid Result : The valid field value is A123, 123. Ungültiges Ergebnis: Der gültige Feldwert ist 234, 1A23.

Kritikalitätsstufe

Indicates the criticality of all rules defined for a field. You cannot set a MUST level if the rule is broken in the Validation Station session. There are two criticality levels that you can choose from: MUST, SHOULD.

Die erstellte Regel wird ausgelöst, sobald die festgelegte Kritikalitätsstufe identifiziert wurde.

When you want to submit a rule, a MUST rule requires 100% success, otherwise the Submit operation fails. A SHOULD rule allows you to Submit it even if the rule is broken.

You can always check if a rule is broken by using the helper method from the ExtractionResult Class class, that resides in the UiPath.DocumentProcessing.Contracts activity package.

Table 2. Table displaying Criticality levels and their descriptions

	Beschreibung
MUST	Verwenden Sie diese Kritikalitätsstufe, wenn die erstellte Regel unbedingt in den Extraktionsergebnisprozess aufgenommen werden muss.
SHOULD	Verwenden Sie diese Kritikalitätsstufe, wenn die erstellte Regel optional ist.

Once you have selected the Evaluator Type and the Criticality Level, you must set a type applicable for your newly created rule. There are several options you can choose from. Here's a complete list with all the available ones:

• Ist nicht leer
• Mögliche Werte
• Beginnend mit (Starts with)
• Endend mit (Ends with)
• Enthält
• Feste Länge
• Ist E-Mail
• RegEx
  Hinweis:

  The field type for which you created a rule dictates the number of possible rule types from which you can select one. For example, a field of type Text displays all the possible rule types, while a field of type Date displays only two rule types, Is not empty and Possible values.

Regeltyp

Die folgende Tabelle zeigt Details für jeden verfügbaren Regeltyp, klassifiziert nach der Kritikalitätsstufe und dem Bewertertyp.

Table 3. Rule types and their descriptions, depending on the criticality level and evaluator type

	Beschreibung	Feldtyp	Kritikalitätsstufe	Auswertertyp
Ist nicht leer	Der extrahierte Wert darf nicht leer sein, d. h. das Feld ist ein Pflichtfeld. Wenn der Wert fehlt, ist eine Validierung/manuelle Eingabe erforderlich.	Gilt für Felder der folgenden Typen: Nummer text Datum Adresse name FESTLEGEN boolean	MUST SHOULD	AND ODER
Mögliche Werte	Der Benutzer definiert alle möglichen Werte und die extrahierten Daten sind einer der Werte, die beim Erstellen der Regel als Eingabe hinzugefügt wurden (z. B. ist der Mitarbeitertyp entweder „Vollzeit“, „Teilzeit“ oder „Praktisch“).	Gilt für Felder der folgenden Typen: Nummer text Datum	MUST SHOULD	AND ODER
Ausdruck	Definieren Sie mathematische Ausdrücke, die als Regel zum Extrahieren von Daten fungieren.	Applicable to fields of type number. A condition is required while configuring the rule. Choose one of the following options: Ist gleich Ist nicht gleich Ist größer als Ist größer oder gleich Ist kleiner oder gleich Ein mathematischer Ausdruck ist erforderlich. Verwenden Sie die vordefinierten Operatoren, um Ihren Ausdruck zu definieren. Sehen Sie sich die folgenden Beispiele an: Summenmenge * Nettostückpreis\n- Gesamt = Zwischensumme + Lieferung Rabatt – Der Summenoperator sammelt alle Werte aus einer Tabellenspalte.	MUST SHOULD	AND ODER
Beginnend mit (Starts with)	Dies ist eine feste Regel, d. h. der extrahierte Wert muss mit einem der vom Benutzer hinzugefügten Werte beginnen.	Gilt für Felder der folgenden Typen: text Adresse name	MUST SHOULD	AND ODER
Endend mit (Ends with)	Dies ist eine feste Regel, was bedeutet, dass der extrahierte Wert mit einem der vom Benutzer hinzugefügten Werte enden muss.	Gilt für Felder der folgenden Typen: text Adresse name	MUST SHOULD	AND ODER
Enthält	Dies ist eine feste Regel, was bedeutet, dass der extrahierte Wert einen der vom Benutzer hinzugefügten Werte enthalten muss.	Gilt für Felder der folgenden Typen: text Adresse name	MUST SHOULD	AND ODER
Feste Länge	Das ist eine feste Regel, was bedeutet, dass der extrahierte Wert eine bestimmte feste Länge haben muss.	Gilt für Felder der folgenden Typen: text Adresse name	MUST SHOULD	AND ODER
Ist E-Mail	Dies ist eine feste Regel, was bedeutet, dass der extrahierte Wert in einem E-Mail-Format geschrieben werden muss.	Gilt für Felder der folgenden Typen: text Adresse name	MUST SHOULD	AND ODER
RegEx	Dies ist eine feste Regel, was bedeutet, dass der extrahierte Wert einen regulären Ausdruck enthalten muss, der einem der vom Benutzer hinzugefügten Werte ähnelt.	Gilt für Felder der folgenden Typen: text Adresse name	MUST SHOULD	AND ODER

Verwenden von Regeln

Let's take a practical example to better understand the applicability of these rules. We will create a set of rules for the Address field of document. Check the following example steps to learn how you can create a new rule or a set of rules for a field:

1. Select a field in the Taxonomy panel.
2. Go to the Rules tab.
3. Select Add new, to add a new rule.
4. Type in the full address rule, for which the Type is Contains, and the Expression is st, str, street.
5. Choose the Evaluator type. In this example, select OR.
6. Choose the Criticality level. In this example, select MUST.
7. Select Add new.
8. Type in the phone number rule, for which the Type is Is not empty.
9. Select Add new.
10. Type in the city or state rule, for which the Type is Contains, and the Expression is city, state.

Das folgende animierte Bild zeigt die zuvor beschriebenen Schritte.

Figure 3. Animated image displaying how to add three rules for a field

Andere Optionen

Bearbeiten

Sie können den Namen einer jeden Gruppe, Kategorie oder eines jeden Dokumenttyps bearbeiten, den bzw. die Sie erstellt haben. Dazu kann eine der drei Konfigurationsebenen ausgewählt und das Feld Name bearbeitet werden.

Wird gelöscht…

Gruppen, Kategorien und Dokumenttypen können ebenfalls gelöscht werden. Es gibt zwei verfügbare Optionen:

• Select Delete , at the parent element of the object you want to delete.
• Select Delete while selecting the object you want to delete.

In both cases, a pop-up is displayed asking you to confirm the deleting action. Select Delete to approve the action.

Anpassung und Barrierefreiheit

Dem neu erstellten Feld werden automatisch ein Hotkey und eine Farbe zugewiesen. Sie schaffen eine bessere Sichtbarkeit und schnellere Navigation durch Ihre Taxonomie. Passen Sie sie an, indem Sie auf den Hotkey oder das Farbcodefeld klicken.

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. See the Validation Station page for more information about how to use the field shortcuts to assign values to a field.

To assign a color and a hotkey for a field, select the field, and choose a certain color code in the Color field, and then select a specific hotkey from the Hotkey menu.

Navigate through the Taxonomy Manager by using the keyboard shortcuts. Select Show available keyboard shortcuts and activate the Toggle keyboard shortcuts option to avoid the accidental triggering of the keyboard shortcuts. Nodes can also be collapsed.

Hinweis:

Die im Taxonomiemanager vorgenommenen Änderungen werden automatisch in der projektspezifischen Datei taxonomy.json gespeichert.