Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Islandora uses Solr to make objects in your Islandora installation discoverable. The Solr search module uses an xslt in Gsearch to index the FOXML documents in your repository, and allows you to configure search fields for searching and faceting. Whenever you add a new object in Fedora, the Solr module updates your index, and makes those results available to your users.

Panel
borderStylesolid
titleTo Recap:borderStylesolid
  • Solr makes digital assets in your Islandora installation discoverable. Solr helps to enable the display/searching of your digital assets' metadata.
  • To index Fedora content in Solr, Islandora currently relies on Fedora's Gsearch.
  • When going through the Islandora installation process, there is an xslt and solrschema.xml document that come packaged with GSearch that can be used out-of-the-box or customized to suit your repository's needs.
  • GSearch uses the xslt to transform a Fedora FOXML document into a Solr xml document.
  • solrchema.xml controls how Solr indexes xml files.
  • FOXML files are simple xml files that directly expresses the Fedora Digital Object Model. FOXML is similar to METS as it is basically an xml container.

...

Start by going to the ‘Islandora’ page in the admin panel and click on the ‘Solr Index’ link.

Image RemovedImage Added

2. Verify the Solr URL and Request Handler

The Solr URL should be ip.address.of.site:port/solr. So, for example, if you’re using the Islandora Virtual Machine Image or another a local installation it should be localhost:8080/solr. If the URL is correct you will see a green check mark.

Image RemovedImage Added

Make sure the request handler is set to ‘standard’. You can customize the request handler by editing solrconfig.xml to make other request handlers available. This assumes that you are using the default request handler, which will support all the metadata in our solution packs.

...

Out-of-the-box, support for RSS and CSV output is also provided. Selecting these options will place an RSS feed and CSV button next to your search results.

Image RemovedImage Added

4. Choose Search Terms in Advanced Search Block

...

Note that you will want to use fields that have been indexed as “text” in the advanced search block. 

Image RemovedImage Added

Panel
borderStylesolid
titleTypes of Indexing
borderStylesolid

You may notice when setting up your Solr instance that some fields contain qualifiers like _t, _s_mt, or _ms at the end of the field name. These indicate how the values of these fields are stored in Solr. Read APPENDIX D - SOLR SCHEMA (SEARCH) Term Reference for more information.

Image RemovedImage Added

 

You also have the option of setting permissions on a per-field basis, allowing only certain subsets of users access to search across different facets. These permissions, and the human-readable label for each Solr field, can be configured by clicking configure to open a new options window:

Image RemovedImage Added

Info

Solr field permissions are dependent on a role having Drupal permissions to search the Solr index. Roles without this permissions may appear in this list, but they will not be selectable.

...

  1. Minimum Limit - The minimum number of search results returned for a particular facet before that facet will be displayed. For instance, if the limit was set to '3' and a search for "fish" returned only two results for 'Bass', 'Bass' would not be included as a facet.
  2. Soft Limit - The number of facets to show when a search is first returned. This setting will return the most populous facets first, and include a button to expose more available facets.
  3. Maximum Limit - Similar to a Soft Limit, but without the option to expand to show more terms beyond the limit set here.

Image RemovedImage Added

Note that you will want to use terms here that have been indexed as “strings”. Read APPENDIX D - SOLR SCHEMA (SEARCH) Term Reference for more information.

...

Using the same field formatting as Advanced Search and Faceting fields, you can select fields to make available to the user to sort their search results in the Sort block.

Image RemovedImage Added

Info

The field for a relevance based sort is "score".

...

  • Limit results to specific namespaces- restrict your search results to a particular namespace. This is useful if there are multiple sites using the same repository and you want to block search results from the other sites. Remember that the namespace is the first half of the PID – everything before the colon.
  • Solr Default Query - This option allows you to specify a default query used to browse results when no explicit query has been entered. For example, if a user runs a search and then deletes their search term from the breadcrumbs, this default query will be applied in its place.
  • Solr Base Filter - You can use this option as a blanket way to filter all Solr search queries. For example, you can apply date-based or collection-based restrictions - such as removing page objects from search results by entering -RELS_EXT_hasModel_uri_ms:"info:fedora/islandora:pageCModel" in the Solr Base Filter field.

Image Added

8. Set Required Solr Fields Default

This section of the configuration panel provides required Solr fields for Islandora modules.

...

These fields must be met by the object for Solr to index the object properly. 

Warning
titleCaution

Advanced configuration, edit with caution.


Image AddedImage Removed


After setting up all of the above sections, you will have successfully configured your Solr client!

...