Woocommerce

Plugin

my.clerk.io settings #

In my.clerk.io, click “Data” in the left-side menu and scroll down to “Data Sync Settings” to set and adjust your Clerk.io backend settings with WooCommerce.

Here, you enter your Store URL, the page size of your synced data, and sync time(the time of day your data syncs, default is whenever needed).

Plugin Settings #

If you are using v3.8.0 or a later version of the extension, you will be able to access the below settings in two ways after adding your Public and Private Keys to the plugin:

  • Through the WooCommerce backend in Plugins > Clerk
  • Through my.clerk.io, under Settings > Extensions

It does not matter where you make the changes, as the extension will sync with any changes made in my.clerk.io and vice versa.

In my.clerk.io you will also be able to see your current version of the extension, your platform, and the PHP version.

Simply click “Edit” on any setting, to see the available options:

Sync #

After downloading the Clerk.io plugin, you can access this from your main left-side menu in your WooCommerce admin page by clicking " Clerk".

General & Customer Sync

In the General section, after adding your Public and Private Keys, you can choose the language for the Clerk.io plugin. Your Import URL, which you added to your my.clerk.io Data Settings, is also located here for reference.

Under Customer Sync, you have the option to add customer data fields that you use in your store. Be sure to check the “Enabled” box to sync things customer details with Clerk.io.

Data Sync

In the Data Sync section, you have the option to:

  • Use Real-Time Updates to sync your data to Clerk.io in real-time once changes are made.

  • Include Pages: Checking the box next to “Include Pages” allows the different pages in your store to be synced along with your Product data.

    • Type in the data fields you’d like to sync from your pages under " Pages Additional Fields", separated by commas. This could include “URL” or “images” for example.

  • Check the appropriate boxes to Include Out of Stock Products, Collect Emails, and/or Collect Baskets data to sync with Clerk.io.

  • Additional Fields: Here, you can add a comma-separated list of any additional Product Data fields you’d like to sync to Clerk.io from your WooCommerce store.

  • You can also check the box to Disable Order Synchronization with Clerk.io if needed.

  • With Image Size you can control the size of the images that Clerk imports

In this section of the plugin, you’ll set the different options for your Clerk.io Search Page.

  • Choose your page type for your Search Page from the dropdown, like “Example Page” in the example here.

  • Content: Enter the name of your Clerk.io Search Page Content here, found in embed code for that Content in your store’s my.clerk.io backend, often something like search-page.

  • No results text: Enter the text you’d like to display on the Search Page if a search returns no results here, and set the text for the “Load More” button in the following field.

  • Include Categories / Pages: This let’s you control whether Clerk should find matching Categories or Pages to show on the Search Page.

  • Number of Categories / Pages: This let’s you decide how many possible matches to return for each type.

Note: You are now able to call the data for categories and pages in your Search page in the same way you would in your Live search, giving you a larger range of information to engage your customers with. For more information you can check here.

Enable your Clerk.io Live Search by checking the first box in this section.

  • Include Suggestions/ Categories / Pages: This let’s you control whether Clerk should find matching Categories or Pages to show on the Search Page.

  • Number of Suggestions / Categories / Pages: This let’s you decide how many possible matches to return for each type

  • Select the Pages type you’d like to return as page results in the next dropdown, such as Blog Posts or CMS Pages.

  • Choose the position of the Live Search dropdown results, then enter the Input Selector and Form Selector for your live search found in your store by inspecting the Search box with your browser.

  • Finally, enter the name of your Live Search Content from the Content embed code in my.clerk.io, often something like “live-search”.

To add facets to your Search Page, first be sure to check the “Enabled” box under Faceted Navigation.

Facets #

  • Type in the value of an attribute you’d like to include in your facets in the “Add Custom Attribute” box, then click “Add”.

  • Once added, your added attributes will appear under Facet Attributes. In this section, you can create the Title to be display for that facet, and what position in the list of facets you’d like that attribute to appear. Check the box under “Show” to show that attribute in your facets.

Customising Your Search Page Facets

  • Clerk.io allows you to style your search page facets from within the design and you can display this by referencing it with the Design field in the plugin
  • The design ID can be found in the Clerk.io backend, on the far left column of each design on the design overview page and in the bottom left of the page once you enter the design to edit.

Powerstep & Exit Intent #

In the Powerstep Settings section, you can enable the Clerk.io Powerstep by first checking the box, then set:

  • Powerstep Type: Choose the type of powerstep you’d like to enable from the dropdown menu, like “page” or “popup”.

  • Powerstep Page: Choose the page for the Powerstep to appear, between “Front Page”, “Example Page”, “Cart”, etc.

  • Contents: Here, you’ll enter the Content you’ve created for your Powerstep in my.clerk.io, which is listed within the Content embed code as your data template name, which looks something like: “data-template= YOUR-CONTENT-NAME”

  • Filter Duplicates: Activating this will ensure that each banner shows completely unique products, at the cost of a slightly longer load time.

Under Exit Intent Settings, you can enable your Clerk.io exit intent content by checking the box, then enter the name of the exit intent Content you’ve created for your store, which can be found the same way as your Powerstep Content.

Category, Product, and Cart #

In these sections, you’ll enable and add the Content names for Recommendations content you’d like to add to your Category, Product, and Cart pages.

Check the " Enabled" box under the appropriate page section, and paste the Content name in the “Content” box to include that content on the page. In this example, we’ve added category-page-popular in the Category content.

  • Filter Duplicates: Activating this will ensure that each banner shows completely unique products, at the cost of a slightly longer load time.
  • Category / Product / Cart ID Shortcode: These shortcodes allow you to easily insert Clerk embedcodes if you want to customise their placements with editors like WPBakery and Elementor. The shortcodes needs to be inserted in order to add the relevant ID’s from the categories, product pages or cart. E.g:
<span class="clerk"
   data-template="product-page-alternatives"
   data-products="[[clerk_product_id]]">
</span>

_

Logging #

First thing you have to do to change the logging settings is to go into your WooCommerce backend and choose Clerk in the left side menu:

Next, scroll down to the headline called Logging and choose your preferred settings:

To make the changes take effect, scroll to the bottom of the page and press Save:

The Logging settings include:

Log level

  • Only Errors: Will log any errors that stops the module from working correctly

  • Errror + Warn: Also logs warnings that are not causing the module to stop working, but might be necessary to fix as well.

  • Error + Warn + Debug: Logs everything that the module interacts with. This should not be enabled on a live webshop as it will slow down the site.

Log to

  • File: Will save the log to a file on the WooCommerce server.

  • my.clerk.io: Will log everything to Data->Logs in the my.clerk.io backend.

Upgrading #

If you are using a version before 2.0.0, upgrading will break your Designs, since Clerk.js 2 will be used. If using an older version, follow this guide instead.*

Important: Remember to take backups of any modified files, as they will be overwritten.

Upgrading the Plugin can be done directly from the WooCommerce admin.

Start by going to Plugin->Add New

Then, search for Clerk in the search-field to the right, and click Update Now.

Thats it! Now you are running the latest version of Clerk.io for WooCommerce.

If you already have the latest version, this button will simply say Active.

I updated the plugin but now I do not see clerk active anywhere on my webshop.

Note that in order for the update to go through, then the clerk plugin will be deactivated. To fix this then you will need to reactivate the clerk again.

Uninstalling #

Disabling Customer Sync #

To disable customer data syncing with Clerk.io, simply uncheck next to “Enabled” in this section within the plugin. You can find the plugin in your WooCommerce admin portal on the left-side menu, labeled “Clerk”._

Disabling Search & Recommendations #

Similar to disabling Customer Data, you can disable each of the Clerk.io products by unchecking the box next to “Enabled”. Example below of disabling Live Search from a WooCommerce webshop:

Disabling the Clerk.io plugin #

To remove Clerk.io from your store, first log into your WooCommerce admin portal, and choose “Extensions” from the left-side menu.

Find “Clerk”, and click “Disable”:

Once disabled, the option to Delete the Clerk.io extension will appear in the same location as Disable previously was.