• Browse
    • Search
    • Recs
Menu
  • Browse
    • Search
    • Recs
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages
  • Browse
    • Search
    • Recs
Menu
  • Browse
    • Search
    • Recs
  • Search
    • Browse
    • Recs
Menu
  • Search
    • Browse
    • Recs
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages
  • Get started
  • Documentation
  • Integration Doc
  • FAQ
Menu
  • Get started
  • Documentation
  • Integration Doc
  • FAQ

Down Arrow up_Arrow_active Feed

Direct Feed Upload

  • Prepare your Schema
  • Prepare your Catalog
  • Upload your Feed

Feed API

  • Full Feed Upload
  • Delta Feed Upload
  • Single Record Upload
  • Check Product Count

Down Arrow up_Arrow_active Analytics

Introduction

  •  
  •  

Browser Integration

  • Visitors

GTM Integration

  • Introduction to GTM
  • Requirements

Analytics API

  • Events
  • API Integration

Unbxd Events Validator

  •  
  •  

Down Arrow up_Arrow_active Deploy Unbxd

Search API

  • Search Endpoint
  • Authentication
  • Header
  • Request Parameter
  • Response Components
  • Explanation Request Parameter

PDP API

  • PDP API Format

Autosuggest API

  • Sample Request
  • Request Parameters
  • Response Parameters

Android SDK

  • System Requirements
  • Install SDK
  • Initialize SDK
  • Unbxd Commerce Search
  • Integrating Unbxd Autosuggest
  • Unbxd Analytics
  • Unbxd Browse
  • Unbxd Recommendations
  • Sample App

iOS SDK

  • Installation
  • Unbxd Analytics
  • Unbxd Commerce Search
  • Unbxd Autosuggest
  • Unbxd Browse
  • Unbxd Recommendations
  • Sample iOS App

Javascript Library Integration

  • Quickstart with Unbxd Template
  • Quick Integration to your site
  • Detailed Guide
  • Authentication
  • Types of Pages to Render
  • Configuring the Page
  • Instance Methods
  • More Information
  • Available Configurations

Autosuggest SDK

  • Libraries
  • QuickStart
  • Authentication
  • Configuring Autosuggest
  • Sample Options Object
  • Handlebar Functions
  • List of Configs

Search JS SDK Config

  • Search Template
  • Loader Config
  • Facet Config
  • Pagination
  • Spellcheck
  • Sort Config
  • PageSize Config
  • Breadcrumb Config
  • Product Views
  • Variants

React SDK

  • Quick Integration with Unbxd template
  • Quick Integration to your site
  • Installation
  • Authentication
  • Types of pages to render
  • Configuring the page
  • PageSize Config
  • More Info

Down Arrow up_Arrow_active Onboarding & Platform Integration

Onboarding Flow

  • Create an Unbxd Account
  • Create an Unbxd Site
  • Upload a Catalog
  • Setup Search
  • Integrate Search

Onboarding Flow

  • Create an Unbxd Account
  • Create an Unbxd Site
  • Upload a Catalog
  • Setup Search
  • Integrate Search

Shopify

  • Plugin Installation
  • Configuration
  • Uninstallation
  • Test Plugin Installation

Magento Integration

  • Installation
  • Authentication
  • Catalog
  • Catalog Sync
  • Product Integration
  • Custom Template
  • Indexing Queue View
  • Feed View
  • Upgrade
  • Uninstall

SAP Hybris

  • Installation
  • Authentication
  • Catalog
  • Cron Job
  • Product Config
  • Uninstall

BigCommerce

  • Installation
  • Configuration

SAP Hybris

Unbxd Hybris Plugin helps you use Unbxd plugin within your SAP Hybris website which allows to integrate all the product discovery features for your SAP Hybris site with minimal developer intervention.

It allows:

  • Automatic Catalog Sync: Each product addition or deletion is sent to Unbxd servers automatically based on the schedule set up by you, to keep the data at Unbxd servers up-to-date. 
  • Analytics Integration: The Unbxd Extension for SAP Hybris automatically tracks user analytics and behavior that is essential in order to provide accurate and user-specific search results. The extension analyzes every user event and tracks product clicks, products added to cart, and orders. With this information, a user profile is built for every user based on his/her affinity to a certain category, brand, or price.
  • Product Integration: The Unbxd Extension for SAP Hybris helps you to implement Unbxd Site Search on your website and get a fully functional search. The plugin provides a full set of UI/UX libraries to help you build a search interface with a default template instantly. You will also be able to modify the UI elements by creating custom templates. The plugin also helps you to integrate Browse and Recommendations. 

Version

The plugin is currently developed on SAP Commerce version 6.6. 

However, the plugin will support all Commerce versions from 6.0 to 1905 (latest release)

Installation

Installation is the first step to integrate the Unbxd SAP Hybris platform extension. 

To install Unbxd plugin, 

 

  1. Download this module from GIT directories. 
  2. Unzip the module & copy /hybris/bin/custom to /hybris/bin/custom
  3. Open /bin/config/localextensions.xml and add the mentioned code:
      
      <extensions>
      <extension name='unbxd' />
      <extension name='unbxdBackoffice' />
      <extension name='unbxdsearch' />
      </extensions>
     
  4. The UnbxdSearch addon needs to be installed on top of the hybris storefront. To do that, you need to run the following command:
    ant addoninstall -Daddonnames="unbxdsearch" -DaddonStorefront.yacceleratorstorefront="yacceleratorstorefront"
  5. Rebuild ‘Hybris Solution’ by running the following command:
    $ cd /bin/platform
    $ ant clean all && ant updatesystem

NOTE: Here “yacceleratorstorefront” is a storefront plugin that needs to be replaced with the storefront extension name of your installation. Once you rebuild the solution, You can see that unbxdsearch related files are copied in your storefront plugin.

Authentication

Once installed, you need to authenticate your Unbxd extension using your Unbxd account keys.

 

There are three types of account keys:

  • Site Key: The unique identifier of a Site. Each site added on your dashboard will have a visible unique alphanumeric key
  • API Key: The unique identifier of the API calls made from an account. Unbxd provides only one API Key per account.
  • Secret Key: An additional securely generated key used in important request calls such as Product Feed upload. Secret Key is not exposed in the URL. Unbxd provides one Secret Key per account.

To know more about the Keys, refer to our Search Documentation. 

To authenticate you have to create a link between your Facet Config and Unbxd site.

For every Facet Search config, there should be one Unbxd site config to be created, the values for sitename, apikey, secretkey will be provided by Unbxd.

Catalog

All Unbxd algorithms are based on product-related information within the product catalog. 

When you send your catalog to us, we convert it to the Unbxd format, store and index it on our servers. This is called the Product Feed. Synchronizing your feed will allow your Unbxd extension to retrieve your catalog information stored within the Magento database. To know more, refer to Product Feed.

 

To upload your catalog,

  1. Navigate to Unbxd > Index Management, select the relevant Unbxd site config. 
  2. Navigate to Catalog and select True option for Unbxd Feed Push.
  3. Once the feed is pushed, click Index under the Synchronization tab. 

You have successfully synced the Full feed. 

Cron Job

 

Cronjobs are automatically created at the ‘Hybris’ end.

To create a cronjob, 

  1. Navigate to the Unbxd> Index Management> Jobs tab and you would have one full and incremental cron job listed.

  2. Click the hamburger icon on the left of the job which you wish to update and then click edit details:
  3. Now navigate to Time Schedule within the cron job popup and create a trigger element for the cron job.
  4. Fill the Cron Expression field as per the frequency in which you want the jobs to be executed. Ex.
    */2 * * * * (For every 2 mins)

Once done, the cron job is successfully created and scheduled. 

Product Config

Using the Unbxd plugin via the SAP Hybris platform, you can integrate all the product features like Autosuggest, Search, and Browse in few easy steps. To configure Unbxd product offerings, check the following product configs: 

*Ensure that a full index operation is completed prior to enabling the Unbxd features listed below,

Enable Autosuggest

Autosuggest delivers suggestions as the shoppers’ type on the search bar of your site. To enable autosuggest,

  1. Navigate to Unbxd > Index Management & select the relevant Unbxd site config from the result view.
  2. Navigate to the product tab in the editor view of the Unbxd site config and update the enabled attribute in the autosuggest section to true. The config attribute can be used to customize the behavior of autosuggest.

To know more about the configs, go through the Javascript library.

Enable Search

The Search features that let you power your site by Unbxd can be enabled via SAP Hybris. To enable Search,

 

  1. Navigate to Unbxd > Index Management & select the relevant Unbxd site config from the result view.
  2. Navigate to the product tab in the editor view of the Unbxd site config and set the enabled attribute in the Search section to true. The config attribute can be used to customize the behavior of Search.

 

Enable UnbxdDefault Layout

If you select True, then the default template of Unbxd Search is applied. 

But if you have a custom template, set the value of UnbxdDefault layout to False. Then, populate the custom HTML component for layout in SearchResultsListSlot, SearchResultsGridSlot, ProductListSlot, ProductGridSlot respectively.

To know more about the configs, go through the Javascript library.

Enable Browse

You can integrate Browse feature to let the shoppers navigate through product categories. To enable Browse,

 

  1. Navigate to Unbxd > Index Management & select the relevant Unbxd site config from the result view.
  2. Update the enabled attribute in the Category section to true. The config attribute can be used to customize the behavior of browse.

To know more about the configs, go through the Javascript library.

Enable Recommendations

Unbxd recommendation services enable businesses to promote cross-sell or upsell products across the category, product, cart, home & brand pages. There can be up to three recommendation widgets included on one page. To include Unbxd recommendation in  a page follow the below steps,

 

  1. Create an instance of UnbxdProductCarouselComponent (this can be done either through smart edit or use the Impex shown below)
    $contentCatalog=apparel-ukContentCatalog 
    $contentCV=catalogVersion(CatalogVersion.catalog(Catalog.id[default=$contentCatalog]),CatalogVersion.version[default=Staged])[default=$contentCatalog:Staged]
     
    INSERT_UPDATE UnbxdProductCarouselComponent;$contentCV[unique=true];uid[unique=true];name;pageType(code);widget(code);scroll(code);popup;&componentRef;
    
    ;;UnbxdRecommendationsHomepageComponent1;Recommendations Homepage Widget1;HOME;WIDGET1;allVisible;false;UnbxdRecommendationsHomepageComponent1
    
  2. Select the pageType attribute to one of the following value (PRODUCT, HOME, CART, CATEGORY, BRAND) depending on what page you wanted to include  the component
    SmartEdit:
    For a script-based approach use the Impex in step 1
  3. Select the widget attribute to one of the following values (Widget1, Widget2, Widget3) this ties up the recommendation algorithm configured in the Unbxd console. By selecting “All Widgets” options all three widgets will be included one after another.
  4. Associate the newly created component to the content slot on the page.
    $contentCatalog=apparel-ukContentCatalog 
    $contentCV=catalogVersion(CatalogVersion.catalog(Catalog.id[default=$contentCatalog]),CatalogVersion.version[default=Staged])[default=$contentCatalog:Staged]
    INSERT_UPDATE ContentSlot;$contentCV[unique=true];uid[unique=true];cmsComponents(&componentRef)[mode=remove]
    
    ;;Section2CSlot-Homepage;UnbxdRecommendationsHomepageComponent1
    

Enable Analytics

Unbxd search tracks user behavior anonymously and uses machine learning algorithms to power personalized search results that are relevant and accurate. Analytics is built into your Unbxd SAP Hybris extension. To enable Analytics,

 

  1. Navigate to Unbxd > Index Management & select the relevant Unbxd site config from the result view.
  2. Update the enabled attribute in the Analytics section to true. The config attribute can be used to customize the behavior of Analytics.

Uninstall

If you want to remove the hybris plugin from your system, you can uninstall Hybris by the following steps:

  1. Open /bin/config/localextensions.xml, remove the code lines:
      
    <extensions>
      <extension name='unbxd' />
      <extension name='unbxdBackoffice' />
      <extension name='unbxdSearch' />
    </extensions>
    
    
  2. Open /bin/config/local.properties, remove the keys:
    unbxd.sitekey=
    unbxd.secretkey==
    unbxd.apikey==

    For uninstalling Analytics, remove the analytics keys.

    unbxd.analytics.sitekey.default=DevHybris801271569422411

    Analytics plugin needs to be uninstalled as an addon from of hybris storefront plugin. You need to run below command:

    Here “yacceleratorstorefront” is storefront plugin it needs to be replaced with the storefront extension name of your installation.

    ant addonuninstall -Daddonnames="unbxdanalytics" 
    -DaddonStorefront.yacceleratorstorefront="yacceleratorstorefront"
    Rebuild Hybris Solution by running below command
    $ cd /bin/platform
    $ ant clean all && ant updatesystem

    Restart the server

    For Linux users:

    $ cd /bin/platform
    $ ./hybrisserver.sh stop
    $ ./hybrisserver.sh start
     $ cd /bin/platform
    $ ./hybrisserver.sh stop
    $ ./hybrisserver.sh start
    For Windows users:
    C:> cd \bin\platform
    C:> hybrisserver.bat stop
    C:> hybrisserver.bat start
  • Did this answer your question?
  • No…

    I have some feedback

    Feedback is submitted

On this Section

  • To create a Query Rule
  • To Edit a Query Rule
  • Delete a Query Rule
  • Campaign States
  • Create Campaigns
  • Edit Campaigns
  • Preview Campaigns
  • Duplicate Campaigns
  • Delete Campaigns

Copyright 2020 © Unbxd Inc, All Rights Reserved. Privacy Policy