Getting Started

WHAT DOES THE EXTENSION DO?

The PureClarity Magento 1 extension 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

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 downloading the latest release from our GitHub repository releases page.

Once you've downloaded the source cod,e it needs to be extracted into the root folder of your Magento 1 site.

ENVIRONMENT CONFIGURATION

Once the PureClarity extension has been installed, navigate to the PureClarity settings page by hovering over the System menu item from the top bar menu. Then click Configuration, right at the bottom. Finally, scroll down until you see PURECLARITY configuration on the left-hand menu bar:

Go ahead and click that.

This takes you to six config areas.

First, expand the Environment tab and click ‘Yes’ on the Enabled menu.

Then, expand the Credentials tab. Here, paste in your AccessKey, SecretKey and select your specific Region from the drop down. Click [Save Config].

If you have multiple stores (e.g. with differing languages), contact us to provide you with multiple Access Keys.

You can configure each store individually by selecting the store from the Current Configuration Scope drop down at the top left of the configurations page, and configuring each store separately.

DATA FEEDS

BRAND FEEDS

If you’d like to enable PureClarity with Brand information you will need to configure, enable and submit brand feeds. This could also be a Vendor or Manufacturer. A brand under most circumstances requires a name and an image to activate the brand recommender and search functionality in PureClarity. As Magento does not support Brands, PureClarity uses categories for brands.

You can configure this in the Catalog section on the top menu bar:

From there, select ‘Manage Categories’.

The PureClarity Magento extension handles brand feeds using Magento categories. This is done by creating a parent category, for example with the name “Brands”, that will have a list of subcategories for each of your brands. This will allow you to give each brand a name, an image and add the products that belong to that brand. The parent category and subcategories can be set to hidden from menus, but note that “Is Active” must be set to “Yes”.

Once your brand categories are configured and you’ve added your products to them, you can set the parent category, such as Brands, under the “Brand Parent Category” drop down box under the PureClarity configurations page you navigated to earlier. This tells PureClarity to treat all the first level children of this category as brands.

Before enabling PureClarity on the front end you must ensure the extension has submitted an initial set of data feeds to PureClarity. This is documented below.

To keep your data in sync, you can use the Daily Feed, which sends the feed to PureClarity once a day. You might also consider turning on the Delta feed, which enables any changed you make to products to be sent along to PureClarity within a matter of minutes.

SUBMITTING THE FIRST FEEDS

To kick things off ensure you have saved your settings and then click the [Run Feed…] button under the Actions tab to display the PureClarity Data Feed popup. From here we can manually generate and submit the data feeds:

Select the Website and Store you’d like to submit a data feed to, ensure Products, Categories, Brands and Users are checked, and click the [Run selected feed generations now] button.

For now, leave the “Import Historic Sales Orders” unchecked, this is discussed below.

You will see a status progress for the data feed creation and submission process.

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 there are any issues with the feeds, see the TroubleShooting Guide.

See the Advanced Configuration for more information on configuring what is sent as part of the product and category feed.

HISTORIC SALES ORDERS

Following the same initial import process for Products, Categories, Brands 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.

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 SecretKey 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! 

Please see our Magento 1.x Configuration article for the next steps.

Did this answer your question?