Tracking plan spreadsheet

Configure your tracking plan with our tracking plan spreadsheet.

By default, the Tracking Plan configuration is in JSON format. The Tracking Plan spreadsheet is a no-code, spreadsheet representation of your Tracking Plan configuration. It lets you easily create or use an existing Tracking Plan.

success
To use the Tracking Plan spreadsheet, go to the spreadsheet and click File > Make a copy in the Google Sheets menu.

This guide details the various options and spreadsheet settings that let you configure your Tracking Plan.

Spreadsheet overview

info
The Tracking Plan spreadsheet uses the Google Sheets’ scripts functionality to integrate with the RudderStack Tracking Plan API.

The configuration settings for your Tracking Plan are listed in the Homepage and Additional Features tabs of the Tracking Plan spreadsheet. They are linked to the actions listed in the RudderStack Tracking Plan menu in the Google Sheets top bar:

Tracking Plan menu
info
The Tracking Plan spreadsheet currently supports only simple datatypes (strings, numbers, Boolean, arrays, and objects).
success
You can create, delete, or update the events or the properties within these events. Once you upload the changes, RudderStack creates a new version of the Tracking Plan to keep track of your changes.

Creating a Tracking Plan from existing event data

RudderStack lets you create a Tracking Plan from an existing event data source. This option uses the Data Governance API and the Tracking API features to generate an initial plan.

success
This is the easiest way to kickstart your Tracking Plan program without having to start from scratch.

To create a Tracking Plan from an existing RudderStack source, follow these steps:

  1. Go to the Additional Features tab of your Tracking Plan spreadsheet.

  2. Under Create Tracking Plan from Existing Source, enter the following settings:

    • Data Plane URL: Enter the data plane URL of your workspace or where the data plane is hosted.
    • Write key: Enter the write key for the RudderStack source. You can find it in the Sources page.
    • Username: Enter your admin username.
    • Password: Enter your admin password.
    • Tracking Plan Name: Assign a name to this Tracking Plan.
warning
The Username and Password are your Grafana dashboard credentials and not your RudderStack account credentials. If you are unsure, contact your Account Manager.
  1. Click the RudderStack Tracking Plan > Create Tracking Plan from Existing Source Events option in the top bar to create a new Tracking Plan.
info
For the first time you use the Tracking Plan spreadsheet, you will be prompted with an approval request. Select Allow to permit Google Apps to execute the scripts. Refer to the Google Apps Permissions section below for more information.
  1. To verify if the Tracking Plan is created, refer to the Getting the Tracking Plans section below.

Getting the Tracking Plans

To get a list of all your existing Tracking Plans, go to RudderStack Tracking Plan > Show All Tracking Plans.

This option lists all your existing Tracking Plans along with their respective Tracking Plan IDs in the List of Tracking Plans sheet.

Downloading existing Tracking Plans from RudderStack

To download existing Tracking Plans from RudderStack, follow these steps:

  1. Get a list of all your Tracking Plans by going to RudderStack Tracking Plan > Show All Tracking Plans. Note the Tracking Plan ID.
  2. Go to the Download Tracking Plan from RudderStack option in the spreadsheet and enter the Tracking Plan ID:
Download Tracking Plan
  1. Click RudderStack Tracking Plan > Download Tracking Plan from RudderStack in the top bar.

This will create a new sheet with your Tracking Plan.

Uploading a Tracking Plan to RudderStack

success
You can use this option to create or update a Tracking Plan.

To upload a Tracking Plan to RudderStack, follow these steps:

  1. Go to the Upload Tracking Plan to RudderStack section in the Homepage tab of your spreadsheet.
Upload Tracking Plan
  1. Enter the following settings:

    • Sheet Name (for Upload): Enter the tab name of the sheet containing the Tracking Plan.
    • Tracking Plan name: Enter the name of the Tracking Plan you want to upload to RudderStack.
info
RudderStack will create a new Tracking Plan if the name does not exist.
  1. Upload the Tracking Plan by going to RudderStack Tracking Plan > Upload Tracking Plan to RudderStack in the top bar.

Linking Tracking Plan to a source

When you link a Tracking Plan to a source, all events will be processed in accordance with that plan.

info
This option lets you define the events that will be allowed to pass through or dropped by RudderStack, and the permissible errors in the event’s context field.
info
Refer to the Server-side validation section below for more information on how RudderStack enforces the Tracking Plans on your source events.

To link a Tracking Plan to a source, follow these steps:

  1. In the Additional Features tab, go to the Link Tracking Plan to Source.

  2. Then, enter the following settings:

    • Tracking Plan ID: Enter the Tracking Plan ID. Refer to the Getting the Tracking Plans section for more information.
    • Source ID: Enter your source ID. The following image highlights the source ID’s location in the RudderStack dashboard:
Source ID
warning
A source ID uniquely identifies a RudderStack source. It is different to the source write key which is used by RudderStack to send events from the source to your specified destinations.

Global settings

  1. Specify the following settings under Global Settings (applicable for all events):

    • Allow unplanned events: This setting has the following options:
    OptionDescription
    TRUERudderStack will not drop the events not defined in your Tracking Plan
    FALSERudderStack will drop the events not defined in the Tracking Plan.
    • Unplanned Properties: This setting has the following options:
    OptionDescription
    FORWARDThe event’s context field will be updated with the erroneous/unplanned property and forwarded to RudderStack.
    DROPRudderStack will drop the event containing the unplanned properties.
    • Other Violations: These violations include discrepancies such as type mismatch, missing required properties, etc.
    OptionDescription
    FORWARDThe event’s context field will be updated with these violations and forwarded to RudderStack.
    DROPRudderStack will drop the event containing the violations.
    • Propagate Errors: This setting has the following options:
    OptionDescription
    TRUEThe validation errors are captured in the event’s context and sent downstream (user transformations, destinations)
    FALSERudderStack will drop the event containing the validation errors.
info
You can use Settings for track to explicitly define the Tracking Plan rules for track events.
  1. After finalizing the settings, go to RudderStack Tracking Plan > Link Tracking Plan to Source in the top bar.

Other spreadsheet settings

This section contains the noteworthy spreadsheet settings required to interact with your Tracking Plan.

API key settings (Global)

  • API Personal Access Token: Enter your Personal Access Token obtained from the RudderStack dashboard.
Personal Access Token
info
For more information, refer to the Personal Access Token documentation.
  • Email: Enter the email ID associated with your RudderStack account.

Advanced settings

These settings define how RudderStack should pick the data (event/property values) from the Tracking Plan.

warning
Do not change these settings unless absolutely necessary as it may impact the entire Tracking Plan workflow.

Google Apps permissions

When you run the RudderStack Tracking Plan menu options for the first time, Google Apps will prompt you to authorize the scripts using the Tracking Plan API.

Google Apps permissions

Click Allow to set the permissions required for the script to work.

Server-side validation

RudderStack uses server-side validation to enforce your Tracking Plans. When you link a Tracking Plan to a source, RudderStack will check all new events against the Tracking Plan.

The validation adds two new columns for each table and each row that specify:

  • Which Tracking Plan was used
  • The error message associated with the Plan

These columns will then propagate to both your data warehouse as well as cloud destinations. This lets you monitor the state of your violations and choose to act on them through manual operations or through the transformations.

Currently, RudderStack propagates any context related to the tracking plan violations only to the data warehouses but not all destinations. You can use this context in your Transformations for filtering or modifying the events before they reach the destination.

If you have defined the tracking plan global settings such that Allow unplanned events is set to FALSE, the events that are explicitly dropped via the tracking plan will not reach any destination.


Questions? Contact us by email or on Slack