Add Import Tracking Plan docs [DOC-687] #5678
Conversation
forstisabella
requested review from
ranand,
a team and
pwseg
and removed request for
a team
✅ Deploy Preview for segment-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| 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). | ||
| 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**. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
@chenxzhang - do we wanna capture common cases in which we generate error_report.csv and cases when we show the error in the upload ui itself?
There was a problem hiding this comment.
Technically there are 3 types of errors: upload ui validation, upload & download history error for the general file itself, and upload & download history error report with specific error details.
- upload ui validation (this happens as you upload the file from your local computer)
Common reasons for error:
- A filetype other than .csv
- An empty file
- A file that is empty besides the header row
- A CSV file that exceeds 100,000 rows
- A CSV file that does not have the expected number of columns/headers
- File name exceeding 80 characters
- upload & download history error for the general file itself
- A CSV file that exceeds 2,000 rules
- A malformed CSV file (rows have different columns)
- Internal system errors
- upload & download history that generates error_report
- Invalid label format (should be label:value)
- Invalid nested property (should be an object or array)
There was a problem hiding this comment.
Thanks for the tag!
I'll add a note under the "Upload a Tracking Plan" header with file size/formatting requirements, and make some changes to the troubleshooting section to slim it down.
There was a problem hiding this comment.
Changes LGTM. Thanks for incorporating them!
There was a problem hiding this comment.
sweet! glad to hear it
Proposed changes
Added "Import Tracking Plan" docs
Merge timing
December 11, 2023
Related issues (optional)
#4629