Documentation Commerce Data Connection extension for Adobe Commerce

Install Data Connection

Last update: Tue Jul 30 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Topics:
Install

CREATED FOR:

Admin
Developer

Before you install the extension, review the prerequisites.

Install the extension

The Data Connection extension is available from the Adobe Marketplace. When you install this extension from the command line of the server, it connects to your Adobe Commerce installation as a service. When the process is complete, Data Connection and Commerce Services Connector appear on the System menu under Services in the Commerce Admin.

Data Connection extension Admin view

IMPORTANT

While the name of the extension has changed from Experience Platform connector to Data Connection, the package name remains experience-platform-connector to support backward compatibility.

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

code language-bash
`composer require magento/experience-platform-connector`

This metapackage contains the following modules and extensions:

magento/orders-connector
magento/data-services
magento/customers-connector
magento/module-experience-connector
magento/module-experience-connector-admin
magento/module-experience-connector-admin-graph-ql
magento/module-experience-connector-aep-integration

(Optional) To include Live Search data, which comprises search events, install the Live Search extension.
(Optional) To include B2B data, which comprises requisition events, install the B2B extension.

Install Adobe I/O Events and configure the customers-connector module

After you install the experience-platform-connector extension, you must install Adobe I/O Events for Adobe Commerce and configure the customers-connector module.

The following steps apply to both Adobe Commerce on cloud infrastructure and on-premises installations.

If you are running Commerce 2.4.4 or 2.4.5, use the following command to load the eventing modules:

code language-bash
`composer require magento/commerce-eventing=^1.0 --no-update`

Commerce 2.4.6 and later loads these modules automatically.

Update the project dependencies.

code language-bash
`composer update`

Enable the new modules:

code language-bash
`bin/magento module:enable Magento_AdobeCommerceEventsClient Magento_AdobeCommerceEventsGenerator Magento_AdobeIoEventsClient Magento_AdobeCommerceOutOfProcessExtensibility`

Finalize installation based on the deployment type: Adobe Commerce on Cloud infrastructure or on-premises.

On Cloud infrastructure

In Adobe Commerce on Cloud infrastructure, enable the ENABLE_EVENTING global variable in .magento.env.yaml. Learn more.

stage:
   global:
      ENABLE_EVENTING: true

Commit and push updated files to the Cloud environment. When deployment is finished, enable sending events with the following command:

bin/magento config:set adobe_io_events/eventing/enabled 1

On-premises

In on-premises environments, you must manually enable code generation and Adobe Commerce Events:

bin/magento events:generate:module
bin/magento module:enable Magento_AdobeCommerceEvents
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento config:set adobe_io_events/eventing/enabled 1

Install the B2B extension

For B2B merchants, install the following extension to include requisition list event data.

Download the magento/experience-platform-connector-b2b extension by running the following from the command line:

composer require magento/experience-platform-connector-b2b

Update the Data Connection extension update

To update the Data Connection extension, run the following from the command line:

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

Or, for B2B merchants:

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

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

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

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

code language-json
`"require": { ... "magento/experience-platform-connector": "^3.0", ... }`

Save composer.json. Then, run the following from the command line:

code language-bash
`composer update magento/experience-platform-connector –-with-dependencies`

Or, for B2B merchants:

code language-bash
`composer update magento/experience-platform-connector-b2b --with-dependencies`

Uninstall the Data Connection extension uninstall

To uninstall the Data Connection extension, refer to uninstall modules.

recommendation-more-help

6bf243c8-c8c6-4074-826f-546af445e840