Difference between revisions of "SUNScholar/Discovery/5.X"

From Libopedia
Jump to navigation Jump to search
 
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<center>
 
<center>
−
  '''[[SUNScholar/Search_Indexes|Back to Search Indexes]]'''
+
  '''[[SUNScholar/Search_Indexes|Back to Discovery Search Indexes]]'''
 
</center>
 
</center>
  
−
==Requirements==
+
==Step 1 - Define Discovery SOLR service==
−
<font color="red">'''Before attempting SOLR discovery setup please make sure the following are correct:'''</font>
+
Edit the following file:
−
#[[SUNScholar/Prepare_Ubuntu/S05#Step_5.2.1:_Setup_.22authbind.22_for_Tomcat|Tomcat is listening on TCP port 80.]]
+
  nano $HOME/{{Source}}/dspace/config/modules/discovery.cfg
−
#[[SUNScholar/Install_DSpace/S08|The SOLR webapp is correctly published.]]
 
−
 
 
−
==Step 1 - Enable Discovery SOLR service==
 
−
Edit the the discovery service setup file.
 
−
  nano $HOME/<u>[[SUNScholar/Install_DSpace/S03#Step_3.2|source]]</u>/dspace/config/modules/discovery.cfg
 
  
 
See example below.
 
See example below.
Line 22: Line 17:
 
##### Search Indexing #####
 
##### Search Indexing #####
 
search.server = ${solr.server}/search
 
search.server = ${solr.server}/search
 +
 +
#Enable the url validation of the search.server setting above.
 +
#Defaults to true: validation is enabled
 +
#solr.url.validation.enabled = true
  
 
#Char used to ensure that the sidebar facets are case insensitive
 
#Char used to ensure that the sidebar facets are case insensitive
Line 37: Line 36:
  
 
==Step 2 - Enable Discovery in XMLUI==
 
==Step 2 - Enable Discovery in XMLUI==
−
Enable discovery by following: https://wiki.duraspace.org/display/DSDOC4x/Discovery#Discovery-EnablingDiscovery
+
Discovery should be enabled by default with DSpace 5.X, if not then enable discovery by following: https://wiki.duraspace.org/display/DSDOC5x/Discovery#Discovery-EnablingDiscovery.
  
 
==Step 3 - Discovery Configuration==
 
==Step 3 - Discovery Configuration==
−
Discovery now handles the following:
+
Edit the following file:
−
*Search sort
 
−
*Simple search
 
−
*Advanced search
 
−
*Recent submissions
 
−
*Related items
 
−
*Did you mean
 
−
 
 
−
See below for an example.
 
−
 
 
−
===Discovery Custom Config Example===
 
−
Basically you have to edit the following file:
 
 
  nano $HOME/{{Source}}/dspace/config/spring/api/discovery.xml
 
  nano $HOME/{{Source}}/dspace/config/spring/api/discovery.xml
  
 
'''<span style="color: red;">Please note: All the sidebar facets MUST be a part of the search filters list</span>'''
 
'''<span style="color: red;">Please note: All the sidebar facets MUST be a part of the search filters list</span>'''
  
−
In the customised example below, "Advisor", "Type" and "Provenance" search fields have been added and "Provenance" has been removed from ignored metadata fields.
+
''In the customised example below, "<tt>'''Advisor'''</tt>", "<tt>'''Type'''</tt>" and "<tt>'''Provenance'''</tt>" search fields have been added and "Provenance" has been removed from ignored metadata fields.''
 
<pre>
 
<pre>
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
Line 161: Line 149:
 
             </list>
 
             </list>
 
         </property>
 
         </property>
 +
        <!-- Set TagCloud configuration per discovery configuration -->
 +
        <property name="tagCloudFacetConfiguration" ref="defaultTagCloudFacetConfiguration"/>
 
         <!--The search filters which can be used on the discovery search page-->
 
         <!--The search filters which can be used on the discovery search page-->
 
         <property name="searchFilters">
 
         <property name="searchFilters">
Line 199: Line 189:
 
                 <property name="metadataSortField" value="dc.date.accessioned" />
 
                 <property name="metadataSortField" value="dc.date.accessioned" />
 
                 <property name="type" value="date"/>
 
                 <property name="type" value="date"/>
−
                 <property name="max" value="20"/>
+
                 <property name="max" value="30"/>
 
                 <!-- If enabled the collection home page will not display metadata but show a pageable list of recent submissions -->
 
                 <!-- If enabled the collection home page will not display metadata but show a pageable list of recent submissions -->
 
                 <property name="useAsHomePage" value="false"/>
 
                 <property name="useAsHomePage" value="false"/>
Line 205: Line 195:
 
         </property>
 
         </property>
 
         <!--Default result per page  -->
 
         <!--Default result per page  -->
−
         <property name="defaultRpp" value="40" />
+
         <property name="defaultRpp" value="30" />
 
         <property name="hitHighlightingConfiguration">
 
         <property name="hitHighlightingConfiguration">
 
             <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightingConfiguration">
 
             <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightingConfiguration">
Line 212: Line 202:
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                             <property name="field" value="dc.title"/>
 
                             <property name="field" value="dc.title"/>
−
                             <property name="snippets" value="10"/>
+
                             <property name="snippets" value="20"/>
 
                         </bean>
 
                         </bean>
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                             <property name="field" value="dc.contributor.author"/>
 
                             <property name="field" value="dc.contributor.author"/>
−
                             <property name="snippets" value="10"/>
+
                             <property name="snippets" value="20"/>
 
                         </bean>
 
                         </bean>
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                             <property name="field" value="dc.contributor.advisor"/>
 
                             <property name="field" value="dc.contributor.advisor"/>
−
                             <property name="snippets" value="10"/>
+
                             <property name="snippets" value="20"/>
 
                         </bean>
 
                         </bean>
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                             <property name="field" value="dc.description.abstract"/>
 
                             <property name="field" value="dc.description.abstract"/>
 
                             <property name="maxSize" value="250"/>
 
                             <property name="maxSize" value="250"/>
−
                             <property name="snippets" value="5"/>
+
                             <property name="snippets" value="10"/>
 
                         </bean>
 
                         </bean>
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                             <property name="field" value="fulltext"/>
 
                             <property name="field" value="fulltext"/>
 
                             <property name="maxSize" value="250"/>
 
                             <property name="maxSize" value="250"/>
−
                             <property name="snippets" value="5"/>
+
                             <property name="snippets" value="10"/>
 
                         </bean>
 
                         </bean>
 
                     </list>
 
                     </list>
Line 244: Line 234:
 
                         <value>dc.title</value>
 
                         <value>dc.title</value>
 
                         <value>dc.contributor.author</value>
 
                         <value>dc.contributor.author</value>
−
            <value>dc.contributor.advisor</value>
+
                <value>dc.contributor.advisor</value>
 
                         <value>dc.creator</value>
 
                         <value>dc.creator</value>
 
                         <value>dc.subject</value>
 
                         <value>dc.subject</value>
Line 250: Line 240:
 
                 </property>
 
                 </property>
 
                 <!--The minimum number of matching terms across the metadata fields above before an item is found as related -->
 
                 <!--The minimum number of matching terms across the metadata fields above before an item is found as related -->
−
                 <property name="minTermFrequency" value="3"/>
+
                 <property name="minTermFrequency" value="5"/>
 
                 <!--The maximum number of related items displayed-->
 
                 <!--The maximum number of related items displayed-->
−
                 <property name="max" value="10"/>
+
                 <property name="max" value="20"/>
 
                 <!--The minimum word length below which words will be ignored-->
 
                 <!--The minimum word length below which words will be ignored-->
 
                 <property name="minWordLength" value="5"/>
 
                 <property name="minWordLength" value="5"/>
Line 273: Line 263:
 
             </list>
 
             </list>
 
         </property>
 
         </property>
 +
        <!-- Set TagCloud configuration per discovery configuration -->
 +
        <property name="tagCloudFacetConfiguration" ref="homepageTagCloudFacetConfiguration"/>
 
         <!--The search filters which can be used on the discovery search page (same as defaultConfiguration above)-->
 
         <!--The search filters which can be used on the discovery search page (same as defaultConfiguration above)-->
 
         <property name="searchFilters">
 
         <property name="searchFilters">
Line 304: Line 296:
 
                 <property name="metadataSortField" value="dc.date.accessioned" />
 
                 <property name="metadataSortField" value="dc.date.accessioned" />
 
                 <property name="type" value="date"/>
 
                 <property name="type" value="date"/>
−
                 <property name="max" value="20"/>
+
                 <property name="max" value="30"/>
 
                 <property name="useAsHomePage" value="false"/>
 
                 <property name="useAsHomePage" value="false"/>
 
             </bean>
 
             </bean>
Line 314: Line 306:
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                             <property name="field" value="dc.title"/>
 
                             <property name="field" value="dc.title"/>
−
                             <property name="snippets" value="10"/>
+
                             <property name="snippets" value="20"/>
 
                         </bean>
 
                         </bean>
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                             <property name="field" value="dc.contributor.author"/>
 
                             <property name="field" value="dc.contributor.author"/>
−
                             <property name="snippets" value="10"/>
+
                             <property name="snippets" value="20"/>
 
                         </bean>
 
                         </bean>
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                             <property name="field" value="dc.description.abstract"/>
 
                             <property name="field" value="dc.description.abstract"/>
 
                             <property name="maxSize" value="250"/>
 
                             <property name="maxSize" value="250"/>
−
                             <property name="snippets" value="10"/>
+
                             <property name="snippets" value="20"/>
 
                         </bean>
 
                         </bean>
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                         <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
 
                             <property name="field" value="fulltext"/>
 
                             <property name="field" value="fulltext"/>
 
                             <property name="maxSize" value="250"/>
 
                             <property name="maxSize" value="250"/>
−
                             <property name="snippets" value="10"/>
+
                             <property name="snippets" value="20"/>
 
                         </bean>
 
                         </bean>
 
                     </list>
 
                     </list>
Line 338: Line 330:
 
     </bean>
 
     </bean>
  
 +
    <!--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>
 +
   
 +
    <!--TagCloud configuration bean for default discovery configuration-->
 +
    <bean id="defaultTagCloudFacetConfiguration" 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>
 +
   
 +
    <bean id="tagCloudConfiguration" class="org.dspace.discovery.configuration.TagCloudConfiguration">
 +
<!-- Should display the score of each tag next to it? Default: false -->
 +
<!-- <property name="displayScore" value="true"/> -->
 +
 +
<!-- Should display the tag as center aligned in the page or left aligned? Possible values: true | false. Default: true  -->
 +
<!-- <property name="shouldCenter" value="true"/> -->
 +
 +
<!-- How many tags will be shown. Value -1 means all of them. Default: -1 -->
 +
<!--<property name="totalTags" value="-1"/> -->
 +
 +
<!-- The letter case of the tags.
 +
Possible values: Case.LOWER | Case.UPPER | Case.CAPITALIZATION | Case.PRESERVE_CASE | Case.CASE_SENSITIVE
 +
Default: Case.PRESERVE_CASE -->
 +
<!--<property name="cloudCase" value="Case.PRESERVE_CASE"/> -->
 +
 +
<!-- If the 3 colors of the tag cloud should be independent of score (random=yes) or based on the score. Possible values: true | false . Default: true-->
 +
<!-- <property name="randomColors" value="true"/> -->
 +
 +
<!-- The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 1.1 -->
 +
<!-- <property name="fontFrom" value="1.1"/>-->
 +
 +
<!-- The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 3.2 -->
 +
<!-- <property name="fontTo" value="3.2"/>-->
 +
 +
<!-- The score that tags with lower than that will not appear in the rag cloud. Possible values: any integer from 1 to infinity. Default: 0 -->
 +
<!-- <property name="cuttingLevel" value="0"/>-->
 +
 +
<!-- The ordering of the tags (based either on the name or the score of the tag)
 +
Possible values: Tag.NameComparatorAsc | Tag.NameComparatorDesc | Tag.ScoreComparatorAsc | Tag.ScoreComparatorDesc
 +
Default: Tag.NameComparatorAsc  -->
 +
<!-- <property name="ordering" value="Tag.NameComparatorAsc"/>-->
 +
    </bean>
 +
   
 +
    <!-- The tag cloud parameters for the tag clouds that appear in the browse pages -->
 +
    <bean id="browseTagCloudConfiguration" class="org.dspace.discovery.configuration.TagCloudConfiguration">
 +
<!-- Should display the score of each tag next to it? Default: false -->
 +
<!-- <property name="displayScore" value="true"/> -->
 +
 +
<!-- Should display the tag as center aligned in the page or left aligned? Possible values: true | false. Default: true  -->
 +
<!-- <property name="shouldCenter" value="true"/> -->
 +
 +
<!-- How many tags will be shown. Value -1 means all of them. Default: -1 -->
 +
<!--<property name="totalTags" value="-1"/> -->
 +
 +
<!-- The letter case of the tags.
 +
Possible values: Case.LOWER | Case.UPPER | Case.CAPITALIZATION | Case.PRESERVE_CASE | Case.CASE_SENSITIVE
 +
Default: Case.PRESERVE_CASE -->
 +
<!--<property name="cloudCase" value="Case.PRESERVE_CASE"/> -->
 +
 +
<!-- If the 3 colors of the tag cloud should be independent of score (random=yes) or based on the score. Possible values: true | false . Default: true-->
 +
<!-- <property name="randomColors" value="true"/> -->
 +
 +
<!-- The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 1.1 -->
 +
<!-- <property name="fontFrom" value="1.1"/>-->
 +
 +
<!-- The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 3.2 -->
 +
<!-- <property name="fontTo" value="3.2"/>-->
 +
 +
<!-- The tags with score lower than this will not appear in the tag cloud. Possible values: any integer from 1 to infinity. Default: 0 -->
 +
<!-- <property name="cuttingLevel" value="0"/>-->
 +
 +
<!-- The ordering of the tags (based either on the name or the score of the tag)
 +
Possible values: Tag.NameComparatorAsc | Tag.NameComparatorDesc | Tag.ScoreComparatorAsc | Tag.ScoreComparatorDesc
 +
Default: Tag.NameComparatorAsc  -->
 +
<!-- <property name="ordering" value="Tag.NameComparatorAsc"/>-->
 +
    </bean>
 +
   
 
     <!--Search filter configuration beans-->
 
     <!--Search filter configuration beans-->
 
     <bean id="searchFilterTitle" class="org.dspace.discovery.configuration.DiscoverySearchFilter">
 
     <bean id="searchFilterTitle" class="org.dspace.discovery.configuration.DiscoverySearchFilter">
Line 426: Line 509:
  
 
==Step 4 - Update localised messages.xml file==
 
==Step 4 - Update localised messages.xml file==
−
It may be required to update the ''messages.xml'' file with any new indexes defined. See example below.
+
Because we introduced new discovery indexes above, we need to update the language file to present human readable messages for these new indexes.
  
−
Add the following to the bottom of the file. '''Also see: [[SUNScholar/Theme/Language|Language modification]]'''
+
Edit the following file:
 +
nano $HOME/{{Source}}/dspace-xmlui/src/main/webapp/i18n/messages.xml
 +
 
 +
Add the following to the bottom of the file before the closing <tt>'''</catalogue>'''</tt> tag.
 
{{MESSAGES}}
 
{{MESSAGES}}
  
−
==[[SUNScholar/Rebuild_DSpace|Step 5 - Rebuild Webapps]]==
+
'''Also see: [[SUNScholar/Theme/Language|Language modification]]'''
−
Click on the heading above.
+
 
 +
==[[SUNScholar/Rebuild_DSpace|Step 5 - Rebuild DSpace]]==
  
 
==[[SUNScholar/Indexes/Rebuild|Step 6 - Rebuild Indexes]]==
 
==[[SUNScholar/Indexes/Rebuild|Step 6 - Rebuild Indexes]]==
−
Click on the heading above.
 
−
 
 
'''<font color="red">Remember:</font>''' Clear the XMLUI cache when logged in as an administrator, after rebuilding the discovery indexes..
 
'''<font color="red">Remember:</font>''' Clear the XMLUI cache when logged in as an administrator, after rebuilding the discovery indexes..
  
 
==[[SUNScholar/Daily_Admin|Step 7 - Do regular index maintenance]]==
 
==[[SUNScholar/Daily_Admin|Step 7 - Do regular index maintenance]]==
−
Click on the heading above.
+
[[Category:Customisation]]
−
 
 
−
==References==
 
−
*https://wiki.duraspace.org/display/DSDOC5x/Discovery
 
−
*https://wiki.duraspace.org/display/DSDOC5x/Discovery#Discovery-StructureSummary
 
−
*https://wiki.duraspace.org/display/DSDOC5x/Discovery#Discovery-DSpace4.0
 
−
*https://wiki.duraspace.org/display/DSDOC5x/Legacy+methods+for+re-indexing+content
 
−
*https://github.com/DSpace/DSpace/blob/master/dspace-xmlui/src/main/webapp/themes/dri2xhtml-alt/aspect/artifactbrowser/discovery.xsl
 

Latest revision as of 15:45, 29 May 2016

Back to Discovery Search Indexes

Step 1 - Define Discovery SOLR service

Edit the following file: 

nano $HOME/source/dspace/config/modules/discovery.cfg

See example below. 

#---------------------------------------------------------------#
#-----------------DISCOVERY CONFIGURATIONS----------------------#
#---------------------------------------------------------------#
# Configuration properties used solely by the Discovery         #
# faceted-search system.                                        #
#---------------------------------------------------------------#
##### Search Indexing #####
search.server = ${solr.server}/search

#Enable the url validation of the search.server setting above.
#Defaults to true: validation is enabled
#solr.url.validation.enabled = true

#Char used to ensure that the sidebar facets are case insensitive
#solr.facets.split.char=\n|||\n

# index.ignore-variants = false
# index.ignore-authority = false
index.projection=dc.title,dc.contributor.*,dc.date.issued

# ONLY-FOR-JSPUI: 
# 1) you need to set the DiscoverySearchRequestProcessor in the dspace.cfg 
# 2) to show facet on Site/Community/etc. you need to add a Site/Community/Collection
#	 Processors plugin in the dspace.cfg

Step 2 - Enable Discovery in XMLUI

Discovery should be enabled by default with DSpace 5.X, if not then enable discovery by following: https://wiki.duraspace.org/display/DSDOC5x/Discovery#Discovery-EnablingDiscovery.

Step 3 - Discovery Configuration

Edit the following file: 

nano $HOME/source/dspace/config/spring/api/discovery.xml

Please note: All the sidebar facets MUST be a part of the search filters list

In the customised example below, "Advisor", "Type" and "Provenance" search fields have been added and "Provenance" has been removed from ignored metadata fields. 

<?xml version="1.0" encoding="UTF-8"?>
<!--

    The contents of this file are subject to the license and copyright
    detailed in the LICENSE and NOTICE files at the root of the source
    tree and available online at

    http://www.dspace.org/license/

-->
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:util="http://www.springframework.org/schema/util"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
           http://www.springframework.org/schema/context
           http://www.springframework.org/schema/context/spring-context-3.0.xsd
           http://www.springframework.org/schema/util
           http://www.springframework.org/schema/util/spring-util-3.0.xsd"
    default-autowire-candidates="*Service,*DAO,javax.sql.DataSource">

    <context:annotation-config /> <!-- allows us to use spring annotations in beans -->

    <bean id="solrServiceResourceIndexPlugin" class="org.dspace.discovery.SolrServiceResourceRestrictionPlugin" scope="prototype"/>
    <bean id="SolrServiceSpellIndexingPlugin" class="org.dspace.discovery.SolrServiceSpellIndexingPlugin" scope="prototype"/>

    <alias name="solrServiceResourceIndexPlugin" alias="org.dspace.discovery.SolrServiceResourceRestrictionPlugin"/>

    <!-- Additional indexing plugin to implement the browse system via SOLR -->
    <bean id="solrBrowseIndexer" scope="prototype"
          class="org.dspace.browse.SolrBrowseCreateDAO">
    </bean>

    <!--Bean that is used for mapping communities/collections to certain discovery configurations.-->
    <bean id="org.dspace.discovery.configuration.DiscoveryConfigurationService" class="org.dspace.discovery.configuration.DiscoveryConfigurationService">
        <property name="map">
            <map>
                <!--The map containing all the settings,
                    the key is used to refer to the page (the "site" or a community/collection handle)
                    the value-ref is a reference to an identifier of the DiscoveryConfiguration format
                    -->
                <!--The default entry, DO NOT REMOVE the system requires this-->
               <entry key="default" value-ref="defaultConfiguration" />

               <!--Use site to override the default configuration for the home page & default discovery page-->
               <entry key="site" value-ref="homepageConfiguration" />
               <!--<entry key="123456789/7621" value-ref="defaultConfiguration"/>-->
            </map>
        </property>
        <property name="toIgnoreMetadataFields">
            <map>
                <entry>
                    <key><util:constant static-field="org.dspace.core.Constants.COMMUNITY"/></key>
                    <list>
                        <!--Introduction text-->
                        <!--<value>dc.description</value>-->
                        <!--Short description-->
                        <!--<value>dc.description.abstract</value>-->
                        <!--News-->
                        <!--<value>dc.description.tableofcontents</value>-->
                        <!--Copyright text-->
                        <value>dc.rights</value>
                        <!--Community name-->
                        <!--<value>dc.title</value>-->
                    </list>
                </entry>
                <entry>
                    <key><util:constant static-field="org.dspace.core.Constants.COLLECTION"/></key>
                    <list>
                        <!--Introduction text-->
                        <!--<value>dc.description</value>-->
                        <!--Short description-->
                        <!--<value>dc.description.abstract</value>-->
                        <!--News-->
                        <!--<value>dc.description.tableofcontents</value>-->
                        <!--Copyright text-->
                        <value>dc.rights</value>
                        <!--Collection name-->
                        <!--<value>dc.title</value>-->
                    </list>
                </entry>
                <entry>
                    <key><util:constant static-field="org.dspace.core.Constants.ITEM"/></key>
                    <list>
                        <!-- <value>dc.description.provenance</value> -->
                    </list>
                </entry>
            </map>
        </property>
    </bean>

    <!--The default configuration settings for discovery-->
    <bean id="defaultConfiguration" class="org.dspace.discovery.configuration.DiscoveryConfiguration" scope="prototype">
        <!--Which sidebar facets are to be displayed-->
        <property name="sidebarFacets">
            <list>
                <ref bean="searchFilterAdvisor" />
                <ref bean="searchFilterAuthor" />
                <ref bean="searchFilterSubject" />
                <ref bean="searchFilterIssued" />
            </list>
        </property>
        <!-- Set TagCloud configuration per discovery configuration -->
        <property name="tagCloudFacetConfiguration" ref="defaultTagCloudFacetConfiguration"/>
        <!--The search filters which can be used on the discovery search page-->
        <property name="searchFilters">
            <list>
                <ref bean="searchFilterTitle" />
                <ref bean="searchFilterAdvisor" />
                <ref bean="searchFilterAuthor" />
                <ref bean="searchFilterSubject" />
                <ref bean="searchFilterIssued" />
                <ref bean="searchFilterType" />
                <ref bean="searchFilterProvenance" />
            </list>
        </property>
        <!--The sort filters for the discovery search-->
        <property name="searchSortConfiguration">
            <bean class="org.dspace.discovery.configuration.DiscoverySortConfiguration">
                <!--<property name="defaultSort" ref="sortDateIssued"/>-->
                <!--DefaultSortOrder can either be desc or asc (desc is default)-->
                <property name="defaultSortOrder" value="desc"/>
                <property name="sortFields">
                    <list>
                        <ref bean="sortTitle" />
                        <ref bean="sortDateIssued" />
                    </list>
                </property>
            </bean>
        </property>
        <!--Any default filter queries, these filter queries will be used for all queries done by discovery for this configuration-->
        <!--<property name="defaultFilterQueries">-->
            <!--<list>-->
                <!--Only find items-->
                <!--<value>search.resourcetype:2</value>-->
            <!--</list>-->
        <!--</property>-->
        <!--The configuration for the recent submissions-->
        <property name="recentSubmissionConfiguration">
            <bean class="org.dspace.discovery.configuration.DiscoveryRecentSubmissionsConfiguration">
                <property name="metadataSortField" value="dc.date.accessioned" />
                <property name="type" value="date"/>
                <property name="max" value="30"/>
                <!-- If enabled the collection home page will not display metadata but show a pageable list of recent submissions -->
                <property name="useAsHomePage" value="false"/>
            </bean>
        </property>
        <!--Default result per page  -->
        <property name="defaultRpp" value="30" />
        <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="20"/>
                        </bean>
                        <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
                            <property name="field" value="dc.contributor.author"/>
                            <property name="snippets" value="20"/>
                        </bean>
                        <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
                            <property name="field" value="dc.contributor.advisor"/>
                            <property name="snippets" value="20"/>
                        </bean>
                        <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
                            <property name="field" value="dc.description.abstract"/>
                            <property name="maxSize" value="250"/>
                            <property name="snippets" value="10"/>
                        </bean>
                        <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
                            <property name="field" value="fulltext"/>
                            <property name="maxSize" value="250"/>
                            <property name="snippets" value="10"/>
                        </bean>
                    </list>
                </property>
            </bean>
        </property>
        <property name="moreLikeThisConfiguration">
            <bean class="org.dspace.discovery.configuration.DiscoveryMoreLikeThisConfiguration">
                <!--When altering this list also alter the "xmlui.Discovery.RelatedItems.help" key as it describes
                the metadata fields below-->
                <property name="similarityMetadataFields">
                    <list>
                        <value>dc.title</value>
                        <value>dc.contributor.author</value>
        	    	    <value>dc.contributor.advisor</value>
                        <value>dc.creator</value>
                        <value>dc.subject</value>
                    </list>
                </property>
                <!--The minimum number of matching terms across the metadata fields above before an item is found as related -->
                <property name="minTermFrequency" value="5"/>
                <!--The maximum number of related items displayed-->
                <property name="max" value="20"/>
                <!--The minimum word length below which words will be ignored-->
                <property name="minWordLength" value="5"/>
            </bean>
        </property>
        <!-- When true a "did you mean" example will be displayed, value can be true or false -->
        <property name="spellCheckEnabled" value="true"/>
    </bean>


    <!--The Homepage specific configuration settings for discovery-->
    <bean id="homepageConfiguration" class="org.dspace.discovery.configuration.DiscoveryConfiguration" scope="prototype">
        <!--Which sidebar facets are to be displayed (same as defaultConfiguration above)-->
        <property name="sidebarFacets">
            <list>
                <ref bean="searchFilterAdvisor" />
                <ref bean="searchFilterAuthor" />
                <ref bean="searchFilterSubject" />
                <ref bean="searchFilterIssued" />
            </list>
        </property>
        <!-- Set TagCloud configuration per discovery configuration -->
        <property name="tagCloudFacetConfiguration" ref="homepageTagCloudFacetConfiguration"/>
        <!--The search filters which can be used on the discovery search page (same as defaultConfiguration above)-->
        <property name="searchFilters">
            <list>
                <ref bean="searchFilterTitle" />
                <ref bean="searchFilterAdvisor" />
                <ref bean="searchFilterAuthor" />
                <ref bean="searchFilterSubject" />
                <ref bean="searchFilterIssued" />
                <ref bean="searchFilterType" />
                <ref bean="searchFilterProvenance" />
            </list>
        </property>
        <!--The sort filters for the discovery search (same as defaultConfiguration above)-->
        <property name="searchSortConfiguration">
            <bean class="org.dspace.discovery.configuration.DiscoverySortConfiguration">
                <!--<property name="defaultSort" ref="sortDateIssued"/>-->
                <!--DefaultSortOrder can either be desc or asc (desc is default)-->
                <property name="defaultSortOrder" value="desc"/>
                <property name="sortFields">
                    <list>
                        <ref bean="sortTitle" />
                        <ref bean="sortDateIssued" />
                    </list>
                </property>
            </bean>
        </property>
        <!-- Limit recent submissions on homepage to only 5 (default is 20) -->
        <property name="recentSubmissionConfiguration">
            <bean class="org.dspace.discovery.configuration.DiscoveryRecentSubmissionsConfiguration">
                <property name="metadataSortField" value="dc.date.accessioned" />
                <property name="type" value="date"/>
                <property name="max" value="30"/>
                <property name="useAsHomePage" value="false"/>
            </bean>
        </property>
        <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="20"/>
                        </bean>
                        <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
                            <property name="field" value="dc.contributor.author"/>
                            <property name="snippets" value="20"/>
                        </bean>
                        <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
                            <property name="field" value="dc.description.abstract"/>
                            <property name="maxSize" value="250"/>
                            <property name="snippets" value="20"/>
                        </bean>
                        <bean class="org.dspace.discovery.configuration.DiscoveryHitHighlightFieldConfiguration">
                            <property name="field" value="fulltext"/>
                            <property name="maxSize" value="250"/>
                            <property name="snippets" value="20"/>
                        </bean>
                    </list>
                </property>
            </bean>
        </property>
        <!-- When true a "did you mean" example will be displayed, value can be true or false -->
        <property name="spellCheckEnabled" value="true"/>
    </bean>

    <!--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>
    
     <!--TagCloud configuration bean for default discovery configuration-->
    <bean id="defaultTagCloudFacetConfiguration" 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>
    
    <bean id="tagCloudConfiguration" class="org.dspace.discovery.configuration.TagCloudConfiguration">
		<!-- Should display the score of each tag next to it? Default: false -->
		<!-- <property name="displayScore" value="true"/> -->
		
		<!-- Should display the tag as center aligned in the page or left aligned? Possible values: true | false. Default: true  -->
		<!-- <property name="shouldCenter" value="true"/> -->
		
		<!-- How many tags will be shown. Value -1 means all of them. Default: -1 -->
		<!--<property name="totalTags" value="-1"/> -->
		
		<!-- The letter case of the tags. 
			 Possible values: Case.LOWER | Case.UPPER | Case.CAPITALIZATION | Case.PRESERVE_CASE | Case.CASE_SENSITIVE
			 Default: Case.PRESERVE_CASE -->
		<!--<property name="cloudCase" value="Case.PRESERVE_CASE"/> -->
		
		<!-- If the 3 colors of the tag cloud should be independent of score (random=yes) or based on the score. Possible values: true | false . Default: true-->
		<!-- <property name="randomColors" value="true"/> -->

		<!-- The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 1.1 -->
		<!-- <property name="fontFrom" value="1.1"/>-->
		
		<!-- The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 3.2 -->
		<!-- <property name="fontTo" value="3.2"/>-->
		
		<!-- The score that tags with lower than that will not appear in the rag cloud. Possible values: any integer from 1 to infinity. Default: 0 -->
		<!-- <property name="cuttingLevel" value="0"/>-->

		<!-- The ordering of the tags (based either on the name or the score of the tag)
			 Possible values: Tag.NameComparatorAsc | Tag.NameComparatorDesc | Tag.ScoreComparatorAsc | Tag.ScoreComparatorDesc
			 Default: Tag.NameComparatorAsc  -->
		<!-- <property name="ordering" value="Tag.NameComparatorAsc"/>-->	
    </bean>
    
    <!-- The tag cloud parameters for the tag clouds that appear in the browse pages -->
    <bean id="browseTagCloudConfiguration" class="org.dspace.discovery.configuration.TagCloudConfiguration">
		<!-- Should display the score of each tag next to it? Default: false -->
		<!-- <property name="displayScore" value="true"/> -->
		
		<!-- Should display the tag as center aligned in the page or left aligned? Possible values: true | false. Default: true  -->
		<!-- <property name="shouldCenter" value="true"/> -->
		
		<!-- How many tags will be shown. Value -1 means all of them. Default: -1 -->
		<!--<property name="totalTags" value="-1"/> -->
		
		<!-- The letter case of the tags. 
			 Possible values: Case.LOWER | Case.UPPER | Case.CAPITALIZATION | Case.PRESERVE_CASE | Case.CASE_SENSITIVE
			 Default: Case.PRESERVE_CASE -->
		<!--<property name="cloudCase" value="Case.PRESERVE_CASE"/> -->
		
		<!-- If the 3 colors of the tag cloud should be independent of score (random=yes) or based on the score. Possible values: true | false . Default: true-->
		<!-- <property name="randomColors" value="true"/> -->

		<!-- The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 1.1 -->
		<!-- <property name="fontFrom" value="1.1"/>-->
		
		<!-- The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 3.2 -->
		<!-- <property name="fontTo" value="3.2"/>-->
		
		<!-- The tags with score lower than this will not appear in the tag cloud. Possible values: any integer from 1 to infinity. Default: 0 -->
		<!-- <property name="cuttingLevel" value="0"/>-->
	
		<!-- The ordering of the tags (based either on the name or the score of the tag)
			 Possible values: Tag.NameComparatorAsc | Tag.NameComparatorDesc | Tag.ScoreComparatorAsc | Tag.ScoreComparatorDesc
			 Default: Tag.NameComparatorAsc  -->
		<!-- <property name="ordering" value="Tag.NameComparatorAsc"/>-->	
    </bean>
    
    <!--Search filter configuration beans-->
    <bean id="searchFilterTitle" class="org.dspace.discovery.configuration.DiscoverySearchFilter">
        <property name="indexFieldName" value="title"/>
        <property name="metadataFields">
            <list>
                <value>dc.title</value>
            </list>
        </property>
    </bean>

    <bean id="searchFilterAuthor" class="org.dspace.discovery.configuration.DiscoverySearchFilterFacet">
        <property name="indexFieldName" value="author"/>
        <property name="metadataFields">
            <list>
                <value>dc.contributor.author</value>
                <value>dc.creator</value>
            </list>
        </property>
        <property name="facetLimit" value="30"/>
        <property name="sortOrder" value="COUNT"/>
    </bean>

    <bean id="searchFilterAdvisor" class="org.dspace.discovery.configuration.DiscoverySearchFilterFacet">
        <property name="indexFieldName" value="advisor"/>
        <property name="metadataFields">
            <list>
                <value>dc.contributor.advisor</value>
            </list>
        </property>
        <property name="facetLimit" value="30"/>
        <property name="sortOrder" value="COUNT"/>
    </bean>

    <bean id="searchFilterSubject" class="org.dspace.discovery.configuration.HierarchicalSidebarFacetConfiguration">
        <property name="indexFieldName" value="subject"/>
        <property name="metadataFields">
            <list>
                <value>dc.subject.*</value>
            </list>
        </property>
        <property name="facetLimit" value="30"/>
        <property name="sortOrder" value="COUNT"/>
        <property name="splitter" value="::"/>
    </bean>

    <bean id="searchFilterIssued" class="org.dspace.discovery.configuration.DiscoverySearchFilterFacet">
        <property name="indexFieldName" value="dateIssued"/>
        <property name="metadataFields">
            <list>
                <value>dc.date.issued</value>
            </list>
        </property>
        <property name="type" value="date"/>
        <property name="sortOrder" value="VALUE"/>
    </bean>

    <bean id="searchFilterType" class="org.dspace.discovery.configuration.DiscoverySearchFilter">
        <property name="indexFieldName" value="type"/>
        <property name="metadataFields">
            <list>
                <value>dc.type</value>
            </list>
        </property>
    </bean>

    <bean id="searchFilterProvenance" class="org.dspace.discovery.configuration.DiscoverySearchFilter">
        <property name="indexFieldName" value="provenance"/>
        <property name="metadataFields">
            <list>
                <value>dc.description.provenance</value>
            </list>
        </property>
    </bean>

    <!--Sort properties-->
    <bean id="sortTitle" class="org.dspace.discovery.configuration.DiscoverySortFieldConfiguration">
        <property name="metadataField" value="dc.title"/>
    </bean>

    <bean id="sortDateIssued" class="org.dspace.discovery.configuration.DiscoverySortFieldConfiguration">
        <property name="metadataField" value="dc.date.issued"/>
        <property name="type" value="date"/>
    </bean>
    
</beans>

Step 4 - Update localised messages.xml file

Because we introduced new discovery indexes above, we need to update the language file to present human readable messages for these new indexes.

Edit the following file: 

nano $HOME/source/dspace-xmlui/src/main/webapp/i18n/messages.xml

Add the following to the bottom of the file before the closing </catalogue> tag. 

<!-- Added by H Gibson -->

       <!-- Title Messages -->
        <message key="xmlui.ArtifactBrowser.ConfigurableBrowse.title.column_heading">Title</message>
        <message key="xmlui.ArtifactBrowser.ConfigurableBrowse.title.metadata.title">Browsing by Title</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.trail.metadata.title">Browsing by Title</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.sort_by.title">title</message>
	<message key="xmlui.ArtifactBrowser.AbstractSearch.sort_by.title">title</message>

       <!-- Author Messages -->
        <message key="xmlui.ArtifactBrowser.ConfigurableBrowse.author.column_heading">Author</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.title.metadata.author">Author</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.trail.metadata.author">Browsing by Author</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.sort_by.author">author</message>
	<message key="xmlui.ArtifactBrowser.AbstractSearch.sort_by.author">author</message>

       <!-- Advisor Messages -->
        <message key="xmlui.ArtifactBrowser.ConfigurableBrowse.advisor.column_heading">Advisor</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.title.metadata.advisor">Advisor</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.trail.metadata.advisor">Browsing by Advisor</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.sort_by.advisor">advisor</message>
	<message key="xmlui.ArtifactBrowser.AbstractSearch.sort_by.advisor">advisor</message>
        <message key="xmlui.ArtifactBrowser.Navigation.browse_advisor">By Advisor</message>
        <message key="xmlui.ArtifactBrowser.SimpleSearch.filter.dc.contributor.advisor">Advisor</message>
        <message key="xmlui.ArtifactBrowser.SimpleSearch.filter.advisor">Advisor</message>

       <!-- Issue Date Messages -->
        <message key="xmlui.ArtifactBrowser.ConfigurableBrowse.dateissued.column_heading">Issue Date</message>
        <message key="xmlui.ArtifactBrowser.ConfigurableBrowse.title.metadata.dateissued">Browsing by Issue Date</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.trail.metadata.dateissued">Browsing by Issue Date</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.sort_by.issuedate">issuedate</message>
	<message key="xmlui.ArtifactBrowser.AbstractSearch.sort_by.issuedate">issuedate</message>
	<message key="xmlui.ArtifactBrowser.AdvancedSearch.type_date">Date</message>
	<message key="xmlui.ArtifactBrowser.AdvancedSearch.type_issuedate">Issue Date</message>

       <!-- Subject Messages -->
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.title.metadata.subject">Subject</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.trail.metadata.subject">Browsing by Subject</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.sort_by.subject">subject</message>
	<message key="xmlui.ArtifactBrowser.AbstractSearch.sort_by.subject">subject</message>

       <!-- Type Messages -->
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.type.column_heading">Type</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.title.metadata.type">Type</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.trail.metadata.type">Browsing by Type</message>
	<message key="xmlui.ArtifactBrowser.ConfigurableBrowse.sort_by.type">type</message>
	<message key="xmlui.ArtifactBrowser.AbstractSearch.sort_by.type">type</message>
        <message key="xmlui.ArtifactBrowser.Navigation.browse_type">By Type</message>
	<message key="xmlui.ArtifactBrowser.AdvancedSearch.type_type">Type</message>	
	<message key="xmlui.ArtifactBrowser.SimpleSearch.filter.dc.type">Type</message>
	<message key="xmlui.ArtifactBrowser.SimpleSearch.filter.type">Type</message>
	<message key="xmlui.ArtifactBrowser.SimpleSearch.filter.type_filter">Type</message>

       <!-- Provenance Messages -->
	<message key="xmlui.ArtifactBrowser.AdvancedSearch.type_provenance">Provenance</message>
	<message key="xmlui.ArtifactBrowser.SimpleSearch.filter.dc.description.provenance">Provenance</message>
	<message key="xmlui.ArtifactBrowser.SimpleSearch.filter.provenance">Provenance</message>
	<message key="xmlui.ArtifactBrowser.SimpleSearch.filter.provenance_filter">Provenance</message>

Also see: Language modification

Step 5 - Rebuild DSpace

Step 6 - Rebuild Indexes

Remember: Clear the XMLUI cache when logged in as an administrator, after rebuilding the discovery indexes..

Step 7 - Do regular index maintenance

Retrieved from "http://wiki.lib.sun.ac.za/index.php?title=SUNScholar/Discovery/5.X&oldid=42846"