Skip to content

Dictionaries

Dictionaries contain values to identify data elements in resources by matching against data content or name of resources.

Some examples of dictionary are:

  • A dictionary of US person names that can be used to identify a column of person names in a database by matching with the values in that column.

  • A dictionary of typical column name patterns that can be used to identify a column of account IDs in a database by pattern matching with the column name.

A dictionary has a list of values to perform different actions based on those values. The dictionary has a type that determines how the values in the dictionary are used.

Dictionaries support multiple include/exclude patterns. This helps enable a longer-term transition from conventional patterns for pattern matching. For example, the 'email' conventional pattern and its associated structured/unstructured rules can be disabled, and the same pattern value can be added as part of a new dictionary lookup. Resulting rules can then be configured just as conventional patterns.

Dictionary Types#

A dictionary has the following fields:

  • Type. There are three types of dictionaries: exact match, fuzzy match, pattern match
    • With exact match, the value of the data must exactly match the value in the dictionary.
    • With fuzzy match, the matching is based on fuzzy logic instead of exact match.
    • With pattern match, the values in the dictionary are regexes.
  • Apply For  indicates whether the dictionary should be applied to data content or to the name of a resource: Content or Metaname.

Structure of Dictionary#

A dictionary is identified by:

  • Name
  • Key: The key is used in Discovery rules to associate a tag with a resource element. Because a dictionary can be applied to either content or metaname, a naming convention is used for the key:
    • Content dictionary: LOOKUP suffix.
    • Metaname dictionary: KEYWORD suffix.

Managing Dictionaries#

Privacera comes with a set of useful dictionaries. You can create your custom dictionaries and configure Discovery rules to use them. For smaller dictionaries you can create the dictionary and add values through portal, either one by one or with the bulk input interface where you can paste a list of values.

  • For pre-supplied dictionaries or custom dictionaries that are file-based, you can add additional values or exclude existing values via the portal user interface.
  • The values in a dictionary can come from a text file that can be uploaded through the portal or can be directly copied into your installation.

When a dictionary is created or modified, the updated dictionary becomes available for use within a few minutes.

Add Dictionary#

To add a dictionary:

  1. On the Dictionaries page, click the + sign.

    The Add Dictionary dialog is displayed.

  2. Enter the following details:

    • Enter the Name of dictionary (required)
    • Enter the Description of dictionary.
    • The Key field is not editable because it is populated by the system. You have the option to add IPv4 and IPv6 address regexes as an option under Key description for regexes and used to lookup dictionary content.
    • Enter the required File name.
  3. Select the required Type. The choices are Exact, Pattern, or Fuzzy Match.

  4. Select Apply For. The choices are content or metaname. If you select metaname, for pattern type dictionaries, you have the choice to apply the input tags directly to the resource. See Add Meta Tags Directly to Dictionary.

  5. Select the Status (enabled by default).
  6. Click Save.

The dictionary is added.

Add Meta Tags Directly to Dictionary#

When you create a new dictionary of type pattern, you can apply meta tags directly to a data source. The option appears after you select the combination of pattern and metaname.

Upload Dictionary#

To upload a dictionary:

  1. In the Dictionaries page, click Upload Dictionary.

  2. The Upload Dictionary dialog is displayed.

  3. Browse and select the .txt file.

  4. Click Save.

The dictionary file is uploaded.

Edit Dictionary#

To edit a dictionary:

  1. In the Dictionaries page, select a dictionary from the dictionary list and click Edit.

  2. The Edit Dictionary Info dialog is displayed.

  3. Update the required fields.

  4. Click Save.

The dictionary is updated.

Copy Dictionary#

To make a copy of a dictionary:

  1. On the Dictionary page, select a dictionary from the dictionary list and click Create Copy.

  2. The Copy Dictionary Info dialog is displayed with selected Type and Apply For** values.

  3. Enter the following details:

    • Enter the Name dictionary (required).

    • Enter the Description of dictionary.

    • Enter the File name (required).

    • Select the Type (required).

    • Select the Apply For (required).

    • Select the Status (enabled by default)

  4. Click Save.

A copy of the dictionary is created.

Enable, Disable, Search, Show Details, Tour#

  • To enable/disable a dictionary, on the Dictionaries page, select a dictionary from the dictionary list, click Status, and toggle enable/disable.
  • To search for a dictionary, on the Dictionaries page, enter the dictionary name in the search filter and press Enter.

  • To view dictionary details for either included or excluded dictionaries, click Show Details.

  • To see an explanation of the different components of a dictionary, click Tour.

Include Dictionary#

You can filter the list of included dictionaries using the search included dictionary option. This tab also displays the current count of records relying on the dictionary. 

The  Include Dictionary tab displays the following:

  • Name: Name of the dictionary.

  • Description: The lookup/keyword description.

  • Actions: Edit or delete dictionaries.

  • Bulk Edit/Delete: Select this to edit or delete the dictionary values in bulk. After selecting, click x to delete the values.

Add Keyword to Included Dictionary#

To add a keyword/lookup under Include Dictionary:

  1. On the Dictionaries page, select a dictionary from the dictionary list.
  2. Under Include Dictionary, click +Add.

    The Add Dictionary dialog is displayed.

  3. Enter the name of the keyword/lookup, one name per line.

  4. Add a Description for the dictionary name.
  5. Click Save.

The keyword/lookup is added to the selected dictionary under Include Dictionary tab.

Exclude Dictionary#

You can filter the list of excluded dictionaries using the search excluded dictionary option. This tab also displays the total record count.

The Exclude Dictionary tab has the following:

  • Name: This indicates name of the dictionary.

  • Actions: This allows you to edit the dictionary as well as you can delete the dictionary on clicking the respective icon under Actions column.

To add a lookup under the Exclude Dictionary:

  1. On the Dictionaries page, select a dictionary from the dictionary list.
  2. Under Exclude Dictionary, click +Add.
  3. In the Add Dictionary dialog, enter the names of dictionary, one name per line.
  4. Add the Description for the dictionary.
  5. Click Save.

The lookup is added to the selected dictionary.

Import Dictionary#

To import a dictionary in JSON format:

  1. On the Discovery page, click Import.
    The Import dialog is displayed.
  2. Browse and select the JSON file and click Save.

The dictionary configuration file is imported.

Export Dictionary#

To export a dictionary in JSON format:

  1. On the Dictionaries page, click Export .

  2. Check the checkbox of the required dictionary and click Export. You can select multiple dictionaries.

The dictionary file is exported.

Testing Dictionaries#

Pattern Validation#

If the dictionary is of type pattern, you can validate its regexes.

To validate a pattern:

  1. In the Dictionaries page, add a new dictionary of type 'Patterns'.

    The Add Dictionary field for the pattern type is displayed.

  2. Enter a complex Expression (regex).

  3. Enter the Description for the expression.

  4. Enter the Input Test Data.

  5. Click Test Expression.

The message "Passed" or "Failed" appears in the Test Output field.

Test Against Data Source#

To test changes to a dictionary:

  1. Perform an offline scan of the data source that has sensitive fields you want to test.
  2. Check the Scan Status.
  3. After the scan is completed, open the resource to verify if the scan classified the tags correctly.

The tags are classified under Data Inventory > Classification.

List of Privacera-supplied Dictionaries#

The following is a list of the Privacera-supplied dictionaries. The name of a dictionary in general describes the purpose of the dictionary. For precise details, look at the dictionary itself in the Platform UI.

  • AU_BSB_LOOKUP
  • BINARY_MIME_KEYWORD
  • CC_KEYWORD
  • CC_PROTECTED_KEYWORDDisabled
  • CITY_KEYWORD
  • COUNTY_KEYWORD
  • CRIMINAL_RECORD_LOOKUP
  • DISALLOW_DOB_KEYWORDDisabled
  • DISALLOW_NAME_KEYWORDDisabled
  • DISALLOW_ZIP_KEYWORDDisabled
  • DOB_KEYWORD
  • ETHNICITY_LOOKUP
  • EXEC_MIME_KEYWORD
  • GEO_KEYWORD
  • GPS_KEYWORD
  • IMAGE_MIME_KEYWORD
  • ISO3166_CC_LOOKUP
  • MEDICAL_RECORD_LOOKUP
  • ORG_LOOKUP
  • PASSPORT_KEYWORD
  • PASSWORD_KEYWORD
  • PERSON_NAME_KEYWORD
  • PERSON_NAME_LOOKUP
  • PII_ID_KEYWORD
  • SSN_KEYWORD
  • STATE_KEYWORD
  • SWIFT_BIC_KEYWORDDisabled
  • SWIFT_BIC_LOOKUPDisabled
  • TAX_ID_KEYWORD
  • UK_ELECTORAL_ROLL_KEYWORDDisabled
  • UK_NHS_KEYWORDDisabled
  • UK_NINO_KEYWORDDisabled
  • UK_POSTAL_TOWN_LOOKUPDisabled
  • US_ABA_NUMBER_KEYWORDDisabled
  • US_ADDRESS_KEYWORD
  • US_CITY_KEYWORD
  • US_CITY_LOOKUP
  • US_COUNTY_KEYWORDDisabled
  • US_COUNTY_LOOKUPDisabled
  • US_DLICENSE_KEYWORD
  • US_DLICENSE_LOOKUP
  • US_STATE_KEYWORD
  • US_STATE_LOOKUP
  • US_ZIP_KEYWORD
  • US_ZIP_LOOKUP

Last update: July 23, 2021