Skip to main content

DocuMine Documentation

Rule editors

DocuMine offers two rule editors to manage the different rule types: the Entity rule editor and the Component rule editor.

How to access the rule editors:

  1. Go to the User menu and click on Settings to display the Dossier templates list.

    Settings_1_2.png

    Settings in user menu

    Important

    What is a dossier template?

    The dossier templates contain the rules dictating DocuMine's behavior in extracting components from documents.

    Users can configure different ruleset. The applied template determines the outcome of the extraction.

  2. Clone the dossier template you wish to create the rules for.

    We recommend working in a template clone. It has the same rule set, but ensures that your new rules do not have unintended effects on other (still unapproved) files using the same template. You can later copy the rules into the original template.

    Clone_dossier_template_1_2.png

    Clone template

    The "Clone dossier template" dialog opens.

  3. You can change the template name and description.

    Press Save and edit to clone the template and open it.

    Clone_template_dialog_1_2.png

    "Clone template" dialog

  4. Depending on the rule you want to create: Go to the Entity rule editor and search for the "Headline rules" or the "General documine rules" section, ...

    Entity_rule_editor_1_2.png

    Entity rule editor

    ... or go to the Component rule editor and search for the “Default component rules”.

    Component_rule_editor_1_2.png

    Component rule editor

In order to extract an entity, you need a representation of the entity within DocuMine. For further information, please see Create an entity.

We recommend testing your rules while working in the rule editors. For further information, please Rule validation.