User Guide

Magento

Suggest Edits

D·engage now integrates seamlessly with Magento, the leading framework for ecommerce. This integration allows you to sync the following data from your Magento website to D·engage CDMP:

  1. Contacts
  2. Products
  3. Product variants
  4. Orders
  5. Order details
  6. Events (e.g., shopping cart, page views, wishlists)

📘

Compatibility

The plugin is supported with the following versions of Magento:
2.2.X
2.3.X
2.4.X

Installation
The prerequisite for installation is to have a .zip file containing the Dengage Magento plugin. Once you have the file, follow these steps to install the plugin:

  1. Visit the URL: https://commercemarketplace.adobe.com/dev-dengage-module-cdmp.html

  2. Select your store version and click 'Add to Cart.'

  3. Start the checkout process, complete the required information, and click 'Place Order.'

  4. On the checkout success page, click 'Install.'

  5. On the next page, go to 'My Profile - Access Keys' to create public and private keys if they don't exist.

  6. Add the public and private keys to the auth.json file in the project root as shown in the figure below.

  7. Run composer require dev_dengage/module-cdmp in your project.

  8. Run the following commands to install the plugin and clear relevant caches on Magento.

#!/bin/bash


# Clean directories
rm -rf var/di/* var/generation/* var/cache/* var/log/* var/page_cache/*


# Clean Magento Cache
php bin/magento cache:clean


# Flush Magento Cache
php bin/magento cache:flush


# Run Magento Upgrade
php bin/magento setup:upgrade


# Compile Magento DI
php bin/magento setup:di:compile


# Set Permissions
chmod -R 777 ./


# Reindex Magento Indexers
php bin/magento indexer:reindex


# Reset Permissions
chmod -R 777 ./

Configuration

Settings

There are settings that need to be configured for the plugin to function correctly. You can do so by navigating to Dengage CDMP > Settings in your admin panel and configure as shown in the figure below.

📘

Note: Refer to the settings explained section in this document to understand what each setting is for.

Other Configurations

These settings are particularly valuable when integrating configurations into custom backend logic.

To configure additional settings, access Dengage CDMP > Other Configurations through your admin panel

Settings Explained

SettingRequiredDescription
Account IDNoThe Dengage Account ID - this is used to sync events from the backend to the Dengage platform
API UsernameYesThe username for the Dengage API User - should have permissions to read and write for Data Space and Transactional Push.
API PasswordYesThe password for the Dengage API User - should have permissions to read and write for Data Space and Transactional Push.
Staging EnabledYesWhen set to Yes, data is sent to the Staging / Testing environment for Dengage. When going “Live”, this setting should be set to No.
Module EnabledYesThis determines if any actions (backend events, frontend events, SDK injection, or cron jobs) will be run by the module or not.
This setting is there to be able to easily enable / disable the plugin for testing or other purposes. Turning this off will disable the integration and no events / data will be sent to the Dengage platform.
RegionYesThis setting determines which API endpoints should be used when sending data to the Dengage platform. As best practice and for ideal performance, this should be set to the region closest to where your e-commerce website is hosted e.g. if it is hosted in Europe, this should be set to Europe.
SDK ScriptYesThe Dengage SDK script to be added to the frontend for reporting events to the Dengage platform. The exact code that is pasted here is added to the frontend as it is.
Note: The Load Frontend Scripts setting must be set to Yes for the SDK Script to be loaded via the plugin.
TimezoneNoWhen this is set, all datetimes sent to the Dengage platform (such as Order Date) are converted to the timezone specified.
Log TypeYesDetermines what type of logs are written to the local log file. It is recommended that this is set to all on ‘Staging / Testing’ environment and at minimum, set to error on ‘Live’ environment.
Sync TypeYesWhen set to Real Time, data is sent to the Dengage platform immediately when an event is triggered. Not recommended for stores that have high-volume transactions as it may affect performance.
Otherwise, when set to Cron, data is sent to the Dengage platform at a fixed interval - this is ideal for stores that have a high-volume of transactions.

Reporting Errors

All logs generated by the plugin begin with "dEngage" on the backend and "Dengage" on the frontend.

Backend logs can be found in the dengage.log file located in the /var/log directory. To report errors, you can extract pertinent logs from the dengage.log file and provide them to the Dengage team for resolution and support.

Besides being written to the Magento log file, errors are also sent to the Dengage server for monitoring purposes.

Updated about 2 months ago