SearchBlox

SearchBlox Developer Hub

Welcome to the SearchBlox developer hub. Here you will find comprehensive guides and documentation to help you start working with SearchBlox as quickly as possible, as well as support if you get stuck. Let's jump right in!

Documentation

Featured Results

Featured results bring sponsored-search-like functionality to SearchBlox. When specific words are searched, links are highlighted at the top of the results page. One major advantage of featured results for admins is that keywords can be directly extracted from the highlighted link, rather than having to be entered manually. In addition to text-based featured results, SearchBlox also supports graphic-based featured results similar to banner ads.

All of the functionality to create, manage and deliver featured results is accessible from within the SearchBlox Admin Console.

Please note that featured results tab in Admin console would be accessible in Chrome, Firefox, Safari and Opera browsers. Please make sure to use the following browsers when adding or viewing featured results in the console

Types of Featured Results

Featured results can be text based or graphic based. Text-based featured results only show text content in the featured result. Graphics-based featured results display images.

Creating Featured Results

Follow these steps to create featured results:

  1. Log in to the Admin Console, then click the Results tab.
  2. In the Results section, select the Featured Results tab.
  3. Input the required values in the fields displayed.
  4. Click Save to activate the featured results.

Featured results with start and end date (expiry date):

Featured results without expiry date:

Featured results with Graphic URL:

Settings in Featured Results

See below for details of each setting required to activate featured results.

Setting
Description

Type

Specifies whether the featured result has to be displayed in text or graphic format.

Title

Specifies the title to be displayed in the featured result.

Description

Specifies the description to be displayed in the featured result.

URL

URL link of the featured result.

Keyword Content

Specifies whether keywords are explicitly specified, or to be fetched from the URL.

Keywords

Keywords specified explicitly by the user for featured results display.

Keyword Match

If each word provided as keywords can be considered for featured ad display then this option has to be checked
Eg:
Keywords: test world
Search terms:
this is a test
test now
would give featured results

Phrase Match

If the terms are to be considered as a phrase match for featured ad display then this option has to checked
Eg:
Keywords: test world
Search terms:
this is test world
test world good
would give featured results
test is world
should not give featured results

Exact Match

If the exact term or phrase has to be considered for featured ad display then this option has to be checked
Eg:
Keywords: test world
Search terms:
test world
would give featured results
no other search term with test or world would give results

Keywords URL

URL of the webpage from which the keywords will be considered for featured results display.

Collections

Collections for which the results have to display can be selected by checking the check box

Use Start/End date

Yes/no radio buttons determine whether to use a start/end date or not.

Start date

Date from which the featured result has to appear in search results.

Expiry date

Date until which the featured result has to appear in the search results.

No. of times to display

Number of times the feature has to be displayed in the search results.

Priority

The order or priority in which the feature needs to be displayed among other search results.

Graphic URL

The URL of the image to be displayed in the ad.

Keywords for Featured Results Display

Keywords entered in the keywords field determine the display of featured results in the search results. Follow these instructions to enter keywords:

  • Keywords must be separated by a comma or space.
  • Keywords for featured result display can be given using one the following options
    1. Keyword Match
    2. Phrase Match
    3. Exact Match
  • Keyword match is used when any of the keyword can be considered for featured result display
    Eg:
    Keywords: test world
    Search terms:
    this is a test
    test now
    would give featured results
  • Phrase match is used when the featured result has to be displayed when the phrase is available in the search query
    Eg:
    Keywords: test world
    Search terms:
    this is test world
    test world good
    would give featured results
    test is world
    should not give featured results
  • Exact match is used when the exact term is supposed to give the featured result
    Eg:
    Keywords: test world
    Search terms:
    test world
    would give featured results
    no other search term with test or world would give results
  • If a URL is provided as a keyword URL, the keywords from that webpage will be considered for the featured results display.
  • Featured results do not support synonyms, so all of the possible keywords have to be listed in the keywords field. (For example, "email", "e-mail" and "e mail" must each be listed).
  • When using a keyword URL for a webpage, both spaces and commas are used as separators. Individual words from phrases will result in featured results. For example, if the meta keywords for a webpage are
    <meta name="keywords" content="business consulting, application development, application management/>
    featured results would appear for "business" or "consulting", etc.
  • It is best to have keywords separated by space or comma. Using a new line for each keyword can cause problems when exporting featured results.

Collection based Featured Results

Based on the collections selected in the featured results, the featured results would be displayed in search results. If collection 1 is enabled in the featured ad and if collection 1 is being searched then featured results would get displayed with right keywords.

Featured Results dashboard

The following activities can be performed while creating featured results: clear form, save, save and activate, preview result, and cancel.
Once activated, you can view the activated featured results by clicking the Featured Results tab in the Results section.

The number of featured results to be displayed in the search results can be selected using the drop down in the left-hand corner above the dashboard. The values range in multiples of 5, between 5 and 20.
Results can be previewed and deactivated from the dashboard. By clicking preview, the result will appear as follows:

Importing and Exporting Featured Results

Featured results can be imported and exported using the export and import buttons in the top right-hand corner of the dashboard. The featured results created can be exported using the export option. Bulk featured results can be uploaded and activated using the import option.

After clicking upload, the new file has to be uploaded as shown in the screenshot below:

The featured results uploaded must be in CSV format, similar to file in the link below:
searchblox_ads.csv

Viewing Featured Results in Search Results

When any of the featured results keywords are entered as a search term, the featured result appears in the results based on priority.

Featured Results in Regular Search

To view featured results in regular search, you need to select featured_results_top.xsl in Menu -> Search -> Settings

If you select the xsl while searching in regular search, the featured results appear as shown below:

Featured results in Faceted Search

Featured Results in XML or JSON results

The featured results are presented in the xml/json output in a separate section as shown below:

Sample XML output for Featured Results

<ads>
<ad no="1" collection="ads" lastmodified="1970-01-01T00:00:00.000Z" 
    title="Apply to Bradford" keywords="apply" content="apply" description=""
    url="http://bradford.ac.uk/study/how-to-apply/" 
    alpha="Apply to Bradford" col="9999" colname="ads"
    graphic_url="http://bradford.ac.uk/elementheader/university-of-bradford-logo.svg"
    uid="1507038904752"/>
</ads>

Sample JSON output for Featured Results:

  "ads": {"ad":     
          { "@no": "1", 
           "@collection": "ads",        
           "@lastmodified": "1970-01-01T00:00:00.000Z",        
           "@title": "Apply to Bradford",        
           "@keywords": "apply",        
           "@content": "apply",        
           "@description": "",        
           "@url": "http://bradford.ac.uk/study/how-to-apply/",        
           "@alpha": "Apply to Bradford",        
           "@col": "9999",        
           "@colname": "ads",        
           "@graphic_url": "http://bradford.ac.uk/elementheader/university-of-bradford-logo.svg",        
           "@uid": "1507038904752"    
          }
         },

You can display the Featured Results at the top of page of any other location based on the separation. You could also use any field, like Graphic URL, that is not used to manage the collection id, or any other custom data for display.

Featured Results