ZAIUS connects directly to your Magento instance using the ZAIUS Magento Connector. Follow the instructions below to enable the connection and start receiving live data.

Installing the Magento 1.X Connector

  1. Download the latest connector package: Zaius_Engage-0.13.3.tgz (Change Log)
  2. Log in to your Magento admin console, and from the System drop down menu, navigate to the Magento Connect sub-menu and select Magento Connect Manager
  1. Once you have logged in to the Connect manager, click 'Choose File...' and select the connector file you downloaded in step one
  2. Click 'Upload', you will see a log on the bottom of the page detailing the installation process. Once that is complete, the connector is installed.
  3. Navigate back to your Magento admin console, and from the System menu select Configuration
  4. On the left-hand menu under the 'Sales' category, you will see a Zaius Engage Option. Click that.
    Note: 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
  1. Paste your Tracking ID into the specified text box, and click save.
  2. If you see a box labeled "Track Product Listing Views" say Yes

Congratulations! Your new events will now be sent to Zaius

Magento 1.X Permissions Setup

In order to use Magento with Zaius, a user with SOAP API permissions must be created. To do this, navigate to System > Web Services > SOAP/XML-RPC - Users and create a user if one does not already exist.

The username and API key specified will be provided to Zaius in order to enable the integration.

This user must have permissions to use the Zaius Engage API to retrieve data from Magento. To ensure the user has appropriate permissions, navigate to System > Web Services > SOAP/XML-RPC - Roles to assign appropriate permissions to the user. Zaius Engage provides a custom API that is used during the initial import of customers, products, and orders.

Once the Role is created, make sure you associate the user with the new role.

Enter the username, API key and the URL endpoint on your server into the boxes found in the integrations screen in the Magento box. The API URL is typically of the form: "http://your-magento-server/api/v2_soap?wsdl=1"

Configuring Zaius Engage

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

  • Tracking identifier -- This option is the Zaius Tracker Id to send to
  • Cart Abandonment Secret Key -- This is a secret value used to encode link information for cart abandonment campaigns. Once set, this should not be changes. This is a random string that you enter in and is not something Zaius provides.
  • Zaius Schema Update & Zaius Batch Updates - these are optional but recommended tweaks. For more information see "Configuring Batch Updates" below.

Other settings should be left to the default unless your customer success manager recommends a change to them.

Configuring Batch Updates (0.12.0 and up)

Many Magento sites have a variety of backend processes which run direct SQL inserts and updates, especially ERPs. When the Magento database is modified via direct SQL, Magento's Observers don't know that there are updates to inform other technologies (like Zaius) about. This can cause those technologies to desynchronize from the Magento dataset.

To account for this, Zaius has built a Batch Update module which lives in Magento. This feature causes Magento to regularly look through the database to find those products, customers, and orders which have been updated since the last time it scanned through. 

  1. Navigate to the Zaius Engage configuration page.
  2. In the Zaius Schema Update panel, click "Run It!" to make necessary modifications so that the batch process can know which entries need to be synced. This adds two columns to the database tables which Zaius syncs, zaius_created_at and zaius_updated_at.
  3. In the Zaius Batch Updating panel, change the Crontab line to indicate how frequently you would like the updates to be run. More frequent updates mean that each update takes less time to process, but each time we're scheduled to update a small query will be run against the database to determine if there is anything which needs to be synced. Zaius recommends either a high frequency update (eg "*/5 * * * *" meaning every 5 minutes) or a daily batch at a low-traffic time (eg "0 1 * * *" meaning at 1 AM as indicated by your Magento server's clock).
  4. Make sure to set the "Enable/Disable" option to "Enable".

Configuring Localizations (0.13.0 and up)

Many Magento sites support multiple language/currency code combinations, and create each one as a separate store_view. Zaius has added support for this workflow.

The Zaius Localizations feature in the Zaius Engage module adds support for such sites. The feature automatically detects those store_views configured as localizations and sends additional, localized versions of products. These products provide all information necessary to generate dynamic product grids in your customers' preferred languages, even when the products shown are not necessarily products they have explicitly interacted with.

At this point in time this feature is in a beta phase, which means that the Zaius support team must make certain updates on the Zaius platform to fully utilize this feature. Please consult with your CSM to get those changes made prior to initializing this feature. 

  1. Navigate to the Zaius Engage configuration page.
  2. In the Zaius Localizations panel, switch the Enable/Disable dropdown to "Enable"

Zaius Double Opt-in beta (0.13.3 and up)

Zaius Engage has a new option to support double opt-in workflows. To enable this, make sure to set the "Submit Event For Status Not Active" option in the Zaius 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 Zaius CSM can help set this up.

Magento Coupon Codes

To add a coupon code in an email in Zaius, you need to add the below liquid add 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 }}

This ID can be found in Magento under Promotions > Shopping Cart Price Rules.

Magento Connector Change Log

0.13.3  (Download) - 2018-10-22

  • Added beta support for double opt-in workflows
  • Cleaned up potential undefined case when getting subscriber information (which would have appeared in logs, but didn't interrupt tracking or loading)

0.13.2  (DEPRECATED) - 2018-09-19

  • Hotfixes for a variety of bulk import errors
  • Minor tweaks to localizations code for broader compatibility
  • Additional logging of errors to Zaius-specific logs
  • Added product availability field which is populated using the Magento "getIsSalable" function.

0.13.1  (DEPRECATED) - 2018-07-13

  • Hotfixes for tracking live updates to products when using new localizations feature.

0.13.0  (DEPRECATED) - 2018-07-12

  • Localizations Update: Adds support for localized store_views, including inheritance, linking between languages, varied currency reporting, and more. (During the public beta phase, configuration requires support from the Zaius team, please contact your Customer Success Manager)
  • Improved support for configurable products (more to come)
  • Improved and extended APIs to enable the Zaius support team to provide more accurate troubleshooting, more quickly

0.12.2  (Download) - 2018-07-12

  • Hotfixes for Coupon Code Support which addresses a case where coupons were not setting the appropriate type, causing the generated codes to be usable multiple times.

0.12.1  (Download) - 2018-06-20

  • Hotfixes for Batch Updates which cover more environments and improve consistency of APIs.

0.12.0  (DEPRECATED) - 2018-06-04

  • Further fix for Customer address import issues causing some addresses to be cut off prematurely. If affected, install the update, then ask Zaius Support to reimport customers for you.
  • Fix for subscriber import and updates ensuring subscribe events are appropriately timestamped - prevents a subscriber synchronization causing all subscribers to appear actively engaged within Zaius.
  • New Feature: Batch Updates.
    In certain situations, updates (frequently to products)  are not detected by Magento, which meant Magento never updated Zaius. This could cause Magento and Zaius to get out of sync.
    We've added an optional component which will configure Magento to send regular updates to Zaius. When activated, this feature will add columns to Magento databases (zaius_created_at and zaius_updated_at) so that the batch process can send us updates of only new and updated datapoints.
    While we have not previously identified cases beyond the products feed, this feature is available for products, customers, and orders (but not refunds or cancellations).
    Please see "Enabling Batch Updates" above for details on configuration.

0.11.1  (Download) - 2018-05-14

  • Fix for Customer address import issues causing some addresses to be cut off prematurely. If affected, install the update, then ask Zaius Support to reimport customers for you.

0.11.0  (Download)

  • Support Magento EE Full Page Cache

0.10.2  (Download)

  • Fixed for WS-I compliance for python and .NET clients.

0.10.1  (Download)

  • The initial data ingest will no longer fail if orders correspond to an invalid Magento store. 

0.10.0  (Download)

  • Zaius works with Magento when WS-I mode is enabled.

0.9.0 (Download)

  • In-stock information/quantity remaining is now provided for items each time they are purchased.

0.8.3 (Download)

  • Orders now use base currency, rather than native currency.

0.8.2 (Download)

  • Fix a regression in support for older PHP versions where the plugin would not work correctly.

0.8.1 (Download)

  • Every API call to Zaius now submits data via an encrypted connection.

0.8.0 (Download)

  • Allow product/order/customer ids to be prefixed by a unique id to allow multiple magento instances to be pulled into a single Zaius account

0.7.2 (Download)

  • For products, Zaius now uses the "media URL" for an item, rather than the cached, rescaled version of an image.

0.7.1 (Download)

  • Provide product brand information from the Magento manufacturer field

0.7.0 (Download)

  • Add support for generating unique coupon codes via Zaius campaigns

0.6.11 (Download)

  • Fixed a potential problem with cart abandonment link handling

0.6.10 (Download)

  • Support installs with php up to 7.1.2
  • Fix a bug where cart abandonment required a static cart creation time (other Magento plugins can change the cart creation timestamp) resulting in problems with cart abandonment campaigns.

0.6.8 (Download)

  • Backend order tracking now correctly handles orders that move directly from "pending" to "complete". Previously, because "processing" was skipped, the order purchase event was not being sent. This only applies if the "Track Orders on Frontend" option is turned off.

0.6.7 (Download)

  • Cart Abandonment links now work for installs with multiple servers
  • Orders are now tracked when the order moved into the "processing" state, rather than when it is created (only if the "Track Orders on Frontend" option is turned off).

0.6.6 (Download)

  • UTM parameters are passed along during abandoned cart redirects
  • Custom fields are now optionally returned on products
  • The plugin version number (0.6.6) is provided back to Zaius when data is sent to Zaius, to aid in debugging

0.6.4 (Download)

  • Abandon cart links work more reliably with Zaius Engage
  • Product images are now correctly imported into Zaius

0.6.2 (Download)

  • Provide historical information about customer unsubscribe status upon customer ingest

0.6.1 (Download)

  • Bug fixes related to posting of backend orders and product entities.

0.6.0 (Download)

  • Default orders to be produced via the Magento backend, rather than relying on the post-order page fully loading.
  • Fix an issue related to UTF-8 corruption in billing address which could cause lost orders for customers in foreign locales

0.5.7 (Download)

  • Allows cart abandonment to work for customers who are not logged into the system (but whose identities can be inferred through user stitching)

0.5.5 (Download)

  • Minor bugfix related to producing errors instead of exceptions on missing image files

0.5.4 (Download)

  • Minor bugfix related to incorrect processing of purchases entered from the admin console

0.5.3 (Download)

  • Changed order tracking strategy to work more reliably with checkouts involving redirection to third party payment processors

0.5.2 (Download)

  • Capture image_url and description for product entities

0.5.1 (Download)

  • Provide information for shopping cart abandonment campaigns

0.5.0 (Download)

  • Support order cancellation and order refunds

0.4.0 (Download)

  • New bulk retrieval API to streamline and generally improve the initial import process
  • Capture price for product entities
  • Capture associated Magento website, store, and store view on all events (and bulk imported orders) to aid in scoping and analysis

0.3.2 (Download)

  • Fixed order tracking bug that was causing multi-shipping checkouts to fail.

0.3.1 (Download)

  • Added safer handling of potentially missing internal data fields. If you are having trouble with the checkout process not completing, this should fix the issue.
  • Explicitly reverts to anonymous mode upon customer logout.

0.3.0 (Download)

Did this answer your question?