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.
configuration:course_reserves

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
configuration:course_reserves [2023/11/09 18:42] demiankatzconfiguration:course_reserves [2023/11/09 18:47] (current) demiankatz
Line 11: Line 11:
 ===== Solr-Based Reserves ===== ===== Solr-Based Reserves =====
  
-Starting with VuFind® 1.3, you can configure the software to use a Solr index for course reserves searching instead of the ILS driver.  This offers greater flexibility and a more attractive user interface.  To configure:+You can configure the software to use a Solr index for course reserves searching instead of the ILS driver.  This offers greater flexibility and a more attractive user interface, but it requires you to periodically reindex your data to keep the system up to date.  To configure:
  
 1.) Edit the [Reserves] section of [[configuration:files:config.ini]] and set search_enabled to true. 1.) Edit the [Reserves] section of [[configuration:files:config.ini]] and set search_enabled to true.
  
-2.) Turn on the reserves Solr core by editing solr/solr.xml to uncomment the appropriate line and then [[administration:starting_and_stopping_solr|restarting Solr]]. :!: This step is not necessary in VuFind® 3.0 or newer.+2.) Load data into the index by running the util/index_reserves.php tool to extract it from your ILS.  ILS extraction requires support in the [[development:plugins:ils_drivers|ILS driver]].  You can also load data from a CSV file.  See index_reserves.php parameters below for details.
  
-3.) Load data into the index by running the util/index_reserves.php tool to extract it from your ILS.  ILS extraction requires support in the [[development:plugins:ils_drivers|ILS driver]].  Starting with VuFind® 1.4, you can also load data from a CSV file.  See index_reserves.php parameters below for details.+==== index_reserves.php command-line parameters ====
  
-==== index_reserves.php command-line parameters (VuFind® 1.4 or newer) ====+You can load data into your Solr reserves index by running the ''util/index_reserves.php'' command. Usage details:
  
 <code> <code>
Line 44: Line 44:
 ==== Multiple reserve Solr cores ==== ==== Multiple reserve Solr cores ====
  
-If your Solr installation has more than one core for reserves (for instance, your Solr service is used by more than one VuFind® installation), you can change the name of the reserves core. +Starting with VuFind® 9.0, if your Solr installation has more than one core for reserves (for instance, your Solr service is used by more than one VuFind® installation), you can change the name of the reserves core by customizing the [Index] section of reserves.iniFor earlier versions of VuFind®, customizing the core name required you to override the factory of the SolrReserves search backend.
- +
-1.) Create module/<your_module>/src/<your_module>/Search/Factory/SolrReservesBackendFactory.php and extend the parent class. Change $this->solrCore to the name of your reserves Solr core: +
- +
-<code> +
-<?php +
-namespace <your_module>\Search\Factory; +
- +
-class SolrReservesBackendFactory extends \VuFind\Search\Factory\SolrReservesBackendFactory +
-+
-    public function __construct() +
-    { +
-        parent::__construct(); +
-        $this->solrCore = '<your-library>_reserves'; +
-    } +
-+
-</code> +
- +
-2.) Add a factory plugin to the new factory in your module's "module.config.php" +
- +
-<code> +
-'vufind' => +
-  array( +
-    'search_backend' => +
-      array( +
-        'factories' => +
-          array( +
-            'SolrReserves' => '<your_module>\Search\Factory\SolrReservesBackendFactory', +
-          ) +
-      ) +
-  ) +
-</code>+
 ---- struct data ---- ---- struct data ----
 properties.Page Owner :  properties.Page Owner : 
 ---- ----
  
configuration/course_reserves.txt · Last modified: 2023/11/09 18:47 by demiankatz