Install Data Connection
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.
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:
module-experience-connector-admin
- Updates the Admin UI so you can select the Datastream ID for a specific Adobe Commerce instance.module-experience-connector
- Sets theOrganization ID
anddatastreamId
in the Storefront Events 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.orders-connector
- Connects the order status service to your Adobe Commerce instance.
-
(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 the Adobe I/O Events
After you install the experience-platform-connector
extension, you must install the Adobe I/O Events for Adobe Commerce.
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: on-premises or Adobe Commerce on Cloud infrastructure.
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
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
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 formagento/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.