SUNScholar/Browse Indexes/4.X

From Libopedia
Jump to navigation Jump to search
Back to Browse Indexes


Starting with DSpace versions =>3.2, the DAO engine can now be defined to be one of the following:

  • PostgreSQL
  • Oracle
  • SOLR


See step 1 below to determine which engine to use.

Step 1 - Select DAO (Data Access Objects) Engine

Edit the dspace.cfg file and select the DAO engine by typing as follows:

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

Select SOLR DAO engine as per example below:

###### Browse Configuration ######
# Define the DAO class to use this must meet your storage choice for 
# the browse system (RDBMS: PostgreSQL or Oracle, Solr). 
# By default, since DSpace 4.0, the Solr implementation is used
# PostgreSQL:
# browseDAO.class = org.dspace.browse.BrowseDAOPostgres
# browseCreateDAO.class = org.dspace.browse.BrowseCreateDAOPostgres
# Oracle:
# browseDAO.class = org.dspace.browse.BrowseDAOOracle
# browseCreateDAO.class = org.dspace.browse.BrowseCreateDAOOracle
# Solr:
browseDAO.class = org.dspace.browse.SolrBrowseDAO
browseCreateDAO.class = org.dspace.browse.SolrBrowseCreateDAO

Step 2 - Setup custom indexes

Modify the following sections of the "dspace.cfg" config file.

Simple and Advanced Search Indexes

Replaced by the "Discovery" search indexes.

Browse Indexes

Go to line 1125 approx in the DSpace config file and modify as desired.

# webui.browse.index.<n> = <index name> : metadata : (dc schema identifier) : (date | title | text) : (asc | desc)
# webui.browse.index.<n> = <index name> : item : <sort option name> : (asc | desc)
### SUNScholar browse indexes ###
webui.browse.index.1 = title:item:title:asc
webui.browse.index.2 =
webui.browse.index.3 = advisor:metadata:dc.contributor.advisor:text
webui.browse.index.4 =
webui.browse.index.5 = subject:metadata:dc.subject.*:text
webui.browse.index.6 = type:metadata:dc.type:text

<option name> = <index name> as per "item" definition above.

# webui.itemlist.sort-option.<n> = <option name> : (dc schema identifier) :  (date | title | text) : (show | hide)
### SUNScholar item lists ###
webui.itemlist.sort-option.1 = title:dc.title:title 
webui.itemlist.sort-option.2 =
webui.itemlist.sort-option.3 =

Author Listing Indexes

Using "nano" modify the following section in the DSpace config file to suit your needs. The default as configured below is to list all contributors.

## Set the options for how authors are displayed in the browse listing

# Define which field is the author/editor etc listing.  This should be
listed in the
# field webui.itemlist.columns, otherwise it will have no effect.
# This cannot be a field already marked out as a title or a date, as this
# will also have no effect.  This is used in conjunction with the
# field below, to truncate author lists.  For
# configuring links to author publication lists use below.
# (This setting is not used by the XMLUI as it is controlled by your theme)
# = = dc.contributor.*

# define how many authors to display before truncating and completing with
"et al"
# (or language pack specific alternative)
# Use -1 for unlimited (which is what will be used if this option
# is omitted)
# = 3

# which fields should link to other browse listings.  This should associated
# the name of one of the above browse indices with a metadata field listed
# in <webui.itemlist.columns> above.  The form is:
#<n> = <index name>:<display column metadata>
# Note that cross linking will only work for fields other than title.
# The effect this has is to create links to browse views for the item
clicked on.
# If it is a "single" type, it will link to a view of all the items which
# that metadata element in common (i.e. all the papers by a single author).
# it is a "full" type, it will link to a view of the standard full browse
# starting with the value of the link clicked on.
# (This setting is not used by the XMLUI, as links are controlled by your
# The default below defines the authors to link to other publications by
that author
# = = author:dc.contributor.*

Recent Submissions Sort

#### Additional configuration for Recent Submissions code ####

# the sort option name (from webui.itemlist.sort-option above) to use for
# displaying recent submissions.  (this
# is used by the Recent Submissions system and any other time based
# browse query such as FeedServlet)
recent.submissions.sort-option = dateaccessioned

Step 3 - Update messages.xml file

Because we introduced new search and browse 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="">Author</message>
	<message key="">Author</message>
	<message key="">Browsing by Author</message>
	<message key="">author</message>
	<message key="">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 4 - Rebuild DSpace

Step 5 - Rebuild Indexes

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

Step 6 - Do regular index maintenance