You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/protocols/tracking-plan/create.md
+42-29Lines changed: 42 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,48 @@ To download a Tracking Plan:
42
42
4. Open the Download History page by clicking the link in the toast or clicking the **Download History** tab in the top navigation bar.
43
43
5. Once the file status column indicates that the download was successful, click the link in the File column to download your CSV to your computer. If the file status column shows the download has failed, return to the Tracking Plan Overview page or the Tracking Plan page and try the download again.<br/> The Tracking Plan CSV name has the following format:<br/>`workspaceSlug-trackingPlanName--yyyy-mm-dd--hh-mm-utc`
44
44
45
-
Once you've downloaded a Tracking Plan, you can use it as a template to make changes to the Tracking Plan, which you can then [upload back to your Tracking Plan](#upload-a-tracking-plan) to directly apply your changes.
45
+
Once you've downloaded a Tracking Plan, you can [upload it](#upload-a-tracking-plan) as a template for a new Tracking Plan or use it to make changes to an existing Tracking Plan.
46
+
47
+
## Upload a Tracking Plan
48
+
49
+
You can create a Tracking Plan or make changes to an existing Tracking Plan by uploading a CSV that contains the rules and events you'd like to track. Segment provides a Tracking Plan template file that you can download during the import process, or you can [download an existing Tracking Plan](#download-a-tracking-plan) to use as your template.
50
+
51
+
### Create a new Tracking Plan
52
+
To create a new Tracking Plan by uploading a CSV file:
53
+
1. Click **Protocols** in the left navigation bar.
54
+
2. Click **New Tracking Plan**.
55
+
4. Click the **Import...** button and select **From CSV**.
56
+
5. Download the Tracking Plan template CSV and fill in the template file with your new Tracking Plan rules, or [download an existing Tracking Plan](#download-a-tracking-plan).
57
+
6. Once you've filled in the provided template or made changes to your downloaded Tracking Plan, add your CSV file to the file uploader and click **Upload**.
58
+
59
+
Any new Tracking Plans created by an uploaded file are reflected in the [Tracking Plan changelog](/docs/protocols/faq/#how-can-i-see-who-made-changes-to-my-tracking-plan) and [Audit Trail](docs/segment-app/iam/audit-trail/).
60
+
61
+
### Update an existing Tracking Plan
62
+
63
+
> info "Tracking Plans with imported libraries cannot be changed using the Upload a Tracking Plan method"
64
+
> If you have a Tracking Plan with imported libraries, you must make changes to your Tracking Plan in the Segment app.
65
+
66
+
To update a Tracking Plan by uploading a CSV file:
67
+
1. Click **Protocols** in the left navigation bar.
68
+
2. On the row of the Tracking Plan you want to edit, open the contextual menu(...) and select **View Tracking Plan**.
69
+
3. Select **Edit Tracking Plan**.
70
+
4. Click the **Import...** button and select **From CSV**.
71
+
5. Download the Tracking Plan template CSV and fill in the template file with your new Tracking Plan rules, or [download an existing Tracking Plan](#download-a-tracking-plan).
72
+
6. Once you've filled in the provided template or made changes to your downloaded Tracking Plan, add your CSV file to the file uploader and click **Upload**.
73
+
74
+
Any changes made to a Tracking Plan using an uploaded file are reflected in the [Tracking Plan changelog](/docs/protocols/faq/#how-can-i-see-who-made-changes-to-my-tracking-plan) and [Audit Trail](docs/segment-app/iam/audit-trail/).
75
+
76
+
### Troubleshooting Tracking Plan uploads
77
+
After uploading your CSV file, you are redirected to the Upload & Download History page while the upload is in progress. If the CSV upload fails due to issues with the content of your Tracking Plan, you can download the file `error_report.csv`, which provides you the error in the "Error Details" column of your CSV file. If the upload fails due to issues with the uploaded file itself (a file that is too large, has too many rows, or is not a CSV file, for example), you'll be able to view the error directly in the Reports column.
78
+
79
+
Common reasons a CSV upload may fail include:
80
+
- A filetype other than .csv
81
+
- More than one file uploaded at a time
82
+
- A file that is empty besides the header row
83
+
- A CSV file that exceeds 100,000 rows
84
+
- A CSV file with more than 20,000 rules
85
+
- A CSV file with duplicate headers
86
+
- A CSV file that is larger than 15 mb
46
87
47
88
## Delete a Tracking Plan
48
89
@@ -89,34 +130,6 @@ You can define which traits you expect to see passed in Identify or Group calls
89
130
90
131
It's best to keep traits optional because Identify and Group are often called and pass only _new or changed_ traits, because Segment's client-side libraries (analytics.js, Swift, Kotlin) cache traits in local storage. See the [Identify Best Practices](/docs/connections/spec/best-practices-identify#when-and-how-often-to-call-identify) to learn more.
91
132
92
-
### Upload a Tracking Plan
93
-
94
-
You can make changes to a Tracking Plan by uploading a CSV to replace the rules of your existing Tracking Plan.
95
-
96
-
> info "Tracking Plans with imported libraries cannot be changed using the Upload a Tracking Plan method"
97
-
> If you have a Tracking Plan with imported libraries, you must make changes to your Tracking Plan in the Segment app.
98
-
99
-
To update a Tracking Plan by uploading a CSV file:
100
-
1. Click **Protocols** in the left navigation bar.
101
-
2. On the row of the Tracking Plan you want to edit, open the contextual menu(...) and select **View Tracking Plan**.
102
-
3. Select **Edit Tracking Plan**.
103
-
4. Click the **Import...** button and select **From CSV**.
104
-
5. Download the Tracking Plan template CSV and fill in the template CSV file with your new Tracking Plan rules, or make changes to your [downloaded Tracking Plan](#download-a-tracking-plan).
105
-
6. Once you've filled in the provided template or made changes to your downloaded Tracking Plan, add your CSV file to the file uploader and click **Upload**.
106
-
107
-
After uploading your CSV file, you are redirected to the Upload & Download History page while the upload is in progress. If the CSV upload fails due to issues with the content of your Tracking Plan, you can download the file `error_report.csv`, which provides you the error in the "Error Details" column of your CSV file. If the upload fails due to issues with the uploaded file itself (a file that is too large, has too many rows, or is not a CSV file, for example), you'll be able to view the error directly in the Reports column.
108
-
109
-
Common reasons a CSV upload may fail include:
110
-
- A filetype other than .csv
111
-
- More than one file uploaded at a time
112
-
- A file that is empty besides the header row
113
-
- A CSV file that exceeds 100,000 rows
114
-
- A CSV file with more than 20,000 rules
115
-
- A CSV file with duplicate headers
116
-
- A CSV file that is larger than 15 mb
117
-
118
-
Any changes made to a Tracking Plan through an uploaded file are reflected in the [Tracking Plan changelog](/docs/protocols/faq/#how-can-i-see-who-made-changes-to-my-tracking-plan) and [Audit Trail](docs/segment-app/iam/audit-trail/).
119
-
120
133
### Remove a source from your Tracking Plan
121
134
122
135
> info "Removing a source from a Tracking Plan requires Workspace Owner or Tracking Plan Admin permissions"
0 commit comments