Use summary data
- Topics:
- Use Cases
CREATED FOR:
- Admin
This use case is to help you understand how to use summary data in your reporting and analysis. The use case details all the steps that are required to use summary data in Customer Journey Analytics:
- Ingest summary data and other data sources in Experience Platform.
- Set up your Connection for the summary data and other data sources.
- Configure your Data view to combine your data sources.
- Report and analyze in Workspace on your combined data.
The use case provides sample data for summary data, event data and lookup data. All data contains random values.
Ingest
You use the following sample summary data for this use case, showing summary data for running campaigns on Facebook.
To use the summary data in Customer Journey Analytics, in a report or as part of analyzing data in Workspace, you need
- a summary schema in Experience Platform,
- a summary dataset in Experience Platform,
- a connection in Customer Journey Analytics configured to use the summary dataset,
- a data view in Customer Journey Analytics, correctly configured with metrics and dimensions for the summary data.
You use this summary data alongside a dataset for event data and a dataset for lookup data.
Event data is available in the Example Event Data Dataset. The sample data looks like:
Lookup data is available in the Example Lookup Data Dataset. The sample data looks like:
Summary schema
Summary data needs a summary schema in Experience Platform. A summary schema is a schema that is using the XDM Summary Metrics as its base class.
To create a summary schema in Experience Platform:
- Select Experience Platform from the
- Select Schemas from the left rail.
- Select
- Select Manual in the Create a schema dialog. Then use Select to continue.
- In the Select a class step of the Schemas > Create schema wizard, select Other from the Select a base class for this schema options.
- From the list, select XDM Summary Metrics (or use
- In the Name and review step of the Schemas > Create schema wizard, enter a Schema display name, for example
Example Summary Data Schema
and an optional description. Select Finish to finish this step.
The structure of your base summary schema is displayed, ready to be augmented with the fields for your summary data. You add fields to a schema, using field groups.
To add a field group, containing the fields for your sample data:
-
Select
-
In the Add field groups dialog, select Create new field group.
-
Enter a Display name for the field group, for example
Example Summary Data
. Optionally provide a description. -
Select Add field groups.
-
You are back in the schema structure user interface. Select the new Example Summary Data in Field groups.
-
Select the
- Enter a Field name:
campaign_id
- Enter a Display name:
campaign_id
- Select a Type from the Select data type dropdown: String
- Ensure Assign to Field group is selected, and select Example Summary Data from the dropdown.
- Scroll down to the bottom, and select Apply.
- Enter a Field name:
-
Repeat the previous step for the other fields of the summary data. See the table below for the correct values.
Field nameDisplay nameTypeField Groupad_group
ad_group
StringExample Summary Datacampaign_name
campaign_name
StringExample Summary Datacost
cost
DoubleExample Summary Dataimpression
impression
IntegerExample Summary Datanetwork
network
StringExample Summary Data -
To save your Example Summary Data field group as part of your schema, select Save. You see a confirmation when your schema is successfully saved.
You have now defined a schema, detailing the model for your summary data. Similar to the one below.
Summary dataset
To store your summary data in Experience Platform, you first need to create a dataset, and then upload your summary data into the dataset.
To create a dataset:
-
Select Experience Platform from the
-
Select Datasets from the left rail.
-
Select
-
In the Datasets > Create datasets screen, select Create dataset from schema.
-
In the Select schema step of the Workflows > Create dataset from schema wizard,
-
Select Next.
-
In the Configure dataset step of the Workflows > Create dataset from schema wizard:
- Enter a Name for the dataset, for example:
Example Summary Data Dataset
. Optionally provide a description. - Select Finish.
- Enter a Name for the dataset, for example:
You see a screen displaying the details of your new dataset.
To upload your sample data into this dataset:
-
Select Experience Platform from the
-
Select Workflows from the left rail.
- Select Map CSV to XDM schema from the Data ingestion options in the Workflows screen.
- Select Launch from the Map CSV to XDM schema panel.
-
In the Dataflow detail step of the Workflows > Map CSV to XDM schema wizard:
- Select Existing dataset for Target dataset.
- Select Example Summary Data Dataset from the dropdown list.
- Select Next.
-
In the Select data step of the Workflows > Map CSV to XDM schema wizard:
- Drag and drop your file with summary data in CSV format onto Drag and drop files. Alternatively, use Choose files to select your file.
- Ensure the Data format and Delimiter do have the correct values for your sample data. For example, Delimited as the Data format, and , as the Delimiter.
- A sample (10 records) of your summary data is shown in Sample data.
- Select Next.
-
In the Mapping step of the Workflows > Map CSV to XDM schema wizard:
- Check whether all data fields of your Source Data are correctly mapped to the corresponding Target fields in your schema. For the sample data, no errors are reported as you explicitly named the fields in your schema similar to the field names in your sample data. Otherwise, you can use this screen to correct the mapping.
- You can optionally select
- You can optionally select
- Select Finish.
In Sources > Dataflow - XX/XX/XXXX, XX:XX XX, the status of your upload appears. Refresh to see updates of the upload. When successful, your sample data is loaded into Experience Platform.
Connection
To use your sample data in Customer Journey Analytics, you create a connection that includes the Example Summary Data Dataset from Experience Platform.
-
Select Customer Journey Analytics from the
-
Select Connections, optionally from Data management, in the top menu.
-
Select Create new connection.
-
In Connections > Untitled connection:
-
Enter a Connection name, for example
Example Connection Using Summary Data
. -
Select the sandbox that contains the dataset you created and the other datasets you want to include from the Sandbox dropdown list.
-
Select less than 1 million from the Average number of daily events dropdown list.
-
Select Add datasets.
-
In the Select datasets step of the Add datasets wizard:
- Search
- Select Next.
- Search
-
In the Datasets settings step of the Add datasets wizard:
-
For the Example Event Data Dataset:
- Confirm the selections for Person ID (
person_id
) and Timestamp are correct. - Select Web Data from the Data source type.
- Enable Import all new data.
- Enable Backfill all existing data.
- Confirm the selections for Person ID (
-
For the Example Lookup Data Dataset:
- Select tracking_code as the Key and tracking_code (Event datasets) as the Matching Key.
- Select Web Data from the Data source type.
- Enable Import all new data.
- Enable Backfill all existing data.
-
For the Example Summary Data Dataset:
- Confirm the selections for Timestamp and Timezone are correct.
- Enable Import all new data.
- Enable Backfill all existing data.
-
Select Add datasets.
-
-
-
In the Connections > Example Connection using Summary Data connection screen, select Save to save the connection.
The data from the datasets is added to Customer Journey Analytics, which can take a couple of hours. So please, be patient before continuing.
After a while, verify that data from your datasets is properly loaded in Customer Journey Analytics.
-
Select Customer Journey Analytics from the
-
Select Connections, optionally from Data management, in the top menu.
-
Select your connection, for example Example Connection Using Summary Data.
-
Select an appropriate date range in the Connection > Example Connection Using Summary data details.
- Select
- Select Apply.
- Select
In the list of Datasets, the values in the Records added column should confirm that data from your datasets is now part of Customer Journey Analytics.
Data view
To ensure you can report on the correct data in Workspace, you want to create a data view containing the relevant metrics and dimensions.
-
Select Customer Journey Analytics from the
-
Select Data views, optionally from Data management, in the top menu.
-
Select Create new data view.
-
In Data views, go through the wizard screens to configure your data view.
-
In the Configure step of Data views:
- Select your connection from Settings | Connection. For example, Example Connection Using Summary Data.
- Enter a Name for your data view, for example
Example Data View Using Summary Data
. - Leave all other settings.
- Select Save and continue.
-
In the Components step of Data views > Example Data View Using Summary Data:
-
Add the following components to the Dimensions and Metrics list. Note that for clarity, the component names are modified from their default name, using Component name in Component settings in the component panel (at the right).
Metrics
Component nameDatasetSchema data typeSchema pathCostExample Summary Data DatasetDouble_tenant.costImpressionsExample Summary Data DatasetInteger_tenant.impressionOrdersExample Event Data DatasetInteger_tenant.ordersRevenueExample Event Data DatasetDouble_tenant.revenue_amountDimensions
Component nameDatasetSchema data typeSchema pathAd Group (Lookup)Example Lookup Data DatasetString_tenant.ad_groupAd Group (Summary)Example Summary Data DatasetString_tenant.ad_groupCampaign IdExample Summary Data DatasetString_tenant.campaign_idCampaign Name (Lookup)Example Lookup Data DatasetString_tenant.campaign_nameCampaign Name (Summary)Example Summary Data DatasetString_tenant.campaign_nameNetworkExample Summary Data DatasetString_tenant.networkPage NameExample Event Data DatasetString_tenant.page_namePerson IdExample Event Data DatasetString_tenant.person_idTracking Code (Event)Example Event Data DatasetString_tenant.tracking_codeTracking Code (Lookup)Example Lookup Data DatasetString_tenant.tracking_code -
Select the Tracking Code (Event) dimension in the Dimensions list. In the component panel:
-
Unfold
-
Enable Create grouping.
-
Select Campaign Id from the Dimension dropdown list. This step ensures that event data and summary data is properly combined for reporting.
-
You can optionally enable Hide in reporting. Hide in reporting ensures the selected dimension (Campaign Id) is hidden in Analysis Workspace and other Customer Journey Analytics reporting tools. If you have enabled this option, you can verify the option:
- Select the Campaign Id dimension in the Dimensions list.
- You notice that Hide component in reporting in Component settings is now automatically enabled.
-
-
Create a new derived field, for example
Campaign Name (Lookup Derived Field)
, to ensure you can report in Workspace using the Campaign Name (Lookup) dimension from the Example Lookup Data dataset.- Select campaign_id for Value.
- Select Example Lookup Data Dataset from the Lookup dataset dropdown menu.
- Select tracking_code from the Matching Key dropdown menu.
- Select campaign_name from the Values to return dropdown menu.
- Select Save.
-
Add the newly created derived field, Campaign Name (Lookup Derived Field), to the Dimensions component list.
-
Select the Campaign Name (Lookup) dimension in the Dimensions list. In the component panel:
- Unfold
- Enable Create grouping.
- Select Campaign Name (Lookup Derived Field) from the Dimension dropdown list. This step ensures that the Campaign Name (Lookup) from the Example Lookup Data Dataset can be safely used in reporting (see Workspace).
- Unfold
-
Select the Revenue metric from the Metrics list. In the component panel:
-
Unfold
- Select
- Select 30 Day from the Lookback window dropdown list.
- Select
-
Unfold
- Select Currency from the Format dropdown list.
- Select 2 from the Decimal places dropdown list.
-
-
Select the Orders metric from the Metrics list. In the component panel:
-
Unfold
- Select
- Select 30 Day from the Lookback window dropdown list.
- Select
-
Unfold
- Select Decimal from the Format dropdown list.
- Select ▲ Good (green) from the Show upward trend as dropdown list.
-
-
Select Save and continue.
-
-
In the Settings step of Data views:
- Leave all settings at their defaults.
- Select Save and finish.
-
You have now set up your data view for proper reporting on summary data.
Workspace
To report on your summary data, create a new Project in Analysis Workspace.
- Select Customer Journey Analytics from the
- Select Workspace from the top menu.
- Select Create project.
- Select Blank Workspace project from the dialog with options to create a blank Workspace project.
- Select Create.
You see an empty canvas with a Freeform panel, consisting of an empty Freeform table.
- Ensure that the data view, selected for the panel, is referring to the data view containing the configuration for the summary data. For example, Example Data View Using Summary Data.
- Ensure that the date range is valid for the data you want to report on. For example: Last 2 full months.
- Drag Tracking Code (Event) from Dimensions and drop the dimension onto the empty Freeform table.
- Drag Orders from Metrics, and drop the metric onto the Events column to replace that column in the Freeform table.
- Drag Revenue from Metrics, and drop the metric to add as an additional column to the Freeform table.
- Drag Impressions (Summary) from Metrics, and drop the metric to add as an additional column to the Freeform table.
- Drag Cost (Summary) from Metrics, and drop the metric to add as an additional column to the Freeform table.
- To save your project, select Project > Save, and provide a name for your project. For example,
Example Project Using Summary Data
.
You want to use the power of reporting on summary data and report on cost per impression and return on ad spend (ROAS). To report on these metrics, you have to create two calculated metrics.
-
Select Components > Calculated metrics.
-
Select
- Specify
Cost per Impression
for the Name. - Select Currency for Format.
- Specify
4
for Decimal places. - Use
- Select Save.
- Specify
-
Select
- Specify
Return on Ad Spend
for the Name. - Select Currency for Format.
- Select
2
for Decimal places. - Use
- Select Save.
- Specify
Add your calculated metrics to your report.
-
Drag Cost per Impression
- Select
- Disable Percent.
- Select
-
Drag Return on Ad Spend
-
Select
-
Disable Percent.
-
Enable Conditional formatting.
- Select Auto-generated.
- Select a preferred Conditional formatting palette.
-
-
Select Save to save your project.
-
If you want to report on Campaign Name rather than Tracking Code (Event), take the following steps:
- Duplicate the Summary Data Report Freeform table visualization.
- Rename the duplicated visualization to
Summary Data Report (using Campaign Name)
. - Replace
You can report correctly on Campaign Name (Lookup) because of the derived field you created, and the summary data group component configuration for Campaign Name (Lookup). See Data view.
Your final project should look like the one shown below.