Setup for a Store with One Store View

  • 6 minute(s) read
Prev Next

Purpose

Use this setup if you have one store (one website) with one store view.

Procedure

Setup in Mapp Engage

A) Create Groups

You must create three groups for the purpose of data synchronization. You will need them later during the plugin setup.

  1. On Mapp Engage, navigate to the Audience section and click on Groups > Create New and three groups:

    1. one for customers called, for example, "magento_customer"

    2. one for subscribers called, for example, "magento_subscriber"

    3. one for guests called, for example, "magento_guest"

B) Prepare messages

You can create messages in Mapp Engage or use the default message provided by Adobe Commerce (Adobe Commerce Admin Panel > Marketing > Email Templates). The plugin supports sending email messages described on this page.

To create the message in Engage, follow these steps:

  1. Go to the Message section in Mapp Engage and choose Prepared Message.

  2. Click on Email > New Email.

  3. Compose the transactional emails you want to send. You will need them at a later stage of the configuration.

    Once these messages are created, you can select them in Adobe Commerce by going to Stores > Configuration > Mapp Cloud > Mapp Engage (Connect) - Emails. See step I2 below.

    For more information, see Prepared Messages.

C) Create integration between Engage and Adobe Commerce

  1. Go to Data Management > Mapp Connect.

  2. Click Add New Integration.

  3. Select the integration type "Magento" from the drop-down list. 

  4. Enter the name of the connection and click Create.
     

  5. The Integration Settings tab opens to the Overview tab. You can still change the name of the integration here and add a description.

  6. (optional) Check the box if you want a Whiteboard triggered when the contact's mapping attributes change.

  7. Copy the secret key and save it for future reference. You will need it to authenticate the connection between Mapp Engage and your plugin.

  8. Click Save.
     

D) Configure Mapping

A mapping is a list of imported data objects from Adobe Commerce. The default types of import for Adobe Commerce, as well as standard attributes, are already added.

Default Magento Mapping

Mapping

Mapping Type

Description

Web Push Mapping

Allows you to send a push notification (prepared message) to the contact using email as an identifier. This requires adding the mobile app ID in the API call.

Product Mapping

Adds products from the Adobe Commerce product catalog to the product catalog in Mapp Engage.

Coupon Mapping

Imports coupons from your Adobe Commerce store in bulk.

​Customer Mapping​

Adds users to Mapp Engage. By clicking Edit, users can add more Adobe Commerce attributes as add-on attributes. For more information about attributes, see Attributes.

​Newsletter Mapping

​Adds users to newsletter mapping. Not editable.

​Transaction Mapping

Allows to:

The Edit button allows to:

  • change mapping items (not recommended due to email parameters – if the mapping name is changed, email placeholder needs to be changed as well), or

  • add order attributes (they must be added to the Transactional Related Data structure first).

​Email Mapping​

Here are all the default parameters that can be used as email placeholders. Editing and adding new parameters is allowed (remember to use the same name in email placeholders with parameters).

Abandoned Cart Mapping

Allows you to map source data with the default structure of the Abandoned Cart Related Data Table.

Wish List Mapping

Allows you to map source data with the default structure of the Wishlist Related Data Table.

Any custom mapping needs to be added to the configuration. This can be done via an import or manually:

  1. Go to Data Management > Mapp Connect.

  2. Open the Adobe Commerce integration of your choice.

  3. Click the Mapping tab.

  4. Import your mapping, or add it manually. 

For more information, see Mapping.

Setup in Adobe Commerce

E) General Configuration

  1. Log in to the Adobe Commerce Admin panel and go to Store > Configuration > Mapp Cloud > Mapp Engage (Connect) General. By default, this page opens to Scope: Default Config. 

  2. Configure the Adobe Commerce general settings, such as choosing the environment or adding specific preferences.

    Setting

    Details

    Module Enable

    Here, you can activate and deactivate the Mapp Engage module.

    Mapp Connect API URL

    • EU L3:  https://jamie/.g.shortest-route.com/charon/api/v1/  

    • EU EMC:  https://jamie/.h.shortest-route.com/charon/api/v1/  

    • US L3:  https://jamie/.a.shortest-route.com/charon/api/v1/

    • US EMC:  https://jamie/.c.shortest-route.com/charon/api/v1/  

    • Specified: This option opens the Mapp Connect custom API URL input field.

    For more information, see Mapp Engage Clusters and Time Zones.

    Mapp Connect custom API URL

    You must select Specified in the Mapp Connect API URL field for this field to appear.

    Example configuration

    Settings for Mapp Connect API module with URLs and enable options displayed.

F) Integration Configuration

  1. Enable the integration by selecting Yes in the Integration Enable field.

  2. Enter the Integration ID and Integration Secret generated in Mapp Engage.

  3. Click the Save button.

  4. Click the Save Config button to save the configuration.

    Setting

    Details

    Integration Enable

    You can activate and deactivate the integration between Mapp Engage and Adobe Commerce.

    Integration ID

    Both are generated in Mapp Connect. See point C3 above.

    For more information, see Create an Integration.

    Integration Secret

    Connection Status

    Displays the connection status with Mapp Connect.

    Example configuration

    Integration settings display with successful connection status and generated IDs for Mapp Engage.

G) Export Connection Configuration

Configure synchronization for products, customers, transactions, and newsletters.

Adobe Commerce sends only real-time data to Mapp Engage. Data created before the integration is not transferred automatically.

If you need historical data in Engage, you must:

  1. Export data from Adobe Commerce using CSV Exports, and

  2. Import data into Engage using Data Imports in Mapp Connect (FTP/SFTP).

Setting

Details

Synchronization method

  • DB Trigger: This is the recommended setting. The DB Trigger method allows for requests to be sent multiple times in case of a failure (for example, connection issues). If you select this option, the  Max Newsletter Request Retry Count option will appear at the bottom of the Export Connection Configuration section. There, you can change the default number of retries from 10 to a custom number.

  • Legacy: This is the default setting. Note that failed requests are not resent when this option is used.

Enable Product Synchronization

Allows you to define your synchronization preferences for products. 

If enabled, the products created on the Adobe Commerce admin page will show in the product catalog in Mapp Engage. 

Add Cached Product URLs to Sync

  • Yes: Enabling this option is recommended to prevent accidental syncing of large images.

    By default, Adobe Commerce resizes catalog images and caches them, ensuring that only the necessary image size is loaded. If a resized image is not found, placeholder images are used instead.here

  • No: You can disable this option if cached images are not reliably used. If you decide to change this option, it is recommended to perform a full synchronization of products again using the mapp:export:products command to ensure that everything is up to date.

Generate Resized Product Images during Sync

This option appears when you set Add Cached Product URLs to Sync to Yes. Enabling this option ensures that all cached images are present during the product synchronization process.

Enabling this option may decrease the export performance, as it will generate two resized files for each product if they don't already exist during the syncing process.

Enable Customer Synchronization

This setting enables you to specify your synchronization preferences for contacts. 

If enabled, Engage will mirror contacts created in Adobe Commerce.

Enable Sales Transaction Synchronization

This setting enables you to specify your synchronization preferences for transactions. 

If enabled, Engage will mirror transactions registered in Adobe Commerce.

Newsletter Synchronization

Allows you to define your synchronization preferences for newsletters.

If enabled, contacts who sign up for a newsletter with their email address will be added to the defined Mapp Engage group.

Newsletter double opt-in

Allows you to Enable or Disable double opt-in for the newsletter. 

For more information, see Set up Double Opt-in with the Email Channel.

Max Newsletter Request Retry Count

This option appears when the Synchronization Method: DB Trigger is used. The DB Trigger method allows for requests to be sent multiple times in case of a failure (for example, connection issues). The default number of retries is 10, but you can uncheck the Use system value checkbox and enter a custom number.

Use system value

If checked, the plugin will use the Adobe Commerce system value even if another option is selected from the drop-down. 

Example configuration

Configuration settings for product synchronization and customer data management in Magento.

H) Mapp Engage Groups

  1. Select the groups created in Mapp Engage in step A of the procedure.

  2. Click on the Save Config button to save the configuration.

You must create three groups for the purpose of data synchronization in Mapp Engage. The groups will only appear if the plugin is set up correctly and the connection is active.

Example configuration

Mapp Engage Groups interface displaying customer, subscriber, and guest group options.

I) Configure messages

  1. In the Adobe Commerce Admin account, go to Stores > Configuration >  Mapp Cloud > Mapp Engage (Connect) - Emails.

  2. For each transactional email, select the prepared messages you created in Engage (step B above) or check the Use system value checkbox if you want to use the Adobe Commerce email. See Use Magento Transactional Emails for more information about transactional emails.

  3. Click Save Config.

Related articles