The functions in this module deal with the monetary aspect of Koha, including looking up and modifying the amount of money owed by a patron.

Used By
C4::Circulation::Fines
C4::Overdues
members/maninvoice.pl
members/mancredit.pl
members/pay.pl
misc/tidyaccounts.pl

Test script
t/Accounts.t

Koha functions for dealing with orders and acquisitions

Used By
acqui/basket.pl
acqui/neworderempty.pl
acqui/booksellers.pl
acqui/finishreceive.pl
acqui/currency.pl
acqui/addorder.pl
acqui/acqui-home.pl
acqui/lateorders.pl
acqui/supplier.pl
acqui/orderreceive.pl
acqui/parcels.pl
acqui/histsearch.pl
acqui/parcel.pl
admin/aqbudget.pl
authorities/auth_finder.pl
authorities/authorities-home.pl
barcodes/label-item-search.pl
catalogue/moredetail.pl
catalogue/MARCdetail.pl
catalogue/suggest.pl
members/member-flags.pl
opac/opac-MARCdetail.pl
opac/opac-main.pl
opac/opac-ISBDdetail.pl
reports/borrowers_stats.pl
serials/routing-preview.pl
serials/subscription-copy.pl
serials/reorder_members.pl
serials/routing.pl
serials/claims.pl
serials/lateissues-excel.pl
serials/subscription-add.pl
serials/acqui-search-result.pl

Test script
t/Acquisition.t

Functions for retrieving Amazon.com content in Koha

Used By
opac/opac-detail.pl
opac/opac-ISBDdetail.pl

Test Script
t/Amazon.t

Module for dealing with MARC Authority data

Used By
C4::Biblio.pm

admin/thesaurus.pl
authorities/authorities.pl
authorities/auth_finder.pl
authorities/detail.pl
authorities/detail-biblio-search.pl
authorities/authorities-home.pl
authorities/blinddetail-biblio-search.pl
catalogue/dictionary.pl
cataloguing/value_builder/marc21_field_040c.pl
cataloguing/value_builder/marc21_field_040d.pl
cataloguing/value_builder/unimarc_field_210c.pl
mainpage.pl
misc/merge_authority.pl
misc/marc_into_authority.pl
misc/migration_tools/buildCOUNTRY.pl
misc/migration_tools/rebuild_zebra.pl
misc/migration_tools/rebuild_nozebra.pl
misc/migration_tools/check_marc_definition.pl
misc/migration_tools/buildEDITORS.pl
misc/migration_tools/22_to_30/export_Authorities_xml.pl
misc/migration_tools/22_to_30/export_Authorities.pl
misc/migration_tools/22_to_30/move_marc_to_authheader.pl
misc/migration_tools/build6xx.pl
misc/migration_tools/buildLANG.pl
misc/bulkauthimport.pl
misc/cronjobs/zebraqueue_start.pl
opac/opac-authoritiesdetail.pl
opac/opac-dictionary.pl
opac/opac-authorities-home.pl

Test Script
t/AuthoritesMarc.t

Responsible for handling the Authentication/Authorisation parts of Koha The main function of this module is to provide authentication. However the get_template_and_user function has been provided so that a users login information is passed along automatically. This gets loaded into the template.

Used By
Every script under the sun

Test Script
t/Auth.t

This module is specific to LDAP authentification. It requires Net::LDAP package and a working LDAP server. To use it :

• move initial Auth.pm elsewhere
• Search the string LOCAL
• modify the code between LOCAL and /LOCAL to fit your LDAP server parameters & fields
• rename this module to Auth.pm

That should be enough.

Test Script
t/Auth_with_ldap.t

This is currently failing its test

This package is used to deal with labels in a pdf file. Giving some parameters, this package contains several functions to handle every label considering the environment of the pdf file.

Used By
barcodes/barcodesGenerator.pl
barcodes/barcodes.pl
tools/barcodesGenerator.pl
tools/barcodes.pl

Test Script
t/Barcodes_PrinterConfig.t

Biblio.pm contains functions for managing storage and editing of bibliographic data within Koha. Most of the functions in this module are used for cataloging records: adding, editing, or removing biblios, biblioitems, or items. Koha's stores bibliographic information in three places:

1. in the biblio,biblioitems,items, etc tables, which are limited to a one-to-one mapping to underlying MARC data
2. as raw MARC in the Zebra index and storage engine
3. as raw MARC the biblioitems.marc and biblioitems.marcxml

Used By
C4::Breeding.pm
C4::Circulation.pm
C4::AuthoritiesMarc.pm
C4::Search.pm
C4::Z3950.pm
C4::Serials.pm
C4::Koha.pm
C4::BookShelves.pm
C4::Reserves.pm

acqui/updatesupplier.pl
acqui/neworderempty.pl
acqui/booksellers.pl
acqui/finishreceive.pl
acqui/neworderbiblio.pl
acqui/currency.pl
acqui/addorder.pl
acqui/newordersuggestion.pl
acqui/supplier.pl
acqui/parcel.pl
admin/checkmarc.pl
admin/koha2marclinks.pl
authorities/authorities.pl
authorities/authorities-home.pl
barcodes/label-item-search.pl
bookshelves/shelves.pl
bookshelves/addbookbybiblionumber.pl
catalogue/dictionary.pl
catalogue/moredetail.pl
catalogue/MARCdetail.pl
catalogue/ISBDdetail.pl
catalogue/detail.pl
catalogue/detailprint.pl
catalogue/suggest.pl
cataloguing/additem.pl
cataloguing/addbooks.pl
cataloguing/addbiblio.pl
cataloguing/z3950_search.pl
cataloguing/value_builder/unimarc_field_4XX.pl
circ/transferstoreceive.pl
circ/circulation.pl
circ/returns.pl
circ/branchoverdues.pl
circ/transferstodo.pl
circ/branchtransfers.pl
circ/waitingreserves.pl
circ/bookcount.pl
export/export.pl
export/marc.pl
export/export_filtered.pl
members/moremember.pl
misc/merge_authority.pl
misc/exportauth.pl
misc/cleanmarcdb.pl
misc/rebuildthesaurus.pl
misc/fines2.pl
misc/migration_tools/buildCOUNTRY.pl
misc/migration_tools/rebuild_zebra.pl
misc/migration_tools/bulkmarcimport.pl
misc/migration_tools/rebuild_zebra_idx.pl
misc/migration_tools/rebuild_nozebra.pl
misc/migration_tools/check_marc_definition.pl
misc/migration_tools/buildEDITORS.pl
misc/migration_tools/22_to_30/missing090field.pl
misc/migration_tools/22_to_30/rebuild_leader.pl
misc/migration_tools/22_to_30/rebuild_unimarc_100.pl
misc/migration_tools/22_to_30/move_marc_to_biblioitems.pl
misc/migration_tools/build6xx.pl
misc/migration_tools/check_dirs.pl
misc/migration_tools/buildLANG.pl
misc/xmlintobiblioitems.pl
misc/fines.pl
misc/rebuildnonmarc.pl
misc/marcimport_to_biblioitems.pl
misc/notifys/fines.pl
misc/missing090field.pl
misc/rebuild_marc_newframework.pl
misc/cronjobs/reservelist.pl
misc/cronjobs/build_browser_and_cloud.pl
misc/cronjobs/zebraqueue_start.pl
misc/cronjobs/test_zebra_delete.p
misc/cronjobs/update_items.pl
opac/opac-rss.pl
opac/opac-user.pl
opac/opac-detail.pl
opac/opac-showreviews.pl
opac/opac-sendbasket.pl
opac/opac-sendbasket.pl
opac/opac-tags_subject.pl
opac/opac-addbookbybiblionumber.pl
opac/opac-dictionary.pl
opac/opac-browser.pl
opac/opac-review.pl
opac/opac-basket.pl
opac/opac-MARCdetail.pl
opac/opac-ISBDdetail.pl
opac/opac-detailprint.pl
opac/opac-reserve.pl
reports/inventory.pl
reserve/request.pl
reserve/placerequest.pl
reviews/reviewswaiting.pl
serials/routing-preview.pl
serials/subscription-bib-search.pl
serials/serials-recieve.pl
serials/serials-edit.pl
serials/acqui-search-result.pl
tools/export.pl
tools/inventory.pl:use C4::Biblio;
tools/import.pl:use C4::Biblio;
tools/itemslost.pl:use C4::Biblio;

Test Script
t/Biblio.t:use C4::Biblio;

The functions in this modules deal with bookfund, currency and money. They allow to get and/or set some informations for a specific budget or currency.

Used By
acqui/basket.pl
acqui/neworderempty.pl
acqui/currency.pl
acqui/acqui-home.pl
acqui/supplier.pl
admin/aqbookfund.pl

serials/acqui-search.p

Test Script
t/Bookfund.t

The functions in this module deal with booksellers. They allow to add a new bookseller, to modify it or to get some information about a bookseller.

Used By
acqui/basket.pl
acqui/updatesupplier.pl
acqui/neworderempty.pl
acqui/booksellers.pl
acqui/neworderbiblio.pl
acqui/lateorders.pl
acqui/supplier.pl
acqui/orderreceive.pl
acqui/parcels.pl
acqui/parcel.pl
serials/claims.pl
serials/acqui-search-result.pl

Test Script
t/Bookseller.t

This module provides functions for manipulating virtual bookshelves, including creating and deleting bookshelves, and adding and removing items to and from bookshelves.

Used By
bookshelves/shelves.pl
bookshelves/addbookbybiblionumber.pl
opac/opac-addbookbybiblionumber.pl
opac/opac-shelves.pl
opac/opac-main.pl

Test Script
t/BookShelves.t
tests are failing

In the parameter table, there are various Boolean values that variously require a 0/1, no/yes, false/true, or off/on values. This module aims to provide scripts a means to interpret these Boolean values in a consistent way which makes common sense.

Used By
C4::Context

Test Script
t/Boolean.t

ImportBreeding import MARC records in the reservoir (marc_breeding table). The records can be properly encoded or not, we try to reencode them in utf-8 if needed. Works perfectly with BNF server, that sends UNIMARC latin1 records. Should work with other servers too. The FixEncoding sub is in Koha.pm, as it's a general usage sub.

Used By
cataloguing/addbooks.pl
cataloguing/z3950_search.pl
tools/breeding.pl
tools/import.pl

Test Script
t/Breeding.t

This package is used to deal with holidays. Through this package, you can set all kind of holidays for the library.

Used By
tools/holidays.pl
tools/newHolidays.pl
tools/exceptionHolidays.pl

Test Script
t/Calendar.t

The functions in this module deal with circulation, issues, and returns, as well as general information about the library. Also deals with stocktaking.

Used By

C4/Print.pm
C4/BookShelves.pm
C4/Overdues.pm
C4/Reserves.pm

bookshelves/addbookbybiblionumber.pl
catalogue/moredetail.pl
catalogue/issuehistory.pl
circ/transferstoreceive.pl
circ/circulation.pl
circ/returns.pl
circ/transferstodo.pl
circ/branchtransfers.pl
circ/waitingreserves.pl
circ/bookcount.pl
circ/selectbranchprinter.pl
members/moremember.pl
misc/fines2.pl
misc/notifys/printnote.pl
misc/notifys/fines.pl
misc/notifys/contact_history.pl
misc/cronjobs/notifyMailsOp.pl
opac/opac-user.pl
opac/opac-showreviews.pl
opac/opac-userupdate.pl
opac/opac-account.pl
opac/opac-addbookbybiblionumber.pl
opac/opac-shelves.pl
opac/opac-renew.pl
opac/opac-userdetails.pl
opac/opac-review.pl
opac/opac-passwd.pl
opac/opac-readingrecord.pl
opac/opac-reserve.pl
reports/bor_issues_top.pl
reports/cat_issues_top.pl
reports/borrowers_out.pl
reports/manager.pl
reports/acquisitions_stats.pl
reports/issues_stats.pl
reports/inventory.pl
reports/catalogue_stats.pl
reports/catalogue_out.pl
reports/borrowers_stats.pl
reports/issues_avg_stats.pl
reserve/renewscript.pl
reserve/request.pl
reserve/placerequest.pl
serials/routing-preview.pl
tools/cleanborrowers.pl

Test Script
t/Circulation.t

This module contains several functions for dealing with fines for overdue items. It is primarily used by the 'misc/fines2.pl' script.

is this module still in use?

Used By C4::Overdues

When a Koha script runs, it makes use of a certain number of things: configuration settings in /etc/koha.xml, a connection to the Koha databases, and so forth. These things make up the context in which the script runs. This module takes care of setting up the context for a script: figuring out which configuration file to load, and loading it, opening a connection to the right database, and so forth.

Used By
Everything

Test Script
t/Context.t

Module to handle formating of date strings.

Exported functions

• display_date_format
• get_date_format_string_for_DHTMLcalendar
• format_date
• format_date_in_iso
• fixdate

Used By Tons of things :)

Test Script
t/Date.t

This module provides functions to see whether a given library card number or ISBN is valid.

Used By
C4::Z3950

acqui/neworderempty.pl
members/memberentry.pl
members/borrowers_details.pl
tools/breeding.pl
tools/import.pl

Test Script
t/Input.t
tests failing

Module containing convenience functions for Koha scripts

Used By

Test Script
t/koha.t
tests failing

Functions for printing spine labels and barcodes in Koha

Used By
barcodes/label-print-opus-pdf.pl
barcodes/label-print-pdf.pl
barcodes/label-home.pl
barcodes/label-manager.pl

Test Script
t/Labels.t

Module containing language list functions for Koha

Used By
admin/systempreferences.pl
catalogue/search.pl
installer/install.pl
opac/opac-search.pl
opac/opac-main.pl:
tools/koha-news.pl

Test Script
t/Languages.t

“Letters” is the tool used in Koha to manage informations sent to the patrons and/or the library. This include some cron jobs like late issues, as well as other tasks like sending a mail to users that have subscribed to a “serial issue alert” ( being warned every time a new issue has arrived at the library)

Letters are managed through “alerts” sent by Koha on some events. All “alert” related functions are in this module too.

Used By
C4::Serials

acqui/lateorders.pl
members/moremember.pl
opac/opac-alert-subscribe.pl
opac/opac-user.pl
opac/opac-serial-issues.pl
serials/viewalerts.pl
serials/serials-collection.pl
serials/claims.pl
serials/subscription-add.pl
tools/overduerules.pl

Test Script
t/Letters.t

The functions in this module perform various functions in order to log all the operations done on the Database, including deleting and undeleting books, adding/editing members, etc.

Used By
C4::Biblio.pm
C4::Circulation
C4::Circulation::Fines
C4::Serials
C4::Letters
C4::Overdues
C4::Members

cataloguing/addbiblio.pl
members/memberentry.pl
members/borrowers_details.pl
tools/viewlog.pl

Test Script
t/Log.t

The functions in this module perform various catalog-maintenance functions, including deleting and undeleting books, fixing miscategorized items, etc.

Used By
Nothing — Deprecated???

Test Script
t/Maintainance.t

This module contains routines for adding, modifying and deleting members/patrons/borrowers

Used By
C4::Auth.pm
C4::Circulation
C4::Auth_with_ldap
C4::Letters.pm
C4::Accounts.pm
C4::Members.pm

acqui/neworderempty.pl
acqui/acqui-home.pl
acqui/orderreceive.pl
circ/transferstoreceive.pl
circ/circulation.pl
circ/returns.pl
circ/transferstodo.pl
circ/waitingreserves.pl
members/maninvoice.pl
members/readingrec.pl
members/guarantor_search.pl
members/member-password.pl
members/boraccount.pl
members/moremember.pl
members/deletemem.pl
members/memberentry.pl
members/borrowers_details.pl
members/mancredit.pl:
members/pay.pl
members/member.pl
members/member-flags.pl
members/moremember.pl
members/deletemem.pl
members/memberentry.pl
members/borrowers_details.pl
members/mancredit.pl
members/pay.pl
members/member.pl
members/member-flags.pl
misc/notifys/fines.pl
opac/opac-user.pl
opac/opac-detail.pl
opac/opac-userupdate.pl
opac/opac-account.pl
opac/opac-userdetails.pl
opac/opac-main.pl
opac/opac-ISBDdetail.pl
opac/opac-readingrecord.pl
opac/opac-reserve.pl
reports/bor_issues_top.pl
reports/cat_issues_top.pl
reports/borrowers_out.pl
reserve/request.pl
reserve/placerequest.pl
reviews/reviewswaiting.pl
serials/routing-preview.pl
serials/routing.pl
serials/distributedto.pl
serials/member-search.pl
tools/cleanborrowers.pl

Test Script
t/Members.t

This module provides the functions needed to admin the news channels and its categories

Used By
mainpage.pl
opac/opac-main.pl
tools/koha-news.pl

Test Script
t/NewsChannels.t

Functions for managing templates

Used By
Pretty much every script

Test Script
t/output.t

This module contains several functions for dealing with fines for overdue items. It is primarily used by the 'misc/fines2.pl' script.

Used By C4::Circulation::Fines
C4::Overdues
C4::Members

circ/branchoverdues.pl
members/pay.pl
misc/fines2.pl
misc/fines.pl
misc/notifys/printnote.pl
misc/notifys/fines.pl
misc/notifys/contact_history.pl

Test Script
t/Overdues.t

The functions in this module handle sending text to a printer.

Used By
circ/circulation.pl
circ/returns.pl
circ/selectbranchprinter.pl

Test Script
t/Print.t

New in Koha 3.x. This module handles all record-related management functions.

Used By Nothing?

Test Script
t/Record.t

This modules provides somes functions to deal with reservations.

Used By
C4::Biblio
C4::Circulation
C4::Reserves.pm
C4::Members.pm

circ/transferstoreceive.pl
circ/circulation.pl
circ/returns.pl
circ/transferstodo.pl
circ/branchtransfers.pl
circ/waitingreserves.pl
members/moremember.pl
opac/opac-user.pl
opac/opac-reserve.pl
reserve/modrequest.pl
reserve/request.pl
reserve/placerequest.pl
serials/routing-preview.pl

Test Script
t/Reserves.t

Review.pm provides many routines for manipulating reviews.

Used By
opac/opac-detail.pl
opac/opac-showreviews.pl
opac/opac-review.pl
opac/opac-ISBDdetail.pl
reviews/reviewswaiting.pl

Test Script
t\Review.t

This module provides the searching facilities for Koha.

Used By
C4::AuthoritiesMarc
C4::Serials
C4::Reserves

acqui/finishreceive.pl
acqui/neworderbiblio.pl
catalogue/dictionary.pl
catalogue/search.pl
cataloguing/addbooks.pl
cataloguing/addbiblio.pl
cataloguing/value_builder/marc21_leader_book.pl
cataloguing/value_builder/marc21_field_008_authorities.pl
cataloguing/value_builder/marc21_leader_computerfile.pl
cataloguing/value_builder/unimarc_leader.pl
cataloguing/value_builder/marc21_field_003.pl
cataloguing/value_builder/marc21_field_005.pl
cataloguing/value_builder/marc21_field_006.pl
cataloguing/value_builder/marc21_field_007.pl
cataloguing/value_builder/marc21_field_008.pl
cataloguing/value_builder/unimarc_field_115a.pl
cataloguing/value_builder/unimarc_field_115b.pl
cataloguing/value_builder/marc21_leader_authorities.pl
cataloguing/value_builder/unimarc_field_121a.pl
cataloguing/value_builder/unimarc_field_121b.pl
cataloguing/value_builder/unimarc_field_123a.pl
cataloguing/value_builder/unimarc_field_123d.pl
cataloguing/value_builder/unimarc_field_123e.pl
cataloguing/value_builder/unimarc_field_123f.pl
cataloguing/value_builder/unimarc_field_123g.pl
cataloguing/value_builder/unimarc_field_123i.pl
cataloguing/value_builder/unimarc_field_123j.pl
cataloguing/value_builder/unimarc_field_124a.pl
cataloguing/value_builder/unimarc_field_124b.pl
cataloguing/value_builder/unimarc_field_124c.pl
cataloguing/value_builder/unimarc_field_124d.pl
cataloguing/value_builder/unimarc_field_124e.pl
cataloguing/value_builder/unimarc_field_124f.pl
cataloguing/value_builder/unimarc_field_124g.pl
cataloguing/value_builder/unimarc_field_125a.pl
cataloguing/value_builder/unimarc_field_125b.pl
cataloguing/value_builder/unimarc_field_126a.pl
cataloguing/value_builder/unimarc_field_126b.pl
cataloguing/value_builder/unimarc_field_128a.pl
cataloguing/value_builder/unimarc_field_128b.pl
cataloguing/value_builder/unimarc_field_128c.pl
cataloguing/value_builder/unimarc_field_135a.pl
cataloguing/value_builder/unimarc_field_700-4.pl
cataloguing/value_builder/unimarc_field_700_701_702.pl
cataloguing/value_builder/marc21_field_040c.pl
cataloguing/value_builder/marc21_field_040d.pl
cataloguing/value_builder/usmarc_field_952v.pl
cataloguing/value_builder/unimarc_field_100.pl
cataloguing/value_builder/unimarc_field_105.pl
cataloguing/value_builder/unimarc_field_106.pl
cataloguing/value_builder/unimarc_field_110.pl
cataloguing/value_builder/unimarc_field_116.pl
cataloguing/value_builder/unimarc_field_117.pl
cataloguing/value_builder/unimarc_field_120.pl
cataloguing/value_builder/unimarc_field_122.pl
cataloguing/value_builder/unimarc_field_124.pl
cataloguing/value_builder/unimarc_field_125.pl
cataloguing/value_builder/unimarc_field_126.pl
cataloguing/value_builder/unimarc_field_127.pl
cataloguing/value_builder/unimarc_field_130.pl
cataloguing/value_builder/unimarc_field_140.pl
cataloguing/value_builder/unimarc_field_141.pl
cataloguing/value_builder/unimarc_field_210c.pl
cataloguing/value_builder/unimarc_field_225a.pl
cataloguing/value_builder/unimarc_field_60X.pl
cataloguing/value_builder/unimarc_field_4XX.pl
cataloguing/value_builder/marc21_leader_video.pl
cataloguing/value_builder/marc21_leader.pl
misc/cronjobs/zebraqueue_start.pl
opac/opac-rss.pl
opac/opac-search.pl
opac/opac-topissues.pl
opac/opac-dictionary.pl
reports/itemtypes.plugin
reports/issues_by_borrower_category.plugin
serials/subscription-bib-search.pl

Test Script
t/Search.t

Functions for dealing with serials, and serial subscriptions

Used By
catalogue/MARCdetail.pl
catalogue/ISBDdetail.pl
catalogue/detail.pl
opac/opac-alert-subscribe.pl
opac/opac-detail.pl
opac/opac-ISBDdetail.pl
opac/opac-serial-issues.pl
serials/routing-preview.pl
serials/checkexpiration.pl
serials/subscription-renew.pl
serials/viewalerts.pl
serials/subscription-copy.pl
serials/serials-collection.pl
serials/reorder_members.pl
serials/serials-home.pl
serials/statecollection.pl
serials/routing.pl
serials/claims.pl
serials/lateissues-excel.pl
serials/serial-issues.pl
serials/subscription-add.pl
serials/serials-recieve.pl
serials/distributedto.pl
serials/subscription-detail.pl
serials/serials-edit.pl

Test Script
t/Serials.t

Update Koha statistics (log)

Used By
C4/Circulation
C4/Accounts

circ/stats.pl
members/pay.pl
reports/stats.print.pl
reports/reservereport.pl

Test Script
t/Stats.t

The functions in this module deal with the suggestions in OPAC and in librarian interface A suggestion is done in the OPAC. It has the status “ASKED” When a librarian manages the suggestion, he can set the status to “REJECTED” or “ACCEPTED”. When the book is ordered, the suggestion status becomes “ORDERED” When a book is ordered and arrived in the library, the status becomes “AVAILABLE” All suggestions of a borrower can be seen by the borrower itself. Suggestions done by other borrowers can be seen when not “AVAILABLE”

Used By
C4/Acquisition
C4/Serials
C4/Letters

acqui/neworderempty.pl
acqui/addorder.pl
acqui/acqui-home.pl
acqui/newordersuggestion.pl
opac/opac-suggestions.pl
suggestion/acceptorreject.pl

Test Script
t/Suggestions.t

This module contains functions for looking up Z39.50 servers, and for entering Z39.50 lookup requests.

Used By
Nothing ?

Test Script
t/Z3950.t