Patron-import Koha plugin

Patron-import is a plugin for Koha allowing configurable, customizable and automated patrons import.

Current versions

• 18.05-1.x => Koha 18.05.xx, 18.11.xx and 19.05.xx
• 19.11-1.x => Koha 19.11.xx
• 20.05-1.x => Koha 20.05.xx
• 20.11-1.x => Koha >= 20.11.xx
• 21.05-1.x => Koha >= 21.05.xx
• 21.11-1.x => Koha >= 21.11.xx
• 22.11-2.x => Koha >= 22.11.xx
• master => Koha latest version

This documentation is for master version

Downloading

From the release page, download the relevant .kpz file

Getting started

Before (project management)

Start importing patrons in a Koha system needs advance preparation. All the things you need to draft is explain is the before starting page.

Setup

Once the plugin is installed, you can access the plugin's configuration in the Koha's plugins home page.

• find the Patron import plugin in the table
• click on Action -> configure

Here you can add one or more imports and see existing ones. Click on New import and fill the form as you need

• The Import name can be what you want
• There is 2 options in Flow type but only CSV file is currently usable
• All other form element are described

Configuration

• Create new import
• Define mappings
  • Field mappings
  • Value mappings
  • Transformation plugins
  • Matching points
• Protected and erasables fields
• Default values
• Exclusions
• Deletions
• Debarments
• Extended attributes

Plugins (add-ons)

• Create an add-on
• Install / use add-on

Cronjob

Cronjob should be executed daily, preferably at night to prevent interfere with Koha's normal use.

Example:

PERL5LIB=/path/to/koha
KOHA_CONF=/path/to/koha-conf.xml
PATH_TO_PLUGIN=/path/to/plugin

0 23 * * * perl $PATH_TO_PLUGIN/Koha/Plugin/Com/Biblibre/PatronImport/cron/run-import.pl -i 1 -f /path/to/patrons.csv