Integrate Magento v1

Magento is a very flexible platform that lets you make modifications to the core capabilities for better marketing. The Optimizely Data Platform (ODP) connector integrates with Magento using best practices. If you have concerns with how your Magento store is set up, please reach out to support@zaius.com before integrating.

What data is integrated?

Configure Magento 1.X connector

1. Download the latest connector package: Zaius_Engage-0.14.2.tgz (Change Log)
2. Log in to your Magento admin console.
3. Go to System > Magneto Connect > Magento Connect Manager.

   

4. After you log in to the Magento Connect Manager, click Choose File... and select the connector file you downloaded in step one.
5. Click Upload. You will see a log at the bottom of the page detailing the installation process.
6. In your Magento admin console, go to System > Configuration.
7. Under Sales, select Zaius Engage.
   If you get a 404 or permission error when clicking on Zaius Engage, you must log out of your admin session and log back in.
   
8. Paste your Tracker ID into the specified text box and click Save.
9. If the Track Product Listing Views option displays, click Yes.

Congratulations! Your new events will now be sent to ODP.

Magento 1.X permissions setup

To use Magento with ODP, create a user with SOAP API permissions.

1. Go to System > Web Services > SOAP/XML-RPC - Users. If a user does not already exist, create a new one.

   

   • You must provide the username and API key that is specified to ODP to enable the integration.
   • This user must have permission to use the ODP Engage API to retrieve data from Magento.

To ensure the user has appropriate permissions:

1. Go to System > Web Services > SOAP/XML-RPC - Roles to assign appropriate permissions to the user. ODP Engage provides a custom API that is used during the initial import of customers, products, and orders.
2. Associate the user with the new role.
3. Go to Integrations > Magento API and enter the Username, API Key, and the API URL for your server. The API URL often looks like this: http://your-magento-server/api/v2_soap?wsdl=1

Configure ODP Engage

ODP Engage provides a set of configuration options for the plugin.

• Tracking identifier – The ODP Tracker Id.
• Cart Abandonment Secret Key – A secret value used to encode link information for cart abandonment campaigns. Do not change this once set. This is a random string that you enter not provided by ODP.
• ODP Schema Update & ODP Batch Updates – Optional but recommended tweaks.

Don't change the other settings unless your customer success manager (CSM) recommends it.

Configure batch updates (0.12.0 and up)

Many Magento sites have a variety of backend processes that run direct SQL inserts and updates, especially ERPs. When a direct SQL modifies the Magento database, Magento's Observers do not inform other technologies (such as ODP) about it, causing those technologies to desynchronize from the Magento dataset.

To account for this, ODP has built a Batch Update module which lives in Magento to find those products, customers, and orders that have been updated since the last scan.

1. Go to ODP Engage > ODP Schema Update > Run It! so that the batch process knows which entries to sync. This adds two columns to the database tables that ODP syncs: zaius_created_at and zaius_updated_at.
2. In the ODP Batch Updating panel, change the Crontab line to indicate how frequently you would like the updates to run. More frequent updates mean that each update takes less time to process; however, a small query runs against the database to determine if there is anything ODP needs to sync. ODP recommends either a high-frequency update (such as "*/5 * * * *" meaning every 5 minutes) or a daily batch at a low-traffic time (such as "0 1 * * *" meaning at 1 AM as indicated by your Magento server's clock).
3. Set the Enable/Disable option to Enable.

Configure localizations (0.13.0 and up)

Many Magento sites support multiple language/currency code combinations and create each one as a separate store_view. 

The ODP Localizations featured in the ODP Engage module adds support for such sites to automatically detects those store_views and send additional, localized versions of products. These products provide all information necessary to generate dynamic product grids in your customers' preferred languages, even for products that have not interacted with.

This feature is  still in a beta phase, meaning that the ODP support team must make certain updates on the ODP platform to fully utilize this feature. Please consult with your CSM to get those changes made prior to initializing this feature.

1. Go to the ODP Engage configuration page.
2. Under ODP Localizations, switch Enable/Disable to Enable.

ODP Double Opt-in Beta (0.13.3 and up)

ODP Engage has a new option to support double opt-in workflows. Set the Submit Event For Status Not Active option in the ODP Engage Configuration.

With the Submit Event For Status Not Active option enabled, new users with subscription status 2 ("Not Active") will trigger a "newsletter" event with action "email_submitted."

Users can configure an Event Triggered campaign to allow the user to opt-in and use engagement with that campaign as a filter for their regularly-occurring sends. Your ODP CSM can help set this up.

Magento coupon codes

To add a coupon code in an email in ODP, add the below Liquid to set the rule_id as the ID for the coupon code you want to use.

{% assign coupon_rule = '{"rule_id": 1}' %}
{{ zaius.magento.api_config | magento_v1_coupon_code: coupon_rule }}

You can find this ID in Magento under Promotions > Shopping Cart Price Rules.

Change log