Ingest and use data using source connectors

This quick start guide explains how you can ingest data into Adobe Experience Platform using a source connector to a data provider and then use that data in Customer Journey Analytics.

To accomplish this, you need to:

  • Set up a schema and dataset in Adobe Experience Platform to define the model (schema) of the data that you want to collect and where to actually collect the data (dataset).

  • Use a source connector in Adobe Experience Platform to get your data into the dataset configured.

  • Set up a connection in Customer Journey Analytics. This connection should (at least) include your Adobe Experience Platform dataset.

  • Set up a data view in Customer Journey Analytics to define metrics and dimension that you want to use in Analysis Workspace.

  • Set up a project in Customer Journey Analytics to build your reports and visualizations.

This quick start guide is a simplified guide on how to ingest data using a source connector into Adobe Experience Platform and use it in Customer Journey Analytics. It is highly recommended to study the additional information when referred to.

Set up a schema and dataset

To ingest data into Adobe Experience Platform, you first must define which data you want to collect. All data ingested into Adobe Experience Platform must conform to a standard, denormalized structure for it be recognized and acted upon by downstream capabilities and features. Experience Data Model (XDM) is the standard framework that provides the structure in the form of schemas.

Once you have defined a schema, you use one or more datasets to store and manage the collection of data. A dataset is a storage and management construct for a collection of data (typically a table) that contains a schema (columns) and fields (rows).

All data that is ingested into Adobe Experience Platform must conform to a pre-defined schema before it can be persisted as a dataset.

Set up a schema

For this quick start, you want to collect some loyalty data, for example loyalty id, loyalty points, and loyalty status.
You first must define a schema that models this data.

To set up your schema:

  1. In the Adobe Experience Platform UI, in the left rail, select Schemas within DATA MANAGEMENT.

  2. Select Create schema.

  3. In the Select a class step of the Create schema wizard:

    1. Select Individual Profile.

      Create a schema window with Individual Profile selected

      note info
      An Experience Event schema is used to model the behavior of a profile (like scene name, push button to add to cart). An Individual Profile schema is used to model the profile attributes (like name, email, gender).
    2. Select Next.

  4. In the Name and review step of the Create schema wizard:

    1. Enter a Schema display name for your schema and (optional) a Description.

      Create schema window showing the fields to name your schema

    2. Select Finish.

  5. In the Structure tab of Example Schema:

    1. Select + Add in Field groups.

      Create schema window showing the Add field group

      Field groups are reusable collection of objects and attributes that allow you to easily extend your schemas.

    2. In the Add fields groups dialog, select the Loyalty Details field group from the list.

      AEP Web SDK ExperienceEvent fieldgroup

      You can select the preview button, to see a preview of the fields that are part of this field group.

      AEP Web SDK ExperienceEvent fieldgroup preview

      Select Back to close the preview.

    3. Select Add field groups.

  6. Select + next to your schema name in the Structure panel.

    Example Schema Add Field button

  7. In the Field Properties panel, enter Identification as the name, Identification as the Display name, select Object as the Type and select Profile Core v2 as the Field Group.

    Identification Object

    This identification object adds identification capabilities to your schema. In your case, you want to identify loyalty information using the email address in your batch data.

    Select Apply to add this object to your schema.

  8. Select the email field in the identification object you just added, and select Identity and Email from the Identity namespace in the Field Properties panel.

    Specifiy email as identity

    You are specifying the email address as the identity the Adobe Experience Platform Identity service can use to combine (stitch) the behavior of profiles.

    Select Apply. You see that a fingerprint icon appears in the email attribute.

  9. Select the root level of your schema (with the schema name), then select the Profile switch.

    You are prompted to enable the schema for profile. Once enabled, when data is ingested into datasets based on this schema, that data is merged into the Real-Time Customer Profile.

    See Enable the schema for use in Real-Time Customer Profile for more information.

    note important
    Once you save a schema enabled for profile, it can no longer be disabled for profile.

    Enable schema for profile

  10. Select Save to save your schema.

You have created a minimal schema that models the loyalty data you can ingest into Adobe Experience Platform. The schema allows profiles to be identified using the email address. By enabling the schema for profile, you ensure that data from your streaming source is added to the Real-Time Customer Profile.

See Create and edit schemas in the UI for more information on adding and removing field groups and individual fields to a schema.

Set up a dataset

With your schema, you have defined your data model. You now have to define the construct to store and manage that data, which is done through datasets.

To set up your dataset:

  1. In the Adobe Experience Platform UI, in the left rail, select Datasets within DATA MANAGEMENT.

  2. Select Create dataset.

    Create dataset

  3. Select Create dataset from schema.

    Create dataset from schema

  4. Select the schema that you created earlier and select Next.

  5. Name your dataset and (optional) provide a description.

    Name dataset

  6. Select Finish.

  7. Select the Profile switch.

    You are prompted to enable the dataset for profile. Once enabled, the dataset enriches real-time customer profiles with its ingested data.

    note important
    You can only enable a dataset for profile when the schema, to which the dataset adheres, is also enabled for profile.

    Enable schema for profile

See Datasets UI guide for much more information on how to view, preview, create, delete a dataset. And how to enable a dataset for Real-Time Customer Profile.

Use a source connector

Depending on where you receive the loyalty data from, you pick the relevant source connector available within Adobe Experience Platform.

You can ingest data from a variety of sources. Following are just a few of the many sources available:

To set up a source connector:

  1. In Adobe Experience Platform, select Sources from CONNECTIONS in the left rail.

  2. Select your source connector from the list of available source connectors.

    Each connector follows a similar workflow:

    1. Authentication. You provide authentication details to access the source of data.

    2. Select data: You select the source data that you want to ingest.

    3. Dataflow detail: You provide additional details on the dataflow, for example name and which dataset to use.

    4. Mapping: You map the incoming source data fields to attributes in the schema associated with the dataset that you selected.

    5. Scheduling: If available, you can schedule the ingestion of data.

    6. Review: You see a review of the definition of the source connector.

  3. Each connector provides detailed documentation. To access this documentation:

    1. On the connector tile, select the … next to Set up or Add data.

      View documentation

    2. Select View documentation.

See Ingest and use data from traditional Adobe Analytics for information about how to use the Adobe Analytics source connector.

See Ingest and use streaming data for information about how to use the HTTP API source connector.

See Source Connectors overview for an overview of source connectors including links to more information for each connector.

Set up a connection

To use the Adobe Experience Platform data in Customer Journey Analytics, you create a connection that includes the data resulting from setting up your schema, dataset, and workflow.

A connection lets you integrate datasets from Adobe Experience Platform into Workspace. To report on these datasets, you first have to establish a connection between datasets in Adobe Experience Platform and Workspace.

To create your connection:

  1. In the Customer Journey Analytics UI, select Connections in the top navigation.

  2. Select Create new connection.

  3. In the Untitled connection screen:

    1. Name and describe your connection in Connection Settings.

    2. Select the correct sandbox from the Sandbox list in Data settings and select the number of daily events from the Average number of daily events list.

      Connection Settings

    3. Select Add datasets.

  4. In the Select datasets step in Add datasets:

    1. Select the dataset that you created earlier (Example Loyalty Dataset) and any other dataset you want to include in your connection.

      Add datasets

    2. Select Next.

  5. In the Datasets settings step in Add datasets:

    For each dataset:

    1. Select a Person ID from the available identities defined in the dataset schemas in Adobe Experience Platform.

    2. Select the correct data source from the Data source type list. If you specify Other, then add a description for your data source.

    3. Set Import all new data and Dataset backfill existing data according to your preferences.

      Configure datasets

    4. Select Add datasets.

    5. Select Save.

After you create a connection, you can perform various management tasks, such as selecting and combining datasets, checking the status of a connection’s datasets and the status of data ingestion, and more.

Set up a data view

A data view is a container specific to Customer Journey Analytics that lets you determine how to interpret data from a connection. It specifies all dimensions and metrics available in Analysis Workspace and which columns those dimensions and metrics obtain their data from. Data views are defined in preparation for reporting in Analysis Workspace.

To create your data view:

  1. In the Customer Journey Analytics UI, select Data views in the top navigation.

  2. Select Create new data view.

  3. In the Configure step:

    Select your connection from the Connection list.

    Name and (optionally) describe your connection.

    Data view configure

    Select Save and continue.

  4. In the Components step:

    Add any schema field and/or standard component that you want to include to the METRICS or DIMENSIONS component boxes.

    Data view components

    Select Save and continue.

  5. In the Settings step:

    Data view settings

    Leave the settings as they are and select Save and finish.

See Data views overview for more information on how to create and edit a data view, what components are available for you to use in your data view and how to use filter and sessions settings.

Set up a project

Analysis Workspace is a flexible browser tool that allows you to quickly build analyses and share insights based on your data. You use Workspace projects to combine data components, tables, and visualizations to craft your analysis and share with anyone in your organization.

To create your project:

  1. In the Customer Journey Analytics UI, select Projects in the top navigation.

  2. Select Projects in the left navigation.

  3. Select Create project.

    Workspace Project

    Select Blank project.

    Workspace - Blank Project

  4. Select your data view from the list.

    Workspace Select Data view .

  5. To create your first report, start dragging and dropping dimensions and metrics on the Freeform table in the Panel . As an example, drag Program Points Balance and Page View as metrics and email as dimension to get a quick overview of profiles that have visited your website and are part of the loyalty program collecting loyalty points.

    Workspace - First Report

See Analysis Workspace overview for more information on how to create projects and build your analysis using components, visualizations, and panels.

You have completed all the steps. Starting by defining what loyalty data you want to collect (schema) and where to store it (dataset) in Adobe Experience Platform, you configured the appropriate source connector to provide you with the loyalty data. You defined a connection in Customer Journey Analytics to use the ingested loyalty data and other data. Your data view definition allowed you to specify which dimension and metrics to use and finally you created your first project visualizing and analyzing your data.