Redaction
=========

.. _RedactionConfiguration:

Redaction Configuration
-----------------------

This contains the possible redactions that we allow for a given file.

.. code-block:: json

 message RedactionConfiguration {
  RedactionType redaction_type = 1;
  bool redact_person_names = 2;
  bool redact_email = 3;
  bool redact_phone_numbers = 4;
  bool redact_credit_cards = 5;
  bool redact_iban_bic = 6;
  bool redact_organizations = 7;
  bool redact_locations = 8;
  bool redact_dates = 9;
  bool redact_times = 10;
  bool redact_currency = 11;
  bool redact_urls = 12;
  bool redact_ipv4 = 13;
  bool redact_ipv6 = 14;
  bool redact_mac_address = 15;
  bool redact_events = 16;
  bool redact_fac = 17;
  bool redact_gpe = 18;
  bool redact_law = 19;
  bool redact_norps = 20;
  bool redact_products = 21;
  bool redact_work_of_art = 22;
  bool redact_register_ids = 23;

  repeated string project_names = 30;
  repeated string company_names = 31;
  repeated string contract_names = 32;
  repeated string customers = 33;
  repeated string sellers = 34;
  repeated string tenants = 35;
  repeated string product_names = 36;

  repeated string custom_dictionary = 40;

  // Default language when reliable detection is not possible
  string language = 50;

  bool notify_admins_on_redaction = 60;
  optional string user_to_notify_on_redaction = 61;
 }

+---------------------------------+----------------------+--------------------------------------------------------------+
| Field                           | Type                 | Description                                                  |
+=================================+======================+==============================================================+
| ``redaction_type``              | ``RedactionType``    | The redaction type. See :ref:`RedactionType <RedactionType>` |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_person_names``         | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_email``                | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_phone_numbers``        | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_credit_cards``         | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_iban_bic``             | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_organizations``        | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_locations``            | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_dates``                | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_times``                | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_currency``             | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_urls``                 | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_ipv4``                 | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_ipv6``                 | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_mac_address``          | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_events``               | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_fac``                  | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_gpe``                  | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_law``                  | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_norps``                | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_products``             | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_work_of_art``          | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``redact_register_ids``         | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``project_names``               | array of ``string``  |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``company_names``               | array of ``string``  |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``contract_names``              | array of  ``string`` |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``customers``                   | array of ``string``  |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``sellers``                     | array of ``string``  |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``tenants``                     | array of ``string``  |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``product_names``               | array of ``string``  |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``custom_dictionary``           | array of ``string``  |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``language``                    | ``string``           | Default language when reliable detection is not possible     |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``notify_admins_on_redaction``  | ``bool``             |                                                              |
+---------------------------------+----------------------+--------------------------------------------------------------+
| ``user_to_notify_on_redaction`` | ``string``           | **Optional**                                                 |
+---------------------------------+----------------------+--------------------------------------------------------------+

.. _RedactionTask:

Redaction Task
--------------

A single redaction task for a single file. This one is used only internall inside the API-Server and Redaction-Server.

.. code-block:: json

 message RedactionTask {
  uint32 id = 1;
  string job_id = 2;
  string dataroom_id = 3;
  string item_id = 4;
  string parent_id = 5;
  string filename = 6;
  RedactionConfiguration redaction_configuration = 7;
  RedactionStatus status = 8;
  string error = 9;

  google.protobuf.Timestamp creation_date = 10;
  google.protobuf.Timestamp start_date = 11;
  google.protobuf.Timestamp finish_date = 12;
  optional uint32 found_entries = 13;
  // The username of the user who started the task
  string username = 14;

  // Whether this task was started via `Automatically Redact New Files`
  optional bool automatically_started = 15;
 }

+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| Field                       | Type                          | Description                                                                             |
+=============================+===============================+=========================================================================================+
| ``id``                      | ``uint32``                    |                                                                                         |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``job_id``                  | ``string``                    |                                                                                         |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``dataroom_id``             | ``string``                    |                                                                                         |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``item_id``                 | ``string``                    |                                                                                         |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``parent_id``               | ``string``                    |                                                                                         |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``filename``                | ``string``                    |                                                                                         |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``redaction_configuration`` | ``RedactionConfiguration``    | The redaction configuration. See :ref:`RedactionConfiguration <RedactionConfiguration>` |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``status``                  | ``RedactionStatus``           | The redaction status. See :ref: `RedactionStatus <RedactionStatus>`                     |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``error``                   | ``string``                    |                                                                                         |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``creation_date``           | ``google.protobuf.Timestamp`` |                                                                                         |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``start_date``              | ``google.protobuf.Timestamp`` |                                                                                         |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``finish_date``             | ``google.protobuf.Timestamp`` |                                                                                         |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``found_entries``           | ``uint32``                    | **Optional**                                                                            |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``username``                | ``string``                    | The username of the user who started the task                                           |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+
| ``automatically_started``   | ``bool``                      | **Optional.** Whether this task was started via `Automatically Redact New Files`        |
+-----------------------------+-------------------------------+-----------------------------------------------------------------------------------------+