Skip to content

Commit bd3f05c

Browse files
Merge pull request #5825 from segmentio/ashton-huxtable-patch-4
Add info on Common JSON schema blocking
2 parents 922ee5c + 3282f74 commit bd3f05c

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

src/protocols/enforce/schema-configuration.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,21 @@ 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, note that Segment prioritizes blocking controls in the following order:
27+
28+
1. **Standard Schema Controls**: Segment first evaluates incoming events against these controls and your Tracking Plan. Events, properties, or traits not blocked or omitted in this phase then flow to the next level of controls: the Advanced Blocking Controls/Common JSON Schema.
29+
![A screenshot of the Uplanned Events, Properties and Values table, which contains unplanned events, unplanned properties/traits, and JSON schema violation columns.](../images/standard-schema-controls.png)
30+
31+
2. **Advanced Blocking Controls/Common JSON Schema:** These controls act as a secondary layer, evaluating incoming events against the Common JSON schema included in your Tracking Plan.
32+
![A screenshot of the Advanced Blocking Controls table, which contains two columns: call type and common JSON schema violations.](../images/advanced-blocking-controls.png)
33+
34+
> info "Using only the Common JSON Schema to block events"
35+
> If your Tracking Plan only has Common JSON Schema rules, you only need to use the Advanced Blocking Controls for your source.
36+
>
37+
> If you use the Standard Schema Controls and omit properties or traits that do not exist, the Tracking Plan might not generate violations for the Common JSON Schema, as the entire Tracking Plan has nothing and everything is considered to be "unplanned".
38+
2439
## Track Calls - Unplanned Events
2540
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.
2641

14.3 KB
Loading
26.2 KB
Loading

0 commit comments

Comments
 (0)