1 <?xml version='1.0' encoding='UTF-8'?>
\r
2 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
\r
3 xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="migratingdata" >
\r
5 <title>Migrating Data</title>
\r
7 <para>Migrating data into Evergreen can be one of the most daunting tasks for an administrator. This chapter will explain some procedures to help to migrate
\r
8 bibliographic records, copies and patrons into the Evergreen system. This chapter requires advanced ILS Administration experience, knowledge of Evergreen data structures,
\r
9 as well as knowledge of how to export data from your current system or access to data export files from your current system.</para>
\r
12 <section xml:id="migratingbibrecords">
\r
13 <title>Migrating Bibliographic Records</title>
\r
14 <indexterm><primary>migrating</primary><secondary>importing bibliographic records</secondary></indexterm>
\r
16 One of the most important and challenging tasks is migrating your bibliographic records to a new system. The procedure may be different depending on the system from which you
\r
17 are migrating and the content of the marc records exported from the existing system. The procedures in this section deal with the process once the data from the existing system
\r
18 is exported into marc records. It does not cover exporting data from your existing non-Evergreen system.</para>
\r
19 <para>Several tools for importing bibliographic records into Evergreen can be found in the Evergreen installation folder
\r
20 (<filename class="directory">/home/opensrf/Evergreen-ILS-1.6.1.6/Open-ILS/src/extras/import/</filename> ) and are also available from the Evergreen repository
\r
21 (<link xl:href="http://svn.open-ils.org/trac/ILS/browser/branches/rel_1_6_1/Open-ILS/src/extras/import" xl:title="import scripts - Evergreen repository">
\r
22 http://svn.open-ils.org/trac/ILS/browser/branches/rel_1_6_1/Open-ILS/src/extras/import</link>).</para>
\r
24 <title>Converting MARC records to Evergreen BRE JSON format</title>
\r
25 <indexterm><primary>BRE JSON</primary></indexterm>
\r
26 <para>If you are starting with MARC records from your existing system or another source, use the marc2bre.pl script to create the JSON representation of a bibliographic
\r
27 record entry (hence bre) in Evergreen. <filename>marc2bre.pl</filename> can perform the following functions:</para>
\r
29 <listitem><para>Converts <systemitem>MARC-8</systemitem> encoded records to <systemitem>UTF-8</systemitem> encoding</para></listitem>
\r
30 <listitem><para>Converts <systemitem>MARC21</systemitem> to <systemitem>MARCXML21</systemitem></para></listitem>
\r
31 <listitem><para>Select the unique record number field (common choices are '035' or '001'; check your records as you might be surprised how a supposedly unique field
\r
32 actually has duplicates, though marc2bre.pl will select a unique identifier for subsequent duplicates)</para></listitem>
\r
33 <listitem><para>Extracts certain pertinent fields indexing and display purposes (along with the complete MARCXML21 record)</para></listitem>
\r
34 <listitem><para>Sets the ID number of the first record from this batch to be imported into the biblio.record_entry table (hint - run the following
\r
35 <systemitem>SQL</systemitem> to determine what this number should be to avoid conflicts:</para>
\r
37 <userinput>psql -U postgres evergreen</userinput>
\r
38 <userinput> # SELECT MAX(id)+1 FROM biblio.record_entry;</userinput>
\r
42 <para>If you are processing multiple sets of MARC records with <command>marc2bre.pl</command>before loading the records into the database, you will need to keep track
\r
43 of the starting ID number for each subsequent batch of records that you are importing. For example, if you are processing three files of MARC records with 10000
\r
44 records each into a clean database, you would use <option>–startid 1</option>, <option>–startid 10001</option>, and <option>–startid 20001</option>
\r
45 parameters for each respective file.</para>
\r
48 <para>Ignore <quote>trash</quote> fields that you do not want to retain in Evergreen</para>
\r
51 <para>If you use <filename>marc2bre.pl</filename> to convert your MARC records from the <systemitem>MARC-8</systemitem> encoding to the UTF-8 encoding, it relies
\r
52 on the <systemitem>MARC::Charset Perl</systemitem> module to complete the conversion. When importing a large set of items, you can speed up the process by using a
\r
53 utility like <systemitem>marc4j</systemitem> or <systemitem>marcdumper</systemitem> to convert the records
\r
54 to <systemitem>MARC21XML</systemitem> and <systemitem>UTF-8</systemitem> before running them through <command>marc2bre.pl</command> with the
\r
55 <option>–marctype=XML</option> flag to tell <command>marc2bre.pl</command> that the records are already in <systemitem>MARC21XML</systemitem> format with
\r
56 the <systemitem>UTF-8 </systemitem>encoding. If you take this approach, due to a current limitation of <systemitem>MARC::File::XML</systemitem> you have to do a
\r
57 horrible thing and ensure that there are no namespace prefixes in front of the element names. <filename>marc2bre.pl</filename> cannot parse the following
\r
60 <programlisting language="xml">
\r
63 <?xml version="1.0" encoding="UTF-8" ?>
\r
64 <marc:collection xmlns:marc="http://www.loc.gov/MARC21/slim"
\r
65 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
\r
66 xsi:schemaLocation="http://www.loc.gov/MARC/slim
\r
67 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd">
\r
69 <marc:leader>00677nam a2200193 a 4500</marc:leader>
\r
70 <marc:controlfield tag="001">H01-0000844</marc:controlfield>
\r
71 <marc:controlfield tag="007">t </marc:controlfield>
\r
72 <marc:controlfield tag="008">060420s1950 xx 000 u fre d</marc:controlfield>
\r
73 <marc:datafield tag="040" ind1=" " ind2=" ">
\r
74 <marc:subfield code="a">CaOHCU</marc:subfield>
\r
75 <marc:subfield code="b">fre</marc:subfield>
\r
81 <para>But marc2bre.pl can parse the same example with the namespace prefixes removed:</para>
\r
82 <programlisting language="xml">
\r
84 <?xml version="1.0" encoding="UTF-8" ?>
\r
85 <collection xmlns:marc="http://www.loc.gov/MARC21/slim"
\r
86 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
\r
87 xsi:schemaLocation="http://www.loc.gov/MARC/slim
\r
88 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd">
\r
90 <leader>00677nam a2200193 a 4500</leader>
\r
91 <controlfield tag="001">H01-0000844</controlfield>
\r
92 <controlfield tag="007">t </controlfield>
\r
93 <controlfield tag="008">060420s1950 xx 000 u fre d</controlfield>
\r
94 <datafield tag="040" ind1=" " ind2=" ">
\r
95 <subfield code="a">CaOHCU</subfield>
\r
96 <subfield code="b">fre</subfield>
\r
105 <title>Converting Records for Import into PostgreSQL</title>
\r
106 <indexterm><primary>migrating</primary><secondary>import into PostgreSQL</secondary></indexterm>
\r
107 <para>Once you have your records in Open-ILS <systemitem>JSON</systemitem> ingest format, you then need to use <command>pg_loader.pl</command> to convert these records into a
\r
108 set of <systemitem>SQL</systemitem> statements that you can use to
\r
109 load the records into PostgreSQL. The <option>–order</option> and <option>–autoprimary</option> command line options (bre, mrd, mfr, etc) map to class IDs defined in
\r
110 <filename>/openils/conf/fm_IDL.xml</filename>.</para>
\r
113 <title>Adding Metarecords to the Database</title>
\r
114 <indexterm><primary>migrating</primary><secondary>adding metarecords</secondary></indexterm>
\r
115 <para>One you have loaded the records into PostgreSQL, you can create metarecord entries in the <link linkend="metabib.table.metarecord">metabib.metarecord</link> table by running the following <systemitem>SQL</systemitem>:</para>
\r
117 <userinput>psql evergreen</userinput>
\r
118 <userinput># \i /home/opensrf/Evergreen-ILS-1.6*/src/extras/import/quick_metarecord_map.sql</userinput>
\r
120 <para>Metarecords are required to place holds on items, among other actions.</para>
\r
126 <section xml:id="migrating_records_using_migration_tools">
\r
127 <title>Migrating Bibliographic Records Using the ESI Migration Tools</title>
\r
128 <indexterm><primary>migrating</primary><secondary>bibliograohic records</secondary></indexterm>
\r
129 <para>The following procedure explains how to migrate bibliographic records from marc records into Evergreen. This is a general guide and will need to be adjusted for your
\r
130 specific environment. It does not cover exporting records from specific proprietary ILS
\r
131 systems. For assistance with exporting records from your current system please refer to the manuals for your system or you might try to ask for help from the
\r
132 <link linkend="more_info">Evergreen community</link>.</para>
\r
136 <para>Download the Evergreen <link xl:href="http://git.esilibrary.com/?p=migration-tools.git;a=summary"
\r
137 xl:title="Equinox migration utilities">migration utilities</link> from the git repository.</para>
\r
138 <para>Use the command <command>git clone git://git.esilibrary.com/git/migration-tools.git</command> to clone the migration tools.</para>
\r
139 <para>Install the migration tools:</para>
\r
143 cd migration-tools/Equinox-Migration
\r
153 <para>Add environmental variables for migration and import tools. These paths must point to:
\r
155 <listitem>the import perl scripts bundled with Evergreen </listitem>
\r
156 <listitem>the folder where you extracted the migration tools</listitem>
\r
157 <listitem>the location of the Equinox-Migration perl modules </listitem>
\r
158 <listitem>the location of the Evergreen perl modules (e.g. perl5)</listitem>
\r
163 export PATH=[<emphasis class="italic">path to Evergreen</emphasis>]/Open-ILS/src/extras/import:/[<emphasis class="italic">path to migration-tools</emphasis>]/migration-tools:$PATH:.
\r
164 export PERL5LIB=/openils/lib/perl5:/[<emphasis class="italic">path to migration-tools directory</emphasis>]/migration-tools/Equinox-Migration/lib
\r
169 <para>Dump marc records into MARCXML using <systemitem>yaz-marcdump</systemitem></para>
\r
174 echo '<?xml version="1.0" encoding="UTF-8" ?>' > imported_marc_records.xml
\r
175 yaz-marcdump -f MARC-8 -t UTF-8 -o marcxml imported_marc_records.mrc >> imported_marc_records.xml
\r
181 <para>Test validity of XML file using <systemitem>xmllint</systemitem></para>
\r
186 xmllint --noout imported_marc_records.xml 2> marc.xml.err
\r
193 <para>Clean up the marc xml file using the <systemitem>marc_cleanup</systemitem> utility:</para>
\r
196 marc_cleanup --marcfile=imported_marc_records.xml --fullauto [--renumber-from #] -ot 001
\r
199 <para>The <option>--renumber-from</option> is required if you have bibliographic records already in your system. Use this to set the starting id number higher
\r
200 then the last id in the biblio.record_entry table. The marc_cleanup command will generate a file called <filename>clean.marc.xml</filename></para>
\r
203 <para>Create a fingerprinter file using the <systemitem>fingerprinter</systemitem> utility:</para>
\r
206 fingerprinter -o incumbent.fp -x incumbent.ex clean.marc.xml
\r
209 <para><systemitem>fingerprinter</systemitem> is used for deduplification of the incumbent records. The <option>-o</option> option specifies the
\r
210 output file and the <option>-x</option> option is used to specify the error output file.</para>
\r
213 <para>Create a fingerprinter file for existing Evergreen bibliographic records using the <systemitem>fingerprinter</systemitem> utility if you
\r
214 have existing bibliographic records in your system previously imported:</para>
\r
217 fingerprinter -o production.fp -x production.fp.ex --marctype=MARC21 existing_marc_records.mrc --tag=901 --subfield=c
\r
220 <para><systemitem>fingerprinter</systemitem> is used for deduplification of the incumbant records.</para>
\r
224 <para>Create a merged fingerprint file removing duplicate records.</para>
\r
227 cat cat production.fp incumbent.fp | sort -r > dedupe.fp
\r
228 match_fingerprints [-t start id] -o records.merge dedupe.fp
\r
234 <para>Create a new import XML file using the <systemitem>extract_loadset</systemitem> utility</para>
\r
236 <userinput>extract_loadset -l 1 -i clean.marc.xml -o merged.xml records.merge</userinput>
\r
241 <para>Extract all of the currently used TCN's an generate the .bre and .ingest files to prepare for the bibliographic record load.</para>
\r
244 psql -U evergreen -c "select tcn_value from biblio.record_entry where not deleted" | perl -npe 's/^\s+//;' > used_tcns
\r
245 marc2bre.pl --idfield 903 [--startid=#] --marctype=XML -f final.xml --used_tcn_file=used_tcns > evergreen_bre_import_file.bre
\r
249 <para> The option <option>--startid</option> needs to match the start id used in earlier steps and must be higher than largest id value
\r
250 in the biblio.record_entry table. the option <option>--idfield</option> should match the marc datafield used to store your records ids.</para>
\r
255 <para>Ingest the bibliographic records into the Evergreen database.</para>
\r
259 parallel_pg_loader.pl \
\r
274 -a msefe evergreen_bre_import_file.bre > bibrecords.sql
\r
280 <para>Load the records using psql and the sql scripts generated from the previous step.</para>
\r
284 psql -U evergreen -h localhost -d evergreen -f bibrecords.sql
\r
285 psql -U evergreen < ~/Ever*/Open-ILS/src/extras/import/quick_metarecord_map.sql > log.create_metabib
\r
291 <para>Extract holdings from marc records for importing copies into Evergreen using the <systemitem>extract_holdings</systemitem> utility.</para>
\r
294 extract_holdings --marcfile=clean.marc.xml --holding 999 --copyid 999i --map holdings.map
\r
297 <para>This command would extract holdings based on the 949 datafield in the marc records. The copy id is generated from the subfile i in the 999 datafield. You may
\r
298 need to adjust these options based on the field used for holdings informatiom in your marc records.</para>
\r
299 <para>The <option>map</option> option <filename>holdings.map</filename> refers to a file to be used for mapping subfields to the holdings data you would like extracted. Here is an example based on mapping holdings data to the 999 data field:</para>
\r
306 circ_modifier 999 t
\r
309 <para>Running the extract holdings script should produce an sql script <filename>HOLDINGS.pg</filename> similar to:</para>
\r
310 <programlisting language="sql">
\r
313 egid, hseq, l_call_num, l_barcode, l_location, l_owning_lib, l_circ_modifier,
\r
314 40 0 HD3616.K853 U54 1997 30731100751928 STACKS FENNELL BOOK
\r
315 41 1 HV6548.C3 S984 1998 30731100826613 STACKS FENNELL BOOK
\r
316 41 2 HV6548.C3 S984 1998 30731100804958 STACKS BRANTFORD BOOK
\r
320 <para>Edit the holdings.pg sql script like so:</para>
\r
321 <programlisting language="sql">
\r
324 <emphasis class="bold">TRUNCATE TABLE staging_items;</emphasis>
\r
326 <emphasis class="bold">INSERT INTO staging_items (</emphasis>egid, hseq, l_call_num, l_barcode, l_location, l_owning_lib, l_circ_modifier <emphasis>FROM stdin;</emphasis>
\r
327 40 0 HD3616.K853 U54 1997 30731100751928 STACKS FENNELL BOOK
\r
328 41 1 HV6548.C3 S984 1998 30731100826613 STACKS FENNELL BOOK
\r
329 41 2 HV6548.C3 S984 1998 30731100804958 STACKS BRANTFORD BOOK
\r
330 <emphasis>COMMIT;</emphasis>
\r
332 <para>This file can be used for importing holdings into Evergreen. the <database class="field">egid</database> is a critical column. It is used to link the volume and
\r
333 copy to the bibliographic record. Please refer to <link linkend="migratingbibrecordcopies">for the steps to import your holdings into Evergreen.</link></para>
\r
338 <section xml:id="migratingbibrecordcopies">
\r
339 <title>Adding Copies to Bibliographic Records</title><indexterm><primary>migrating</primary><secondary>holdings</secondary></indexterm>
\r
340 <para>Before bibliographic records can be found in an OPAC search copies will need to be created. It is very important to understand how various tables related to each other in regards
\r
341 to holdings maintenance.</para>
\r
342 <para>The following procedure will guide you through the process of populating Evergreen with volumes and copies. This is a very simple example. The SQL queries may need to be adjusted
\r
343 for the specific data in your holdings.</para>
\r
346 <para>Create a staging_items staging table to hold the holdings data:</para>
\r
347 <programlisting language="sql">
\r
348 CREATE TABLE staging_items (
\r
349 callnum text, -- call number label
\r
350 hseq int, -- call number label
\r
351 egid int, -- biblio.record_entry_id
\r
356 owning_lib text -- actor.org_unit.shortname
\r
361 <para>Import the items using the HOLDINGS.pg SQL script created using the extract_holdings utility.</para>
\r
363 <userinput>psql -U evergreen -f HOLDINGS.pg evergreen</userinput>
\r
365 <para>the file <filename>HOLDINGS.pg</filename> and/or the COPY query may need to be adjusted for your particular circumstances.</para>
\r
370 <para>Generate shelving locations from your staging table.</para>
\r
371 <programlisting language="sql">
\r
372 INSERT INTO asset.copy_location (name, owning_lib)
\r
373 SELECT DISTINCT l.location, ou.id
\r
374 FROM staging_items l
\r
375 JOIN actor.org_unit ou ON (l.owning_lib = ou.shortname);
\r
379 <para>Generate circulation modifiers from your staging table.</para>
\r
380 <programlisting language="sql">
\r
381 INSERT INTO config.circ_modifier (code, name, description, sip2_media_type, magnetic_media)
\r
382 SELECT DISTINCT item_type AS code,
\r
384 LOWER(item_type) AS description,
\r
385 '001' AS sip2_media_type,
\r
386 FALSE AS magnetic_media
\r
388 WHERE item_type NOT IN (SELECT code FROM config.circ_modifier);
\r
392 <para>Generate call numbers from your staging table:</para>
\r
393 <programlisting language="sql">
\r
394 INSERT INTO asset.call_number (creator,editor,record,label,owning_lib)
\r
395 SELECT DISTINCT 1, 1, b.id, l.callnum, ou.id
\r
396 FROM staging.staging_items l
\r
397 JOIN actor.org_unit ou ON (l.owning_lib = ou.shortname);
\r
401 <para>Generate copies from your staging table:</para>
\r
402 <programlisting language="sql">
\r
403 INSERT INTO asset.copy (
\r
404 circ_lib, creator, editor, create_date, barcode,
\r
405 STATUS, location, loan_duration, fine_level, circ_modifier, deposit, ref, call_number)
\r
407 SELECT DISTINCT ou.id AS circ_lib,
\r
410 l.createdate AS create_date,
\r
411 l.barcode AS barcode,
\r
414 2 AS loan_duration,
\r
416 l.item_type AS circ_modifier,
\r
419 WHEN l.item_type = 'REFERENCE' THEN TRUE
\r
422 cn.id AS call_number
\r
423 FROM staging.staging_items l
\r
424 JOIN actor.org_unit ou
\r
425 ON (l.owning_lib = ou.shortname)
\r
426 JOIN asset.copy_location cl
\r
427 ON (ou.id = cl.owning_lib AND l.location = cl.name)
\r
428 JOIN asset.call_number cn
\r
429 ON (ou.id = cn.owning_lib
\r
430 AND l.callnum = cn.label);
\r
432 <para>You should now have copies in your Evergreen database and should be able to search and find the bibliographic records with attached copies.</para>
\r
436 <section xml:id="migratingpatrons">
\r
437 <title>Migrating Patron Data</title>
\r
438 <indexterm><primary>migrating</primary><secondary>patrons</secondary></indexterm>
\r
440 This section will explain the task of migrating your patron data from comma delimited files<indexterm><primary>comma delimited files</primary></indexterm> into Evergreen.
\r
441 It does not deal with the process of exporting from the non-Evergreen
\r
442 system since this process may vary depending on where you are extracting your patron records. Patron could come from an ILS or it could come from a student database in the case of
\r
445 <para>When importing records into Evergreen you will need to populate 3 tables in your Evergreen database:</para>
\r
447 <listitem><link linkend="actor.table.usr">actor.usr</link> - The main table for user data</listitem>
\r
448 <listitem><link linkend="actor.table.card">actor.card</link> - Stores the barcode for users; Users can have more than 1 card but only 1 can be active at a given time;</listitem>
\r
449 <listitem><link linkend="actor.table.usr-address">actor.usr_address</link> - Used for storing address information; A user can have more than one address.</listitem>
\r
451 <para>Before following the procedures below to import patron data into Evergreen, it is a good idea to examine the fields in these tables in order to decide on a strategy
\r
452 for data to include
\r
453 in your import. It is important to understand the data types and constraints on each field.</para>
\r
456 <para>Export the patron data from your existing ILS or from another source into a comma delimited file. The comma delimited file used for importing
\r
457 the records should use Unicode (UTF8) <indexterm><primary>Unicode</primary></indexterm> character encoding.</para>
\r
460 <para>Create a staging table.<indexterm><primary>staging table</primary></indexterm> A staging table will allow you to tweak the data before importing.
\r
461 Here is an example sql statement:</para>
\r
462 <indexterm><primary>sql</primary></indexterm>
\r
463 <programlisting language="sql">
\r
464 CREATE TABLE students (
\r
465 student_id int, barcode text, last_name text, first_name text, program_number text,
\r
466 program_name text, email text, address_type text, street1 text, street2 text,
\r
467 city text, province text, country text, postal_code text, phone text, profile int,
\r
468 ident_type int, home_ou int, claims_returned_count int DEFAULT 0, usrname text,
\r
469 net_access_level int DEFAULT 2, password text
\r
472 <para>Note the <varname>DEFAULT</varname> variables. These allow you to set default for your library or to populate required fields if you data allows
\r
473 <systemitem>NULL</systemitem> values where fields are required in Evergreen.</para>
\r
476 <para>Formatting of some fields to fit Evergreen filed formatting may be required. Here is an example of sql to adjust phone numbers in the staging
\r
477 table to fit the evergreen field:</para>
\r
478 <programlisting language="sql">
\r
479 UPDATE students phone = replace(replace(replace(rpad(substring(phone from 1 for 9), 10, '-') ||
\r
480 substring(phone from 10), '(', ''), ')', ''), ' ', '-');
\r
482 <para>Data <quote>massaging</quote> may be required to fit formats used in Evergreen.</para>
\r
485 <para>Insert records from the staging table into the <link linkend="actor.table.usr">actor.usr</link> Evergreen table:</para>
\r
486 <programlisting language="sql">
\r
487 INSERT INTO actor.usr (
\r
488 profile, usrname, email, passwd, ident_type, ident_value, first_given_name,
\r
489 family_name, day_phone, home_ou, claims_returned_count, net_access_level)
\r
490 SELECT profile, students.usrname, email, student_id, ident_type, student_id,
\r
491 first_name, last_name, phone, home_ou, claims_returned_count, net_access_level
\r
496 <para>insert records into <link linkend="actor.table.card">actor.card</link> from <link linkend="actor.table.usr">actor.usr</link>.</para>
\r
497 <programlisting language="sql">
\r
498 INSERT INTO actor.card (usr, barcode)
\r
499 SELECT actor.usr.id, students.barcode
\r
501 INNER JOIN actor.usr
\r
502 ON students.usrname = actor.usr.usrname;
\r
504 <para>This assumes a one to one card patron relationship. If your patron data import has multiple cards assigned to one patron more complex import scripts may be required which look for inactive or active flags.</para>
\r
507 <para>Update actor.usr.card field with actor.card.id to associate active card with the user:</para>
\r
508 <programlisting language="sql">
\r
510 SET card = actor.card.id
\r
512 WHERE actor.card.usr = actor.usr.id;
\r
516 <para>Insert records into <link linkend="actor.table.usr-address">actor.usr_address</link> to add address information for users:</para>
\r
517 <programlisting language="sql">
\r
518 INSERT INTO actor.usr_address (usr, street1, street2, city, state, country, post_code)
\r
519 SELECT actor.usr.id, students.street1, students.street2, students.city, students.province,
\r
520 students.country, students.postal_code
\r
522 INNER JOIN actor.usr ON students.usrname = actor.usr.usrname;
\r
526 <para>update <link linkend="actor.table.usr-address">actor.usr.address</link> with address id from address table.</para>
\r
527 <programlisting language="sql">
\r
529 SET mailing_address = actor.usr_address.id, billing_address = actor.usr_address.id
\r
530 FROM actor.usr_address
\r
531 WHERE actor.usr.id = actor.usr_address.usr;
\r
533 <para>This assumes 1 address per patron. More complex scenarios may require more sophisticated SQL.</para>
\r
537 <title>Creating an sql Script for Importing Patrons</title>
\r
538 <para>The procedure for importing patron can be automated with the help of an sql script. Follow these steps to create an import script:</para>
\r
542 <para>Create an new file and name it <filename>import.sql</filename></para>
\r
547 <para>Edit the file to look similar to this:</para>
\r
551 -- Create staging table.
\r
552 CREATE TABLE students (
\r
553 student_id int, barcode text, last_name text, first_name text, program_number text,
\r
554 program_name text, email text, address_type text, street1 text, street2 text,
\r
555 city text, province text, country text, postal_code text, phone text, profile int,
\r
556 ident_type int, home_ou int, claims_returned_count int DEFAULT 0, usrname text,
\r
557 net_access_level int DEFAULT 2, password text
\r
561 --Insert records from the staging table into the actor.usr table.
\r
562 INSERT INTO actor.usr (
\r
563 profile, usrname, email, passwd, ident_type, ident_value, first_given_name, family_name,
\r
564 day_phone, home_ou, claims_returned_count, net_access_level)
\r
565 SELECT profile, students.usrname, email, student_id, ident_type, student_id, first_name,
\r
566 last_name, phone, home_ou, claims_returned_count, net_access_level FROM students;
\r
568 --Insert records from the staging table into the actor.usr table.
\r
569 INSERT INTO actor.card (usr, barcode)
\r
570 SELECT actor.usr.id, students.barcode
\r
572 INNER JOIN actor.usr
\r
573 ON students.usrname = actor.usr.usrname;
\r
575 --Update actor.usr.card field with actor.card.id to associate active card with the user:
\r
577 SET card = actor.card.id
\r
579 WHERE actor.card.usr = actor.usr.id;
\r
581 --INSERT records INTO actor.usr_address from staging table.
\r
582 INSERT INTO actor.usr_address (usr, street1, street2, city, state, country, post_code)
\r
583 SELECT actor.usr.id, students.street1, students.street2, students.city, students.province,
\r
584 students.country, students.postal_code
\r
586 INNER JOIN actor.usr ON students.usrname = actor.usr.usrname;
\r
589 --Update actor.usr mailing address with id from actor.usr_address table.:
\r
591 SET mailing_address = actor.usr_address.id, billing_address = actor.usr_address.id
\r
592 FROM actor.usr_address
\r
593 WHERE actor.usr.id = actor.usr_address.usr;
\r
597 <para>Placing the sql statements between <code>BEGIN;</code> and <code>COMMIT;</code> creates a transaction block so that if any sql statements fail, the
\r
598 entire process is canceled and the database is rolled back to its original state. Lines beginning with <code>--</code> are comments to let you you what
\r
599 each sql statement is doing and are not processed.</para>
\r
604 <title>Batch Updating Patron Data</title>
\r
605 <indexterm><primary>migrating</primary><secondary>batch updating patrons</secondary></indexterm>
\r
606 <para>For academic libraries, doing batch updates to add new patrons to the Evergreen database is a critical task. The above procedures and
\r
607 import script can be easily adapted to create an update script for importing new patrons from external databases. If the data import file contains only new patrons, then,
\r
608 the above procedures will work well to insert those patrons. However, if the data load contains all patrons, a second staging table and a procedure to remove existing patrons from that second staging table may be required before importing the new patrons. Moreover, additional steps to update address information and perhaps delete
\r
609 inactive patrons may also be desired depending on the requirements of the institution.</para>
\r
610 <para>After developing the scripts to import and update patrons have been created, another important task for library staff is to develop an import strategy and schedule
\r
611 which suits the needs of the library. This could be determined by registration dates of your institution in the case of academic libraries. It is important to balance
\r
612 the convenience of patron loads and the cost of processing these loads vs staff adding patrons manually.</para>
\r
615 <section xml:id="electronicresourcesvisible">
\r
616 <title>Making Electronic Resources Visible in the Catalogue</title>
\r
617 <indexterm><primary>migrating</primary><secondary>importing bibliographic records</secondary><tertiary>electronic resources </tertiary></indexterm>
\r
618 <para>For electronic resources that should be visible in the catalogue without any copies, you must set the source column value in the record.biblio_entry row for the respective
\r
619 bibliographic record to a value that matches the corresponding ID of the <link linkend="config.table.bib-source">config.bib_source</link> where the transcendant value is
\r
620 <emphasis>TRUE</emphasis>. Here's a practical example:</para>
\r
623 <para>Connect to your Evergreen database with <command>psql</command> (substitute username / database name as required):</para>
\r
625 <userinput>psql -U postgres evergreen</userinput>
\r
629 <para>Add a source for your electronic resources:</para>
\r
632 # INSERT INTO config.bib_source(quality, source, transcendant)
\r
633 VALUES (50, 'Institutional repository', TRUE);</userinput>
\r
637 <para>Find the ID that was generated for your new source:</para>
\r
639 <userinput># SELECT ID FROM config.bib_source WHERE source = 'Institutional repository';</userinput>
\r
643 <para>Update the source column for your bibliographic record for the electronic resource (for the sake of the example, let's assume that the ID returned from the new
\r
644 source was 4, and that we know that the bib record with ID 75 is an electronic resource from your institutional repository):</para>
\r
646 <userinput># UPDATE biblio.record_entry SET source = 4 where biblio.record_entry.id=75;</userinput>
\r
651 <section xml:id="emptydatabase">
\r
652 <title>Restoring your Evergreen Database to an Empty State</title>
\r
653 <para>If you've done a test import of records and you want to quickly get Evergreen back to a pristine state, you can create a clean Evergreen database schema by performing the
\r
658 <userinput>cd ILS/Open-ILS/src/sql/Pg/</userinput>
\r
662 <para>Rebuild the database schema:</para>
\r
664 <userinput>./build-db.sh [db-hostname> [db-port] [db-name] [db-user] [db-password] [db-version]</userinput>
\r
666 <caution><para>This will remove all of your data from the database and restore the default values.</para></caution>
\r
670 <section xml:id="exportingbibrecordsintoMARC">
\r
671 <title>Exporting Bibliographic Records into MARC files</title>
\r
672 <indexterm><primary>migrating</primary><secondary>exporting bibliographic records</secondary><tertiary>MARC</tertiary></indexterm>
\r
673 <para>The following procedure explains how to export Evergreen bibliographic records into MARC files using the marc_export support script. All steps should be performed by the
\r
674 opensrf user from your Evergreen server.</para>
\r
677 <para>Create a text file list of the Bibliographic record ids you would like to export from Evergreen. One way to do this is using SQL:</para>
\r
678 <programlisting language="sql">
\r
679 SELECT DISTINCT bre.id FROM biblio.record_entry AS bre
\r
680 JOIN asset.call_number AS acn ON acn.record-bre.id
\r
681 WHERE bre.deleted='false' and ownling_lib=101 \g /home/opensrf/records.txt;
\r
683 <para>This query will create a file called <filename>ids.txt</filename> containing a column of distinct ids of items owned by the organizational unit with the
\r
684 <table class="field">id</table> <literal>101</literal>.</para>
\r
687 <para>Navigate to the support-scripts folder</para>
\r
689 <userinput>cd /home/opensrf/Evergreen-ILS*/Open-ILS/src/support-scripts/</userinput>
\r
693 <para>Run <command>marc_export</command>, using the id file you created in step 1 to define which files to export.</para>
\r
695 <userinput>cat /home/opensrf/records.txt | ./marc_export -i -c /openils/conf/opensrf_core.xml -x /openils/conf/fm_IDL.xml -f XML --timeout 5 > exported_files.xml
\r
698 <para>The example above export the records into MARCXML format.</para>
\r
700 <para>For help or for more options when running <command>marc_export</command>, run <command>marc_export</command> with the <option>-h</option> option:</para>
\r
702 <userinput>./marc_export -h</userinput>
\r
708 <para>Processing time for exporting records will depond on several factors such as the number of records you are exporting. It is recommended that you divide the
\r
709 export id files (<filename>records.txt</filename>) into manageable number of records if you are exporting a large number of records.</para>
\r
713 <section xml:id="importingauthorityrecords">
\r
714 <title>Importing Authority Records</title>
\r
715 <indexterm><primary>migrating</primary><secondary>importing authority records</secondary></indexterm>
\r
716 <para>The following procedure explains how to export Evergreen bibliographic records into MARC files using the marc_export support script. All steps should be performed by the
\r
717 opensrf user from your Evergreen server.</para>
\r
719 <title>Importing Authority Records from Command Line</title>
\r
720 <para>The major advantages of the command line approach are its speed and its convenience for system administrators who can perform bulk loads of authority records in a
\r
721 controlled environment.</para>
\r
725 <para>Run <command>marc2are.pl</command> against the authority records, specifying the user name, password, MARC type (USMARC or XML). Use
\r
726 <varname>STDOUT</varname> redirection
\r
727 to either pipe the output directly into the next command or into an output file for inspection. For example, to process a set of authority records
\r
728 named <filename>auth_small.xml</filename> using the default user name and password and directing the output into a file named <filename>auth.are</filename>:</para>
\r
730 <userinput>cd Open-ILS/src/extras/import/</userinput>
\r
731 <userinput>perl marc2are.pl --user admin --pass open-ils auth_small.xml > auth.are</userinput>
\r
736 <para>Run <command>pg_loader.pl</command> to generate the SQL necessary for importing the authority records into your system. To save time for very large batches of records, you could
\r
737 simply pipe the output of <command>marc2are.pl</command> directly into <command>pg_loader.pl</command>.</para>
\r
739 <userinput>cd Open-ILS/src/extras/import/</userinput>
\r
740 <userinput> perl pg_loader.pl --auto are --order are auth.are > auth_load.sql</userinput>
\r
745 <para>Load the authority records from the SQL file that you generated in the last step into your Evergreen database using the psql tool. Assuming the default user
\r
746 name, host name, and database name for an Evergreen instance, that command looks like:</para>
\r
748 <userinput>psql -U evergreen -h localhost -d evergreen -f auth_load.sql</userinput>
\r
755 <title>Importing authority records using the MARC Batch Import/Export interface from the Staff Client</title>
\r
756 <para>Good for loading batches of up to 5,000 records (roughly) at a time, the major advantages to importing authority records using the MARC Batch Import/Export interface are
\r
757 that it does not require command-line or direct database access – good for both security in that it minimizes the number of people who need this access and for spreading the
\r
758 effort around to others in the library – and it does most of the work (for example, figuring out whether the batch of records is in XML or USMARC format) for you.</para>
\r
759 <para>To import a set of MARC authority records from the MARC Batch Import/Export interface:</para>
\r
762 <para>From the Evergreen staff client, select <menuchoice><guimenu>Cataloging</guimenu><guimenuitem>MARC Batch Import/Export</guimenuitem></menuchoice>.
\r
763 The <guilabel>Evergreen MARC File Upload</guilabel> screen opens, with <guilabel>Import Records</guilabel> as the highlighted tab.</para>
\r
766 <para>From the <guimenu>Bibliographic records</guimenu> drop-down menu, select <guimenuitem>Authority records</guimenuitem>.</para>
\r
770 <para>Enter a name for the queue (batch import job) in the <guilabel>Create a new upload queue</guilabel> field.</para>
\r
774 <para>Select the <guilabel>Auto-Import Non-Colliding Records</guilabel> checkbox.</para>
\r
778 <para>Click the <guibutton>Browse…</guibutton> button to select the file of MARC authorities to import.</para>
\r
782 <para>Click the <guibutton>Upload</guibutton> button to begin importing the records. The screen displays <guilabel>Uploading…</guilabel>
\r
783 <guilabel>Processing…</guilabel> to show that the records are being transferred to the server, then displays a progress bar to show the actual import
\r
784 progress. When the staff client displays the progress bar, you can disconnect your staff client safely. Very large batches of records might time out at this
\r
789 <para>Once the import is finished, the staff client displays the results of the import process. You can manually display the import progress by selecting
\r
790 the <guilabel>Inspect Queue</guilabel> tab of the MARC Batch Import/Export interface and selecting the queue name. By default, the staff client does not
\r
791 display records that were imported successfully; it only shows records that conflicted with existing entries in the database. The screen shows the overall
\r
792 status of the import process in the top right-hand corner, with the <guilabel>Total</guilabel> and <guilabel>Imported</guilabel> number of records for the
\r
projects / working / Evergreen.git / blob