Merge remote-tracking branch 'origin/new/bug_7747'
[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 <ul>
8     <li><em>Get there:</em> More &gt; Administration &gt; Patrons &amp; Circulation &gt; Circulation and fines rules</li>
9 </ul>
10
11 <p>The rules are applied from most specific to less specific, using the first found in this order:</p>
12
13 <ul>
14         <li>same library, same patron type, same item type</li>
15         <li>same library, same patron type, all item type</li>
16         <li>same library, all patron types, same item type</li>
17         <li>same library, all patron types, all item types</li>
18         <li>all libraries, same patron type, same item type</li>
19         <li>all libraries, same patron type, all item types</li>
20         <li>all libraries, all patron types, same item type</li>
21         <li>all libraries, all patron types, all item types</li>
22 </ul>
23
24 <p style="background-color: #ffe599;">Tip: 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)
25
26 <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 types 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 types to avoid this holds issue. Koha needs to know what rule to fall back on.
27
28 <h3>Default Circulation Rules</h3>
29
30 <p>Using the issuing rules matrix you can define rules that depend on patron/item type combos. To set your rules, choose a library from the pull down (or 'all libraries' if you want to apply these rules to all branches)</p>
31
32 <p>From the matrix you can choose any combination of patron categories and item types to apply the rules to</p>
33
34 <ul>
35         <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>
36         <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>
37         <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>
38      <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>
39     <li>Choose which unit of time, Days or Hours, that the loan period and fines will be calculate in</li>
40         <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>
41    <li>'Fine Amount' should have the amount you would like to charge for overdue items
42 <ul>
43        <li style="color: #990000;">Important: Enter only numbers and decimal points (no currency symbols).</li>
44
45 </ul>
46 </li>
47   <li>Enter the 'Fine Charging Interval' in the unit you set (ex. charge fines every 1 day, or every 2 hours)</li>
48        <li>The 'Fine Grace Period' is the period of time an item can be overdue before you start charging fines.
49 <ul>
50  <li style="color: #990000;">Important: This can only be set for the Day unit, not in Hours</li>
51 </ul>
52 </li>
53     <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
54 <ul>
55  <li style="color: #990000;">Important: This can only be set for the Day unit, not in Hours</li>
56 </ul>
57 </li>
58     <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>
59     <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>
60  <li>Finally, if you charge a rental fee for the item type and want to give a specific patron type a discount on that fee, enter the percentage discount (without the % symbol) in the 'Rental Discount' field</li>
61 </ul>
62
63 <p>When finished, click 'Add' to save your changes. To modify a rule, create a new one with the same patron type and item type. If you would like to delete your rule, simply click the 'Delete' link to the right of the rule.</p>
64
65 <p>To save time you can clone rules from one library to another by choosing the clone option above the rules matrix.</p>
66
67 <p>After choosing to clone you will be presented with a confirmation message.</p>
68
69 <h3>Default Checkouts and Hold Policy</h3>
70
71 <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>
72
73 <p>From this menu you can set a default to apply to all item types and patrons in the library.</p>
74
75 <ul>
76   <li>In 'Total Current Checkouts Allowed' enter the total number of items patrons can have checked out at one time</li>
77  <li>Control where patrons can place holds from using the 'Hold Policy' menu
78 <ul>
79        <li>From Any Library: Patrons from any library may put this item on hold. (default if none is defined)</li>
80     <li>From Home Library: Only patrons from the item's home library may put this book on hold.</li>
81        <li>No Holds Allowed: No patron may put this book on hold.</li>
82 </ul>
83 </li>
84     <li>Control where the item returns to once it is checked in
85 <ul>
86        <li>Item returns home</li>
87      <li>Item returns to issuing branch</li>
88         <li>Item floats
89 <ul>
90    <li>When an item floats it stays where it was checked in and does not ever return 'home'</li>
91 </ul>
92 </li>
93 </ul>
94 </li>
95         <li>Once your policy is set, you can unset it by clicking the 'Unset' link to the right of the rule</li>
96 </ul>
97
98 <h3>Checkouts Per Patron</h3>
99
100 <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>
101
102 <p style="background-color: #ffe599;">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>
103
104 <h3>Item Hold Policies</h3>
105
106 For this library, you can edit rules for given itemtypes, regardless of the patron's category. Currently, this means hold policies.
107
108 <p>The various Hold Policies have the following effects:</p>
109
110 <ul>
111    <li>From Any Library: Patrons from any library may put this item on hold. (default if none is defined)</li>
112     <li>From Home Library: Only patrons from the item's home library may put this book on hold.</li>
113        <li>No Holds Allowed: No patron may put this book on hold.</li>
114 </ul>
115
116 <p style="color: #990000;">Important: Note that if the system preference AllowHoldPolicyOverride set to 'allow', these policies can be overridden by your circulation staff.</p>
117
118 <p style="color: #990000;">Important: These policies are based on the patron's home branch, not the branch that the reserving staff member is from.</p>
119
120 <p>The various Return Policies have the following effects:</p>
121
122 <ul>
123  <li>Item returns home: The item will prompt the librarian to transfer the item to its home library
124 <ul>
125         <li style="color: #990000;">Important: If the AutomaticItemReturn preference is set to automatically transfer the items home, then a prompt will not appear</li>
126 </ul>
127 </li>
128    <li>Item returns to issuing branch: The item will prompt the librarian to transfer the item back to the library where it was checked out
129 <ul>
130   <li style="color: #990000;">Important: If the AutomaticItemReturn preference is set to automatically transfer the items home, then a prompt will not appear</li>
131 </ul>
132 </li>
133    <li>Item floats: The item will not be transferred from the branch it was checked in at, instead it will remain there until transferred manually or checked in at another branch</li>
134 </ul>
135
136 <p><strong>See the full documentation for Circulation and Fine Rules in the <a href="http://manual.koha-community.org/3.8/en/patscirc.html#circfinerules">manual</a> (online).</strong></p>
137
138 [% INCLUDE 'help-bottom.inc' %]