Skip to content

Commit a2731b6

Browse files
author
markzegarelli
authored
Merge pull request #1695 from segmentio/DOC-218_update-libraries-doc
DOC-218 updates
2 parents af9570c + a8e6162 commit a2731b6

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

src/protocols/tracking-plan/libraries.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Tracking Plan Libraries
55
{% include content/plan-grid.md name="protocols" %}
66

77

8-
Tracking Plan Libraries make it easy to scale the creation of multiple Tracking Plans within your workspace. You can create libraries for track events or track event properties. Editing Tracking Plan Libraries is identical to [editing Tracking Plans](/docs/protocols/tracking-plan/create/).
8+
Tracking Plan Libraries make it easy to scale Tracking Plan creation within your workspace. You can create libraries for track events or track event properties. Editing Tracking Plan Libraries is identical to [editing Tracking Plans](/docs/protocols/tracking-plan/create/).
99

1010
> note ""
1111
> **Note**: Segment does support advanced JSON schema implementations and identify/group trait libraries.
@@ -23,32 +23,33 @@ To create a new Library:
2323

2424
### Tracking Plan Event Libraries
2525

26-
Tracking Plan Event Libraries support Track events and associated properties. Event Libraries are helpful when you want to track a group of events consistently across tracking plans. For example, if you are an eCommerce company with multiple apps, you likely need to track [eCommerce Spec](/docs/connections/spec/ecommerce/v2/) events consistently across those sources. Instead of having to re-create the eCommerce spec across multiple tracking plans, simply create a library and import the events to each Tracking Plan.
26+
Tracking Plan Event Libraries support Track events and associated properties. Event Libraries are helpful when you want to track a group of events consistently across tracking plans. For example, if you are an eCommerce company with more than one application, you may need to track [eCommerce Spec](/docs/connections/spec/ecommerce/v2/) events consistently across those sources. Instead of needing to re-create the eCommerce spec across all tracking plans, create a library and import the events to each Tracking Plan.
2727

2828
### Tracking Plan Property Libraries
2929

30-
Tracking Plan property Libraries support Track event property groups. Property Libraries are helpful when you have many events in a Tracking Plan that share a common set of properties. For example, if you want to consistently include `order_id`, `currency`, `cart_id` and a `products` array of objects in your checkout flow events, you can create a Library with these properties including descriptions, data types and conditional filters.
30+
Tracking Plan property Libraries support Track event property groups. Property Libraries are helpful when you have more than one event in a Tracking Plan that share a common set of properties. For example, if you want to consistently include `order_id`, `currency`, `cart_id` and a `products` array of objects in your checkout flow events, you can create a Library with these properties including descriptions, data types and conditional filters.
3131

32-
### Importing Libraries into a Tracking Plan
32+
### Import Libraries into a Tracking Plan
3333

34-
Event and property libraries can be easily imported into a Tracking Plan. Enter the Draft mode for a Tracking Plan and click the **Import from Event or Property Library** dropdown. A wizard will appear allowing you to either add the events to a tracking plan, or add properties to selected events already in the tracking plan. After adding your events or properties, remember to merge your changes!
34+
You can import event and property libraries into a Tracking Plan. Enter the Draft mode for a Tracking Plan and click the **Import from Event or Property Library** dropdown. A wizard will appear allowing you to either add the events to a tracking plan, or add properties to selected events already in the tracking plan. After adding your events or properties, remember to merge your changes!
3535

3636
![](../images/import_library_to_tracking_plan.gif)
3737

38-
### Enabling Library Syncing
38+
### Enable Event Library syncing
3939

40-
When importing events from a Library, you can enable syncing to ensure that changes made to the Library are passed down to all "synced" Tracking Plans. Syncing is especially important when you want to make sure all your Tracking Plans define events consistently. For example, it's best practice to create separate tracking plans for mobile and web sources as these two sources share some but not all events. Library syncing is the best way to ensure that the shared events are consistently tracked across Tracking Plans, even as changes are made to the Library.
40+
> warning ""
41+
> [Property Library](/docs/protocols/tracking-plan/libraries/) syncing is **not** supported.
42+
43+
When you import events from an Event Library, you can enable syncing to ensure that changes made to the Library pass down to all synced Tracking plans.Syncing is important when you want to make sure all Tracking Plans define events consistently. For example, it's best practice to create separate tracking plans for mobile and web sources as these two sources share some but not all events. Library syncing is the best way to ensure that the shared events are consistently tracked across Tracking Plans, even as you make changes to the Library.
4144

42-
To enable syncing, simply select the desired Library from the Tracking Plan import flow, and toggle the syncing option. Doing so will automatically select all events in the Library to be imported. Partial syncs are not supported as it would make it impossible to ensure complete compliance with the Library.
45+
To enable syncing, select the desired Library from the Tracking Plan import flow, and toggle the syncing option. This selects all events in the Library for import. Partial syncs are not supported as it would make it impossible to ensure complete compliance with the Library.
4346

4447
![](../images/sync_library_flow.gif)
4548

46-
When synced, events and properties from the synced Library cannot be edited and the Tracking Plan merge step is bypassed. Properties can however be added to synced events. Synced events cannot be removed unless the Library sync is removed. To unsync a library, click View Synced Libraries from the Tracking Plan and click the overflow menu to unsync the Library.
49+
Syncing a Library makes events and properties un-editable, and bypasses the Tracking Plan merge step. You can add properties to synced events, but cannot remove those synced events unless you also remove the Library sync. To unsync a library, click **View Synced Libraries** from the Tracking Plan and click the overflow menu to unsync the Library.
4750

4851
> warning ""
49-
> All changes made to a synced library will immediately pass through to the Tracking Plans and may impact data deliverability
52+
> All changes made to a synced library pass through to the Tracking Plans and may impact data deliverability
5053
5154
![](../images/unsync_library.png)
5255

53-
> warning ""
54-
> [Property Library](/docs/protocols/tracking-plan/libraries/) syncing is **not** currently supported.

0 commit comments

Comments
 (0)