Bug 20706: Fixes the links to the manual to reflect chanced chapter file names
[koha.git] / koha-tmpl / intranet-tmpl / prog / en / modules / help / admin / smart-rules.tt
1 [% INCLUDE 'help-top.inc' %]
2
3 <h1>Circulation and Fines Rules</h1>
4
5 <p>These rules define how your items are circulated, how/when fines are calculated and how holds are handled.</p>
6
7 <p>The rules are applied from most specific to less specific, using the first found in this order:</p>
8
9 <ul>
10         <li>same library, same patron category, same item type</li>
11         <li>same library, same patron category, all item type</li>
12         <li>same library, all patron categories, same item type</li>
13         <li>same library, all patron categories, all item types</li>
14         <li>all libraries, same patron category, same item type</li>
15         <li>all libraries, same patron category, all item types</li>
16         <li>all libraries, all patron categories, same item type</li>
17         <li>all libraries, all patron categories, all item types</li>
18 </ul>
19
20 <p>The CircControl and HomeOrHoldingBranch also come in to play when figuring out which circulation rule to follow.</p>
21
22 <ul>
23         <li>If CircControl is set to "the library you are logged in at" circ rules will be selected based on the library you are logged in at</li>
24         <li>If CircControl is set to "the library the patron is from" circ rules will be selected based on the patron's library</li>
25         <li>If CircControl is set to "the library the item is from" circ rules will be selected based on the item's library where HomeOrHoldingBranch chooses if item's home library is used or holding library is used.</li>
26         <li>If IndependentBranches is set to 'Prevent' then the value of HomeOrHoldingBranch is used in figuring out if the item can be checked out. If the item's home library does not match the logged in library, the item cannot be checked out unless you are a superlibrarian.</li>
27 </ul>
28
29 <p>If you are a single library system choose your branch name before creating rules (sometimes having only rules for the 'all libraries' option can cause issues with holds)</p>
30
31 <p style="color: #990000;">Important: At the very least you will need to set a default circulation rule. This rule should be set for all item types, all libraries and all patron categories. That will catch all instances that do not match a specific rule. When checking out if you do not have a rule for all libraries, all item types and all patron categories then you may see patrons getting blocked from placing holds. You will also want a rule for your specific library set for all item types and all patron categories to avoid this holds issue. Koha needs to know what rule to fall back on.</p>
32
33 <h4>Default Circulation Rules</h4>
34
35 <p>Using the circulation and fine rules matrix you can define rules that depend on patron/item type combinations. To set your rules, choose a library from the pull down (or 'all libraries' if you want to apply these rules to all libraries)</p>
36
37 <p>From the matrix you can choose any combination of patron categories and item types to apply the rules to</p>
38
39 <ul>
40         <li>First choose which patron category you'd like the rule to be applied to. If you leave this to 'All' it will apply to all patron categories</li>
41         <li>Choose the 'Item Type' you would like this rule to apply to. If you leave this to 'All' it will apply to all item types</li>
42         <li>Limit the number of items a patron can have checked out at the same time by entering a number in the 'Current Checkouts Allowed' field</li>
43     <li>Define the period of time an item can be checked out to a patron by entering the number of units (days or hours) in the 'Loan Period' box.</li>
44     <li>Choose which unit of time, Days or Hours, that the loan period and fines will be calculate in</li>
45     <li>You can also define a hard due date for a specific patron category and item type. A hard due date ignores your usual circulation rules and makes it so that all items of the type defined are due on, before or after the date you specify.</li>
46     <li>'Fine Amount' should have the amount you would like to charge for overdue items
47 <ul>
48     <li style="color: #990000;">Important: Enter only numbers and decimal points (no currency symbols).</li>
49 </ul>
50 </li>
51     <li>Enter the 'Fine Charging Interval' in the unit you set (ex. charge fines every 1 day, or every 2 hours)</li>
52     <li>The 'Fine Grace Period' is the period of time an item can be overdue before you start charging fines.
53 <ul>
54     <li style="color: #990000;">Important: This can only be set for the Day unit, not in Hours</li>
55 </ul>
56 </li>
57     <li>The 'Overdue Fines Cap' is the maximum fine for this patron and item combination
58 <ul>
59     <li style="color: #990000;">Important: If this field is left blank then Koha will not put a limit on the fines this item will accrue. A maximum fine amount can be set using the MaxFine system preference.</li>
60 </ul>
61 </li>
62     <li>If your library 'fines' patrons by suspending their account you can enter the number of days their fine should be suspended in the 'Suspension in Days' field
63 <ul>
64     <li style="color: #990000;">Important: This can only be set for the Day unit, not in Hours</li>
65 </ul>
66 </li>
67     <li>You can also define the maximum number of days a patron will be suspended in the 'Max suspension duration' setting</li>
68     <li>Next decide if the patron can renew this item type and if so, enter how many times they can renew it in the 'Renewals Allowed' box</li>
69     <li>If you're allowing renewals you can control how long the renewal loan period will be (in the units you have chosen) in the 'Renewal period' box</li>
70     <li>If you're allowing renewals you can control how soon before the due date patrons can renew their materials with the 'No renewals before' box.
71     <ul><li>Items can be renewed at any time if this value is left blank. Otherwise items can only be renewed if the item is before the number in units (days/hours) entered in this box.</li></ul></li>
72     <li>You can enable automatic renewals for certain items/patrons if you'd like. This will renew automatically following your circulation rules unless there is a hold on the item
73     <ul>
74     <li style="color: #990000;">Important: You will need to enable the automatic renewal cron job for this to work.</li>
75     <li style="color: #990000;">Important: This feature needs to have the "no renewal before" column filled in or it will auto renew everyday after the due date.</li>
76     </ul>
77     </li>
78     <li>If the patron can place holds on this item type, enter the total numbers of items (of this type) that can be put on hold in the 'Holds Allowed' field</li>
79     <li>Next you can decide if this patron/item combo are allowed to place holds on items that are on the shelf (or available in the library) or not. If you choose 'no' then items can only be placed on hold if checked out</li>
80     <li>You can also decide if patrons are allowed to place item specific holds on the item type in question. The options are:
81     <ul>
82     <li>Allow: Will allow patrons the option to choose next available or item specific</li>
83     <li>Don't allow: Will only allow patrons to choose next available</li>
84     <li>Force: Will only allow patrons to choose an specific item</li>
85     </ul></li>
86     <li>Finally, if you charge a rental fee for the item type and want to give a specific patron category a discount on that fee, enter the percentage discount (without the % symbol) in the 'Rental Discount' field</li>
87 </ul>
88
89 <p>When finished, click 'Add' to save your changes. To modify a rule, create a new one with the same patron category and item type. If you would like to delete your rule, simply click the 'Delete' link to the right of the rule.</p>
90
91 <p>To save time you can clone rules from one library to another by choosing the clone option above the rules matrix.</p>
92
93 <p>After choosing to clone you will be presented with a confirmation message.</p>
94
95 <h4>Default Checkouts and Hold Policy</h4>
96
97 <p>You can set a default maximum number of checkouts and hold policy that will be used if none is defined below for a particular item type or category.</p>
98
99 <p>From this menu you can set a default to apply to all item types and patrons in the library.</p>
100
101 <ul>
102     <li>In 'Total Current Checkouts Allowed' enter the total number of items patrons can have checked out at one time</li>
103     <li>Control where patrons can place holds from using the 'Hold Policy' menu
104 <ul>
105     <li>From Any Library: Patrons from any library may put this item on hold. (default if none is defined)</li>
106     <li>From Home Library: Only patrons from the item's home library may put this book on hold.</li>
107     <li>No Holds Allowed: No patron may put this book on hold.</li>
108 </ul>
109 </li>
110     <li>Control where the item returns to once it is checked in
111 <ul>
112     <li>Item returns home</li>
113     <li>Item returns to issuing library</li>
114     <li>Item floats
115 <ul>
116     <li>When an item floats it stays where it was checked in and does not ever return 'home'</li>
117 </ul>
118 </li>
119 </ul>
120 </li>
121         <li>Once your policy is set, you can unset it by clicking the 'Unset' link to the right of the rule</li>
122 </ul>
123
124 <h4>Checkouts Per Patron</h4>
125
126 <p>For this library, you can specify the maximum number of loans that a patron of a given category can make, regardless of the item type.</p>
127
128 <p>Tip: If the total amount loanable for a given patron category is left blank, no limit applies, except possibly for a limit you define for a specific item type.</p>
129
130 <h4>Item Hold Policies</h4>
131
132 <p>For this library, you can edit rules for given itemtypes, regardless of the patron's category. Currently, this means hold policies.</p>
133
134 <p>The various Hold Policies have the following effects:</p>
135
136 <ul>
137     <li>From Any Library: Patrons from any library may put this item on hold. (default if none is defined)</li>
138     <li>From Home Library: Only patrons from the item's home library may put this book on hold.</li>
139     <li>No Holds Allowed: No patron may put this book on hold.</li>
140 </ul>
141
142 <p style="color: #990000;">Important: Note that if the system preference AllowHoldPolicyOverrideset to 'allow', these policies can be overridden by your circulation staff.</p>
143
144 <p style="color: #990000;">Important: These policies are based on the patron's home library, not the library that the reserving staff member is from.</p>
145
146 <p>The various Return Policies have the following effects:</p>
147
148 <ul>
149     <li>Item returns home: The item will prompt the librarian to transfer the item to its home library
150 <ul>
151     <li style="color: #990000;">Important: If the AutomaticItemReturnpreference is set to automatically transfer the items home, then a prompt will not appear</li>
152 </ul>
153 </li>
154     <li>Item returns to issuing library: The item will prompt the librarian to transfer the item back to the library where it was checked out
155 <ul>
156     <li style="color: #990000;">Important: If the AutomaticItemReturnpreference is set to automatically transfer the items home, then a prompt will not appear</li>
157 </ul>
158 </li>
159     <li>Item floats: The item will not be transferred from the library it was checked in at, instead it will remain there until transferred manually or checked in at another library</li>
160 </ul>
161
162 <p><strong>See the full documentation for Circulation and Fine Rules in the <a href="http://koha-community.org/manual/[% helpVersion %]/html/administration.html#circulation-and-fine-rules">manual</a> (online).</strong></p>
163
164 [% INCLUDE 'help-bottom.inc' %]