Skip to main content

DocuMine Documentation

Rule validation

We recommend testing your rules in the application while you are working in the rule editors to ensure they work as expected.

Start by creating a dossier with a document that uses the template you are working on. We recommend working with a template clone to avoid unintended impacts on unapproved files in the production environment. For further information, please see Clone dossier templates.

Next, open a second browser tab or window alongside the rule editor, and open one of the documents from which you want to extract the entity. That will open the document editor.

Document editor

The processed document is displayed on the right of the editor.

Relevant information detected by DocuMine based on the defined ruleset is annotated (highlighted). The highlighting color indicates the respective information type (= annotation/entity type).

Document_in_editor_1_2.png

Document with highlighted entities

The annotations list in the center of the editor lists the pieces of information that have been annotated and extracted on the currently visited page and provides information on the respective annotation type (= entity type) and applied rule(s).

Annotations_list_1_2.png

Annotations list

When you select an entry from the annotations list, the respective annotation is highlighted in the document (and vice versa).

Select_annotation_1_2.png

Selected annotation

The Components table on the left provides a tabular view of the components that have been built from one or more of the annotated and extracted pieces of information.

Components_table_1_2.png

Components table

Entity rule validation

Once you have saved your new extraction rule in the entity rule editor, disable the extraction and re-enable it to trigger a re-analysis. The newly created annotations should then show up in the text and in the annotations list.

Disable_extraction_1_2.png

Disable extraction

You can also filter for the newly extracted entity. If it has been extracted correctly, the respective text passage(s) will be highlighted in the entity color selected during entity creation.

Filter_for_entity_1_2.png

Filter for annotation/entity type

Component rule validation

Check whether the component appears in the component list, whether it was built from the required entities, and whether its value was transformed or standardized as expected.