This comprehensive guide provides start to finish instructions for users who need to install and configure the connector for the first time. It focuses on the most important things you need to know and do, in order to get up and running.
This guide doesn't cover advanced features
Full and comprehensive guidance can be found in the Dotdigital for Magento Open Source and Adobe Commerce section of the Help Centre.
Before you start
Things you need to know:
The integration has an initial onboarding charge for setup assistance, and a monthly license fee to ensure ongoing support and development.
To learn more, speak to your Customer Success representative.
Credentials
Multiple environments
You must use a separate set of credentials for your live and staging sites.
API user
To enable the connector to communicate with your Dotdigital account and allow data synchronisation, you need to enter valid Dotdigital API credentials.
API user credentials are made up of a username and password. They are required to authenticate each operation/method call that's made and to make sure you're connected to the correct account.
Learn how in Create an API user.
Enter API credentials in Magento
Go to Stores > Configuration.
Expand the Dotdigital drop-down menu, then select Accounts.
Expand the Enabled drop-down menu, and select Yes.
Select Save Config.
You see a confirmation to notify you that the credentials are valid.
Transactional email user
You can make use of Dotdigital's transactional email service to send, manage and track all of your transactional emails. The transactional service acts as a delivery mechanism for all the transactional emails such as order and shipping confirmations.
Learn more about using EasyEditor to create and manage transactional emails for Magento in Map transactional email templates.
To create a transactional email user:
In Dotdigital, expand the User menu in the bottom left and go to Settings > Transactional email > Credentials.
Select ADD NEW TRANSACTIONAL EMAIL USER.
Enter a description and password for the new transactional email user.
Select Enabled to activate the user.
Select SAVE.
Enter transactional email credentials in Magento
Go to Stores > Configuration.
Expand the Dotdigital drop-down menu, then select Transactional Emails.
Expand the Enabled drop-down menu, and select Yes.
Expand the Send Mode drop-down menu, and select SMTP.
For Host, enter your hostname:
For region 1 (Europe), enter r1-smtp.dotdigital.com
For region 2 (North America), enter r2-smtp.dotdigital.com
For region 3 (Asia), enter r3-smtp.dotdigital.com
Enter your transactional email Username and Password.
Expand the Port drop-down menu, then choose an open port.
Options are 25, 587, and 2525.Select Save Config.
Map data fields
In addition to the basic contact information, the connector can map over 40 other pieces of key information from your contacts in Magento to your Dotdigital account.
To automatically map your data fields:
In Magento 2, go to Stores > Configuration.
Expand the Dotdigital drop-down menu, then select Developer.
Under the heading Sync Settings, for Automap Data Fields, select Run Now.
Lists
The connector synchronises contacts to three different lists for three Magento contact types:
Customers
Registered customers of your Magento site that have a customer account.
Subscribers
Contacts who have opted into newsletter subscription on your site.
Guests
Email addresses from an order placed during guest checkout. They are neither a customer or a subscriber.
Before synchronisation, you must create the lists so they can be selected and mapped to.
Create lists
You can create lists directly in the connector or from inside your Dotdigital account.
To create lists from inside the connector:
Go to Stores > Configuration.
Expand the Dotdigital menu, then select Sync Settings.
Under the heading Create List, for List Name, enter a name for your list.
Expand the Visibility drop-down menu, and choose either Private or Public.
This setting controls whether contacts can see the list in a preference centre.Select Create New List.
Repeat the steps above for each of the three lists.
Learn how to create lists in Dotdigital in Create a contact list.
Map lists
Go to Stores > Configuration.
Expand the Dotdigital drop-down menu, then select Sync Settings.
Under the heading List Mapping, expand the Add Customers To drop-down menu, and select the list you want to add your customers to.
Expand the Add Subscribers To drop-down menu, and select the list you want to add your subscribers to.
Expand the Add Guests To drop-down menu, and select the list you want to add your guests to.
Select Save Config.
Tracking
The connector automatically installs the Dotdigital Tag to your store. The Tag enables you to track:
Website views
User identification
Products browsed, to power abandoned browse
Cart updates, to power abandoned cart
Purchase completions
You can also use the Tag to enable Dotdigital Chat.
For joint customers of Dotdigital and Fresh Relevance, you can use the Dotdigital Tag to make your tracking data available across both platforms.
Learn more about the Dotdigital Tag.
Easy Email Capture
Easy email capture functionality allows you to capture your site visitor's email addresses when they haven't fully completed your checkout process or newsletter sign up process.
To turn on Easy Email Capture:
Go to Stores > Configuration.
Expand the Dotdigital drop-down menu, then select Configuration.
Under the heading Abandoned Carts:
Expand the Easy Email Capture (Checkout) drop-down menu, then select Yes.
Expand the Easy Email Capture (Newsletter) drop-down menu, then select Yes.
Select Save Config.
Order sync settings
You can choose to only import and synchronise orders with a certain status, rather than all orders.
For example, you might only be interested in sending campaigns or running segments based on orders that have been fulfilled. In this case, you might only want to import orders with the status Complete.
To choose your order import status:
In Magento 2, go to Stores > Configuration.
Expand the Dotdigital drop-down menu, then select Configuration.
Under the heading Transactional Data, for Import Order With Status, select the order statuses you want to import.
To choose multiple options, hold down the CTRL key on your keyboard.Select Save Config.
Custom attributes
In addition to the default order data, you can synchronise custom order attributes. You can select from all of the order attributes that are available within the Magento system, allowing you to segment and send content based on these additional fields.
To choose your order custom attributes status:
In Magento 2, go to Stores > Configuration.
Expand the Dotdigital drop-down menu, then select Configuration.
Under the heading Transactional Data, for Order Custom Attributes, select the attributes you want to import.
To choose multiple options, hold down the CTRL key on your keyboard.Select Save Config.
Future adjustments
Changes made to custom order attributes are reflected in new imports run after the adjustment has been made. To include these in previous imports the order Insight collection must be deleted and the data re-imported.
Learn more in Synchronise order Insight data in Magento Open Source.
Catalog sync settings
The connector allows you to map and synchronise your product catalog to your Dotdigital account so you can insert products into campaigns and set up product recommendations.
You can choose to sync products of a certain visibility and/or product type rather than all products. This allows you to exclude products that are no longer relevant on your site.
To manage your catalog sync settings:
In Magento 2, go to Stores > Configuration.
Expand the Dotdigital drop-down menu, then select Configuration.
Under the heading Catalog Sync Settings, expand the Catalog values drop-down menu, then select the catalog value.
For Catalog Visibility, select the visibility type for the products to be exported.
For Catalog Type, select the catalog types to be exported.
Select Save Config.
Broken product images
To fix broken product images, try setting the Catalog Values to Store. This uses the store URL for the image path instead of the admin URL.
Enable sync
After your lists have been mapped and your order Insight settings configured you can enable the data sync.
To enable data sync:
In Magento 2, go to Stores > Configuration.
Expand the Dotdigital menu, then select Sync Settings.
Under the heading Sync, you can see all the different types of sync settings. To enable sync for a sync type, expand the sync type drop-down menu, then select Yes.
Most users enable Customer, Subscriber, Guest and Order.Select Save Config.
Within 15 minutes, contacts and Insight data should begin to sync. There is however an intentional hour delay prior to importing order information. This is to prevent order imports from failing due to the related contact not having been imported yet.
For advanced synchronisation options such as Wishlist and Review, see the Data syncing section of the Help Centre.
Status check
There are several ways to check that data is syncing from Magento into Dotdigital.
Contact sync report
Contacts that are successfully batched to be imported should be marked as Imported.
To view your sync report:
In Magento 2, go to Stores > Configuration.
Expand the Dotdigital drop-down menu, then select Sync Settings.
Under the heading Sync, you can see all the different types of sync settings. Find the sync you want to view the report for, then select Click here for status.
Importer status
Batched contacts/orders should exist in this report. Once the importer cron has run, an import should be marked with a status of Importing. Shortly after, data should appear in Dotdigital.
To view your importer status, in Magento 2, go to Reports > Customer Engagement > Importer Status.
Troubleshooting
Cron
Confirm Dotdigital (ddg) cron jobs are running. Cron is a vital part of making sure your data syncing happens correctly. We recommend installing Cron Job Manager to give you a real-time view of the tasks running throughout your site, as well as giving you the ability to manage and configure your cron jobs.
API user
Confirm API credentials are active and valid. You can view the status of the API credentials on the dashboard. The dashboard can be accessed under Reports > Dashboard.
Sync enabled
Confirm at least one contact sync is turned on.
Check permissions
Requires full access (0777) to the var/export directory or full access to the CRON user running on the server.
Abandoned cart - email series
The abandoned cart email series is set up directly within the connector and can be sent to customers and guests. Customers and guests can receive up to three different emails that are scheduled for different time intervals.
If your Magento instance has more then once website, you can configure different emails and settings per website.
Using external dynamic content (EDC), you can include the contents of a cart in your emails.
Learn more
Abandoned cart program
If you want more flexibility for setting up abandoned carts, you can enrol contacts into an Abandoned cart program.
This allows you to use the program builder to tailor the abandoned carts to fit your business needs. For example, you can include more emails or exit contacts based on specific types of behaviour.
This feature is only available in connector version 3.20+.
Status check
You can check the status of abandoned cart emails in the Campaign Sends report.
To access the Campaign Sends report, go to Reports > Customer Engagement > Campaign Sends.
You can see whether abandoned cart emails are being queued for sending, whether they are being sent to Dotdigital, and whether anything is failing. You can sort and filter this report to more easily find the information you're looking for.
Troubleshooting
External Dynamic Content
Confirm that the external dynamic content link you’re using for abandoned carts is correct. To check this, select Dynamic Content from the Dotdigital menu in Magento.
Cron
Confirm that ddg_automation_abandonedcarts and ddg_automation_campaign cron jobs are running. Without both of these running, abandoned cart emails aren't batched or sent.
Conflict
Disable any extensions you might have used previously to send abandoned cart emails.
