Data plans allow you to describe the type and format of the data you expect to collect in your app. mParticle compares incoming data to a data plan, preventing any data that does not match the plan from being stored in your account or forwarded to your outputs.
You can create multiple data plans in each workspace of your account, and each plan can have multiple versions.
Data plans are created from two main elements:
Criteria: the name for a particular data point
Schema: a specific description of what each datapoint should look like. The schema is used to validate incoming data.
Use the following steps to create a basic data plan using a template in the mParticle UI. More complex data plans can be created using the Data Plan Builder or the Data Planning API if the templates provided in the UI are insufficient for your app.
8.1 Create your first data plan
Data plans can be created from templates in the mParticle UI, they can be created using the Data Plan Builder, or they can be created by importing actual event data collected from your app.
For this tutorial, you can use the sample data plan that has been built for the Higgs Shop specifically. The steps below explain where to find the sample data plan, how to upload it to your mParticle account, activate it, and then make sure that data from your instance of the sample app is being validated against the plan.
Download the JSON formatted sample data plan to your computer. The data plan is also included in the the Higgs Shop repository. You can find it at /mparticle-web-sample-apps/core-sdk-samples/higgs-shop-sample-app/dataplans/higgs_shop_basic_data_plan_1.json in the directory where you cloned the sample app repo.
From your mParticle dashboard, click Data Master in the left nav bar and select Plans.
Click Create Plan and select Import data before clicking Next.
Enter a name for your plan, like “Higgs Shop Plan”. Note the Plan Id which you will need later.
Under Import From, select Upload JSON File and upload the sample data plan.
Click Create Plan.
You will be taken to a detailed view of your new data plan where you can see a list of the events you should expect to track in The Higgs Shop.
Displayed on this page are each event category, the event name, and a description. Events that include additional attributes can be expanded by clicking the + icon next to the event category.
8.2 Activate your data plan
From the details page for your new data plan, click Activate.
Under Status, select Active on Dev since our SDK is only initialized to collect dev data. When you begin collecting production data, you will need to change your plan’s status from Active on Dev to Active on Prod/Dev.
If you like, enter an optional description of the version you are activating.
8.3 Add your data plan to your SDK initialization snippet
Open the source code for The Higgs Shop in your IDE or text editor.
Replace your_plan_name with your Plan Id referenced earlier when creating a data plan.
Make sure that planVersion is set to the correct version of your plan. If you kept the default settings in step 7.1, this should be 1.
Save your changes and restart your development server.
8.4 Verify that your data plan is working
If you haven’t restarted your development sever since adding your data plan, do so now by entering Ctrl+C in your terminal and then running npm start.
Open a new browser window and navigate to your mParticle dashboard. Navigate to Data Master > Live Stream in the left nav bar.
In the browser window containing the sample app, begin clicking different pages or products to start generating event data.
As events begin appearing in the Live Stream, note the small green check mark adjacent to each event name. This indicates that the event is valid according to our new data plan. Should an event appear that is labeled as Not Validated, it will not be added to your Data Catalog, and it will not be forwarded to any connected outputs.
Learn more about data plans and data validation in Data Planning.