Skip to content

DOC 579 TP library updates #3548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/protocols/tracking-plan/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,19 @@ Tracking Plans are stored in workspaces and can be connected to one or more Sour

To create a new Tracking Plan:
1. Contact your Segment account team to enable the Protocols features in your workspace.
2. Once enabled, click on **Protocols** in the left bar navigation.
2. Once enabled, click **Protocols** in the left bar navigation.
3. Click **New Tracking Plan**.
4. Add events, properties, traits and filters in the Tracking Plan editor.
- You'll see an option to import events and traits to your tracking plan from a source in your workspace. This option is great if you want to get started with your current events. Note that Segment infers data types, but often can't if several data types are sent for a specific category.


## Copy a Tracking Plan

To create a copy of an existing Tracking Plan:

1. Click **Protocols** in the left navigation bar.
2. On the row of the Tracking Plan you want to copy, open the contextual menu(...), and select Duplicate Tracking Plan.
3. Enter a name for the new Tracking Plan instance, and click Duplicate.
### Tracking Plan Columns
The Tracking Plan editor is organized as a spreadsheet to help you add new events and properties, and edit the relevant fields for each. Like a spreadsheet, you can navigate across cells in a single event with your arrow keys and press enter to edit a cell.

Expand Down
10 changes: 3 additions & 7 deletions src/protocols/tracking-plan/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,12 @@ You can import event and property libraries into a Tracking Plan. Enter the Draf

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

### Enable Event Library syncing
### Library syncing

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

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.

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.
When you import events or properties from a 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 and properties 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 or properties. 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.

![](../images/sync_library_flow.gif)
To enable syncing, select the desired Library from the Tracking Plan import flow, and toggle the syncing option. This selects all events or properties in the Library for import. Partial syncs are not supported.

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.

Expand Down