Changing Circulation Rules
Let's take a look at what happens when you change your circulation and fine rules and discuss how Koha receives the data and processes a circulation transaction.
At checkout
When you scan a barcode into the checkout box, Koha zips through a lot of data to decide what to do. Figuring out which circulation rule to use starts with the system preference CircControl.
If we’re setting up different circulation rules for different branches, we need to tell Koha how to decide which library to use. Imagine you have a patron from Branch A who put a hold on an item from Branch B and set it for pickup at Branch C - those could be three totally different sets of rules! CircControl lets us decide whether we want to use the circ rules for the patron’s library, the item’s library, or the library at which the checkout is happening.
If CircControl is set to the item’s library, then you must also set the system preference HomeOrHoldingBranch.
Every item has a home branch (where it lives) and a holding branch (where it is right now), so Koha needs to know which one of those to use.
Once the branch question has been settled, it’s time to pick a specific circulation rule. That means finding an item type and a patron category. Based on those, Koha finds a circulation rule and, assuming the checkout is allowed, creates an entry in the issues table.
We store the itemnumber, the borrowernumber, and the branchcode for the branch at which the checkout happened so we can find the circulation rule again, but we don’t store anything about the rule itself. We store the issuedate and the datedue, but not anything about how the latter was calculated or what might happen when we get to or past that datedue.
There’s a bit of an outlier here, though. That’s the auto_renew field. At the moment of checkout, Koha checks whether the rule it’s using says yes or no for auto-renewal and records that in the transaction (1 for yes, 0 for no). That determines this checkout’s auto-renewal behavior for the rest of its life, even if the rule later changes. Auto-renew behavior can also be set manually at checkout using the Automatic Renewal checkbox in the checkout screen. Checking this box records a 1 in issues.auto_renew, setting this checkout to auto-renew, regardless of the circ rule used.
After checkout
Given that we store only the bare minimum of information about a checkout, much of the process outlined above gets repeated many times in the course of a checkout’s life. For example, each time the fines cron job runs, it uses the system preferences mentioned above to pick which branch’s rules to follow and then uses the itemnumber and borrowernumber recorded in the issues table to figure out what rule to use based on the item type and patron category. That means that any changes to those system preferences, edits to the item or patron, or changes to the rule between checkout and a run of the fines cron will change what the fines cron does.
For a more specific example, suppose a library does not charge their staff any late fines. A staff member has a book that is 3 weeks overdue but has been charged no fines, based on the circ rules for staff members. But then the staff member retires and their patron category is changed from staff to patron. The next morning, when the fines cron runs, it sees a patron with a book that is 3 weeks and 1 day overdue and assesses an overdue fine for that whole period. The fines process has no concept of the history of this checkout - it just uses the facts as they exist in that moment to calculate what the fines should be.
- Fines: fine amount, fine charging interval, when to charge, fine grace period, overdue fines cap, cap fine at replacement price
- Renewal: renewals allowed, renewal period, no renewal before, no automatic renewal after
Any changes to those fields in your circulation rules will apply to any future interactions with existing checkouts. Additionally, any changes to your items, patrons, or CircControl and HomeOrHolding system preferences could change which rule is used, even if the rules themselves stay the same.
Automatic renewal
Once again, automatic renewal works a little bit differently. As noted above, the part of your circulation rule that determines whether or not a given item will automatically renew is consulted at checkout, and the decision made at that time persists throughout the checkout period. More specifically, this decision is whether or not the auto-renew cron should look at this checkout when it runs. However, once the cron has decided to look at a given checkout, it uses the other parts of your circulation rule (renewals allowed, renewal period, no renewal before, and no automatic renewal after) to decide whether or not the item can be renewed that day and, if so, how long it should renew for. So changing the Automatic Renewal yes/no rule will not change the behavior of existing checkouts, but changing the other renewal-related parts of your circulation rule will.
One caveat here, though: Koha allows patrons to opt out of auto-renewal.
The auto renewal feature doesn't change how your circulation rules work or what gets recorded in the issues table. At time of checkout, Koha still looks at the circulation rules to decide whether to put a 1 or a 0 in issues.auto_renew. The ability for patrons to opt out of auto-renewal adds another check to the auto-renew cron. Now the cron will only look at checkouts where issues.auto_renew=1 and the patron has not opted out of auto-renew. Whenever a patron changes their auto-renew opt out setting, that change applies to all of their existing checkouts and will apply to the next run of the auto-renew cron.
At check in
If you have the system preference CalculateFinesOnReturn set to “Do,” Koha checks your circulation rules one last time when an item gets checked in.
If you’ve changed your circulation rules since this item was checked out (or even since the last time the fines cron ran), the final fine for this item will be calculated using the circ rules as they exist at the moment of checkin. Similarly, if the item or patron have changed such that they should follow a different rule than the one used at checkout, their final fine will be calculated using that new rule.
Related Articles
Circulation Rules Default Policies
In addition to the circulation and fine matrix, the Default Policies control other aspects of circulation. Koha reads the Default Policies from the bottom of the page to the top. Default checkout, hold, and return policy You can set a default maximum ...Grouping Item Types in Circulation Rules
Parent and Child item types allow you to create combined rules to incorporate several item type rules together. In the circulation and fine rule matrix, there is the ability to limit the number of checkouts by item type. However, a further option ...Circulation and Fine Rule Matrix
Koha reads the circulation matrix from the top to the bottom. The bottom rule is usually (and recommended) to have what is called an ALL/ALL rule. This rule will capture any combination of patron category/item type that does not have its own specific ...Koha Offline Circulation Tool
The Koha Offline Circulation Tool that was created by Kyle Hall for Windows. The offline circulation tool for Windows will generate a KOC (koha offline circulation) file that you can upload into Koha once your system comes back up. This tool works ...Item Types in Koha
One of the key components of your library's collection will be the Item Type designation. Item types are a way for your patrons to identify what the item is and more importantly to Koha how this item circulates in your library. Here is a link to the ...