Skip to content

bywatersolutions/koha-plugin-ums-gentle-nudge-multi

Repository files navigation

Unique Collections plugin for Koha

This plugin automates the process of sending patrons to the UMS collections service and updating those patrons in Koha.

What is ByWater Solutions’ UMS Gentle Nudge plugin?

Gentle Nudge is a product offered by Unique Management Services to assist libraries with the recovery of overdue material and unpaid fines. ByWater’s Gentle Nudge plugin will generate and send reports of patrons to UMS. UMS then contacts those patrons and ‘nudges’ them to return to the library to pay their fines and/or return materials. UMS does not ‘collect’ on behalf of the library.

This plugin allows for configuration on a per library or per library group basis. The most specific (branch) configuration will be used if it exists, if it doesn't exist, group will be used, and default if there's not a branch or group configuration.

Reports sent to UMS:

  1. New submission report: A weekly report of ‘new’ patrons that qualify for collections based on the specified criteria of minimum balance, patron types, account age, etc.
  2. Update report: A report sent daily that monitors previously referred/active accounts for changes in account balance. This report keeps UMS current on patron balances for active collection accounts.
  3. Synchronization report: This is the same as the Update report above and can be generated manually at any time by clicking the ‘Sync’ button on the plugin configuration page. This report sends the patron ID, patron name and total amount owed. Unique uses this report to query against our database to look for balance discrepancies and is useful for troubleshooting or catching up missed update or submission files.

The plugin will automatically flag patrons who meet specific requirements as being in collections and optionally add a processing fee and restrict their account. Once a patron clears their account by paying their fines to 0, the plugin can optionally automatically clear the collections flag. At this time, the patron’s account restriction must be manually removed by library staff.

How to set up the plugin:

Downloading

From the release page you can download the latest release in kpz format.

Installation

The plugin requires the Perl library Text::CSV::Slurp. Please install this library before installing the plugin.

Cronjob

This plugin uses Koha's nightly plugin cronjob system. You can set some environment variables to affect the behavior of this plugin:

  • UMS_COLLECTIONS_DEBUG - Set to 1 to unable debugging messages
  • UMS_COLLECTIONS_NO_EMAIL - Set to 1 to test without sending email
  • UMS_COLLECTIONS_ARCHIVES_DIR - Set to a path to keep copies of the files sent to UMS

Configurations:

On what day of the week would you like new submissions sent to Unique?

Choose a single day of the week to report new patrons in collections to Unique. Any day of the week can be selected.

What patron categories are eligible for collections?

Select the Koha category codes for the patrons that can be sent to collections. You can select as many category codes as you need. If this field is left blank, all patron categories will be included.

Threshold: at what amount owed should patrons be sent to collections?

This is the minimum amount owed by a single patron that will move them to collections.

Processing fee: what fee, if any, should be applied to patrons’ accounts when they are sent to collections?

If you charge the patron an additional fee when they are moved to collections, enter it here. It will be added to the patron’s account as a line item.

Unique email: to what email address with UMS would you like the report sent?

This email will be provided to you by Unique Management Systems. It is the email address at which they will receive the weekly, daily, and sync reports from Koha.

Collections flag: How are you identifying patrons in collections?

This is the field that Koha will use to mark patrons as being in collections. Sort1, Sort2, or a Patron Attribute are often used. Your Data Librarian and Educator will discuss the options with you.

Count fees newer/older than

These parameters establish the age of fees that Koha will review in determining collection status for new submissions and updates, i.e. the total fees between X and Y days old to check if a patron should be sent to collections. The default values are older than 60, newer than 90.

Clear collections flag

If you would like the collections flag automatically cleared for patrons who have paid their balance to 0, check this box.

Add Restriction

If your library restricts patrons while they are in collections, check the box. Remember that while the collections flag can be set to clear automatically, restrictions must be manually cleared.

Age Limitation

If your library would prefer to exclude minors under the age of 18 from being sent to collections then check the box. Remember that this is dependent on having a birthdate available for the patron.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors