ÃÛ¶¹ÊÓÆµ

Ingest Algolia User Profiles data to Experience Platform using the UI

Read this tutorial to learn how to ingest payments data from your Algolia User Profiles account to ÃÛ¶¹ÊÓÆµ Experience Platform using the user interface.

Get started

IMPORTANT
Before getting started, ensure that you complete the prerequisite steps outlined in the Algolia User Profiles overview.

This tutorial requires a working understanding of the following components of Experience Platform:

  • Experience Data Model (XDM) System: The standardized framework by which Experience Platform organizes customer experience data.

  • Real-Time Customer Profile: Provides a unified, real-time consumer profile based on aggregated data from multiple sources.

  • Sources: Experience Platform allows data to be ingested from various sources while providing you with the ability to structure, label, and enhance incoming data using Experience Platform services.

Gather required credentials

In order to connect Algolia to Experience Platform, you must provide values for the following credentials:

Credential
Description
Application ID
The Algolia application ID is a unique identifier assigned to your Algolia account.
API Key
The Algolia API Key is a credential used to authenticate and authorize API requests to Algolia’s search and indexing services.

For more information on these credentials, see the Algolia .

Connect your Algolia account

In the Experience Platform UI, select Sources from the left navigation to access the Sources workspace. You can select the appropriate category in the Categories panel. Alternatively, you can use the search bar to navigate to the specific source that you want to use.

To use Algolia, select the Algolia source card under Data & Identity Partners and then select Set up.

TIP
Sources in the sources catalog display the Set up option when a given source does not yet have an authenticated account. Once an authenticated account exists, this option changes to Add data.

The sources catalog with the Algolia User Profiles source selected.

Authentication

Use an existing account

To use an existing account, select Existing account and then select the Algolia User Profiles account that you want to use. To proceed, select Next.

The existing account interface.

Create a new account

If you are creating a new account, select New account, and then provide a name, an optional description, and Algolia credentials. When finished, select Connect to source and then allow some time for the new connection to establish.

The new account interface.

Add data

After creating your Algolia User Profiles account, the Add data step appears, providing an interface for you to explore your Algolia user profiles that you want to bring to Experience Platform.

  • The left part of the interface is for you to enter optional Indices and Affinity(s) fields.
  • The right part of the interface lets you preview up to 100 rows of user profiles.

Once you finish selecting and previewing your data for ingestion, select Next.

The select data step of the workflow.

Provide dataflow details

If you are using an existing dataset, select a dataset that is associated with a schema that is using the Algolia Profile Field Group.

The existing dataset step of the sources workflow.

If you are creating a new dataset, select a schema that is using the Algolia Profile field group which is required in the mapping step.

The new dataset step of the sources workflow.

Map data fields to an XDM schema

Use the mapping interface to map your source data to the appropriate schema fields before ingesting data to Experience Platform. For more information, read the mapping guide in the UI.

The mapping step of the sources workflow.

Schedule ingestion runs

Next, use the scheduling interface to define the ingestion schedule of your dataflow.

The scheduling step of the sources workflow.

Scheduling configuration
Description
Frequency

Configure frequency to indicate how often the dataflow should run. You can set your frequency to:

  • Once: Set your frequency to once to create a one-time ingestion. Configurations for interval and backfill are unavailable when creating a one-time ingestion dataflow. By default, the scheduling frequency is set to once.
  • Minute: Set your frequency to minute to schedule your dataflow to ingest data on a per-minute basis.
  • Hour: Set your frequency to hour to schedule your dataflow to ingest data on a per-hour basis.
  • Day: Set your frequency to day to schedule your dataflow to ingest data on a per-day basis.
  • Week: Set your frequency to week to schedule your dataflow to ingest data on a per-week basis.
Interval

Once you select a frequency, you can then configure the interval setting to establish the time frame between every ingestion. For example, if you set your frequency to day and configure the interval to 15, then your dataflow will run every 15 days. You cannot set the interval to zero. The minimum accepted interval value for each frequency is as follows:

  • Once: n/a
  • Minute: 15
  • Hour: 1
  • Day: 1
  • Week: 1
Start Time
The timestamp for the projected run, presented in UTC time zone.
Backfill
Backfill determines what data is initially ingested. If backfill is enabled, all current files in the specified path will be ingested during the first scheduled ingestion. If backfill is disabled, only the files that are loaded in between the first run of ingestion and the start time will be ingested. Files loaded prior to the start time will not be ingested.

Review your dataflow

Use the review page for a summary of your dataflow prior to ingestion. Details are grouped in the following categories:

  • Connection - Shows the source type, the relevant path of the chosen source file, and the number of columns within that source file.
  • Assign dataset & map fields - Shows which dataset the source data is being ingested into, including the schema that the dataset adheres to.
  • Scheduling - Shows that active period, frequency, and interval of the ingestion schedule.

Once you have reviewed your dataflow, select Finish and allow some time for the dataflow to be created.

The review step of the sources workflow.

Next steps

By following this tutorial, you have successfully created a dataflow to bring intent data from your Algolia source to Experience Platform. For additional resources, visit the documentation outlined below.

Monitor your dataflow

Once your dataflow has been created, you can monitor the data that is being ingested through it to view information on ingestion rates, success, and errors. For more information on how to monitor dataflow, visit the tutorial on monitoring accounts and dataflows in the UI.

Update your dataflow

To update configurations for your dataflows scheduling, mapping, and general information, visit the tutorial on updating sources dataflows in the UI.

Delete your dataflow

You can delete dataflows that are no longer necessary or were incorrectly created using the Delete function available in the Dataflows workspace. For more information on how to delete dataflows, visit the tutorial on deleting dataflows in the UI.

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089