How to configure your Schema

Overview

The Schema are the skeleton of your Woopra project. Schema define how the data you track is read and processed by Woopra. Your Schema configuration for all event and visitor data, tells Woopra what type of data it is, how you want it to be displayed, and how it can be aggregated.

Schema define the type of actions and visitor data you are tracking, and the type and aggregation you set for each property will be leveraged for smart filtering and richer pre-generated reports.

Basic Schema are automatically created from any custom actions and visitor properties being tracked, or AppConnect App actions that you select from the configuration. Once added, they should be configured as desired by the agent who set up the tracking code.

To access the Schema editor, you must be an Administrator. First, you must click on the Settings icon on the bottom left of your Woopra screen and then click on the Schema icon. In the Schema editor view, you will see the tabs for each of the two Schema types.

There are two types of Schema:

  • Visitor Data Schema
  • Action Data Schema

Visitor Data Schema

Visitor Data Schema allow you to define the custom visitor properties that you are tracking. The name, email, and company name are added to your Visitor Data Schema by default, but Woopra will also add Schema for the other custom visitor data you are sending. To learn more about how to identify your visitors and track custom visitor data, please read the Javascript tracking tutorial.

Screen Shot 2014-09-20 at 9.25.56 PM

For each Schema, you will need to define the display name, description, type and aggregation:

Property Name The property name as tracked on your website. This comes directly from your tracking code. e.g. username
Display Name The property display name as seen throughout Woopra. This helps your other users understand the property being tracked, even if they did not participate in the setup. e.g. User ID
Type Type of the property:

  • Text – For any string value.
  • Number – For numbers/decimals.
  • Timestamp – For dates. Note that these should be sent in milliseconds rather than seconds.

Number and Timestamp types support formats. Text type doesn’t.

Aggregation Specify whether the property is a unique value (A property you wish to track, but do not wish to visualize graphically e.g. account_id), amount (e.g. monetary value), or group (value that could be shared with other customers and that you wish to see in a report e.g. trial, package, etc.).

Learn more about aggregation types

Description The description is an important reference for your entire team to understand the meaning of this property, especially those who did not participate in the tracking code setup. It’s always a good practice to add a description to fields to make it easy for other agents to take action on this data.

Action Data Schema

The Action Data Schema are different from the Visitor Data Schema. They define the actions from your installed AppConnect apps or the actions you set up tracking for and any properties associated with those actions. Each business has its own key events that need to be tracked. For an e-commerce website, you may want to track product views, cart updates, and purchases while in a SaaS business, you’ll want to track form submissions, signups, trial engagement, conversions, etc. To learn more about how to track custom events, please read the Javascript tracking tutorial.

Screen Shot 2014-09-20 at 9.27.08 PM

Your Action Data Schema configuration will fine tune the look and feel of Woopra for your business. Woopra will use the Schema to build the content of your customer profiles (instead of “Visitor did action payment”, it will say “Jim purchased the Yearly Small Business package for $1,999.50“), pre-generate analytics reports, and more.

Screen Shot 2014-09-17 at 10.10.20 PM

Each action consists of three parts to be configured:

Here’s the list of available icons:

Woopra Action Icons

Event Info
Event Name The name of the event as it’s tracked
Display Name The property display name as seen throughout Woopra. This helps your other users understand the property being tracked, even if they did not participate in the setup. You can also associate an icon with that event.
Description The description is an important reference for your entire team to understand the meaning of this property, especially those who did not participate in the tracking code setup. It’s always a good practice to add a description to fields to make it easy for other agents to take action on this data.
Event Properties (each property will have the below fields)
Property Name The property name as tracked on your website. e.g. username
Type Type of the property:

  • Text – For any string value.
  • Number – For numbers/decimals.
  • Timestamp – For dates. Note that these should be sent in milliseconds rather than seconds.

Number and Timestamp types support formats. Text type doesn’t.

Aggregation Specify whether the property is a unique value, amount, or group.

Learn more about aggregation types

Action Template
Template The template for your action defines how it will be displayed in the activity stream of your customer profiles. You can add properties to the template from the action ${action.propertyname}, or visitor properties like ${visitor.name}. Below is an example of a template for the signup event:

${visitor.name} signed up to Woopra from ${action.company} (${action.company size})


Aggregations

Group This is used for properties that can be applied to multiple events or visitors, such as company, product, or credit card type. When you designate a property as “group”, Woopra will generate an analytics report for this group.

For example, in the “payment” Action Data Schema, we would designated the “package” property as “group”. As a result, Woopra will automatically generated an action report for us which groups all of the payments by package type.

Unique This is used for properties that are a unique identifier for a specific event, such as a receipt ID or a transaction ID. For visitors, a username or email address would be a unique identifier, while company would be a “group” as it can be applied to more than one visitor.

Note that you may also designate any properties which you do not wish to be included in your action reports as “unique” so that they will be excluded. For example, for the “payment” Action Data Schema, we can designated the “website” property as “unique”, although it is not a unique identifier to this event and could also be designated as group. However, we do not want a “website” report so we designate the property as “unique” in order to exclude it.

Amount This is used for properties that can be added up or summed. When you designate a property as “amount”, you will be able to sum it in your segmentation filters and action reports.

For example, in the “payment” Action Data Schema, we can designate the “amount” property as an “amount”. Now when we are using segmentation filters, we may segment for “all customers who have made payments that totaled more than $200”. Similarly, our action report for the “payment” event will include a column which sums the total payment amounts by day, week, or month.

Do you know what your customers are doing?
Find out in 5 minutes.

Try Woopra for free. No credit cards. No obligations.

Start for free