3 # Parts copyright 2014 ByWater Solutions
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
22 use Getopt::Long qw( GetOptions );
23 use Pod::Usage qw( pod2usage );
26 use Koha::Patrons::Import;
27 my $Import = Koha::Patrons::Import->new();
31 my $overwrite_cardnumber;
32 my $overwrite_passwords;
40 my $update_dateexpiry;
41 my $update_dateexpiry_from_today;
44 'c|confirm' => \$confirm,
45 'f|file=s' => \$csv_file,
46 'm|matchpoint=s' => \$matchpoint,
47 'd|default=s' => \%defaults,
48 'o|overwrite' => \$overwrite_cardnumber,
49 'op|overwrite_passwords' => \$overwrite_passwords,
50 'ue|update-expiration' => \$update_dateexpiry,
51 'et|expiration-from-today' => \$update_dateexpiry_from_today,
52 'en|email-new' => \$welcome_new,
53 'p|preserve-extended-attributes' => \$ext_preserve,
54 'pf|preserve-field=s' => \@preserve_fields,
55 'v|verbose+' => \$verbose,
59 pod2usage(1) if $help;
60 pod2usage(q|--file is required|) unless $csv_file;
61 pod2usage(q|--matchpoint is required|) unless $matchpoint;
63 warn "Running in dry-run mode, provide --confirm to apply the changes\n" unless $confirm;
66 open( $handle, "<", $csv_file ) or die $!;
68 my $return = $Import->import_patrons(
71 defaults => \%defaults,
72 matchpoint => $matchpoint,
73 overwrite_cardnumber => $overwrite_cardnumber,
74 overwrite_passwords => $overwrite_passwords,
75 preserve_extended_attributes => $ext_preserve,
76 preserve_fields => \@preserve_fields,
77 update_dateexpiry => $update_dateexpiry,
78 update_dateexpiry_from_today => $update_dateexpiry_from_today,
79 send_welcome => $welcome_new,
84 my $feedback = $return->{feedback};
85 my $errors = $return->{errors};
86 my $imported = $return->{imported};
87 my $overwritten = $return->{overwritten};
88 my $alreadyindb = $return->{already_in_db};
89 my $invalid = $return->{invalid};
92 my $total = $imported + $alreadyindb + $invalid + $overwritten;
94 say "Import complete:";
95 say "Imported: $imported";
96 say "Overwritten: $overwritten";
97 say "Skipped: $alreadyindb";
98 say "Invalid: $invalid";
105 say Data::Dumper::Dumper( $errors );
110 say Data::Dumper::Dumper( $feedback );
115 import_patrons.pl - CLI script to import patrons data into Koha
119 import_patrons.pl --file /path/to/patrons.csv --matchpoint cardnumber --confirm [--default branchcode=MPL] [--overwrite] [--preserve-field <column>] [--preserve-extended-attributes] [--update-expiration] [--expiration-from-today] [--verbose]
127 Prints a brief help message and exits
129 =item B<-c|--confirm>
131 Confirms you really want to import these patrons, otherwise prints this help
135 Path to the CSV file of patrons to import
137 =item B<-m|--matchpoint>
139 Field on which to match incoming patrons to existing patrons
141 =item B<-d|--default>
143 Set defaults to patron fields, repeatable e.g. --default branchcode=MPL --default categorycode=PT
145 =item B<-k|--preserve-field>
147 Prevent specified patron fields for existing patrons from being overwritten
149 =item B<-o|--overwrite>
151 Overwrite existing patrons with new data if a match is found
153 =item B<-p|--preserve-extended-attributes>
155 Retain extended patron attributes for existing patrons being overwritten
157 =item B<-en|--email-new>
159 Send the WELCOME notice email to new users
161 =item B<-ue|--update-expiration>
163 If a matching patron is found, extend the expiration date of their account using the patron's enrollment date as the base
165 =item B<-et|--expiration-from-today>
167 If a matching patron is found, extend the expiration date of their account using the patron's enrollment date as the base
169 =item B<-v|--verbose>
173 Multiple -v options increase the verbosity
175 2 repetitions or above will report lines in error
177 3 repetitions or above will report feedback