Skip to content

Commit 50ce499

Browse files
authored
Merge pull request #4939 from segmentio/sarahrudy-patch-16
Update Schema Controls page
2 parents 70d6d0d + 0235f89 commit 50ce499

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

src/connections/sources/schema/index.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,30 @@
11
---
2-
title: Schema Controls
2+
title: Source Schema
33
redirect_from:
44
- '/protocols/schema/'
55
---
66

77
{% include content/plan-grid.md name="protocols" %}
88

9-
10-
Segment Business plan customers can use Schema Controls to manage which events are allowed to pass through Segment and on to Destinations. These filters are a first-line defense to help you protect the integrity of your data, and the decisions made with it.
9+
Segment Business Tier customers can use Schema Controls to manage which events are allowed to pass through Segment and on to Destinations. These filters are a first-line defense to help you protect the integrity of your data, and the decisions made with it.
1110

1211
Blocking events within the source schema will exclude them from API and MTU calculations. These events are discarded before they reach the pipeline that Segment uses for MTU calculations.
1312

13+
## Schema view
14+
15+
The Schema tab shows the schema of events, properties, and traits for each source that Segment receives over a specific timeframe. It also shows when the events were last seen, how many events were allowed vs. blocked, and the downstream destinations those events are connected to.
16+
17+
You can view events by Segment call type in the Source Schema with the **Track**, **Identify**, and **Group** tabs.
18+
The Schema tracks:
19+
- Track event details by _event_ name
20+
- Identify and Group event details by _trait_ name
21+
22+
Click the arrow to the left of the event name to view additional event properties for Page or Track events. Since the Schema tracks Identify traits, you will need to make sure you are passing traits into your Identify call in order to view event data in your schema.
23+
24+
The Schema shows "Page Viewed" for all Page calls under the **Track** tab.
25+
26+
The Source Schema UI changes slightly depending on whether you have a [Protocols Tracking Plan](https://segment.com/docs/protocols/tracking-plan/create/){:target='_blank’} connected to the source. If you have a Tracking Plan connected to your source, the UI displays a **Planned** column that will indicate if the event is planned or unplanned. This allows you to quickly identify unplanned events and take action to align your schema with your Tracking Plan. If there is no Tracking Plan connected to the source, the UI will display a toggle next to each event where, if you're a Business Tier customer, you can simply block or allow that event at the source level.
27+
1428
## Event filters
1529

1630
If you no longer want to track a specific event, you can either remove it from your code or, if you're on the Business plan and don't have a Tracking Plan connected, you can block track calls from the Segment UI. To do so, click on the Schema tab in a Source and toggle the event to enable or block an event.
@@ -24,7 +38,7 @@ If you no longer want to track a specific event, you can either remove it from y
2438

2539
Once you block an event, Segment stops forwarding it to all of your Cloud and Device-mode Destinations, including your warehouses. You can remove the events from your code at your leisure. In addition to blocking track calls, Business plan customers can block all Page and Screen calls, as well as Identify traits and Group properties.
2640

27-
When an event is blocked, the name of the event or property is added to your Schema page with a counter to show how many events have been blocked. By default, data from blocked events and properties is not recoverable. You can always re-enable the event to continue sending it to downstream Destinations.
41+
When an event is blocked, the name of the event or property is added to your Schema page with a counter to show how many events have been blocked. By default, data from blocked events and properties is not recoverable. You can always re-enable the event to continue sending it to downstream Destinations.
2842

2943
In most cases, blocking an event immediately stops that event from sending to Destinations. In rare cases, it can take **up to six hours** to fully block an event from delivering to all Destinations.
3044

@@ -62,3 +76,4 @@ Segment Business tier customers can block track calls from delivering to specifi
6276

6377

6478
![Schema integration filters](images/asset_d3SRmkWy.gif "Animation showing how to block events with the toggle switch")
79+

0 commit comments

Comments
 (0)