Unsupported Release
This documentation relates to an old, unsupported version of DSpace, version 1.7.x. Looking for another version? See all documentation.
As of January 2014, the DSpace 1.7.x platform is no longer supported. We recommend upgrading to a more recent version of DSpace.
DSpace Discovery
Introduction Video
Instructions for enabling Discovery in DSpace 1.7.0
As with any upgrade procedure, it is highly recommend that you backup your existing data thoroughly. This includes cases where upgrading DSpace from 1.6.2 to 1.7.0. Although upgrades in versions of Solr/Lucene do tend to be forwards compatible for the data stored in the Lucene index, it is always a best practice to backup your dspace.dir/solr/statistics cores to assure no data is lost.
- Enable the Discovery Aspects in the XMLUI by changing the following settings in config/xmlui.xconf
- Comment out: SearchArtifacts
- Uncomment: Discovery
<xmlui> <aspects> <aspect name="Artifact Browser" path="resource://aspects/ArtifactBrowser/" /> <aspect name="Browsing Artifacts" path="resource://aspects/BrowseArtifacts/" /> <!--<aspect name="Searching Artifacts" path="resource://aspects/SearchArtifacts/" />--> <aspect name="Administration" path="resource://aspects/Administrative/" /> <aspect name="E-Person" path="resource://aspects/EPerson/" /> <aspect name="Submission and Workflow" path="resource://aspects/Submission/" /> <aspect name="Statistics" path="resource://aspects/Statistics/" /> <!-- To enable Discovery, uncomment this Aspect that will enable it within your existing XMLUI Also make sure to comment the SearchArtifacts aspect as leaving it on together with discovery will cause UI overlap issues--> <aspect name="Discovery" path="resource://aspects/Discovery/" /> <!-- This aspect tests the various possible DRI features, it helps a theme developer create themes --> <!-- <aspect name="XML Tests" path="resource://aspects/XMLTest/"/> --> </aspects>
- Enable the Discovery Indexing Consumer that will update Discovery Indexes on changes to content in XMLUI, JSPUI, SWORD, and LNI in config/dspace.cfg
- Add discovery to the list of event.dispatcher.default.consumers
- Change recent.submissions.count to zero
#### Event System Configuration #### # default synchronous dispatcher (same behavior as traditional DSpace) event.dispatcher.default.class = org.dspace.event.BasicDispatcher #event.dispatcher.default.consumers = search, browse, eperson, harvester event.dispatcher.default.consumers = search, browse, discovery, eperson, harvester #Put the recent submissions count to 0 so that discovery can use it's recent submissions, # not doing this when discovery is enabled will cause UI overlap issues #How many recent submissions should be displayed at any one time #recent.submissions.count = 5 recent.submissions.count = 0
- Check that the port is correct for solr.search.server in config/dspace-solr-search.cfg
- If all of your traffic runs over port 80, then you need to remove the port from the URL
##### Search Indexing ##### solr.search.server = http://localhost/solr/search
- If all of your traffic runs over port 80, then you need to remove the port from the URL
- From the command line, navigate to the dspace directory and run the command below to index the content of your DSpace instance into Discovery.
./bin/dspace update-discovery-index
NOTE: This step may take some time if you have a large number of items in your repository.
Instructions for Configuring Discovery
Discovery can be configured at multiple levels of the application. Outlined below will be where in Discovery changes can be made that will alter the presentation. The primary place that the user experience is altered in XMLUi is through the dspace-solr-search.cfg file
Configuring Facets that are Exposed for Search Results
Property: |
solr.search.server |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example Value: |
http://localhost:8080/solr/search | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Informational Note: |
Discovery relies on a SOLR index. This parameter determines the location of the SOLR index. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Property: |
solr.facets.search |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example Value: |
solr.facets.search=dc.contributor.author,dc.subject,dc.date.issued_dt |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Informational Note: |
The Discovery search facets, offered in the navigation bar, can be customized for each specific page in DSpace. When no specification is given for a page, this default configuration is used. Every SOLR facet field which ends with _dt will be handled as a date. Handeling as date implies that Unknown macro: {field.name}
.year will be used for faceting |
.year so it can be used for date faceting |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Property: |
solr.recent-submissions.size |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example Value: |
solr.recent-submissions.size=5 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Informational Note: |
Defines the number of items that are shown in the Recently Added lists. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Property: |
recent.submissions.sort-option |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example Value: |
recent.submissions.sort-option=dc.date.accessioned_dt |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Informational Note: |
The indexed metadata field on which Discovery sorts to determine which items were recently submitted |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Property: |
search.facet.max |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example Value: |
search.facet.max=10 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Informational Note: |
Use the property below to limit the number of facet filters in the side of the search page |
##### Search Indexing ##### solr.search.server = http://localhost:8080/solr/search # Should no solr facet be configured for a certain page, this one will be used as default #Every solr facet field which ends with _dt will be handled as a date #Handeling as date implies that {field.name}.year will be used for faceting solr.facets.search=dc.contributor.author,dc.subject,dc.date.issued_dt solr.facets.site=dc.contributor.author,dc.subject,dc.date.issued_dt solr.facets.community=dc.contributor.author,dc.subject,dc.date.issued_dt solr.facets.collection=dc.contributor.author,dc.subject,dc.date.issued_dt # solr.facets.item=dc.contributor.author,dc.subject,dc.date.issued_dt # Put any default search filters here, these filters will be applied to any search in discovery # You can specify multiple filters by separating them using , ##Default filters are used for every search in discovery, including the separate scope filters below #solr.default.filterQuery=location:l2 # You can also specify (additional) filter(s) ## for homepage recent submissions #solr.site.default.filterQuery= ## for community recent submissions #solr.community.default.filterQuery= ## for collection recent submissions #solr.collection.default.filterQuery= ## for searches #solr.search.default.filterQuery= ## for browsing (not used at the moment) #solr.browse.default.filterQuery= # The filters which can be selected in the search form solr.search.filters=dc.title, dc.contributor.author, dc.subject, dc.date.issued.year # Indexed fields which can sorted on in our search solr.search.sort=dc.title, dc.date.issued_dt #Defines whichs fields are indexed as dates #please be aware that for each date field an _dt will be suffixed so that dc.date.issued will become dc.date.issued_dt #For each date indexed the year will also be stored separately in a {field.name}.year so it can be used for date faceting solr.index.type.date=dc.date,dc.date.* #Recent submission size solr.recent-submissions.size=5 #The indexed field on which we sort so we can determine which items where recently submitted recent.submissions.sort-option=dc.date.accessioned_dt #Use the property below to limit the number of facet filters in the side of the search page #search.facet.max=10
Advanced Configuration in Solr
Solr itself now runs two cores. One for collection DSpace Solr based "statistics", the other for Discovery Solr based "search"
solr ├── search │ ├── conf │ │ ├── admin-extra.html │ │ ├── elevate.xml │ │ ├── protwords.txt │ │ ├── schema.xml │ │ ├── scripts.conf │ │ ├── solrconfig.xml │ │ ├── spellings.txt │ │ ├── stopwords.txt │ │ ├── synonyms.txt │ │ └── xslt │ │ ├── DRI.xsl │ │ ├── example.xsl │ │ ├── example_atom.xsl │ │ ├── example_rss.xsl │ │ └── luke.xsl │ └── conf2 ├── solr.xml └── statistics └── conf ├── admin-extra.html ├── elevate.xml ├── protwords.txt ├── schema.xml ├── scripts.conf ├── solrconfig.xml ├── spellings.txt ├── stopwords.txt ├── synonyms.txt └── xslt ├── example.xsl ├── example_atom.xsl ├── example_rss.xsl └── luke.xsl
Usage Guidelines
The Discovery Module enables your repository to have faceted searching.
Thus a user can filter what they are looking for by grouping entries into a facet, and drill down to find the content they are interested in.
So instead of user searching: [ wetland + "dc.author=Mitsch, William J" + dc.subject="water quality" ], they can instead do their initial search, [ wetland ], and then filter the results by attributes.
Unable to render embedded object: File (worddava7d46df6db45f7ce78511e9f8e78b098.png) not found.
A website like Amazon, might do this to help you select a digital camera. You can reduce the results by price range, features, megapixels, manufacturer, etc.
The further the DSpace Discovery module is developed, the more useful that browsing can be to the researcher looking for items in your collections.
Screenshots
Empty search shows that it can be filtered easily.
Unable to render embedded object: File (worddave0432a807dfbee0a0920d684f5c5e9e5.png) not found.