Connect Commerce data to Adobe Experience Platform

In the Commerce Admin, navigate to Stores > Settings > Configuration > Services > Data Connection.

Select the server-to-server authorization method that you implemented from the Adobe Developer Authorization Type menu. Adobe recommends using OAuth. JWT has been deprecated. Learn more.

(JWT only) Copy and paste the contents of your private.key file into the Client Secret field. Use the following command to copy the contents.

cat config/private.key | pbcopy

See Service Account (JWT) Authentication for more information about the private.key file.

Copy the contents of the <workspace-name>.json file into the Service Account/Credential details field.

img-md
w-700 modal-image

Click Save Config.

In the Admin, go to System > Services > Data Connection.

On the Settings tab under General, verify the ID associated with your Adobe Experience Platform account, as configured in the Commerce Services Connector. The organization ID is global. Only one organization ID can be associated per Adobe Commerce instance.

In the Scope drop-down, set the context to Website.

(Optional) If you already have an AEP Web SDK (alloy) deployed to your site, enable the checkbox and add the name of your AEP Web SDK. Otherwise, leave these fields blank and the Data Connection extension deploys one for you.

Select Storefront events if you want to send storefront behavioral data.

Select Back office events if you want to send order status information, such as if an order was placed, canceled, refunded, or shipped.

(Skip this step if you are using your own AEP Web SDK.) Create a datastream in the Adobe Experience Platform or select an existing datastream you want to use for collection. Enter that datastream ID in the Datastream ID field.

Enter the Dataset ID that you want to contain your Commerce data. To find the dataset ID:

1. Open the Experience Platform UI and select Datasets in the left-navigation to open the Datasets dashboard. The dashboard lists all available datasets for your organization. Details are displayed for each listed dataset, including its name, the schema the dataset adheres to, and status of the most recent ingestion run.
2. Open the dataset associated with your datastream.
3. In the right-hand pane, view the details about the dataset. Copy the dataset ID.

To ensure back office event data updates based on a schedule according to a cron job, you must change the Sales Orders Feed index to Update by Schedule.

1. On the Admin sidebar, go to System > Tools > Index Management.

2. Select the checkbox for the Sales Orders Feed indexer.

3. Set Actions to Update by Schedule.

4. If you are enabling back office data for the first time, run the following commands to reindex and trigger a resync. Subsequent resyncs occur automatically as long as the cron job is set up correctly.

   code language-bash
   bin/magento index:reindex sales_order_data_exporter_v2

   code language-bash
   bin/magento saas:resync --feed orders

Make sure you have provided service account and credential details.

Make sure you have a schema and dataset specified for profile record data ingestion and time series profile event data ingestion.

Place a checkmark in the Customer profiles checkbox if you want to send profile data to the Experience Platform.

Enter the Profile Dataset ID.

Profile record data must use a different dataset than what you are currently using for behavioral and back office event data.

If you do not want to stream profile events through the same datastream ID that you are using for behavioral and back office data, remove the checkmark from the Stream customer profiles through same datastream ID and enter the datastream ID you want to use instead.

Make sure you have provided service account and credential details.

Enable RabbitMQ.

Enable message queue consumers by cron job in .magento.env.yaml using CRON_CONSUMERS_RUNNER environment variable.

   stage:
     deploy:
       CRON_CONSUMERS_RUNNER:
         cron_run: true

In the Admin, go to System > Services > Data Connection.

Select the Order History tab.

Under Order History Sync, the Copy Dataset ID from Settings checkbox is already enabled. This ensures you are using the same dataset specified in the Settings tab.

In the From and To fields, specify the date range for the historical order data you want to send. You cannot select a date range that exceeds five years.

Select Start Sync to trigger the sync to begin. Historical order data is batched data as opposed to storefront and back office data that is streaming data. Batched data takes about 45 minutes to arrive in Experience Platform.

Select Queries in the left navigation of Experience Platform and click Create Query.

When the Query Editor opens, enter a query that selects data from the dataset.

For example, your query might look like the following:

SELECT * from `your_dataset_name` ORDER by TIMESTAMP DESC

After the query runs, the results are displayed in the Results tab, next to the Console tab. This view shows the tabular output of your query.