All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
Page History
...
The discovery.cfg file is located in the [dspace-install-dir]/config/modules directory and contains following properties:
Property: | search.server |
Example Value: |
|
Informational Note: | Discovery relies on a Solr index for storage and retrieval of its information. This parameter determines the location of the Solr index. |
| Property: | index.authority.ignore[.field] |
| Example Value: |
|
| 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, the property without field set the default value. |
| Property: | index.authority.ignore-prefered[.field] |
| Example Value: |
|
| Informational Note: | By default, Discovery will use the authority information in the metadata to query the authority for the prefered label. Setting this property to false will make the indexing process the same as the metadata doesn't include authority information (i.e. the prefered form is the one recorded in the metadata value). The configuration can be different on a field (<schema>.<element>.<qualifier>) basis, the property without field set the default value. If the authority is a remote service, disabling this feature can greatly improve performance. |
| Property: | index.authority.ignore-variants[.field] |
| Example Value: |
|
| 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, the property without field set the default value. If authority is a remote service, disabling this feature can greatly improve performance. |
Modifying the Discovery User Interface (config/spring/api/discovery.xml)
...
Download the configuration file and review it together with the following parameters
Class: | DiscoveryConfigurationService |
Purpose: | Defines the mapping between separate Discovery configurations and individual collections/communities |
Default: | All communities, collections and the homepage (key=default) are mapped to defaultConfiguration, also controls the metadata fields that should not be indexed in the search core (item provenance for example). |
Class: | DiscoveryConfiguration |
Purpose: | Groups configurations for sidebar facets, search filters, search sort options and recent submissions |
Default: | There is one configuration by default called defaultConfiguration |
Class: | DiscoverySearchFilter |
Purpose: | Defines that specific metadata fields should be enabled as a search filter |
Default: | dc.title, dc.contributor.author, dc.creator, dc.subject.* and dc.date.issued are defined as search filters |
Class: | DiscoverySearchFilterFacet |
Purpose: | Defines which metadata fields should be offered as a contextual sidebar browse options, each of these facets has also got to be a search filter |
Default: | dc.contributor.author, dc.creator, dc.subject.* and dc.date.issued |
Class: | HierarchicalSidebarFacetConfiguration |
Purpose: | Defines which metadata fields contain hierarchical data and should be offered as a contextual sidebar option |
Class: | DiscoverySortConfiguration |
Purpose: | Further specifies the sort options to which a DiscoveryConfiguration refers |
Default: | dc.title and dc.date.issued are defined as alternatives for sorting, other than Relevance (hard-coded) |
Class: | DiscoveryHitHighlightingConfiguration |
Purpose: | Defines which metadata fields can contain hit highlighting & search snippets |
Default: | dc.title, dc.contributor.author, dc.subject, dc.description.abstract & full text from text files. |
Class: | TagCloudFacetConfiguration |
| Purpose: | Defines the tag cloud appearance configuration bean and the search filter facets to appear in the tag cloud form. You can have different "TagCloudFacetConfiguration" per community or collection or the home page |
Default settings
In addition to the summarized descriptions of the default values, following details help you to better understand these defaults. If you haven't already done so, download the configuration file and review it together with the following parameters.
The file contains one default configuration that defines following sidebar facets, search filters, sort fields and recent submissions display:
...
This paragraph only applies to JSPUI
| Code Block | ||
|---|---|---|
| ||
<!-- Set TagCloud configuration per discovery configuration --> <property name="tagCloudFacetConfiguration" ref="defaultTagCloudFacetConfiguration"/> |
...
Declare the bean (of class: TagCloudFacetConfiguration) that holds the configuration for the tag cloud facet.
| Code Block | ||
|---|---|---|
| ||
<!--TagCloud configuration bean for homepage discovery configuration-->
<bean id="homepageTagCloudFacetConfiguration" class="org.dspace.discovery.configuration.TagCloudFacetConfiguration">
<!-- Actual configuration of the tagcloud (colors, sorting, etc.) -->
<property name="tagCloudConfiguration" ref="tagCloudConfiguration"/>
<!-- List of tagclouds to appear, one for every search filter, one after the other -->
<property name="tagCloudFacets">
<list>
<ref bean="searchFilterSubject" />
</list>
</property>
</bean>
|
...
When tagCloud is rendered there are some CSS classes that you can change in order to change the appearance of the tag cloud.
Class | Note |
|---|---|
| tagcloud | General class for the whole tagcloud |
| tagcloud_1 | Specific tag class for tag of type 1 (based on score) |
| tagcloud_2 | Specific tag class for tag of type 2 (based on score) |
| tagcloud_3 | Specific tag class for tag of type 3 (based on score) |
Discovery Solr Index Maintenance
Command used: |
|
| |
Java class: | org.dspace.discovery.IndexClient |
Arguments (short and long forms): | Description |
called without any options, will update/clean an existing index | |
| (re)build index, wiping out current one if it exists |
| clean existing index removing any documents that no longer exist in the db |
| if updating existing index, force each handle to be reindexed even if up to date |
-h | print this help message |
|
| add or update an Item, Collection or Community in index based on its handle. |
|
| remove an Item, Collection or Community from index based on its handle |
| -s |
| rebuild the spellchecker, can be combined with -b and -f. |
Routine Discovery Solr Index Maintenance
...
Advanced search related keys (change "author" to desired field)
| Filter name | xmlui.ArtifactBrowser.SimpleSearch.filter.author |
| Facet heading | xmlui.ArtifactBrowser.AdvancedSearch.type_author |
| "Filter by" page heading | xmlui.Discovery.AbstractSearch.type_author |
Overview
Content Tools