About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
indexing:solrmarc

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
indexing:solrmarc [2016/04/18 12:49] – [BeanShell Scripts] demiankatzindexing:solrmarc [2016/12/16 13:58] – [Customizing Import Mappings] demiankatz
Line 1: Line 1:
 ====== SolrMarc ====== ====== SolrMarc ======
  
-SolrMarc is used to import MARC metadata to the "biblio" index on Solr used by VuFind.  See [[development:architecture:solr_index_schema|Solr Index Schema]] for notes on the layout of the index.+[[https://github.com/solrmarc/solrmarc|SolrMarc]] is used to import MARC metadata to the "biblio" index on Solr used by VuFind.  See [[development:architecture:solr_index_schema|Solr Index Schema]] for notes on the layout of the index.
  
-===== Upgrading SolrMarc =====+===== SolrMarc Versions =====
  
-There should rarely be a need to do so, but if you wish, you can update to the latest version of the tool, available [[http://code.google.com/p/solrmarc/|here]] Instructions on setting up SolrMarc with VuFind are available [[http://code.google.com/p/solrmarc/wiki/VufindHowTo|here]].+VuFind's [[:changelog|changelog]] can help you determine which version of SolrMarc you are currently running. 
 + 
 +:!: Prior to VuFind 3.1, SolrMarc 2.x was used. With the introduction of SolrMarc 3.xmany performance benefits and enhanced features became available. 
 + 
 +Users are strongly encouraged to upgrade to VuFind 3.1 or later in order to take advantage of the improved indexing toolManually installing the new SolrMarc in an earlier version of VuFind should also be possible with relatively minimal work by replacing the necessary .jar files and adapting the revised indexing scripts found in later releases. 
 + 
 +Manually upgrading SolrMarc to a later 3.x version is simply a matter of updating import/solrmarc-core.jar and any necessary dependencies found in import/lib.
 ===== Customizing Import Mappings ===== ===== Customizing Import Mappings =====
  
-The import process is controlled by the settings in the import/marc.properties file under your VuFind installation directory.  The default settings should be fine for a first-time user, but if you want to change or expand the set of MARC fields that are used to build VuFind's search indexes, you can edit this file to make adjustments.  See the [[http://code.google.com/p/solrmarc/wiki/ConfiguringSolrMarc|SolrMarc documentation]] for details on how this works.+The import process is controlled by the settings in the import/marc.properties file under your VuFind installation directory.  The default settings should be fine for a first-time user, but if you want to change or expand the set of MARC fields that are used to build VuFind's search indexes, you can edit this file to make adjustments.  See the [[https://github.com/solrmarc/solrmarc/wiki|SolrMarc documentation]] for details on how this works.
  
 As of VuFind 1.0RC2, a second properties file is also available called import/marc_local.properties.  Any lines added to this file will override the equivalent settings in marc.properties.  Use of this file is optional, but it is an easy way to separate your local customizations from the default settings packaged with VuFind.  For more details, see [[indexing:solrmarc:local_marc_mappings|local MARC mappings]]. As of VuFind 1.0RC2, a second properties file is also available called import/marc_local.properties.  Any lines added to this file will override the equivalent settings in marc.properties.  Use of this file is optional, but it is an easy way to separate your local customizations from the default settings packaged with VuFind.  For more details, see [[indexing:solrmarc:local_marc_mappings|local MARC mappings]].
Line 30: Line 36:
 By default, formats are generated using the getFormat function built into SolrMarc.  However, the logic used by getFormat is also replicated in a BeanShell script packaged with VuFind.  If you want to customize the behavior, here are the steps to follow: By default, formats are generated using the getFormat function built into SolrMarc.  However, the logic used by getFormat is also replicated in a BeanShell script packaged with VuFind.  If you want to customize the behavior, here are the steps to follow:
  
-  - Copy import/index_scripts/format.bsh into your [[configuration:local_settings_directory|local settings directory]] and edit it to customize the behavior as needed.  BeanShell borrows its syntax and libraries from Java, so the code should look familiar to many developers.  The MARC access is accomplished with the [[http://marc4j.tigris.org/|MARC4J]] library.+  - Copy import/index_scripts/format.bsh into the import/index_scripts subdirectory of your [[configuration:local_settings_directory|local settings directory]] and edit it to customize the behavior as needed.  BeanShell borrows its syntax and libraries from Java, so the code should look familiar to many developers.  The MARC access is accomplished with the [[http://marc4j.tigris.org/|MARC4J]] library.
   - If your new custom script returns different values than the old script, or if you want to change the way the existing values are mapped into your index, edit a local copy of the translation map found in import/translation_maps/format_map.properties.   - If your new custom script returns different values than the old script, or if you want to change the way the existing values are mapped into your index, edit a local copy of the translation map found in import/translation_maps/format_map.properties.
   - Uncomment the format line (format = script(format.bsh), getFormat, format_map.properties) in a local copy of import/marc_local.properties to ensure that VuFind imports using the custom BeanShell version of getFormat instead of the built-in SolrMarc version.   - Uncomment the format line (format = script(format.bsh), getFormat, format_map.properties) in a local copy of import/marc_local.properties to ensure that VuFind imports using the custom BeanShell version of getFormat instead of the built-in SolrMarc version.
indexing/solrmarc.txt · Last modified: 2024/02/23 11:34 by demiankatz