EmpathyBroker: FAQs

I am integrating EmpathyBroker Experience API with an instant-motion and token-token search kind of behaviour. How can I make sure trackQuery from tag API is not sending noise to my findability metrics?

To avoid sending queries to EmpathyBroker findability metrics that are just characters (since token-token search deploys inmediacy and acts on every character), you can add a delay of ‘n’ milliseconds.

Here is a sample to apply a delay to trackQuery (formerly known as trackSearch) from EmpathyBroker tagAPI:

window.setTimeout(function(){

//Here is where the trackQuery (before known as trackSearch) would be called.

} , 2000);

Regarding the trackClick tag (known as trackDocument on previous versions) within the tagAPI: Is there a way to define a unique listener of events for all DOM elements?

The listener event will only be assigned to those elements that you wish to track and measure as a click and therefore elements that will affect the findability metrics (-elements such as an image, a product title or an add to basket icon-).

The extensive use of the trackClick tag (known formally as trackDocuments tag) does not cause performance issues that need to be accounted for. Anyhow your Set Up team provides an staging environment URL (which is the same as the live environment by with the prefix “PRE”) so you can run whatever tests you consider necessary to confirm there is no performance issues related with the extensive use of trackClick tag (or trackDocuments tag).

Can I check the status of a Data Feed sent to EmpathyBroker Index API?

Yes, EmpathyBroker IndexAPI provides REST services that allow you to access details of sent Data Feeds so you know what has been indexed any moment.

Can I control when to index in EmpathyBroker?

EmpathyBroker Index API gives you total control. You decide when, what and how to index.

Can I have multiple Data Feeds for each language or content type (prices or stock updates only)?

Yes you can and is a recommended practice that will optimize your indexing cycles.

Can I index any language into EmpathyBroker?

Yes you can, however you have to let EmpathyBroker Set Up team you know you are adding new languages. One of the key differentiators of EmpathyBroker deployments regarding multi-language and multi-bite encodings is that it handles every language independently, processing and assigning specific synonyms and hyponyms as well as given stop words (empty words) that apply to every specific language.

From EmpathyBroker dashboard you can edit and control your active languages, scopes, domains and portals.

Yes you can. All indexing jobs can be managed and controlled at your end, whether you’d like to create scheduled jobs or push an specific indexing job.

Can we use other Data Feeds like Google Merchant?

Sure you can, as long as it contains sufficient Data to satisfy your user demands. ;) Many EmpathyBroker customers use other Data Feeds and most times are directly indexed, some other times might be necessary for EmpathyBroker to take care of some Data Feed improvements for you.

Get client TOKEN

Our developers validate the file and send the TOKEN to use the index platform.

How can I generate a Data Feed file?

All ecommerce platforms provide APIs that allow you to export a product catalogue Data Feed in XML or any other text format.

In some cases we can help you Spider product or non-product pages, depending on what an excellent search service needs from a Data Feed.

We have extensive experience on how to accomplish a Data Feed export, do not hesitate getting in touch with our Support or Set Up teams.

How can I obtain or request my Client ID to start using EmpathyBroker Index API?

Contact your appointed Set Up Manager or get in touch with EmpathyBroker Support team .

How can I start using EmpathyBroker Index API?

Once you sign up with EmpathyBroker, you receive your EmpathyBroker Set Up activation email with your Client ID. This Client ID is what you need to send your Data Feed to EmpathyBroker.

How often can I send a Data Feed for indexing so I can update my Search with my Catalogue/Content?

As often as the nature of your Data demands. You take control of your indexing cycles with EmpathyBroker IndexAPI. Some of EmpathyBroker customers index hundreds of times a day, some other just a few times a day, it all depends on the needs of your Site to which EmpathyBroker adapts.

How to index manually from a command line into EmpathyBroker with Index API

You just have to follow 3 steps. Don’t be afraid! Is easy ;))

a) Identifying yourself to Index API

b) Sending the feed to index via a command line

c) Checking status.

A) Identifying yourself to EmpathyBroker Index API:

1. You need a security token to be able to identify your site to EmpathyBroker index API. If you don’t have one contact Support or your Account Manager

2. You need the name of your Feed is: catalog is the default name but you could have been provided Stock, Price or Sales independent feeds. You need to confirm this with our Set Up team or Support team.

Where you have to replace “YOUR_XML_FILE_NAME” for the XML file you want to send and TOKEN_ID is your identifier (see section A; Identifying yourself to EmpathyBroker Index API)

C) Checking status:

3. How do I check if it has been sent OK?

http://index.colbenson.com/services/jobs/TOKEN_ID

Again you need your TOKEN_ID to check status.

I try to send a file for indexing via “post” to index API but indexing does not execute

If you have tried to index a file via “post” with a method=”post” for EmpathyBroker index API and the indexing hasn’t been executed, this is most probably caused by the fact that you don’t have the Data Feed Name (catalogue) or the TOKEN id (provided by your Set Up manager).

Here is a sample of a complete indexing instruction to help you out (an instruction sent with POST method to the index API with the Data Feed as a parameter):

The only thing that needs to be changed is the DATAFEED_FILENAME.xml and the TOKENID for your data feed name and your provided TOKENID.

What encoding do I have to use for the Data Feed?

UTF-8 is the global encoding standard and EmpathyBroker runs on SolrCloud for whichUTF-8 is a standard.

What format can I use for a Data Feed?

Any text format works, however at EmpathyBroker we recommend the use of XML or JSON as this simplifies and optimizes the indexing process.

What is a Data Feed?

A Data Feed contains all your Site Content or Catalogue. Is the vehicle that transports your Site Data for third parties like a cloud based Search & Navigation product such as EmpathyBroker.

What is EmpathyBroker Index API?

A set of functions that give you control on how and when you index your Data Feed into your EmpathyBroker.

What kind of Data does EmpathyBroker need on a Feed?

The more the better. Is all about delivering to your users the Data they expect and presented in the way that works best. If your users demand to order results by sold units then sold units should be in the Data Feed, same for Stock, Colours, Categories, Properties, etc.

What structure do I have to use to represent multiple categories in a Data Feed?

Can you show me any front samples or customers that use EmpathyBroker Experience API?

Even though the Experience is key to a joyful and effective Findability strategy, features like dynamic ranking, real-time results equalization, boosting and linking, are essential to an excellent result. However if you are looking for cool front samples here are some!

There are three possible scenarios (Standard, Spelled Checked and Partial Results):

A) Standard: Queries that are standard just with paramter “q”

B) Spelled Cheked: Query with Spell Check where the return provides “spellchecked”: “querycorrected” (use this response to display messages such as “Did you mean?”)

C) Partial Results: When no results available for word1+word2, then returning results separately for word1 and then results for word2 just as the following sample return shows:

What does the AutoComplete Method from Experience API return?

The AutoComplete Method is used to request Links (which are called quickLinks and are to be presented in an Autocomplete) and Popular searches (called topTerms).

a) Quick Links (to be shown within in an AutoComplete)
b) Popular Searches (that are very successful)

What does the Featured Method from Experience API return?

The Featured method is used to request Links to be shown on your result page (created from EmpathyBroker Dashboard) of type:

A) Banner
B) Promoted Link
C) Direct Link

What does the Search Method from Experience API return?

The Search Method with the essence of the Experience API.

From the Search Method you can execute searches directly against your EmpathyBroker and all the indexed content provided with your Data Feeds.

What if my AutoComplete Method from Experience API does not return any Quick Links (quickLinks) and/or Popular Searches (topTerms)?

No Quick Links are returned when none have been created (Whether these are created manually or automatically).

What is EmpathyBroker Experience API?

Is the way we call the API used to query EmpathyBroker. The API with which your team can access absolutely all Search features such as sending queries, filters, spell checks, partial searches, detect entities, etc.

What is the response format of the Experience API?

JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate.

Here is an example of the JSON response from Experience API (specifically from the Featured Method):

When trying to embed EmpathyBroker Experience API into Magento with the provided JavaScripting code I get a conflict with Prototype. How can I resolve the conflict with Prototype?

Frequently the conflicts between Prototype and other Javascript frameworks are related with the use of the $ character operator. The character $ is a reserved word in Prototype.

If the conflict is between jQuery and Prototype the solution could be using the word jQuery as operator instead of $ for example jQuery(mycssclass).click(…) instead of $(mycssclass).click(…)

EmpathyBroker is the only Site Search and Navigation platform that offersresults Equalization. Search Managers and Content Managers can handle ranking themselves with the unique feature ranking equalization. Being able to create multiple rankings, compare findability-conversion and apply those that deliver best results.

Additionally EmpathyBroker handles results Boosts. Boosting lets you select which products/results will be boosted for which keywords, altering the ranking based on queries and query clusters instantly.

Yes you can, however you have to let EmpathyBroker Set Up team you know you are adding new languages. One of the key differentiators of EmpathyBroker deployments regarding multi-language and multi-bite encodings is that it handles every language independently, processing and assigning specific synonyms and hyponyms as well as given stop words (empty words) that apply to every specific language.

From EmpathyBroker dashboard you can edit and control your active languages, scopes, domains and portals.

Does EmpathyBroker handle Synonyms?

Sure it does, on any language. However the use of synonyms can turn into complex maintenance problems as it changes catalogue word correlations and persists these with the risk of language progression. To handle this, EmpathyBroker offers user driven synonyms and hyponyms.

For example, if you search “jeans jacket” it understand “jeans” as a synonym of “denim” and will return “denim jacket”.

Does EmpathyBroker learn from its users?

It does so from clicks, conversions and user driven indicators.

EmpathyBroker deployes TOPHIT, calculating the most likely result given a user or group of users and based on in-site Search Analytics.

In addition EmpathyBroker learns from user interactions on Open Social Media such as Twitter and industry leading blogs for words correlations and brand-product notorieties that are applied to result ranking.

Does EmpathyBroker understand colours or product properties like size, etc?

EmpathyBroker understands that a colour is not just another search term. Additionally, it handles colour families (ie stone trousers).

Same principle applies to product properties like sizes, formats or even brands. These can be detected at query time creating direct links to brand pages if Findability metrics dictate it so.

EmpathyBroker core is built on a unique combination of Lucene Solr Cloud and Mongo DB for language independence. References like 24Symbols.com, Mango.com, Zara.com. deliver Site Search and Information Access in over 30 languages including multi-byte character sets such as Japanese, Chinese, Russian or Arabic.

EmpathyBroker processes plurals and masculine/feminine forms on any spoken language.

How does the front Integrate?

There are 4 simple steps to call EmpathyBroker from your Front while any of the presentation elements are fully customizable.

However the no-results situation is mostly caused by large queries that contain a large average set of terms. To turn this into opportunities, EmpathyBroker applies partial matches, showing partial results when the search term is long and there is only one or very few matches. (ie “floral-print trousers” will offer “floral-print” options and other “trouser” options)

Another case occurs when the result is not indexed or is not available. On such occasions EmpathyBroker allows to add Links to external content (whether is text, audio or video) and associate these to pre-set keywords and query clusters.

We don't store any personal details however we use cookies to ensure that we give you the best experience on our website. If you continue without changing your settings, we'll assume that you are happy to receive all cookies on the EmpathyBroker, if you would like to, you can see the Privacy Policy and the cookies we use at any time.