SearchBlox

SearchBlox Developer Documentation

Welcome to the SearchBlox developer documentation. Here you will find comprehensive technical 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!

Guides

Collection Dashboard

In SearchBlox, a collection is a grouping of documents indexed according to a set of rules and paths, and searches are submitted against the collection. The set of collections that are created can be viewed through the collection dashboard. The collection dashboard is accessible only by the admin.

There are several different types of collections that can be created in SearchBlox:

Creating a Collection

  • After logging in to the Admin Console, click on the Add Collection button.
  • Enter a unique Collection name for the data source.
  • Choose a Collection Type.
  • Choose the language of the content (if the language is other than English).
  • Click Add to create the collection.

Collection Dashboard Items

The Collections page displays the following headers:

  • ID (Collection ID number)
  • Name (Name of the collection with the collection type icon)
  • Status (Indexing or Ready)
  • Last Updated (Date and time the index was last updated)
  • Queries (Number of queries that each collection has processed)
  • Documents (Number of documents currently in the index)
  • Language (Language used in the indexed data)
  • Actions (Possible actions that can be performed such as index, refresh, clear, configure collection and search)

Collections Per Page

The number of collections displayed per page is 20. The value can be modfied in the file <SEARCHBLOX_INSTALLATION_PATH>/webapps/searchblox/admin.yml

collectionsPerPage: 20

The maximum number of collections allowed per page is 25. If you give value more than 25 then it would revert to default 20.
The limit has been implemented for the number of collections to avoid memory issues while reloading/refreshing collections in the admin dashboard.

Updated 3 months ago


What's Next

HTTP Collection

Collection Dashboard


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.