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
indexing:solrmarc [2023/11/28 19:49] demiankatzindexing:solrmarc [2024/02/23 11:34] (current) demiankatz
Line 1: Line 1:
 ====== SolrMarc ====== ====== SolrMarc ======
  
-[[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.+[[https://github.com/solrmarc/solrmarc|SolrMarc]] is used to import MARC bibliographic and authority metadata into the Solr instance used by VuFind®. See [[development:architecture:solr_index_schema|Solr Index Schema]] and [[development:architecture:authority_control|Authority Control]] for notes on the layout of the index.
  
 ===== SolrMarc Versions ===== ===== SolrMarc Versions =====
Line 9: Line 9:
 :!: Prior to VuFind® 3.1, SolrMarc 2.x was used. With the introduction of SolrMarc 3.x, many performance benefits and enhanced features became available. :!: Prior to VuFind® 3.1, SolrMarc 2.x was used. With the introduction of SolrMarc 3.x, many 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 tool. Manually 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.+==== Upgrading SolrMarc ====
  
 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. 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.
Line 16: Line 16:
 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. 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]].+While editing or overriding marc.properties is possible, a preferred technique is to instead add custom settings to 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]].
  
 You can use [[development:architecture:solr_index_schema#dynamic_field_suffixes]] as part of your custom field names in your marc_local.properties file. This will enable you to add fields to the marc_local.properties file without having to modify schema.xml or restart Solr. To do this, name the custom field with the appropriate suffix for the data type you need. Otherwise, be sure to update schema.xml to define the custom fields, and also restart Solr.  You can use [[development:architecture:solr_index_schema#dynamic_field_suffixes]] as part of your custom field names in your marc_local.properties file. This will enable you to add fields to the marc_local.properties file without having to modify schema.xml or restart Solr. To do this, name the custom field with the appropriate suffix for the data type you need. Otherwise, be sure to update schema.xml to define the custom fields, and also restart Solr. 
- 
- 
- 
 ===== Customizing Translation Maps ===== ===== Customizing Translation Maps =====
  
 One of the features of SolrMarc is the ability to translate values found in MARC into different strings using translation map files (i.e. language_map.properties).  See the [[https://github.com/solrmarc/solrmarc/wiki/Translation-maps|SolrMarc documentation]] for details on how to specify a translation map in the marc.properties file. One of the features of SolrMarc is the ability to translate values found in MARC into different strings using translation map files (i.e. language_map.properties).  See the [[https://github.com/solrmarc/solrmarc/wiki/Translation-maps|SolrMarc documentation]] for details on how to specify a translation map in the marc.properties file.
  
-Starting with VuFind® 1.0RC2, translation maps are found in the import/translation_maps directory+Translation maps are found in the import/translation_maps directory and can be overridden in the [[configuration:local_settings_directory|local settings directory]].
- +
-Starting with VuFind® 2.x, translation maps can be overridden in the [[configuration:local_settings_directory|local settings directory]]. +
- +
-Prior to RC2, translation maps are embedded in the SolrMarc .jar file, making them more difficult (but certainly not impossible) to modify. +
 ===== Customizing Format Determination ===== ===== Customizing Format Determination =====
  
Line 97: Line 89:
  
 It may occasionally be useful to manipulate records after you export them from your ILS but before you load them into SolrMarc.  See the Code4Lib [[http://wiki.code4lib.org/index.php/Working_with_MaRC|Working with MARC]] page for some tools to help you with MARC manipulation. It may occasionally be useful to manipulate records after you export them from your ILS but before you load them into SolrMarc.  See the Code4Lib [[http://wiki.code4lib.org/index.php/Working_with_MaRC|Working with MARC]] page for some tools to help you with MARC manipulation.
 +
 +===== Troubleshooting =====
 +
 +See the [[indexing:solrmarc:troubleshooting]] page for more details.
 ---- struct data ---- ---- struct data ----
 properties.Page Owner :  properties.Page Owner : 
 ---- ----
  
indexing/solrmarc.1701200994.txt.gz · Last modified: 2023/11/28 19:49 by demiankatz