Page History
...
The legacy search engine (based on Apache Lucene) and legacy Browse system (based on database tables) have been removed from DSpace 6.0 or above. Instead, DSpace now only uses Discovery for all Search/Browse capabilities.
In addition, to support the new Configuration options, all of the Discovery configurations in discovery.cfg
have been prefixed with "discovery.
" (see configuration below).
DSpace 5.0
The new JSPUI-only tag cloud facet feature is disabled by default. In order to enable it, you will need to set up the corresponding processor that the PluginManager will load to actually perform the tag cloud query on the relevant pages. This is configured in the dspace.cfg configuration file using the following properties:
...
The discovery.cfg
file is located in the [dspace-install-dir]/config/modules
directory and contains following properties. Any of these properties may be overridden in your local.cfg
(see Configuration Reference):
Property: | discovery.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. 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:
| ||
Property: | discovery.index.authority.ignore[.field] | 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: | discovery.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 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 prefered preferred 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: | discovery.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. |
...
The discovery.xml
file is located in the [dspace-install-dir]/config/spring/api
directory.
...
Customizing hit highlighting & search snippets
The hit highlighting configuration element contains all settings necessary to display search snippets & enable hit highlighting.
Warning |
---|
This paragraph section only applies to XMLUI. JSPUI does not currently support "highlighting & search snippets". |
The hit highlighting configuration element contains all settings necessary to display search snippets & enable hit highlighting.
Info | ||
---|---|---|
| ||
You can disable hit highlighting / search snippets by commenting out the entire PLEASE BE AWARE there are two sections where this <property> definition exists. You should comment out both. One is under the Alternatively, you may also choose to tweak which fields are shown in hit highlighting, or modify the number of matching words shown (snippets) and/or number of characters shown around the matching word (maxSize). For this change to take effect in the User Interface, you will need to restart Tomcat. |
Notewarning |
---|
Changes made to the configuration will not automatically be displayed in the user interface. By default, only the following fields are displayed: dc.title, dc.contributor.author, dc.creator, dc.contributor, dc.date.issued, dc.publisher, dc.description.abstract and fulltext. If additional fields are required, look for the "itemSummaryList" template. |
...
Code Block | ||
---|---|---|
| ||
<property name="hitHighlightingConfiguration"> <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightingConfiguration"> <property name="metadataFields"> <list> <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration"> <property name="field" value="dc.title"/> <property name="snippets" value="5"/> </bean> <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration"> <property name="field" value="dc.contributor.author"/> <property name="snippets" value="5"/> </bean> <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration"> <property name="field" value="dc.subject"/> <property name="snippets" value="5"/> </bean> <property<bean nameclass="field" value="dc.subject"/org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration"> <property name="snippetsfield" value="5dc.description.abstract"/> </bean> <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration" <!-- Max number of characters to display around the matching word (Warning setting to 0 returns entire field) --> <property name="fieldmaxSize" value="dc.description.abstract250"/> <property name="maxSize" value="250"/<!-- Max number of snippets (matching words) to show --> <property name="snippets" value="2"/> </bean> <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration"> <!-- Displays snippets from indexed full text of document (for supported formats) --> <property name="field" value="fulltext"/"fulltext"/> <!-- Max number of characters to display around the matching word (Warning setting to 0 returns entire field) --> <property name="maxSize" value="250"/> <!-- Max number of snippets (matching words) to show --> <property name="snippets" value="2"/> </bean> </list> </property> </bean> </property> |
...
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 uptodate |
| print this help message |
-i <object handle> | Reindex an individual object (and any child objects). When run on an Item, it just reindexes that single Item. When run on a Collection, it reindexes the Collection itself and all Items in that Collection. When run on a Community, it reindexes the Community itself and all sub-Communities, contained Collections and contained Items. |
| optimize search core |
| remove an Item, Collection or Community from index based on its handle |
-s | Rebuild the spellchecker, can be combined with -b and -f. |
...