Privacy Settings Manage
=======================

.. contents:: Table of Contents

Privacy Settings can be found in the manage interface, underneath the *Settings* menu item.
This item only shows up if Privacy is enabled within your case.

.. note::
  To fully enable Privacy within your case please make sure you enable Privacy within the Privacy settings page *before indexing*!
  Privacy can also be enabled afterwards, but your case will need to be fully reindexed, 
  so it's better to enable it beforehand.

.. thumbnail:: /media/img/manage/caseSettings/Privacy/managePrivacySettingsOverview.png

Privacy Settings
----------------
Within this panel you can do the following:

* *Enable / Disable Privacy*

  Enabling Privacy is needed if you want to fully enable Privacy within your case.

* *Create new privacy datatab*

  This will create a seperate datatab that can function as a filter.

* *Privacy datatab name*

  The name for your privacy datatab so you can find it easily in the menu.

* *Enable / Disable use datatab as seed*

  With this option you're able to enable the datatab as a seed.

* *Own email domains*

  Adding your own email domains will make sure they are not added as a privacy record.

* *High Risk AD Groups (if AD is connected)*

  If you have an AD connected, add AD groups here that are possible high risks for your case.

* *Own bank accounts (IBANs)*

  Add own bank accounts (IBANs) so these are filtered out of the sensitive data.

.. thumbnail:: /media/img/manage/caseSettings/Privacy/managePrivacySettings.png

Privacy Patterns
----------------
Within this panel it's possible to add Privacy patterns. 
These 'patterns' are regular expressions which will capture the specified values in your data.
INDICA comes with a few standard Privacy patterns already in there, but it's also possible to add your own.

To add your own Privacy pattern click the 'Add pattern' button at the bottom of the panel. 
This will add a new, empty row with the following fields to fill in:

* *Name*

  The name you want to give your pattern. If documents fall into the pattern, this name will show up under the
  Privacy filter in the sidebar.

* *Pattern*

  The pattern you want to add. This is a standard regular expression. The actual value that is captured must
  be placed within parentheses. e.g.: selector(theValueToCapture)

* *Confidence*

  The confidence score you wish to add to pattern. This is a score between 0 (low) and 100 (high).

* *Inactive*
  
  Select this if you wish to have the Privacy pattern **not active** within your case.

* *Actions*
  
  Here you can save, restore and delete your Privacy patterns. Please **do not forget** to save your new pattern(s)

.. thumbnail:: /media/img/manage/caseSettings/Privacy/managePrivacyPatterns.png

Privacy Threat Matrix
---------------------
Within this panel it's possible to add a Privacy threat matrix.

* *Name*

  Add a name for your threat matrix

* *Collection*

  Select which collection you wish to apply the threat matrix to, or if you want to apply it to all of your collections.

* *Labels*

  Select which labels (Privacy patterns) you wish to add to this matrix.

* *Risk*

  Select which risk level applies to your threat matrix: low, medium or high.

.. thumbnail:: /media/img/manage/caseSettings/Privacy/managePrivacyThreat.png

Privacy regular vs. sensitive personal information
--------------------------------------------------
Here you can select which types are either regular or sensitive personal information.

.. thumbnail:: /media/img/manage/caseSettings/Privacy/managePrivacySensitivePersonal.png

Bag of Words
------------
Within this panel it's possible to add a "Bag of Words" as we call it.

* *Add new*

  Add a name to identify your bag of words. Every word within the bag of words should be
  surrounded by quotes.
  eg. "Word1" "Word2" "Word3"

* *Import List*

  The name for the bag of words and actual bag of words should be separated by a comma.
  eg. Name, "Word1" "Word2" "Word3"

* *Export List*
  
  It's also possible to export your bag of words list. When you decide to export your bag of words, 
  a .csv file will be downloaded.

.. thumbnail:: /media/img/manage/caseSettings/Privacy/managePrivacyBoW.png