Skip to content

Commit 365b38a

Browse files
Update privacy portal docs
- Moved Privacy detection to top to make it consistent with how these are ordered in Segment app. - Added details about classifications and their impact - Renamed "Symbol Name" to "Matcher Name" to make it consistent with UI.
1 parent 86399ed commit 365b38a

File tree

1 file changed

+99
-93
lines changed

1 file changed

+99
-93
lines changed

src/privacy/portal.md

Lines changed: 99 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -18,97 +18,6 @@ When you use Segment as the single point of collection for your customer data, y
1818

1919
Privacy Portal features are available to all Segment workspaces, however only workspace owners can access the Privacy Portal.
2020

21-
22-
## Privacy Inbox
23-
24-
The Inbox helps you keep track of new restricted data types as they are captured, quickly classify them, and build a data Inventory.
25-
26-
Segment detects these fields by scanning data from your Web, Mobile, Server, and Cloud Event Sources to detect PII based on the [default PII matchers](#default-pii-matchers). New properties sent into Segment appear in the Inbox in realtime.
27-
28-
When you view the Inbox, it displays every property that was sent into Segment from Web, Mobile, Server, and Cloud Event Sources for the past 7 days. ([Object Cloud Sources](/docs/connections/sources/#object-cloud-sources) and [Reverse ETL Sources](/docs/connections/sources/#reverse-etl-sources) do not appear in the Inbox at this time.)
29-
30-
You can click a row in the Inbox to learn more about a field and where it was collected. The expanded view shows:
31-
32-
- which events contain the field
33-
- which sources are sending the field
34-
- which matcher (and what type of matcher) detected the field
35-
- an example code snippet containing a payload that the field appears in
36-
37-
38-
![Animation of a user selecting a row in the Privacy Portal and clicking on the expanded view.](images/privacy-inbox.gif)
39-
40-
41-
To streamline the classification process, Segment pre-classifies the data in the
42-
Privacy Portal Inbox as **Red** (likely highly restricted data), **Yellow**
43-
(likely moderately restricted data), and **Green** (likely least restricted
44-
data). These colors indicate how restricted the data is for your business. You
45-
can also send and block data from flowing based on its color classification and
46-
how restricted it is.
47-
48-
Segment makes recommendations about how a field should be classified using
49-
built-in PII matcher [detection](#privacy-detection), however, you can always
50-
update the classification in the Inbox based on your company's requirements.
51-
52-
### Change a recommended classification
53-
54-
You can update the classifications to suit your needs by clicking on the color
55-
dropdown menu to change. For example, you might manually change a field that
56-
does not contain personal information in your implementation from a "Yellow"
57-
classification to "Green."
58-
59-
![Animation of a user selecting the color dropdown menu and changing the phone field from a Yellow field to a Green field.](images/privacy-inbox-change-color.gif)
60-
61-
62-
When you're satisfied that the fields have been classified appropriately, you
63-
can click `Add to Inventory` to officially apply the classification to the
64-
field. This moves the field into your [Data Inventory](#privacy-inventory),
65-
which is a central repository of all of the properties _you_ classified as Red,
66-
Yellow, and Green. Any time you send this field from a Web, Mobile, Server, or
67-
Cloud Event Source — whether from another Source or event type — the Privacy
68-
Portal automatically classifies it and adds it to the Inventory.
69-
70-
Keep in mind that if you have any Privacy Controls configured to control how you route Red data into Segment,
71-
the classifications you create in the Inbox are forwarded on to those Controls.
72-
73-
For example, if you have a Privacy Control set up to block **Red** data from your Android source, any new fields you classify in the Inbox as **Red** will be blocked from entering Segment from your Android source.
74-
75-
## Privacy Inventory
76-
77-
The Inventory is a central repository of all of the properties _you_ classified as Red, Yellow, and Green. Where the [Inbox](#privacy-inbox) shows new, unclassified data with Segment's _recommended_ classifications, the Inventory only contains data that you explicitly applied Classifications to.
78-
79-
**The Inventory is intended to be a Single Source of Truth so you can answer common regulatory questions about the data you're sending through Segment, for example:**
80-
81-
- What data am I sending into Segment, and how frequently?
82-
- How restricted is the data I'm sending through Segment?
83-
- Where is the data coming from, on a property-by-property level?
84-
- Where am I sending this data?
85-
- Who within my organization has access to each property within Segment?
86-
87-
Once you've classified the fields as Red, Yellow, and Green in the Inbox, the classified fields appear in the Inventory. You can use the filter at the top left to filter down to specific categories of data (for example, Red data, data from a production environment, data from specific sources).
88-
89-
![Animation of a user filtering the data inventory to only show red fields in their production environment that came from Clearbrain.](images/privacy-inventory-filtering.gif)
90-
91-
Click into a field (for example, `ip`) in the Inventory to open the Inventory
92-
details. The details sheet displays how many times a specific field has been
93-
sent from each Source it comes from. You can click the Events tab to see which
94-
events contained the event, along with the Sources which sent the event. The
95-
data in the side sheet updates in realtime, and includes a limited historical
96-
view.
97-
98-
You can click **Connected Destinations** to see which Destinations are
99-
connected to the Source that contains the field. The Access tab displays a list
100-
of who within your organization has access to this field.
101-
102-
103-
![Screenshot of the product_id Inventory details page in the Privacy Portal.](images/privacy-inventory-overview.png)
104-
105-
106-
Finally, workspace owners can use the **Download CSV** button to export a CSV of
107-
their data Inventory to share with their Data Protection Officer (DPO), Chief
108-
Information Security Officer (CISO), legal teams, and more! Note that the CSV
109-
download button includes _all_ data from your Inventory, and ignores any filters
110-
you applied in the UI.
111-
11221
## Privacy Detection
11322

11423
The Detection page in the Privacy Portal is where you can find out more about
@@ -197,7 +106,7 @@ treat that property whenever it is appears in data Segment processes.
197106
**To create a Custom Matcher:**
198107

199108
1. Click **Add a Custom Matcher**.
200-
2. Enter the **Symbol Name** (for example the property name, like "Social Insurance Number"). Segment matches against the **Symbol Name**, as well as the other context you provide in the next steps.
109+
2. Enter the **Matcher Name** (for example the property name, like "Social Insurance Number"). Segment matches against the **Matcher Name**, as well as the other context you provide in the next steps.
201110
3. Set the default classification:
202111
- **Red** for highly restricted
203112
- **Yellow** for moderately restricted
@@ -261,4 +170,101 @@ build new custom matchers:
261170
Segment's exact matching and fuzzy matching do not detect all variations in the received keys
262171
and for those scenarios, you can use synonyms. For example, for the value `credit card number`, you can add `credit card no`,
263172
`debit card number`, `debit card no`, or similar variations in the synonyms section to classify those fields.
264-
![Screenshot of the Synonym used in Custom Matcher.](images/privacy-synonym-in-matcher.png)
173+
![Screenshot of the Synonym used in Custom Matcher.](images/synonym-in-matcher.png)
174+
175+
## Privacy Inbox
176+
177+
The Inbox helps you keep track of new restricted data types as they are captured, quickly classify them, and build a data Inventory.
178+
179+
Segment detects these fields by scanning data from your Web, Mobile, Server, and Cloud Event Sources to detect PII based on the [default PII matchers](#default-pii-matchers). New properties sent into Segment appear in the Inbox in realtime.
180+
181+
When you view the Inbox, it displays every property that was sent into Segment from Web, Mobile, Server, and Cloud Event Sources for the past 7 days. ([Object Cloud Sources](/docs/connections/sources/#object-cloud-sources) and [Reverse ETL Sources](/docs/connections/sources/#reverse-etl-sources) do not appear in the Inbox at this time.)
182+
183+
You can click a row in the Inbox to learn more about a field and where it was collected. The expanded view shows:
184+
185+
- which events contain the field
186+
- which sources are sending the field
187+
- which matcher (and what type of matcher) detected the field
188+
- an example code snippet containing a payload that the field appears in
189+
190+
![Animation of a user selecting a row in the Privacy Portal and clicking on the expanded view.](images/privacy-inbox.gif)
191+
192+
To streamline the classification process, Segment pre-classifies the data in the
193+
Privacy Portal Inbox as **Red** (likely highly restricted data), **Yellow**
194+
(likely moderately restricted data), and **Green** (likely least restricted
195+
data). These colors indicate how restricted the data is for your business. You
196+
can also send and block data from flowing based on its color classification and
197+
how restricted it is.
198+
199+
Segment makes recommendations about how a field should be classified using
200+
built-in PII matcher [detection](#privacy-detection), however, you can always
201+
update the classification in the Inbox based on your company's requirements.
202+
203+
### Change a recommended classification
204+
205+
You can update the classifications to suit your needs by clicking on the color
206+
dropdown menu to change. For example, you might manually change a field that
207+
does not contain personal information in your implementation from a "Yellow"
208+
classification to "Green."
209+
210+
![Animation of a user selecting the color dropdown menu and changing the phone field from a Yellow field to a Green field.](images/privacy-inbox-change-color.gif)
211+
212+
When you're satisfied that the fields have been classified appropriately, you
213+
can click `Add to Inventory` to officially apply the classification to the
214+
field. This moves the field into your [Data Inventory](#privacy-inventory),
215+
which is a central repository of all of the properties _you_ classified as Red,
216+
Yellow, and Green. Any time you send this field from a Web, Mobile, Server, or
217+
Cloud Event Source — whether from another Source or event type — the Privacy
218+
Portal automatically classifies it and adds it to the Inventory.
219+
220+
### Understanding Classification types:
221+
222+
**Red Classification**:
223+
Fields that are classified as 'Red' are masked for users that do not have PII Access enabled. These fields are also blocked if you have set Standard Controls under Privacy > Settings section.
224+
225+
Keep in mind that if you have set Standard Controls to block fields from any of your sources, any new classifications you create in the Inbox will start to take affect immediately. For example, if you have a Privacy Control set up to block **Red** data from your Android source, any new fields you classify in the Inbox as **Red** will be blocked from entering Segment from your Android source.
226+
227+
**Yellow Classification**:
228+
Fields that are classified as 'Yellow' are masked for users that do not have PII Access enabled.
229+
230+
**Green Classification**:
231+
Classifying a field as 'Green' does not have any impact on the behavior of masking of fields within the Segment App, it is only available for the housekeeping purposes.
232+
233+
Once a field has been classified as "Yellow" or "Red", marking it "Green" will not make it visible for users that don't have PII access.
234+
235+
## Privacy Inventory
236+
237+
The Inventory is a central repository of all of the properties _you_ classified as Red, Yellow, and Green. Where the [Inbox](#privacy-inbox) shows new, unclassified data with Segment's _recommended_ classifications, the Inventory only contains data that you explicitly applied Classifications to.
238+
239+
**The Inventory is intended to be a Single Source of Truth so you can answer common regulatory questions about the data you're sending through Segment, for example:**
240+
241+
- What data am I sending into Segment, and how frequently?
242+
- How restricted is the data I'm sending through Segment?
243+
- Where is the data coming from, on a property-by-property level?
244+
- Where am I sending this data?
245+
- Who within my organization has access to each property within Segment?
246+
247+
Once you've classified the fields as Red, Yellow, and Green in the Inbox, the classified fields appear in the Inventory. You can use the filter at the top left to filter down to specific categories of data (for example, Red data, data from a production environment, data from specific sources).
248+
249+
![Animation of a user filtering the data inventory to only show red fields in their production environment that came from Clearbrain.](images/privacy-inventory-filtering.gif)
250+
251+
Click into a field (for example, `ip`) in the Inventory to open the Inventory
252+
details. The details sheet displays how many times a specific field has been
253+
sent from each Source it comes from. You can click the Events tab to see which
254+
events contained the event, along with the Sources which sent the event. The
255+
data in the side sheet updates in realtime, and includes a limited historical
256+
view.
257+
258+
You can click **Connected Destinations** to see which Destinations are
259+
connected to the Source that contains the field. The Access tab displays a list
260+
of who within your organization has access to this field.
261+
262+
263+
![Screenshot of the product_id Inventory details page in the Privacy Portal.](images/privacy-inventory-overview.png)
264+
265+
266+
Finally, workspace owners can use the **Download CSV** button to export a CSV of
267+
their data Inventory to share with their Data Protection Officer (DPO), Chief
268+
Information Security Officer (CISO), legal teams, and more! Note that the CSV
269+
download button includes _all_ data from your Inventory, and ignores any filters
270+
you applied in the UI.

0 commit comments

Comments
 (0)