Koha plugins

From Koha Wiki
Jump to navigation Jump to search

Plugins for use with Koha

Also the manual covers plugins in detail: Plugin system

Plugins are used by Koha in different ways:

  • A full fledged app that has its own controller script and is integrated with Koha by the use of the core libraries (for example the Coverflow plugin, which requires setting an Apache alias to a shipped script).
  • Implementing API routes that are injected into Koha's core API extending it
  • Using Koha Plugin Hooks in specific places

Plugin development

If you are interested in developing a Koha plugin visit the Koha plugin development reference.

Also, a good reference is the Kitchen Sink plugin which implements every feature of the plugin system. It includes a reference gitlab-ci file for reusing it on your project.

You can also use GitHub Actions to automatically build and release your kpz files for you, using this guide.

For plugins that don't include static files served to the user (such as REST API plugins), you can also use a simplified Travis CI build to automatically build and release your kpz files for you, using this guide.

Plugins

Acquisitions plugins

  • Donor Tracking - This is a plugin used to track donor contributions and contacts. More information at Donor Tracking wiki
  • Enhanced Edifact plugin - A Koha Edifact plugin that replicates the existing Order file behavior with additional options.
  • GOBI Integration plugin - This plugin is designed to provide an easy integration for the GOBI Library Solutions from EBSCO.
  • Vendor Acquisition Plugin - This plugin facilitates receiving acquisition orders from a vendor, where the order is initiated at the vendor's site. The vendor must implement the protocol of this plugin.

Authorities plugins

Cataloging plugins

  • Add URLs to MARC - This plugin provides a way for importing URLs into MARC records in Koha.
  • CLA Check Permissions plugin - Allows you to make queries to the CLA Check Permissions service for biblios within your catalog.
  • Deduplication Tool - This plugin aims to make the process of deduplicating records more friendly and faster.
  • Ebook Deleter - This plugin assists in batch deleting ebook records.
  • Force Delete Record - Koha tool plugin to forcefully delete records that you cannot access in Koha due to record corruption.
  • Generate Cover from PDF - This plug-in creates a cover image for documents missing one, using the first page of a PDF file associated to the 856$u subfield.
  • Item Barcode plugin - This plugin makes cataloguing an item painless. It will make Koha request a 'fresh' barcode on saving the item.
  • LTI Import plugin - A plugin for staging LTI MARC import files. It implements a configurable overlay behavior policy.
  • Record Merger - This plugin takes a CSV file of biblionumbers and merges all records in a row into the record specified in the first column.
  • Show subordinate items - Plugin Conditionaly creates a tab in catalogue/detail.pl showing subordinate-items via MARC 773 18 w (by MarkHofstetter/HKS3, Sponsored-by: Styrian State Library)
  • Undelete Records - This plugin allows you to undelete records and their items that you have deleted by mistake.
  • UpdateMarcFields - This plugin provides a way to append data fields in Koha MARC records optionally based on a regex criteria. It also provides the ability to delete data fields based on a regex expression
  • Austlang - This plugin adds a new cronjob that can be scheduled to regularly load Indigenous Australian languages (Austlang) data from an external source, process it, then create or update authorised values of this data. When installed, it adds an AUSTLANG authorised value category which can be used for the Austlang data.

Circulation plugins

  • Capita Pay360 plugin - This is a plugin for Koha which enables the use of Capita Pay360 for online payments.
  • Change Due Date - This plug-in allows you to modify loan due dates in batch mode from one or more filters.
  • Curbside Pickup plugin - A plugin to enable curbside pickup of holds in Koha.
  • Interlibrary Loans Koha Backend - This backend provides the ability to create Interlibrary Loan requests by searching other Koha instances.
  • INN-Reach plugin - INN-Reach inter-library loan service integration plugin for Koha.
  • Inter-Library Loan - The Inter-Library Loan (ILL) plugin allows users to send a loan request for an unavailable item to their library so that it can make a manual request.
  • Item Recall plugin - A Koha plugin that adds the ability to place recalls on items. Demo
  • Paypal plugin - This plugin adds PayPal payments to the OPAC interface.
  • Rolling Hard Due Dates - Koha tool plugin to batch modify hard due date rules and hard due dates on existing checkouts.
  • Rule Hard Due Dates - This plugin allows you to set a specific hard due date for a selected branch, patron category and item type.
  • Special Reserves - Plugin that sends an email to the library to reserve an item that cannot normally be reserved from the OPAC
  • Unpaywall ILL plugin - This plugin provides ILL availability searching for the Unpaywall API.
  • WPM Online Payments plugin - Enables a library to accept online payments from patrons using the WPM payments platform.
  • z39.50 ILL availability plugin - An availability plugin for the Koha ILL availability searching.
  • EDS ILL availability plugin - This plugin provides ILL availability searching for EDS (Ebsco Discovery Service).
  • Putaside plugin - Staff people can put aside a patron checked out item for the same patron.

Library event management plugins

  • LMSEventManagement - This plugin enables you to manage events your institution in the intranet interface and present them to your patrons in the OPAC interface.

Library space management plugins

OPAC plugins

Patron plugins

  • Koha Batch Permissions Modifier plugin - This plugin allows librarians to use arbitrary patron accounts as 'templates' for setting the user permissions of other patrons via patron lists. Demo
  • Merge Users - This plugin lets merge users, combining their issues, holds and fines.
  • Messaging Preferences plugin - This extension lets you change the messaging preferences of your users. The preferences used are defined for each patron categories, from the page Patron categories, section Patrons and circulation in the Administration module.
  • Peoplesoft import for Koha - Koha plugin to convert CSV file of peoplesoft data to Koha patron CSV file.
  • User Permissions plugin - Koha plugin to display users with permissions.

Reports plugins

  • Batch Search Report - Plugin to return search results from Koha given a list of terms.
  • Counters - Display counters of things happening in the library (currently loans and searches) on screen in the library.
  • DLL Statistics plugin - Koha plugin for DLL statistics.
  • MARC Checker - This plugin will check a range of Koha records using MARC::Lint and tell you if they are not well formatted.
  • Matomo plugin - Koha plugin for Matomo on OPAC.
  • Merge Reports - This plugin let’s combine multiple reports into one, presenting it in a single unified HTML page, organized in customizable sections.
  • Patron Last Activity - Koha report plugin to show the last time a patron was active.
  • Records by Biblionumber - Koha plugin to download records by an arbitrary list of biblionumbers.
  • Report Plus - Plugin to allow for more options for reports
  • Report Table - This plugin contains a script that will generate an html table from a report to be used on public displays.
  • Stat Chart - This plugin lets you generate charts presenting statistics about various elements of your network.
  • Storage plugin - This plugin is designed to provide some helpers for working with a remote storage facility.
  • Widgets plugin - A plugin for generating HTML widgets from reports and notices using the REST API.

Staff interface plugins

Tools plugins

  • Check SMS Numbers plugin - This Koha plugin gives ability to test the format of SMS numbers in database.
  • Label Maker - An alternative label creator for Koha powered by HTML and CSS Demo
  • Patron Overdue Notices plugin - This plugin will allow a librarian to create a set of overdue notices to print and mail based on a set of criteria the librarian may select.
  • Shelfreading plugin - Allows inventory and shelf order to be updated and evaluated in real time. Item is marked with current date in datelastseen field, lost items are marked as not lost. Items are checked for correct collection and shelving location, and for correct order in either LCC or alphanumeric order.
  • Plugin Lists Creator - This plugin is intended to create shelves dynamically from an excel file.
  • Plugin Lists Manager - This plugin is intended to remove lists in batch mode.
  • Plugin Export - This plugin is intended to create jobs for export records in Koha.

See also

Translating plugins

While there is no standard way of translating plugins yet, an interesting example can be found in this plugin koha-plugin-pay-via-paypal

Koha::I18N may also be useful in the future.


Developer handbook

Retrieved from "https://wiki.koha-community.org/w/index.php?title=Koha_plugins&oldid=33695"