Update Time Series Event Schemas for Commerce Data Ingestion
One of the onboarding steps for using the Data Connection extension is to access the datastream workspace and create a datastream that is specific to Adobe Commerce. When you create that datastream, you must also select a schema that describes the data you plan to ingest. That schema must include commerce-specific field groups.
This article provides you with the field groups your schema must include to successfully collect the following time series data provided by the Adobe Commerce events:
- Behavioral - Includes storefront, profile, search, and B2B events.
- Back office - Includes order status and profile events.
Learn more about time series data.
Learn more about the basics of schema composition.
Update schema with time series behavioral and back office event data
In this section, you learn how to update your existing schema or create a schema to include behavioral and back office event data.
-
If you do not already have a schema, create one with the class set to Experience Event.
-
Add the following Commerce-specific field groups (or edit your existing schema and add these field groups):
- Site Search
- Visit Web Page
- User Login Process
- Reference Keys
- Personal Contact Details
- Channel Details
- Commerce Details
- Adobe Analytics ExperienceEvent Commerce (if you want to send data to Adobe Analytics)
note note NOTE Do not set any Commerce-specific field groups as Primary identity. Doing so identifies the field as required and Experience Platform expects that field in every event. If that field is absent, data ingestion fails.Your schema now contains Commerce-specific field groups so that the time series data collected from the Commerce behavioral and back office events is represented in the schema.
-
Enable the schema for Profile.
When a schema is enabled for Profile, any datasets created from this schema participate in Real-Time CDP, which merges data from disparate sources to construct a complete view of each customer.
-
Create a dataset based off the schema you created or updated.
A dataset is a storage and management construct for a collection of data, typically a table that contains a schema (columns) and fields (rows). Datasets also contain metadata that describes various aspects of the data they store.
-
Create a datastream and select the schema that contains the Commerce-specific field groups and the corresponding dataset.
The datastream forwards the collected data to the dataset. The data is represented in the dataset based on the selected schema.
-
Beta (Optional) You can use custom attributes if you want to pass custom back office event data from your Commerce instance to the Experience Platform. This feature is in beta. If you would like to join the beta program, send a request to dataconnection@adobe.com. In your request, include the following:
- Your Adobe Org ID. For example
organization_id@AdobeOrg. - List of Order level custom attributes.
- List of Order Item level attributes.
The Adobe Commerce team will contact you with more information and next steps.
- Your Adobe Org ID. For example
With the schemas, datasets, and datastreams configured for behavioral and back office data, you can configure your Commerce instance to collect and send that data to the Experience Platform.
To include your shopper’s profile information, see the next section.
Time series profile event data
Time series profile event data is generated from the following events:
If you want to ingest your customer’s profile event data into the Experience Platform, you can update your existing Commerce schema and use the same datastream already configured, or you can create a profile-specific datastream and schema. That decision is based on your company’s data governance. The next two sections walk you through either case.
Send time series profile event data to Experience Platform using your existing datastream
If you want to add time series server-side profile event data to your existing Commerce datastream, add the Demographic Details field group to your schema. Your schema now contains the following Commerce-specific field groups:
- Site Search
- Visit Web Page
- User Login Process
- Reference Keys
- Personal Contact Details
- Channel Details
- Commerce Details
- Adobe Analytics ExperienceEvent Commerce (if you want to send data to Adobe Analytics)
- New: Demographic Details
With the addition of the Demographic Details field group in your existing Commerce schema, the dataset and datastream already associated with your Commerce schema is used for this time series profile data.
Send time series profile event data to Experience Platform in a separate datastream
If you want to add server-side profile event data to a new profile-specific datastream and schema, complete the following steps.
-
Create a schema and set the class to Experience Event.
-
Add the following profile-specific field groups:
- Demographic Details
- Personal Contact Details
- Channel Details
- Commerce Details
-
Enable the schema for Profile.
When a schema is enabled for Profile, any datasets created from this schema participate in Real-Time CDP, which merges data from disparate sources to construct a complete view of each customer.
-
Create a dataset based off the schema that you created.
A dataset is a storage and management construct for a collection of data, typically a table that contains a schema (columns) and fields (rows). Datasets also contain metadata that describes various aspects of the data they store.
-
Create a datastream and select the XDM schema that contains the Commerce-specific field groups and the corresponding dataset.
The datastream forwards the collected data to the dataset. The data is represented in the dataset based on the selected schema.
With the schemas, datasets, and datastreams configured for customer profile data, you can configure your Commerce instance to collect and send that data to Experience Platform.
To create a schema, dataset, and datastream for profile record data, see send profile record data to the Experience Platform.