Skip to main content

RedactManager Documentation

Entities

The dossier templates contain entities with dictionaries. These define what will be redacted in the dossiers that apply the respective dossier template.

How to get there:

User menu > Settings > Dossier Templates >Select dossier template > Entities

A list of entities will be displayed:

Entities_list_3_4-en.png

Entity list

Inside each entity, you will find the following tabs:

  • Info

  • Dictionary

  • False Positive

  • False Recommendations

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

What can you do?

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's properties. Mandatory fields are marked with a red asterisk.

  3. Finally, click Save Entity.

Create_entity_dialog_3_4-en.png

"Create Entity" dialog

Guide:

Technical Name/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.

Hex-Code Redaction/Hint:

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

Hex-Code Skipped Redaction/Skipped Hint:

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 must contain a dictionary. It is also possible to store only rules.

Case Sensitive:

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

Enable 'Add to dictionary':

Check this box if you want to allow users to add new entries to the entity's dictionaries.

Edit properties of an entity or delete entity

How to change the properties 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 without clicking on it.

    The Edit and the Trash buttons appear on the right.

  3. Click on the respective button.

    A dialog opens. It looks exactly like the "Create Entity" dialog.

Edit_and_delete_entity_3_4-en.png

Edit or delete entity

Guide:

Technical Name/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.

Hex-Code Redaction/Hint:

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

Hex-Code Skipped Redaction/Skipped Hint:

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 must contain a dictionary. It is also possible to store only rules.

Case Sensitive:

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

Enable 'Add to dictionary':

Check this box if you want to allow users to add new entries to the entity's dictionaries.

Caution!

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

In this section: