Configure a datastream

A datastream represents the server-side configuration when implementing the Adobe Experience Platform Web and Mobile SDKs. While the configure command in the SDK controls things that must be handled on the client (such as the edgeDomain), datastreams handle all other configurations for the SDK. When a request is sent to the Adobe Experience Platform Edge Network, the edgeConfigId is used to reference the datastream. This allows you to update the server-side configuration without having to make code changes on your website.

This document covers the steps for configuring a datastream in the Data Collection UI.

NOTE

Your organization must be provisioned for this feature in order to access it in the UI. Please fill out the following form to request the necessary access. To manage datastreams, your user account must be added to a product profile for tags in Adobe Experience Platform.

Access the Datastreams workspace

You can create and manage datastreams in the Data Collection UI by selecting Datastreams in the left navigation.

Datastreams tab in the Data Collection UI

The Datastreams tab displays a list of existing datastreams, including their friendly name, ID, and last modified date. Select the name of of a datastream to view its details and configure services.

Select the “more” icon () for a particular datastream to reveal more options. Select Edit to update the basic configuration for the datastream, or select Delete to remove the datastream.

Options to edit or delete and existing datastream

Create a new datastream

To create a datastream, start by selecting New Datastream.

Select New Datastream

Configure

The datastream creation workflow appears, starting at the configuration step. From here, you must provide a name and optional description for the datastream.

If you are configuring this datastream for use in Experience Platform and are using the Platform Web SDK, you must also select an event-based Experience Data Model (XDM) schema to represent the data you plan on ingesting.

Basic configuration for a datastream

Select Advanced Options to reveal additional controls to configure the datastream.

Advanced configuration options

Setting Description
Geo Location Determines whether GPS lookups occur based on the user’s IP address. The default setting None disables any GPS lookups, while the City setting provides GPS coordinates to two decimal places.
First Party ID Cookie When enabled, this setting tells the Edge Network to refer to a specified cookie when looking up a first-party device ID, rather than looking up this value in the Identity Map.

When enabling this setting, you must provide the name of the cookie where the ID is expected to be stored.
Third Party ID Sync ID syncs can be grouped into containers to allow different ID syncs to be run at different times. When enabled, this setting lets you specify which container of ID syncs is run for this datastream.

The rest of this section focuses on the steps to map data to a selected Platform event schema. If you are using the Mobile SDK or are otherwise not configuring your datastream for Platform, select Save before proceeding to the next section on adding services to the datastream.

Data Prep for Data Collection

IMPORTANT

Data Prep for Data Collection is currently not supported for Mobile SDK implementations.

Data Prep is an Experience Platform service that allows you to map, transform, and validate data to and from Experience Data Model (XDM). When configuring a Platform-enabled datastream, you can use Data Prep capabilities to map your source data to XDM when sending it to the Platform Edge Network.

NOTE

For comprehensive guidance on all Data Prep capabilities, including transformation functions for calculated fields, refer to the following documentation:

The subsections below cover the basic steps for mapping your data within the Data Collection UI. For a quick demonstration of these steps, refer to the following video:

Select data

Select Save and Add Mapping after completing the basic configuration step, and the Select data step appears. From here, you must provide a sample JSON object that represents the structure of the data you plan on sending to Platform.

You should construct this JSON object so that you can map it the properties in your data layer that you want to capture. Select the section below to view an example of a properly formatted JSON object.

 Sample JSON file
{
  "data": {
    "eventMergeId": "cce1b53c-571f-4f36-b3c1-153d85be6602",
    "eventType": "view:load",
    "timestamp": "2021-09-30T14:50:09.604Z",
    "web": {
      "webPageDetails": {
        "siteSection": "Product section",
        "server": "example.com",
        "name": "product home",
        "URL": "https://www.example.com"
      },
      "webReferrer": {
        "URL": "https://www.adobe.com/index2.html",
        "type": "external"
      }
    },
    "commerce": {
      "purchase": 1,
      "order": {
        "orderID": "1234"
      }
    },
    "product": [
      {
        "productInfo": {
          "productID": "123"
        }
      },
      {
        "productInfo": {
          "productID": "1234"
        }
      }
    ],
    "reservation": {
      "id": "anc45123xlm",
      "name": "Embassy Suits",
      "SKU": "12345-L",
      "skuVariant": "12345-LG-R",
      "priceTotal": "112.99",
      "currencyCode": "USD",
      "adults": 2,
      "children": 3,
      "productAddMethod": "PDP",
      "_namespace": {
        "test": 1,
        "priceTotal": "112.99",
        "category": "Overnight Stay"
      },
      "freeCancellation": false,
      "cancellationFee": 20,
      "refundable": true
    }
  }
}
IMPORTANT

The JSON object must have a single root node data in order to pass validation.

You can select the option to upload the object as a file, or paste the raw object into the provided textbox instead. If the JSON is valid, a preview schema is displayed in the right panel. Select Next to continue.

JSON sample of expected incoming data

Mapping

The Mapping step appears, allowing you to map the fields in your source data to that of the target event schema in Platform. To get started, select Add new mapping to create a new mapping row.

Adding a new mapping

Select the source icon (Source icon), and in the dialog that appears select the source field that you want to map in the provided canvas. Once you have chosen a field, use the Select button to continue.

Selecting the field to be mapped in the source schema

Next, select the schema icon (Schema icon) to open a similar dialog for the target event schema. Choose the field that you want to map the data to before confirming with Select.

Selecting the field to be mapped in the target schema

The mapping page reappears with the completed field mapping shown. The Mapping progress section updates to reflect the total number of fields that have been successfully mapped.

Field successfully mapped with progress reflected

TIP

If you want to map an array of objects (in the source field) to an array of different objects (in the target field), add [*] after the array name in the source and destination field paths, as shown below.

Array object mapping

Continue following the above steps to map the rest of the fields to the target schema. While you do not have to map all available source fields, any fields in the target schema that are set as required must be mapped in order to complete this step. The Required fields counter indicates how many required fields are not yet mapped in the current configuration.

Once the required fields count reaches zero and you are satisfied with your mapping, select Save to finalize your changes.

Mapping complete

View datastream details

After configuring a new datastream or selecting an existing one to view, the details page for that datastream appears. Here you can find further information about the datastream, including its ID.

Details page for a created datastream

From the datastream details screen, you can add services to enable capabilities from the Adobe Experience Cloud products you have access to.

Add services to a datastream

On the details page of a datastream, select Add Service to start adding available services for that datastream.

Select Add Service to continue

On the next screen, use the dropdown menu to select a service to configure for this datastream. Only the services that you have access to will appear in this list.

Select a service from the list

Select the desired service, fill in the configuration options that appear, and then select Save to add the service to the datastream. All added services appear in the details view for the datastream.

Services added to a datastream

The subsections below describe the configuration options for each service.

NOTE

Each service configuration contains an Enabled toggle that is automatically activated when the service is selected. To disable the selected service for this datastream, select the Enabled toggle again.

Adobe Analytics settings

This service controls whether and how data is sent to Adobe Analytics. Additional details can be found in the guide on sending data to Analytics.

Adobe Analytics settings Block

Setting Description
Report Suite ID (Required) The ID of the Analytics report suite that you want to send data to. This ID can be found in the Adobe Analytics UI under Admin > ReportSuites. If multiple report suites are specified, then data is copied to each report suite.

Adobe Audience Manager settings

This service controls whether and how data is sent to Adobe Audience Manager. All that is needed to send data to Audience Manager is to enable this section. The other settings are optional but encouraged.

Adobe Audience Manage settings block

Setting Description
Cookie Destinations Enabled Allows the SDK to share segment information via cookie destinations from Audience Manager.
URL Destinations Enabled Allows the SDK to share segment information via URL destinations from Audience Manager.

Adobe Experience Platform settings

IMPORTANT

When enabling a datastream for Platform, take note of the Platform sandbox that you are currently using, as displayed in the top ribbon of the Data Collection UI.

Selected sandbox

Sandboxes are virtual partitions in Adobe Experience Platform that allow you to isolate your data and implementations from others in your organization. Once a datastream is created, its sandbox cannot be changed. For more details about the role of sandboxes in Experience Platform, see the sandboxes documentation.

This service controls whether and how data is sent to Adobe Experience Platform.

Adobe Experience Platform settings block

Setting Description
Event Dataset (Required) Select the Platform dataset that customer event data will be streamed to. This schema must use the XDM ExperienceEvent class.
Profile Dataset Select the Platform dataset that customer attribute data will be sent to. This schema must use the XDM Individual Profile class.
Offer Decisioning Select this checkbox to enable Offer Decisioning for a Platform Web SDK implementation. See the guide on using Offer Decisioning with the Platform Web SDK for more implementation details. For more information on Offer Decisioning capabilities, refer to the Adobe Journey Optimizer documentation.
Edge Segmentation Select this checkbox to enable edge segmentation for this datastream. When the SDK sends data through an edge-segmentation-enabled datastream, any updated segment memberships for the profile in question are sent back in the response.

This option can be used in combination with Personalization Destinations for next-page personalization use cases.
Personalization Destinations When used in combination with the Edge Segmentation checkbox, this option allows the datastream to connect to personalization engines like Adobe Target. Refer to the destinations documentation for specific steps on configuring personalization destinations.

Adobe Target settings

This service controls whether and how data is sent to Adobe Target.

Adobe Target settings block

Setting Description
Property Token Target allows customers to control permissions through the use of properties. For more information on properties, see the guide on configuring enterprise permissions in the Target documentation.

The property token can be found in the Adobe Target UI under Setup > Properties.
Target Environment ID Environments in Adobe Target help you manage your implementation through all stages of development. This setting specifies which environment you are going to use with this datastream.

Best practice is to set this differently for each of your dev, stage, and prod datastream environments to keep things simple. However, if you already have Adobe Target environments defined, you can use those.
Target Third Party ID namespace The identity namespace for the mbox3rdPartyId you want to use for this datastream. See the guide on implementing mbox3rdPartyId with the Web SDK for more information.

Event Forwarding settings

This service controls whether and how data is sent to event forwarding.

Event Forwarding section of the configuration UI

Setting Description
Launch Property (Required) The event forwarding property that you want to send data to.
Launch Environment (Required) The environment within the selected property that you want to send data to.
NOTE

You can select Manually enter IDs to type in the property and environment names instead of using the dropdown menus.

Next steps

This guide covered how to configure a datastream in the Data Collection UI. For more information on how to install and configure the Web SDK after setting up a datastream, refer to the Data Collection E2E guide.

On this page