Installation

Summary

The dotmailer for Magento 2 connector can be installed via Composer's dependency management tool or via FTP. Firstly though, this article begins with guidelines for a pre-installation health check to ensure all goes as well as possible before, during and after installation.

Pre-installation health check

Note: We recommend that you back up your installation before using it.

Versions and compatibility

This connector is available for Community Edition (version 2.0 upwards), and Enterprise Edition (version 2.0 upwards).

Conflicts

While every site is different, the connector could potentially come into conflict with other extensions. For instance, other extensions using namespace could conflict with front name 'connector', previously used to access dynamic content, which is pulled from the site on a send. Abandoned cart extensions and other SMTP tools could also come into conflict with the connector, and this makes it important to state these during the installation process.

Note: Core rewrite conflicts with Newsletter\Model\Subscriber.php, Customer\Model\Customer.php, Core\Model\Email\Template.php

Cron installation and dotmailer tasks

The dotmailer for Magento connector has several cron tasks attached to the installation to ensure the connector functions correctly. Below are the current tasks and their timings:

  • ddg_automation_abandonedcarts - at five-minute intervals
  • ddg_automation_campaign - at five-minute intervals
  • ddg_automation_catalog_sync - at 15-minute intervals
  • ddg_automation_cleaner – on the 1st day of every month
  • ddg_automation_customer_subscriber_guest_sync - at 15-minute intervals
  • ddg_automation_importer - at five-minute intervals
  • ddg_automation_order_and_quote_sync - at 15-minute intervals
  • ddg_automation_reviews_and_wishlist - at 15-minute intervals
  • ddg_automation_status - at 15-minute intervals

The cron heartbeat should be running every five minutes to do the required tasks and the synchronisation of data into the dotmailer account. The connector is unable to function correctly without cron tasks.

File permissions on var/export

File permissions on your site are an important part of the connector being able to write imports to be sent to dotmailer.
The connector will require full access (0777) to the var/export directory or full access to the CRON user running on the server.

UAT and sandbox environments

dotmailer always recommends testing any new deploys/extensions within sandbox/UAT environments, enabling you to check the compatibility with your site and other extensions you may have installed.
For UAT and sandbox environments, you should check the types of your contact data fields in dotmailer plus any possible firewall restrictions for API calls, i.e. when connecting an API user between dotmailer and Magento.
You can do this by creating a separate trial account of dotmailer.


Installing the Magento 2.0 connector via Composer

  1. Set up the correct path for Composer or keep Composer within Magento root
  2. In Magento root, run the command 'composer require dotmailer/dotmailer-magento2-extension'
  3. After the above is successful, run the command 'php bin/magento module:enable Dotdigitalgroup_Email' in Magento root. This will let Magento know about the module
  4. Run the command 'php bin/magento setup:upgrade' in Magento root. This will ensure any installer scripts we may have are executed properly and store the current data version
  5. Run the command 'php bin/magento setup:di:compile' if you have a single website and store, or 'php bin/magento setup:di:compile-multi-tenant' if you have multiple ones
  6. Clear your cache from Magento admin

Installing the Magento 2.0 connector via FTP

  1. Go to our official Magento 2.0 public repository, and download the ZIP file
  2. Unzip the file
  3. Create the following directory structure: 'Magento_Root/app/code/Dotdigitalgroup/Email'
  4. Drop/move all of the content inside the unzipped folder to directory 'Magento_Root/app/code/Dotdigitalgroup/Email' on FTP
  5. Run the command 'php bin/magento module:enable Dotdigitalgroup_Email' in Magento root. This will let Magento know about the module
  6. Run the command 'php bin/magento setup:upgrade' in Magento root. This will ensure any installer scripts we may have are executed properly and store the current data version
  7. Run the command 'php bin/magento setup:di:compile' if you have a single website and store, or 'php bin/magento setup:di:compile-multi-tenant' if you have multiple ones
  8. Clear your cache from Magento admin
Have more questions? Submit a request

Comments