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
Next revision
Previous revision
Last revisionBoth sides next revision
course_reserves [2014/06/13 13:14] – external edit 127.0.0.1configuration:course_reserves [2023/11/09 18:42] demiankatz
Line 1: Line 1:
 ====== Course Reserves ====== ====== Course Reserves ======
  
-Academic libraries often need to list resources held on reserve for particular courses, departments and instructors.  VuFind supports this need in multiple ways.+Academic libraries often need to list resources held on reserve for particular courses, departments and instructors.  VuFind® supports this need in multiple ways.
  
-Regardless of how reserves are configured, they can be accessed through the "/Search/Reserves" action beneath your base VuFind URL.+Regardless of how reserves are configured, they can be accessed through the "/Search/Reserves" action beneath your base VuFind® URL.
  
 ===== Driver-Based Reserves (Default) ===== ===== Driver-Based Reserves (Default) =====
  
-If your [[vufind2:building_an_ils_driver|ILS driver]] implements the findReserves() method, VuFind can load course reserves information in real-time from the ILS.+If your [[development:plugins:ils_drivers|ILS driver]] implements the findReserves() method, VuFind® can load course reserves information in real-time from the ILS.
  
 ===== 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:+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:
  
-1.) Edit the [Reserves] section of [[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 [[starting and stopping VuFind|restarting Solr]].+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.
  
-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 [[vufind2:building_an_ils_driver|ILS driver]].  Starting with VuFind 1.4, you can also load data from a CSV file.  See index_reserves.php parameters below for details.  //See [[http://vufind.org/jira/browse/VUFIND-582|VUFIND-582]] for a patch if you need to add CSV functionality to VuFind 1.3.//+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 (VuFind 1.4 or newer) ====+==== index_reserves.php command-line parameters (VuFind® 1.4 or newer) ====
  
 <code> <code>
Line 40: Line 40:
      Default template is BIB_ID,COURSE,INSTRUCTOR,DEPARTMENT      Default template is BIB_ID,COURSE,INSTRUCTOR,DEPARTMENT
  -h or -? display this help information.  -h or -? display this help information.
 +</code>
 +
 +==== 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.
 +
 +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> </code>
 ---- struct data ---- ---- struct data ----
 +properties.Page Owner : 
 ---- ----
  
configuration/course_reserves.txt · Last modified: 2023/11/09 18:47 by demiankatz