Kibo RTI Application

Configuration Guide

Current Version: 1.0.0 (February 2017)
Install: Kibo eCommerce App Marketplace
More Info: Version History

Kibo Real-Time Individualization (RTI) delivers truly individualized experiences to each customer, across all devices and touchpoints from a big data and machine learning engine that scales for large catalogs and high volumes of interactions. The Kibo RTI Application integrates the functionality of RTI into your Kibo eCommerce solution. Typical RTI use cases include:

Kibo RTI is built on an extensible, big data framework that supports the processing and storage of extremely large data sets in a distributed computing environment. Proven technologies including Hortonworks Hadoop, Cassandra, and Spark drive big data modeling, reporting data aggregation, and customer data processing. Kibo RTI has a unique real-time tier that stores models and data in memory. This real-time access system allows for extremely fast response times for complex queries, including site or app context data and unique customer data. All requests to the RTI system can be managed via REST APIs, allowing for complete control of front-end systems.

Application Features:

Install the App

You can install the Kibo RTI Application directly from the Kibo eCommerce App Marketplace:

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

After the application installs to your tenant, log in to Dev Center and install it on the sandbox(es) of your choice:

  1. Log in to Dev Center.
  2. Click Develop > Application.
  3. Double-click Kibo RTI Application.
  4. Click Install and select the sandbox of your choice from the list.

You can now configure the Kibo RTI Application through Admin on any sandbox in which it is installed.

Configure the Application

To integrate your Kibo RTI services with Kibo eCommerce, review the configuration requirements to ensure you have everything you need to be successful before you begin, and then complete the steps in this section.

Configuration Requirements

Obtain Kibo RTI Account Credentials

Contact your Kibo RTI professional services team to obtain your Kibo RTI credentials, which you need to configure the Kibo RTI Application. The credentials you need to obtain are:

Configure Kibo RTI to Receive Exports

One of the features of the Kibo RTI Application is the ability to schedule recurring exports of product attributes from Kibo eCommerce to Kibo RTI. To configure your Kibo RTI account to receive these exports, contact your Kibo RTI professional services team.

Configure the App

  1. In Admin, go to System > Customization > Applications.
  2. Click Kibo RTI Application.
  3. Click the Configuration link to open configuration settings.
  4. Open the Settings tab.
    1. Enter your Instance ID.
    2. Enter your SFTP User Name and SFTP Password.
    3. Enter your FTP Path.
    4. Choose an Export Time and Export Frequency.
    5. Click Save.
  5. (Optional) Open the Attributes tab.
    1. Choose custom product attributes if you want to export attributes additional to the ones included in the export by default, which are the Canonical URL, Price, Product Code, Product Image, Product Name, and Source URL attributes.
    2. Click Save.

Enable the App

After configuration, enable the Kibo RTI Application. To enable the app:

  1. In Admin, go to System > Customization > Applications.
  2. Click Kibo RTI Applications.
  3. Click Enable App.

Update Your Theme

This section assumes you are familiar with Kibo eCommerce theme development. Consult your theme developer or Kibo eCommerce Professional Services if you need help implementing these theme modifications.

The Kibo RTI Application requires a new widget in your Kibo eCommerce theme. You can download the required code from GitHub.

Note: The Mozu/Mozu.Integrations.RTI.Widgets GitHub repository is private. Contact Kibo eCommerce Support with your GitHub username to request access to this repo.

Edit Your Site in Site Builder

After you update your theme with the sample code from GitHub and apply the new theme you to your site, you are ready to add RTI widgets to your site.

  1. In Admin, go to Main > Site Builder > Editor.
  2. Select your site from the top bar.
  3. In the site tree, click a page where you want to add RTI functionality.
  4. Switch to Widgets in the site tree and drag any of the RTI widgets onto a dropzone. The widgets available to you are:
    • RTI Observation Log—This widget needs to be on every page on your site, so place it on your base site template. This widget does not have configuration steps aside from dropping it into a dropzone.
    • RTI Configuration—Place one of these widgets on every page in which you place an RTI Recommended Products widget. You only need one of these widgets per page, no matter how many RTI Recommended Products widgets you place. To configure this widget:
      1. (Optional) Enter additional query parameters if you want to import RTI data for product attributes not included in the default list, which includes only the price, product ID, thumbnail URL, and title attributes.Note:  You must first export any custom product attributes to Kibo RTI if you want to import their data in this widget. To learn how to specify custom product attributes for export, refer to the Configuration and Export sections of this guide.
      2. (Optional) Select to limit the query by Tenant ID or Site ID.
      3. Click Save.
    • RTI Recommended Products—Place this widget on any Home, Cart, Product Detail, or Category page where you want to display recommended products to shoppers. You can place multiple RTI Recommended Products widgets on the same page, but make sure to place one (and only one) RTI Configuration widget on any page that contains RTI Recommended Products widgets. To configure this widget:
      1. Specify the Page Type in which you placed the widget in.
      2. Under Placeholder Name, select the RTI widget group that the widget should be associated with. You can find details about the available RTI widget groups by logging into your RTI account and searching for your configured widgets. As shown in the following example, if you want to match to the You Might Like widget group, you would select the bn_div2 placeholder name.
      3. Click Save.
  5. Publish your changes to your live site.

Use the App

Export Data

The Kibo RTI Application works by automatically exporting product attribute data from Kibo eCommerce to Kibo RTI. However, you should initially perform a manual export to check whether any errors occur during the export process.

  1. In Admin, go to System > Customization > Applications.
  2. Click Kibo RTI Application.
  3. Click the Configuration link to open configuration settings.
  4. Open the Exports tab.
  5. Click Export Now.

If you encounter any errors, click the error number in the list to identify the product that is causing the error. After the first manual export, the Kibo RTI Application automatically exports data at the frequency and time that you specified during configuration.