---
title: "Installation and configuration"
description: "Install the Data Breach Response application in a workspace, configure user roles and permissions, and optionally set it as the default tab."
feature: "Data Breach Response"
audience: ["end user", "developer", "system analyst", "system administrator", "system engineer"]
version: "Relativity aiR"
type: ["User Guide", "Tutorial"]
url: "https://help.relativity.com/RelativityaiR/Content/Relativity/Data_Breach_Response/Installation_and_configuration.htm"
lastModified: "2026-11-04"
---

# Installation and configuration

Relativity installs the Data Breach Response application at the instance level. After this initial installation, you must add the application to each workspace where you plan to use it and configure user roles and permissions.

## Prerequisites

Before you begin, verify the following:

- The Control Number field is populated in the Document ID data settings field mapping before you ingest documents.
- The Extracted Text field contains all text you want analyzed. If you OCR documents, the resulting text must be stored in this field.
- The Extracted Text field is stored in [Data Grid](https://help.relativity.com/RelativityaiR/Content/Relativity/Processing/Processing_to_Data_Grid.md).

## Installation to workspaces

If you do not see the Data Breach Response application in your instance, contact your Relativity representatives (Account Executives, Customer Success Manager, etc.) to have the application installed at the instance level.

Once Relativity installs the application at the instance level, your team can install it into selected workspaces.

To add the application to a workspace:

1. Search for and open **Relativity Applications** from the Quick nav.
2. Click **New Relativity Application**.
3. Click **Select from Application Library**.
4. Search in your application library for **Data Breach Response.**
5. Select the application and install it in your workspace.

> **Notes:** Data Breach Response is not compatible with sandbox environments.

## Data Breach Response permissions

> **Note:** This feature supports feature permission actions. Each action grants access to a specific task within the feature. You can grant groups access to individual actions, allowing them to perform only the tasks they need. To grant access to the entire feature, select all of its actions. Manage feature actions on the Features tab in a group's workspace permissions. For instructions, see [Setting workspace permissions](https://help.relativity.com/RelativityaiR/Content/Relativity/Security_permissions/Setting_workspace_permissions.md). For more information about feature permissions, see [Feature permissions](https://help.relativity.com/RelativityaiR/Content/Relativity/Security_permissions/Feature_permissions.md).

![An image of feature permissions for Data Breach Response](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Data_Breach_Response/SCR_feature-permissions-DBR.png)

The following features must be granted to users for Data Breach Response:

- **Annotate PI in Document Viewer**—Select to allow users to add, edit, and delete PI annotations on documents in the Document Viewer, including manually drawing annotations and linking them to entities.
- **Manage Data Breach Response**—Select to allow users to create and manage Data Breach Response projects, including running PI detection, resolving conflicts on the Entity Analysis tab, and generating the notification report.

<details>
<summary>Data Breach Response granular permissions</summary>

We recommend two dedicated permissions groups for Data Breach Response users.

| Role | Object security | Tab visibility | Other settings |
| --- | --- | --- | --- |
| Data Breach Response - Administrator | • **Data Breach Response** - View, Annotator, Lead<br>• **Document** - View, Edit | • Blocklisting<br>• Data Analysis<br>• Data Breach Response<br>• Documents<br>• Entity Analysis<br>• Jobs<br>• Project Dashboard<br>• Settings<br>• Spreadsheet QC |   |
| Data Breach Response - User | • Data Breach Response - View, Annotator<br>• Document - View, Edit | • Documents |   |

</details>

## Set the Data Breach Response application as a default tab

Once you install the application to a workspace, you can set it as a default tab:

1. Click on Workspace Setup and select **Tabs**.
2. Find the **Data Breach Response** application.
3. Click the pencil icon to edit.
4. Enable **Visible** under *Tab Information*.
5. Enable **Show in Sidebar**under *Tab Location*.
6. Pick an icon.
7. Click **Save.**

The Data Breach Response application now appears in the sidebar.
