ILL backends

A generic inter library loan (ILL) module was added to Koha in version 17.11.0 (See Bug 7317 and this commit). This provides a generic framework for implementing different ILL workflows and protocols in Koha. These implementations will take the form of different "backends".

It is not yet clear if these backends will become part of Koha, or live outside Koha as more freestanding plugins. Bug 19605 - "ILL backends should be pluggable through regular Koha plugins" - aims to convert the ILL backends to regular KPZ plugins.

Here is a list of backends that have been developed so far:

Demo backends

• Dummy - a demo with some sample data baked in, does not talk to any outside sources. Note: This backend is no longer maintained, it's role as a demonstration backend has been assumed by the FreeForm backend

"Real" backends

• Koha - A Koha2Koha ILL based on existing SRU and ILS-DI API's
• BLDSS - British Library ILL
• FreeForm - "The FreeForm backend is a simple backend that is supposed to act as a fallback. It provides the end user with some mandatory fields in a form as well as the option to enter additional fields with arbitrary names & values."
• Libris - Swedish ILL (in regular use)
• NNCIPP - Norwegian ILL, based on NCIP (in development)
• INN-Reach

Installing a backend

1. Create the Illbackends directory below Koha (not Koha's root, but the Koha subdirectory already containing many .pm files), if it doesn't exist yet:

   1mkdir Koha/Illbackends
   

2. Clone the backend or backends you want to install. You can clone them anywhere, but you might prefere to do this outside of the Koha directory.

   1git clone https://github.com/PTFS-Europe/koha-ill-freeform.git
   

3. Symlink the cloned backend to the Koha/Illbackends directory making sure the symlink matches the package name from the backend.

   1ln -s <path-of-your-backend> <path-to-koha>/Koha/Illbackends/<Package name of backend>
   

   Example for koha-ill-freeform backend (where package = `Illbackends::FreeForm::Base.pm`):

   1ln -s /home/koha/illbackends/koha-ill-freeform /usr/share/koha/lib/Koha/Illbackends/FreeForm
   

4. Update your koha-conf.xml file, especially the backend_directory setting.

    1  <interlibrary_loans>
    2      <!-- Path to where Illbackends are located on the system
    3           - This setting should normally not be touched -->
    4      <backend_directory>__PERL_MODULE_DIR__/Koha/Illbackends</backend_directory>
    5      <!-- How should we treat staff comments?
    6           - hide: don't show in OPAC
    7           - show: show in OPAC -->
    8      <staff_request_comments>hide</staff_request_comments>
    9      <!-- How should we treat the reply_date field?
   10           - hide: don't show this field in the UI
   11           - any other string: show, with this label -->
   12      <reply_date>hide</reply_date>
   13      <!-- Where should digital ILLs be sent?
   14           - borrower: send it straight to the borrower email
   15           - branch: send the ILL to the branch email -->
   16      <digital_recipient>branch</digital_recipient>
   17      <!-- What patron category should we use for p2p ILL requests?
   18           - By default this is set to 'ILLLIBS' -->
   19      <partner_code>ILLLIBS</partner_code>
   20      <branch>
   21          <code>code_for_your_branch</code>
   22          <!-- An optional prefix for all ILL request IDs for this branch -->
   23         <prefix>ILL</prefix>
   24     </branch>
   25  </interlibrary_loans>
   

5. Turn on the ILLModule system preference.
6. Create a patron category with the code ILLLIBS' and a first patron using this category.
7. Check for any problems on About > System information