| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| indexing:koha [2023/03/09 15:08] – [VuFind Indexing Configuration] sturkel | indexing:koha [2023/11/28 19:22] (current) – demiankatz |
|---|
| ====== How to index Koha with VuFind ====== | ====== How to index Koha with VuFind® ====== |
| |
| These are general instructions for setting up indexing of bibliographic records from Koha into VuFind's Solr index. | These are general instructions for setting up indexing of bibliographic records from Koha into VuFind®'s Solr index. |
| |
| Koha uses an [[https://vufind.org/wiki/development:plugins:ils_drivers|ILS driver]] to connect the records with their holdings and status information. You still need to manually import the MARC data from Koha, so VuFind has the records that can be searched. Once those records are there, VuFind can determine the real time status of the items using the ILS driver. | Koha uses an [[https://vufind.org/wiki/development:plugins:ils_drivers|ILS driver]] to connect the records with their holdings and status information. You still need to manually import the MARC data from Koha, so VuFind® has the records that can be searched. Once those records are there, VuFind® can determine the real time status of the items using the ILS driver. |
| |
| VuFind also supports fetching records from Koha using [[indexing:oai-pmh|OAI-PMH]]. It can be useful for automating regular index updates. If you decide to use OAI-PMH, you will also need to set it up in Koha using a [[https://tiketti.koha-suomi.fi/projects/koha-suomen-dokumentaatio/wiki/OAI-PMH-configuration|configuration file to include item information]] (see also the [[configuration:ils:examples:koha_export|Exporting Records from Koha]] page and the [[https://koha-community.org/manual/20.11/en/html/webservices.html#oai-pmh|Koha Manual]]). | VuFind® also supports fetching records from Koha using [[indexing:oai-pmh|OAI-PMH]]. It can be useful for automating regular index updates. If you decide to use OAI-PMH, you will also need to set it up in Koha using a [[https://tiketti.koha-suomi.fi/projects/koha-suomen-dokumentaatio/wiki/OAI-PMH-configuration|configuration file to include item information]] (see also the [[configuration:ils:examples:koha_export|Exporting Records from Koha]] page and the [[https://koha-community.org/manual/20.11/en/html/webservices.html#oai-pmh|Koha Manual]]). |
| |
| ===== VuFind Indexing Configuration ===== | ===== VuFind® Indexing Configuration ===== |
| |
| Start by configuring indexing settings in VuFind. The default settings contain everything needed for a basic setup apart from location-related fields. | Start by configuring indexing settings in VuFind®. The default settings contain everything needed for a basic setup apart from location-related fields. |
| |
| There are several ways to index location-related fields. The first one is to put library and location to separate fields, but also a single hierarchical facet can be specified as shown further below. | There are several ways to index location-related fields. The first one is to put library and location to separate fields, but also a single hierarchical facet can be specified as shown further below. |
| |
| Using the export command described below, Koha will include MARC field 952 for each item (see [[https://wiki.koha-community.org/wiki/Holdings_data_fields_(9xx)|Koha's wiki]] for more information). | Using the export command described below, Koha will include MARC field 952 for each item (see [[https://wiki.koha-community.org/wiki/Holdings_data_fields_(9xx)|Koha's wiki]] for more information). |
| These fields can be mapped to VuFind's facet fields. The values are typically codes that are not very user-friendly, and while you could translate them to user-readable strings in marc_local.properties, translating them with VuFind's translation mechanism allows more flexibility. See [[indexing:adding_facets#translating_values_with_the_language_translation_system|Adding Facets]] for more information. | These fields can be mapped to VuFind®'s facet fields. The values are typically codes that are not very user-friendly, and while you could translate them to user-readable strings in marc_local.properties, translating them with VuFind®'s translation mechanism allows more flexibility. See [[indexing:adding_facets#translating_values_with_the_language_translation_system|Adding Facets]] for more information. |
| |
| Copy your marc_local.properties from $VUFIND_HOME/import to the $VUFIND_LOCAL_DIR/import ([[configuration:local_settings_directory|local settings]]) directory. Make all the changes you need to this file. | Copy your marc_local.properties from $VUFIND_HOME/import to the $VUFIND_LOCAL_DIR/import ([[configuration:local_settings_directory|local settings]]) directory. Make all the changes you need to this file. |
| </code> | </code> |
| |
| The id = 999c is needed for Vufind to find Koha's biblionumbers properly. The 'id =' field is not in every version of the marc_local.properties file, so you may need to add that manually. This is the field that the IDs are stored in. Koha and VuFind use different fields by default (vufind = 001, koha = 999c). | The id = 999c is needed for Vufind to find Koha's biblionumbers properly. The 'id =' field is not in every version of the marc_local.properties file, so you may need to add that manually. This is the field that the IDs are stored in. Koha and VuFind® use different fields by default (vufind = 001, koha = 999c). |
| |
| You can also set any of the index fields to static strings if desired, for example: | You can also set any of the index fields to static strings if desired, for example: |
| </code> | </code> |
| |
| You'll need to tell VuFind to handle the building field as a hierarchical one in $VUFIND_LOCAL_DIR/config/vufind/facets.ini: | You'll need to tell VuFind® to handle the building field as a hierarchical one in $VUFIND_LOCAL_DIR/config/vufind/facets.ini: |
| |
| <code> | <code> |
| ==== Suppressed Records ==== | ==== Suppressed Records ==== |
| |
| If you want to exclude suppressed records from display in VuFind, you may need to add additional settings to your import configuration. Koha stores suppressed status in MARC field 942, subfield n. A value of "1" or "Y" in 942n indicates a suppressed record. Adding a line similar to this to your marc_local.properties may help: | If you want to exclude suppressed records from display in VuFind®, you may need to add additional settings to your import configuration. Koha stores suppressed status in MARC field 942, subfield n. A value of "1" or "Y" in 942n indicates a suppressed record. Adding a line similar to this to your marc_local.properties may help: |
| |
| <code> | <code> |
| |
| |
| ===== Importing Into VuFind ===== | ===== Importing Into VuFind® ===== |
| |
| Once you have exported the koha records, you will need to import the records into VuFind. | Once you have exported the koha records, you will need to import the records into VuFind®. |
| |
| If necessary, transfer the file over so that VuFind can find it. | If necessary, transfer the file over so that VuFind® can find it. |
| |
| Now you are ready to run the import: | Now you are ready to run the import: |
| ===== The Koha ILS Driver ===== | ===== The Koha ILS Driver ===== |
| |
| :!: // The example here describes the simple, database-driven Koha driver; newer VuFind releases may include KohaILSDI and/or KohaRest drivers that implement additional functionality using APIs found in newer Koha versions. // | :!: // The example here describes the simple, database-driven Koha driver; newer VuFind® releases may include KohaILSDI and/or KohaRest drivers that implement additional functionality using APIs found in newer Koha versions. The **KohaRest driver is recommended** as it supports the widest range of functionality and does not require direct database connection. See KohaRest.ini configuration file for more information. // |
| |
| You will need to change the $VUFIND_LOCAL_DIR/config/vufind/config.ini file to have | You will need to change the $VUFIND_LOCAL_DIR/config/vufind/config.ini file to have |
| </file> | </file> |
| |
| This will enable the Koha ILS driver. But you will still need to configure it. Copy the Koha.ini file from $VUFIND_HOME/config/vufind/Koha.ini to $VUFIND_LOCAL_DIR/config/vufind/Koha.ini (from the global directory to the VuFind [[configuration:local_settings_directory|local settings directory]]). | This will enable the Koha ILS driver. But you will still need to configure it. Copy the Koha.ini file from $VUFIND_HOME/config/vufind/Koha.ini to $VUFIND_LOCAL_DIR/config/vufind/Koha.ini (from the global directory to the VuFind® [[configuration:local_settings_directory|local settings directory]]). |
| |
| Change your Koha.ini file to reflect your site. | Change your Koha.ini file to reflect your site. |
| It will prompt you for the password. If it works, then you are fine. If it fails, then you will need to verify the username / password / database with your system administrator. | It will prompt you for the password. If it works, then you are fine. If it fails, then you will need to verify the username / password / database with your system administrator. |
| |
| Once you have your koha.ini file set up, [[administration:starting_and_stopping_solr|restart Solr]] and check to see that your Koha records show up, and that the holdings information shows up. | Once you have your koha.ini file set up, check to see that your Koha records show up, and that the holdings information shows up. |
| |
| |
