Taiga 1274 (24976) Updated guided reports process
[kohadocs.git] / source / ILL_requests.rst
1 .. include:: images.rst
2
3 .. _ill-requests-label:
4
5 ILL requests / Interlibrary loans
6 ===================================
7
8 The ILL (Interlibrary loans) requests 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.
9
10 .. _setup-ill-requests-label:
11
12 Set up
13 -------------
14
15 Before using the ILL requests module you will want to make sure that you have completed all of the set up.
16
17 The ILL requests 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.
18
19 Next, set your system preferences.
20
21 -  Set the :ref:`ILLModule` preference to ‘Enable’.
22
23 -  If you wish to include a copyright declaration in your ILL workflow you can this in the :ref:`ILLModuleCopyrightClearance` preference.
24
25 Library staff responsible for ILL requests need the following permission set on their account: *ill: Create and modify Interlibrary loan requests*.
26
27 The ILL requests module uses system defined statuses. You can add custom statuses to match your ILL workflow as ILLSTATUS :ref:`authorized values <authorized-values-label>`.
28
29 .. _create-ILL-requests-label:
30
31 Create ILL requests
32 ----------------------
33
34 -  *Get there:* More > ILL requests
35
36 |image1386|
37
38 -  Choose ‘New ILL request’ and then Freeform.
39
40     **Note**
41
42     The images shown here are for the FreeFrom backend only.
43
44 |image1387|
45
46 -  Enter a Type: Book, Article, Journal, Other.
47
48 -  In the next two sections enter as much as information as you can including chapter/article/part if applicable.
49
50 |image1388|
51
52 -  Add custom fields, for example if you wished to add a note.
53
54 -  Under the borrower options enter the library branch you would like the request to be sent to.
55
56 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:
57
58 |image1389|
59
60 Click ‘Confirm request’ again to create your request.
61
62 .. _viewing-ILL-requests-label:
63
64 Viewing ILL requests
65 ------------------------
66
67 From the main ILL requests screen you can see all of your ILL requests. You
68 can also click on the ‘View requests’ button at any time.
69
70 |image1435|
71
72 There is a large amount of data available in the Requests table so it is
73 advisable to make use of column visibility to view only the information you need.
74 The first half of the table displays data related to the ILL item itself
75 such as title, volume, page numbers.
76
77 |image1436|
78
79 The second half of the table displays data related to the request such as notes
80 and comments.
81
82 .. _managing-ILL-requests-label:
83
84 Managing ILL requests
85 ------------------------
86
87 Click on the ‘Manage request’ button in the final column. Depending on the current
88 status of the request you may see some or all of the following options:
89
90 -  Edit request
91
92    -  you can edit the borrowernumber, biblionumber, branch and can add notes.
93 -  Confirm request
94
95    -  place the request with a document supply service using a backend such as BLDSS.
96 -  Place request with partners
97
98    -  place the request via email with a :ref:`partner library <place-request-with-partners-label>`
99 -  Delete
100
101    -  fully delete the request. Details of deleted requests are not retained in Koha.
102 -  Revert request
103
104    -  following a status of ‘Requested’ or ‘Requested from partners’ library
105       staff can cancel the request from the external source. The status reverts to ‘New’
106 -  Mark completed
107
108    -  used when the ILL request has been fulfilled.
109 -  Edit item metadata
110
111    -  Depending on the backend used for the request you may be able to edit,
112       add or delete some or all of the request metadata.  For example, if the
113       metdata has originated from a requestor using the FreeForm backend this
114       may need to be edited, whereas metadata from an external recognised source
115       such as BLDSS should not.
116 -  Display supplier metadata
117
118    -  Displays any extra metadata that might have been provided by your ILL
119       supplier that has not been included in the standard request fields.
120 -  Comments
121
122    -  It is possible to add comments to an ILL request and these can be used
123       by ILL staff to keep track of work undertaken. Comments are read only and are
124       stored in chronological order. They display the borrower details and date of the
125       comment. If present, the number of comments is displayed in the List
126       requests view.
127
128 Request statuses
129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130
131 The full list of ILL statuses are:
132
133 -  New request
134 -  Requested
135 -  Requested from partners
136 -  Request reverted
137 -  Cancellation requested – a patron has requested cancellation from the OPAC.
138 -  Completed
139
140 .. _place-request-with-partners-label:
141
142 Place request with partners
143 -----------------------------
144
145 If you have a network of partner libraries which permit ILL requests you can manage this through Koha. First you need to create your partner library accounts:
146
147 -  You will need to set up a :ref:`patron category <patron-categories-label>` with the code ILLLIBS.
148
149 -  You will need to create a patron account with this category for each partner library.
150
151 -  Each library must have an email address as this will be the mechanism for sending the inter-library loan request.
152
153 You can now use the 'Place request with partners' option when processing requests.