Skip to content

Commit 4f0505c

Browse files
Update to include section on priority in blocking controls
1 parent 046507a commit 4f0505c

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

src/protocols/enforce/schema-configuration.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,19 @@ To enable blocking, go to the **Settings** tab for your source and click on **Sc
2121
>
2222
> To view all archived events, go to your **Source Schema** page, click **Filter** next to the search bar, and select **Archived**. To unarchive events that have been archived, click **Unarchive** in the event column.
2323
24+
## Order of Priority in Blocking Options
25+
26+
When setting up Schema Configuration, please note the following prioritization of blocking controls:
27+
28+
1. **Standard Schema Controls:** Initially, the system evaluates incoming events against these controls, along with your Tracking Plan. Events, properties, or traits not blocked or omitted in this phase then proceed to the next level of controls:
29+
![image](https://github.com/segmentio/segment-docs/assets/78318468/6610f54e-6a09-4252-88b9-6be414d78065)
30+
31+
2. **Advanced Blocking Controls/Common JSON Schema:** These controls are assessed after the Standard Schema Controls. They act as an essential secondary layer, evaluating incoming events against the Common JSON schema included in your Tracking Plan:
32+
![image](https://github.com/segmentio/segment-docs/assets/78318468/f12f8bd4-03f7-48bd-ab6f-1c7d85b7accf)
33+
34+
> info "Using only the Common JSON Schema to block events"
35+
> If a tracking plan is empty of events, but has Common JSON Schema rules, you do not need to use the standard schema controls. You would only need to use the Advanced Blocking Controls in your source. If you use the standard schema controls and omit properties or traits that do not exist, the Tracking Plan may not generate violations for the Common JSON Schema, as the entire Tracking Plan has nothing and everything will be considered unplanned.
36+
2437
## Track Calls - Unplanned Events
2538
When you set this dropdown to Block Event, Segment drops any events that are not defined in your Tracking Plan. Only allowlisted `track` calls in your Tracking Plan flow through Segment to your Destinations.
2639

@@ -64,9 +77,6 @@ This is an advanced feature that requires extensive testing and a squeaky clean
6477

6578
**IMPORTANT: JSON schema violation event blocking is ONLY supported in cloud-mode Destinations. Events with invalid properties will not be blocked from sending to device-mode Destinations.**
6679

67-
> info "Using only the Common JSON Schema to block events"
68-
> If a tracking plan is empty of events, but has Common JSON Schema rules, you do not need to use the standard schema controls. You would only need to use the Advanced Blocking Controls in your source. If you use the standard schema controls and omit properties or traits that do not exist, the Tracking Plan may not generate violations for the Common JSON Schema, as the entire Tracking Plan has nothing and everything will be considered unplanned.
69-
7080
## Identify Calls - Unplanned Traits
7181
Setting this dropdown to Omit Traits will ensure that traits not defined in your Tracking Plan are removed from the identify call. For example, if you specify three traits in your Tracking Plan (`name`, `email`, `join_date`), the below identify call would have the `first_name` property omitted by Protocols.
7282

0 commit comments

Comments
 (0)