biblibre / koha-plugin-patron-import

koha-plugin-patron-import

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

koha-plugin-patron-import's Issues

remaining marks of a git conflict in launcher.sh

Hey,
Marks of a git conflict are left in launcher.sh script :

if (( ARCHIVES_DAYS > 0 )); then
<<<<<<< HEAD
    find "$ARCHIVES_DIR" -maxdepth 1 -mtime "+$ARCHIVES_DAYS" -name '*.csv' -delete
=======
    find $ARCHIVES_DIR -maxdepth 1 -mtime +$ARCHIVES_DAYS -name '*.csv' -delete
>>>>>>> add-asterisk-quote-char
fi

Find a way to prevent branchcode and categorycode check which cause an import error

If in the import source there is not explicitly an indication of the 'branchcode' and the 'categorycode' and the mapping do not mention it either, an error will be thrown because of 'branchcode' and / or 'categorycode' are undef.

To get around the problem you have to add a default value on these fields, and possibly protect them.

The logic would have to be reviewed.

Purge borrowers history table

To prevent many rows in datatable

Add a file handler directly on interface to launch a new import

It could be nice to have an input to add a local file and launch an import

Fix extended attributes config when plugin table is empty

In fact, if it has never been saved, no value will be found in the table and extended attributes will never be integrated.

Change of system preference BorrowersLog appears in action_logs with interface OPAC

koha-plugin-patron-import/Koha/Plugin/Com/Biblibre/PatronImport.pm

Line 552 in b3961fc

C4::Context->set_preference( 'BorrowersLog', 0 );

When comming from a cron, it should set C4::Context interface 'cron'.

Maybe use like in Koha cronjobs :

use Koha::Script -cron;

Launcher modifications

• Add specific directory for import dir : IMPORT_DIR=/home/koha/webdatas/private/patrons
• Move log dir with all other logs : LOD_DIR=/home/koha/var/log/patrons/
• If $LOG_DIR does not exist, create it : if [ ! -d $LOG_DIR]; then mkdir $LOG_DIR; fi
• Default archive delay should not be 0 : ARCHIVES_DAYS = 7
• Cleanup logs : find $LOG_DIR -maxdepth 1 -mtime +$((++ARCHIVES_DAYS)) -name '*.log' -delete

File name should be in run details

The name of imported file should be in run details.

This can be very useful for debug.

Add option to get LDAP config from koha-conf