Install and configure the Experience Platform connector

Before you install the extension, review the prerequisites.

Install the extension

The Experience Platform connector extension is installed from the command line of the server and connects to your Adobe Commerce installation as a service. When the process is complete, Experience Platform Connector appears on the System menu under Services in the Commerce Admin.

The Experience Platform connector is installed as an extension from Adobe Marketplace.

  1. To download the experience-platform-connector package, run the following from the command line:

    composer require magento/experience-platform-connector
    

    This metapackage contains the following modules and extensions:

    • module-platform-connector-admin - Updates the Admin UI so you can select the Datastream ID for a specific Adobe Commerce instance
    • module-platform-connector - Sets the ImsOrgId and datastreamId in the Adobe Commerce Storefront Event SDK
    • data-services - Provides attribute context for storefront events. For example, when a checkout event occurs, information about how many items were in the cart and product attribute data for those items are included.
    • services-id - Connects your Adobe Commerce instance to Adobe Commerce SaaS using sandbox and production API keys and to the Adobe Experience Platform to retrieve the IMS Organization ID
  2. (Optional) To include Live Search data, which comprises search events, install the Live Search extension.

Update the Experience Platform connector

To update the Experience Platform connector, run the following from the command line:

composer update magento/experience-platform-connector --with-dependencies

To update to a major version such as from 1.0.0 to 2.0.0, edit the project’s root Composer .json file as follows:

  1. Open the root composer.json file and search for magento/platform-connector.

  2. In the require section, update the version number as follows:

    "require": {
       ...
       "magento/experience-platform-connector": "^2.0",
       ...
     }
    
  3. Save composer.json. Then, run the following from the command line:

    composer update magento/experience-platform-connector –-with-dependencies
    

Uninstall the Experience Platform connector

To uninstall the Experience Platform connector, refer to uninstall modules.

On this page