Update ILL_requests.rst
[kohadocs.git] / source / ILL_requests.rst
1 Interlibrary loans
2 =====================
3
4 The interlibrary loans (ILL) module adds the ability to request and manage loans or copies of material from external sources.  Patrons submit a request form via the OPAC for review and processing by library staff.  Alternatively staff can place requests themselves from the staff client.  
5
6 .. _setup-label:
7
8 Set up
9 -------------
10
11 Before using the ILL Requests module you will want to make sure that you have completed all of the set up.
12
13 The ILL module can be configured for different types of requests and workflows known as backends.   Currently available backends are documented on the Koha community wiki at https://wiki.koha-community.org/wiki/ILL_backends.  You will need to configure at least one backend. 
14
15 Next set your system preferences.  
16
17 -  Set the :ref:`ILLModule` preference to ‘Enable’.  
18
19 -  If you wish to include a copyright declaration in your ILL workflow you can this in the :ref:`ILLModuleCopyrightClearance` preference. 
20
21 Library staff responsible for ILL requests need the following permission set on their account: *ill: Create and modify Interlibrary loan requests*.
22
23 The ILL module uses system defined statuses.  You can add custom statuses to match your ILL workflow as ILLSTATUS :ref:`authorized values <authorized-values-label>`.
24
25 .. _create-ILL-requests-label:
26
27 Create ILL requests
28 ----------------------
29
30 -  *Get there:* More > ILL requests
31
32 |image|
33
34 -  Choose ‘New ILL request’ and then Freeform.
35
36 **Note:** 
37 The images shown here are for the FreeFrom backend only.
38
39 |image|
40
41 -  Enter a Type – Book, Article, Journal, Other.
42 -  In the next two sections enter as much as information as you can including chapter/article/part if applicable.
43
44 |image|
45
46 -  Add custom fields, for example if you wished to add a note.
47 -  Under the borrower options enter the library branch you would like the request to be sent to.
48
49 Click on ‘Create’ and you will be shown a Request details summary page.  Click on the ‘Confirm request’ button and you will see the following confirmation message:
50
51 |image|
52
53 Click ‘Confirm request’ again.  From the main ILL requests screen you can see all of your ILL requests and their status.  Alternatively you can click on ‘View requests’ at any time. The request will have the status ‘New request’. 
54
55 .. _managing-ILL-requests-label:
56
57 Managing ILL requests
58 ----------------------
59
60 Click on the ‘Manage request’ button in the final column. Depending on the current status of the request you may see some or all of the following buttons:
61
62 -  Edit request - you can edit the borrowernumber, biblionumber, branch and can add notes.
63 -  Confirm request - place the request with a document supply service using a backend such as BLDSS.
64 -  Place request with partners -  place the request via email with a partner library.  See (link)
65 -  Delete - fully delete the request.  Details of deleted requests are not retained in Koha.
66 -  Revert request –  following a status of ‘Requested’ or ‘Requested from partners’ library staff can cancel the request from the external source.  The status reverts to ‘New’
67 -  Mark completed - used when the ILL request has been fulfilled. 
68
69 The full list of ILL statuses re:
70
71 -  New request
72 -  Requested
73 -  Requested from partners 
74 -  Request reverted 
75 -  Cancellation requested – a patron has requested cancellation from the OPAC.
76 -  Completed
77
78 .. _place-request-with-partners-label:
79
80 Place request with partners
81 -----------------------------
82
83 If you have a network of partner libraries to which you regularly send ILL requests you can manage this through Koha.  First you need to create your partner library accounts as follows:
84
85 -  You will need to set up a :ref:`patron category <patron-categories-label>` with the code ILLLIBS.
86 -  You will need to create a patron account with this category for each partner library.  
87 -  Each library must have an email address as this will be the mechanism for sending the inter-library loan request.