WooCommerce

Getting Started

What does the Plug-In do?

The PureClarity Woocommerce Plug-in does the following:

  • Creates all the links to product, category, user & brand data
  • Allows you to submit data feeds and historic order data feeds
  • Ensures data integrity between your store and PureClarity through cron jobs
  • Sets up the Zones (BMZs) for the Home Page, Cart Page, and Checkout Page.

To get started you’ll need to create a PureClarity Application Account.

Create a PureClarity Application Account

You can sign up for a new account by clicking here and following the steps to create your admin account.

Once you’re in you’ll need to get the following keys which you’ll add to the Magento extension:

  1. AccessKey
  2. SecretKey

You can find these under the My Account > Integration menu.

If you have multiple language stores you will need an application per store, and thus multiple Application Access Keys. Please contact our Support Team to create additional PureClarity accounts for you at support@pureclarity.com.

NOTE: For security reasons it’s important to not share the SecretKey with anyone.

Install the Extension

You can install the extension by visiting the WordPress Plugins and downloading the PureClarity – eCommerce Personalization for WooCommerce.

Environment Configuration

Once the PureClarity extension has been installed and enabled, navigate to the PureClarity settings page by clicking on PureClarity on the left-hand bar menu. Then click Settings, right at the top.

This takes you to the config area, then do the following:

  1. Paste in your AccessKey and SecretKey.
  2. Select ‘On’ on the ‘Enable Mode’ option. This will give you the option to enable PureClarity on your site, disable it, or enable it only for the admin user. That is, you will see PureClarity on your site, but any visitors will not.
  3. Check the boxes to enable Merchandising and Product Delta Sync.
  4. Scroll down and hit the Save Changes button.

Data Feeds

Before Enabling PureClarity on the front end you must ensure the extension has submitted an initial set of data feeds to PureClarity.

Navigate to Data Feeds under the PureClarity tab.

Submitting the first feeds

To begin with, you will have four red-lined boxes, saying you have never run a Product, Category, User, or Order feed.

As soon as you do the first one, these will turn into green-lined boxes and will stay that way.

For now, leave the Run Order Feed, this is discussed below.

NOTE: As outlined above changes to data are updated automatically by the PureClarity extension. However, should you wish to manually submit a full feed to PureClarity you can follow this process at any time.

Once the feeds have been generated, they will be submitted to PureClarity. To see when the data has been processed you can log into the PureClarity admin console, select Settings > Feed Management to see a list of the feeds along with their import statuses.

If you switch on the WordPress debug logging on, PureClarity will write any issues from data feeds to the error log, so it’s possible for you to check there to detect the root of the problem.

Historic Sales Orders

Following the same initial import process for Products, Categories, and Users, you can also import the last 6 months of orders into PureClarity. This helps to activate and kick start the data that PureClarity collects by allowing the system to begin mining common purchase patterns and associating buying activities to users.

Orders can only be imported only once. If orders are imported a second time they are dropped by the system so as to not duplicate data.

Advanced

In the advanced settings, there are several configuration options.

First, it’s possible to enable BMZ debugging. This is where you can see the location of your BMZs but they’re not being populated. Navigate to the PureClarity: Advanced Settings page and check the “Enable BMZ Debugging” box. BMZs will be populate with their name and id.

You can allow PureClarity to automatically insert BMZs on six areas: the Home Page, Product Listing Page, the Search Results, the Product Page, the Cart Page and the Checkout Page.

The Home Page and the Product Page will have four BMZs automatically inserted, the other four pages will have two inserted.

If these are not checked, placement will have to be done manually. As mentioned above, the plugin only allows you to edit a few pages. If you want to alter BMZ placement on any pages other than those, you will need to alter your theme templates, which may require front end development support.

You can manually edit the pages which are available by navigating to Pages > All Pages, and then selecting the page you’d like to edit.

There you can use the following short code:


 [pureclarity-bmz id=“HP-01”]

to place the BMZs around the page.

The Id is necessary for the BMZ to appear.

You can also use the short codes top=”XX” and bottom=”XX” to add additional buffer space on the top and bottom areas of the BMZ, respectively. These are optional.

You can also add setting class=”XXX” to apply a custom CSS class to the PureClarity BMZ element.

If you want to add a PureClarity BMZ to a theme template, you can use


 <?php echo do_shortcode("[pureclarity-bmz id='HP-01']"); ?>

Product Page & Product Tags

On the Product Page, you can add product tags, which will then become searchable tags for that product for search recommenders.

You can also set the product to be Published, draft, or pending review. PureClarity will only be sent that product if they are Published.

There is also the option to change visibility. Visibility must be set to Public to be sent across to PureClarity.

Go Live with PureClarity

To go live with PureClarity, the next time you do a release on your site, you can make sure the site has the PureClarity plugin on it, ensure that the plugin has the same AccessKey and ScretKey as your current staging site, and then run a product feed once the keys are on the live site, so that PureClarity knows about the products on your live site – including links.

Congratulations! PureClarity is now installed, configured and initialised and is ready to be switched on!

Zones (BMZs)

Overview

The WooCommerce Plugin has defined areas for Zones, or to give them their long name Behavioral Merchandising Zones (BMZs), which will be placed automatically upon implementation.

This is done on six pages:

  1. Home Page
  2. Product Listing Page
  3. Search Results
  4. Product Page
  5. Cart Page
  6. Order Received Page.

This document is a guide to where you can expect Zones to sit on your site. You can see these for yourself on your site by enabling the BMZ debugger.

Some pages also allow you to use shortcodes to arrange the PureClarity BMZs around your content: the Home Page and the Cart Page. You can do this on the plugin under Pages> All pages

PureClarity has three shortcodes:


[pureclarity-bmz id="XX-YY]

where XX is HP for Home Page, or OC for Order Confirmation Page. YY is the number, so 01, 02, 03, or 04. You can arrange this around your content to your liking.

You can also add top=”XX’ and bottom=”YY”, replacing XX and YY with numbers, to add buffer space to the top and bottom of the BMZ.

Home Page

The Home Page has four BMZs. It is one of the pages that allows you to use shortcode.

Product Page

The Product Page has four BMZs. WordPress’s setup does not allow you to edit the placement of the BMZs within the PureClarity plugin.

Product Listing Page

The Product Listing Page has two BMZs.

Search Results

The Search Results have two BMZs.

Cart Page

Also known as the Basket Page (and hence is BP in the shortcode). The plugin allows you to use shortcode to arrange these BMZs. There are two BMZs on this page.

Order Confirmation Page

This page has two BMZs, and is called the Order received page on the site.

NOTE: Any further arrangements or additions will need to be done in a theme by a developer.

Need Any Help?

For any further questions, please get in touch with your success manager, or the support team at support@pureclarity.com

  WooCommerce