Bazaarvoice Conversations Application by Kibo eCommerce

Configuration Guide

Current Version: 1.0.0 (May 2015)
Install: Kibo eCommerce App Marketplace
More Info: Version History

Bazaarvoice Conversations provides services to track and display customer interactions with your products. With Bazaarvoice Conversations, you can leverage multiple types of shopper-generated content, including ratings and reviews, questions and answers, and campaigns. By displaying this content on your store site(s), you can increase customer engagement, your SEO rankings, and ultimately your ROI.

The Bazaarvoice Conversations Application by Kibo eCommerce seamlessly integrates your Bazaarvoice Conversations account with Kibo eCommerce so you can display captured content on your Kibo eCommerce storefront.

Application Features

Note: You must add Bazaarvoice widgets to your Kibo eCommerce theme to display Bazaarvoice Conversations content on your Kibo eCommerce site. Code for these widgets is available on GitHub. Contact Kibo eCommerce Support with your Github username for access to the Mozu/Integration-BVWidgets repository.

When a shopper enters a review or rating, the following occurs between Kibo eCommerce and Bazaarvoice:

Install the App

You can install the Bazaarvoice Conversations Application by Kibo eCommerce directly from the Kibo eCommerce App Marketplace:

  1. Go to: www.kibocommerce.com/marketplace
  2. In the Search field, enter: Bazaarvoice
  3. Click the app icon.
  4. On the app page, click Install Now.

Configuration Requirements

Configure the App

  1. In Admin, go to System > Customization > Applications.
  2. Click Mozu Bazaarvoice Conversations Application.
  3. Click the Configuration link to open the configuration dialog.
  4. Enter your Bazaarvoice credentials on the Configuration tab. For more information on the options available in the Configuration tab, refer to the following sections:
    1. Edit Clients
    2. Edit Client Settings
    3. Edit Groups
    4. Edit Group Sites

Edit Clients

On the Clients page, you can edit credentials and configurations for your Bazaarvoice clients. The following table describes the options on the options available on the Clients page:

 

Field Description
New Client Select to add a new Bazaarvoice client to the list of clients available in the Clients table.
Name Bazaarvoice client name.
Master Catalog The number of the master catalog linked to this Bazaarvoice client.
Edit Select to edit a client. When you select this option, Kibo eCommerce displays the Client Settings configuration page. For more information, refer to the Edit Client Settings section below.
Delete Select to delete this client from the Clients table.


Edit Client Settings

When you select Edit on the Clients page, Kibo eCommerce displays the Client Settings configuration page. Here you can edit credentials associated with your selected Bazaarvoice client.

The following table describes the options on the Client Settings configuration page:

Field Description
Environment Specifies the site you are configuring for Bazaarvoice content. If you have multiple sites, you can enter different settings for each site.
Master Catalog Specifies whether the site can exchange data with Bazaarvoice Conversations. You must enable this option for your Bazaarvoice content to remain up-to-date.
Client Name Name used to identify a Bazaarvoice client. Usually the same as your FTP Username.
FTP Username Your username for the Bazaarvoice FTP server. The FTP server is used for imports and exports of data. This name is provided to you by Bazaarvoice and is typically the same as your Client Name.
Use Client Name Select to use the current client name as your FTP username.
FTP Password Your password for the Bazaarvoice FTP server.
Deployment Zone (Optional) The Bazaarvoice deployment zone you want to use. Most configuratons have one zone, Main Site. However, you can configure multiple deployment zones in Bazaarvoice if you have multiple product detail page types.
SEO Cloud Key (Optional) This key allows Kibo eCommerce to access your SEO data in Bazaarvoice SEO. Bazaarvoice SEO features can include user-generated content in addition to your own site content for purposes of SEO. You can find this key on the Settings > SEO page of the Bazaarvoice Configuration Hub:
The Settings > SEO page of the Bazaarvoice Configuration Hub
The Settings > SEO page of the Bazaarvoice Configuration Hub


Edit Groups

In the Site Groups section of the Client Settings page, you can view groups associated with your Bazaarvoice client and add, edit, or delete an individual group. Group contain sites that Bazaarvoice will import/export data from.

The following table describes the fields for the Site Groups section and table:

Field Description
Add New Group Select to add a new group
(unlabeled) Group Name Name of the group. Group names must be alphanumeric and contain no spaces.
(unlabeled) Group Domain Indicates the domain associated with this group. If you do not enter a domain for a group, it will default to the domain for your site.
Edit Select to edit a group. When selected, Kibo eCommerce displays the Sites table. For more information, see the Edit Group Sites section below.
Delete Select to delete a group from the Site Groups table.
Save Client Select to save client settings.


Edit Group Sites

When you select Edit in the Site Groups section of the Client Settings page, Kibo eCommerce displays the Sites table. Here you can edit the Kibo eCommerce sites associated with a group.

The following table describes the field in the group sites table:

Field Description
Add New Site Select to add a new site to this group.
Site ID Site ID for the site associated with this group.
Enabled Indicates whether the site is enabled for Bazaarvoice to pull data from it.
Note: A client will export if at least one site is enabled, but the export will only include information from the enabled sites.
Variant Indicates whether to export data for product variants in addition to base products.
Delete Select to remove a site from this group.
Save Group Select to save changes to this group’s settings.


 

Enable the App

  1. In Admin, go to System > Customization > Applications.
  2. Click Mozu Bazaarvoice Conversations Application.
  3. Click Enable App.

Edit Your Theme

This feature requires changes to your core theme. Ask your theme developer to make the changes outlined in this github pull request.

Enable Live Edit

Enabling Live Edit for products allows you to make immediate edits to products that are live on your storefront even if product publishing is set to staged. The Bazaarvoice Application uses this functionality to ensure your products display the latest ratings and reviews. To enable the live editing feature:

  1. In Admin, go to System > Settings > Publishing.
  2. Ensure your product publishing setting is set to Staged.
  3. Check Live Edit.

Import and Export Data

After you configure the Bazaarvoice Application for the first time, you must manually import and export data between the systems. After this initial sync, imports and exports occur automatically. Data transfers go through the Bazaarvoice FTP server, using the credentials and Environment you specified on the Configuration tab. Remember to switch the Environment to Production when you are ready to display live data on your site.

Note: The default times for imports and exports of each type of data are indicated in the following sections. You can change import/export timing and frequency from within Bazaarvoice.

Product Exports

Exporting products updates all products in Bazaarvoice to capture with ratings, reviews, questions and answers, and so on that have come in through your Kibo eCommerce site.

Assign Products to Bazaarvoice Categories

You must assign a Bazaarvoice category to each product in your catalog before you can complete a successful export:

  1. In Admin, go to System > Schema > Product Attributes.
  2. Create a new property and name it Bazaarvoice Category.
  3. For each product you want to export, go the product page in Admin and enter a value for the Bazaarvoice Category.

Note: Each product can only belong to one Bazaarvoice Category.

Export Product Data

  1. In the app configuration dialog, go to the Product Export tab.
  2. If this is your first export, or if you want to manually force an export, click Export Now. Future exports will occur automatically. By default, Kibo eCommerce exports product data to the Bazaarvoice FTP server daily, at 2:00 AM CST. Bazaarvoice accesses the files at 3:00 AM CST.
  3. (Optional) If an error occurs, click the link in the Errors column to view the error log.

Ratings Import

Importing ratings gets the latest customer rating info for all configured products:

  1. In the app configuration dialog, go to the Ratings Import tab.
  2. If this is your first import, or if you want to manually force an import, click Get Ratings. Future imports will occur automatically. By default, Kibo eCommerce imports ratings data daily, at 1:00 PM CST.
  3. (Optional) If an error occurs, click the link in the Errors column to view the error log.

You can view the imported ratings for a product in Admin. Go to Main > Catalog > Products and select a product. In the Properties section, a Rating field appears. The populated rating data is synced from Bazaarvoice using a calculated average rating from all calculated shopper ratings entered through the storefront. The theme widgets use the Rating property as an option for faceting and filtering products on your storefront. For example, a shopper can choose to only view products with a certain rating.

SEO Import

The SEO Import tab displays a log of imports of SEO tracked data. You must enter your SEO Cloud Key on the Configuration tab to import this data. By default, Kibo eCommerce imports data files from the FTP at 3:00 AM CST daily from Bazaarvoice.

To manually start a job, select the tab and click Import SEO Ratings.

Add the Theme Widgets

Shoppers interact with Bazaarvoice in your storefront through widgets you add to your product pages in Site Builder. For the widgets to appear, you must add them to your Kibo eCommerce theme. Code for the widgets is available on GitHub.

Note: The Mozu/Integration-BVWidgets repository is private. Contact Kibo eCommerce Support with your GitHub username to request access to this repo.

Once you have added the Bazaarvoice widgets to your Kibo eCommerce theme, you can view them in Site Builder:

  1. In Admin, go to Site Builder > Editor.
  2. In the site tree, go to Pages > Templates > Product.
  3. Switch to the Widgets view:
  4. Drag the Bazaarvoice Conversations Ratings widget to a dropzone on the page. A configuration screen appears:
  5. Select the type of widget to add:
    • Summary—Displays a detailed summary of reviews. You can enter JavaScript in the Tab Code to have the summary open the Reviews or Q&A tabs on-click by shoppers.
    • Customer Reviews—Displays all customer reviews and ratings entered for the product.
    • Q&A—Displays questions and answers about the product.
    • SEO—Tracks SEO ratings. This widget does not display content to the page. It simply captures and saves data for SEO.
    Note: You can stack multiple widget types on the page, such as Summary followed by Customer Reviews.
  6. Click Save to save the widget configuration.
  7. Click Save in the Editor to save the template changes. You can now preview the changes on your storefront.