How to integrate with Magento platform

In case of a Magento store that serves more than one language/currency, we recommend the standard tag integration (for example using Google Tag Manager).

The Magento integration lets you install a plugin via GitHub and enable Mention Me’s tags from within your Magento account. Once installed, you can choose from several default tag positions—or manually select where tags load. You can also preview how tags appear in your Magento account.

The plugin is compatible with Magento 2.1.18, 2.2.9, 2.3.x

Follow these instructions to install and enable a Mention Me integration with Magento.

Installing the Module

You can install the plugin via:

• Composer (recommended)
• ZIP (downloaded from GitHub)

We recommend using Composer for a clean install. Your Magento2 project should have an associated composer.json file to manage modules.

Install via Composer (recommended)

• Add the GitHub repository as a Composer source:

composer config repositories.mentionme vcs https://github.com/mention-me/magento2-integration

• Add the dependency:

composer require mentionme/module-mention-me --no-update

• Update dependencies:

composer update mentionme/module-mention-me

• Enable the module and refresh cache:

php bin/magento module:enable MentionMe_MentionMe
php bin/magento setup:upgrade
php bin/magento cache:flush

Install manually via FTP

• Download ZIP from GitHub ("clone or download" > "Download ZIP")
• Copy the "app" folder from the ZIP archive to your Magento root directory
• Enable the module and refresh cache:

php bin/magento module:enable MentionMe_MentionMe
php bin/magento setup:upgrade
php bin/magento cache:flush

After the above steps, the Mention Me module will be ready for configuration.

If you're running PHP OPcache that doesn’t clear automatically, you must clear it for the new module to be available.

Configuring the Integration

• Navigate to Stores > Configuration > Mention Me
• Add your Merchant Partner Code in the General configuration section

Referrer

• Automatically enabled.
• Fields populated on order: firstname, surname, customer email, order_number, order_total (net), order_currency, locale.

Referee

• Automatically enabled.
• Select the tag position from the "Position on Page" dropdown, or choose manual placement for custom themes (insert the MM wrapper in your template).

Landing Page

Automatically enabled as a Magento widget. Manage and place the landing page using Magneto's widget system.

• Go to Content > Widgets
• Click Add Widget
• Select MentionMe Landing Page as the type and your theme. Click Continue.
• Give the widget a title and select stores to trigger
• Under Widget Options, specify the situation param
• Use Layout Update to select the CMS page/container for the landing page
• Send the full landing page URL to your Mention Me Onboarding Manager

Dashboard

• Automatically enabled.

Conversion Message (homepage and product)

• Automatically enabled.
• Select the position, or manually place the tag for custom themes.

Saving and viewing the configuration

After placing tags or widgets, save config and flush cache. Click Customer View to preview how tags look for your customers.

Click Customer View to check that enabled tags are in place.

Upgrading the Module

Upgrading via Composer

• Update to the latest stable version:

composer require mentionme/module-mention-me --no-update

• Update Composer dependencies:

composer update mentionme/module-mention-me

• Upgrade the module and flush cache:

php bin/magento setup:upgrade
php bin/magento cache:flush

Upgrading manually via FTP

• Download latest ZIP and remove existing app/code/MentionMe directory
• Copy new "app" folder to Magento root
• Upgrade module and flush cache:

php bin/magento setup:upgrade
php bin/magento cache:flush

Removing the Module

Remove via Composer (recommended)

• Remove the module:

composer remove mentionme/module-mention-me

• Flush config and cache:

php bin/magento setup:upgrade
php bin/magento cache:flush

Remove manually via FTP

• Delete app/code/MentionMe directory
• Flush config and cache:

php bin/magento setup:upgrade
php bin/magento cache:flush

Support

As with any new software install, always take backups and test in staging before deploying to production.

You may also view these instructions here.