What does the extension do?
The PureClarity WooCommerce extension does the following:
- Creates all the links to product, category, user & brand data
- Allows you to submit the first data feed and historic data feed
- Sets up the autocomplete and search results page
- Sets up some starting BMZs automatically for the Home Page, Cart Page, and Checkout Page, Product Listing Page, Product Page and Search Results.
- Ensures data integrity between your store and PureClarity through cron jobs
To get started you'll need to create a PureClarity Application Account.
Create a PureClarity Application Account
You will need to contact our Support Team to create your PureClarity account at firstname.lastname@example.org.
You will then receive the following for your new application:
NOTE: For security reason it’s important to not share the SecretKey with anyone.
Install the Extension
When you first start, ensure WooCommerce is installed and working. Your PureClarity Success Manager will provide you with the PureClarity Plugin in a zip file, which can be installed in WordPress by unzipping it in the correct location.
Check out this WordPress documentation to read more about that.
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.
Paste in your AccessKey and SecretKey.
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.
Check the boxes to enable Search, Merchandising, Product Listing and Product Delta Sync, or whichever combination of PureClarity features you'd like to enable.
Scroll down and hit the Save Changes button.
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 Configuration > 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.
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.
Tell PureClarity where to put the Autocomplete and Search results with the DOM selector.
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 short code
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']"); ?>
On the Product Page, you can add product tags, which will then become searchable tags for that product.
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.
Congratulations! PureClarity is now installed, configured and initialised and is ready to be switched on!