Skip to main content

RedactManager Documentation

Entities

The dossier templates contain entities.

An entity represents an information type to be redacted or highlighted as hint in the document. Entities are linked to rules that are applied during the analysis.

Entities can contain dictionaries that define the values to be detected in the text.

How to get there:

User menu > Settings > Dossier templates > Dossier template > Entities > Dictionary

A list of entities will be displayed:

Entity_list_4_1.png

Entity list

Inside each entity, you will find the following tabs:

  • Info

  • Dictionary

  • False Positive

  • False Recommendations

Not all Entities have dictionaries. If an entity does not have a dictionary, only the Info tab is active.

What can you do there?

Create new entity

  1. Click New entity at the top (next to the search bar).

    The "Create entity" dialog opens.

  2. Complete the dialog to define the entity settings. Mandatory fields are marked with a red asterisk.

  3. Finally, click Save entity.

create_Entity_4_0.png

"Create entity" dialog

Table 2. Guide

Display name:

Enter a display name for your entity.

The technical name is generated automatically from the display name you enter.

Special characters are removed automatically from the technical names, as they would otherwise lead to errors during analysis.

Rank:

Decide how to rank the new entity within the entity ranking.

The rank defines which entity is given priority when dictionary entries from two different entities match the same text passage. The entity with the higher rank wins.

Redaction/hint color:

Specify the color for redactions or hints generated by RedactManager on the basis of this entity. Enter the hex code of the color or click the pencil button to select a color. The redactions/hints will then be highlighted in the selected color in the editor.

Recommendation color:

Specify the color for recommendations generated on the basis of this dictionary. Enter the hex code of the color or click the pencil button to select a color. The recommendations will then be highlighted in the selected color in the editor.

Skipped redaction color:

Specify the color for skipped redactions or skipped hints generated by RedactManager on the basis of this entity. Enter the hex code of the color or click the pencil button to select a color. The skipped redactions/hint will then be highlighted in the selected color in the editor.

Redaction/Hint:

Indicate whether the entries in the entity shall be considered redactions or hints. (Notes are markings in the document that draw the user's attention to certain facts.)

Default reason:

Enter a default reason for redactions/hints that are based on this entity.

Description:

Enter a description.

Has dictionary:

Enable the toggle if you want the entity to have a dictionary. Not every entity needs a dictionary, and it is also possible to store only rules.

If you opt for an entity with a dictionary, you can define the dictionary settings:

Table 3. Dictionary settings

Template & dossier dictionaries or Dossier dictionary only:

Select one of these options to specify whether you want to create a template and a dossier dictionary or a dossier dictionary only.

Dossier dictionary: When creating a dossier, RedactManager creates a dossier dictionary for the entity. Terms in the dictionary are redacted on dossier level.

Users can add/remove entries manually via the dictionary editor or by selecting the Redact in dossier / Remove from dossier option when adding or removing a redaction or hint if you enable the Available in add/remove dialogs option (see below).

Template dictionary: Terms contained in the template dictionary are redacted in all dossiers that apply the respective dossier template.

The template dictionary is managed at admin level. Users can add/remove entries by selecting the Apply to all dossiers option when adding or removing a redaction or hint if you enable the Available in add/remove dialogs option (see below).

Available in add/edit dialogs:

Check this box if you want users to be able to select the respective dictionary from the type drop-down in the editor when adding a redaction/hint to the dossier, or to all dossiers or when editing a redaction/hint.

Case-sensitive:

Check this box if you want RedactManager to be case-sensitive when parsing and redacting documents based on this entity.





Open entity

Enter an entity to change the entity settings.

Click on the entity to open it.

The entity opens. Via the navigation menu on the left, you can then access different tabs to:

Edit or delete entity

How to change the settings of an existing entity or how to delete an entity:

  1. Hover over the dossier templates list.

  2. Stop on the dossier template you want to edit or delete.

    The Trans and the Edit buttons appear on the right.

  3. Click on the respective button.

    If you click on Trash you will be asked to confirm the deletion of the entity.

If you click on Edit, Info tab opens. It looks like the "Create entity" dialog.

Edit_and_delete_entity_4_1.png

Edit or delete entity

Table 4. Guide

Display name:

The technical name is generated automatically from the display name you enter.

Special characters are removed automatically from the technical names, as they would otherwise lead to errors during analysis.

Rank:

Decide how to rank the new entity in the entity ranking.

The rank defines which entity is given priority when dictionary entries from two different entities match the same text passage. The entity with the higher rank wins.

Redaction/hint color:

Specify the color for redactions or hints generated by RedactManager on the basis of this entity. Enter the hex code of the color or click the pencil button to select a color. The redactions/hints will then be highlighted in the selected color in the editor.

Recommendation color:

Specify the color for recommendations generated on the basis of this dictionary. Enter the hex code of the color or click the pencil button to select a color. The recommendations will then be highlighted in the selected color in the editor.

Skipped redaction color:

Specify the color for skipped redactions or skipped hints generated by RedactManager on the basis of this entity. Enter the hex code of the color or click the pencil button to select a color. The skipped redactions/hint will then be highlighted in the selected color in the editor.

Redaction/Hint:

Indicate whether the entries in the entity shall be considered redactions or hints. (Notes are markings in the document that draw the user's attention to certain facts.)

Default reason:

Enter a default reason for redactions/hints that are based on this entity.

Description:

Enter a description.

Has dictionary:

Enable the toggle if you want the entity to have a dictionary. Not every entity needs a dictionary, and it is also possible to store only rules.

If you opt for an entity with a dictionary, you can define the dictionary settings:

Table 5. Dictionary settings

Template & dossier dictionaries or Dossier dictionary only:

Select one of these options to specify whether you want to create a template and a dossier dictionary or a dossier dictionary only.

Dossier dictionary: When creating a dossier, RedactManager creates a dossier dictionary for the entity. Terms in the dictionary are redacted on dossier level.

Users can add/remove entries manually via the dictionary editor or by selecting the Redact in dossier / Remove from dossier option when adding or removing a redaction or hint if you enable the Available in add/remove dialogs option (see below).

Template dictionary: Terms contained in the template dictionary are redacted in all dossiers that apply the respective dossier template.

The template dictionary is managed at admin level. Users can add/remove entries by selecting the Apply to all dossiers option when adding or removing a redaction or hint if you enable the Available in add/remove dialogs option (see below).

Available in add/remove dialogs:

Check this box if you want users to be able to select the respective dictionary from the type drop-down in the editor when adding or removing a redaction/hint to or from the dossier, or to or from all dossiers.

Case-sensitive:

Check this box if you want RedactManager to be case-sensitive when parsing and redacting documents based on this entity.





Caution!

Be careful with deleting entities. If you delete an entity, the redaction may no longer work as intended.

In this section: