Skip to main content

How to create a dictionary

Create a dictionary of phrases that trigger policy flagging.

H
Written by Harriet Christie

Summary

A dictionary is a list of keyword phrases that policies use to flag messages. In the Lexicon area you can create a new dictionary, add phrases by typing them or pasting from a spreadsheet, and choose how each phrase is matched. Once created, a dictionary can be attached to one or more policies.

Prerequisites

  • Access to MirrorWeb Insight

  • Dictionary write permission (the Create dictionary button is disabled with the tooltip "You don't have access to create dictionaries" if you lack this)

Step-by-Step Instructions

Step 1: Open the Dictionaries page

Navigate to the Dictionaries page under Lexicon. The page heading reads Dictionaries with the subtitle "Manage keyword dictionaries".

The Dictionaries page showing the Create dictionary button

Step 2: Start a new dictionary

Click the Create dictionary button in the top-right. If no dictionaries exist yet, you can also use the Add dictionary button in the empty state. The New dictionary form opens with the subtitle "Create a new dictionary of flagging terms".

The New dictionary form

Step 3: Enter the dictionary details

In the Details panel on the right:

  1. Enter a Dictionary name.

  2. Set the Match type using the toggle, which offers Any or All.

NOTE: Match type "Any" flags a message when at least one phrase in the dictionary matches. "All" requires every phrase in the dictionary to match.

The Details panel with the dictionary name field and Any/All match type toggle

Step 4: Add phrases to the dictionary

In the Dictionary of terms panel, use the table to enter phrases. As the helper text states, you can "Create a new dictionary from scratch or paste values from a CSV or excel document." The table has columns labelled phrase, plural, and prefix:

  1. Type a phrase in the phrase column (or paste multiple rows from a spreadsheet).

  2. Tick plural to also match the plural form of the phrase.

  3. Tick prefix to also match the phrase as a prefix.

  4. Use the + and - buttons below the table to add or remove rows.

The Dictionary of terms table with phrase, plural, and prefix columns

Step 5: Create the dictionary

Click Create dictionary. While saving, the button shows "Creating...". You are returned to the Dictionaries list when it succeeds.

The completed dictionary form with the Create dictionary button

Notes

NOTE: Phrase matching depends on the options selected. A single-word phrase matches exactly on a word boundary; prefix matches tokens that start with the phrase (but not an identical token); plural auto-generates the +s, +es, and y→ies forms; a multi-word phrase is matched as a substring (not word-boundary aware).

IMPORTANT: Dictionaries are evaluated by policies at ingest time only. Changes are not applied retroactively to messages that have already been processed, and import messages skip flagging entirely.

NOTE: Dictionary names must be unique per organisation.

Did this answer your question?