Versions Compared

Key

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

...

  • General settings: The discovery.cfg file located in the [dspace-install-dir]/config/modules directory.
  • Browse settings: The dspace.cfg file located in [dspace-install-dir]/config/ includes "webui.browse.index.*" settings
  • User Interface Configuration: The discovery.xml file is located in [dspace-install-dir]/config/spring/api/ directory.

...

Property:

discovery.search.server

Example Value:

discovery.search.server=[http://localhost:8080/solr/search]

Informational Note:

Discovery relies on a Solr index for storage and retrieval of its information. This parameter determines the location of the Solr index.

If you are uncertain whether this property is set correctly, you can use a commandline tool like "wget" to perform a query against the Solr index (and ensure Solr responds). For example, the below query searches the Solr index for "test" and returns the response on standard out:

wget -O - http://localhost:8080/solr/search/select?q=test

Property:

discovery.index.authority.ignore[.field]

Example Value:

discovery.index.authority.ignore=true

discovery.index.authority.ignore.dc.contributor.author=false

Informational Note:

By default, Discovery will use the authority information in the metadata to disambiguate homonyms. Setting this property to false will make the indexing process the same as the metadata doesn't include authority information. The configuration can be different on a field (<schema>.<element>.<qualifier>) basis. Setting the property without a field will change the default value.

Property:

discovery.browse.authority.ignore[.browse-index]

Example Value:

discovery.browse.authority.ignore=true

discovery.browse.authority.ignore.author=false

Informational Note:Similar property to "discovery.index.authority.ignore", except specific to the "Browse By" indexes. By default, Discovery will use the authority information in the metadata to disambiguate homonyms. Setting this property to false will make the indexing process the same as the metadata doesn't include authority information. The configuration can be different on a browse index basis. Setting the property without a browse index will change the default value.
Property:

discovery.index.authority.ignore-prefered[.field]

Example Value:

discovery.index.authority.ignore-prefered=true

discovery.index.authority.ignore-prefered.dc.contributor.author=false

Informational Note:

By default, Discovery will use the authority information in the metadata to query the authority for the preferred label. Setting this property to false will make the indexing process the same as the metadata  doesn't include authority information (i.e. the preferred form is the one recorded in the metadata value). The configuration can be different on a field (<schema>.<element>.<qualifier>) basis. Setting the property without a field will change the default value. If the authority is a remote service, disabling this feature can greatly improve performance.

Property:

discovery.browse.authority.ignore-prefered[.browse-index]

Example Value:

discovery.browse.authority.ignore-prefered=true

discovery.browse.authority.ignore-prefered.author=false

Informational Note:Similar property to "discovery.index.authority.ignore-prefered", except specific to the "Browse By" indexes. By default, Discovery will use the authority information in the metadata to query the authority for the preferred label. Setting this property to false will make the indexing process the same as the metadata doesn't include authority information (i.e. the preferred form is the one recorded in the metadata value). The configuration can be different on a browse index basis. Setting the property without a browse index will change the default value. If the authority is a remote service, disabling this feature can greatly improve performance.
Property:

discovery.index.authority.ignore-variants[.field]

Example   Value:

discovery.index.authority.ignore-variants=true

discovery.index.authority.ignore-variants.dc.contributor.author=false

Informational Note:

By default, Discovery will use the authority information in the metadata to query the authority for variants. Setting this property to false will make the indexing process the same, as the metadata doesn't include authority information. The configuration can be different on a per-field (<schema>.<element>.<qualifier>) basis. Setting the property without a field will change the default value. If authority is a remote service, disabling this feature can greatly improve performance.

Property:

discovery.browse.authority.ignore-variants[.browse-index]

Example Value:

discovery.browse.authority.ignore-variants=true

discovery.browse.authority.ignore-variants.author=false

Informational Note:Similar property to "discovery.index.authority.ignore-variants", except specific to the "Browse By" indexes. By default, Discovery will use the authority information in the metadata to query the authority for variants. Setting this property to false will make the indexing process the same, as the metadata doesn't include authority information. The configuration can be different on a browse index basis. Setting the property without a browse index will change the default value. If authority is a remote service, disabling this feature can greatly improve performance.

Browse settings (config/dspace.cfg)

See the "Browse Index Configuration" section of the Configuration Reference for all "Browse By" configurations.  These Configurations control both which fields are indexed for browsing, as well as which Browse by options appear in the user interface.  Changing these configurations requires reindexing.

Modifying the Discovery User Interface (config/spring/api/discovery.xml)

The discovery.xml file is located in the [dspace]/config/spring/api directory.  Modifying these settings can change the behavior of the Search pages in the user interface, allowing you to customize the facets, filters, sort options, etc.

Structure Summary

This file is in XML format, you should be familiar with XML before editing this file. The configurations are organized together in beans, depending on the purpose these properties are used for.
This purpose can be derived from the class of the beans. Here's a short summary of classes you will encounter throughout the file and what the corresponding properties in the bean are used for.

...

Discovery is built as an application layer on top of the Solr open source enterprise search server. Therefore, Solr configuration can be applied to the Solr cores that are shipped with DSpace.
The DSpace Solr instance currently runs several cores (which means indexes in Solr parlance). The "statistics" core is for collection of DSpace usage events for statistical purposes (if you have been collecting statistics for multiple years, you may have chosen to use sharding and you will see one core per each year collected). The "search" core is used by Discovery for for search and  faceting, for displaying the collection/community hierarchy and item counts. The "authority" core is used by SolrAuthority to store information about authors, including their data imported from the ORCID registry.

...