What does the extension do?
The PureClarity Magento 2 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
- Setup the autocomplete and search results page
- Sets up the BMZs for the Home Page, Product Page, Basket Page and Order Confirmation Page.
- 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 email@example.com.
You will then receive the following for your new application:
- SecretKey, and
- Region ID
If you have multiple language stores you will need an application per store, and thus multiple Application Access Keys.
NOTE: For security reason it’s important to not share the SecretKey with anyone.
Install The Extension
The best way to install PureClarity via Composer:
$ composer require pureclarity/pureclarity-magento-2 $ php bin/magento module:enable Pureclarity_Core $ php bin/magento setup:upgrade $ php bin/magento setup:static-content:deploy
Once the PureClarity extension has been installed and enabled, navigate to the PureClarity settings page by selecting the PureClarity menu item from the left hand menu. You may need to clear the cache if the item isn’t available. You can also access the setting by navigating to Stores > Configuration > PureClarity > Configuration.
Select “Yes” under Enabled, and paste in your AccessKey, SecretKey and select your specific Region from the drop down. Click [Save Config].
Note: If you have multiple stores (e.g. with differing languages) and we have provided you with multiple Access Keys, you can configure each store individually by selecting the Store from the “Store View” drop down at the top of the configurations page, and configuring each store separately.
Data Feeds & Indexing
Before Enabling PureClarity on the front end you must ensure the extension has submitted an initial set of data feeds to PureClarity.
Under normal circumstance, Products and Categories are automatically taken care of for you using the Magento Index Manager. In addition to indexing, nightly feeds keep the system up to date with User data and Brand data.
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 in order to activate the brand recommender and search functionality in PureClarity
The PureClarity Magento extension handles brand feeds through the use of 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 they must be enabled.
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 Data/Feed Indexing section on the PureClarity configurations page. This tells PureClarity to treat all the first level children of this category as brands.
Submitting the first feeds
To kick things off ensure you have saved your settings and then click the [Data Feed] button 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 anytime.
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 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 12 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.
You will be able to tell if the historic sales orders have been imported by going to Analytics -> Merchandising Performance, selecting "Offline Orders" as the channel in the top right corner, and then looking at the past 18 months as a time window. If you have imported historic orders, there will be data appearing there.
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!