forum
login
home HOME

Extension Library

Here, we will explain the extension features provided by KandaSearch.

Page Sections

What are Extensions?

The extension features of KandaSearch refer to plugins, sample data, configuration files for the search engine Apache Solr, and other materials aimed at extending and enhancing the functionality of Apache Solr.
The Extension Library is the place where you can find a list of all available extension features.
To utilize an extension feature, you add it to your project from the library. Management tasks such as listing, downloading, and deleting are performed on a project-by-project basis.

Types of Extensions

The types of extensions available in KandaSearch are as follows:

  • DATA: Sample data for search
  • SOLR COLLECTION CONFIG: Apache Solr configuration files corresponding to the sample data
  • SOLR DICTIONARY: Dictionary files
  • SOLR PLUGIN: Plugins for Apache Solr (JAR files)
  • SOLR MODEL: Model files
  • MISC: Miscellaneous (e.g., seminar slides)

How to Find Extensions

There are two types of Extension Libraries: the 'KandaSearch website Extension Library', accessible while not logged into KandaSearch, and the Extension Library within the KandaSearch Management Console, which is available when logged in.

KandaSearch website Extension Library

  1. Access the KandaSearch website and click on the three horizontal lines icon in the top left corner.
  2. Click on 'Extensions'.

Extension Library within the KandaSearch Management Console

  1. Access the KandaSearch Management Console and log in.
  2. Click on the jigsaw puzzle icon at the top of the screen.

Filtering and Sorting

The initial display of the Extension Library shows all extensions sorted by popularity.
On this screen, you can filter by extension type and sort by popularity or newest.

  • To filter by type, click on buttons like 'DATA' or 'SOLR COLLECTION CONFIG' at the top of the screen.
  • Clicking on a button with colored background will reset the corresponding filter.
  • Clicking on '× CLEAR' will clear all filters and display all extensions.
  • Clicking on 'MOST POPULAR' will display extensions in order of most downloads.
  • Clicking on 'RECENTLY UPDATED' will display extensions in order of the latest version update date.

How to Use Extensions

To use an extension, locate the desired extension from the Extension Library, add it to your project, and then download it.

  1. Once you find the desired extension in the Extension Library, click on 'DETAILS' in the respective extension block.
  2. If you are not logged in to KandaSearch, click on 'Get this extension' and log in.
  3. If you are logged in, click on 'ADD TO PROJECT', select the destination project, and add it to the project. If you see 'No projects found,' create a project first and then proceed with step 1.
  4. Click on the KandaSearch logo in the top left corner, then click on the project name where you added the extension from the project list.
  5. Click on 'Extensions' from the left side menu.
  6. Click on 'DOWNLOAD' in the extension block you added in step 3.
  7. If multiple versions are available, a list will appear. Click on the download icon on the right side of the row corresponding to the appropriate version (usually the latest version).

The destination for the download varies depending on the type of extension, such as your local PC or the search engine instance.

For instructions on how to use the downloaded extension, refer to the detailed page displayed when you clicked on 'DETAILS' in the extension block, or check the README included with the extension (if available).

List of Registered Extensions and Deletion

You can check and delete the list of extensions registered to the project.

Review Registered Extensions

  1. Click on the KandaSearch logo in the top left corner of the screen, then click on the project name where the extension you want to delete has been added from the list of displayed projects.
  2. Click on 'Extensions' from the left side menu to display the list of registered extensions.

Delete Extensions

  1. Click on 'DELETE' in the block of the extension you want to delete.
  2. Click 'CONFIRM' in the 'Extension Deletion' dialog box.

Deleted extensions can be re-registered to the project from the Extension Library.

Notes for Use

  • Extensions may or may not depend on the version of Apache Solr, depending on their type. Please select the appropriate one for your use.
  • For information regarding the license and copyright of each extension, please refer to the detailed page of each extension.
  • Currently, customers cannot add extensions to the Extension Library themselves. If you wish to publish an extension, please contact us.

Related Topics