1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- This document is maintained with oXygen. -->
3 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
6 <title>Koha 3.14 Manual (en)</title>
8 <author id="manualauthor">
9 <firstname>Nicole C.</firstname>
11 <surname>Engard</surname>
14 <orgname>ByWater Solutions/BibLibre</orgname>
18 <copyright id="manualcopy">
20 <holder>Nicole C. Engard/ByWater Solutions/BibLibre</holder>
23 <legalnotice id="manuallegal">
24 <para>This manual is licensed under the <ulink url="http://www.gnu.org/licenses/gpl.html">GNU General Public License,
25 version 3</ulink> or later</para>
27 <para>Learn more about this license in the <link linkend="gpl">GPL3
28 Appendix</link></para>
31 <pubdate id="manualpubdate">Published: 2013</pubdate>
33 <chapter id="introchapter">
34 <title>Introduction</title>
36 <title id="introbasics">Koha Basics</title>
37 <para>Koha is the first free and open source software library automation package (ILS).
38 Development is sponsored by libraries of varying types and sizes, volunteers, and support
39 companies from around the world.</para>
40 <para>Learn more about Koha by visiting the official Koha website: <ulink
41 url="http://koha-community.org">http://koha-community.org</ulink></para>
43 <section id="introrecommend">
44 <title>Koha Recommendations</title>
45 <para>Full system recommendations can be found on the official Koha wiki along with the
46 developer documentation: <ulink url="http://wiki.koha-community.org">
47 http://wiki.koha-community.org</ulink></para>
48 <para>When working in the Koha staff client it is strongly recommended that you use the
49 Firefox browser. Koha's staff client is not supported in Internet Explorer and has not yet
50 been fully optimized for Google Chrome.</para>
52 <section id="usingmanual">
53 <title>Using this Manual</title>
54 <para>This manual is always changing and suggestions for edits can be sent to the
55 Documentation Manager via the <ulink
56 url="https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs">DOCS mailing
57 list</ulink>. The manual is organized by Koha module. At the start of most sections (and
58 throughout) you will find 'Get there' tips. These lines tell you how to get to the section
60 <para>For example: <emphasis>Get there:</emphasis> More > Administration > Global System
64 <screeninfo>Get there: More > Administration > Global System Preferences</screeninfo>
67 <imagedata fileref="images/intro/getthere.png"/>
72 <para>The instruction tells you where to find the necessary menu option at the top of the Koha
74 <para>Links will be found throughout the manual to other sections in the manual and images
75 will depict what should be seen on the screen. </para>
76 <para>The manual can be searched using the custom Google search on the <ulink
77 url="http://koha-community.org/documentation/">Koha Documentation</ulink> page.</para>
79 <section id="contributing">
80 <title>Contributing to the Manual</title>
81 <para>This manual is an ever-changing document and edits to the manual are welcome at any
83 <para>The <ulink url="http://manual.koha-community.org/">Koha Manual</ulink> is managed by the
84 Documentation Manager, but that doesn't mean we can't all participate in making the best
85 manual possible. </para>
86 <para>The manual is stored in git at: <ulink
87 url="http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary"
88 >http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary</ulink></para>
89 <para>To edit the manual we recommend <ulink url="http://www.oxygenxml.com">oXygen</ulink> or
90 other XML/DocBook editor. We ask that every chapter and section have an ID tag associated
91 with it to enable permanent linking and searching. </para>
92 <para>Patches to the manual should be emailed to the <ulink
93 url="https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs">DOCS mailing
94 list</ulink> and will be reviewed by the Documentation Manager before inclusion. </para>
98 <chapter id="administration">
99 <title>Administration</title>
101 <section id="globalsysprefs">
102 <title>Global System Preferences</title>
104 <para>Global system preferences control the way your Koha system works
105 in general. Set these preferences before anything else in Koha.</para>
109 <para><emphasis>Get there:</emphasis> More > Administration > Global System
115 <screeninfo>Global System Preferences Link and Search</screeninfo>
119 <imagedata fileref="images/admin/globalprefs/prefsearch.png"/>
124 <para>System preferences can be searched (using any part of the
125 preference name or description) using the search box on the
126 'Administration' page or the search box at the top of each system
127 preferences page.</para>
130 <screeninfo>Preferences search at the top of System Preference
135 <imagedata fileref="images/admin/globalprefs/prefsearch1.png"/>
140 <para>When editing preferences a '(modified)' tag will appear next to
141 items you change until you click the 'Save All' button:</para>
144 <screeninfo>After editing TagsModeration the '(modified)' label
149 <imagedata fileref="images/admin/globalprefs/saveallprefs.png"/>
154 <para>After saving your preferences you'll get a confirmation message
155 telling you what preferences were saved:</para>
158 <screeninfo>Preference save confirmation message</screeninfo>
162 <imagedata fileref="images/admin/globalprefs/saveconfirmation.png"/>
167 <para>Each section of preferences can be sorted alphabetically by
168 clicking the small down arrow to the right of the word 'Preference' in
169 the header column</para>
172 <screeninfo>Sort option at the top right of each section of
173 preferences</screeninfo>
177 <imagedata fileref="images/admin/globalprefs/sortprefs.png"/>
182 <para>If the preference refers to monetary values (like <link linkend="maxoutstanding"
183 >maxoutstanding</link>) the currency displayed will be the default you set in your <link
184 linkend="currexchangeadmin">Currency and Exchange Rate</link> administration area. In the
185 examples to follow they will all read USD for U.S. Dollars.<important>
186 <para>For libraries systems with unique URLs for each site the system preference can be
187 overridden by editing your koha-http.conf file this has to be done by a system
188 administrator or someone with access to your system files. For example if all libraries
189 but one want to have search terms highlighted in results you set the
190 OpacHighlightedWords preference to 'Highlight' then edit the koha-http.conf for the
191 library that wants this turned off by adding 'SetEnv
192 OVERRIDE_SYSPREF_OpacHighlightedWords "0"'. After restarting the web server that one
193 library will no longer see highlighted terms. Consult with your system administrator
194 for more information.</para>
197 <section id="acqprefs">
198 <title>Acquisitions</title>
200 <para><emphasis>Get there:</emphasis> More > Administration >
201 Global System Preferences > Acquisitions</para>
203 <section id="acqprefspolicy">
204 <title>Policy</title>
206 <section id="AcqCreateItem">
207 <title>AcqCreateItem</title>
209 <para>Default: placing an order</para>
211 <para>Asks: Create an item when ___.</para>
217 <para>cataloging a record</para>
221 <para>placing an order</para>
225 <para>receiving an order</para>
229 <para>Description:</para>
233 <para>This preference lets you decide when you'd like to
234 create an item record in Koha. If you choose to add an item
235 record when 'placing an order' then you will enter item
236 information in as you place records in your basket. If you
237 choose to add the item when 'receiving an order' you will be
238 asked for item record information when you're receiving orders
239 in acquisitions. If you choose to add the item when
240 'cataloging a record' then item records will not be created in
241 acquisitions at all, you will need to go to the cataloging
242 module to add the items.</para>
246 <section id="AcqItemSetSubfieldsWhenReceived">
247 <title>AcqItemSetSubfieldsWhenReceived</title>
248 <para>Asks: ___ Set subfields for item when items are created when receiving (e.g.
249 o=5|a="foo bar") </para>
250 <para>Description:<itemizedlist>
252 <para>This preference allows you to set default values for items that you receive
253 via acquisitions. Enter the data as subfield=value and split your values with a
254 bar ( | ). For example you can remove the Ordered status on the item
255 automatically when you receive it just by entering 7=0 in this preference. That
256 will set the Not for Loan status (subfield 7) to 0 which is available.</para>
258 </itemizedlist></para>
261 <section id="AcqViewBaskets">
262 <title>AcqViewBaskets</title>
264 <para>Default: created by staff member</para>
266 <para>Asks: Show baskets ___</para>
272 <para>created by staff member</para>
276 <para>from staff member's branch</para>
280 <para>in system, regardless of owner</para>
284 <para>Description:</para>
288 <para>When in acquisitions this preference allows you to
289 control whose baskets you can see when looking at a vendor.
290 The default value of 'created by staff member' makes it so
291 that you only see the baskets you created. Choosing to see
292 baskets 'from staff member's branch' will show you the baskets
293 created by anyone at the branch you're logged in at. Finally,
294 you can choose to set this preference to show you all baskets
295 regardless of who created it ('in system, regardless of
296 owner). Regardless of which value you choose for this
297 preference, superlibrarians can see all baskets created in the
302 <section id="AcqWarnOnDuplicateInvoice">
303 <title>AcqWarnOnDuplicateInvoice</title>
304 <para>Default: Do not warn</para>
305 <para>Asks: ___ when the librarian tries to create an invoice with a duplicate
307 <para>Values: <itemizedlist>
309 <para>Do not warn</para>
314 </itemizedlist></para>
317 <section id="BasketConfirmations">
318 <title>BasketConfirmations</title>
320 <para>Default: always ask for confirmation</para>
322 <para>Asks: When closing or reopening a basket, ___.</para>
328 <para>always ask for confirmation</para>
332 <para>do not ask for confirmation</para>
336 <para>Descriptions:</para>
340 <para>This preference adds the option to skip confirmations on
341 closing and reopening a basket. If you skip the confirmation,
342 you do not create a new basket group.</para>
347 <section id="CurrencyFormat">
348 <title>CurrencyFormat</title>
350 <para>Default: 360,000.00 (US)</para>
352 <para>Asks: Display currencies using the following format
359 <para>360,000.00 (US)</para>
363 <para>360 000,00 (FR)</para>
371 <para>Default: 0</para>
373 <para>Asks: The default tax rate is ___</para>
375 <para>Description:</para>
379 <para>This preference will allow the library to define a
380 default Goods and Services Tax rate. The default of value of 0
381 will disable this preference.</para>
386 <para>Enter this value as a number (.06) versus a percent
391 <section id="UniqueItemFields">
392 <title>UniqueItemFields</title>
394 <para>Default: barcode</para>
396 <para>Asks:___ (space-separated list of fields that should be
397 unique for items, must be valid SQL fields of <ulink url="http://schema.koha-community.org/tables/items.html">items</ulink>
400 <para>Description:</para>
404 <para>If this preference is left blank when adding items in
405 acquisitions there will be no check for uniqueness. This means
406 that a duplicate barcode can be created in acquisitions which
407 will cause errors later when checking items in and out.</para>
413 <section id="acqprefsprinting">
414 <title>Printing</title>
416 <section id="OrderPdfFormat">
417 <title>OrderPdfFormat</title>
419 <para>Default: pdfformat::layout2pages</para>
421 <para>Asks: Use ___ when printing basket groups.</para>
426 <section id="adminprefs">
427 <title>Administration</title>
429 <para>These preferences are general settings for your system.</para>
431 <para><emphasis>Get there:</emphasis> More > Administration >
432 Global System Preferences > Administration</para>
434 <section id="casauthentication">
435 <title>CAS Authentication</title>
437 <para>The Central Authentication Service (CAS) is a single sign-on
438 protocol for the web. If you don't know what this is, leave these
439 preferences set to their defaults.</para>
441 <section id="AllowPKIAuth">
442 <title>AllowPKIAuth</title>
444 <para>Default: no</para>
446 <para>Asks: Use ___ field for SSL client certificate
447 authentication</para>
457 <para>the common name</para>
461 <para>the email address</para>
466 <section id="casAuthentication">
467 <title>casAuthentication</title>
469 <para>Default: Don't use</para>
471 <para>Asks: ___ CAS for login authentication.</para>
474 <section id="casLogout">
475 <title>casLogout</title>
477 <para>Default: Don't logout</para>
479 <para>Asks: ___ of CAS when logging out of Koha.</para>
482 <section id="casServerUrl">
483 <title>casServerUrl</title>
485 <para>Asks: The CAS Authentication Server can be found at
490 <section id="adminprefsinterface">
491 <title>Interface options</title>
493 <para>These preference are related to your Koha interface</para>
495 <section id="DebugLevel">
496 <title>DebugLevel</title>
498 <para>Default: lots of</para>
500 <para>Asks: Show ___ debugging information in the browser when an
501 internal error occurs.</para>
507 <para>lots of - will show as much information as
512 <para>no - will only show basic error messages</para>
516 <para>some - will show only some of the information
521 <para>Description:</para>
525 <para>This preference determines how much information will be
526 sent to the user's screen when the system encounters an error.
527 The most detail will be sent when the value level is set at 2,
528 some detail will be sent when the value is set at 1, and only
529 a basic error message will display when the value is set at 0.
530 This setting is especially important when a system is new and
531 the administration is interested in working out the bugs
532 (errors or problems) quickly. Having detailed error messages
533 makes quick fixes more likely in problem areas.</para>
538 <section id="delimiter">
539 <title>delimiter</title>
541 <para>Default: semicolons</para>
543 <para>Asks: Separate columns in an exported report file with ___
554 <para>backslashes</para>
562 <para>semicolons</para>
574 <para>Description:</para>
578 <para>This preference determines how reports exported from
579 Koha will separate data. In many cases you will be able to
580 change this option when exporting if you'd like.</para>
585 <section id="KohaAdminEmailAddress">
586 <title>KohaAdminEmailAddress</title>
588 <para>This is the default 'From' address for emails unless there
589 is one for the particular branch, and is referred to when an
590 internal error occurs.</para>
592 <para>Asks: Use ___ as the email address for the administrator of
595 <para>Description:</para>
599 <para>This preference allows one email address to be used in
600 warning messages set to the OPAC. If no email address is set
601 for the branch this address will receive messages from patrons
602 regarding modification requests, purchase suggestions, and
603 questions or information regarding overdue notices. It is
604 recommended that a email address that can be accessed by
605 multiple staff members be used for this purpose so that if one
606 librarian is out the others can address these requests. This
607 email address can be changed when needed.</para>
612 <section id="noItemTypeImages">
613 <title>noItemTypeImages</title>
615 <para>Default: Show</para>
617 <para>Asks: ___ itemtype icons in the catalog.</para>
627 <para>Don't show</para>
631 <para>Description:</para>
635 <para>This preference allows the system administrator to
636 determine if users will be able to set and see an <link linkend="itemtypeadmin">item type icon</link> the catalog on
637 both the OPAC and the Staff Client. The images will display in
638 both the OPAC and the Staff Client/Intranet. If images of item
639 types are disabled, text labels for item types will still
640 appear in the OPAC and Staff Client.</para>
645 <section id="virtualshelves">
646 <title>virtualshelves</title>
648 <para>Default: Allow</para>
650 <para>Asks: ___ staff and patrons to create and view saved lists
661 <para>Don't Allow</para>
665 <para>Description:</para>
669 <para>This preference controls whether the lists functionality
670 will be available in the staff client and OPAC. If this is set
671 to "Don't allow" then no one will be able to save items to
672 public or private lists.</para>
678 <section id="adminprefslogin">
679 <title>Login options</title>
681 <para>These preferences are related to logging into your Koha
684 <section id="AutoLocation">
685 <title>AutoLocation</title>
687 <para>Default: Don't require</para>
689 <para>Asks: ___ staff to log in from a computer in the IP address
690 range specified by their library (if any).</para>
694 <para>Set IP address range in the library administration
699 <para><emphasis>Get there:</emphasis> More >
700 Administration > Basic Parameters > <link linkend="libsgroups">Libraries & Groups</link></para>
710 <para>Don't require</para>
718 <para>Description:</para>
722 <para>This preference protects the system by blocking
723 unauthorized users from accessing the staff client program and
724 settings. Authorized and unauthorized users are determined by
725 their computer's IP addresses. When the preference is set to
726 'Require', IP authorization is in effect and unauthorized IP
727 addresses will be blocked. This means that staff cannot work
728 from home unless their IP address has been authorized. When
729 set to 'Don't require', anyone with a staff client login will
730 have access no matter which IP address they are using.</para>
735 <section id="IndependentBranches">
736 <title>IndependentBranches</title>
737 <para>Default: Don't prevent</para>
738 <para>Asks: ___ staff (but not superlibrarians) from modifying objects (holds, items,
739 patrons, etc.) belonging to other libraries.</para>
743 <para>Don't prevent</para>
749 <para>Description:</para>
752 <para>This preference should only be used by library systems which are sharing a
753 single Koha installation among multiple branches but are considered independent
754 organizations, meaning they do not share material or patrons with other branches
755 and do not plan to change that in the future. If set to 'Prevent' it increases the
756 security between library branches by: prohibiting staff users from logging into
757 another branch from within the staff client, filtering out patrons from patron
758 searches who are not a part of the login branch conducting the search, limiting
759 the location choices to the login branch when adding or modifying an item record,
760 preventing users from other branch locations from placing holds or checking out
761 materials from library branches other than their own, and preventing staff from
762 editing item records which belong to other library branches. All of these security
763 safeguards can be overridden only by the superlibrarian, the highest level of
768 <para>It is important that this value be set before going live and that it NOT be
773 <section id="SessionStorage">
774 <title>SessionStorage</title>
776 <para>Default: in the MySQL database</para>
778 <para>Asks: Store login session information ___</para>
784 <para>as temporary files</para>
788 <para>in the MySQL database</para>
792 <para>in the PostgreSQL database</para>
797 <para>PostgreSQL is not yet supported</para>
804 <para>Description:</para>
808 <para>This preference allows administrators to choose what
809 format session data is stored in during web sessions.</para>
814 <section id="timeout">
815 <title>timeout</title>
817 <para>Default: 12000000</para>
819 <para>Asks: Automatically log out users after ___ seconds of inactivity.</para>
821 <para>Description:</para>
825 <para>This preference sets the length of time the Staff Client
826 or OPAC accounts can be left inactive before re-logging in is
827 necessary. The value of this preference is in seconds. At this
828 time, the amount of time before a session times out must be
829 the same for both the Staff Client and the OPAC.</para>
834 <section id="mozillapersona">
835 <title>Mozilla Persona</title>
836 <section id="persona">
837 <title>Persona</title>
838 <para>Default: Don't allow</para>
839 <para>Asks: ___ Mozilla persona for login.</para>
845 <screeninfo>Persona login on OPAC</screeninfo>
848 <imagedata fileref="images/admin/globalprefs/persona.png"/>
854 <para>Don't allow</para>
857 <para>Description:<itemizedlist>
859 <para>Mozilla Persona is an OpenID-like service that lets you log in to multiple
860 websites with your Mozilla credentials. If you allow Persona log in for Koha
861 then your patrons can log in to the OPAC using their Mozilla Persona. Learn
862 more about Persona on the <ulink url="http://www.mozilla.org/en-US/persona/">official Mozilla site</ulink>.<important>
863 <para>For Persona log in to work you will need you <link linkend="OPACBaseURL">OPACBaseURL</link> preference to be set correctly.</para>
866 </itemizedlist></para>
869 <section id="searchengineprefs">
870 <title>Search Engine</title>
871 <section id="SearchEngine">
872 <title>SearchEngine</title>
874 <para>This preference is highly experimental and should not be changed from the
875 default value in a production environment.</para>
877 <para>Default: Zebra</para>
878 <para>Asks: ___ is the search engine used. </para>
879 <para>Values:<itemizedlist>
886 </itemizedlist></para>
887 <para>Description:<itemizedlist>
889 <para>This preference will be used to control which search engine Koha uses for
890 catalog searches in the OPAC and the staff client.</para>
892 </itemizedlist></para>
897 <section id="authprefs">
898 <title>Authorities</title>
900 <para><emphasis>Get there:</emphasis> More > Administration >
901 Global System Preferences > Authorities</para>
903 <section id="generalauthorities">
904 <title>General</title>
906 <section id="AuthDisplayHierarchy">
907 <title>AuthDisplayHierarchy</title>
909 <para>Default: Don't display</para>
911 <para>Asks: ___ broader term/narrower term hierarchies when
912 viewing authorities.</para>
921 <screeninfo>AuthDisplayHierarchy</screeninfo>
925 <imagedata fileref="images/admin/globalprefs/AuthDisplayHierarchy.png"/>
932 <para>Don't display</para>
936 <para>Description:</para>
940 <para>If your authority records includes 5xx fields with
941 linked references to broader and/or narrower see also
942 references this preference will turn on a display of those
943 authorities at the top of the record.</para>
948 <section id="AutoCreateAuthorities">
949 <title>AutoCreateAuthorities</title>
951 <para>Default: do not generate</para>
953 <para>Asks: When editing records, ___ authority records that are
960 <para>do not generate</para>
964 <para>generate</para>
969 <para><link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
970 must be set to "allow" for this to have any effect</para>
973 <para>Description:</para>
977 <para>When this and <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
978 are both turned on, automatically create authority records for
979 headings that don't have any authority link when cataloging.
980 When BiblioAddsAuthorities is on and AutoCreateAuthorities is
981 turned off, do not automatically generate authority records,
982 but allow the user to enter headings that don't match an
983 existing authority. When BiblioAddsAuthorities is off, this
984 has no effect.</para>
989 <section id="BiblioAddsAuthorities">
990 <title>BiblioAddsAuthorities</title>
992 <para>Default: allow</para>
994 <para>Asks: When editing records, ___ them to automatically create
995 new authority records if needed, rather than having to reference
996 existing authorities.</para>
1006 <para>This setting allows you to type values in the fields
1007 controlled by authorities and then adds a new authority if
1008 one does not exist</para>
1014 <para>don't allow</para>
1018 <para>This setting will lock the authority controlled
1019 fields, forcing you to search for an authority versus
1020 allowing you to type the information in yourself.</para>
1027 <section id="dontmerge">
1028 <title>dontmerge</title>
1030 <para>Default: Don't</para>
1032 <para>Asks: ___ automatically update attached biblios when
1033 changing an authority record.</para>
1035 <para>Values:</para>
1047 <para>Description:</para>
1051 <para>This preference tells Koha how to handle changes to your Authority records. If
1052 you edit an authority record and this preference is set to 'Do' Koha will
1053 immediately update all of the bib records linked to the authority with the new
1054 authority record's data. If this is set to "Don't" then Koha won't edit bib
1055 records when changes are made to authorities, rather, this is done later by the
1056 <link linkend="mergeauthcron">merge_authority.pl cronjob</link>.</para>
1061 <para>If this is set to "Don't automatically update" you will need to ask your
1062 administrator to enable the <link linkend="mergeauthcron">merge_authority.pl
1063 cronjob</link>.</para>
1067 <section id="MARCAuthorityControlField008">
1068 <title>MARCAuthorityControlField008</title>
1070 <para>Default: || aca||aabn | a|a d</para>
1072 <para>Asks: Use the following text for the contents of MARC
1073 authority control field 008 position 06-39 (fixed length data
1077 <para>Do not include the date (position 00-05) in this
1078 preference, Koha will calculate automatically and put that in
1079 before the values in this preference.</para>
1080 </important>Description:</para>
1084 <para>This preference controls the default value in the 008
1085 field on Authority records. It does not effect bibliographic
1090 <section id="UNIMARCAuthorityField100">
1091 <title>UNIMARCAuthorityField100</title>
1092 <para>Default: afrey50 ba0</para>
1093 <para>Asks: Use the following text for the contents of UNIMARC authority field 100
1094 position (fixed length data elements). <important>
1095 <para>Do not include the date (position 00-07) in this preference, Koha will
1096 calculate automatically and put that in before the values in this
1099 <para>Description:<itemizedlist>
1101 <para>This preference controls the default value in the 100 field on Authority
1102 records cataloged in UNIMARC. It does not effect bibliographic records.</para>
1104 </itemizedlist></para>
1107 <section id="UseAuthoritiesForTracings">
1108 <title>UseAuthoritiesForTracings</title>
1110 <para>Default: Don't use</para>
1112 <para>Asks: ___ authority record numbers instead of text strings
1113 for searches from subject tracings.</para>
1115 <para>Values:</para>
1119 <para>Don't use</para>
1123 <para>Search links look for subject/author keywords
1124 (example: opac-search.pl?q=su:Business%20networks)</para>
1134 <para>Search links look for an authority record (example:
1135 opac-search.pl?q=an:354)</para>
1141 <para>Description:</para>
1145 <para>For libraries that have authority files, they may want
1146 to make it so that when a link to an authorized subject or
1147 author is clicked on the OPAC or staff client it takes the
1148 searcher only to a list of results with that authority record.
1149 Most libraries do not have complete authority files and so
1150 setting this preference to 'Don't use' will allow searchers to
1151 click on links to authors and subject headings and perform a
1152 keyword search against those fields, finding all possible
1153 relevant results instead.</para>
1159 <section id="linkerauthorities">
1160 <title>Linker</title>
1162 <para>These preferences will control how Koha links bibliographic records to authority
1163 records. All bibliographic records added to Koha after these preferences are set will
1164 link automatically to authority records, for records added before these preferences are
1165 set there is a script (misc/link_bibs_to_authorities.pl) that your system administrator
1166 can run to link records together.</para>
1168 <section id="CatalogModuleRelink">
1169 <title>CatalogModuleRelink</title>
1171 <para>Default: Do not</para>
1173 <para>Asks: ___ automatically relink headings that have previously
1174 been linked when saving records in the cataloging module.</para>
1176 <para>Values:</para>
1188 <para>Description:</para>
1192 <para>Longtime users of Koha don't expect the authority and
1193 bib records to link consistently. This preference makes it
1194 possible to disable authority relinking in the cataloging
1195 module only (i.e. relinking is still possible if
1196 link_bibs_to_authorities.pl is run). Note that though the
1197 default behavior matches the previous behavior of Koha
1198 (retaining links to outdated authority records), it does not
1199 match the intended behavior (updating biblio/authority link
1200 after bibliographic record is edited). Libraries that want the
1201 intended behavior of authority control rather than the way
1202 Koha used to handle linking should set CatalogModuleRelink to
1203 'Do'. Once setting this to 'Do' the following preferences can
1209 <section id="LinkerKeepStale">
1210 <title>LinkerKeepStale</title>
1212 <para>Default: Do not</para>
1214 <para>Asks: ___ keep existing links to authority records for
1215 headings where the linker is unable to find a match.</para>
1217 <para>Values:</para>
1229 <para>Description:</para>
1233 <para>When set to 'Do', the linker will never remove a link to
1234 an authority record, though, depending on the value of <link linkend="LinkerRelink">LinkerRelink</link>, it may change the
1240 <section id="LinkerModule">
1241 <title>LinkerModule</title>
1243 <para>Default: Default</para>
1245 <para>Asks: Use the ___ linker module for matching headings to
1246 authority records.</para>
1248 <para>Values:</para>
1252 <para>Default</para>
1256 <para>Retains Koha's previous behavior of only creating
1257 links when there is an exact match to one and only one
1258 authority record; if the <link linkend="LinkerOptions">LinkerOptions</link> preference is
1259 set to 'broader_headings', it will try to link headings to
1260 authority records for broader headings by removing
1261 subfields from the end of the heading</para>
1267 <para>First match</para>
1271 <para>Creates a link to the first authority record that
1272 matches a given heading, even if there is more than one
1273 authority record that matches</para>
1279 <para>Last match</para>
1283 <para>Creates a link to the last authority record that
1284 matches a given heading, even if there is more than one
1285 record that matches</para>
1291 <para>Description:</para>
1295 <para>This preference tells Koha which match to use when
1296 searching for authority matches when saving a record.</para>
1301 <section id="LinkerOptions">
1302 <title>LinkerOptions</title>
1304 <para>Asks: Set the following options for the authority linker
1306 <para>This feature is experimental and shouldn't be used in a
1307 production environment until further expanded upon.</para>
1310 <para>Description:</para>
1314 <para>This is a pipe separated (|) list of options. At the
1315 moment, the only option available is "broader_headings." With
1316 this option set to "broader_headings", the linker will try to
1317 match the following heading as follows:<programlisting>=600 10$aCamins-Esakov, Jared$xCoin collections$vCatalogs$vEarly works to 1800.</programlisting></para>
1319 <para>First: Camins-Esakov, Jared--Coin
1320 collections--Catalogs--Early works to 1800</para>
1322 <para>Next: Camins-Esakov, Jared--Coin
1323 collections--Catalogs</para>
1325 <para>Next: Camins-Esakov, Jared--Coin collections</para>
1327 <para>Next: Camins-Esakov, Jared (matches! if a previous
1328 attempt had matched, it would not have tried this)</para>
1333 <section id="LinkerRelink">
1334 <title>LinkerRelink</title>
1336 <para>Default: Do</para>
1338 <para>Asks: ___ relink headings that have previously been linked
1339 to authority records.</para>
1341 <para>Values:</para>
1353 <para>Description:</para>
1357 <para>When set to 'Do', the linker will confirm the links for
1358 headings that have previously been linked to an authority
1359 record when it runs, correcting any incorrect links it may
1360 find. When set to 'Do not', any heading with an existing link
1361 will be ignored, even if the existing link is invalid or
1369 <section id="catprefs">
1370 <title>Cataloging</title>
1372 <para><emphasis>Get there:</emphasis> More > Administration >
1373 Global System Preferences > Cataloging</para>
1375 <section id="catdisplayprefs">
1376 <title>Display</title>
1380 <section id="authoritysep">
1381 <title>authoritysep</title>
1383 <para>Default: --</para>
1385 <para>Asks: Separate multiple displayed authors, series or
1386 subjects with ___.</para>
1389 <section id="hide_marc">
1390 <title>hide_marc</title>
1392 <para>Default: Display</para>
1394 <para>Asks: ___ MARC tag numbers, subfield codes and indicators in
1397 <para>Values:</para>
1401 <para>Display -- shows the tag numbers on the cataloging
1405 <screeninfo>MARC editor with tags showing</screeninfo>
1409 <imagedata fileref="images/admin/globalprefs/hide_marc-display.png"/>
1416 <para>Don't display -- shows just descriptive text when
1420 <screeninfo>MARC editor without tags showing</screeninfo>
1424 <imagedata fileref="images/admin/globalprefs/hide_marc-dont.png"/>
1432 <section id="IntranetBiblioDefaultView">
1433 <title>IntranetBiblioDefaultView</title>
1435 <para>Default: ISBD form</para>
1437 <para>Asks: By default, display biblio records in ___</para>
1439 <para>Values:</para>
1443 <para>ISBD form -- displays records in the staff client in the
1444 old card catalog format</para>
1448 <para>See <link linkend="isbdpref">ISBD</link> preference
1449 for more information</para>
1455 <para>Labelled MARC form -- displays records in the staff
1456 client in MARC with text labels to explain the different
1461 <para>MARC form -- displays records in the staff client in
1466 <para>normal form -- visual display in the staff client (for
1467 the average person)</para>
1471 <para>Description:</para>
1475 <para>This setting determines the bibliographic record display
1476 when searching the catalog on the staff client. This setting
1477 does not affect the display in the OPAC which is changed using
1478 the <link linkend="BiblioDefaultView">BiblioDefaultView</link>
1479 preference under the OPAC preference tab. This setting changes
1480 the look of the record when first displayed. The MARC and ISBD
1481 views can still be seen by clicking in the sidebar.</para>
1486 <section id="isbdpref">
1489 <para>Default: <link linkend="isbddefault">MARC21 Default
1490 Appendix</link> or <link linkend="unimarcdefault">UNIMARC Default
1491 Appendix</link></para>
1493 <para>Asks: Use the following as the ISBD template:</para>
1495 <para>Description:</para>
1499 <para>This determines how the ISBD information will display.
1500 Elements in the list can be reordered to produce a different
1501 ISBD view. ISBD, the International Standard Bibliographic
1502 Description, was first introduced by IFLA (International
1503 Federation of Library Associations) in 1969 in order to
1504 provide guidelines for descriptive cataloging. The purpose of
1505 ISBD is to aid the international exchange of bibliographic
1506 records for a variety of materials.</para>
1511 <section id="LabelMARCView">
1512 <title>LabelMARCView</title>
1514 <para>Default: Don't</para>
1516 <para>Asks: ___ collapse repeated tags of the same type into one
1519 <para>Values:</para>
1523 <para>Do -- will combine all identical tag numbers under one
1524 heading in the MARC view in the OPAC and Staff Client</para>
1527 <screeninfo>MARC View in the Staff Client with LabelMARCView
1528 set to Do</screeninfo>
1532 <imagedata fileref="images/admin/globalprefs/LabelMARCView-do.png"/>
1539 <para>Don't -- will list all of the tags individually in the
1540 MARC view in the OPAC and Staff Client</para>
1543 <screeninfo>MARC View in the Staff Client with LabelMARCView
1544 set to Don't</screeninfo>
1548 <imagedata fileref="images/admin/globalprefs/LabelMARCView-dont.png"/>
1555 <section id="NotesBlacklist">
1556 <title>NotesBlacklist</title>
1557 <para>Asks: Don't show these ___ note fields in title notes separator (OPAC record
1558 details) and in the description separator (Staff client record details). </para>
1559 <para>Description:<itemizedlist>
1561 <para>This preference lets you define which of your note fields are hidden from
1562 the title notes (OPAC) and descriptions (Staff) tabs. Enter the values as a
1563 comma separated list. For example to hide the local note and the bibliography
1564 note in MARC21 enter 504, 590.</para>
1566 </itemizedlist></para>
1569 <section id="OpacSuppression">
1570 <title>OpacSuppression and OpacSuppressionByIPRange</title>
1571 <para>OpacSuppression Default: Don't hide</para>
1573 <para>Asks: ___ items marked as suppressed from OPAC search
1574 results. Restrict the suppression to IP adresses outside of the IP
1577 <para>OpacSuppression Values:</para>
1581 <para>Don't hide</para>
1585 <para>Will show records in OPAC search results if they are marked
1596 <para>Will not show records in OPAC search results if they're marked as
1603 <para>Description:</para>
1607 <para>These preferences control hiding of bibliographic records from display in the
1608 OPAC. Each bibliogrphic record you want to hide from the OPAC simply needs to have
1609 the value "1" in the field mapped with Suppress index (942$n field in MARC21, no
1610 official field in UNIMARC). The indexer then hides it from display in OPAC but
1611 will still display it in the Staff Client. If you want to further control
1612 suppression you can set an IP address range to still show suppressed items to.
1613 Define a range like 192.168.. If you don't want to limit suppression in this way,
1614 leave the IP field blank.</para>
1617 <para>An <link linkend="authorizedvalues">authorized value</link> for the MARC21
1618 942$n field (or the equivalent UNIMARC field) should be set to eliminate
1619 errors. One example would be to create an authorized value titled SUPPRESS
1620 with a value of 0 for don't suppress and 1 for suppress.</para>
1627 <para>If this preference is set to 'hide' and you have the 942n
1628 field set to 1, it will hide the entire bib record - not just an
1629 individual item.</para>
1633 <para>You must have the Suppress index set up in Zebra and at least one record with
1634 the value "1" in the field mapped with this index, or your searches will be
1635 completely broken in OPAC (you won't get any results at all).</para>
1638 <section id="SeparateHoldings">
1639 <title>SeparateHoldings & SeparateHoldingsBranch </title>
1640 <para>SeparateHoldings default: Don't separate</para>
1641 <para>SeparateHoldingsBranch default: home library </para>
1642 <para>Asks: ___ items display into two tabs, where the first tab contains items whose
1643 ___ is the logged in user's library. The second tab will contain all other items. </para>
1644 <para>SeparateHoldings values:<itemizedlist>
1646 <para>Don't separate</para>
1649 <para>Separate</para>
1651 </itemizedlist></para>
1652 <para>SeparateHoldingsBranch values:<itemizedlist>
1654 <para>holding library</para>
1657 <para>home library</para>
1659 </itemizedlist></para>
1660 <para>Description:</para>
1663 <para>This preference lets you decide if you would like to have the holding
1664 information on the bibliographic detail page in the staff client split in to
1665 multiple tabs. The default is to show all holdings on one tab.</para>
1667 <screeninfo>Separate holdings tabs</screeninfo>
1670 <imagedata fileref="images/admin/globalprefs/SeparateHoldings.png"/>
1678 <section id="URLLinkText">
1679 <title>URLLinkText</title>
1681 <para>Default: Online Resource</para>
1683 <para>Asks: Show ___ as the text of links embedded in MARC
1686 <para>Description:</para>
1690 <para>If the 856 field does not have a subfield 3 or y
1691 defined, the OPAC will say 'Click here to access online.' If
1692 you would like the field to say something else enter that in
1698 <section id="UseControlNumber">
1699 <title>UseControlNumber</title>
1701 <para>Default: Don't use</para>
1703 <para>Asks: ___ record control number ($w subfields) and control
1704 number (001) for linking of bibliographic records.</para>
1706 <para>Values:</para>
1710 <para>Don't use</para>
1714 <para>When clicking on links to titles that appear next to
1715 'Continues' and 'Continued by' in the detail display Koha
1716 will perform a title search</para>
1726 <para>When clicking on links to titles that appear next to
1727 'Continues' and 'Continued by' in the detail display Koha
1728 will perform a control number (MARC field 001)
1736 <para>Unless you are going in and manually changing 773$w to
1737 match your rigorously-defined bibliographic relationships, you
1738 should set this preference to "Don't use" and instead set <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link> to
1742 <para>Description:</para>
1746 <para>If you have a serial called "Journal of Interesting
1747 Things" which has a separate record from when it was called
1748 "Transactions of the Interesting Stuff Society," you could add
1749 linking fields to indicate the relationship between the two
1750 records. UseControlNumber allows you to use your local
1751 accession numbers for those links. In MARC21, the relevant
1752 sections of the two records might look like
1753 this:<programlisting> =001 12345
1754 =110 2_$aInteresting Stuff Society.
1755 =245 10$aTransactions of the Interesting Stuff Society.
1756 =785 00$aInteresting Stuff Society$tJournal of Interesting Things.$w12346
1759 =110 2_$aInteresting Stuff Society.
1760 =245 10$aJournal of Interesting Things.
1761 =780 00$aInteresting Stuff Society$tTransactions of the Interesting Stuff Society.$w12345</programlisting></para>
1763 <para>With UseControlNumber set to 'Use', the 78x links will
1764 use the Control Numbers is subfield $w, instead of doing a
1765 title search on "Journal of Interesting Things" and
1766 "Transactions of the Interesting Stuff Society"
1767 respectively.</para>
1773 <section id="catinterfaceprefs">
1774 <title>Interface</title>
1778 <section id="advancedMARCeditor">
1779 <title>advancedMARCeditor</title>
1781 <para>Default: Don't display</para>
1783 <para>Asks: ___ descriptions of fields and subfields in the MARC
1786 <para>Description:</para>
1790 <para>This preference determines whether or not MARC field
1791 names will be present when editing or creating MARC
1796 <para>Values:</para>
1800 <para>Display</para>
1803 <screeninfo>MARC editor with text labels</screeninfo>
1807 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-display.png"/>
1814 <para>Don't display</para>
1817 <screeninfo>MARC editor without text labels</screeninfo>
1821 <imagedata fileref="images/admin/globalprefs/advancedMARCeditor-dontdisplay.png"/>
1829 <section id="DefaultClassificationSource">
1830 <title>DefaultClassificationSource</title>
1832 <para>Default: Dewey Decimal System</para>
1834 <para>Asks: Use ___ as the default classification source.</para>
1836 <para>Values:</para>
1840 <para>ANSCR (Sound Recordings)</para>
1844 <para>Dewey Decimal Classification</para>
1848 <para>Library of Congress Classification</para>
1852 <para>Other/Generic Classification Scheme</para>
1856 <para>SuDoc Classification (U.S. GPO)</para>
1860 <para>Universal Decimal Classification</para>
1865 <section id="EasyAnalyticalRecords">
1869 <firstname>Linda</firstname>
1870 <surname>Culberson</surname>
1872 <orgname>Ms. Dept. of Archives and History</orgname>
1877 <firstname>Nicole C.</firstname>
1878 <surname>Engard</surname>
1879 <contrib>Fixed typos, changed content
1880 where necessary and added new screenshots.</contrib>
1884 <pubdate>October 2011</pubdate>
1887 <title>EasyAnalyticalRecords</title>
1888 <para>Default: Don't Display</para>
1890 <para>Asks: ___ easy ways to create analytical record
1891 relationships</para>
1893 <para>Values:</para>
1897 <para>Display</para>
1901 <para>Don't Display</para>
1906 <para>If you decide to use this feature you'll want to make sure
1907 that your <link linkend="UseControlNumber">UseControlNumber</link> preference is
1908 set to "Don't use" or else the "Show analytics" links in the
1909 staff client and the OPAC will be broken.</para>
1912 <para>Description:</para>
1916 <para>An analytic entry in a catalog is one that describes a
1917 part of a larger work that is also described in the catalog.
1918 In bibliographic cataloging, analytic entries may be made for
1919 chapters in books or special issues of articles in
1920 periodicals. In archival cataloging, analytic entries may be
1921 made for series or items within a collection. This feature in
1922 Koha allows for an easy way of linking analytic entries to the
1923 host records, and this system preference adds several new menu
1924 options to the staff cataloging detail pages to allow that to
1931 <section id="catrecordprefs">
1932 <title>Record Structure</title>
1936 <section id="AlternateHoldingsField">
1937 <title>AlternateHoldingsField &
1938 AlternateHoldingsSeparator</title>
1940 <para>Asks: Display MARC subfield ___ as holdings information for
1941 records that do not have items, with the subfields separated by
1944 <para>Description:</para>
1948 <para>Sometimes libraries migrate to Koha with their holding
1949 info in the 852 field (OCLC holdings information field) and
1950 choose not to transfer that information into the 952 (Koha
1951 holdings information field) because they don't plan on
1952 circulating those items. For those libraries or other
1953 libraries that have data in the 852 fields of their records
1954 that they want to display, these preferences let you choose to
1955 display holdings info from a field other than the 952 field.
1956 The AlternateHoldingsField preference can contain multiple
1957 subfields to look in; for instance 852abhi would look in 852
1958 subfields a, b, h, and i.</para>
1962 <para>With AlternateHoldingsField set to 852abhi and
1963 AlternateHoldingsSeparator set to a space the holdings would
1964 look like the following:</para>
1967 <screeninfo>Alternate Holdings Display</screeninfo>
1971 <imagedata fileref="images/admin/globalprefs/AlternateHoldingsField.png"/>
1979 <section id="autoBarcode">
1980 <title>autoBarcode</title>
1982 <para>Default: generated in the form
1983 <branchcode>yymm0001</para>
1985 <para>Asks: Barcodes are ___</para>
1987 <para>Values:</para>
1991 <para>generated in the form <branchcode>yymm0001</para>
1995 <para>generated in the form <year>-0001, <year>-0002</para>
1999 <para>generated in the form 1, 2, 3</para>
2003 <para>incremental EAN-13 barcodes</para>
2007 <para>not generated automatically</para>
2011 <para>Description:</para>
2015 <para>This setting is for libraries wishing to generate
2016 barcodes from within Koha (as opposed to scanning in
2017 pre-printed barcodes or manually assigning them). The default
2018 behavior makes it so that when you click in the barcode field
2019 (952$p in MARC21) it will populate with the automatic barcode
2020 you have chosen. If you would rather it only enter an
2021 automatic barcode when you click on the plugin (the ... to the
2022 right of the field) you can change the plugin used for that
2023 field in the framework. Set the plugin for 952$p (if using
2024 MARC21 or equivalent field mapped to items.barcode in your
2025 local MARC format) for your frameworks to barcode_manual.pl
2026 instead of barcode.pl. Learn more about editing frameworks
2027 under the <link linkend="marcbibframeworks">MARC Bibliographic
2028 Frameworks</link> section of this manual.</para>
2033 <section id="DefaultLanguageField008">
2034 <title>DefaultLanguageField008</title>
2036 <para>Asks: Fill in the default language for field 008 Range 35-37
2039 <para>Description:</para>
2043 <para>This preference will allow you to set the language for your MARC21 008 field
2044 by default. If this is left empty it will default to English (eng). See the <ulink
2045 url="http://www.loc.gov/marc/languages/language_code.html">MARC Code List for
2046 Languages</ulink> for additional values for this preference.</para>
2050 <para>This preference won't have any effect if your records are in UNIMARC.</para>
2054 <section id="item-level_itypes">
2055 <title>item-level_itypes</title>
2057 <para>Default: specific item</para>
2059 <para>Asks: Use the item type of the ___ as the authoritative item
2060 type (for determining circulation and fines rules, etc).</para>
2062 <para>Values:</para>
2066 <para>biblio record</para>
2070 <para>specific item</para>
2074 <para>Description:</para>
2078 <para>This preference determines whether the item type Koha
2079 uses for issuing rules will be an attribute of the
2080 bibliographic record or the item record. Most libraries refer
2081 to the item record for item types. It also determines if the
2082 item type icon appears on the OPAC search results. If you have
2083 the preference set to 'biblio record' then Koha displays the
2084 item type icon on the search results to the left of the result
2088 <screeninfo>Item Type Icons to the Left of Result
2089 Information</screeninfo>
2093 <imagedata fileref="images/admin/globalprefs/item-level_itypes.png"/>
2101 <section id="itemcallnumber">
2102 <title>itemcallnumber</title>
2104 <para>Default: 082ab</para>
2106 <para>Asks: Map the MARC subfield to an item's callnumber.</para>
2109 <para>This can contain multiple subfields to look in; for
2110 instance 082ab would look in 082 subfields a and b.</para>
2113 <para>Description:</para>
2117 <para>This setting determines which MARC field will be used to
2118 determine the call number that will be entered into item
2119 records automatically (952$o). The value is set by providing
2120 the MARC field code (050, 082, 090, 852 are all common) and
2121 the subfield codes without the delimiters ($a, $b would be
2126 <para>Examples:</para>
2130 <para>Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the
2131 item record: 852hi</para>
2136 <section id="marcflavour">
2137 <title>marcflavour</title>
2139 <para>Default: MARC21</para>
2141 <para>Asks: Interpret and store MARC records in the ___
2144 <para>Values:</para>
2148 <para>MARC21<itemizedlist>
2150 <para>The standard style for the US, Canada, Australia, New Zealand, United
2151 Kingdom, Germany and other countries</para>
2153 </itemizedlist></para>
2157 <para>UNIMARC<itemizedlist>
2159 <para>The standard style used in France, Italy, Portugal, Russia, and other
2162 </itemizedlist></para>
2165 <para>NORMARC<itemizedlist>
2167 <para>The standard style for Norway</para>
2169 </itemizedlist></para>
2172 <para>Description:</para>
2175 <para>This preference defines global MARC style (MARC21, UNIMARC or NORMARC) used
2176 for encoding.</para>
2180 <para>Changing the value of this preference will not convert your records from one
2181 MARC style to an other.</para>
2185 <section id="MARCOrgCode">
2186 <title>MARCOrgCode</title>
2188 <para>Default: OSt</para>
2190 <para>Asks: Fill in the MARC organization code ___ by default in
2191 new MARC records (leave blank to disable).</para>
2193 <para>Description:</para>
2197 <para>The MARC Organization Code is used to identify libraries
2198 with holdings of titles and more.</para>
2202 <para>Learn more and find your library's MARC21 code on the <ulink
2203 url="http://www.loc.gov/marc/organizations/orgshome.html">MARC Code list for
2204 Organizations</ulink> or in Canada on the <ulink
2205 url="http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1">Canadian
2206 Symbols Directory</ulink>.<tip>
2207 <para>This preference won't have any effect if your records are in UNIMARC.</para>
2211 <section id="NewItemsDefaultLocation">
2212 <title>NewItemsDefaultLocation</title>
2214 <para>Asks: When items are created, give them the temporary
2215 location of ___ (should be a location code, or blank to
2218 <section id="PrefillItem">
2219 <title>PrefillItem</title>
2220 <para>Default: the new item is not prefilled with last created item values.</para>
2221 <para>Asks: When a new item is added ___</para>
2222 <para>Values:<itemizedlist>
2224 <para>the new item is not prefilled with last created item values.</para>
2227 <para>the new item is prefilled with last created item values.</para>
2229 </itemizedlist></para>
2230 <para>Description:<itemizedlist>
2232 <para>This preference controls the behavior used when adding new items. Using the
2233 options here you can choose to have your next new item prefill with the values
2234 used in the last item was added to save time typing values or to have the item
2235 form appear completely blank. Using <link linkend="SubfieldsToUseWhenPrefill">SubfieldsToUseWhenPrefill</link> you can control specifically which fields
2236 are prefilled.</para>
2238 </itemizedlist></para>
2240 <section id="SubfieldsToUseWhenPrefill">
2241 <title>SubfieldsToUseWhenPrefill</title>
2242 <para>Asks: Define a list of subfields to use when prefilling items ___<important>
2243 <para>Separate values with a space.</para>
2245 <para>Description:<itemizedlist>
2247 <para>When the <link linkend="PrefillItem">PrefillItem</link> preference is set to
2248 prefill item values with those from the last added item, this preference can
2249 control which fields are prefilled (and which are not). Enter a space separated
2250 list of fields that you would like to prefill when adding a new item.</para>
2252 </itemizedlist></para>
2255 <section id="z3950NormalizeAuthor">
2256 <title>z3950NormalizeAuthor & z3950AuthorAuthFields</title>
2258 <para>Defaults: Don't copy & 701,702,700</para>
2260 <para>Asks: ___ authors from the UNIMARC ___ tags (separated by
2261 commas) to the correct author tags when importing a record using
2264 <para>Description for z3950NormalizeAuthor:</para>
2268 <para>This preference allows for 'Personal Name Authorities'
2269 to replace authors as the bibliographic authority. This
2270 preference should only be considered by libraries using
2275 <para>Values for z3950NormalizeAuthor:</para>
2283 <para>Don't copy</para>
2287 <para>Description for z3950AuthorAuthFields:</para>
2291 <para>This preference defines which MARC fields will be used
2292 for 'Personal Name Authorities' to replace authors as the
2293 bibliographic authorities. This preference only applies to
2294 those using UNIMARC encoding. The MARC fields selected here
2295 will only be used if 'z3950NormalizeAuthor' is set to "Copy".
2296 The default field are 700, 701, and 702.</para>
2302 <section id="catspineprefs">
2303 <title>Spine Labels</title>
2307 <section id="SpineLabelAutoPrint">
2308 <title>SpineLabelAutoPrint</title>
2310 <para>Default: don't</para>
2312 <para>Asks: When using the quick spine label printer, ___
2313 automatically pop up a print dialog.</para>
2315 <para>Values:</para>
2328 <section id="SpineLabelFormat">
2329 <title>SpineLabelFormat</title>
2331 <para>Default: <itemcallnumber><copynumber></para>
2333 <para>Asks: Include the following fields on a quick-printed spine
2334 label: (Enter in columns from the biblio, biblioitems or items
2335 tables, surrounded by < and >.)</para>
2338 <section id="SpineLabelShowPrintOnBibDetails">
2339 <title>SpineLabelShowPrintOnBibDetails</title>
2341 <para>Default: Don't display</para>
2343 <para>Asks: ___ buttons on the bib details page to print item
2344 spine labels.</para>
2346 <para>Values:</para>
2350 <para>Display</para>
2353 <screeninfo>'Print Label' link appears on bibliographic
2354 record in the staff client</screeninfo>
2358 <imagedata fileref="images/admin/globalprefs/SpineLabelShowPrintOnBibDetails.png"/>
2365 <para>Don't display</para>
2372 <section id="circprefs">
2373 <title>Circulation</title>
2375 <para><emphasis>Get there:</emphasis> More > Administration >
2376 Global System Preferences > Circulation</para>
2377 <section id="checkinpolicyprefs">
2378 <title>Checkin Policy</title>
2380 <section id="BlockReturnOfWithdrawnItems">
2381 <title>BlockReturnOfWithdrawnItems</title>
2382 <para>Default: Block</para>
2383 <para>Asks: ___ returning of items that have been withdrawn. </para>
2384 <para>Values:<itemizedlist>
2389 <para>Don't block</para>
2391 </itemizedlist>Description:<itemizedlist>
2393 <para>This preference controls whether and item with a withdrawn status (952$0 in
2394 MARC21) can be checked in or not.</para>
2396 </itemizedlist></para>
2398 <section id="CalculateFinesOnReturn">
2399 <title>CalculateFinesOnReturn</title>
2400 <para>Default: Do</para>
2401 <para>Asks: ___ calculate and update overdue charges when an item is returned.</para>
2402 <para>Values:<itemizedlist>
2409 </itemizedlist></para>
2410 <para>Description:<itemizedlist>
2412 <para>If this preference is set to "Do" and the <link linkend="finescronjob">fines
2413 cron job</link> is off then Koha will calculate fines only when items are
2414 returned. If you have the fines cron job on and this preference set to "Do" then
2415 this preference will calculate fines based on the cron (usually run nightly) and
2416 then again when you check the item in. This option is best for those who are
2417 doing hourly loans. If this preference is set to "Don't" then fines will only
2418 be accrued if the fines cron job is running.</para>
2420 </itemizedlist></para>
2423 <para>If you are doing hourly loans then you should have this set to 'Do'.</para>
2429 <section id="circcheckoutpolicy">
2430 <title>Checkout Policy</title>
2434 <section id="AgeRestrictionMarker">
2435 <title>AgeRestrictionMarker</title>
2437 <para>Asks: Restrict patrons with the following target audience
2438 values from checking out inappropriate materials: ___</para>
2440 <para>Description:</para>
2444 <para>This preference defines certain keywords that will
2445 trigger Koha to restrict checkout based on age. These
2446 restrictions can be overridden by the <link linkend="AgeRestrictionOverride">AgeRestrictionOverride</link>
2447 preference. Enter in this field a series of keywords separated
2448 by bar (|) with no spaces. For example PG|R|E|EC|Age| will
2449 look for PG followed by an age number, R folllowed by an age
2450 number, Age followed by an age number, and so on. These values
2451 can appear in any MARC field, but Library of Congress
2452 recommends the 521$a (Target Audience Note). Whatever field
2453 you decide to use you must map the word agerestriction in the
2454 biblioitems table to that field in the <link linkend="kohamarcmapping">Koha to MARC Mapping</link>. When
2455 cataloging you can enter values like PG 13 or E 10 in the
2456 521$a and Koha will then notify circulation librarians that
2457 the material may not be recommended for the patron based on
2458 their age.<important>
2459 <para>You must map the word agerestriction in the biblioitems table to the MARC
2460 field where this information will appear via the <link linkend="kohamarcmapping">Koha to MARC Mapping</link> administration
2467 <section id="AgeRestrictionOverride">
2468 <title>AgeRestrictionOverride</title>
2470 <para>Default: Don't allow</para>
2472 <para>Asks: ___ staff to check out an item with age
2475 <para>Values:</para>
2482 <screeninfo>Allow age restriction override</screeninfo>
2486 <imagedata fileref="images/admin/globalprefs/AgeRestrictionOverride.png"/>
2493 <para>Don't allow</para>
2496 <screeninfo>Don't allow age restriction
2497 override</screeninfo>
2501 <imagedata fileref="images/admin/globalprefs/AgeRestrictionMarker.png"/>
2508 <para>Description:</para>
2512 <para>When the <link linkend="AgeRestrictionMarker">AgeRestrictionMarker</link>
2513 preference is set, Koha will try to warn circulation
2514 librarians before checking out an item that might have an age
2515 restriction listed in the MARC record. This preference asks if
2516 you would like the staff to be able to still check out these
2517 items to patrons under the age limit.</para>
2522 <section id="AllFinesNeedOverride">
2523 <title>AllFinesNeedOverride</title>
2525 <para>Default: Require</para>
2527 <para>Asks: ___ staff to manually override all fines, even fines
2528 less than <link linkend="noissuescharge">noissuescharge</link>.</para>
2530 <para>Values:</para>
2534 <para>Don't require</para>
2538 <para>Require</para>
2542 <para>Description:</para>
2546 <para>This preference let's you decide if you want to always
2547 be warned that the patron has fines when checking out. If you
2548 have it set to 'Require' then no matter how much money the
2549 patron owes a message will pop up warning you that the patron
2555 <section id="AllowFineOverride">
2556 <title>AllowFineOverride</title>
2558 <para>Default: Don't allow</para>
2560 <para>Asks: ___ staff to manually override and check out items to
2561 patrons who have more than <link linkend="noissuescharge">noissuescharge</link> in fines.</para>
2563 <para>Values:</para>
2571 <para>Don't allow</para>
2575 <para>Description:</para>
2579 <para>This preference lets you decide if you staff can check
2580 out to patrons who owe more money than you usually let them
2581 carry on their account. If set to 'Allow' staff will be warned
2582 that the patrons owes money, but it won't stop the staff from
2583 checking out to the patron.</para>
2588 <section id="AllowItemsOnHoldCheckout">
2589 <title>AllowItemsOnHoldCheckout</title>
2591 <para>Default: Don't allow</para>
2593 <para>Asks: ___ checkouts of items reserved to someone else. If
2594 allowed do not generate RESERVE_WAITING and RESERVED warning. This
2595 allows self checkouts for those items.</para>
2597 <para>Values:</para>
2605 <para>Don't allow</para>
2610 <para>This system preference relates only to SIP based self
2611 checkout, not Koha's web based self checkout.</para>
2614 <para>Description:</para>
2618 <para>When this preference is set to 'Allow' patrons will be
2619 able to use your external self check machine to check out a
2620 book to themselves even if it's on hold for someone else. If
2621 you would like Koha to prevent people from checking out books
2622 that are on hold for someone else set this preference to
2623 "Don't allow."</para>
2628 <section id="AllowNotForLoanOverride">
2629 <title>AllowNotForLoanOverride</title>
2631 <para>Default: Allow</para>
2633 <para>Asks: ___ staff to override and check out items that are
2634 marked as not for loan.</para>
2636 <para>Values:</para>
2644 <para>Don't allow</para>
2648 <para>Description:</para>
2652 <para>This parameter is a binary setting which controls the
2653 ability of staff (patrons will always be prevented from
2654 checking these items out) to check out items that are marked
2655 as "not for loan". Setting it to "Allow" would allow such
2656 items to be checked out, setting it to "Don't allow" would
2657 prevent this. This setting determines whether items meant to
2658 stay in the library, such as reference materials, and other
2659 library resources can be checked out by patrons.</para>
2664 <section id="AllowRenewalLimitOverride">
2665 <title>AllowRenewalLimitOverride</title>
2667 <para>Default: Allow</para>
2669 <para>Asks: ___ staff to manually override the renewal limit and
2670 renew a checkout when it would go over the renewal limit.</para>
2672 <para>Values:</para>
2680 <para>Don't allow</para>
2684 <para>Description:</para>
2688 <para>This preference is a binary setting which controls the
2689 ability of staff to override the limits placed on the number
2690 of times an item can be renewed. Setting it to "Allow" would
2691 allow such limits to be overridden, setting it to "Don't
2692 allow" would prevent this. This is a preference in which if it
2693 is set to "allow" it would allow the library staff to use
2694 their judgment for overriding the renew limit for special
2695 cases, setting it to "Don't allow" prevents an opportunity for
2696 abuse by the library staff.</para>
2701 <section id="AllowReturnToBranch">
2702 <title>AllowReturnToBranch</title>
2704 <para>Default: to any library</para>
2706 <para>Asks: Allow materials to be returned to ___</para>
2708 <para>Values:</para>
2712 <para>either the library the item is from or the library it
2713 was checked out from.</para>
2717 <para>only the library the item is from.</para>
2721 <para>only the library the item was checked out from.</para>
2725 <para>to any library.</para>
2729 <para>Description:</para>
2733 <para>This preference lets the library system decide how they
2734 will accept returns. Some systems allow for items to be
2735 returned to any library in the system (the default value of
2736 this preference) others want to limit item returns to only
2737 specific branches. This preference will allow you to limit
2738 item returns (checkins) to the branch(es) set in the
2743 <section id="AllowTooManyOverride">
2744 <title>AllowTooManyOverride</title>
2745 <para>Default: Allow</para>
2746 <para>Asks: ___ staff to override and check out items when the patron has reached the
2747 maximum number of allowed checkouts.</para>
2748 <para>Values:</para>
2753 <screeninfo>Allow too many checkouts override</screeninfo>
2756 <imagedata fileref="images/admin/globalprefs/AllowTooManyOverride-yes.png"
2763 <para>Don't allow</para>
2765 <screeninfo>Don't allow too many checkouts override</screeninfo>
2768 <imagedata fileref="images/admin/globalprefs/AllowTooManyOverride-no.png"/>
2774 <para>Description:<itemizedlist>
2776 <para>If this preference is set to "Allow" then staff all will be presented with
2777 an option to checkout more items to a patron than are normally allowed in the
2778 <link linkend="circfinerules">Circulation and Fine Rules</link>. If this
2779 preference is set to "Don't allow" then no staff member will be able to check
2780 out more than the circulation limit.</para>
2782 </itemizedlist></para>
2785 <section id="AutomaticItemReturn">
2786 <title>AutomaticItemReturn</title>
2788 <para>Default: Do</para>
2790 <para>Asks: ___ automatically transfer items to their home branch
2791 when they are returned.</para>
2793 <para>Values:</para>
2805 <para>Description:</para>
2809 <para>This preference is a binary setting which determines
2810 whether an item is returned to its home branch automatically
2811 or not. If set to "Don't", the staff member checking an item
2812 in at a location other than the item's home branch will be
2813 asked whether the item will remain at the non-home branch (in
2814 which case the new location will be marked as a holding
2815 location) or returned. Setting it to "Do" will ensure that
2816 items checked in at a branch other than their home branch will
2817 be sent to that home branch.</para>
2821 <section id="AutoRemoveOverduesRestrictions">
2822 <title>AutoRemoveOverduesRestrictions</title>
2823 <para>Default: Do not</para>
2824 <para>Asks: ___ allow OVERDUES restrictions triggered by sent notices to be cleared
2825 automatically when all overdue items are returned by a patron. </para>
2826 <para>Values:<itemizedlist>
2833 </itemizedlist></para>
2834 <para>Description:<itemizedlist>
2836 <para>Using the <link linkend="noticetriggers">Overdue Notice/Status
2837 Triggers</link> you can restrict patrons after they receive an overdue notice.
2838 This preference lets you define whether Koha will automatically remove that
2839 restriction once the overdue items in question are returned or not.</para>
2841 </itemizedlist></para>
2844 <section id="CircControl">
2845 <title>CircControl</title>
2847 <para>Default: the library the item is from</para>
2849 <para>Asks: Use the checkout and fines rules of ___</para>
2851 <para>Values:</para>
2855 <para>the library the item is from</para>
2859 <para>The <link linkend="circfinerules">circulation and fines policies</link>
2860 will be determined by the library that owns the item</para>
2866 <para>the library the patron is from</para>
2870 <para>The <link linkend="circfinerules">circulation and fines policies</link>
2871 will be determined the patron's home library</para>
2877 <para>the library you are logged in at</para>
2881 <para>The <link linkend="circfinerules">circulation and fines policies</link>
2882 will be determined by the library that checked the item out to the
2890 <section id="HomeOrHoldingBranch">
2891 <title>HomeOrHoldingBranch</title>
2893 <para>Default: the library the item was checked out from</para>
2895 <para>Asks: Use the checkout and fines rules of ___</para>
2897 <para>Values:</para>
2901 <para>the library the item is from</para>
2905 <para>the library the item was checked out from</para>
2910 <para>It is not recommend that this setting be changed after initial setup of Koha
2911 because it will change the behavior of items already checked out.</para>
2913 <para>Description:</para>
2916 <para>If <link linkend="IndependentBranches">IndependentBranches</link> is set to
2917 'Prevent' and <link linkend="CircControl">CircControl</link> is set to 'the
2918 library the item is from' this preference decides whether the library holding the
2919 item (holding library on the item record) may check the item out to its own patron
2920 or if it must immediately send the item back to the owning location (home library
2921 on the item record).</para>
2925 <para>This preference does nothing unless the <link linkend="IndependentBranches"
2926 >IndependentBranches</link> preference is set to 'Prevent'.</para>
2929 <section id="HomeOrHoldingBranchReturn">
2930 <title>HomeOrHoldingBranchReturn</title>
2931 <para>Default: the library the item is from</para>
2932 <para>Asks: On checkin route the returned item to ___</para>
2933 <para>Values:<itemizedlist>
2935 <para>the library the item is from</para>
2938 <para>the library item was checked out from</para>
2940 </itemizedlist></para>
2941 <para>Description:<itemizedlist>
2943 <para>This preference will control where Koha prompts you to return the checked in
2944 item to. The value in this preference is overridden by any values you have
2945 related to item returns and floating collections in the <link linkend="circfinerules">Circulation and Fine Rules</link>.</para>
2947 </itemizedlist></para>
2950 <section id="InProcessingToShelvingCart">
2951 <title>InProcessingToShelvingCart</title>
2953 <para>Default: Don't move</para>
2955 <para>Asks: ___ items that have the location PROC to the location
2956 CART when they are checked in.</para>
2958 <para>Values:</para>
2962 <para>Don't move</para>
2971 <section id="IssuingInProcess">
2972 <title>IssuingInProcess</title>
2974 <para>Default: Don't prevent</para>
2976 <para>Asks: ___ patrons from checking out an item whose rental
2977 charge would take them over the limit.</para>
2979 <para>Values:</para>
2983 <para>Don't prevent</para>
2987 <para>Prevent</para>
2991 <para>Description:</para>
2995 <para>This preference determines if a patron can check items
2996 out if there is an overdue fine on the account and any of the
2997 materials the patron wishes to check out will potentially tip
2998 the account balance over the maximum fines policy the library
2999 has in place.</para>
3003 <para>Example: Your library has a $5 limit set for 'fines' (ie,
3004 after incurring $5 in fines, a patron can no longer check out
3005 items). A patron comes to the desk with 5 items to check out (4
3006 books and a video) The patron has $4 in charges already on their
3007 account. One of the videos has a rental charge of $1, therefore
3008 making the total fines on the patron's account suddenly $5 (the
3012 <section id="IssueLostItem">
3013 <title>IssueLostItem</title>
3015 <para>Default: display a message</para>
3017 <para>Asks: When issuing an item that has been marked as lost,
3020 <para>Values:</para>
3024 <para>display a message</para>
3027 <screeninfo>Lost message when checking out</screeninfo>
3031 <imagedata fileref="images/admin/globalprefs/IssueLostItem-msg.png"/>
3038 <para>do nothing</para>
3042 <para>This option will just check the item out without
3043 notifying you that the item was marked lost.</para>
3049 <para>require confirmation</para>
3052 <screeninfo>Confirm checkout of lost item</screeninfo>
3056 <imagedata fileref="images/admin/globalprefs/IssueLostItem-confirm.png"/>
3063 <para>Description:</para>
3067 <para>This preference lets you define how library staff are
3068 notified that an item with a lost status is being checked out.
3069 This will help staff mark items as 'available' if you choose
3070 to 'display a message' or 'require confirmation.' If you
3071 choose to 'do nothing,' there will be no notification that the
3072 item being checked out is marked as 'lost.'</para>
3076 <section id="ManInvInNoissuesCharge">
3077 <title>ManInvInNoissuesCharge</title>
3078 <para>Default: Include</para>
3079 <para>Asks: ___ MANUAL_INV charges when summing up charges for noissuescharge. </para>
3080 <para>Values:<itemizedlist>
3082 <para>Don't include</para>
3085 <para>Include</para>
3087 </itemizedlist></para>
3088 <para>Description:<itemizedlist>
3090 <para>This preference lets you decide if charges entered as manual invoices are
3091 included when calculating the <link linkend="noissuescharge">noissuescharge</link>. If this is set to include then Koha will include all
3092 manual invoices when deciding if the patron owes too much money to check
3093 anything else out of the library. If it's set to Don't include then Koha will
3094 ignore all manual invoice charges when figuring out if the patron owes too much
3095 money to checkout additional materials.</para>
3097 </itemizedlist></para>
3100 <section id="maxoutstanding">
3101 <title>maxoutstanding</title>
3103 <para>Default: 5</para>
3105 <para>Asks: Prevent patrons from making holds on the OPAC if they
3106 owe more than ___ USD in fines.</para>
3109 <section id="noissuescharge">
3110 <title>noissuescharge</title>
3112 <para>Default: 5</para>
3114 <para>Asks: Prevent patrons from checking out books if they have
3115 more than ___ USD in fines.</para>
3117 <para>Description:</para>
3121 <para>This preference is the maximum amount of money owed to the library before the
3122 user is banned from borrowing more items. Using the <link linkend="ManInvInNoissuesCharge">ManInvInNoissuesCharge</link> and <link linkend="RentalsInNoissuesCharge">RentalsInNoissuesCharge</link> preferences you
3123 can control which types of charges are considered in this total. This also
3124 coincides with <link linkend="maxoutstanding">maxoutstanding</link> that limits
3125 patrons from placing holds when the maximum amount is owed to the library.</para>
3130 <section id="OverduesBlockCirc">
3131 <title>OverduesBlockCirc</title>
3133 <para>Default: Ask for confirmation</para>
3135 <para>Asks: ___ when checking out to a borrower that has overdues
3138 <para>Values:</para>
3142 <para>Ask for confirmation</para>
3146 <para>Will not let you check an item out to patrons with
3147 overdues until a librarian confirms that it is okay</para>
3157 <para>Block all patrons with overdue items from being able
3164 <para>Don't block</para>
3168 <para>Allow all patrons with overdue items to continue to
3176 <section id="OverdueNoticeBcc">
3177 <title>OverdueNoticeBcc</title>
3179 <para>Asks: Send all notices as a BCC to this email address
3182 <para>This preference makes it so that a librarian can get a copy of every notice sent
3183 out to patrons.<tip>
3184 <para>If you'd like more than one person to receive the blind copy you can simply
3185 enter in multiple email addresses separated by commas.</para>
3187 <para>The name of this preference is misleading, it does not only send overdues, but
3188 all notices to the BCC address.</para>
3192 <section id="PrintNoticesMaxLines">
3193 <title>PrintNoticesMaxLines</title>
3195 <para>Asks: Include up to ___ item lines in a printed overdue
3199 <para>If the number of items is greater than this number, the
3200 notice will end with a warning asking the borrower to check
3201 their online account for a full list of overdue items.</para>
3205 <para>Set to 0 to include all overdue items in the notice, no
3206 matter how many there are.</para>
3210 <para>This preference only refers to the print notices, not
3211 those sent via email.</para>
3215 <section id="RenewalPeriodBase">
3216 <title>RenewalPeriodBase</title>
3218 <para>Default: the old due date of the checkout</para>
3220 <para>Asks: When renewing checkouts, base the new due date on
3223 <para>Values:</para>
3227 <para>the old due date of the checkout</para>
3231 <para>the current date</para>
3235 <section id="RenewalSendNotice">
3236 <title>RenewalSendNotice</title>
3237 <para> Default: Don't send </para>
3238 <para>Asks: ____ a renewal notice according to patron checkout alert preferences. </para>
3239 <para>Values: <itemizedlist>
3241 <para>Don't send</para>
3246 </itemizedlist></para>
3247 <para>Description:<itemizedlist>
3249 <para>If a patron has chosen to receive a check out notice in their messaging
3250 preferences and this preference is set to 'Send' then those patrons will also
3251 receive a notice when they renew materials. You will want to set up a <link
3252 linkend="addnotices">new notice</link> with the code of RENEWAL (if you don't
3253 already have it) with custom text for renewing items.<important>
3254 <para>This preference requires that you have <link
3255 linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
3256 set to 'Allow'</para>
3259 </itemizedlist></para>
3261 <section id="RentalsInNoissuesCharge">
3262 <title>RentalsInNoissuesCharge</title>
3263 <para>Default: Include</para>
3264 <para>Asks: ___ rental charges when summing up charges for noissuescharge. </para>
3265 <para>Values:<itemizedlist>
3267 <para>Don't include</para>
3270 <para>Include</para>
3272 </itemizedlist></para>
3273 <para>Description:<itemizedlist>
3275 <para>This preference lets you decide if rental charges are included when
3276 calculating the <link linkend="noissuescharge">noissuescharge</link>. If this is
3277 set to include then Koha will include all rental charges when deciding if the
3278 patron owes too much money to check anything else out of the library. If it's
3279 set to Don't include then Koha will ignore all rental charges when figuring out
3280 if the patron owes too much money to checkout additional materials.</para>
3282 </itemizedlist></para>
3285 <section id="ReturnBeforeExpiry">
3286 <title>ReturnBeforeExpiry</title>
3288 <para>Default: Don't require</para>
3290 <para>Asks: ___ patrons to return books before their accounts
3291 expire (by restricting due dates to before the patron's expiration
3294 <para>Values:</para>
3298 <para>Don't require</para>
3302 <para>Require</para>
3306 <para>Description:</para>
3310 <para>This is preference may prevent a patron from having
3311 items checked out after their library card has expired. If
3312 this is set to "Require", then a due date of any checked out
3313 item can not be set for a date which falls after the patron's
3314 card expiration. If the setting is left "Don't require" then
3315 item check out dates may exceed the expiration date for the
3316 patron's library card.</para>
3321 <section id="ReturnToShelvingCart">
3322 <title>ReturnToShelvingCart</title>
3324 <para>Default: Don't move</para>
3326 <para>Asks: ___ all items to the location CART when they are
3329 <para>Values:</para>
3333 <para>Don't move</para>
3342 <section id="TransfersMaxDaysWarning">
3343 <title>TransfersMaxDaysWarning</title>
3345 <para>Default: 3</para>
3347 <para>Asks: Show a warning on the "Transfers to Receive" screen if
3348 the transfer has not been received ___ days after it is
3351 <para>Description:</para>
3355 <para>The TransferMaxDaysWarning preference is set at a
3356 default number of days. This preference allows for a warning
3357 to appear after a set amount of time if an item being
3358 transferred between library branches has not been received.
3359 The warning will appear in the <link linkend="transferstoreceive">Transfers to Receive</link>
3365 <section id="UseBranchTransferLimits">
3366 <title>UseBranchTransferLimits &
3367 BranchTransferLimitsType</title>
3369 <para>Defaults: Don't enforce & collection code</para>
3371 <para>Asks: ___ branch transfer limits based on ___</para>
3373 <para>UseBranchTransferLimits Values:</para>
3377 <para>Don't enforce</para>
3381 <para>Enforce</para>
3385 <para>BranchTransferLimitsType Values:</para>
3389 <para>collection code</para>
3393 <para>item type</para>
3397 <para>BranchTransferLimitsType Description:</para>
3401 <para>This parameter is a binary setting which determines
3402 whether items are transferred according to item type or
3403 collection code. This value determines how the library manager
3404 is able to restrict what items can be transferred between the
3410 <section id="useDaysMode">
3411 <title>useDaysMode</title>
3413 <para>Default: Don't include</para>
3415 <para>Asks: Calculate the due date using ___.</para>
3417 <para>Values:</para>
3421 <para>circulation rules only.</para>
3425 <para>the calendar to push the due date to the next open
3430 <para>the calendar to skip all days the library is
3435 <para>Description:</para>
3439 <para>This preference controls how scheduled library closures
3440 affect the due date of a material. The 'the calendar to skip
3441 all days the library is closed' setting allows for a scheduled
3442 closure not to count as a day in the loan period, the
3443 'circulation rules only' setting would not consider the
3444 scheduled closure at all, and 'the calendar to push the due
3445 date to the next open day' would only effect the due date if
3446 the day the item is due would fall specifically on the day of
3451 <para>Example:</para>
3455 <para>The library has put December 24th and 25th in as
3456 closures on the calendar. A book checked out by a patron has a
3457 due date of December 25th according to the circulation and
3458 fine rules. If this preference is set to 'circulation rules
3459 only' then the item will remain due on the 25th. If the
3460 preference is set to 'the calendar to push the due date to the
3461 next open day' then the due date will be December 26th. If the
3462 preference is set to 'the calendar to skip all days the
3463 library is closed' then the due date will be pushed to the
3464 27th of December to accommodate for the two closed
3469 <para>The calendar is defined on a branch by branch basis. To
3470 learn more about the calendar, check out the '<link linkend="calholidays">Calendar & Holidays</link>' section of
3473 <section id="UseTransportCostMatrix">
3474 <title>UseTransportCostMatrix</title>
3475 <para>Default: Don't use</para>
3476 <para>Asks: ___ Transport Cost Matrix for calculating optimal holds filling between
3478 <para>Values:<itemizedlist>
3480 <para>Don't use</para>
3485 </itemizedlist></para>
3486 <para>Description:<itemizedlist>
3488 <para>If the system is configured to use the <link linkend="transportcostmatrix">Transport cost matrix</link> for filling holds, then when attempting to fill
3489 a hold, the system will search for the lowest cost branch, and attempt to fill
3490 the hold with an item from that branch first. Branches of equal cost will be
3491 selected from randomly. The branch or branches of the next highest cost shall be
3492 selected from only if all the branches in the previous group are unable to fill
3494 <para>The system will use the item's current holding branch when determining
3495 whether the item can fulfill a hold using the Transport Cost Matrix. This
3496 behaviour will be overruled if the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link> system preference is enabled.</para>
3498 </itemizedlist></para>
3501 <section id="coursereserveprefs">
3502 <title>Course Reserves</title>
3503 <section id="UseCourseReserves">
3504 <title>UseCourseReserves</title>
3505 <para>Default: Don't use</para>
3506 <para>Asks: ___ course reserves</para>
3507 <para>Values:</para>
3510 <para>Don't use</para>
3516 <para>Description:<itemizedlist>
3518 <para>The <link linkend="coursereserves">Course Reserves</link> module in Koha
3519 allows you to temporarily move items to 'reserve' and assign different
3520 circulation rules to these items while they are being used for a specific
3523 </itemizedlist></para>
3527 <section id="circfinespolicy">
3528 <title>Fines Policy</title>
3532 <section id="finesCalendar">
3533 <title>finesCalendar</title>
3535 <para>Default: not including the days the library is closed</para>
3537 <para>Asks: Calculate fines based on days overdue ___</para>
3539 <para>Values:</para>
3543 <para>directly</para>
3547 <para>not including the days the library is closed</para>
3551 <para>Description:</para>
3555 <para>This preference will determine whether or not fines will
3556 be accrued during instances when the library is closed.
3557 Examples include holidays, library in-service days, etc.
3558 Choosing "not including the days the library is closed"
3559 setting will enable Koha to access its <link linkend="calholidays">Calendar</link> module and be
3560 considerate of dates when the library is closed. To make use
3561 of this setting the administrator must first access Koha's
3562 calendar and mark certain days as "holidays" ahead of
3567 <para>The calendar is defined on a branch by branch basis. To
3568 learn more about the calendar, check out the '<link linkend="calholidays">Calendar & Holidays</link>' section of
3571 <section id="FinesIncludeGracePeriod">
3572 <title>FinesIncludeGracePeriod</title>
3573 <para>Default: Include</para>
3574 <para>Asks: ___ the grace period when calculating the fine for an overdue item.</para>
3575 <para>Values:<itemizedlist>
3577 <para>Don't include</para>
3580 <para>Include</para>
3582 </itemizedlist></para>
3583 <para>Description:<itemizedlist>
3585 <para>This preference lets you control how Koha calculates fines when there is a
3586 grace period. If you choose to include the grace period when calculating fines
3587 then Koha will charge for the days in the grace period should the item be
3588 overdue more than those days. If you choose not to include the grace period then
3589 Koha will only charge for the days overdue after the grace period.</para>
3591 </itemizedlist></para>
3594 <section id="finesMode">
3595 <title>finesMode</title>
3597 <para>Default: Calculate (but only for mailing to the
3600 <para>Asks: ___ fines</para>
3602 <para>Values:</para>
3606 <para>Calculate (but only for mailing to the admin)</para>
3610 <para>Calculate and charge</para>
3614 <para>Don't calculate</para>
3619 <para>Requires that you have the fines cron job running
3620 (misc/cronjobs/fines.pl)</para>
3623 <section id="RefundLostItemFeeOnReturn">
3624 <title>RefundLostItemFeeOnReturn</title>
3625 <para>Default: Refund</para>
3626 <para>Asks: ___ lost item fees charged to a borrower when the lost item is
3628 <para>Values:<itemizedlist>
3630 <para>Don't refund</para>
3635 </itemizedlist></para>
3636 <para>Description:<itemizedlist>
3638 <para>When an item is marked lost in Koha the system charges the patron the
3639 replacement fee for the item. This preference lets you control how Koha handles
3640 returns of these items. By default when an item that was previously marked lost
3641 is checked in Koha refunds the patron the replacement fee. Change this
3642 preference to "Don't refund" if you would like Koha to not refund the
3643 replacement fee.</para>
3645 </itemizedlist></para>
3647 <section id="WhenLostChargeReplacementFee">
3648 <title>WhenLostChargeReplacementFee</title>
3649 <para>Default: Charge</para>
3650 <para>Asks: ___ the replacement price when a patron loses an item. </para>
3651 <para>Values:<itemizedlist>
3656 <para>Don't charge</para>
3658 </itemizedlist></para>
3659 <para>Description:<itemizedlist>
3661 <para>This preference lets you tell Koha what to do with an item is marked lost.
3662 If you want Koha can 'Charge' the patron the replacement fee listed on the item
3663 they lost or it can do nothing in reference to the patron and just mark the item
3664 lost in the catalog.</para>
3666 </itemizedlist></para>
3668 <section id="WhenLostForgiveFine">
3669 <title>WhenLostForgiveFine</title>
3670 <para>Default: Don't forgive</para>
3671 <para>Asks: ___ the fines on an item when it is lost.</para>
3672 <para>Values:<itemizedlist>
3674 <para>Don't forgive</para>
3677 <para>Forgive</para>
3679 </itemizedlist></para>
3680 <para>Description:<itemizedlist>
3682 <para>This preference allows the library to decide if fines are charged in
3683 addition to the replacement fee when an item is marked as lost. If this
3684 preference is set to 'Forgive' then the patron won't be charged fines in
3685 addition to the replacement fee.</para>
3687 </itemizedlist></para>
3691 <section id="circholdspolicy">
3692 <title>Holds Policy</title>
3696 <section id="AllowHoldDateInFuture">
3697 <title>AllowHoldDateInFuture</title>
3699 <para>Default: Allow</para>
3701 <para>Asks: ___ hold requests to be placed that do not enter the
3702 waiting list until a certain future date.</para>
3704 <para>Values:</para>
3712 <para>Don't allow</para>
3717 <section id="AllowHoldsOnDamagedItems">
3718 <title>AllowHoldsOnDamagedItems</title>
3720 <para>Default: Allow</para>
3722 <para>Asks: ___ hold requests to be placed on damaged
3725 <para>Values:</para>
3733 <para>Don't allow</para>
3737 <para>Description:</para>
3741 <para>This parameter is a binary setting which controls
3742 whether or not hold requests can be placed on items that are
3743 marked as "damaged" (items are marked as damaged by editing
3744 subfield 4 on the item record). Setting this value to "Don't
3745 allow" will prevent anyone from placing a hold on such items,
3746 setting it to "Allow" will allow it. This preference is
3747 important because it determines whether or not a patron can
3748 place a request for an item that might be in the process of
3749 being repaired or not in good condition. The library may wish
3750 to set this to "Don't allow" if they were concerned about
3751 their patrons not receiving the item in a timely manner or at
3752 all (if it is determined that the item is beyond repair).
3753 Setting it to "Allow" would allow a patron to place a hold on
3754 an item and therefore receive it as soon as it becomes
3759 <section id="AllowHoldsOnPatronsPossessions">
3760 <title>AllowHoldsOnPatronsPossessions</title>
3761 <para>Default: Allow </para>
3762 <para>Asks: ____ a patron to place a hold on a record where the patron already has one
3763 or more items attached to that record checked out. </para>
3764 <para>Values:<itemizedlist>
3769 <para>Don't allow</para>
3771 </itemizedlist></para>
3772 <para>Description:<itemizedlist>
3774 <para>By setting to "Don't allow," you can prevent patrons from placing holds on
3775 items they already have out, thus preventing them from blocking anyone else from
3776 getting an item. </para>
3778 </itemizedlist></para>
3781 <section id="AllowHoldPolicyOverride">
3782 <title>AllowHoldPolicyOverride</title>
3784 <para>Default: Allow</para>
3786 <para>Asks: ___ staff to override hold policies when placing
3789 <para>Values:</para>
3797 <para>Don't allow</para>
3801 <para>Description:</para>
3805 <para>This preference is a binary setting which controls
3806 whether or not the library staff can override the circulation
3807 and fines rules as they pertain to the placement of holds.
3808 Setting this value to "Don't allow" will prevent anyone from
3809 overriding, setting it to "Allow" will allow it. This setting
3810 is important because it determines how strict the libraries
3811 rules for placing holds are. If this is set to "Allow",
3812 exceptions can be made for patrons who are otherwise normally
3813 in good standing with the library, but there is opportunity
3814 for the staff to abuse this function. If it is set to "Don't
3815 allow", no abuse of the system is possible, but it makes the
3816 system entirely inflexible in respect to holds.</para>
3821 <section id="AllowOnShelfHolds">
3822 <title>AllowOnShelfHolds</title>
3824 <para>Default: Allow</para>
3826 <para>Asks: ___ hold requests to be placed on items that are not
3829 <para>Values:</para>
3837 <para>Don't Allow</para>
3841 <para>Description:</para>
3845 <para>This preference is a binary setting which controls the
3846 ability of patrons to place holds on items that are not
3847 currently checked out. Setting it to "Don't allow" allows
3848 borrowers to place holds on items that are checked out but not
3849 on items that are on the shelf (or assumed available in the
3850 library), setting it to "Allow" allows borrowers to place
3851 holds on any item that is available for loan whether it is
3852 checked out or not. This setting might be set to "Allow" if
3853 the library system is a multi branch system and patrons used
3854 the hold system to request items from other libraries, or if
3855 the library wanted to allow users to place holds on items from
3856 home through the OPAC. Setting it to "Don't allow" would
3857 enforce a first come, first served standard.</para>
3861 <para>An item's hold status doesn't not affect whether or not the item is 'available'
3862 until the item is in 'waiting' status. Items with on-shelf holds will show as
3863 available until a librarian has pulled them from the shelf and checked the item in
3864 make it show 'waiting'.</para>
3868 <section id="AutoResumeSuspendedHolds">
3869 <title>AutoResumeSuspendedHolds</title>
3871 <para>Default: Allow</para>
3873 <para>Asks: ___ suspended holds to be automatically resumed by a
3876 <para>Values:</para>
3884 <para>Don't allow</para>
3888 <para>Description:</para>
3892 <para>If this preference is set to 'Allow' then all suspended holds will be able to
3893 have a date at after which they automatically become unsuspended. If you have this
3894 preference set to 'Allow' you will also need the <link linkend="unsuspendholdcron">Unsuspend Holds</link> cron job running.</para>
3898 <para>The holds will become unsuspended the date after that entered by the
3903 <section id="canreservefromotherbranches">
3904 <title>canreservefromotherbranches</title>
3906 <para>Default: Allow</para>
3908 <para>Asks: ___ a user from one library to place a hold on an item
3909 from another library</para>
3911 <para>Description:</para>
3915 <para>This preference is a binary setting which determines
3916 whether patrons can place holds on items from other branches.
3917 If the preference is set to "Allow" patrons can place such
3918 holds, if it is set to "Don't allow" they cannot. This is an
3919 important setting because it determines if users can use Koha
3920 to request items from another branch. If the library is
3921 sharing an installation of Koha with other independent
3922 libraries which do not wish to allow interlibrary borrowing it
3923 is recommended that this parameter be set to "Don't
3928 <para>Values:</para>
3936 <para>Don't allow (with <link linkend="IndependentBranches">independent
3937 branches</link>)</para>
3941 <section id="ConfirmFutureHolds">
3942 <title>ConfirmFutureHolds</title>
3943 <para>Default: 0</para>
3944 <para>Asks: Confirm future hold requests (starting no later than ___ days from now) at
3945 checkin time. </para>
3946 <para>Description:<itemizedlist>
3948 <para>When confirming a hold at checkin time, the number of days in this
3949 preference is taken into account when deciding which holds to show alerts for.
3950 This preference does not interfere with renewing, checking out or transferring a
3953 </itemizedlist></para>
3955 <para>This number of days will be used too in calculating the default end date for the
3956 Holds to pull-report. But it does not interfere with issuing, renewing or
3957 transferring books.</para>
3960 <para>This preference is only looked at if you're allowing hold dates in the future
3961 with <link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link> or <link
3962 linkend="OPACAllowHoldDateInFuture">OPACAllowHoldDateInFuture</link></para>
3965 <section id="decreaseLoanHighHolds">
3966 <title>decreaseLoanHighHolds, decreaseLoanHighHoldsDuration and
3967 decreaseLoanHighHoldsValue</title>
3968 <para>Asks: ___ the reduction of loan period to ___ days for items with more than ___
3970 <para>decreaseLoanHighHolds default: Don't enable</para>
3971 <para>decreaseLoanHighHolds values:<itemizedlist>
3972 <para>Don't enable</para>
3976 </itemizedlist>Description:<itemizedlist>
3978 <para>These preferences let you change the loan length for items that have many
3979 holds on them. This will not effect items that are already checked out, but
3980 items that are checked out after the decreaseLoanHighHoldsValue is met will only
3981 be checked out for the number of days entered in the
3982 decreaseLoanHighHoldsDuration preference.</para>
3984 <screeninfo>Warning on checkout</screeninfo>
3987 <imagedata fileref="images/admin/globalprefs/decreaseLoanHighHoldsDuration.png"/>
3992 </itemizedlist></para>
3995 <section id="DisplayMultiPlaceHold">
3996 <title>DisplayMultiPlaceHold</title>
3998 <para>Default: Don't enable</para>
4000 <para>Asks: ___ the ability to place holds on multiple biblio from
4001 the search results</para>
4003 <para>Values:</para>
4007 <para>Don't enable</para>
4016 <section id="emailLibrarianWhenHoldIsPlaced">
4017 <title>emailLibrarianWhenHoldIsPlaced</title>
4019 <para>Default: Don't enable</para>
4021 <para>Asks: ___ sending an email to the Koha administrator email
4022 address whenever a hold request is placed.</para>
4024 <para>Values:</para>
4028 <para>Don't enable</para>
4036 <para>Description:</para>
4040 <para>This preference enables Koha to email the library staff
4041 whenever a patron requests an item to be held. While this
4042 function will immediately alert the librarian to the patron's
4043 need, it is extremely impractical in most library settings. In
4044 most libraries the hold lists are monitored and maintained
4045 from a separate interface. That said, many libraries that
4046 allow on shelf holds prefer to have this preference turned on
4047 so that they are alerted to pull an item from the
4053 <para>In order for this email to send you must have a <link linkend="notices"
4054 >notice</link> template with the code of HOLDPLACED</para>
4058 <para>This notice will only be sent if the <link linkend="msgqueuecron">process_message_queue.pl cronjob</link>
4059 being run periodically to send the messages.</para>
4063 <section id="ExpireReservesMaxPickUpDelay">
4064 <title>ExpireReservesMaxPickUpDelay</title>
4066 <para>Default: Don't allow</para>
4068 <para>Asks: ___ holds to expire automatically if they have not
4069 been picked by within the time period specified in <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link></para>
4071 <para>Values:</para>
4079 <para>Don't allow</para>
4083 <para>Description:</para>
4087 <para>If set to 'allow' this will cancel holds that have been
4088 waiting for longer than the number of days specified in the
4089 <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
4090 system preference. Holds will only be cancelled if the <link linkend="expiredholdscron">Expire Holds cron job</link> is
4096 <section id="ExpireReservesMaxPickUpDelayCharge">
4097 <title>ExpireReservesMaxPickUpDelayCharge</title>
4099 <para>Default: 0</para>
4101 <para>Asks: If using <link linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>,
4102 charge a borrower who allows his or her waiting hold to expire a
4103 fee of ___ USD</para>
4105 <para>Description:</para>
4109 <para>If you are expiring holds that have been waiting too
4110 long you can use this preference to charge the patron for not
4111 picking up their hold. If you don't charge patrons for items
4112 that aren't picked up you can leave this set to the default
4113 which is 0. Holds will only be cancelled and charged if the
4114 <link linkend="expiredholdscron">Expire Holds cron job</link>
4120 <section id="maxreserves">
4121 <title>maxreserves</title>
4123 <para>Default: 50</para>
4125 <para>Asks: Patrons can only have ___ holds at once.</para>
4128 <section id="OPACAllowHoldDateInFuture">
4129 <title>OPACAllowHoldDateInFuture</title>
4131 <para>Default: Allow</para>
4133 <para>Asks: ___ patrons to place holds that don't enter the
4134 waiting list until a certain future date.</para>
4136 <para>Values:</para>
4144 <para><link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
4145 must also be enabled for this to work</para>
4151 <para>Don't allow</para>
4156 <section id="OPACAllowUserToChooseBranch">
4157 <title>OPACAllowUserToChooseBranch</title>
4159 <para>Default: Allow</para>
4161 <para>Asks: ___ a user to choose the branch to pick up a hold
4164 <para>Values:</para>
4172 <para>Don't allow</para>
4176 <para>Description:</para>
4180 <para>Changing this preference will not prevent staff from
4181 being able to transfer titles from one branch to another to
4182 fill a hold, it will only prevent patrons from saying they
4183 plan on picking a book up at a branch other than their home
4189 <section id="ReservesControlBranch">
4190 <title>ReservesControlBranch</title>
4192 <para>Default: item's home library</para>
4194 <para>Asks: Check the ___ to see if the patron can place a hold on
4197 <para>Values:</para>
4201 <para>item's home library.</para>
4205 <para>patron's home library.</para>
4210 <section id="ReservesMaxPickUpDelay">
4211 <title>ReservesMaxPickUpDelay</title>
4213 <para>Default: 7</para>
4215 <para>Asks: Mark a hold as problematic if it has been waiting for
4216 more than ___ days.</para>
4218 <para>Description:</para>
4222 <para>This preference (based on calendar days, not the <link linkend="calholidays">Koha holiday calendar</link>) puts an
4223 expiration date on an item a patron has on hold. After this
4224 expiration date the staff will have the option to release the
4225 unclaimed hold which then may be returned to the library shelf
4226 or issued to the next patron on the item's hold list. Items
4227 that are 'expired' by this preference are moved to the 'Holds
4228 Over' tab on the '<link linkend="holdspickup">Holds Awaiting
4229 Pickup</link>' report.</para>
4234 <section id="ReservesNeedReturns">
4235 <title>ReservesNeedReturns</title>
4237 <para>Default: Don't automatically</para>
4239 <para>Asks: ___ mark holds as found and waiting when a hold is
4240 placed specifically on them and they are already checked
4243 <para>Values:</para>
4247 <para>Automatically</para>
4251 <para>Don't automatically</para>
4255 <para>Description:</para>
4259 <para>This preference refers to 'item specific' holds where
4260 the item is currently on the library shelf. This preference
4261 allows a library to decide whether an 'item specific' hold is
4262 marked as "Waiting" at the time the hold is placed or if the
4263 item will be marked as "Waiting" after the item is checked in.
4264 This preference will tell the patron that their item is
4265 'Waiting' for them at their library and ready for check
4271 <section id="holdqueueweight">
4272 <title>StaticHoldsQueueWeight &
4273 RandomizeHoldsQueueWeight</title>
4275 <para>StaticHoldsQueueWeight Default: 0</para>
4277 <para>RandomizeHoldsQueueWeight Default: in that order</para>
4279 <para>Asks: Satisfy holds from the libraries ___ (as branchcodes,
4280 separated by commas; if empty, uses all libraries) ___</para>
4282 <para>RandomizeHoldsQueueWeight Values:</para>
4286 <para>in random order</para>
4290 <para>If StaticHoldsQueueWeight is left at the default
4291 Koha will randomize all libraries, otherwise it will
4292 randomize the libraries listed.</para>
4298 <para>in that order</para>
4302 <para>If StaticHoldsQueueWeight is left at the default
4303 then this will use all of your branches in alphabetical
4304 order, otherwise it will use the branches in the order
4305 that you entered them in the StaticHoldsQueueWeight
4312 <para>Descriptions:</para>
4316 <para>These preferences control how the <link linkend="holdsqueue">Holds Queue report</link> is generated
4317 using <link linkend="buildholdscron">a cron job</link>.</para>
4319 <para>If you do not want all of your libraries to participate
4320 in the on-shelf holds fulfillment process, you should list the
4321 the libraries that *do* participate in the process here by
4322 inputting all the participating library's branchcodes,
4323 separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
4325 <para>By default, the holds queue will be generated such that
4326 the system will first attempt to hold fulfillment using items
4327 already at the pickup library if possible. If there are no
4328 items available at the pickup library to fill a hold,
4329 build_holds_queue.pl will then use the list of libraries
4330 defined in StaticHoldsQueueWeight. If
4331 RandomizeHoldsQueueWeight is disabled ( which it is by default
4332 ), the script will assign fulfillment requests in the order
4333 the branches are placed in the StaticHoldsQueueWeight system
4336 <para>For example, if your system has three libraries, of
4337 varying sizes ( small, medium and large ) and you want the
4338 burden of holds fulfillment to be on larger libraries before
4339 smaller libraries, you would want StaticHoldsQueueWeight to
4340 look something like "LRG,MED,SML".</para>
4342 <para>If you want the burden of holds fulfillment to be spread
4343 out equally throughout your library system, simply enable
4344 RandomizeHoldsQueueWeight. When this system preference is
4345 enabled, the order in which libraries will be requested to
4346 fulfill an on-shelf hold will be randomized each time the list
4347 is regenerated.</para>
4349 <para>Leaving StaticHoldsQueueWeight empty is contraindicated
4350 at this time. Doing so will cause the build_holds_queue script
4351 to ignore RandomizeHoldsQueueWeight, causing the script to
4352 request hold fulfillment not randomly, but by alphabetical
4357 <para>The <link linkend="transportcostmatrix">Transport Cost Matrix</link> takes
4358 precedence in controlling where holds are filled from, if the matrix is not used
4359 then Koha checks the StaticHoldsQueueWeight. To use the Transport Cost Matrix
4360 simply set your <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link>
4361 preference to 'Use'</para>
4365 <section id="SuspendHoldsIntranet">
4366 <title>SuspendHoldsIntranet</title>
4368 <para>Default: Allow</para>
4370 <para>Asks: ___ holds to be suspended from the intranet.</para>
4372 <para>Values:</para>
4380 <para>Don't allow</para>
4384 <para>Description:</para>
4388 <para>The holds suspension feature can be turned on and off in
4389 the staff client by altering this system preference. If this
4390 is set to 'allow' you will want to set the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
4391 system preference.</para>
4396 <section id="SuspendHoldsOpac">
4397 <title>SuspendHoldsOpac</title>
4399 <para>Default: Allow</para>
4401 <para>Asks: ___ holds to be suspended from the OPAC.</para>
4403 <para>Values:</para>
4411 <para>Don't allow</para>
4415 <para>Description:</para>
4419 <para>The holds suspension feature can be turned on and off in
4420 the OPAC by altering this system preference. If this is set to
4421 'allow' you will want to set the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
4422 system preference.</para>
4428 <section id="circinterfaceprefs">
4429 <title>Interface</title>
4433 <section id="AllowAllMessageDeletion">
4434 <title>AllowAllMessageDeletion</title>
4436 <para>Default: Don't allow</para>
4438 <para>Asks: ___ staff to delete messages added from other
4441 <para>Values:</para>
4449 <para>Don't allow</para>
4453 <section id="AllowOfflineCirculation">
4454 <title>AllowOfflineCirculation</title>
4455 <para>Default: Do not enable</para>
4456 <para>Asks: ___ offline circulation on regular circulation computers. </para>
4457 <para>Values:<itemizedlist>
4459 <para>Do not enable</para>
4464 </itemizedlist></para>
4465 <para>Description:<itemizedlist>
4467 <para>Setting this preference to 'Enable' allows you to use the Koha interface for
4468 <link linkend="offlinecirc">offline circulation</link>. This system preference
4469 does not affect the <link linkend="firefoxofflinecirc">Firefox plugin</link> or
4470 the <link linkend="windowsofflinecirc">desktop application</link>, any of these
4471 three options can be used for offline circulation without effecting the
4474 </itemizedlist></para>
4477 <section id="CircAutocompl">
4478 <title>CircAutocompl</title>
4480 <para>Default: Try</para>
4482 <para>Asks: ___ to automatically fill in the member when entering
4483 a patron search on the circulation screen.</para>
4485 <para>Description:</para>
4489 <para>This preference is a binary setting which determines
4490 whether auto-completion of fields is enabled or disabled for
4491 the circulation input field. Setting it to "Try" would enable
4492 a staff member to begin typing a name or other value into the
4493 field and have a menu pop up with suggestions for completing
4494 it. Setting it to "Don't try" would disable this feature. This
4495 preference can make staff members' jobs easier or it could
4496 potentially slow down the page loading process.</para>
4500 <para>Values:</para>
4504 <para>Don't try</para>
4511 <screeninfo>When CircAutocompl is turned on search results
4512 will appear below the search box</screeninfo>
4516 <imagedata fileref="images/admin/globalprefs/CircAutocompl.png"/>
4524 <section id="CircAutoPrintQuickSlip">
4525 <title>CircAutoPrintQuickSlip</title>
4527 <para>Default: open a print quick slip window</para>
4529 <para>Asks: When an empty barcode field is submitted in
4530 circulation ___</para>
4532 <para>Values:</para>
4536 <para>clear the screen</para>
4540 <para>open a print quick slip window</para>
4543 <para>open a print slip window</para>
4547 <para>Description:</para>
4551 <para>If this preference is set to open a quick slip (<link
4552 linkend="existingnotices">ISSUEQSLIP</link>) or open a slip (<link
4553 linkend="existingnotices">ISSUESLIP</link>) for printing it will eliminate the
4554 need for the librarian to click the print button to generate a checkout receipt
4555 for the patron they're checking out to. If the preference is set to clear the
4556 screen then "checking out" an empty barcode will clear the screen of the patron
4557 you were last working with.</para>
4562 <section id="FilterBeforeOverdueReport">
4563 <title>FilterBeforeOverdueReport</title>
4565 <para>Default: Don't require</para>
4567 <para>Asks: ___ staff to choose which checkouts to show before
4568 running the overdues report.</para>
4570 <para>Description:</para>
4574 <para>Koha's overdue report shows you all of the overdue items
4575 in your library system. If you have a large library system
4576 you'll want to set this preference to 'Require' to force those
4577 running the report to first limit the data generated to a
4578 branch, date range, patron category or other such filter.
4579 Requiring that the report be filtered before it's run prevents
4580 your staff from running a system heavy report and slowing down
4581 other operations in the system.</para>
4584 <screeninfo>Overdue Report Filters</screeninfo>
4588 <imagedata fileref="images/admin/globalprefs/FilterBeforeOverdueReport.png"/>
4595 <para>Values:</para>
4599 <para>Don't require</para>
4603 <para>Require</para>
4608 <section id="FineNotifyAtCheckin">
4609 <title>FineNotifyAtCheckin</title>
4611 <para>Default: Don't notify</para>
4613 <para>Asks: ___ librarians of overdue fines on the items they are
4616 <para>Values:</para>
4620 <para>Don't notify</para>
4628 <para>Description:</para>
4632 <para>With this preference set to 'Notify' all books that have
4633 overdue fines owed on them will pop up a warning when checking
4634 them in. This warning will need to acknowledged before you can
4635 continue checking items in. With this preference set to 'Don't
4636 notify,' you will still see fines owed on the patron record,
4637 you just won't have an additional notification at check
4641 <screeninfo>Fine notification at checkin</screeninfo>
4645 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
4653 <section id="DisplayClearScreenButton">
4654 <title>DisplayClearScreenButton</title>
4656 <para>Default: Show</para>
4658 <para>Asks: ___ a button to clear the current patron from the
4659 screen on the circulation screen.</para>
4661 <para>Values:</para>
4665 <para>Don't show</para>
4668 <screeninfo>No X in the top right</screeninfo>
4672 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButtonOff.png"/>
4682 <screeninfo>X in the top right will clear the
4687 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
4694 <section id="ExportRemoveFields">
4695 <title>ExportRemoveFields</title>
4696 <para>Asks: The following fields should be excluded from the patron checkout history CSV
4697 or iso2709 export ___ </para>
4698 <para>Description:<itemizedlist>
4700 <para>This space separated list of fields (e.g. 100a 245b) will automatically be
4701 excluded when exporting the patron's current checkout history.</para>
4703 <screeninfo>ExportRemoveFields</screeninfo>
4706 <imagedata fileref="images/admin/globalprefs/ExportRemoveFields.png"/>
4711 </itemizedlist></para>
4713 <section id="ExportWithCsvProfile">
4714 <title>ExportWithCsvProfile</title>
4715 <para>Asks: Use the ___ CSV profile when exporting patron checkout history</para>
4716 <para>Description:<itemizedlist>
4718 <para>Use this preference to define which <link linkend="csvprofiles">CSV
4719 profile</link> should be used when exporting patron's current checkout data.
4720 Enter the CSV Profile name as the value for this preference. If this preference
4721 is left blank you will not be able to export the patron's current checkout
4724 <screeninfo>ExportWithCsvProfile</screeninfo>
4727 <imagedata fileref="images/admin/globalprefs/ExportWithCsvProfile.png"/>
4732 </itemizedlist></para>
4734 <section id="HoldsToPullStartDate">
4735 <title>HoldsToPullStartDate</title>
4736 <para>Default: 2</para>
4737 <para>Asks: Set the default start date for the Holds to pull list to ___ day(s) ago. </para>
4738 <para>Description:<itemizedlist>
4740 <para>The <link linkend="holdspull">Holds to Pull</link> report in circulation
4741 defaults to filtering holds placed 2 days ago. This preference allows you to set
4742 this default filter to any number of days.</para>
4744 </itemizedlist></para>
4746 <section id="itemBarcodeFallbackSearch">
4747 <title>itemBarcodeFallbackSearch</title>
4748 <para>Default: Don't enable</para>
4749 <para>Asks: ___ the automatic use of a keyword catalog search if the phrase entered as
4750 a barcode on the checkout page does not turn up any results during an item barcode
4752 <para>Values:</para>
4755 <para>Don't enable</para>
4760 <screeninfo>Checkout by keyword</screeninfo>
4764 fileref="images/admin/globalprefs/itemBarcodeFallbackSearch.png"/>
4770 <para>Description:<itemizedlist>
4772 <para>Sometimes libraries want to checkout using something other than the barcode.
4773 Enabling this preference will do a keyword search of Koha to find the item
4774 you're trying to check out. You can use the call number, barcode, part of the
4775 title or anything you'd enter in the keyword search when this preference is
4776 enabled and Koha will ask you which item you're trying to check out.</para>
4778 </itemizedlist></para>
4780 <para>While you're not searching by barcode a barcode is required on every title you
4781 check out. Only titles with barcodes will appear in the search results.</para>
4785 <section id="itemBarcodeInputFilter">
4786 <title>itemBarcodeInputFilter</title>
4788 <para>Default: Don't filter</para>
4790 <para>Asks: ___ scanned item barcodes.</para>
4792 <para>Values:</para>
4796 <para>Convert from CueCat format</para>
4800 <para>Convert from Libsuite8 form</para>
4804 <para>Don't filter</para>
4808 <para>EAN-13 or zero-padded UPC-A from</para>
4812 <para>Remove spaces from</para>
4816 <para>Remove the first number from T-prefix style</para>
4820 <para>This format is common among those libraries
4821 migrating from Follett systems</para>
4828 <section id="NoticeCSS">
4829 <title>NoticeCSS</title>
4831 <para>Asks: Include the stylesheet at ___ on Notices.<important>
4832 <para>This should be a complete URL, starting with
4836 <para>Description:</para>
4840 <para>If you would like to style your notices with a
4841 consistent set of fonts and colors you can use this preference
4842 to point Koha to a stylesheet specifically for your
4848 <section id="numReturnedItemsToShow">
4849 <title>numReturnedItemsToShow</title>
4851 <para>Default: 20</para>
4853 <para>Asks : Show the ___ last returned items on the checkin
4857 <section id="previousIssuesDefaultSortOrder">
4858 <title>previousIssuesDefaultSortOrder</title>
4860 <para>Default: earliest to latest</para>
4862 <para>Asks: Sort previous checkouts on the circulation page from
4863 ___ due date.</para>
4865 <para>Values:</para>
4869 <para>earliest to latest</para>
4873 <para>latest to earliest</para>
4878 <section id="RecordLocalUseOnReturn">
4879 <title>RecordLocalUseOnReturn</title>
4881 <para>Default: Don't record</para>
4883 <para>Asks: ___ local use when an unissued item is checked
4886 <para>Values:</para>
4890 <para>Don't record</para>
4898 <para>Description:</para>
4902 <para>When this preference is set to "Don't record" you can
4903 record local use of items by checking items out to the
4904 statistical patron. With this preference set to "Record" you
4905 can record local use by checking out to the statistical patron
4906 and/or by checking in a book that is not currently checked
4912 <section id="soundon">
4913 <title>soundon</title>
4915 <para>Default: Don't enable</para>
4917 <para>Asks: ___ circulation sounds during checkin and checkout in
4918 the staff interface.</para>
4920 <para>Values:</para>
4924 <para>Don't enable</para>
4933 <para>This feature is not supported by all browsers. Requires
4934 an HTML5 compliant browser.</para>
4938 <section id="SpecifyDueDate">
4939 <title>SpecifyDueDate</title>
4941 <para>Default: Allow</para>
4943 <para>Asks: ___ staff to specify a due date for a checkout.</para>
4945 <para>Due dates are calculated using your circulation and fines
4946 rules, but staff can override that if you allow them to specify a
4947 due date at checkout.</para>
4949 <para>Description:</para>
4953 <para>This preference allows for circulation staff to change a
4954 due date from the automatic due date to another calendar date.
4955 This option would be used for circumstances in which the due
4956 date may need to be decreased or extended in a specific
4957 circumstance. The "Allow" setting would allow for this option
4958 to be utilized by staff, the "Don't allow" setting would bar
4959 staff from changing the due date on materials.</para>
4963 <para>Values:</para>
4970 <screeninfo>Specify Due Date Box Shows</screeninfo>
4974 <imagedata fileref="images/admin/globalprefs/SpecifyDueDate.png"/>
4981 <para>Don't allow</para>
4984 <screeninfo>Specify Due Date Box Doesn't Show</screeninfo>
4988 <imagedata fileref="images/admin/globalprefs/SpecifyDueDate-no.png"/>
4996 <section id="todaysIssuesDefaultSortOrder">
4997 <title>todaysIssuesDefaultSortOrder</title>
4999 <para>Default: latest to earliest</para>
5001 <para>Asks: Sort today's checkouts on the circulation page from
5002 ___ due date.</para>
5004 <para>Values:</para>
5008 <para>earliest to latest</para>
5012 <para>latest to earliest</para>
5017 <section id="UpdateTotalIssuesOnCirc">
5018 <title>UpdateTotalIssuesOnCirc</title>
5020 <para>Default: Do not</para>
5022 <para>Asks: ___ update a bibliographic record's total issues count
5023 whenever an item is issued</para>
5025 <para>Values:</para>
5030 <para>This increases server load significantly; if
5031 performance is a concern, use the <link linkend="updateissuescron">cron job</link> to update the
5032 total issues count instead.</para>
5041 <para>Description:</para>
5045 <para>Koha can track the number of times and item is checked
5046 out and store that on the item record in the database. This
5047 information is not stored by default. Setting this preference
5048 to 'Do' will tell Koha to track that info everytime the item
5049 is checked out in real time. Otherwise you could use the <link linkend="updateissuescron">cron job</link> to have Koha update
5050 that field nightly.</para>
5055 <section id="UseTablesortForCirc">
5056 <title>UseTablesortForCirc</title>
5058 <para>Default: Don't enable</para>
5060 <para>Asks: ___ the sorting of current patron checkouts on the
5061 circulation screen.</para>
5063 <para>Values:</para>
5067 <para>Don't enable</para>
5076 <para>Enabling this function may slow down circulation time for
5077 patrons with many checkouts.</para>
5081 <section id="WaitingNotifyAtCheckin">
5082 <title>WaitingNotifyAtCheckin</title>
5084 <para>Default: Don't notify</para>
5086 <para>Asks: ___ librarians of waiting holds for the patron whose
5087 items they are checking in.</para>
5089 <para>Values:</para>
5093 <para>Don't notify</para>
5100 <screeninfo>Notification that a hold is waiting</screeninfo>
5104 <imagedata fileref="images/admin/globalprefs/WaitingNotifyAtCheckin.png"/>
5111 <para>Description:</para>
5115 <para>When checking in books you can choose whether or not to
5116 have a notice pop up if the patron who returned the book has a
5117 hold waiting for pick up. If you choose 'Notify' for
5118 WaitingNotifyAtCheckin then every time a hold is found for the
5119 patron who had the book out last a message will appear on your
5120 check in screen.</para>
5126 <section id="circscoprefs">
5127 <title>Self Checkout</title>
5131 <section id="AllowSelfCheckReturns">
5132 <title>AllowSelfCheckReturns</title>
5134 <para>Default: Don't allow</para>
5136 <para>Asks: ___ patrons to return items through web-based self
5137 checkout system.</para>
5139 <para>Values:</para>
5147 <para>Don't allow</para>
5151 <para>Description:</para>
5155 <para>This preference is used to determine if you want patrons
5156 to be allowed to return items through your self check
5157 machines. By default Koha's self check interface is simply for
5158 checking items out.</para>
5163 <section id="AutoSelfCheckAllowed">
5164 <title>AutoSelfCheckAllowed, AutoSelfCheckID &
5165 AutoSelfCheckPass</title>
5168 <para>Most libraries will want to leave this set to 'Don't
5169 allow.' This preference turns off the requirement to log into
5170 the self checkout machine with a staff username and password by
5171 storing the username and password for automatic login.</para>
5174 <para>AutoSelfCheckAllowed Default: Don't allow</para>
5176 <para>Asks: ___ the web-based self checkout system to
5177 automatically login with this staff login ___ and this password
5180 <para>AutoSelfCheckAllowed Values:</para>
5188 <para>Don't allow</para>
5192 <para>AutoSelfCheckID Value:<itemizedlist>
5194 <para>The username of a staff patron with 'circulate' <link linkend="patronpermissions">permissions</link>.</para>
5196 </itemizedlist></para>
5198 <para>AutoSelfCheckPass Value:<itemizedlist>
5200 <para>The password of a staff patron with 'circulate' <link linkend="patronpermissions">permissions</link>.</para>
5202 </itemizedlist></para>
5204 <section id="SCOUserCSS">
5205 <title>SCOUserCSS</title>
5206 <para>Asks: Include the following CSS on all pages in the web-based self checkout</para>
5207 <para>Description:<itemizedlist>
5209 <para>The CSS entered in this preference will be used on all of your Koha self
5210 checkout screens.</para>
5212 </itemizedlist></para>
5214 <section id="SCOUserJS">
5215 <title>SCOUserJS</title>
5216 <para>Asks: Include the following JavaScript on all pages in the web-based self
5218 <para>Description:<itemizedlist>
5220 <para>The JavaScript entered in this preference will effect all of your Koha self
5221 checkout screens.</para>
5223 </itemizedlist></para>
5226 <section id="SelfCheckHelpMessage">
5227 <title>SelfCheckHelpMessage</title>
5229 <para>Asks: Include the following HTML in the Help page of the
5230 web-based self checkout system</para>
5232 <para>Description:</para>
5236 <para>Clicking the 'Help' link in the top right of the self
5237 checkout interface opens up a three step process for using the
5238 self check interface. Adding HTML to this system preference
5239 will print that additional help text above what's already
5245 <section id="SelfCheckoutByLogin">
5246 <title>SelfCheckoutByLogin</title>
5248 <para>Default: Barcode</para>
5250 <para>Asks: Have patrons login into the web-based self checkout
5251 system with their ___</para>
5253 <para>Values:</para>
5257 <para>Barcode</para>
5260 <screeninfo>Self Checkout Patron Card Number</screeninfo>
5264 <imagedata fileref="images/circ/selfcheckout.png"/>
5271 <para>Username and password</para>
5274 <screeninfo>Shelf checkout by login</screeninfo>
5278 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
5285 <para>Description:</para>
5289 <para>This preference lets you decide how your patrons will
5290 log in to the self checkout machine. Barcode is the patron's
5291 card number and their username and password is set using the
5292 opac/staff username and password fields on the patron
5297 <section id="SelfCheckReceiptPrompt">
5298 <title>SelfCheckReceiptPrompt</title>
5299 <para>Default: Show</para>
5300 <para>Asks: ___ the print receipt popup dialog when self checkout is finished.</para>
5301 <para>Values:<itemizedlist>
5303 <para>Don't show</para>
5308 </itemizedlist></para>
5309 <para>Description:<itemizedlist>
5311 <para>This preference controls whether a prompt shows up on the web based self
5312 check out when the patron clicks the 'Finish' button.</para>
5314 </itemizedlist></para>
5317 <section id="SelfCheckTimeout">
5318 <title>SelfCheckTimeout</title>
5320 <para>Default: 120</para>
5322 <para>Asks: Time out the current patron's web-based self checkout
5323 system login after ___ seconds.</para>
5325 <para>Description:</para>
5329 <para>After the machine is idle for the time entered in this
5330 preference the self check out system will log out the current
5331 patron and return to the starting screen.</para>
5336 <section id="ShowPatronImageInWebBasedSelfCheck">
5337 <title>ShowPatronImageInWebBasedSelfCheck</title>
5339 <para>Default: Don't show</para>
5341 <para>Asks: ___ the patron's picture (if one has been added) when
5342 they use the web-based self checkout.</para>
5344 <para>Values:</para>
5348 <para>Don't show</para>
5357 <section id="WebBasedSelfCheck">
5358 <title>WebBasedSelfCheck</title>
5360 <para>Default: Don't enable</para>
5362 <para>Asks: ___ the web-based self checkout system.</para>
5364 <para>Values:</para>
5368 <para>Don't enable</para>
5376 <para>Enabling this preference will allow access to the <link linkend="selfcheckout">self checkout</link> module in Koha.</para>
5381 <section id="creatorprefs">
5382 <title>Creators</title>
5384 <para>These preferences have to do with creating content.</para>
5386 <para><emphasis>Get there:</emphasis> More > Administration >
5387 Global System Preferences > Creators</para>
5389 <section id="creatorpatcardprefs">
5390 <title>Patron Cards</title>
5392 <para>These preferences are in reference to the <link linkend="patroncardcreator">Patron Card Creator</link> tool.</para>
5394 <section id="ImageLimit">
5395 <title>ImageLimit</title>
5397 <para>Asks: Limit the number of creator images stored in the
5398 database to ___ images.</para>
5403 <section id="enhancedcontent">
5404 <title>Enhanced Content</title>
5406 <para><emphasis>Get there:</emphasis> More > Administration >
5407 Global System Preferences > Enhanced Content</para>
5410 <para>Always read the terms of service associated with external data
5411 sources to be sure that you are using the products within the
5412 allowed limits.</para>
5416 <para>You cannot have more than one service for cover images
5417 (including local cover images) set up. If you set up more than one
5418 you will get multiple cover images. Instead choose only one source
5419 for cover images.</para>
5422 <section id="frbrenhancedprefs">
5427 <section id="FRBRizeEditions">
5428 <title>FRBRizeEditions</title>
5430 <para>Default: Don't show</para>
5432 <para>Asks: ___ other editions of an item on the staff
5435 <para>Values:</para>
5439 <para>Don't show</para>
5446 <screeninfo>Editions tab in staff client</screeninfo>
5450 <imagedata fileref="images/admin/globalprefs/editionstab.png"/>
5457 <para>Description:</para>
5461 <para>Using the rules set forth in the Functional Requirements for Bibliographic
5462 records, this option, when enabled, pulls all editions of the same title available
5463 in your collection regardless of material type. Items will appear under an
5464 'Editions' tab on the detail page for the title in question.. According to
5465 <emphasis>Libraries Unlimited's Online Dictionary for Library and Information
5466 Science</emphasis> (<ulink url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>), FRBRizing the catalog involves collating MARC
5467 records of similar materials. FRBRization brings together entities (sets of Works,
5468 Expressions, or Manifestations), rather than just sets of Items. It can aid
5469 patrons in selecting related items, expressions, and manifestations that will
5470 serve their needs. When it is set to "Show", the OPAC will query one or more ISBN
5471 web services for associated ISBNs and display an Editions tab on the details
5472 pages. Once this preference is enabled, the library must select one of the ISBN
5473 options (<link linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN">XISBN</link>). This option is only for the Staff Client; the <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> option must be enabled
5474 to have the Editions tab appear on the OPAC.</para>
5479 <para>Requires that you turn on one or more of the ISBN services (<link linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN">XISBN</link>)</para>
5483 <section id="OPACFRBRizeEditions">
5484 <title>OPACFRBRizeEditions</title>
5486 <para>Default: Don't show</para>
5488 <para>Asks: ___ other editions of an item on the OPAC.</para>
5490 <para>Description:</para>
5494 <para>Using the rules set forth in the Functional Requirements for Bibliographic
5495 records, this option, when enabled, pulls all editions of the same title available
5496 in your collection regardless of material type. Items will appear under an
5497 'Editions' tab on the detail page for the title in question.. According to
5498 <emphasis>Libraries Unlimited's Online Dictionary for Library and Information
5499 Science</emphasis> (<ulink url="http://lu.com/odlis/">http://lu.com/odlis/</ulink>), FRBRizing the catalog involves collating MARC
5500 records of similar materials. FRBRization brings together entities (sets of Works,
5501 Expressions, or Manifestations), rather than just sets of Items. It can aid
5502 patrons in selecting related items, expressions, and manifestations that will
5503 serve their needs. When it is set to "Show", the OPAC will query one or more ISBN
5504 web services for associated ISBNs and display an Editions tab on the details
5505 pages. Once this preference is enabled, the library must select one of the ISBN
5506 options (<link linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN">XISBN</link>). This option is only for the OPAC; the <link linkend="FRBRizeEditions">FRBRizeEditions</link> option must be turned "On" to
5507 have the Editions tab appear on the Staff Client.</para>
5511 <para>Values:</para>
5515 <para>Don't show</para>
5522 <screeninfo>Editions tab in the OPAC</screeninfo>
5526 <imagedata fileref="images/admin/globalprefs/editions.png"/>
5533 <para>This preference pulls all editions of the same title
5534 available in your collection regardless of material type. Items
5535 will appear under an 'Editions' tab on the detail page for the
5536 title in question.</para>
5539 <para>Requires that you turn on one or more of the ISBN services (<link linkend="ThingISBN">ThingISBN</link> and/or <link linkend="XISBN">XISBN</link>)</para>
5544 <section id="amazonprefs">
5545 <title>Amazon</title>
5549 <section id="AmazonAssocTag">
5550 <title>AmazonAssocTag</title>
5552 <para>Asks: Put the associate tag ___ on links to Amazon.</para>
5555 <para>This can net your library referral fees if a patron
5556 decides to buy an item after clicking through to Amazon from
5560 <para>Description:</para>
5564 <para>An Amazon Associates Tag allows a library to earn a
5565 percentage of all purchases made on Amazon when a patron
5566 accesses Amazon's site via links on the library's website.
5567 More information about the Amazon Associates program is
5568 available at Amazon's Affiliate Program's website, <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink>.
5569 Before a tag can be obtained, however, the library must first
5570 apply for an Amazon Web Services (AWS) account. Applications
5571 are free of charge and can be made at <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink>.
5572 Once an AWS account has been established, the library can then
5573 obtain the Amazon Associates Tag.</para>
5577 <para>Sign up at: <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com/</ulink></para>
5580 <section id="AmazonCoverImages">
5581 <title>AmazonCoverImages</title>
5583 <para>Default: Don't show</para>
5585 <para>Asks: ___ cover images from Amazon on search results and
5586 item detail pages on the staff interface.</para>
5588 <para>Values:</para>
5592 <para>Don't show</para>
5600 <para>Description:</para>
5604 <para>This preference makes it possible to either allow or
5605 prevent Amazon cover images from being displayed in the Staff
5606 Client. Cover images are retrieved by Amazon, which pulls the
5607 content based on the first ISBN number in the item's MARC
5608 record. Amazon offers this service free of charge. If the
5609 value for this preference is set to "Show", the cover images
5610 will appear in the Staff Client, and if it is set to "Don't
5611 show", the images will not appear. Finally, if you're using
5612 Amazon cover images, all other cover image services must be
5613 disabled. If they are not disabled, they will prevent
5614 AmazonCoverImages from functioning properly.</para>
5619 <section id="AmazonLocale">
5620 <title>AmazonLocale</title>
5622 <para>Default: American</para>
5624 <para>Asks: Use Amazon data from its ___ website.</para>
5630 <para>American</para>
5634 <para>British</para>
5638 <para>Canadian</para>
5650 <para>Japanese</para>
5655 <section id="OPACAmazonCoverImages">
5656 <title>OPACAmazonCoverImages</title>
5658 <para>Default: Don't show</para>
5660 <para>Asks: ___ cover images from Amazon on search results and
5661 item detail pages on the OPAC.</para>
5663 <para>Values:</para>
5667 <para>Don't show</para>
5675 <para>Description:</para>
5679 <para>This preference makes it possible to either allow or
5680 prevent Amazon cover images from being displayed in the OPAC.
5681 Cover images are retrieved by Amazon, which pulls the content
5682 based on the first ISBN number in the item's MARC record.
5683 Amazon offers this service free of charge. If the value for
5684 this preference is set to "Show", the cover images will appear
5685 in the OPAC, and if it is set to "Don't show", the images will
5686 not appear. Finally, if you're using Amazon cover images, all
5687 other cover image services must be disabled. If they are not
5688 disabled, they will prevent AmazonCoverImages from functioning
5695 <section id="Babelthequeprefs">
5696 <title>Babelthèque</title>
5700 <section id="Babeltheque">
5701 <title>Babeltheque</title>
5703 <para>Default: Don't</para>
5705 <para>Asks: ___ include information (such as reviews and
5706 citations) from Babelthèque in item detail pages on the
5709 <para>Description:</para>
5713 <para>This preference makes it possible to display a
5714 Babeltheque tab in the OPAC, allowing patrons to access tags,
5715 reviews, and additional title information provided by
5716 Babeltheque. The information which Babeltheque supplies is
5717 drawn from the French language-based <ulink url="http://www.babelio.com/">Babelio.com</ulink>, a French
5718 service similar to LibraryThing for Libraries. More
5719 information about Babeltheque is available through its
5720 website, <ulink url="http://www.babeltheque.com/">http://www.babeltheque.com</ulink>.
5721 Libraries that wish to allow access to this information must
5722 first register for the service at <ulink url="http://www.babeltheque.com">http://www.babeltheque.com</ulink>.
5723 Please note that this information is only provided in
5728 <para>Values:</para>
5735 <screeninfo>Data from Babelthèque on the bib
5740 <imagedata fileref="images/admin/globalprefs/Babeltheque.png"/>
5752 <section id="Babeltheque_url_js">
5753 <title>Babeltheque_url_js</title>
5755 <para>Asks: ___ Defined the url for the Babeltheque javascript
5756 file (eg. http://www.babeltheque.com/bw_XX.js)</para>
5759 <section id="Babeltheque_url_update">
5760 <title>Babeltheque_url_update</title>
5762 <para>Asks: ___ Defined the url for the Babeltheque update
5764 http://www.babeltheque.com/.../file.csv.bz2).</para>
5768 <section id="btcontentprefs">
5769 <title>Baker & Taylor</title>
5772 <para>This is a pay service, you must contact Baker & Taylor
5773 to subscribe to this service before setting these options.</para>
5776 <section id="BakerTaylorEnabled">
5777 <title>BakerTaylorEnabled</title>
5779 <para>Default: Don't add</para>
5781 <para>Asks: ___ Baker and Taylor links and cover images to the
5782 OPAC and staff client. This requires that you have entered in a
5783 username and password (which can be seen in image links).</para>
5785 <para>Values:</para>
5793 <para>Don't add</para>
5797 <para>Description:</para>
5801 <para>This preference makes it possible to display Baker &
5802 Taylor content (book reviews, descriptions, cover images,
5803 etc.) in both the Staff Client and the OPAC. Libraries that
5804 wish to display Baker & Taylor content must first register
5805 and pay for this service with Baker & Taylor (<ulink url="http://www.btol.com">http://www.btol.com</ulink>). If
5806 Baker & Taylor content is enabled be sure to turn off
5807 other cover and review services to prevent
5808 interference.</para>
5813 <para>To use this you will need to also set the <link linkend="btuserpass">BakerTaylorUsername &
5814 BakerTaylorPassword</link> system preferences</para>
5818 <section id="BakerTaylorBookstoreURL">
5819 <title>BakerTaylorBookstoreURL</title>
5821 <para>Asks: Baker and Taylor "My Library Bookstore" links should
5822 be accessed at https:// ___ isbn</para>
5824 <para>Description:</para>
5828 <para>Some libraries generate additional funding for the
5829 library by selling books and other materials that are
5830 purchased from or have been previously leased from Baker &
5831 Taylor. These materials can be accessed via a link on the
5832 library's website. This service is often referred to as "My
5833 Library Bookstore." In order to participate in this program,
5834 the library must first register and pay for the service with
5835 Baker & Taylor. Additional information about this and
5836 other services provided by Baker & Taylor is available at
5837 the Baker & Taylor website, <ulink url="http://www.btol.com">http://www.btol.com</ulink>. The
5838 BakerTaylorBookstoreURL preference establishes the URL in
5839 order to link to the library's Baker & Taylor-backed
5840 online bookstore, if such a bookstore has been established.
5841 The default for this field is left blank; if no value is
5842 entered, the links to My Library Bookstore will remain
5843 inactive. If enabling this preference, enter the library's
5844 Hostname and Parent Number in the appropriate location within
5845 the URL. The "key" value (key=) should be appended to the URL,
5846 and https:// should be prepended.</para>
5850 <para>This should be filled in with something like
5851 koha.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&parentNum=10923&key=</para>
5854 <para>Leave it blank to disable these links.</para>
5858 <para>Be sure to get this information from Baker & Taylor
5859 when subscribing.</para>
5863 <section id="btuserpass">
5864 <title>BakerTaylorUsername & BakerTaylorPassword</title>
5866 <para>Asks: Access Baker and Taylor using username ___ and
5869 <para>Descriptions:</para>
5873 <para>This setting in only applicable if the library has a
5874 paid subscription to the external Content Café service from
5875 Baker & Taylor. Use the box provided to enter in the
5876 library's Content Café username and password. Also, ensure
5877 that the <link linkend="BakerTaylorBookstoreURL">BakerTaylorBookstoreURL</link>
5878 and <link linkend="BakerTaylorEnabled">BakerTaylorEnabled</link>
5879 settings are properly set. The Content Café service is a feed
5880 of enhanced content such as cover art, professional reviews,
5881 and summaries that is displayed along with Staff Client/OPAC
5882 search results. For more information on this service please
5883 see the Baker & Taylor website: <ulink url="http://www.btol.com">http://www.btol.com</ulink></para>
5888 <para>Be sure to get this information from Baker & Taylor
5889 when subscribing.</para>
5894 <section id="googleprefs">
5895 <title>Google</title>
5899 <section id="GoogleJackets">
5900 <title>GoogleJackets</title>
5902 <para>Default: Don't add</para>
5904 <para>Asks: ___ cover images from Google Books to search results
5905 and item detail pages on the OPAC.</para>
5907 <para>Values:</para>
5915 <para>Don't add</para>
5919 <para>Description:</para>
5923 <para>This setting controls the display of applicable cover
5924 art from the free Google Books database, via the Google Books
5925 API. Please note that to use this feature, all other cover
5926 services should be turned off.</para>
5931 <section id="html5">
5932 <title>HTML5 Media</title>
5933 <section id="HTML5MediaEnabled">
5934 <title>HTML5MediaEnabled</title>
5935 <para>Default: not at all</para>
5936 <para>Asks: Show a tab with a HTML5 media player for files catalogued in field 856
5938 <para>Values:<itemizedlist>
5940 <para>in OPAC and staff client</para>
5943 <para>in the OPAC</para>
5945 <screeninfo>HTML5 Media in the OPAC</screeninfo>
5948 <imagedata fileref="images/admin/globalprefs/HTML5MediaEnabled-opac.png"/>
5954 <para>in the staff client</para>
5956 <screeninfo>HTML5 Media in the staff client</screeninfo>
5959 <imagedata fileref="images/admin/globalprefs/HTML5MediaEnabled-staff.png"/>
5965 <para>not at all</para>
5967 </itemizedlist></para>
5968 <para>Description:<itemizedlist>
5970 <para>If you have media elements in the 856 of your MARC record this preference
5971 can run/show those media files in a separate tab using HTML5.</para>
5973 </itemizedlist></para>
5975 <section id="HTML5MediaExtensions">
5976 <title>HTML5MediaExtensions</title>
5977 <para>Default: webm|ogg|ogv|oga|vtt</para>
5978 <para>Asks: Media file extensions ___</para>
5979 <para>Description:<itemizedlist>
5981 <para>Enter in file extensions separated with bar (|)</para>
5983 </itemizedlist></para>
5986 <section id="IDreamLibraries">
5987 <title>IDreamLibraries</title>
5988 <para><ulink url="http://idreambooks.com/">IDreamBooks.com</ulink> aggregates book reviews
5989 by critics to help you discover the very best of what's coming out each week. These
5990 preferences let you integrated content from <ulink url="http://IDreamBooks.com">IDreamBooks.com</ulink> in to your Koha OPAC. <tip>
5991 <para>This is a new website and has limited content, so you may only see these
5992 features on new popular titles until the database grows some more.</para>
5994 <section id="IDreamBooksReadometer">
5995 <title>IDreamBooksReadometer</title>
5996 <para>Default: Don't add</para>
5997 <para>Asks: ___ a "Readometer" that summarizes the reviews gathered by IDreamBooks.com
5998 to the OPAC details page. </para>
5999 <para>Values:<itemizedlist>
6003 <screeninfo>Readometer on the details page</screeninfo>
6006 <imagedata fileref="images/admin/globalprefs/IDreamBooksReadometer.png"/>
6012 <para>Don't add</para>
6014 </itemizedlist></para>
6016 <section id="IDreamBooksResults">
6017 <title>IDreamBooksResults</title>
6018 <para>Default: Don't add</para>
6019 <para>Asks: ___ the rating from IDreamBooks.com to OPAC search results. </para>
6020 <para>Values:<itemizedlist>
6024 <screeninfo>iDreamBooks rating on search results</screeninfo>
6027 <imagedata fileref="images/admin/globalprefs/IDreamBooksResults.png"/>
6033 <para>Don't add</para>
6035 </itemizedlist></para>
6037 <section id="IDreamBooksReviews">
6038 <title>IDreamBooksReviews</title>
6039 <para>Default: Don't add</para>
6040 <para>Asks: ___ a tab on the OPAC details with book reviews from critics aggregated by
6041 IDreamBooks.com. </para>
6042 <para>Values:<itemizedlist>
6046 <screeninfo>Reviews tab on the detail page</screeninfo>
6049 <imagedata fileref="images/admin/globalprefs/IDreamBooksReviews.png"/>
6055 <para>Don't add</para>
6057 </itemizedlist></para>
6061 <section id="librarythingprefs">
6062 <title>LibraryThing</title>
6064 <para>LibraryThing for Libraries is a pay service. You must first
6065 contact LibraryThing directly for pricing and subscription
6066 information. Learn more at <ulink url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink>.
6067 Also, for further configuration instructions please see the
6068 LibraryThing Wiki: <ulink url="http://www.librarything.com/wiki/index.php/Koha">http://www.librarything.com/wiki/index.php/Koha</ulink></para>
6070 <section id="LibraryThingForLibrariesEnabled">
6071 <title>LibraryThingForLibrariesEnabled</title>
6073 <para>Default: Don't show</para>
6075 <para>Asks: ___ reviews, similar items, and tags from Library
6076 Thing for Libraries on item detail pages on the OPAC.</para>
6078 <para>Values:</para>
6082 <para>Don't show</para>
6090 <para>Description:</para>
6094 <para>This setting is only applicable if the library has a
6095 paid subscription to the external LibraryThing for Libraries
6096 service. This service can provide patrons with the display of
6097 expanded information on catalog items such as book
6098 recommendations. It also can offer advanced features like
6099 tagged browsing, patron written reviews, and a virtual library
6100 display accessed from the details tab.</para>
6105 <para>If this is set to 'show' you will need to enter a value in
6106 the '<link linkend="LibraryThingForLibrariesID">LibraryThingForLibrariesID</link>'
6107 system preference.</para>
6111 <section id="LibraryThingForLibrariesID">
6112 <title>LibraryThingForLibrariesID</title>
6114 <para>Asks: Access Library Thing for Libraries using the customer
6117 <para>Description:</para>
6121 <para>This setting is only applicable if the library has a
6122 paid subscription to the external LibraryThing for Libraries
6123 service. Use the box provided to enter in the library's
6124 LibraryThing for Libraries ID as provided to the library by
6125 LibraryThing. The ID number is a series of numbers in the form
6126 ###-#########, and can be found on the library's account page
6127 at LibraryThing for Libraries. This service can provide
6128 patrons with the display of expanded information on catalog
6129 items such as book recommendations and cover art. It also can
6130 offer advanced features like tagged browsing, patron written
6131 reviews, and a virtual library display accessed from the
6137 <section id="LibraryThingForLibrariesTabbedView">
6138 <title>LibraryThingForLibrariesTabbedView</title>
6140 <para>Default: in line with bibliographic information</para>
6142 <para>Asks: Show Library Thing for Libraries content ___</para>
6144 <para>Values:</para>
6148 <para>in line with bibliographic information</para>
6152 <para>in tabs</para>
6156 <para>Description:</para>
6160 <para>This setting is only applicable if the library has a
6161 paid subscription to the external LibraryThing for Libraries
6162 service. This service can provide patrons with the display of
6163 expanded information on catalog items such as book
6164 recommendations and cover art. It also can offer advanced
6165 features like tagged browsing, patron written reviews, and a
6166 virtual library display accessed from the details tab.</para>
6170 <section id="ThingISBN">
6171 <title>ThingISBN</title>
6172 <para>Default: Don't use</para>
6173 <para>Asks: ___ the ThingISBN service to show other editions of a title</para>
6174 <para>Values:</para>
6177 <para>Don't use</para>
6183 <para>Description:</para>
6186 <para>Set to 'Use' to display an "Editions" tab on the item's detail page. Editions
6187 are listed, complete with cover art (if you have one of the cover services
6188 enabled) and bibliographic information. The feed comes from LibraryThing's
6189 ThingISBN web service. This is a free service to non-commercial sites with fewer
6190 than 1,000 requests per day.</para>
6194 <para>Requires <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link
6195 linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to 'show'</para>
6198 <para>This is separate from Library Thing for Libraries and does not have a cost
6199 associated with it.</para>
6204 <section id="localimages">
6205 <title>Local Cover Images</title>
6209 <section id="AllowMultipleCovers">
6210 <title>AllowMultipleCovers</title>
6212 <para>Default: Don't allow</para>
6214 <para>Asks: ___ multiple images to be attached to each
6215 bibliographic record.</para>
6217 <para>Values:</para>
6225 <para>Don't allow</para>
6229 <para>Description:</para>
6233 <para>If this preference is set to 'Allow' then you can upload
6234 multiple images that will appear in the images tab on the bib
6235 record in the OPAC and the staff client. This preference
6236 requires that either one or both <link linkend="LocalCoverImages">LocalCoverImages</link> and <link linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> are
6237 set to 'Display.'</para>
6240 <screeninfo>Multiple cover images</screeninfo>
6244 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
6252 <section id="LocalCoverImages">
6253 <title>LocalCoverImages</title>
6255 <para>Default: Don't display</para>
6257 <para>Asks: ___ local cover images on intranet search and details
6260 <para>Values:</para>
6264 <para>Display</para>
6268 <para>Don't display</para>
6272 <para>Description:</para>
6276 <para>Setting this preference to 'Display' allows you to
6277 upload your own cover images to bib records and display them
6278 on the detail page in the staff client. At this time the cover
6279 will only show under the 'Images' tab on the holdings table on
6280 the detail display, not next to the title at the top left or
6281 on the search results.</para>
6286 <section id="OPACLocalCoverImages">
6287 <title>OPACLocalCoverImages</title>
6289 <para>Default: Don't display</para>
6291 <para>Asks: ___ local cover images on OPAC search and details
6294 <para>Values:</para>
6298 <para>Display</para>
6302 <para>Don't display</para>
6306 <para>Description:</para>
6310 <para>Setting this preference to 'Display' allows you to
6311 upload your own cover images to bib records and display them
6312 on the detail page and search results in the OPAC.</para>
6318 <section id="novelistselect">
6319 <title>Novelist Select</title>
6321 <para>Novelist Select is not a free service. Contact your Ebsco
6322 representitive to get your log in information to embed this content
6323 in the OPAC.<important>
6324 <para>Novelist Select does not include cover images for the search results and
6325 bibliographic detail pages. You can choose any other cover image service for this
6326 content or you can contract with Ebsco to get access to the <link linkend="btcontentprefs">Baker & Taylor Content Cafe</link> for an added
6330 <section id="NovelistSelectEnabled">
6331 <title>NovelistSelectEnabled</title>
6333 <para>Default: Don't add</para>
6335 <para>Asks: ___ Novelist Select content to the OPAC.</para>
6337 <para>Values:</para>
6345 <para>Don't add</para>
6350 <para>Enabling this requires that you have entered in a user
6351 profile and password in the <link linkend="NovelistSelectProfile">NovelistSelectProfile &
6352 NovelistSelectPassword</link> preferences</para>
6353 </important>Description:</para>
6357 <para>Novelist Select from Ebsco is a subscription service
6358 that can provide additional content in the OPAC.</para>
6363 <section id="NovelistSelectProfile">
6364 <title>NovelistSelectProfile & NovelistSelectPassword</title>
6366 <para>Asks: Access Novelist Select using user profile ___ and
6367 password ___.</para>
6370 <para>This information will be visible if someone views the
6371 source code on your OPAC.</para>
6374 <para>Description:</para>
6378 <para>Novelist Select from Ebsco is a subscription service
6379 that can provide additional content in the OPAC.</para>
6384 <section id="NovelistSelectView">
6385 <title>NovelistSelectView</title>
6387 <para>Default: in an OPAC tab</para>
6389 <para>Asks: Display Novelist Select content ___</para>
6391 <para>Description:</para>
6395 <para>Novelist Select provides a lot of content, for that
6396 reason you have four choices of where to display this content.
6397 The default view is in a tab in the holdings table.</para>
6400 <screeninfo>Novelist Select in a tab</screeninfo>
6404 <imagedata fileref="images/admin/globalprefs/novelisttab.png"/>
6409 <para>The content is the same if you choose to show it above
6410 the holdings table or below it. If shown in the right column
6411 of the page it's the same content, but displays a bit
6412 differently since space is limited.</para>
6415 <screeninfo>Novelist Select on the side</screeninfo>
6419 <imagedata fileref="images/admin/globalprefs/novelistside.png"/>
6426 <para>Values:</para>
6430 <para>above the holdings table</para>
6434 <para>below the holdings table</para>
6438 <para>in an OPAC tab</para>
6442 <para>under the Save Record dropdown on the right</para>
6448 <section id="oclcprefs">
6453 <section id="XISBN">
6454 <title>XISBN</title>
6456 <para>Default: Don't use</para>
6458 <para>Asks: ___ the OCLC xISBN service to show other editions of a
6461 <para>Description:</para>
6465 <para>Set to 'Use' to display an "Editions" tab on the item's
6466 detail page. Editions are listed, complete with cover art and
6467 bibliographic information. The feed comes from OCLC's xISBN
6468 web service. The feed limit for non-commercial sites is 1000
6469 requests per day.</para>
6473 <para>Values:</para>
6477 <para>Don't use</para>
6486 <para>Requires <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
6491 <section id="OCLCAffiliateID">
6492 <title>OCLCAffiliateID</title>
6494 <para>Asks: Use the OCLC affiliate ID ___ to access the xISBN
6497 <para>Description:</para>
6501 <para>This setting is only applicable if the library has an
6502 OCLC Affiliate ID. This allows WorldCat searching in the OPAC
6503 via the XISBN programming interface. Simply enter the
6504 library's OCLC Affiliate ID in the box provided. Please note
6505 that using this data is only necessary if <link linkend="FRBRizeEditions">FRBRizeEditions</link> and/or <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> and
6506 <link linkend="XISBN">XISBN</link> settings are enabled. For
6507 more information on this service please visit the OCLC
6508 website: <ulink url="http://www.worldcat.org/affiliate/default.jsp">http://www.worldcat.org/affiliate/default.jsp</ulink>.</para>
6513 <para>Unless you have signed up for an ID with OCLC, you are
6514 limited to 1000 requests per day. Available at: <ulink url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
6518 <section id="XISBNDailyLimit">
6519 <title>XISBNDailyLimit</title>
6521 <para>Default: 999</para>
6523 <para>Asks: Only use the xISBN service ___ times a day.</para>
6526 <para>Unless you have signed up for an ID with OCLC, you are
6527 limited to 1000 requests per day. Available at: <ulink url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
6532 <section id="OpenLibraryPrefs">
6533 <title>Open Library</title>
6535 <section id="OpenLibraryCovers">
6536 <title>OpenLibraryCovers</title>
6538 <para>Default: Don't add</para>
6540 <para>Asks: ___ cover images from Open Library to search results
6541 and item detail pages on the OPAC.</para>
6543 <para>Values:</para>
6551 <para>Don't add</para>
6555 <para>Description:</para>
6559 <para>This setting controls the display of applicable cover
6560 art from the free Open Library database, via the Open Library
6561 API. Please note that to use this feature, all other cover
6562 services should be turned off.</para>
6567 <section id="overdriveprefs">
6568 <title>Overdrive</title>
6569 <para>OverDrive is an pay service. You must first contact OverDrive directly for pricing
6570 and subscription information. Enabling this service will integrate Overdrive results in
6571 to your OPAC searches. You will have to apply for these 3 pieces of information through
6572 an application as an API developer. Overdrive API applications are evaluated once a week
6573 so you may not be able to use this feature immediately after signing up. To learn more
6574 please contact your OverDrive representative.</para>
6576 <screeninfo>Overdrive results</screeninfo>
6579 <imagedata fileref="images/admin/globalprefs/Overdrive.png"/>
6583 <section id="OverDriveClientKey">
6584 <title>OverDriveClientKey and OverDriveClientSecret</title>
6585 <para>Asks: Include OverDrive availability information with the client key __ and client
6587 <para>Description:<itemizedlist>
6589 <para>OverDrive customers can get this information by visiting the <ulink
6590 url="https://developer.overdrive.com/docs/getting-started">OverDrive Developer
6591 Portal</ulink> and following the instructions found there to apply as an API
6592 developer. Once this data and the <link linkend="OverDriveLibraryID"
6593 >OverDriveLibraryID</link> are populated you will see OverDrive results on
6594 your OPAC searches.</para>
6596 </itemizedlist></para>
6598 <section id="OverDriveLibraryID">
6599 <title>OverDriveLibraryID</title>
6600 <para>Asks: Show items from the OverDrive catalog of library # ___</para>
6601 <para>Description:<itemizedlist>
6603 <para>OverDrive customers can get this information by visiting the <ulink
6604 url="https://developer.overdrive.com/docs/getting-started">OverDrive Developer
6605 Portal</ulink> and following the instructions found there to apply as an API
6606 developer. Once this data and the <link linkend="OverDriveClientKey"
6607 >OverDriveClientKey and OverDriveClientSecret</link> are populated you will
6608 see OverDrive results on your OPAC searches.</para>
6610 </itemizedlist></para>
6613 <section id="pluginprefs">
6614 <title>Plugins</title>
6615 <section id="UseKohaPlugins">
6616 <title>UseKohaPlugins</title>
6617 <para>Default: Don't enable</para>
6618 <para>Asks: ___ the ability to use Koha Plugins.</para>
6619 <para>Values:<itemizedlist>
6621 <para>Don't enable</para>
6626 </itemizedlist></para>
6628 <para>The plugin system must also be enabled in the Koha configuration file to be
6629 fully enabled. Learn more in the <link linkend="pluginsystem">Plugins
6630 chapter</link>.</para>
6635 <section id="Syndeticsprefs">
6636 <title>Syndetics</title>
6638 <para>Syndetics is a pay service. You must first contact Syndetics
6639 directly for pricing and subscription information.</para>
6641 <section id="SyndeticsEnabled">
6642 <title>SyndeticsEnabled</title>
6644 <para>Default: Don't use</para>
6646 <para>Asks: ___ content from Syndetics.</para>
6648 <para>Values:</para>
6652 <para>Don't use</para>
6660 <para>Description:</para>
6664 <para>When this option is enabled any of the Syndetics options
6670 <para>Requires that you enter your <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> before
6671 this content will appear.</para>
6675 <section id="SyndeticsClientCode">
6676 <title>SyndeticsClientCode</title>
6678 <para>Asks: Use the client code ___ to access Syndetics.</para>
6680 <para>Description:</para>
6684 <para>Once the library signs up for Syndetics' services,
6685 Syndetics will provide the library with an access code. (Visit
6686 the Syndetics homepage at <ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>
6687 for more information.) This is the code that must be entered
6688 to access Syndetics' subscription services. Syndetics is a
6689 paid subscription service. This value must be entered before
6690 <link linkend="SyndeticsEditions">SyndeticsEditions</link> can
6691 be enabled. If the code is lost, corrupted, or forgotten, a
6692 new one can be obtained from <ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>.</para>
6697 <para>You will need to get your client code directly from
6702 <section id="SyndeticsCoverImages">
6703 <title>SyndeticsCoverImages & SyndeticsCoverImageSize</title>
6705 <para>SyndeticsCoverImages Default: Don't show</para>
6707 <para>SyndeticsCoverImageSize Default: medium</para>
6709 <para>Asks: ___ cover images from Syndetics on search results and
6710 item detail pages on the OPAC in a ___ size.</para>
6712 <para>Descriptions:</para>
6716 <para>When enabled, SyndeticsCoverImages, allows libraries to
6717 display Syndetics' collection of full-color cover images for
6718 books, videos, DVDs and CDs on their OPAC. For each book or
6719 item that comes up during a user search, the cover image for
6720 that title will be displayed. Since these cover images come in
6721 three sizes, the optimum size must be selected using the
6722 SyndeticsCoverImageSize preference after SyndeticsCoverImages
6723 are enabled. Syndetics cover images come in two sizes:
6724 mid-size (187 x 187 pixels), and large (400 x 400 pixels).
6725 Syndetics is a paid subscription service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6726 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6727 be activated before this service can be used. Other cover
6728 image preferences should also be disabled to avoid
6729 interference.</para>
6733 <para>SyndeticsCoverImages Values:</para>
6737 <para>Don't show</para>
6745 <para>SyndeticsCoverImageSize Values:</para>
6758 <section id="SyndeticsAuthorNotes">
6759 <title>SyndeticsAuthorNotes</title>
6761 <para>Default: Don't show</para>
6763 <para>Asks: ___ notes about the author of a title from Syndetics
6764 on item detail pages on the OPAC.</para>
6766 <para>Values:</para>
6770 <para>Don't show</para>
6778 <para>Description:</para>
6782 <para>When this option is set to "Show", Syndetics provides
6783 notes and short author biographies for more that 300,000
6784 authors, in both fiction and nonfiction. With this option
6785 enabled the library can display Syndetics Author Notes on the
6786 OPAC. According to the Syndetics Solutions website (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>),
6787 Author Notes include lists of contributors for many
6788 multi-author texts and compilations. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6789 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6790 be activated before this service can be used.</para>
6795 <section id="SyndeticsAwards">
6796 <title>SyndeticsAwards</title>
6798 <para>Default: Don't show</para>
6800 <para>Asks: ___ information from Syndetics about the awards a
6801 title has won on item detail pages on the OPAC.</para>
6803 <para>Values:</para>
6807 <para>Don't show</para>
6815 <para>Description:</para>
6819 <para>When this option is set to "Show", Syndetics provides
6820 its clients with a list of awards that any title has won. With
6821 this service enabled the library can display those awards for
6822 each book on its website. For each book or item that comes up
6823 during a user search, the list of awards for that title will
6824 be displayed. When a user clicks on a given award, information
6825 about that award is presented along with a list of the other
6826 titles that have won that award. If the user clicks on any
6827 title in the list, they will see holdings information about
6828 that title in their region. This option is a paid subscription
6829 service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6830 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6831 be activated before this service can be used.</para>
6836 <section id="SyndeticsEditions">
6837 <title>SyndeticsEditions</title>
6839 <para>Default: Don't show</para>
6841 <para>Asks: ___ information about other editions of a title from
6842 Syndetics on item detail pages on the OPAC</para>
6844 <para>Description:</para>
6848 <para>When enabled this option shows information on other
6849 editions of a title from Syndetics on the item detail pages of
6850 the OPAC. Syndetics is a paid subscription service. The <link linkend="SyndeticsClientCode">SyndeticsClientCode</link> must
6851 be entered and the <link linkend="SyndeticsEnabled">SyndeticsEnabled</link> option must
6852 be activated before this service can be used.</para>
6856 <para>Values:</para>
6860 <para>Don't show</para>
6869 <para>Requires <link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> set to
6874 <section id="SyndeticsExcerpt">
6875 <title>SyndeticsExcerpt</title>
6877 <para>Default: Don't show</para>
6879 <para>Asks: ___ excerpts from of a title from Syndetics on item
6880 detail pages on the OPAC.</para>
6882 <para>Values:</para>
6886 <para>Don't show</para>
6894 <para>Description:</para>
6898 <para>This preference allows Syndetics to display excerpts
6899 given to them from selected publishers. The excerpts are
6900 available from prominently reviewed new titles, both fiction
6901 and non-fiction. The excerpts include poems, essays, recipes,
6902 forwards and prefaces. Automatic links provided by the ISBNs
6903 within local MARC records are required to integrate Syndetics
6904 secured, high-speed Internet servers to the library OPACs. For
6905 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6910 <section id="SyndeticsReviews">
6911 <title>SyndeticsReviews</title>
6913 <para>Default: Don't show</para>
6915 <para>Asks: ___ reviews of a title from Syndetics on item detail
6916 pages on the OPAC.</para>
6918 <para>Values:</para>
6922 <para>Don't show</para>
6930 <para>Description:</para>
6934 <para>Syndetics Reviews is an accumulation of book reviews
6935 available from a variety of journals and serials. The reviews
6936 page displays colored images of reviewed books dust jackets,
6937 partnered with the names of the journal or serial providing
6938 the review. Clicking on an icon opens a window revealing the
6939 book title, author's name, book cover icon and the critic's
6940 opinion of the book. Automatic links provided by the ISBNs
6941 within local MARC records are required to integrate Syndetics
6942 secured, high-speed Internet servers to the library OPACs. For
6943 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6948 <section id="SyndeticsSeries">
6949 <title>SyndeticsSeries</title>
6951 <para>Default: Don't show</para>
6953 <para>Asks: ___ information on other books in a title's series
6954 from Syndetics on item detail pages on the OPAC.</para>
6956 <para>Values:</para>
6960 <para>Don't show</para>
6968 <para>Description:</para>
6972 <para>Each fiction title within a series is linked to the
6973 complete series record. The record displays each title in
6974 reading order and also displays the publication order, if
6975 different. Alternate series titles are also displayed.
6976 Automatic links provided by the ISBNs within local MARC
6977 records are required to integrate Syndetics secured, high-
6978 speed Internet servers to the library OPACs. For more
6979 information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
6984 <section id="SyndeticsSummary">
6985 <title>SyndeticsSummary</title>
6987 <para>Default: Don't show</para>
6989 <para>Asks: ___ a summary of a title from Syndetics on item detail
6990 pages on the OPAC.</para>
6992 <para>Values:</para>
6996 <para>Don't show</para>
7004 <para>Description:</para>
7008 <para>Providing more than 5.6 million summaries and
7009 annotations derived from book jackets, edited publisher copy,
7010 or independently written annotations from Book News, Inc.
7011 Covering fiction and non-fiction, this summaries option
7012 provides annotations on both trade and scholarly titles. For
7013 more information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7018 <section id="SyndeticsTOC">
7019 <title>SyndeticsTOC</title>
7021 <para>Default: Don't show</para>
7023 <para>Asks: ___ the table of contents of a title from Syndetics on
7024 item detail pages on the OPAC.</para>
7026 <para>Values:</para>
7030 <para>Don't show</para>
7038 <para>Description:</para>
7042 <para>This preference allows staff and patrons to review the
7043 Table of Contents from a wide variety of publications from
7044 popular self-help books to conference proceedings. Specific
7045 Information access is the main purpose for this option,
7046 allowing patrons guidance to their preferred section of the
7047 book. Special arrangements with selected book services is used
7048 to obtain the table of contents for new publications each
7049 year. Automatic links provided by the ISBNs within local MARC
7050 records are required to integrate Syndetics secured,
7051 high-speed Internet servers to the library OPACs. For more
7052 information see (<ulink url="http://www.bowker.com/syndetics/">http://www.bowker.com/syndetics/</ulink>).</para>
7058 <section id="taggingprefs">
7059 <title>Tagging</title>
7061 <section id="TagsEnabled">
7062 <title>TagsEnabled</title>
7064 <para>Default: Allow</para>
7066 <para>Asks: ___ patrons and staff to put tags on items.</para>
7068 <para>Values:</para>
7076 <para>Don't allow</para>
7080 <para>Description:</para>
7084 <para>Set to 'Allow' enable tagging. A tag is metadata, a word
7085 added to identify an item. Tags allow patrons to classify
7086 materials on their own. TagsEnabled is the main switch that
7087 permits the tagging features. TagsEnable must be set to
7088 'Allow' to allow for other tagging features.</para>
7093 <section id="TagsModeration">
7094 <title>TagsModeration</title>
7096 <para>Default: Don't require</para>
7098 <para>Asks: ___ that tags submitted by patrons be reviewed by a
7099 staff member before being shown.</para>
7101 <para>Values:</para>
7105 <para>Don't require</para>
7109 <para>Require</para>
7113 <para>Description:</para>
7117 <para>When set to 'Require,' all tags to be first filtered by
7118 the tag moderator. Only approved tags will be visible to
7119 patrons. When set to 'Don't require' tags will bypass the tag
7120 moderator and patrons' tags to be immediately visible. When
7121 this preference is enabled the moderator, a staff member,
7122 would approve the tag in the Staff Client. The moderator will
7123 have the option to approve or reject each pending tag
7128 <para>When moderation is required all tags go through the tag
7129 moderation tool before becoming visible.</para>
7133 <para><emphasis>Get there:</emphasis> More > Tools >
7134 <link linkend="tagsmoderation">Tags</link></para>
7139 <section id="TagsShowOnList">
7140 <title>TagsShowOnList</title>
7142 <para>Default: 6</para>
7144 <para>Asks: Show ___ tags on search results on the OPAC.</para>
7147 <para>Set the value to 0 (zero) to turn this feature off.</para>
7151 <section id="TagsInputOnList">
7152 <title>TagsInputOnList</title>
7154 <para>Default: Allow</para>
7156 <para>Asks: ___ patrons to input tags on search results on the
7159 <para>Values:</para>
7166 <screeninfo>Tags on Search Results</screeninfo>
7170 <imagedata fileref="images/admin/globalprefs/TagsInputOnList.png"/>
7177 <para>Don't allow</para>
7182 <section id="TagsShowOnDetail">
7183 <title>TagsShowOnDetail</title>
7185 <para>Default: 10</para>
7187 <para>Asks: Show ___ tags on item detail pages on the OPAC.</para>
7190 <para>Set the value to 0 (zero) to turn this feature off.</para>
7194 <section id="TagsInputOnDetail">
7195 <title>TagsInputOnDetail</title>
7197 <para>Default: Allow</para>
7199 <para>Asks: ___ patrons to input tags on item detail pages on the
7202 <para>Values:</para>
7209 <screeninfo>Add Tags on Detail</screeninfo>
7213 <imagedata fileref="images/admin/globalprefs/TagsInputOnDetail.png"/>
7220 <para>Don't allow</para>
7225 <section id="TagsExternalDictionary">
7226 <title>TagsExternalDictionary</title>
7228 <para>Asks: Allow tags in the dictionary of the ispell executable
7229 ___ on the server to be approved without moderation.</para>
7231 <para>Description:</para>
7235 <para>The dictionary includes a list of accepted and rejected
7236 tags. The accepted list includes all the tags that have been
7237 pre-allowed. The rejected list includes tags that are not
7238 allowed. This preference identifies the "accepted" dictionary
7239 used. Ispell is an open source dictionary which can be used as
7240 a list of accepted terms. Since the dictionary allows for
7241 accurately spelled obscenities, the libraries policy may
7242 dictate that modifications are made to the Ispell dictionary
7243 if this preference is use. For more information about Ispell
7244 <ulink url="http://www.gnu.org/software/ispell/ispell.html">http://www.gnu.org/software/ispell/ispell.html</ulink>.
7245 Enter the path on your server to a local ispell executable,
7246 used to set $Lingua::Ispell::path.</para>
7253 <section id="l18nprefs">
7254 <title>I18N/L10N</title>
7256 <para><emphasis> <emphasis>These preferences control your
7257 Internationalization and Localization settings.</emphasis>
7260 <para><emphasis>Get there:</emphasis> More > Administration >
7261 Global System Preferences > I18N/L10N</para>
7262 <section id="alphabet">
7263 <title>alphabet</title>
7264 <para>Default: A B C D E F G H I J K L M N O P Q R S T U V W X Y Z</para>
7265 <para>Asks: Use the alphabet ___ for lists of browsable letters. This should be a space
7266 separated list of uppercase letters. </para>
7267 <para>Description:</para>
7270 <para>This preference allows you define your own alphabet for browsing patrons in Koha.</para>
7272 <screeninfo>Alphabet browse on patron module</screeninfo>
7275 <imagedata fileref="images/admin/globalprefs/alphabet.png"/>
7283 <section id="CalendarFirstDayOfWeek">
7284 <title>CalendarFirstDayOfWeek</title>
7286 <para>Default: Sunday</para>
7288 <para>Asks: Use ___ as the first day of week in the calendar.</para>
7290 <para>Values:</para>
7302 <para>Description:</para>
7306 <para>Using this preference you can control what day shows as
7307 the first day of the week in the calendar pop ups throughout
7308 Koha and on the Calendar tool. If you change this preference and
7309 don't see a change in your browser try clearing your cache since
7310 it makes changes to the Javascript on these pages.</para>
7315 <section id="dateformat">
7316 <title>dateformat</title>
7318 <para>Default: mm/dd/yyyy</para>
7320 <para>Asks: Format dates like ___</para>
7322 <para>Values:</para>
7326 <para>dd/mm/yyyy</para>
7330 <para>mm/dd/yyyy</para>
7334 <para>yyyy/mm/dd</para>
7338 <para>Description:</para>
7342 <para>This preference controls how the date is displayed. The
7343 options are the United States method, mm/dd/yyyy (04/24/2010),
7344 the metric method, dd/mm/yyyy (24/04/2010) or ISO, which is the
7345 International Standard of Organization, yyyy/mm/dd (2010/04/24).
7346 The International Standard of Organization would primarily be
7347 used by libraries with locations in multiple nations that may
7348 use different date formats, to have a single display type, or if
7349 the library would be in a region that does not use the United
7350 States or metric method. More information regarding the ISO date
7351 format can be found at <ulink url="http://www.iso.org/iso/iso_catalogue.htm">http://www.iso.org/iso/iso_catalogue.htm</ulink>.</para>
7356 <section id="languagepref">
7357 <title>language</title>
7359 <para>Default: English</para>
7361 <para>Asks: Enable the following languages on the staff
7364 <para>Values:</para>
7368 <para>English</para>
7372 <para>To install additional languages you need to run
7373 misc/translation/install-code.pl. For example, to install French you
7374 would run the following command <emphasis>install-code.pl
7375 fr-FR</emphasis> to make the templates, once they exist and are in
7376 the right place then they will show up as an option in this
7380 <section id="opaclanguages">
7381 <title>opaclanguages</title>
7383 <para>Default: English</para>
7385 <para>Asks: Enable the following languages on the OPAC</para>
7387 <para>Values:</para>
7391 <para>English</para>
7395 <para>To install additional languages you need to run
7396 misc/translation/install-code.pl. For example, to install French you
7397 would run the following command <emphasis>install-code.pl
7398 fr-FR</emphasis> to make the templates, once they exist and are in
7399 the right place then they will show up as an option in this
7403 <section id="opaclanguagesdisplay">
7404 <title>opaclanguagesdisplay</title>
7406 <para>Default: Don't allow</para>
7408 <para>Asks: ___ patrons to select their language on the OPAC.</para>
7410 <para>Values:</para>
7417 <screeninfo>When this preference is on, patrons can choose
7418 their language from a list at the bottom of the
7423 <imagedata fileref="images/admin/globalprefs/opaclanguagesdisplay.png"/>
7430 <para>Don't allow</para>
7434 <section id="TimeFormat">
7435 <title>TimeFormat</title>
7436 <para>Default: 24 hour format</para>
7437 <para>Asks: Format times in ___ </para>
7438 <para>Values:<itemizedlist>
7440 <para>12 hour format (eg 02:18PM)</para>
7443 <para>24 hour format (eg 14:18)</para>
7445 </itemizedlist></para>
7449 <section id="localprefs">
7450 <title>Local Use</title>
7452 <para><emphasis> <emphasis>These preferences are defined
7453 locally.</emphasis> </emphasis></para>
7455 <para><emphasis>Get there:</emphasis> More > Administration >
7456 Global System Preferences > Local Use<tip>
7457 <para>Sometimes preferences which are either new or outdated will
7458 appear in this tab, if you didn't add any preferences to this tab
7459 then it's best to ignore preferences listed here.</para>
7466 <para>Logs keep track of transaction on the system. You can decide
7467 which actions you want to log and which you don't using these
7470 <para><emphasis>Get there:</emphasis> More > Administration >
7471 Global System Preferences > Logs</para>
7473 <section id="AuthoritiesLog">
7474 <title>AuthoritiesLog</title>
7476 <para>Default: Don't log</para>
7478 <para>Asks: ___ changes to authority records.</para>
7480 <para>Values:</para>
7484 <para>Don't log</para>
7493 <section id="BorrowersLog">
7494 <title>BorrowersLog</title>
7496 <para>Default: Log</para>
7498 <para>Asks: ___ changes to patron records.</para>
7500 <para>Values:</para>
7504 <para>Don't log</para>
7513 <section id="CataloguingLog">
7514 <title>CataloguingLog</title>
7516 <para>Default: Don't log</para>
7518 <para>Asks: ___ any changes to bibliographic or item records.</para>
7520 <para>Values:</para>
7524 <para>Don't log</para>
7533 <para>Since this occurs whenever a book is cataloged, edited, or
7534 checked in or out it can be very resource intensive - slowing down
7539 <section id="FinesLog">
7540 <title>FinesLog</title>
7542 <para>Default: Log</para>
7544 <para>Asks: ___ when overdue fines are charged or automatically
7547 <para>Values:</para>
7551 <para>Don't log</para>
7560 <section id="IssueLog">
7561 <title>IssueLog</title>
7563 <para>Default: Log</para>
7565 <para>Asks: ___ when items are checked out.</para>
7567 <para>Values:</para>
7571 <para>Don't log</para>
7580 <section id="LetterLog">
7581 <title>LetterLog</title>
7583 <para>Default: Log</para>
7585 <para>Asks: ___ when an automatic claim notice is sent.</para>
7587 <para>Values:</para>
7591 <para>Don't log</para>
7600 <para>This log tracks all notices that go to patrons including the
7601 overdue notices.</para>
7605 <section id="ReturnLog">
7606 <title>ReturnLog</title>
7608 <para>Default: Log</para>
7610 <para>Asks: ___ when items are returned.</para>
7612 <para>Values:</para>
7616 <para>Don't log</para>
7625 <section id="SubscriptionLog">
7626 <title>SubscriptionLog</title>
7628 <para>Default: Log</para>
7630 <para>Asks: ___ when serials are added, deleted or changed.</para>
7632 <para>Values:</para>
7636 <para>Don't log</para>
7646 <section id="opacprefs">
7649 <para><emphasis>Get there:</emphasis> More > Administration >
7650 Global System Preferences > OPAC</para>
7652 <section id="opacappearanceprefs">
7653 <title>Appearance</title>
7655 <para>These preferences control how things appear in the
7658 <section id="AuthorisedValueImages">
7659 <title>AuthorisedValueImages</title>
7661 <para>Default: Don't show</para>
7663 <para>Asks: ___ images for authorized values (such as lost
7664 statuses and locations) in search results and item detail pages on
7667 <para>Values:</para>
7671 <para>Don't show</para>
7679 <para><emphasis>Get there:</emphasis> More > Administration
7680 > <link linkend="authorizedvalues">Authorized
7681 Values</link></para>
7684 <section id="BiblioDefaultView">
7685 <title>BiblioDefaultView</title>
7687 <para>Default: in simple form</para>
7689 <para>Asks: By default, show bib records ___</para>
7691 <para>Values:</para>
7695 <para>as specified in the ISBD template.</para>
7699 <para>See <link linkend="isbdpref">ISBD</link> preference
7700 for more information</para>
7706 <para>in simple form.</para>
7710 <para>in their MARC format.</para>
7714 <para>Description:</para>
7718 <para>This preference determines the level of bibliographic
7719 detail that the patron will see on the OPAC detail page. The
7720 simple form displays the graphical interface; MARC format
7721 displays the MARC21 cataloging view; ISBD displays the ISBD
7722 (International Standard Bibliographic Description, AACR2)
7728 <section id="COinSinOPACResults">
7729 <title>COinSinOPACResults</title>
7731 <para>Default: Include</para>
7733 <para>Asks: ___ COinS / OpenURL / Z39.88 in OPAC search
7736 <para>Values:</para>
7740 <para>Don't include</para>
7744 <para>If you choose not to include COinS on the search
7745 results, it will still be loaded on the individual
7746 bibliographic records.</para>
7752 <para>Include</para>
7756 <para>Enabling this feature will slow OPAC search response
7763 <para>Description:</para>
7767 <para>COinS stands for ContextObjects in Spans. COinS is a
7768 method to embed bibliographic metadata in the HTML code of web
7769 pages. This allows bibliographic software to publish
7770 machine-readable bibliographic items and client reference
7771 management software (such as Zotero) to retrieve bibliographic
7772 metadata. The metadata can also be sent to an OpenURL
7773 resolver. This allows, for instance, searching for a copy of a
7774 book in one's own library.</para>
7779 <section id="DisplayOPACiconsXSLT">
7780 <title>DisplayOPACiconsXSLT</title>
7782 <para>Default: Don't show</para>
7784 <para>Asks: On pages displayed with XSLT stylesheets on the OPAC,
7785 ___ icons for itemtype and authorized values.<important>
7786 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>
7787 and/or <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
7788 must be set to use an XSLT stylesheet for this to show
7789 (default or custom)</para>
7792 <para>Values:</para>
7796 <para>Don't show</para>
7803 <screeninfo>DisplayOPACiconsXSLT</screeninfo>
7807 <imagedata fileref="images/admin/globalprefs/DisplayOPACiconsXSLT.png"/>
7815 <para>See the <link linkend="XSLTiTypes">XSLT Icon
7816 Guide</link> for more information on these icons.</para>
7820 <section id="hidelostitems">
7821 <title>hidelostitems</title>
7823 <para>Default: Don't show</para>
7825 <para>Asks: ___ lost items on search and detail pages.</para>
7827 <para>Description:</para>
7831 <para>Items that are marked lost by the library can either be
7832 shown or not shown on the OPAC. By setting the value to "Don't
7833 show," the lost item is not shown on the OPAC. By setting the
7834 value "Show," the lost item is shown on the OPAC for patrons
7835 to view with a status of 'lost.'</para>
7839 <para>Values:</para>
7843 <para>Don't show</para>
7850 <screeninfo>Lost item showing in the OPAC</screeninfo>
7854 <imagedata fileref="images/admin/globalprefs/hidelostitems.png"/>
7861 <section id="HighlightOwnItemsOnOPAC">
7862 <title>HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich</title>
7863 <para>HighlightOwnItemsOnOPAC Default: Don't emphasize</para>
7864 <para>HighlightOwnItemsOnOPACWhich Default: patron's home library </para>
7865 <para>Asks: ___ results from the ___ by moving the results to the front and increasing
7866 the size or highlighting the rows for those results. </para>
7867 <para>HighlightOwnItemsOnOPAC Values:<itemizedlist>
7869 <para>Don't emphasize</para>
7872 <para>Emphasize</para>
7874 </itemizedlist></para>
7875 <para>HighlightOwnItemsOnOPACWhich Values:<itemizedlist>
7877 <para>OPAC's branch based via the URL<itemizedlist>
7879 <para>The library is chosen based on the Apache environment variable
7880 BRANCHCODE. For example, this could be added to the OPAC section of
7881 koha-httpd.conf: SetEnv BRANCHCODE "CPL"</para>
7883 </itemizedlist></para>
7886 <para>patron's home library<itemizedlist>
7888 <para>The items emphasized will be those of the same library as the patron's
7889 library. If no one is logged into the OPAC, no items will be
7892 </itemizedlist></para>
7894 </itemizedlist></para>
7896 <para>This preference will only effect sites that are not using an XSLT stylesheet.
7897 XSLT stylesheets are defined in the <link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> and <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> preferences.</para>
7901 <section id="LibraryName">
7902 <title>LibraryName</title>
7904 <para>Asks: Show ___ as the name of the library on the
7908 <para>This value will appear in the title bar of the
7913 <para>Edit '<link linkend="opacheader">opacheader</link>' if
7914 you'd like to add a library name above your search box on the
7919 <screeninfo>Browser title and address bar</screeninfo>
7923 <imagedata fileref="images/admin/globalprefs/LibraryName.png"/>
7929 <section id="OpacAddMastheadLibraryPulldown">
7930 <title>OpacAddMastheadLibraryPulldown</title>
7932 <para>Default: Don't add</para>
7934 <para>Asks: ___ a library select pulldown menu on the OPAC
7937 <para>Values:</para>
7944 <screeninfo>Library select box on Koha OPAC</screeninfo>
7948 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-add.png"/>
7955 <para>Don't Add</para>
7958 <screeninfo>No library select box on Koha OPAC</screeninfo>
7962 <imagedata fileref="images/admin/globalprefs/OpacAddMastheadLibraryPulldown-dontadd.png"/>
7970 <section id="OPACBaseURL">
7971 <title>OPACBaseURL</title>
7973 <para>Asks: The OPAC is located at http:// ___</para>
7974 <para>Description:<itemizedlist>
7976 <para>This preference is looking for the URL of your public catalog (OPAC) without
7977 the http:// in front of it (enter www.mycatalog.com instead of
7978 http://www.mycatalog.com). Once it is filled in Koha will use it to generate
7979 permanent links in your RSS feeds, for your social network share buttons and in
7980 your staff client when generating links to bib records in the OPAC.</para>
7982 </itemizedlist></para>
7984 <para>Do not include a trailing slash in the URL this will break links created using
7985 this URL. (example: www.google.com not www.google.com/)</para>
7989 <para>This must be filled in with the URL of your public catalog for RSS, unAPI, and
7990 search plugins to work.</para>
7994 <para>This must be filled in with the URL of your public catalog to show 'OPAC View'
7995 links from bib records in the staff client:</para>
7999 <screeninfo>With OPACBaseURL set, links to the OPAC will appear
8000 on each individual bib record in the staff client</screeninfo>
8004 <imagedata fileref="images/admin/globalprefs/OPACBaseURL.png"/>
8010 <section id="opaccolorstylesheet">
8011 <title>opaccolorstylesheet</title>
8013 <para>Asks: Include the additional CSS stylesheet ___ to override
8014 specified settings from the default stylesheet.</para>
8016 <para>Description:</para>
8020 <para>The preference can look for stylesheets in the template
8021 directory for your OPAC language, for instance:
8022 /koha-tmpl/opac-tmpl/prog/en/css. If you upload a custom file,
8023 opac-mystyles.css to this directory, you can specify it by
8024 entering opac-mystyles.css in your opaccolorstylesheet system
8025 preference. This adds your custom stylesheet as a linked
8026 stylesheet alongside the OPAC's default CSS files. This method
8027 is preferable because linked stylesheets are cached by the
8028 user's browser, meaning upon repeat visits to your site the
8029 user's browser will not have to re-download the stylesheet,
8030 instead using the copy in the browser's cache.</para>
8034 <para>If you would rather, you can upload your CSS to another
8035 server and enter the full URL pointing to it's location
8036 remember to begin the URL with http://</para>
8041 <para>Leave this field blank to disable it</para>
8045 <para>This file will add a linked CSS, not replace the
8046 existing default CSS.</para>
8049 <para>If using the <link linkend="opacthemes">CCSR theme</link>, this preference must
8050 be set to color.css and any user generated CSS must be appended to the default
8051 color.css file.</para>
8055 <section id="opaccredits">
8056 <title>opaccredits</title>
8058 <para>Asks: Include the following HTML in the footer of all pages
8062 <para>Click the 'Click to edit; link to enter HTML to appear at
8063 the bottom of every page in the OPAC</para>
8067 <screeninfo>HTML version of a footer for your OPAC</screeninfo>
8071 <imagedata fileref="images/admin/globalprefs/opaccredits-html.png"/>
8077 <screeninfo>A sample of what can appear in your OPAC
8078 credits/footer</screeninfo>
8082 <imagedata fileref="images/admin/globalprefs/opaccredits.png"/>
8087 <para>Description:</para>
8091 <para>This setting is for credits that will appear at the
8092 bottom of your OPAC pages. Credits traditionally encompass
8093 copyright information, last date updated, hyperlinks or other
8094 information represented in an HTML format. This is static
8095 information and any updates must be entered manually.</para>
8099 <para>Learn more in the <link linkend="editableopac">OPAC Editable
8100 Regions</link> section.</para>
8103 <section id="OPACDisplay856uAsImage">
8104 <title>OPACDisplay856uAsImage</title>
8106 <para>Default: Neither details or results page</para>
8108 <para>Asks: Display the URI in the 856u field as an image on:
8111 <para>Values:</para>
8115 <para>Both results and details pages</para>
8120 <para>Not implemented yet</para>
8127 <para>Detail page only</para>
8132 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
8133 needs to have a value in it for this preference to work.</para>
8139 <screeninfo>Showing the 856u as an image</screeninfo>
8143 <imagedata fileref="images/admin/globalprefs/OPACDisplay856uAsImage.png"/>
8150 <para>Neither details or results page</para>
8154 <para>Results page only</para>
8159 <para>Not yet implemented</para>
8166 <para>Description:</para>
8170 <para>In addition to this option being set, the corresponding
8171 XSLT option must be turned on. Also, the corresponding 856q
8172 field must have a valid MIME image extension (e.g., "jpg") or
8173 MIME image type (i.e. starting with "image/"), or the generic
8174 indicator "img" entered in the field. When all of the
8175 requirements are met, an image file will be displayed instead
8176 of the standard link text. Clicking on the image will open it
8177 in the same way as clicking on the link text. When you click
8178 on the image it should open to full size, in the current
8179 window or in a new window depending on the value in the system
8180 pref <link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
8183 <screeninfo>Sample 856 in MARC Record</screeninfo>
8187 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
8195 <section id="OpacExportOptions">
8196 <title>OpacExportOptions</title>
8199 bibtex|dc|marcxml|marc8|utf8|marcstd|mods|ris</para>
8201 <para>Asks: List export options that should be available from OPAC
8202 detail page separated by |: ___</para>
8204 <para>Description:</para>
8208 <para>In the OPAC on the right of each bib record there is a
8209 menu that allows for saving the record in various formats.
8210 This patch will allow you to define which options are in the
8211 pull down menu. Available options are: BIBTEX (bibtex), Dublin
8212 Core (dc), MARCXML (marcxml), MARC-8 encoded MARC (marc8),
8213 Unicode/UTF-8 encoded MARC (utf8), Unicode/UTF-8 encoded MARC
8214 without local use -9xx, x9x, xx9- fields and subfields
8215 (marcstd), MODS (mods), and RIS (ris).</para>
8220 <section id="OpacFavicon">
8221 <title>OpacFavicon</title>
8223 <para>Asks: Use the image at ___ for the OPAC's favicon.
8225 <para>This should be a complete URL, starting with
8230 <para>Turn your logo into a favicon with the <ulink url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
8233 <para>Description:</para>
8237 <para>The favicon is the little icon that appears next to the
8238 URL in the address bar in most browsers. The default value for
8239 this field (if left blank) is the small 'K' in the Koha
8243 <screeninfo>Default Koha Favicon</screeninfo>
8247 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
8255 <section id="opacheader">
8256 <title>opacheader</title>
8258 <para>Asks: Include the following HTML in the header of all pages
8262 <screeninfo>Sample HTML to be displayed at the top of my
8267 <imagedata fileref="images/admin/globalprefs/opacheader-html.png"/>
8273 <para>This value will appear above the main content of your
8278 <screeninfo>OPAC display of the value from
8279 'opacheader'</screeninfo>
8283 <imagedata fileref="images/admin/globalprefs/opacheader.png"/>
8289 <para>Edit '<link linkend="LibraryName">LibraryName</link>' if
8290 you'd like to edit the contents of the <title> tag</para>
8293 <para>Learn more in the <link linkend="editableopac">OPAC Editable
8294 Regions</link> section.</para>
8297 <section id="OpacHighlightedWords">
8298 <title>OpacHighlightedWords</title>
8300 <para>Default: Don't highlight</para>
8302 <para>Asks: ___ words the patron searched for in their search
8305 <para>Values:</para>
8309 <para>Don't highlight</para>
8313 <para>Highlight</para>
8318 <section id="OpacKohaUrl">
8319 <title>OpacKohaUrl</title>
8321 <para>Default: Don't show</para>
8323 <para>Values:</para>
8327 <para>Don't show</para>
8335 <para>Description:</para>
8339 <para>When this preference is set to 'Show' text will appear
8340 in the bottom right of the OPAC footer stating 'Powered by
8341 Koha' and linking to the official Koha website.</para>
8344 <screeninfo>Powered by Koha</screeninfo>
8348 <imagedata fileref="images/admin/globalprefs/OpacKohaUrl.png"/>
8356 <section id="opaclayoutstylesheet">
8357 <title>opaclayoutstylesheet</title>
8359 <para>Default: opac.css</para>
8361 <para>Asks: Use the CSS stylesheet /css/ ___ on all pages in the
8362 OPAC, instead of the default</para>
8364 <para>Description:</para>
8368 <para>This setting's function is to point to the *.css file
8369 used to define the OPAC layout. A *.css file is a cascading
8370 stylesheet which is used in conjunction with HTML to set how
8371 the HTML page is formatted and will look on the OPAC. There
8372 are two stylesheets that come with the system; opac.css and
8373 opac2.css. A custom stylesheet may also be used. The
8374 stylesheets listed in the opaclayoutstylesheet preference are
8375 held on the Koha server.</para>
8380 <para>Leave this field blank to disable it and let Koha use the
8381 default file instead</para>
8384 <para>Using a custom value in this preference causes Koha to completely ignore the
8385 default layout stylesheet.</para>
8389 <section id="OpacMaintenance">
8390 <title>OpacMaintenance</title>
8392 <para>Default: Don't show</para>
8394 <para>Asks: ___ a warning that the OPAC is under maintenance,
8395 instead of the OPAC itself. <note>
8396 <para>this shows the same warning as when the database needs
8397 to be upgraded, but unconditionally.</para>
8400 <para>Description:</para>
8404 <para>This preference allows the system administrator to turn
8405 off the OPAC during maintenance and display a message to
8406 users. When this preference is switched to "Show" the OPAC is
8407 not usable. The text of this message is not editable at this
8412 <para>Values:</para>
8416 <para>Don't show</para>
8424 <para>When this preference is set to show the maintenance
8425 message the ability to search the OPAC is disabled and a
8426 message appears</para>
8429 <screeninfo>OPAC Maintenance Message</screeninfo>
8433 <imagedata fileref="images/admin/globalprefs/opacmaintenance.png"/>
8443 <section id="OpacMainUserBlock">
8444 <title>OpacMainUserBlock</title>
8446 <para>Default: Welcome to Koha... <hr></para>
8448 <para>Asks: Show the following HTML in its own column on the main
8449 page of the OPAC</para>
8451 <para>Description: </para>
8454 <para>HTML entered in this field will appear in the center of the main page of your
8460 <screeninfo>Sample OpacMainUserBlock appears below the search
8465 <imagedata fileref="images/admin/globalprefs/OpacMainUserBlock.png"/>
8470 <para>Learn more in the <link linkend="editableopac">OPAC Editable
8471 Regions</link> section.</para>
8473 <section id="OpacMainUserBlockMobile">
8474 <title>OpacMainUserBlockMobile</title>
8475 <para>Asks: Show the following HTML in its own column on the main page of the OPAC
8476 (mobile version)</para>
8477 <para>Description:</para>
8480 <para>This content will display below the search boxes when viewing the OPAC on a
8481 mobile device as long as the <link linkend="opacthemes">theme</link> you're using
8482 has a mobile version.</para>
8486 <para>This preference is only used with the CCSR theme.</para>
8489 <section id="OPACMobileUserCSS">
8490 <title>OPACMobileUserCSS</title>
8491 <para>Asks: Include the following CSS for the mobile view on all pages in the
8493 <para>Description:<itemizedlist>
8495 <para>This CSS will be used when your OPAC is viewed on a mobile device as long as
8496 the <link linkend="opacthemes">theme</link> you're using has a mobile
8499 </itemizedlist></para>
8501 <para>This preference is only used with the CCSR theme.</para>
8505 <section id="OPACMySummaryHTML">
8506 <title>OPACMySummaryHTML</title>
8508 <para>Asks: Include a "Links" column on the "my summary" tab when
8509 a user is logged in to the OPAC, with the following HTML (leave
8510 blank to disable).</para>
8512 <para>Description:</para>
8516 <para>In this preference you can enter HTML that will appear
8517 on the 'Checked Out' tab on the 'My Summary' section when
8518 logged in to the OPAC. The placeholders {BIBLIONUMBER},
8519 {TITLE}, {ISBN} and {AUTHOR} will be replaced with information
8520 from the displayed record. This can be used to enter in
8521 'share' links for social networks or generate searches against
8522 other library catalogs.</para>
8525 <screeninfo>Example of 'Links' column with a value in the
8526 OPACMySummaryHTML preference</screeninfo>
8530 <imagedata fileref="images/admin/globalprefs/OPACMySummaryHTML.png"/>
8537 <para>Sample Data:<programlisting><p><a href="http://www.facebook.com/sharer.php?u=http://YOUROPAC.ORG/cgi-bin/koha/opac-detail.pl?biblionumber={BIBLIONUMBER}">Share on Facebook</a>
8538 <br />TITLE: {TITLE}
8539 <br />AUTHOR: {AUTHOR}
8540 <br />ISBN: {ISBN}
8541 <br />BIBLIONUMBER: {BIBLIONUMBER}</p></programlisting></para>
8544 <section id="OpacNav">
8545 <title>OpacNav</title>
8547 <para>Default: Important links here.</para>
8549 <para>Asks: Show the following HTML on the left hand column of the
8550 main page and patron account on the OPAC (generally navigation
8554 <screeninfo>Sample navigation links</screeninfo>
8558 <imagedata fileref="images/admin/globalprefs/OpacNav.png"/>
8563 <para>Learn more in the <link linkend="editableopac">OPAC Editable
8564 Regions</link> section.</para>
8567 <section id="OpacNavBottom">
8568 <title>OpacNavBottom</title>
8570 <para>Asks: Show the following HTML on the left hand column of the
8571 main page and patron account on the OPAC, after <link linkend="OpacNav">OpacNav</link>, and before patron account links
8572 if available:</para>
8574 <para>Description: When a patron is logged in to their account
8575 they see a series of tabs to access their account information.
8576 <link linkend="OpacNav">OpacNav</link> appears above this list of
8577 tabs and OpacNavBottom will appear below them. When not on the
8578 patron account pages the HTML in OpacNavBottom will just appear
8579 right below <link linkend="OpacNav">OpacNav</link>.</para>
8582 <screeninfo>OpacNav and OpacNavBottom on Patron
8583 Account</screeninfo>
8587 <imagedata fileref="images/admin/globalprefs/OpacNavBottom.png"/>
8593 <section id="OpacNavRight">
8594 <title>OpacNavRight</title>
8596 <para>Asks: Show the following HTML in the right hand column of
8597 the main page under the main login form.</para>
8599 <para>Description: HTML entered in this preference will appear on
8600 the right hand side of the OPAC under the log in form. If the log
8601 in form is not visible this content will move up on the right
8605 <screeninfo>OpacNavRight</screeninfo>
8609 <imagedata fileref="images/admin/globalprefs/OpacNavRight.png"/>
8615 <section id="OPACNoResultsFound">
8616 <title>OPACNoResultsFound</title>
8618 <para>No Default</para>
8620 <para>Asks: Display this HTML when no results are found for a
8621 search in the OPAC</para>
8623 <para>This HTML will display below the existing notice that no
8624 results were found for your search.</para>
8627 <screeninfo>HTML in OPACNoResultsFound will appear below lines
8628 that look like this</screeninfo>
8632 <imagedata fileref="images/admin/globalprefs/OPACNoResultsFound.png"/>
8637 <para>You can insert placeholders {QUERY_KW} that will be replaced with the keywords
8638 of the query. </para>
8642 <section id="OpacPublic">
8643 <title>OpacPublic</title>
8645 <para>Default: Enable</para>
8647 <para>Asks: ___ Koha OPAC as public. Private OPAC requires
8648 authentication before accessing the OPAC.</para>
8650 <para>Values:</para>
8654 <para>Don't enable</para>
8662 <para>Description:</para>
8666 <para>This preference determines if your OPAC is accessible
8667 and searchable by anyone or only by members of the library. If
8668 set to 'Don't enable' only members who are logged into the
8669 OPAC can search. Most libraries will leave this setting at its
8670 default of 'Enable' to allow their OPAC to be searched by
8671 anyone and only require login for access to personalized
8677 <section id="OPACResultsSidebar">
8678 <title>OPACResultsSidebar</title>
8680 <para>Asks: Include the following HTML under the facets in OPAC
8681 search results</para>
8683 <para>Description:</para>
8687 <para>The HTML entered in this preference will appear on the
8688 search results pages below the list of facets on the left side
8689 of the screen.</para>
8694 <section id="OPACSearchForTitleIn">
8695 <title>OPACSearchForTitleIn</title>
8697 <para>Default: <li><a
8698 href="http://worldcat.org/search?q={TITLE}"
8699 target="_blank">Other Libraries (WorldCat)</a></li>
8701 href="http://www.scholar.google.com/scholar?q={TITLE}"
8702 target="_blank">Other Databases (Google
8703 Scholar)</a></li> <li><a
8704 href="http://www.bookfinder.com/search/?author={AUTHOR}&title={TITLE}&st=xl&ac=qr"
8705 target="_blank">Online Stores
8706 (Bookfinder.com)</a></li></para>
8708 <para>Asks: Include a "More Searches" box on the detail pages of
8709 items on the OPAC, with the following HTML (leave blank to
8713 <para>The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE},
8714 {ISBN}, {ISSN} and {AUTHOR} will be replaced with information
8715 from the displayed record.</para>
8718 <section id="OpacSeparateHoldings">
8719 <title>OpacSeparateHoldings & OpacSeparateHoldingsBranch </title>
8720 <para>OpacSeparateHoldings default: Don't separate</para>
8721 <para>OpacSeparateHoldingsBranch default: home library </para>
8722 <para>Asks: ___ items display into two tabs, where the first tab contains items whose
8723 ___ is the logged in user's library. The second tab will contain all other items. </para>
8724 <para>OpacSeparateHoldings values:<itemizedlist>
8726 <para>Don't separate</para>
8729 <para>Separate</para>
8731 </itemizedlist></para>
8732 <para>OpacSeparateHoldingsBranch values:<itemizedlist>
8734 <para>holding library</para>
8737 <para>home library</para>
8739 </itemizedlist></para>
8740 <para>Description:<itemizedlist>
8742 <para>This preference lets you decide if you would like to have the holding
8743 information on the bibliographic detail page in the OPAC split in to multiple
8744 tabs. The default is to show all holdings on one tab.</para>
8746 <screeninfo>Separate holdings tabs</screeninfo>
8749 <imagedata fileref="images/admin/globalprefs/OpacSeparateHoldings.png"/>
8754 </itemizedlist></para>
8757 <section id="OPACShowBarcode">
8758 <title>OPACShowBarcode</title>
8760 <para>Default: Don't show</para>
8762 <para>Asks: ___ the item's barcode on the holdings tab.</para>
8764 <para>Values:</para>
8768 <para>Don't show</para>
8771 <screeninfo>Barcode not shown in the OPAC</screeninfo>
8775 <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-noshow.png"/>
8785 <screeninfo>Barcode shown in the OPAC</screeninfo>
8789 <imagedata fileref="images/admin/globalprefs/OPACShowBarcode-show.png"/>
8796 <para>Description:</para>
8800 <para>This preference allows you to control whether patrons
8801 can see items' barcodes in the OPAC.</para>
8806 <section id="OPACShowCheckoutName">
8807 <title>OPACShowCheckoutName</title>
8809 <para>Default: Don't show</para>
8811 <para>Asks: ___ the name of the patron that has an item checked
8812 out on item detail pages on the OPAC.</para>
8814 <para>Values:</para>
8818 <para>Don't show</para>
8826 <para>Description:</para>
8830 <para>This preference allows all patrons to see who has the
8831 item checked out if it is checked out. In small corporate
8832 libraries (where the OPAC is behind a firewall and not
8833 publicly available) this can be helpful so coworkers can just
8834 contact the patron with the book themselves. In larger public
8835 and academic libraries setting this to 'Show' would pose
8836 serious privacy issues.</para>
8840 <section id="OpacShowFiltersPulldownMobile">
8841 <title>OpacShowFiltersPulldownMobile</title>
8842 <para>Default: Show</para>
8843 <para>Asks: ___ the search filters pulldown on the mobile version of the OPAC. </para>
8844 <para>Values:<itemizedlist>
8846 <para>Don't show</para>
8851 </itemizedlist>Description:<itemizedlist>
8853 <para>This preference controls whether patrons can choose a search type when
8854 viewing the OPAC on mobile devices. If this is set to 'Don't show' then all
8855 searches will be keyword searches. This preference assumes that you're using a
8856 <link linkend="opacthemes">theme</link> with a mobile version.</para>
8858 </itemizedlist></para>
8861 <section id="OPACShowHoldQueueDetails">
8862 <title>OPACShowHoldQueueDetails</title>
8864 <para>Default: Don't show any hold details</para>
8866 <para>Asks: ___ to patrons in the OPAC.</para>
8868 <para>Values:</para>
8872 <para>Don't show any hold details</para>
8876 <para>Show holds</para>
8879 <screeninfo>The holdings table on the bibliographic record
8880 will show the number of holds</screeninfo>
8884 <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-showholds.png"/>
8891 <para>Show holds and priority level</para>
8895 <para>Show priority level</para>
8898 <screeninfo>Patron record in the OPAC shows where in line
8899 the patron waits for their hold.</screeninfo>
8903 <imagedata fileref="images/admin/globalprefs/OPACShowHoldQueueDetails-priority.png"/>
8910 <para><link linkend="opacuserlogin">opacuserlogin</link>
8911 needs to be set to 'allow'</para>
8917 <section id="OpacShowLibrariesPulldownMobile">
8918 <title>OpacShowLibrariesPulldownMobile</title>
8919 <para>Default: Show</para>
8920 <para>Asks: ___ the libraries pulldown on the mobile version of the OPAC. </para>
8921 <para>Values:<itemizedlist>
8923 <para>Don't show</para>
8928 </itemizedlist>Description:<itemizedlist>
8930 <para>This preference controls whether the library selector pull down shows when
8931 viewing the OPAC on a mobile device as long as the <link linkend="opacthemes">theme</link> you're using has a mobile version.</para>
8933 </itemizedlist></para>
8936 <section id="OpacShowRecentComments">
8937 <title>OpacShowRecentComments</title>
8939 <para>Default: Don't show</para>
8941 <para>Asks: ___ a link to recent comments in the OPAC
8944 <para>Values:</para>
8948 <para>Don't show</para>
8956 <para>Description:</para>
8960 <para>If you have chosen to allow comments in your OPAC by
8961 setting <link linkend="reviewson">reviewson</link> to 'Allow'
8962 you can include a link to the recent comments under the search
8963 box at the top of your OPAC with this preference.</para>
8966 <screeninfo>Recent Comments link on OPAC</screeninfo>
8970 <imagedata fileref="images/admin/globalprefs/OpacShowRecentComments.png"/>
8978 <section id="OPACShowUnusedAuthorities">
8979 <title>OPACShowUnusedAuthorities</title>
8981 <para>Default: Show</para>
8983 <para>Asks: ___ unused authorities in the OPAC authority
8986 <para>Values:</para>
8990 <para>Do not show</para>
8999 <para>Requires that the <link linkend="OpacAuthorities">OpacAuthorities</link>
9000 preference is set to 'Allow'</para>
9007 <para>Description:</para>
9011 <para>When patrons search your authority file via the OPAC
9012 they will see all authorities in your system even if you don't
9013 have them linked to any bibliographic records. This preference
9014 lets you determine what the default behavior is when searching
9015 authorities via the OPAC. If you choose 'Do not show' it will
9016 only show patrons authority records that are linked to bib
9017 records in the search results. Otherwise the system will show
9018 all authority records even if they aren't linked to
9024 <section id="opacsmallimage">
9025 <title>opacsmallimage</title>
9027 <para>Asks: Use the image at ___ in the OPAC header, instead of
9028 the Koha logo. If this image is a different size than the Koha
9029 logo, you will need to customize the CSS.</para>
9031 <para>Description:</para>
9035 <para>The opacsmallimage system pref is a little tricky to
9036 deal with because you really have to tweak some CSS at the
9037 same time. The default CSS defines a region just large enough
9038 to display the Koha logo, and if your logo doesn't match the
9039 Koha logo's dimensions (120 pixels wide by 38 pixels high), it
9040 won't display correctly.</para>
9045 <para>This should be a complete URL, starting with
9049 <para>This preference is only used in the prog and ccsr themes.</para>
9053 <section id="OpacStarRatings">
9054 <title>OpacStarRatings</title>
9056 <para>Default: no</para>
9058 <para>Asks: Show star-ratings on ___ pages.</para>
9060 <para>Values:</para>
9068 <para>only details</para>
9071 <screeninfo>Star Ratings on the Details Page</screeninfo>
9075 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-details.png"/>
9082 <para>results and details</para>
9085 <screeninfo>OPAC Star Ratings on the Search
9086 Results</screeninfo>
9090 <imagedata fileref="images/admin/globalprefs/OpacStarRatings-results.png"/>
9097 <para>Description:</para>
9101 <para>Star ratings are a way for your patrons to leave ratings
9102 without having to leave a full review. Patrons who are not
9103 logged in will only be able to see the stars, once logged in
9104 patrons can click on the stars on the details page to leave
9105 their own rating. Clicking on the stars on the search results
9106 will not submit a rating.</para>
9111 <section id="opacthemes">
9112 <title>opacthemes</title>
9114 <para>Default: prog</para>
9116 <para>Asks: Use the ___ theme on the OPAC.</para>
9118 <para>Values:</para>
9122 <para>bootstrap</para>
9125 <screeninfo>Bootstrap Theme</screeninfo>
9128 <imagedata fileref="images/admin/globalprefs/opacthemes-bootstrap.png"/>
9133 <para>This theme is completely responsive</para>
9139 <screeninfo>CCSR Theme</screeninfo>
9142 <imagedata fileref="images/admin/globalprefs/opacthemes-ccsr.png"/>
9147 <para>This theme comes with a mobile version.</para>
9153 <screeninfo>PROG Theme</screeninfo>
9156 <imagedata fileref="images/admin/globalprefs/opacthemes-prog.png"/>
9161 <para>This is the original Koha 3.x theme and does not come with a mobile
9167 <section id="OPACURLOpenInNewWindow">
9168 <title>OPACURLOpenInNewWindow</title>
9170 <para>Default: don't</para>
9172 <para>Asks: When patrons click on a link to another website from
9173 your OPAC (like Amazon or OCLC), ___ open the website in a new
9176 <para>Values:</para>
9188 <para>Description:</para>
9192 <para>This preference determines if URLs in the OPAC will open
9193 in a new window or not. When clicking on a link in the OPAC, a
9194 patron does not need to worry about navigating away from their
9195 search results.</para>
9200 <section id="OPACUserCSS">
9201 <title>OPACUserCSS</title>
9203 <para>Asks: Include the following CSS on all pages in the
9206 <para>Description:</para>
9210 <para>OPACUserCSS allows the administrator to enter styles
9211 that will overwrite the OPAC's default CSS as defined in
9212 'opaclayoutstylesheet' or 'opacstylesheet'. Styles may be
9213 entered for any of the selectors found in the default style
9214 sheet. The default stylesheet will likely be found at
9215 http://your_koha_address/opac-tmpl/prog/en/css/opac.css.
9216 Unlike <link linkend="opaccolorstylesheet">opaccolorstylesheet</link> and
9217 <link linkend="opaclayoutstylesheet">opaclayoutstylesheet</link>
9218 this preference will embed the CSS directly on your OPAC
9224 <section id="opacuserjs">
9225 <title>opacuserjs</title>
9227 <para>Asks: Include the following JavaScript on all pages in the
9231 <screeninfo>OPAC login box before opacuserjs edit</screeninfo>
9235 <imagedata fileref="images/admin/globalprefs/opacuserjs-before.png"/>
9241 <screeninfo>JavaScript in opacuserjs to change the OPAC login
9246 <imagedata fileref="images/admin/globalprefs/opacuserjs.png"/>
9252 <screeninfo>New OPAC login box after editing
9253 opacuserjs</screeninfo>
9257 <imagedata fileref="images/admin/globalprefs/opacuserjs-after.png"/>
9262 <para>Description:</para>
9266 <para>This preference allows the administrator to enter
9267 JavaScript or JQuery that will be embedded across all pages of
9268 the OPAC. Administrators may use this preference to customize
9269 some of the interactive sections of Koha, customizing the text
9270 for the login prompts, for example. Sample JQuery scripts used
9271 by Koha libraries can be found on the wiki: <ulink url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
9276 <section id="OPACXSLTDetailsDisplay">
9277 <title>OPACXSLTDetailsDisplay</title>
9279 <para>Default: default</para>
9281 <para>Asks: Display OPAC details using XSLT stylesheet at
9284 <para>Values:</para>
9288 <para>leave empty to not use the XSLT stylesheet</para>
9292 <para>In previous versions of Koha this was the setting
9293 that read 'normally'</para>
9299 <para>enter "default" for the default one</para>
9303 <para>put a path to define a XSLT file</para>
9307 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
9311 <para>If in a multi-language system you can enter
9312 {langcode} in the path to tell Koha to look in the right
9313 language folder</para>
9318 /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
9323 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
9331 <para>put an URL for an external specific stylesheet</para>
9335 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
9341 <para>Description:</para>
9345 <para>XSLT stylesheets allow for the customization of the
9346 details shows on the screen when viewing a bib record. This
9347 preference will allow you either use the default look that
9348 comes with Koha or design your own stylesheet.</para>
9353 <section id="OPACXSLTResultsDisplay">
9354 <title>OPACXSLTResultsDisplay</title>
9356 <para>Default: default</para>
9358 <para>Asks: Display OPAC results using XSLT stylesheet at
9361 <para>Values:</para>
9365 <para>leave empty to not use the XSLT stylesheet</para>
9369 <para>In previous versions of Koha this was the setting
9370 that read 'normally'</para>
9376 <para>enter "default" for the default one</para>
9380 <para>put a path to define a XSLT file</para>
9384 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
9388 <para>If in a multi-language system you can enter
9389 {langcode} in the path to tell Koha to look in the right
9390 language folder</para>
9395 /home/koha/src/koha-tmpl/opac/prog/{langcode}/xslt/OpacDetail.xsl</para>
9400 http://mykohaopac.org/{langcode}/stylesheet.xsl</para>
9408 <para>put an URL for an external specific stylesheet</para>
9412 <para>ex: http://mykohaopac.org/stylesheet.xsl</para>
9418 <para>Description:</para>
9422 <para>XSLT stylesheets allow for the customization of the
9423 details shows on the screen when viewing the search results.
9424 This preference will allow you either use the default look
9425 that comes with Koha or design your own stylesheet.</para>
9431 <section id="opacfeaturesprefs">
9432 <title>Features</title>
9436 <section id="numSearchRSSResults">
9437 <title>numSearchRSSResults</title>
9439 <para>Default: 50</para>
9441 <para>Asks: Display ___ search results in the RSS feed.</para>
9443 <para>Description:</para>
9447 <para>By default the RSS feed that is automatically generated
9448 for every search results page will list 50 items. This can
9449 sometimes be too much for some RSS feed readers and for some
9450 people this isn't enough. This preference allows you to adjust
9451 this number to show the best number of results for your
9457 <section id="OpacAuthorities">
9458 <title>OpacAuthorities</title>
9460 <para>Default: Allow</para>
9462 <para>Asks: ___ patrons to search your authority records.</para>
9464 <para>Description:</para>
9468 <para>This preference displays the link on the OPAC for the authority search. By
9469 setting the preference to "Allow" patrons can use this search link of the
9474 <para>Values:</para>
9482 <para>A link labeled 'Authority search' will appear at the top of your OPAC
9483 under the search box</para>
9486 <screeninfo>'Browse by Subject' link under search box on
9491 <imagedata fileref="images/admin/globalprefs/authoritysearch.png"/>
9500 <para>Don't allow</para>
9505 <section id="opacbookbag">
9506 <title>opacbookbag</title>
9508 <para>Default: Allow</para>
9510 <para>Asks: ___ patrons to store items in a temporary "Cart" on
9513 <para>Values:</para>
9521 <para>Don't allow</para>
9525 <para>Description:</para>
9529 <para>This preference allows the user to temporarily save a
9530 list of items found on the catalog. By using the Book Bag, or
9531 Cart, the user can print out or email a list of items found.
9532 The user does not need to be logged in. This list is temporary
9533 and will be emptied, or cleared, at the end of the
9539 <section id="OpacBrowser">
9540 <title>OpacBrowser</title>
9543 <para>This preference only applies to French systems at this
9547 <para>Default: Don't allow</para>
9549 <para>Asks: ___ patrons to browse subject authorities on
9552 <para>Values:</para>
9560 <para>Don't allow</para>
9565 <para>run the <link linkend="authbrowsercron">Authorities
9566 Browser Cron Job</link> to create the browser list</para>
9570 <section id="OpacBrowseResults">
9571 <title>OpacBrowseResults</title>
9573 <para>Default: enable</para>
9575 <para>Asks: ___ browsing and paging search results from the OPAC
9578 <para>Values:</para>
9582 <para>disable</para>
9589 <screeninfo>Browsing and Paging Search Results</screeninfo>
9593 <imagedata fileref="images/admin/globalprefs/OpacBrowseResults.png"/>
9600 <para>Description:</para>
9604 <para>This preference will control the option to return to
9605 your results and/or browse them from the detail page in the
9610 <section id="OpacCloud">
9611 <title>OpacCloud</title>
9613 <para>This preference only applies to French systems at this time.</para>
9614 </important>Default: Don't show</para>
9615 <para>Asks: ___ a subject cloud on OPAC</para>
9616 <para>Values:<itemizedlist>
9618 <para>Don't show</para>
9623 </itemizedlist></para>
9626 <para>run the <link linkend="authbrowsercron">Authorities Browser Cron Job</link> to
9627 create the browser list</para>
9632 <section id="OPACFinesTab">
9633 <title>OPACFinesTab</title>
9635 <para>Default: Allow</para>
9637 <para>Asks: ___ patrons to access the Fines tab on the My Account
9638 page on the OPAC.</para>
9640 <para>Values:</para>
9648 <para><link linkend="opacuserlogin">opacuserlogin</link>
9649 needs to be set to 'allow'</para>
9655 <para>Don't allow</para>
9659 <section id="OpacHoldNotes">
9660 <title>OpacHoldNotes</title>
9661 <para>Default: Do not allow</para>
9662 <para>Asks: ___ users to add a note when placing a hold.</para>
9663 <para>Values:<itemizedlist>
9667 <screeninfo>Holds notes in the OPAC</screeninfo>
9670 <imagedata fileref="images/admin/globalprefs/OpacHoldNotes.png"/>
9676 <para>Do not allow</para>
9678 </itemizedlist></para>
9680 <section id="OpacItemLocation">
9681 <title>OpacItemLocation</title>
9682 <para>Default: call number only</para>
9683 <para>Asks: Show ____ for items on the OPAC search results.</para>
9684 <para>Values:<itemizedlist>
9686 <para>call number only</para>
9689 <para>collection code</para>
9692 <para>location</para>
9694 </itemizedlist></para>
9695 <para>Description: </para>
9698 <para>This setting allows users of the OPAC results XSLT stylesheet to choose to
9699 display collection code or location in addition to call number.</para>
9704 <section id="OpacPasswordChange">
9705 <title>OpacPasswordChange</title>
9707 <para>Default: Allow</para>
9709 <para>Asks: ___ patrons to change their own password on the
9712 <para>Values:</para>
9720 <para><link linkend="opacuserlogin">opacuserlogin</link>
9721 needs to be set to 'allow'</para>
9727 <para>Don't allow</para>
9732 <para>Enabling this will break LDAP authentication.</para>
9736 <section id="OPACPatronDetails">
9737 <title>OPACPatronDetails</title>
9739 <para>Default: Allow</para>
9741 <para>Asks: ___ patrons to notify the library of changes to their
9742 contact information from the OPAC.</para>
9744 <para>Values:</para>
9752 <para><link linkend="opacuserlogin">opacuserlogin</link>
9753 needs to be set to 'allow'</para>
9759 <para>Don't allow</para>
9763 <para>Description:</para>
9767 <para>If patrons are allowed to notify the library of changes to their account then
9768 staff will need to approve the changes via the staff client. Notification of
9769 patron account requests will appear on the dashaboard below the list of modules
9770 with other pending actions.</para>
9772 <screeninfo>Patrons requesting modifications</screeninfo>
9775 <imagedata fileref="images/admin/globalprefs/OPACPatronDetails.png"/>
9779 <para>Once you click the notification you will be presented with the changes the
9780 patron would like to make to their account and from there you can choose how to
9783 <screeninfo>Patrons modifications</screeninfo>
9786 <imagedata fileref="images/admin/globalprefs/OPACPatronDetails-approve.png"/>
9791 <para>You can control what fields patrons see and can modify via the OPAC by
9792 setting the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link>
9793 <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
9799 <section id="OPACpatronimage">
9800 <title>OPACpatronimage</title>
9802 <para>Default: Don't show</para>
9804 <para>Asks: ___ patron images on the patron information page in
9807 <para>Values:</para>
9811 <para>Don't show</para>
9819 <para>Description:</para>
9823 <para>If <link linkend="patronimages">patronimages</link> is
9824 set to allow the upload of patron images via the staff client,
9825 then setting this preference to 'show' will show the patron
9826 what image you have on file for them when they view their
9827 personal information on their account in the OPAC.</para>
9831 <section id="OPACPopupAuthorsSearch">
9832 <title>OPACPopupAuthorsSearch</title>
9833 <para>Default: Don't display</para>
9834 <para>Asks: ___ the list of authors/subjects in a popup for a combined search on OPAC
9835 detail pages.</para>
9836 <para>Values:<itemizedlist>
9838 <para>Display</para>
9841 <screeninfo>Subject search pop up</screeninfo>
9844 <imagedata fileref="images/admin/globalprefs/OPACPopupAuthorsSearch.png"/>
9851 <para>This will only display the pop up if you are not using an XSLT
9852 stylesheet. Review your <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> to find out what stylesheet you're
9860 <para>Don't display<itemizedlist>
9862 <para>Authors and subjects will display as search links instead of pop up
9865 </itemizedlist></para>
9867 </itemizedlist></para>
9868 <para>Description:<itemizedlist>
9870 <para>If this preference is set to 'Display' then clicking a subject or author
9871 from the details page in the OPAC will present the searcher with a pop up box.
9872 From this box you can check off any of the subjects or authors listed and search
9873 them all at once by clicking 'Search' at the bottom of the pop up. The default
9874 behavior is for Koha to search just the clicked author or subject.</para>
9876 </itemizedlist></para>
9879 <section id="OpacTopissue">
9880 <title>OpacTopissue</title>
9882 <para>Default: Don't allow</para>
9884 <para>Asks: ___ patrons to access a list of the most checked out
9885 items on the OPAC.</para>
9887 <para>Values:</para>
9895 <para>A link to 'Most Popular' will appear at the top of
9899 <screeninfo>'Most Popular' link under the search
9904 <imagedata fileref="images/admin/globalprefs/OpacTopissue.png"/>
9913 <para>Don't allow</para>
9917 <para>Description:</para>
9921 <para>This preference allows the administrator to choose to
9922 show the "Most Popular" link at the top of the OPAC under the
9923 search box. The "Most Popular" page shows the top circulated
9924 items in the library, as determined by the number of times a
9925 title has been circulated. This allows users to see what
9926 titles are popular in their community. It is recommended that
9927 you leave this preference set to 'Don't allow' until you have
9928 been live on Koha for a couple of months, otherwise the data
9929 that it shows will not be an accurate portrayal of what's
9930 popular in your library.</para>
9933 <screeninfo>Sample top issues page</screeninfo>
9937 <imagedata fileref="images/admin/globalprefs/topissues.png"/>
9945 <section id="opacuserlogin">
9946 <title>opacuserlogin</title>
9948 <para>Default: Allow</para>
9950 <para>Asks: ___ patrons to log in to their accounts on the
9953 <para>Values:</para>
9961 <para>Don't allow</para>
9965 <para>The OPAC will still be searchable if patrons can't
9966 log in, this just disables the patron account access via
9974 <section id="QuoteOfTheDay">
9975 <title>QuoteOfTheDay</title>
9977 <para>Default: Disable</para>
9979 <para>Asks: ___ Quote of the Day display on OPAC home page</para>
9981 <para>Values:</para>
9985 <para>Disable</para>
9993 <para>Description:</para>
9997 <para>This feature will allow you to enter a series of quotes
9998 that will then show on the OPAC homepage in random order. To
9999 add/edit quotes, visit the <link linkend="QOTDEditor">Quote of
10000 the Day Editor</link> under Tools.</para>
10005 <section id="RequestOnOpac">
10006 <title>RequestOnOpac</title>
10008 <para>Default: Allow</para>
10010 <para>Asks: ___ patrons to place holds on items from the
10013 <para>Values:</para>
10021 <para><link linkend="opacuserlogin">opacuserlogin</link>
10022 needs to be set to 'allow'</para>
10028 <para>Don't allow</para>
10033 <section id="reviewson">
10034 <title>reviewson</title>
10036 <para>Default: Allow</para>
10038 <para>Asks: ___ patrons to make comments on items on the
10041 <para>Values:</para>
10049 <para>Patrons comments/reviews all require moderation
10050 before they appear in the OPAC</para>
10054 <para><link linkend="opacuserlogin">opacuserlogin</link>
10055 needs to be set to 'Allow'</para>
10061 <para>Don't allow</para>
10065 <para>Description:</para>
10069 <para>This button allows the patrons to submit comments on
10070 books they have read via the OPAC. If this preference is set
10071 to "Allow" reviews are first sent to the staff client for
10072 staff approval before the review is displayed in the OPAC. The
10073 staff member who reviews and approves comments may find the
10074 pending comments on the <link linkend="comments">Comments</link> tool. The staff member can
10075 then choose to approve or delete the comments.</para>
10080 <section id="ShowReviewer">
10081 <title>ShowReviewer</title>
10083 <para>Default: full name</para>
10085 <para>Asks: Show ___ of commenter with comments in OPAC.</para>
10087 <para>Values:</para>
10091 <para>first name</para>
10095 <para>first name and last initial</para>
10099 <para>full name</para>
10103 <para>last name</para>
10107 <para>no name</para>
10111 <para>username</para>
10115 <para>Description:</para>
10119 <para>If you would like to protect your patron's privacy in
10120 the OPAC you can choose to hide their names or parts of their
10121 names from any of the comments they leave on bib records in
10122 your system. <link linkend="reviewson">reviewson</link> needs
10123 to be set to 'Allow' for this to preference to come in to
10129 <section id="ShowReviewerPhoto">
10130 <title>ShowReviewerPhoto</title>
10132 <para>Default: Show</para>
10134 <para>Asks: ___ reviewer's photo beside comments in OPAC.</para>
10136 <para>Values:</para>
10148 <para><link linkend="reviewson">reviewson</link> needs to
10149 be set to 'Allow' and <link linkend="ShowReviewer">ShowReviewer</link> needs to be set
10150 to 'Show' for this to preference to come in to play</para>
10153 <screeninfo>ShowReviewerPhoto set to 'Show'</screeninfo>
10157 <imagedata fileref="images/admin/globalprefs/ShowReviewerPhoto.png"/>
10166 <para>Description:</para>
10170 <para>This system preference allows libraries to show avatars
10171 next to patron's comments in the OPAC. These avatars are
10172 pulled from the <ulink url="https://www.libravatar.org">Libravatar</ulink> library,
10173 an open source powered product that allows Internet users to
10174 choose a small icon to display next to their name on various
10175 different websites. The library has no control over the images
10176 the patron chooses to display.</para>
10181 <section id="SocialNetworks">
10182 <title>SocialNetworks</title>
10184 <para>Default: Disable</para>
10186 <para>Asks: ___ social network links in opac detail pages</para>
10188 <para>Values:</para>
10192 <para>Disable</para>
10196 <para>Enable</para>
10199 <screeninfo>Social Networks</screeninfo>
10203 <imagedata fileref="images/admin/globalprefs/SocialNetworks.png"/>
10210 <para>Description:</para>
10214 <para>This preference will enable a line of social network
10215 share buttons below the right hand column on the detail pages
10216 of records in the OPAC.</para>
10221 <para>In order for these share buttons to work when clicked you
10222 must have filled in your <link linkend="OPACBaseURL">OPACBaseURL</link> preference.</para>
10226 <section id="suggestionspref">
10227 <title>suggestion</title>
10229 <para>Default: Allow</para>
10231 <para>Asks: ___ patrons to make purchase suggestions on the
10234 <para>Values:</para>
10242 <para><link linkend="opacuserlogin">opacuserlogin</link>
10243 needs to be set to 'allow' unless <link linkend="AnonSuggestions">AnonSuggestions</link> is set to
10250 <para>Don't allow</para>
10256 <section id="opacpolicyprefs">
10257 <title>Policy</title>
10261 <section id="AllowPurchaseSuggestionBranchChoice">
10262 <title>AllowPurchaseSuggestionBranchChoice</title>
10264 <para>Default: Don't allow</para>
10266 <para>Asks: ___ patrons to select branch when making a purchase
10269 <para>Values:</para>
10277 <para>Don't allow</para>
10281 <para>Description:</para>
10285 <para>If your library system lets patrons make purchase
10286 suggestions for a specific branch you can set this preference
10287 to 'Allow' to add a branch selection option to the purchase
10288 suggestion form.</para>
10293 <section id="OpacAllowPublicListCreation">
10294 <title>OpacAllowPublicListCreation</title>
10296 <para>Default: Allow</para>
10298 <para>Asks: ___ opac users to create public lists</para>
10300 <para>Values:</para>
10308 <para>Don't allow</para>
10312 <para>Description:</para>
10316 <para>Public lists are visible to anyone who visits your OPAC.
10317 With this preference you can control whether or now patrons
10318 are allowed to create these public lists. If this is set to
10319 "Don't allow" then only staff will be able to create public
10325 <para>This preference will only be taken in to account if you
10326 have <link linkend="virtualshelves">virtualshelves</link> set to
10331 <section id="OpacAllowSharingPrivateLists">
10332 <title>OpacAllowSharingPrivateLists</title>
10335 <para>This feature is not active yet but will be released
10339 <para>Default: Don't allow</para>
10341 <para>Asks: ___ opac users to share private lists with other
10344 <para>Values:</para>
10352 <para>Don't allow</para>
10356 <para>Description:</para>
10360 <para>This feature will add the option for patrons to share
10361 their lists with other patrons.</para>
10366 <section id="OPACFineNoRenewals">
10367 <title>OPACFineNoRenewals</title>
10369 <para>Default: 99999</para>
10371 <para>Asks: Only allow patrons to renew their own books on the
10372 OPAC if they have less than ___ USD in fines</para>
10375 <para>Leave this field blank to disable</para>
10379 <para>To allow renewals in the OPAC, <link linkend="opacuserlogin">opacuserlogin</link> needs to be set to
10384 <section id="OpacHiddenItems">
10385 <title>OpacHiddenItems</title>
10387 <para>Asks: Allows to define custom rules for hiding specific
10388 items at opac. <tip>
10389 <para>See docs/opac/OpacHiddenItems.txt in your Koha install
10390 directory for more information</para>
10393 <para>Description:</para>
10397 <para>In this field you can enter criteria for items you would
10398 like to hide from display in the OPAC. This field takes any
10399 combination of item fields (from the items table in the Koha
10400 database) for blocking. For example a value of:</para>
10402 <para><programlisting>itype: [07, 10]
10403 location: [STAFF, ISO]</programlisting>Will block items with an itype code of
10404 07 or 10 as well as items that have a shelving location of
10405 STAFF or ISO.</para>
10407 <para>In items my items.itype 07 is defined in Item Types
10408 Administration as Staff Assigned My items.itype 10 in Item
10409 Types is Archival Copy The locations STAFF and ISO are in
10410 Authorized Values for category=LOC STAFF means it's assigned
10411 to the staff reading room and ISO means it is in the isolation
10417 <section id="OPACItemHolds">
10418 <title>OPACItemHolds</title>
10420 <para>Default: Allow</para>
10422 <para>Asks: ___ patrons to place holds on specific items in the
10425 <para>Values:</para>
10433 <para>Patrons can place holds on specific items as well as
10434 the next available item.</para>
10438 <para><link linkend="opacuserlogin">opacuserlogin</link>
10439 needs to be set to 'allow'</para>
10445 <para>Don't allow</para>
10449 <para>If this is disabled, users can only put a hold on
10450 the next available item.</para>
10457 <section id="OpacRenewalAllowed">
10458 <title>OpacRenewalAllowed</title>
10460 <para>Default: Don't allow</para>
10462 <para>Asks: ___ patrons to renew their own books on the
10465 <para>Values:</para>
10473 <para><link linkend="opacuserlogin">opacuserlogin</link>
10474 needs to be set to 'allow'</para>
10480 <para>Don't allow</para>
10484 <para>Staff will still be able to renew items for patrons
10485 via the staff client</para>
10491 <para>Description:</para>
10495 <para>This preference allows the administration to choose if
10496 patrons can renew their checked out materials via their
10497 checked out history in the OPAC. It allows patrons to renew
10498 their materials without having to contact the library or
10499 having to return to the library.</para>
10504 <section id="OpacRenewalBranch">
10505 <title>OpacRenewalBranch</title>
10507 <para>Default: the branch the item was checked out from</para>
10509 <para>Asks: Use ___ as branchcode to store in the statistics
10512 <para>Values:</para>
10520 <para>'OPACRenew'</para>
10524 <para>the item's home branch</para>
10528 <para>the patron's home branch</para>
10532 <para>the branch the item was checked out from</para>
10536 <para>Description:</para>
10540 <para>This value is used in the statistics table to help with
10541 reporting. The statistics table in Koha keeps track of all
10542 checkouts and renewals, this preference defines which branch
10543 is entered in to the table when a patron renews an item for
10544 themselves via the OPAC.</para>
10549 <section id="OPACViewOthersSuggestions">
10550 <title>OPACViewOthersSuggestions</title>
10552 <para>Default: Don't show</para>
10554 <para>Asks: ___ purchase suggestions from other patrons on the
10557 <para>Values:</para>
10561 <para>Don't show</para>
10569 <para><link linkend="opacuserlogin">opacuserlogin</link>
10570 needs to be set to 'allow'</para>
10577 <section id="SearchMyLibraryFirst">
10578 <title>SearchMyLibraryFirst</title>
10580 <para>Default: Don't limit</para>
10582 <para>Asks: ___ patrons' searches to the library they are
10583 registered at.</para>
10585 <para>Values:</para>
10589 <para>Don't limit</para>
10593 <para>Searching the OPAC will show results from all
10598 <para>If you're a one branch system, choose 'Don't
10609 <para>Patrons will still be able to search other libraries
10610 via the Advanced search page - but will be limited to
10611 searches for their library only from the basic search
10616 <para><link linkend="opacuserlogin">opacuserlogin</link>
10617 needs to be set to 'allow'</para>
10624 <section id="singleBranchMode">
10625 <title>singleBranchMode</title>
10627 <para>Default: Don't allow</para>
10629 <para>Asks: ___ patrons to select their branch on the OPAC.</para>
10631 <para>Values:</para>
10639 <para><link linkend="opacuserlogin">opacuserlogin</link>
10640 needs to be set to 'allow'</para>
10646 <para>Don't allow</para>
10650 <para>Description:</para>
10654 <para>This preference is for libraries that have branches but
10655 do not want to share their items among other branches within
10656 their system. If the preference is set to "Don't allow" then
10657 holdings will be shown for all branches within a system. On
10658 the "Home" screen of the OPAC users have the choice of
10659 narrowing down results by item location. Setting this
10660 preference to "Allow" will display only one branch's
10667 <section id="opacprivacyprefs">
10668 <title>Privacy</title>
10672 <section id="AnonSuggestions">
10673 <title>AnonSuggestions</title>
10675 <para>Default: Don't allow</para>
10677 <para>Asks: ___ patrons that aren't logged in to make purchase
10678 suggestions. <important>
10679 <para>If set to 'Allow', suggestions are connected to the
10680 <link linkend="AnonymousPatron">AnonymousPatron</link></para>
10681 </important></para>
10683 <para>Values:</para>
10691 <para>Don't allow</para>
10696 <section id="AnonymousPatron">
10697 <title>AnonymousPatron</title>
10699 <para>Default: 0</para>
10701 <para>Asks: Use borrowernumber ___ as the Anonymous Patron (for
10702 anonymous suggestions and reading history) <tip>
10703 <para>Before setting this preference <link linkend="addnewpatron">create a patron</link> to be used for
10704 all anonymous suggestions and/or reading history items. This
10705 patron can be any type and should be named something to make
10706 it clear to you that they're anonymous (ex. Anonymous
10711 <section id="EnableOpacSearchHistory">
10712 <title>EnableOpacSearchHistory</title>
10714 <para>Default: Keep</para>
10716 <para>Asks: ___ patron search history in the OPAC.</para>
10718 <para>Values:</para>
10722 <para>Don't keep</para>
10731 <section id="OPACPrivacy">
10732 <title>OPACPrivacy</title>
10734 <para>Default: Don't allow</para>
10736 <para>Asks: ___ patrons to choose their own privacy settings for
10737 their reading history. <important>
10738 <para>This requires <link linkend="opacreadinghistory">opacreadinghistory</link> set to
10739 'Allow' and <link linkend="AnonymousPatron">AnonymousPatron</link> to be set to
10740 your anonymous patron's borrowernumber.</para>
10741 </important></para>
10743 <para>Values:</para>
10751 <para>Don't allow</para>
10756 <section id="opacreadinghistory">
10757 <title>opacreadinghistory</title>
10759 <para>Default: Allow</para>
10761 <para>Asks: ___ patrons to see what books they have checked out in
10765 <para>Enabling this will make it so that patrons can view their
10766 circulation history in the OPAC unless you have OPACPrivacy set
10771 <para>This data is stored in the system regardless of your
10772 choice, unless your patrons have chosen to never have their
10773 reading history kept.</para>
10776 <section id="TrackClicks">
10777 <title>TrackClicks</title>
10778 <para>Default: Don't track</para>
10779 <para>Asks: ___ links that patrons click on.</para>
10780 <para>Values:<itemizedlist>
10782 <para>Don't track</para>
10788 <para>Track anonymously</para>
10790 </itemizedlist></para>
10791 <para>Description:<itemizedlist>
10793 <para>By setting this preference to one of the track options you will allow Koha
10794 to track every link clicked in Koha. This data will be stored in a database
10795 table so that you can run reports against that data. If you choose to 'Track'
10796 clicks then Koha will record both the link clicked and the logged in user who
10797 clicked the link. If you choose to 'Track anonymously' then the borrowernumber
10798 will not be recorded, but the rest of the data will.<tip>
10799 <para>Remember to update your local privacy policies and link to them from the
10800 OPAC to notify your users that you are tracking their information.</para>
10803 </itemizedlist></para>
10806 <section id="opacselfregistrationprefs">
10807 <title>Self Registration</title>
10808 <section id="PatronSelfRegistration">
10809 <title>PatronSelfRegistration</title>
10810 <para>Default: Don't allow</para>
10811 <para>Asks: ___ library patrons to register an account via the OPAC.</para>
10812 <para>Values:<itemizedlist>
10817 <para>Don't allow</para>
10819 </itemizedlist></para>
10820 <para>Description:</para>
10823 <para>Setting this preference to 'Allow' will provide a link on the OPAC to register
10824 for a new account. Using the other <link linkend="opacselfregistrationprefs">Self
10825 Registration</link> system preferences you can control how this preference will function.</para>
10827 <screeninfo>Register link in the OPAC</screeninfo>
10830 <imagedata fileref="images/admin/globalprefs/PatronSelfRegistration.png"/>
10837 <para>Patrons registering via the OPAC will not need to be approved by a librarian.
10838 For this reason it is recommended that you set up a provisional <link linkend="patcats">patron category</link> with no <link linkend="circfinerules">circulation rights</link>. That way patrons will have to come in to the library
10839 to verify their identity before given circulation rights at the library. Once the
10840 patron confirms their identiy the library staff can change the category to one with
10841 permissions to check items out and place holds.</para>
10844 <section id="PatronSelfRegistrationAdditionalInstructions">
10845 <title>PatronSelfRegistrationAdditionalInstructions</title>
10846 <para>Asks: Display the following additional instructions for patrons who self register
10847 via the OPAC ( HTML is allowed ): </para>
10848 <para>Description:<itemizedlist>
10850 <para>This preference takes any HTML you'd like to display on the page the patron
10851 sees after successfully registering for their library card.</para>
10853 </itemizedlist></para>
10855 <section id="PatronSelfRegistrationBorrowerMandatoryField">
10856 <title>PatronSelfRegistrationBorrowerMandatoryField</title>
10857 <para>Default: surname|firstname</para>
10858 <para>Asks: The following database columns must be filled in on the patron entry screen:
10860 <para>Description:</para>
10863 <para>This preference allows you to define what fields patrons must fill in on their
10864 self regisration form. If any of the required fields are blank Koha will not let
10865 the patron register.</para>
10869 <para>Separate columns with |</para>
10872 <para>For help with field names, ask your system administrator or <ulink url="http://schema.koha-community.org/tables/borrowers.html">view the database
10873 structure</ulink> associated with the borrowers table.</para>
10876 <para>If you're going to require that patrons verify their accounts via email with the
10877 <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference the email field will
10878 automatically be marked as required.</para>
10881 <section id="PatronSelfRegistrationBorrowerUnwantedField">
10882 <title>PatronSelfRegistrationBorrowerUnwantedField</title>
10883 <para>Asks: The following database columns will not appear on the patron entry screen:
10885 <para>Description:</para>
10888 <para>Using this preference you can hide fields from the patron registraion and
10889 update form in the OPAC.</para>
10893 <para>Separate columns with |</para>
10896 <para>For help with field names, ask your system administrator or <ulink url="http://schema.koha-community.org/tables/borrowers.html">view the database
10897 structure</ulink> associated with the borrowers table.</para>
10900 <section id="PatronSelfRegistrationDefaultCategory">
10901 <title>PatronSelfRegistrationDefaultCategory</title>
10902 <para>Asks: Use the patron category code ___ as the default patron category for patrons
10903 registered via the OPAC. </para>
10904 <para>Description:</para>
10907 <para>Enter in the patron category code for the category that all new patrons
10908 registered via the OPAC will be put in to.</para>
10912 <para>Patrons registering via the OPAC will not need to be approved by a librarian.
10913 For this reason it is recommended that you set up a provisional <link linkend="patcats">patron category</link> with no <link linkend="circfinerules">circulation rights</link>. That way patrons will have to come in to the library
10914 to verify their identity before given circulation rights at the library. Once the
10915 patron confirms their identiy the library staff can change the category to one with
10916 permissions to check items out and place holds.</para>
10919 <para>If you leave this blank or enter in an invalid code your patrons will still be
10920 able to register but will not be given a username. There will be no errors on the
10921 page to explain this, so be sure to enter a valid patron category code.</para>
10924 <section id="PatronSelfRegistrationExpireTemporaryAccountsDelay">
10925 <title>PatronSelfRegistrationExpireTemporaryAccountsDelay</title>
10926 <para>Default: 0</para>
10927 <para>Asks: Delete patrons registered via the OPAC, but not yet verified after ___
10929 <para>Description:<itemizedlist>
10931 <para>This prefence links to the <link linkend="deleteexpiredregistrationcron"
10932 >delete_expired_opac_registrations.pl cron job</link>. If that cron is set to
10933 run nightly it will clean up any registrations that have not been verified via
10934 email in the number of days entered on this preference. This is dependent on
10935 <link linkend="PatronSelfRegistrationVerifyByEmail"
10936 >PatronSelfRegistrationVerifyByEmail</link> preference.</para>
10938 </itemizedlist></para>
10940 <section id="PatronSelfRegistrationVerifyByEmail">
10941 <title>PatronSelfRegistrationVerifyByEmail</title>
10942 <para>Default: Don't require</para>
10943 <para>Asks: ___ that a self-registering patron verify his or herself via email.</para>
10944 <para>Values:<itemizedlist>
10946 <para>Don't require</para>
10949 <para>Require</para>
10951 </itemizedlist></para>
10952 <para>Description:<itemizedlist>
10954 <para>If you require patrons to verify their accounts via email they will not be
10955 able to log in to the OPAC until they acknowledge the email sent by Koha. If you
10956 don't require this then patrons will be able to log in as soon as they fill in
10957 the registration form. You can set the <link
10958 linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay"
10959 >PatronSelfRegistrationExpireTemporaryAccountsDelay</link> preference to
10960 delete the un-verified self registrations after a certain number of days.</para>
10962 </itemizedlist><tip>
10963 <para>If you're going to require that patrons verify their accounts via email then
10964 the email field will automatically be marked as required.</para>
10969 <section id="shelfbrowseprefs">
10970 <title>Shelf Browser</title>
10974 <section id="OPACShelfBrowser">
10975 <title>OPACShelfBrowser</title>
10977 <para>Default: Show</para>
10979 <para>Asks: ___ a shelf browser on item details pages, allowing
10980 patrons to see what's near that item on the shelf.</para>
10982 <para>Values:</para>
10986 <para>Don't show</para>
10993 <screeninfo>OPACShelfBrowser</screeninfo>
10997 <imagedata fileref="images/admin/globalprefs/OPACShelfBrowser.png"/>
11004 <para>Description:</para>
11008 <para>This preference allows patrons to view what is located
11009 on the shelf near the item they looked up. The shelf browser
11010 option appears on the details page to the right of each items'
11011 call number. Clicking the 'Browse Shelf' link allows for a
11012 virtual shelf browsing experience via the OPAC and lets
11013 patrons see other books that may relate to their search and
11014 items that sit on the shelf near the item they are looking
11020 <para>This uses up a fairly large amount of resources on your
11021 server, and should be avoided if your collection has a large
11022 number of items.</para>
11026 <section id="ShelfBrowserUsesCcode">
11027 <title>ShelfBrowserUsesCcode</title>
11029 <para>Default: Don't use</para>
11031 <para>Asks: ___ the item collection code when finding items for
11032 the shelf browser.</para>
11034 <para>Values:</para>
11038 <para>Don't use</para>
11046 <para>Description:</para>
11050 <para>If your library uses collection codes then you might
11051 want the shelf browser to take into consideration what
11052 collection the books belong to when populating the virtual
11053 shelf browser.</para>
11058 <section id="ShelfBrowserUsesHomeBranch">
11059 <title>ShelfBrowserUsesHomeBranch</title>
11061 <para>Default: Use</para>
11063 <para>Asks: ___ the item home branch when finding items for the
11064 shelf browser.</para>
11066 <para>Values:</para>
11070 <para>Don't use</para>
11078 <para>Description:</para>
11082 <para>If you have a multiple branch system you may want to
11083 make sure that Koha takes into consideration what branch owns
11084 the books when populating the virtual shelf browser for
11090 <section id="ShelfBrowserUsesLocation">
11091 <title>ShelfBrowserUsesLocation</title>
11093 <para>Default: Use</para>
11095 <para>Asks: ___ the item location when finding items for the shelf
11098 <para>Values:</para>
11102 <para>Don't use</para>
11110 <para>Description:</para>
11114 <para>If your library uses shelving locations then you might
11115 want the shelf browser to take into consideration what
11116 shelving location the books belong to when populating the
11117 virtual shelf browser.</para>
11124 <section id="patronprefs">
11125 <title>Patrons</title>
11127 <para><emphasis>Get there:</emphasis> More > Administration >
11128 Global System Preferences > Patrons</para>
11130 <section id="AddPatronLists">
11131 <title>AddPatronLists</title>
11133 <para>Default: specific categories</para>
11135 <para>Asks: List ___ under the new patron menu.</para>
11137 <para>Values:</para>
11141 <para>general patron types</para>
11144 <screeninfo>Add patron options with AddPatronLists set to
11145 general patron types</screeninfo>
11149 <imagedata fileref="images/admin/globalprefs/AddPatronLists-category.png"/>
11156 <para>specific categories</para>
11159 <screeninfo>Add patron options with AddPatronLists set to
11160 specific categories</screeninfo>
11164 <imagedata fileref="images/admin/globalprefs/AddPatronLists-specific.png"/>
11172 <section id="AutoEmailOPACUser">
11173 <title>AutoEmailOpacUser</title>
11175 <para>Default: Don't send</para>
11177 <para>Asks: ___ an email to newly created patrons with their account
11180 <para>Description:</para>
11184 <para>AutoEmailOpacUser allows library users to be notified by
11185 email of their account details when a new account is opened at
11186 the email address specified in the <link linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
11187 preference. The email contains the username and password given
11188 to or chosen by the patron when signing up for their account and
11189 can be customized by editing the <link linkend="ACCTDETAILS">ACCTDETAILS</link> notice.</para>
11193 <para>Values:</para>
11197 <para>Don't send</para>
11206 <section id="AutoEmailPrimaryAddress">
11207 <title>AutoEmailPrimaryAddress</title>
11209 <para>Default: alternate</para>
11211 <para>Asks: Use ___ patron email address for sending out
11214 <para>Values:</para>
11218 <para>alternate</para>
11222 <para>first valid</para>
11234 <para>Description:</para>
11238 <para>If you choose 'first valid' as the value for
11239 AutoEmailPrimaryAddress the system will check the email fields
11240 in this order: home, work, then alternate. Otherwise the system
11241 will use the email address you specify.</para>
11246 <section id="autoMemberNum">
11247 <title>autoMemberNum</title>
11249 <para>Default: Do</para>
11251 <para>Asks: ___ default the card number field on the patron addition
11252 screen to the next available card number</para>
11254 <para>Values:</para>
11262 <para>If the largest currently used card number is
11263 26345000012941, then this field will default to
11264 26345000012942 for the next patron</para>
11274 <para>Description:</para>
11278 <para>This preference determines if the patron's barcode is
11279 automatically calculated. This prevents the person setting up
11280 the library card account from having to assign a number to the
11281 new card. If set to 'Do' the system will calculate a new patron
11282 barcode by adding 1 to the maximum barcode already present in
11283 the database.</para>
11288 <section id="BorrowerMandatoryField">
11289 <title>BorrowerMandatoryField</title>
11291 <para>Default: surname|cardnumber|barcode</para>
11293 <para>Asks: The following database columns must be filled in on the
11294 patron entry screen: ___</para>
11296 <para>Description:</para>
11300 <para>This preference enables the system administrator to choose
11301 which fields your library would like required for patron
11302 accounts. Enter field names separated by | (bar). This ensures
11303 that basic information is included in each patron record. If a
11304 patron leaves one of the required fields blank an error message
11305 will issue and the account will not be created.</para>
11310 <para>Separate columns with |</para>
11314 <para>For help with field names, ask your system administrator or
11315 <ulink url="http://schema.koha-community.org/tables/borrowers.html">view
11316 the database structure</ulink> associated with the borrowers
11321 <section id="borrowerRelationship">
11322 <title>borrowerRelationship</title>
11324 <para>Default: father|mother</para>
11326 <para>Asks: Guarantors can be the following of those they guarantee
11329 <para>Description:</para>
11333 <para>This preference enables the system administrator to define
11334 valid relationships between a guarantor (usually a parent) &
11335 a guarantee (usually a child). Defining values for this field
11336 does not make the guarantor field required when adding a
11337 guarantee type patron. This preference creates a drop down list
11338 identifying the relationship of the guarantor to the guarantee.
11339 To disable the ability to add children types in Koha you can
11340 leave this field blank.</para>
11345 <para>Input multiple choices separated by |</para>
11349 <section id="BorrowerRenewalPeriodBase">
11350 <title>BorrowerRenewalPeriodBase</title>
11352 <para>Default: current date</para>
11354 <para>Asks: When renewing borrowers, base the new expiry date on
11357 <para>Values:</para>
11361 <para>current date.</para>
11365 <para>current membership expiry date.</para>
11369 <para>Description:</para>
11373 <para>This preference controls what the patron's new expiration
11374 date will be when you renew their card. Using the 'current date'
11375 will add the subscription period to today's date when
11376 calculating the new expiration date. Using 'current membership
11377 expiry date' will add the subscription period to the old
11378 expiration date for the patron when renewing their
11384 <section id="BorrowersTitles">
11385 <title>BorrowersTitles</title>
11387 <para>Default: Mr|Mrs|Miss|Ms</para>
11389 <para>Asks: Borrowers can have the following titles ___</para>
11391 <para>Description:</para>
11395 <para>This preference allows the staff to choose the titles that
11396 can be assigned to patrons. The choices present as a drop down
11397 list when creating a patron record.</para>
11402 <para>Input multiple choices separated by |</para>
11406 <section id="BorrowerUnwantedField">
11407 <title>BorrowerUnwantedField</title>
11409 <para>Asks: The following database columns will not appear on the
11410 patron entry screen: ___</para>
11412 <para>Description:</para>
11416 <para>This preference enables the system administrator to choose
11417 which fields your library doesn't need to see on the patron
11418 entry form. Enter field names separated by | (bar).</para>
11423 <para>Separate columns with |</para>
11427 <para>For help with field names, ask your system administrator or
11428 <ulink url="http://schema.koha-community.org/tables/borrowers.html">view
11429 the database structure</ulink> associated with the borrowers
11434 <section id="checkdigit">
11435 <title>checkdigit</title>
11437 <para>Default: Don't</para>
11439 <para>Asks: ___ check and construct borrower card numbers in the
11440 Katipo style.</para>
11442 <para>Values:</para>
11455 <para>This overrides <link linkend="autoMemberNum">autoMemberNum</link> if on.</para>
11459 <section id="EnableBorrowerFiles">
11460 <title>EnableBorrowerFiles</title>
11462 <para>Default: Don't</para>
11464 <para>Asks: ___ enable the ability to upload and attach arbitrary
11465 files to a borrower record.</para>
11467 <para>Values:</para>
11479 <para>Description:</para>
11483 <para>When enabled this will add a 'Files' tab to the left of
11484 the patron detail page where you can view and upload files to
11485 the patron record.</para>
11490 <section id="EnhancedMessagingPreferences">
11491 <title>EnhancedMessagingPreferences</title>
11493 <para>Default: Allow</para>
11495 <para>Asks: ___ patrons to choose which notices they receive and
11496 when they receive them.</para>
11498 <para>Values:</para>
11506 <para>Don't allow</para>
11511 <para>This only applies to certain kinds of notices, overdue
11512 notices will be sent based on the library's rules, not the
11513 patron's choice.</para>
11516 <para>Description:</para>
11520 <para>These messages are in addition to the overdue notices that
11521 the library sends. The difference between these notices and
11522 overdues is that the patron can opt-in and out of these. Setting
11523 this preference to 'Allow' will allow patrons to choose to
11524 receive any one of the following messages:</para>
11528 <para>Item Checkout : A notice that lists all the of the items the patron has just
11529 checked out and/or renewed, this is an electronic form of the checkout
11534 <para>Item Due : A notice on the day and item is due back at
11539 <para>Hold Filled : A notice when you have confirmed the
11540 hold is waiting for the patron</para>
11544 <para>Item Checkin : A notice that lists all the of the
11545 items the patron has just checked in</para>
11549 <para>Advanced Notice : A notice in advance of the patron's
11550 items being due (The patron can choose the number of days in
11558 <section id="ExtendedPatronAttributes">
11559 <title>ExtendedPatronAttributes</title>
11561 <para>Default: Enable</para>
11563 <para>Asks: ___ searching, editing and display of custom attributes
11566 <para>Values:</para>
11570 <para>Don't enable</para>
11574 <para>Enable</para>
11578 <para>Define attributes in Koha administration</para>
11582 <para>Get there: More > Administration > <link linkend="patronattributetypes">Patron Attribute
11583 Types</link></para>
11589 <para>Description:</para>
11593 <para>Patron attributes are library-defined custom fields that
11594 can be applied to patron records.</para>
11599 <para>Use custom attributes for fields that the default patron
11600 record does not support such as driver's license number or student
11605 <section id="intranetreadinghistory">
11606 <title>intranetreadinghistory</title>
11608 <para>Default: Allow</para>
11610 <para>Asks: ___ staff to access a patron's checkout
11612 <para>If you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference set to
11613 'Allow' and the patron has decided to not have their history
11614 kept staff will only see currently checked out items.</para>
11615 </important></para>
11617 <para>Values:</para>
11625 <para>Don't allow</para>
11630 <para>This data is stored in the system regardless of your
11635 <section id="MaxFine">
11636 <title>MaxFine</title>
11638 <para>Default: 9999</para>
11640 <para>Asks: The late fine for all checkouts will only go up to ___
11643 <para>Description:</para>
11647 <para>This preference controls the default cap on fines accrued
11648 by the patron. Leaving this preference blank means that there is
11649 no cap on the amount of fines a patron can accrue. If you'd
11650 like, single item caps can be specified in the <link linkend="circfinerules">circulation rules matrix</link>.</para>
11655 <section id="memberofinstitution">
11656 <title>memberofinstitution</title>
11658 <para>Default: Don't</para>
11660 <para>Asks: ___ allow patrons to be linked to institutions</para>
11662 <para>Values:</para>
11675 <para>In order to allow this, the library must have Institution
11676 patrons to link members to</para>
11680 <section id="minPasswordLength">
11681 <title>minPasswordLength</title>
11683 <para>Default: 3</para>
11685 <para>Asks: Login passwords for staff and patrons must be at least
11686 ___ characters long.</para>
11689 <para>This applies to both the staff login and the patron OPAC
11694 <section id="NotifyBorrowerDeparture">
11695 <title>NotifyBorrowerDeparture</title>
11697 <para>Default: 30</para>
11699 <para>Asks: Show a notice that a patron is about to expire ___ days
11702 <para>Description:</para>
11706 <para>When the patron attempts to check out materials, a warning
11707 will appear in the check out window of the Staff Client telling
11708 the librarian that the patrons account is about to
11714 <para>This notice will appear on the patron's record in the staff
11719 <section id="patronimages">
11720 <title>patronimages</title>
11722 <para>Default: Allow</para>
11724 <para>Asks: ___ images to be uploaded and shown for patrons on the
11725 staff client.</para>
11727 <para>Values:</para>
11735 <para>Don't allow</para>
11738 <para>Description:<itemizedlist>
11740 <para>If this preference is set to 'Allow' the staff will be able to upload images
11741 of patrons either <link linkend="addpatronimages">one by one</link> or <link
11742 linkend="uploadpatronimages">in bulk</link>. Patrons images will show on the
11743 detail page to the left of the patron information. They can also show in the OPAC
11744 if you set the <link linkend="OPACpatronimage">OPACpatronimage</link> preference
11745 or in the self check out module if you set the <link
11746 linkend="ShowPatronImageInWebBasedSelfCheck"
11747 >ShowPatronImageInWebBasedSelfCheck</link> preference.</para>
11749 </itemizedlist></para>
11752 <section id="PatronsPerPage">
11753 <title>PatronsPerPage</title>
11755 <para>Default: 20</para>
11757 <para>Asks: By default, show ___ results per page in the staff
11759 <para>Description:<itemizedlist>
11761 <para>This preference will let you define how many patrons to show on patron search
11762 results pages.</para>
11764 </itemizedlist></para>
11767 <section id="SMSSendDriver">
11768 <title>SMSSendDriver</title>
11770 <para>Asks: Use the SMS::Send:: ___ driver to send SMS
11773 <para>Some examples of values are:</para>
11777 <para>SMS::Send::Us::Ipipi</para>
11781 <para>SMS::Send::US::TMobile</para>
11785 <para>SMS::Send::US::Verizon</para>
11789 <para>Additional values can be found here: <ulink url="http://search.cpan.org/search?query=sms%3A%3Asend&mode=all">http://search.cpan.org/search?query=sms%3A%3Asend&mode=all
11793 <para>Only drivers available as Perl modules will work in this
11794 preference, so make sure a Perl module is available before
11795 choosing an SMS service.</para>
11798 <para>Once a driver is entered in the preference an option will
11799 appear in the staff client and the OPAC on the patron messaging form
11800 to choose to receive messages as SMS</para>
11803 <screeninfo>SMSSendDriver Options</screeninfo>
11807 <imagedata fileref="images/admin/globalprefs/SMSSendDriver.png"/>
11813 <para>You must allow <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
11814 for this to work.</para>
11818 <section id="StatisticsFields">
11819 <title>StatisticsFields</title>
11821 <para>Default: location|itype|ccode</para>
11823 <para>Asks: Show the following fields from the items database table
11824 as columns on the statistics tab on the patron record: ___</para>
11827 <screeninfo>Statistics on Patron Record</screeninfo>
11831 <imagedata fileref="images/admin/globalprefs/StatisticsFields.png"/>
11837 <para>Enter the values separated by bars (|)</para>
11840 <para>Description:</para>
11844 <para>This preference lets you set which fields will show on the
11845 patron record on the Statistics tab.</para>
11850 <section id="TalkingTechItivaPhoneNotification">
11851 <title>TalkingTechItivaPhoneNotification</title>
11853 <para>Default: Disable</para>
11855 <para>Asks: ___ patron phone notifications using Talking Tech i-tiva
11856 (overdues, predues and holds notices currently supported).</para>
11858 <para>Values:</para>
11862 <para>Disable</para>
11866 <para>Enable</para>
11870 <para>Description:</para>
11874 <para>To learn more about setting up this third party product
11875 view the <link linkend="talkingtechappendix">Talking Tech
11876 Appendix</link>.</para>
11881 <para>Requires that you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
11882 set to Allow to use.</para>
11886 <section id="uppercasesurnames">
11887 <title>uppercasesurnames</title>
11889 <para>Default: Don't</para>
11891 <para>Asks: ___ store and display surnames (last names) in upper
11894 <para>Values:</para>
11908 <section id="searchingprefs">
11909 <title>Searching</title>
11911 <para><emphasis>Get there:</emphasis> More > Administration >
11912 Global System Preferences > Searching</para>
11914 <section id="searchfeatureprefs">
11915 <title>Features</title>
11918 <section id="IncludeSeeFromInSearches">
11919 <title>IncludeSeeFromInSearches</title>
11920 <para>Default: Don't include</para>
11921 <para>Asks: ___ <emphasis role="italic">see from</emphasis> (non-preferred form)
11922 headings in bibliographic searches. </para>
11923 <para>Values:<itemizedlist>
11925 <para>Don't include</para>
11928 <para>Include</para>
11930 </itemizedlist></para>
11931 <para>Description: <itemizedlist>
11933 <para>When this preference is set to include the search engine indexer will insert
11934 <emphasis role="italic">see from</emphasis> headings from authority records
11935 into bibliographic records when indexing, so that a search on an obsolete term
11936 will turn up relevant records. For example when you search for cookery (the old
11937 term) you get titles with the heading of cooking (the new term).</para>
11939 </itemizedlist><important>
11940 <para>You will need to reindex your bibliographic database when changing this
11941 preference. </para>
11942 </important></para>
11945 <section id="OpacGroupResults">
11946 <title>OpacGroupResults</title>
11948 <para>Default: Don't use</para>
11950 <para>Asks: ___ PazPar2 to group similar results on the
11953 <para>Values:</para>
11957 <para>Don't use</para>
11966 <para>This requires that <ulink url="http://www.indexdata.com/pazpar2">PazPar2</ulink> is set up
11967 and running.</para>
11971 <section id="QueryAutoTruncate">
11972 <title>QueryAutoTruncate</title>
11974 <para>Default: automatically</para>
11976 <para>Asks: Perform wildcard searching (where, for example, Har
11977 would match Harry and harp) ___ (The * character would be used
11978 like so: Har* or *logging.)</para>
11980 <para>Values:</para>
11984 <para>automatically</para>
11988 <para>only if * is added</para>
11992 <para>Description:</para>
11996 <para>This setting allows for searches to be automatically
11997 truncated or for additional characters to be added to the end
11998 of a search string. When set to "automatically" the search
11999 string automatically ends with a wildcard function. For
12000 example, a search for the word "invent" with auto truncation
12001 enabled will also retrieve results for inventor, invention,
12002 inventory, etc. If you don't want this to happen automatically
12003 you can still be perform wildcard searches manually by adding
12004 an asterisk (*). Typing "invent*" even with auto truncation
12005 disabled will retrieve the same inventor, invention, inventory
12006 results. Auto truncation bypasses the necessity to type long
12007 search strings in their entirety.</para>
12012 <section id="QueryFuzzy">
12013 <title>QueryFuzzy</title>
12015 <para>Default: Try</para>
12017 <para>Asks: ___ to match similarly spelled words in a search (for
12018 example, a search for flang would also match flange and
12021 <para>Values:</para>
12025 <para>Don't try</para>
12033 <para>Description:</para>
12037 <para>This preference enables "fuzzy" searching, in which the
12038 search engine returns results that are similar to, but not
12039 exactly matching, the word or words entered by the user. This
12040 preference enables the search function to compensate for
12041 slightly misspelled names or phrases.</para>
12046 <para>Requires that <link linkend="UseICU">UseICU</link> set to 'Not using'</para>
12050 <section id="QueryStemming">
12051 <title>QueryStemming</title>
12053 <para>Default: Try</para>
12055 <para>Asks: ___ to match words of the same base in a search</para>
12057 <para>Values:</para>
12061 <para>Don't try</para>
12069 <para>A search for enabling would also match enable and
12076 <para>Description:</para>
12080 <para>This preference enables word stemming. Stemming allows
12081 the search function to return multiple versions of the same
12082 word, as well as related terms (i.e., both fish and fishing
12083 would be returned).</para>
12088 <section id="QueryWeightFields">
12089 <title>QueryWeightFields</title>
12091 <para>Default: Enable</para>
12093 <para>Asks: ___ ranking of search results by relevance</para>
12095 <para>Values:</para>
12099 <para>Disable</para>
12103 <para>Enable</para>
12108 <section id="TraceCompleteSubfields">
12109 <title>TraceCompleteSubfields</title>
12111 <para>Default: Force</para>
12113 <para>Asks: ___ subject tracings in the OPAC and Staff Client to
12114 search only for complete-subfield matches.</para>
12116 <para>Values:</para>
12120 <para>Don't force</para>
12124 <para>Searches for subject keywords (example:
12125 opac-search.pl?q=su:World%20Wide%20Web)</para>
12135 <para>Searches for complete subject fields (example:
12136 opac-search.pl?q=su,complete-subfield:World%20Wide%20Web)</para>
12142 <para>Description:</para>
12146 <para>When TraceCompleteSubfields is set to "force," clicking
12147 on links in non-authority controlled subject tracings will
12148 only find other records where the entire subfields match.
12149 Leaving it at "don't force" does a keyword search of the
12150 subject indexes.</para>
12155 <para>This preference assumes that you're using XSLT stylesheets
12156 as set in the <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
12161 <section id="TraceSubjectSubdivisions">
12162 <title>TraceSubjectSubdivisions</title>
12164 <para>Default: Include</para>
12166 <para>Asks: ___ subdivisions for searches generated by clicking on
12167 subject tracings.</para>
12169 <para>Values:</para>
12173 <para>Don't include</para>
12177 <para>Searches for subject keywords (example:
12178 opac-search.pl?q=su,complete-subfield:%22Web%20sites%22)</para>
12184 <para>Include</para>
12188 <para>Searches for complete subject fields (example:
12189 opac-search.pl?q=(su,complete-subfield:%22Web%20sites%22)%20and%20(su,complete-subfield:%22Design.%22))</para>
12195 <para>Description:</para>
12199 <para>When TraceSubjectSubdivisions is set to "Include," if
12200 you click on a subject with subdivisions (subfields other than
12201 'a') they will be searched along with the subject heading
12202 (subfield 'a'). To have only the subject heading (subfield
12203 'a') searched, set this preference to "Don't include."</para>
12208 <para>This preference assumes that you're using XSLT stylesheets
12209 as set in the <link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>
12214 <section id="UseICU">
12215 <title>UseICU</title>
12217 <para>Default: Not using</para>
12219 <para>Asks: ___ ICU Zebra indexing.</para>
12221 <para>Values:</para>
12225 <para>Not using</para>
12233 <para>Description:</para>
12237 <para>ICU is a set of code libraries providing Unicode and
12238 Globalization support for software applications. What this
12239 means is ICU Zebra indexing is only necessary if you use
12240 non-roman characters in your cataloging. If using ICU Zebra
12241 indexing you will want to not use <link linkend="QueryFuzzy">QueryFuzzy</link>.</para>
12246 <para>This setting will not affect Zebra indexing, it should
12247 only be used to tell Koha that you have activated ICU indexing
12248 if you have actually done so, since there is no way for Koha to
12249 figure this out on its own.</para>
12253 <para>Talk to your system administrator when changing this
12254 preference to make sure that your system is set up properly for
12255 this to work.</para>
12258 <section id="UseQueryParser">
12259 <title>UseQueryParser</title>
12260 <para>Default: Do not try</para>
12261 <para>Asks: ___ to use the QueryParser module for parsing queries. <note>
12262 <para>Enabling this will have no impact if you do not have QueryParser installed,
12263 and everything will continue to work as usual.</para>
12265 <para>Values:<itemizedlist>
12267 <para>Do not try</para>
12272 </itemizedlist></para>
12273 <para>Description:<itemizedlist>
12275 <para>This preference enables an experimental new query parser which opens the
12276 door for a more expressive and more-effective search syntax.</para>
12278 </itemizedlist></para>
12282 <section id="searchresultsprefs">
12283 <title>Results Display</title>
12287 <section id="defaultSortField">
12288 <title>defaultSortField & defaultSortOrder</title>
12290 <para>defaultSortField Default: author</para>
12292 <para>defaultSortOrder Default: ascending</para>
12294 <para>Asks: By default, sort search results in the staff client by
12297 <para>Description:</para>
12301 <para>These preferences set the default sort field and sort
12302 order for searches on the staff side. Regardless of your
12303 choice, the other sort options are still available in the drop
12304 down list on the advanced search page.</para>
12308 <para>defaultSortField Values:</para>
12312 <para>author</para>
12316 <para>call number</para>
12320 <para>date added</para>
12324 <para>date of publication</para>
12328 <para>relevance</para>
12336 <para>total number of checkouts</para>
12340 <para>defaultSortOrder Values:</para>
12344 <para>ascending</para>
12348 <para>descending</para>
12352 <para>from A to Z</para>
12356 <para>from Z to A</para>
12361 <section id="displayFacetCount">
12362 <title>displayFacetCount</title>
12364 <para>Default: Don't show</para>
12366 <para>Asks: ___ facet counts.</para>
12368 <para>Description:</para>
12372 <para>This preference lets you decide if you show how many
12373 times a facet is used in your search results in the OPAC and
12374 the staff client. The relevance of these numbers highly
12375 depends on the value of the <link linkend="maxRecordsForFacets">maxRecordsForFacets</link>
12376 preference. Showing these numbers can potentially effect the
12377 performance of your searching, so test your system with
12378 different values for this preference to see what works
12383 <para>Values:</para>
12387 <para>Don't show</para>
12394 <screeninfo>Number of times each Facet is found in
12395 results</screeninfo>
12399 <imagedata fileref="images/admin/globalprefs/displayFacetCount.png"/>
12407 <section id="FacetLabelTruncationLength">
12408 <title>FacetLabelTruncationLength</title>
12410 <para>Default: 20</para>
12412 <para>Asks: Truncate facets length to ___ characters, in
12413 OPAC/staff interface.</para>
12415 <para>Description:</para>
12419 <para>In the OPAC and the staff client your facets are cut off
12420 at 20 characters by default. Depending on your layout this may
12421 be too many or two few letters, this preference lets you
12422 decide what number is best for your library's design.</para>
12427 <section id="maxItemsInSearchResults">
12428 <title>maxItemsInSearchResults</title>
12430 <para>Default: 20</para>
12432 <para>Asks: Show up to ___ items per biblio in the search
12435 <para>Description:</para>
12439 <para>This preference will let you set how many results
12440 display by default when a search is run on the Staff
12446 <section id="maxRecordsForFacets">
12447 <title>maxRecordsForFacets</title>
12449 <para>Default: 20</para>
12451 <para>Asks: Build facets based on ___ records from the search
12454 <para>Description:</para>
12458 <para>By default Koha only bases facets on the first page of
12459 results (usually 20 results). This preference lets you tell
12460 Koha to based the facet descriptions and numbers on any number
12461 of search results returned. The higher this number the longer
12462 it will take for your search results to return, so test with
12463 various different values to find the best balance for your
12469 <section id="numSearchResults">
12470 <title>numSearchResults</title>
12472 <para>Default: 20</para>
12474 <para>Asks: By default, show ___ results per page in the staff
12478 <section id="opacdefaultsort">
12479 <title>OPACdefaultSortField & OPACdefaultSortOrder</title>
12481 <para>OPACdefaultSortField Default: relevance</para>
12483 <para>OPACdefaultSortOrder Default: ascending</para>
12485 <para>Asks: By default, sort search results in the OPAC by ___,
12488 <para>Description:</para>
12492 <para>These preferences set the default sort field and sort
12493 order for searches on the OPAC. Regardless of your choice, the
12494 other sort options are still available in the drop down list
12495 on the advanced search page.</para>
12499 <para>OPACdefaultSortField Values:</para>
12503 <para>author</para>
12507 <para>call number</para>
12511 <para>date added</para>
12515 <para>date of publication</para>
12519 <para>relevance</para>
12527 <para>total number of checkouts</para>
12531 <para>OPACdefaultSortOrder Values:</para>
12535 <para>ascending</para>
12539 <para>descending</para>
12543 <para>from A to Z</para>
12547 <para>from Z to A</para>
12554 <section id="OPACItemsResultsDisplay">
12555 <title>OPACItemsResultsDisplay</title>
12557 <para>Default: Don't show</para>
12559 <para>Asks: ___ an item's branch, location and call number in OPAC
12560 search results.</para>
12562 <para>Values:</para>
12566 <para>Don't show</para>
12574 <para>Description:</para>
12578 <para>This setting selects the information about an item that
12579 will display in the search results page of the OPAC. The
12580 results can display the status of an item and/or full details
12581 including branch, location, and call number. While the 'Show'
12582 option allows for more information to be displayed on the
12583 search results page, the information can be overwhelming for
12584 large collections with multiple branches.</para>
12589 <section id="OPACnumSearchResults">
12590 <title>OPACnumSearchResults</title>
12592 <para>Default: 20</para>
12594 <para>Asks: By default, show ___ results per page in the
12599 <section id="searchformprefs">
12600 <title>Search Form</title>
12602 <section id="AdvancedSearchTypes">
12603 <title>AdvancedSearchTypes</title>
12605 <para>Default: itemtype</para>
12607 <para>Asks: Show tabs in OPAC and staff-side advanced search for
12608 limiting searches on the ___ fields (separate values with
12611 <para>Description:</para>
12615 <para>On the advanced search page you can choose to allow
12616 filters on one or all of the following: Item types
12617 (itemtypes), Collection Codes (ccode) and Shelving Location
12618 (loc). If you would like to be able to limit searches on item
12619 type and shelving location for example you would enter
12620 itemtypes|loc in the preference input box. The order of these
12621 fields will determine the order of the tabs in the OPAC and
12622 staff client advanced search screens. Values within the search
12623 type are OR'ed together, while each different search type is
12624 AND'ed together in the query limits. The current stored values
12625 are supported without any required modification.Each set of
12626 advanced search fields are displayed in tabs in both the OPAC
12627 and staff client. The first value in the AdvancedSearchTypes
12628 syspref is the selected tab; if no values are present,
12629 "itemtypes" is used. For non-itemtype values, the value in
12630 AdvancedSearchTypes must match the Authorised Value name, and
12631 must be indexed with 'mc-' prefixing that name.</para>
12634 <screeninfo>Searching by Item Type and Shelving
12635 Location</screeninfo>
12639 <imagedata fileref="images/admin/globalprefs/AdvancedSearchTypes.png"/>
12647 <section id="expandedSearchOption">
12648 <title>expandedSearchOption</title>
12650 <para>Default: don't show</para>
12652 <para>Asks: By default, ___ "More options" on the OPAC and staff
12653 advanced search pages.</para>
12655 <para>Values:</para>
12659 <para>don't show</para>
12667 <section id="IntranetNumbersPreferPhrase">
12668 <title>IntranetNumbersPreferPhrase</title>
12669 <para>Default: don't use</para>
12670 <para>Asks: By default, ___ the operator "phr" in the callnumber and standard number
12671 staff client searches </para>
12672 <para>Values:<itemizedlist>
12674 <para>don't use</para>
12679 </itemizedlist></para>
12680 <para>Description:<itemizedlist>
12682 <para>When searching by call number and standard number (biblionumber) in Koha
12683 Staff Client you can choose to force the search to be a phrase search by setting
12684 this preference to 'use.' This will allow for more accurate results over doing a
12685 general keyword field search.</para>
12687 </itemizedlist></para>
12689 <section id="OPACNumbersPreferPhrase">
12690 <title>OPACNumbersPreferPhrase</title>
12691 <para>Default: don't use</para>
12692 <para>Asks: By default, ___ the operator "phr" in the callnumber and standard number
12693 OPAC searches </para>
12694 <para>Values:<itemizedlist>
12696 <para>don't use</para>
12701 </itemizedlist></para>
12702 <para>Description:<itemizedlist>
12704 <para>When searching by call number and standard number (biblionumber) in the Koha
12705 OPAC you can choose to force the search to be a phrase search by setting this
12706 preference to 'use.' This will allow for more accurate results over doing a
12707 general keyword field search.</para>
12709 </itemizedlist></para>
12714 <section id="serialsprefs">
12715 <title>Serials</title>
12717 <para><emphasis>Get there:</emphasis> More > Administration >
12718 Global System Preferences > Serials</para>
12720 <section id="opacSerialDefaultTab">
12721 <title>opacSerialDefaultTab</title>
12723 <para>Default: Subscriptions tab</para>
12725 <para>Asks: Show ___ as default tab for serials in OPAC. </para>
12727 <para>Values:</para>
12731 <para>Holdings tab</para>
12735 <para>Serial Collection tab</para>
12737 <para>Please note that the Serial Collection tab is currently available only for
12738 systems using the UNIMARC standard.</para>
12741 <screeninfo>Serial Collection tab</screeninfo>
12744 <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-colltab.png"/>
12751 <para>Subscriptions tab</para>
12753 <screeninfo>Subscritions tab</screeninfo>
12756 <imagedata fileref="images/admin/globalprefs/opacSerialDefaultTab-subtab.png"
12765 <section id="OPACSerialIssueDisplayCount">
12766 <title>OPACSerialIssueDisplayCount</title>
12768 <para>Default: 3</para>
12770 <para>Asks: Show the ___ previous issues of a serial on the
12773 <para>Description:</para>
12777 <para>This preference allows the administrator to select the
12778 number of recent issues for each serial which appear in the OPAC
12779 when the serial is accessed. This is just the default value,
12780 patrons can always click to see a full list of serials.</para>
12785 <section id="RenewSerialAddsSuggestion">
12786 <title>RenewSerialAddsSuggestion</title>
12788 <para>Default: Don't add</para>
12790 <para>Asks: ___ a suggestion for a biblio when its attached serial
12793 <para>Values:</para>
12801 <para>Don't add</para>
12805 <para>Description:</para>
12809 <para>If set to "Add", this preference will automatically add a
12810 serial to the Acquisitions Purchase Suggestions menu when
12811 clicking the 'renew' option. If you don't use the Acquisitions
12812 module to manage serials purchases it's best to leave this set
12813 as 'Don't add.'</para>
12818 <section id="RoutingListAddReserves">
12819 <title>RoutingListAddReserves</title>
12821 <para>Default: Place</para>
12823 <para>Asks: ___ received serials on hold if they are on a routing
12826 <para>Values:</para>
12834 <para>Don't place</para>
12839 <section id="RoutingListNote">
12840 <title>RoutingListNote</title>
12842 <para>Asks: Include following note on all routing lists</para>
12844 <para>Description:</para>
12848 <para>Text entered in this box will appear below the routing
12849 list information.</para>
12854 <section id="RoutingSerials">
12855 <title>RoutingSerials</title>
12857 <para>Default: Don't add</para>
12859 <para>Asks: ___ received serials to the routing list.</para>
12861 <para>Description:</para>
12865 <para>This preference determines if serials routing lists are
12866 enabled or disabled for the library. When set to "Add", serials
12867 routing is enabled and a serial can be directed through a list
12868 of people by identifying who should receive it next. The list of
12869 people can be established for each serial to be passed using the
12870 Serials module. This preference can be used to ensure each
12871 person who needs to see a serial when it arrives at the library
12872 will get it. Learn more in the <link linkend="routinglist">routing list</link> section of this
12877 <para>Values:</para>
12885 <para>Don't add</para>
12890 <section id="StaffSerialIssueDisplayCount">
12891 <title>StaffSerialIssueDisplayCount</title>
12893 <para>Default: 3</para>
12895 <para>Asks: Show the ___ previous issues of a serial on the staff
12898 <para>Description:</para>
12902 <para>This preference allows the administrator to select the
12903 number of recent issues for each serial which appear in the
12904 Staff Client when the serial is accessed. This is just the
12905 default value, staff members can always click to see a full list
12911 <section id="SubscriptionDuplicateDroppedInput">
12912 <title>SubscriptionDuplicateDroppedInput</title>
12914 <para>Asks: List of fields which must not be rewritten when a
12915 subscription is duplicated (Separated by pipe |) ___</para>
12917 <para>Description:</para>
12921 <para>When duplicating a subscription sometimes you don't want
12922 all of the fields duplicated, using this preference you can list
12923 the fields that you don't want to be duplicated. These field
12924 names come from the subscription table in the Koha database.
12925 Learn what fields are in that table on the <ulink url="http://schema.koha-community.org/tables/subscription.html">Koha
12926 DB Schema</ulink> site.</para>
12931 <section id="SubscriptionHistory">
12932 <title>SubscriptionHistory</title>
12934 <para>Default: full history</para>
12936 <para>Asks: When showing the subscription information for a
12937 bibliographic record, preselect ___ view of serial issues.</para>
12939 <para>Values:</para>
12943 <para>brief history</para>
12946 <screeninfo>Brief History</screeninfo>
12950 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-brief.png"/>
12957 <para>full history</para>
12960 <screeninfo>Full History</screeninfo>
12964 <imagedata fileref="images/admin/globalprefs/SubscriptionHistory-full.png"/>
12971 <para>Description:</para>
12975 <para>This preference determines what information appears in the
12976 OPAC when the user clicks the More Details option. The 'brief'
12977 option displays a one-line summary of the volume and issue
12978 numbers of all issues of that serial held by the library. The
12979 'full' option displays a more detailed breakdown of issues per
12980 year, including information such as the issue date and the
12981 status of each issue.</para>
12987 <section id="staffprefs">
12988 <title>Staff Client</title>
12990 <para><emphasis>Get there:</emphasis> More > Administration >
12991 Global System Preferences > Staff Client</para>
12993 <section id="staffappearprefs">
12994 <title>Appearance</title>
12998 <section id="Display856uAsImage">
12999 <title>Display856uAsImage</title>
13001 <para>Default: Neither details or results page</para>
13003 <para>Asks: Display the URI in the 856u field as an image on:
13006 <para>Values:</para>
13010 <para>Both results and details pages</para>
13015 <para>Not implemented yet</para>
13022 <para>Detail page only</para>
13027 <para><link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>
13028 needs to be on for this preference to work.</para>
13034 <screeninfo>Showing the 856u as an image</screeninfo>
13038 <imagedata fileref="images/admin/globalprefs/Display856uAsImage.png"/>
13045 <para>Neither details or results page</para>
13049 <para>Results page only</para>
13054 <para>Not yet implemented</para>
13061 <para>Description:</para>
13065 <para>In addition to this option being set, the corresponding
13066 XSLT option must be turned on. Also, the corresponding 856q
13067 field must have a valid MIME image extension (e.g., "jpg") or
13068 MIME image type (i.e. starting with "image/"), or the generic
13069 indicator "img" entered in the field. When all of the
13070 requirements are met, an image file will be displayed instead
13071 of the standard link text. Clicking on the image will open it
13072 in the same way as clicking on the link text. When you click
13073 on the image it should open to full size, in the current
13074 window or in a new window depending on the value in the system
13075 pref <link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link>.</para>
13078 <screeninfo>Sample 856 Field</screeninfo>
13082 <imagedata fileref="images/admin/globalprefs/856imagemarc.png"/>
13089 <section id="DisplayIconsXSLT">
13090 <title>DisplayIconsXSLT</title>
13091 <para>Default: Show</para>
13092 <para>Asks: ___ the format, audience, and material type icons in XSLT MARC21 results and
13093 detail pages in the staff client.<important>
13094 <para><link linkend="XSLTResultsDisplay">XSLTResultsDisplay</link> and/or <link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link> must be set to use an
13095 XSLT stylesheet (default or custom) for these icons to show.</para>
13096 </important></para>
13097 <para>Values:</para>
13100 <para>Don't show</para>
13105 <screeninfo>DisplayIconsXSLT</screeninfo>
13108 <imagedata fileref="images/admin/globalprefs/DisplayIconsXSLT.png"/>
13116 <para>See the <link linkend="XSLTiTypes">XSLT Icon Guide</link> for more information
13117 on these icons.</para>
13122 <section id="intranet_includes">
13123 <title>intranet_includes</title>
13125 <para>Default: includes</para>
13127 <para>Asks: Use include files from the ___ directory in the
13128 template directory, instead of includes/. (Leave blank to
13132 <section id="intranetcolorstylesheet">
13133 <title>intranetcolorstylesheet</title>
13135 <para>Asks: Include the additional CSS stylesheet ___ to override specified settings
13136 from the default stylesheet</para>
13138 <para>Description:</para>
13142 <para>This preference is used to set the background color and style of the Staff
13143 Client. The value is a .css file. The system administrator should determine which
13144 file is appropriate. Enter just a filename, a full local path or a complete URL
13145 starting with http:// (if the file lives on a remote server). Please note that if
13146 you just enter a filename, the file should be in the css subdirectory for each
13147 active theme and language within the Koha templates directory. A full local path
13148 is expected to start from your HTTP document root. </para>
13153 <para>Leave this field blank to disable.</para>
13157 <section id="IntranetFavicon">
13158 <title>IntranetFavicon</title>
13160 <para>Asks: Use the image at ___ for the Staff Client's favicon.
13162 <para>This should be a complete URL, starting with
13164 </important></para>
13167 <para>Turn your logo into a favicon with the <ulink url="http://antifavicon.com/">Favicon Generator</ulink>.</para>
13170 <para>Description:</para>
13174 <para>The favicon is the little icon that appears next to the
13175 URL in the address bar in most browsers. The default value for
13176 this field (if left blank) is the small 'K' in the Koha
13180 <screeninfo>Default Koha Favicon</screeninfo>
13184 <imagedata fileref="images/admin/globalprefs/favicon.png"/>
13192 <section id="IntranetmainUserblock">
13193 <title>IntranetmainUserblock</title>
13195 <para>Asks: Show the following HTML in its own column on the main
13196 page of the staff client</para>
13199 <screeninfo>Sample HTML for IntranetmainUserblock</screeninfo>
13203 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock-html.png"/>
13209 <screeninfo>Message from IntranetmainUserblock as it appears on
13210 the Staff Client main page</screeninfo>
13214 <imagedata fileref="images/admin/globalprefs/IntranetmainUserblock.png"/>
13220 <section id="IntranetNav">
13221 <title>IntranetNav</title>
13223 <para>Asks: Show the following HTML in the More menu at the top of
13224 each page on the staff client (should be a list of links or
13228 <section id="IntranetSlipPrinterJS">
13229 <title>IntranetSlipPrinterJS</title>
13231 <para>Asks: Use the following JavaScript for printing
13234 <para>Description:</para>
13238 <para>The most logical use of this preference is in
13239 conjunction with the <ulink url="http://jsprintsetup.mozdev.org/">jsPrintSetup</ulink>
13240 Firefox add-on. Learn more about this preference and the
13241 add-on setup on the Koha wiki at <ulink url="http://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently">http://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently</ulink>.</para>
13246 <section id="intranetstylesheet">
13247 <title>intranetstylesheet</title>
13249 <para>Asks: Use the CSS stylesheet ___ on all pages in the staff interface, instead of
13250 the default css (used when leaving this field blank). </para>
13252 <para>Description:</para>
13256 <para>The Intranetstylesheet preference is a layout and design feature for the
13257 intranet or staff client. This preference allows a library to customize the
13258 appearance of the Staff Client. Enter just a filename, a full local path or a
13259 complete URL starting with http:// (if the file lives on a remote server). Please
13260 note that if you just enter a filename, the file should be in the css subdirectory
13261 for each active theme and language within the Koha templates directory. A full
13262 local path is expected to start from your HTTP document root. </para>
13267 <section id="IntranetUserCSS">
13268 <title>IntranetUserCSS</title>
13270 <para>Asks: Include the following CSS on all pages in the staff
13274 <section id="intranetuserjs">
13275 <title>intranetuserjs</title>
13277 <para>Asks: Include the following JavaScript on all pages in the
13278 staff interface</para>
13280 <para>Description:</para>
13284 <para>This preference allows the administrator to enter
13285 JavaScript or JQuery that will be embedded across all pages of
13286 the Staff Client. Administrators may use this preference to
13287 customize some of the interactive sections of Koha,
13288 customizing the text for the login prompts, for example.
13289 Sample JQuery scripts used by Koha libraries can be found on
13290 the wiki: <ulink url="http://wiki.koha-community.org/wiki/JQuery_Library">http://wiki.koha-community.org/wiki/JQuery_Library</ulink>.</para>
13295 <section id="SlipCSS">
13296 <title>SlipCSS</title>
13298 <para>Asks: Include the stylesheet at ___ on Issue and Reserve
13300 <para>This should be a complete URL, starting with
13302 </important></para>
13304 <para>Description:</para>
13308 <para>If you would like to style your receipts or slips with a
13309 consistent set of fonts and colors you can use this preference
13310 to point Koha to a stylesheet specifically for your
13316 <section id="StaffAuthorisedValueImages">
13317 <title>StaffAuthorisedValueImages</title>
13319 <para>Default: Show</para>
13321 <para>Asks: ___ images for authorized values (such as lost
13322 statuses and locations) in search results.</para>
13324 <para>Values:</para>
13328 <para>Don't show</para>
13337 <section id="staffClientBaseURL">
13338 <title>staffClientBaseURL</title>
13340 <para>Asks: The staff client is located at http:// ___</para>
13343 <section id="template">
13344 <title>template</title>
13346 <para>Default: prog</para>
13348 <para>Asks: Use the ___ theme on the staff interface.</para>
13350 <para>Values:</para>
13358 <para>Do not include a trailing slash in the URL this will break links created using
13359 this URL. (example: www.google.com not www.google.com/)</para>
13363 <section id="XSLTDetailsDisplay">
13364 <title>XSLTDetailsDisplay</title>
13366 <para>Default: default</para>
13368 <para>Asks: Display details in the staff client using XSLT
13369 stylesheet at ___</para>
13371 <para>Values:</para>
13375 <para>leave empty to not use the XSLT stylesheet</para>
13379 <para>In previous versions of Koha this was the setting
13380 that read 'normally'</para>
13383 <screeninfo>Detail display without XSLT
13384 stylesheets</screeninfo>
13388 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-off.png"/>
13397 <para>enter "default" for the default one</para>
13400 <screeninfo>Detail display using XSLT
13401 stylesheets</screeninfo>
13405 <imagedata fileref="images/admin/globalprefs/XSLTDetailsDisplay-on.png"/>
13412 <para>put a path to define a XSLT file</para>
13416 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
13420 <para>If in a multi-language system you can enter
13421 {langcode} in the path to tell Koha to look in the right
13422 language folder</para>
13427 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
13432 http://mykoha.org/{langcode}/stylesheet.xsl</para>
13440 <para>put an URL for an external specific stylesheet</para>
13444 <para>ex: http://mykoha.org/stylesheet.xsl</para>
13450 <para>Description:</para>
13454 <para>XSLT stylesheets allow for the customization of the
13455 details shows on the screen when viewing a bib record. This
13456 preference will allow you either use the default look that
13457 comes with Koha or design your own stylesheet.</para>
13462 <section id="XSLTResultsDisplay">
13463 <title>XSLTResultsDisplay</title>
13465 <para>Default: default</para>
13467 <para>Asks: Display results in the staff client using XSLT
13468 stylesheet at ___</para>
13470 <para>Values:</para>
13474 <para>leave empty to not use the XSLT stylesheet</para>
13478 <para>In previous versions of Koha this was the setting
13479 that read 'normally'</para>
13485 <para>enter "default" for the default one</para>
13489 <para>put a path to define a XSLT file</para>
13493 <para>ex: /path/to/koha/and/your/stylesheet.xsl</para>
13497 <para>If in a multi-language system you can enter
13498 {langcode} in the path to tell Koha to look in the right
13499 language folder</para>
13504 /home/koha/src/koha-tmpl/intranet-tmpl/prog/{langcode}/xslt/intranetDetail.xsl</para>
13509 http://mykoha.org/{langcode}/stylesheet.xsl</para>
13517 <para>put an URL for an external specific stylesheet</para>
13521 <para>ex: http://mykoha.org/stylesheet.xsl</para>
13527 <para>Description:</para>
13531 <para>XSLT stylesheets allow for the customization of the
13532 details shows on the screen when viewing the search results.
13533 This preference will allow you either use the default look
13534 that comes with Koha or design your own stylesheet.</para>
13539 <section id="yuipath">
13540 <title>yuipath</title>
13542 <para>Default: included with Koha</para>
13544 <para>Asks: Use the Yahoo UI libraries ___</para>
13546 <para>Values:</para>
13550 <para>from Yahoo's servers</para>
13554 <para>With this option there is less demand on your
13555 servers, but if the Internet goes down there will be
13562 <para>included with Koha</para>
13566 <para>With this option calls are made faster, and they
13567 will still work if the Internet goes down</para>
13573 <para>Description:</para>
13577 <para>The yuipath preference allows for the user to define a
13578 local path or web URL to the Yahoo User Interface Library
13579 (<ulink url="http://developer.yahoo.com/yui/2/">http://developer.yahoo.com/yui/2/</ulink>).
13580 This library is a resource of developer tools including
13581 JavaScript and style sheets.</para>
13587 <section id="staffoptsprefs">
13588 <title>Options</title>
13590 <section id="HidePatronName">
13591 <title>HidePatronName</title>
13593 <para>Default: Show</para>
13595 <para>Asks: ___ the names of patrons that have items checked out
13596 or on hold on detail pages or the "Place Hold" screen.</para>
13598 <para>Values:</para>
13602 <para>Don't show</para>
13611 <section id="intranetbookbag">
13612 <title>intranetbookbag</title>
13614 <para>Default: Show</para>
13616 <para>Asks: ___ the cart option in the staff client.</para>
13618 <para>Values:</para>
13622 <para>Don't show</para>
13630 <section id="StaffDetailItemSelection ">
13631 <title>StaffDetailItemSelection</title>
13632 <para>Default: Enable</para>
13633 <para>Asks: ___ item selection in record detail page. </para>
13634 <para>Values:<itemizedlist>
13636 <para>Disable</para>
13639 <para>Enable</para>
13641 </itemizedlist></para>
13642 <para>Description:<itemizedlist>
13644 <para>This preference lets you choose to show (or not show) checkboxes to the left
13645 of every item in the holdings tab on the detail display of a record in the staff
13646 client. Showing these checkboxes allows the staff members to select multiple
13647 items to edit or delete at once.</para>
13649 <screeninfo>Items with the checkboxes enabled</screeninfo>
13652 <imagedata fileref="images/admin/globalprefs/StaffDetailItemSelection.png"
13658 </itemizedlist></para>
13661 <section id="viewISBD">
13662 <title>viewISBD</title>
13664 <para>Default: Allow</para>
13666 <para>Asks: ___ staff to view records in ISBD form on the staff
13669 <para>Values:</para>
13677 <para>Don't allow</para>
13682 <section id="viewLabeledMARC">
13683 <title>viewLabeledMARC</title>
13685 <para>Default: Allow</para>
13687 <para>Asks: ___ staff to view records in labeled MARC form on the
13688 staff client.</para>
13690 <para>Values:</para>
13698 <para>Don't allow</para>
13703 <section id="viewMARC">
13704 <title>viewMARC</title>
13706 <para>Default: Allow</para>
13708 <para>Asks: ___ staff to view records in plain MARC form on the
13709 staff client.</para>
13711 <para>Values:</para>
13719 <para>Don't allow</para>
13726 <section id="webserviceprefs">
13727 <title>Web Services</title>
13729 <para><emphasis>Get there:</emphasis> More > Administration >
13730 Global System Preferences > Web Services</para>
13732 <section id="ilsdiprefs">
13733 <title>ILS-DI</title>
13737 <section id="ILS-DI">
13738 <title>ILS-DI</title>
13740 <para>Default: Disable</para>
13742 <para>Asks: ___ ILS-DI services for OPAC users</para>
13744 <para>Values:</para>
13748 <para>Disable</para>
13752 <para>Enable</para>
13757 <section id="ILS-DIAuthorized_IPs">
13758 <title>ILS-DI:AuthorizedIPs</title>
13760 <para>Asks: ___ allowed IPs to use the ILS-DI services</para>
13764 <section id="oaiprefs">
13765 <title>OAI-PMH</title>
13769 <section id="OAI-PMH">
13770 <title>OAI-PMH</title>
13772 <para>Default: Disable</para>
13774 <para>Asks: ___ Koha's OAI-PMH server.</para>
13776 <para>Values:</para>
13780 <para>Disable</para>
13784 <para>Enable</para>
13788 <para>Description:</para>
13792 <para>For the Open Archives Initiative-Protocol for Metadata
13793 Harvesting (OAI-PMH) there are two groups of 'participants':
13794 Data Providers and Service Providers. Data Providers (open
13795 archives, repositories) provide free access to metadata, and
13796 may, but do not necessarily, offer free access to full texts
13797 or other resources. OAI-PMH provides an easy to implement, low
13798 barrier solution for Data Providers. Service Providers use the
13799 OAI interfaces of the Data Providers to harvest and store
13800 metadata. Note that this means that there are no live search
13801 requests to the Data Providers; rather, services are based on
13802 the harvested data via OAI-PMH. Koha at present can only act
13803 as a Data Provider. It can not harvest from other
13804 repositories. The biggest stumbling block to having Koha
13805 harvest from other repositories is that MARC is the only
13806 metadata format that Koha indexes natively. Visit <ulink url="http://www.oaforum.org/tutorial/english/page3.htm">http://www.oaforum.org/tutorial/english/page3.htm</ulink>
13807 for diagrams of how OAI-PMH works.</para>
13811 <para>Learn more about OAI-PMH at: <ulink url="http://www.openarchives.org/pmh/">http://www.openarchives.org/pmh/</ulink></para>
13814 <section id="OAI-PMHarchiveID">
13815 <title>OAI-PMH:archiveID</title>
13817 <para>Default: KOHA-OAI-TEST</para>
13819 <para>Asks: Identify records at this site with the prefix ___
13823 <section id="OAI-PMHAutoUpdateSets">
13824 <title>OAI-PMH:AutoUpdateSets</title>
13826 <para>Default: Disable</para>
13828 <para>Asks: ___ automatic update of OAI-PMH sets when a
13829 bibliographic record is created or updated.</para>
13831 <para>Values:</para>
13835 <para>Disable</para>
13839 <para>Enable</para>
13844 <section id="OAI-PMHConfFile">
13845 <title>OAI-PMH:ConfFile</title>
13847 <para>If this preference is left empty, Koha's OAI Server operates
13848 in normal mode, otherwise it operates in extended mode. In
13849 extended mode, it's possible to parameter other formats than
13850 marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML
13851 configuration file which list available metadata formats and XSL
13852 file used to create them from marcxml records.</para>
13854 <para>For more information, see the <link linkend="oaiconfsample">sample conf file</link> in the
13858 <section id="OAI-PMHMaxCount">
13859 <title>OAI-PMH:MaxCount</title>
13861 <para>Default: 50</para>
13863 <para>Asks: Only return ___ records at a time in response to a
13864 ListRecords or ListIdentifiers query.</para>
13866 <para>Description:</para>
13870 <para>This is the maximum number of records that would be
13871 returned based on ListRecord or ListIdentifier queries from
13872 harvesters. ListRecords harvest the entire records while the
13873 ListIdentifier is an abbreviated form of ListRecords,
13874 retrieving only headers rather than records.</para>
13879 <section id="reportingservice">
13880 <title>Reporting</title>
13881 <section id="SvcMaxReportRows">
13882 <title>SvcMaxReportRows</title>
13883 <para>Default: 10</para>
13884 <para>Asks: Only return ___ rows of a report requested via the reports web
13886 <para>Description:<itemizedlist>
13888 <para>This value will be used to limit the number of results returned by <link linkend="publicreport">public reports</link>.</para>
13890 </itemizedlist></para>
13896 <section id="basicparams">
13897 <title>Basic Parameters</title>
13899 <para><emphasis>Get there:</emphasis> More > Administration</para>
13902 <para>Configure all 'parameters' in the order they appear.</para>
13905 <section id="libsgroups">
13906 <title>Libraries & Groups</title>
13908 <para>When setting up your Koha system you will want to add
13909 information for every library that will be sharing your system. This
13910 data is used in several areas of Koha.</para>
13914 <para><emphasis>Get there:</emphasis> More > Administration
13915 > Basic Parameters > Libraries and Groups</para>
13919 <para>When visiting this page you are presented with a list of the
13920 libraries and groups that have already been added to the
13924 <screeninfo>Library List</screeninfo>
13928 <imagedata fileref="images/admin/basicparams/librarylist.png"/>
13934 <screeninfo>Group Lists</screeninfo>
13938 <imagedata fileref="images/admin/basicparams/grouplists.png"/>
13943 <section id="addingalibrary">
13944 <title>Adding a Library</title>
13946 <para>To add a new library:</para>
13950 <para>Click 'New Library'</para>
13954 <para>The top of the form asks for some basics about the
13958 <screeninfo>Basic Library Info</screeninfo>
13962 <imagedata fileref="images/admin/basicparams/newlibrary.png"/>
13969 <para>The library code should not contain any spaces and be
13970 10 or fewer characters. This code will be used as a unique
13971 identifier in the database.</para>
13975 <para>The name will be displayed on the OPAC wherever the
13976 library name displays to the public and should be a name
13977 that makes sense to your patrons.</para>
13981 <para>If you have <link linkend="addinglibgroup">groups</link> set up you can choose
13982 what group this library belongs to after entering in the
13983 code and name</para>
13989 <para>Next you can enter basic contact info about the
13993 <screeninfo>Library Contact Info</screeninfo>
13997 <imagedata fileref="images/admin/basicparams/librarycontact.png"/>
14004 <para>The address and contact fields can be used to make
14005 notices custom for each library</para>
14009 <para>The email address field is not required, but it should
14010 be filled for every library in your system</para>
14015 <para>Be sure to enter a library email address to make
14016 sure that notices are sent to and from the right
14024 <para>If the URL field is populated then the library name
14025 will be linked in the holdings table on the OPAC</para>
14028 <screeninfo>Linked Library Name</screeninfo>
14032 <imagedata fileref="images/admin/basicparams/librarylink.png"/>
14039 <para>The OPAC Info box is for you to put information about
14040 the library that will appear in the OPAC when the branch
14041 name is moused over in the holdings table</para>
14044 <screeninfo>OPAC Info</screeninfo>
14048 <imagedata fileref="images/admin/basicparams/opacinfo.png"/>
14055 <para>IP Address does not have be filled in unless you plan
14056 on limiting access to your staff client to a specific IP
14062 <para>An IP address is required if you have enabled
14063 <link linkend="AutoLocation">AutoLocation</link></para>
14070 <para>Finally, if you have any notes you can put them here.
14071 These will not show in the OPAC</para>
14078 <para>Of the fields listed, only 'Library code' and 'Name' are
14085 <section id="editingalibrary">
14086 <title>Editing/Deleting a Library</title>
14088 <para>You will be unable to delete any library that has patrons or
14089 items attached to it.</para>
14092 <screeninfo>Staff will be presented with a warning when trying to
14093 delete a library that is being used</screeninfo>
14097 <imagedata fileref="images/admin/basicparams/cannotdeletelibrary.png"/>
14102 <para>Each library will have an 'Edit' link to the right of it.
14103 Click this link to edit/alter details associated with the library in
14107 <para>You will be unable to edit the 'Library code'</para>
14111 <section id="addinglibgroup">
14112 <title>Adding a group</title>
14114 <para>To add a Search Domain or Library Property Group click the
14115 'New Group' button at the top of the screen</para>
14118 <screeninfo>Add group form</screeninfo>
14122 <imagedata fileref="images/admin/basicparams/addlibgroup.png"/>
14126 <para>Give the group a 'Category type; of 'searchdomain' and if you would like the group
14127 to show up in the library pull down at the top of the OPAC (with <link
14128 linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link> set to
14129 'Add') and on the advanced search page you can check the 'Show in search pulldown'
14132 <para>Of the fields on the group form, 'Category code', 'Name', and 'Category type' are
14133 the only required fields</para>
14135 <section id="searchdomaingroups">
14136 <title>Search Domain Groups</title>
14138 <para>Search Domain Groups allow you to search a group of
14139 libraries at the same time instead of searching just one library
14140 or all libraries.</para>
14143 <screeninfo>Search Domain Groups</screeninfo>
14147 <imagedata fileref="images/admin/basicparams/searchgroup.png"/>
14152 <para>To see Search Domain Groups in action visit the staff client
14153 advanced search page in your Koha system:</para>
14156 <screeninfo>Library group search on staff client</screeninfo>
14160 <imagedata fileref="images/admin/basicparams/stafflibgroupsearch.png"/>
14166 <section id="libpropertygroups">
14167 <title>Library Property Groups</title>
14169 <para>You can assign specific categories to your libraries by
14170 adding groups for them</para>
14173 <screeninfo>Library Property Groups</screeninfo>
14177 <imagedata fileref="images/admin/basicparams/groupproperties.png"/>
14182 <para>Properties are then applied to libraries via the add or edit
14183 library form</para>
14186 <screeninfo>Groups on the Add/Modify library form</screeninfo>
14190 <imagedata fileref="images/admin/basicparams/addlibrarytogroup.png"/>
14198 <section id="itemtypeadmin">
14199 <title>Item Types</title>
14201 <para>Koha allows you to organize your collection by item types and
14202 collection codes.</para>
14206 <para><emphasis>Get there:</emphasis> More > Administration
14207 > Basic Parameters > Item Types</para>
14211 <para>Item types typically refer to the material type (book, cd, dvd,
14212 etc), but can be used in any way that works for your library.</para>
14215 <screeninfo>Item Types</screeninfo>
14219 <imagedata fileref="images/admin/basicparams/itemtypes.png"/>
14224 <section id="additemtype">
14225 <title>Adding Item Types</title>
14227 <para>To add a new item type, simply click the 'New Item Type'
14228 button at the top of the Item Types page.</para>
14231 <screeninfo>Sample DVD Item Type</screeninfo>
14235 <imagedata fileref="images/admin/basicparams/additemtype.png"/>
14242 <para>In the 'Item Type' field, enter a short code for your item
14247 <para>The description is the plain text definition of the item
14252 <para>You can choose to have an image associated with your item
14257 <para>You can choose from a series of image
14262 <para>You can link to a remote image</para>
14266 <para>Or you can just have no image associated with the item
14272 <para>To have your item type images appear in the OPAC you
14273 need to set noItemTypeImages to 'Show'</para>
14278 <para><emphasis>Get there: </emphasis>More >
14279 Administration > Global System Preferences > <link linkend="adminprefs">Admin</link></para>
14287 <para>For items that do not circulate, check the 'Not for loan'
14292 <para>Items marked 'Not for loan' will appear in the
14293 catalog, but cannot be checked out to patrons</para>
14299 <para id="rentalcharge">For items that you charge a rental fee
14300 for, enter the total fee you charge in the 'Rental charge'
14306 <para>Do not enter symbols in this field, only numbers and
14307 decimal points (ex. $5.00 should be entered as 5 or
14313 <para>This will charge the patron on checkout</para>
14319 <para>If you would like a message or alert to appear when items of this type are
14320 checked in you can enter that in the 'Checkin message' box</para>
14322 <screeninfo>Checkin message setup</screeninfo>
14325 <imagedata fileref="images/admin/basicparams/itemtype-msgsetup.png"/>
14332 <para>The Checkin message type can be a Message or an Alert. The only
14333 difference between these two is the styling. By default a Message is blue </para>
14335 <screeninfo>Checkin Message</screeninfo>
14338 <imagedata fileref="images/admin/basicparams/itemtype-msg.png"/>
14342 <para>and an Alert is yellow.</para>
14344 <screeninfo>Checkin Alert</screeninfo>
14347 <imagedata fileref="images/admin/basicparams/itemtype-alert.png"/>
14356 <para>When finished, click 'Save Changes'</para>
14360 <para>All fields, with the exception of the 'Item Type' will be editable from
14361 the Item Types list</para>
14368 <para>Your new item type will now appear on the list</para>
14371 <screeninfo>New DVD Item Type</screeninfo>
14375 <imagedata fileref="images/admin/basicparams/newitemtype.png"/>
14383 <section id="edititemtype">
14384 <title>Editing Item Types</title>
14386 <para>Each item type has an Edit button beside it. To edit an item
14387 simply click the 'Edit' link.</para>
14390 <para>You will not be able to edit the code you assigned as the
14391 'Item Type' but you will be able to edit the description for the
14396 <section id="deleteitemtype">
14397 <title>Deleting Item Types</title>
14399 <para>Each item has a Delete button beside it. To delete an item,
14400 simply click the 'Delete' link.</para>
14403 <para>You will not be able to delete item types that are being
14404 used by items within your system.</para>
14408 <screeninfo>Warning when you try to delete an item that is in
14413 <imagedata fileref="images/admin/basicparams/nodeleteitemtype.png"/>
14420 <section id="authorizedvalues">
14421 <title>Authorized Values</title>
14423 <para>Authorized values can be used in several areas of Koha. One
14424 reason you would add an authorized value category would be to control
14425 the values that can be entered into MARC fields by catalogers.</para>
14429 <para><emphasis>Get there:</emphasis> More > Administration
14430 > Basic Parameters > Authorized Values</para>
14434 <section id="existingauthvalues">
14435 <title>Existing Values</title>
14437 <para>Koha installs with pre-defined values that your library is
14438 likely to use, for instance 'Lost'.</para>
14441 <listitem id="asort1">
14442 <para>Asort1</para>
14445 <para>Used for acquisitions statistical purposes</para>
14450 <listitem id="asort2">
14451 <para>Asort2</para>
14454 <para>Used for acquisitions statistical purposes</para>
14459 <listitem id="bornotes">
14460 <para>BOR_NOTES</para>
14463 <para>Values for custom patron messages that appear on the circulation screen and
14464 the OPAC. The value in the Description field should be the message text and is
14465 limited to 200 characters.</para>
14467 <screeninfo>Borrower messages</screeninfo>
14470 <imagedata fileref="images/admin/basicparams/bor_notes.png"/>
14478 <listitem id="bsort1">
14479 <para>Bsort1</para>
14482 <para>Values that can be entered to fill in the patron's sort 1 field</para>
14487 <listitem id="bsort2">
14488 <para>Bsort2</para>
14491 <para>Values that can be entered to fill in the patron's sort 2 field</para>
14496 <listitem id="cartauth">
14500 <para>Is the shelving cart location, used by <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link> and
14501 <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link></para>
14506 <listitem id="ccode">
14510 <para>Collection codes (appears when cataloging and working with items)</para>
14515 <listitem id="damageauth">
14516 <para>DAMAGED</para>
14519 <para>Descriptions for items marked as damaged (appears when cataloging and
14520 working with items)</para>
14525 <listitem id="hingsas">
14526 <para>HINGS_AS</para>
14529 <para>General Holdings: Acquisition Status Designator :: This data element
14530 specifies acquisition status for the unit at the time of the holdings
14536 <listitem id="hingsc">
14537 <para>HINGS_C</para>
14540 <para>General Holdings: Completeness Designator</para>
14545 <listitem id="hingspf">
14546 <para>HINGS_PF</para>
14549 <para>Physical Form Designators</para>
14554 <listitem id="hingsrd">
14555 <para>HINGS_RD</para>
14558 <para>General Holdings: Retention Designator :: This data element specifies the
14559 retention policy for the unit at the time of the holdings report.</para>
14564 <listitem id="hingsut">
14565 <para>HINGS_UT</para>
14568 <para>General Holdings: Type of Unit Designator</para>
14573 <listitem id="shelvelocvals">
14577 <para>Shelving location (usually appears when adding or editing an item)</para>
14582 <listitem id="lost">
14586 <para>Descriptions for the items marked as lost (appears when adding or editing an
14591 <para>Values given to lost statuses should be numeric and not alphabetical in
14592 order for statuses to appear properly</para>
14598 <listitem id="manualinvvals">
14599 <para>MANUAL_INV</para>
14602 <para>Values for manual invoicing types</para>
14607 <para>The value set as the Authorized Value for the MANUAL_INV authorized
14608 value category will appear as the Description and the Authorized Value
14609 Description will be used as the amount. Enter monetary amounts in the
14610 description without currency symbols.</para>
14617 <listitem id="notforloan">
14618 <para>NOT_LOAN</para>
14621 <para>Reasons why a title is not for loan</para>
14625 <para>Values given to lost statuses should be numeric and not alphabetical in
14626 order for statuses to appear properly</para>
14631 <para>Negative number values will still allow holds (use for on order statuses
14632 for example) where as positive numbers will not allow holds or
14639 <listitem id="procauth">
14643 <para>The location to be used for <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link> (change description as desired), also the
14644 location expected by <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>.</para>
14649 <listitem id="reportgroup">
14650 <para>REPORT_GROUP</para>
14653 <para>A way to sort and filter your reports, the default values in this category
14654 include the Koha modules (Accounts, Acquitisions, Catalog, Circulation,
14657 <screeninfo>Report Groups</screeninfo>
14660 <imagedata fileref="images/admin/basicparams/report_group.png"/>
14668 <listitem id="reportsubgroup">
14669 <para>REPORT_SUBGROUP</para>
14672 <para>Can be used to further sort and filter your reports. This category is empty
14673 by default. Values here need to include the authorized value code from
14674 REPORT_GROUP in the Description (OPAC) field to link the subgroup to the
14675 appropriate group.</para>
14677 <screeninfo>Report Subgroups</screeninfo>
14680 <imagedata fileref="images/admin/basicparams/report_subgroup.png"/>
14688 <listitem id="restricted">
14689 <para>RESTRICTED</para>
14692 <para>Restricted status of an item</para>
14697 <listitem id="suggestauthorized">
14698 <para>ROADTYPE<itemizedlist>
14700 <para>Road types to be used in patron addresses</para>
14702 </itemizedlist></para>
14705 <para>SUGGEST</para>
14708 <para>List of patron suggestion reject or accept reasons (appears when managing
14709 suggestions)</para>
14714 <listitem id="withdrawnauth">
14715 <para>WITHDRAWN</para>
14718 <para>Description of a withdrawn item (appears when adding or editing an
14724 <listitem id="yesnoauth">
14725 <para>YES_NO</para>
14728 <para>A generic authorized value field that can be used anywhere you need a simple
14729 yes/no pull down menu.</para>
14736 <section id="newauthvalcat">
14737 <title>Add new Authorized Value Category</title>
14739 <para>In addition to the existing categories that come by default
14740 with Koha, librarians can add their own authorized value categories
14741 to control data that is entered into the system. To add a new
14746 <para>Click 'New Category'</para>
14749 <screeninfo>New Authorized Category form</screeninfo>
14753 <imagedata fileref="images/admin/basicparams/addauthcat.png"/>
14760 <para>Limit your Category to 10 characters (something short to
14761 make it clear what the category is for)</para>
14766 <para>Category cannot have spaces or special characters
14767 other than underscores and hyphens in it.</para>
14774 <para>When adding a new category you're asked to create at least
14775 one authorized value</para>
14779 <para>Enter a code for your Authorized Value into the
14780 'Authorized value' field</para>
14785 <para>Authorized value is limited to 80 characters and
14786 cannot have spaces or special characters other than
14787 underscores and hyphens in it.</para>
14794 <para>Use the Description field for the actual value that will be displayed. If
14795 you want something different to show in the OPAC, enter a 'Description
14799 <para>If you would like to limit this authorized value category to only specific
14800 libraries you can choose them from the 'Branches limitation' menu. To have it
14801 show for all libraries just choose 'All branches' at the top of the list.</para>
14805 <para>If you have <link linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
14806 and/or <link linkend="AuthorisedValueImages">AuthorisedValueImages</link>
14807 set to show images for authorized values you can choose the
14808 image under 'Choose an icon'</para>
14814 <para>Click 'Save'</para>
14818 <para>Your new category and value will appear on the list of
14819 Authorized Values</para>
14822 <screeninfo>Custom Authorized Value on list of
14823 values</screeninfo>
14827 <imagedata fileref="images/admin/basicparams/authvallist.png"/>
14835 <section id="newauthval">
14836 <title>Add new Authorized Value</title>
14838 <para>New authorized values can be added to any existing or new
14839 category. To add a value:</para>
14843 <para>Click 'New authorized value for ...'</para>
14846 <screeninfo>New Authorized Value form</screeninfo>
14850 <imagedata fileref="images/admin/basicparams/addauthvalue.png"/>
14857 <para>Enter a code for your Authorized Value into the
14858 'Authorized value' field</para>
14863 <para>Authorized value is limited to 80 characters and
14864 cannot have spaces or special characters other than
14865 underscores and hyphens in it.</para>
14872 <para>Use the Description field for the actual value that will be displayed. If you
14873 want something different to show in the OPAC, enter a 'Description (OPAC)'</para>
14876 <para>If you would like to limit this authorized value category to only specific
14877 libraries you can choose them from the 'Branches limitation' menu. To have it show
14878 for all libraries just choose 'All branches' at the top of the list.</para>
14882 <para>If you have <link linkend="StaffAuthorisedValueImages">StaffAuthorisedValueImages</link>
14883 and/or <link linkend="AuthorisedValueImages">AuthorisedValueImages</link> set
14884 to show images for authorized values you can choose the image
14885 under 'Choose an icon'</para>
14889 <para>Click 'Save'</para>
14893 <para>The new value will appear in the list along with existing
14897 <screeninfo>List of authorized values in MARC504
14898 category</screeninfo>
14902 <imagedata fileref="images/admin/basicparams/authvals.png"/>
14912 <section id="patscirc">
14913 <title>Patrons & Circulation</title>
14915 <para>Settings for controlling circulation and patron
14916 information.</para>
14918 <section id="patcats">
14919 <title>Patron Categories</title>
14921 <para>Patron categories allow you to organize your patrons into
14922 different roles, age groups, and patron types.</para>
14926 <para><emphasis>Get there:</emphasis> More > Administration
14927 > Patrons & Circulation > Patron Categories</para>
14932 <screeninfo>Patron category list</screeninfo>
14936 <imagedata fileref="images/admin/patroncirc/patroncatlist.png"/>
14941 <para>Patrons are assigned to one of six main categories:</para>
14949 <para>Most common patron type, usually used for a general
14950 'Patron' category.</para>
14960 <para>Children patrons can have a guardian to be attached to
14971 <para>Librarians (and library workers) should be assigned the
14972 staff category so that you can <link linkend="patronpermissions">set their permissions</link> and
14973 give them access to the staff client.</para>
14979 <para>Organizational</para>
14983 <para>Organizational patrons are organizations. Organizations
14984 can be used as guarantors for Professional patrons.</para>
14990 <para>Professional</para>
14994 <para>Professional patrons can be linked to Organizational
15001 <para>Statistical</para>
15005 <para>This patron type is used strictly for statistical
15006 purposes, such as in house use of items.</para>
15012 <section id="addingpatroncat">
15013 <title>Adding a patron category</title>
15015 <para>To add a new patron category click 'New Category' at the top
15019 <screeninfo>New patron category form</screeninfo>
15023 <imagedata fileref="images/admin/patroncirc/newpatroncat.png"/>
15030 <para>The 'Category Code' is an identifier for your new
15036 <para>The category code is limited to 10 characters
15037 (numbers and letters)</para>
15043 <para>This field is required in order to save your patron
15044 category. If left blank you will be presented with an
15048 <screeninfo>Missing fields error</screeninfo>
15052 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15062 <para>Enter a plain text version of the category in the
15063 'Description' field.</para>
15068 <para>This field is required in order to save your patron
15069 category. If left blank you will be presented with an
15073 <screeninfo>Missing fields error</screeninfo>
15077 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15087 <para>Enrollment period (in months) should be filled in if you
15088 have a limited enrollment period for your patrons (eg. Student
15089 cards expire after 9 months or until a specific date)</para>
15094 <para>You cannot enter both a month limit and a date
15095 until. Choose to enter either one or the other.</para>
15101 <para>This field is required in order to save your patron
15102 category. If left blank you will be presented with an
15106 <screeninfo>Missing fields error</screeninfo>
15110 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15120 <para>Some patron categories can have a minimum age (in years)
15121 requirement associated with them, enter this age in the 'Age
15127 <para>This value will only be checked if <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
15128 defines the dateofbirth as a required field on the patron
15136 <para>Patron categories can also have a maximum age (in years)
15137 associated with them (such as children), enter this age in the
15138 'Upperage limit'</para>
15143 <para>This value will only be checked if <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
15144 defines the dateofbirth as a required field on the patron
15152 <para>If you charge a membership fee for your patrons (such as
15153 those who live in another region) you can enter that in the
15154 'Enrollment fee' field.</para>
15159 <para>Only enter numbers and decimals in this field</para>
15166 <para>If you want your patron to receive overdue notices, set
15167 the 'Overdue notice required' to 'Yes'</para>
15171 <para>You can decide on a patron category basis if lost items
15172 are shown in the staff client by making a choice from the 'Lost
15173 items in staff client' pull down</para>
15176 <screeninfo>Choose a value for 'Hide Lost Items'</screeninfo>
15180 <imagedata fileref="images/admin/patroncirc/hidelostitemspatron.png"/>
15188 <para>Note that this is only applicable in the staff
15189 client, so changing this value on patron categories who do
15190 not have access to the staff client won't make any
15198 <para>If you charge patrons for placing holds on items, enter
15199 the fee amount in the 'Hold fee' field.</para>
15204 <para>Only enter numbers and decimals in this field</para>
15211 <para>In the 'Category type' field choose one of the six main
15212 parent categories</para>
15215 <screeninfo>Six main patron categories</screeninfo>
15219 <imagedata fileref="images/admin/patroncirc/patroncatpulldown.png"/>
15227 <para>This field is required in order to save your patron
15228 category. If left blank you will be presented with an
15232 <screeninfo>Missing fields error</screeninfo>
15236 <imagedata fileref="images/admin/patroncirc/patcaterror.png"/>
15246 <para>The Branch Limitations let you limit this patron category to only some branches
15247 in your library system. Select 'All branches' if you would like any library to be
15248 able to use this category.</para>
15251 <para>Finally you can assign advanced messaging preferences by default to a patron
15257 <para>Requires that you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> enabled</para>
15262 <para>These defaults will be applied to new patrons that are added to the system.
15263 They will not edit the preferences of the existing patrons. Also, these can be
15264 changed for individual patrons, this setting is just a default to make it easier
15265 to set up messages for an entire category.<itemizedlist>
15268 <para>After setting the default for the patron category you can force
15269 those changes to all existing patrons by running the <emphasis role="italic">borrowers-force-messaging-defaults</emphasis> script
15270 found in the <emphasis role="italic">misc/maintenance</emphasis> folder.
15271 Ask your system administrator for assistance with this script.</para>
15274 </itemizedlist></para>
15281 <section id="circfinerules">
15282 <title>Circulation and Fine Rules</title>
15283 <para>These rules define how your items are circulated, how/when fines are calculated and
15284 how holds are handled.</para>
15287 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
15288 Circulation > Circulation and fines rules</para>
15291 <para>The rules are applied from most specific to less specific, using the first found in
15295 <para>same library, same patron type, same item type</para>
15298 <para>same library, same patron type, all item type</para>
15301 <para>same library, all patron types, same item type</para>
15304 <para>same library, all patron types, all item types</para>
15307 <para>default (all libraries), same patron type, same item type</para>
15310 <para>default (all libraries), same patron type, all item types</para>
15313 <para>default (all libraries), all patron types, same item type</para>
15316 <para>default (all libraries), all patron types, all item types</para>
15320 <para>If you are a single library system choose your branch name before creating rules
15321 (sometimes having only rules for the 'all libraries' option can cause issues with
15326 <para>At the very least you will need to set a default circulation rule. This rule
15327 should be set for all item types, all libraries and all patron categories. That will
15328 catch all instances that do not match a specific rule. When checking out if you do not
15329 have a rule for all libraries, all item types and all patron types then you may see
15330 patrons getting blocked from placing holds. You will also want a rule for your
15331 specific library set for all item types and all patron types to avoid this holds
15332 issue. Koha needs to know what rule to fall back on.</para>
15335 <section id="defaultcircrules">
15336 <title>Default Circulation Rules</title>
15337 <para>Using the issuing rules matrix you can define rules that depend on patron/item type
15338 combos. To set your rules, choose a library from the pull down (or 'all libraries' if
15339 you want to apply these rules to all branches):</para>
15341 <screeninfo>Libraries to apply the rules to</screeninfo>
15344 <imagedata fileref="images/admin/patroncirc/selectissuinglibrary.png"/>
15348 <para>From the matrix you can choose any combination of patron categories and item types
15349 to apply the rules to</para>
15351 <screeninfo>Setting issuing rules for your libraries</screeninfo>
15354 <imagedata fileref="images/admin/patroncirc/addcircrule.png"/>
15360 <para>First choose which patron category you'd like the rule to be applied to. If you
15361 leave this to 'All' it will apply to all patron categories</para>
15364 <para>Choose the 'Item type' you would like this rule to apply to. If you leave this
15365 to 'All' it will apply to all item types</para>
15368 <para>Limit the number of items a patron can have checked out at the same time by
15369 entering a number in the 'Current checkouts allowed' field</para>
15372 <para>Define the period of time an item can be checked out to a patron by entering the
15373 number of units (days or hours) in the 'Loan period' box.</para>
15376 <para>Choose which unit of time, Days or Hours, that the loan period and fines will be
15377 calculated in in the 'Unit' column</para>
15380 <para>You can also define a hard due date for a specific patron category and item
15381 type. A hard due date ignores your usual circulation rules and makes it so that all
15382 items of the type defined are due on, before or after the date you specify.</para>
15385 <para>'Fine amount' should have the amount you would like to charge for overdue
15390 <para>Enter only numbers and decimal points (no currency symbols).</para>
15396 <para>Enter the 'Fine charging interval' in the unit you set (ex. charge fines every 1
15397 day, or every 2 hours)</para>
15400 <para>The 'Fine grace period' is the period of time an item can be overdue before you
15401 start charging fines.</para>
15405 <para>This can only be set for the Day unit, not in Hours</para>
15411 <para>The 'Overdue fines cap' is the maximum fine for this patron and item
15416 <para>If this field is left blank then Koha will not put a limit on the fines
15417 this item will accrue. A maximum fine amount can be set using the <link linkend="MaxFine">MaxFine</link> system preference.</para>
15423 <para>If your library 'fines' patrons by suspending their account you can enter the
15424 number of days their fine should be suspended in the 'Suspension in days'
15429 <para>This can only be set for the Day unit, not in Hours</para>
15435 <para>Next decide if the patron can renew this item type and if so, enter how many
15436 times they can renew it in the 'Renewals allowed' box</para>
15439 <para>If you're allowing renewals you can control how long the renewal loan period
15440 will be (in the units you have chosen) in the 'Renewal period' box</para>
15443 <para>If the patron can place holds on this item type, enter the total numbers of
15444 items (of this type) that can be put on hold in the 'Holds allowed' field</para>
15447 <para>Finally, if you charge a <link linkend="rentalcharge">rental fee</link> for the
15448 item type and want to give a specific patron type a discount on that fee, enter the
15449 percentage discount (without the % symbol) in the 'Rental Discount' field</para>
15452 <para>When finished, click 'Add' to save your changes. To modify a rule, simply click the
15453 'Edit' link to the right of the fule and edit the values that appear filled in at the
15454 bottom of the form.</para>
15456 <screeninfo>Edit circ and fine rule</screeninfo>
15459 <imagedata fileref="images/admin/patroncirc/editcircfine.png"/>
15463 <para>If you would like to delete your rule, click the 'Delete' link to the right of the
15465 <para>To save time you can clone rules from one library to another by choosing the clone
15466 option above the rules matrix.</para>
15468 <screeninfo>Circulation & Fine Rules Clone Tool</screeninfo>
15471 <imagedata fileref="images/admin/patroncirc/clonerules.png"/>
15475 <para>After choosing to clone you will be presented with a confirmation message.</para>
15477 <screeninfo>Circulation & Fine Rules Successfully Cloned Message</screeninfo>
15480 <imagedata fileref="images/admin/patroncirc/rulescloned.png"/>
15485 <section id="defaultcheckoutpolicy">
15486 <title>Default Checkouts and Hold Policy</title>
15487 <para>You can set a default maximum number of checkouts and hold policy that will be used
15488 if none is defined below for a particular item type or category. This is the fall back
15489 rule for defaults.</para>
15491 <screeninfo>Default Checkouts and Hold Policy</screeninfo>
15494 <imagedata fileref="images/admin/patroncirc/defaultcheckholds.png"/>
15498 <para>From this menu you can set a default to apply to all item types and patrons in the
15499 library if no other option is set in the forms below.</para>
15502 <para>In 'Total Current Checkouts Allowed' enter the total number of items patrons can
15503 have checked out at one time</para>
15506 <para>Control where patrons can place holds from using the 'Hold Policy' menu</para>
15509 <para>From Any Library: Patrons from any library may put this item on hold.
15510 (default if none is defined)</para>
15513 <para>From Home Library: Only patrons from the item's home library may put this
15514 book on hold.</para>
15517 <para>No Holds Allowed: No patron may put this book on hold.</para>
15522 <para>Control where the item returns to once it is checked in</para>
15525 <para>Item returns home</para>
15528 <para>Item returns to issuing branch</para>
15531 <para>Item floats</para>
15534 <para>When an item floats it stays where it was checked in and does not ever
15535 return 'home'</para>
15542 <para>Once your policy is set, you can unset it by clicking the 'Unset' link to the
15543 right of the rule</para>
15547 <section id="checkoutperpatron">
15548 <title>Checkouts Per Patron</title>
15549 <para>For this library, you can specify the maximum number of loans that a patron of a
15550 given category can make, regardless of the item type. </para>
15552 <screeninfo>Set default checkouts per patron category</screeninfo>
15555 <imagedata fileref="images/admin/patroncirc/checkoutsperpatron.png"/>
15560 <para>If the total amount loanable for a given patron category is left blank, no limit
15561 applies, except possibly for a limit you define for a specific item type.</para>
15563 <para>For example, if you have a rule in the matrix that says Board patrons are allowed 10
15564 books and 5 DVDs but you want to make it so that Board patrons only have a total of 12
15565 things checked out at once. If you enter 12 here and the patron has 10 books out
15566 already they will only be allowed 2 DVDs to equal the 12 total they're allowed.</para>
15568 <section id="holdpolicies">
15569 <title>Item Hold Policies</title>
15570 <para>For this library, you can edit hold and return policies for a given item type,
15571 regardless of the patron's category.</para>
15573 <screeninfo>Hold policies per item type</screeninfo>
15576 <imagedata fileref="images/admin/patroncirc/holdsperitem.png"/>
15580 <para>The various Hold Policies have the following effects:</para>
15583 <para>From Any Library: Patrons from any library may put this item on hold. (default
15584 if none is defined)</para>
15587 <para>From Home Library: Only patrons from the item's home library may put this book
15591 <para>No Holds Allowed: No patron may put this book on hold.</para>
15595 <para>Note that if the system preference <link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link> set to 'allow', these policies can be overridden by
15596 your circulation staff.</para>
15599 <para>These policies are based on the patron's home branch, not the branch that the
15600 reserving staff member is from.</para>
15602 <para>The various Return Policies have the following effects:</para>
15605 <para>Item returns home: The item will prompt the librarian to transfer the item to
15606 its home library</para>
15610 <para>If the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link>
15611 preference is set to automatically transfer the items home, then a prompt will
15618 <para>Item returns to issuing branch: The item will prompt the librarian to transfer
15619 the item back to the library where it was checked out</para>
15623 <para>If the <link linkend="AutomaticItemReturn">AutomaticItemReturn</link>
15624 preference is set to automatically transfer the items home, then a prompt will
15631 <para>Item floats: The item will not be transferred from the branch it was checked in
15632 at, instead it will remain there until transferred manually or checked in at another
15636 <para>For example you might allow holds at your libraries but not what New items or DVDs to
15637 be placed on hold by other branches so you can set the 'Hold policy' to 'From home
15638 library' so that those items can only be placed on hold if the items' owning library and
15639 the patron's home library are the same. You can also block holds completely on specific
15640 item types from this form. This is also how you can set up floating item types and
15641 types that remain with their home library.</para>
15644 <section id="patronattributetypes">
15645 <title>Patron Attribute Types</title>
15646 <para>Patron attributes can be used to define custom fields to associate with your patron
15647 records. In order to enable the use of custom fields you need to set the <link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link> system
15651 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
15652 Circulation > Patron attribute types</para>
15655 <para>A common use for this field would be for a student ID number or a Driver's license
15658 <screeninfo>List of Patron Attributes</screeninfo>
15661 <imagedata fileref="images/admin/patroncirc/attributes.png"/>
15665 <section id="addpatattributes">
15666 <title>Adding Patron Attributes</title>
15667 <para>To add a new Patron Attribute Type, click the 'New Patron Attribute Type' button at
15668 the top of the page</para>
15670 <screeninfo>Add Patron Attribute Type form</screeninfo>
15673 <imagedata fileref="images/admin/patroncirc/addattribute.png"/>
15679 <para>In the 'Patron attribute type code', enter a short code to identify this
15684 <para>This field is limited to 10 characters (numbers and letters only)</para>
15689 <para>This setting cannot be changed after an attribute is defined</para>
15695 <para>In the 'Description' field, enter a longer (plain text) explanation of what this
15696 field will contain</para>
15699 <para>Check the box next to 'Repeatable' to let a patron record have multiple values
15700 of this attribute.</para>
15704 <para>This setting cannot be changed after an attribute is defined</para>
15710 <para>If 'Unique identifier' is checked, the attribute will be a unique identifier
15711 which means, if a value is given to a patron record, the same value cannot be given
15712 to a different record.</para>
15716 <para>This setting cannot be changed after an attribute is defined</para>
15722 <para>Check 'Allow password' to make it possible to associate a password with this
15726 <para>Check 'Display in OPAC' to display this attribute on a patron's details page in
15730 <para>Check 'Searchable' to make this attribute searchable in the staff patron
15734 <para>Check 'Display in check-out' to make this attribute visible in the patron's
15735 short detail display on the left of the checkout screen and other patron
15738 <screeninfo>Show attribute in patron detail on the left</screeninfo>
15741 <imagedata fileref="images/admin/patroncirc/showattribute.png"/>
15747 <para>Authorized value category; if one is selected, the patron record input page will
15748 only allow values to be chosen from the authorized value list.</para>
15751 <para>You will first need to add an authorized value list for it to appear in this
15755 <para><emphasis>Get there: </emphasis>More > Administration > Basic
15756 Parameters > <link linkend="authorizedvalues">Authorized
15757 Values</link></para>
15763 <para>an authorized value list is not enforced during batch patron
15770 <para>If you would like this attribute to only be used by specific branches you can
15771 choose those branches from the 'Branches limitation' list. Choose 'All branches' to
15772 show it for all libraries.<itemizedlist>
15775 <para>Note that items with locations already set on them will not be altered.
15776 The branch limitation only limits the choosing of an authorized value based
15777 on the home branch of the current staff login. All authorized values for
15778 item records (LOC, LOST, CCODE, etc) will show in the OPAC for all
15782 </itemizedlist></para>
15785 <para>If you'd like to only show this attribute on patrons of one type choose that
15786 patron type from the 'Category' pull down</para>
15789 <para>If you have a lot of attributes it might be handy to group them so that you can
15790 easily find them for editing. If you create an <link linkend="authorizedvalues">Authorized Value</link> for PA_CLASS it will show in the 'Class' pull down and
15791 you can then change your attributes page to have sections of attributes</para>
15793 <screeninfo>Patron Attributes Sorted</screeninfo>
15796 <imagedata fileref="images/admin/patroncirc/pa_class.png"/>
15802 <para>Click Save to save your new attribute</para>
15805 <para>Once added your attribute will appear on the list of attributes and also on the
15806 patron record add/edit form</para>
15808 <screeninfo>Patron Attributes list on the Patron add/edit form</screeninfo>
15811 <imagedata fileref="images/admin/patroncirc/patronattribute.png"/>
15815 <para>If you have set up classes for organizing attributes they will appear that way on
15816 the add/edit patron form</para>
15818 <screeninfo>Grouped Attributes</screeninfo>
15821 <imagedata fileref="images/admin/patroncirc/pa_class-patron.png"/>
15826 <section id="editpatattributes">
15827 <title>Editing/Deleting Patron Attributes</title>
15828 <para>Each patron attribute has an edit and a delete link beside it on the list of
15830 <para>Some fields in the attribute will not be editable once created:</para>
15833 <para>Patron attribute type code</para>
15836 <para>Repeatable</para>
15839 <para>Unique identifier</para>
15842 <para>You will be unable to delete an attribute if it's in use.</para>
15844 <screeninfo>Warning when trying to delete an attribute that is in use</screeninfo>
15847 <imagedata fileref="images/admin/patroncirc/deletepatronattr.png"/>
15853 <section id="libtransferlimits">
15854 <title>Library Transfer Limits</title>
15855 <para>Limit the ability to transfer items between libraries based on the library sending,
15856 the library receiving, and the collection code involved.</para>
15859 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
15860 Circulation > Library Transfer Limits</para>
15863 <para>These rules only go into effect if the preference <link linkend="UseBranchTransferLimits">UseBranchTransferLimits</link> is set to
15865 <para>Before you begin you will want to choose which library you are setting these limits
15868 <screeninfo>Choose the library you're setting limits for</screeninfo>
15871 <imagedata fileref="images/admin/patroncirc/librarytransferselect.png"/>
15875 <para>Transfer limits are set based on the collections codes you have applied via the <link linkend="authorizedvalues">Authorized Value</link> administration area.</para>
15877 <screeninfo>Collection Code values assigned in the Authorized Value area</screeninfo>
15880 <imagedata fileref="images/admin/patroncirc/collectcodes.png"/>
15884 <para>Collection codes will appear as tabs above the checkboxes:</para>
15886 <screeninfo>Collection Code tabs</screeninfo>
15889 <imagedata fileref="images/admin/patroncirc/limittocollcode.png"/>
15893 <para>Check the boxes for the libraries that you accept checkins from for the item type you
15894 have selected at the top (in the example below - FIC)</para>
15896 <screeninfo>Example transfer limits set up</screeninfo>
15899 <imagedata fileref="images/admin/patroncirc/transferlimits.png"/>
15903 <para>In the above example, Centerville library will allow patrons to return items from all
15904 libraries except Liberty and Franklin to their branch.</para>
15906 <section id="transportcostmatrix">
15907 <title>Transport cost matrix</title>
15908 <para>The Transport cost matrix lets a library system define relative costs to transport
15909 books to one another. In order for the system to use this matrix you must first set the
15910 <link linkend="UseTransportCostMatrix">UseTransportCostMatrix</link> preference to
15912 <para>The Transport cost matrix takes precedence in controlling where holds are filled
15913 from, if the matrix is not used then Koha checks the <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>.</para>
15914 </important></para>
15915 <para>Costs are decimal values between some arbitrary maximum value (e.g. 1 or 100) and 0
15916 which is the minimum (no) cost. For example, you could just use the distance between each
15917 library in miles as your 'cost', if that would accurately reflect the cost of transferring
15918 them. Perhaps post offices would be a better measure. Libraries sharing a post office
15919 would have a cost of 1, adjacent post offices would have a cost of 2, etc.</para>
15920 <para>To enter transport costs simply click in the cell you would like to alter, uncheck the
15921 'Disable' box and enter your 'cost'</para>
15923 <screeninfo>Transport cost matrix</screeninfo>
15926 <imagedata fileref="images/admin/patroncirc/transportcostmatrix.png"/>
15930 <para>After entering in your cost, hit 'Enter' on your keyboard or click the 'Save' button
15931 at the bottom of the matrix to save your changes.</para>
15933 <section id="itemcircalerts">
15934 <title>Item Circulation Alerts</title>
15935 <para>Libraries can decide if they want to have patrons automatically notified of
15936 circulation events (check ins and check outs).</para>
15939 <para><emphasis>Get there:</emphasis> More > Administration > Patrons &
15940 Circulation > Item Circulation Alerts</para>
15943 <para>These preferences are set based on patron types and item types.</para>
15945 <para>These preference can be overridden by changes in the individual patron's messaging
15946 preferences.</para>
15948 <para>To set up circulation alerts:</para>
15951 <para>Choose your library from the pull down at the top of the screen</para>
15953 <screeninfo>Libraries to set Circulation Alerts</screeninfo>
15956 <imagedata fileref="images/admin/patroncirc/librariesforalert.png"/>
15962 <para>To set preferences for all libraries, keep the menu set to 'Default'</para>
15967 <para>By default all item types and all patrons are notified of check ins and check
15968 outs. To change this, click on the item/patron type combo that you would like to stop
15969 notices for.</para>
15971 <screeninfo>Circulation Alert Matrix</screeninfo>
15974 <imagedata fileref="images/admin/patroncirc/alertmatrix.png"/>
15980 <para>In the above example, Juveniles and Kids will not receive check out
15988 <section id="citytowns">
15989 <title>Cities and Towns</title>
15991 <para>To standardize patron input you can define cities or towns
15992 within your region so that when new patrons are added librarians
15993 simply have to select the town from a list instead of having to type
15994 the town and zip (or postal) code information.</para>
15998 <para><emphasis>Get there:</emphasis> More > Administration
15999 > Patrons & Circulation > Cities and Towns</para>
16003 <section id="addingcity">
16004 <title>Adding a City</title>
16006 <para>To add a new city, click the 'New City' button at the top of
16007 the page and enter the city name, state, zip/postal code and
16011 <screeninfo>New city entry form</screeninfo>
16015 <imagedata fileref="images/admin/patroncirc/newcity.png"/>
16020 <para>One you click Submit, your city will be saved and will be
16021 listed on the Cities and Towns page</para>
16024 <screeninfo>List of Cities</screeninfo>
16028 <imagedata fileref="images/admin/patroncirc/cities.png"/>
16033 <para>Cities can be edited or deleted at any time.</para>
16036 <section id="citiesonpatform">
16037 <title>Viewing Cities on Patron Add Form</title>
16039 <para>If you have defined local cities using the New city form, then
16040 when adding or editing a patron record you will see those cities in
16041 a pull down menu to make city selection easy.</para>
16044 <screeninfo>Cities pull down on the patron record</screeninfo>
16048 <imagedata fileref="images/admin/patroncirc/patroncity.png"/>
16053 <para>This will allow for easy entry of local cities into the patron
16054 record without risking the potential for typos or mistaken
16055 zip/postal codes.</para>
16060 <section id="catadmin">
16061 <title>Catalog Administration</title>
16063 <para>Set these controls before you start cataloging on your Koha
16068 <para><emphasis>Get there:</emphasis> More > Administration >
16073 <section id="marcbibframeworks">
16074 <title>MARC Bibliographic Frameworks</title>
16076 <para>Think of Frameworks as templates for creating new bibliographic
16077 records. Koha comes with some predefined frameworks that can be edited
16078 or deleted, and librarians can create their own frameworks for content
16079 specific to their libraries.</para>
16083 <para><emphasis>Get there:</emphasis> More > Administration
16084 > Catalog > MARC Bibliographic Frameworks</para>
16089 <screeninfo>Frameworks List</screeninfo>
16093 <imagedata fileref="images/admin/cataloging/frameworks.png"/>
16099 <para>Do not delete or edit the Default Framework since this will
16100 cause problems with your cataloging records - always create a new
16101 template based on the Default Framework, or alter the other
16105 <para>After clicking the 'MARC structure' link to the right of each
16106 framework you can decide how many fields you want to see on one screen
16107 by using the pagination options at the top of the table.</para>
16110 <screeninfo>Pagination options</screeninfo>
16114 <imagedata fileref="images/admin/cataloging/frameworkoptions.png"/>
16119 <section id="addframework">
16120 <title>Add New Framework</title>
16122 <para>To add a new framework</para>
16126 <para>Click 'New Framework'</para>
16129 <screeninfo>Add Framework Form</screeninfo>
16133 <imagedata fileref="images/admin/cataloging/addframework.png"/>
16140 <para>Enter a code of 4 or fewer characters</para>
16144 <para>Use the Description field to enter a more detailed
16145 definition of your framework</para>
16151 <para>Click 'Submit'</para>
16155 <para>Once your Framework is added click 'MARC structure' to the
16156 right of it on the list of Frameworks</para>
16159 <screeninfo>Choose basis for new Framework</screeninfo>
16163 <imagedata fileref="images/admin/cataloging/startnewframework.png"/>
16170 <para>You will be asked to choose a Framework to base your
16171 new Framework off of, this will make it easier than starting
16172 from scratch</para>
16178 <para>Once your Framework appears on the screen you can edit or
16179 delete each field by following the instructions for <link linkend="editsubfields">editing subfields</link></para>
16184 <section id="editframeworks">
16185 <title>Edit Existing Frameworks</title>
16187 <para>Clicking 'Edit' to the right of a Framework will only allow
16188 you to edit the Description for the Framework:</para>
16191 <screeninfo>Edit Framework</screeninfo>
16195 <imagedata fileref="images/admin/cataloging/editframework.png"/>
16200 <para>To make edits to the fields associated with the Framework you
16201 must first click 'MARC Structure' and then follow the instructions
16202 for <link linkend="editsubfields">editing subfields</link></para>
16205 <section id="addsubfieldsframework">
16206 <title>Add subfields to Frameworks</title>
16208 <para>To add a field to a Framework click the 'New Tag' button at
16209 the top of the Framework definition</para>
16212 <screeninfo>New Tag Button</screeninfo>
16216 <imagedata fileref="images/admin/cataloging/newtag.png"/>
16221 <para>This will open up a blank form for entering MARC field
16225 <screeninfo>Add a new tag to framework</screeninfo>
16229 <imagedata fileref="images/admin/cataloging/newtagform.png"/>
16234 <para>Enter the information about your new tag:</para>
16238 <para>The 'Tag' is the MARC field number</para>
16242 <para>The 'Label for lib' is the text that will appear in the
16243 staff client when in the cataloging module</para>
16247 <para>The 'Label for OPAC' is the text that will appear in the
16248 OPAC when viewing the MARC version of the record</para>
16252 <para>If this field can be repeated, check the 'Repeatable'
16257 <para>If this field is mandatory, check the 'Mandatory'
16262 <para>If you want this field to be a pull down with limited
16263 possible answers, choose which 'Authorized value' list you want
16268 <para>When you're finished, click 'Save Changes' and you will be
16269 presented with your new field</para>
16272 <screeninfo>New tag and link to subfields</screeninfo>
16276 <imagedata fileref="images/admin/cataloging/subfieldslink.png"/>
16281 <para>To the right of the new field is a link to 'Subfields,' you
16282 will need to add subfields before this tag will appear in your MARC
16283 editor. The process of entering the settings for the new subfield is
16284 the same as those found in the <link linkend="editsubfields">editing
16285 subfields in frameworks</link> section of this manual.</para>
16288 <section id="editsubfields">
16289 <title>Edit Framework Subfields</title>
16291 <para>Frameworks are made up of MARC fields and subfields. To make
16292 edits to most Frameworks you must edit the fields and subfields.
16293 Clicking 'Edit' to the right of each subfield will allow you to make
16294 changes to the text associated with the field</para>
16297 <screeninfo>Modify MARC Field</screeninfo>
16301 <imagedata fileref="images/admin/cataloging/editfield.png"/>
16308 <para>Each field has a tag (which is the MARC tag)</para>
16312 <para>The 'Label for lib' is what will show in the staff
16313 client if you have <link linkend="advancedMARCeditor">advancedMARCeditor</link> set
16314 to display labels</para>
16318 <para>The 'Label for OPAC' is what will show on the MARC
16319 view in the OPAC</para>
16323 <para>If you check 'Repeatable' then the field will have a
16324 plus sign next to it allowing you to add multiples of that
16329 <para>If you check 'Mandatory' the record will not be
16330 allowed to save unless you have a value assigned to this
16335 <para>'Authorized value' is where you define an <link linkend="authorizedvalues">authorized value</link> that your
16336 catalogers can choose from a pull down to fill this field
16343 <para>To edit the subfields associated with the tag, click
16344 'Subfields' to the right of the tag on the 'MARC Structure'
16349 <para>From the list of subfields you can click 'Delete' to the
16350 right of each to delete the subfields</para>
16354 <para>To edit the subfields click 'Edit Subfields'</para>
16358 <para>For each subfield you can set the following Basic constraint values</para>
16360 <screeninfo>Editing the 504 Subfield</screeninfo>
16363 <imagedata fileref="images/admin/cataloging/editsubfield.png"/>
16370 <para>Text for librarian</para>
16374 <para>what appears before the subfield in the librarian
16381 <para>Text for OPAC</para>
16385 <para>what appears before the field in the OPAC.</para>
16389 <para>If left empty, the text for librarian is used
16398 <para>Repeatable</para>
16402 <para>the field will have a plus sign next to it
16403 allowing you to add multiples of that tag</para>
16409 <para>Mandatory</para>
16413 <para>the record will not be allowed to save unless you
16414 have a value assigned to this tag</para>
16420 <para>Managed in tab</para>
16424 <para>defines the tab where the subfield is shown. All
16425 subfields of a given field must be in the same tab or
16426 ignored. Ignore means that the subfield is not
16434 <para>For each subfield you can set the following Advanced constraint values</para>
16436 <screeninfo>Advanced constraints</screeninfo>
16439 <imagedata fileref="images/admin/cataloging/advancedoptsubfield.png"/>
16445 <para>Default value</para>
16448 <para>defines what you want to appear in the field by default, this will be
16449 editable, but it saves time if you use the same note over and over or the
16450 same value in a field often.</para>
16455 <para>Visibility</para>
16458 <para>allows you to select from where this subfield is visible/hidden, simply
16459 check the boxes where you would like the field to show and uncheck the boxes
16460 where you would like it hidden.</para>
16462 <screeninfo>Framework visibility</screeninfo>
16465 <imagedata fileref="images/admin/cataloging/frameworkvisibility.png"/>
16473 <para>Is a URL</para>
16476 <para>if checked, it means that the subfield is a URL and can be
16485 <para>If you enter a field/subfield here (200b), a link appears after the
16486 subfield in the MARC Detail view. This view is present only in the staff
16487 client, not the OPAC. If the librarian clicks on the link, a search is done
16488 on the database for the field/subfield with the same value. This can be used
16489 for 2 main topics :</para>
16492 <para>on a field like author (200f in UNIMARC), put 200f here, you will be
16493 able to see all bib records with the same author.</para>
16496 <para>on a field that is a link (4xx) to reach another bib record. For
16497 example, put 011a in 464$x, will find the serials that are with this
16504 <para>This value should not change after data has been added to your
16505 catalog. If you need to change this value you must ask your system
16506 administrator to run misc/batchRebuildBiblioTables.pl. </para>
16512 <para>Koha link</para>
16515 <para>Koha is multi-MARC compliant. So, it does not know what the 245$a means,
16516 neither what 200$f (those 2 fields being both the title in MARC21 and
16517 UNIMARC). So, in this list you can "map" a MARC subfield to its meaning.
16518 Koha constantly maintains consistency between a subfield and its meaning.
16519 When the user want to search on "title", this link is used to find what is
16520 searched (245 if you're MARC21, 200 if you're UNIMARC).</para>
16527 <para>For each subfield you can set the following Other option values</para>
16532 <imagedata fileref="images/admin/cataloging/otheroptssubfield.png"/>
16538 <para>Authorized value</para>
16541 <para>means the value cannot by typed by the librarian, but must be chosen
16542 from a pull down generated by the <link linkend="authorizedvalues"
16543 >authorized value</link> list</para>
16546 <para>In the example above, the 504a field will show the MARC504 Authorized
16547 Values when cataloging</para>
16549 <screeninfo>Example of an Authorized Subfield</screeninfo>
16552 <imagedata fileref="images/admin/cataloging/504auth.png"/>
16560 <para>Thesaurus</para>
16563 <para>means that the value is not free text, but must be searched in the
16564 authority/thesaurus of the selected category</para>
16569 <para>Plugin</para>
16572 <para>means the value is calculated or managed by a plugin. Plugins can do
16573 almost anything.</para>
16576 <para>For example, in UNIMARC there are plugins for every 1xx fields that are
16577 coded fields. The plugin is a huge help for cataloger ! There are also two
16578 plugins (unimarc_plugin_210c and unimarc_plugin_225a that can "magically"
16579 find the editor from an ISBN, and the collection list for the editor)</para>
16587 <para>To save your changes simply click the 'Save Changes'
16588 button at the top of the screen</para>
16595 <section id="importexportframeworks">
16596 <title>Import/Export Frameworks</title>
16598 <para>Next to each framework is a link to either import or export
16599 the framework.</para>
16601 <section id="exportframeworks">
16602 <title>Export Framework</title>
16604 <para>To export a framework simply click the 'Export' link to the
16605 right of framework title.</para>
16608 <screeninfo>Export link next to framework</screeninfo>
16612 <imagedata fileref="images/admin/cataloging/importexport.png"/>
16617 <para>When you click 'Export' you will be prompted to choose what
16618 format to export the file in.</para>
16621 <screeninfo>Export formats</screeninfo>
16625 <imagedata fileref="images/admin/cataloging/exportoptions.png"/>
16630 <para>A framework exported this way can be imported into any other
16631 Koha installation using the import framework option.</para>
16634 <section id="importframeworks">
16635 <title>Import Framework</title>
16637 <para>An easy way to create a new framework is to import one created for your or another
16638 Koha installation. This framework would need to be exported from the other system
16639 <link linkend="exportframeworks">using the instructions above</link> to be available
16640 for import here. </para>
16641 <para>To import a framework you first need to create <link linkend="addframework">a new
16642 framework</link>. Once you have that framework, click 'Import' to the right of the
16643 new framework.</para>
16646 <screeninfo>Import link next to framework</screeninfo>
16650 <imagedata fileref="images/admin/cataloging/importexport.png"/>
16655 <para>You will be prompted to find a file on your computer to
16656 import into the framework.</para>
16659 <screeninfo>Choose a file to import</screeninfo>
16663 <imagedata fileref="images/admin/cataloging/importfile.png"/>
16668 <para>You will be asked to confirm your actions before the file is
16672 <screeninfo>Confirm your desire to import</screeninfo>
16676 <imagedata fileref="images/admin/cataloging/importconfirm.png"/>
16681 <para>As your file is uploaded you will see an image that will
16682 confirm that the system is working.</para>
16685 <screeninfo>Import timer</screeninfo>
16689 <imagedata fileref="images/admin/cataloging/importtimer.png"/>
16694 <para>Once your import is complete you will be brought to the
16695 framework edit tool where you can make any changes you need to the
16696 framework you imported.</para>
16701 <section id="kohamarcmapping">
16702 <title>Koha to MARC Mapping</title>
16704 <para>While Koha stores the entire MARC record, it also stores common
16705 fields for easy access in various tables in the database. Koha to MARC
16706 Mapping is used to tell Koha where to find these values in the MARC
16707 record. In many cases you will not have to change the default values
16708 set by in this tool on installation, but it is important to know that
16709 the tool is here and can be used at any time.</para>
16713 <para><emphasis>Get there:</emphasis> More > Administration
16714 > Catalog > Koha to MARC Mapping</para>
16718 <para>The Koha to MARC Mapping page offers you the option of choosing
16719 from one of three tables in the database to assign values to.</para>
16722 <screeninfo>Koha to MARC Mapping Table Pull Down</screeninfo>
16726 <imagedata fileref="images/admin/cataloging/kohamarcmapping.png"/>
16731 <para>After choosing the table you would like to view, click 'OK.' To
16732 edit any mapping click on the 'Koha Filed' or the 'Edit' link.</para>
16735 <screeninfo>Map MARC Field to Koha Field</screeninfo>
16739 <imagedata fileref="images/admin/cataloging/mapmarc.png"/>
16744 <para>Choose which MARC field you would like to map to this Koha Field
16745 and click the 'OK' button. If you would like to clear all mappings,
16746 click the 'Click to "Unmap"' button.</para>
16749 <para>At this time you can map only 1 MARC field to 1 Koha field.
16750 This means that you won't be able to map both the 100a and the 700a
16751 to the author field, you need to choose one or the other.</para>
16757 <section id="keywordmapping">
16758 <title>Keywords to MARC Mapping</title>
16760 <para>This tool will allow you to map MARC fields to a set of
16761 predefined keywords.</para>
16765 <para><emphasis>Get there:</emphasis> More > Administration
16766 > Catalog > Keywords to MARC Mapping</para>
16771 <para>This tool only effects sites that are not using the XSLT
16772 Stylesheets.</para>
16775 <para>At this time the only keyword in use is 'subtitle.'</para>
16777 <para>Using this tool you can define what MARC field prints to the
16778 detail screen of the bibliographic record using keywords. The
16779 following example will use the subtitle field.</para>
16781 <para>Using the Framework pull down menu, choose the <link linkend="marcbibframeworks">Framework</link> you would like to apply
16782 this rule to. For example, the subtitle for books can be found in the
16783 245$b field.</para>
16786 <screeninfo>Assigning Book Subtitle</screeninfo>
16790 <imagedata fileref="images/admin/cataloging/subtitlebookmapping.png"/>
16795 <para>However the subtitle for DVDs appears in 245$p</para>
16798 <screeninfo>Assigning DVD Subtitle</screeninfo>
16802 <imagedata fileref="images/admin/cataloging/subtitledvdmapping.png"/>
16807 <para>Using this tool you can tell Koha to print the right field as
16808 the subtitle when viewing the bibliographic record in the OPAC.</para>
16811 <screeninfo>Subtitle display in the OPAC</screeninfo>
16815 <imagedata fileref="images/admin/cataloging/subtitlebookinopac.png"/>
16820 <para>This tool can be used to chain together pieces of the record as
16821 well. If you want the series number to show in the title on your
16822 search results you simply have to map 490 $v to 'subtitle' along with
16824 <para>Chain together the fields you want to show after the item
16825 title in the order in which you want them to appear.</para>
16828 <para>Future developments will include additional keyword assigned
16832 <section id="marcbibframeworkstest">
16833 <title>MARC Bibliographic Framework Test</title>
16835 <para>Checks the MARC structure.</para>
16839 <para><emphasis>Get there:</emphasis> More > Administration
16840 > Catalog > MARC Bibliographic Framework Test</para>
16844 <para>If you change your MARC Bibliographic framework it's recommended
16845 that you run this tool to test for errors in your definition.</para>
16848 <screeninfo>Framework Test</screeninfo>
16852 <imagedata fileref="images/admin/cataloging/frameworktest.png"/>
16858 <section id="authoritiesadmin">
16859 <title>Authority Types</title>
16861 <para>Authority Types are basically MARC Frameworks for Authority
16862 records and because of that they follow the same editing rules found
16863 in the <link linkend="marcbibframeworks">MARC Bibliographic
16864 Frameworks</link> section of this manual. Koha comes with many of the
16865 necessary Authority frameworks already installed. To learn how to add
16866 and edit Authority Types, simply review the <link linkend="marcbibframeworks">MARC Bibliographic Frameworks</link>
16867 section of this manual.</para>
16871 <para><emphasis>Get there:</emphasis> More > Administration
16872 > Catalog > Authority Types</para>
16877 <section id="classificationsources">
16881 <firstname>Savitra</firstname>
16882 <surname>Sirohi</surname>
16884 <orgname>Nucsoft OSS Labs</orgname>
16889 <firstname>Nicole C.</firstname>
16890 <surname>Engard</surname>
16891 <contrib>Fixed typos, changed content where
16892 necessary and added new screenshots.</contrib>
16896 <pubdate>2010</pubdate>
16899 <title>Classification Sources</title>
16901 <para>Source of classification or shelving scheme is an <link linkend="authorizedvalues"
16902 >Authorized Values</link> category that is mapped to field 952$2 and 942$2 in Koha's
16903 MARC Bibliographic frameworks and stored in the items.cn_source field in the
16908 <para><emphasis>Get there:</emphasis> More > Administration
16909 > Catalog > Classification sources</para>
16914 <screeninfo>Classification Sources</screeninfo>
16918 <imagedata fileref="images/admin/cataloging/classsources.png"/>
16923 <para>Commonly used values of this field are:</para>
16927 <para>ddc - Dewey Decimal Classification</para>
16931 <para>lcc - Library of Congress Classification</para>
16935 <para>If you chose to install classification sources during Koha's
16936 installation, you would see other values too:</para>
16940 <para>ANSCR (sound recordings)</para>
16944 <para>SuDOC classification</para>
16948 <para>Universal Decimal Classification</para>
16952 <para>Other/Generic Classification</para>
16956 <section id="addingclasssource">
16957 <title>Adding/Editing Classification Sources</title>
16959 <para>You can add your own source of classification by using the New
16960 Classification Source button. To edit use the Edit link.</para>
16963 <screeninfo>Add classification source</screeninfo>
16967 <imagedata fileref="images/admin/cataloging/addclasssource.png"/>
16972 <para>When creating or editing:</para>
16976 <para>You will need to enter a code and a description.</para>
16980 <para>Check the 'Source in use?' checkbox if you want the value
16981 to appear in the drop down list for this category.</para>
16985 <para>Select the appropriate <link linkend="classfilingrules">filing rule</link> from the drop down
16993 <section id="classfilingrules">
16994 <title>Classification Filing Rules</title>
16996 <para>Filing rules determine the order in which items are placed on
16999 <para>Values that are pre-configured in Koha are:</para>
17011 <para>Generic</para>
17015 <para>Filing rules are mapped to <link linkend="addingclasssource">Classification sources</link>. You can
17016 setup new filing rules by using the New Filing Rule button. To edit
17017 use the Edit link.</para>
17019 <para>When creating or editing:</para>
17023 <para>Enter a code and a description</para>
17027 <para>Choose an appropriate filing routine - dewey, generic or
17034 <section id="recordmatchingrules">
17038 <firstname>Joy</firstname>
17039 <surname>Nelson</surname>
17041 <orgname>ByWater Solutions</orgname>
17046 <firstname>Nicole C.</firstname>
17047 <surname>Engard</surname>
17048 <contrib>Changed/edited content where necessary.</contrib>
17052 <pubdate>2013</pubdate>
17054 <title>Record Matching Rules</title>
17056 <para>Record matching rules are used when importing MARC records into
17061 <para><emphasis>Get there:</emphasis> More > Administration
17062 > Catalog > Record Matching Rules</para>
17066 <para>The rules that you set up here will be referenced with you <link linkend="stagemarc">Stage MARC Records for Import</link>.</para>
17067 <para>It is important to understand the difference between Match Points and Match Checks
17068 before adding new matching rules to Koha.</para>
17070 <para>Match Points are the criteria that you enter that must be met in order for an incoming
17071 record to match an existing MARC record in your catalog. You can have multiple match
17072 points on an import rule each with its own score. An incoming record will be compared
17073 against your existing records (‘one record at a time’) and given a score for each match
17074 point. When the total score of the matchpoints matches or exceeds the threshold given for
17075 the matching rule, Koha assumes a good match and imports/overlays according your
17076 specifications in the import process. An area to watch out for here is the sum of the
17077 match points. Doublecheck that the matches you want will add up to a successful
17080 <para>Example: </para>
17081 <para>Threshold of 1000 </para>
17082 <para>Match Point on 020$a 1000 </para>
17083 <para>Match Point on 022$a 1000 </para>
17084 <para>Match Point on 245$a 500 </para>
17085 <para>Match Point on 100$a 100</para>
17087 <para>In the example above, a match on either the 020$a or the 022$a will result in a successful match. A match on 245$a title and 100$a author (and not on 020$a or 022$a) will only add up to 600 and not be a match. And a match on 020$a and 245$a will result in 1500 and while this is a successful match, the extra 500 point for the 245$a title match are superfluous. The incoming record successfully matched on the 020$a without the need for the 245$a match. However, if you assigned a score of 500 to the 100$a Match Point, a match on 245$a title and 100$a author will be considered a successful match (total of 1000) even if the 020$a is not a match.</para>
17089 <para>Match Checks are not commonly used in import rules. However, they can serve a couple of
17090 purposes in matching records. First, match checks can be used as the matching criteria
17091 instead of the match points if your indexes are stale and out of date. The match checks go
17092 right for the data instead of relying on the data in the indexes. (If you fear your
17093 indexes are out of date, a rebuild of your indexes would be a great idea and solve that
17094 situation!) The other use for a Match Check is as a “double check” or “veto” of your
17095 matching rule. For example, if you have a matching rule as below:</para>
17096 <para>Threshold of 1000 </para>
17097 <para>Match Point on 020$a 1000 </para>
17098 <para>Match Check on 245$a</para>
17100 <para>Koha will first look at the 020$a tag/subfield to see if the incoming record matches an existing record. If it does, it will then move on to the Match Check and look directly at the 245$a value in the incoming data and compare it to the 245$a in the existing ‘matched’ record in your catalog. If the 245$a matches, Koha continues on as if a match was successful. If the 245$a does not match, then Koha concludes that the two records are not a match after all. The Match Checks can be a really useful tool in confirming true matches.</para>
17102 <para>Match Points and Match Checks are powerful tools in the import process. Harness the power of these two matching criteria and make your data behave for you!</para>
17103 <section id="addrecordmatchrule">
17104 <title>Adding Matching Rules</title>
17105 <para>To create a new matching rule :</para>
17108 <para>Click 'New Record Matching Rule'</para>
17110 <screeninfo>Add record matching rule</screeninfo>
17113 <imagedata fileref="images/admin/cataloging/newmatchrule.png"/>
17119 <para>Choose a unique name and enter it in the 'Matching rule code' field</para>
17122 <para>'Description' can be anything you want to make it clear to you what rule
17123 you're picking</para>
17126 <para>'Match threshold' is the total number of 'points' a biblio must earn to be
17127 considered a 'match'</para>
17130 <para>'Record type' is the type of import this rule will be used for - either
17131 authority or bibliographic</para>
17134 <para>Match points are set up to determine what fields to match on</para>
17137 <para>'Search index' can be found by looking at the ccl.properties file on your
17138 system which tells the zebra indexing what data to search for in the MARC
17142 <para>'Score' - The number of 'points' a match on this field is worth. If the sum
17143 of each score is greater than the match threshold, the incoming record is a
17144 match to the existing record</para>
17147 <para>Enter the MARC tag you want to match on in the 'Tag' field</para>
17150 <para>Enter the MARC tag subfield you want to match on in the 'Subfields'
17154 <para>'Offset' - For use with control fields, 001-009</para>
17157 <para>'Length' - For use with control fields, 001-009</para>
17160 <para>Koha only has one 'Normalization rule' that removes extra characters such as
17161 commas and semicolons. The value you enter in this field is irrelevant to the
17162 normalization process.</para>
17165 <para>'Required match checks' - ??</para>
17171 <section id="samplerecordmatch">
17172 <title>Sample Bibliographic Record Matching Rule: Control Number</title>
17175 <screeninfo>LOC Matching Rule</screeninfo>
17179 <imagedata fileref="images/admin/cataloging/samplematchrule.png"/>
17186 <para>Match threshold: 100</para>
17189 <para>Record type: Bibliographic<itemizedlist>
17192 <para>If you'd like a rule to match on the 001 in authority records you will
17193 need the repeat all of these values and change just the record type to
17194 'Authority record'</para>
17197 </itemizedlist></para>
17201 <para>Matchpoints (just the one):</para>
17205 <para>Search index: Control-number</para>
17209 <para>Score: 101</para>
17213 <para>Tag: 001</para>
17218 <para>this field is for the control number assigned by the
17219 organization creating, using, or distributing the
17227 <para>Subfields: a</para>
17231 <para>Offset: 0</para>
17235 <para>Length: 0</para>
17239 <para>Normalization rule: Control-number</para>
17243 <para>Required Match checks: none (remove the blank one)</para>
17246 <screeninfo>Remove match check</screeninfo>
17250 <imagedata fileref="images/admin/cataloging/removematchcheck.png"/>
17259 <section id="oaisetsconfig">
17260 <title>OAI Sets Configuration</title>
17262 <para>On this page you can create, modify and delete OAI-PMH
17265 <section id="oaicreate">
17266 <title>Create a set</title>
17268 <para>To create a set:</para>
17272 <para>Click on the link 'Add a new set'</para>
17276 <para>Fill the mandatory fields 'setSpec' and 'setName'</para>
17280 <para>Then you can add descriptions for this set. To do this
17281 click on 'Add description' and fill the newly created text box.
17282 You can add as many descriptions as you want.</para>
17286 <para>Click on 'Save' button'</para>
17291 <section id="oaimodify">
17292 <title>Modify/Delete a set</title>
17294 <para>To modify a set, just click on the link 'Modify' on the same
17295 line of the set you want to modify. A form similar to set creation
17296 form will appear and allow you to modify the setSpec, setName and
17297 descriptions.</para>
17299 <para>To delete a set, just click on the link 'Delete' on the same
17300 line of the set you want to delete.</para>
17303 <section id="oaimapping">
17304 <title>Define mappings</title>
17306 <para>Here you can define how a set will be build (what records will
17307 belong to this set) by defining mappings. Mappings are a list of
17308 conditions on record content. A record only need to match one
17309 condition to belong to the set.</para>
17313 <para>Fill the fields 'Field', 'Subfield' and 'Value'. For
17314 example if you want to include in this set all records that have
17315 a 999$9 equal to 'XXX'. Fill 'Field' with 999, 'Subfield' with 9
17316 and 'Value' with XXX.</para>
17320 <para>If you want to add another condition, click on 'OR' button
17321 and repeat step 1.</para>
17325 <para>Click on 'Save'</para>
17329 <para>To delete a condition, just leave at least one of 'Field',
17330 'Subfield' or 'Value' empty and click on 'Save'.<note>
17331 <para>Actually, a condition is true if value in the
17332 corresponding subfield is strictly equal to what is defined if
17333 'Value'. A record having 999$9 = 'XXX YYY' will not belong to a
17334 set where condition is 999$9 = 'XXX'.</para>
17337 <para>And it is case sensitive : a record having 999$9 = 'xxx' will
17338 not belong to a set where condition is 999$9 = 'XXX'.</para>
17341 <section id="oaibuild">
17342 <title>Build sets</title>
17344 <para>Once you have configured all your sets, you have to build the
17345 sets. This is done by calling the script
17346 misc/migration_tools/build_oai_sets.pl.</para>
17351 <section id="acqadmin">
17352 <title>Acquisitions</title>
17354 <para>The Koha Acquisitions module provides a way for the library to
17355 record orders placed with vendors and manage purchase budgets.</para>
17357 <para>Before using the <link linkend="acqmodule">Acquisitions
17358 Module</link>, you will want to make sure that you have completed all of
17363 <para><emphasis>Get there:</emphasis> More > Administration >
17364 Acquisitions</para>
17368 <section id="currexchangeadmin">
17369 <title>Currencies and Exchange Rates</title>
17371 <para>If you place orders from more than one country you will want to
17372 input currency exchange rates so that your acquisitions module will
17373 properly calculate totals.</para>
17377 <para><emphasis>Get there:</emphasis> More > Administration
17378 > Acquisitions > Currencies and Exchange Rates</para>
17383 <screeninfo>Currencies</screeninfo>
17387 <imagedata fileref="images/admin/acquisitions/currencies.png"/>
17393 <para>This data is not automatically updated, so be sure to keep it
17394 up to date so that your accounting is kept correct.</para>
17397 <para>The active currency is the main currency you use in your
17398 library. Your active currency will have a check mark in the 'Active'
17399 column. If you don't have an active currency you will see an error
17400 message telling you to choose an active currency.</para>
17403 <screeninfo>No active currency warning</screeninfo>
17407 <imagedata fileref="images/admin/acquisitions/nocurrency.png"/>
17413 <section id="budgetplanning">
17414 <title>Budgets</title>
17416 <para>Budgets are used for tracking accounting values related to
17417 acquisitions. For example you could create a Budget for the current
17418 year (ex. 2012) and then break that into <link linkend="funds">Funds</link> for different areas of the library (ex.
17419 Books, Audio, etc).</para>
17423 <para><emphasis>Get there:</emphasis> More > Administration
17424 > Acquisitions > Budgets</para>
17428 <para>When visiting the main budget administration you will see two
17429 tabs, one for active and one for inactive budgets.</para>
17432 <screeninfo>Budgets List</screeninfo>
17436 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
17441 <section id="addbudget">
17442 <title>Add a budget</title>
17444 <para>Budgets can either be created from scratch or by duplicating
17445 the previous year's budget.</para>
17447 <para>To duplicate a budget from a previous year, click on the link
17448 for the budget name from the list of budgets</para>
17451 <screeninfo>Budgets List</screeninfo>
17455 <imagedata fileref="images/admin/acquisitions/budgetslist.png"/>
17460 <para>On the screen listing the budget breakdown click the Edit
17461 button at the top and choose to Duplicate budget</para>
17464 <screeninfo>Duplicate Budget</screeninfo>
17468 <imagedata fileref="images/admin/acquisitions/duplicatebudget.png"/>
17473 <para>You will be presented with a form where you simply need to
17474 enter the new start and end date and save the budget.</para>
17477 <screeninfo>New Duplicate Budget</screeninfo>
17481 <imagedata fileref="images/admin/acquisitions/duplicatestartend.png"/>
17486 <para>This will not only duplicate your budget, but all of the funds
17487 associated with that budget so that you can reuse budgets and funds
17488 from year to year.</para>
17490 <para>If you haven't used Koha before for acquisitions then you'll
17491 need to start fresh with a new budget. To add a new budget click the
17492 'New Budget' button.</para>
17495 <screeninfo>New Budget Form</screeninfo>
17499 <imagedata fileref="images/admin/acquisitions/newbudgetform.png"/>
17506 <para>Choose the time period this budget is for, whether it's an
17507 academic year, a fiscal year, a quarter, etc.</para>
17511 <para>The Description should be something that will help you
17512 identify the budget when ordering</para>
17516 <para>In the amount box do not use any symbols, simply enter the
17517 amount of the budget with numbers and decimals.</para>
17521 <para>Marking a budget active makes it usable when placing
17522 orders in the acquisitions module, even if the order is placed
17523 after the budget end date. This will allow you to record orders
17524 that were places in a previous budget period.</para>
17528 <para>Locking a budget means that Funds will not be able to be
17529 modified by librarians</para>
17533 <para>Once you have made your edits, click the 'Save Changes'
17534 button. You will be brought to a list of your existing
17538 <screeninfo>List of Budgets</screeninfo>
17542 <imagedata fileref="images/admin/acquisitions/budgetlist.png"/>
17549 <section id="funds">
17550 <title>Funds</title>
17554 <para><emphasis>Get there:</emphasis> More > Administration
17555 > Acquisitions > Funds</para>
17559 <section id="addbudgetfund">
17560 <title>Add a Fund</title>
17562 <para>A fund is added to a budget.</para>
17565 <para>A <link linkend="addbudget">budget</link> must be defined
17566 before a fund can be created.</para>
17567 </important>To add a new fund click the New button and then choose
17568 which Budget you would like to add the fund to.</para>
17571 <screeninfo>Choose which budget to add a fund to</screeninfo>
17575 <imagedata fileref="images/admin/acquisitions/newfund.png"/>
17580 <para>In the form that appears you wan to enter the basics about
17584 <screeninfo>New Fund Form</screeninfo>
17588 <imagedata fileref="images/admin/acquisitions/newfundform.png"/>
17593 <para>The three first fields are required, the rest are
17598 <para>Fund Code is a unique identifier for your fund</para>
17602 <para>The Fund Name should be something that librarians will
17607 <para>Amount should be entered with only numbers and decimals, no other
17611 <para>Warning at (%) or Warning at (amount) can be filled in to make Koha warn you
17612 before you spend a certain percentage or amount of your budget. This will prevent
17613 you from overspending.</para>
17617 <para>You can choose to assign this fund to a librarian. Doing
17618 so will make it so that only that librarian can make changes to
17623 <para>Choose which library will be using this fund</para>
17627 <para>You can restrict who can order from this fund by choosing either the 'owner',
17628 'owner and users' or 'owner, users and library' from the 'Restrict access to'
17632 <screeninfo>Restrict Fund Access</screeninfo>
17636 <imagedata fileref="images/admin/acquisitions/restrictfund.png"/>
17643 <para>Without an owner, the access restriction will be ignored, be sure to enter
17644 an owner as well as choose a restriction</para>
17651 <para>Notes are simply for any descriptive notes you might want
17652 to add so that librarians know when to use this fund</para>
17656 <para>Planning categories are used for statistical purposes. To
17657 learn more about planning categories, check out the <link linkend="planningcatfaq">Planning Category FAQ</link>.</para>
17661 <para>When complete, click 'Submit' and you will be brought to a
17662 list of all of the funds for the budget.</para>
17665 <screeninfo>List of funds</screeninfo>
17669 <imagedata fileref="images/admin/acquisitions/fundlist.png"/>
17674 <para>To the right of each fund you will find the 'Edit,' 'Delete,' and 'Add Child Fund'
17676 <para>A child fund simply a sub-fund of the fund listed. An example would be to have a
17677 fund for 'Fiction' and under that have a fund for 'New Releases' and a fund for 'Science
17678 Fiction.' It is an optional way to further organize your finances.</para>
17679 <para>Funds with children will show with a small arrow to the left. Clicking that will
17680 show you the children funds.</para>
17682 <screeninfo>Chld funds</screeninfo>
17685 <imagedata fileref="images/admin/acquisitions/childfunds.png"/>
17691 <section id="fundsplanning">
17692 <title>Budget Planning</title>
17694 <para>When viewing the list of funds click the 'Planning' button and
17695 choose how you would like to plan to spend your budget.</para>
17698 <screeninfo>Planning pull down menu</screeninfo>
17702 <imagedata fileref="images/admin/acquisitions/planningpulldown.png"/>
17707 <para>If you choose 'Plan by MONTHS' you will see the budgeted
17708 amount broken down by months:</para>
17711 <screeninfo>Budget Planning Formula</screeninfo>
17715 <imagedata fileref="images/admin/acquisitions/planningbymonths.png"/>
17720 <para>To hide some of the columns you can click the 'hide' link to the right (or below as
17721 in the screenshot above) the dates. To add more columns you can click the 'Show a
17722 column' link found below the 'Fund Remaining' heading.</para>
17725 <screeninfo>Choose columns to add</screeninfo>
17729 <imagedata fileref="images/admin/acquisitions/addplanningcol.png"/>
17734 <para>From here you can plan your budget spending by manually
17735 entering values or by clicking the 'Auto-fill row' button. If you
17736 choose to auto-fill the form the system will try to divide the
17737 amount accordingly, you may have to make some edits to split things
17738 more accurately.</para>
17741 <screeninfo>Auto-filled columns</screeninfo>
17745 <imagedata fileref="images/admin/acquisitions/autofill.png"/>
17750 <para>Once your changes are made, click the 'Save' button. If you
17751 would like to export your data as a CSV file you can do so by
17752 entering a file name in the 'Output to a file named' field and
17753 clicking the 'Output' button.</para>
17756 <screeninfo>Export planning as CSV</screeninfo>
17760 <imagedata fileref="images/admin/acquisitions/planningcsv.png"/>
17768 <section id="additionaladmin">
17769 <title>Additional Parameters</title>
17773 <para><emphasis>Get there:</emphasis> More > Administration >
17774 Additional Parameters</para>
17778 <section id="z3950admin">
17779 <title>Z39.50 Servers</title>
17781 <para>Z39.50 is a client–server protocol for searching and retrieving information from
17782 remote computer databases, in short it's a tool used for copy cataloging. Using Koha you
17783 can connect to any Z39.50 target that is publicly available or that you have the log in
17784 information to and copy both bibliographic and/or authority records from that
17789 <para><emphasis>Get there:</emphasis> More > Administration
17790 > Additional Parameters > Z39.50 Servers</para>
17794 <para>Koha comes with a default list of Z39.50 targets set up that you
17795 can add to, edit or delete</para>
17798 <screeninfo>List of Z39.50 Servers in Koha</screeninfo>
17802 <imagedata fileref="images/admin/additional/z39list.png"/>
17807 <para>To find additional targets you use IndexData's IRSpy: <ulink
17808 url="http://irspy.indexdata.com/">http://irspy.indexdata.com</ulink> or the Library of
17809 Congress's List of Targets <ulink url="http://www.loc.gov/z3950/"
17810 >http://www.loc.gov/z3950/</ulink>
17813 <section id="addztarget">
17814 <title>Add a Z39.50 Target</title>
17818 <para>From the main Z39.50 page, click 'New Z39.50
17821 <screeninfo>New Z39.50 Server Form</screeninfo>
17824 <imagedata fileref="images/admin/additional/newz39.png"/>
17831 <para>'Z39.50 server' should be populated with a name that will help you identify
17832 the source (such as the library name).</para>
17835 <para>'Hostname' will be the address to the Z39.50 target.</para>
17838 <para>'Port' tells Koha what port to listen on to get results from this
17842 <para>'Userid' and 'Password' are only required for servers that are password
17846 <para>Check the 'Checked' box if you want this target to always be selected by
17850 <para>'Rank' lets you enter where in the list you'd like this target to appear.<itemizedlist>
17852 <para>If this is left blank the targets will be in alphabetical
17855 </itemizedlist></para>
17858 <para>'Syntax' is the MARC flavor you use.</para>
17861 <para>'Encoding' tells the system how to read special characters.</para>
17864 <para>'Timeout' is helpful for targets that take a long while. You can set the
17865 timeout so that it doesn't keep trying the target if results aren't found in a
17866 reasonable amount of time.</para>
17869 <para>'Record type' lets you define if this is a bibliographic or an authority
17877 <section id="suggestztarget">
17878 <title>Suggested Bibliographic Z39.50 Targets</title>
17879 <para>Koha libraries with open Z39.50 targets can share and find connection information on
17880 the Koha wiki: <ulink url="http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources"
17881 >http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources</ulink>. You can also
17882 find open Z39.50 targets by visiting IRSpy: <ulink url="http://irspy.indexdata.com"
17883 >http://irspy.indexdata.com</ulink>.</para>
17885 <para>The following targets have been used successfully by other
17886 Koha libraries (in the Americas):</para>
17890 <para>ACCESS PENNSYLVANIA 205.247.101.11:210 INNOPAC</para>
17893 <para>CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210
17898 <para>GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC</para>
17902 <para>HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210
17907 <para>HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton_hills</para>
17911 <para>LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB</para>
17915 <para>LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210
17920 <para>MANITOBA PUBLIC library.gov.mb.ca:210 horizon</para>
17924 <para>MILTON PL cat.mpl.on.ca:210 horizon</para>
17928 <para>NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default</para>
17931 <para>NHUPAC 199.192.6.130:211 nh_nhupac</para>
17934 <para>OCEAN STATE LIBRARIES (RI) catalog.oslri.net:210 INNOPAC</para>
17937 <para>OHIOLINK olc1.ohiolink.edu:210 INNOPAC</para>
17940 <para>PUBCAT prod890.dol.state.vt.us:2300 unicorn</para>
17943 <para>SAN JOAQUIN VALLEY PUBLIC LIBRARY SYSTEM (CA) hip1.sjvls.org:210 ZSERVER</para>
17946 <para>SEATTLE PUBLIC LIBRARY ZSERVER.SPL.ORG:210 HORIZON</para>
17950 <para>TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200
17955 <para>TRI-UNI 129.97.129.194:7090 voyager</para>
17959 <para>VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon</para>
17963 <section id="suggestauthz39">
17964 <title>Suggested Authority Z39.50 Targets</title>
17965 <para>The following targets have been used successfully by other Koha libraries (in the
17969 <para>LIBRARIESAUSTRALIA AUTHORITIES z3950-test.librariesaustralia.nla.gov.au:210
17970 AuthTraining Userid: ANLEZ / Password: z39.50</para>
17973 <para>LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF </para>
17976 <para>LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF</para>
17981 <section id="didyoumean">
17982 <title>Did you mean?</title>
17983 <para><emphasis>Get there:</emphasis> More > Administration > Additional Parameters
17984 > Did you mean?</para>
17985 <para>Koha can offer 'Did you mean?' options on searches based on values in your <link linkend="catauthorities">authorities</link>. <important>
17986 <para>Did you mean? only works in the OPAC at this time. The Intranet options are here
17987 for future development.</para>
17988 </important></para>
17989 <para>Using this page you can control which options Koha gives patrons on their search results.</para>
17991 <screeninfo>Did you mean?</screeninfo>
17994 <imagedata fileref="images/admin/additional/didyoumean.png"/>
17998 <para>To turn on the 'Did you mean?' bar on your search results you need to check the box
17999 next to each plugin you would like to use. The two plugins you have to choose from are:<itemizedlist>
18001 <para>The ExplodedTerms plugin suggests that the user try searching for
18002 broader/narrower/related terms for a given search (e.g. a user searching for "New
18003 York (State)" would click the link for narrower terms if they're also interested in
18004 "New York (City)"). This is only relevant for libraries with highly hierarchical
18005 authority data. </para>
18008 <para>The AuthorityFile plugin searches the authority file and suggests the user might
18009 be interested in bibs linked to the top 5 authorities</para>
18011 </itemizedlist></para>
18012 <para>If you want one plugin to take priority over another you simply drag it above the other.</para>
18014 <screeninfo>Drag and drop options</screeninfo>
18017 <imagedata fileref="images/admin/additional/didyoumeandrag.png"/>
18021 <para>If you choose both plugins you will see several options at the top of your search results</para>
18023 <screeninfo>Both plugins</screeninfo>
18026 <imagedata fileref="images/admin/additional/didyoumeanopacexplode.png"/>
18030 <para>If you choose just the AuthorityFile you'll see just authorities.</para>
18032 <screeninfo>AuthorityFile</screeninfo>
18035 <imagedata fileref="images/admin/additional/didyoumeanopacauth.png"/>
18043 <chapter id="tools">
18044 <title>Tools</title>
18046 <para>Tools in Koha all perform some sort of action. Often many of the
18047 items listed under Tools in Koha are referred to as 'Reports' in other
18048 library management systems.</para>
18052 <para><emphasis>Get there:</emphasis> More > Tools</para>
18056 <section id="patrontools">
18057 <title>Patrons and Circulation</title>
18060 <section id="patronlists">
18061 <title>Patron lists</title>
18064 <para><emphasis>Get there:</emphasis> More > Tools > Patrons and Circulation >
18065 Patron lists</para>
18068 <para>Patron lists are a way to store a group of patrons for easy modification via the <link
18069 linkend="batchpatronmod">batch patron modification tool</link> or reporting.</para>
18071 <screeninfo>Patron lists</screeninfo>
18074 <imagedata fileref="images/tools/patronlists/patronlists.png"/>
18078 <para>To create a new list of patrons click the 'New patron list' button</para>
18080 <screeninfo>New patron list</screeninfo>
18083 <imagedata fileref="images/tools/patronlists/newpatronlist.png"/>
18087 <para>Enter a list name and save the list.</para>
18089 <screeninfo>Empty patron list</screeninfo>
18092 <imagedata fileref="images/tools/patronlists/addtopatronlist.png"/>
18096 <para>To add patrons to the list click the 'Add patron's button to the right of the list name.</para>
18098 <screeninfo>Add patron to a list</screeninfo>
18101 <imagedata fileref="images/tools/patronlists/addpatrontolist.png"/>
18105 <para>Enter the patron's name or cardnumber in the search box and click on the right result
18106 to add the patron.</para>
18108 <screeninfo>Patrons to add</screeninfo>
18111 <imagedata fileref="images/tools/patronlists/patronstoadd.png"/>
18115 <para>Once you have all of the patrons you would like to add you can click the 'Update'
18116 button to save them to the list.</para>
18118 <screeninfo>List of patrons</screeninfo>
18121 <imagedata fileref="images/tools/patronlists/patronlist.png"/>
18127 <section id="comments">
18128 <title>Comments</title>
18132 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18133 and Circulation > Comments</para>
18137 <para>All comments added by patrons via the OPAC to bibliographic
18138 records require moderation by the librarians. If there are comments
18139 awaiting moderation they will be listed on the main staff dashboard
18140 under the Tools label:</para>
18143 <screeninfo>Comments pending approval</screeninfo>
18147 <imagedata fileref="images/tools/comments/commentswaiting.png"/>
18152 <para>To moderate comments click on the notification on the main
18153 dashboard or go directly to the Comments Tool and click 'Approve' or
18154 'Delete' to the right of the comments awaiting moderation.</para>
18157 <screeninfo>Comment awaiting moderation</screeninfo>
18161 <imagedata fileref="images/tools/comments/commentmoderation.png"/>
18166 <para>If there are no comments to moderate you will see a message
18167 saying just that</para>
18170 <screeninfo>No comments to moderate</screeninfo>
18174 <imagedata fileref="images/tools/comments/nocomments.png"/>
18179 <para>You can also review and unapprove comments you have approved in
18180 the past by choosing the 'Approved comments' tab</para>
18183 <screeninfo>Approved comments</screeninfo>
18187 <imagedata fileref="images/tools/comments/commentapproved.png"/>
18193 <section id="patronimport">
18194 <title>Patron Import</title>
18198 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18199 and Circulation > Import Patrons</para>
18203 <para>The patron import tool can be used at any time to add patrons in
18204 bulk. It is commonly used in universities and schools when a new batch
18205 of students registers.</para>
18207 <section id="createpatronfile">
18208 <title>Creating Patron File</title>
18210 <para>Your Koha installation comes with a blank CSV file that you
18211 can use as a template for your patron records. If you would like to
18212 create the file yourself, make sure that your file has the following
18213 fields in this order as the header row:</para>
18215 <para>borrowernumber, cardnumber, surname, firstname, title, othernames, initials,
18216 streetnumber, streettype, address, address2, city, zipcode, country, email, phone,
18217 mobile, fax, emailpro, phonepro, B_streetnumber, B_streettype, B_address, B_address2,
18218 B_city, B_zipcode, B_country, B_email, B_phone, dateofbirth, branchcode, categorycode,
18219 dateenrolled, dateexpiry, gonenoaddress, lost, debarred, contactname, contactfirstname,
18220 contacttitle, guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex,
18221 password, flags, userid, opacnote, contactnote, sort1, sort2, altcontactfirstname,
18222 altcontactsurname, altcontactaddress1, altcontactaddress2, altcontactaddress3,
18223 altcontactzipcode, altcontactcountry, altcontactphone, smsalertnumber, patron_attributes<important>
18224 <para>The borrowernumber column should not be left blank. If you do not have data for
18225 that column you should delete that column before importing your patrons.</para>
18226 </important></para>
18229 <para>The 'password' value should be stored in plain text, and
18230 will be converted to a md5 hash (which is an encrypted version of
18231 the password).</para>
18233 <para>If your passwords are already encrypted, talk to your
18234 systems administrator about options</para>
18238 <para>Date formats should match your <link linkend="dateformat">system preference</link>, and must be
18239 zero-padded, e.g. '01/02/2008'.</para>
18243 <para>The fields 'branchcode', 'categorycode' and all fields you have defined in the
18244 <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> preference are
18245 required and must match valid entries in your database.</para>
18249 <para>If loading <link linkend="patronattributetypes">patron
18250 attributes</link>, the 'patron_attributes' field should contain a
18251 comma-separated list of attribute types and values.</para>
18255 <para>The attribute type code and a colon should precede each
18260 <para>For example: <emphasis role="bold">INSTID:12345,LANG:fr</emphasis> or <emphasis role="bold">STARTDATE:January 1
18261 2010,TRACK:Day</emphasis></para>
18265 <para>If an input record has more than one attribute, the
18266 fields should either be entered as an unquoted string
18267 (previous examples), or with each field wrapped in
18268 separate double quotes and delimited by a comma:</para>
18272 <para><emphasis role="bold">"STARTDATE:January 1,
18273 2010","TRACK:Day"</emphasis></para>
18277 <para>This syntax would be required if the data might
18278 have a comma in it, like a date string.</para>
18288 <section id="importpatrons">
18289 <title>Importing Patrons</title>
18291 <para>Once you have created your file, you can use the Patron Import
18292 Tool to bring the data into Koha.</para>
18295 <screeninfo>Import Patron Form</screeninfo>
18299 <imagedata fileref="images/tools/importpatrons/importpatrons.png"/>
18306 <para>Choose your CSV file and choose to match on 'Cardnumber'
18307 to prevent adding of duplicate card numbers to the system</para>
18311 <para>Next you can choose default values to apply to all patrons
18312 you are importing</para>
18316 <para>ex. If you're importing patrons specific to one branch
18317 you can use the field on the Import form to apply the branch
18318 code to all those you are importing.</para>
18324 <para>Finally you need to decide on what data you want to
18325 replace if there are duplicates.</para>
18328 <screeninfo>Record matching options</screeninfo>
18332 <imagedata fileref="images/tools/importpatrons/patronmatching.png"/>
18339 <para>A matching record is found using the field you chose
18340 for matching criteria to prevent duplication</para>
18344 <para>If you included patron attributes in your file you can
18345 decide whether to add your values to existing values or
18346 erase existing values and enter only your new values.</para>
18354 <section id="notices">
18355 <title>Notices & Slips</title>
18359 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18360 and Circulation > Notices & Slips</para>
18364 <para>All notices and circulation receipts (or slips) generated by
18365 Koha can be customized using the Notices & Slips Tool. The system
18366 comes with several predefined templates that will appear when you
18367 first visit this tool.</para>
18370 <screeninfo>Notices & Slips Tool</screeninfo>
18374 <imagedata fileref="images/tools/notices/notices.png"/>
18379 <para>Each notice can be edited, but only a few can be deleted, this
18380 is to prevent system errors should a message try to send without a
18381 template. Each notice and slip can be edited on a per library basis,
18382 by default you will see the notices for all libraries.</para>
18384 <para>If you have a style you'd like applied to all slips you can
18385 point the <link linkend="SlipCSS">SlipCSS</link> preference to a
18386 stylesheet. The same is true for notices, using the <link linkend="NoticeCSS">NoticeCSS</link> preference to define a
18389 <section id="addnotices">
18390 <title>Adding Notices & Slips</title>
18392 <para>To add a new notice or slip</para>
18396 <para>Click 'New Notice'</para>
18399 <screeninfo>New Notice Form</screeninfo>
18403 <imagedata fileref="images/tools/notices/newnotice.png"/>
18410 <para>Choose which library this notice or slip is for</para>
18414 <para>Choose the module this notice is related to</para>
18418 <para>The Code is limited to 20 characters</para>
18423 <para>When working with the overdue notices you want each
18424 notice at each branch to have a unique code. Think about
18425 using the branch code in front of the notice code for each
18433 <para>Use the name field to expand on your Code</para>
18438 <para>With overdue notices, be sure to put your branch
18439 name in the description as well so that it will be visible
18440 when setting up your <link linkend="noticetriggers">triggers</link>.</para>
18447 <para>If you plan on writing the notice or slip in HTML check
18448 the 'HTML Message' box, otherwise the content will be generated
18449 as plain text</para>
18453 <para>Message Subject is what will appear in the subject line of
18458 <para>In the message body feel free to type whatever message you
18459 feel is best, use the fields on the left hand side to enter
18460 individualized data from the from database.</para>
18465 <para>Overdue notices can use <<items.content>> tags by themselves,
18466 or use <item></item> to span all of the tags. Learn more about the
18467 <link linkend="noticemarkup">Overdue Notice Markup</link></para>
18470 <para>On overdue notices make sure to use <<items.content>> tags
18471 to print out the data related to all items that are overdue.</para>
18476 <para>The other option, only for overdue notices, is to use the
18477 <item></item> tags to span the line so that it will print out
18478 multiple lines One example for the <item></item> tag option
18480 <para><item>"<<biblio.title>>" by
18481 <<biblio.author>>, <<items.itemcallnumber>>,
18482 Barcode: <<items.barcode>> , Checkout date:
18483 <<issues.issuedate>>, Due date:
18484 <<issues.date_due>> Fine: <<items.fine>> Due date:
18485 <<issues.date_due>> </item></para>
18492 <para>Only the overdue notices take advantage of the <item></item>
18493 tags, all other notices referencing items need to use
18494 <<items.content>></para>
18499 <para>To add today's date you can use the <<today>> syntax</para>
18506 <section id="noticemarkup">
18507 <title>Overdue Notice Markup</title>
18509 <para>When creating your overdue notices there are two tags in addition to the various
18510 database fields that you can use in your notices.<important>
18511 <para>These new tags only work on the overdue notices, not other circulation related
18512 notices at this time.</para>
18513 </important>These tags are <item> and </item> which should enclose all
18514 fields from the biblio, biblioitems, and items tables.</para>
18516 <para>An example of using these tags in a notice template might be like:</para>
18518 <programlisting> The following item(s) is/are currently overdue:
18520 <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <<items.fine>></item></programlisting>
18522 <para>Which, assuming two items were overdue, would result in a notice
18523 like:<programlisting> The following item(s) is/are currently overdue:
18525 "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: 3.50
18526 "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: 3.50</programlisting></para>
18530 <section id="existingnotices">
18531 <title>Existing Notices & Slips</title>
18533 <para>Among the default notices are notices for several common
18534 actions within Koha. All of these notices can be customized by
18535 altering their text via the Notices & Slips tool and their style
18536 using the <link linkend="NoticeCSS">NoticeCSS</link> preference to
18537 define a stylesheet. Here are some of what those notices do</para>
18541 <para id="ACCTDETAILS">ACCTDETAILS</para>
18545 <para>Sent to patrons when their account is set up if the
18546 <link linkend="AutoEmailOPACUser">AutoEmailOPACUser</link>
18547 preference is set to 'Send'</para>
18553 <para id="ACQCLAIM">ACQCLAIM (Acquisition Claim)</para>
18557 <para>Used in the claim acquisition module</para>
18561 <para><emphasis>Get there:</emphasis> More > Acquisitions
18562 > Late issues</para>
18568 <para id="HOLDnotice">HOLD (Hold Available for Pickup)</para>
18572 <para>This notice is used if two criteria are met:</para>
18576 <para>The <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
18577 is set to 'Allow'</para>
18581 <para>The patron has requested to receive this
18586 <para><emphasis>Get there: </emphasis>OPAC >
18587 Login > my messaging</para>
18591 <para><emphasis>Get there: </emphasis>Staff Client
18592 > Patron Record > <link linkend="patnotices">Notices</link></para>
18600 <para>When this notice references the branches table it is
18601 referring to the pickup branch information.</para>
18607 <para id="HOLDPLACED">HOLDPLACED (a notice to the library staff
18608 that a hold has been placed)</para>
18612 <para>This notice requires the <link linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
18613 system preference to be set to 'Enable'</para>
18617 <para>When this notice references the branches table it is
18618 referring to the pickup branch information.</para>
18624 <para id="HOLD_PRINT">HOLD_PRINT (Printed notice when hold
18625 available for pickup)</para>
18629 <para>This notice is used for hold confirmation notices that
18630 are sent out in print format. This will not effect what the
18631 email notice looks like.</para>
18635 <para>When this notice references the branches table it is
18636 referring to the pickup branch information.</para>
18642 <para id="ODUE">ODUE (Overdue Notice)</para>
18646 <para>This notice is used to send Overdue Notices to
18651 <para>See a <link linkend="samplenotice">Sample Overdue
18652 Notice</link></para>
18656 <para>Requires that you set <link linkend="noticetriggers">Overdue Notice/Status
18657 Triggers</link></para>
18663 <para id="RLIST">RLIST (Routing List)</para>
18667 <para>Used in the serials module to notify patrons/staff of
18668 new issues of a serial</para>
18672 <para><emphasis>Get there:</emphasis> More > Serials
18673 > <link linkend="newsubscription">New
18674 Subscription</link></para>
18680 <para>You have the option to select the 'Routing List'
18681 notice when creating a new subscription (Choose from the
18682 'Patron notification' drop down).</para>
18687 <para>Notice also that if you'd like to notify patrons of
18688 new serial issues, you can click on 'define a notice'
18689 which will take you to the 'Notices' tool</para>
18696 <para>There are also a set of predefined slips (or receipts) listed
18697 on this page. All of these slips can be customized by altering their
18698 text via the Notices & Slips tool and their style using the
18699 <link linkend="SlipCSS">SlipCSS</link> preference to define a
18700 stylesheet. Here is what those slips are used for:</para>
18704 <para>ISSUEQSLIP</para>
18708 <para>Used to print the quick slip in circulation</para>
18712 <para>The quick slip only includes items that were checked
18719 <para>ISSUESLIP</para>
18723 <para>Used to print a full slip in circulation</para>
18727 <para>The slip or receipt will show items checked out today
18728 as well as items that are still checked out</para>
18734 <para>RESERVESLIP</para>
18738 <para>Used to print a holds slip</para>
18742 <para>The holds slip is generated when a hold is
18749 <para>TRANSFERSLIP</para>
18753 <para>Used to print a transfer slip</para>
18757 <para>The transfer slip is printed when you confirm a
18758 transfer from one branch to another in your system</para>
18766 <section id="noticetriggers">
18767 <title>Overdue Notice/Status Triggers</title>
18771 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18772 and Circulation > Overdue Notice/Status Triggers</para>
18776 <para>In order to send the overdue notices that you defined using the
18777 <link linkend="notices">Notices</link> tool, you need to first set the
18778 triggers to have these messages.</para>
18781 <para>In order to have overdue notices sent to your patrons, you
18782 need to <link linkend="addingpatroncat">set that patron
18783 category</link> to require overdue notices.</para>
18786 <para>The Overdue Notice/Status Triggers tool gives the librarian the
18787 power to send up to three notices to each patron type notifying them
18788 of overdue items</para>
18791 <screeninfo>Overdue Notice/Status Triggers Tool</screeninfo>
18795 <imagedata fileref="images/tools/triggers.png"/>
18802 <para>Delay is the number of days after an issue is due before an
18803 action is triggered.</para>
18808 <para>If you want Koha to trigger an action (send a letter
18809 or restrict member), a delay value is required.</para>
18816 <para>To send additional notices, click on the tabs for 'Second'
18817 and 'Third' notice</para>
18821 <para>If you would like to prevent a patron from checking items out because of their
18822 overdue items, check the 'Restrict' box, this will put a notice on the patron's record
18823 at checkout informing the librarian that the patron cannot check out due to overdue items.<itemizedlist>
18825 <para>If you choose to restrict a patron in this way you can also have Koha
18826 automatically remove that restriction with the <link
18827 linkend="AutoRemoveOverduesRestrictions">AutoRemoveOverduesRestrictions</link>
18830 </itemizedlist></para>
18834 <para>See a <link linkend="samplenotice">Sample Overdue
18835 Notice</link></para>
18840 <section id="patroncardcreator">
18841 <title>Patron Card Creator</title>
18845 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
18846 and Circulation > Patron Card Creator</para>
18850 <para>The Patron Card Creator allow you to use layouts and templates
18851 which you design to print a nearly unlimited variety of patron cards
18852 including barcodes. Here are some of the features of the Patron Card
18853 Creator module:</para>
18857 <para>Customize patron card layouts</para>
18861 <para>Design custom card templates for printed patron cards</para>
18865 <para>Build and manage batches of patron cards</para>
18869 <para>Export single or multiple batches</para>
18873 <para>Export single or multiple patron cards from within a
18878 <para>Export card data as a PDF readable by any standard PDF
18879 reader, making patron cards printable directly on a printer</para>
18883 <para>At the top of each screen within the Patron Card Creator, you
18884 will see a toolbar allowing quick access to relevant functions. The
18885 menu to the left of each screen also allows easy access to the
18886 different sections of the Patron Card Creator. The bread crumb trail
18887 near the top of each screen will give specific indication as to where
18888 you are within the Patron Card Creator module and allow quick
18889 navigation to previously traversed sections. And finally, you can find
18890 more detailed information on each section of the Patron Card Creator
18891 by clicking the online help link at the upper left-hand corner of
18894 <section id="patrontemplate">
18895 <title>Templates</title>
18899 <para><emphasis>Get there:</emphasis> More > Tools >
18900 Patron Card Creator > Templates</para>
18904 <para>A template is the label/card stock you are using. This might
18905 be Avery 5160 for address labels, Gaylord 47-284 for spine labels or
18906 Avery 28371 for your patron cards, just to give a couple of
18907 examples. These labels will include all of the information you will
18908 need for setting up a Koha, this information may be on the
18909 packaging, and if not it can usually be found on the vendor's
18912 <section id="addcardtemplate">
18913 <title>Add a Template</title>
18915 <para>To add a new template, you want to click on the 'Templates'
18916 button at the top of your page and choose 'New Template'</para>
18919 <screeninfo>New Template Button</screeninfo>
18923 <imagedata fileref="images/tools/patroncards/newtemplate.png"/>
18928 <para>Using the form that appears you can define the template for
18929 your sheet of labels or cards.</para>
18932 <screeninfo>Add Patron Card Template</screeninfo>
18936 <imagedata fileref="images/tools/patroncards/edittemplate.png"/>
18943 <para>Template ID will be automatically generated after saving
18944 your template, this is simply a system generated unique
18949 <para>Template Code should be something you can use to
18950 identify your template on a list of templates</para>
18954 <para>You can use the Template Description to add additional
18955 information about the template</para>
18959 <para>The Units pull down is used to define what measurement
18960 scale you're going to be using for the template. This should
18961 probably match the unit of measurement used on the template
18962 description provided by the product vendor.</para>
18965 <screeninfo>Measurement Units</screeninfo>
18969 <imagedata fileref="images/tools/patroncards/units.png"/>
18976 <para>The measurements can be found on the vendor product
18977 packaging or website.</para>
18981 <para>A profile is a set of "adjustments" applied to a given
18982 template just prior to printing which compensates for
18983 anomalies unique and peculiar to a given printer (to which the
18984 profile is assigned).</para>
18988 <para>Before picking a profile try printing some sample
18989 cards so that you can easily define a profile that is
18990 right for your printer/template combination.</para>
18994 <para>After finding any anomalies in the printed document,
18995 <link linkend="addcardprofile">create a profile</link> and
18996 assign it to the template.</para>
19002 <para>After saving, your templates will appear on the 'Manage
19003 Templates' page.</para>
19006 <screeninfo>Manage Templates</screeninfo>
19010 <imagedata fileref="images/tools/patroncards/managetemplates.png"/>
19017 <section id="patronprofile">
19018 <title>Profiles</title>
19022 <para><emphasis>Get there:</emphasis> More > Tools >
19023 Patron Card Creator > Profiles</para>
19027 <para>A profile is a set of "adjustments" applied to a given <link linkend="patrontemplate">template</link> just prior to printing
19028 which compensates for anomalies unique and peculiar to a given
19029 printer (to which the profile is assigned). This means if you set a
19030 template up and then print a sample set of data and find that the
19031 items are not all aligned the same on each card, you need to set up
19032 a profile for each printer to make up for the differences in
19033 printing styles, such as the shifting of text to the left, right,
19034 top or bottom.</para>
19036 <para>If your cards are printing just the way you want, you will not
19037 need a profile.</para>
19039 <section id="addcardprofile">
19040 <title>Add a Profile</title>
19042 <para>To add a new profile, you want to click on the 'Profiles'
19043 button at the top of your page and choose 'New Profile'</para>
19046 <screeninfo>New Profile Button</screeninfo>
19050 <imagedata fileref="images/tools/patroncards/newprofile.png"/>
19055 <para>Using the form that appears you can create a profile to fix
19056 any problems with your template.</para>
19059 <screeninfo>Add Printer Profile</screeninfo>
19063 <imagedata fileref="images/tools/patroncards/addprofile.png"/>
19070 <para>The Printer Name and Paper Bin do not have to match your
19071 printer exactly, they are for your reference so you can
19072 remember what printer you have set the profile for. So if you
19073 want to use the Printer model number in printer name or you
19074 can call it 'the printer on my desk'</para>
19078 <para>Template will be filled in once you have chosen which
19079 template to apply the profile to on the <link linkend="addcardtemplate">template edit form</link></para>
19083 <para>The Units pull down is used to define what measurement
19084 scale you're going to be using for your profile.</para>
19087 <screeninfo>Units of Measurement</screeninfo>
19091 <imagedata fileref="images/tools/patroncards/units.png"/>
19098 <para>Offset describes what happens when the entire image is
19099 off center either vertically or horizontally and creep
19100 describes a condition where the distance between the labels
19101 changes across the page or up and down the page</para>
19105 <para>For these values, negative numbers move the error up
19106 and to the left and positive numbers move the error down
19107 and to the right</para>
19111 <para>Example: the text is .25" from the left edge of the
19112 first label, .28" from the left edge of the second label
19113 and .31" from the left edge of the third label. This means
19114 the horizontal creep should be set to .03" to make up for
19115 this difference.</para>
19121 <para>After saving, your profiles will appear on the 'Manage
19122 Profiles' page.</para>
19125 <screeninfo>Manage Profiles</screeninfo>
19129 <imagedata fileref="images/tools/patroncards/manageprofiles.png"/>
19134 <para>Once you have saved your new profile, you can return to the
19135 list of templates and choose to edit the template that this
19136 profile is for.</para>
19140 <section id="cardlayouts">
19141 <title>Layouts</title>
19145 <para><emphasis>Get there:</emphasis> More > Tools >
19146 Patron Card Creator > Layouts</para>
19150 <para>A layout defines the text and images that will be printed on
19151 to the card and where it will appear.</para>
19153 <section id="addcardlayout">
19154 <title>Add a Layout</title>
19156 <para>To add a new layout, you want to click on the 'Layouts'
19157 button at the top of your page and choose 'New Layout'</para>
19160 <screeninfo>New Layout Button</screeninfo>
19164 <imagedata fileref="images/tools/patroncards/newlayout.png"/>
19169 <para>Using the form that appears you can create a profile to fix
19170 any problems with your template.</para>
19173 <screeninfo>Add New Layout</screeninfo>
19177 <imagedata fileref="images/tools/patroncards/addlayout.png"/>
19184 <para>The name you assign to the layout is for your benefit,
19185 name it something that will be easy to identify at a later
19190 <para>The Units pull down is used to define what measurement
19191 scale you're going to be using for your layout.</para>
19194 <screeninfo>Units of Measurement</screeninfo>
19198 <imagedata fileref="images/tools/patroncards/units.png"/>
19205 <para>Next note if this layout is for the front or the back of
19206 the patron card</para>
19210 <para>You will need a layout for both the front and back
19211 of your card if you have 2-sided library cards</para>
19217 <para>You have the option of adding up to 3 lines of text to
19218 your card. Your text can be static text of your choosing
19219 and/or fields from the patron record. If you want to print
19220 fields from the patron record you want to put the field names
19221 in brackets like so - <firstname></para>
19225 <para>For each line of text, you can choose your font, font
19226 size and the location of the text on the card using the lower
19227 X and Y coordinates</para>
19231 <para>In order to show the barcode and the patron card number
19232 you will need to check the 'Print Card Number as Barcode'
19233 option. This will turn the patron card number into a barcode.
19234 If you want the number to print in human readable format you
19235 will need to check the 'Print Card Number as Text Under
19236 Barcode' option.</para>
19240 <para>Finally you can choose up to two images to print on the
19245 <para>One can be the <link linkend="uploadpatronimages">patron image</link> which you
19246 can resize to meet your needs.</para>
19250 <para>The other image can be something like a library logo
19251 or symbol that you uploaded using the '<link linkend="managecardimages">Manage Images</link>' module of
19252 the Patron Card Creator Tool.</para>
19258 <para>After saving, your layouts will appear on the 'Manage
19259 Layouts' page.</para>
19262 <screeninfo>Manage Layouts</screeninfo>
19266 <imagedata fileref="images/tools/patroncards/managelayouts.png"/>
19273 <section id="patroncardbatches">
19274 <title>Batches</title>
19278 <para><emphasis>Get there:</emphasis> More > Tools >
19279 Patron Card Creator > Batches</para>
19283 <para>A batch is a collection of patrons for whom you want to
19284 generate cards.</para>
19286 <section id="addcardbatch">
19287 <title>Add a Batch</title>
19289 <para>To add a new batch, you want to click on the 'Batches'
19290 button at the top of your page and choose 'New Batch'</para>
19293 <screeninfo>New Batch Button</screeninfo>
19297 <imagedata fileref="images/tools/patroncards/newbatch.png"/>
19306 <section id="managecardimages">
19307 <title>Manage Images</title>
19311 <para><emphasis>Get there:</emphasis> More > Tools >
19312 Patron Card Creator > Manage Images</para>
19316 <para>Images uploaded using this tool will appear on the menu when
19317 creating <link linkend="cardlayouts">patron card layouts</link>. You
19318 are limited in how many images you can upload (not counting patron
19319 images) by the <link linkend="ImageLimit">ImageLimit</link> system
19323 <para>Images must be under 500k in size.</para>
19327 <para>Pictures uploaded with this tool should be at least 300dpi
19328 which is the minimum quality for a printable image.</para>
19331 <para>In the center of the screen is a simple upload form, simply
19332 browse for the file on your computer and give it a name you'll
19333 recognize later.</para>
19336 <screeninfo>Upload Images</screeninfo>
19340 <imagedata fileref="images/tools/patroncards/imageupload.png"/>
19345 <para>Once the file is uploaded you will be presented with a
19346 confirmation message.</para>
19349 <screeninfo>Image Uploaded</screeninfo>
19353 <imagedata fileref="images/tools/patroncards/imageuploaded.png"/>
19358 <para>And the image will be listed with all of your others on the
19359 right hand side of the page.</para>
19362 <screeninfo>Images</screeninfo>
19366 <imagedata fileref="images/tools/patroncards/imagedelete.png"/>
19371 <para>To delete one or multiple of these images, click the checkbox
19372 to the right of each image you want to delete and click the 'Delete'
19377 <section id="anonpatrons">
19378 <title>Patrons (anonymize, bulk-delete)</title>
19382 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
19383 and Circulation > Patrons (anonymize, bulk-delete)</para>
19386 <para>This tool allows you to bulk anonymize circulation histories (this means that you keep
19387 records of how many times items were checked out - but not the patrons who checked the
19388 items out) or bulk delete patrons (remove them from the system completely).<important>
19389 <para>Patrons with outstanding fines or items checked out are not saved. They are not
19390 completely removed from the system (they are only moved to the delete_borrowers
19391 table), but this tool does not provide as many checks as one may desire.</para>
19392 </important></para>
19394 <para>Before using this tool it is recommended that you backup your database. Changes made
19395 here are permanent.</para>
19398 <para>The anonymization will fail quietly if <link linkend="AnonymousPatron">AnonymousPatron</link> preference does not contain a valid value.</para>
19402 <screeninfo>Patron Anonymize/Bulk Delete Tool</screeninfo>
19406 <imagedata fileref="images/tools/anonymize/patronbulkdelete.png"/>
19411 <para>To either delete or anonymize patrons</para>
19415 <para>Check the 'Verify' box on the task you would like to complete (Delete or
19420 <para>Enter a date before which you want to alter the data</para>
19423 <para>If deleting patrons you can also choose to find patrons with a specific expiration
19424 date or category</para>
19428 <para>Click 'Next'</para>
19432 <para>A confirmation will appear asking if you're sure this is
19433 what you want to happen</para>
19436 <screeninfo>Patron Anonymize/Bulk Delete
19437 Confirmation</screeninfo>
19441 <imagedata fileref="images/tools/anonymize/patronanonconfirm.png"/>
19448 <para>Clicking 'Finish' will delete or anonymize your data</para>
19451 <screeninfo>Completed Process</screeninfo>
19455 <imagedata fileref="images/tools/anonymize/patronanoncomplete.png"/>
19463 <section id="batchpatronmod">
19464 <title>Batch patron modification</title>
19468 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
19469 and Circulation > Batch patron modification</para>
19473 <para>With this tool you can make edits to a batch of patron records. Simply load in a file
19474 of cardnumbers (one per line), choose from a <link linkend="patronlists">list of
19475 patrons</link> or scan patron card numbers in to the box provided.</para>
19478 <screeninfo>Batch patron modification</screeninfo>
19482 <imagedata fileref="images/tools/batchpatron/batchmodify.png"/>
19487 <para>Once you have the file loaded or the barcodes scanned click
19488 'Continue.' You will be presented with a list of the patrons and the
19489 changes you can make.</para>
19492 <screeninfo>Patrons to modify</screeninfo>
19496 <imagedata fileref="images/tools/batchpatron/modifyform.png"/>
19501 <para>To the left of each text box there is a checkbox. Clicking that
19502 checkbox will clear our the field values. <important>
19503 <para>If the field is mandatory you will not be able to clear the
19504 value in it.</para>
19505 </important></para>
19507 <para>If you have multiple patron attributes you can change them all
19508 by using the plus (+) sign to the right of the text box. This will
19509 allow you to add another attribute value.</para>
19512 <screeninfo>Editing patron attributes</screeninfo>
19516 <imagedata fileref="images/tools/batchpatron/attributes.png"/>
19521 <para>Once you have made the changes you want, you can click 'Save'
19522 and Koha will present you with the changed patron records.</para>
19525 <section id="tagsmoderation">
19526 <title>Tag Moderation</title>
19530 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
19531 and Circulation > Tags</para>
19535 <para>Depending on your <link linkend="taggingprefs">tagging system preferences</link>,
19536 librarians may need to approve tags before they are published on the OPAC. This is done
19537 via the Tag Moderation Tool. If there are tags awaiting moderation they will be listed on
19538 the main staff dashboard under the module labels:</para>
19541 <screeninfo>Tags pending approval</screeninfo>
19545 <imagedata fileref="images/tools/tagging/pendingtags.png"/>
19550 <para>To moderate the tags visit the Tags tool. When first visiting
19551 the tool, you will be presented with a list of tags that are pending
19552 approval or rejection by a librarian</para>
19555 <screeninfo>Tags pending moderation</screeninfo>
19559 <imagedata fileref="images/tools/tagging/tagpending.png"/>
19566 <para>To see all of the titles this tag was added to simply click on the term<screenshot>
19567 <screeninfo>Titles with a specific tag</screeninfo>
19570 <imagedata fileref="images/tools/tagging/taggedtitles.png"/>
19573 </screenshot><itemizedlist>
19575 <para>From this list of titles you can remove a tag without outright rejecting it
19576 from being used in the future by clicking the 'Remove tag' button to the right
19577 of the title.</para>
19579 </itemizedlist></para>
19582 <para>To approve a tag, you can either click the 'Approve' button in line with the term,
19583 or check all terms you want to approve and click 'Approve' below the table.</para>
19587 <para>To reject a tag, you can either click the 'Reject' button in
19588 line with the term, or check all terms you want to approve and
19589 click 'Reject' below the table.</para>
19593 <para>Once a tag has been approved or rejected it will be moved to the
19594 appropriate list of tags. A summary of all tags will appear on the
19595 right of the screen.</para>
19598 <screeninfo>Summary of tags</screeninfo>
19602 <imagedata fileref="images/tools/tagging/tagsummary.png"/>
19607 <para>Even though a tag is approved or rejected, it can still be moved
19608 to another list. When viewing approved tags each tag has the option to
19612 <screeninfo>Approved Tags</screeninfo>
19616 <imagedata fileref="images/tools/tagging/tagapproved.png"/>
19621 <para>To check terms against the approved and rejected lists (and
19622 possibly against <link linkend="TagsExternalDictionary">the
19623 dictionary</link> you have assigned for tag moderation) simply enter
19624 the term into the search box on the bottom right of the screen to see
19625 the status of the term</para>
19628 <screeninfo>Sample Check list test search</screeninfo>
19632 <imagedata fileref="images/tools/tagging/tagblacklisttest-neither.png"/>
19636 <para>Finally you can find tags by using the filters on the left.</para>
19638 <screeninfo>Tag filters</screeninfo>
19641 <imagedata fileref="images/tools/tagging/tagfilters.png"/>
19647 <section id="uploadpatronimages">
19648 <title>Upload Patron Images</title>
19652 <para><emphasis>Get there:</emphasis> More > Tools > Patrons
19653 and Circulation > Upload Patron Images</para>
19657 <para>Patron images can be uploaded in bulk if you are <link linkend="patronimages">allowing patron images</link> to be attached to
19658 patron records. These images can also be used when creating <link linkend="patroncardcreator">patron cards</link>.</para>
19662 <para>Create a txt file and title it "DATALINK.TXT" or
19663 "IDLINK.TXT"</para>
19667 <para>On each line in the text file enter the patron's card number
19668 followed by comma (or tab) and then the image file name</para>
19671 <screeninfo>Sample file and image</screeninfo>
19675 <imagedata fileref="images/tools/patronphotos/uploadphotosfile.png"/>
19682 <para>Make sure that your TXT file is a plain text document,
19689 <para>Zip up the text file and the image files</para>
19693 <para>Go to the Upload Patron Images Tool</para>
19696 <screeninfo>Upload Image Tool for Single Image</screeninfo>
19700 <imagedata fileref="images/tools/patronphotos/uploadimagetool.png"/>
19707 <para>For a single image, simply point to the image file and enter
19708 the patron card number</para>
19712 <para>For multiple images, choose to upload a zip file</para>
19716 <para>After uploading you will be presented with a
19717 confirmation</para>
19720 <screeninfo>Image Upload Confirmation</screeninfo>
19724 <imagedata fileref="images/tools/patronphotos/imageuploadconfirm.png"/>
19732 <para>There is a limit of 100K on the size of the picture uploaded and it is recommended
19733 that the image be 200x300 pixels, but smaller images will work as well.</para>
19738 <section id="catalogtools">
19739 <title>Catalog</title>
19743 <section id="batchmodifyitems">
19744 <title>Batch item modification</title>
19748 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19749 > Batch item modification</para>
19753 <para>This tool will allow you to modify a batch of item records in
19757 <screeninfo>Batch Modification Tool</screeninfo>
19761 <imagedata fileref="images/tools/batchmod/batchmod.png"/>
19766 <para>From the tool you can choose to upload a file of barcodes or item ids, or you can scan
19767 items one by one into the box below the upload tool. You can also decide the items edited
19768 should be populated with the default values you have defined in your <link
19769 linkend="marcbibframeworks">default framework</link>.</para>
19770 <para>Once you have your file uploaded or the barcodes listed you can click
19774 <screeninfo>Batch Modify Summary</screeninfo>
19778 <imagedata fileref="images/tools/batchmod/batchmodsummary.png"/>
19783 <para>You will be presented with a summary of the items you want to modify. From here you
19784 can uncheck the items you don't want to modify before making changes in the form below.
19785 You can also hide columns you don't need to see to prevent having to scroll from left to
19786 right to see the entire item form.<tip>
19787 <para>To uncheck all items thar are currently checked out you can click the 'Clear on
19788 loan' link at the top of the form.</para>
19791 <para>Using the edit form you can choose which fields to make edits
19792 to. By checking the checkbox to the right of each field you can clear
19793 the values in that field for the records you are modifying.</para>
19796 <screeninfo>Choose fields you want to change in bulk</screeninfo>
19800 <imagedata fileref="images/tools/batchmod/batchmodform.png"/>
19805 <para>Once you have made you changes you will be presented with the
19806 resulting items.</para>
19809 <screeninfo>Item results summary</screeninfo>
19813 <imagedata fileref="images/tools/batchmod/batchmodresults.png"/>
19819 <para>You can also edit items on one bib record in a batch by going
19820 to the bib record and clicking Edit > Edit items in batch</para>
19824 <screeninfo>Edit items in a batch</screeninfo>
19828 <imagedata fileref="images/tools/batchmod/editinbatch.png"/>
19834 <section id="batchdeleteitems">
19835 <title>Batch item deletion</title>
19839 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19840 > Batch item deletion</para>
19844 <para>This tool will allow you to delete a batch of item records from
19847 <para>From the tool you can choose to upload a file of barcodes or
19848 item ids, or you can scan items one by one into the box below the
19849 upload tool.</para>
19852 <screeninfo>Batch Deletion Tool</screeninfo>
19856 <imagedata fileref="images/tools/batchdelete/batchdel.png"/>
19861 <para>Once you have your file uploaded or the barcodes scanned you can
19862 click 'Continue.'</para>
19864 <para>You will be presented with a confirmation screen. From here you can uncheck the items
19865 you don't want to delete and decide if Koha should delete the bib record if the last item
19866 is being deleted before clicking 'Delete selected items.' If you'd like you can delete
19867 the bibliogrphic record if you're deleting the last item by clicking the checkbox next to
19868 'Delete records if no items remain'.</para>
19871 <screeninfo>Confirm Deletion</screeninfo>
19875 <imagedata fileref="images/tools/batchdelete/confirmbatchdel.png"/>
19880 <para>If your file (or list of scanned barcodes) has more than 1000
19881 barcodes, Koha will be unable to present you with a list of the items.
19882 You will still be able to delete them, but not able to choose which
19883 items specifically to delete or delete the biblio records.</para>
19886 <screeninfo>More than 1000 records in the file</screeninfo>
19890 <imagedata fileref="images/tools/batchdelete/toomanytodelete.png"/>
19895 <para>If the items are checked out you will be presented with an error
19896 after clicking 'Delete selected items' and the items will not be
19900 <screeninfo>Items not Deleted</screeninfo>
19904 <imagedata fileref="images/tools/batchdelete/nobatchdel.png"/>
19909 <para>If the items can be deleted they will be and you will be
19910 presented with a confirmation of your deletion.</para>
19913 <screeninfo>Batch Deletion Confirmation</screeninfo>
19917 <imagedata fileref="images/tools/batchdelete/batchdeldone.png"/>
19923 <section id="exportbibs">
19924 <title>Export Data (MARC & Authorities)</title>
19928 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
19929 > Export Data</para>
19933 <para>Koha comes with a tool that will allow you to export your
19934 bibliographic, holdings and/or authority data in bulk. This can be
19935 used to send your records to fellow libraries, organizations or
19936 services; or simply for backup purposes.</para>
19938 <section id="exportmarc">
19939 <title>Export Bibliographic Records</title>
19941 <para>At the top of the screen you need to pick what data you're
19942 exporting. If you're exporting bibliographic records with or without
19943 the holdings information you want to click the 'Export bibliographic
19944 records' tab.</para>
19948 <para>Fill in the form in order to limit your export to a
19949 specific range (all fields are optional)</para>
19952 <screeninfo>Select Records to Export</screeninfo>
19956 <imagedata fileref="images/tools/exportmarc/marcexport-pt1.png"/>
19963 <para>Choose to limit your export by any one or more of the
19964 following options</para>
19968 <para>Limit to a bib number range</para>
19972 <para>Limit to a specific item type<itemizedlist>
19975 <para>This limit will use the type you have defined in the <link
19976 linkend="item-level_itypes">item-level_itypes</link> preference.
19977 If you have the item-level_itypes preference set to 'specific item'
19978 and you have no items attached to a bib record it will not be
19979 exported. To get all bib records of a specific type you will need
19980 your item-level_itypes preference set to 'biblio record'.</para>
19983 </itemizedlist></para>
19987 <para>Limit to a specific library</para>
19991 <para>Limit to a call number range</para>
19995 <para>Limit to an acquisition date range</para>
20001 <para>Next choose what to skip when exporting</para>
20004 <screeninfo>Export options</screeninfo>
20008 <imagedata fileref="images/tools/exportmarc/marcexport-pt2.png"/>
20015 <para>By default items will be exported, if you would
20016 like to only export bibliographic data, check the 'Don't
20017 export items' box</para>
20021 <para>To limit your export only to items from the
20022 library you're logged in as (if you leave the 'Library'
20023 field set to 'All') or to the library you selected above
20024 check the 'Remove non-local items' box</para>
20028 <para>You can also choose what fields you don't want to
20029 export. This can be handy if you're sharing your data,
20030 you can remove all local fields before sending your data
20031 to another library</para>
20037 <para>Finally choose the file type and file name</para>
20040 <screeninfo>File export format</screeninfo>
20044 <imagedata fileref="images/tools/exportmarc/marcexport-pt3.png"/>
20051 <para>Choose to export your data in marc or marcxml
20056 <para>Choose the name you want your file to save
20063 <para>Click 'Export bibliographic records'</para>
20070 <section id="exportauthority">
20071 <title>Export Authority Records</title>
20073 <para>At the top of the screen you need to pick what data you're
20074 exporting. If you're exporting authority records you want to click
20075 the 'Export authority records' tab.</para>
20079 <para>Fill in the form in order to limit your export to a
20080 specific range or type of authority record (all fields are
20084 <screeninfo>Export authorities</screeninfo>
20088 <imagedata fileref="images/tools/exportmarc/authexport-pt1.png"/>
20095 <para>Next choose fields that you would like to exclude from the
20096 export separated by a space (no commas)</para>
20099 <screeninfo>Authority export options</screeninfo>
20103 <imagedata fileref="images/tools/exportmarc/authexport-pt2.png"/>
20110 <para>If you'd like to exclude all subfields of the 200 for
20111 example just enter 200</para>
20115 <para>If you'd like to exclude a specific subfield enter it
20116 beside the field value 100a will exclude just the subfield
20117 'a' of the 100</para>
20123 <para>Finally choose the file type and file name</para>
20126 <screeninfo>Export format</screeninfo>
20130 <imagedata fileref="images/tools/exportmarc/authexport-pt3.png"/>
20137 <para>Choose to export your data in marc or marcxml
20142 <para>Choose the name you want your file to save as</para>
20148 <para>Click 'Export authority records'</para>
20154 <section id="inventory">
20155 <title>Inventory/Stocktaking</title>
20159 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
20160 > Inventory/Stocktaking</para>
20164 <para>Koha's Inventory Tool can be used in one of two ways, the first
20165 is by printing out a shelf list that you can then mark items off on,
20166 or by uploading a text files of barcodes gathered by a portable
20169 <para>If you do not have the ability to use your barcode scanner on
20170 the floor of the library, the first option available to you is to
20171 generate a shelf list based on criteria you enter.</para>
20174 <screeninfo>Inventory & Stocktaking Tool</screeninfo>
20178 <imagedata fileref="images/tools/inventory/generateshelflist.png"/>
20183 <para>Choose which library, shelving location, call number range, item
20184 status and when the item was last seen to generate a shelf list that
20185 you can then print to use while walking around the library checking
20186 your collection</para>
20189 <screeninfo>Shelf List</screeninfo>
20193 <imagedata fileref="images/tools/inventory/shelflist.png"/>
20198 <para>Alternatively you can export the list to a CSV file for altering
20199 in an application on your desktop. Simply check the box next to
20200 'Export to csv file' to generate this file.</para>
20202 <para>Once you have found the items on your shelves you can return to
20203 this list and check off the items you found to have the system update
20204 the last seen date to today.</para>
20206 <para>If you have a portable scanner (or a laptop and USB scanner) you
20207 can walk through the library with the scanner in hand and scan
20208 barcodes as you come across them. Once finished you can then upload
20209 the text file generated by the scanner to Koha</para>
20212 <screeninfo>Barcode Import for Inventory Tool</screeninfo>
20216 <imagedata fileref="images/tools/inventory/importbarcodes.png"/>
20221 <para>Choose the text file and the date you want to mark all items as seen and then scroll
20222 to the very bottom and click 'Submit.'</para>
20225 <section id="labelcreator">
20226 <title>Label Creator</title>
20230 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
20231 > Label Creator</para>
20235 <para>The Label Creator allow you to use layouts and templates which
20236 you design to print a nearly unlimited variety of labels including
20237 barcodes. Here are some of the features of the Label Creator
20242 <para>Customize label layouts</para>
20246 <para>Design custom label templates for printed labels</para>
20250 <para>Build and manage batches of labels</para>
20254 <para>Export single or multiple batches</para>
20258 <para>Export single or multiple labels from within a batch</para>
20262 <para>Export label data in one of three formats:</para>
20266 <para>PDF - Readable by any standard PDF reader, making labels
20267 printable directly on a printer</para>
20271 <para>CSV - Export label data after your chosen layout is
20272 applied allowing labels to be imported in to a variety of
20273 applications</para>
20277 <para>XML - Included as an alternate export format</para>
20283 <para>At the top of each screen within the Label Creator, you will see
20284 a toolbar allowing quick access to relevant functions. The menu to the
20285 left of each screen also allows easy access to the different sections
20286 of the Label Creator. The bread crumb trail near the top of each
20287 screen will give specific indication as to where you are within the
20288 Label Creator module and allow quick navigation to previously
20289 traversed sections. And finally, you can find more detailed
20290 information on each section of the Label Creator by clicking the
20291 online help link at the upper left-hand corner of every page.</para>
20293 <section id="labeltemplates">
20294 <title>Templates</title>
20298 <para><emphasis>Get there:</emphasis> More > Tools > Label
20299 Creator > Templates</para>
20303 <para>A template is based on the label/card stock you are using.
20304 This might be Avery 5160 for address labels, Gaylord 47-284 for
20305 spine labels or Avery 28371 for your patron cards, just to give a
20306 couple of examples. These labels will include all of the information
20307 you will need for setting up a Koha, this information may be on the
20308 packaging, and if not it can usually be found on the vendor's
20311 <section id="addlabeltemplate">
20312 <title>Add a Template</title>
20314 <para>To add a new template, you want to click on the 'New template' button at the top
20315 of the Label Creator.</para>
20318 <screeninfo>New Label Template Option</screeninfo>
20322 <imagedata fileref="images/tools/labelcreator/newtemplate.png"/>
20327 <para>Using the form that appears you can define the template for
20328 your sheet of labels or cards.</para>
20331 <screeninfo>Label Template Form</screeninfo>
20335 <imagedata fileref="images/tools/labelcreator/labelform.png"/>
20342 <para>Template ID will be automatically generated after saving
20343 your template, this is simply a system generated unique
20348 <para>Template Code should be something you can use to
20349 identify your template on a list of templates</para>
20353 <para>You can use the Template Description to add additional
20354 information about the template</para>
20358 <para>The Units pull down is used to define what measurement
20359 scale you're going to be using for the template. This should
20360 probably match the unit of measurement used on the template
20361 description provided by the product vendor.</para>
20364 <screeninfo>Measurement Units</screeninfo>
20368 <imagedata fileref="images/tools/patroncards/units.png"/>
20375 <para>The measurements, number of columns and number of rows
20376 can be found on the vendor product packaging or
20382 <para>If you do not supply a left text margin in the
20383 template, a 3/16" (13.5 point) left text margin will
20384 apply by default.</para>
20391 <para>A profile is a set of "adjustments" applied to a given
20392 template just prior to printing which compensates for
20393 anomalies unique and peculiar to a given printer (to which the
20394 profile is assigned).</para>
20398 <para>Before picking a profile try printing some sample
20399 labels so that you can easily define a profile that is
20400 right for your printer/template combination.</para>
20404 <para>After finding any anomalies in the printed document,
20405 <link linkend="addlabelprofile">create a profile</link>
20406 and assign it to the template.</para>
20412 <para>After saving, your templates will appear on the 'Manage
20413 Templates' page.</para>
20416 <screeninfo>List of label templates</screeninfo>
20420 <imagedata fileref="images/tools/labelcreator/labeltemplates.png"/>
20427 <section id="labelprofiles">
20428 <title>Profiles</title>
20432 <para><emphasis>Get there:</emphasis> More > Tools > Label
20433 Creator > Profiles</para>
20437 <para>A profile is a set of "adjustments" applied to a given <link linkend="addlabeltemplate">template</link> just prior to printing
20438 which compensates for anomalies unique and peculiar to a given
20439 printer (to which the profile is assigned). This means if you set a
20440 template up and then print a sample set of data and find that the
20441 items are not all aligned the same on each label, you need to set up
20442 a profile for each printer to make up for the differences in
20443 printing styles, such as the shifting of text to the left, right,
20444 top or bottom.</para>
20446 <para>If your labels are printing just the way you want, you will
20447 not need a profile.</para>
20449 <section id="addlabelprofile">
20450 <title>Add a Profile</title>
20452 <para>To add a new profile, you want to click on the 'New profile' button at the top of
20453 the Label Creator tool.</para>
20456 <screeninfo>New Profile Button</screeninfo>
20460 <imagedata fileref="images/tools/labelcreator/newprofile.png"/>
20465 <para>Using the form that appears you can create a profile to fix
20466 any problems with your template.</para>
20469 <screeninfo>Create a Printer Profile</screeninfo>
20473 <imagedata fileref="images/tools/labelcreator/newprofileform.png"/>
20480 <para>The Printer Name and Paper Bin do not have to match your
20481 printer exactly, they are for your reference so you can
20482 remember what printer you have set the profile for. So if you
20483 want to use the Printer model number in printer name or you
20484 can call it 'the printer on my desk'</para>
20488 <para>Template will be filled in once you have chosen which
20489 template to apply the profile to on the <link linkend="addlabeltemplate">template edit form</link></para>
20493 <para>The Units pull down is used to define what measurement
20494 scale you're going to be using for your profile.</para>
20497 <screeninfo>Units of Measurement</screeninfo>
20501 <imagedata fileref="images/tools/patroncards/units.png"/>
20508 <para>Offset describes what happens when the entire image is
20509 off center either vertically or horizontally and creep
20510 describes a condition where the distance between the labels
20511 changes across the page or up and down the page</para>
20515 <para>For these values, negative numbers move the error up
20516 and to the left and positive numbers move the error down
20517 and to the right</para>
20521 <para>Example: the text is .25" from the left edge of the
20522 first label, .28" from the left edge of the second label
20523 and .31" from the left edge of the third label. This means
20524 the horizontal creep should be set to .03" to make up for
20525 this difference.</para>
20531 <para>After saving, your profiles will appear on the 'Manage
20532 Profiles' page.</para>
20535 <screeninfo>List of Profiles</screeninfo>
20539 <imagedata fileref="images/tools/labelcreator/profiles.png"/>
20544 <para>Once you have saved your new profile, you can return to the
20545 list of templates and choose to edit the template that this
20546 profile is for.</para>
20550 <section id="labellayouts">
20551 <title>Layouts</title>
20555 <para><emphasis>Get there:</emphasis> More > Tools > Label
20556 Creator > Layouts</para>
20560 <para>A layout is used to define the fields you want to appear on
20561 your labels.</para>
20563 <section id="addlabellayout">
20564 <title>Add a Layout</title>
20566 <para>To add a new layout, you want to click on the 'New layout' button at the top of
20567 the Label Creator tool.</para>
20570 <screeninfo>New Layout Button</screeninfo>
20574 <imagedata fileref="images/tools/labelcreator/newlayout.png"/>
20579 <para>Using the form that appears you can create a profile to fix
20580 any problems with your template.</para>
20583 <screeninfo>Add New Layout</screeninfo>
20587 <imagedata fileref="images/tools/labelcreator/layoutform.png"/>
20594 <para>The name of your layout can be anything you'd like to
20595 help you identify it later.</para>
20599 <para>If this is a barcode label you'll want to choose the
20600 encoding (Code 39 is the most common)</para>
20604 <para>The layout type can be any combination of bibliographic
20605 information and/or barcode. For example a spine label would
20606 just be Biblio whereas a label for your circulation staff to
20607 use to checkout the book would probably be
20608 Biblio/Barcode.</para>
20612 <para>The Bibliographic Data to Print includes any of the data
20613 fields that may be mapped to your MARC frameworks. You can
20614 choose from the preset list of fields or you can click on
20615 'List Fields' and enter your own data. In 'List Fields', you
20616 can specify MARC subfields as a 4-character tag-subfield
20617 string: (ie. 254a for the title field), You can also enclose a
20618 whitespace-separated list of fields to concatenate on one line
20619 in double quotes. (ie. "099a 099b" or "itemcallnumber
20620 barcode"). The fields available are from the database tables
20621 list below. Finally you could add in static text strings in
20622 single-quote (ie. 'Some static text here.')</para>
20626 <para>You can use the schema viewer (<ulink url="http://schema.koha-community.org">http://schema.koha-community.org</ulink>)
20627 with the following tables to find field names to
20632 <para>Currently all fields in the following tables are
20633 used: items, biblioitems, biblio, branches</para>
20636 <screeninfo>List fields</screeninfo>
20640 <imagedata fileref="images/tools/labelcreator/listlabelfields.png"/>
20651 <para>Choose if the label maker should print out the
20652 guidelines around each label</para>
20656 <para>Choose if you'd like Koha to try to split your call
20657 numbers (usually used on Spine Labels)</para>
20661 <para>Finally choose your text settings such as alignment,
20662 font type and size.</para>
20666 <para>After saving, your layouts will appear on the 'Manage
20667 Layouts' page.</para>
20671 <section id="labelbatches">
20672 <title>Batches</title>
20676 <para><emphasis>Get there:</emphasis> More > Tools > Label
20677 Creator > Batches</para>
20681 <para>Batches are made up of the barcodes you would like to print.
20682 Once in this tool you can search for the item records you would like
20683 to print out labels for.</para>
20685 <section id="addlabelbatch">
20686 <title>Add a Batch</title>
20688 <para>Batches can be created in one of two ways. The first is to
20689 click the 'Create Label Batch' link on the '<link linkend="managestaged">Staged MARC Management</link>' page:</para>
20692 <screeninfo>Create Label Batch Link on Staged Records
20697 <imagedata fileref="images/tools/labelcreator/labelfromstaged.png"/>
20702 <para>The other is to choose to create a new batch from the label
20703 creator tool</para>
20706 <screeninfo>Create New Batch</screeninfo>
20710 <imagedata fileref="images/tools/labelcreator/newbatch.png"/>
20715 <para>You will be brought to an empty batch with an 'Add item(s)'
20716 button at the top of the page and a box to scan barcodes in
20720 <screeninfo>Add Items</screeninfo>
20724 <imagedata fileref="images/tools/labelcreator/addbatchitems.png"/>
20729 <para>You can either scan barcodes in to the box provided and
20730 click the 'Add item(s)' button or you can click the 'Add item(s)'
20731 button with the barcodes box empty. Clicking 'Add item(s)' with
20732 nothing in the barcodes box will open a search window for you to
20733 find the items you want to add to the batch.</para>
20736 <screeninfo>Search for items for a Batch</screeninfo>
20740 <imagedata fileref="images/tools/labelcreator/searchforbatch.png"/>
20745 <para>From the search results, click the check box next to the
20746 items you want to add to the batch and click the 'Add checked'
20747 button. You can also add items one by one by clicking the 'Add'
20748 link to the left of each item.</para>
20751 <screeninfo>Batch search results</screeninfo>
20755 <imagedata fileref="images/tools/labelcreator/batchsearchresults.png"/>
20760 <para>Once you have added all of the items click the 'Done'
20761 button. The resulting page will list the items you have
20765 <screeninfo>List of items in the batch</screeninfo>
20769 <imagedata fileref="images/tools/labelcreator/itemsinbarch.png"/>
20774 <para>To print your labels, click the 'Export Batch' button. To
20775 print only some of the labels, click the 'Export Item(s)' button.
20776 Either way you will be presented with a confirmation screen where
20777 you can choose your template and layout.</para>
20780 <screeninfo>Start batch export</screeninfo>
20784 <imagedata fileref="images/tools/labelcreator/exportbatch.png"/>
20789 <para>You will then be presented with three download options: PDF,
20790 Excel, and CSV.</para>
20793 <screeninfo>Batch save options</screeninfo>
20797 <imagedata fileref="images/tools/labelcreator/savebatch.png"/>
20802 <para>After saving your file, simply print to the blank labels you
20803 have in your library.</para>
20808 <section id="quicklabelcreator">
20809 <title>Quick Spine Label Creator</title>
20813 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
20814 > Quick Spine Label Creator</para>
20819 <para>This tool does not use the label layouts or templates, it
20820 simply prints a spine label in the first spot on the label
20825 <para>Define the fields you want to print on the spine label in
20826 the <link linkend="SpineLabelFormat">SpineLabelFormat</link>
20827 system preference</para>
20831 <para>Format your label printing by editing spinelabel.css found
20832 in koha-tmpl/intranet-tmpl/prog/en/css/</para>
20837 <para>To use this tool you simply need the barcode for the book you'd
20838 like to print the spine label for.</para>
20841 <screeninfo>Quick Spine Label Creator</screeninfo>
20845 <imagedata fileref="images/tools/quickspinelable.png"/>
20850 <section id="marcmodtemplates">
20851 <title>MARC modification templates</title>
20852 <para>The MARC Modification Templates system gives Koha users the power to make alterations
20853 to MARC records automatically while staging MARC records for import. </para>
20854 <para>This tool is useful for altering MARC records from various venders/sources work with
20855 your MARC framework. The system essentially allows one to create a basic script using
20856 actions to Copy, Move, Add, Update and Delete fields. </para>
20857 <para>Start by adding a new template (a template can be made up of one or more actions) by
20858 entering a name and clicking 'Create template'.</para>
20860 <screeninfo>Add a new template</screeninfo>
20863 <imagedata fileref="images/tools/marcmodtemplates/addtemplate.png"/>
20867 <para>Next you can add actions to the template by filling in the Action box. For example if
20868 you're loading in a batch of files from your EBook vendor you might want to add the biblio
20869 item type of EBOOK to the 942$c.<screenshot>
20870 <screeninfo>Add action</screeninfo>
20873 <imagedata fileref="images/tools/marcmodtemplates/addaction.png"/>
20876 </screenshot><itemizedlist>
20878 <para>Choose 'Add/Update'</para>
20881 <para>Enter the field 942 and subfield c</para>
20884 <para>Enter the value of 'EBOOK' (or whatever your ebook item type code is)</para>
20887 <para>Provide a description so you can identify this action later</para>
20890 <para>Click 'Add action'</para>
20892 </itemizedlist></para>
20893 <para>Each action can also have an optional condition to check the value or existance of
20894 another field. For example you might want to add the call number to the item record if
20895 it's not already there.</para>
20897 <screeninfo>Add conditional action</screeninfo>
20900 <imagedata fileref="images/tools/marcmodtemplates/ifexample.png"/>
20906 <para>Choose 'Copy'</para>
20909 <para>Decide if you want to copy the first occurance or all occurances of the
20913 <para>Enter the field 090 (or other biblio call number field) and subfield a to
20917 <para>Enter the 952 field and o subfield to copy to</para>
20920 <para>Choose 'if'</para>
20923 <para>Enter the 952 field and o subfield</para>
20926 <para>Choose "doesn't exist"</para>
20929 <para>Provide a description so you can identify this action later</para>
20932 <para>Click 'Add action'</para>
20935 <para>The Copy & Move actions also support Regular Expressions, which can be used to
20936 automatically modify field values during the copy/move. An example would be to strip out
20937 the '$' character in field 020$c.</para>
20939 <screeninfo>Add regex action</screeninfo>
20942 <imagedata fileref="images/tools/marcmodtemplates/regexexample.png"/>
20948 <para>Choose 'Copy'</para>
20951 <para>Decide if you want to copy the first occurance or all occurances of the
20955 <para>Enter the field 020 and subfield c to copy</para>
20958 <para>Enter the 020 field and c subfield to copy to</para>
20961 <para>Check the 'RegEx' box and enter your regular expression (in this case s/\$//
20965 <para>Choose 'if'</para>
20968 <para>Enter the 020 field and c subfield</para>
20971 <para>Choose "matches"</para>
20974 <para>Check the 'RegEx' box and enter your regular expression (in this case m/^\$/
20978 <para>Provide a description so you can identify this action later</para>
20981 <para>Click 'Add action'</para>
20985 <para>The value for an update can include variables that change each time the template is
20986 used. Currently, the system supports two variables, __BRANCHCODE__ which is replaced
20987 with the branchcode of the library currently using the template, and __CURRENTDATE__
20988 which is replaced with the current date in ISO format ( YYYY-MM-DD ).</para>
20990 <para>You could also use regular expressions to add your library's proxy URL in front of
20991 links in your MARC record.<screenshot>
20992 <screeninfo>Add proxy URL</screeninfo>
20995 <imagedata fileref="images/tools/marcmodtemplates/proxyurl.png"/>
20998 </screenshot><itemizedlist>
21000 <para>Choose 'Copy'</para>
21003 <para>Decide if you want to copy the first occurance or all occurances of the
21007 <para>Enter the field 856 and subfield u to copy</para>
21010 <para>Enter the 856 field and u subfield to copy to</para>
21013 <para>Check the 'RegEx' box and enter your regular expression (in this case
21014 s/^/PROXY_URL/ )</para>
21017 <para>Provide a description so you can identify this action later</para>
21020 <para>Click 'Add action'</para>
21022 </itemizedlist></para>
21023 <para>Once your actions are saved you can view them at the top of the screen. Actions can be
21024 moved around using the arrows to the left of them. </para>
21026 <screeninfo>View actions</screeninfo>
21029 <imagedata fileref="images/tools/marcmodtemplates/viewactions.png"/>
21033 <para>Depending on your actions the order may be very important. For example you don't want
21034 to delete a field before you copy it to another field.</para>
21035 <para>To add another template you can either start fresh or click the 'Duplicate current
21036 template' checkbox to create a copy of an existing template to start with.</para>
21038 <screeninfo>Duplicate template</screeninfo>
21041 <imagedata fileref="images/tools/marcmodtemplates/duplicate.png"/>
21045 <para>Once your template is saved you will be able to pick it when using the <link
21046 linkend="stagemarc">Stage MARC Records for Import</link> tool.</para>
21048 <screeninfo>Choose template</screeninfo>
21051 <imagedata fileref="images/tools/marcmodtemplates/templatechoice.png"/>
21057 <section id="stagemarc">
21058 <title>Stage MARC Records for Import</title>
21062 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
21063 > Stage MARC records for import</para>
21067 <para>This tool can be used to import both bibliographic and authority
21068 records that are saved in MARC format. Importing records into Koha
21069 includes two steps. The first is to stage records for import.</para>
21073 <para>First find the MARC file on your computer</para>
21076 <screeninfo>Stage MARC Records for Import</screeninfo>
21080 <imagedata fileref="images/tools/marcimport/stagemarc-pt1.png"/>
21087 <para>Next you will be presented with options for record matching
21088 and item imports</para>
21091 <screeninfo>Upload options</screeninfo>
21095 <imagedata fileref="images/tools/marcimport/stagemarc-pt2.png"/>
21102 <para>Enter 'Comments about this file' to identify your upload
21103 when going to the '<link linkend="managestaged">Manage Staged
21104 MARC Records</link>' tool</para>
21108 <para>Tell Koha which type of file this is, bibliographic or
21112 <screeninfo>Record type</screeninfo>
21116 <imagedata fileref="images/tools/marcimport/recordtype.png"/>
21123 <para>Choose the character encoding</para>
21126 <screeninfo>Chracter encoding</screeninfo>
21130 <imagedata fileref="images/tools/marcimport/encoding.png"/>
21137 <para>Choose if you would like to use a <link linkend="marcmodtemplates">MARC
21138 Modification Template</link> to alter the data you're about to import</para>
21140 <screeninfo>Choose modification template</screeninfo>
21143 <imagedata fileref="images/tools/marcimport/templatechoice.png"/>
21149 <para>Choose whether or not you want to look for matching records</para>
21151 <screeninfo>Look for matches</screeninfo>
21154 <imagedata fileref="images/tools/marcimport/matches.png"/>
21160 <para>You can set up <link linkend="recordmatchingrules">record matching
21161 rules</link> through the administration area</para>
21163 <screeninfo>Matching rules</screeninfo>
21166 <imagedata fileref="images/tools/marcimport/matchrule.png"/>
21175 <para>Next choose what to do with matching records if they are
21180 <para>Finally choose what to do with records that are
21185 <para>Next you can choose whether or not to import the item
21186 data found in the MARC records (if the file you're loading is
21187 a bibliographic file)</para>
21190 <screeninfo>Import items</screeninfo>
21194 <imagedata fileref="images/tools/marcimport/checkitems.png"/>
21200 <listitem><para>From here you can choose to always add items regardless of matching status, add them only if a
21201 matching bib was found, add items only if there was no matching bib record,
21202 replace items if a matching bib was found (The match will look at the
21203 itemnumbers and barcodes to match on for items. Itemnumbers take precendence
21204 over barcodes), or Ignore items and not add them.</para></listitem>
21210 <para>Click 'Stage for import'</para>
21214 <para>You will be presented with a confirmation of your MARC
21218 <screeninfo>MARC Import Confirmation</screeninfo>
21222 <imagedata fileref="images/tools/marcimport/stagemarc-results.png"/>
21229 <para>To complete the process continue to the <link linkend="managestaged">Managed Staged MARC Records
21235 <section id="managestaged">
21236 <title>Staged MARC Record Management</title>
21240 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
21241 > Staged MARC Record Management</para>
21245 <para>Once you have <link linkend="stagemarc">staged</link> your
21246 records for import you can complete the import using this tool.</para>
21249 <screeninfo>List of Staged MARC Records</screeninfo>
21253 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
21260 <para>From the list of staged records, click on the file name that
21261 you want to finish importing</para>
21265 <para>You will note that records that have already been
21266 imported will say so under 'Status'</para>
21272 <para>A summary of your import will appear along with the option
21273 to change your matching rules</para>
21276 <screeninfo>Manage Staged Records Batch</screeninfo>
21280 <imagedata fileref="images/tools/marcimport/managestagedrecords.png"/>
21287 <para>Below the summary is the option to import the batch of bib
21288 records using a specific framework</para>
21291 <screeninfo>Choose Framework to Import Into</screeninfo>
21295 <imagedata fileref="images/tools/marcimport/importframework.png"/>
21302 <para>Choosing a framework other than 'Default' isn't
21303 necessary, but it's helpful for running reports and having the
21304 right bib level item type selected on import.</para>
21310 <para>Below the framework selection there will be a list of the
21311 records that will be imported</para>
21314 <screeninfo>List of Staged Records</screeninfo>
21318 <imagedata fileref="images/tools/marcimport/stagedrecords.png"/>
21325 <para>Review your summary before completing your import to
21326 make sure that your matching rule worked and that the records
21327 appear as you expect them to</para>
21333 <para>Click 'Import into catalog' to complete the import</para>
21336 <screeninfo>Import summary</screeninfo>
21340 <imagedata fileref="images/tools/marcimport/importedrecords.png"/>
21347 <para>Once your import is complete a link to the new bib records
21348 will appear to the right of each title that was imported</para>
21352 <para>You can also undo your import by clicking the 'Undo import
21353 into catalog' button</para>
21357 <para>Records imported using this tool remain in the 'reservoir' until
21358 they are cleaned. These items will appear when searching the catalog
21359 from the <link linkend="cataloging">Cataloging</link> tool:</para>
21362 <screeninfo>Reservoir Results</screeninfo>
21366 <imagedata fileref="images/tools/marcimport/reservoirresults.png"/>
21371 <para>To clean items out of the 'reservoir':</para>
21375 <para>Visit the main screen of the Manage Staged MARC Records
21379 <screeninfo>List of Staged MARC Records</screeninfo>
21383 <imagedata fileref="images/tools/marcimport/managestaged.png"/>
21390 <para>To clean a batch, click the 'Clean' button to the
21395 <para>You will be presented with a confirmation message</para>
21398 <screeninfo>Clean MARC Records Confirmation</screeninfo>
21402 <imagedata fileref="images/tools/marcimport/cleanbatch.png"/>
21409 <para>Accept the deletion and the records will be removed from
21410 the reservoir and the status will be changed to
21418 <section id="uploadlocalimages">
21419 <title>Upload Local Cover Image</title>
21423 <para><emphasis>Get there:</emphasis> More > Tools > Catalog
21424 > Upload Local Cover Image</para>
21428 <para>This tool will allow you to upload cover images for the materials in your catalog. To
21429 access this tool, staff will need the <link linkend="toolspermissions"
21430 >upload_local_cover_images permission</link>. In order for images to show in the staff
21431 client and/or OPAC you will need to set your <link linkend="LocalCoverImages"
21432 >LocalCoverImages</link> and/or <link linkend="OPACLocalCoverImages"
21433 >OPACLocalCoverImages</link> preferences to 'Display.' Images can be uploaded in batches
21434 or one by one.<tip>
21435 <para>Koha does not have a maximum file size limit for this tool, but Apache may limit
21436 the maximum size of uploads (talk to your sys admin).</para>
21438 <para>When you want to upload multiple images onto a bib record, they will display left
21439 to right (then top to bottom, depending on screen real estate) in order of uploading,
21440 and the one on the left (the first one uploaded) will be the one used as a thumbnail
21441 cover in search results and on the detail page. There is no way to reorder cover
21442 images uploaded in this way, so be sure to upload them in the order you'd like them to appear.<screenshot>
21443 <screeninfo>Multiple cover images on one record</screeninfo>
21446 <imagedata fileref="images/tools/uploadlocalimg/multiplecovers.png"/>
21449 </screenshot></para>
21452 <para>If uploading a single image:</para>
21456 <para>Visit the tool and click the 'Browse' button to browse to
21457 the image on your local machine.</para>
21460 <screeninfo>Upload single cover image</screeninfo>
21464 <imagedata fileref="images/tools/uploadlocalimg/uploadsingle.png"/>
21471 <para>Click 'Upload file'</para>
21475 <para>Choose 'Image file' under the 'File type' section</para>
21479 <para>Enter the biblionumber for the record you're attaching this
21480 image to. This is not the same as the barcode, this is the system
21481 generated number assigned by Koha.</para>
21485 <para>Find the biblionumber by looking at the end of the URL
21486 in the address bar when on the detail page</para>
21489 <screeninfo>Biblionumber in URL</screeninfo>
21493 <imagedata fileref="images/tools/uploadlocalimg/bibnumurl.png"/>
21500 <para>or by clicking on the MARC tab on the detail page in the
21501 staff client</para>
21504 <screeninfo>Biblionumber on MARC Record</screeninfo>
21508 <imagedata fileref="images/tools/uploadlocalimg/bibnummarc.png"/>
21517 <para>If you would like to replace any other cover images you may
21518 have uploaded in the past, check the 'Replace existing covers' box
21519 under the 'Options' section</para>
21523 <para>Click 'Process images'</para>
21527 <para>You will be presented with a summary of the upload and a
21528 link to the record you have just added the image to</para>
21532 <para>If uploading a batch of images at once you will need to prepare
21533 a ZIP file first.</para>
21537 <para>Enter in to the ZIP file all the images you are
21542 <para>Also include a text file (*.TXT) named either datalink.txt
21543 or idlink.txt listing the biblionumber followed by the image name
21544 for each image one per line</para>
21548 <para>ex. 4091,image4091.jpg</para>
21551 <screeninfo>ZIP File Contents</screeninfo>
21555 <imagedata fileref="images/tools/uploadlocalimg/zipfiles.png"/>
21564 <para>Browse your local computer to the ZIP file</para>
21568 <para>Click 'Upload file'</para>
21572 <para>Choose 'Zip file' under the 'File type' section</para>
21576 <para>If you would like to replace any other cover images you may
21577 have uploaded in the past, check the 'Replace existing covers' box
21578 under the 'Options' section</para>
21582 <para>Click 'Process images'</para>
21586 <para>You will be presented with a summary of the upload</para>
21589 <screeninfo>Upload Summary</screeninfo>
21593 <imagedata fileref="images/tools/uploadlocalimg/uploadsummary.png"/>
21601 <para>The source image is used to generate a 140 x 200 px thumbnail image and a 600 x 800
21602 px full-size image. The original sized image uploaded will not be stored by Koha</para>
21605 <para>You will be able to see your cover images in the staff client on
21606 the detail page under the 'Image' tab in the holdings table at the
21610 <screeninfo>Cover images in the staff client</screeninfo>
21614 <imagedata fileref="images/admin/globalprefs/AllowMultipleCovers.png"/>
21619 <para>In the OPAC the cover images will also appear in the images tab,
21620 as well as next to the title and on the search results.</para>
21621 <para>If you would like to remove a cover image you can click 'Delete image' below the image
21622 if you have the <link linkend="toolspermissions">upload_local_cover_images
21623 permission</link>.</para>
21627 <section id="additionaltools">
21628 <title>Additional Tools</title>
21632 <section id="calholidays">
21633 <title>Calendar</title>
21637 <para><emphasis>Get there:</emphasis> More > Tools >
21638 Additional Tools > Calendar</para>
21642 <para>Libraries can define library closings and holidays to be used
21643 when calculating due dates. You can make use of the Calendar by
21644 turning on the proper system preferences:</para>
21648 <para><emphasis>Get there: </emphasis>More > Administration
21649 > Global System Preferences > Circulation > <link linkend="useDaysMode">useDaysMode</link></para>
21653 <para>Choose the method for calculating due date - either
21654 include days the library is closed in the calculation or don't
21655 include them.</para>
21661 <para><emphasis>Get there:</emphasis> More > Administration
21662 > Global System Preferences > Circulation > <link linkend="finesCalendar">finescalendar</link></para>
21666 <para>This will check the holiday calendar before charging
21674 <screeninfo>Calendar & Holidays Tools</screeninfo>
21678 <imagedata fileref="images/tools/calendar/calendar.png"/>
21683 <section id="addevents">
21684 <title>Adding Events</title>
21686 <para>Before adding events, choose the library you would like to
21687 apply the closings to. When adding events you will be asked if you
21688 would like to apply the event to one branch or all branches. To add
21689 events, simply</para>
21693 <para>Click on the date on the calendar that you would like to
21694 apply the closing to</para>
21697 <screeninfo>Calendar Add Form</screeninfo>
21701 <imagedata fileref="images/tools/calendar/calendaradd.png"/>
21708 <para>In the form that appears above the calendar, enter the
21709 closing information (for more info on each option click the
21710 question mark [?] to the right of the option)</para>
21714 <para>Library will be filled in automatically based on the
21715 library you chose from the pull down at the top of the
21720 <para>The day information will also be filled in
21721 automatically based on the date you clicked on the
21726 <para>In the description enter the reason the library is
21731 <para>Next you can choose if this event is a one time event
21732 or if it is repeatable.</para>
21736 <para>If this is a one day holiday choose 'Holiday only
21737 on this day'</para>
21741 <para>If this is a weekly closing (like a weekend day)
21742 then you can choose 'Holiday repeated every same day of
21747 <para>If this is an annual holiday closing choose
21748 'Holiday repeated yearly on the same date'</para>
21752 <para>If the library is going to be closed for the week
21753 or a range of time choose 'Holiday on a range' and enter
21754 a 'To Date' at the top</para>
21758 <para>If the library is going to be closed for a range
21759 of time each year (such as summer holidays for schools)
21760 choose 'Holiday repeated yearly on a range' and enter a
21761 'To Date' at the top</para>
21767 <para>Finally decide if this event should be applied to all
21768 libraries or just the one you have originally
21773 <para>If you'd rather enter all the holidays and then
21774 copy them all to another branch all at once you can use
21775 the copy menu below the calendar</para>
21778 <screeninfo>Copy holidays</screeninfo>
21782 <imagedata fileref="images/tools/calendar/copyholidays.png"/>
21793 <para>After saving you will see the event listed in the summary
21794 to the right the calendar</para>
21797 <screeninfo>Calendar Summary</screeninfo>
21801 <imagedata fileref="images/tools/calendar/calendarsummary.png"/>
21809 <section id="editevents">
21810 <title>Editing Events</title>
21812 <para>To edit events</para>
21816 <para>Click on the event on the calendar that you want to change
21817 (do this by clicking on the date on the calendar, not the event
21818 listed in the summary)</para>
21821 <screeninfo>Edit holiday form</screeninfo>
21825 <imagedata fileref="images/tools/calendar/calendaredit.png"/>
21832 <para>From this form you can make edits to the holiday or delete the holiday
21833 completely. <itemizedlist>
21835 <para>All actions require that you click 'Save' before the change will be
21838 </itemizedlist></para>
21842 <para>Clicking on repeatable events will offer slightly
21843 different options</para>
21846 <screeninfo>Edit repeatable event</screeninfo>
21850 <imagedata fileref="images/tools/calendar/calendarexception.png"/>
21857 <para>In the form above you will note that there is now an option to 'Generate an
21858 exception for this repeated holiday,' choosing this option will allow you to
21859 make it so that this date is not closed even though the library is usually
21860 closed on this date.<itemizedlist>
21862 <para>All actions require that you click 'Save' before the change will be
21865 </itemizedlist></para>
21872 <section id="calendarhelp">
21873 <title>Additional Help</title>
21875 <para>When adding or editing events you can get additional help by
21876 clicking on the question mark next to various different options on
21880 <screeninfo>Additional Calendar Help Buttons</screeninfo>
21884 <imagedata fileref="images/tools/calendar/calendarhelp.png"/>
21891 <section id="csvprofiles">
21892 <title>CSV Profiles</title>
21896 <para><emphasis>Get there:</emphasis> More > Tools >
21897 Additional Tools > CSV Profiles</para>
21901 <para>CSV Profiles are created to define how you would like your cart
21902 or list to export.</para>
21904 <section id="addcsvprofile">
21905 <title>Add CSV Profiles</title>
21907 <para>To add a CSV Profile</para>
21911 <para>Click 'CSV Profiles' from the Tools menu</para>
21914 <para>The 'Profile type' determines what type of fields you plan to use (MARC or SQL)
21915 to define your profile<itemizedlist>
21917 <para>If tyou choose MARC then you will need to enter MARC fields</para>
21919 </itemizedlist></para>
21921 <screeninfo>MARC CSV Profile</screeninfo>
21924 <imagedata fileref="images/tools/csvprofiles/addcsv.png"/>
21930 <para>If tyou choose SQL then you will need to enter SQL database fields</para>
21932 <screeninfo>SQL CSV Profile</screeninfo>
21935 <imagedata fileref="images/tools/csvprofiles/addcsv-sql.png"/>
21943 <para>The 'Profile name' will appear on the export pull down list when choosing
21944 'Download' from your cart or list</para>
21946 <screeninfo>Download List</screeninfo>
21949 <imagedata fileref="images/tools/csvprofiles/downloadcsv.png"/>
21955 <para>The 'Profile description' is for your own benefit, but will also appear in
21956 the OPAC when patrons download content, so make sure it's clear to your patrons
21960 <para>The 'CSV separator' is the character used to separate values and value groups<tip>
21961 <para>The most common option here is comma because most spreadsheet
21962 applications know how to open files split by commas.</para>
21966 <para>The 'Field separator' is the character used to separate duplicate
21970 <para>Example: You may have multiple 650 fields and this is the character that
21971 will appear in between each one in the column</para>
21973 <screeninfo>Field separators in between multiple subjects</screeninfo>
21976 <imagedata fileref="images/tools/csvprofiles/csvfieldsep.png"/>
21984 <para>The 'Subfield separator' is the character used to separate duplicate
21988 <para>Example: You may have multiple $a subfields in a field</para>
21993 <para>The 'Encoding' field lets you define the encoding used when saving the
21997 <para>Finally format your CSV file using the 'Profile MARC' or 'Profile SQL'
22001 <para>Define which fields or subfields you want to export, separated by pipes.
22002 Example : 200|210$a|301 for MARC and biblio.title|biblio.author for
22007 <para>You can also use your own headers (instead of the ones from Koha) by
22008 prefixing the field number with an header, followed by the equal sign.
22009 Example : Personal name=100|title=245$a|300</para>
22015 <para>When you have entered in all of the information for you profile, simply click
22016 'Submit' and you will be presented with a confirmation that your profile has been saved.</para>
22018 <screeninfo>Confirmation of new CSV profile</screeninfo>
22021 <imagedata fileref="images/tools/csvprofiles/csvadded.png"/>
22029 <section id="editcsvprofile">
22030 <title>Modify CSV Profiles</title>
22032 <para>Once you have created at least one CSV Profile an 'Edit
22033 profile' tab will appear next to the 'New profile' button.</para>
22036 <screeninfo>Modify CSV Profiles</screeninfo>
22040 <imagedata fileref="images/tools/csvprofiles/modifycsv.png"/>
22047 <para>Choose the profile you would like to edit and alter the necessary fields.</para>
22050 <para>After submitting your changes you will be presented with a confirmation message
22051 at the top of the screen</para>
22053 <screeninfo>Confirmation of CSV modification</screeninfo>
22056 <imagedata fileref="images/tools/csvprofiles/csvmodified.png"/>
22063 <para>To delete a profile, check the 'Delete selected profile'
22064 option before clicking 'Submit Query'</para>
22067 <screeninfo>Delete an existing CSV Profile</screeninfo>
22071 <imagedata fileref="images/tools/csvprofiles/deletecsv.png"/>
22079 <section id="usecsvprofiles">
22080 <title>Using CSV Profiles</title>
22082 <para>Your CSV Profiles will appear on the export list or cart menu under the 'Download'
22083 button in both the staff client and the OPAC</para>
22086 <screeninfo>CSV Profiles on Download Menu in the Staff Client</screeninfo>
22090 <imagedata fileref="images/tools/csvprofiles/exportlist.png"/>
22097 <section id="logviewer">
22098 <title>Log Viewer</title>
22102 <para><emphasis>Get there:</emphasis> More > Tools >
22103 Additional Tools > Log Viewer</para>
22107 <para>Actions within the Koha system are tracked in log files. Your
22108 <link linkend="logs">system preferences</link> can be changed to
22109 prevent the logging of different actions. These logs can be viewed
22110 using the Log Viewer Tool.</para>
22113 <screeninfo>Log Viewer</screeninfo>
22117 <imagedata fileref="images/tools/logs/logviewer.png"/>
22122 <para>Choosing different combinations of menu options will produce the
22123 log file for that query.</para>
22126 <screeninfo>A query for all logs related to the Circulation module
22127 produces a result like this</screeninfo>
22131 <imagedata fileref="images/tools/logs/logresults.png"/>
22136 <para>You will note that real names do not appear on the log, only
22137 identifying numbers. You need to use the identifying numbers when
22138 searching the logs as well.</para>
22141 <section id="newstool">
22142 <title>News</title>
22146 <para><emphasis>Get there:</emphasis> More > Tools >
22147 Additional Tools > News</para>
22151 <para>Koha's news module allows librarians to post news to the OPAC,
22152 staff interface and circulation receipts.</para>
22155 <screeninfo>Koha News Module</screeninfo>
22159 <imagedata fileref="images/tools/news/news.png"/>
22164 <para>To add news to either the OPAC, the Staff Client or a
22165 Circulation receipt:</para>
22169 <para>Click 'New Entry'</para>
22172 <screeninfo>Add Koha News Form</screeninfo>
22176 <imagedata fileref="images/tools/news/addnews.png"/>
22183 <para>Under 'Display Location' choose whether to put the news
22184 on the OPAC, Slip (circulation receipt) or the Librarian
22185 (Staff) Interface.</para>
22189 <para>Choose a title for your entry</para>
22193 <para>Using the publication and expiration date fields you can
22194 control how long your item appears</para>
22198 <para>'Appear in position' lets you decide what order your
22199 news items appear in</para>
22203 <para>The 'News' box allows for the use of HTML for formatting
22204 of your news item</para>
22210 <para>After filling in all of the fields, click 'Submit'</para>
22214 <para>News in the OPAC will appear above the <link linkend="OpacMainUserBlock">OpacMainUserBlock</link></para>
22217 <screeninfo>News in the OPAC</screeninfo>
22221 <imagedata fileref="images/tools/news/opacnews.png"/>
22228 <para>News in the Staff Client will appear on the far left of the
22232 <screeninfo>News in the Staff Client</screeninfo>
22236 <imagedata fileref="images/tools/news/librariannews.png"/>
22243 <para>News on the circulation receipts will appear below the items
22244 that are checked out</para>
22247 <screeninfo>News at the bottom of the circulation
22248 receipt</screeninfo>
22252 <imagedata fileref="images/tools/news/slipnews.png"/>
22260 <section id="taskscheduler">
22261 <title>Task Scheduler</title>
22265 <para><emphasis>Get there:</emphasis> More > Tools >
22266 Additional Tools > Task Scheduler</para>
22270 <para>The task scheduler is a way to schedule reports to run whenever
22273 <para>To schedule a task, visit the Task Scheduler and fill in the
22277 <screeninfo>Task Scheduler</screeninfo>
22281 <imagedata fileref="images/tools/tasksched/taskscheduler.png"/>
22288 <para>Current Server Time shows the time on your server (schedule
22289 all of your reports to run based on that time - not on your local
22294 <para>Time should be entered as hh:mm (2 digit hour, 2 digit
22299 <para>Date should be entered using the calendar pop up</para>
22303 <para>From Report choose the report you want to schedule</para>
22307 <para>Choose whether to receive the text of or a link to the
22312 <para>In the Email filed enter the email of the person you want to
22313 receive your report</para>
22317 <para>Below the task scheduler form, there is a list of scheduled
22321 <screeninfo>Scheduled Tasks</screeninfo>
22325 <imagedata fileref="images/tools/tasksched/scheduledreports.png"/>
22330 <para>You can also schedule reports directly from the list of saved
22331 reports by clicking the 'Schedule' link</para>
22334 <screeninfo>Saved Reports List</screeninfo>
22338 <imagedata fileref="images/tools/tasksched/savedreports.png"/>
22343 <section id="taskscedtroubleshoot">
22344 <title>Troubleshooting</title>
22346 <para>Task scheduler will not work if the user the web server runs
22347 as doesn't have the permission to use it. To find out if the right
22348 user has the permissions necessary, check /etc/at.allow to see what
22349 users are in it. If you don't have that file, check etc/at.deny. If
22350 at.deny exists but is blank, then every user can use it. Talk to
22351 your system admin about adding the user to the right place to make
22352 the task scheduler work.</para>
22356 <section id="QOTDEditor">
22357 <title>Quote of the Day (QOTD) Editor</title>
22360 <para><emphasis>Get there:</emphasis> More > Tools > Additional Tools > Edit
22361 quotes for QOTD feature</para>
22365 <para>This tool will allow you to add and edit quotes to show on the
22366 OPAC if you're using the Quote of the Day (QOTD) feature.</para>
22368 <para>To turn this feature on set the <link linkend="QuoteOfTheDay">QuoteOfTheDay</link> preference to 'Enable and
22369 add at least one quote via the Quote of the Day Editor. Once these
22370 steps are complete you will see your quotes above the <link linkend="OpacMainUserBlock">OpacMainUserBlock</link> in the
22374 <screeninfo>Quote in the OPAC</screeninfo>
22378 <imagedata fileref="images/tools/qotd/quoteinopac.png"/>
22383 <section id="addquote">
22384 <title>Add a Quote</title>
22386 <para>To add a quote:</para>
22390 <para>Click the 'Add quote' button in the toolbar and an empty
22391 quote entry will be added to the end of the current quote
22395 <screeninfo>Add quote button</screeninfo>
22399 <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
22407 <para>Both the 'Source' and the 'Text' fields must be
22408 filled in in order to save the new quote.</para>
22411 <screeninfo>Add quote</screeninfo>
22415 <imagedata fileref="images/tools/qotd/addquote.png"/>
22425 <para>When finished filling in both fields, press the
22426 <Enter> key on your keyboard to save the new quote.</para>
22430 <para>The list will update and the new quote should now be
22431 visible in the list.</para>
22436 <para>You may cancel the addition of a new quote any time prior to
22437 saving it simply by pressing the <Esc> key on your
22442 <section id="editquote">
22443 <title>Edit/Delete a Quote</title>
22445 <para>Once the current quote pool has been loaded into the editing
22446 table, you may edit the quote source and text.</para>
22450 <para>Edit either the 'Source' or 'Text' fields by clicking on
22451 the desired field.</para>
22454 <screeninfo>Edit quote</screeninfo>
22458 <imagedata fileref="images/tools/qotd/editquote.png"/>
22465 <para>When you are finished editing a field, press the
22466 <Enter> key on your keyboard to save the changes.</para>
22470 <para>The list will be updated, the edits saved, and visible.</para>
22472 <para>If you'd like you can also delete quote(s).</para>
22476 <para>Select the quote(s) you desire to delete by clicking on
22477 the corresponding quote id.</para>
22481 <para>Once quote selection is finished, simply click the 'Delete
22482 quote(s)' button.</para>
22486 <para>You will be prompted to confirm the deletion.</para>
22490 <para>After confirming the deletion, the list will update and
22491 the quote(s) will no longer appear.</para>
22496 <section id="importquote">
22497 <title>Import Quotes</title>
22499 <para>If you'd like you can import a batch of quotes as a CSV file.
22500 Your file must contain two columns in the form: "source","text" with
22501 no header row.</para>
22504 <para>You will be prompted to confirm upload of files larger than
22510 <para>To start the import process click the 'Import quotes'
22511 button at the top of the screen</para>
22514 <screeninfo>Import quotes button</screeninfo>
22518 <imagedata fileref="images/tools/qotd/quotebuttons.png"/>
22525 <para>Once on the import quotes screen you can browse your
22526 computer for the file you would like to import</para>
22529 <screeninfo>Import quotes</screeninfo>
22533 <imagedata fileref="images/tools/qotd/importquotes.png"/>
22540 <para>After selecting the CSV file, click the 'Open' button and
22541 the file will be uploaded into a temporary editing table.</para>
22544 <screeninfo>Imported quotes</screeninfo>
22548 <imagedata fileref="images/tools/qotd/importedsummary.png"/>
22555 <para>From the listing you can edit either the 'Source' or
22556 'Text' fields by clicking on the desired field. When you are
22557 finished editing a field, press the <Enter> key on your
22558 keyboard to save the changes.</para>
22561 <screeninfo>Edit imported quote</screeninfo>
22565 <imagedata fileref="images/tools/qotd/editimported.png"/>
22572 <para>You can also delete quotes from this listing before
22573 completing the import.</para>
22577 <para>Select the quote(s) you desire to delete by clicking
22578 on the corresponding quote id.</para>
22581 <screeninfo>Selected for deletion</screeninfo>
22585 <imagedata fileref="images/tools/qotd/selectfordelete.png"/>
22592 <para>Once quote selection is finished, simply click the
22593 'Delete quote(s)' key.</para>
22596 <screeninfo>Delete quote(s)</screeninfo>
22600 <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
22607 <para>You will be prompted to confirm the deletion.</para>
22610 <screeninfo>Confirm deletion</screeninfo>
22614 <imagedata fileref="images/tools/qotd/confirmdelete.png"/>
22621 <para>After confirming the deletion, the list will update
22622 and the quote(s) will no longer appear.</para>
22628 <para>Once you are satisfied with the quotes, click the 'Save
22629 quotes' button in the toolbar at the top and the quotes will be
22633 <screeninfo>Save quotes button</screeninfo>
22637 <imagedata fileref="images/tools/qotd/importquotebuttons.png"/>
22648 <chapter id="patrons">
22649 <title>Patrons</title>
22651 <para>Before importing and/or adding patrons be sure to set up your <link linkend="patcats">patron categories</link>.</para>
22653 <section id="addnewpatron">
22654 <title>Add a new patron</title>
22656 <para>Patrons are added by going to the 'Patrons' module.<itemizedlist>
22658 <para><emphasis>Get there:</emphasis> Patrons</para>
22660 </itemizedlist></para>
22661 <para>Once there you can add a new patron.</para>
22665 <para>Click 'New patron'</para>
22668 <screeninfo>Choose patron type</screeninfo>
22672 <imagedata fileref="images/patrons/newpatron.png"/>
22679 <para>The fields that appear on the patron add form can be
22680 controlled by editing the <link linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> system
22685 <para>First enter the identifying information regarding your
22689 <screeninfo>Add Patron Form</screeninfo>
22693 <imagedata fileref="images/patrons/addpatronform.png"/>
22700 <para>Required fields are defined in the <link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link>
22701 system preference</para>
22705 <para>Salutation is populated by the <link linkend="BorrowersTitles">BorrowersTitles</link> system
22712 <para>Next enter the contact information</para>
22715 <screeninfo>Patron Contact Information</screeninfo>
22719 <imagedata fileref="images/patrons/addcontact.png"/>
22726 <para>For contact information, note that the primary phone and
22727 email addresses are the ones that appear on notices and slips
22728 printed during circulation (receipts, transfer slips and hold
22729 slips). The primary email is also the one that overdue notices
22730 and other messages go to.</para>
22736 <para>If this patron is a child, you will be asked to attach the
22737 child patron to an adult patron</para>
22740 <screeninfo>Guarantor Linking</screeninfo>
22744 <imagedata fileref="images/patrons/addGuarantor.png"/>
22751 <para>Click 'Set to Patron' to search your system for an
22752 existing patron</para>
22756 <para>If the Guarantor is not in the system, you can enter the
22757 first and last name in the fields available</para>
22761 <para>The relationships are set using the <link linkend="borrowerRelationship">borrowerRelationship</link>
22762 system preference</para>
22768 <para>If this patron is a professional, you will be asked to attach
22769 the patron to an organizational patron</para>
22772 <screeninfo>Organization Linking</screeninfo>
22776 <imagedata fileref="images/patrons/addOrg.png"/>
22783 <para>Click 'Set to Patron to search your system for an existing
22790 <para>Each patron can have an alternate contact</para>
22793 <screeninfo>Alternate Contact</screeninfo>
22797 <imagedata fileref="images/patrons/addaltcontact.png"/>
22804 <para>An alternate contact could be a parent or guardian. It can
22805 also be used in academic settings to store the patron's home
22812 <para>The library management section includes values that are used
22813 within the library</para>
22816 <screeninfo>Library Management</screeninfo>
22820 <imagedata fileref="images/patrons/addlibmanagement.png"/>
22827 <para>The card number field is automatically calculated if you
22828 have the <link linkend="autoMemberNum">autoMemberNum</link>
22829 system preference set that way</para>
22834 <para>For a newly installed system this preference will
22835 start at 1 and increment by 1 each time after. To have it
22836 start with the starting number of your barcodes, enter the
22837 first barcode by hand in the patron record and save the
22838 patron. After that the field will increment that number by
22846 <para>If you accidentally chose the wrong patron category at the
22847 beginning you can fix that here</para>
22851 <para>Sort 1 and 2 are used for statistical purposes within your
22858 <para>Next, the Library Setup section includes additional library
22862 <screeninfo>Library set-up options</screeninfo>
22866 <imagedata fileref="images/patrons/addlibsetup.png"/>
22873 <para>The registration date will automatically be filled in with
22874 today's date</para>
22878 <para>If your patron cards expire (based on your <link linkend="patcats">patron category settings</link>) the Expiry
22879 date will automatically be calculated</para>
22883 <para>The OPAC Note is a note for the patron - it will appear in
22884 the OPAC on the patron's record</para>
22888 <para>The Circulation Note is meant solely for your library
22889 staff and will appear when the circulation staff goes to check
22890 an item out to the patron</para>
22893 <screeninfo>Sample Circulation Note</screeninfo>
22897 <imagedata fileref="images/patrons/circnote.png"/>
22904 <para>The Staff/OPAC asks for the username and password to be
22905 used by the patron (and/or staff member) to log into their
22906 account in the OPAC and for staff to log in to the staff
22911 <para>Staff will only be able to use this log in info to log
22912 in to the staff client if they have the <link linkend="patronpermissions">necessary
22913 permissions</link>.</para>
22921 <para>If you have set <link linkend="patronattributetypes">additional patron attributes</link>
22922 up, these will appear next</para>
22925 <screeninfo>Additional Patron Attributes</screeninfo>
22929 <imagedata fileref="images/patrons/addattributes.png"/>
22936 <para id="setpatronmessaging">Finally, if you have <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
22937 set to 'allow,' you can choose the messaging preferences for this
22941 <screeninfo>Patron Messaging Settings</screeninfo>
22945 <imagedata fileref="images/patrons/addpatronmsg.png"/>
22952 <para>These notices are:</para>
22955 <para>Advanced Notice : A notice in advance of the patron's items being due (The
22956 patron can choose the number of days in advance)</para>
22959 <para>Item Checkout : A notice that lists all the of the items the patron has just
22960 checked out and/or renewed, this is an electronic form of the checkout
22964 <para>Hold Filled : A notice when you have confirmed the hold is waiting for the
22968 <para>Item Due : A notice on the day and item is due back at the library</para>
22971 <para>Item Checkin : A notice that lists all the of the items the patron has just
22978 <para>These preferences will override any you set via the
22979 <link linkend="addingpatroncat">patron
22980 categories</link></para>
22986 <para>These preference can be altered by the patron via the
22994 <para>Once finished, click 'Save'</para>
22998 <para>If the system suspects this patron is a duplicate of another it
22999 will warn you.</para>
23002 <screeninfo>Patron Duplicate Suspected</screeninfo>
23006 <imagedata fileref="images/patrons/duplicatewarn.png"/>
23011 <para>A duplicate patron is detected if first and last names match and there is no date of
23012 birth populated or if first name, last name and date of birth fields are all populated. If
23013 two patrons have matching names, but one has a date of birth and the other does not they
23014 will not match as duplicates.</para>
23017 <para>If you have set a minimum or upper age limit on the patron
23018 category and are requiring that the birth date be filled in, Koha will
23019 warn you if the patron you're adding is too old or young for the patron
23020 category you have selected:</para>
23023 <screeninfo>Patron age warning</screeninfo>
23027 <imagedata fileref="images/patrons/patronagelimit.png"/>
23033 <section id="addstaffpatron">
23034 <title>Add a Staff Patron</title>
23036 <para>All staff members must be entered into Koha as patrons of the
23037 'Staff' type. Follow the steps in <link linkend="addnewpatron">Add a
23038 Patron</link> to add a staff member. To give the staff member
23039 permissions to access the staff client, follow the steps in <link linkend="patronpermissions">Patron Permissions</link></para>
23042 <para>Remember to assign your staff secure usernames and passwords
23043 since these will be used to log into the staff client.</para>
23047 <section id="addstatspatron">
23048 <title>Add a Statistical Patron</title>
23050 <para>One way to track use of in house items is to "check out" the
23051 materials to a statistical patron. The "check out" process doesn's check
23052 the book out, but instead tracks an in house use of the item. To use
23053 this method for tracking in house use you first will need a <link linkend="patcats">patron category</link> set up for your Statistical
23057 <screeninfo>In House Patron Category</screeninfo>
23061 <imagedata fileref="images/patrons/statspatcat.png"/>
23066 <para>Next, you will need to create a new patron of the statistical
23070 <screeninfo>New In House Patron</screeninfo>
23074 <imagedata fileref="images/patrons/newinhouse.png"/>
23079 <para>Next, follow the steps put forth in the '<link linkend="addnewpatron">Add a new Patron</link>' section of this manual.
23080 Since this patron is not a real person, simply fill in the required
23081 fields, the correct library and nothing else.</para>
23083 <para>To learn about other methods of tracking in house use visit the
23084 <link linkend="trackinhouse">Tracking inhouse use</link> section of this
23088 <section id="duplicatepatron">
23089 <title>Duplicate a Patron</title>
23091 <para>Sometimes when you're adding a new family to your system you don't
23092 want to type the contact information over and over. Koha allows for you
23093 to duplicate a patron and change only the parts you want to (or need to)
23098 <para>Open the patron you want to use as your base (the patron you
23099 want to duplicate information from)</para>
23103 <para>Click the 'Duplicate' button at the top of their record</para>
23106 <screeninfo>The Duplicate Button is the 3rd one in</screeninfo>
23110 <imagedata fileref="images/patrons/patronedit.png"/>
23117 <para>All of the fields with the exception of first name, card
23118 number, username and password have been duplicated. Fill in the
23119 missing pieces and click 'Save'</para>
23122 <screeninfo>Duplicating Patron Form</screeninfo>
23126 <imagedata fileref="images/patrons/duplicatedpatron.png"/>
23134 <para>Clicking in a field that is already populated with data
23135 will clear that field of all information (making it easier for
23136 you to type in something different)</para>
23143 <para>You will be brought to your new patron</para>
23146 <screeninfo>Newly created patron</screeninfo>
23150 <imagedata fileref="images/patrons/duplicatedpatronfinal.png"/>
23157 <section id="addpatronimages">
23158 <title>Add Patron Images</title>
23159 <para>If you would like you can add patron images to help identify patrons. To enable this
23160 feature you must first set the <link linkend="patronimages">patronimages</link> preference
23162 <para>If the preference is set to 'Allow' you will see a placeholder image under the patron's
23163 name and box to upload a patron image below the basic contact information.</para>
23165 <screeninfo>Add patron image</screeninfo>
23168 <imagedata fileref="images/patrons/addpatronimage.png"/>
23172 <para>In the 'Upload Patron Image' box click 'Browse' to find the image on your computer and
23173 'Upload' to load the image on to the patron record.</para>
23175 <screeninfo>Patron image</screeninfo>
23178 <imagedata fileref="images/patrons/patronimage.png"/>
23184 <para>There is a limit of 100K on the size of the picture uploaded and it is recommended
23185 that the image be 200x300 pixels, but smaller images will work as well.</para>
23190 <section id="editpatrons">
23191 <title>Editing Patrons</title>
23193 <para>Patrons in Koha can be edited using one of many edit
23198 <para>To edit the entire patron record simply click the 'Edit'
23199 button at the top of the patron record.</para>
23202 <screeninfo>Main Patron Edit Menu</screeninfo>
23206 <imagedata fileref="images/patrons/patronedit.png"/>
23213 <para>Patron passwords are not recoverable. The stars show on the
23214 patron detail next to the Password label are always there even if a
23215 password isn't set. If a patron forgets their password the only
23216 option is to reset their password. To change the patron's password,
23217 click the 'Change Password' button</para>
23220 <screeninfo>Patron Password Change Form</screeninfo>
23224 <imagedata fileref="images/patrons/patronpassword.png"/>
23231 <para>Koha cannot display existing passwords. Leave the field
23232 blank to leave password unchanged.</para>
23236 <para>This form can automatically generate a random password if
23237 you click the link labeled "Click to fill with a randomly
23238 generated suggestion. Passwords will be displayed as
23245 <para>To edit a specific section of the patron record (for example
23246 the Library Use section) click the 'Edit' link below the
23250 <screeninfo>Library Use Section of Patron Record</screeninfo>
23254 <imagedata fileref="images/patrons/patroneditsection.png"/>
23261 <para>A patron image can be added by browsing for the image on your
23262 machine from the 'Manage Patron Image' section</para>
23265 <screeninfo>Manage Patron Image Form</screeninfo>
23269 <imagedata fileref="images/patrons/patronaddimage.png"/>
23276 <para>This form will not appear if you have the <link linkend="patronimages">patronimages</link> system preference to
23277 not allow patron images</para>
23281 <para>To add patron images in bulk, use the <link linkend="uploadpatronimages">Upload Patron Images</link>
23288 <para id="patronflags">Patrons can also be blocked from checking
23289 items out by setting Patron Flags</para>
23292 <screeninfo>Patron Warning Flags</screeninfo>
23296 <imagedata fileref="images/patrons/patronflags.png"/>
23303 <para>If you would like your circulation staff to confirm a
23304 patron's address before checking items out to the patron, you
23305 can see the 'Gone no Address' flag</para>
23308 <screeninfo>Patron's address in doubt</screeninfo>
23312 <imagedata fileref="images/patrons/patronaddress.png"/>
23318 <para>If the patron reports that they have lost their card you can set the 'Lost Card'
23319 flag to prevent someone else from using that card to check items out</para>
23321 <screeninfo>Patron lost card</screeninfo>
23324 <imagedata fileref="images/patrons/patroncardlost.png"/>
23331 <para>If you would like to bar a patron from the library you can add a manual
23334 <screeninfo>Add manual restriction</screeninfo>
23337 <imagedata fileref="images/patrons/addpatronrestriction.png"/>
23344 <tip><para>This flag can automatically be set with the <link linkend="noticetriggers">Overdue/Notice Status
23345 Triggers</link></para></tip>
23351 <para>If you enter in a date and/or note related to the
23352 restriction you will see that in the restricted message as
23356 <screeninfo>Restricted until message</screeninfo>
23360 <imagedata fileref="images/patrons/restricteduntil.png"/>
23369 <para>Children patrons do not become adults automatically in Koha unless you have <link linkend="j2acron">Juvenile to Adult cron job</link> running. To upgrade a child patron
23370 to and adult patron category manually go to the 'More' menu and choose 'Update Child to
23371 Adult Patron'</para>
23374 <screeninfo>Update Child to Adult Patron</screeninfo>
23378 <imagedata fileref="images/patrons/updatetoadult.png"/>
23385 <para>You will then be presented with a pop up window asking
23386 which one of your adult patron categories this Child should be
23390 <screeninfo>Choose Adult Category to Update To</screeninfo>
23394 <imagedata fileref="images/patrons/choosadulttype.png"/>
23403 <section id="mangepatronedits">
23404 <title>Manging Patron Self Edits</title>
23405 <para>If you are allowing patrons to edit their accounts via the OPAC with the <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference then you will need to
23406 approve all changes via the staff client before they're applied. If there are patron edits
23407 awaiting action they will appear on the staff client dashboard below the modules list (along
23408 with other items awaiting action).</para>
23410 <screeninfo>Patron requests waiting</screeninfo>
23413 <imagedata fileref="images/patrons/pendingpatronrequest.png"/>
23417 <para>When you click the 'Patrons requesting modifications' link you will be brought to a list
23418 of patrons with requested changes.</para>
23420 <screeninfo>Manage patron updates</screeninfo>
23423 <imagedata fileref="images/patrons/managepatronupdates.png"/>
23427 <para>From here you can 'Approve' and apply the changes to the patron record, 'Delete' and
23428 remove the changes or 'Ignore' and keep the changes pending to review later.</para>
23431 <section id="patronpermissions">
23432 <title>Patron Permissions</title>
23434 <para>Patron Permissions are used to allow staff members access to the
23435 staff client.</para>
23438 <para>In order for a staff member to log into the staff interface they
23439 must have (at the very least) 'catalogue' permissions which allow them
23440 to view the staff interface.</para>
23443 <section id="setpatronperms">
23444 <title>Setting Patron Permissions</title>
23446 <para>To set patron permissions, you must first <link linkend="addstaffpatron">have a patron of the 'Staff' type</link>
23451 <para>On the patron record click More and choose Set Permissions
23452 to alter patron permissions</para>
23455 <screeninfo>Set Patron Permissions</screeninfo>
23459 <imagedata fileref="images/patrons/editpatronpermissions.png"/>
23466 <para>You will be presented with a list of preferences, some of
23467 which can be expanded by clicking the plus sign to the left of the
23468 section title.</para>
23471 <screeninfo>Patron Permissions</screeninfo>
23475 <imagedata fileref="images/patrons/GranularPermissions.png"/>
23483 <section id="patronpermsdefined">
23484 <title>Patron Permissions Defined</title>
23490 <para>superlibrarian</para>
23494 <para>Access to all librarian functions</para>
23499 <para>With this selected there is no need to choose any
23500 other permissions</para>
23509 <para>circulate</para>
23513 <para>Check out and check in items</para>
23517 <para>This section can be expanded (<link linkend="circpermissions">Learn more</link>)</para>
23523 <para>catalogue</para>
23527 <para><emphasis role="bold">Required for staff login.</emphasis> Staff access,
23528 allows viewing the catalogue in staff client<itemizedlist>
23531 <para>Must be given to all staff members to allow them to login to the staff
23535 </itemizedlist></para>
23541 <para>parameters</para>
23545 <para>Manage Koha system systems (Administration panel)</para>
23549 <para>This section can be expanded (<link linkend="parameterpermissions">Learn
23550 more</link>)</para>
23556 <para>borrowers</para>
23560 <para>Add or modify patrons</para>
23566 <para>permissions</para>
23570 <para>Set user permissions</para>
23576 <para>reserveforothers</para>
23580 <para>Place and modify holds for patrons</para>
23584 <para>This section can be expanded (<link linkend="reservepermissions">Learn more</link>)</para>
23590 <para>borrow</para>
23594 <para>Borrow books</para>
23600 <para>editcatalogue</para>
23604 <para>Edit Catalog (Modify bibliographic/hodings data)</para>
23608 <para>This section can be expanded (<link linkend="catpermissions">Learn more</link>)</para>
23614 <para>updatecharges</para>
23618 <para>Manage patrons fines and fees</para>
23624 <para>acquisition</para>
23628 <para>Acquisition and/or suggestion management</para>
23632 <para>This section can be expanded (<link linkend="acqpermissions">Learn more</link>)</para>
23638 <para>management</para>
23642 <para>Set library management paraments (deprecated)<itemizedlist>
23645 <para>This permission level no longer controls anything.</para>
23648 </itemizedlist></para>
23658 <para>Use all tools</para>
23662 <para>This section can be expanded (<link linkend="toolspermissions">Learn more</link>)</para>
23668 <para>editauthorities</para>
23672 <para>Edit Authorities</para>
23678 <para>serials</para>
23682 <para>Manage serial subscriptions</para>
23686 <para>This section can be expanded (<link linkend="serpermissions">Learn more</link>)</para>
23692 <para>reports</para>
23696 <para>Allow access to the reports module</para>
23700 <para>Reports found on the Circulation page are not controlled
23701 by this permission</para>
23705 <para>This section can be expanded (<link linkend="reportpermissions">Learn more</link>)</para>
23711 <para>staffaccess</para>
23715 <para>Allow staff members to modify permissions for other staff members</para>
23720 <para>Requires the borrowers permission above</para>
23726 <para>plugins<itemizedlist>
23728 <para>Koha plugins</para>
23731 <para>This section can be expanded (<link linkend="pluginpermissions">Learn
23732 more</link>)</para>
23734 </itemizedlist></para>
23738 <section id="circpermissions">
23739 <title>Granular Circulate Permissions</title>
23741 <para>If the staff member has 'circulate' permissions they have the
23742 ability to perform all of these actions. If you would like to
23743 control circulation permissions on a more granular level choose from
23744 these options:</para>
23748 <para>circulate_remaining_permissions</para>
23752 <para>Remaining circulation permissions</para>
23755 <para>All circulation rights except the ability to override renewals</para>
23760 <para>overdues_report<itemizedlist>
23762 <para> Execute overdue items report </para>
23765 <para>The permission to run the overdues reports found under Circulation</para>
23767 </itemizedlist></para>
23771 <para>override_renewals</para>
23775 <para>Override blocked renewals</para>
23779 <para>Requires that the staff member also has
23780 circulate_remaining_permissions</para>
23787 <section id="parameterpermissions">
23788 <title>Granular Parameters Permissions</title>
23790 <para>If the staff member has 'parameters' permissions they have the
23791 ability to perform all of these actions. If you would like to
23792 control parameter permissions on a more granular level choose from
23793 these options:</para>
23797 <para>manage_circ_rules</para>
23801 <para>Manage circulation rules</para>
23804 <para>The ability to access the <link linkend="circfinerules">Circulation and
23805 fines rules</link> in the administration area</para>
23811 <para>parameters_remaining_permissions</para>
23815 <para>Remaining system parameters permissions</para>
23818 <para>The ability to access all areas in Administration (other than the
23819 Circulation and fine rules)</para>
23826 <section id="reservepermissions">
23827 <title>Granular Holds Permissions</title>
23829 <para>If the staff member has 'reserveforothers' permissions they
23830 have the ability to perform all of these actions. If you would like
23831 to control holds permissions on a more granular level choose from
23832 these options:</para>
23836 <para>modify_holds_priority</para>
23840 <para>Modify holds priority</para>
23843 <para>Allow staff members to alter the holds priority (moving patrons up and down
23850 <para>place_holds</para>
23854 <para>Place holds for patrons</para>
23861 <section id="catpermissions">
23862 <title>Granular Cataloging Permissions</title>
23864 <para>If the staff member has 'editcatalogue' permissions they have
23865 the ability to perform all of these actions. If you would like to
23866 control cataloging permissions on a more granular level choose from
23867 these options:</para>
23871 <para>edit_catalogue</para>
23875 <para>Edit catalog (Modify bibliographic/holdings data)</para>
23878 <para>Ability to access all cataloging functions via the <link linkend="cataloging">Cataloging</link> page</para>
23884 <para>edit_items</para>
23888 <para>Edit items</para>
23891 <para>Ability to make <link linkend="editingitems">edits to item/holdings
23892 records</link>, but not bibliographic records</para>
23898 <para id="fastaddpermissions">fast_cataloging</para>
23902 <para>Fast cataloging</para>
23905 <para>The ability to catalog using only the <link linkend="fastaddcat">Fast Add
23906 Framework</link> found on the <link linkend="circulation">Circulation</link>
23914 <section id="acqpermissions">
23915 <title>Granular Acquisitions Permissions</title>
23917 <para>If the staff member has 'acquisition' permissions they have
23918 the ability to perform all of these actions. If you would like to
23919 control acquisitions permissions on a more granular level choose
23920 from these options:</para>
23924 <para>budget_add_del</para>
23928 <para>Add and delete budgets (but can't modify them)</para>
23934 <para>budget_manage</para>
23937 <para>Manage budgets</para>
23943 <para>budget_manage_all <itemizedlist>
23945 <para>Manage all budgets</para>
23947 </itemizedlist></para>
23948 <para>budget_modify</para>
23951 <para>Modify budget (can't create lines, but can modify existing ones)</para>
23957 <para>contracts_manage</para>
23961 <para>Manage contracts</para>
23967 <para>group_manage</para>
23971 <para>Manage orders and basket groups</para>
23977 <para>order_manage</para>
23981 <para>Manage orders and baskets</para>
23986 <para>order_manage_all<itemizedlist>
23988 <para>Manage all orders and baskets, regardless of restrictions on them</para>
23990 </itemizedlist></para>
23994 <para>order_receive</para>
23998 <para>Manage orders and baskets</para>
24004 <para>period_manage</para>
24008 <para>Manage periods</para>
24014 <para>planning_manage</para>
24018 <para>Manage budget planning</para>
24024 <para>vendors_manage</para>
24028 <para>Manage vendors</para>
24035 <section id="serpermissions">
24036 <title>Granular Serials Permissions</title>
24038 <para>If the staff member has 'serials' permissions they have the
24039 ability to perform all of these actions. If you would like to
24040 control serials permissions on a more granular level choose from
24041 these options:</para>
24045 <para>check_expiration</para>
24049 <para>Check the <link linkend="serialexpiration">expiration of a
24050 serial</link></para>
24056 <para>claim_serials</para>
24060 <para>Claim missing serials via the <link linkend="serialclaims">Claims
24061 section</link></para>
24067 <para>create_subscription</para>
24071 <para>Create <link linkend="newsubscription">a new subscription</link></para>
24077 <para>delete_subscription</para>
24081 <para>Delete an existing subscription</para>
24087 <para>edit_subscription</para>
24091 <para>Edit an existing subscription</para>
24094 <para>This permission does not include the ability to delete or create a
24095 subscription</para>
24101 <para>receive_serials</para>
24105 <para>Serials receiving</para>
24108 <para>Receive serials on existing subscriptions</para>
24114 <para>renew_subscription</para>
24118 <para>Renew a subscription</para>
24124 <para>routing</para>
24128 <para>Routing</para>
24131 <para>Manage <link linkend="routinglist">routing lists</link></para>
24136 <para>superserials<itemizedlist>
24138 <para>Manage subscriptions from any branch (only applies when <link
24139 linkend="IndependentBranches">IndependantBranches</link> is used)</para>
24141 </itemizedlist></para>
24146 <section id="toolspermissions">
24147 <title>Granular Tools Permissions</title>
24149 <para>If the staff member has 'tools' permissions they have the
24150 ability to access and use all items under the Tools menu. If you
24151 would like to control which tools staff members have access to on a
24152 more granular level choose from these options:</para>
24156 <para>batch_upload_patron_images</para>
24160 <para>Upload patron images in batch or one at a time </para>
24163 <para>Access to the <link linkend="uploadpatronimages">Image Upload
24170 <para>delete_anonymize_patrons</para>
24174 <para>Delete old borrowers and anonymize circulation/reading history (deletes
24175 borrower reading history)</para>
24178 <para>Access to the <link linkend="anonpatrons">Anonymize Patron
24185 <para>edit_calendar</para>
24189 <para>Define days when the library is closed </para>
24192 <para>Access to the <link linkend="calholidays">Calendar/Holidays
24199 <para>edit_news</para>
24203 <para>Write news for the OPAC and staff interfaces </para>
24206 <para>Access to the <link linkend="newstool">News Tool</link></para>
24212 <para>edit_notice_status_triggers</para>
24216 <para>Set notice/status triggers for overdue items </para>
24219 <para>Access to the <link linkend="noticetriggers">Overdue Notice Status/Triggers
24226 <para>edit_notices</para>
24230 <para>Define notices </para>
24233 <para>Access to the <link linkend="notices">Notices Tool</link></para>
24239 <para>export_catalog</para>
24243 <para>Export bibliographic, authorities and holdings data </para>
24246 <para>Access to the <link linkend="exportbibs">Export Data Tool</link></para>
24252 <para>import_patrons</para>
24256 <para>Import patron data </para>
24259 <para>Access to the <link linkend="patronimport">Import Patrons Tool</link></para>
24265 <para>inventory</para>
24269 <para>Perform inventory (stocktaking) of your catalog </para>
24272 <para>Access to the <link linkend="inventory">Inventory Tool</link></para>
24278 <para>items_batchdel</para>
24282 <para>Perform batch deletion of items </para>
24285 <para>Access to the <link linkend="batchdeleteitems">Batch Item Deletion
24292 <para>items_batchmod</para>
24296 <para>Perform batch modification of items </para>
24299 <para>Access to the <link linkend="batchmodifyitems">Batch Item Modification
24306 <para>label_creator</para>
24310 <para>Create printable labels and barcodes from catalog and patron data </para>
24313 <para>Access to the <link linkend="labelcreator">Label Creator</link> and <link linkend="quicklabelcreator">Quick Label Creator</link> Tools</para>
24319 <para>manage_csv_profiles</para>
24323 <para>Manage CSV export profiles</para>
24326 <para>Access to the <link linkend="csvprofiles">CSV Profiles Tool</link></para>
24332 <para>manage_staged_marc</para>
24336 <para>Managed staged MARC records, including completing and reversing imports
24340 <para>Access to the <link linkend="managestaged">Manage Staged MARC Records
24347 <para>moderate_comments</para>
24351 <para>Moderate patron comments </para>
24354 <para>Access to the <link linkend="comments">Comments Tool</link>
24361 <para>moderate_tags<itemizedlist>
24363 <para>Moderate patron tags</para>
24366 <para>Access to the <link linkend="tagsmoderation">Tags Tool</link></para>
24368 </itemizedlist></para>
24371 <para>schedule_tasks</para>
24374 <para>Schedule tasks to run </para>
24377 <para>Access to the <link linkend="taskscheduler">Task Scheduler
24384 <para>stage_marc_import</para>
24388 <para>Stage MARC records into the reservoir </para>
24391 <para>Access to the <link linkend="stagemarc">Stage MARC Records
24398 <para>upload_local_cover_images</para>
24402 <para>Upload local cover images </para>
24405 <para>Access to the <link linkend="uploadlocalimages">Upload Local Cover Image
24406 Tool</link> as well as permission to add and delete local cover images from
24407 the bib detail page</para>
24413 <para>view_system_logs</para>
24417 <para>Browse the system logs </para>
24420 <para>Access to the <link linkend="logviewer">Log Viewer Tool</link></para>
24427 <section id="reportpermissions">
24428 <title>Granular Reports Permissions</title>
24430 <para>If the staff member has 'reports' permissions they have the
24431 ability to perform all of these actions. If you would like to
24432 control reports permissions on a more granular level choose from
24433 these options:</para>
24437 <para>create_reports</para>
24441 <para>Create SQL Reports</para>
24444 <para>The ability to create and edit but not run SQL reports</para>
24450 <para>execute_reports</para>
24454 <para>Execure SQL Reports</para>
24457 <para>The ability to run but not create or edit SQL reports </para>
24463 <section id="pluginpermissions">
24464 <title>Granular Plugins Permissions</title>
24465 <para>If the staff member has 'plugins' permissions they have the ability to perform all
24466 of these actions. If you would like to control reports permissions on a more granular
24467 level choose from these options:<itemizedlist>
24469 <para>configure<itemizedlist>
24471 <para>Configure plugins</para>
24474 <para>The ability to run the 'configure' section of a plugin if it has
24477 </itemizedlist></para>
24480 <para>manage<itemizedlist>
24482 <para>Manage plugins </para>
24485 <para>The ability to install or uninstall plugins</para>
24487 </itemizedlist></para>
24490 <para>report<itemizedlist>
24492 <para>Use report plugins</para>
24495 <para>The ability to use report plugins</para>
24497 </itemizedlist></para>
24500 <para>tool<itemizedlist>
24502 <para>Use tool plugins</para>
24505 <para>The ability to use tool plugins</para>
24507 </itemizedlist></para>
24509 </itemizedlist></para>
24514 <section id="patroninformation">
24515 <title>Patron Information</title>
24517 <para>When viewing a patron record you have the option to view information from one of many
24518 tabs found on the left hand side of the record.<itemizedlist>
24520 <para><emphasis role="italic">Get there:</emphasis> Patrons > Browse or search for
24521 patron > Click patron name</para>
24523 </itemizedlist></para>
24525 <section id="patcheckout">
24526 <title>Check Out</title>
24528 <para>For instruction on checking items out, view the <link linkend="checkingout">Checking Out</link> section of this
24532 <section id="patrondetails">
24533 <title>Details</title>
24535 <para>All patron information will appear on the Details tab. This
24536 includes all the contact information, notes, custom patron attributes,
24537 messaging preferences, etc entered when adding the patron.</para>
24539 <para>In the case of patrons who are marked as 'Child' or
24540 'Professional' and their Guarantors additional information will appear
24541 on their record.</para>
24545 <para>A child patron will list their Guarantor</para>
24548 <screeninfo>Guarantor listed and linked from the child
24549 record</screeninfo>
24553 <imagedata fileref="images/patrons/child.png"/>
24560 <para>On the Guarantor's record, all children and/or professionals
24561 will be listed</para>
24564 <screeninfo>Guarantees listed on the Guarantor's
24565 profile</screeninfo>
24569 <imagedata fileref="images/patrons/parent.png"/>
24576 <section id="patcircsummary">
24577 <title>Circulation Summary</title>
24579 <para>Below the patron's information on the details screen is a
24580 tabbed display of the items they have checked out, overdue, and on
24584 <screeninfo>Checkout summary</screeninfo>
24588 <imagedata fileref="images/patrons/checkoutsummary.png"/>
24593 <para>If they have family at the library staff can see what the
24594 other family members have checked out.</para>
24597 <screeninfo>Relative checkouts</screeninfo>
24601 <imagedata fileref="images/patrons/relativecheckouts.png"/>
24605 <para>The Restrictions tab will show for all patrons. If the patron has no restrictions
24606 you will see that on the tab.</para>
24608 <screeninfo>Patron restrictions</screeninfo>
24611 <imagedata fileref="images/patrons/patronrestrictions-none.png"/>
24615 <para>If the patron has restrictions on their account the tab will show the number and the
24616 description.</para>
24618 <screeninfo>Patron restrictions</screeninfo>
24621 <imagedata fileref="images/patrons/patronrestrictions.png"/>
24625 <para>Using the 'Add manual restriction' button you can add a restriction to the patron
24626 record from here.</para>
24628 <screeninfo>Add restriction</screeninfo>
24631 <imagedata fileref="images/patrons/addrestriction.png"/>
24638 <section id="patronfines">
24639 <title>Fines</title>
24641 <para>The patron's complete accounting history will appear on the
24642 Fines tab. Contrary to its name, the Fines tab does not just show fine
24643 data, it also shows membership fees, rental fees, reserve fees and any
24644 other charge you may have for patrons.</para>
24647 <screeninfo>Patron Accounting Summary</screeninfo>
24651 <imagedata fileref="images/patrons/patronaccount.png"/>
24656 <para>The table will show you the following columns:</para>
24660 <para>Date: the date the charge/payment was posted</para>
24664 <para>In the case of fines this will be the last day that the
24665 fine was accrued</para>
24671 <para>Description: a description of the charges including the due
24672 date for overdue items and a link to the item record where one is
24677 <para>Note: any notes about this charge/payment</para>
24681 <para>Amount: the total amount of the payment or charge</para>
24685 <para>Outstanding: the amount still due on charge</para>
24689 <section id="chargefines">
24690 <title>Charging Fines/Fees</title>
24692 <para>Most fees and fines will be charged automatically if the <link linkend="finescronjob">fines cron job</link> is running:</para>
24696 <para>Fines will be charged based on your <link linkend="circfinerules">Circulation & Fines
24697 Rules</link></para>
24701 <para>Hold fees will be charged based on the rules you set in
24702 the <link linkend="patcats">Patron Types & Categories</link>
24703 administration area</para>
24707 <para>Rental fees will be charged based on the settings in your
24708 <link linkend="itemtypeadmin">Item Types</link> administration
24713 <para>Marking an item 'Lost' via the cataloging module will
24714 automatically charge the patron the replacement cost for that
24720 <section id="payfines">
24721 <title>Pay/Reverse Fines</title>
24723 <para>Each line item can be paid in full (or written off) using the
24724 'Pay Fines' tab.</para>
24727 <screeninfo>Paying Fines</screeninfo>
24731 <imagedata fileref="images/patrons/makepayment.png"/>
24738 <para>Each line item can be paid in full, partially paid, or
24739 written off.</para>
24743 <para>Pay a fine in full</para>
24747 <para>Click "Pay" next to the fine you want to pay in
24752 <para>The full amount of the fine will be populated for you
24753 in the "Collect From Patron" box</para>
24756 <screeninfo>Pay fine</screeninfo>
24760 <imagedata fileref="images/patrons/payfine.png"/>
24767 <para>Click "Confirm"</para>
24771 <para>The fine will be removed from outstanding fines, and
24772 displayed as fully paid.</para>
24778 <para>Pay a partial fine</para>
24782 <para>Click "Pay" next to the fine you want to partially
24787 <para>Enter the amount you are collecting from the patron in
24788 the "Collect From Patron" box</para>
24791 <screeninfo>Pay partial fine</screeninfo>
24795 <imagedata fileref="images/patrons/paypartial.png"/>
24802 <para>Click "Confirm"</para>
24806 <para>The fine will be updated to show the original Amount,
24807 and the current Amount Outstanding</para>
24813 <para>Pay an amount towards all fines</para>
24817 <para>Click the "Pay Amount" button</para>
24821 <para>Enter the amount you are collecting from the patron in
24822 "Collect from Patron." The sum of all fines is shown in
24823 "Total Amount Outstanding"</para>
24826 <screeninfo>Pay Amount</screeninfo>
24830 <imagedata fileref="images/patrons/payamount.png"/>
24837 <para>Click "Confirm"</para>
24841 <para>The fine totals will be updated with the payment
24842 applied to oldest fines first.</para>
24848 <para>Pay Selected fines</para>
24852 <para>Check the selection boxes next to the fines you wish
24853 to pay, click "Pay Selected"</para>
24856 <screeninfo>Select lines to pay</screeninfo>
24860 <imagedata fileref="images/patrons/payselected-select.png"/>
24867 <para>Enter an amount to pay towards the fines.</para>
24870 <screeninfo>Pay Selected</screeninfo>
24874 <imagedata fileref="images/patrons/payselected.png"/>
24881 <para>Click "Confirm"</para>
24885 <para>The fine totals will be updated with the payment
24886 applied to the oldest selected fines first.</para>
24892 <para>Writeoff a single fine</para>
24896 <para>Click "Writeoff" next to the fine you wish to
24901 <para>The fine will be removed from outstanding fines, and
24902 displayed as written off.</para>
24908 <para>Writeoff All fines</para>
24912 <para>Click the "Writeoff All" button</para>
24916 <para>All fines will be removed from outstanding fines, and
24917 displayed as written off.</para>
24923 <para>If you accidentally mark and item as paid, you can reverse
24924 that line item by clicking 'Reverse' to the right of the
24928 <screeninfo>Reverse Link</screeninfo>
24932 <imagedata fileref="images/patrons/reverselink.png"/>
24939 <para>Once clicked a new line item will be added to the
24940 account, showing the payment as reversed</para>
24943 <screeninfo>Reversed Payment</screeninfo>
24947 <imagedata fileref="images/patrons/reversed.png"/>
24957 <section id="manualinvoice">
24958 <title>Creating Manual Invoices</title>
24960 <para>For fees that are not automatically charged, librarians can
24961 create a manual invoice</para>
24964 <screeninfo>Create Manual Invoice</screeninfo>
24968 <imagedata fileref="images/patrons/manualinvoice.png"/>
24975 <para>First choose the type of invoice you would like to
24980 <para>To add additional values to the manual invoice type pull down menu, add them
24981 to the <link linkend="manualinvvals">MANUAL_INV</link> Authorized Value</para>
24986 <para>The value set as the Authorized Value for the MANUAL_INV authorized
24987 value category will appear as the Description and the Authorized Value
24988 Description will be used as the amount.</para>
24996 <para>If the fee is associated with an item you can enter its
24997 barcode so that the line item shows a link to that item</para>
25001 <para>The description field is where you will enter the
25002 description of the charge</para>
25006 <para>In the amount field, do not enter currency symbols, only
25007 numbers and decimals</para>
25012 <section id="manualcredit">
25013 <title>Creating Manual Credits</title>
25015 <para>Manual credits can be used to pay off parts of fines, or to
25016 forgive a fine amount.</para>
25019 <screeninfo>Create Manual Credit</screeninfo>
25023 <imagedata fileref="images/patrons/manualcredit.png"/>
25030 <para>First choose the type of credit you'd like to apply</para>
25034 <para>If this credit is associated with an item you can enter
25035 that item's barcode so that the line item links to the right
25040 <para>The description field is where you will enter the
25041 description of the credit</para>
25045 <para>In the amount field, do not enter currency symbols, only
25046 numbers and decimals</para>
25051 <section id="printinglineitems">
25052 <title>Printing Invoices</title>
25054 <para>To the right of each account line there is a print link.
25055 Clicking that link will print an invoice for the line item that
25056 includes the date and description of the line item along with the
25057 total outstanding on the account.</para>
25060 <screeninfo>Sample Invoice</screeninfo>
25064 <imagedata fileref="images/patrons/patroninvoice.png"/>
25071 <section id="patronroutingtab">
25072 <title>Routing Lists</title>
25074 <para>A list of all of the serial routing lists the patron belongs to
25075 will be accessible via the 'Routing Lists' tab on the patron
25079 <screeninfo>Routing Lists</screeninfo>
25083 <imagedata fileref="images/patrons/routinglisttab.png"/>
25088 <para>On this tab you will be able to see and edit all of the routing
25089 lists that this patron is on.</para>
25092 <screeninfo>Patron's routing lists</screeninfo>
25096 <imagedata fileref="images/patrons/patronroutinglists.png"/>
25102 <section id="circhistory">
25103 <title>Circulation History</title>
25105 <para>The circulation history tab will appear if you have set the
25106 <link linkend="intranetreadinghistory">intranetreadinghistory</link>
25107 preference to allow it to appear. If you have the <link linkend="OPACPrivacy">OPACPrivacy</link> system preference set to
25108 'Allow' and the patron has decided that the library cannot keep this
25109 information this tab will only show currently checked out
25113 <screeninfo>Patron Circulation History</screeninfo>
25117 <imagedata fileref="images/patrons/readinghistory.png"/>
25122 <para>If you would like to export a list of barcodes for the items
25123 checked in today you can find that option under the More menu on the
25124 top right of the page.</para>
25127 <screeninfo>Export today's checkins</screeninfo>
25131 <imagedata fileref="images/patrons/readinghistory-export.png"/>
25136 <para>This will generate a text file with one barcode per line.</para>
25139 <section id="patmodlog">
25140 <title>Modification Log</title>
25142 <para>If you have set your <link linkend="BorrowersLog">BorrowersLog</link> to track changes to patron
25143 records, then this tab will appear. The Modification Log will show
25144 when changes were made to the patron record. If you also have turned
25145 on the <link linkend="IssueLog">IssueLog</link> and <link linkend="ReturnLog">ReturnLog</link> you will see checkins and outs on
25146 this screen as well.</para>
25149 <screeninfo>Changes to Patron</screeninfo>
25153 <imagedata fileref="images/patrons/borrowerlog.png"/>
25160 <para>The Librarian field shows the patron number for the
25161 librarian who made the changes</para>
25165 <para>The module lists 'MEMBERS' for the patron module</para>
25169 <para>The action will tell you what action was being logged</para>
25173 <para>The Object field lists the borrowernumber that is being
25174 modified (in the example above, it was my changing my own
25180 <section id="patnotices">
25181 <title>Notices</title>
25183 <para>The <link linkend="setpatronmessaging">patron's messaging
25184 preferences</link> are set when <link linkend="addnewpatron">adding</link> or <link linkend="editpatrons">editing</link> the patron. This tab will show
25185 the messages that have been sent and those that are queued to be
25189 <screeninfo>Patron Notices Tab</screeninfo>
25193 <imagedata fileref="images/patrons/patnoticestab.png"/>
25198 <para>Clicking on the message title will expand the view to show you
25199 the full text of the message that was sent.</para>
25202 <screeninfo>Full message text</screeninfo>
25206 <imagedata fileref="images/patrons/patnoticestab-full.png"/>
25212 <section id="patronstatstab">
25213 <title>Statistics</title>
25215 <para>Depending on what you set for the values of your <link linkend="StatisticsFields">StatisticsFields</link> system preference,
25216 you can see statistics for one patron's circulation actions.</para>
25219 <screeninfo>Patron's Statistics</screeninfo>
25223 <imagedata fileref="images/patrons/patronstats.png"/>
25229 <section id="patronfiles">
25230 <title>Files</title>
25232 <para>If you set the <link linkend="EnableBorrowerFiles">EnableBorrowerFiles</link> preference to
25233 'Do' the Files tab will be visible on the patron information
25237 <screeninfo>Patron Files Tab</screeninfo>
25241 <imagedata fileref="images/patrons/patronfilestab.png"/>
25246 <para>From here you can upload files to attach to the patron
25250 <screeninfo>Upload patron files</screeninfo>
25254 <imagedata fileref="images/patrons/nopatronfiles.png"/>
25259 <para>All files that are uploaded will appear above a form where
25260 additional files can be uploaded from.</para>
25263 <screeninfo>List of files on the patron record</screeninfo>
25267 <imagedata fileref="images/patrons/patronfileslist.png"/>
25274 <section id="patronsearch">
25275 <title>Patron Search</title>
25277 <para>Clicking on the link to the Patron module will bring you to a search/browse screen for
25278 patrons. From here you can search for a patron by any part of their name or their card
25282 <screeninfo>Patron Search</screeninfo>
25286 <imagedata fileref="images/patrons/patronsearch.png"/>
25290 <para>Clicking the small plus sign [+] to the right of the search box will open up an advanced
25291 patron search with more filters including the ability to limit to a specific category and/or library.</para>
25293 <screeninfo>Expanded patron search</screeninfo>
25296 <imagedata fileref="images/patrons/patronsearchexpand.png"/>
25301 <para>Depending on what you have chosen for the 'Search fields' you can
25302 search for patrons in various different ways.</para>
25305 <screeninfo>Patron Search Fields</screeninfo>
25309 <imagedata fileref="images/patrons/patronfieldsearch.png"/>
25316 <para>Standard:</para>
25320 <para>Enter any part of their name, username, email address or
25327 <para>Email:</para>
25331 <para>Enter any part of their email address and choose 'Contains' instead of 'Starts
25338 <para>Borrower number:</para>
25342 <para>Enter the Koha borrower number</para>
25348 <para>Phone number:</para>
25352 <para>Enter the phone number exactly as it is in the system or
25353 by using spaces between each batch of numbers.</para>
25357 <para>Example: To find (212) 555-1212 you can search for it
25358 exactly as it was entered or by searching for 212 555
25365 <para>Street address:</para>
25369 <para>Enter any part of the patron's address (includes all address fields) and choose
25370 'Contains' instead of 'Starts with' to find the string anywhere in the
25376 <para>Date of birth<itemizedlist>
25378 <para>A tooltip will appear telling you how to enter the date of birth, most
25379 libraries will be entering MM/DD/YYYY for the birthday search</para>
25381 <screeninfo>Birth date search tooltip</screeninfo>
25384 <imagedata fileref="images/patrons/patronsearchbday.png"/>
25389 </itemizedlist></para>
25392 <para>You can also choose to either search for fields that start with the string you entered
25393 or contain the string. Choosing 'Contains' will work like a wildcard search.</para>
25395 <screeninfo>Contains or Starts with Search</screeninfo>
25398 <imagedata fileref="images/patrons/patronsearchcontains.png"/>
25403 <para>You can also choose how your results will be sorted by using the
25404 'Order by' pull down menu at the end of the form.</para>
25407 <screeninfo>Patron search sort</screeninfo>
25411 <imagedata fileref="images/patrons/patronsearchsort.png"/>
25416 <para>You can also browse through the patron records by clicking on the
25417 linked letters across the top.</para>
25420 <screeninfo>Patron Browse</screeninfo>
25424 <imagedata fileref="images/patrons/patronbrowse.png"/>
25431 <chapter id="circulation">
25432 <title>Circulation</title>
25434 <para>Circulation functions can be accessed in several different ways. On
25435 the main page of the staff client there are some quick links in the center
25436 of the page to check items out, in or transfer them. For a complete
25437 listing of Circulation functions you can visit the Circulation page which
25438 is linked from the top left of every page or from the center of the main
25441 <para>Before circulating your collection you will want to set your <link linkend="globalsysprefs">Global System Preferences</link>, <link linkend="basicparams">Basic Parameters</link> and <link linkend="patscirc">Patrons & Circulation Rules</link>.</para>
25443 <para>While in Circulation you can jump between the tabs on the quick
25444 search box at the top of the screen by using the following hot
25449 <para>jump to the catalog search with Alt+Q</para>
25453 <para>jump to the checkout with Alt+U</para>
25457 <para>this will not work for Mac users</para>
25463 <para>jump to the checkin with Alt+R</para>
25468 <para>Mac users use the OPTION button in place of ALT</para>
25471 <section id="checkingout">
25472 <title>Check Out (Issuing)</title>
25474 <para>To begin the checkout process you must enter the patron barcode or
25475 part of their name. The checkout option appears in three main
25480 <para>Check out option on the top of the main staff client</para>
25483 <screeninfo>Check out box on main Koha Staff Client
25488 <imagedata fileref="images/circ/checkoutmain.png"/>
25495 <para>Check out option on the patron record</para>
25498 <screeninfo>Check out tab on a patron record</screeninfo>
25502 <imagedata fileref="images/circ/checkoutpatron.png"/>
25509 <para>Check out option on the quick search bar on the circulation
25513 <screeninfo>Check out tab on quick search bar</screeninfo>
25517 <imagedata fileref="images/circ/circquickbox.png"/>
25524 <section id="checkitemout">
25525 <title>Checking Items Out</title>
25527 <para>To check an item out to a patron, first search for that patron
25528 using one of the many options listed above.</para>
25531 <screeninfo>Check Out Screen</screeninfo>
25535 <imagedata fileref="images/circ/checkingout.png"/>
25540 <para>At the top of the Check Out screen is a box for you to type or
25541 scan the item's barcode into.</para>
25546 <para>Many modern barcode scanners will send a 'return' to the
25547 browser, making it so that the 'Check Out' button is
25548 automatically clicked</para>
25553 <para>If the barcode is not found you will be prompted to use fast cataloging to add the
25554 item. Learn more about <link linkend="fastaddcat">fast cataloging</link> later in this
25558 <para>If you have <link linkend="itemBarcodeFallbackSearch"
25559 >itemBarcodeFallbackSearch</link> set to 'Enable' then you can enter a keyword
25560 search in this box instead of just a barcode (this will make it possible to check out
25561 using title and/or call number).</para>
25565 <para>Below the box for the barcode there may be options for you to
25566 override the default due date for the item.</para>
25570 <para>This option will only appear if you have set the <link linkend="SpecifyDueDate">SpecifyDueDate</link> system preference
25571 to allow staff to override the due date</para>
25575 <para>At the bottom of the page there is a summary of the patron's
25576 current checked out items along with the due date (and time if the
25577 item is an hourly loan), items checked out today will appear at the
25581 <para>If the checked out time is listed as 00:00 then the item is a
25582 daily loan item. The due time for daily checkouts will show 23:59
25583 which is the last minute of the day.</para>
25587 <screeninfo>Patron's checkout summary</screeninfo>
25591 <imagedata fileref="images/circ/checkoutsummary.png"/>
25595 <para>If you have set your <link linkend="ExportWithCsvProfile">ExportWithCsvProfile</link>
25596 preference, you will also see the option to export the patron's current checkout
25597 information using a CSV Profile or ISO2709 (MARC21) format.</para>
25599 <screeninfo>Export patron's checkout information</screeninfo>
25602 <imagedata fileref="images/circ/exportcheckouts.png"/>
25607 <para>Also at the bottom of the page is the list of items the patron
25611 <screeninfo>Holds summary on check out screen</screeninfo>
25615 <imagedata fileref="images/circ/holdssummary.png"/>
25620 <para>From the holds list you can suspend or resume patrons holds
25621 using the options at the bottom of the list if you have the <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link> preference
25622 set to 'allow.'</para>
25625 <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
25626 preference set to "Don't allow" then you will not have the option to
25627 put an end date on the hold suspension</para>
25630 <para>If there are notes on the patron record these will appear to the
25631 right of the checkout box</para>
25634 <screeninfo>Patron notes on check out screen</screeninfo>
25638 <imagedata fileref="images/circ/patronnotes.png"/>
25643 <para>If the patron has a hold waiting at the library that too will
25644 appear to the right of the check out box making it easy for the
25645 circulation librarian to see that there is another item to give the
25649 <screeninfo>Hold waiting message on check out screen</screeninfo>
25653 <imagedata fileref="images/circ/holdwaiting.png"/>
25658 <section id="printcircreceipt">
25659 <title>Printing Receipts</title>
25661 <para>Once you have checked out all of the items for the patron you
25662 can print them a receipt by choosing one of two methods.</para>
25664 <para>If you have the <link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
25665 preference set to 'open a print quick slip window' you can simply
25666 hit enter on your keyboard or scan a blank piece of paper with your
25667 barcode scanner. The idea being that you're "checking out" a blank
25668 barcode which triggers Koha to print the 'Quick slip.'</para>
25670 <para>You can also click the Print button at the top of the screen
25671 and choose 'Print slip' or 'Print quick slip'.</para>
25674 <screeninfo>Print receipt to slip printer</screeninfo>
25678 <imagedata fileref="images/circ/printslip.png"/>
25683 <para>If you choose 'Print slip' it will print all of the items the
25684 patron has checked out, including those they checked out at an
25685 earlier date. Choosing 'Print quick slip' will print only the items
25686 that were checked out today.</para>
25688 <para>What prints on the slips can be customized by altering the
25689 slip templates under the <link linkend="notices">Notices &
25690 Slips</link> tool.</para>
25693 <section id="clearpatroninfo">
25694 <title>Clear Patron Information</title>
25696 <para>When you're done checking an item out if you have the <link linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
25697 preference set to 'Show' you can clear the current patron by
25698 clicking the X in the top right of the patron's info to remove the
25699 current patron from the screen and start over.</para>
25702 <screeninfo>Clear Screen Button</screeninfo>
25706 <imagedata fileref="images/admin/globalprefs/DisplayClearScreenButton.png"/>
25711 <para>If you have the <link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link>
25712 preference set to 'clear the screen' then you simply need to hit
25713 enter or scan a blank barcode and the screen will be cleared of the
25714 current patron.</para>
25718 <section id="checkoutmsg">
25719 <title>Check Out Messages</title>
25721 <para>If you check out an item that has multiple pieces and you have
25722 cataloged that information in subfield 3 of the item record (in
25723 MARC21) a message will pop up when you check out that item telling you
25724 how many pieces should be there.</para>
25727 <screeninfo>Materials in the checked out item</screeninfo>
25731 <imagedata fileref="images/circ/materialspecified.png"/>
25736 <para>There are times when Koha will prevent the librarian from being
25737 able to check out items to a patron. When this happens a warning will
25738 appear notifying the librarian of why the patron cannot check items
25743 <para>Patron owes too much in fines</para>
25746 <screeninfo>Patron owes too much in fines</screeninfo>
25750 <imagedata fileref="images/circ/fineswarning.png"/>
25757 <para>You can set the amount at which patron checkouts are
25758 blocked with the <link linkend="noissuescharge">noissuescharge</link> system
25765 <para>Patron has been barred from the library</para>
25768 <screeninfo>Patron account barred</screeninfo>
25772 <imagedata fileref="images/circ/debarwarning.png"/>
25779 <para>This can be set by the librarian editing a patron record and adding a <link
25780 linkend="patronflags">restriction</link> or by the <link
25781 linkend="noticetriggers">Overdue/Notice Status Triggers</link></para>
25787 <para>Patron needs to confirm their address</para>
25790 <screeninfo>Patron's address warning</screeninfo>
25794 <imagedata fileref="images/circ/addresswarning.png"/>
25801 <para>This can be set by the librarian editing a patron record
25802 and adding a <link linkend="patronflags">flag</link></para>
25808 <para>Patrons has lost their library card</para>
25811 <screeninfo>Lost patron card warning</screeninfo>
25815 <imagedata fileref="images/circ/lostcardwarning.png"/>
25822 <para>This can be set by the librarian editing a patron record
25823 and adding a <link linkend="patronflags">flag</link></para>
25830 <section id="checkoutwarn">
25831 <title>Check Out Warnings</title>
25833 <para>Sometimes checkouts will trigger warning messages that will
25834 appear in a yellow box above the check out field. These warnings need
25835 to be acknowledged before you will be able to continue checking items
25840 <para>Patron has outstanding fines</para>
25843 <screeninfo>Patron has a debt</screeninfo>
25847 <imagedata fileref="images/circ/warnings/patrondebt.png"/>
25854 <para>Item on hold for someone else</para>
25857 <screeninfo>Item is on hold for someone else</screeninfo>
25861 <imagedata fileref="images/circ/warnings/onhold.png"/>
25868 <para>Item should be on the hold shelf waiting for someone
25872 <screeninfo>Item is on hold shelf waiting for someone
25877 <imagedata fileref="images/circ/warnings/holdwaiting.png"/>
25884 <para>Item already checked out to this patron</para>
25887 <screeninfo>Item is currently checked out to this
25888 patron</screeninfo>
25892 <imagedata fileref="images/circ/warnings/alreadycheckedout.png"/>
25899 <para>Item checked out to another patron</para>
25902 <screeninfo>Item checked out to another patron</screeninfo>
25906 <imagedata fileref="images/circ/warnings/checkedoutelse.png"/>
25913 <para>Item not for loan</para>
25916 <screeninfo>Item is not normally for loan</screeninfo>
25920 <imagedata fileref="images/circ/warnings/notforloan.png"/>
25927 <para>Patron has too many things checked out and <link linkend="AllowTooManyOverride"
25928 >AllowTooManyOverride</link> is set to 'Allow'</para>
25931 <screeninfo>Too many checkouts</screeninfo>
25935 <imagedata fileref="images/circ/warnings/toomanycheckouts.png"/>
25941 <para>Patron has too many things checked out and <link linkend="AllowTooManyOverride"
25942 >AllowTooManyOverride</link> is set to "Don't allow"</para>
25944 <screeninfo>Too many checkouts</screeninfo>
25947 <imagedata fileref="images/circ/warnings/toomanycheckouts-no.png"/>
25954 <para>Item cannot be renewed</para>
25957 <screeninfo>No more renewals</screeninfo>
25961 <imagedata fileref="images/circ/warnings/norenewals.png"/>
25968 <para>This can be overridden with the <link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
25969 system preference</para>
25975 <para>Barcode not found</para>
25978 <screeninfo>Barcode not found</screeninfo>
25982 <imagedata fileref="images/circ/barcodefastadd.png"/>
25989 <para>Learn more about <link linkend="fastaddcat">fast
25990 cataloging</link> later in this manual.</para>
25996 <para>Item being checked out is marked as 'lost'</para>
26000 <para>Depending on the value in your <link linkend="IssueLostItem">IssueLostItem</link> preference, you
26001 may just see a warning</para>
26004 <screeninfo>Warning that item is lost</screeninfo>
26008 <imagedata fileref="images/circ/lostitemmsg.png"/>
26013 <para>or a confirmation box</para>
26016 <screeninfo>Confirm checkout of lost item</screeninfo>
26020 <imagedata fileref="images/circ/lostitemconfirm.png"/>
26029 <para>Item being checked out is not recommended for a patron of
26033 <screeninfo>Age warning</screeninfo>
26037 <imagedata fileref="images/circ/warnings/agewarning.png"/>
26043 <para>Item being checked out meets the <link linkend="decreaseLoanHighHolds">decreaseLoanHighHolds</link> system preference criteria</para>
26045 <screeninfo>Too many holds</screeninfo>
26048 <imagedata fileref="images/circ/warnings/decreaseLoanHighHoldsDuration.png"/>
26057 <section id="circrenew">
26058 <title>Renewing</title>
26060 <para>Checked out items can be renewed (checked out for another period of time) based on your
26061 <link linkend="circfinerules">circulation rules</link> and <link
26062 linkend="RenewalPeriodBase">renewal preferences</link>. </para>
26063 <para>If <link linkend="OpacRenewalAllowed">you allow it</link>, patrons can renew their own
26064 items via the OPAC, but sometimes you'll need to help them by renewing their items via the
26065 staff client. </para>
26066 <para>To renew items checked out to a patron, you can do one of two things. </para>
26067 <para>The first is to visit their details page or checkout page and review their checkout
26068 summary at the bottom.</para>
26071 <screeninfo>Circulation Summary</screeninfo>
26075 <imagedata fileref="images/circ/circsummary.png"/>
26080 <para>In the Renew column you will see how many times each item has been
26081 renewed and a checkbox to renew the item for the patron. Check the boxed
26082 of the items you would like to renew and click the 'Renew or Return
26083 checked items' button, or to renew all items checked out to the patron
26084 simply click the 'Renew all' button.</para>
26087 <screeninfo>Renew buttons</screeninfo>
26091 <imagedata fileref="images/circ/renewbutton.png"/>
26096 <para>Sometimes renewals will be blocked based on your circulation
26097 rules, to override this block you must have your <link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
26098 preference set to 'Allow'. If you allow renewal limit overrides, you
26099 will see a checkbox at the bottom left of the circulation summary. Check
26100 that box and then choose the items you would like to renew.</para>
26103 <screeninfo>Override renewal limit</screeninfo>
26107 <imagedata fileref="images/circ/overriderenew.png"/>
26112 <para>Checking that box will add checkboxes in the renew column above
26113 where before the item was not renewable.</para>
26114 <para>The second option is to visit the 'Renew' page found under the Circulation menu.</para>
26116 <screeninfo>Renew</screeninfo>
26119 <imagedata fileref="images/circ/renewcirc.png"/>
26123 <para>And scan the barcodes of the items you would like to renew.</para>
26125 <screeninfo>Barcode to renew</screeninfo>
26128 <imagedata fileref="images/circ/renewbarcode.png"/>
26132 <para>If the item is renewed you will receive a confirmation message.</para>
26134 <screeninfo>Item renewed</screeninfo>
26137 <imagedata fileref="images/circ/renewed.png"/>
26141 <para>If the barcode is not found you will be presented with an error.</para>
26143 <screeninfo>No barcode found</screeninfo>
26146 <imagedata fileref="images/circ/renewnomatch.png"/>
26150 <para>If the item is not actually checked out you will also receive an error.</para>
26152 <screeninfo>Item not checked out</screeninfo>
26155 <imagedata fileref="images/circ/renewnotchecked.png"/>
26161 <section id="checkingin">
26162 <title>Check In (Returning)</title>
26164 <para>Checking in items can be performed from various different
26169 <para>The check in box on the top of the main staff client</para>
26172 <screeninfo>Check out box on main Koha Staff Client
26177 <imagedata fileref="images/circ/checkinmain.png"/>
26184 <para>The check in option on the quick search bar on the Circulation
26187 <screeninfo>Check in tab on quick search bar</screeninfo>
26191 <imagedata fileref="images/circ/checkinquickbox.png"/>
26198 <para>The check in link on the patron's checkout summary (and on the
26199 checkout summary page)</para>
26202 <screeninfo>Patron checkout summary includes 'Check In'
26207 <imagedata fileref="images/circ/checkinlink.png"/>
26214 <para>The Check in page under the Circulation menu</para>
26217 <screeninfo>Check in link on Circulation Module</screeninfo>
26221 <imagedata fileref="images/circ/checkincirc.png"/>
26228 <section id="checkitemin">
26229 <title>Checking Items In</title>
26231 <para>To check an item in scan the barcode for the item into the box
26232 provided. A summary of all items checked in will appear below the
26236 <screeninfo>Check In Summary</screeninfo>
26240 <imagedata fileref="images/circ/checkin.png"/>
26245 <para>If you are checking items in that were put in the book drop while the library was
26246 closed you can check the 'Book drop mode' box before scanning items. This will effectively
26247 roll back the returned date to the last date the library was open.</para>
26251 <para>This requires that you have your closings added to the <link linkend="calholidays">Holidays & Calendar Tool </link></para>
26255 <para>You can also choose to forgive all overdue charges for items you
26256 are checking in by checking the 'Forgive overdue charges' box before
26257 scanning items.</para>
26260 <section id="checkinmsg">
26261 <title>Check In Messages</title>
26263 <para>There are several messages that can appear when checking items
26268 <para>If you are checking an item in at a library other than the
26269 home branch, a message will appear asking you to transfer the book
26270 to the home library</para>
26273 <screeninfo>Check in Transfer Message</screeninfo>
26277 <imagedata fileref="images/circ/checkintransfer.png"/>
26284 <para>After this item is checked in the status of the item
26285 will be changed in the catalog to 'in transit'</para>
26288 <screeninfo>In Transit Status</screeninfo>
26292 <imagedata fileref="images/circ/transferstatus.png"/>
26299 <para>To mark an item as back at the home branch, check the
26300 item in at the home branch</para>
26303 <screeninfo>Check In Transferred Item</screeninfo>
26307 <imagedata fileref="images/circ/transfercheckin.png"/>
26314 <para>A message will appear tell you that the item is not
26315 checked out, but the status will now say available in the
26316 catalog. This step is necessary to mark items as received
26317 by the home branch.</para>
26325 <para>If you are checking in an item that should have multiple
26326 parts or pieces a message will appear warning you about the number
26327 of pieces you should have in your hand</para>
26330 <screeninfo>Materials Specified</screeninfo>
26334 <imagedata fileref="images/circ/materialspecified.png"/>
26341 <para>If you're checking an item in that has a hold on it, you
26342 will be prompted to confirm the hold</para>
26345 <screeninfo>Hold Found Check In Message</screeninfo>
26349 <imagedata fileref="images/circ/holdfound.png"/>
26356 <para>Clicking the Confirm hold button will mark the item as
26357 waiting for pickup from the library</para>
26360 <screeninfo>Hold waiting at the library</screeninfo>
26364 <imagedata fileref="images/circ/waitingstatus.png"/>
26371 <para>Clicking the Print Slip and Confirm button will mark the
26372 item as waiting for pickup at the library and present the
26373 library with a receipt to print and place on the book with the
26374 patron's information</para>
26378 <para>Ignoring the hold will leave the item on hold, but leave
26379 its status as Available (it will not cancel the hold)</para>
26385 <para>If you're checking in an item that has a hold on it at
26386 another branch you will be prompted to confirm and transfer the
26390 <screeninfo>Hold found for another branch</screeninfo>
26394 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
26401 <para>Clicking the Confirm hold and Transfer button will mark
26402 the item as in transit to the library where the hold was
26406 <screeninfo>In transit hold status</screeninfo>
26410 <imagedata fileref="images/circ/intransithold.png"/>
26417 <para>Clicking the Print Slip, Transfer and Confirm button
26418 will mark the item as in transit to the library where the hold
26419 was placed and present the library with a receipt to print and
26420 place on the book with the patron's information</para>
26424 <para>Ignoring the hold will leave the item on hold, but leave
26425 its status as Available (it will not cancel the hold)</para>
26431 <para>If you have the system showing you fines at the time of
26432 checkin (<link linkend="FineNotifyAtCheckin">FineNotifyAtCheckin</link>) you will
26433 see a message telling you about the fine and providing you a link
26434 to the payment page for that patron</para>
26437 <screeninfo>FineNotifyAtCheckin</screeninfo>
26441 <imagedata fileref="images/admin/globalprefs/FineNotifyAtCheckin.png"/>
26450 <section id="circmessages">
26451 <title>Circulation Messages</title>
26453 <para>Circulation messages are short messages that librarians can leave
26454 for their patrons or their colleagues that will appear at the time of
26455 circulation.</para>
26457 <section id="setcircmsg">
26458 <title>Setting up Messages</title>
26460 <para>Circulation messages are set up as <link linkend="authorizedvalues">Authorized Values</link>. To add or edit
26461 Circulation Messages you want to work with the <link linkend="bornotes">BOR_NOTES</link> value.</para>
26464 <screeninfo>BOR_NOTES Authorized Values</screeninfo>
26468 <imagedata fileref="images/circ/bor_notes.png"/>
26473 <para>The 'Description' field can hold a canned message that you would
26474 like to appear on the patron's record. <important>
26475 <para>The 'Description' field is limited to 80 characters, but the
26476 patron message field can hold more than that. Enter 80 characters
26477 in the 'Description' field and then type the rest on the patron
26479 </important></para>
26482 <section id="addcircmsg">
26483 <title>Adding a Message</title>
26485 <para>When on the patron's check out tab you will see a link to 'Add a
26486 new message' to the right of the check out box.</para>
26489 <screeninfo>Circulation Message in Staff Client</screeninfo>
26493 <imagedata fileref="images/circ/staffmessages.png"/>
26498 <para>When you click 'Add a new message' you will be asked to choose
26499 if the message is for the librarians or the patron and the message you
26500 would like to leave.</para>
26503 <screeninfo>Leave a Circulation Message</screeninfo>
26507 <imagedata fileref="images/circ/leavecircmsg.png"/>
26513 <para>A message for the patron will also show to the library
26518 <section id="viewcircmsg">
26519 <title>Viewing Messages</title>
26521 <para>Circulation messages meant for the staff and/or the patron will
26522 appear on the patron's checkout screen to the right of the checkout
26523 box. Messages in bold and red are meant for the library staff only,
26524 whereas messages in regular italics font are meant for the patron and
26525 the librarian.</para>
26528 <screeninfo>Circulation Message in Staff Client</screeninfo>
26532 <imagedata fileref="images/circ/staffmessages.png"/>
26537 <para>Circulation messages meant for the patron will also appear when
26538 they log into the OPAC.</para>
26541 <screeninfo>Circulation Message in OPAC</screeninfo>
26545 <imagedata fileref="images/circ/opacmsg.png"/>
26552 <section id="holds">
26553 <title>Holds</title>
26555 <para>Koha allows patrons to put things on hold. A 'Hold' is a way to reserve an item.
26556 Depending on your <link linkend="circfinerules">circulation and fine rules</link> and <link linkend="circholdspolicy">hold preference</link> settings patrons will be able to place
26557 items on hold for pickup at the library at a later date/time.</para>
26559 <section id="holdsinstaff">
26560 <title>Placing Holds in Staff Client</title>
26562 <para>There are several ways to place holds from the staff client. The
26563 most obvious is using the 'Place Hold' button at the top of any
26564 bibliographic record.</para>
26567 <screeninfo>Place Hold Button on Bib Record</screeninfo>
26571 <imagedata fileref="images/circ/placeholdbib.png"/>
26576 <para>You can also click the smaller 'Place Hold' link found at the
26577 top of your catalog search results, or the 'Holds' link found below
26578 each result.</para>
26581 <screeninfo>Hold options on search results</screeninfo>
26585 <imagedata fileref="images/circ/placeholdsearch.png"/>
26590 <para>You will be asked to search for a patron by barcode or any part
26591 of their name to start the hold process.</para>
26594 <screeninfo>Find Patron For Hold</screeninfo>
26598 <imagedata fileref="images/circ/placeholdfindpatron.png"/>
26603 <para>If you'd like to search for the patron first and then the bib
26604 record for the hold, you can open the patron record and click on the
26605 'Search to Hold' button at the top of the patron record.</para>
26608 <screeninfo>Search to Hold on Patron Record</screeninfo>
26612 <imagedata fileref="images/circ/searchtohold.png"/>
26617 <para>After clicking the button you will be brought to the catalog
26618 search page where you can find the book(s) you want to place a hold
26619 on. Under each title on the results you'll see an option to 'Hold for
26620 Patron Name.'</para>
26623 <screeninfo>Hold for Patron links on Search Results</screeninfo>
26627 <imagedata fileref="images/circ/holdresults.png"/>
26632 <para>If you want to place a hold on multiple items, simply check the
26633 boxes to the left of them and click the arrow to the right of the
26634 'Place Hold' button.</para>
26637 <screeninfo>Hold Multiple Items for Patron</screeninfo>
26641 <imagedata fileref="images/circ/holdmultiresults.png"/>
26646 <para>Depending on how many items you choose to place a hold on at
26647 once you will see a different place hold form. If you are placing a
26648 hold on one bibliographic record you will see a list of all of the
26649 items you can place a hold on.</para>
26652 <screeninfo>Place Hold Form</screeninfo>
26656 <imagedata fileref="images/circ/placeholdsingle.png"/>
26663 <para>Enter any notes that might apply to this hold</para>
26667 <para>Choose the library where the patron will pick up the
26672 <para>If the patron wants the hold to start on a date other than
26673 today, enter that in the 'Hold starts on date' field</para>
26677 <para>This option will only appear if the <link linkend="AllowHoldDateInFuture">AllowHoldDateInFuture</link>
26678 system preference is set to 'Allow'</para>
26684 <para>If the patron has specified that they don't want the item
26685 after a certain date, or if you have limits on hold lengths, you
26686 can enter an expiration date for the hold in the 'Hold expires on
26691 <para>To have expired holds canceled automatically you will
26692 need to have the <link linkend="expiredholdscron">Expired
26693 Holds</link> cron job set to run on a regular basis.</para>
26699 <para>Next choose if you want to place a hold on the next
26700 available item or a specific item by clicking the radio button
26701 next to an individual item.</para>
26705 <para>If you're placing a hold on multiple items you will be presented
26706 with the next available option for all titles. If no items are
26707 available for hold it will say so on the confirmation screen.</para>
26710 <screeninfo>Place multiple items on hold</screeninfo>
26714 <imagedata fileref="images/circ/placeholdmultiple.png"/>
26719 <para>Once your hold is placed, if you'd like to have Koha forget that
26720 you used the 'Search to Hold' function, you can choose to have Koha
26721 'forget' the patron's name by clicking the arrow to the right of the
26722 'Place Hold' button on the search results and choosing the 'Forget'
26726 <screeninfo>Forget Search to Hold Option</screeninfo>
26730 <imagedata fileref="images/circ/forgethold.png"/>
26736 <section id="manageholds">
26737 <title>Managing Holds</title>
26739 <para>Holds can be altered and canceled from the Holds tab found on
26740 the left of the bibliographic record.</para>
26743 <screeninfo>Bibliographic Record Tabs</screeninfo>
26747 <imagedata fileref="images/circ/holdtab.png"/>
26752 <para>From the list of holds you can change the order of the holds,
26753 the pickup location, suspend and/or cancel the hold.</para>
26756 <screeninfo>Lists of Holds</screeninfo>
26760 <imagedata fileref="images/circ/holdslist.png"/>
26766 <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
26767 preference set to "Don't allow" then you will not have the option to
26768 put an end date on the hold suspension</para>
26772 <para>Depending on how you have your <link linkend="HidePatronName">HidePatronName</link> system preference set
26773 the list may show card numbers instead of names in the Patron column
26774 like in the image above.</para>
26777 <para>To rearrange or delete holds, simply make a selection from the
26778 'Priority' pull down or click the arrows to the right of the priority
26782 <screeninfo>Hold Priority Menu</screeninfo>
26786 <imagedata fileref="images/circ/holdpriority.png"/>
26791 <para>If you use the priority pull down to rearrange or delete holds
26792 you will need to click the 'Update hold(s)' button to save your
26795 <para>Clicking the down arrow to the right of the hold will stick the
26796 hold at the bottom of the list even if more requests are made.</para>
26798 <para>For example, your library has home-bound patrons that are
26799 allowed to keep books out for months at a time. It would not be fair
26800 to other patrons if a home-bound patron were able to check out a brand
26801 new book and keep it for months. For this reason, the home-bound
26802 patron's hold request would stay at the bottom of the queue until
26803 everyone else who wanted to read that book has already done so.</para>
26806 <screeninfo>Lowest Priority & Delete Options for
26811 <imagedata fileref="images/circ/lowestpriority.png"/>
26816 <para>If a patron asks to have their hold suspended and you have the
26817 <link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
26818 system preference set to 'allow' you can do so by clicking the Suspend
26819 button to far right. If the patron gives you a date for the items to
26820 become unsuspended you can enter that in the date box and click the
26821 'Update hold(s)' button to save your changes.</para>
26824 <screeninfo>Hold suspension column</screeninfo>
26828 <imagedata fileref="images/circ/suspendholds.png"/>
26833 <para>To delete or cancel a hold click the red 'X' to the right of the
26834 hold line. To delete/cancel a bunch of holds you can choose 'del' from
26835 pull down to the left of each line and then click 'Update hold(s)' at
26836 the bottom of the list.</para>
26839 <screeninfo>Cancel Holds</screeninfo>
26843 <imagedata fileref="images/circ/cancelholds.png"/>
26849 <section id="receiveholds">
26850 <title>Receiving Holds</title>
26852 <para>When items that are on hold are <link linkend="checkingin">checked in</link> or <link linkend="checkingout">out</link> the system will remind the circulation librarian that
26853 the item is on hold and offer them options for managing the hold.</para>
26855 <para>When you check in an item that has a hold on it the system will
26856 ask you to either confirm and transfer the item</para>
26859 <screeninfo>Confirm Hold & Transfer</screeninfo>
26863 <imagedata fileref="images/circ/holdconfirmtransfer.png"/>
26868 <para>or just confirm the hold</para>
26871 <screeninfo>Confirm Hold</screeninfo>
26875 <imagedata fileref="images/circ/holdconfirm.png"/>
26880 <para>Clicking the Confirm button will mark the item as on hold for
26881 the patron. If the item needs to be transferred the item will also be
26882 marked as in transit to the proper branch. Clicking 'Ignore' will
26883 retain the hold, but allow you to check the item out to another
26884 patron. Choosing to confirm and print will present you with a
26885 printable page that you can slip inside the book with the necessary
26886 hold and/or transfer information.</para>
26888 <para>Once confirmed the hold will show on the patron record and on
26889 the checkout screen under the 'Hold' tab.</para>
26892 <screeninfo>Hold on Patron Record</screeninfo>
26896 <imagedata fileref="images/circ/holdpatronrec.png"/>
26901 <para>The item record will also show that the item is on hold.</para>
26904 <screeninfo>Hold on Item Record</screeninfo>
26908 <imagedata fileref="images/circ/holditem.png"/>
26913 <para>In some cases a patron may come in to pick up a hold for their
26914 partner (or someone else in their household). In this case you want to
26915 make sure that the hold is cancelled when you check the item out to
26916 someone else. When trying to check out an item that is already waiting
26917 for someone else you will be presented with a warning message.</para>
26920 <screeninfo>Hold waiting for someone else</screeninfo>
26924 <imagedata fileref="images/circ/holdwaitingwarn.png"/>
26929 <para>From here you can check the item out to the patron at the desk
26930 and cancel the hold for the patron.</para>
26934 <section id="transfers">
26935 <title>Transfers</title>
26937 <para>If you work in a multi-branch system you can transfer items from one library to another
26938 by using the Transfer tool.<itemizedlist>
26940 <para><emphasis role="italic">Get there</emphasis>: Circulation > Transfer</para>
26942 </itemizedlist></para>
26943 <para>To transfer an item</para>
26947 <para>Click 'Transfer' on the Circulation page</para>
26950 <screeninfo>Transfer Tool</screeninfo>
26954 <imagedata fileref="images/circ/transfer.png"/>
26961 <para>Enter the library you would like to transfer the item
26966 <para>Scan or type the barcode on the item you would like to
26973 <para>Click 'Submit'</para>
26976 <screeninfo>Transfer Summary</screeninfo>
26980 <imagedata fileref="images/circ/itemtransferred.png"/>
26987 <para>The item will now say that it is in transit</para>
26990 <screeninfo>Item in Transit</screeninfo>
26994 <imagedata fileref="images/circ/itemintransit.png"/>
27001 <para>When the item arrives at the other branch the librarian must
27002 check the item in to acknowledge that it is no longer in
27007 <para>The item will not be permanently moved to the new
27011 <screeninfo>Item record</screeninfo>
27015 <imagedata fileref="images/circ/itemlocations.png"/>
27022 <para>The item shows the same 'Home Library' but has updated the
27023 'Current Location' to note where it resides at this time</para>
27030 <section id="setlibrary">
27031 <title>Set Library</title>
27033 <para>By default you will enter the staff client as if you are at your
27034 home library. This library will appear in the top right of the Staff
27038 <screeninfo>My Library</screeninfo>
27042 <imagedata fileref="images/circ/mylibrary.png"/>
27047 <para>This is the library that all circulation transactions will take
27048 place at. If you are at another library (or on a bookmobile) you will
27049 want to set your library before you start circulating items. To do this
27050 you can click 'Set' at the top right or on the Circulation page.</para>
27053 <screeninfo>Set Library Form</screeninfo>
27057 <imagedata fileref="images/circ/setlibrary.png"/>
27062 <para>Once you have saved your changes you new library will appear in
27063 the top right.</para>
27066 <section id="fastaddcat">
27067 <title>Fast Add Cataloging</title>
27069 <para>Sometimes circulation librarians need to quickly add a record to
27070 the system for an item they are about to check out. This is called 'Fast
27071 Add.' To allow circulation librarians access to the Fast Add Cataloging
27072 tool, simply make sure they have the <link linkend="fastaddpermissions">fast_cataloging</link> permissions. There
27073 are two ways to add titles via fast add. If you know that you're about
27074 to check out an item that isn't in you catalog you can go to the
27075 Circulation module and click 'Fast cataloging.'</para>
27078 <screeninfo>Circulation Menu</screeninfo>
27082 <imagedata fileref="images/circ/circmenu.png"/>
27087 <para>The cataloging interface will open up with the short cataloging
27091 <screeninfo>Fast Add Framework</screeninfo>
27095 <imagedata fileref="images/circ/fastadd.png"/>
27100 <para>After adding your cataloging data you will be asked to enter item
27101 data. Enter the items barcode, collection code, etc and save the item
27102 before checking it out.</para>
27104 <para>The other way to fast catalog is from the checkout screen. When
27105 you enter a barcode at checkout that Koha can't find, it will prompt you
27106 to use fast cataloging to add the item to Koha and check it out.</para>
27109 <screeninfo>Barcode not found</screeninfo>
27113 <imagedata fileref="images/circ/barcodefastadd.png"/>
27118 <para>Clicking 'Fast cataloging' will bring you to the fast cataloging
27119 form where you can enter the title information</para>
27122 <screeninfo>Fast cataloging</screeninfo>
27126 <imagedata fileref="images/circ/fastaddbarcode.png"/>
27131 <para>After clicking 'Save' you will be brought to the item record where
27132 the barcode will already be filled in with the barcode you're trying to
27136 <screeninfo>Fast cataloging item record</screeninfo>
27140 <imagedata fileref="images/circ/fastadditem.png"/>
27145 <para>After clicking the 'Add item' button the item will automatically
27146 be checked out the patron you were trying to check the book out to
27150 <screeninfo>Checked out item</screeninfo>
27154 <imagedata fileref="images/circ/fastaddcheckedout.png"/>
27160 <section id="circreports">
27161 <title>Circulation Reports</title>
27163 <para>Most reports can be found vai the Reports module, but some of the more common
27164 circulation reports are available right from the Circulation module.<itemizedlist>
27166 <para><emphasis role="italic">Get there</emphasis>: Circulation > Circulation
27169 </itemizedlist></para>
27171 <section id="holdsqueue">
27172 <title>Holds Queue</title>
27174 <para>This report will show you all of the holds at your
27178 <screeninfo>Sample Holds Queue</screeninfo>
27182 <imagedata fileref="images/circ/holdsqueue.png"/>
27187 <para>To generate this report, you must have the <link linkend="buildholdscron">Build Holds Queue cron job</link> running.
27188 This cron job is a script that should be run periodically if your
27189 library system allows borrowers to place on-shelf holds. This script
27190 decides which library should be responsible for fulfilling a given
27191 hold request.</para>
27193 <para>It's behavior is controlled by the system preferences <link linkend="holdqueueweight">StaticHoldsQueueWeight</link> and <link linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
27195 <para>If you do not want all of your libraries to participate in the
27196 on-shelf holds fulfillment process, you should list the the libraries
27197 that *do* participate in the process here by inputting all the
27198 participating library's branchcodes, separated by commas ( e.g.
27199 "MPL,CPL,SPL,BML" etc. ).</para>
27201 <para>By default, the holds queue will be generated such that the
27202 system will first attempt to hold fulfillment using items already at
27203 the pickup library if possible. If there are no items available at the
27204 pickup library to fill a hold, build_holds_queue.pl will then use the
27205 list of libraries defined in StaticHoldsQueueWeight. If
27206 RandomizeHoldsQueueWeight is disabled ( which it is by default ), the
27207 script will assign fulfillment requests in the order the branches are
27208 placed in the StaticHoldsQueueWeight system preference.</para>
27210 <para>For example, if your system has three libraries, of varying
27211 sizes ( small, medium and large ) and you want the burden of holds
27212 fulfillment to be on larger libraries before smaller libraries, you
27213 would want StaticHoldsQueueWeight to look something like
27214 "LRG,MED,SML".</para>
27216 <para>If you want the burden of holds fulfillment to be spread out
27217 equally throughout your library system, simply enable
27218 RandomizeHoldsQueueWeight. When this system preference is enabled, the
27219 order in which libraries will be requested to fulfill an on-shelf hold
27220 will be randomized each time the list is regenerated.</para>
27222 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at this
27223 time. Doing so will cause the build_holds_queue script to ignore
27224 RandomizeHoldsQueueWeight, causing the script to request hold
27225 fulfillment not randomly, but by alphabetical order.</para>
27228 <section id="holdspull">
27229 <title>Holds to pull</title>
27231 <para>This report will show you all of the items that have holds on
27232 them that are available at the library for pulling. If the items are
27233 available at multiple branches then all branches with that item
27234 available will see the hold to pull until one library triggers the
27238 <screeninfo>Holds to Pull</screeninfo>
27242 <imagedata fileref="images/circ/holdstopull.png"/>
27247 <para>You can limit the results you see by using the Refine box on the
27248 left side of the page:</para>
27251 <screeninfo>Refine Holds to Pull Report</screeninfo>
27255 <imagedata fileref="images/circ/refineholdstopull.png"/>
27261 <section id="holdspickup">
27262 <title>Holds awaiting pickup</title>
27264 <para>This report will show all of the holds that are waiting for
27265 patrons to pick them up.</para>
27268 <screeninfo>Holds Awaiting Pickup</screeninfo>
27272 <imagedata fileref="images/circ/holdspickup.png"/>
27277 <para>Items that have been on the hold shelf longer than you normally
27278 allow (based on the <link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link>
27279 preference value) will appear on the 'Holds Over' tab, they will not
27280 automatically be cancelled unless you have set the <link linkend="expiredholdscron">cron job</link> to do that for you, but you
27281 can cancel all holds using the button at the top of the list.</para>
27284 <screeninfo>Items waiting on the hold shelf too long</screeninfo>
27288 <imagedata fileref="images/circ/holdspickupover.png"/>
27294 <section id="holdratios">
27295 <title>Hold ratios</title>
27297 <para>Hold ratios help with collection development. Using this report
27298 you will be able to see how many of your patrons have holds on items
27299 and whether you should buy more. By default it will be set to the
27300 library needing 3 items per hold that has been placed. The report will
27301 tell you how many additional items need to be purchased to meet this
27305 <screeninfo>Hold Ratios</screeninfo>
27309 <imagedata fileref="images/circ/holdratio.png"/>
27315 <section id="transferstoreceive">
27316 <title>Transfers to receive</title>
27318 <para>This report will list all of the items that Koha thinks are in
27319 transit to your library.</para>
27322 <screeninfo>Transfers to Receive</screeninfo>
27326 <imagedata fileref="images/circ/transitreceive.png"/>
27331 <para>If your transfers are late in arriving at your library you will
27332 see a message stating how late your items are.</para>
27335 <screeninfo>Late transfers include warning messages</screeninfo>
27339 <imagedata fileref="images/circ/transferlate.png"/>
27345 <para>An item is considered late based on the number of days you
27346 have entered in the <link linkend="TransfersMaxDaysWarning">TransfersMaxDaysWarning</link>
27347 system preference.</para>
27351 <section id="overduesreport">
27352 <title>Overdues</title>
27355 <para>For libraries with a large patron base, this report may take a
27356 significant amount of time to run.</para>
27360 <para>Large libraries can choose to filter the report before it runs
27361 by setting the <link linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
27362 system preference to 'Require'.</para>
27365 <para>This report will list all items that are overdue at your
27369 <screeninfo>Overdues List</screeninfo>
27373 <imagedata fileref="images/circ/overdues.png"/>
27378 <para>The report can be filtered using the menu options found on the left of the report.<tip>
27379 <para>The 'Show any items currently checked out' checkbox basically switches this from a
27380 report of overdues to a report of checkouts. It will show all titles checked out
27381 regardless of due date.</para>
27385 <section id="overduesfines">
27386 <title>Overdues with fines</title>
27388 <para>This report will show you any overdues at your library that have
27389 accrued fines on them.</para>
27392 <screeninfo>Overdues with fines</screeninfo>
27396 <imagedata fileref="images/circ/overduewfines.png"/>
27401 <para>If you would like to limit the report you can use the pull down
27402 menu at the top to limit to a specific shelving location at your
27403 branch. To see overdues with fines at other branches you will have to
27404 <link linkend="setlibrary">change your branch</link> or log in at that
27406 <para>If you do not charge fines and/or don't have the <link linkend="finescronjob">fines cron job</link> running you will see
27407 no data on this report.</para>
27408 </important></para>
27412 <section id="trackinhouse">
27413 <title>Tracking In house Use</title>
27415 <para>Many libraries track the use of items within the library. This can
27416 be done in Koha one of two ways. The first is to create one or more
27417 <link linkend="addstatspatron">Statistical Patrons</link>. When
27418 collecting items that have been used within the library, you will want
27419 to check them out to your statistical patron:</para>
27422 <screeninfo>Check Out Items to Stats Patron</screeninfo>
27426 <imagedata fileref="images/circ/checkoutinhouse.png"/>
27431 <para>Instead of marking the item as 'checked out' the system will
27432 record that the item was used in house:</para>
27435 <screeninfo>Local Use Recorded</screeninfo>
27439 <imagedata fileref="images/circ/localuserecorded.png"/>
27444 <para>Repeat these steps for all items that have been used within the
27445 library to keep accurate statistics for item use.</para>
27447 <para>The other way to record local use of items is to set your <link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link>
27448 preference to 'Record.' Then whenever you check an item in that is not
27449 checked out and not on hold a local use will be recorded.</para>
27452 <screeninfo>Local Use Recorded</screeninfo>
27456 <imagedata fileref="images/circ/localusecheckin.png"/>
27462 <para>If you have <link linkend="RecordLocalUseOnReturn">RecordLocalUseOnReturn</link> set to
27463 'Record' you can still use your statistical patrons to record local
27464 use as well.</para>
27468 <section id="processinglocations">
27469 <title>In Processing / Book Cart Locations</title>
27471 <para>Koha allows for handling temporary locations like the processing
27472 center and/or book carts throughout the library. For this feature to
27473 work you must first make sure you have <link linkend="authorizedvalues">authorized values</link> set in the <link linkend="shelvelocvals">LOC</link> category for PROC (Processing Center)
27474 and CART (Book Cart).</para>
27477 <screeninfo>CART & PROC values in LOC</screeninfo>
27481 <imagedata fileref="images/circ/LOCvalues.png"/>
27486 <para>Next you need to set the <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link> system
27487 preference to PROC. This will set the new items to the Processing Center
27488 as their default location.</para>
27490 <para>Create items with their desired final shelving location.</para>
27494 <para>These newly cataloged items will be temporarily set to the
27495 PROC location and will display with whatever description PROC has.
27496 The original location code entered at item creation is stored in the
27497 new items column 'permanent_location', for future use. Items will
27498 stay in the PROC location until they are checked in. To have those
27499 items then move to the shelving cart:</para>
27503 <para>Turn on the <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>
27504 system preference</para>
27508 <para>Check in those newly-created items and they will be moved
27509 to the location code of CART and display with whatever
27510 description CART has.</para>
27514 <para>A <link linkend="proccartcron">cron job</link> runs at
27515 specified intervals to age items from CART to the permanent
27516 shelving location. (For example, an hourly cron entry of
27517 cart_to_shelf.pl --hours 3 where --hours is the amount of time
27518 an item should spend on the cart before aging to its permanent
27524 <para>If the <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
27525 system preference is turned on, any newly checked-in item
27526 is also automatically put into the shelving cart, to be
27527 covered by the same script run.</para>
27533 <para>Checkins with confirmed holds will not go into the
27534 shelving cart. If items on the shelving cart are checked
27535 out, the cart location will be cleared.</para>
27545 <section id="selfcheckout">
27546 <title>Self Checkout</title>
27548 <para>Koha comes with a very basic self checkout module. To enable this
27549 module you need to set the <link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link> preference to
27550 'Enable.' To use this module you have to log in as a <link linkend="addstaffpatron">staff member</link> with <link linkend="patronpermissions">circulation permissions</link>.</para>
27553 <para>Create a <link linkend="addstaffpatron">staff patron</link>
27554 specifically for this action so that you don't leave a real staff
27555 client logged into a computer all day</para>
27558 <para>There is no link to the Self Checkout module, but a simple
27559 addition to the <link linkend="intranetuserjs">intranetuserjs</link>
27560 system preference can add one.</para>
27562 <programlisting>$(document).ready(function(){ $("#login
27563 #submit").parent().after("<p><a
27564 href=\"http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl\"
27565 target=\"_blank\">Self-Checkout</a></p>"); }); </programlisting>
27568 <para>The code above has line breaks added to make it more readable,
27569 please be sure to enter the above as one line in when putting it in
27570 the system preference.</para>
27573 <para>The link will then appear at the bottom of the log in page:</para>
27576 <screeninfo>Self Checkout Link on Staff Login</screeninfo>
27580 <imagedata fileref="images/circ/selfcheckoutlink.png"/>
27585 <para>You can also access this module by going to :
27586 http://YOUR_KOHA_OPAC_URL/cgi-bin/koha/sco/sco-main.pl</para>
27588 <para>When on the self checkout page depending on your value in the
27589 <link linkend="SelfCheckoutByLogin">SelfCheckoutByLogin</link>
27590 preference you will be asked to enter you cardnumber</para>
27593 <screeninfo>Self Checkout Patron Card Number</screeninfo>
27597 <imagedata fileref="images/circ/selfcheckout.png"/>
27602 <para>or your username and password:</para>
27605 <screeninfo>Shelf checkout by login</screeninfo>
27609 <imagedata fileref="images/circ/SelfCheckoutByLogin.png"/>
27614 <para>Once you're logged in to the self check module you will be asked
27615 to scan the items you are checking out</para>
27618 <screeninfo>Self Checkout</screeninfo>
27622 <imagedata fileref="images/circ/selfcheckoutuser.png"/>
27627 <para>As you scan items they will appear below the barcode box</para>
27630 <screeninfo>Self Checkout Summary</screeninfo>
27634 <imagedata fileref="images/circ/selfcheckoutsummary.png"/>
27639 <para>When you are finished scanning items it is important to click the 'Finish' button. This
27640 will prompt you to print a receipt and log you out of the self check module.</para>
27642 <screeninfo>Self Checkout Receipt</screeninfo>
27645 <imagedata fileref="images/circ/selfreceiptprint.png"/>
27650 <para>When attempting to check items out there are some instances where
27651 error messages will appear and the patron will be directed to the
27652 librarian. This will happen even if you are allowing overrides on
27653 circulation functions. Only a librarian can override a circulation block
27654 and so patrons must go to the librarian for help in these
27658 <screeninfo>Self Checkout Error Message</screeninfo>
27662 <imagedata fileref="images/circ/selfcheckoutfines.png"/>
27668 <section id="offlinecirc">
27669 <title>Offline Circulation Utilities</title>
27670 <para>Koha allows for you to continue circulation actions while offline by using any one of
27671 three utilities.</para>
27672 <section id="kohaofflinecirc">
27673 <title>Offline Circulation in Koha</title>
27674 <para>If the <link linkend="AllowOfflineCirculation">AllowOfflineCirculation</link>
27675 preference is set to 'Enable' the library staff can continue to perform circulation
27676 actions within Koha when the system is offline. You will want to visit
27677 http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl at least once while online
27678 and bookmark that page. That is the page you will go to when you are offline.</para>
27680 <para>The offline interface uses HTML LocalStorage, which depending on the browser and
27681 user setting, is limited to 2.5MB or 5MB per domain. This means that larger systems will
27682 not be able to syncronize their data and are recommended to use either the <link
27683 linkend="firefoxofflinecirc">Firefox</link> or <link linkend="windowsofflinecirc"
27684 >Windows</link> application for offline circulation.</para>
27686 <section id="kohaofflinesetup">
27687 <title id="offlinesetup">Setup</title>
27688 <para>Before the first time the system goes offline go to Circulation and choose 'Built-in
27689 offline circulation interface'</para>
27691 <screeninfo>Built-in offline circulation interface</screeninfo>
27694 <imagedata fileref="images/circ/offlinecirc.png"/>
27698 <para>And synchronize your data on every circulation computer by clicking the
27699 'Synchronize' link on the right of the screen.</para>
27701 <screeninfo>Synchronize data</screeninfo>
27704 <imagedata fileref="images/circ/syncoffline.png"/>
27709 <para>The offline interface uses HTML LocalStorage, which depending on the browser and
27710 user setting, is limited to 2.5MB or 5MB per domain. This means that larger systems
27711 will not be able to syncronize their data and are recommended to use either the <link
27712 linkend="firefoxofflinecirc">Firefox</link> or <link linkend="windowsofflinecirc"
27713 >Windows</link> application for offline circulation.</para>
27715 <para>This will allow you download a local copy of your patrons and circulation data.
27716 Click the 'Download records' link at the top of the page to synchronize your data.</para>
27718 <screeninfo>Download records for offline use</screeninfo>
27721 <imagedata fileref="images/circ/downloadoffline.png"/>
27725 <para>Once your data is downloaded you will see the dates your data was last synced to the
27726 right of each data set.<screenshot>
27727 <screeninfo>Synced offline data</screeninfo>
27730 <imagedata fileref="images/circ/syncedoffline.png"/>
27733 </screenshot>This should be done regularly in preparation for any unexpected connection
27736 <section id="kohaofflinecirculating">
27737 <title id="offlinecirculating">Circulating</title>
27738 <para>When your system goes offline visit the Offline Circulation page
27739 (http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl) in Koha and click
27740 'Check out' or 'Check in' to perform offline actions.</para>
27741 <para>Checking out is done by searching for the patron by barcode or name at the top of
27742 the 'Check out' screen. After selecting a patron you will be presented with the synced
27743 patron info, including fines and check outs.</para>
27745 <screeninfo>Check out offline</screeninfo>
27748 <imagedata fileref="images/circ/offlinecheckout.png"/>
27752 <para>Scan the barcode of the item you would like to check out and enter a due date. If
27753 you don't enter a due date Koha will prompt you for one.</para>
27755 <screeninfo>Offline due date</screeninfo>
27758 <imagedata fileref="images/circ/offlineduedate.png"/>
27762 <para>Once the item is checked out it will appear below the patron's info.</para>
27764 <screeninfo>Offline checkouts</screeninfo>
27767 <imagedata fileref="images/circ/offlinecheckouts.png"/>
27773 <section id="kohaofflineupload">
27774 <title>Koha Offline Uploading</title>
27775 <para>Once the system is back online visit the Synchronize page on the Offline Circulation
27776 module and click 'Upload transactions'</para>
27778 <screeninfo>Upload transactions</screeninfo>
27781 <imagedata fileref="images/circ/offlineupload.png"/>
27785 <para>After the files are uploaded you can click 'View pending offline circulation
27786 actions' on the right.</para>
27788 <screeninfo>View pending offline circulation actions</screeninfo>
27791 <imagedata fileref="images/circ/viewkohaoffline.png"/>
27795 <para>After clicking 'View pending offline circulation actions' you will be brought to a
27796 summary of all of the actions you loaded in to Koha in your *.koc file.</para>
27798 <screeninfo>Offline Circulation</screeninfo>
27801 <imagedata fileref="images/circ/offlinecirclog.png"/>
27807 <para>Once all of the logs from all of the circulation computers are loaded you will
27808 be able to check them all or select just those you want to process into Koha.</para>
27811 <para>Click on the Process button and Koha will record every stored transaction one by
27812 one. For each transaction, the status will change to:<itemizedlist>
27814 <para>"Success." if the transaction was processed correctly</para>
27817 <para>"Borrower not found." if the borrower card number is incorrect</para>
27820 <para>"Item not found." if the item barcode is wrong</para>
27823 <para>"Item not issued." if you checked in an available item</para>
27825 </itemizedlist></para>
27828 <para>Once finished you will have a summary of all of your transactions</para>
27830 <screeninfo>Offline Circulation Summary</screeninfo>
27833 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
27840 <section id="firefoxofflinecirc">
27844 <firstname>Franois</firstname>
27845 <surname>Charbonnier</surname>
27847 <orgname>BibLibre</orgname>
27852 <firstname>Nicole C.</firstname>
27853 <surname>Engard</surname>
27854 <contrib>Changed/edited content where necessary.</contrib>
27858 <pubdate>2012</pubdate>
27860 <title>Firefox Plugin</title>
27862 <para>There is an offline circulation tool that you can add to your Firefox browser as an
27863 addon. To do so, just go to <ulink url="https://addons.mozilla.org/en/firefox/addon/koct/"
27864 >https://addons.mozilla.org/en/firefox/addon/koct/</ulink> page and click on the
27865 "install now" button. You may have to confirm the installation, just click on "install
27866 now" and then restart Firefox to complete the installation.</para>
27868 <para>Once you have installed the plugins and restarted Firefox, you will see the Koha logo
27869 in the download bar at the bottom right of Firefox.</para>
27872 <screeninfo>Koha Icon on Add-on Bar</screeninfo>
27876 <imagedata fileref="images/circ/koctstatusbar.png"/>
27881 <para>A click on the logo will open the tool in its own window.</para>
27884 <screeninfo>Koha Offline Circ Tool</screeninfo>
27888 <imagedata fileref="images/circ/koct.png"/>
27893 <para>The plugin consists of four tabs:</para>
27897 <para>The Check Out tab is where you check out items</para>
27901 <para>The Check In tab is where you check in items</para>
27905 <para>The Log tab keeps track of every transaction done while in
27906 offline mode</para>
27910 <para>The log will keep information until you empty it. Each
27911 time you open the plugin and it contains data in the log it
27912 will warn you</para>
27915 <screeninfo>Koha Offline Circ Warning</screeninfo>
27919 <imagedata fileref="images/circ/koctwarn.png"/>
27924 <para>If you'd like to clear the log, check the 'I want to
27925 delete rows' box before hitting the 'OK' button. Otherwise
27926 clicking 'OK' will keep the items in the log and let you
27927 continue working with the tool.</para>
27933 <para>The Param tab is to set up the plugin</para>
27937 <para>The first thing you want to do then is to set up the plugin. Go
27938 to the Param tab to set up the plugin</para>
27941 <screeninfo>Koha Offline CIrc Params</screeninfo>
27945 <imagedata fileref="images/circ/koctparam.png"/>
27950 <para>Answer the 4 questions presented:</para>
27954 <para>Server = the URL of the librarian interface</para>
27958 <para>Branch Code = the code for the branch where you are
27963 <para>Username = your staff account login</para>
27967 <para>Password = your staff account password</para>
27972 <para>To save the settings, you will have to close the plugin
27973 window and re-open it by clicking again on the Koha logo in the
27976 <para>You can create a staff account dedicated to the offline
27977 circulation. So that, no matter who is at the circulation desk,
27978 they can all use the same login. Along those lines, you can use a
27979 group login that you already have in place for circulation as
27981 </tip>Once you have everything set up you can start checking items
27984 <para>Checking out:</para>
27987 <screeninfo>Koha Offline Circulation Check Out</screeninfo>
27991 <imagedata fileref="images/circ/koct.png"/>
27998 <para>Go to the Check Out tab</para>
28002 <para>Scan the patron barcode</para>
28006 <para>Scan the item barcode</para>
28010 <para>Click 'Save'</para>
28014 <para>Checking in:</para>
28017 <screeninfo>Koha Offline Circulation Check In</screeninfo>
28021 <imagedata fileref="images/circ/koctcheckin.png"/>
28028 <para>Go to the Check In tab</para>
28032 <para>Scan the item barcode</para>
28036 <para>Click Save</para>
28040 <para>Each time, you check out or check in an item, a new transaction
28041 is recorded in the local plugin database and you will see, at the
28042 bottom of the plugin how many transactions has been made during the
28043 offline circulation. For example, "10 Row(s) Added" means you did 10
28044 transactions.</para>
28047 <screeninfo>Koha Offline Circulation Tool Count</screeninfo>
28051 <imagedata fileref="images/circ/koctcount.png"/>
28056 <para>Then, if you want an overview of every transaction, go to the
28057 Log tab. This tab will show you the transactions in the plugin
28061 <screeninfo>Koha Offline Circulation Log</screeninfo>
28065 <imagedata fileref="images/circ/koctlog.png"/>
28071 <para>The status will be "Local." as long as you are offline and
28072 don't process the transactions into Koha.</para>
28073 </tip>When your Internet connection comes back up you will want to
28074 get these transactions in to Koha. Before processing these
28075 transactions you should be aware of a few issues.</para>
28077 <para>Because you are not connected to your Koha database when using
28078 this plugin holds will need additional processing. If an item you
28079 check in while offline has a hold, the hold is kept on the item.
28080 Since, you can't confirm holds found during the processing of every
28081 check in, the holds stay on the item and will need to be managed
28082 later. If you only checked in a few items you can just keep a record
28083 of them all. If you checked in a lot of items you can use the Holds
28084 Queue once it rebuilds to see what holds made it to the shelf
28085 erroneously.</para>
28087 <para>Similarly, if an patron card was expired, the offline
28088 circulation tool won't know about it, so the checkout will be recorded
28089 regardless of the patron's account being blocked normally.</para>
28091 <para>You have two options for adding this data to Koha</para>
28095 <para>Commit to Koha</para>
28099 <para>If you checked in/out on more than one computer at the
28100 same time, what you want is to process every transaction
28101 consistently. Let's say for instance that one patron checked a
28102 book out on one computer and then checked the same book in on
28103 another computer. To be consistent, you need to record the
28104 check out first and then the check in. Not the opposite! To do
28105 so, you need to group every transaction in one place, sort
28106 them all and then, process everything. So, you need to use the
28107 "Commit to Koha" option from every plugin/computer you worked
28108 with. This way, the log will go to Koha and be accessible from
28109 the Offline Circulation page.</para>
28112 <screeninfo>Circulation Menu</screeninfo>
28116 <imagedata fileref="images/circ/offlinecirclink.png"/>
28123 <para><emphasis>Get there:</emphasis> Circulation > Pending offline circulation
28127 <screeninfo>Offline Circulation</screeninfo>
28131 <imagedata fileref="images/circ/offlinecirclog.png"/>
28138 <para>Once all of the logs from all of the circulation
28139 computers are loaded you will be able to check them all or
28140 select just those you want to process into Koha.</para>
28144 <para>Click on the Process button and Koha will record every stored transaction one
28145 by one. For each transaction, the status will change to:</para>
28149 <para>"Success." if the transaction was processed
28154 <para>"Borrower not found." if the borrower card number is
28159 <para>"Item not found." if the item barcode is
28164 <para>"Item not issued." if you checked in an available
28171 <para>Once finished you will have a summary of all of your
28172 transactions</para>
28175 <screeninfo>Offline Circulation Summary</screeninfo>
28179 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
28188 <para>Apply directly</para>
28192 <para>If you performed all of the circulation actions on one
28193 computer then everything is sorted already so you can choose
28194 to "Apply directly"</para>
28198 <para>The status column will be updated to let you know if the
28199 transactions were applied</para>
28203 <para>"Success." if the transaction was processed
28208 <para>"Borrower not found." if the borrower card number is
28213 <para>"Item not found." if the item barcode is
28218 <para>"Item not issued." if you checked in an available
28225 <para>Once you're finished you can review all of the items
28226 right in the Log tab</para>
28229 <screeninfo>Koha Offline Circulation Apply
28230 Directly</screeninfo>
28234 <imagedata fileref="images/circ/koctdirectly.png"/>
28243 <para>Once you are done you can clear the log by clicking Clear. If
28244 you don't you will be warned the next time you open the Offline
28245 Circulation tool.</para>
28248 <screeninfo>Koha Offline Circulation Tool Warning</screeninfo>
28252 <imagedata fileref="images/circ/koctwarn.png"/>
28258 <section id="windowsofflinecirc">
28259 <title>Offline Circ Tool for Windows</title>
28261 <para>The Offline Circulation Utility can be downloaded at: <ulink url="http://kylehall.info/index.php/projects/koha/koha-offline-circulation/">http://kylehall.info/index.php/projects/koha/koha-offline-circulation/</ulink></para>
28262 <para>To generate a borrowers.db file for loading in to the Windows tool you will need to
28263 run the <link linkend="offlinecirccron">file generator via a cron job</link>.</para>
28264 <section id="uploadofflinecirc">
28265 <title>Upload Offline Circ File</title>
28266 <para>The <link linkend="windowsofflinecirc">offline circulation tool for Windows</link>
28267 will generate a KOC file that you can upload into Koha once your system comes back
28269 <para>On the Circulation menu click 'Upload offline circulation file (.koc)'</para>
28271 <screeninfo>Circulation menu</screeninfo>
28274 <imagedata fileref="images/circ/offlinecirclink.png"/>
28278 <para>Browse your computer for the *.koc file</para>
28280 <screeninfo>Upload KOC File</screeninfo>
28283 <imagedata fileref="images/circ/uploadofflinecirc.png"/>
28287 <para>Once the file is uploaded, click the process the file</para>
28289 <screeninfo>Process offline circulation file</screeninfo>
28292 <imagedata fileref="images/circ/processoffline.png"/>
28296 <para>When this is complete you'll be able to upload another file or tend to pending
28297 offline circulation actions.</para>
28299 <screeninfo>Summary of offline actions</screeninfo>
28302 <imagedata fileref="images/circ/offlinesummary.png"/>
28306 <para>After clicking 'View pending offline circulation actions' you will be brought to a
28307 summary of all of the actions you loaded in to Koha in your *.koc file.</para>
28309 <screeninfo>Offline Circulation</screeninfo>
28312 <imagedata fileref="images/circ/offlinecirclog.png"/>
28318 <para>Once all of the logs from all of the circulation computers are loaded you will
28319 be able to check them all or select just those you want to process into Koha.</para>
28322 <para>Click on the Process button and Koha will record every stored transaction one by
28323 one. For each transaction, the status will change to:<itemizedlist>
28325 <para>"Success." if the transaction was processed correctly</para>
28328 <para>"Borrower not found." if the borrower card number is incorrect</para>
28331 <para>"Item not found." if the item barcode is wrong</para>
28334 <para>"Item not issued." if you checked in an available item</para>
28336 </itemizedlist></para>
28339 <para>Once finished you will have a summary of all of your transactions</para>
28341 <screeninfo>Offline Circulation Summary</screeninfo>
28344 <imagedata fileref="images/circ/offlinecircsuccess.png"/>
28353 <chapter id="cataloging">
28354 <title>Cataloging</title>
28356 <para>Before you start cataloging in Koha you're going to want to do some
28357 basic setup. Refer to the <link linkend="implementation">Implementation
28358 Checklist</link> for a full list of these things. Most importantly you're
28359 going to want to make sure that your <link linkend="marcbibframeworks">Frameworks</link> are all defined the way you
28360 want. Once in the cataloging module you will not be able to add or remove
28361 fields and subfields so your frameworks must be ready before you start
28363 <para>You can also use OCLC Connexion to send records directly in to Koha. For more information
28364 on that please review the <link linkend="oclcappendix">OCLC Connexion Setup
28365 appendix</link>.</para>
28369 <para><emphasis>Get there:</emphasis> More > Cataloging</para>
28373 <section id="catbibs">
28374 <title>Bibliographic Records</title>
28376 <para>In Koha the bibliographic record contains the main information
28377 related to the material. This includes things like the title, author,
28378 ISBN, etc. This information is stored in Koha in Marc (different flavors
28379 of Marc are supported in Koha). Once this information is saved, <link linkend="catitems">items or holdings</link> can be attached.</para>
28381 <section id="addbibrec">
28382 <title>Adding Records</title>
28384 <para>Records can be added to Koha via original or copy cataloging. If
28385 you would like to catalog a record using a blank template</para>
28389 <para>Click 'New Record'</para>
28392 <screeninfo>New Record Menu</screeninfo>
28396 <imagedata fileref="images/cataloging/newfromframework.png"/>
28403 <para>Choose the framework you would like to base your record
28410 <para>If you want to catalog a record based on an existing record at
28411 another library</para>
28415 <para>Click 'Z39.50 Search'</para>
28418 <screeninfo>Z39.50 Search</screeninfo>
28422 <imagedata fileref="images/cataloging/zsearch.png"/>
28429 <para>Search for the item you would like to catalog</para>
28434 <para>If no results are found, try searching for fewer
28435 fields, not all Z39.50 targets can search all of the
28436 fields above.</para>
28443 <para>Search targets can be altered by using the <link linkend="z3950admin">Z39.50 Admin</link> area.</para>
28447 <para>From the results you can view the MARC or Card view for
28448 the records or choose to Import them into Koha</para>
28451 <screeninfo>Z39.50 Search Results</screeninfo>
28455 <imagedata fileref="images/cataloging/zsearchresults.png"/>
28462 <para>In addition to the Import link to the right of each
28463 title, you can click on the title you're interested in and
28464 a menu will pop up with links to preview the record and
28468 <screeninfo>Import Link Popup on Z39.50 Search
28469 Results</screeninfo>
28473 <imagedata fileref="images/cataloging/importz39.png"/>
28480 <para>If you don't find the title you need in your Z39.50
28481 search results you can click the 'Try Another Search'
28482 button at the bottom left of your results</para>
28485 <screeninfo>Try another search</screeninfo>
28489 <imagedata fileref="images/cataloging/tryanotherzsearch.png"/>
28500 <para>Once you've opened a blank framework or imported a record via
28501 Z39.50 you will be presented with the form to continue
28505 <screeninfo>Add MARC Record</screeninfo>
28509 <imagedata fileref="images/cataloging/addmarc.png"/>
28516 <para>To expand a collapsed tag click on the tag
28521 <para>To get help from the Library of Congress on a Marc tag click
28522 the question mark (?) to the right of each field number</para>
28526 <para>If you feel that this clutters the screen you can hide
28527 the question marks by unchecking the box next to the 'Show
28528 MARC tag documentation links' note at the top right of the
28532 <screeninfo>Show MARC tag documentation links
28533 checkbox</screeninfo>
28537 <imagedata fileref="images/cataloging/marcdoclinks.png"/>
28546 <para>Sometimes fields may not be editable due to the value in
28547 your <link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link>
28548 system preference. If you have this preference set to not allow
28549 catalogers to type in fields controlled by authorities you may see
28550 a lock symbol to the left of the field.</para>
28553 <screeninfo>Authority fields locked against editing</screeninfo>
28557 <imagedata fileref="images/cataloging/lockedauthority.png"/>
28564 <para>If this icon appears you must click the icon to the
28565 right of the field to search for an existing authority.</para>
28568 <screeninfo>Search for authority</screeninfo>
28572 <imagedata fileref="images/cataloging/catauthoritysearch.png"/>
28579 <para>From the results list click 'Choose authority' to bring
28580 that into your catalog record</para>
28583 <screeninfo>Authority search results</screeninfo>
28587 <imagedata fileref="images/cataloging/catauthoritysearchresults.png"/>
28596 <para>To duplicate a field click on the 'repeat this tag' icon to
28597 the right of the tag</para>
28600 <screeninfo>Duplicate a Field</screeninfo>
28604 <imagedata fileref="images/cataloging/dupfield.png"/>
28611 <para>To move subfields in to the right order, click the up
28612 arrow to the left of the field</para>
28616 <para>To duplicate a subfield click on the clone icon (to
28617 remove a copied field, click the delete clone icon) to the
28618 right of the field</para>
28621 <screeninfo>Clone Subfield</screeninfo>
28625 <imagedata fileref="images/cataloging/clonesubfield.png"/>
28632 <para>To remove a subfield (if there is more than one of the
28633 same type), click the - (minus sign) to the right of the
28640 <para>To use a plugin click on the icon to the right of the
28644 <screeninfo>Leader Builder Plugin</screeninfo>
28648 <imagedata fileref="images/cataloging/leaderbuilder.png"/>
28655 <para>Some fixed fields have editors that will change based on
28656 the material type you're cataloging (for example the 006 and
28657 the 008 fields)</para>
28660 <screeninfo>008 Plugin</screeninfo>
28664 <imagedata fileref="images/cataloging/008plugin.png"/>
28673 <para>Once you've finished, click the 'Save' button at the top and
28674 choose whether you want to save and view the bib record you have
28675 created or continue on to add/edit items attached to the
28679 <screeninfo>Record save options</screeninfo>
28683 <imagedata fileref="images/cataloging/savecataloging.png"/>
28689 <para>Choosing 'Save and view record' will bring you right to the record you just
28693 <para>Choosing 'Save and edit items' will bring you to the add/edit item form after
28694 saving the bib record so that you can attach holdings</para>
28697 <para>Choosing 'Save and continute editing' will allow you to save your work so far
28698 and keep you in the editor to continue working</para>
28703 <para>If you are about to add a duplicate record to the system you will be warned before
28706 <screeninfo>Duplicate Record Warning</screeninfo>
28709 <imagedata fileref="images/cataloging/duprecordwarn.png"/>
28717 <section id="cataloganalytics">
28718 <title>Adding Analytic Records</title>
28720 <para>Libraries sometimes make journal articles and articles within
28721 monographs and serials accessible to library patrons through analytics
28722 cataloging. Analytics cataloging creates separate bibliographic
28723 records for these articles, chapters, sections, etc. found within a
28724 larger resource such as a book, an article within a journal, newspaper
28725 or serial. In analytics cataloging, although a separate bib record is
28726 created for the title, it is not physically separated from the host
28727 item. Learn more about Analytics in Chapter 13 of AACR2.</para>
28729 <para>If you would like to catalog analytic records there are two options. One is to use the
28730 <link linkend="catalogeasyanalytics">Easy Analytics</link> funtion; the other is the
28731 <link linkend="catalogenhanceanalytics">Analytics Enhanced Workflow</link>.</para>
28732 <section id="catalogeasyanalytics">
28733 <title>Easy Analytics</title>
28734 <para>The Easy Analytics feature makes linking analytic records together easier. The
28735 first thing you need to do is set the <link linkend="EasyAnalyticalRecords"
28736 >EasyAnalyticalRecords</link> preference to 'Display' and the <link
28737 linkend="UseControlNumber">UseControlNumber</link> preference to 'Don't use.' </para>
28738 <para>After cataloging your analytic record (see <link linkend="addbibrec">Adding
28739 Records</link> for more on creating records) click 'Edit' from the normal view and
28740 choose to 'Link to Host Item'</para>
28742 <screeninfo>Link to Host Item</screeninfo>
28745 <imagedata fileref="images/cataloging/analyticslink.png"/>
28749 <para>This will prompt you to enter the barcode for the item this record should be linked
28752 <screeninfo>Barcode for Analytic Linking</screeninfo>
28755 <imagedata fileref="images/cataloging/analyticsbarcode.png"/>
28759 <para>After entering the item's barcode and clicking 'Select' you will receive a
28760 confirmation message.</para>
28762 <screeninfo>Analytic Link Success</screeninfo>
28765 <imagedata fileref="images/cataloging/analyticlinksuccess.png"/>
28769 <para>The record will now have the 773 field filled in properly to complete the
28772 <screeninfo>773</screeninfo>
28775 <imagedata fileref="images/cataloging/analytics773.png"/>
28779 <para>To view all of the items tied to the host record, do a search for the record, click
28780 the Analytics tab on the left and the analytics tied to each barcode will be shown under
28781 the "Used in" column.</para>
28783 <screeninfo>Analytics Tab</screeninfo>
28786 <imagedata fileref="images/cataloging/analyticstab.png"/>
28791 <para>It is also possible to create analytic records from this screen by clicking on
28792 "Create Analytics"</para>
28794 <para>You can also see the analytics attached to this record by clicking the 'Show
28795 Analytic' link towards the top of the record in the normal view.</para>
28797 <screeninfo>Show Analytics on Bib Record</screeninfo>
28800 <imagedata fileref="images/cataloging/anayticbib.png"/>
28804 <para>When looking at the anaytic record you will also see a link to the host item under
28805 the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.</para>
28807 <screeninfo>Host Record</screeninfo>
28810 <imagedata fileref="images/cataloging/hostrecords.png"/>
28815 <section id="catalogenhanceanalytics">
28816 <title>Analytics Enhanced Workflow </title>
28817 <para>To use the Enhanced Workflow method of adding analytics, the first thing you need to
28818 do is set the <link linkend="EasyAnalyticalRecords">EasyAnalyticalRecords</link>
28819 preference to 'Don't display' and the <link linkend="UseControlNumber"
28820 >UseControlNumber</link> preference to 'Use.' </para>
28821 <para>After cataloging your original record (see <link linkend="addbibrec">Adding
28822 Records</link> for more on creating records) click 'New' from the normal view and
28823 choose to 'New child record.'</para>
28825 <screeninfo>New child record</screeninfo>
28828 <imagedata fileref="images/cataloging/analyticschildlink.png"/>
28832 <para>This will open a new blank record for cataloging. The blank record will only have
28833 the 773 field filled in properly to complete the link once the record is saved.</para>
28835 <screeninfo>773</screeninfo>
28838 <imagedata fileref="images/cataloging/analytics773child.png"/>
28842 <para>To view all of the items tied to the host record, do a search for the record, click
28843 the Analytics tab on the left and the analytics tied to each barcode will be shown under
28844 the "Used in" column.</para>
28846 <screeninfo>Analytics Tab</screeninfo>
28849 <imagedata fileref="images/cataloging/analyticstab.png"/>
28853 <para>You can also see the analytics attached to this record by clicking the 'Show
28854 Analytic' link towards the top of the record in the normal view.</para>
28856 <screeninfo>Show Analytics on Bib Record</screeninfo>
28859 <imagedata fileref="images/cataloging/anayticbib.png"/>
28863 <para>When looking at the anaytic record you will also see a link to the host item under
28864 the 'Host records' column in the holdings table when viewing the 'Analtyics' tab.</para>
28866 <screeninfo>Host Record</screeninfo>
28869 <imagedata fileref="images/cataloging/hostrecords.png"/>
28874 <section id="analyticediting">
28875 <title>Editing Analytics</title>
28876 <para>If you have linked an analytic record incorrectly you can remove that link by
28877 editing the item on the analytic record (not the host record). To do this, go to the
28878 analytic record and click the 'Edit' button and choose to 'Edit items'. To the left of
28879 each item you will see two options.</para>
28881 <screeninfo>Edit Analytic Item Record</screeninfo>
28884 <imagedata fileref="images/cataloging/analyticdelink.png"/>
28890 <para>Clicking 'Edit in Host' will allow you to edit the item on the host
28894 <para>Clicking 'Delink' will remove the 773 field and the link between the analytic
28895 and the host.</para>
28901 <section id="editbibrec">
28902 <title>Editing Records</title>
28904 <para>To edit a record you can click 'Edit Biblio' from the search
28905 results on the cataloging page</para>
28908 <screeninfo>Edit Biblio Option on Search Results</screeninfo>
28912 <imagedata fileref="images/cataloging/catalogsearch.png"/>
28917 <para>or by clicking the Edit button on the Bibliographic Record and
28918 choosing 'Edit Record'</para>
28921 <screeninfo>Edit Record Option on Bibliographic Record</screeninfo>
28925 <imagedata fileref="images/cataloging/editrecord.png"/>
28930 <para>The record will open in the MARC editor</para>
28933 <screeninfo>Editing MARC Record</screeninfo>
28937 <imagedata fileref="images/cataloging/editingrecord.png"/>
28942 <para>The alternative is to search via Z39.50 to overlay your record
28943 with a fuller record found at another library. You can do this by
28944 choosing 'Replace Record via Z39.50' from the Edit menu.</para>
28947 <screeninfo>Replace via Z39.50</screeninfo>
28951 <imagedata fileref="images/cataloging/replaceviaz39.png"/>
28956 <para>Once you choose that you will be brought to a Z39.50 search
28957 window to search other libraries for the record in question.</para>
28959 <para>Once you have made your edits (via either method) you can click
28960 'Save' at the top left of the editor.</para>
28962 <para>You can also use the edit menu to add your own custom cover
28963 image if you have either <link linkend="OPACLocalCoverImages">OPACLocalCoverImages</link> and/or
28964 <link linkend="LocalCoverImages">LocalCoverImages</link> set to
28965 'Display' by choosing 'Upload Image' from the menu.</para>
28968 <screeninfo>Upload Image</screeninfo>
28972 <imagedata fileref="images/cataloging/uploadimage.png"/>
28977 <para>Choosing to 'Upload Image' will take you to the <link linkend="uploadlocalimages">Upload Local Cover Image
28978 Tool</link>.</para>
28981 <section id="dupbibrec">
28982 <title>Duplicating Records</title>
28984 <para>Sometimes a copy of the record you need to catalog can't be
28985 found via Z39.50. In these cases you can create a duplicate of similar
28986 record and edit the necessary pieces to create a new record. To
28987 duplicate an existing record click 'Edit as New (Duplicate)' from the
28988 Edit menu on the Bibliographic Record</para>
28991 <screeninfo>Edit as New (Duplicate) Bibliographic
28992 Record</screeninfo>
28996 <imagedata fileref="images/cataloging/createduplicate.png"/>
29001 <para>This will open a new MARC record with the fields filled in with
29002 the values from the original Bibliographic Record.</para>
29005 <screeninfo>New Duplicate Record</screeninfo>
29009 <imagedata fileref="images/cataloging/newduprecord.png"/>
29015 <section id="mergebibs">
29016 <title>Merging Records</title>
29018 <para>If you would like to merge together multiple records you can do
29019 that via the <link linkend="lists">Lists</link> tool. <link linkend="mergebibrecs">Learn more here</link>.</para>
29021 <section id="deleterecord">
29022 <title>Deleting Records</title>
29023 <para>To delete a bibliographic record simply choose the 'Edit' button and select 'Delete record'</para>
29025 <screeninfo>Delete record</screeninfo>
29028 <imagedata fileref="images/cataloging/deleterecord.png"/>
29032 <para>Bibliographic records can only be deleted one all items have been deleted. If you try
29033 to delete a bibliographic record with items still attached you will see that the delete
29034 option is grayed out.</para>
29036 <screeninfo>Record with items still attached</screeninfo>
29039 <imagedata fileref="images/cataloging/nodeleterecord.png"/>
29046 <section id="catitems">
29047 <title>Item Records</title>
29049 <para>In Koha each bibliographic record can have one or more items
29050 attached. These items are sometimes referred to as holdings. Each item
29051 includes information to the physical copy the library has.</para>
29053 <section id="addingitems">
29054 <title>Adding Items</title>
29056 <para>After saving a new bibliographic record, you will be redirected
29057 to a blank item record so that you can attach an item to the
29058 bibliographic record. You can also click 'Add/Edit Items' from the
29059 cataloging search results</para>
29062 <screeninfo>Add/Edit Items Option on Search Results</screeninfo>
29066 <imagedata fileref="images/cataloging/catalogsearch.png"/>
29071 <para>or you can add new item at any time by clicking 'New' on the
29072 bibliographic record and choosing 'New Item'</para>
29075 <screeninfo>New Item Button</screeninfo>
29079 <imagedata fileref="images/cataloging/newitem.png"/>
29084 <para>The item edit form will appear:</para>
29087 <screeninfo>Add item form</screeninfo>
29091 <imagedata fileref="images/cataloging/additem.png"/>
29096 <para>At the very least, if you plan on circulating the item, the
29097 following fields should be entered for new items:</para>
29101 <para>2 - Source of classification</para>
29105 <para>a - Permanent location</para>
29109 <para>b - Current location</para>
29113 <para>o - Full call number</para>
29117 <para>p - Barcode</para>
29121 <para>v - Cost, replacement price</para>
29125 <para>This value will be charged to patrons when you mark an
29126 item they have checked out as 'Lost'</para>
29132 <para>y - Koha item type</para>
29136 <para>To make sure that these values are filled in you can mark them
29137 as mandatory in the <link linkend="marcbibframeworks">framework</link>
29138 you're using and then they will appear in red with a 'required' label.
29139 The item will not save until the required fields are filled in.</para>
29142 <screeninfo>Required Item Subfield</screeninfo>
29146 <imagedata fileref="images/cataloging/requireditemfields.png"/>
29154 <para>To make item subfields required in a framework you'll want
29155 to edit the 952 field in the <link linkend="marcbibframeworks">framework editor</link>.</para>
29160 <para>Below the add form there are 3 buttons for adding the
29164 <screeninfo>Add Item Buttons</screeninfo>
29168 <imagedata fileref="images/cataloging/additembuttons.png"/>
29175 <para>Add Item will add just the one item</para>
29179 <para>Add & Duplicate will add the item and fill in a new form
29180 with the same values for your to alter</para>
29184 <para>Add Multiple items will ask how many items and will then add that number of items
29185 adding +1 to the barcode so each barcode is unique</para>
29189 <para>Your added items will appear above the add form once
29193 <screeninfo>Items</screeninfo>
29197 <imagedata fileref="images/cataloging/items.png"/>
29202 <para>Your items will also appear below the bibliographic details on
29203 the bib record display.</para>
29206 <screeninfo>List of Items on the Bib Record</screeninfo>
29210 <imagedata fileref="images/cataloging/items-withoutlabelprint.png"/>
29215 <para>If you have <link linkend="SpineLabelShowPrintOnBibDetails">SpineLabelShowPrintOnBibDetails</link>
29216 set to 'Display' then there will also be a link to print a quick spine
29217 label next to each item.</para>
29220 <screeninfo>List of Items on the Bib Record with a Print Label
29225 <imagedata fileref="images/cataloging/items-withlabelprint.png"/>
29229 <para>You can also filter the contents of your holdings table by clicking the 'Activate
29230 filters' links. This will show a row at the top where you can type in any column to
29231 filter the results in the table.</para>
29233 <screeninfo>Filter holdings</screeninfo>
29236 <imagedata fileref="images/cataloging/items-activatefilters.png"/>
29242 <section id="editingitems">
29243 <title>Editing Items</title>
29245 <para>Items can be edited in several ways.</para>
29249 <para>Clicking 'Edit' and 'Edit Items' from the bibliographic
29253 <screeninfo>Edit Items Menu Option</screeninfo>
29257 <imagedata fileref="images/cataloging/edititem.png"/>
29262 <para>Which will open up a list of items where you can click
29263 'Edit' to the left of the specific item you would like to
29267 <screeninfo>Edit individual items</screeninfo>
29271 <imagedata fileref="images/cataloging/edititemlink.png"/>
29278 <para>Clicking 'Edit Items' beside the item on the 'Items'
29282 <screeninfo>Items Tab</screeninfo>
29286 <imagedata fileref="images/cataloging/itemstab.png"/>
29291 <para>Which will open up a list of items where you can click
29292 'Edit' to the left of the specific item you would like to
29296 <screeninfo>Edit individual items</screeninfo>
29300 <imagedata fileref="images/cataloging/edititemlink.png"/>
29307 <para>Clicking 'Edit' and then 'Edit items in batch'</para>
29310 <screeninfo>Edit items in a batch</screeninfo>
29314 <imagedata fileref="images/cataloging/editinbatch.png"/>
29319 <para>This will open up the <link linkend="batchmodifyitems">batch
29320 item modification tool</link> where you can edit all of the items
29321 on this record as a batch.</para></listitem>
29322 <listitem><para>You can also enable <link linkend="StaffDetailItemSelection">StaffDetailItemSelection
29323 </link> to have checkboxes appear to the left of each item
29324 on the detail display. You can then check off the items you would like to edit and
29325 click 'Modify selected items' at the top of the list.</para>
29327 <screeninfo>Editing selected items</screeninfo>
29330 <imagedata fileref="images/cataloging/editwithitemchecks.png"/>
29336 <para>Finally you can use the <link linkend="batchmodifyitems">Batch Item
29337 Modification</link> tool</para>
29341 <section id="itemquickedit">
29342 <title>Quick Item Status Updates</title>
29344 <para>Often circulation staff need to change the status of an item
29345 to Lost or Damaged. This doesn't require you to edit the entire item
29346 record. Instead clicking on the item barcode on the checkout summary
29347 or checkin history will bring you to an item summary. You can also
29348 get to the item summary by clicking on the Items tab to the left of
29349 the bib detail page.</para>
29352 <screeninfo>Item Edit</screeninfo>
29356 <imagedata fileref="images/cataloging/quickitemedit.png"/>
29361 <para>From this view you can mark an item lost by choosing a lost
29362 status from the pull down and clicking the 'Set Status'
29366 <screeninfo>Edit Lost Status</screeninfo>
29370 <imagedata fileref="images/cataloging/editloststatus.png"/>
29375 <para>You can also mark an item as damaged by choosing a damaged
29376 status from the pull down and clicking the 'Set Status'
29380 <screeninfo>Edit Damaged Status</screeninfo>
29384 <imagedata fileref="images/cataloging/editdamagedstatus.png"/>
29391 <section id="iteminfo">
29392 <title>Item Information</title>
29394 <para>To the left of every bibliographic record there is a tab to view
29398 <screeninfo>Items Tab</screeninfo>
29402 <imagedata fileref="images/cataloging/quickitemedit.png"/>
29407 <para>Clicking that tab will give you basic information about the
29408 items. If you ordered the item via the acquisitions module then the
29409 History section will include information about the order.</para>
29412 <screeninfo>History with order info</screeninfo>
29416 <imagedata fileref="images/cataloging/itemorderinfo.png"/>
29421 <para>If the Order or Accession date is linked, clicking it will bring
29422 you to the acquisitions information for that item.</para>
29425 <section id="moveitemrec">
29426 <title>Moving Items</title>
29428 <para>Items can be moved from one bibliographic record to another
29429 using the Attach Item option</para>
29432 <screeninfo>Attach Item Option</screeninfo>
29436 <imagedata fileref="images/cataloging/attachitem.png"/>
29441 <para>Visit the bibliographic record you want to attach the item to
29442 and choose 'Attach Item' from the 'Edit' menu.</para>
29445 <screeninfo>Attach Item Form</screeninfo>
29449 <imagedata fileref="images/cataloging/attachitemform.png"/>
29454 <para>Simply enter the barcode for the item you want to move and click
29457 <para>If you want to move all items to a new record creating only one
29458 bibliographic record you can use the <link linkend="mergebibrecs">Merge Records tool</link> instead.</para>
29461 <section id="deleteitems">
29462 <title>Deleting Items</title>
29464 <para>There are many ways to delete item records. If you only need to
29465 delete one item you can do this by opening up the detail page for the
29466 bib record and clicking the 'Edit' button at the top. From there you
29467 can choose to 'Edit items'.</para>
29470 <screeninfo>'Edit Items' menu option</screeninfo>
29474 <imagedata fileref="images/cataloging/edititemstodelete.png"/>
29479 <para>You will be presented with a list of items and next to each one
29480 will be a link labeled 'Delete'. Click that link and if the item is
29481 not checked out it will delete that item.</para>
29484 <screeninfo>Delete link on the left</screeninfo>
29488 <imagedata fileref="images/cataloging/deleteitemlink.png"/>
29493 <para>If you know that all of the items attached to your record are
29494 not currently checked out you can use the 'Delete all items' option
29495 under the 'Edit menu' and it will remove all items from the
29497 <para>You can also enable <link linkend="StaffDetailItemSelection">StaffDetailItemSelection</link>
29498 to have checkboxes appear to the left of each item on
29499 the detail display. You can then check off the items you would like to delete and click
29500 'Delete selected items' at the top of the list.</para>
29502 <screeninfo>Deleting selected items</screeninfo>
29505 <imagedata fileref="images/cataloging/editwithitemchecks.png"/>
29510 <para>Finally you can use the <link linkend="batchdeleteitems">batch
29511 delete tool</link> to delete a batch of items.</para>
29514 <section id="itemcirchistory">
29515 <title>Item Specific Circulation History</title>
29517 <para>Each bibliographic record keeps a circulation history (with or
29518 without the patron information depending on your settings), but each
29519 item also has its own circulation history page. To see this, click on
29520 the 'Items' tab to the left of the record you are viewing.</para>
29523 <screeninfo>Items tab</screeninfo>
29527 <imagedata fileref="images/cataloging/itemstab-long.png"/>
29532 <para>Below the 'History' heading is a link to 'View item's checkout
29533 history,' clicking that will open up the item's history which will
29534 look slightly different from the bibliographic record's history
29538 <screeninfo>Item Specific Circulation History</screeninfo>
29542 <imagedata fileref="images/cataloging/itemspecifichistory.png"/>
29549 <section id="catauthorities">
29550 <title>Authorities</title>
29552 <para>Authority records are a way of controlling fields in your MARC
29553 records. Using authority records will provide you with control over
29554 subject headings, personal names and places.</para>
29556 <section id="addauthorities">
29557 <title>Adding Authorities</title>
29559 <para>To add a new authority record you can either choose the authority type from the 'New
29560 Authority' button or search another library by clicking the 'New from Z39.50'
29564 <screeninfo>New Authority Record Options</screeninfo>
29568 <imagedata fileref="images/cataloging/newauthtypes.png"/>
29573 <para>If you choose to enter a new authority from scratch, the form that appears will allow
29574 you to enter all of the necessary details regarding your authority record.</para>
29577 <screeninfo>New Authority Record</screeninfo>
29581 <imagedata fileref="images/cataloging/newauthrec.png"/>
29586 <para>To expand collapsed values simply click on the title and the
29587 subfields will appear. To duplicate a field or subfield just click the
29588 plus sign (+) to the right of the label. To use field helper plugins
29589 simply click the ellipsis (...) to the right of the field.</para>
29591 <para>When linking authorities to other headings, you can use the
29592 authority finder plugin by clicking the ellipsis (...) to the right of
29596 <screeninfo>Authority search plugin</screeninfo>
29600 <imagedata fileref="images/cataloging/creatnewauthfromlink.png"/>
29605 <para>From there you can search your authority file for the authority
29606 to link. If you can't find the authority to link, you can click the
29607 'Create new' button and add the necessary authority for the link. This
29608 plugin also allows for you to choose the link relationship between the
29609 authorities.</para>
29612 <screeninfo>Authority relationships</screeninfo>
29616 <imagedata fileref="images/cataloging/authrelationships.png"/>
29620 <para>If you choose to search another library for the authority record you will be presented
29621 with a search box</para>
29623 <screeninfo>Authority Z39.50 Search</screeninfo>
29626 <imagedata fileref="images/cataloging/authzsearch.png"/>
29630 <para>From the results you can choose the 'Import' link to the right of the record you would
29631 like to add to Koha</para>
29633 <screeninfo>Authority Z39.50 Results</screeninfo>
29636 <imagedata fileref="images/cataloging/authimport.png"/>
29640 <para>You will then be presented with the form to edit the authority before saving it to
29643 <screeninfo>Imported Authority</screeninfo>
29646 <imagedata fileref="images/cataloging/authorityimported.png"/>
29652 <section id="searchauthorities">
29653 <title>Searching Authorities</title>
29655 <para>From the authorities page you can search for existing terms and
29656 the bibliographic records they are attached to.</para>
29659 <screeninfo>Authority Search</screeninfo>
29663 <imagedata fileref="images/cataloging/authoritysearch.png"/>
29668 <para>From the results you will see the authority record, how many bibliographic records it
29669 is attached to, an <link linkend="editauthorities">edit</link> link, a <link
29670 linkend="authoritymerge">merge</link> link and a <link linkend="editauthorities"
29671 >delete</link> link (if there are no bibliographic records attached).</para>
29674 <screeninfo>Authority Search Results</screeninfo>
29678 <imagedata fileref="images/cataloging/authorityresults.png"/>
29683 <para>Clicking on the Details link to the right of the authority
29684 record summary will open the full record and the option to edit the
29688 <screeninfo>Authority Record</screeninfo>
29692 <imagedata fileref="images/cataloging/authrecord.png"/>
29697 <para>If the authority has See Alsos in it you will see those broken
29698 out on the search results, clicking the linked headings will run a
29699 search for that heading instead.</para>
29702 <screeninfo>See Also in Authorities</screeninfo>
29706 <imagedata fileref="images/cataloging/authoritiesseealso.png"/>
29712 <section id="editauthorities">
29713 <title>Editing Authorities</title>
29715 <para>Authorities can be edited by clicking on the authority summary from the search results
29716 and then clicking the 'Edit' button above the record. Or by clicking on the 'Edit' link to
29717 the left of the authority on the search results.</para>
29720 <screeninfo>Edit Authority Record</screeninfo>
29724 <imagedata fileref="images/cataloging/editauthority.png"/>
29729 <para>Once you've made the necessary edits, simply click 'Save' and <link
29730 linkend="dontmerge">dontmerge</link> is set to 'Do', Koha will immediately update all of
29731 the bib records linked to the authority with the new authority record's data. If dontmerge
29732 is set to "Don't" then Koha won't edit bib records when changes are made to authorities,
29733 rather, this is done later by the <link linkend="mergeauthcron">merge_authority.pl
29734 cronjob</link>.</para>
29736 <para>To delete an authority record you first must make sure it's not
29737 linked to any bibliographic records. If it is not used by any
29738 bibliographic records a 'Delete' link will appear to the right of the
29739 record on the search results and as a button that appears after
29740 clicking on the summary of the authority record.</para>
29742 <section id="authoritymerge">
29743 <title>Merging Authorities</title>
29744 <para>If you have duplicate authority records you can merge them together by clicking the
29745 'Merge' link next to two results on an authority search. After clicking 'Merge' on the
29746 first result you will see that authority listed at the top of the results.</para>
29748 <screeninfo>Merging authorities results</screeninfo>
29751 <imagedata fileref="images/cataloging/authmergesearch.png"/>
29755 <para>You will be asked which of the two records you would like to keep as your primary
29756 record and which will be deleted after the merge.</para>
29758 <screeninfo>Merging authorities</screeninfo>
29761 <imagedata fileref="images/cataloging/authmergechoice.png"/>
29765 <para>You will be presented with the MARC for both of the records (each accessible by tabs
29766 labeled with the authority numbers for those records). By default the entire first record
29767 will be selected, uncheck the fields you don't want in the final (destination) record and
29768 then move on to the second tab to choose which fields should be in the final (destination)
29771 <screeninfo>Authorities to merge</screeninfo>
29774 <imagedata fileref="images/cataloging/authmerging.png"/>
29778 <para>Once you have completed your selections click the 'Merge' button. The primary record
29779 will now contain the data you chose for it and the second record will be deleted.</para>
29781 <screeninfo>Merged authority</screeninfo>
29784 <imagedata fileref="images/cataloging/authmerged.png"/>
29791 <section id="catguides">
29792 <title>Cataloging Guides</title>
29796 <section id="bibcatcheatsheet">
29800 <firstname>Jared</firstname>
29801 <surname>Camins-Esakov</surname>
29803 <orgname>American Numismatic Society</orgname>
29808 <firstname>Nicole C.</firstname>
29809 <surname>Engard</surname>
29810 <contrib>Changed/edited content where necessary.</contrib>
29814 <pubdate>2010</pubdate>
29816 <title>Bibliographic Record Cataloging Cheat Sheet</title>
29818 <table cellpadding="4" cellspacing="4" frame="all">
29819 <title>Cataloging Guide</title>
29821 <tgroup align="left" cols="4" colsep="1" rowsep="1">
29824 <entry><para>Tag</para></entry>
29826 <entry><para>Label</para></entry>
29828 <entry><para>Description</para></entry>
29830 <entry><para>Instructions</para></entry>
29836 <entry><para>000</para></entry>
29838 <entry><para>LEADER</para></entry>
29840 <entry><para>Describes the record(i.e. surrogate) -- is it a
29841 record for a monograph? A serial?</para></entry>
29843 <entry><para>Click in this field to fill it in. Then set
29844 "Bibliographic level" to 'a' for articles or 's' for serials.
29845 Otherwise, leave everything as is.</para></entry>
29849 <entry><para>001</para></entry>
29851 <entry><para>CONTROL NUMBER</para></entry>
29853 <entry><para>Accession number.</para></entry>
29855 <entry><para>Enter the accession number written inside the
29856 item here. For articles and items which do not have accession
29857 numbers, leave blank.</para></entry>
29861 <entry><para>003</para></entry>
29863 <entry><para>CONTROL NUMBER IDENTIFIER</para></entry>
29865 <entry><para>Your MARC Organizational Code</para></entry>
29867 <entry><para>Click in this field to fill it in (will auto fill
29868 if you have your <link linkend="MARCOrgCode">MARCOrgCode</link> preference
29869 set).</para></entry>
29873 <entry><para>005</para></entry>
29875 <entry><para>D & T LATEST TRANSACTION</para></entry>
29877 <entry><para>Current date and time.</para></entry>
29879 <entry><para>Click in this field to fill it in.</para></entry>
29883 <entry><para>008</para></entry>
29885 <entry><para>FIXED-LENGTH DATA ELEMENTS</para></entry>
29887 <entry><para>Field containing computer-readable
29888 representations of a number of things.</para></entry>
29890 <entry><para>Generally you will only use 's' (single) or 'm'
29891 (multiple) options for position 06- use the former when the
29892 item was published in a single year, the latter when it was
29893 published over the course of several. If there is a single
29894 date, only enter a date in the first date field (positions
29895 07-10). Enter the three-digit country code in positions 15-17,
29896 being sure to add spaces if the country code is fewer than
29897 three characters long. If there is an index, note that fact in
29898 position 31. Enter the three-letter language code in positions
29899 35-37.</para></entry>
29903 <entry><para>010</para></entry>
29905 <entry><para>LCCN</para></entry>
29907 <entry><para>A number assigned by the Library of Congress to
29908 uniquely identify the work.</para></entry>
29910 <entry><para>Check on the copyright page of the book (if it
29911 was published in the US) or the LC catalog for this number. If
29912 you can't find it, don't worry about it.</para></entry>
29916 <entry><para>020</para></entry>
29918 <entry><para>ISBN</para></entry>
29920 <entry><para>Unique number used by publishers to identify
29921 books.</para></entry>
29923 <entry><para>If this number isn't listed on the book, there
29924 probably isn't one.</para></entry>
29928 <entry><para>022</para></entry>
29930 <entry><para>ISSN</para></entry>
29932 <entry><para>Unique number used by publishers to identify
29933 serials.</para></entry>
29935 <entry><para>If this number isn't listed on the book, there
29936 probably isn't one.</para></entry>
29940 <entry><para>033</para></entry>
29942 <entry><para>DATE/TIME OF EVENT</para></entry>
29944 <entry><para>Used for auction dates. Required for auction
29945 catalogs.</para></entry>
29947 <entry><para>For auctions that took place on only one day,
29948 enter the date of the auction in the format YYYYMMDD in the
29949 subfield 'a' and a '0' in the first indicator. For auctions
29950 that took place over two consecutive days or any number of
29951 non-consecutive days, create a subfield 'a' for each day with
29952 the date in the format YYYYMMDD, and put a '1' in the first
29953 indicator. For auctions that took place over more than two
29954 consecutive days, create a subfield 'a' (in format YYYYMMDD)
29955 for the first day and a subfield 'a' (also in format YYYYMMDD)
29956 for the last day, and put a '2' in the first
29957 indicator.</para></entry>
29961 <entry><para>040</para></entry>
29963 <entry><para>CATALOGING SOURCE</para></entry>
29965 <entry><para>Identifies which libraries created and modified
29966 the record.</para></entry>
29968 <entry><para>For imported records, add a subfield 'd' with
29969 your OCLC code as the value. For new records, make sure that
29970 the subfield 'c' with your OCLC code as the
29971 value.</para></entry>
29975 <entry><para>041</para></entry>
29977 <entry><para>LANGUAGE CODE</para></entry>
29979 <entry><para>Identifies all the languages used in an item,
29980 when two or more languages are present.</para></entry>
29982 <entry><para>For significant portions of a text in a given
29983 language, there should be a subfield 'a' with that language
29984 code. If there are only summaries or abstracts in a specific
29985 language, create a subfield 'b' with that language
29986 code.</para></entry>
29990 <entry><para>100</para></entry>
29992 <entry><para>MAIN ENTRY--PERSONAL</para></entry>
29994 <entry><para>Authorized form of the main author's
29995 name</para></entry>
29997 <entry><para>See Authorized headings sheet and AACR2. The
29998 first indicator should generally be a '1', to indicate that
29999 the entry is surname first. If the name consists only of a
30000 forename, however, the first indicator should be
30001 '0'.</para></entry>
30005 <entry><para>110</para></entry>
30007 <entry><para>MAIN ENTRY--CORPORATE</para></entry>
30009 <entry><para>Authorized form of the name of the main corporate
30010 author. Required for auction catalogs.</para></entry>
30012 <entry><para>Auction catalogs should use a 110 field rather
30013 than a 100 field. See Authorized headings sheet and AACR2. Set
30014 the first indicator to '2'.</para></entry>
30018 <entry><para>111</para></entry>
30020 <entry><para>MAIN ENTRY--MEETING</para></entry>
30022 <entry><para>Authorized form of the name of a meeting which
30023 acted as a main offer (e.g. conference
30024 proceedings)</para></entry>
30026 <entry><para>See Authorized headings sheet and AACR2. Set the
30027 first indicator to '2'.</para></entry>
30031 <entry><para>245</para></entry>
30033 <entry><para>TITLE STATEMENT</para></entry>
30035 <entry><para>Transcription of the title statement from the
30036 title page (or chief source of information)</para></entry>
30038 <entry><para>Enter the title in subfield 'a', the subtitle in
30039 subfield 'b', and the statement of responsibility in subfield
30040 'c'. If you are creating a record for a single volume or part
30041 of a multi-part item, you should put the part number in
30042 subfield 'n' and the part title in subfield 'p.' For auction
30043 catalogs, the date (in 'MM/DD/YYYY' format) should be listed
30044 in square brackets in subfield 'f'. See ISBD punctuation
30045 sheet. Set the first indicator to '0' if there is no author,
30046 otherwise set it to '1'. Set the second indicator to the
30047 number of non-filing characters (i.e. characters in an initial
30048 articles plus the space... for "The " set the second indicator
30049 to '4').</para></entry>
30053 <entry><para>246</para></entry>
30055 <entry><para>VARYING FORM OF TITLE</para></entry>
30057 <entry><para>Alternate form of title for searching and filing
30058 purposes</para></entry>
30060 <entry><para>If the patron might look for the work under a
30061 different title, enter it here. Do not include initial
30062 articles. The first indicator should be '3', unless the title
30063 is merely a variant spelling, in which case the first
30064 indicator should be '1'.</para></entry>
30068 <entry><para>250</para></entry>
30070 <entry><para>EDITION STATEMENT</para></entry>
30072 <entry><para>Transcription of the edition statement from the
30073 title page (or chief source of information)</para></entry>
30075 <entry><para>Transcribe the edition statement exactly as it
30076 appears on the title-page. You may abbreviate if the edition
30077 statement is very long.</para></entry>
30081 <entry><para>260</para></entry>
30083 <entry><para>PUBLICATION (IMPRINT)</para></entry>
30085 <entry><para>Publication information.</para></entry>
30087 <entry><para>Put the location of publication in subfield 'a',
30088 the publisher in subfield 'b', and the year (or probable year)
30089 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
30093 <entry><para>300</para></entry>
30095 <entry><para>PHYSICAL DESCRIPTION</para></entry>
30097 <entry><para>Physical description</para></entry>
30099 <entry><para>Enter the pagination statement in subfield 'a', a
30100 brief description of "special" contents such as illustrations
30101 or maps in subfield 'b' (see AACR2), and the size of the item
30102 in subfield 'c'. See ISBD punctuation sheet.</para></entry>
30106 <entry><para>490</para></entry>
30108 <entry><para>SERIES STATEMENT</para></entry>
30110 <entry><para>Shows the series statement exactly as it appears
30111 on the item.</para></entry>
30113 <entry><para>Transcribe the series statement into subfield 'a'
30114 with the volume number in subfield 'v'. See ISBD punctuation
30115 sheet. Set the first indicator to '1' if you are using an 830.
30116 As a general rule, you should do so.</para></entry>
30120 <entry><para>500</para></entry>
30122 <entry><para>GENERAL NOTE</para></entry>
30124 <entry><para>Notes that don't fit anywhere
30125 else.</para></entry>
30127 <entry><para>Enter notes as full sentences, with a separate
30128 500 field for each distinct topic.</para></entry>
30132 <entry><para>501</para></entry>
30134 <entry><para>WITH NOTE</para></entry>
30136 <entry><para>Notes whether the work is bound with the works
30137 described by other records.</para></entry>
30139 <entry><para>Put description of relationship in subfield
30140 'a'.</para></entry>
30144 <entry><para>504</para></entry>
30146 <entry><para>BIBLIOGRAPHY, ETC. NOTE</para></entry>
30148 <entry><para>Indicates whether the work includes a
30149 bibliography.</para></entry>
30151 <entry><para>If the work includes a bibliography and index,
30152 put the text "Includes bibliographical references (p. XXX-XXX)
30153 and index." in subfield 'a'. If the work does not include an
30154 index, remove that part of the sentence. If the references are
30155 scattered throughout the work and not gathered into a distinct
30156 sentence, remove the parenthetical statement.</para></entry>
30160 <entry><para>505</para></entry>
30162 <entry><para>FORMATTED CONTENTS</para></entry>
30164 <entry><para>List of contents in a standard format.
30165 Unformatted contents can be listed in a 500 (General Note)
30166 field.</para></entry>
30168 <entry><para>See ISBD punctuation sheet. Set the first
30169 indicator to '0'. If you are separately coding authors and
30170 titles, set the second indicator to '0'. Otherwise, leave the
30171 second indicator blank.</para></entry>
30175 <entry><para>518</para></entry>
30177 <entry><para>DATE/TIME OF EVENT NOTE</para></entry>
30179 <entry><para>Used for auction dates.</para></entry>
30181 <entry><para>For auction catalogs, enter the date of the
30182 auction in the format 'January 2, 1984' in the subfield
30187 <entry><para>520</para></entry>
30189 <entry><para>SUMMARY, ETC.</para></entry>
30191 <entry><para>A brief summary or abstract of the book or
30192 article.</para></entry>
30194 <entry><para>In general you do not need to write a summary. A
30195 summary might be called for, however, with items that cannot
30196 be easily reviewed by a patron, such as books with highly
30197 acidic paper or CD-ROMs.</para></entry>
30201 <entry><para>546</para></entry>
30203 <entry><para>LANGUAGE NOTE</para></entry>
30205 <entry><para>Note describing the languages used in the
30206 work</para></entry>
30208 <entry><para>Only needed for works in multiple languages. See
30209 ISBD punctuation sheet.</para></entry>
30213 <entry><para>561</para></entry>
30215 <entry><para>PROVENANCE INFORMATION</para></entry>
30217 <entry><para>Describes the previous ownership of the
30218 item.</para></entry>
30220 <entry><para>Used only for rare books.</para></entry>
30224 <entry><para>563</para></entry>
30226 <entry><para>BINDING INFORMATION</para></entry>
30228 <entry><para>Describes the binding of the item.</para></entry>
30230 <entry><para>Used only for rare books.</para></entry>
30234 <entry><para>590</para></entry>
30236 <entry><para>LOCAL NOTE</para></entry>
30238 <entry><para>Local notes. Required for auction
30239 catalogs.</para></entry>
30241 <entry><para>Used for auction catalogs to indicate what types
30242 of coins are sold in the auction- Roman, Greek,
30243 etc.</para></entry>
30247 <entry><para>600</para></entry>
30249 <entry><para>SUBJECT ADDED--PERSONAL</para></entry>
30251 <entry><para>Authorized form of personal names for people
30252 discussed in the work</para></entry>
30254 <entry><para>See Authorized headings sheet and AACR2. The
30255 first indicator should generally be a '1', to indicate that
30256 the entry is surname first. If the name consists only of a
30257 forename, however, the first indicator should be '0'. If you
30258 found the name in the LC authority file, set the second
30259 indicator to '0'. Otherwise set the second indicator to
30260 '4'.</para></entry>
30264 <entry><para>610</para></entry>
30266 <entry><para>SUBJECT ADDED--CORPORATE</para></entry>
30268 <entry><para>Authorized form of corporate names for
30269 organizations discussed in the work</para></entry>
30271 <entry><para>See Authorized headings sheet and AACR2. Set the
30272 first indicator to '2'. If you found the name in the LC
30273 authority file, set the second indicator to '0'. Otherwise set
30274 the second indicator to '4'.</para></entry>
30278 <entry><para>611</para></entry>
30280 <entry><para>SUBJECT ADDED--MEETING</para></entry>
30282 <entry><para>Authorized form of meeting names for meetings
30283 discussed in the work</para></entry>
30285 <entry><para>See Authorized headings sheet and AACR2. Set the
30286 first indicator to '2'. If you found the name in the LC
30287 authority file, set the second indicator to '0'. Otherwise set
30288 the second indicator to '4'.</para></entry>
30292 <entry><para>630</para></entry>
30294 <entry><para>SUBJECT ADDED--UNIFORM TITLE</para></entry>
30296 <entry><para>Authorized form of titles for other works
30297 discussed in the work</para></entry>
30299 <entry><para>See Authorized headings sheet and AACR2. Set the
30300 first indicator to the number of non-filing characters (i.e.
30301 characters in an initial articles plus the space... for "The "
30302 set the first indicator to '4'). If you found the name in the
30303 LC authority file, set the second indicator to '0'. Otherwise
30304 set the second indicator to '4'.</para></entry>
30308 <entry><para>650</para></entry>
30310 <entry><para>SUBJECT ADDED--TOPICAL</para></entry>
30312 <entry><para>Library of Congress Subject Heading terms
30313 describing the subject of the work</para></entry>
30315 <entry><para>See Authorized headings sheet and AACR2. If you
30316 found the name in the LC authority file, set the second
30317 indicator to '0'. Otherwise set the second indicator to
30318 '4'.</para></entry>
30322 <entry><para>651</para></entry>
30324 <entry><para>SUBJECT ADDED--GEOGRAPHICAL</para></entry>
30326 <entry><para>Library of Congress Subject Heading geographical
30327 terms describing the subject of the work</para></entry>
30329 <entry><para>See Authorized headings sheet and AACR2. If you
30330 found the name in the LC authority file, set the second
30331 indicator to '0'. Otherwise set the second indicator to
30332 '4'.</para></entry>
30336 <entry><para>655</para></entry>
30338 <entry><para>INDEX TERM--GENRE/FORM</para></entry>
30340 <entry><para>Describes what an item is as opposed to what the
30341 item is about.</para></entry>
30343 <entry><para>Generally used only for auction catalogs, which
30344 should have the genre heading "Auction catalogs." (make sure
30345 to find the authorized heading!) If you found the name in the
30346 LC authority file, set the second indicator to '0'. If you are
30347 using a term from a specific thesaurus, set the second
30348 indicator to '7' and put the code for the thesaurus in
30349 subfield '2'. Otherwise set the second indicator to
30350 '4'.</para></entry>
30354 <entry><para>690</para></entry>
30356 <entry><para>LOCAL SUBJECT ADDED--TOPICAL</para></entry>
30358 <entry><para>Used for headings from any custom subject
30359 authority file.</para></entry>
30361 <entry><para>If there is no appropriate LCSH term, you can use
30362 a 690 with subject headings you find on other items in the
30363 catalog.</para></entry>
30367 <entry><para>691</para></entry>
30369 <entry><para>LOCAL SUBJECT ADDED--GEOGRAPHICAL</para></entry>
30371 <entry><para>Used for headings from any custom subject
30372 authority file.</para></entry>
30374 <entry><para>If there is no appropriate LCSH term, you can use
30375 a 691 with subject headings you find on other items in the
30376 catalog.</para></entry>
30380 <entry><para>700</para></entry>
30382 <entry><para>ADDED ENTRY--PERSONAL</para></entry>
30384 <entry><para>Used for second authors and other persons related
30385 to the production of the work.</para></entry>
30387 <entry><para>See Authorized headings sheet and AACR2. The
30388 first indicator should generally be a '1', to indicate that
30389 the entry is surname first. If the name consists only of a
30390 forename, however, the first indicator should be
30391 '0'.</para></entry>
30395 <entry><para>710</para></entry>
30397 <entry><para>ADDED ENTRY--CORPORATE</para></entry>
30399 <entry><para>Used for corporate bodies related to the
30400 production of the work (e.g. publishers).</para></entry>
30402 <entry><para>See Authorized headings sheet and AACR2. Set the
30403 first indicator to '2'.</para></entry>
30407 <entry><para>711</para></entry>
30409 <entry><para>ADDED ENTRY--MEETING</para></entry>
30411 <entry><para>Used for meetings related to the production of
30412 the work (e.g. symposia that contributed to the
30413 work).</para></entry>
30415 <entry><para>See Authorized headings sheet and AACR2. Set the
30416 first indicator to '2'.</para></entry>
30420 <entry><para>730</para></entry>
30422 <entry><para>ADDED ENTRY--UNIFORM TITLE</para></entry>
30424 <entry><para>Used for uniform titles related to the production
30425 of the work (e.g. a work that inspired the present
30426 work)</para></entry>
30428 <entry><para>See Authorized headings sheet and AACR2. Set the
30429 first indicator to the number of non-filing characters (i.e.
30430 characters in an initial articles plus the space... for "The "
30431 set the first indicator to '4').</para></entry>
30435 <entry><para>773</para></entry>
30437 <entry><para>HOST ITEM ENTRY</para></entry>
30439 <entry><para>Describes the larger bibliographic unit that
30440 contains the work (e.g. book or journal containing the article
30441 being described in the current record)</para></entry>
30443 <entry><para>If the host publication is author main entry,
30444 enter the authorized form of the author's name in subfield
30445 'a'. Put the title in subfield 't'. If the host publication is
30446 an independent work, put publication information in subfield
30447 'd'. When available, ISSN and ISBN should always be used in,
30448 in subfields 'x' and 'z' respectively. Relationship
30449 information (e.g. volume number, page number, etc.) goes in
30450 subfield 'g'. Subfield 'q' contains an encoded representation
30451 of the location of the item: volume, issue, and section
30452 numbers are separated by colons, and the first page is entered
30453 following a '<' at the end of the subfield. See ISBD
30454 punctuation sheet. Set the first indicator to '0'. If you want
30455 the label "In:" to be generated, leave the second indicator
30456 blank. If you want something else displayed before the 773
30457 text, set the second indicator to '8' and add a subfield 'i'
30458 with the label you want at the beginning of the field (e.g.
30459 "$iOffprint from:").</para></entry>
30463 <entry><para>830</para></entry>
30465 <entry><para>SERIES ENTRY--UNIFORM TITLE</para></entry>
30467 <entry><para>Authorized form of the series name transcribed in
30468 the 490 field. Often this will just be the same as the
30469 490.</para></entry>
30471 <entry><para>See Authorized headings sheet and AACR2. Set the
30472 second indicator to the number of non-filing characters (i.e.
30473 characters in an initial articles plus the space... for "The "
30474 set the second indicator to '4').</para></entry>
30478 <entry><para>852</para></entry>
30480 <entry><para>LOCATION/CALL NUMBER</para></entry>
30482 <entry><para>Provides the section name for pre-barcode books,
30483 pamphlets, and some articles and serials.</para></entry>
30485 <entry><para>Do not put anything in this field if you are
30486 cataloging a volume which gets only one record and a barcode.
30487 If the item does not get a barcode, or you are currently
30488 creating a record for an article in a volume, put the section
30489 in subfield 'a' (see ANS cataloging documentation), and the
30490 call number in subfield 'i'. Set the first indicator to
30491 '8'.</para></entry>
30495 <entry><para>856</para></entry>
30497 <entry><para>ELECTRONIC ACCESS</para></entry>
30499 <entry><para>Links to material available
30500 online.</para></entry>
30502 <entry><para>Put the URL of any electronic copies or
30503 summaries, etc. in subfield 'u' and a link title in subfield
30504 'y'. Set the first indicator to '4'.</para></entry>
30508 <entry><para>942</para></entry>
30510 <entry><para>ADDED ENTRY ELEMENTS (KOHA)</para></entry>
30512 <entry><para>Used for Koha-specific data.</para></entry>
30514 <entry><para>Set the subfield 'c' to the appropriate item
30515 type.</para></entry>
30522 <section id="itemcatguide">
30523 <title>Item/Holdings Record Cataloging Guide</title>
30525 <para>This table represents the default embedded holdings data in Koha. This information can
30526 be used for migration or importing data purposes</para>
30528 <table cellpadding="4" cellspacing="4" frame="all">
30529 <title>Koha Embedded Holdings Data</title>
30531 <tgroup align="left" cols="4" colsep="1" rowsep="1">
30532 <colspec colname="tag" colnum="1"/>
30534 <colspec colname="data" colnum="2"/>
30536 <colspec colname="desc" colnum="3"/>
30538 <colspec colname="note" colnum="4"/>
30542 <entry><para>MARC21 Tag/subfield</para></entry>
30544 <entry><para>Data Element</para></entry>
30546 <entry><para>Description</para></entry>
30548 <entry><para>Notes</para></entry>
30554 <entry><para>952$0</para></entry>
30556 <entry><para>Withdrawn status</para></entry>
30558 <entry><para>Default values: </para> <itemizedlist>
30560 <para>0 = Not withdrawn</para>
30564 <para>1 = Withdrawn</para>
30566 </itemizedlist></entry>
30568 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
30569 ('WITHDRAWN' in default installation)</para></entry>
30573 <entry><para>952$1</para></entry>
30575 <entry><para>Lost status</para></entry>
30577 <entry><para>Default values:</para> <itemizedlist>
30579 <para>0 = Available</para>
30583 <para>1 = Lost</para>
30587 <para>2 = Long Overdue (Lost)</para>
30591 <para>3 = Lost and Paid For</para>
30595 <para>4 = Missing in Inventory</para>
30599 <para>5 = Missing in Hold Queue</para>
30601 </itemizedlist></entry>
30603 <entry><para>It's possible to configure OPAC so that lost
30604 items don't display with the <link linkend="hidelostitems">hidelostitems</link> system
30605 preference. </para> <para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
30606 ('LOST' in default installation)</para></entry>
30610 <entry><para>952$2</para></entry>
30612 <entry><para>Classification</para></entry>
30614 <entry><para>Classification scheme that defines filing rules
30615 used for sorting call numbers.</para></entry>
30617 <entry><para>A choice of <link linkend="classificationsources">classification sources</link>
30618 as they are defined in administration. If no classification
30619 scheme is entered, the system will use the value entered in
30620 the <link linkend="DefaultClassificationSource">DefaultClassificationSource</link>
30621 preference.</para></entry>
30625 <entry><para>952$3</para></entry>
30627 <entry><para>Materials specified</para></entry>
30629 <entry><para>Specific issues of serials or multi-part
30630 items.</para></entry>
30632 <entry><para>Displayed when items are checked out and in to
30633 tell the staff how many pieces the item has. Copy/volume data
30634 is stored in 952$h and $t for display in Normal
30635 views.</para></entry>
30639 <entry><para>952$4</para></entry>
30641 <entry><para>Damaged status</para></entry>
30643 <entry><para>Default values: </para> <itemizedlist>
30645 <para>0 = Not damaged</para>
30649 <para>1 = Damaged</para>
30651 </itemizedlist></entry>
30653 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
30654 ('DAMAGE' in default installation)</para></entry>
30658 <entry><para>952$5</para></entry>
30660 <entry><para>Use restrictions</para></entry>
30662 <entry><para>Default values:</para> <itemizedlist>
30664 <para>0 = No use restrictions</para>
30668 <para>1 = Restricted Access</para>
30670 </itemizedlist></entry>
30672 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
30673 ('RESTRICT' in default installation). This value has no effect
30674 on circulation.</para></entry>
30678 <entry><para>952$7</para></entry>
30680 <entry><para>Not for loan</para></entry>
30682 <entry><para>Default values:</para> <itemizedlist>
30684 <para>-1 = Ordered</para>
30688 <para>0 = Available for loans</para>
30692 <para>1 = Not for Loan</para>
30696 <para>2 = Staff Collection</para>
30698 </itemizedlist></entry>
30700 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
30701 ('NOT_LOAN' in default installation). Negative number values
30702 can still be placed on hold.</para></entry>
30706 <entry><para>952$8</para></entry>
30708 <entry><para>Collection code</para></entry>
30710 <entry><para>Coded value</para></entry>
30712 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
30713 ('CCODE' in default installation)</para></entry>
30717 <entry><para>952$9</para></entry>
30719 <entry><para>Item number</para></entry>
30721 <entry><para>System-generated item number.</para></entry>
30723 <entry><para>Does not display in the item
30724 record.</para></entry>
30728 <entry><para>952$a</para></entry>
30730 <entry><para>Owning Library **</para></entry>
30732 <entry><para>Branch code</para></entry>
30734 <entry><para><emphasis role="bold">Required</emphasis>. Code
30735 must be defined in <link linkend="libsgroups">Libraries,
30736 Branches and Groups</link></para></entry>
30740 <entry><para>952$b</para></entry>
30742 <entry><para>Holding library ** (usually the same as 952$a
30745 <entry><para>Branch code</para></entry>
30747 <entry><para><emphasis role="bold">Required</emphasis>. Code
30748 must be defined in <link linkend="libsgroups">Libraries,
30749 Branches and Groups</link></para></entry>
30753 <entry><para>952$c</para></entry>
30755 <entry><para>Shelving location code</para></entry>
30757 <entry><para/></entry>
30759 <entry><para>Coded value, matching <link linkend="authorizedvalues">Authorized Value</link> category
30760 ('LOC' in default installation)</para></entry>
30764 <entry><para>952$d</para></entry>
30766 <entry><para>Date acquired</para></entry>
30768 <entry><para>YYYY-MM-DD</para></entry>
30770 <entry><para>Date formats in the 952 subfields are required to
30771 be in the system internal format for data loading and
30772 subsequent item editing: YYYY-MM-DD</para></entry>
30776 <entry><para>952$e</para></entry>
30778 <entry><para>Source of acquisition</para></entry>
30780 <entry><para>Coded value or vendor string</para></entry>
30782 <entry><para>Filled in automatically with the Koha assigned
30783 vendor id by Acquisitions when an item is
30784 received.</para></entry>
30788 <entry><para>952$g</para></entry>
30790 <entry><para>Purchase price</para></entry>
30792 <entry><para>Decimal number, no currency symbol (ex.
30793 10.00)</para></entry>
30795 <entry><para>Filled in automatically by Acquisitions when an
30796 item is received.</para></entry>
30800 <entry><para>952$h</para></entry>
30802 <entry><para>Serial enumeration</para></entry>
30804 <entry><para/></entry>
30806 <entry><para>Filled in automatically by Serials if the issue
30807 is received there.</para></entry>
30811 <entry><para>952$o</para></entry>
30813 <entry><para>Koha full call number</para></entry>
30815 <entry><para/></entry>
30817 <entry><para>Can be filled in automatically based on the <link linkend="itemcallnumber">itemcallnumber</link> system
30818 preference.</para></entry>
30822 <entry><para>952$p</para></entry>
30824 <entry><para>Barcode *</para></entry>
30826 <entry><para>Max 20 characters</para></entry>
30828 <entry><para/></entry>
30832 <entry><para>952$t</para></entry>
30834 <entry><para>Copy number</para></entry>
30836 <entry><para>Max 32 characters</para></entry>
30838 <entry><para/></entry>
30845 <para>Uniform Resource Identifier </para>
30848 <para>Item specific URL</para>
30851 <para>Full URL starting with http:// Only needed if your item has its own URL, not
30852 necessary if the bib record has a 856$u that applies to all items on the record.
30861 <para>Replacement price</para>
30864 <para>Decimal number, no currency symbol (ex. 10.00)</para>
30867 <para>Filled in automatically by Acquisitions when an item is received.</para>
30872 <entry><para>952$w</para></entry>
30874 <entry><para>Price effective from</para></entry>
30876 <entry><para>YYYY-MM-DD</para></entry>
30878 <entry>Date formats in the 952 subfields are required to be in
30879 the system internal format for data loading and subsequent
30880 item editing: YYYY-MM-DD. Filled in automatically by
30881 Acquisitions when an item is received.</entry>
30888 <para>Nonpublic note</para>
30893 <entry>This is a note field for notes that will not appear in the OPAC. Right now
30894 this note does not appear anywhere but in the item edit screen in the staff
30899 <entry><para>952$y</para></entry>
30901 <entry><para>Koha item type **</para></entry>
30903 <entry><para>Coded value, required field for
30904 circulation</para></entry>
30906 <entry><para><emphasis role="bold">Required</emphasis>. Coded
30907 value, must be defined in <link linkend="itemtypeadmin">Item
30908 types</link></para></entry>
30912 <entry><para>952$z</para></entry>
30914 <entry><para>Public note</para></entry>
30916 <entry><para/></entry>
30918 <entry><para/></entry>
30924 <para>* - required for circulation</para>
30926 <para>** - required by Koha</para>
30929 <section id="onorderitemholds">
30931 <corpauthor>VOKAL</corpauthor>
30934 <firstname>Nicole C.</firstname>
30936 <surname>Engard</surname>
30939 <pubdate>2010</pubdate>
30941 <bibliosource><ulink url="http://docs.google.com/View?id=dcccx9zm_3htvhwzgc#Handling_On_Order_items_and_ho">http://docs.google.com/View?id=dcccx9zm_3htvhwzgc#Handling_On_Order_items_and_ho</ulink></bibliosource>
30944 <title>Handling On Order Items and Holds</title>
30946 <para>If you tend to import your MARC records when you have ordered
30947 the book (as opposed to when you receive the books), and allow patrons
30948 to place holds on those books, you may need to add item records to the
30949 *.mrc file before importing.</para>
30951 <para>The easiest way to import your latest order is to first run your records through
30952 <ulink url="http://marcedit.reeset.net/">MARCEdit</ulink>. Download your MARC records,
30953 saving them to your desktop or some other location you use/will remember. If you have
30954 MARCEdit already installed you should simply have to double click on your MARC records,
30955 and they will automatically open in MARCEdit.<important>
30956 <para>This tutorial was written with MARCEdit version 5.2.3769.41641 on Windows XP,
30957 instructions may be different if your version or operating system is different.</para>
30958 </important></para>
30962 <para>Your original file will automatically be in the input;
30963 ensure MarcBreaker is chosen, and then click "Execute"</para>
30966 <screeninfo>MarcBreaker</screeninfo>
30970 <imagedata fileref="images/appendix-onorder/marcbreaker.png"/>
30977 <para>You will be presented with a summary of the records
30978 processed at the bottom of the screen</para>
30981 <screeninfo>MarcBreaker Summary</screeninfo>
30985 <imagedata fileref="images/appendix-onorder/marcbreaker-summary.png"/>
30992 <para>Click 'Edit Records' to continue on to adding item
30997 <para>Your screen will be replaced with a larger screen containing
30998 the MARC records</para>
31001 <screeninfo>MARC file for editing</screeninfo>
31005 <imagedata fileref="images/appendix-onorder/editrecords.png"/>
31012 <para>Click on Tools > Add/Edit Field</para>
31015 <screeninfo>Add/Delete Field</screeninfo>
31019 <imagedata fileref="images/appendix-onorder/addfield.png"/>
31026 <para>Enter in the Koha specific item info</para>
31029 <screeninfo>Add 942 Field</screeninfo>
31033 <imagedata fileref="images/appendix-onorder/add942.png"/>
31040 <para>In the Field box, type 942</para>
31044 <para>In the Field Data box, type \\$c and the item type code
31045 (\\$cBOOK in this example)</para>
31049 <para>Check the 'Insert last' option</para>
31053 <para>Click 'Add Field'</para>
31059 <para>Enter in the item record data</para>
31062 <screeninfo>Add 952 Field</screeninfo>
31066 <imagedata fileref="images/appendix-onorder/add952.png"/>
31073 <para>In the Field box, type 952</para>
31077 <para>In the Field Data box, type
31078 $7ORDERED_STATUS$aPERM_LOC$bCURR_LOC$cSHELVING_LOCATION$eSOURCE_OF_ACQ$yITEM_TYPE</para>
31082 <para>ex. $7-1$aCPL$bCPL$cNEW$eBrodart$yBOOK</para>
31086 <para>In a default install of Koha -1 is the value for
31087 the Ordered status</para>
31093 <para>You may want to look at other subfields you would
31094 like data in -- for example, changing the collection code
31095 to put all the items in the same collection (8),
31096 automatically fill in the acquisition date (d), or put in
31097 a public note (z).</para>
31101 <para>Be sure you use the $ to separate subfields; adding
31102 each subfield on a separate line will cause that many
31103 items to be imported with your MARC record (in the example
31104 above, four items, each with one of those subfields
31109 <para>Make sure you look at the Administration >
31110 Authorized Values in Koha to put the correct code into the
31117 <para>Check the 'Insert last' option</para>
31121 <para>Click 'Add Field'</para>
31127 <para>Close the field editor window</para>
31131 <para>Click on File > Compile into MARC</para>
31134 <screeninfo>Compile into MARC</screeninfo>
31138 <imagedata fileref="images/appendix-onorder/compile.png"/>
31145 <para>Choose where to save your file</para>
31149 <para>Now you want to go into your Koha system and follow the
31150 instructions for <link linkend="stagemarc">importing MARC
31151 records</link>.</para>
31153 <para>Once the item has come in, you will need to go to the item
31154 record and individually change the item to have the correct barcode,
31155 and manually change the status from Ordered to the blank line in the
31156 Not for Loan field.</para>
31159 <para>If you purchase your cataloged item records, you may want to
31160 request your vendor put in the information you need into the MARC
31161 records for you; that way, you could import the edited-by-the-vendor
31162 file, overwriting the current record, automatically replacing the
31163 data with what you need.</para>
31168 <chapter id="coursereserves">
31169 <title>Course Reserves</title>
31170 <para>The course reserves module in Koha allows you to temporarily move items to 'reserve' and
31171 assign different circulation rules to these items while they are being used for a specific
31173 <section id="coursesetup">
31174 <title>Course Reserves Setup</title>
31175 <para>Before using Course Reserves you will need to do some set up. </para>
31176 <para>First you will need to enable course reserves by setting the <link
31177 linkend="UseCourseReserves">UseCourseReserves</link> preference to 'Use'.</para>
31178 <para>Next you will need to have all of your course instructors <link linkend="addnewpatron"
31179 >added as patrons</link>.</para>
31180 <para>Next you will want to add a couple of new <link linkend="newauthval">authorized
31181 values</link> for Departments and Terms. </para>
31182 <para>You may also want to create new <link linkend="additemtype">item types</link>, <link
31183 linkend="ccode">collection codes</link> and/or <link linkend="shelvelocvals">shelving
31184 locations</link> to make it clear that the items are on reserve to your patrons. You will
31185 also want to be sure to confirm that your <link linkend="circfinerules">circulation and fine
31186 rules</link> are right for your new item types (whether they be hourly or daily
31189 <section id="addingcourses">
31190 <title>Adding Courses</title>
31191 <para>Once you have completed your set up for Course Reserves you can start creating courses
31192 and adding titles to the reserve list.</para>
31194 <screeninfo>Course Reserves Admin</screeninfo>
31197 <imagedata fileref="images/coursereserves/coursesblank.png"/>
31201 <para>From the main course reserves page you can add a new course by clicking the 'New course'
31202 button at the top left.</para>
31204 <screeninfo>Add a new course</screeninfo>
31207 <imagedata fileref="images/coursereserves/newcourse.png"/>
31211 <para>Your new course will need a Department, Number and Name at the bare minimum. You can
31212 also add in additional details like course section number and term. To link an instructor to
31213 this course simply start typing their name and Koha will search your patron database to find
31214 you the right person.</para>
31216 <screeninfo>Instrcutor search</screeninfo>
31219 <imagedata fileref="images/coursereserves/instructorsearch.png"/>
31223 <para>Once the instructor you want appears just click their name and they will be added. You
31224 can repeat this for all instructors on this course. Each instructor will appear above the
31225 search box and can be removed by clicking the 'Remove' link to the right of their name.</para>
31227 <screeninfo>Instructors</screeninfo>
31230 <imagedata fileref="images/coursereserves/instructorremove.png"/>
31234 <para>If you would like your course to show publicly you'll want to be sure to check the
31235 'Enabled?' box before saving your new course.</para>
31236 <para>Once your course is saved it will show on the main course reserves page and be
31237 searchable by any field in the course.</para>
31239 <screeninfo>Courses</screeninfo>
31242 <imagedata fileref="images/coursereserves/courses.png"/>
31247 <section id="addreserves">
31248 <title>Adding Reserve Materials </title>
31249 <para>Before adding reserve materials you will need at least one course to add them to. To
31250 add materials visit the Course Reserves module.</para>
31252 <screeninfo>Courses</screeninfo>
31255 <imagedata fileref="images/coursereserves/courses.png"/>
31259 <para>Click on the title of the course you would like to add materials to.</para>
31261 <screeninfo>Course administration</screeninfo>
31264 <imagedata fileref="images/coursereserves/courseadmin.png"/>
31268 <para>At the top of the course description click the 'Add reserves' button to add titles to
31269 this reserve list. You will be asked to enter the barcode for the reserve item.</para>
31271 <screeninfo>Add item to reserve</screeninfo>
31274 <imagedata fileref="images/coursereserves/addbarcode.png"/>
31278 <para>After you are done scanning the barcodes to add to the course you can see them on the
31281 <screeninfo>Course with reserves</screeninfo>
31284 <imagedata fileref="images/coursereserves/coursewithreserves.png"/>
31289 <section id="opaccoursereserves">
31290 <title>Course Reserves in the OPAC</title>
31291 <para>Once you have enabled Course Reserves and added courses you will see a link to Course
31292 Reserves below your search box in the OPAC.</para>
31294 <screeninfo>Course Reserves Link</screeninfo>
31297 <imagedata fileref="images/coursereserves/courselinkopac.png"/>
31301 <para>Clicking that link will show you your list of enabled courses (if you have only one
31302 course you will just see the contents of that one course).</para>
31304 <screeninfo>Course list in the OPAC</screeninfo>
31307 <imagedata fileref="images/coursereserves/coursesopac.png"/>
31311 <para>You can search course reserves by any field (course number, course name, instructor
31312 name, department) that is visbile in the list of courses. Clicking a course name will show
31313 you the details and reserve items.</para>
31315 <screeninfo>Course listing</screeninfo>
31318 <imagedata fileref="images/coursereserves/courseopac.png"/>
31325 <chapter id="serials">
31326 <title>Serials</title>
31328 <para>Serials actions can be accessed by going to the More menu at the top
31329 of your screen and choosing Serials or by clicking Serials on the main
31330 Koha staff client page. The Serials module in Koha is used for keeping
31331 track of journals, newspapers and other items that come on a regular
31332 schedule. As with all modules, make sure you go through the related <link linkend="impserials">Implementation Checklist</link> before using the
31333 Serials module.</para>
31337 <para><emphasis>Get there:</emphasis> More > Serials</para>
31340 <section id="serialfreq">
31341 <title>Manage Serial Frequencies</title>
31342 <para>Koha keeps a record of publication frequencies for easy management and
31343 duplication.</para>
31346 <para><emphasis>Get there:</emphasis> More > Serials > Manage frequencies</para>
31349 <para>From this page you can view all of the existing frequencies in your system</para>
31351 <screeninfo>Frequencies</screeninfo>
31354 <imagedata fileref="images/serials/frequencies.png"/>
31358 <para>and create new ones.</para>
31360 <screeninfo>New frequency</screeninfo>
31363 <imagedata fileref="images/serials/newfrequency.png"/>
31368 <section id="serialpatterns">
31369 <title>Manage Serial Numbering Patterns</title>
31370 <para>Everytime you create a new numbering pattern in serials you can save it for later use.
31371 These patters are accessible via the Manage numbering patterns page.</para>
31374 <para><emphasis>Get there:</emphasis> More > Serials > Manage numbering patterns</para>
31377 <para>This page will list for you the numbering patterns you have saved in the past as well as
31378 a few canned patterns.</para>
31380 <screeninfo>Number patterns</screeninfo>
31383 <imagedata fileref="images/serials/numpatterns.png"/>
31388 <para>If you have upgraded from a previous version of Koha you will see 'Backup patterns'
31389 listed for patterns used in version before Koha 3.14. This is how Koha saved your old
31390 numbering patterns. You can edit these to give them more meaningful names from
31392 </tip>It will also allow you to create a new numbering pattern without first adding a
31393 subscription. To add new new pattern click 'New numbering pattern' at the top of the list of
31396 <screeninfo>New number pattern</screeninfo>
31399 <imagedata fileref="images/serials/newnumpattern.png"/>
31405 <section id="newsubscription">
31406 <title>Add a subscription</title>
31408 <para>Subscriptions can be added by clicking the 'New' button on any
31409 bibliographic record</para>
31412 <screeninfo>New Subscription Button</screeninfo>
31416 <imagedata fileref="images/serials/newsubfrombib.png"/>
31421 <para>Or by visiting the Serials module and clicking 'New
31422 Subscription'</para>
31425 <screeninfo>New Subscription Button</screeninfo>
31429 <imagedata fileref="images/serials/newsubbutton.png"/>
31434 <para>If you are entering a new subscription from the Serials module you
31435 will be presented with a blank form (if creating new from a
31436 bibliographic record the form will include the bib info).</para>
31439 <screeninfo>Add a new subscription (1/2)</screeninfo>
31443 <imagedata fileref="images/serials/addsub.png"/>
31450 <para>'Librarian' field will show the logged in librarian's
31455 <para>'Vendor' can be found by either searching vendors entered via
31456 the <link linkend="acqmodule">Acquisitions module</link> or entering
31457 the vendor ID number</para>
31461 <para>Vendor information is not required</para>
31465 <para>In order to claim missing and late issues you need to
31466 enter vendor information</para>
31469 <screeninfo>Vendor Missing Warning</screeninfo>
31473 <imagedata fileref="images/serials/vendorwarning.png"/>
31482 <para>'Biblio' is the MARC record you'd like to link this
31483 subscription to</para>
31487 <para>This can be done by searching for an existing record by
31488 clicking on the 'Search for Biblio' link below the boxes or by
31489 entering the bib number for a record in the first box. Only if
31490 you search with the field between the parenthesis.</para>
31496 <para>Next you can choose whether a new item is created when receiving an issue (if you
31497 barcode issues you'll want to create an item at this time)</para>
31500 <para>In order to determine how to handle irregularities in your subscription answer 'When
31501 there is an irregular issue', if the numbers are always sequential you'll want to pick
31502 'Keep issue number'</para>
31505 <para>Checking the 'Manual history' box will allow you to enter serials outside the
31506 prediction pattern once the subscription is saved by going to the 'Planning' tab on the
31507 subscription detail page.<screenshot>
31508 <screeninfo>Manual History</screeninfo>
31511 <imagedata fileref="images/serials/manualhistory.png"/>
31514 </screenshot></para>
31517 <para>'Call Number' is for your item's call number or call number prefix</para>
31520 <para>'Library' is the branch that owns this subscription.</para>
31523 <para>If more than one library subscribes to this serial you will need to create a
31524 subscription for each library</para>
31527 <para>This can be done easily by using the 'Edit as New (Duplicate)' option found on
31528 the subscription information page and changing only the 'Library' field</para>
31530 <screeninfo>New Duplicate Subscription</screeninfo>
31533 <imagedata fileref="images/serials/newasdup.png"/>
31541 <para>Use the 'Public Note' for any notes you would like to appear in the OPAC for the
31545 <para>'Nonpublic Note' should be used for notes that are only visible to the librarians
31546 via the staff client</para>
31549 <para>The 'Patron notification' option lets you pick a notice to send to patrons who
31550 subscribe to updates on this serial via the OPAC.</para>
31553 <para>For this option to appear you need to make sure that you have a Routing List
31554 notice set up in the <link linkend="notices">Notices Tool</link></para>
31560 <para>'Location' is for the shelving location</para>
31564 <para>The 'Grace period' is the number of days before an issue is automatically moved from
31565 'Expected' status to 'Waiting' and how many days before an issue is automatically moved
31566 from 'Waiting' status to 'Late'</para>
31570 <para>The Staff and OPAC Display options allow you to control how
31571 many issues appear by default on bibliographic records in the Staff
31572 Client and the OPAC</para>
31576 <para>If no values are entered in these fields, they will use
31577 the <link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
31578 and <link linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
31579 system preference values</para>
31584 <para>Once that data is filled in you can click 'Next' to enter the prediction pattern information.</para>
31586 <screeninfo>Add a new subscription (2/2)</screeninfo>
31589 <imagedata fileref="images/serials/addsub2.png"/>
31595 <para>In 'First issue publication date' you want to enter the date
31596 of the issue you have in your hand, the date from which the
31597 prediction pattern will start</para>
31601 <para>There are several pre-defined options for the 'Frequency' of publication all of
31602 which are visible alongside your own custom frequencies by visiting '<link
31603 linkend="serialfreq">Manage frequencies</link>'</para>
31607 <para>Without periodicy: some very specific (usually high level
31608 science journals) don't have a true periodicity. When you
31609 subscribe to the title, you subscribe for 6 issues, which can
31610 arrive in 1 year... or 2... There is no regularity or known
31615 <para>Unknown select this if none of the other choices are
31620 <para>Irregular: The journal is not "regular" but has a
31621 periodicity. You know that it comes out on January, then in
31622 October and December, it is irregular, but you know when it's
31623 going to arrive.</para>
31627 <para>2/day: Twice daily</para>
31631 <para>1/day: Daily</para>
31635 <para>3/week: Three times a week</para>
31639 <para>1/week: Weekly</para>
31643 <para>1/ 2 weeks: Twice monthly (fortnightly)</para>
31647 <para>1/ 3 weeks: Tri-weekly</para>
31651 <para>1/month: Monthly</para>
31655 <para>1/ 2 months (6/year): Bi-monthly</para>
31659 <para>1/ 3 months (1/quarter): Quarterly</para>
31663 <para>1/quarter (seasonal) : Quarterly related to seasons (ie.
31664 Summer, Autumn, Winter, Spring)</para>
31668 <para>2/year: Half yearly</para>
31672 <para>1/year: Annual</para>
31676 <para>1/ 2 years: Bi-annual</para>
31681 <para>'Subscription length' is the number of issues or months in the subscription. This is
31682 also used for setting up renewal alerts</para>
31685 <para>'Subscription start date' is the date at which the subscription begins. This is used
31686 for setting up renewal alerts</para>
31689 <para>'Subscription end date' should only be entered for subscriptions that have ended (if
31690 you're entering in a backlog of serials)</para>
31694 <para>'Numbering pattern' will help you determine how the numbers are printed for each
31695 issue. Patterns entered here are saved and editable at any time by visiting '<link
31696 linkend="serialpatterns">Manage numbering patterns</link>'</para>
31700 <para>Start with the numbering on the issue you have in hand,
31701 the numbering that matches the date you entered in the 'First
31702 issue publication' field</para>
31706 <para>You can choose to create your own numbering pattern by choosing 'None of the
31707 above' and clicking the 'Show/Hide Advanced Pattern' button at the bottom of the form</para>
31709 <screeninfo>Advanced prediction pattern</screeninfo>
31712 <imagedata fileref="images/serials/advancedpattern.png"/>
31720 <para>The 'Locale' option is useful when you want to display days, month or season. For
31721 example, if you have a German serial, you can use the German locale option to display
31722 days, etc. in German.</para>
31726 <para>Once a 'Numbering pattern' is chosen the number formula will appear.<screenshot>
31727 <screeninfo>Numbering Forumla</screeninfo>
31730 <imagedata fileref="images/serials/numberonly.png"/>
31733 </screenshot><itemizedlist>
31735 <para>The 'Begins with' number is the number of the issue you're holding in your
31739 <para>The 'Inner counter' is used to tell Koha where the "receiving cycle" starts<itemizedlist>
31741 <para>For example: If the first issue to receive is "vol. 4, no. 1, iss. 796",
31742 you need to set up "inner counter = 0" But if it's "vol. 4, no. 2, iss.
31743 797", the inner counter should be "1".</para>
31745 </itemizedlist></para>
31748 <para>After filling in this data click the 'Test prediction pattern' button to see
31749 what issues the system will generate, if there are irregularities you can choose
31750 which issues don't exist from the list presented.</para>
31752 <screeninfo>Prediction pattern</screeninfo>
31755 <imagedata fileref="images/serials/predictionpattern.png"/>
31760 </itemizedlist></para>
31764 <para>Click 'Save Subscription' to save the information you have
31765 entered. <link linkend="sampleserialsapp">Find sample serial examples in
31766 the appendix</link>.</para>
31769 <section id="receiveissues">
31770 <title>Receive Issues</title>
31772 <para>Issues can be marked as received from several locations. To find a
31773 subscription, use the search box at the top of the Serials page to
31774 search for the serial you'd like to receive issues for:</para>
31777 <screeninfo>Subscription Search</screeninfo>
31781 <imagedata fileref="images/serials/subsearch.png"/>
31786 <para>From the search results you can click the 'Serial Receive' link or
31787 you can click on the subscription title and then click the 'Receive'
31791 <screeninfo>Subscription Buttons</screeninfo>
31795 <imagedata fileref="images/serials/subbuttons.png"/>
31800 <para>The final way to receive serials is from the 'Serial Collection'
31801 page. To the left of the Subscription summary page there is a menu with
31802 a link to 'Serial Collection'</para>
31805 <screeninfo>Serial Subscription Menu</screeninfo>
31809 <imagedata fileref="images/serials/serialcolllink.png"/>
31814 <para>From the page that opens up you can click 'Edit Serial' with the
31815 issue you want to receive checked.</para>
31818 <screeninfo>Edit Issues</screeninfo>
31822 <imagedata fileref="images/serials/editissue.png"/>
31827 <para>All three of these options will open up the issue receive
31831 <screeninfo>Receive Serials</screeninfo>
31835 <imagedata fileref="images/serials/receiveissue.png"/>
31842 <para>Choose 'Arrived' from the status pull down to mark a serial as
31847 <para>If you have decided to have an item record created for each issue an <link linkend="addingitems">item add form</link>
31848 will appear after choosing 'Arrived'</para>
31850 <screeninfo>Serial item record</screeninfo>
31853 <imagedata fileref="images/serials/serialitem.png"/>
31860 <para>If your issue has a supplemental issue with it, fill in the
31861 Supplemental Issue information.</para>
31865 <para>If you have decided to have an item record created for each
31866 issue an <link linkend="addingitems">item add form</link> will
31867 appear for your supplement and for the issue itself</para>
31871 <para>Once you have entered your info you can click 'Save'</para>
31875 <para>If you are receiving multiple issues at once, or have marked an
31876 issue as 'Late' or 'Missing' there you can click the 'Generate Next'
31877 button below the list of issues.</para>
31880 <screeninfo>Generate Next Button</screeninfo>
31884 <imagedata fileref="images/serials/editissue.png"/>
31889 <para>Clicking this button will generate the next issue for you and mark
31890 the previously expected issue as 'Late' automatically. You can then
31891 check the 'Edit' box to the right of each issue and edit the status on
31892 multiple issues at once.</para>
31895 <section id="routinglist">
31896 <title>Create a Routing List</title>
31898 <para>A routing list is a list of people who receive the serial before it goes to the shelf.
31899 To enable routing lists you want to set your <link linkend="RoutingSerials"
31900 >RoutingSerials</link> preference to 'Add'.</para>
31902 <para>When on the subscription page you will see a link to the left that
31903 reads 'Create Routing List' or 'Edit Routing List'</para>
31906 <screeninfo>Subscription Routing List Link</screeninfo>
31910 <imagedata fileref="images/serials/createroutinglink.png"/>
31915 <para>Clicking that link will bring you to the menu to add a new routing
31919 <screeninfo>Routing List Creation</screeninfo>
31923 <imagedata fileref="images/serials/createroutinglist.png"/>
31928 <para>From here you want to click 'Add recipients' in order to add
31929 people to the routing list. In the menu that appears you can filter
31930 patrons by part of their name, their library and/or patron
31934 <screeninfo>Add Members to Routing List</screeninfo>
31938 <imagedata fileref="images/serials/addtorouting.png"/>
31943 <para>Clicking 'Add' to the right of each name will add them to the
31944 routing list. When you have chosen all of the people for the list, click
31945 the 'Close' link to be redirected to the routing list.</para>
31948 <screeninfo>Routing List</screeninfo>
31952 <imagedata fileref="images/serials/editroutinglist.png"/>
31957 <para>If the list looks the way you expect it to, then click 'Save'.
31958 Next you will be brought to a preview of the routing list. To print the
31959 list click 'Save and preview routing slip.' This will open a printable
31960 version of the list.</para>
31963 <screeninfo>Preview Routing List</screeninfo>
31967 <imagedata fileref="images/serials/previewroutinglist.png"/>
31972 <para>If <link linkend="RoutingListAddReserves">RoutingListAddReserves</link> is set to
31973 on then patrons listed in the routing list will automatically be added
31974 to the holds list for the issue.</para>
31976 <para>To see a list of all of the routing lists a specific patron is on visit the <link
31977 linkend="patronroutingtab">Routing Lists tab</link> on their patron record.</para>
31980 <section id="serialsubinstaff">
31981 <title>Subscriptions in Staff Client</title>
31983 <para>Subscription information will appear on bibliographic records
31984 under the 'Subscriptions' tab</para>
31987 <screeninfo>Subscription Tab on Bibliographic Record</screeninfo>
31991 <imagedata fileref="images/serials/subinfoonbib.png"/>
31996 <para>Clicking the 'Subscription Details' link will take you to the
31997 Subscription summary page in the staff client.</para>
32000 <screeninfo>Subscription Detail</screeninfo>
32004 <imagedata fileref="images/serials/subscriptiondetail.png"/>
32008 <para>If you are using the <link linkend="acqmodule">Acquisitions</link> module to keep <link
32009 linkend="ordersubscription">track of serial subscriptions</link> you will see that info
32010 before your subscription details.</para>
32012 <screeninfo>Acquisitions information for subscription</screeninfo>
32015 <imagedata fileref="images/acquisitions/subdetails.png"/>
32021 <section id="serialsubinopac">
32022 <title>Subscriptions in OPAC</title>
32024 <para>When viewing the subscription in the OPAC there will be several
32027 <para>Like in the staff client, there will be a Subscriptions tab on the
32028 bibliographic record.</para>
32031 <screeninfo>Subscriptions Tab in OPAC</screeninfo>
32035 <imagedata fileref="images/serials/subopac.png"/>
32040 <para>Under this tab will appear the number of issues you chose when
32041 setting up the subscription or in your <link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
32042 system preference. Clicking the 'More details' link will provide you
32043 with additional information about the serial history. You can set the
32044 default view of a serial in the OPAC with the <link linkend="SubscriptionHistory">SubscriptionHistory</link> system
32047 <para>There are two views, compact and full. The compact serial
32048 subscription will show basic information regarding the
32049 subscription</para>
32052 <screeninfo>Compact Serial View</screeninfo>
32056 <imagedata fileref="images/serials/compactopac.png"/>
32061 <para>From this compact display patrons can subscribe to be notified of new issues as they are
32062 released by clicking the 'Subscribe to email notifications of new issues' button. For this
32063 link to appear you will want to have chosen to notify patrons <link
32064 linkend="newsubscription">on the subscription</link> itself.</para>
32067 <screeninfo>Subscribe link in the OPAC</screeninfo>
32071 <imagedata fileref="images/serials/opacroutingsubscribe.png"/>
32075 <para>You can see thos who subscribe to new issue alerts by going to the subscription page in
32076 the staff client and looking on the right of the 'Information' tab.<screenshot>
32077 <screeninfo>Serial notification subscribers</screeninfo>
32080 <imagedata fileref="images/serials/subscribers.png"/>
32083 </screenshot></para>
32085 <para>Whereas the full view shows extensive details, broken out by year,
32086 regarding the subscription</para>
32089 <screeninfo>Full Serial View</screeninfo>
32093 <imagedata fileref="images/serials/fullopac.png"/>
32099 <section id="serialclaims">
32100 <title>Claim Late Serials</title>
32102 <para>Koha can send email messages to your serial vendors if you have
32103 late issues. To the left of the main serials page there is a link to
32107 <screeninfo>Link to Claims on Serials Menu</screeninfo>
32111 <imagedata fileref="images/serials/serialclaimmenu.png"/>
32116 <para>The links to claims also appears to the left of the subscription
32120 <screeninfo>Link to Claims on the Serials Menu</screeninfo>
32124 <imagedata fileref="images/serials/serialclaimmenu1.png"/>
32129 <para>If you don't have a claim notice defined yet you will see a
32130 warning message that you need to first define a notice.</para>
32133 <screeninfo>Missing Claims Notice Warning</screeninfo>
32137 <imagedata fileref="images/serials/noserialclaim.png"/>
32142 <para>Clicking 'Claims' will open a report that will ask you to choose
32143 from your various serial vendors to generate claims for late
32147 <screeninfo>Serial Claims</screeninfo>
32151 <imagedata fileref="images/serials/serialclaims.png"/>
32156 <para>From the list of late issues you can choose which ones you want to
32157 send a claim email to by clicking the checkbox to the left of late
32158 issue, choosing the notice template to use and clicking the 'Send
32159 notification' button.</para>
32162 <section id="serialexpiration">
32163 <title>Check Serial Expiration</title>
32165 <para>When adding serials you enter a subscription length, using the
32166 check expiration tool you can see when your subscriptions are about to
32167 expire. To use the tool click the link to 'Check expiration' on the
32168 serials menu.</para>
32171 <screeninfo>Check Serial Expiration</screeninfo>
32175 <imagedata fileref="images/serials/serialexpiresearch.png"/>
32180 <para>In the form that appears you need to enter at least a date to
32183 <para>In your results you will see all subscriptions that will expire
32184 before the date you entered. From there you can choose to view the
32185 subscription further or renew it in one click.</para>
32188 <screeninfo>Serial Expiration Search Results</screeninfo>
32192 <imagedata fileref="images/serials/serialexpire.png"/>
32198 <section id="serialrenew">
32199 <title>Renewing Serials</title>
32201 <para>If your serial subscription has expired you won't be able to
32202 receive issues. To renew your subscription you can click the 'Renew'
32203 button at the top of your subscription detail page.</para>
32206 <screeninfo>Renew option on subscription detail</screeninfo>
32210 <imagedata fileref="images/serials/renewsubscription.png"/>
32215 <para>Another option is to click the 'Renew' link to the right of the
32216 subscription on the Serial Collection page.</para>
32219 <screeninfo>Renew option on serial collection</screeninfo>
32223 <imagedata fileref="images/serials/collectionrenew.png"/>
32228 <para>Once you click the 'Renew' link or button you will be presenting
32229 with renewal options.</para>
32232 <screeninfo>Subscription renewal form</screeninfo>
32236 <imagedata fileref="images/serials/serialrenew.png"/>
32243 <para>The start date should be the date your subscription period
32248 <para>For the subscription length you'll want to fill in one of the
32249 three fields presented: Number of num (issues), Number of months or
32250 Number of weeks.</para>
32254 <para>Finally enter any notes you might have about this
32260 <section id="serialsearch">
32261 <title>Searching Serials</title>
32263 <para>Once in the Serials module there is basic search box at the top
32264 that you can use to find subscriptions using any part of the ISSN and/or
32268 <screeninfo>Basic Serials Search</screeninfo>
32272 <imagedata fileref="images/serials/serialsearch.png"/>
32277 <para>You can also click the 'Advanced Search' link to the right of the
32278 'Submit' button to do a more thorough search of your serials.</para>
32281 <screeninfo>Advanced Serials Search</screeninfo>
32285 <imagedata fileref="images/serials/advanceserialsearch.png"/>
32290 <para>From your results you can filter by using the search boxes at the
32291 bottom of each column and adjust the number of resutls using the toolbar
32292 at the top of the results set.</para>
32295 <screeninfo>Serial Search Results</screeninfo>
32299 <imagedata fileref="images/serials/serialsearchresults.png"/>
32306 <chapter id="acqmodule">
32307 <title>Acquisitions</title>
32309 <para>The Koha Acquisitions module provides a way for the library to
32310 record orders placed with vendors and manage purchase budgets.</para>
32314 <para><emphasis>Get there:</emphasis> More > Acquisitions</para>
32318 <section id="acqsetup">
32319 <title>Setup</title>
32321 <para>Before using the Acquisitions Module you will want to make sure
32322 that you have completed all of the set up.</para>
32324 <para>First, set your <link linkend="acqprefs">Acquisitions System
32325 Preferences</link> and <link linkend="acqadmin">Acquisitions
32326 Administration</link> to match your library's workflow.</para>
32328 <para>On the main acquisitions page you will see your library's funds
32332 <screeninfo>Acquisitions Funds Summary</screeninfo>
32336 <imagedata fileref="images/acquisitions/acqfunds.png"/>
32342 <para>If the total line is confusing for the funds you have set up
32343 you can hide it by adding <programlisting>#funds_total {display:none;}</programlisting></para>
32345 <para>to the <link linkend="IntranetUserCSS">IntranetUserCSS</link>
32349 <para>To see all active funds you can click the checkbox next to 'Show active and inactive'
32350 above the funds table.</para>
32352 <para>To see a history of all orders in a fund you can click on the
32353 linked amount and it will run a search for you.</para>
32356 <screeninfo>Breakdown of orders against the FIC Fund</screeninfo>
32360 <imagedata fileref="images/acquisitions/fundbreakdown.png"/>
32365 <para>Learn more in the <link linkend="fundtracking">Budget/Fund
32366 Tracking</link> section of this manual.</para>
32369 <section id="acqvendors">
32370 <title>Vendors</title>
32372 <para>Before any orders can be places you must first enter at least one
32375 <section id="addacqvendor">
32376 <title>Add a Vendor</title>
32378 <para>To add a vendor click the 'New Vendor' button on the
32379 Acquisitions page</para>
32382 <screeninfo>New Vendor Button on Acquisitions</screeninfo>
32386 <imagedata fileref="images/acquisitions/newvendbutton.png"/>
32391 <para>The vendor add form is broken into three pieces</para>
32395 <para>The first section is for basic information about the
32399 <screeninfo>Basic Vendor Information</screeninfo>
32403 <imagedata fileref="images/acquisitions/newvendor1.png"/>
32410 <para>Of these fields, only the Vendor name is required, the
32411 rest of the information should be added to help with
32412 generating claim letters and invoices</para>
32418 <para>The second section is for information regarding your contact
32419 at the Vendor's office</para>
32422 <screeninfo>Vendor Contact Details</screeninfo>
32426 <imagedata fileref="images/acquisitions/newvendor2.png"/>
32433 <para>None of these fields are required, they should only be
32434 entered if you want to keep track of your contact's
32435 information within Koha</para>
32441 <para>The final section is for billing information</para>
32444 <screeninfo>Vendor Ordering/Billing Information</screeninfo>
32448 <imagedata fileref="images/acquisitions/newvendor3.png"/>
32455 <para>To be able to order from a vendor you must make them
32460 <para>For List Prices and Invoice Prices choose the
32465 <para>Currencies are assigned in the <link linkend="currexchangeadmin">Currencies & Exchange
32466 Rates</link> admin area</para>
32472 <para>If your library is charged tax mark your Tax Number as
32477 <para>Note if you list prices and/or invoice prices include
32482 <para>If the vendor offers a consistent blank discount, enter
32483 that in the 'Discount' field</para>
32487 <para>You can enter item specific discounts when placing
32494 <para>Enter your tax rate if your library is charged taxes on
32499 <para>If you know about how long it usually takes orders to
32500 arrive from this vendor you can enter a delivery time. This
32501 will allow Koha to estimate when orders will arrive at your
32502 library on the late orders report.</para>
32506 <para>Notes are for internal use</para>
32513 <section id="editacqvendor">
32514 <title>View/Edit a Vendor</title>
32516 <para>To view a vendor's information page you must search for the
32517 vendor from the Acquisitions home page. Your search can be for any
32518 part of the Vendor's name:</para>
32521 <screeninfo>Vendor Search Results</screeninfo>
32525 <imagedata fileref="images/acquisitions/vendorsearch.png"/>
32530 <para>From the results, click on the name of the vendor you want to
32531 view or edit</para>
32534 <screeninfo>Vendor Information Page</screeninfo>
32538 <imagedata fileref="images/acquisitions/vendorpage.png"/>
32543 <para>To make changes to the vendor, simply click the 'Edit vendor' button.</para>
32545 <para>If the vendor has no baskets attached to it then a 'Delete vendor' button will also be
32546 visible and the vendor can be deleted. Otherwise you will see a 'Receive shipment'
32550 <screeninfo>Receive shipment button</screeninfo>
32554 <imagedata fileref="images/acquisitions/receivebutton.png"/>
32560 <section id="vendorcontracts">
32561 <title>Vendor Contracts</title>
32563 <para>You can define contracts (with a start and end date) and attach
32564 them to a vendor. This is used so that at the end of the year you can
32565 see how much you spent on a specific contract with a vendor. In some
32566 places, contracts are set up with a minimum and maximum yearly
32569 <section id="addvendorcontract">
32570 <title>Add a Contract</title>
32572 <para>At the top of a Vendor Information Page, you will see a 'New
32573 Contract' button.</para>
32576 <screeninfo>New Contract Button</screeninfo>
32580 <imagedata fileref="images/acquisitions/newcontract.png"/>
32585 <para>The contract form will ask for some very basic information
32586 about the contract</para>
32589 <screeninfo>New Contract Form</screeninfo>
32593 <imagedata fileref="images/acquisitions/newcontractform.png"/>
32599 <para>You cannot enter a contract retrospectively. The end date
32600 must not be before today's date.</para>
32603 <para>Once the contract is saved it will appear below the vendor
32604 information.</para>
32607 <screeninfo>Vendor with contracts</screeninfo>
32611 <imagedata fileref="images/acquisitions/contractdisplay.png"/>
32616 <para>It will also be an option when creating a basket</para>
32619 <screeninfo>Contract Pull Down on New Basket Form</screeninfo>
32623 <imagedata fileref="images/acquisitions/contractonbasket.png"/>
32631 <section id="managesuggest">
32632 <title>Managing Suggestions</title>
32634 <para>Depending on your settings in the <link linkend="suggestionspref">suggestion</link> system preference, patrons
32635 may be able to make purchase suggestions via the OPAC. When a suggestion
32636 is waiting for library review, it will appear on the Acquisitions home
32637 page under the vendor search.</para>
32640 <screeninfo>Pending suggestions on Acquisitions</screeninfo>
32644 <imagedata fileref="images/acquisitions/suggestonacq.png"/>
32649 <para>It will also appear on the main staff dashboard under the module
32653 <screeninfo>Pending suggestions on main page</screeninfo>
32657 <imagedata fileref="images/acquisitions/pendingsuggestions.png"/>
32662 <para>Clicking 'Manage suggestions' will take you to the suggestion
32663 management tool. If there are no pending suggestions you can access the
32664 suggestion management tool by clicking the 'Manage suggestions' link on
32665 the menu on the left of the Acquisitions page.</para>
32668 <screeninfo>Suggestion Management</screeninfo>
32672 <imagedata fileref="images/acquisitions/suggestmanage.png"/>
32677 <para>Your suggestions will be sorted into several tabs: Accepted,
32678 Pending, Checked, Ordered and/or Rejected. Each accepted or rejected
32679 suggestion will show the name of the librarian who managed the
32680 suggestion and the reason they gave for accepting or rejecting it (found
32681 under 'Status').</para>
32682 <para>An 'Accepted' suggestion is one that you have marked as 'Accepted' using the form below
32683 the suggestions. A 'Pending' suggestion is one that is awaiting action from the library. A
32684 'Checked' suggestion is one that has been marked as 'Checked' using the form before the
32685 suggestions. An 'Ordered' suggestion is on that has been ordered using the '<link linkend="orderfromsuggestion">From a purchase suggestion</link>' link in your basket. A
32686 'Rejected' suggestion is one that you have marked at 'Rejected' using the form below the
32687 list of suggestions.</para>
32689 <para>For libraries with lots of suggestions, there are filters on the
32690 left hand side of the Manage Suggestions page to assist in limiting the
32691 number of titles displayed on the screen.</para>
32694 <screeninfo>Suggestion Filtering</screeninfo>
32698 <imagedata fileref="images/acquisitions/suggestionsfilters.png"/>
32703 <para>Clicking on the blue headings will expand the filtering options
32704 and clicking '[clear]' will clear all filters and show all
32706 <para>The suggestions page will automatically be limited to
32707 suggestions for your library. To see information for all (or any
32708 other) libraries click on the 'Acquisition information' filter and
32709 change the library.</para>
32712 <screeninfo>Branch filter</screeninfo>
32716 <imagedata fileref="images/acquisitions/suggestbranchfilter.png"/>
32722 <para>When reviewing 'Pending' suggestions you can choose to check the
32723 box next to the item(s) you want to approve/reject and then choose the
32724 status and reason for your selection. You can also choose to completely
32725 delete the suggestion by checking the 'Delete selected' box.</para>
32728 <screeninfo>Pending Suggestions</screeninfo>
32732 <imagedata fileref="images/acquisitions/suggestpending.png"/>
32737 <para>Another option for libraries with long lists of suggestions is to
32738 approve or reject suggestions one by one by clicking on the title of the
32739 suggestion to open a summary of the suggestion, including information if
32740 the item was purchased.</para>
32743 <screeninfo>Suggestion Information</screeninfo>
32747 <imagedata fileref="images/acquisitions/suggestiondetails.png"/>
32752 <para>Clicking 'edit' to the right of the suggested title or at the to pof the suggestion
32753 detail page will open a suggestion editing page.</para>
32756 <screeninfo>Edit Purchase Suggestion</screeninfo>
32760 <imagedata fileref="images/acquisitions/editsuggestion.png"/>
32765 <para>From this form you can make edits to the suggestion (adding more
32766 details or updating incorrect information provided by the patron). You
32767 can also choose to accept or reject the suggestion on an individual
32772 <para>Choosing to mark a request as 'Pending' will move the request
32773 back to the 'Pending' tab.</para>
32777 <para>Reasons for accepting and rejecting suggestions are defined by the
32778 <link linkend="suggestauthorized">SUGGEST</link> authorized
32782 <screeninfo>Reasons for approving or rejecting
32783 suggestions</screeninfo>
32787 <imagedata fileref="images/acquisitions/suggestreasons.png"/>
32792 <para>If you choose 'Others...' as your reason you will be prompted to
32793 enter your reason in a text box. Clicking 'Cancel' to the right of the
32794 box will bring back the pull down menu with authorized reasons.</para>
32797 <screeninfo>Enter reason for 'Others...'</screeninfo>
32801 <imagedata fileref="images/acquisitions/suggestothers.png"/>
32806 <para>Once you have clicked 'Submit' the suggestion will be moved to the
32807 matching tab. The status will also be updated on the patron's account in
32808 the OPAC and an <link linkend="notices">email notice</link> will be sent
32809 to the patron using the template that matches the status you have
32813 <screeninfo>Purchase suggestions in the OPAC</screeninfo>
32817 <imagedata fileref="images/acquisitions/mysuggestions.png"/>
32823 <section id="placingacqorder">
32824 <title>Placing Orders</title>
32826 <para>To place an order you must first search for the vendor or
32827 bookseller you want to send the order to.</para>
32829 <section id="createacqbasket">
32830 <title>Create a basket</title>
32832 <para>To create a basket you must first search for the vendor you're
32833 ordering from:</para>
32836 <screeninfo>New Basket / Add Basket Options</screeninfo>
32840 <imagedata fileref="images/acquisitions/addbasketbutton.png"/>
32845 <para>And click the 'New basket' button to the right of the vendor name.<tip>
32846 <para>You can also add to an existing basket by clicking the 'Add to basket' link to the
32847 far right of each basket's information in the results table. </para>
32849 <para>After clicking 'New basket' you will be asked to enter some information about the
32853 <screeninfo>Add Basket Form</screeninfo>
32857 <imagedata fileref="images/acquisitions/addbasket.png"/>
32864 <para>When adding a basket you want to give it a name that will
32865 help you identify it later</para>
32869 <para>Enter in the Billing Place and Delivery Place (this will
32870 default the library you're logged in at)</para>
32874 <para>If you would like to change the vendor you're ordering from
32875 you can use the Vendor pull down menu</para>
32879 <para>The notes fields are optional and can contain any type of
32884 <para>If you have <link linkend="addvendorcontract">added
32885 contracts</link> to the vendor you're ordering from, you will also
32886 have an option to choose which contract you're ordering these items
32890 <screeninfo>Basket with contract options</screeninfo>
32894 <imagedata fileref="images/acquisitions/basketwithcontracts.png"/>
32899 <para>When finished, click 'Save'</para>
32902 <screeninfo>New Empty Basket</screeninfo>
32906 <imagedata fileref="images/acquisitions/basket.png"/>
32911 <para>Once your basket is created you are presented with several
32912 options for adding items to the order.</para>
32916 <para>If you are ordering another copy of an existing item, you
32917 can simply search for the record in your system.</para>
32920 <screeninfo>Search for existing records</screeninfo>
32924 <imagedata fileref="images/acquisitions/orderfromexisting.png"/>
32931 <para>From the results, simply click 'Order' to be brought to
32932 the order form.</para>
32935 <screeninfo>Order form</screeninfo>
32939 <imagedata fileref="images/acquisitions/existingitemorder.png"/>
32946 <para>All of the details associated with the item will
32947 already be listed under 'Catalog details.'</para>
32954 <listitem id="orderfromsuggestion">
32955 <para>If you allow patrons to make purchase suggestions (learn more in the <link linkend="managesuggest">Managing Suggestions</link> section of this manual), then
32956 you can place orders from those suggestions. In order to keep track of suggestions
32957 that have been ordered and received you must place the order using this link. </para>
32959 <screeninfo>Approved Suggestions to Order From</screeninfo>
32962 <imagedata fileref="images/acquisitions/orderfromsuggest.png"/>
32968 <para>From the results, click 'Order' next to the item you want to order and you
32969 will be presented with the order form including a link to the suggestion</para>
32971 <screeninfo>Order from a Suggestion</screeninfo>
32974 <imagedata fileref="images/acquisitions/orderfromsuggestform.png"/>
32980 <para>From this form you can make changes to the Catalog Details if
32984 <para>When the item appears in your basket it will include a link to the
32987 <screeninfo>Suggestion Link in basket</screeninfo>
32990 <imagedata fileref="images/acquisitions/ordersuggestlink.png"/>
32998 <para>Orders added to the basket in this way will notify the patron via email that
32999 their suggestion has been ordered and will update the patron's '<link linkend="opacmysuggestions">My purchase suggestions</link>' page in the
33004 <listitem id="ordersubscription">
33005 <para>If you're using the <link linkend="serials">Serials</link> module you can link
33006 your subscription order information to acquisitions by choosing to order 'From a susbscription'<itemizedlist>
33008 <para>After clicking the order link you will be brought to a search page that will
33009 help you find your subscription</para>
33011 <screeninfo>Subscription order search</screeninfo>
33014 <imagedata fileref="images/acquisitions/subordersearch.png"/>
33020 <para>Your results will appear to the right of the form and each subscription will
33021 have an 'Order' link to the right</para>
33023 <screeninfo>Subscription results</screeninfo>
33026 <imagedata fileref="images/acquisitions/suborderresults.png"/>
33032 <para>Clicking 'Order' will bring the subscription info in to the order form
33033 without an 'Add item' section since you are just ordering a subscription and an
33034 item isn't needed</para>
33036 <screeninfo>Order from subscription</screeninfo>
33039 <imagedata fileref="images/acquisitions/suborder.png"/>
33044 </itemizedlist></para>
33048 <para>To order from a record that can't be found anywhere else,
33049 choose the 'From a new (empty) record.'</para>
33052 <screeninfo>Order a new record</screeninfo>
33056 <imagedata fileref="images/acquisitions/fromnewemptyrecord.png"/>
33063 <para>You will be presented with an empty form to fill in all
33064 of the necessary details about the item you are
33071 <para>If you want to search other libraries for an item to
33072 purchase, you can use the 'From an external source' option that
33073 will allow you to order from a MARC record found via a Z39.50
33077 <screeninfo>Search for record to add</screeninfo>
33081 <imagedata fileref="images/acquisitions/orderz39.png"/>
33088 <para>From the results, click the Order link next to the item
33089 you want to purchase.</para>
33092 <screeninfo>Search Results to Order From</screeninfo>
33096 <imagedata fileref="images/acquisitions/orderz39results.png"/>
33103 <para>If the item you're ordering from an external source
33104 looks like it might be a duplicate, Koha will warn you and
33105 give you options on how to proceed.</para>
33108 <screeninfo>Duplicate order warning</screeninfo>
33112 <imagedata fileref="images/acquisitions/dupwarning.png"/>
33119 <para>From the warning, you can choose to order another
33120 copy on the existing bib record, create a new bib record,
33121 or cancel your order of this item.</para>
33127 <para>In the order form that pops up, you will not be able to
33128 edit the catalog details.</para>
33131 <screeninfo>New order from Z39.50 Search</screeninfo>
33135 <imagedata fileref="images/acquisitions/orderz39form.png"/>
33144 <para>The final option for ordering is to order from a staged
33145 record (<link linkend="stagemarc">learn more about staging
33146 records</link>).</para>
33149 <screeninfo>Staged Files to Order From</screeninfo>
33153 <imagedata fileref="images/acquisitions/stagedfiles.png"/>
33160 <para>From the list of files you are presented with, choose
33161 the 'Add orders' link.</para>
33164 <screeninfo>Records in the staged file</screeninfo>
33168 <imagedata fileref="images/acquisitions/stagedrecords.png"/>
33175 <para>From the list of records, click 'Add order' next to
33176 the item that you want to add to your order.</para>
33179 <screeninfo>New order from Staged Record</screeninfo>
33183 <imagedata fileref="images/acquisitions/stagedorder.png"/>
33190 <para>From the order form, you will not be able to
33191 edit the catalog details.</para>
33197 <para>The other option is to import all records from the
33198 staged file by scrolling below the list of records in the
33199 staged file and filling in the item information.</para>
33202 <screeninfo>Import All</screeninfo>
33206 <imagedata fileref="images/acquisitions/importallstaged.png"/>
33213 <para>If you choose this option the Koha will look in
33214 the 020$c and grab the pricing information from that
33215 field and put that on each order line.</para>
33225 <para>After bringing in the bib information, if your <link linkend="AcqCreateItem">AcqCreateItem</link> system preference is set
33226 to add an item when ordering you will enter the item info next. You
33227 need to fill out at least one item record and then click the 'Add'
33228 button at the bottom left of the item form.</para>
33231 <screeninfo>Item order</screeninfo>
33235 <imagedata fileref="images/acquisitions/itemonorder.png"/>
33240 <para>After clicking the 'Add item' button below the item record the item will appear above
33241 the form and then you can enter your next item the same way (if ordering more than one
33245 <screeninfo>Item ordered</screeninfo>
33249 <imagedata fileref="images/acquisitions/itemonorderadded.png"/>
33254 <para>Once you have entered the info about the item, you need to enter
33255 the Accounting information.</para>
33258 <screeninfo>Accounting Details</screeninfo>
33262 <imagedata fileref="images/acquisitions/accounting.png"/>
33269 <para>Quantity is populated by the number of items you've added to the order above.<itemizedlist>
33272 <para>You cannot edit the quantity manually, you must click 'Add' below the item
33273 form to add as many items as you're ordering.</para>
33276 </itemizedlist></para>
33280 <para>The list of funds is populated by the <link linkend="funds">funds</link> you have assigned in the Acquisitions
33281 Administration area.</para>
33285 <para>The currency pull down will have the <link linkend="currexchangeadmin">currencies</link> you set up in the
33286 <link linkend="acqadmin">Acquisitions Administration</link>
33291 <para>The vendor price is the price before any taxes or discounts
33292 are applied.</para>
33296 <para>If the price is uncertain, check the uncertain price
33301 <para>A basket with at least one uncertain price can't be
33308 <para>If you are charged sales tax, choose that from the gstrate
33313 <para>Enter the percentage discount you're receiving on this
33314 order, once you enter this, hit tab and Koha will populate the
33315 rest of the cost fields below.</para>
33319 <para>If you added Planning Values when <link linkend="addbudgetfund">creating the Fund</link>, those values
33320 will appear in the two Planning Value fields.</para>
33323 <para>Once you have filled in all of the fields click 'Save' to add the item to your basket.
33324 If your price goes over the amount availalbe in the fund you will be presented with a
33325 confirmation.</para>
33327 <screeninfo>Fund warning</screeninfo>
33330 <imagedata fileref="images/acquisitions/fundconfirmation.png"/>
33334 <para>The confirmation warning will allow you order past your fund amount if you so
33337 <para>After an item is added to the basket you will be presented with a basket
33341 <screeninfo>Basket with item info</screeninfo>
33345 <imagedata fileref="images/acquisitions/finalbasket.png"/>
33350 <para>If you would like to see more details you can check the 'Show
33351 all details' checkbox</para>
33354 <screeninfo>Show all details</screeninfo>
33358 <imagedata fileref="images/acquisitions/showalldetails.png"/>
33363 <para>From here, you can edit or remove the items that you have
33368 <para>Choosing to 'Delete the order' will delete the order line
33369 but leave the record in the catalog.</para>
33373 <para>Choosing to 'Delete order and catalog record' removes both
33374 the order line and the record in the catalog.</para>
33378 <para>The catalog record cannot always be deleted. You might
33379 see notes explaining why.</para>
33382 <screeninfo>Can't delete order line</screeninfo>
33386 <imagedata fileref="images/acquisitions/cantdeleteorderline.png"/>
33395 <para>On the summary page, you also have the option to edit the
33396 information that you entered about the basket by clicking the 'Edit
33397 basket header information' button, to delete the basket altogether by
33398 clicking the 'Delete this basket' button, or to export your basket as
33399 a CSV file by clicking the 'Export this basket as CSV' button.</para>
33402 <screeninfo>Basket Buttons</screeninfo>
33406 <imagedata fileref="images/acquisitions/basketbuttons.png"/>
33411 <para>Once you're sure your basket is complete, you can click 'Close
33412 this basket' button to indicate that this basket is complete and has
33413 been sent to the vendor. If you have your <link linkend="BasketConfirmations">BasketConfirmations</link> preference
33414 set to show a confirmation, you will be asked if you are sure about
33415 closing the basket.</para>
33418 <screeninfo>Basket Closure Confirmation</screeninfo>
33422 <imagedata fileref="images/acquisitions/BasketConfirmations.png"/>
33427 <para>When closing the basket you can choose to add the basket to a
33428 group for easy printing and retrieval. If you check the box to 'Attach
33429 this basket to a new basket group' you will be brought to the group
33430 list where you can print a PDF of the order.</para>
33433 <screeninfo>Closed Baskets</screeninfo>
33437 <imagedata fileref="images/acquisitions/basketgroup.png"/>
33443 <para>A basket with at least one item marked as 'uncertain price'
33444 will not be able to be closed.</para>
33447 <screeninfo>A basket with items where the price is
33448 uncertain</screeninfo>
33452 <imagedata fileref="images/acquisitions/basketuncertain.png"/>
33456 </important></para>
33458 <para>Clicking the 'Uncertain Prices' button will call up a list of
33459 items with uncertain prices to quick editing. From that list, you can
33460 quickly edit the items by entering new prices and quantities.</para>
33463 <screeninfo>Uncertain Prices</screeninfo>
33467 <imagedata fileref="images/acquisitions/uncertainprices.png"/>
33473 <para>The Uncertain Prices page is independent of the basket. It is
33474 linked to the vendor so you will see all items on order with
33475 uncertain prices for that vendor.</para>
33479 <section id="acqbasketgroup">
33480 <title>Create a basket group</title>
33482 <para>A basket group is simply a group of baskets. In some libraries,
33483 you have several staff members that create baskets, and, at the end of
33484 a period of time, someone then groups them together to send to the
33485 vendor in bulk. That said, it is possible to have one basket in a
33486 basket group if that's the workflow used in your library.</para>
33489 <section id="printacqbasket">
33490 <title>Printing baskets</title>
33492 <para>When you are finished adding items to your basket, click 'Close
33493 this Basket.'</para>
33496 <screeninfo>Close Basket</screeninfo>
33500 <imagedata fileref="images/acquisitions/closebasket.png"/>
33505 <para>You will be asked if you want to 'Attach this basket to a new basket group with the
33506 same name'. A basket group is necessary if you want to be able to print PDFs of your
33510 <screeninfo>Create Purchase Order</screeninfo>
33514 <imagedata fileref="images/acquisitions/createpurchaseorder.png"/>
33519 <para>Your completed order will be listed on the Basket Grouping page
33520 for printing or further modification.</para>
33523 <screeninfo>Basket Grouping</screeninfo>
33527 <imagedata fileref="images/acquisitions/basketgroup.png"/>
33532 <para>Clicking the 'Print' button next to your order will generate a PDF for printing, which
33533 will have all of your library information followed by the items in your order.</para>
33536 <screeninfo>Order found on PDF</screeninfo>
33540 <imagedata fileref="images/acquisitions/pdforder.png"/>
33547 <section id="receiveacqorder">
33548 <title>Receiving Orders</title>
33550 <para>Orders can be received from the vendor information page</para>
33553 <screeninfo>Receive from Vendor Information</screeninfo>
33557 <imagedata fileref="images/acquisitions/receivebutton.png"/>
33562 <para>or the vendor search results page</para>
33565 <screeninfo>Vendor Search Results</screeninfo>
33569 <imagedata fileref="images/acquisitions/receivefromsearch.png"/>
33574 <para>After clicking 'Receive shipment' you will be asked to enter a vendor invoice number, a
33575 shipment received date, a shipping cost and a budget to subtract that shipping amount
33579 <screeninfo>Receive Shipment</screeninfo>
33583 <imagedata fileref="images/acquisitions/receive.png"/>
33588 <para>The receive page will list all items still on order with the
33589 vendor regardless of the basket the item is from.</para>
33592 <screeninfo>Receipt Summary</screeninfo>
33596 <imagedata fileref="images/acquisitions/receiptsummary.png"/>
33601 <para>To receive a specific item, click the 'Receive' link to the right
33602 of the item.</para>
33605 <screeninfo>Receive Item Form</screeninfo>
33609 <imagedata fileref="images/acquisitions/receiveitem.png"/>
33614 <para>From this form you can alter the cost information. You can also
33615 choose to mark only part of the order as received if the vendor didn't
33616 send your entire order by checking only the boxes next to the items on
33617 the left that you want to receive. The values you enter in the
33618 'Replacement cost' and 'Actual cost' will automatically populate the
33619 item record by filling in subfield v (Cost, replacement price) and
33620 subfield g (Cost, normal purchase price) on the item record after
33624 <screeninfo>Item record after receipt</screeninfo>
33628 <imagedata fileref="images/acquisitions/receiveditem.png"/>
33633 <para>You can also make edits to the item record from this form by clicking the 'Edit' link
33634 next to each item. This will allow you to enter in accurate call numbers and barcodes if
33635 you'd like to do that at the point of receipt. Once you have made any changes necessary (to
33636 the order and/or items, click 'Save' to mark the item(s) as received.<tip>
33637 <para>If you have your <link linkend="AcqItemSetSubfieldsWhenReceived"
33638 >AcqItemSetSubfieldsWhenReceived</link> preference set to add or change values on
33639 received items those changes will take place after you hit 'Save'. </para>
33643 <screeninfo>Already Received Items</screeninfo>
33647 <imagedata fileref="images/acquisitions/received.png"/>
33651 <para>If the item is no longer available from this vendor you can transfer the order to
33652 another vendor's basket by clicking the 'Transfer' link to the right of the title. This will
33653 pop up a vendor search box.</para>
33655 <screeninfo>Transfer search</screeninfo>
33658 <imagedata fileref="images/acquisitions/transfersearch.png"/>
33662 <para>From the results you can click 'Choose' to the right of the vendor you would like to
33663 reorder this item from.</para>
33665 <screeninfo>Transfer vendor</screeninfo>
33668 <imagedata fileref="images/acquisitions/transfervendor.png"/>
33672 <para>You will then be presented with the open baskets for that vendor to choose from. To move
33673 the item simply click 'Choose' to the right of the basket you would like to add the item
33676 <screeninfo>Basket choice</screeninfo>
33679 <imagedata fileref="images/acquisitions/transferbasket.png"/>
33683 <para>Once you have chosen you will be presented with a confirmation message.</para>
33685 <screeninfo>Confirm transfer</screeninfo>
33688 <imagedata fileref="images/acquisitions/transferconfirm.png"/>
33693 <para>When you're finished receiving items you can navigate away from
33694 this page or click the 'Finish receiving' button at the bottom of the
33697 <para>You will also see that the item is received and/or cancelled if
33698 you view the basket.</para>
33701 <screeninfo>One item marked (rcvd) in basket</screeninfo>
33705 <imagedata fileref="images/acquisitions/basketwithreceived.png"/>
33710 <section id="acqinvoices">
33711 <title>Invoices</title>
33712 <para>When orders are received invoices are generated. Invoices can be searched by clicking
33713 on 'Invoices' in the left of the Acquisitions page.</para>
33715 <screeninfo>Invoices page</screeninfo>
33718 <imagedata fileref="images/acquisitions/invoicesearch.png"/>
33722 <para>After searching, your results will appear to the right of the search options.</para>
33724 <screeninfo>Invoice search results</screeninfo>
33727 <imagedata fileref="images/acquisitions/invoices.png"/>
33731 <para>From the results you can click the 'Details' link to see the full invoice or 'Close' to
33732 note that the invoice is closed/paid for.</para>
33734 <screeninfo>Invoice details</screeninfo>
33737 <imagedata fileref="images/acquisitions/invoice.png"/>
33741 <para>From the results you can also merge together two invoices should you need to. Simply
33742 click the checkbox to the left of the invoices you would like to merge and click the 'Merge
33743 selected invoices' button at the bottom of the page. You will be presented with a
33744 confirmation screen:</para>
33746 <screeninfo>Merge invoices</screeninfo>
33749 <imagedata fileref="images/acquisitions/mergeinvoices.png"/>
33753 <para>Click on the row of the invoice number you would like to keep and it will be highlighted
33754 in yellow. Enter any different billing information in the fields provided and click
33755 'Merge'. The two invoices will become one.</para>
33758 <section id="acqclaims">
33759 <title>Claims & Late Orders</title>
33761 <para>If you have entered in an email address for the vendors in your
33762 system you can send them claim emails when an order is late. Before you
33763 can send claims you will need to set up an <link linkend="ACQCLAIM">acquisitions claim notice</link>.</para>
33765 <para>Upon clicking on the link to 'Late Orders' from the Acquisitions
33766 page you will be presented with a series of filter options on the left
33767 hand side. These filters will be applied only closed baskets.</para>
33770 <screeninfo>Acquisitions Late Order Filters</screeninfo>
33774 <imagedata fileref="images/acquisitions/acqclaimfilter.png"/>
33780 <para>The vendor pull down only shows vendors with closed baskets that
33784 <para>Once you filter your orders to show you the things you consider to
33785 be late you will be presented with a list of these items.</para>
33788 <screeninfo>Late Orders</screeninfo>
33792 <imagedata fileref="images/acquisitions/lateorders.png"/>
33797 <para>To the right of each late title you will be see a checkbox. Check
33798 off the ones you want a claim letter sent to and click 'Claim Order' at
33799 the bottom right of the list. This will automatically send an email to
33800 the vendor at the email address you have on file.<note>
33801 <para>The Estimated Delivery Date is based on the Delivery time
33802 value entered on the vendor record.</para>
33805 <para>If you would rather use a different acquisition claim letter
33806 (other than the default) you can <link linkend="addnotices">create that
33807 in the notices module</link> and choose it from the menu above the list
33808 of late items.</para>
33811 <screeninfo>Choose a Claim Letter</screeninfo>
33815 <imagedata fileref="images/acquisitions/claimletter.png"/>
33821 <section id="acqsearch">
33822 <title>Acquisition Searches</title>
33824 <para>At the top of the various Acquisition pages there is a quick
33825 search box where you can perform either a Vendor Search or an Order
33829 <screeninfo>Acquisition Searches</screeninfo>
33833 <imagedata fileref="images/acquisitions/acqsearches.png"/>
33838 <para>In the Vendor Search you can enter any part of the vendor name to
33839 get results.</para>
33842 <screeninfo>Vendor Search Results</screeninfo>
33846 <imagedata fileref="images/acquisitions/vendorquicksearch.png"/>
33851 <para>Using the Orders Search you can search for items that have been
33852 ordered with or without the vendor.</para>
33855 <screeninfo>Order Search Box</screeninfo>
33859 <imagedata fileref="images/acquisitions/ordersearch.png"/>
33864 <para>You can enter info in one or both fields and you can enter any
33865 part of the title and/or vendor name.</para>
33868 <screeninfo>Order Search Results</screeninfo>
33872 <imagedata fileref="images/acquisitions/ordersearchresults.png"/>
33877 <para>Clicking the plus sign to the right of the Vendor search box will
33878 expand the search and allow you to search for additional fields.</para>
33881 <screeninfo>Expanded Orders Search</screeninfo>
33885 <imagedata fileref="images/acquisitions/ordersearchexpand.png"/>
33890 <para>Clicking Advanced Search to the right of the search button will
33891 give you all of the order search options available.</para>
33894 <screeninfo>Full Order Search</screeninfo>
33898 <imagedata fileref="images/acquisitions/ordersearchfull.png"/>
33904 <section id="fundtracking">
33905 <title>Budget/Fund Tracking</title>
33907 <para>On the main acquisitions page there will be a table showing you all of your active funds
33908 and a breakdown of what has been ordered or spent against them.</para>
33911 <screeninfo>Fund Table</screeninfo>
33915 <imagedata fileref="images/acquisitions/acqfunds.png"/>
33920 <para>Clicking on the linked amounts under spent or ordered will show you a summary of the
33921 titles ordered/received on that budget.</para>
33924 <screeninfo>Titles Spent</screeninfo>
33928 <imagedata fileref="images/acquisitions/spent.png"/>
33935 <chapter id="stafflists">
33936 <title>Lists & Cart</title>
33938 <para>Lists are a way to save a collection of content on a specific topic
33939 or for a specific purpose. The Cart is a session specific storage
33944 <para><emphasis>Get there:</emphasis> More > Lists</para>
33948 <section id="lists">
33949 <title>Lists</title>
33953 <section id="createlist">
33954 <title>Create a List</title>
33956 <para>A list can be created by visiting the Lists page and clicking
33960 <screeninfo>New List Button</screeninfo>
33964 <imagedata fileref="images/lists/newlistbutton.png"/>
33969 <para>The new list form offers several options for creating your
33973 <screeninfo>New List Form</screeninfo>
33977 <imagedata fileref="images/lists/newlistform.png"/>
33984 <para>The name is what will appear on the list of Lists</para>
33988 <para>You can also choose how to sort the list</para>
33991 <para>Next decide if your list is going to be private or public</para>
33994 <para>A Private List is managed by you and can be seen only by you (depending on
33995 your permissions settings below)</para>
33998 <para>A Public List can be seen by everybody, but managed only by you (depending on
33999 your permissions settings below)</para>
34004 <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
34006 <para>anyone else to add entries</para>
34009 <para>anyone to remove his own contributed entries<itemizedlist>
34012 <para>The owner of a list is always allowed to add entries, but needs
34013 permission to remove.</para>
34016 </itemizedlist></para>
34019 <para>anyone to remove other contributed entries </para>
34021 </itemizedlist></para>
34025 <para>A list can also be created from the catalog search
34029 <screeninfo>New list from catalog search</screeninfo>
34033 <imagedata fileref="images/lists/newlistsearch.png"/>
34040 <para>Check the box to the left of the titles you want to add to
34041 the new list</para>
34045 <para>Choose [New List] from the 'Add to:' pull down menu</para>
34048 <screeninfo>New List from Search Results</screeninfo>
34052 <imagedata fileref="images/lists/newlistfromsearch.png"/>
34059 <para>Name the list and choose what type of list this
34064 <para>A Private List is managed by you and can be seen
34069 <para>A Public List can be seen by everybody, but managed
34078 <para>Once the list is saved it will accessible from the Lists page
34079 and from the 'Add to' menu at the top of the search results.</para>
34082 <section id="addtolist">
34083 <title>Add to a List</title>
34085 <para>To add titles to an existing list click on the list name from
34086 the page of lists</para>
34089 <screeninfo>List of Lists</screeninfo>
34093 <imagedata fileref="images/lists/listslist.png"/>
34098 <para>From the List page you can add titles by scanning barcodes into
34099 the box at the bottom of the page</para>
34102 <screeninfo>Content of a List</screeninfo>
34106 <imagedata fileref="images/lists/listcontents.png"/>
34111 <para>A title can also be added to a list by selecting titles on the
34112 search results page and choosing the list from the 'Add to'
34116 <screeninfo>Add to List</screeninfo>
34120 <imagedata fileref="images/lists/addtolist.png"/>
34126 <section id="viewlist">
34127 <title>Viewing Lists</title>
34129 <para>To see the contents of a list, visit the Lists page on the staff
34133 <screeninfo>List of Lists</screeninfo>
34137 <imagedata fileref="images/lists/listslist.png"/>
34142 <para>Clicking on the 'List Name' will show the contents of the
34146 <screeninfo>Content of a List</screeninfo>
34150 <imagedata fileref="images/lists/listcontents.png"/>
34154 <para>From this list of items you can perform several actions</para>
34157 <para>'New list' will allow you to create another list</para>
34160 <para>'Edit' will allow you to edit the description and permissions for this list</para>
34163 <para>'Send list' will send the list to the email address you enter (<link
34164 linkend="examplelistemail">view sample List email</link>)</para>
34167 <para>'Download list' will allow you to download the cart using one of 3 default formats
34168 or your <link linkend="csvprofiles">CSV Profiles</link></para>
34171 <para>'Print list' will present you with a printable version of the list</para>
34176 <section id="mergebibrecs">
34177 <title>Merging Bibliographic Records Via Lists</title>
34179 <para>The easiest way to merge together duplicate bibliographic
34180 records is to add them to a list and use the Merge Tool from
34184 <screeninfo>List of Duplicate Records</screeninfo>
34188 <imagedata fileref="images/lists/listofdups.png"/>
34193 <para>From the list, check the two items you want to merge. If you
34194 choose more than or fewer than 2, you will be presented with an
34198 <screeninfo>Merge Items Error</screeninfo>
34202 <imagedata fileref="images/lists/merge2rec.png"/>
34207 <para>Once you have selected the records you want to merge, click the 'Merge selected'
34208 button at the top of the list. You will be asked which of the two records you would like
34209 to keep as your primary record and which will be deleted after the merge. If the records
34210 were created using different frameworks, Koha will also ask you what Framework you would
34211 like the newly merged record to use.</para>
34214 <screeninfo>Choose Primary Record for Merge</screeninfo>
34218 <imagedata fileref="images/lists/mergeprimary.png"/>
34223 <para>You will be presented with the MARC for both of the records
34224 (each accessible by tabs labeled with the bib numbers for those
34225 records). By default the entire first record will be selected, uncheck
34226 the fields you don't want in the final (destination) record and then
34227 move on to the second tab to choose which fields should be in the
34228 final (destination) record.</para>
34231 <screeninfo>Merging Records</screeninfo>
34235 <imagedata fileref="images/lists/mergerecs.png"/>
34240 <para>Should you try to add a field that is not repeatable two times
34241 (like choosing the 245 field from both record #1 and #2) you will be
34242 presented with an error</para>
34245 <screeninfo>Non-repeatable Error</screeninfo>
34249 <imagedata fileref="images/lists/nondupfield.png"/>
34254 <para>Once you have completed your selections click the 'merge'
34255 button. The primary record will now CONTAIN the data you chose for it
34256 as well as all of the items/holdings from both bib records, and the
34257 second record will be deleted.<important>
34258 <para>It is important to rebuild your zebra index immediately
34259 after merging records. If a search is performed for a record which
34260 has been deleted Koha will present the patrons with an error in
34262 </important></para>
34266 <section id="cart">
34267 <title>Cart</title>
34269 <para>The cart is a temporary holding place for items in the OPAC and/or
34270 staff client. The cart will be emptied once the session is ended (by
34271 closing the browser or logging out). The cart is best used for
34272 performing batch operations (holds, printing, emailing) or for getting a
34273 list of items to be printed or emailed to yourself or a patron.</para>
34275 <para>If you would like to enable the cart in the staff client, you need
34276 to set the <link linkend="intranetbookbag">intranetbookbag</link> system
34277 preference to 'Show.' To add things to the cart, search the catalog and
34278 select the items you would like added to your cart and choose 'Cart'
34279 from the 'Add to' menu</para>
34282 <screeninfo>Add to Cart</screeninfo>
34286 <imagedata fileref="images/lists/addtocart.png"/>
34291 <para>A confirmation will appear below the cart button at the top of the
34292 staff client</para>
34295 <screeninfo>Items added to Cart</screeninfo>
34299 <imagedata fileref="images/lists/itemsaddedcart.png"/>
34304 <para>Clicking on the Cart icon will provide you with the contents of
34308 <screeninfo>Cart Contents</screeninfo>
34312 <imagedata fileref="images/lists/cart.png"/>
34316 <para>From this list of items you can perform several actions</para>
34320 <para>'More details' will show more information about the items in the cart</para>
34324 <para>'Send' will send the list to the email address you enter (<link
34325 linkend="examplecartemail">view sample Cart email</link>)</para>
34329 <para>'Download' will allow you to download the cart using one of 3
34330 default formats or your <link linkend="csvprofiles">CSV
34331 Profiles</link></para>
34335 <para>'Print' will present you with a printable version of the
34340 <para>'Empty and Close' will empty the list and close the
34345 <para>'Hide Window' will close the window</para>
34351 <chapter id="reports">
34352 <title>Reports</title>
34354 <para>Reports in Koha are a way to gather data. Reports are used to
34355 generate statistics, member lists, shelving lists, or any list of data in
34356 your database.</para>
34360 <para><emphasis>Get there:</emphasis> More > Reports</para>
34364 <section id="customreports">
34365 <title>Custom Reports</title>
34367 <para>Koha's data is stored in a MySQL database which means that
34368 librarians can generate nearly any report they would like by either
34369 using the <link linkend="quidedreportwizard">Guided Reports
34370 Wizard</link> or writing their own <link linkend="reportfromsql">SQL
34371 query</link>.</para>
34373 <section id="customreport">
34374 <title>Add Custom Report</title>
34378 <section id="quidedreportwizard">
34379 <title>Guided Report Wizard</title>
34381 <para>The guided report wizard will walk you through a six step
34382 process to generate a report.</para>
34384 <para>Step 1: Choose the module you want to report on. This will
34385 determine what tables and fields are available for you to
34388 <para>'Report is public' should be left to the default of 'No' in
34389 most cases. A report can be made public if you intend to allow
34390 access to it through the JSON webservice interface. This is a system
34391 that can be used by developers to make custom presentations of the
34392 data from the report, for example displaying it using a graphing
34393 API. To learn more speak to your local developer.</para>
34397 <para>A public report is accessible via a URL that looks like
34398 this: http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
34403 <screeninfo>Chose Module for Report</screeninfo>
34407 <imagedata fileref="images/reports/report1.png"/>
34412 <para>If your system administrator has set up memcache on your server you might see one
34413 more option for the Cache expiry. This is related to your public reports. If you make
34414 the report public then it's constantly running and will cause a large load on your
34415 system. Setting this value prevents that.<screenshot>
34416 <screeninfo>Cache expiry</screeninfo>
34419 <imagedata fileref="images/reports/cacheexiprywizard.png"/>
34422 </screenshot></para>
34424 <para>Step 2: Choose a report type. For now, Tabular is the only option available.</para>
34427 <screeninfo>Report Type</screeninfo>
34431 <imagedata fileref="images/reports/report2.png"/>
34436 <para>Step 3: Choose the fields you want in your report. You can
34437 select multiple fields and add them all at once by using CTRL+Click
34438 on each item you want to add before clicking the Add button.</para>
34441 <screeninfo>Select database fields to query</screeninfo>
34445 <imagedata fileref="images/reports/report3.png"/>
34450 <para>Step 4: Choose any limits you might want to apply to your
34451 report (such as item types or branches). If you don't want to apply
34452 any limits, simply click Next instead of making an option.</para>
34455 <screeninfo>Choose limits</screeninfo>
34459 <imagedata fileref="images/reports/report4.png"/>
34464 <para>Step 5: Perform math functions. If you don't want to do any
34465 calculations, simply click Next instead of making an option.</para>
34468 <screeninfo>Choose math functions</screeninfo>
34472 <imagedata fileref="images/reports/report5.png"/>
34477 <para>Step 6: Choose data order. If you want the data to print out
34478 in the order it's found in the database, simply click Finish.</para>
34481 <screeninfo>Choose ordering</screeninfo>
34485 <imagedata fileref="images/reports/report6.png"/>
34490 <para>When you are finished you will be presented with the SQL
34491 generated by the report wizard. From here you can choose to save the
34492 report by clicking 'Save' or copy the SQL and make edits to it by
34496 <screeninfo>Custom Report Confirmation</screeninfo>
34500 <imagedata fileref="images/reports/reportconfirm.png"/>
34505 <para>If you choose to save the report you will be asked to name your report, sort it in
34506 to groups and subgroups and enter any notes regarding it.</para>
34509 <screeninfo>Save custom report</screeninfo>
34513 <imagedata fileref="images/reports/reportsave.png"/>
34518 <para>Once your report is saved it will appear on the 'Use Saved'
34519 page with all other saved reports.</para>
34522 <screeninfo>Saved Reports list</screeninfo>
34526 <imagedata fileref="images/reports/savedreports.png"/>
34531 <para>From here you can make edits, run the report, or schedule a time to have the report
34532 run. To find the report you created you can sort by any of the columns by clicking the
34533 on the column header (creation date is the best bet for finding the report you just
34534 added). You can also filter your results using the filter menu on the left or use the
34535 tabs to find reports based on your custom groups.</para>
34538 <section id="reportfromsql">
34539 <title>Report from SQL</title>
34541 <para>In addition to the report wizard, you have the option to write
34542 your own queries using SQL. To find reports written by other Koha
34543 users, visit the Koha Wiki: <ulink url="http://wiki.koha-community.org/wiki/SQL_Reports_Library">http://wiki.koha-community.org/wiki/SQL_Reports_Library</ulink>.
34544 You can also find your database structure in
34545 /installer/data/mysql/kohastructure.sql or online at: <ulink url="http://schema.koha-community.org/">http://schema.koha-community.org</ulink>.</para>
34547 <para>To add your query, click the link to 'Create from SQL' on the main reports module or
34548 the 'New report' button at the top of the 'Saved reports' page.</para>
34551 <screeninfo>New SQL Report</screeninfo>
34555 <imagedata fileref="images/reports/newsql.png"/>
34560 <para>Fill in the form presented</para>
34563 <screeninfo>Create Report from SQL</screeninfo>
34567 <imagedata fileref="images/reports/reportfromsql.png"/>
34574 <para>The 'Name' is what will appear on the Saved Reports page
34575 to help you identify the report later. It will also be
34576 searchable using the filters found the left of the Saved Reports
34581 <para>You can use the 'Report group' to organize your reports so that you can easily
34582 filter reports by groups. Report groups are set in the <link linkend="reportgroup">REPORT_GROUP</link> authorized value category or can be added on the fly when
34583 creating the report by choosing the 'or create' radio button.<screenshot>
34584 <screeninfo>Report group</screeninfo>
34587 <imagedata fileref="images/reports/reportgroup.png"/>
34590 </screenshot><itemizedlist>
34594 <para>If you're adding a report group on the fly, remember that you code
34595 should be fewer than 10 characters and should not include special
34596 characters or spaces.</para>
34600 </itemizedlist></para>
34604 <para>You can use 'Report subgroup' to further organize your reports so that you can
34605 easily filter reports by groups and subgroups. Report subgroups are set in the <link linkend="reportsubgroup">REPORT_SUBGROUP</link> authorized value category or can
34606 be added on the fly when creating the report by choosing the 'or create' radio
34609 <screeninfo>Report subgroup</screeninfo>
34612 <imagedata fileref="images/reports/reportsubgroup.png"/>
34620 <para>If you're adding a report subgroup on the fly, remember that you code
34621 should be fewer than 10 characters and should not include special characters
34629 <listitem id="publicreport">
34630 <para>'Report is public' should be left to the default of 'No' in most cases. A report
34631 can be made public if you intend to allow access to it through the JSON webservice
34632 interface. This is a system that can be used by developers to make custom
34633 presentations of the data from the report, for example displaying it using a
34634 graphing API. To learn more speak to your local developer.</para>
34637 <para>A public report is accessible via a URL that looks like this:
34638 http://MYOPAC/cgi-bin/koha/svc/report?id=REPORTID</para>
34644 <para>'Notes' will also appear on the Saved Reports page, this
34645 can be used to provide more details about the report or tips on
34646 how to enter values when it runs</para>
34650 <para>The type should always be 'Tabular' at this time since the
34651 other formats have not been implemented</para>
34655 <para>In the 'SQL' box you will type or paste the SQL for the
34660 <para>If you feel that your report might be too resource
34661 intensive you might want to consider using runtime parameters to
34662 your query. Runtime parameters basically make a filter appear
34663 before the report is run to save your system resources.</para>
34665 <para>There is a specific syntax that Koha will understand as
34666 'ask for values when running the report'. The syntax is
34667 <<Question to ask|authorized_value>>.</para>
34671 <para>The << and >> are just delimiters. You
34672 must put << at the beginning and >> at the end
34673 of your parameter</para>
34677 <para>The 'Question to ask' will be displayed on the left of
34678 the string to enter.</para>
34682 <para>The authorized_value can be omitted if not applicable.
34683 If it contains an authorized value category, or branches or
34684 itemtype or categorycode, a list with the Koha authorized
34685 values will be displayed instead of a free field Note that
34686 you can have more than one parameter in a given SQL Note
34687 that entering nothing at run time won't probably work as you
34688 expect. It will be considered as "value empty" not as
34689 "ignore this parameter". For example entering nothing for :
34690 "title=<<Enter title>>" will display results
34691 with title='' (no title). If you want to have to have
34692 something not mandatory, use "title like <<Enter
34693 title>>" and enter a % at run time instead of
34698 <para>Examples:</para>
34702 <para>SELECT surname,firstname FROM borrowers WHERE
34703 branchcode=<<Enter patrons library|branches>>
34704 AND surname like <<Enter filter for patron surname (%
34705 if none)>></para>
34709 <para>SELECT * FROM items WHERE homebranch = <<Pick
34710 your branch|branches>> and barcode like
34711 <<Partial barcode value here>></para>
34716 <para>To generate a date picker calendar to the right of the
34717 field when running a report you can use the 'date' keyword
34718 like this: <<Enter Date|date>></para>
34721 <screeninfo>Date Picker</screeninfo>
34725 <imagedata fileref="images/reports/datepicker.png"/>
34732 <para>You have to put "%" in a text box to 'leave it blank'.
34733 Otherwise, it literally looks for "" (empty string) as the
34734 value for the field.</para>
34738 <para>In addition to using any authorized value code to
34739 generate a dropdown, you can use the following values as
34740 well: Branches (branches), Item Types (itemtypes) and Patron
34741 Categories (categorycode). For example a branch pull down
34742 would be generated like this
34743 <<Branch|branches>></para>
34746 <screeninfo>Branch pull down</screeninfo>
34750 <imagedata fileref="images/reports/branchpulldown.png"/>
34754 </important></para>
34759 <para>There is a limit of 10,000 records put on SQL statements entered in Koha. To get
34760 around this you want to add 'LIMIT 100000' to the end of your SQL statement (or any
34761 other number above 10,000).</para>
34764 <para>If your system administrator has set up memcache on your server you might see one
34765 more option for the Cache expiry. This is related to your public reports. If you make
34766 the report public then it's constantly running and will cause a large load on your
34767 system. Setting this value prevents that.<screenshot>
34768 <screeninfo>Cache expiry</screeninfo>
34771 <imagedata fileref="images/reports/cacheexpiry.png"/>
34774 </screenshot></para>
34777 <para>Once everything is entered click the 'Save Report' button and
34778 you'll be presented with options to run it. Once a report is saved
34779 you do not have to recreate it you can simply find it on the Saved
34780 Reports page and <link linkend="runcustomreport">run</link> or <link linkend="editcustomreports">edit</link> it.</para>
34782 <section id="duplicatereport">
34783 <title>Duplicate Report</title>
34784 <para>Reports can also be added by duplicating an existing report. Visit the 'Saved
34785 reports' page to see all of the reports listed on your system already.</para>
34787 <screeninfo>Saved Reports</screeninfo>
34790 <imagedata fileref="images/reports/duplicatereport.png"/>
34794 <para>To the right of every report there is an 'Actions' pull down. Clickin that and
34795 choose 'Duplicate' to use an existing report as the basis for your new report. That will
34796 populate the new report form with the existing SQL for easy editing and resaving.</para>
34800 <section id="editcustomreports">
34801 <title>Edit Custom Reports</title>
34803 <para>Every report can be edited from the reports lists. To see the
34804 list of reports already stored in Koha, click 'Use Saved.'</para>
34807 <screeninfo>Saved Reports</screeninfo>
34811 <imagedata fileref="images/reports/savedreports.png"/>
34816 <para>To find the report you'd like to edit you can sort by any of the columns by clicking
34817 the on the column header. You can also filter your results using the filter menu on the
34818 left or use the tabs to find reports based on your custom groups.</para>
34820 <para>From this list you can edit any custom report by clicking 'Actions' to the right of
34821 the report and choosing 'Edit' from the menu that appears.</para>
34823 <screeninfo>Edit Report Option</screeninfo>
34826 <imagedata fileref="images/reports/editreportoption.png"/>
34830 <para>The form to edit the report will appear.</para>
34833 <screeninfo>Edit SQL Form</screeninfo>
34837 <imagedata fileref="images/reports/editreport.png"/>
34843 <section id="runcustomreport">
34844 <title>Running Custom Reports</title>
34846 <para>Once custom reports are saved to Koha, you can run them by going to the Saved Reports
34847 page and clicking the 'Actions' button to the right of the report and choosing
34851 <screeninfo>Run Report</screeninfo>
34855 <imagedata fileref="images/reports/runreport.png"/>
34860 <para>When you report runs you will either be asked for some
34864 <screeninfo>Enter report parameters</screeninfo>
34868 <imagedata fileref="images/reports/reportparameters.png"/>
34873 <para>or you will see the results right away</para>
34876 <screeninfo>Report results</screeninfo>
34880 <imagedata fileref="images/reports/reportresults.png"/>
34885 <para>From the results you can choose to rerun the report by clicking
34886 'Run report' at the top, edit the report by clicking the 'Edit' button
34887 or starting over and creating a new report by using the 'New' button.
34888 You can also download your results by choosing a file type at the
34889 bottom of the results next to the 'Download the report' label and
34890 clicking 'Download.'<tip>
34891 <para>A Comma Separated Text file is a CSV file and it can be
34892 opened by any spreadsheet application.</para>
34897 <section id="statsreports">
34898 <title>Statistics Reports</title>
34900 <para>Statistic reports will show you counts and sums. These reports are
34901 all about numbers and statistics, for reports that return more detailed
34902 data, use the <link linkend="quidedreportwizard">Guided Report
34903 Wizard</link>. These reports are limited in what data they can look at,
34904 so it's often recommended to use <link linkend="customreports">custom
34905 reports</link> for official end of the year statistics.</para>
34907 <section id="acqstats">
34908 <title>Acquisitions Statistics</title>
34911 <para>These reports are limited in what data they can look at, so
34912 it's often recommended to use <link linkend="customreports">custom
34913 reports</link> for official end of the year statistics.</para>
34916 <para>Using the form provided, choose which value you would like to
34917 appear in the Column and which will appear in the Row.</para>
34920 <screeninfo>Acquisitions Statistics</screeninfo>
34924 <imagedata fileref="images/reports/acqform.png"/>
34929 <para>If you choose to output to the browser your results will print
34930 to the screen.</para>
34933 <screeninfo>Acquisitions Statistics Results</screeninfo>
34937 <imagedata fileref="images/reports/acqnumbers.png"/>
34942 <para>You can also choose to export to a file that you can manipulate
34943 to your needs.</para>
34945 <para>When generating your report, note that you get to choose between
34946 counting or summing the values.</para>
34949 <screeninfo>Acquisitions Stats Options</screeninfo>
34953 <imagedata fileref="images/reports/acqtotal.png"/>
34958 <para>Choosing amount will change your results to appear as the sum of
34959 the amounts spent.</para>
34962 <screeninfo>Acquisitions statistics with totals</screeninfo>
34966 <imagedata fileref="images/reports/acqamounts.png"/>
34972 <section id="patstats">
34973 <title>Patron Statistics</title>
34976 <para>These reports are limited in what data they can look at, so
34977 it's often recommended to use <link linkend="customreports">custom
34978 reports</link> for official end of the year statistics.</para>
34981 <para>Using the form provided, choose which value you would like to
34982 appear in the Column and which will appear in the Row.</para>
34985 <screeninfo>Patron Statistics Options</screeninfo>
34989 <imagedata fileref="images/reports/patronform.png"/>
34994 <para>If you choose to output to the browser your results will print
34995 to the screen.</para>
34998 <screeninfo>Patron Statistics Results</screeninfo>
35002 <imagedata fileref="images/reports/patronresults.png"/>
35007 <para>Based on your selections, you may see some query information
35008 above your results table. You can also choose to export to a file that
35009 you can manipulate to your needs.</para>
35012 <section id="catstats">
35013 <title>Catalog Statistics</title>
35016 <para>These reports are limited in what data they can look at, so
35017 it's often recommended to use <link linkend="customreports">custom
35018 reports</link> for official end of the year statistics.</para>
35021 <para>Using the form provided, choose which value you would like to
35022 appear in the Column and which will appear in the Row.</para>
35025 <screeninfo>Catalog Statistics Form</screeninfo>
35029 <imagedata fileref="images/reports/catalogform.png"/>
35034 <para>If you choose to output to the browser your results will print
35035 to the screen.</para>
35038 <screeninfo>Catalog Statistic Results</screeninfo>
35042 <imagedata fileref="images/reports/catalogresults.png"/>
35047 <para>You can also choose to export to a file that you can manipulate
35048 to your needs.</para>
35051 <section id="circstats">
35052 <title>Circulation Statistics</title>
35055 <para>These reports are limited in what data they can look at, so
35056 it's often recommended to use <link linkend="customreports">custom
35057 reports</link> for official end of the year statistics.</para>
35060 <para>Using the form provided, choose which value you would like to
35061 appear in the Column and which will appear in the Row.</para>
35064 <screeninfo>Circulation Statistics</screeninfo>
35068 <imagedata fileref="images/reports/circform.png"/>
35073 <para>If you choose to output to the browser your results will print
35074 to the screen.</para>
35077 <screeninfo>Circulation Statistic Results</screeninfo>
35081 <imagedata fileref="images/reports/circresults.png"/>
35086 <para>You can also choose to export to a file that you can manipulate
35087 to your needs.<tip>
35088 <para>To get a complete picture of your monthly or daily
35089 circulation, you can run the report twice, once for 'Type' of
35090 'Checkout' and again for 'Renewal.'</para>
35092 <para>This report uses 'Period,' or date, filtering that allows
35093 you to limit to a month by simply selecting the first day of the
35094 first month through the first day of the next month. For example,
35095 10/1 to 11/1 to find statistics for the month of October.</para>
35099 <para>To find daily statistics, set your date
35100 range.</br> Example: "I want circulation data starting
35101 with date XXX up to, but not including, date XXX."</para>
35105 <para>For a whole month, an example range would be: 11/01/2009
35106 to 12/01/2009</para>
35110 <para>For a whole year, an example range would be: 01/01/2009
35111 to 01/01/2010</para>
35115 <para>For a single day, an example would be: 11/15/2009 to
35116 11/16/2009 to find what circulated on the 15th</para>
35121 <section id="inhouseuse">
35122 <title>Tracking in house use</title>
35124 <para>Using the Circulation statistics reporting wizard you can run
35125 reports on in house usage of items simply by choosing 'Local Use'
35126 from the 'Type' pull down:</para>
35129 <screeninfo>In House Use Stats</screeninfo>
35133 <imagedata fileref="images/reports/inhouse.png"/>
35140 <section id="serialstats">
35141 <title>Serials Statistics</title>
35144 <para>These reports are limited in what data they can look at, so
35145 it's often recommended to use <link linkend="customreports">custom
35146 reports</link> for official end of the year statistics.</para>
35149 <para>Using the form provided, choose how you would like to list the
35150 serials in your system.</para>
35153 <screeninfo>Serials Statistics</screeninfo>
35157 <imagedata fileref="images/reports/serialsform.png"/>
35162 <para>If you choose to output to the browser your results will print
35163 to the screen.</para>
35166 <screeninfo>Serials Results</screeninfo>
35170 <imagedata fileref="images/reports/serialsresults.png"/>
35175 <para>You can also choose to export to a file that you can manipulate
35176 to your needs.</para>
35179 <section id="holdstats">
35180 <title>Holds Statistics</title>
35183 <para>These reports are limited in what data they can look at, so
35184 it's often recommended to use <link linkend="customreports">custom
35185 reports</link> for official end of the year statistics.</para>
35188 <para>Using the form provided you can see statistics for holds placed,
35189 filled, cancelled and more at your library. From the form choose what
35190 value you want to display in the column and what value to show in the
35191 row. You can also choose from the filters on the far right of the
35195 <screeninfo>Hold Statistics Form</screeninfo>
35199 <imagedata fileref="images/reports/holdstatsform.png"/>
35204 <para>If you choose to output to the browser your results will print
35205 to the screen.</para>
35208 <screeninfo>Hold Stats Results</screeninfo>
35212 <imagedata fileref="images/reports/holdstatsresults.png"/>
35217 <para>You can also choose to export to a file that you can manipulate
35218 to your needs.</para>
35221 <section id="mostcheckouts">
35222 <title>Patrons with the most checkouts</title>
35224 <para>This report will simply list the patrons who have the most
35228 <screeninfo>Patrons with the most checkouts form</screeninfo>
35232 <imagedata fileref="images/reports/topcheckoutsform.png"/>
35237 <para>If you choose to output to the browser your results will print
35238 to the screen.</para>
35241 <screeninfo>Top checkouts results</screeninfo>
35245 <imagedata fileref="images/reports/topcheckoutsresult.png"/>
35250 <para>You can also choose to export to a file that you can manipulate
35251 to your needs.</para>
35254 <section id="mostcirculated">
35255 <title>Most Circulated Items</title>
35257 <para>This report will simply list the items that have the been
35258 checked out the most.</para>
35261 <screeninfo>Most Circulation Items Form</screeninfo>
35265 <imagedata fileref="images/reports/topcircform.png"/>
35270 <para>If you choose to output to the browser your results will print
35271 to the screen.</para>
35274 <screeninfo>Top Circulation Items Results</screeninfo>
35278 <imagedata fileref="images/reports/topcircresults.png"/>
35283 <para>You can also choose to export to a file that you can manipulate
35284 to your needs.</para>
35287 <section id="patnocheckouts">
35288 <title>Patrons with no checkouts</title>
35290 <para>This report will list for you the patrons in your system who
35291 haven't checked any items out.</para>
35294 <screeninfo>Patrons with no Checkouts</screeninfo>
35298 <imagedata fileref="images/reports/patnocheckout.png"/>
35303 <para>If you choose to output to the browser your results will print
35304 to the screen.</para>
35307 <screeninfo>Results for Patrons with no Checkouts</screeninfo>
35311 <imagedata fileref="images/reports/patnocheckout-results.png"/>
35316 <para>You can also choose to export to a file that you can manipulate
35317 to your needs.</para>
35320 <section id="itemnocheckouts">
35321 <title>Items with no checkouts</title>
35323 <para>This report will list items in your collection that have never
35324 been checked out.</para>
35327 <screeninfo>Items with No Checkouts</screeninfo>
35331 <imagedata fileref="images/reports/nocheckoutsform.png"/>
35336 <para>If you choose to output to the browser your results will print
35337 to the screen.</para>
35340 <screeninfo>Items with no checkouts results</screeninfo>
35344 <imagedata fileref="images/reports/nocheckoutsresults.png"/>
35349 <para>You can also choose to export to a file that you can manipulate
35350 to your needs.</para>
35353 <section id="catbyitem">
35354 <title>Catalog by Item Type</title>
35356 <para>This report will list the total number of items of each item
35357 type per branch.</para>
35360 <screeninfo>Catalog by Item Type</screeninfo>
35364 <imagedata fileref="images/reports/itemtotals.png"/>
35369 <para>If you choose to output to the browser your results will print
35370 to the screen.</para>
35373 <screeninfo>Total of Items by Type and Branch</screeninfo>
35377 <imagedata fileref="images/reports/itemtotalsresults.png"/>
35382 <para>You can also choose to export to a file that you can manipulate
35383 to your needs.</para>
35386 <section id="lostreport">
35387 <title>Lost Items</title>
35389 <para>This report will allow you to generate a list of items that have
35390 been marked as Lost within the system</para>
35393 <screeninfo>Lost Items Report</screeninfo>
35397 <imagedata fileref="images/reports/lostitems.png"/>
35403 <section id="avloantime">
35404 <title>Average Loan Time</title>
35406 <para>This report will list the average time items are out on loan
35407 based on the criteria you enter:</para>
35410 <screeninfo>Average Checkout Period Form</screeninfo>
35414 <imagedata fileref="images/reports/averloanform.png"/>
35419 <para>If you choose to output to the browser your results will print
35420 to the screen.</para>
35423 <screeninfo>Average Checkout Period Results</screeninfo>
35427 <imagedata fileref="images/reports/avercheckout.png"/>
35432 <para>You can also choose to export to a file that you can manipulate
35433 to your needs.</para>
35437 <section id="reportdic">
35438 <title>Report Dictionary</title>
35440 <para>The report dictionary is a way to pre-define common filters you'd
35441 like to apply to your reports. This is a good way to add in filters that
35442 the report wizard doesn't include by default. To add a new definition,
35443 or filter, click 'New Definition' on the Reports Dictionary page and
35444 follow the 4 step process.</para>
35446 <para>Step 1: Name the definition and provide a description if
35450 <screeninfo>Create a Definition</screeninfo>
35454 <imagedata fileref="images/reports/dict1.png"/>
35459 <para>Step 2: Choose the module that the will be queried.</para>
35462 <screeninfo>Select Koha Module</screeninfo>
35466 <imagedata fileref="images/reports/dict2.png"/>
35471 <para>Step 3: Choose columns to query from the tables presented.</para>
35474 <screeninfo>Choose columns</screeninfo>
35478 <imagedata fileref="images/reports/dict3.png"/>
35483 <para>Step 4: Choose the value(s) from the field(s). These will be
35484 automatically populated with options available in your database.</para>
35487 <screeninfo>Choose fields and values</screeninfo>
35491 <imagedata fileref="images/reports/dict4.png"/>
35496 <para>Confirm your selections to save the definition.</para>
35499 <screeninfo>Confirm Definition</screeninfo>
35503 <imagedata fileref="images/reports/dictconfirm.png"/>
35508 <para>Your definitions will all appear on the Reports Dictionary
35512 <screeninfo>Reports Dictionary Listing</screeninfo>
35516 <imagedata fileref="images/reports/dictlist.png"/>
35521 <para>Then when generating reports on the module you created the value
35522 for you will see an option to limit by the definition at the bottom of
35523 the usual filters.</para>
35526 <screeninfo>Dictionary Limit Option</screeninfo>
35530 <imagedata fileref="images/reports/dictionarylimit.png"/>
35537 <chapter id="opac">
35538 <title>OPAC</title>
35540 <para>This chapter assumes that you have the following preferences set as
35545 <para><link linkend="opacthemes">opacthemes</link> = bootstrap</para>
35548 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> = default</para>
35552 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
35557 <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
35562 <para><link linkend="TagsEnabled">TagsEnabled</link> = Allow</para>
35566 <para><link linkend="TagsInputOnDetail">TagsInputOnDetail</link>
35571 <para><link linkend="TagsInputOnList">TagsInputOnList</link> =
35576 <para><link linkend="reviewson">reviewson</link> = Allow</para>
35580 <para><link linkend="ShowReviewer">ShowReviewer</link> = Allow</para>
35584 <para><link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link>
35589 <para><link linkend="OPACFRBRizeEditions">OPACFRBRizeEditions</link> =
35594 <para><link linkend="OPACAmazonCoverImages">OPACAmazonCoverImages</link> =
35599 <para><link linkend="XISBN">XISBN</link> = Use</para>
35603 <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
35604 = Default set of links</para>
35608 <para><link linkend="OPACShowCheckoutName">OPACShowCheckoutName</link>
35609 = Don't show</para>
35613 <para><link linkend="RequestOnOpac">RequestOnOpac</link> =
35618 <para><link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link> =
35623 <para><link linkend="OpacBrowseResults">OpacBrowseResults</link> =
35628 <para><link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> =
35633 <para><link linkend="OPACShowBarcode">OPACShowBarcode</link> = Don't show</para>
35636 <para><link linkend="OpacSeparateHoldings">OpacSeparateHoldings</link> = Don't
35640 <para><link linkend="OpacSeparateHoldings">OpacSeparateHoldingsBranch</link> = home
35645 <para>If your system preferences are set differently your displays may
35648 <section id="opacsearchresults">
35649 <title>Search Results</title>
35651 <para>To search the OPAC you can either choose to enter your search
35652 words in the box at the top of the OPAC or click on the 'Advanced
35653 Search' link to perform a more detailed search.</para>
35656 <screeninfo>OPAC Search Box</screeninfo>
35660 <imagedata fileref="images/opac/searchbox.png"/>
35665 <para>For more on searching check the '<link linkend="searching">Searching</link>' chapter in this manual.</para>
35667 <section id="opacresultsoverview">
35668 <title>Results Overview</title>
35670 <para>After performing a search the number of results found for your
35671 search will appear above the results</para>
35674 <screeninfo>Total Results</screeninfo>
35678 <imagedata fileref="images/opac/totalresults-rss.png"/>
35683 <para>By default your search results will be sorted based on your
35684 <link linkend="opacdefaultsort">OPACdefaultSortField and
35685 OPACdefaultSortOrder</link> system preference values. To change this
35686 you can choose another sorting method from the pull down on the
35690 <screeninfo>Results Sorting Options</screeninfo>
35694 <imagedata fileref="images/opac/sortingresults.png"/>
35699 <para>Under each title on your results list a series of values from your leader will appear.
35700 It is important to note that this has nothing to do with the item types or collection
35701 codes you have applied to your records, this data is all pulled from your fixed fields.
35702 This can be turned on or off with the <link linkend="DisplayOPACiconsXSLT"
35703 >DisplayOPACiconsXSLT</link> system preference.</para>
35706 <screeninfo>Leader Visualization</screeninfo>
35710 <imagedata fileref="images/opac/leader.png"/>
35715 <para>Below each title you will see the availability for the items attached to the record. <note>
35716 <para>Even if you filtered on one library location all locations that hold the item will
35717 appear on the search results.</para>
35719 <para>An item's hold status doesn't not affect whether or not the item is 'available'
35720 until the item is in 'waiting' status. Items with on-shelf holds will show as
35721 available until a librarian has pulled them from the shelf and checked the item in
35722 make it show 'waiting'.</para>
35723 </important></para>
35726 <screeninfo>Holdings Information</screeninfo>
35730 <imagedata fileref="images/opac/holdings-results.png"/>
35735 <para>If you have turned on <link linkend="enhancedcontent">Enhanced
35736 Content</link> preferences you may have book jackets on your search
35740 <screeninfo>Book Jacket on Results</screeninfo>
35744 <imagedata fileref="images/opac/coverresults.png"/>
35748 <para>If you have set your <link linkend="didyoumean">Did you mean?</link> options you will
35749 see a yellow bar across the top of your results will other related searches.</para>
35751 <screeninfo>Did you mean?</screeninfo>
35754 <imagedata fileref="images/opac/didyoumeanopac.png"/>
35760 <section id="opacfilter">
35761 <title>Filters</title>
35763 <para>To filter your results click on the links below the 'Refine Your
35764 Search' menu on the left of your screen</para>
35767 <screeninfo>Refine Your Results</screeninfo>
35771 <imagedata fileref="images/opac/refineresults.png"/>
35777 <section id="searchrss">
35778 <title>Search RSS Feeds</title>
35780 <para>You will be able to subscribe to your search results as an RSS
35781 feed by clicking the RSS icon in your address bar or next to the
35782 number of results. To learn more about what RSS feeds are check out
35783 <ulink url="http://www.youtube.com/watch?v=0klgLsSxGsU">this tutorial
35784 video</ulink>.</para>
35787 <screeninfo>RSS Feed Icon</screeninfo>
35791 <imagedata fileref="images/opac/totalresults-rss.png"/>
35796 <para>Subscribing to search results as RSS feeds will allow you to see
35797 when a new item is added to the catalog in your area of
35802 <section id="opacbibrec">
35803 <title>Bibliographic Record</title>
35805 <para>When you click on a title from the search results, you're brought
35806 to the bibliographic detail of the record. This page is broken down in
35807 several different areas.</para>
35809 <para>At the top of your screen will be the title and the GMD:</para>
35812 <screeninfo>Title</screeninfo>
35816 <imagedata fileref="images/opac/bibdetail/bibtitle.png"/>
35821 <para>Below the title the authors will be listed. These come from your
35822 1xx and 7xx fields. Clicking the author will run a search for other
35823 titles with that author.</para>
35826 <screeninfo>Author Display</screeninfo>
35830 <imagedata fileref="images/opac/bibdetail/bibauthor.png"/>
35835 <para>If you have an authority file you will see a magnifying glass to
35836 the right of author (and other) authorities. Clicking that magnifying
35837 glass will take you directly to the authority record.</para>
35840 <screeninfo>Authority link</screeninfo>
35844 <imagedata fileref="images/opac/bibdetail/authoritylink.png"/>
35849 <para>If you have your <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> preference
35850 set to 'show' you will see a material type that is determined by values
35851 in your fixed fields (learn more in the <link linkend="XSLTiTypes">XSLT
35852 Item Types</link> Appendix).</para>
35855 <screeninfo>XSLT Item Type</screeninfo>
35859 <imagedata fileref="images/opac/bibdetail/bibleader.png"/>
35864 <para>Next you'll see the description of the record you're
35868 <screeninfo>Basic Details</screeninfo>
35872 <imagedata fileref="images/opac/bibdetail/bibdetails.png"/>
35877 <para>Following that information you'll find the subject headings which
35878 can be clicked to search for other titles on similar topics</para>
35881 <screeninfo>Bibliographic Subjects</screeninfo>
35885 <imagedata fileref="images/opac/bibdetail/bibsubjects.png"/>
35890 <para>If your record has a table of contents or summary it will appear
35891 next to the 'Summary' or 'Table of Contents' label</para>
35894 <screeninfo>Summary</screeninfo>
35898 <imagedata fileref="images/opac/bibdetail/bibsummary.png"/>
35903 <para>If your record has data in the 856 fields you'll see the links to
35904 the right of the 'Online Resources' label</para>
35907 <screeninfo>Online Resources</screeninfo>
35911 <imagedata fileref="images/opac/bibdetail/biblinks.png"/>
35916 <para>If the title you're viewing is in a public list then you'll see a
35917 list of those to the right of the 'List(s) this item appears in' label
35918 and if it has tags they will appear below the 'Tags from this library'
35922 <screeninfo>Tags</screeninfo>
35926 <imagedata fileref="images/opac/bibdetail/bibtags.png"/>
35931 <para>In the tabs below the details you will find your holdings
35939 <imagedata fileref="images/opac/bibdetail/bibholdings.png"/>
35944 <para>Any notes (5xx fields) that have been cataloged will appear under
35945 'Title Notes'</para>
35948 <screeninfo>Title notes</screeninfo>
35952 <imagedata fileref="images/opac/bibdetail/bibtitlenotes.png"/>
35957 <para>If you're allowing comments they will appear in the next
35961 <screeninfo>Comments</screeninfo>
35965 <imagedata fileref="images/opac/bibdetail/bibcomments.png"/>
35970 <para>And finally if you have enabled FRBR and you have other editions
35971 of the title in your collection you will see the 'Editions' tab.</para>
35974 <screeninfo>Editions</screeninfo>
35978 <imagedata fileref="images/opac/bibdetail/bibeditions.png"/>
35983 <para>To the right of the details you'll find a series of boxes. The
35984 first box is a list of buttons to help navigate the search results. From
35985 there you can see the next or previous result from your search or return
35986 to the results.</para>
35989 <screeninfo>Search Options</screeninfo>
35993 <imagedata fileref="images/opac/bibdetail/bibsearch.png"/>
35998 <para>Clicking Browse Results at the top of the right column will open
35999 up your search results on the detail page</para>
36002 <screeninfo>Search Results</screeninfo>
36006 <imagedata fileref="images/opac/bibdetail/bibbrowseresults.png"/>
36011 <para>Below the search buttons you'll find the links to place a hold,
36012 print the record, save the record to your lists, or add it to your
36016 <screeninfo>More options</screeninfo>
36020 <imagedata fileref="images/opac/bibdetail/biboptions.png"/>
36025 <para>Clicking 'More Searches' will show the list of libraries you
36026 entered in your <link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link>
36030 <screeninfo>More Searches</screeninfo>
36034 <imagedata fileref="images/opac/bibdetail/bibmoresearch.png"/>
36039 <para>Under the 'Save Record' label you will find a series of file
36040 formats you can save the record as. This list can be customized by
36041 altering the <link linkend="OpacExportOptions">OpacExportOptions</link>
36042 system preference.</para>
36045 <screeninfo>Save Record</screeninfo>
36049 <imagedata fileref="images/opac/bibdetail/bibsave.png"/>
36054 <para>If at any time you want to change the view from the 'Normal' view
36055 to see the Marc or the ISBD you can click the tabs across the top of the
36059 <screeninfo>Record Views</screeninfo>
36063 <imagedata fileref="images/opac/bibdetail/bibviews.png"/>
36069 <section id="opaclistscart">
36070 <title>Lists & Cart</title>
36072 <para>A cart is a temporary holding place for records you're interested
36073 in finding during this session. That means that once you log out of the
36074 OPAC or close the browser you lose the items in your cart. A list is a
36075 more permanent location for saving items. To learn more about lists,
36076 check the <link linkend="stafflists">Lists in the Staff Client</link>
36077 chapter of this manual.</para>
36079 <section id="opaclists">
36080 <title>Lists</title>
36082 <para>Patrons can manage their own private lists by visiting the 'my
36083 lists' section of their account.</para>
36086 <screeninfo>Lists Management</screeninfo>
36090 <imagedata fileref="images/opac/nolists.png"/>
36095 <section id="opacaddlists">
36096 <title>Creating Lists</title>
36098 <para>Lists can also be created by choosing the 'New List' option in
36099 the 'Add to' menu on the search results</para>
36102 <screeninfo>Add to New List</screeninfo>
36106 <imagedata fileref="images/opac/addtonewlist.png"/>
36111 <para>To create a list the patron simply needs to click the 'New
36112 List' link and populate the form that appears</para>
36115 <screeninfo>Create a new list</screeninfo>
36119 <imagedata fileref="images/opac/newlist.png"/>
36124 <para>The only field required is the 'List Name,' but the patron can also choose how they
36125 want the list sorted and if the list is public or private.<itemizedlist>
36127 <para>A Private List is managed by you and can be seen only by you (depending on
36128 your permissions settings below)</para>
36131 <para>A Public List can be seen by everybody, but managed only by you (depending on
36132 your permissions settings below)</para>
36134 </itemizedlist><important>
36135 <para>If you aren't allowing patrons to create public lists with the <link linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
36136 preference then patrons will only be able to create private lists.</para>
36137 </important></para>
36140 <para>Finally decide what your permissions will be on the list. You can all or disallow:<itemizedlist>
36142 <para>anyone else to add entries</para>
36145 <para>anyone to remove his own contributed entries<itemizedlist>
36148 <para>The owner of a list is always allowed to add entries, but needs
36149 permission to remove.</para>
36152 </itemizedlist></para>
36155 <para>anyone to remove other contributed entries </para>
36157 </itemizedlist></para>
36162 <section id="opacaddtolists">
36163 <title>Adding titles to Lists</title>
36165 <para>Titles can be added to lists from the search results and/or
36166 from the bibliographic record. On the search results options to add
36167 items to the list appear below each result and across the top of the
36168 results page</para>
36171 <screeninfo>Add to Lists from Results</screeninfo>
36175 <imagedata fileref="images/opac/addtolistcart.png"/>
36180 <para>To add a single title to a list, click the 'Save to Lists'
36181 option and then choose the list you'd like to add the title to. To
36182 add multiple titles to a list check the boxes on the left of the
36183 titles you want to add and then choose the list you want to add the
36184 titles to from the 'Add too' pull down at the top of the
36188 <section id="listscontent">
36189 <title>Viewing Lists Contents</title>
36191 <para>To view the contents of a list, click on the list name under
36192 the Lists button.</para>
36195 <screeninfo>Lists</screeninfo>
36199 <imagedata fileref="images/opac/chooselist.png"/>
36204 <para>The contents of the list will look similar to your search
36205 results pages except that there will be different menu options
36206 across the top of the list.</para>
36209 <screeninfo>List View</screeninfo>
36213 <imagedata fileref="images/opac/listview.png"/>
36218 <para>Using the menu options above the list you can place multiple
36219 items on hold, download the list contents, email the list or print
36220 the list out.</para>
36224 <para>To place a hold on one or more list items check the box to
36225 the left of the item and click the 'Place Hold' link at the
36230 <para>To download the list contents click the 'Download List'
36231 link and choose the format you'd like to download the list
36237 <para>iso2079 is MARC format</para>
36244 <para>To email the list contents to someone, click the 'Send List' link and enter in
36245 your email details in the form that pops up (<link linkend="examplelistemail">view a
36246 sample Lists email</link>)</para>
36249 <screeninfo>Email List Contents</screeninfo>
36253 <imagedata fileref="images/opac/emailist.png"/>
36260 <para>To print the contents of your list out click the 'Print
36266 <section id="opacmanagelists">
36267 <title>Managing Lists</title>
36269 <para>Once the list is saved patrons can begin adding items to it.
36270 From the 'my lists' tab on the patron record the patron can edit and
36271 delete the lists they have created by clicking the appropriate link
36272 to the right of the list name.</para>
36275 <screeninfo>My Lists</screeninfo>
36279 <imagedata fileref="images/opac/mylists.png"/>
36284 <para>To edit the list's title or sorting patrons click the 'Edit'
36285 link to the right of the list description.</para>
36288 <screeninfo>Editing List</screeninfo>
36292 <imagedata fileref="images/opac/editlist.png"/>
36297 <para>When clicking 'Delete' next to a list you will be asked to
36298 confirm that you want to delete the list.</para>
36301 <screeninfo>Delete list confirmation</screeninfo>
36305 <imagedata fileref="images/opac/deletelist.png"/>
36310 <para>The list will not be deleted until the 'Confirm' button is
36311 clicked to the right of the list you'd like to delete.</para>
36317 <section id="opaccart">
36318 <title>Cart</title>
36322 <section id="opacaddtocart">
36323 <title>Adding titles to the Cart</title>
36325 <para>Titles can be added to the cart from the search results and/or
36326 from the bibliographic record. On the search results options to add
36327 items to the cart appear below each result and across the top of the
36328 results page</para>
36331 <screeninfo>Add to Cart on Search Results</screeninfo>
36335 <imagedata fileref="images/opac/addtolistcart.png"/>
36340 <para>Clicking the 'Add to Cart' button will add the one title to
36341 your cart. To add multiple titles at once, check the box to the left
36342 of each result and then choose 'Cart' from the 'Add to' pull down at
36343 the top of the screen. Once titles are added to the cart you will be
36344 presented with a confirmation</para>
36347 <screeninfo>Items added to Cart</screeninfo>
36351 <imagedata fileref="images/opac/addedtocart.png"/>
36355 <para>From the results you will see which items are in your cart and will be able to
36356 remove those items by clicking '(remove)'.<screenshot>
36357 <screeninfo>Item in your cart</screeninfo>
36360 <imagedata fileref="images/opac/iteminyourcart.png"/>
36363 </screenshot></para>
36366 <section id="manageopaccart">
36367 <title>Managing the Cart</title>
36369 <para>Once you have titles in your cart you can manage the contents by clicking on the
36370 'Cart' button usually found at the top of the screen. Your cart will open in a new
36374 <screeninfo>Contents of your cart</screeninfo>
36378 <imagedata fileref="images/opac/cartcontents.png"/>
36383 <para>From this window you are presented with several options.
36384 Across the top of the cart are several buttons.</para>
36386 <para>First is the 'More details' button. Clicking this will show you additional
36387 information about the titles in your cart (ISBNs, Subjects, Publisher Info, Notes and more).<screenshot>
36388 <screeninfo>More details in the cart</screeninfo>
36391 <imagedata fileref="images/opac/cartmoredetails.png"/>
36394 </screenshot></para>
36396 <para>Next is the option to send the contents of your cart to an email address. This is
36397 handy if you want to send the resources you found at the library to your home email
36398 account to refer to later or to send to a patron researching a specific topic. Clicking
36399 this link will open up a new window that asks for the email address and message to send.
36400 <link linkend="examplecartemail">View a sample Cart email</link>.</para>
36403 <screeninfo>Email Cart</screeninfo>
36407 <imagedata fileref="images/opac/emailcart.png"/>
36412 <para>The cart can only be emailed by logged in users. This will prevent your cart email
36413 function from being used for spamming.</para>
36416 <para>In addition to sending your cart you can download the contents
36417 of your cart in several pre-defined formats or using a <link linkend="csvprofiles">CSV Profile</link> that you defined in the
36418 Tools module.</para>
36421 <screeninfo>Download Cart</screeninfo>
36425 <imagedata fileref="images/opac/downloadcart.png"/>
36430 <para>Finally you can print out the contents of your cart by
36431 choosing the 'Print' link.</para>
36433 <para>In addition to the various different ways to save the contents
36434 of your cart, there are ways to add value to the data in your cart.
36435 By selecting one or more titles from the cart you can add them to a
36436 list (click 'Add to a List'), place hold(s) (click 'Place hold'), or
36437 tag them (click 'Tag'). All of these operations follow the same
36438 procedure as they do when performing them in the OPAC.</para>
36443 <section id="opacplacehold">
36444 <title>Placing Holds</title>
36446 <para>Patrons can place holds on items via the OPAC if they're logged in
36447 and you have the <link linkend="RequestOnOpac">RequestOnOpac</link>
36448 preference set to 'Allow'. If the item can be placed on hold the option
36449 to place it on hold will appear in several different places.</para>
36453 <para>When viewing a list or search results page you'll see the
36454 option to place hold on multiple items by checking the boxes to the
36455 left of the results and clicking 'Place Hold' at the top</para>
36458 <screeninfo>Place Hold from Results</screeninfo>
36462 <imagedata fileref="images/opac/opacplaceholdresults.png"/>
36469 <para>When viewing a list or search results page you'll see the
36470 option to place the item on hold below the basic information about
36474 <screeninfo>Place Hold</screeninfo>
36478 <imagedata fileref="images/opac/opacplaceholdsindiv.png"/>
36485 <para>When viewing an individual title you'll see the option to
36486 place a hold in the box on the right side of the screen</para>
36489 <screeninfo>Place Hold</screeninfo>
36493 <imagedata fileref="images/opac/opacplaceholdsdetail.png"/>
36500 <para>No matter which of the above links you click to place your hold
36501 you'll be brought to the same hold screen.</para>
36504 <screeninfo>Place Hold Form</screeninfo>
36508 <imagedata fileref="images/opac/opacplacehold.png"/>
36515 <para>Check the box to the left of the items you'd like to place on
36520 <para>The title includes a link back to the detail page for the
36525 <para>The priority shows where in the holds queue this hold will
36529 <para>If allowed by your <link linkend="OPACAllowUserToChooseBranch"
36530 >OPACAllowUserToChooseBranch</link> preference the patron can choose where they'd like
36531 to pick up their hold</para>
36534 <para>If you would like to see more options you can click 'Show more options'</para>
36539 <screeninfo>Place Hold Form with More Options</screeninfo>
36542 <imagedata fileref="images/opac/opacplaceholdmore.png"/>
36549 <para>If allowed by your <link linkend="OPACAllowHoldDateInFuture"
36550 >OPACAllowHoldDateInFuture</link> preference, the 'Hold Starts on Date' column will
36551 show. This field allows the patron to have their hold start on a future date.</para>
36555 <para>By default holds placed in the system remain until canceled,
36556 but if the patron fills in a 'Hold Not Needed After' date then the
36557 hold has an expiration date.</para>
36562 <para>Expired holds are removed by the <link linkend="expiredholdscron">Expired Holds Cron Job</link>, this
36563 is not an automatic process and must be set up by your system
36564 administrator</para>
36571 <para>If allowed by the <link linkend="OpacHoldNotes">OpacHoldNotes</link> preference then
36572 patrons can leave notes about their holds for the library by clicking the 'Edit notes' button</para>
36574 <screeninfo>Hold notes</screeninfo>
36577 <imagedata fileref="images/opac/holdnote.png"/>
36583 <para>If allowed by your <link linkend="OPACItemHolds">OPACItemHolds</link> preference the
36584 patron will be allowed to choose whether to place the hold on the next available copy or
36585 a specific copy</para>
36587 <screeninfo>Specific Copy Hold</screeninfo>
36590 <imagedata fileref="images/opac/opacplaceholdspecific.png"/>
36597 <para>After clicking the Place Hold button the patron will be brought to
36598 their account page where they'll see all of the items they have on
36602 <section id="opacenhancedcontent">
36603 <title>Enhanced Content</title>
36607 <section id="opactagging">
36608 <title>Tagging</title>
36610 <para>Depending on your settings for the <link linkend="TagsEnabled">TagsEnabled</link>, <link linkend="TagsInputOnList">TagsInputOnList</link> and <link linkend="TagsInputOnDetail">TagsInputOnDetail</link> preferences you
36611 may be able to add tags to bibliographic records from the search
36612 results and/or bibliographic records. If you are allowing patrons to
36613 add tags from the search results screen you will see an input box
36614 below each result and a 'Tag' option at the top of the screen.</para>
36617 <screeninfo>Tagging Options on Results</screeninfo>
36621 <imagedata fileref="images/opac/tags-results.png"/>
36626 <para>To add a tag to one item, type the tabs (separated by commas) in
36627 the 'New tag' box and click 'Add'. You will be presented with a
36628 confirmation of your tags being added.</para>
36631 <screeninfo>Tags Added on Results</screeninfo>
36635 <imagedata fileref="images/opac/tagsadded-results.png"/>
36640 <para>From the results you can also tag items in bulk by clicking the
36641 checkboxes on the left and then clicking the 'Tag' button at the top.
36642 After clicking the button it will change into an input box for you to
36643 add tags to all of the items you have selected.</para>
36646 <screeninfo>Add Tags to Multiple Items</screeninfo>
36650 <imagedata fileref="images/opac/tagaddmultiple-results.png"/>
36656 <section id="opaccomments">
36657 <title>Comments</title>
36659 <para>Patrons can leave comments in the OPAC if you have the <link linkend="reviewson">reviewson</link> preference set to allow this.
36660 Each bibliographic record has a comments tab below the bibliographic
36661 information.</para>
36664 <screeninfo>Comments Tab</screeninfo>
36668 <imagedata fileref="images/opac/commentstab.png"/>
36673 <para>If the patron is logged in they will see a link to add a comment
36674 to the item. Clicking this link will open a pop up window with a box
36675 for their comments.</para>
36678 <screeninfo>Add a Comment</screeninfo>
36682 <imagedata fileref="images/opac/addcomment.png"/>
36687 <para>Once the comment has been typed and the 'Submit' button clicked,
36688 the patron will see their comment as pending and other patrons will
36689 simply see that there are no comments on the item.</para>
36692 <screeninfo>Pending Comment</screeninfo>
36696 <imagedata fileref="images/opac/commentpending.png"/>
36701 <para>Once the comment is approved the patron will see the number of comments on the
36702 'Comments' tab and their comment labeled amongst the other comments. If you have set your
36703 <link linkend="ShowReviewerPhoto">ShowReviewerPhoto</link> preference to 'Show' then
36704 you'll see the patron's photo pulled from the <ulink url="https://www.libravatar.org"
36705 >Libravatar</ulink> library.</para>
36708 <screeninfo>Your Comments</screeninfo>
36712 <imagedata fileref="images/opac/yourcomment.png"/>
36717 <para>Other patrons will see the comment with the name of the patron
36718 who left the comment (unless you have set the <link linkend="ShowReviewer">ShowReviewer</link> preference to not show
36719 patron names).</para>
36722 <screeninfo>Comment by other patron</screeninfo>
36726 <imagedata fileref="images/opac/commentby.png"/>
36731 <para>If you have your <link linkend="OpacShowRecentComments">OpacShowRecentComments</link>
36732 set to show then you'll see the approved comments on that page.</para>
36735 <screeninfo>Recent Comments List</screeninfo>
36739 <imagedata fileref="images/opac/recentcomments.png"/>
36745 <section id="zotero">
36746 <title>Zotero</title>
36748 <para>Zotero is a Firefox add on that allows for the saving and
36749 generating of a bibliography. Learn more about and download Zotero at
36750 <ulink url="http://zotero.org">http://zotero.org</ulink>.</para>
36752 <para>When on the search results in the Koha OPAC, if you have Zotero
36753 installed, you will see a folder icon in the address bar to the right
36754 of the URL. Clicking that folder will open up a list of titles on the
36755 page for you to pick from to add to Zotero.</para>
36758 <screeninfo>Zotero pop up</screeninfo>
36762 <imagedata fileref="images/opac/zoteroaddressbar.png"/>
36767 <para>Select the titles you want to add to Zotero and then click the
36768 'OK' button. This will add the title to Zotero. You can see the title
36769 by opening your Zotero library.</para>
36772 <screeninfo>Title in the Zotero Library</screeninfo>
36776 <imagedata fileref="images/opac/zoterotitle.png"/>
36782 <section id="customrss">
36783 <title>Custom RSS Feeds</title>
36785 <para>Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for
36786 any SQL query (for example a new acquisitions RSS feed). rss.pl is run
36787 on the command line to produce an RSS XML document.</para>
36789 <para>The output should be placed in a directory accessible to the
36790 OPAC (or staff) web interface so that users can download the RSS
36793 <para>An example of usage can be found at: misc/cronjobs/rss.pl
36794 lastAcquired.conf</para>
36796 <para>Normally rss.pl should be run periodically (e.g., daily) to keep
36797 the feed up-to-date.</para>
36799 <para>The configuration file (e.g., lastAcquired.conf) lists</para>
36803 <para>name of the template file to use</para>
36807 <para>path of output file</para>
36811 <para>SQL query</para>
36815 <para>rss.pl runs the SQL query, then feeds the output of the query
36816 through the template to produce the output file.</para>
36819 <para>To use custom RSS feeds you need to turn on the rss.pl cron job.</para>
36820 </important></para>
36823 <section id="selfregistration">
36824 <title>OPAC Self Registration</title>
36825 <para>If you allow it, patrons can register for their own accounts via the OPAC. If you have
36826 the <link linkend="PatronSelfRegistration">PatronSelfRegistration</link> preference set to
36827 'Allow' then patrons will see a link to register below the log in box on the right of the
36828 main OPAC page.</para>
36830 <screeninfo>Registration link in OPAC</screeninfo>
36833 <imagedata fileref="images/opac/PatronSelfRegistration.png"/>
36837 <para>When the patron clicks the 'Register here' link they will be brough to a registration
36838 page. The options on the registration page can be conrolled by editing the <link
36839 linkend="PatronSelfRegistrationBorrowerMandatoryField"
36840 >PatronSelfRegistrationBorrowerMandatoryField</link> and the <link
36841 linkend="PatronSelfRegistrationBorrowerUnwantedField"
36842 >PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
36844 <screeninfo>Registration form</screeninfo>
36847 <imagedata fileref="images/opac/patronregistration.png"/>
36851 <para>Once the patron has confirmed submitted their registration they will either be sent an
36852 email to confirm their account (if you have the <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link>
36853 preference to require this) or presented with their new username and password.</para>
36855 <screeninfo>New account confirmation</screeninfo>
36858 <imagedata fileref="images/opac/patronregistrationcomplete.png"/>
36862 <para>Patrons registered in this way will not have a cardnumber until assigned one by the
36863 library, but will have access to all OPAC functionality immediately. For this reason it is
36864 recommended that you:<itemizedlist>
36866 <para>set up a provisional <link linkend="addingpatroncat">patron category</link> for
36867 self registered patrons (such as 'Self Registered) instead of using an existing patron
36868 category and set that value in the <link
36869 linkend="PatronSelfRegistrationDefaultCategory"
36870 >PatronSelfRegistrationDefaultCategory</link> preference</para>
36873 <para>give this patron category minimal circulation privileges in the <link
36874 linkend="circfinerules">Circulation and Fine Rules</link> (such as allowing a couple
36875 holds, but no check outs)</para>
36877 </itemizedlist>That way patrons will either have to come in to the library to verify their
36878 identity before given a cardnumber and the ability to check items out or the library will
36879 have to come up with internal policy on generating cardnumbers before providing them to self
36880 registered patrons. Once this is done the library can change the category to one that is
36881 more appropriate (be it an adult, resident, non resident, student, etc) and add a
36882 cardnumber/barcode.</para>
36885 <section id="opacmyaccount">
36886 <title>My Account</title>
36888 <para>From the OPAC patrons can log in and access their account if you
36889 have set the <link linkend="opacuserlogin">opacuserlogin</link>
36890 preference to 'Allow'. Once logged in patrons are brought to their
36891 account summary. If you would like to get to your account in the OPAC,
36892 you can click on your name in the top right of any page in the
36895 <section id="opacmysummary">
36896 <title>My Summary</title>
36899 <screeninfo>My Summary</screeninfo>
36903 <imagedata fileref="images/opac/myaccount.png"/>
36908 <para>From the 'my summary' tab, patrons will see all of the items
36909 they have checked out with the overdue items highlighted in red. If
36910 you have <link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link>
36911 set to 'Allow' then your patrons will be able to renew their books
36912 right from the OPAC. If you have HTML entered in the <link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link> preference then
36913 you will see that to the right of the 'Fines' column.</para>
36916 <screeninfo>Checked out tab with OPACMySummaryHTML set</screeninfo>
36920 <imagedata fileref="images/opac/opacsummary-wlinks.png"/>
36925 <para id="barcodeattribute">If your patrons would like to see the items barcodes on their
36926 list of checked out items you can set up a <link linkend="patronattributetypes">patron
36927 attribute</link> with the value of SHOW_BCODE and <link linkend="authorizedvalues"
36928 >authorized value</link> of YES_NO.</para>
36931 <screeninfo>Add SHOW_BCODE patron attribute</screeninfo>
36935 <imagedata fileref="images/opac/SHOW_BCODEadd.png"/>
36940 <para>Then on the <link linkend="editpatrons">patron's record set the
36941 value</link> for SHOW_BCODE to yes.</para>
36944 <screeninfo>Setting value for SHOW_BCODE on patron
36945 record</screeninfo>
36949 <imagedata fileref="images/opac/SHOW_BCODEattribute.png"/>
36954 <para>This will add a column to the check out summary in the OPAC that
36955 shows the patrons the barcodes of the items they have checked
36959 <screeninfo>Barcode number on checkout list in OPAC</screeninfo>
36963 <imagedata fileref="images/opac/barcodeoncheckouts.png"/>
36968 <para>Clicking on the 'Overdue' tab will show only the items that are
36972 <screeninfo>Overdue Items</screeninfo>
36976 <imagedata fileref="images/opac/myoverdues.png"/>
36981 <para>The 'Fines' tab will show just a total of what the patron owes.
36982 Clicking on the total will take them to the 'my fines' tab where they
36983 will see a complete breakdown of their fines and bills. If you don't
36984 charge fines at your library you can turn the display of these tabs
36985 off by setting the <link linkend="OPACFinesTab">OPACFinesTab</link>
36986 preference to 'Don't Allow.'</para>
36989 <screeninfo>Patron Fines</screeninfo>
36993 <imagedata fileref="images/opac/myfines.png"/>
36998 <para>Finally, clicking on the 'Holds' tab will show the patron the
36999 status of all of the items they have on hold. Items that are ready for
37000 pickup will be highlighted in yellow.</para>
37003 <screeninfo>Patron holds status</screeninfo>
37007 <imagedata fileref="images/opac/myholds.png"/>
37012 <para>Patrons can cancel their own holds if they are not in transit or
37013 already waiting for them. They can also suspend all of their holds
37014 (depending on the value of your <link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link> system preference)
37015 indefinitely or until a specific date if they choose by filling in the
37016 suspend options at the bottom of the page.</para>
37019 <para>If you have your <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
37020 preference set to "Don't allow" then you will not have the option to
37021 put an end date on the hold suspension</para>
37025 <section id="opacmyaccount-flags">
37026 <title>Patron Flags</title>
37028 <para>If you have <link linkend="patronflags">flagged your patron's
37029 account</link> they may see one of the following error messages at the
37030 top of their account.</para>
37034 <para>Card marked as lost</para>
37037 <screeninfo>Library card lost</screeninfo>
37041 <imagedata fileref="images/opac/nocard.png"/>
37048 <para>Patron address in question</para>
37051 <screeninfo>Patron address in question</screeninfo>
37055 <imagedata fileref="images/opac/noaddress.png"/>
37063 <para>this error message will not include a link to the
37064 update form if you have <link linkend="OPACPatronDetails">OPACPatronDetails</link> set to
37065 'Don't allow'</para>
37072 <para>Patron marked restricted</para>
37075 <screeninfo>Patron restricted</screeninfo>
37079 <imagedata fileref="images/opac/debarred.png"/>
37087 <section id="opacmyfines">
37088 <title>My Fines</title>
37090 <para>If your library charges fines the next tab on the left is 'my
37091 fines.' Opening this tab will show the patron an entire history of
37092 their accounting at the library.</para>
37095 <screeninfo>Library Fines & Charges</screeninfo>
37099 <imagedata fileref="images/opac/mybilling.png"/>
37105 <section id="opacmydetails">
37106 <title>My Details</title>
37108 <para>If you have your <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference
37109 set to 'Allow', your patrons will see a form filled in with their contacting information
37110 by clicking on the 'my personal details' tab. You can control what fields patrons see and
37111 can modify via the OPAC by setting the <link linkend="PatronSelfRegistrationBorrowerMandatoryField">PatronSelfRegistrationBorrowerMandatoryField</link>
37112 <link linkend="PatronSelfRegistrationBorrowerUnwantedField">PatronSelfRegistrationBorrowerUnwantedField</link> preferences.</para>
37115 <screeninfo>Patron's personal details</screeninfo>
37119 <imagedata fileref="images/opac/myprofile.png"/>
37124 <para>Patrons can edit their details in this form and click 'Submit Changes' to have their
37125 edits sent to the library for review before their record is updated. Staff will see all
37126 patrons requesting modification to their record listed below the modules on the main
37127 dashboard along with anything else awaiting library attention.</para>
37129 <screeninfo>Patron requests waiting review</screeninfo>
37132 <imagedata fileref="images/opac/patronrequestwaiting.png"/>
37137 <para>If the <link linkend="OPACPatronDetails">OPACPatronDetails</link> preference is set
37138 to 'Don't allow' then patrons will simply see their details in plain
37142 <screeninfo>Patron's personal details with no edits</screeninfo>
37146 <imagedata fileref="images/opac/myprofile-noedit.png"/>
37152 <section id="opacmytags">
37153 <title>My Tags</title>
37155 <para>If your library has <link linkend="TagsEnabled">TagsEnabled</link> set to 'Allowed' then the
37156 next tab on the left will be 'my tags.' This tab will show patrons all
37157 of the tags in the system as a cloud and then all of the tags they
37158 have applied in a list format. From here patrons have the ability to
37159 remove tags that they have added if they want.</para>
37162 <screeninfo>Patron's tags</screeninfo>
37166 <imagedata fileref="images/opac/mytags.png"/>
37172 <section id="opacmypassword">
37173 <title>Change My Password</title>
37175 <para>Next, if you have <link linkend="OpacPasswordChange">OpacPasswordChange</link> set to 'Allow'
37176 the next tab will be 'change my password,' where patrons can change
37177 their password for logging into the OPAC. Patrons will be presented
37178 with a standard form asking them to enter their old password and then
37179 their new password twice.</para>
37182 <screeninfo>Change my password</screeninfo>
37186 <imagedata fileref="images/opac/mypassword.png"/>
37192 <section id="opacmysearchistory">
37193 <title>My Search History</title>
37195 <para>If you have your <link linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
37196 preference set to 'Allow' then your patrons can access their search
37197 history via the 'my search history' tab.</para>
37200 <screeninfo>my search history tab</screeninfo>
37204 <imagedata fileref="images/opac/mysearchhistory.png"/>
37209 <para>The search history is a record of all searches run by the
37210 patron. Clicking on any of the search phrases will re-run the search
37211 for the patron. The search history can be deleted by the patron at any
37212 time by clicking the 'Delete your search history' link found at the
37213 top of this tab or by clicking the little red 'x' next to the 'Search
37214 history' link at the top right of the OPAC.</para>
37217 <screeninfo>Search history link at the top right of the
37222 <imagedata fileref="images/opac/searchistory.png"/>
37228 <section id="opacmyhistory">
37229 <title>My Reading History</title>
37231 <para>Depending on your library's setting for <link linkend="opacreadinghistory">opacreadinghistory</link> your patrons
37232 may see the 'my reading history' tab next. This will show the patron
37233 their entire reading history unless they have asked the library to not
37234 keep that information via the 'my privacy' tab which will appear if
37235 you have the <link linkend="OPACPrivacy">OPACPrivacy</link> preference
37236 set to 'Allow.'</para>
37239 <screeninfo>Patron reading history</screeninfo>
37243 <imagedata fileref="images/opac/myhistory.png"/>
37249 <section id="opacmyprivacy">
37250 <title>My Privacy</title>
37252 <para>The 'my privacy' tab will appear if you have both the <link linkend="opacreadinghistory">opacreadinghistory</link> and the <link linkend="OPACPrivacy">OPACPrivacy</link> preferences set to 'Allow.'
37253 This tab will allow the patrons to decide how the library keeps their
37254 circulation history data.</para>
37257 <screeninfo>my privacy tab</screeninfo>
37261 <imagedata fileref="images/opac/myprivacy.png"/>
37266 <para>The patron can choose from three options:</para>
37270 <para>Forever: keep my reading history without limit. This is the
37271 option for users who want to keep track of what they are
37276 <para>Default: keep my reading history according to local laws.
37277 This is the default option : the library will keep your reading
37278 history for the duration permitted by local laws.</para>
37282 <para>Never: Delete my reading history immediately. This will
37283 delete all record of the item that was checked-out upon
37288 <para>Depending on the patron's suggestions the contents of the '<link linkend="opacmyhistory">my reading history</link>' tab and the '<link linkend="circhistory">Circulation History</link>' tab in the staff
37289 client may change.</para>
37291 <para>Regardless of the patron's choice they can delete their reading
37292 history in bulk at any time by clicking the 'Immediate deletion'
37296 <screeninfo>Delete Circulation History</screeninfo>
37300 <imagedata fileref="images/opac/deletecirchistory.png"/>
37305 <para>Clicking this button will not delete items that are currently
37306 checked out, but will clear the patron's past reading history.</para>
37309 <section id="opacmysuggestions">
37310 <title>My Purchase Suggestions</title>
37312 <para>If your library allows patrons to make purchase suggestions the
37313 next tab will show all suggestions that the patron made to the library
37314 and their statuses. To disable this tab and the suggestion
37315 functionality set the <link linkend="suggestionspref">suggestion</link> preference to 'Don't
37319 <screeninfo>Patron purchase suggestions</screeninfo>
37323 <imagedata fileref="images/opac/mysuggestions.png"/>
37329 <section id="opacmymsgs">
37330 <title>My Messaging</title>
37332 <para>If your library has the <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
37333 preference set to 'Allow' then your patrons will be able to choose
37334 which messages they receive from the library (with the exception of
37335 overdue notices which the library controls).</para>
37338 <screeninfo>Patron messaging preferences</screeninfo>
37342 <imagedata fileref="images/opac/mymessages.png"/>
37347 <para>If you also allow SMS messages with the <link linkend="SMSSendDriver">SMSSendDriver</link> preference, you will see
37348 an additional column to receive these messages as SMS (or text
37349 messages) and a field for a cell (or SMS) number.</para>
37352 <screeninfo>SMSSendDriver in the OPAC</screeninfo>
37356 <imagedata fileref="images/opac/OPACSMSSendDriver.png"/>
37362 <para>These notices are:</para>
37365 <para>Advanced Notice : A notice in advance of the patron's items being due (The
37366 patron can choose the number of days in advance)</para>
37369 <para>Item Checkout : A notice that lists all the of the items the patron has just
37370 checked out and/or renewed, this is an electronic form of the checkout
37374 <para>Hold Filled : A notice when you have confirmed the hold is waiting for the
37378 <para>Item Due : A notice on the day and item is due back at the library</para>
37381 <para>Item Checkin : A notice that lists all the of the items the patron has just
37389 <section id="opacmylists">
37390 <title>My Lists</title>
37392 <para>Finally, if your library has the <link linkend="virtualshelves">virtualshelves</link> set to 'Allow' then the
37393 last tab will by 'my lists.' From here your patrons can review public
37394 lists and create or edit their own private lists.</para>
37397 <screeninfo>Patron lists</screeninfo>
37401 <imagedata fileref="images/opac/mylists.png"/>
37408 <section id="purchasesuggest">
37409 <title>Purchase Suggestions</title>
37411 <para>If your library has the <link linkend="suggestionspref">suggestion</link> preference set to 'Allow'
37412 then patrons will have the option to make purchase suggestions in
37413 several areas in the OPAC.</para>
37415 <para>If you are allowing everyone to see the purchase suggestions made by others with the
37416 <link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link> preference,
37417 then there will be a link at the top of your OPAC under the search box.</para>
37420 <screeninfo>Purchase Suggestions Link on Search Box</screeninfo>
37424 <imagedata fileref="images/opac/suggestfromsearch.png"/>
37429 <para>There will be a link when the patron finds nothing for their
37433 <screeninfo>Purchase Suggestion Link from Search Results</screeninfo>
37437 <imagedata fileref="images/opac/suggestfromnoresults.png"/>
37442 <para>And there will be a link on the patron's <link linkend="opacmysuggestions">My Purchase Suggestions</link> tab.</para>
37445 <screeninfo>Purchase Suggestion from My Purchase Suggestions
37450 <imagedata fileref="images/opac/suggestfrommyaccount.png"/>
37455 <para>Clicking any one of these links will open the purchase suggestion
37459 <screeninfo>New Purchase Suggestion</screeninfo>
37463 <imagedata fileref="images/opac/newsuggestion.png"/>
37470 <para>From the form on the 'Title' is required by the
37475 <para>If you would like the 'Reason for suggestion' menu shown in
37476 the screenshot above to appear on your suggestions list you need to
37477 add an <link linkend="authorizedvalues">authorized value</link>
37478 category titled 'OPAC_SUG' and include reasons as values in that
37483 <para>If you would like the patron to be able to choose which branch
37484 they are making a suggestion for you need to set the <link linkend="AllowPurchaseSuggestionBranchChoice">AllowPurchaseSuggestionBranchChoice</link>
37485 preference to 'Allow'</para>
37489 <para>Once the form is submitted the data will be saved to the <link linkend="managesuggest">Acquisitions</link> module for the librarians to
37492 <section id="mobileopac">
37493 <title>Mobile OPAC</title>
37494 <para>If you have chosen to use the CCSR theme (set in the <link linkend="opacthemes">opacthemes</link> preference) then you also have a mobile specific view for your OPAC. </para>
37495 <para>The main page of your OPAC will be customized per your <link linkend="opacprefs">OPAC
37496 system preferences</link> (always be sure to test in customizations on the desktop in
37497 multiple browsers and on as many mobile devices as possible. Your main page will look
37498 something like this:</para>
37501 <screeninfo>Mobile OPAC</screeninfo>
37504 <imagedata fileref="images/opac/mobile/mobileccsr.png"/>
37509 <para>Your search results will look something like this:</para>
37512 <screeninfo>Mobile search results</screeninfo>
37515 <imagedata fileref="images/opac/mobile/mobilesearchccsr.png"/>
37520 <para>A detail page will show more info along with the place hold link in the top right</para>
37525 <imagedata fileref="images/opac/mobile/mobiledetail.png"/>
37529 <para>Clicking the place hold link on the search results or detail page will open up the holds
37530 screen for placing holds</para>
37535 <imagedata fileref="images/opac/mobile/mobilehold.png"/>
37539 <para>Patrons will be able to log in to their account and see what they have checked out</para>
37544 <imagedata fileref="images/opac/mobile/mobilemyaccount.png"/>
37548 <para>Once logged in they can click the menu button in the top left to see the usualy patron
37549 account menu</para>
37554 <imagedata fileref="images/opac/mobile/mobilemenu.png"/>
37558 <para>They will be able to renew items (if you allow renewals via the OPAC)</para>
37563 <imagedata fileref="images/opac/mobile/mobilerenew.png"/>
37570 <chapter id="searching">
37571 <title>Searching</title>
37575 <section id="searchprefixes">
37576 <title>Advanced Search Prefixes</title>
37578 <para>The following prefixes can be added to search terms in the keyword
37579 search box to limit items returned</para>
37583 <para>ti: title search</para>
37587 <para>ex. ti:hamlet</para>
37593 <para>su: subject search</para>
37597 <para>ex. su:cooking</para>
37603 <para>pb: publisher search</para>
37607 <para>ex. pb:penguin</para>
37613 <para>au: author search</para>
37617 <para>ex. au:rowling</para>
37623 <para>su-geo: geographic subjects</para>
37627 <para>ex. su-geo:wales and kw:description and kw:travel</para>
37633 <para>bc: barcode</para>
37637 <para>ex. bc:502326000912</para>
37643 <para>lex: lexile</para>
37647 <para>levels lex:510</para>
37656 <section id="searchguide">
37660 <firstname>Becky</firstname>
37661 <surname>Bell</surname>
37663 <orgname>WALDO</orgname>
37668 <firstname>Nicole C.</firstname>
37669 <surname>Engard</surname>
37670 <contrib>Fixed typos, changed content where necessary and added new
37671 screenshots.</contrib>
37675 <pubdate>October 2008</pubdate>
37677 <title>Guide to Searching</title>
37679 <para>This brief guide will explain a chart that shows a sample of how a
37680 MARC21 database can be configured, as well as a brief introductory
37681 searching guide. The indexing fields described in this document relate
37682 to the bibliographic data and does not address authority database
37685 <section id="searchguide-indexing">
37686 <title>Indexing and Searching Description</title>
37688 <para>Koha's databases are indexed by the Zebra open-source software.
37689 The overview to the documentation describes Zebra as:</para>
37692 <para>"...Zebra is a high-performance, general-purpose structured
37693 text indexing and retrieval engine. It reads records in a variety of
37694 input formats (eg. email, XML, MARC) and provides access to them
37695 through a powerful combination of Boolean search expressions and
37696 relevance-ranked free-text queries.</para>
37698 <para>Zebra supports large databases (tens of millions of records,
37699 tens of gigabytes of data). It allows safe, incremental database
37700 updates on live systems. Because Zebra supports the
37701 industry-standard information retrieval protocol, Z39.50, you can
37702 search Zebra databases using an enormous variety of programs and
37703 toolkits, both commercial and free, which understands this
37704 protocol..." Zebra - User's Guide and Reference, p. 1, <ulink url="http://www.indexdata.dk/zebra/doc/zebra.pdf">http://www.indexdata.dk/zebra/doc/zebra.pdf</ulink></para>
37707 <para>This brief guide will explain a chart that shows a sample of how
37708 a MARC21 database can be configured, as well as a brief introductory
37709 searching guide. The indexing fields described in this document relate
37710 to the bibliographic data and does not address authority database
37714 <para>The indexing described in this document is the set used by
37715 SouthEastern University. Your local indexing may vary.</para>
37719 <section id="searchguide-indexconfig">
37720 <title>Indexing Configuration</title>
37722 <para>There are three configuration files that Koha uses while
37725 <para>The first configuration file (etc/zebradb/biblios/etc/bib1.att)
37726 contains the Z39.50 bib-1 attribute list, plus the Koha local use
37727 attributes for Biblio Indexes, Items Index, and Fixed Fields and other
37728 special indexes. The Z39.50 Bib-1 profile is made up of several
37729 different types of attributes: Use, Relation, Position, Structure,
37730 Truncation, and Completeness. The bib-1 'Use' attribute is represented
37731 on the chart; the other attributes are used primarily when doing
37732 searches. While there are over 150+ use attributes that could be used
37733 to define your indexing set, it's unlikely that you will choose to use
37734 them all. The attributes you elect to use are those that become the
37735 indexing rules for your database. The other five attribute sets define
37736 the various ways that a search can be further defined, and will not
37737 specifically be addressed in this document. For a complete list of the
37738 standard Bib-1 attributes, go to <ulink url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink>.</para>
37740 <para>The second file
37741 (etc/zebradb/marc_defs/[marc21|unimarc]/biblios/record.abs) contains
37742 the abstract syntax which maps the MARC21 tags to the set of Use
37743 Attributes you choose to use. The rules established in this file
37744 provides a passable Bath level 0 and 1 service, which includes author,
37745 title, subject, keyword and exact services such as standard
37746 identifiers (LCCN, ISBN, ISSN, etc.)</para>
37748 <para>The third file (etc/zebradb/ccl.properties) is the Common
37749 Command Language (CCL) field mappings. This file combines the bib-1
37750 attribute set file and the abstract file and adds the qualifiers,
37751 usually known as index names. The qualifiers, or indexes, for this
37752 database are: pn, cpn, cfn, ti, se, ut, nb, ns, sn, lcn, callnum, su,
37753 su-to, su-geo, su-ut, yr,pubdate, acqdate, ln, pl, ab, nt, rtype,
37754 mc-rtype, mus, au, su-na, kw, pb, ctype, and an.</para>
37756 <para>The <link linkend="kohasearchindexes">Koha Indexing Chart</link> summarizes the
37757 contents of all three of these files in a more readable format. The first two columns
37758 labeled Z39.50 attribute and Z39.50 name matches the Z39.50 bib-1 attributes file. The
37759 third column labeled MARC tags indexed is where you find which MARC tags are mapped to an
37760 attribute. The fourth column labeled Qualifiers identifies the search abbreviations used
37761 in the internal CCL query. The following description provides a definition for the word
37762 'qualifiers'.</para>
37764 <para><emphasis>Qualifiers are used to direct the search to a
37765 particular searchable index, such as title (ti) and author indexes
37766 (au). The CCL standard itself doesn't specify a particular set of
37767 qualifiers, but it does suggest a few shorthand notations. You can
37768 customize the CCL parser to support a particular set of qualifiers to
37769 reflect the current target profile. Traditionally, a qualifier would
37770 map to a particular use-attribute within the BIB-1attribute set. It is
37771 also possible to set other attributes, such as the structure
37772 attribute.</emphasis></para>
37774 <para>In the MARC tags indexed column, there are some conventions used
37775 that have specific meanings. They are:</para>
37779 <para>A three digit tag (100) means that all subfields in the tag
37780 can be used in a search query. So, if you enter a search for
37781 'Jackson' as an author, you will retrieve records where Jackson
37782 could be the last name or the first name.</para>
37786 <para>A three digit tag that has a '$' followed by a letter
37787 (600$a) means that a search query will only search the 'a'
37792 <para>A three digit tag that is followed by a ':' and a letter
37793 (240:w) means that a search query can be further qualified. The
37794 letter following the ':' identifies how to conduct the search. The
37795 most common values you'll see are 'w' (word), 'p' (phrase), 's'
37796 (sort), and 'n' (numeric).</para>
37800 <para>The contents of the MARC tags, subfields, and/or fixed field
37801 elements that are listed in this chart are all indexed. You'll see
37802 that every attribute line is not mapped to a specific qualifier
37803 (index)-LC card number, line 9 is one example. However, every indexed
37804 word (a string of characters preceded and succeeded by a space) can be
37805 searched using a keyword (kw) search. So, although an LC card number
37806 specific index doesn't exist, you can still search by the LCCN since
37807 tag 010 is assigned to the LC-card-number attribute. To verify this,
37808 enter 72180055 in the persistent search box. You should retrieve The
37809 gods themselves, by Isaac Asimov.</para>
37811 <para>Examples of fixed field elements indexing can be seen on the
37812 chart between Attribute 8822 and Attribute 8703. These attributes are
37813 most commonly used for limiting. The fixed field attributes currently
37814 represent the BK codes. Other format codes, if needed, could be
37818 <section id="searchguide-basics">
37819 <title>Basic Searching</title>
37821 <para>The search box that library staff and library patrons will see
37822 most often is the persistent search box at the top of the page. Koha
37823 interprets the searches as keyword searches.</para>
37826 <screeninfo>Koha search box</screeninfo>
37830 <imagedata fileref="images/searching/searchbox.png"/>
37835 <para>To start a search, you enter a word or multiple words in the
37836 search box. When a single word is entered, a keyword search is
37837 performed. You can check this out by typing one word into the form and
37838 note the number of results located. Then, repeat the search with a
37839 minor change. In front of the search word, type 'kw=' followed by the
37840 same search term. The results will be identical.</para>
37842 <para>When you have more than one word in the search box, Koha will
37843 still do a keyword search, but a bit differently. Each word will be
37844 searched on its own, then the Boolean connector 'and' will narrow your
37845 search to those items with all words contained in matching
37848 <para>Suppose you want to find material about how libraries are using
37849 mashups. You'll select the major words and enter them into the
37850 persistent search box.</para>
37853 <screeninfo>Keyword Search</screeninfo>
37857 <imagedata fileref="images/searching/searchterms.png"/>
37862 <para>The response to this search is:</para>
37865 <screeninfo>Results</screeninfo>
37869 <imagedata fileref="images/searching/resultssummary.png"/>
37874 <para>The order of the words does not affect the retrieval results, so
37875 you could also enter the search as "mashups library". The response to
37876 this search is results</para>
37879 <screeninfo>Results</screeninfo>
37883 <imagedata fileref="images/searching/resultssummary2.png"/>
37888 <para>Too many words in the search box will find very few matches, as
37889 the following example illustrates:</para>
37892 <screeninfo>No results found</screeninfo>
37896 <imagedata fileref="images/searching/noresults.png"/>
37902 <section id="searchguide-advanced">
37903 <title>Advanced Searching</title>
37905 <para>When you can't find the most appropriate material with a general
37906 search, you can move to the Advanced Search page by clicking on the
37907 Search option on the persistent toolbar.</para>
37910 <screeninfo>Koha Menu</screeninfo>
37914 <imagedata fileref="images/searching/menubar.png"/>
37919 <para>The Advanced Search page offers many ways to limit the results
37920 of your search. You can search using the Boolean operators AND, OR,
37921 and NOT; limit by item type; limit by year and language; limit by
37922 subtypes audience, content, format, or additional content types; by
37923 location and by availability.</para>
37925 <para>The first limiting section on the Advanced Search page provides
37926 a quick and simple way to use the Boolean operators in your search.
37927 Note that this display depends on a system preference setting. This
37928 option can be found on the Administration > System Preferences >
37929 Searching page. The option called <link linkend="expandedSearchOption">expandedSearchOption</link> must be set
37930 to 'show' to see the following display.</para>
37933 <screeninfo>Advanced Search Options</screeninfo>
37937 <imagedata fileref="images/searching/searchoptions.png"/>
37942 <para>In this section you can choose among the many indexes by
37943 clicking on the arrow in the first box. The blank box that follows is
37944 where you enter your first search term or terms. On the second line,
37945 you can choose the Boolean operator you want to use in your search.
37946 The options are 'and', 'or', and 'not'. Then, you would again choose
37947 the index to search, followed by the second term or terms. If you have
37948 more concepts you want to include in your search, you can click the
37949 [+] to add another line for your search.</para>
37951 <para>A sample search is shown next, followed by its results:</para>
37954 <screeninfo>Advanced Search</screeninfo>
37958 <imagedata fileref="images/searching/advsearch.png"/>
37964 <screeninfo>Results from Advanced Search</screeninfo>
37968 <imagedata fileref="images/searching/numresults.png"/>
37973 <para>When you use the Boolean operators to broaden or narrow a
37974 search, remember the action of each operator. The 'and' operator
37975 narrows the results you'll retrieve because the search will retrieve
37976 the records that include all your search terms. The 'or' operator
37977 expands the results because the search will look for occurrences of
37978 all of your search terms. The 'not' operator excludes records with the
37979 term that follows the operator.</para>
37981 <para>Note: If you leave this <link linkend="expandedSearchOption">expandedSearchOption</link> set to
37982 'don't show', this is the display you will see:</para>
37985 <screeninfo>Fewer Search Options</screeninfo>
37989 <imagedata fileref="images/searching/feweropts.png"/>
37994 <para>The Advanced Search page then shows the multiple kinds of limits
37995 that can be applied to your search results. Either check a box or
37996 select from the drop down menus to narrow your search. You will type
37997 the year, year range, or a 'greater than (>)' or 'less than (<)'
38001 <screeninfo>Other Advanced Search Options</screeninfo>
38005 <imagedata fileref="images/searching/advoptions.png"/>
38010 <para>Finally, you can choose how the results will be sorted. The
38011 pre-defined sort options are in the final area of the Advanced Search
38015 <screeninfo>Sort Results By</screeninfo>
38019 <imagedata fileref="images/searching/advsortby.png"/>
38024 <para>The default sort is by relevance, although you can choose to sort by author, by title,
38025 by call number, by dates, or by popularity (which uses the information on total issues
38026 found in the items table). If you would prefer a different default sort, you can set <link
38027 linkend="defaultSortField">defaultSortField</link> to one of the other choices in
38028 Administration > System Preferences > Searching.</para>
38031 <section id="searchguide-ccl">
38032 <title>Common Command Language Searching</title>
38034 <para>Koha uses the Common Command Language (CCL) (ISO 8777) as its
38035 internal search protocol. Searches initiated in the graphical
38036 interface use this protocol as well, although the searcher doesn't
38037 know which indexes, operators and limiters are available and being
38038 used to conduct their search. The searcher can use the Advanced Search
38039 when more precise results set are desired and where the search indexes
38040 are somewhat known. However, some library users and many library staff
38041 prefer using a command based structure. This part of the document will
38042 present and explain the use of the Koha command based structure. The
38043 indexes, operators, and limiters used are identical to those used in
38044 the graphical interface.</para>
38046 <section id="searchguide-indexes">
38047 <title>Indexes</title>
38049 <para>The CCL standard itself doesn't specify a particular set of
38050 qualifiers (indexes), but it does suggest a few short-hand notations
38051 such as 'ti', 'au', and 'su'. Koha has a default set of indexes;
38052 it's possible to customize that set by adding needed indexes based
38053 on local requirements. A qualifier (index) maps to a particular
38054 use-attribute within the Z39.50 BIB-1 attribute set. The complete
38055 Z39.50 Bib-1 Attribute can be viewed at <ulink url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink>.</para>
38057 <para>The standard Koha set of indexes is a fairly common example of
38058 MARC21 indexing rules. The indexes that are defined in Koha are
38059 indexes typically used by other integrated library systems. The
38060 defined Z39.50 Bib-1 Attribute mapped to the indexes include:</para>
38062 <table cellpadding="4" cellspacing="4" frame="all">
38063 <title>Attributes</title>
38065 <tgroup align="left" cols="2" colsep="1" rowsep="1">
38068 <entry>Bib-1 Attribute</entry>
38070 <entry>Qualifier (index)</entry>
38076 <entry>Personal-name</entry>
38082 <entry>Corporate-name</entry>
38088 <entry>Conference-name</entry>
38094 <entry>Title</entry>
38100 <entry>Title-series</entry>
38106 <entry>Title-uniform</entry>
38112 <entry>ISBN</entry>
38118 <entry>ISSN</entry>
38124 <entry>Local number</entry>
38130 <entry>Local-classification</entry>
38132 <entry>lcn and callnum</entry>
38136 <entry>Subject</entry>
38138 <entry>su, su-to, su-geo, su-ut</entry>
38142 <entry>Pubdate</entry>
38144 <entry>yr,pubdate</entry>
38148 <entry>Date-of-Acquisition</entry>
38150 <entry>acqdate</entry>
38154 <entry>Language</entry>
38160 <entry>Place-of-publication</entry>
38166 <entry>Abstract</entry>
38172 <entry>Notes</entry>
38178 <entry>Record-type</entry>
38180 <entry>rtype, mc-rtype, mus</entry>
38184 <entry>Author</entry>
38186 <entry>au, aut</entry>
38190 <entry>Subject-person-name</entry>
38192 <entry>su-na</entry>
38196 <entry>Any (keyword)</entry>
38202 <entry>Publisher</entry>
38208 <entry>Content-type</entry>
38210 <entry>ctype</entry>
38214 <entry>Koha-Auth-Number</entry>
38220 <entry>Author-personal-bibliography</entry>
38226 <entry>Author-in-order</entry>
38234 <para>Refer to the <link linkend="kohasearchindexes">Koha Indexing Chart</link> for the
38235 MARC21 tags mapped to each Bib-1 Attribute and index combination.</para>
38237 <section id="search-audexamp">
38238 <title>Audience Examples</title>
38242 <para>aud:a Preschool</para>
38245 <para>aud:b Primary</para>
38248 <para>aud:c Pre-Adolescent</para>
38251 <para>aud:d Adolescent</para>
38255 <para>aud:e Adult</para>
38258 <para>aud:f Specialized</para>
38261 <para>aud:g General</para>
38264 <para>aud:j Juvenile</para>
38269 <section id="search-contentsexamp">
38270 <title>Contents Examples</title>
38274 <para>fic:1 Fiction</para>
38278 <para>fic:0 Non Fiction</para>
38282 <para>bio:b Biography</para>
38286 <para>mus:j Musical recording</para>
38290 <para>mus:I Non musical record</para>
38296 <section id="searchguide-syntax">
38297 <title>Search Syntax</title>
38299 <para>In the persistent search box, single words generally retrieve
38300 large sets. To narrow a search, you can use multiple words. Koha
38301 automatically uses the 'and' Boolean operator to create a set of
38302 records matching your input. When you want to narrow the search to
38303 an author or a title or a subject or some other specific field or
38304 use a Boolean operator, there isn't an obvious way to accomplish
38305 that specificity. The library user can, of course, go to the
38306 Advanced Search page; however, if you know how to construct a CCL
38307 search, you can achieve more specificity while using the persistent
38308 search box on any page.</para>
38310 <para>There is a specific order to the CCL search syntax. Although
38311 it can be used for simple searches, it is an especially effective
38312 way to perform complex searches, as it affords you a great deal of
38313 control over your search results. To construct a CCL search, first
38314 enter a desired index code, then an equal sign, followed by your
38315 search word(s). Following are examples of simple CCL
38320 <para>ti=principles of accounting</para>
38324 <para>au=brown joseph</para>
38328 <para>su=poetry</para>
38332 <para>su-na=Shakespeare</para>
38336 <para>kw=marlin</para>
38340 <para>You can refine your search by combining search terms with
38341 Boolean operators 'and', 'or', or 'not'. Following are examples of
38342 searches using Boolean operators.</para>
38346 <para>ti=principles of accounting and au=brown joseph</para>
38350 <para>su=poetry not su-na=Shakespeare</para>
38354 <para>kw=communication and su=debate</para>
38358 <para>You can also choose to search for things that start with a
38359 character or series of characters</para>
38363 <para>ti,first-in-subfield=C (will show you all titles that
38364 start with the letter 'C')</para>
38368 <para>Other string location searches can be performed with the
38369 following keywords:</para>
38373 <para>rtrn : right truncation</para>
38377 <para>ltrn : left truncation</para>
38381 <para>lrtrn : left and right truncation</para>
38385 <para>st-date : type date</para>
38389 <para>st-numeric : type number (integer)</para>
38393 <para>ext : exact search on whole subfield (does not work with
38398 <para>phr : search on phrase anywhere in the subfield</para>
38402 <para>startswithnt : subfield starts with</para>
38406 <para>Using specific indexes and Boolean operators are not the only
38407 way a search can be refined. You can also refine your search as a
38408 phrase when looking for a title, author, or subject. The syntax for
38409 this search is <emphasis>index,phr=search words</emphasis>.</para>
38411 <para>To illustrate the results of various search types, a search
38412 was done for the words 'supreme court'. The results illustrate that
38413 the search index and the word order make a difference in search
38414 results. Only the results count and the search itself is in these
38415 examples. The search executed will always be between the single
38419 <screeninfo>Sample Search 1</screeninfo>
38423 <imagedata fileref="images/searching/ex1.png"/>
38429 <screeninfo>Sample Search 2</screeninfo>
38433 <imagedata fileref="images/searching/ex2.png"/>
38439 <screeninfo>Sample Search 3</screeninfo>
38443 <imagedata fileref="images/searching/ex3.png"/>
38449 <screeninfo>Sample Search 4</screeninfo>
38453 <imagedata fileref="images/searching/ex4.png"/>
38459 <screeninfo>Sample Search 5</screeninfo>
38463 <imagedata fileref="images/searching/ex5.png"/>
38469 <screeninfo>Sample Search 6</screeninfo>
38473 <imagedata fileref="images/searching/ex6.png"/>
38479 <screeninfo>Sample Search 7</screeninfo>
38483 <imagedata fileref="images/searching/ex7.png"/>
38489 <screeninfo>Sample Search 8</screeninfo>
38493 <imagedata fileref="images/searching/ex8.png"/>
38499 <screeninfo>Sample Search 9</screeninfo>
38503 <imagedata fileref="images/searching/ex9.png"/>
38508 <para>You can also choose to use limiters in your search query. Some
38509 common limiters include dates, languages, record types, and item
38510 types. In the Advance Search, you can either click a box or key in
38511 data to limit your search. You can also apply the same limits with
38512 CCL by using the syntax in the following examples. In all</para>
38514 <para><emphasis>By Date: su=supreme court and
38515 yr,st-numeric=>2000</emphasis></para>
38518 <screeninfo>Sample Search 10</screeninfo>
38522 <imagedata fileref="images/searching/ex10.png"/>
38527 <para>When you limit by date, you can use the '>' (greater than),
38528 '<' (less than), '=' (equal), or 'yyyy-yyyy' (range)
38531 <para><emphasis>By Item Type: su=nursing and
38532 itype:BK</emphasis></para>
38535 <screeninfo>Sample Search 11</screeninfo>
38539 <imagedata fileref="images/searching/ex11.png"/>
38544 <para>Each library will have a different set of item types defined
38545 in their circulation configuration. When you set up item types, you
38546 define a code and a name for each one. The name will appear on the
38547 Advance Search page. The code you assigned is used as a CCL search
38548 limit, formatted as 'itype:x', where 'x' is the assigned code. The
38549 initial set of item types in Koha will usually be edited to reflect
38550 your collections, so your item type limiters may be different than
38551 the initial ones. The initial item type limiters follow.</para>
38555 <para>itype:BKS Books, Booklets, Workbooks</para>
38559 <para>itype:SR Audio Cassettes, CDs</para>
38563 <para>itype:IR Binders</para>
38567 <para>itype:CF CD-ROMs, DVD-ROMs, General Online
38572 <para>itype:VR DVDs, VHS</para>
38576 <para>itype:KT Kit</para>
38580 <para>itype:AR Models</para>
38584 <para>itype:SER Serials</para>
38588 <para><emphasis>By format: su=supreme court not
38589 l-format:sr</emphasis></para>
38592 <screeninfo>Sample Search 12</screeninfo>
38596 <imagedata fileref="images/searching/ex12.png"/>
38601 <para>The format limiters are derived from a combination of LDR, 006
38602 and 007 positions. The formats that are currently defined are the
38607 <para>l-format:ta Regular print</para>
38611 <para>l-format:tb Large print</para>
38615 <para>l-format:fk Braille</para>
38619 <para>l-format:sd CD audio</para>
38623 <para>l-format:ss Cassette recording</para>
38627 <para>l-format:vf VHS tape</para>
38631 <para>l-format:vd DVD video</para>
38635 <para>l-format:co CD software</para>
38639 <para>l-format:cr Website</para>
38643 <para><emphasis>By content type: su=supreme court not
38644 ctype:l</emphasis></para>
38647 <screeninfo>Sample Search 13</screeninfo>
38651 <imagedata fileref="images/searching/ex13.png"/>
38656 <para>The content types are taken from the 008 MARC tag, positions
38659 <para>There are two other limiter types that are not described in
38660 this document. They are: Audience and Content. The only difference
38661 in the syntax of the CCL is the actual limiter. They are reproduced
38662 here just in case you would like to use these limiters.</para>
38667 <section id="kohasearchindexes">
38668 <title>Koha Search Indexes</title>
38670 <para>By default, not all fields are indexed in the Zebra search engine,
38671 but many are. Below are the MARC21 fields that are indexed in
38674 <table cellpadding="4" cellspacing="4" frame="all">
38675 <title>Indexes</title>
38677 <tgroup align="left" cols="2" colsep="1" rowsep="1">
38680 <entry><para>Field</para></entry>
38682 <entry><para>Description</para></entry>
38688 <entry><para>001</para></entry>
38690 <entry><para>Control-number</para></entry>
38694 <entry><para>005</para></entry>
38696 <entry><para>Date/time-last-modified</para></entry>
38700 <entry><para>007</para></entry>
38702 <entry><para>Microform-generation:n:range(data,11,1),
38703 Material-type,ff7-00:w:range(data,0,1),
38704 ff7-01:w:range(data,1,1), ff7-02:w:range(data,2,1),
38705 ff7-01-02:w:range(data,0,2)</para></entry>
38709 <entry><para>008</para></entry>
38711 <entry><para>date-entered-on-file:n:range(data,0,5),
38712 date-entered-on-file:s:range(data,0,5),
38713 pubdate:w:range(data,7,4), pubdate:n:range(data,7,4),
38714 pubdate:y:range(data,7,4), pubdate:s:range(data,7,4),
38715 pl:w:range(data,15,3), ta:w:range(data,22,1),
38716 ff8-23:w:range(data,23,1), ff8-29:w:range(data,29,1),
38717 lf:w:range(data,33,1), bio:w:range(data,34,1),
38718 ln:n:range(data,35,3), ctype:w:range(data,24,4),
38719 Record-source:w:range(data,39,0)</para></entry>
38723 <entry><para>010</para></entry>
38725 <entry><para>LC-card-number, Identifier-standard</para></entry>
38729 <entry><para>011</para></entry>
38731 <entry><para>LC-card-number, Identifier-standard</para></entry>
38735 <entry><para>015</para></entry>
38737 <entry><para>BNB-card-number, BGF-number, Number-db,
38738 Number-natl-biblio, Identifier-standard</para></entry>
38742 <entry><para>017</para></entry>
38744 <entry><para>Number-legal-deposit,
38745 Identifier-standard</para></entry>
38749 <entry><para>018</para></entry>
38751 <entry><para>Identifier-standard</para></entry>
38755 <entry><para>020$a</para></entry>
38757 <entry><para>ISBN:w, Identifier-standard:w</para></entry>
38761 <entry><para>020</para></entry>
38763 <entry><para>Identifier-standard</para></entry>
38767 <entry><para>022$a</para></entry>
38769 <entry><para>ISSN:w, Identifier-standard:w</para></entry>
38773 <entry><para>022</para></entry>
38775 <entry><para>Identifier-standard</para></entry>
38779 <entry><para>023</para></entry>
38781 <entry><para>Identifier-standard</para></entry>
38785 <entry><para>024$a</para></entry>
38787 <entry><para>Identifier-other</para></entry>
38791 <entry><para>024</para></entry>
38793 <entry><para>Identifier-standard</para></entry>
38797 <entry><para>025</para></entry>
38799 <entry><para>Identifier-standard</para></entry>
38803 <entry><para>027</para></entry>
38805 <entry><para>Report-number, Identifier-standard</para></entry>
38809 <entry><para>028</para></entry>
38811 <entry><para>Number-music-publisher,
38812 Identifier-standard</para></entry>
38816 <entry><para>030</para></entry>
38818 <entry><para>CODEN, Identifier-standard</para></entry>
38822 <entry><para>034</para></entry>
38824 <entry><para>Map-scale</para></entry>
38828 <entry><para>037</para></entry>
38830 <entry><para>Identifier-standard, Stock-number</para></entry>
38834 <entry><para>040</para></entry>
38836 <entry><para>Code-institution, Record-source</para></entry>
38840 <entry><para>041</para></entry>
38842 <entry><para>ln</para></entry>
38846 <entry><para>043</para></entry>
38848 <entry><para>Code-geographic</para></entry>
38852 <entry><para>050$b</para></entry>
38854 <entry><para>LC-call-number:w, LC-call-number:p,
38855 LC-call-number:s</para></entry>
38859 <entry><para>050</para></entry>
38861 <entry><para>LC-call-number:w, LC-call-number:p,
38862 LC-call-number:s</para></entry>
38866 <entry><para>052</para></entry>
38868 <entry><para>Geographic-class</para></entry>
38872 <entry><para>060</para></entry>
38874 <entry><para>NLM-call-number</para></entry>
38878 <entry><para>070</para></entry>
38880 <entry><para>NAL-call-number</para></entry>
38884 <entry><para>080</para></entry>
38886 <entry><para>UDC-classification</para></entry>
38890 <entry><para>082</para></entry>
38892 <entry><para>Dewey-classification:w,
38893 Dewey-classification:s</para></entry>
38897 <entry><para>086</para></entry>
38899 <entry><para>Number-govt-pub</para></entry>
38903 <entry><para>100$9</para></entry>
38905 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
38909 <entry><para>100$a</para></entry>
38911 <entry><para>Author,Author:p, Author:s, Editor,
38912 Author-personal-bibliography, Author-personal-bibliography:p,
38913 Author-personal-bibliography:s</para></entry>
38917 <entry><para>100</para></entry>
38919 <entry><para>Author, Author-title, Author-name-personal, Name,
38920 Name-and-title, Personal-name</para></entry>
38924 <entry><para>110$9</para></entry>
38926 <entry><para>Koha-Auth-Number</para></entry>
38930 <entry><para>110</para></entry>
38932 <entry><para>Author, Author-title, Author-name-corporate, Name,
38933 Name-and-title, Corporate-name</para></entry>
38937 <entry><para>111$9</para></entry>
38939 <entry><para>Koha-Auth-Number</para></entry>
38943 <entry><para>111</para></entry>
38945 <entry><para>Author, Author-title, Author-name-corporate, Name,
38946 Name-and-title, Conference-name</para></entry>
38950 <entry><para>130$n</para></entry>
38952 <entry><para>Thematic-number</para></entry>
38956 <entry><para>130$r</para></entry>
38958 <entry><para>Music-key</para></entry>
38962 <entry><para>130$9</para></entry>
38964 <entry><para>Koha-Auth-Number</para></entry>
38968 <entry><para>130</para></entry>
38970 <entry><para>Title, Title-uniform</para></entry>
38974 <entry><para>210</para></entry>
38976 <entry><para>Title, Title-abbreviated</para></entry>
38980 <entry><para>211</para></entry>
38982 <entry><para>Title, Title-abbreviated</para></entry>
38986 <entry><para>212</para></entry>
38988 <entry><para>Title, Title-other-variant</para></entry>
38992 <entry><para>214</para></entry>
38994 <entry><para>Title, Title-expanded</para></entry>
38998 <entry><para>222</para></entry>
39000 <entry><para>Title, Title-key</para></entry>
39004 <entry><para>240$r</para></entry>
39006 <entry><para>Music-key</para></entry>
39010 <entry><para>240$n</para></entry>
39012 <entry><para>Thematic-number</para></entry>
39016 <entry><para>240</para></entry>
39018 <entry><para>Title:w, Title:p, Title-uniform</para></entry>
39022 <entry><para>243$n</para></entry>
39024 <entry><para>Thematic-number</para></entry>
39028 <entry><para>243$r</para></entry>
39030 <entry><para>Music-key</para></entry>
39034 <entry><para>243</para></entry>
39036 <entry><para>Title:w, Title:p, Title-collective</para></entry>
39040 <entry><para>245$a</para></entry>
39042 <entry><para>Title-cover:w, Title-cover:p, Title-cover:s,
39043 Title:w, Title:p, Title:s</para></entry>
39047 <entry><para>245$c</para></entry>
39049 <entry><para>Author, Author-in-order:w, Author-in-order:p,
39050 Author-in-order:s</para></entry>
39054 <entry><para>245$9</para></entry>
39056 <entry><para>Cross-Reference:w, Koha-Auth-Number</para></entry>
39060 <entry><para>245</para></entry>
39062 <entry><para>Title:w, Title:p</para></entry>
39066 <entry><para>246</para></entry>
39068 <entry><para>Title, Title:p, Title-abbreviated, Title-expanded,
39069 Title-former</para></entry>
39073 <entry><para>247</para></entry>
39075 <entry><para>Title, Title:p, Title-former, Title-other-variant,
39076 Related-periodical</para></entry>
39080 <entry><para>260$a</para></entry>
39082 <entry><para>pl:w, pl:p</para></entry>
39086 <entry><para>260$b</para></entry>
39088 <entry><para>Publisher:w, Publisher:p</para></entry>
39092 <entry><para>260$c</para></entry>
39094 <entry><para>copydate, copydate:s</para></entry>
39098 <entry><para>260</para></entry>
39100 <entry><para>pl</para></entry>
39104 <entry><para>300</para></entry>
39106 <entry><para>Extent:w, Extent:p</para></entry>
39110 <entry><para>400$a</para></entry>
39112 <entry><para>Name-and-title</para></entry>
39116 <entry><para>400$t</para></entry>
39118 <entry><para>Author-title, Name-and-title, Title,
39119 Title-series</para></entry>
39123 <entry><para>400$9</para></entry>
39125 <entry><para>Koha-Auth-Number</para></entry>
39129 <entry><para>400</para></entry>
39131 <entry><para>Author, Author-name-personal, Name,
39132 Personal-name</para></entry>
39136 <entry><para>410</para></entry>
39138 <entry><para>Author, Corporate-name</para></entry>
39142 <entry><para>410$a</para></entry>
39144 <entry><para>Name-and-title</para></entry>
39148 <entry><para>410$t</para></entry>
39150 <entry><para>Author-title, Title, Title-series</para></entry>
39154 <entry><para>410$9</para></entry>
39156 <entry><para>Koha-Auth-Number</para></entry>
39160 <entry><para>410</para></entry>
39162 <entry><para>Author-name-corporate, Name</para></entry>
39166 <entry><para>411</para></entry>
39168 <entry><para>Author, Conference-name</para></entry>
39172 <entry><para>411$a</para></entry>
39174 <entry><para>Name-and-title</para></entry>
39178 <entry><para>411$t</para></entry>
39180 <entry><para>Author-title, Title-series</para></entry>
39184 <entry><para>411</para></entry>
39186 <entry><para>Author-name-corporate, Name</para></entry>
39190 <entry><para>440$a</para></entry>
39192 <entry><para>Title-series:w, Title-series:p</para></entry>
39196 <entry><para>440$9</para></entry>
39198 <entry><para>Koha-Auth-Number</para></entry>
39202 <entry><para>440</para></entry>
39204 <entry><para>Title-series:w, Title-series:p, Title,
39205 Title-series</para></entry>
39209 <entry><para>490$a</para></entry>
39211 <entry><para>Title-series:w, Title-series:p</para></entry>
39215 <entry><para>490</para></entry>
39217 <entry><para>Title, Title-series</para></entry>
39221 <entry><para>490$9</para></entry>
39223 <entry><para>Koha-Auth-Number</para></entry>
39227 <entry><para>500</para></entry>
39229 <entry><para>Note:w, Note:p</para></entry>
39233 <entry><para>502</para></entry>
39235 <entry><para>Material-type</para></entry>
39239 <entry><para>505$r</para></entry>
39241 <entry><para>Author</para></entry>
39245 <entry><para>505$t</para></entry>
39247 <entry><para>Title</para></entry>
39251 <entry><para>505</para></entry>
39253 <entry><para>Note:w, Note:p</para></entry>
39257 <entry><para>510</para></entry>
39259 <entry><para>Indexed-by</para></entry>
39263 <entry><para>520</para></entry>
39265 <entry><para>Abstract:w, Abstract:p</para></entry>
39269 <entry><para>521$a</para></entry>
39271 <entry><para>lex:n</para></entry>
39275 <entry><para>526$c</para></entry>
39277 <entry><para>arl, arl:n</para></entry>
39281 <entry><para>526$d</para></entry>
39283 <entry><para>arp, arp:n</para></entry>
39287 <entry><para>590</para></entry>
39289 <entry><para>Note:w, Note:p</para></entry>
39293 <entry><para>600$a</para></entry>
39295 <entry><para>Name-and-title, Name, Personal-name,
39296 Subject-name-personal, Subject</para></entry>
39300 <entry><para>600$t</para></entry>
39302 <entry><para>Name-and-title, Title, Subject</para></entry>
39306 <entry><para>600$9</para></entry>
39308 <entry><para>Koha-Auth-Number</para></entry>
39312 <entry><para>600</para></entry>
39314 <entry><para>Name, Personal-name, Subject-name-personal,
39315 Subject</para></entry>
39319 <entry><para>610$a</para></entry>
39321 <entry><para>Name-and-title</para></entry>
39325 <entry><para>610$t</para></entry>
39327 <entry><para>Name-and-title, Title</para></entry>
39331 <entry><para>610$9</para></entry>
39333 <entry><para>Koha-Auth-Number</para></entry>
39337 <entry><para>610</para></entry>
39339 <entry><para>Name, Subject, Corporate-name</para></entry>
39343 <entry><para>611</para></entry>
39345 <entry><para>Conference-name</para></entry>
39349 <entry><para>611$a</para></entry>
39351 <entry><para>Name-and-title</para></entry>
39355 <entry><para>611$t</para></entry>
39357 <entry><para>Name-and-title, Title</para></entry>
39361 <entry><para>611$9</para></entry>
39363 <entry><para>Koha-Auth-Number</para></entry>
39367 <entry><para>611</para></entry>
39369 <entry><para>Name, Subject</para></entry>
39373 <entry><para>630$n</para></entry>
39375 <entry><para>Thematic-number</para></entry>
39379 <entry><para>630$r</para></entry>
39381 <entry><para>Music-key</para></entry>
39385 <entry><para>630$9</para></entry>
39387 <entry><para>Koha-Auth-Number</para></entry>
39391 <entry><para>630</para></entry>
39393 <entry><para>Subject</para></entry>
39397 <entry><para>650$9</para></entry>
39399 <entry><para>Koha-Auth-Number</para></entry>
39403 <entry><para>650</para></entry>
39405 <entry><para>Subject, Subject:p</para></entry>
39409 <entry><para>651$9</para></entry>
39411 <entry><para>Koha-Auth-Number</para></entry>
39415 <entry><para>651</para></entry>
39417 <entry><para>Name-geographic, Subject,Subject:p</para></entry>
39421 <entry><para>652$9</para></entry>
39423 <entry><para>Koha-Auth-Number</para></entry>
39427 <entry><para>653$9</para></entry>
39429 <entry><para>Koha-Auth-Number</para></entry>
39433 <entry><para>653</para></entry>
39435 <entry><para>Subject, Subject:p</para></entry>
39439 <entry><para>654$9</para></entry>
39441 <entry><para>Koha-Auth-Number</para></entry>
39445 <entry><para>654</para></entry>
39447 <entry><para>Subject</para></entry>
39451 <entry><para>655$9</para></entry>
39453 <entry><para>Koha-Auth-Number</para></entry>
39457 <entry><para>655</para></entry>
39459 <entry><para>Subject</para></entry>
39463 <entry><para>656$9</para></entry>
39465 <entry><para>Koha-Auth-Number</para></entry>
39469 <entry><para>656</para></entry>
39471 <entry><para>Subject</para></entry>
39475 <entry><para>657$9</para></entry>
39477 <entry><para>Koha-Auth-Number</para></entry>
39481 <entry><para>657</para></entry>
39483 <entry><para>Subject</para></entry>
39487 <entry><para>690$9</para></entry>
39489 <entry><para>Koha-Auth-Number</para></entry>
39493 <entry><para>690</para></entry>
39495 <entry><para>Subject, Subject:p</para></entry>
39499 <entry><para>700$9</para></entry>
39501 <entry><para>Cross-Reference, Koha-Auth-Number</para></entry>
39505 <entry><para>700$a</para></entry>
39507 <entry><para>Author, Author:p</para></entry>
39511 <entry><para>700$n</para></entry>
39513 <entry><para>Thematic-number</para></entry>
39517 <entry><para>700$r</para></entry>
39519 <entry><para>Music-key</para></entry>
39523 <entry><para>700$t</para></entry>
39525 <entry><para>Author-title, Name-and-title, Title,
39526 Title-uniform</para></entry>
39530 <entry><para>700</para></entry>
39532 <entry><para>Author, Author-name-corporate,
39533 Author-name-personal, Name, Editor, Personal-name</para></entry>
39537 <entry><para>710</para></entry>
39539 <entry><para>Author, Corporate-name</para></entry>
39543 <entry><para>710$t</para></entry>
39545 <entry><para>Author-title, Name-and-title, Title,
39546 Title-uniform</para></entry>
39550 <entry><para>710$a</para></entry>
39552 <entry><para>Name-and-title</para></entry>
39556 <entry><para>710$9</para></entry>
39558 <entry><para>Koha-Auth-Number</para></entry>
39562 <entry><para>710</para></entry>
39564 <entry><para>Author, Name</para></entry>
39568 <entry><para>711$a</para></entry>
39570 <entry><para>Name-and-title</para></entry>
39574 <entry><para>711$t</para></entry>
39576 <entry><para>Author-title, Title, Title-uniform</para></entry>
39580 <entry><para>711$9</para></entry>
39582 <entry><para>Koha-Auth-Number</para></entry>
39586 <entry><para>711</para></entry>
39588 <entry><para>Author-name-corporate, Name,
39589 Conference-name</para></entry>
39593 <entry><para>730$n</para></entry>
39595 <entry><para>Thematic-number</para></entry>
39599 <entry><para>730$r</para></entry>
39601 <entry><para>Music-key</para></entry>
39605 <entry><para>730$9</para></entry>
39607 <entry><para>Koha-Auth-Number</para></entry>
39611 <entry><para>730</para></entry>
39613 <entry><para>Title, Title-uniform</para></entry>
39617 <entry><para>740</para></entry>
39619 <entry><para>Title, Title-other-variant</para></entry>
39623 <entry><para>773$t</para></entry>
39625 <entry><para>Host-item</para></entry>
39629 <entry><para>780$t</para></entry>
39631 <entry><para>Title</para></entry>
39635 <entry><para>780</para></entry>
39637 <entry><para>Title, Title-former,
39638 Related-periodical</para></entry>
39642 <entry><para>785</para></entry>
39644 <entry><para>Related-periodical</para></entry>
39648 <entry><para>800$a</para></entry>
39650 <entry><para>Name-and-title</para></entry>
39654 <entry><para>800$t</para></entry>
39656 <entry><para>Author-title, Name-and-title, Title,
39657 Title-series</para></entry>
39661 <entry><para>800$9</para></entry>
39663 <entry><para>Koha-Auth-Number</para></entry>
39667 <entry><para>800</para></entry>
39669 <entry><para>Author, Author-name-personal, Name,
39670 Personal-name</para></entry>
39674 <entry><para>810$a</para></entry>
39676 <entry><para>Name-and-title</para></entry>
39680 <entry><para>810$t</para></entry>
39682 <entry><para>Author-title, Name-and-title, Title,
39683 Title-series</para></entry>
39687 <entry><para>810$9</para></entry>
39689 <entry><para>Koha-Auth-Number</para></entry>
39693 <entry><para>810</para></entry>
39695 <entry><para>Author, Corporate-name, Author-name-corporate,
39696 Name</para></entry>
39700 <entry><para>811$a</para></entry>
39702 <entry><para>Name-and-title</para></entry>
39706 <entry><para>811$9</para></entry>
39708 <entry><para>Koha-Auth-Number</para></entry>
39712 <entry><para>811$t</para></entry>
39714 <entry><para>Author-title, Name-and-title, Title,
39715 Title-series</para></entry>
39719 <entry><para>811</para></entry>
39721 <entry><para>Author, Author-name-corporate, Name,
39722 Conference-name</para></entry>
39726 <entry><para>830$9</para></entry>
39728 <entry><para>Koha-Auth-Number</para></entry>
39732 <entry><para>830</para></entry>
39734 <entry><para>Title, Title-series</para></entry>
39738 <entry><para>840</para></entry>
39740 <entry><para>Title, Title-series</para></entry>
39744 <entry><para>999$c</para></entry>
39746 <entry><para>Local-Number:n, Local-Number:w,
39747 Local-Number:s</para></entry>
39751 <entry><para>999$d</para></entry>
39753 <entry><para>biblioitemnumber:n, biblioitemnumber:w,
39754 biblioitemnumber:s</para></entry>
39758 <entry><para>942$0</para></entry>
39760 <entry><para>totalissues:n, totalissues:s</para></entry>
39764 <entry><para>942$2</para></entry>
39766 <entry><para>cn-bib-source</para></entry>
39770 <entry><para>942$6</para></entry>
39772 <entry><para>cn-bib-sort:n, cn-bib-sort:s</para></entry>
39776 <entry><para>942$c</para></entry>
39778 <entry><para>itemtype:w</para></entry>
39782 <entry><para>942$n</para></entry>
39784 <entry><para>Suppress:w, Suppress:n</para></entry>
39788 <entry><para>942$h</para></entry>
39790 <entry><para>cn-class</para></entry>
39794 <entry><para>942$i</para></entry>
39796 <entry><para>cn-item</para></entry>
39800 <entry><para>942$k</para></entry>
39802 <entry><para>cn-prefix</para></entry>
39806 <entry><para>942$m</para></entry>
39808 <entry><para>cn-suffix</para></entry>
39812 <entry><para>952$0</para></entry>
39814 <entry><para>withdrawn:n, withdrawn:w</para></entry>
39818 <entry><para>952$1</para></entry>
39820 <entry><para>lost, lost:n</para></entry>
39824 <entry><para>952$2</para></entry>
39826 <entry><para>classification-source</para></entry>
39830 <entry><para>952$3</para></entry>
39832 <entry><para>materials-specified</para></entry>
39836 <entry><para>952$4</para></entry>
39838 <entry><para>damaged:n, damaged:w</para></entry>
39842 <entry><para>952$5</para></entry>
39844 <entry><para>restricted:n, restricted:w</para></entry>
39848 <entry><para>952$6</para></entry>
39850 <entry><para>cn-sort:n, cn-sort:s</para></entry>
39854 <entry><para>952$7</para></entry>
39856 <entry><para>notforloan:n, notforloan:w</para></entry>
39860 <entry><para>952$8</para></entry>
39862 <entry><para>ccode</para></entry>
39866 <entry><para>952$9</para></entry>
39868 <entry><para>itemnumber:n, itemnumber:s</para></entry>
39872 <entry><para>952$a</para></entry>
39874 <entry><para>homebranch</para></entry>
39878 <entry><para>952$b</para></entry>
39880 <entry><para>holdingbranch</para></entry>
39884 <entry><para>952$c</para></entry>
39886 <entry><para>location</para></entry>
39890 <entry><para>952$d</para></entry>
39892 <entry><para>Date-of-acquisition, Date-of-acquisition:d,
39893 Date-of-acquisition:s</para></entry>
39897 <entry><para>952$e</para></entry>
39899 <entry><para>acqsource</para></entry>
39903 <entry><para>952$f</para></entry>
39905 <entry><para>coded-location-qualifier</para></entry>
39909 <entry><para>952$g</para></entry>
39911 <entry><para>price</para></entry>
39915 <entry><para>952$j</para></entry>
39917 <entry><para>stack:n, stack:w</para></entry>
39921 <entry><para>952$l</para></entry>
39923 <entry><para>issues:n, issues:w, issues:s</para></entry>
39927 <entry><para>952$m</para></entry>
39929 <entry><para>renewals:n, renewals:w</para></entry>
39933 <entry><para>952$n</para></entry>
39935 <entry><para>reserves:n, reserves:w</para></entry>
39939 <entry><para>952$o</para></entry>
39941 <entry><para>Local-classification:w, Local-classification:p,
39942 Local-classification:s</para></entry>
39946 <entry><para>952$p</para></entry>
39948 <entry><para>barcode, barcode:n</para></entry>
39952 <entry><para>952$q</para></entry>
39954 <entry><para>onloan:n, onloan:w</para></entry>
39958 <entry><para>952$r</para></entry>
39960 <entry><para>datelastseen</para></entry>
39964 <entry><para>952$s</para></entry>
39966 <entry><para>datelastborrowed</para></entry>
39970 <entry><para>952$t</para></entry>
39972 <entry><para>copynumber</para></entry>
39976 <entry><para>952$u</para></entry>
39978 <entry><para>uri:u</para></entry>
39982 <entry><para>952$v</para></entry>
39984 <entry><para>replacementprice</para></entry>
39988 <entry><para>952$w</para></entry>
39990 <entry><para>replacementpricedate</para></entry>
39994 <entry><para>952$y</para></entry>
39996 <entry><para>itype:w</para></entry>
40000 <entry><para>952$z</para></entry>
40002 <entry><para>Note:w, Note:p</para></entry>
40009 <chapter id="pluginsystem">
40010 <title>Plugin System</title>
40011 <para>Koha's Plugin System allows for you to add additional tools and reports to Koha that are
40012 specific to your library. Plugins are installed by uploading KPZ ( Koha Plugin Zip ) packages.
40013 A KPZ file is just a zip file containing the perl files, template files, and any other files
40014 necessary to make the plugin work.</para>
40015 <para>The plugin system needs to be turned on by a system administrator. </para>
40016 <section id="pluginsetup">
40017 <title>Set up</title>
40018 <para>To set up the Koha plugin system you must first make some changes to your install.<itemizedlist>
40020 <para>Create the directory /var/lib/koha/plugins</para>
40023 <para>Add the lines <pluginsdir>/var/lib/koha/plugins</pluginsdir>
40024 <enable_plugins>1</enable_plugins>" to your koha-conf.xml file</para>
40027 <para>Add the line Alias /plugin/ "/var/lib/koha/plugins/" to your koha-httpd.conf
40031 <para>Restart your webserver</para>
40033 </itemizedlist>Once set up is complete you will need to alter your <link linkend="UseKohaPlugins">UseKohaPlugins</link> system preference to be able to see a
40034 Plugins option under the More menu on your toolbar. On the Tools page you will see the
40035 Tools Plugins and on the Reports page you will see the Reports Plugins.</para>
40039 <chapter id="aboutkoha">
40040 <title>About Koha</title>
40042 <para>The 'About Koha' area will give you important server information as
40043 well as general information about Koha.</para>
40047 <para><emphasis>Get there:</emphasis> More > About Koha</para>
40051 <section id="aboutserver">
40052 <title>Server Information</title>
40054 <para>Under the 'Server Information' tab you will find information about
40055 the Koha version and the machine you have installed Koha on. This
40056 information is very important for debugging problems. When reporting
40057 issues to your support provider or to the various other support avenues
40058 (mailing lists, chat room, etc), it's always good to give the
40059 information from this screen.</para>
40062 <screeninfo>Server Information on Koha</screeninfo>
40066 <imagedata fileref="images/about/aboutserver.png"/>
40072 <section id="aboutserverperl">
40073 <title>Perl Modules</title>
40075 <para>In order to take advantage of all of the functionalities of Koha,
40076 you will need to keep your Perl modules up to date. The 'Perl Modules'
40077 tab will show you all of the modules required by Koha, the version you
40078 have installed and whether you need to upgrade certain modules.</para>
40081 <screeninfo>Perl Modules</screeninfo>
40085 <imagedata fileref="images/about/aboutperlmodules.png"/>
40090 <para>Items listed in bold are required by Koha, items highlighed in red
40091 are missing completely and items highlighted in yellow simply need to be
40095 <section id="aboutsystem">
40096 <title>System Information</title>
40098 <para>This tab will provide you with warnings if you are using system
40099 preferences that have since been deprecated or system preferences that
40100 you have set without other required preferences</para>
40103 <screeninfo>System Information</screeninfo>
40107 <imagedata fileref="images/about/systeminfo.jpg"/>
40114 <chapter id="implementation">
40115 <title>Implementation Checklist</title>
40117 <para>The following guide will walk you through the areas of Koha you need
40118 to look at in order to prepare to start using the system.</para>
40120 <section id="imp-migration">
40121 <title>Data Migration</title>
40123 <para>Before you can start using Koha you'll need to have some data.
40124 This can be done by entering it all by hand, but most people already
40125 have their data in electronic format of some sort and just need to
40126 reformat it a bit for importing into Koha.</para>
40130 <para>Create a list of libraries and enter their info and codes into
40131 <link linkend="libsgroups">Libraries & Groups</link></para>
40135 <para>Define your list of <link linkend="itemtypeadmin">Item
40136 Types</link></para>
40140 <para>Define you patron categories and enter the categories and
40141 their codes into <link linkend="patcats">Patron
40142 Categories</link></para>
40146 <para>Enter any additional patron information fields you use in your
40147 library in the <link linkend="patronattributetypes">Patron
40148 Attributes</link></para>
40152 <para>Requires that you first set the <link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
40153 system preference if you have custom fields</para>
40159 <para>Define all of your <link linkend="authorizedvalues">Authorized
40160 Values</link></para>
40164 <para><link linkend="ccode">Collection codes</link></para>
40168 <para><link linkend="shelvelocvals">Shelving
40169 locations</link></para>
40173 <para>Item statuses (<link linkend="lost">lost</link>, <link linkend="notforloan">not
40174 for loan</link>, <link linkend="damageauth">damaged</link>, <link linkend="withdrawnauth">withdrawn</link>)</para>
40178 <para>Plus any others that are needed in your library</para>
40184 <para>Optionally define <link linkend="citytowns">City/State/Postal Code</link> combos </para>
40188 <para><link linkend="kohamarcmapping">Map your bibliographic
40189 data</link> from your legacy system to Koha fields and migrate
40190 (remembering to use the collection, shelving, item type and library
40191 codes you entered in the above setting areas)</para>
40195 <para><link linkend="patronimport">Map your patron data</link> from
40196 your legacy system to the Koha fields and migrate (remembering to
40197 use the patron and library codes you defined above)</para>
40201 <para>Test your migrated data to be sure that everything is as you
40202 expect it to be, some things to test include:</para>
40206 <para>Check some of your titles with diacritics and make sure
40207 that they migrated properly.</para>
40211 <para>Check titles in a series and make sure that series
40212 information migrated properly.</para>
40216 <para>Make sure that your patrons have their contact information
40217 in the right fields.</para>
40221 <para>If your serials data was migrated search for these records
40222 in the catalog and confirm that they look right.</para>
40226 <para>If your serials data was migrated search for these records
40227 in the serials module and confirm that they look right.</para>
40231 <para>Check marc records to verify a variety of items are
40232 cataloged correctly</para>
40236 <para>Check cataloging process to see if all necessary fields
40237 are available</para>
40241 <para>If fines are migrated, check to see that they are applied
40246 <para>If holds are migrated, check to see they are accurate in
40247 catalog and patron record</para>
40254 <section id="impadmin">
40255 <title>Admin Configuration</title>
40257 <para>Most of these preferences won't need to be changed to use your
40258 Koha system, but there are a few that you might want to
40263 <para>If your library uses CAS Authentication, you'll want to set
40264 the various <link linkend="casauthentication">CAS system
40265 preferences</link></para>
40269 <para>Administration System Preferences</para>
40273 <para><link linkend="KohaAdminEmailAddress">KohaAdminEmailAddress</link> :
40274 This is the email address that will be used by the system in
40275 'from' lines and to send errors to if there is no email set for
40280 <para><link linkend="noItemTypeImages">noItemTypeImages</link> :
40281 Decide if you want to show item type icons in the staff client
40286 <para><link linkend="delimiter">delimiter</link> : This value
40287 will be put in between fields when exporting data from
40292 <para><link linkend="virtualshelves">virtualshelves</link> :
40293 Decide if you want the staff and/or patrons to use lists in
40298 <para><link linkend="AutoLocation">AutoLocation</link> : Require
40299 staff to log in to the staff client from a specific IP
40304 <para><link linkend="IndependentBranches">IndependentBranches</link> : Prevent
40305 librarians from editing content that belongs to other branches</para>
40311 <para>Go through the <link linkend="logs">Log System
40312 Preferences</link> and decide which actions you want to keep track
40313 of in the logs</para>
40318 <section id="implocal">
40319 <title>Localization Configuration</title>
40321 <para>Koha is used worldwide and so you need to make sure you set your
40322 localization preferences so that options throughout Koha appear properly
40323 for your location/language.</para>
40327 <para>Localization/Internationalization System Preferences</para>
40331 <para><link linkend="dateformat">dateformat</link> : Decide how
40332 dates are displayed throughout Koha</para>
40336 <para><link linkend="opaclanguagesdisplay">opaclanguagesdisplay</link> :
40337 Decide if patrons can choose what language the OPAC appears
40342 <para><link linkend="opaclanguages">opaclanguages</link> :
40343 Decide which languages the patrons can choose from</para>
40349 <para><link linkend="languagepref">language</link> : Decide
40350 which languages appear in the staff client</para>
40354 <para><link linkend="CalendarFirstDayOfWeek">CalendarFirstDayOfWeek</link> :
40355 Define your first day of the week</para>
40362 <section id="impcirc">
40363 <title>Circulation Configuration</title>
40365 <para>Before you start circulating your collection you'll need to set up
40366 your rules and preferences for circulation.</para>
40370 <para>Define you <link linkend="circfinerules">Circulation/Fine
40371 rules</link></para>
40375 <para>Enter the <link linkend="calholidays">days your library is
40376 closed</link> for fines and due date calculations</para>
40380 <para>Circulation System Preferences</para>
40384 <para><link linkend="CircControl">CircControl</link> : Define
40385 whether circ rules are based on item's location, patron's
40386 location or transaction location</para>
40390 <para><link linkend="useDaysMode">useDaysMode</link> : Define
40391 how due dates are calculated</para>
40395 <para><link linkend="finesCalendar">finesCalendar</link> :
40396 Define how fines are calculated (for every late date or only for
40397 days the library is open)</para>
40401 <para><link linkend="SpecifyDueDate">SpecifyDueDate</link> : Decide if staff are
40402 allowed to override due dates on checkout</para>
40405 <para><link linkend="itemBarcodeFallbackSearch">itemBarcodeFallbackSearch</link> :
40406 Decide if you want staff to be able to checkout using a keyword search (title, call
40407 number, etc)</para>
40411 <para><link linkend="AutomaticItemReturn">AutomaticItemReturn</link> :
40412 Decide if items are sent back to the owning branch when checked
40417 <para><link linkend="todaysIssuesDefaultSortOrder">todaysIssuesDefaultSortOrder</link>
40418 : Decide how items checked out today display on the patron
40423 <para><link linkend="previousIssuesDefaultSortOrder">previousIssuesDefaultSortOrder</link>
40424 : Decide how items checked out prior to today display on the
40425 patron record</para>
40429 <para><link linkend="noissuescharge">noissuescharge</link> :
40430 Define the maximum amount a patron can owe before checkouts are
40435 <para><link linkend="ReturnBeforeExpiry">ReturnBeforeExpiry</link> : Decide
40436 if patrons need to return items before their accounts
40441 <para><link linkend="AllowOnShelfHolds">AllowOnShelfHolds</link>
40442 : Decide if patrons can place holds on items that are marked as
40443 being available</para>
40447 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
40448 : Decide if you want the staff to be able to override the
40449 setting for the above at checkout</para>
40455 <para><link linkend="AllowHoldsOnDamagedItems">AllowHoldsOnDamagedItems</link>
40456 : Decide if patrons can place holds on items that are marked as
40461 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
40462 : Decide if you want the staff to be able to override the
40463 setting for the above at checkout</para>
40469 <para><link linkend="maxreserves">maxreserves</link> : Decide
40470 how many items a patron can have on hold at once</para>
40474 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
40475 : Decide if you want the staff to be able to override the
40476 setting for the above at checkout</para>
40482 <para><link linkend="maxoutstanding">maxoutstanding</link> :
40483 Define the maximum amount a patron can owe before holds are
40488 <para><link linkend="AllowHoldPolicyOverride">AllowHoldPolicyOverride</link>
40489 : Decide if you want the staff to be able to override the
40490 setting for the above at checkout</para>
40496 <para><link linkend="ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</link> :
40497 Define the number of days before a hold expires</para>
40501 <para><link linkend="WebBasedSelfCheck">WebBasedSelfCheck</link>
40502 : Decide if you want to use the built in web-based self-checkout
40507 <para><link linkend="AutoSelfCheckAllowed">AutoSelfCheckAllowed</link> :
40508 Decide if the self-checkout system requires login</para>
40512 <para><link linkend="ShowPatronImageInWebBasedSelfCheck">ShowPatronImageInWebBasedSelfCheck</link>
40513 : Decide if you want patron images to show on the self
40514 checkout screen</para>
40520 <para><link linkend="AllowNotForLoanOverride">AllowNotForLoanOverride</link>
40521 : Decide if you want the staff to be able to checkout items
40522 marked as 'not for loan'</para>
40526 <para><link linkend="AllowRenewalLimitOverride">AllowRenewalLimitOverride</link>
40527 : Decide if you want staff to override the limit put on
40532 <para><link linkend="AllowFineOverride">AllowFineOverride</link> : Decide if you want
40533 staff to be able to override fine limits</para>
40536 <para><link linkend="AllowTooManyOverride">AllowTooManyOverride</link> : Descide if
40537 you want staff to be able to check out more than the limit to a patron</para>
40541 <para><link linkend="RenewalPeriodBase">RenewalPeriodBase</link>
40542 : Decide what date renewals are based on</para>
40546 <para><link linkend="finesMode">finesMode</link> : Switch to
40547 'Calculate and Charge' before go live if you charge fines</para>
40551 <para><link linkend="OverdueNoticeBcc">OverdueNoticeBcc</link> :
40552 If you want to receive a copy of every overdue notice sent out,
40553 enter your email address here</para>
40557 <para><link linkend="emailLibrarianWhenHoldIsPlaced">emailLibrarianWhenHoldIsPlaced</link>
40558 : Decide if you want an email every time a hold is placed</para>
40562 <para><link linkend="ReservesControlBranch">ReservesControlBranch</link> :
40563 Decide which branch's hold rules are considered first</para>
40567 <para><link linkend="soundon">soundon</link> : Decide if you
40568 want to have sounds on for circulation actions</para>
40572 <para><link linkend="FilterBeforeOverdueReport">FilterBeforeOverdueReport</link>
40573 : If you have a large amount of overdues, you might want to turn
40574 this preference on so as to allow you to filter before results
40579 <para><link linkend="DisplayClearScreenButton">DisplayClearScreenButton</link>
40580 : If you have a lot of staff members sharing one circ computer
40581 you might want to enable this so that staff can clear the screen
40582 in between checkouts to protect patron's privacy</para>
40586 <para><link linkend="CircAutoPrintQuickSlip">CircAutoPrintQuickSlip</link> :
40587 Decide how you want Koha to react if you scan in a blank barcode
40588 on the checkout screen</para>
40592 <para><link linkend="SuspendHoldsIntranet">SuspendHoldsIntranet</link>
40593 and/or <link linkend="SuspendHoldsOpac">SuspendHoldsOpac</link>
40594 : Decide if you want patrons and/or staff to be able to suspend
40599 <para><link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
40600 : If you allow holds to be suspended decide if you want them
40601 to automatically resume on the date entered by the staff
40602 and/or patron</para>
40610 <para>Customize your <link linkend="notices">Notices &
40611 Slips</link></para>
40615 <para>Define your <link linkend="noticetriggers">Overdue Notice
40616 Triggers</link></para>
40620 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
40624 <para>Populate <link linkend="buildholdscron">your holds
40625 queue</link> (every 1-4 hours)</para>
40629 <para>Decide <link linkend="expiredholdscron">when holds
40630 expire</link> (daily)</para>
40634 <para><link linkend="finescronjob">Calculate fines due</link>
40639 <para>Fines on hourly loans will calculate when you check
40640 the items in</para>
40646 <para><link linkend="longoverduecron">Mark long overdue items as
40647 lost</link> (daily)</para>
40651 <para>Decide when the system <link linkend="msgqueuecron">sends
40652 out messages</link> (1-4 hours)</para>
40656 <para>Decide when the system <link linkend="overduenoticecron">queues overdue notices</link>
40661 <para>Set up <link linkend="printholdcron">hold notices that
40662 didn't send for printing</link> (daily after overdues and
40663 message queue)</para>
40667 <para>Decide when the system <link linkend="advnoticecron">queues the advanced notice of items
40668 due</link> (daily)</para>
40672 <para>Find holds that need to be <link linkend="unsuspendholdcron">resumed and remove suspension</link>
40680 <section id="imppratrons">
40681 <title>Patron Configuration</title>
40683 <para>You have already imported patron data from your old system, but
40684 there are plenty of options available to you regarding patrons and their
40689 <para>Enter your <link linkend="addstaffpatron">staff members as
40690 patrons</link></para>
40694 <para>Define <link linkend="patronpermissions">staff members
40695 access permissions</link></para>
40701 <para>Patron System Preferences</para>
40705 <para><link linkend="AddPatronLists">AddPatronLists</link> :
40706 Decide how patron categories appear when creating a new
40711 <para><link linkend="autoMemberNum">autoMemberNum</link> :
40712 Decide if the patrons barcodes are auto-generated or if you
40713 enter them yourself</para>
40717 <para><link linkend="MaxFine">MaxFine</link> : Determine the
40718 maximum amount that people can owe in fines</para>
40722 <para><link linkend="NotifyBorrowerDeparture">NotifyBorrowerDeparture</link>
40723 : Decide when to warn staff that the patron account is about to
40728 <para><link linkend="intranetreadinghistory">intranetreadinghistory</link> :
40729 Decide if the staff can see the patron's reading/checkout
40734 <para><link linkend="BorrowerMandatoryField">BorrowerMandatoryField</link> :
40735 List fields that you want to appear as mandatory on the patron
40736 add/edit form</para>
40740 <para><link linkend="BorrowersTitles">BorrowersTitles</link> :
40741 Add or change the titles for your patrons</para>
40745 <para><link linkend="borrowerRelationship">borrowerRelationship</link> : Add
40746 or change borrower relationships (child to adult and
40747 professional to organization)</para>
40751 <para><link linkend="AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</link>
40752 : Determine if the patrons get an email confirming the creation
40753 of their account</para>
40757 <para><link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
40758 : Decide if patrons can choose from a series of notices (other
40759 than overdues)</para>
40763 <para><link linkend="patronimages">patronimages</link> : Decide
40764 if you want to save patron images in your system</para>
40768 <para><link linkend="ExtendedPatronAttributes">ExtendedPatronAttributes</link>
40769 : Decide if you want to enable custom patron fields</para>
40773 <para><link linkend="minPasswordLength">minPasswordLength</link>
40774 : Enter the minimum number of characters you want passwords to
40779 <para><link linkend="BorrowerUnwantedField">BorrowerUnwantedField</link> :
40780 Decide what fields your library doesn't need to see on the
40781 patron entry form</para>
40788 <section id="impcatalog">
40789 <title>Cataloging Configuration</title>
40791 <para>Before you start cataloging in Koha you'll want to set up your
40792 preferences and other rules.</para>
40796 <para>Define your cataloging templates aka <link linkend="marcbibframeworks">MARC Bibliographic
40797 Frameworks</link></para>
40801 <para>Run the <link linkend="marcbibframeworkstest">MARC
40802 Bibliographic Framework Test</link> to be sure your changes are
40809 <para>Define any <link linkend="authorizedvalues">authorized
40810 values</link> you might want to use in cataloging</para>
40814 <para>Set up <link linkend="classificationsources">custom
40815 classification sources</link> (if you use something other than the
40820 <para>Set up <link linkend="recordmatchingrules">MARC matching rules</link> for importing
40821 records from mrc files or Z39.50</para>
40825 <para>Set up <link linkend="keywordmapping">Koha to Keyword
40826 mapping</link> for deciding how to display marc fields to the screen
40827 (still in beta - only one field)</para>
40831 <para>Set up the <link linkend="z3950admin">Z39.50 targets</link> you want to search for
40832 cataloging (and acquisitions)</para>
40836 <para>Cataloging System Preferences</para>
40840 <para><link linkend="URLLinkText">URLLinkText</link> : Enter
40841 text to display when 856 fields do not have pre-defined
40846 <para><link linkend="hide_marc">hide_marc</link> : If you are
40847 unfamiliar with MARC you can have the MARC fields number
40852 <para><link linkend="LabelMARCView">LabelMARCView</link> :
40853 Choose how you want duplicate fields to appear on the
40858 <para><link linkend="DefaultClassificationSource">DefaultClassificationSource</link>
40859 : Choose which classification source is the default in your
40864 <para><link linkend="advancedMARCeditor">advancedMARCeditor</link> : Decide
40865 if you need labels to appear on your MARC editor</para>
40869 <para><link linkend="marcflavour">marcflavour</link> : Choose
40870 your MARC format</para>
40874 <para><link linkend="itemcallnumber">itemcallnumber</link> :
40875 Enter which field and subfields to look into for the call
40880 <para><link linkend="MARCOrgCode">MARCOrgCode</link> : Enter
40881 your MARC Organizational Code (not the same as your OCLC
40886 <para><link linkend="autoBarcode">autoBarcode</link> : Decide if
40887 Koha generates item barcodes for you</para>
40891 <para><link linkend="OpacSuppression">OpacSuppression</link> :
40892 Decide if you want to hide items marked as suppressed from the
40893 OPAC search results</para>
40899 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
40903 <para>Decide when the system <link linkend="checkurlcron">checks
40904 URLs in catalog records</link> to see if they are still
40912 <section id="impauthorities">
40913 <title>Authorities Configuration</title>
40915 <para>Koha has the ability to keep track of your authority records and
40916 how they're linked to your bibliographic records. Before using
40917 authorities you should configure several preferences.</para>
40921 <para>Set <link linkend="authoritiesadmin">Authority
40922 Frameworks</link> aka templates</para>
40926 <para>Authority System Preferences</para>
40930 <para><link linkend="BiblioAddsAuthorities">BiblioAddsAuthorities</link> :
40931 Decide if Koha creates authorities when cataloging</para>
40935 <para><link linkend="dontmerge">dontmerge</link> : Decide if
40936 updates to authorities trigger updates to the bibliographic
40937 records that link to them</para>
40941 <para><link linkend="AutoCreateAuthorities">AutoCreateAuthorities</link> :
40942 Decide when authorities are created</para>
40946 <para><link linkend="LinkerModule">LinkerModule</link> : Decide
40947 which match the authority linker should use</para>
40951 <para><link linkend="LinkerOptions">LinkerOptions</link> :
40952 Decide if you want authority linking to be broader or more
40957 <para><link linkend="CatalogModuleRelink">CatalogModuleRelink</link> :
40958 Decide if you want to enable authority linking while
40965 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
40969 <para>Choose when the system looks for authorities updates to
40970 <link linkend="mergeauthcron">merge changes into bibliographic
40971 records</link></para>
40978 <section id="impsearching">
40979 <title>Searching Configuration</title>
40981 <para>There are several system preferences related to searching, it is
40982 not always recommended to make too many changes to these preferences
40983 since they are set to get you the most relevant results. If you would
40984 like to change the default way that Koha handles searching, view the
40985 <link linkend="searchingprefs">Searching system preferences</link>
40990 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
40994 <para>Decide how often your <link linkend="rebuildsearchcron">system rebuilds the search
40995 index</link> (4-10 min)</para>
41001 <para>Searching System Preferences</para>
41005 <para><link linkend="AdvancedSearchTypes">AdvancedSearchTypes</link> :
41006 Decide which authorized value fields you want patrons and staff
41007 to be able to limit their advanced searches by</para>
41011 <para><link linkend="UseAuthoritiesForTracings">UseAuthoritiesForTracings</link>
41012 : Decide how you want Koha to handle subject searches in the
41017 <para><link linkend="TraceCompleteSubfields">TraceCompleteSubfields</link>
41018 : Decide how you want Koha to handle subject searches in the
41023 <para><link linkend="TraceSubjectSubdivisions">TraceSubjectSubdivisions</link>
41024 : Decide how you want Koha to handle subject searches in the
41031 <para><link linkend="displayFacetCount">displayFacetCount</link>
41032 : Decide whether to show facet counts on search results</para>
41039 <section id="impopac">
41040 <title>OPAC Configuration</title>
41042 <para>There are a lot of ways you can customize your OPAC in
41047 <para>Decide how you want your OPAC to look & what content you
41048 want on the main page</para>
41052 <para>Create a library branded stylesheet using CSS</para>
41057 <para>Do not edit the default CSS files, instead create a new
41058 one, that way the system can always fall back on the original
41066 <para>Create a custom XSLT stylesheet to change the way search
41067 results and bib records appear in the OPAC</para>
41071 <para>OPAC System preferences</para>
41075 <para><link linkend="opacuserlogin">opacuserlogin</link> :
41076 Decide if you want to allow patrons to login to the OPAC to
41077 access customized functionality (searching will be allowed
41078 without logging in)</para>
41082 <para><link linkend="RequestOnOpac">RequestOnOpac</link> :
41083 Decide if patrons can place holds via the OPAC</para>
41087 <para><link linkend="OPACItemHolds">OPACItemHolds</link> :
41088 Decide if patrons can place holds on specific items (instead
41089 of just the next available item)</para>
41093 <para><link linkend="OpacPasswordChange">OpacPasswordChange</link> :
41094 Decide if patrons can change their password (don't allow
41095 this if you're using LDAP)</para>
41099 <para><link linkend="OpacRenewalAllowed">OpacRenewalAllowed</link> :
41100 Decide if patrons can renew their checked out items via the
41105 <para><link linkend="opacreadinghistory">opacreadinghistory</link> :
41106 Decide if patrons can view their reading/checkout history
41107 via the OPAC</para>
41111 <para><link linkend="reviewson">reviewson</link> : Decide if
41112 you want to allow patrons to comment on bib records via the
41117 <para><link linkend="OpacStarRatings">OpacStarRatings</link>
41118 : Decide if patrons can leave star ratings</para>
41122 <para><link linkend="virtualshelves">virtualshelves</link> :
41123 Decide if you want patrons to be able to create Lists</para>
41127 <para><link linkend="OpacAllowPublicListCreation">OpacAllowPublicListCreation</link>
41128 : If patrons can create lists then decide if they are
41129 allowed to create public lists</para>
41133 <para><link linkend="suggestionspref">suggestion</link> :
41134 Decide if you want patrons to be able to submit purchase
41139 <para><link linkend="OPACViewOthersSuggestions">OPACViewOthersSuggestions</link>
41140 : Decide if you want patrons to be able to see purchase
41141 suggestions made by other patrons</para>
41147 <para><link linkend="opacbookbag">opacbookbag</link> : Decide if
41148 patrons can save items into their cart</para>
41152 <para><link linkend="AnonSuggestions">AnonSuggestions</link> :
41153 Decide if you want non logged in users to be able to make
41154 purchase suggestions</para>
41158 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> :
41159 Decide if you want to use the XSLT stylesheets on the OPAC
41160 search results</para>
41164 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> :
41165 Decide if you want to use the XSLT stylesheets on the bib
41166 records in the OPAC</para>
41170 <para><link linkend="LibraryName">LibraryName</link> : Enter
41171 your library name for display in the <title> tag and on
41172 the top of the OPAC</para>
41176 <para><link linkend="opacsmallimage">opacsmallimage</link> :
41177 Choose a logo to replace the Koha logo</para>
41181 <para><link linkend="opaccredits">opaccredits</link> : Enter
41182 HTML to appear at the bottom of every page in the OPAC</para>
41186 <para><link linkend="OpacMainUserBlock">OpacMainUserBlock</link>
41187 : Enter HTML that will appear in the center of the main OPAC
41192 <para><link linkend="OpacNav">OpacNav</link> : Enter HTML that
41193 will appear to the left on the main OPAC page</para>
41197 <para><link linkend="OpacNavBottom">OpacNavBottom</link> : Enter
41198 HTML that will appear below OpacNav</para>
41202 <para><link linkend="OpacNavRight">OpacNavRight</link> : Enter
41203 HTML that will appear below the login box on the right</para>
41207 <para><link linkend="opacheader">opacheader</link> : Enter the
41208 HTML that will appear above the search box on the OPAC</para>
41212 <para><link linkend="OPACNoResultsFound">OPACNoResultsFound</link> : Enter
41213 the HTML that will appear when no results are found</para>
41217 <para><link linkend="OPACResultsSidebar">OPACResultsSidebar</link> : Enter
41218 the HTML that will appear below the facets on your search
41223 <para><link linkend="OPACMySummaryHTML">OPACMySummaryHTML</link>
41224 : Enter the HTML that will appear in the far right of the
41225 circulation summary in the OPAC</para>
41229 <para>Customize your stylesheets:</para>
41233 <para><link linkend="OPACUserCSS">OPACUserCSS</link> : Enter
41234 any additional fields you want to define styles for</para>
41238 <para><link linkend="opaclayoutstylesheet">opaclayoutstylesheet</link> :
41239 Point to a CSS file on your Koha server</para>
41243 <para><link linkend="opaccolorstylesheet">opaccolorstylesheet</link> :
41244 Point to a CSS file on your Koha server</para>
41250 <para><link linkend="OpacHighlightedWords">OpacHighlightedWords</link> :
41251 Decide if you want search terms to be highlighted on the search
41256 <para><link linkend="hidelostitems">hidelostitems</link> :
41257 Decide if you want to show patrons items you have marked as
41262 <para><link linkend="BiblioDefaultView">BiblioDefaultView</link>
41263 : Decide what view is the default for bib records on the
41268 <para><link linkend="OPACShelfBrowser">OPACShelfBrowser</link> : Decide if you want to
41269 enable the shelf browse functionality</para>
41272 <para><link linkend="opacthemes">opacthemes</link> : Choose which theme you would like
41273 to use. If you would like a responsive theme pick 'bootstrap'.</para>
41277 <para><link linkend="OPACURLOpenInNewWindow">OPACURLOpenInNewWindow</link> :
41278 Decide if URLs clicked in the OPAC are opened in a new
41283 <para><link linkend="SearchMyLibraryFirst">SearchMyLibraryFirst</link> : If
41284 you have a multi-branch system decide if you want patrons to
41285 search their library first</para>
41289 <para><link linkend="OpacAuthorities">OpacAuthorities</link> :
41290 Decide if you want patrons to be able to search your authority
41295 <para><link linkend="OpacBrowser">OpacBrowser</link> : Decide if
41296 you want patrons to browse your authority file</para>
41300 <para><link linkend="OPACSearchForTitleIn">OPACSearchForTitleIn</link> :
41301 Choose which libraries you want patrons to be able to re-run
41302 their search in</para>
41306 <para><link linkend="OpacAddMastheadLibraryPulldown">OpacAddMastheadLibraryPulldown</link>
41307 : If you're a multi-branch system you can add a pull down to the
41308 search bar for patrons to search which library to search</para>
41312 <para><link linkend="EnableOpacSearchHistory">EnableOpacSearchHistory</link>
41313 : Decide if you want the system to keep a search history</para>
41319 <para>Set up your <link linkend="cronjobs">cron jobs</link></para>
41323 <para>If you have the <link linkend="OpacBrowser">OpacBrowser</link> preference set decide
41324 <link linkend="authbrowsercron">when you want the contents to
41325 rebuild</link></para>
41329 <para>If you have <link linkend="customrss">custom RSS
41330 feeds</link>, decide when you want the <link linkend="customrssfeedcron">feed to be populated</link></para>
41336 <section id="editableopac">
41337 <title>Editable OPAC Regions</title>
41339 <para>Using the OPAC system preferences you can customize various regions, the following
41340 graphic will define what preferences update each of the regions in the Bootstrap
41344 <screeninfo>OPAC Editable Regions</screeninfo>
41348 <imagedata fileref="images/appendix-opac/opaccustomregions.jpg"/>
41355 <section id="impenhanced">
41356 <title>Enhanced Content Configuration</title>
41358 <para>Koha allows you to pull in content from outside sources to enhance
41359 your bib records. All of this content can be toggled on and off using
41360 the enhanced content system preferences.</para>
41364 <para><link linkend="frbrenhancedprefs">FRBR/Editions</link></para>
41368 <para>If you would like to have your OPAC and/or staff client
41369 show an 'Editions' tab on the bib record, you want to enable one
41370 or the other FRBR preferences and then either one or both of the
41371 ISBN services (XISBN and ThingISBN).</para>
41377 <para><link linkend="amazonprefs">Amazon</link> : This service is
41378 free and just requires that you visit <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink> to sign
41383 <para>Using the Amazon preferences you can choose to show cover
41384 images from Amazon.</para>
41390 <para><link linkend="Babelthequeprefs">Babelthèque</link></para>
41394 <para>This is a pay service. Contact Babelthèque to learn how to
41395 enable this content in the OPAC.</para>
41401 <para><link linkend="btcontentprefs">Baker and Taylor</link></para>
41405 <para>This is a pay service from Baker & Taylor. Contact
41406 Baker & Taylor for the information to enter into these
41407 preferences.</para>
41413 <para><link linkend="googleprefs">Google</link></para>
41417 <para>This service is free and does not require registration,
41418 simply enable GoogleJackets and you're set to go.</para>
41424 <para><link linkend="IDreamLibraries">I Deam Books</link><itemizedlist>
41426 <para>This is a free service that compiles reviews for popular titles from many
41427 different sources.</para>
41429 </itemizedlist></para>
41432 <para><link linkend="librarythingprefs">LibraryThing</link></para>
41435 <para>With the exception of ThingISBN, you will need to contact LibraryThing for the
41436 information to enter into these preferences</para>
41439 <para>Enabling ThingISBN will help to populate the editions tab on the bib record
41440 display if you have enabled FRBR.</para>
41446 <para><link linkend="novelistselect">Novelist</link></para>
41450 <para>This is a pay service from Ebsco. Contact Ebsco for the
41451 information to enter into these preferences</para>
41457 <para><link linkend="oclcprefs">OCLC</link></para>
41460 <para>XISBN is used to populate the editions tab on the bib record display if you have
41461 enabled FRBR. This service is free for up to 999 queries a day.</para>
41466 <para><link linkend="OpenLibraryPrefs">Open Library</link><itemizedlist>
41468 <para>Open Library project is an open system that you can pull cover images (and in
41469 the future additional content) from</para>
41471 </itemizedlist></para>
41475 <para><link linkend="Syndeticsprefs">Syndetics</link></para>
41479 <para>This is a pay service from Syndetics to add content for
41480 your bib records. Contact Syndetics for the information to enter
41481 into these preferences.</para>
41487 <para><link linkend="taggingprefs">Tagging</link></para>
41491 <para>Choose whether or not you want to allow patrons to add
41492 tags to records in Koha.</para>
41499 <section id="impacq">
41500 <title>Acquisitions Configuration</title>
41502 <para>When using acquisitions in Koha you first need to define some
41507 <para>Set up your <link linkend="budgetplanning">funds &
41508 budgets</link></para>
41512 <para>Choose your <link linkend="currexchangeadmin">default
41513 currency</link> and enter others if you order from multiple
41518 <para>Enter in your <link linkend="acqvendors">vendor
41519 information</link></para>
41523 <para>Create an <link linkend="marcbibframeworks">Framework with the
41524 code ACQ</link> (if you're going to enter item records at the time
41525 of ordering or receiving)</para>
41529 <para>Acquisitions System preferences</para>
41533 <para><link linkend="AcqCreateItem">AcqCreateItem</link> :
41534 Decide if an item record is created during acquisition</para>
41538 <para><link linkend="CurrencyFormat">CurrencyFormat</link> :
41539 Decide how you want monetary amounts to display</para>
41543 <para><link linkend="gist">gist</link> : Enter your sales tax
41544 (if you are billed for tax)</para>
41548 <para><link linkend="OrderPdfFormat">OrderPdfFormat</link> :
41549 Decide what format you want your print orders to use</para>
41556 <section id="impserials">
41557 <title>Serials Configuration</title>
41559 <para>When you use serials there are a few options you can set before
41564 <para>Serials System Preferences</para>
41568 <para><link linkend="RenewSerialAddsSuggestion">RenewSerialAddsSuggestion</link>
41569 : Decide if you want renewing serials to add a suggestion for
41570 easy purchasing</para>
41574 <para><link linkend="RoutingSerials">RoutingSerials</link> :
41575 Decide if you want to route serials around your library</para>
41579 <para><link linkend="RoutingListAddReserves">RoutingListAddReserves</link> :
41580 Decide if holds are placed on serials when there is a routing
41581 list in place</para>
41587 <para>Cataloging System Preferences</para>
41591 <para><link linkend="StaffSerialIssueDisplayCount">StaffSerialIssueDisplayCount</link>
41592 : Decide how many of the most recent issues to display in the
41593 staff client</para>
41597 <para><link linkend="OPACSerialIssueDisplayCount">OPACSerialIssueDisplayCount</link>
41598 : Decide how many of the most recent issues to display in the
41603 <para><link linkend="SubscriptionHistory">SubscriptionHistory</link> :
41604 Decide how you want the subscription information to display in
41612 <section id="impgolive">
41613 <title>Planning for Go-Live</title>
41615 <para>Once you have all of your settings ready, you need to prepare for
41616 making your system live:</para>
41620 <para>Decide if you need training by an outside service or if your
41621 staff can do the training themselves.</para>
41625 <para>Make sure that there is time for your staff to play with your
41626 test system and get comfortable with it</para>
41630 <para>If this is a migration, work with your previous company to
41631 extract data right before you go live</para>
41635 <para>Come up with URLs for your new Koha OPAC & Staff
41640 <para>Make sure that if you're hosting your own system you have a
41647 <chapter id="sopac">
41648 <title>SOPAC2 Installation</title>
41650 <section id="sopacintro">
41654 <firstname>Jean-André</firstname>
41655 <surname>Santoni</surname>
41657 <orgname>BibLibre</orgname>
41662 <firstname>Nicole C.</firstname>
41663 <surname>Engard</surname>
41664 <contrib>Translation and minor edits.</contrib>
41668 <pubdate>August 2009</pubdate>
41670 <title>Introduction</title>
41672 <para>This is an installation guide for SOPAC2 and its Koha connector. It
41673 has been tested on Debian Lenny and Ubuntu Jaunty with Drupal 6.12 and Koha
41674 3.0.x. It does not cover the installation of Koha and Drupal, only
41675 SOPAC, its dependencies and the connector.</para>
41678 <section id="sopacinstall">
41679 <title>Installation of Locum and Insurge</title>
41681 <para>Locum and Insurge are the two libraries used primarily by SOPAC.
41682 They serve as a layer of abstraction to the data. Insurge manages the
41683 social aspect (tags, reviews, ratings), while Locum manages the
41684 connection to the ILS via the connector. Both libraries use a different
41685 database from that of Drupal.</para>
41687 <section id="sopacdepend">
41688 <title>Dependencies</title>
41690 <para>There are no packages for Debian MDB2 yet, you can install it
41693 <programlisting># apt-get install php-pear
41694 # pear install MDB2
41695 # pear install MDB2#mysql</programlisting>
41698 <section id="sopacdownload">
41699 <title>Download</title>
41701 <para>Download the Locum and Insurge libraries from SVN:</para>
41703 <programlisting># cd /usr/local/lib
41704 # svn co http://dobby.darienlibrary.org/svn/locum/trunk/ locum
41705 # svn co http://dobby.darienlibrary.org/svn/insurge/trunk/ insurge</programlisting>
41708 <section id="sopaccreatedb">
41709 <title>Creation of the Database</title>
41711 <programlisting>$ mysql -u root
41712 mysql> create database scas;
41713 mysql> grant all privileges on scas.* to scas_user@'localhost' identified by 'scas_pass';
41714 mysql> flush privileges;
41715 mysql> exit</programlisting>
41718 <section id="sopacdsn">
41719 <title>Sync DSN</title>
41721 <para>This file will provide the connection information to a DB
41724 <programlisting># nano /usr/local/etc/locum_insurge_dsn.php</programlisting>
41726 <para>It should contain:</para>
41728 <programlisting><?php
41729 $dsn = 'mysql://scas_user:scas_pass@localhost/scas';</programlisting>
41732 <section id="sopacinstallinsurge">
41733 <title>Installation of Insurge</title>
41735 <para>If you customize the name of the database, remember to edit the
41738 <programlisting># nano /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
41740 <para>Import Insurge:</para>
41742 <programlisting>$ mysql -u root -p < /usr/local/lib/insurge/sql/scas_insurge.sql</programlisting>
41744 <para>Configure Insurge:</para>
41746 <programlisting># nano /usr/local/lib/insurge/config/insurge.ini</programlisting>
41748 <para>The variables in insurge.ini are empty. The default values are
41749 too long and cause MySQL errors.</para>
41751 <para>Here is a sample of insurge.ini</para>
41753 <programlisting>; This is the Locum configuration file
41754 ; General configuration options for your installation of Insurge.
41756 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"
41757 ; This is where you configure your repository membership information.
41759 ; parent_server is the server name of the repository parent server you have been
41761 ; group_id = The group ID you have been given by your repository admin.
41762 ; These configuration points are OPTIONAL and are only necessary if you are
41763 ; participating in a repository relationship.
41767 group_key = ""</programlisting>
41770 <section id="sopacinstallocum">
41771 <title>Installation of Locum</title>
41773 <para>The same procedure applies to Locum</para>
41775 <programlisting># nano /usr/local/lib/locum/sql/scas_locum.sql
41776 # mysql < /usr/local/lib/locum/sql/scas_locum.sql
41777 # nano /usr/local/lib/locum/sql/locum_init.sql
41778 # mysql < /usr/local/lib/locum/sql/locum_init.sql
41779 # nano /usr/local/lib/locum/config/locum.ini
41780 # mkdir /usr/local/var
41781 # mkdir /usr/local/var/log</programlisting>
41783 <para>Configure the DSN:</para>
41785 <programlisting>[locum_config]
41786 dsn_file = "/usr/local/etc/locum_insurge_dsn.php"</programlisting>
41788 <para>And the information for your Koha installation:</para>
41790 <programlisting>[ils_config]
41792 ils_version = "30x"
41793 ils_server = "localhost"
41794 ils_harvest_port = "80"</programlisting>
41796 <para>The rest depends on your Koha configuration.</para>
41800 <section id="sopackoha">
41801 <title>Installation of Koha Connector</title>
41803 <para>Download the Koha connector using SVN:</para>
41805 <programlisting># cd /usr/local/lib/locum/connectors/
41806 # svn co http://dobby.darienlibrary.org/svn/connectors/koha/ locum_koha_30x</programlisting>
41809 <section id="sopacharvest">
41810 <title>Harvest Records</title>
41812 <para>Now that the connector is in place, we will be able to launch
41813 harvest.php, a tool that will reap Locum DB Koha and fill the
41816 <para>Start by configuring harvest.php:</para>
41818 <programlisting># nano /usr/local/lib/locum/tools/harvest.php</programlisting>
41820 <para>Here are the variables you must change:</para>
41822 <programlisting>$first_record = 1;
41823 $last_record = 30;</programlisting>
41825 <para>These are the minimum and maximum biblionumbers from your Koha
41828 <para>Then start the harvest:</para>
41830 <programlisting># chmod +x /usr/local/lib/locum/tools/harvest.php
41831 $ /usr/local/lib/locum/tools/harvest.php</programlisting>
41834 <section id="sopacphinx">
41835 <title>Installation of Sphinx</title>
41837 <para>Sphinx is the indexer for the database used by Locum and
41840 <section id="sphinxdepend">
41841 <title>Dependencies</title>
41843 <para>There is no Debian package for Sphinx so you'll have to compile
41844 the source directly:</para>
41846 <programlisting># apt-get install g++ make libmysql++-dev</programlisting>
41849 <section id="sphinxdownload">
41850 <title>Download and Compile</title>
41852 <programlisting>$ wget http://sphinxsearch.com/downloads/sphinx-0.9.8.tar.gz
41853 $ tar zxvf sphinx-0.9.8.tar.gz
41855 $ ./configure --prefix=/usr/local/sphinx
41858 # mkdir /usr/local/sphinx
41859 # mkdir /usr/local/sphinx/lib
41860 # cp api/sphinxapi.php /usr/local/sphinx/lib/
41861 $ rm -R sphinx-0.9.8*</programlisting>
41864 <section id="sphinxuser">
41865 <title>Creation of User and Group</title>
41867 <para>Creating a Sphinx user and change the owner:</para>
41869 <programlisting># adduser sphinx
41871 # usermod -G sphinx sphinx
41872 # mkdir /usr/local/sphinx/var/run
41873 # chown -R sphinx.sphinx /usr/local/sphinx/var</programlisting>
41876 <section id="demonsphinx">
41877 <title>The Sphinx daemon</title>
41879 <para>Download:</para>
41881 <programlisting># cd /etc/init.d
41882 # wget http://www.thesocialopac.net/sites/thesocialopac.net/files/sphinx
41883 # chmod +x /etc/init.d/sphinx</programlisting>
41885 <para>Add Sphinx to the default boot services:</para>
41887 <programlisting># update-rc.d sphinx defaults</programlisting>
41890 <section id="sphinxconfig">
41891 <title>Configuration</title>
41893 <para>Copy the configuration file supplied with the source of Sphinx
41894 before the change:</para>
41896 <programlisting># cp /usr/local/lib/locum/sphinx/sphinx.conf /usr/local/sphinx/etc/
41897 # sed 's/locum_db_user/scas_user/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile;
41898 mv tmpfile /usr/local/sphinx/etc/sphinx.conf
41899 # sed 's/locum_db_pass/scas_pass/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
41901 <para>And if you personalize the name of the database:</para>
41903 <programlisting># sed 's/scas/MY_DB/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf</programlisting>
41906 <section id="sphinxindexing">
41907 <title>Indexing documents</title>
41909 <para>Indexing is necessary if you want to use the search features of
41912 <para>You must first complete the Insurge table index</para>
41914 <programlisting># chmod +x /usr/local/lib/insurge/tools/update-index.php
41915 $ /usr/local/lib/insurge/tools/update-index.php</programlisting>
41917 <para>Then start indexing Sphinx</para>
41919 <programlisting>$ /usr/local/sphinx/bin/indexer --all</programlisting>
41921 <para>Finally, we must start the daemon:</para>
41923 <programlisting># /etc/init.d/sphinx start</programlisting>
41925 <para>When the daemon is running, you can update the index with:</para>
41927 <programlisting>$ /usr/local/sphinx/bin/indexer --all --rotate</programlisting>
41931 <section id="installsopac">
41932 <title>Installation of SOPAC2</title>
41934 <para>Now to the SOPAC software itself:</para>
41936 <section id="downloadsopac">
41937 <title>Download</title>
41939 <para>Download from SVN:</para>
41941 <programlisting>$ cd /chemin/vers/drupal/sites/all/
41944 $ svn co http://dobby.darienlibrary.org/svn/sopac/trunk/ sopac</programlisting>
41947 <section id="sopacinstallation">
41948 <title>Installation</title>
41950 <para>In Drupal's administration settings, activate the module.
41951 Also, enable the dependencies:</para>
41955 <para>Profile</para>
41959 <para>PHP Filter</para>
41967 <para>The Drupal menu should now list these entries.</para>
41970 <section id="configsopac">
41971 <title>Configuration</title>
41973 <para>Then go into the settings of SOPAC.</para>
41977 <para>Configure the paths to the Locum and Insurge
41982 <para>Choose a URL prefix SOPAC, in my "catalog". Create a node
41983 with content like:</para>
41987 <programlisting><?php
41988 print sopac_search_form('both');
41989 print theme('pages_catalog');</programlisting>
41993 <para>Check the Input Format "PHP Code"</para>
41997 <para>Check Move to front page</para>
42001 <para>In URL path settings, set the SOPAC URL prefix you have
42006 <para>Go to the root of Drupal, a search form will appear.</para>
42008 <para>Remember to empty Drupal's cache when something does not
42011 <para>Drupal offers a few blocks, which are not configured by default.
42012 You must specify on which page they should appear.</para>
42017 <chapter id="cronjobsch">
42018 <title>Cron Jobs</title>
42020 <para>A cron job is a Linux command for scheduling a command or script on your server to
42021 complete repetitive tasks automatically. Scripts executed as a cron job are typically used to
42022 modify files or databases; however, they can perform other tasks that do not modify data on
42023 the server, like sending out email notifications. Koha has many cron jobs in place that you
42024 can enable (search engine indexing, overdue notice generation, data cleanup and more), this
42025 chapter will explain those for you.</para>
42027 <section id="cronjobs">
42028 <title>Cron Jobs</title>
42030 <para>The locations below assume a dev install which puts the crons in
42031 misc/, if you have a standard install you may want to look in bin/ for
42032 these files if you cannot find them in misc/</para>
42034 <section id="searchcron">
42035 <title>Search</title>
42039 <section id="rebuildsearchcron">
42040 <title>Rebuild Index</title>
42042 <para>Script path: misc/migration_tools/rebuild_zebra.pl</para>
42044 <para>Does: Updates Zebra indexes with recently changed data.</para>
42046 <para>Required by: Zebra</para>
42048 <para>Frequency suggestion: every x minutes, (between 5-15 minutes)
42049 depending on performance needs</para>
42053 <section id="circcron">
42054 <title>Circulation</title>
42056 <section id="buildholdscron">
42057 <title>Holds Queue</title>
42059 <para>Script path: misc/cronjobs/holds/build_holds_queue.pl</para>
42061 <para>Does: Updates holds queue report</para>
42063 <para>Required by: <link linkend="holdsqueue">Holds Queue
42064 Report</link></para>
42066 <para>Frequency suggestion: every 1-4 hours</para>
42068 <para>Description:</para>
42072 <para>A script that should be run periodically if your library
42073 system allows borrowers to place on-shelf holds. This script
42074 decides which library should be responsible for fulfilling a
42075 given hold request.</para>
42077 <para>It's behavior is controlled by the system preferences
42078 <link linkend="holdqueueweight">StaticHoldsQueueWeight</link>
42079 and <link linkend="holdqueueweight">RandomizeHoldsQueueWeight</link>.</para>
42081 <para>If you do not want all of your libraries to participate in
42082 the on-shelf holds fulfillment process, you should list the the
42083 libraries that *do* participate in the process here by inputting
42084 all the participating library's branchcodes, separated by commas
42085 ( e.g. "MPL,CPL,SPL,BML" etc. ).</para>
42087 <para>By default, the holds queue will be generated such that
42088 the system will first attempt to hold fulfillment using items
42089 already at the pickup library if possible. If there are no items
42090 available at the pickup library to fill a hold,
42091 build_holds_queue.pl will then use the list of libraries defined
42092 in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is
42093 disabled ( which it is by default ), the script will assign
42094 fulfillment requests in the order the branches are placed in the
42095 StaticHoldsQueueWeight system preference.</para>
42097 <para>For example, if your system has three libraries, of
42098 varying sizes ( small, medium and large ) and you want the
42099 burden of holds fulfillment to be on larger libraries before
42100 smaller libraries, you would want StaticHoldsQueueWeight to look
42101 something like "LRG,MED,SML".</para>
42103 <para>If you want the burden of holds fulfillment to be spread
42104 out equally throughout your library system, simply enable
42105 RandomizeHoldsQueueWeight. When this system preference is
42106 enabled, the order in which libraries will be requested to
42107 fulfill an on-shelf hold will be randomized each time the list
42108 is regenerated.</para>
42110 <para>Leaving StaticHoldsQueueWeight empty is contraindicated at
42111 this time. Doing so will cause the build_holds_queue script to
42112 ignore RandomizeHoldsQueueWeight, causing the script to request
42113 hold fulfillment not randomly, but by alphabetical order.</para>
42117 <section id="buildholdscronperl">
42118 <title>Perl Documentation</title>
42120 <para><emphasis role="bold">GetBibsWithPendingHoldRequests</emphasis></para>
42122 <para>my $biblionumber_aref =
42123 GetBibsWithPendingHoldRequests();</para>
42125 <para>Return an arrayref of the biblionumbers of all bibs that
42126 have one or more unfilled hold requests.</para>
42128 <para><emphasis role="bold">GetPendingHoldRequestsForBib</emphasis></para>
42130 <para>my $requests =
42131 GetPendingHoldRequestsForBib($biblionumber);</para>
42133 <para>Returns an arrayref of hashrefs to pending, unfilled hold
42136 <para>the bib identified by $biblionumber. The following keys are
42137 present in each hashref:</para>
42141 <para>biblionumber</para>
42145 <para>borrowernumber</para>
42149 <para>itemnumber</para>
42153 <para>priority</para>
42157 <para>branchcode</para>
42161 <para>reservedate</para>
42165 <para>reservenotes</para>
42169 <para>borrowerbranch</para>
42173 <para>The arrayref is sorted in order of increasing
42176 <para><emphasis role="bold">GetItemsAvailableToFillHoldRequestsForBib</emphasis></para>
42178 <para>my $available_items =</para>
42180 <para>GetItemsAvailableToFillHoldRequestsForBib($biblionumber);</para>
42182 <para>Returns an arrayref of items available to fill hold requests
42183 for the bib identified by $biblionumber. An item is available to
42186 <para>request if and only if:</para>
42190 <para>it is not on loan</para>
42194 <para>it is not withdrawn</para>
42198 <para>it is not marked notforloan</para>
42202 <para>it is not currently in transit</para>
42206 <para>it is not lost</para>
42210 <para>it is not sitting on the hold shelf</para>
42214 <para><emphasis role="bold">MapItemsToHoldRequests</emphasis></para>
42216 <para>MapItemsToHoldRequests($hold_requests,
42217 $available_items);</para>
42219 <para><emphasis role="bold">CreatePickListFromItemMap</emphasis></para>
42221 <para><emphasis role="bold">AddToHoldTargetMap</emphasis></para>
42223 <para><emphasis role="bold">_get_branches_to_pull_from</emphasis></para>
42225 <para>Query system preferences to get ordered list of branches to
42226 use to fill hold requests.</para>
42230 <section id="expiredholdscron">
42231 <title>Expired Holds</title>
42234 misc/cronjobs/holds/cancel_expired_holds.pl</para>
42236 <para>Does: By default, this cron job will only automatically cancel
42237 holds where the user has set an expiration date. If the library is
42238 using the <link linkend="ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</link>
42239 and <link linkend="ExpireReservesMaxPickUpDelayCharge">ExpireReservesMaxPickUpDelayCharge</link>
42240 preferences then this script will also cancel holds that have been
42241 sitting on the hold shelf for too long and will (if the library
42242 does) charge the patron for not picking up the hold.</para>
42244 <para>Frequency suggestion: daily</para>
42247 <section id="unsuspendholdcron">
42248 <title>Unsuspend Holds</title>
42251 misc/cronjobs/holds/auto_unsuspend_holds.pl</para>
42253 <para>Does: This script checks to find holds that should no longer
42254 be suspended and removes the suspension if the <link linkend="AutoResumeSuspendedHolds">AutoResumeSuspendedHolds</link>
42255 preference is set to 'allow'. This puts the patron back in to the
42256 queue where they were when the hold was suspended.</para>
42258 <para>Frequency suggestion: daily</para>
42261 <section id="finescronjob">
42262 <title>Fines</title>
42264 <para>Script path: misc/cronjobs/fines.pl</para>
42265 <para>Does: Calculates and posts fines to patron accounts.</para>
42267 <para>Required by: <link linkend="finesMode">finesMode</link> system
42270 <para>Frequency suggestion: nightly</para>
42273 <section id="longoverduecron">
42274 <title>Long Overdues</title>
42276 <para>Script path: misc/cronjobs/longoverdue.pl</para>
42278 <para>Does: allows one to specify delays for changing items to
42279 different lost statuses, and optionally charge for them using the
42280 replacement price listed on the item record.</para>
42282 <para>Frequency suggestion: nightly</para>
42284 <section id="longoverduecronperl">
42285 <title>Perl Documentation</title>
42287 <para><emphasis role="bold">NAME</emphasis></para>
42289 <para>longoverdue.pl cron script to set lost statuses on overdue
42290 materials. Execute without options for help.</para>
42294 <section id="updateissuescron">
42295 <title>Track total checkouts</title>
42297 <para>Script path: misc/cronjobs/update_totalissues.pl</para>
42299 <para>Does: updates the biblioitems.totalissues field in the
42300 database with the latest tally of checkouts.</para>
42302 <para>Frequency suggestion: nightly</para>
42303 <section id="updateissuesperldoc">
42304 <title>Perl Documentation</title>
42305 <para><emphasis role="bold">NAME</emphasis>
42307 <para>update_totalissues.pl </para>
42308 <para><emphasis role="bold">SYNOPSIS</emphasis>
42310 <para>update_totalissues.pl --use-stats </para>
42311 <para>update_totalissues.pl --use-items </para>
42312 <para>update_totalissues.pl --commit=1000 </para>
42313 <para>update_totalissues.pl --since='2012-01-01' </para>
42314 <para>update_totalissues.pl --interval=30d </para>
42315 <para><emphasis role="bold">DESCRIPTION</emphasis>
42317 <para>This batch job populates bibliographic records' total issues count based on
42318 historical issue statistics. </para>
42319 <para>--help Prints this help </para>
42320 <para>-v|--verbose </para>
42321 <para>Provide verbose log information (list every bib modified). </para>
42322 <para>--use-stats </para>
42323 <para>Use the data in the statistics table for populating total issues. </para>
42324 <para>--use-items </para>
42325 <para>Use items.issues data for populating total issues. Note that issues data from the
42326 items table does not respect the --since or --interval options, by definition. Also
42327 note that if both --use-stats and --use-items are specified, the count of biblios
42328 processed will be misleading. </para>
42329 <para>-s|--since=DATE </para>
42330 <para>Only process issues recorded in the statistics table since DATE. </para>
42331 <para>-i|--interval=S </para>
42332 <para>Only process issues recorded in the statistics table in the last N units of time.
42333 The interval should consist of a number with a one- letter unit suffix. The valid
42334 suffixes are h (hours), d (days), w (weeks), m (months), and y (years). The default
42335 unit is days. </para>
42336 <para>--incremental </para>
42337 <para>Add the number of issues found in the statistics table to the existing total
42338 issues count. Intended so that this script can be used as a cron job to update
42339 popularity information during low-usage periods. If neither --since or --interval are
42340 specified, incremental mode will default to processing the last twenty-four hours. </para>
42341 <para>--commit=N </para>
42342 <para>Commit the results to the database after every N records are processed. </para>
42343 <para>--test </para>
42344 <para>Only test the popularity population script. </para>
42345 <para><emphasis role="bold">WARNING</emphasis>
42347 <para>If the time on your database server does not match the time on your Koha server
42348 you will need to take that into account, and probably use the --since argument instead
42349 of the --interval argument for incremental updating. </para>
42350 <para><emphasis role="bold">CREDITS</emphasis>
42352 <para>This patch to Koha was sponsored by the Arcadia Public Library and the Arcadia
42353 Public Library Foundation in honor of Jackie Faust-Moreno, late director of the
42354 Arcadia Public Library. </para>
42355 <para><emphasis role="bold">AUTHOR</emphasis>
42357 <para>Jared Camins-Esakov <jcamins AT cpbibliography DOT com></para>
42360 <section id="offlinecirccron">
42361 <title>Generate Patron File for Offline Circulation</title>
42362 <para>Script path: misc/cronjobs/create_koc_db.pl</para>
42363 <para>Does: Generates the borrowers.db file for use with the <link
42364 linkend="windowsofflinecirc">Koha Offline Circulation</link> tool</para>
42365 <para>Frequency suggestion: weekly</para>
42368 <section id="patroncrons">
42369 <title>Patrons</title>
42371 <section id="deleteexpiredregistrationcron">
42372 <title>Unverified Registrations</title>
42373 <para>Script path: misc/cronjobs/delete_expired_opac_registrations.pl</para>
42374 <para>Does: Deletes patron registrations that were submitted via the OPAC but not reviewed
42375 by the library within the number of days entered in the <link linkend="PatronSelfRegistrationExpireTemporaryAccountsDelay">PatronSelfRegistrationExpireTemporaryAccountsDelay</link> preference.</para>
42376 <para>Frequency suggestion: nightly</para>
42378 <section id="deleteunverifiedcron">
42379 <title>Unconfirmed Registrations</title>
42380 <para>Script path: misc/cronjobs/delete_unverified_opac_registrations.pl </para>
42381 <para>Does: Deletes patron self registrations that were submitted via the OPAC but not
42382 confirmed via email within 24 hours. This is only necessary if you are requiring patrons
42383 to confirm their registrations via email with the <link linkend="PatronSelfRegistrationVerifyByEmail">PatronSelfRegistrationVerifyByEmail</link> preference.</para>
42384 <para>Frequency suggestion: hourly</para>
42386 <section id="anonymizecron">
42387 <title>Anonymize Patron Data</title>
42388 <para>Script path: misc/cronjobs/batch_anonymise.pl</para>
42389 <para>Does: Used to anonymize patron data. This will remove borrowernumbers from
42390 circulation history so that the stats are kept, but the patron information is removed
42391 for privacy reasons.</para>
42393 <section id="j2acron">
42394 <title>Update Child to Adult Patron Type</title>
42395 <para>Script path: misc/cronjobs/j2a.pl</para>
42396 <para>Does: Convert juvenile/child patrons from juvenile patron category and category code
42397 to corresponding adult patron category and category code when they reach the upper age
42398 limit defined in the Patron Categories. </para>
42399 <para>Frequency suggestion: nightly</para>
42400 <section id="j2aperldoc">
42401 <title>Perl Documentation</title>
42402 <para><emphasis role="bold">NAME</emphasis>
42404 <para>juv2adult.pl - convert juvenile/child patrons from juvenile patron category and
42405 category code to corresponding adult patron category and category code when they reach
42406 the upper age limit defined in the Patron Categories. </para>
42407 <para><emphasis role="bold">SYNOPSIS</emphasis>
42409 <para>juv2adult.pl [ -b=<branchcode> -f=<categorycode> -t=<categorycode> ] </para>
42410 <para>Options: </para>
42411 <para>--help brief help message </para>
42412 <para>--man full documentation </para>
42413 <para>-v verbose mode </para>
42414 <para>-n take no action, display only </para>
42415 <para>-b <branchname> only deal with patrons from this library/branch </para>
42416 <para>-f <categorycode> change patron category from this category </para>
42417 <para>-t <categorycode> change patron category to this category </para>
42418 <para>=head1 OPTIONS </para>
42419 <para>--help Print a brief help message and exits. </para>
42420 <para>--man Prints the manual page and exits. </para>
42421 <para>-v Verbose. Without this flag set, only fatal errors are reported. </para>
42422 <para>-n No Action. With this flag set, script will report changes but not actually
42423 execute them on the database. </para>
42424 <para>-b changes patrons for one specific branch. Use the value in the
42425 branches.branchcode table.</para>
42426 <para> -f *required* defines the juvenile category to update. Expects the code from
42427 categories.categorycode. </para>
42428 <para>-t *required* defines the category juvenile patrons will be converted to. Expects
42429 the code from categories.categorycode. </para>
42430 <para><emphasis role="bold">DESCRIPTION</emphasis>
42432 <para>This script is designed to update patrons from juvenile to adult patron types,
42433 remove the guarantor, and update their category codes appropriately when they reach
42434 the upper age limit defined in the Patron Categories. </para>
42435 <para><emphasis role="bold">USAGE EXAMPLES</emphasis>
42437 <para>"juv2adult.pl" - Suggests that you read this help. :) </para>
42438 <para>"juv2adult.pl" -b=<branchcode> -f=<categorycode> -t=<categorycode> -
42439 Processes a single branch, and updates the patron categories from fromcat to tocat. </para>
42440 <para>"juv2adult.pl" -f=<categorycode> -t=<categorycode> -v -n - Processes all
42441 branches, shows all messages, and reports the patrons who would be affected. Takes no
42442 action on the database.</para>
42447 <section id="noticescron">
42448 <title>Notices</title>
42452 <section id="msgqueuecron">
42453 <title>Message Queue</title>
42455 <para>Script path: misc/cronjobs/process_message_queue.pl</para>
42457 <para>Does: processes the message queue to send the check out, check in and hold filled
42458 emails and SMS message to users and sends outgoing emails to patrons. requires <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link> to be
42461 <para>Frequency suggestion: 1-4 hours<important>
42462 <para>Item due and Advanced due notices are controlled by the <link linkend="advnoticecron">advance_notices cron</link>.</para>
42463 </important></para>
42466 <section id="advnoticecron">
42467 <title>Advanced Notice</title>
42469 <para>Script path: misc/cronjobs/advance_notices.pl</para>
42471 <para>Does: prepares "pre-due" notices and "item due" notices for
42472 patrons who request them prepares notices for patrons for items just
42473 due or coming due soon. requires <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
42476 <para>Frequency suggestion: nightly</para>
42479 <para>This script does not actually send the notices. It queues
42480 them in the <link linkend="msgqueuecron">message queue</link> for
42484 <section id="advnoticecronperl">
42485 <title>Perl Documentation</title>
42487 <para><emphasis role="bold">NAME</emphasis></para>
42489 <para>advance_notices.pl - cron script to put item due reminders
42490 into message queue</para>
42492 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
42494 <para>./advance_notices.pl -c</para>
42496 <para>or, in crontab: 0 1 * * * advance_notices.pl -c</para>
42498 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
42500 <para>This script prepares pre-due and item due reminders to be
42501 sent to patrons. It queues them in the message queue, which is
42502 processed by the process_message_queue.pl cronjob. The type and
42503 timing of the messages can be configured by the patrons in their
42504 "My Alerts" tab in the OPAC.</para>
42506 <para><emphasis role="bold">METHODS</emphasis></para>
42508 <para>parse_letter</para>
42512 <section id="overduenoticecron">
42513 <title>Overdue Notice</title>
42515 <para>Script path: misc/cronjobs/overdue_notices.pl</para>
42517 <para>Does: prepares messages to alert patrons of overdue messages
42518 (both via email and print)</para>
42520 <para>Frequency suggestion: nightly</para>
42523 <para>This script does not actually send the notices. It queues
42524 them in the <link linkend="msgqueuecron">message queue</link> for
42525 later or generates the HTML for later printing</para>
42528 <section id="overduenoticecronperl">
42529 <title>Perl Documentation</title>
42531 <para><emphasis role="bold">NAME</emphasis></para>
42533 <para>overdue_notices.pl - prepare messages to be sent to patrons
42534 for overdue items</para>
42536 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
42538 <para>overdue_notices.pl [ -n ] [ -library <branchcode> ] [
42539 -library <branchcode>...] [ -max <number of days> ] [
42540 -csv [ <filename> ] ] [-itemscontent <field list>
42543 <para>Options:</para>
42545 <para>-help brief help message</para>
42547 <para>-man full documentation</para>
42549 <para>-n No email will be sent</para>
42551 <para>-max <days> maximum days overdue to deal with</para>
42553 <para>-library <branchname> only deal with overdues from
42554 this library (repeatable : several libraries can be given)</para>
42556 <para>-csv <filename> populate CSV file</para>
42558 <para>-html <filename> Output html to file</para>
42560 <para>-itemscontent <list of fields> item information in
42563 <para>-borcat <categorycode> category code that must be
42566 <para>-borcatout <categorycode> category code that must be
42569 <para><emphasis role="bold">OPTIONS</emphasis></para>
42571 <para>-help Print a brief help message and exits.</para>
42573 <para>-man Prints the manual page and exits.</para>
42575 <para>-v Verbose. Without this flag set, only fatal errors are
42578 <para>-n Do not send any email. Overdue notices that would have
42579 been sent to the patrons or to the admin are printed to standard
42580 out. CSV data (if the -csv flag is set) is written to standard out
42581 or to any csv filename given.</para>
42583 <para>-max Items older than max days are assumed to be handled
42584 somewhere else, probably the longoverdues.pl script. They are
42585 therefore ignored by this program. No notices are sent for them,
42586 and they are not added to any CSV files. Defaults to 90 to match
42587 longoverdues.pl.</para>
42589 <para>-library</para>
42591 <para>select overdues for one specific library. Use the value in
42592 the branches.branchcode table. This option can be repeated in
42593 order to select overdues for a group of libraries.</para>
42595 <para>-csv Produces CSV data. if -n (no mail) flag is set, then
42596 this CSV data is sent to standard out or to a filename if
42597 provided. Otherwise, only overdues that could not be emailed are
42598 sent in CSV format to the admin.</para>
42600 <para>-itemscontent</para>
42602 <para>comma separated list of fields that get substituted into
42603 templates in places of the <<items.content>>
42604 placeholder. This defaults to
42605 issuedate,title,barcode,author</para>
42607 <para>Other possible values come from fields in the biblios,
42608 items, and issues tables.</para>
42610 <para>-borcat Repetable field, that permit to select only few of
42611 patrons categories.</para>
42613 <para>-borcatout</para>
42615 <para>Repetable field, permis to exclude some patrons
42618 <para>-t | --triggered</para>
42620 <para>This option causes a notice to be generated if and only if
42621 an item is overdue by the number of days defined in a notice
42624 <para>By default, a notice is sent each time the script runs,
42625 which is suitable for less frequent run cron script, but requires
42626 syncing notice triggers with the cron schedule to ensure proper
42627 behavior. Add the --triggered option for daily cron, at the risk
42628 of no notice being generated if the cron fails to run on
42631 <para>-list-all</para>
42633 <para>Default items.content lists only those items that fall in
42634 the range of the currently processing notice. Choose list-all to
42635 include all overdue items in the list (limited by -max
42638 <para><emphasis role="bold">DESCRIPTION</emphasis></para>
42640 <para>This script is designed to alert patrons and administrators
42641 of overdue items.</para>
42643 <para>Configuration</para>
42645 <para>This script pays attention to the overdue notice
42646 configuration performed in the "Overdue notice/status triggers"
42647 section of the "Tools" area of the staff interface to Koha. There,
42648 you can choose which letter templates are sent out after a
42649 configurable number of days to patrons of each library. More
42650 information about the use of this section of Koha is available in
42651 the Koha manual.</para>
42653 <para>The templates used to craft the emails are defined in the
42654 "Tools: Notices" section of the staff interface to Koha.</para>
42656 <para>Outgoing emails</para>
42658 <para>Typically, messages are prepared for each patron with
42659 overdue items. Messages for whom there is no email address on file
42660 are collected and sent as attachments in a single email to each
42661 library administrator, or if that is not set, then to the email
42662 address in the "KohaAdminEmailAddress" system preference.</para>
42664 <para>These emails are staged in the outgoing message queue, as
42665 are messages produced by other features of Koha. This message
42666 queue must be processed regularly by the
42667 misc/cronjobs/process_message_queue.pl program.</para>
42669 <para>In the event that the "-n" flag is passed to this program,
42670 no emails are sent. Instead, messages are sent on standard output
42671 from this program. They may be redirected to a file if
42674 <para>Templates</para>
42676 <para>Templates can contain variables enclosed in double angle
42677 brackets like <<this>>. Those variables will be
42678 replaced with values specific to the overdue items or relevant
42679 patron. Available variables are:</para>
42681 <para><<bib>></para>
42683 <para>the name of the library</para>
42685 <para><<items.content>></para>
42687 <para>one line for each item, each line containing a tab separated
42688 list of title, author, barcode, issuedate</para>
42690 <para><<borrowers.*>></para>
42692 <para>any field from the borrowers table</para>
42694 <para><<branches.*>></para>
42696 <para>any field from the branches table</para>
42698 <para>CSV output</para>
42700 <para>The "-csv" command line option lets you specify a file to
42701 which overdues data should be output in CSV format.</para>
42703 <para>With the "-n" flag set, data about all overdues is written
42704 to the file. Without that flag, only information about overdues
42705 that were unable to be sent directly to the patrons will be
42706 written. In other words, this CSV file replaces the data that is
42707 typically sent to the administrator email address.</para>
42709 <para><emphasis role="bold">USAGE EXAMPLES</emphasis></para>
42711 <para>"overdue_notices.pl" - In this most basic usage, with no
42712 command line arguments, all libraries are processed individually,
42713 and notices are prepared for all patrons with overdue items for
42714 whom we have email addresses. Messages for those patrons for whom
42715 we have no email address are sent in a single attachment to the
42716 library administrator's email address, or to the address in the
42717 KohaAdminEmailAddress system preference.</para>
42719 <para>"overdue_notices.pl -n -csv /tmp/overdues.csv" - sends no
42720 email and populates /tmp/overdues.csv with information about all
42721 overdue items.</para>
42723 <para>"overdue_notices.pl -library MAIN max 14" - prepare notices
42724 of overdues in the last 2 weeks for the MAIN library.</para>
42726 <para><emphasis role="bold">SEE ALSO</emphasis></para>
42728 <para>The misc/cronjobs/advance_notices.pl program allows you to
42729 send messages to patrons in advance of their items becoming due,
42730 or to alert them of items that have just become due.</para>
42732 <para><emphasis role="bold">INTERNAL METHODS</emphasis></para>
42734 <para>These methods are internal to the operation of
42735 overdue_notices.pl.</para>
42737 <para>parse_letter</para>
42739 <para>parses the letter template, replacing the placeholders with
42740 data specific to this patron, biblio, or item</para>
42742 <para>named parameters:</para>
42744 <para>letter - required hashref</para>
42746 <para>borrowernumber - required integer</para>
42748 <para>substitute - optional hashref of other key/value pairs that
42749 should be substituted in the letter content</para>
42751 <para>returns the "letter" hashref, with the content updated to
42752 reflect the substituted keys and values.</para>
42754 <para>prepare_letter_for_printing</para>
42756 <para>returns a string of text appropriate for printing in the
42757 event that an overdue notice will not be sent to the patron's
42758 email address. Depending on the desired output format, this may be
42759 a CSV string, or a human-readable representation of the
42762 <para>required parameters:</para>
42764 <para>letter</para>
42766 <para>borrowernumber</para>
42768 <para>optional parameters:</para>
42770 <para>outputformat</para>
42774 <section id="printholdcron">
42775 <title>Print Hold Notices</title>
42777 <para>Script path: misc/cronjobs/gather_print_notices.pl</para>
42779 <para>Does: looks through the message queue for hold notices that
42780 didn't go through because the patron didn't have an email address
42781 and generates a print notice</para>
42783 <para>Frequency suggestion: nightly</para>
42786 <section id="talkingtechcrons">
42787 <title>Talking Tech</title>
42789 <para>To learn more about setting up this third party product view
42790 the <link linkend="talkingtechappendix">Talking Tech
42791 Appendix</link>.</para>
42793 <section id="talkingtechsendcron">
42794 <title>Sending Notices File</title>
42797 misc/cronjobs/thirdparty/TalkingTech_itiva_outbound.pl</para>
42799 <para>Does: Script to generate Spec C outbound notifications file
42800 for Talking Tech i-tiva phone notification system.</para>
42802 <para>Required by: <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
42804 <para>Frequency suggestion: nightly</para>
42806 <section id="talkingsendcronperl">
42807 <title>Perl Documentation</title>
42809 <para><emphasis role="bold">USAGE</emphasis></para>
42811 <para>TalkingTech_itiva_outbound.pl</para>
42813 <para>TalkingTech_itiva_outbound.pl --type=OVERDUE -w 0 -w 2 -w
42814 6 --output=/tmp/talkingtech/outbound.csv</para>
42816 <para>TalkingTech_itiva_outbound.pl --type=RESERVE
42817 --type=PREOVERDUE --lang=FR</para>
42819 <para>Script to generate Spec C outbound notifications file for
42820 Talking Tech i-tiva phone notification system.</para>
42822 <para>--help -h</para>
42824 <para>Prints this help</para>
42826 <para>-v Provide verbose log information.</para>
42828 <para>--output -o</para>
42830 <para>Destination for outbound notifications file (CSV format).
42831 If no value is specified, output is dumped to screen.</para>
42833 <para>--lang</para>
42835 <para>Sets the language for all outbound messages. Currently
42836 supported values are EN, FR and ES. If no value is specified, EN
42837 will be used by default.</para>
42839 <para>--type</para>
42841 <para>REQUIRED. Sets which messaging types are to be used. Can
42842 be given multiple times, to specify multiple types in a single
42843 output file. Currently supported values are RESERVE, PREOVERDUE
42844 and OVERDUE. If no value is given, this script will not produce
42845 any outbound notifications.</para>
42847 <para>--waiting-hold-day -w</para>
42849 <para>OPTIONAL for --type=RESERVE. Sets the days after a hold
42850 has been set to waiting on which to call. Use switch as many
42851 times as desired. For example, passing "-w 0 -w 2 -w 6" will
42852 cause calls to be placed on the day the hold was set to waiting,
42853 2 days after the waiting date, and 6 days after. See example
42854 above. If this switch is not used with --type=RESERVE, calls
42855 will be placed every day until the waiting reserve is picked up
42856 or canceled.</para>
42858 <para>--library-code --code -c</para>
42860 <para>OPTIONAL The code of the source library of the message.
42861 The library code is used to group notices together for
42862 consortium purposes and apply library specific settings, such as
42863 prompts, to those notices. This field can be blank if all
42864 messages are from a single library.</para>
42868 <section id="talkingtechreceivecron">
42869 <title>Receiving Notices File</title>
42872 misc/cronjobs/thirdparty/TalkingTech_itiva_inbound.pl</para>
42874 <para>Does: Script to process received Results files for Talking
42875 Tech i-tiva phone notification system.</para>
42877 <para>Required by: <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link></para>
42879 <para>Frequency suggestion: nightly</para>
42881 <section id="talkingreceivecronperl">
42882 <title>Perl Documentation</title>
42884 <para><emphasis role="bold">USAGE</emphasis></para>
42886 <para>TalkingTech_itiva_inbound.pl</para>
42888 <para>TalkingTech_itiva_inbound.pl -v
42889 --input=/tmp/talkingtech/results.csv</para>
42891 <para>Script to process received Results files for Talking Tech
42892 i-tiva phone notification system.</para>
42894 <para>--help -h</para>
42896 <para>Prints this help</para>
42898 <para>-v Provide verbose log information.</para>
42900 <para>--input -i</para>
42902 <para>REQUIRED. Path to incoming results file.</para>
42908 <section id="proccartcron">
42909 <title>In Processing/Book Cart</title>
42911 <para>Script path: misc/cronjobs/cart_to_shelf.pl</para>
42913 <para>Does: Updates all items with a location of CART to the item's
42914 permanent location.</para>
42916 <para>Required by: <link linkend="NewItemsDefaultLocation">NewItemsDefaultLocation</link>,
42917 <link linkend="InProcessingToShelvingCart">InProcessingToShelvingCart</link>,
42918 & <link linkend="ReturnToShelvingCart">ReturnToShelvingCart</link>
42919 system preferences</para>
42921 <para>Frequency suggestion: hourly</para>
42923 <section id="proccartcronperl">
42924 <title>Perl Documentation</title>
42926 <para><emphasis role="bold">NAME</emphasis></para>
42928 <para>cart_to_shelf.pl cron script to set items with location of
42929 CART to original shelving location after X hours. Execute without
42930 options for help.</para>
42934 <section id="catalogcron">
42935 <title>Catalog</title>
42939 <section id="checkurlcron">
42940 <title>Check URLs</title>
42942 <para>Script path: misc/cronjobs/check-url.pl</para>
42944 <para>Does: checks URLs in 856$u field. Script output can now be
42945 formatted in CSV or HTML. The HTML version links directly to MARC
42946 biblio record editor.</para>
42948 <para>Frequency suggestion: monthly</para>
42950 <para>Learn more: <ulink url="http://wiki.koha-community.org/wiki/Check-url_enhancements">http://wiki.koha-community.org/wiki/Check-url_enhancements</ulink></para>
42952 <section id="checkurlcronperl">
42953 <title>Perl Documentation</title>
42955 <para><emphasis role="bold">NAME</emphasis></para>
42957 <para>C4::URL::Checker - base object for checking URL stored in
42960 <para><emphasis role="bold">SYNOPSIS</emphasis></para>
42962 <programlisting>use C4::URL::Checker;
42964 my $checker = C4::URL::Checker->new( );
42965 $checker->{ host_default } = 'http://mylib.kohalibrary.com';
42966 my $checked_urls = $checker->check_biblio( 123 );
42967 foreach my $url ( @$checked_urls ) {
42968 print "url: ", $url->{ url A }, "\n",
42969 "is_success: ", $url->{ is_success }, "\n",
42970 "status: ", $url->{ status }, "\n";
42971 } </programlisting>
42973 <para><emphasis role="bold">FUNCTIONS</emphasis></para>
42977 <para>Create a URL Checker. The returned object can be used to set
42978 default host variable :</para>
42980 <programlisting>my $checker = C4::URL::Checker->new( );
42981 $checker->{ host_default } = 'http://mylib.kohalibrary.com'; </programlisting>
42983 <para>check_biblio</para>
42985 <para>Check all URL from a biblio record. Returns a pointer to an
42986 array containing all URLs with checking for each of them.</para>
42988 <programlisting> my $checked_urls = $checker->check_biblio( 123 ); </programlisting>
42990 <para>With 2 URLs, the returned array will look like that:</para>
42994 'url' => 'http://mylib.tamil.fr/img/62265_0055B.JPG',
42995 'is_success' => 1,
42996 'status' => 'ok'
42999 'url' => 'http://mylib.tamil.fr//img/62265_0055C.JPG',
43000 'is_success' => 0,
43001 'status' => '404 - Page not found'
43003 ], </programlisting>
43005 <para><emphasis role="bold">NAME</emphasis></para>
43007 <para>check-url.pl - Check URLs from 856$u field.</para>
43009 <para><emphasis role="bold">USAGE</emphasis></para>
43011 <para>check-url.pl [--verbose|--help]
43012 [--host=http://default.tld]</para>
43014 <para>Scan all URLs found in 856$u of bib records and display if
43015 resources are available or not.</para>
43017 <para><emphasis role="bold">PARAMETERS</emphasis></para>
43019 <para>--host=http://default.tld</para>
43021 <para>Server host used when URL doesn't have one, ie doesn't begin
43022 with 'http:'. For example, if --host=http://www.mylib.com, then
43023 when 856$u contains 'img/image.jpg', the url checked is:
43024 http://www.mylib.com/image.jpg'.</para>
43026 <para>--verbose|-v</para>
43028 <para>Outputs both successful and failed URLs.</para>
43030 <para>--html</para>
43032 <para>Formats output in HTML. The result can be redirected to a
43033 file accessible by http. This way, it's possible to link directly
43034 to biblio record in edit mode. With this parameter --host-pro is
43037 <para>--host-pro=http://koha-pro.tld</para>
43039 <para>Server host used to link to biblio record editing
43042 <para>--help|-h</para>
43044 <para>Print this help page.</para>
43048 <section id="mergeauthcron">
43049 <title>Update Authorities</title>
43051 <para>Script path: misc/migration_tools/merge_authority.pl</para>
43053 <para>Does: Updates biblio data with changes to authorities records<note>
43054 <para>The name of this script is misleading. This script does not merge authorities
43055 together it instead merges authority data with linked bib records. Edits to
43056 authority records will be applied to bibliographic records that use that authority
43057 when this script is run.</para>
43060 <para>Required by: <link linkend="dontmerge">dontmerge</link> system
43063 <para>Frequency suggestion: nightly</para>
43066 <section id="serialscron">
43067 <title>Serials Update</title>
43069 <para>Script path: misc/cronjobs/serialsUpdate.pl</para>
43071 <para>Does: checks if there is a "late" issue on active
43072 subscriptions, and if there is, the script will set it as late, and
43073 add the next one as expected.</para>
43075 <para>Frequency suggestion: nightly</para>
43079 <section id="opaccrons">
43080 <title>OPAC</title>
43084 <section id="customrssfeedcron">
43085 <title>RSS Feeds</title>
43087 <para>Script path: misc/cronjobs/rss/rss.pl</para>
43089 <para>Does: Produces an RSS XML document for any SQL query (not used
43090 for search results RSS feed). <link linkend="customrss">Learn
43091 more</link>.</para>
43093 <para>Frequency suggestion: hourly</para>
43096 <section id="authbrowsercron">
43097 <title>Authorities Browser</title>
43099 <para>Script path: misc/cronjobs/build_browser_and_cloud.pl</para>
43101 <para>Does: Generate content for authorities browse in OPAC</para>
43103 <para>Required by: <link linkend="OpacBrowser">OpacBrowser</link> system preference<important>
43104 <para>This preference and cron job should only be used on French systems.</para>
43105 </important></para>
43108 <section id="keywordclouds">
43109 <title>Subject/Author Clouds</title>
43111 <para>Script path: misc/cronjobs/cloud-kw.pl</para>
43113 <para>Does: Generates HTML keywords clouds from Koha Zebra indexes.
43114 misc/cronjobs/cloud-sample.conf has a sample of how this script
43117 <para>Frequency: This is the type of script you can run once a month
43118 or so, the content generated isn't going to change very much over
43121 <section id="keywordcloudsperl">
43122 <title>Perl Documentation</title>
43124 <para><emphasis role="bold">NAME</emphasis></para>
43126 <para>cloud-kw.pl - Creates HTML keywords clouds from Koha Zebra
43129 <para><emphasis role="bold">USAGE</emphasis></para>
43131 <para>cloud-kw.pl [--verbose|--help] --conf=cloud.conf</para>
43133 <para>Creates multiple HTML files containing keywords cloud with
43134 top terms sorted by their logarithmic weight. cloud.conf is a YAML
43135 configuration file driving cloud generation process.</para>
43137 <para><emphasis role="bold">PARAMETERS</emphasis></para>
43139 <para>--conf=configuration file</para>
43141 <para>Specify configuration file name</para>
43143 <para>--verbose|-v</para>
43145 <para>Enable script verbose mode.</para>
43147 <para>--help|-h</para>
43149 <para>Print this help page.</para>
43151 <para><emphasis role="bold">CONFIGURATION</emphasis></para>
43153 <para>Configuration file looks like that:</para>
43155 <para><programlisting> ---
43156 # Koha configuration file for a specific installation
43157 # If not present, defaults to KOHA_CONF
43158 KohaConf: /home/koha/mylibray/etc/koha-conf.xml
43159 # Zebra index to scan
43161 # Koha index used to link found kewords with an opac search URL
43163 # Number of top keyword to use for the cloud
43165 # Include CSS style directives with the cloud
43166 # This could be used as a model and then CSS directives are
43167 # put in the appropriate CSS file directly.
43169 # HTML file where to output the cloud
43170 Output: /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
43172 KohaConf: /home/koha/yourlibray/etc/koha-conf.xml
43173 ZebraIndex: Subject
43177 Output: /home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html</programlisting><emphasis role="bold">IMPROVEMENTS</emphasis></para>
43179 <para>Generated top terms have more informations than those
43180 outputted from the time being. Some parameters could be easily
43181 added to improve this script:</para>
43183 <para>WithCount</para>
43185 <para>In order to output terms with the number of occurrences they
43186 have been found in Koha Catalogue by Zebra.</para>
43188 <para>CloudLevels</para>
43190 <para>Number of levels in the cloud. Now 24 levels are
43193 <para>Weighting</para>
43195 <para>Weighting method used to distribute terms in the cloud. We
43196 could have two values: Logarithmic and Linear. Now it's
43197 Logarithmic by default.</para>
43201 <para>Now terms are outputted in the lexical order. They could be
43202 sorted by their weight.</para>
43207 <section id="systemcron">
43208 <title>System Administration</title>
43212 <section id="cleandbcron">
43213 <title>Clean up Database</title>
43215 <para>Script path: misc/cronjobs/cleanup_database.pl</para>
43217 <para>Does: Truncates the sessions table, cleans out old zebraqueue entries, action logs
43218 and staged MARC files.</para>
43220 <title>Perl Documentation</title>
43221 <para><emphasis role="bold">USAGE</emphasis></para>
43222 <para>kohaclone/misc/cronjobs/cleanup_database.pl [-h|--help] [--sessions] [--sessdays
43223 DAYS] [-v|--verbose] [--zebraqueue DAYS] [-m|--mail] [--merged] [--import DAYS]
43224 [--logs DAYS] [--searchhistory DAYS]</para>
43225 <para><emphasis role="bold">PARAMETERS</emphasis></para>
43226 <para>-h --help </para>
43227 <para>prints this help message, and exits, ignoring all other options</para>
43228 <para>--sessions </para>
43229 <para>purge the sessions table. If you use this while users are logged into Koha, they
43230 will have to reconnect.</para>
43231 <para>--sessdays DAYS </para>
43232 <para>purge only sessions older than DAYS days</para>
43233 <para>-v --verbose </para>
43234 <para>will cause the script to give you a bit more information about the run.</para>
43235 <para>--zebraqueue DAYS </para>
43236 <para>purge completed zebraqueue entries older than DAYS days. Defaults to 30 days if no
43237 days specified.</para>
43238 <para>-m --mail DAYS </para>
43239 <para>purge items from the mail queue that are older than DAYS days. Defaults to 30 days
43240 if no days specified.</para>
43241 <para>--merged </para>
43242 <para>purged completed entries from need_merge_authorities.</para>
43243 <para>--import DAYS </para>
43244 <para>purge records from import tables older than DAYS days. Defaults to 60 days if no
43245 days specified</para>
43246 <para>--z3950 </para>
43247 <para>purge records from import tables that are the result of Z39.50 searches</para>
43248 <para>--logs DAYS </para>
43249 <para>purge entries from action_logs older than DAYS days. Defaults to 180 days if no
43250 days specified</para>
43251 <para>--searchhistory DAYS </para>
43252 <para>purge entries from search_history older than DAYS days. Defaults to 30 days if no
43253 days specified</para>
43254 <para>--list-invites DAYS </para>
43255 <para>purge (unaccepted) list share invites older than DAYS days. Defaults to 14 days if
43256 no days specified.</para>
43261 <section id="acqcrons">
43262 <title>Acquisitions</title>
43264 <section id="cleansuggcron">
43265 <title>Clean up old suggestions</title>
43267 <para>Script path: misc/cronjobs/purge_suggestions.pl</para>
43269 <para>Does: Removes old (defined by you) suggestions from the
43270 suggestion management area.</para>
43274 <section id="deprecatedcrons">
43275 <title>Deprecated scripts</title>
43277 <para>These should not be run without modification:</para>
43279 <para>Script path: misc/cronjobs/update_items.pl</para>
43281 <para>Script path:misc/cronjobs/smsoverdues.pl</para>
43283 <para>Script path:misc/cronjobs/notifyMailsOp.pl</para>
43285 <para>Script path:misc/cronjobs/reservefix.pl</para>
43287 <para>Script path:misc/cronjobs/zebraqueue_start.pl</para>
43292 <chapter id="webservices">
43293 <title>Web Services</title>
43297 <section id="OAI-PMHservice">
43298 <title>OAI-PMH</title>
43302 <section id="oaiconfsample">
43303 <title>Sample OAI Conf File</title>
43305 <para><programlisting> format:
43308 metadataNamespace: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs
43309 schema: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs.xsd
43310 xsl_file: /usr/local/koha/xslt/vs.xsl
43312 metadataPrefix: marxml
43313 metadataNamespace: http://www.loc.gov/MARC21/slim
43314 http://www.loc.gov/standards/marcxml/schema/MARC21slim
43315 schema: http://www.loc.gov/MARC21/slim
43316 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
43318 metadataPrefix: oai_dc
43319 metadataNamespace: http://www.openarchives.org/OAI/2.0/oai_dc/
43320 schema: http://www.openarchives.org/OAI/2.0/oai_dc.xsd
43322 /usr/local/koha/koha-tmpl/intranet-tmpl/xslt/UNIMARCslim2OAIDC.xsl</programlisting></para>
43325 <section id="Rest-services">
43326 <title>REST services</title>
43328 <para>Koha can now be requested by REST http requests. BibLibre wrotes an external module to adds more possibilities than ILS-DI can provide.There is no authentication process, but authorized ips are listed in the config file. Services have been tested in 3.10, 3.12 and 3.14 koha versions. You can find more information about it into README file and opac/rest.pl documentation on http://git.biblibre.com. If you want to add features, send us a patch at dev_patches AT biblibre DOT com.</para>
43329 <para>Services provided in 1.4 version are:
43332 GET user/byid/:borrowernumber/holds
43333 GET user/:user_name/holds
43334 GET user/byid/:borrowernumber/issues
43335 GET user/:user_name/issues
43336 GET user/:user_name/issues_history
43337 GET user/byid/:borrowernumber/issues_history
43341 PUT user/:user_name
43342 GET biblio/:biblionumber/items
43343 GET biblio/:biblionumber/holdable
43344 GET biblio/:biblionumber/items_holdable_status
43345 GET item/:itemnumber/holdable
43346 PUT auth/change_password
43348 GET /suggestions/:suggestionid
43350 PUT /suggestions/:suggestionid
43351 DELETE /suggestions/:suggestionid
43358 <title>Using the SRU server</title>
43360 <section id="usingsru">
43364 <firstname>Nicolas</firstname>
43365 <surname>Morin</surname>
43367 <orgname>BibLibre</orgname>
43372 <firstname>Nicole C.</firstname>
43373 <surname>Engard</surname>
43374 <contrib>Edits where necessary.</contrib>
43378 <pubdate>December 2009</pubdate>
43380 <title>Using the SRU server</title>
43382 <para>Koha implements the Search/Retrieve via URL (SRU) protocol. More
43383 information about the protocol itself can be found at <ulink url="http://www.loc.gov/standards/sru/">http://www.loc.gov/standards/sru/</ulink>.
43384 The version implemented is version 1.1.</para>
43386 <section id="sru_explain">
43387 <title>Explain</title>
43389 <para>If you want to have information about the implementation of SRU
43390 on a given server, you should have access to the Explain file using a
43391 request to the server without any parameter. Like
43392 <http://myserver.com:9999/biblios/>. The response from the
43393 server is an XML file that should look like the following and will
43394 give you information about the default settings of the SRU
43398 <zs:explainResponse>
43399 <zs:version>1.1</zs:version>
43401 <zs:recordSchema>http://explain.z3950.org/dtd/2.0/</zs:recordSchema>
43402 <zs:recordPacking>xml</zs:recordPacking>
43403 <zs:recordData>
43404 <explain xml:base="zebradb/explain-biblios.xml">
43406 try stylesheet url: http://./?stylesheet=docpath/sru2.xsl
43408 <serverInfo protocol="SRW/SRU/Z39.50">
43409 <host>biblibre</host>
43410 <port>9999</port>
43411 <database>biblios</database>
43412 </serverInfo>
43413 <databaseInfo>
43414 <title lang="en" primary="true">Koha 3 Bibliographic SRU/SRW/Z39.50 server</title>
43415 <description lang="en" primary="true">Koha 3 Bibliographic Server</description>
43417 <sru>http://biblibre:9999</sru>
43419 </databaseInfo>
43421 <set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1">
43422 <title>CQL Standard Set</title>
43424 <index search="true" scan="true" sort="false">
43425 <title lang="en">CQL Server Choice</title>
43427 <name set="cql">serverChoice</name>
43430 <attr type="1" set="bib1">text</attr>
43433 <index search="true" scan="true" sort="false">
43434 <title lang="en">CQL All</title>
43436 <name set="cql">all</name>
43439 <attr type="1" set="bib1">text</attr>
43442 <!-- Record ID index -->
43443 <index search="true" scan="true" sort="false">
43444 <title lang="en">Record ID</title>
43446 <name set="rec">id</name>
43449 <attr type="1" set="bib1">rec:id</attr>
43450 <attr type="4" set="bib1">3</attr>
43456 <section id="sru_search">
43457 <title>Search</title>
43460 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs
43461 is composed of the following elements:</para>
43465 <para>base url of the SRU server :
43466 http://myserver.com:9999/biblios?</para>
43470 <para>search part with the 3 required parameters : version,
43471 operation and query. The parameters within the search part should
43472 be of the key=value form, and can be combined with the &
43477 <para>One can add optional parameters to the query, for instance
43478 maximumRecords indicating the maximum number of records to be returned
43480 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs&maximumRecords=5
43481 will only get the first 5 results results from the server.</para>
43483 <para><ulink url="http://www.loc.gov/standards/sru/sru1-1archive/search-retrieve-operation.html">http://www.loc.gov/standards/sru/sru1-1archive/search-retrieve-operation.html</ulink>
43484 gives more details about the search operations and in particular the
43485 list of optional parameters for searching.</para>
43487 <section id="sru_search_more_details">
43488 <title>More details about Search</title>
43490 <para>The "operation" key can take two values: scan or
43491 searchRetrieve.</para>
43493 <para>If operation=searchRetrieve, then the search key should be
43494 query. As in : operation=searchRetrieve&query=reefs</para>
43496 <para>If operation=scan, then the search key should be scanClause.
43497 As in : operation=scan&scanClause=reefs</para>
43499 <para>etc/zebradb/biblios/etc/bib1.att defines Zebra/3950 indexes
43500 that exist on your system. For instance you'll see that we have
43501 indexes for Subject and for Title: att 21 Subject and att 4 Title
43502 respectively.</para>
43504 <para>In the pqf.properties file located under
43505 etc/zebradb/pqf.properties I see that an access point already uses
43506 my Subject index (index.dc.subject = 1=21) while another uses my
43507 Title index (index.dc.title = 1=4) I know this is my Subject index
43508 because as I've seen just before in my bib1.att file, it's called
43509 with =1=21 in Z3950: so index.dc.subject = 1=21 correctly points to
43510 my Subject index. And Title was called with 1=4 so index.dc.title =
43511 1=4 correctly points to my Title index. I can now construct my query
43512 just like I would in a search box, just preceding it with the
43513 "query" key: query=Subject=reefs and Title=coral searches "reefs" in
43514 the subject and "coral" in the title. The full url would be
43515 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
43516 and Title=coral If I want to limit the result set to just 5 records,
43518 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
43519 and Title=coral&maximumRecords=5</para>
43521 <para>I can also play with truncate, relations, etc. Those are also
43522 defined in my pqf.properties file. I can see for instance the
43523 position properties defined as:</para>
43526 position.first = 3=1 6=1
43528 position.any = 3=3 6=1
43529 # "any position in field"
43532 <para>So as an example if I want "coral" to be at the beginning of
43533 the title, I can do this query :
43534 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Title=coral
43539 <section id="sru_retrieve">
43540 <title>Retrieve</title>
43542 <para>My search for
43543 http://univ_lyon3.biblibre.com:9999/biblios?version=1.1&operation=searchRetrieve&query=coral
43544 reefs&maximumRecords=1 retrieves just on record. The response
43545 looks like this:</para>
43548 <zs:searchRetrieveResponse>
43549 <zs:version>1.1</zs:version>
43550 <zs:numberOfRecords>1</zs:numberOfRecords>
43553 <zs:recordPacking>xml</zs:recordPacking>
43554 <zs:recordData>
43555 <record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd">
43556 <leader> cam a22 4500</leader>
43557 <datafield tag="010" ind1=" " ind2=" ">
43558 <subfield code="a">2-603-01193-6</subfield>
43559 <subfield code="b">rel.</subfield>
43560 <subfield code="d">159 F</subfield>
43562 <datafield tag="020" ind1=" " ind2=" ">
43563 <subfield code="a">FR</subfield>
43564 <subfield code="b">00065351</subfield>
43566 <datafield tag="101" ind1="1" ind2=" ">
43567 <subfield code="c">ita</subfield>
43569 <datafield tag="105" ind1=" " ind2=" ">
43570 <subfield code="a">a z 00|y|</subfield>
43572 <datafield tag="106" ind1=" " ind2=" ">
43573 <subfield code="a">r</subfield>
43575 <datafield tag="100" ind1=" " ind2=" ">
43576 <subfield code="a">20091130 frey50 </subfield>
43578 <datafield tag="200" ind1="1" ind2=" ">
43579 <subfield code="a">Guide des récifs coralliens / A Guide to Coral Reefs</subfield>
43580 <subfield code="b">Texte imprimé</subfield>
43581 <subfield code="e">la faune sous-marine des coraux</subfield>
43582 <subfield code="f">A. et A. Ferrari</subfield>
43584 <datafield tag="210" ind1=" " ind2=" ">
43585 <subfield code="a">Lausanne</subfield>
43586 <subfield code="a">Paris</subfield>
43587 <subfield code="c">Delachaux et Niestlé</subfield>
43588 <subfield code="d">cop. 2000</subfield>
43589 <subfield code="e">impr. en Espagne</subfield>
43591 <datafield tag="215" ind1=" " ind2=" ">
43592 <subfield code="a">287 p.</subfield>
43593 <subfield code="c">ill. en coul., couv. ill. en coul.</subfield>
43594 <subfield code="d">20 cm</subfield>
43598 <size>4725</size>
43599 <localnumber>2</localnumber>
43600 <filename>/tmp/nw10BJv9Pk/upd_biblio/exported_records</filename>
43603 </zs:recordData>
43604 <zs:recordPosition>1</zs:recordPosition>
43606 </zs:records>
43607 </zs:searchRetrieveResponse>
43614 <appendix id="sysprefdefaults">
43615 <title>System Preference Defaults</title>
43619 <section id="isbddefaults">
43620 <title>ISBD Defaults</title>
43624 <section id="isbddefault">
43625 <title>MARC Default</title>
43627 <para>#100||{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{
43628 110d }{ 110e }{ 110f }{ 110g }{ 130a }{ 130d }{ 130f }{ 130g }{ 130h
43629 }{ 130k }{ 130l }{ 130m }{ 130n }{ 130o }{ 130p }{ 130r }{ 130s }{
43630 130t }|<br/><br/></para>
43632 <para>#245||{ 245a }{ 245b }{245f }{ 245g }{ 245k }{ 245n }{ 245p }{
43633 245s }{ 245h }|</para>
43635 <para>#246||{ : 246i }{ 246a }{ 246b }{ 246f }{ 246g }{ 246n }{ 246p
43638 <para>#242||{ = 242a }{ 242b }{ 242n }{ 242p }{ 242h }|</para>
43640 <para>#245||{ 245c }|</para>
43642 <para>#242||{ = 242c }|</para>
43644 <para>#250| - |{ 250a }{ 250b }|</para>
43646 <para>#254|, |{ 254a }|</para>
43648 <para>#255|, |{ 255a }{ 255b }{ 255c }{ 255d }{ 255e }{ 255f }{ 255g
43651 <para>#256|, |{ 256a }|</para>
43653 <para>#257|, |{ 257a }|</para>
43655 <para>#258|, |{ 258a }{ 258b }|</para>
43657 <para>#260| - |{ 260a }{ 260b }{ 260c }|</para>
43659 <para>#300| - |{ 300a }{ 300b }{ 300c }{ 300d }{ 300e }{ 300f }{ 300g
43662 <para>#306| - |{ 306a }|</para>
43664 <para>#307| - |{ 307a }{ 307b }|</para>
43666 <para>#310| - |{ 310a }{ 310b }|</para>
43668 <para>#321| - |{ 321a }{ 321b }|</para>
43670 <para>#340| - |{ 3403 }{ 340a }{ 340b }{ 340c }{ 340d }{ 340e }{ 340f
43671 }{ 340h }{ 340i }|</para>
43673 <para>#342| - |{ 342a }{ 342b }{ 342c }{ 342d }{ 342e }{ 342f }{ 342g
43674 }{ 342h }{ 342i }{ 342j }{ 342k }{ 342l }{ 342m }{ 342n }{ 342o }{
43675 342p }{ 342q }{ 342r }{ 342s }{ 342t }{ 342u }{ 342v }{ 342w }|</para>
43677 <para>#343| - |{ 343a }{ 343b }{ 343c }{ 343d }{ 343e }{ 343f }{ 343g
43678 }{ 343h }{ 343i }|</para>
43680 <para>#351| - |{ 3513 }{ 351a }{ 351b }{ 351c }|</para>
43682 <para>#352| - |{ 352a }{ 352b }{ 352c }{ 352d }{ 352e }{ 352f }{ 352g
43683 }{ 352i }{ 352q }|</para>
43685 <para>#362| - |{ 362a }{ 351z }|</para>
43687 <para>#440| - |{ 440a }{ 440n }{ 440p }{ 440v }{ 440x }|.</para>
43689 <para>#490| - |{ 490a }{ 490v }{ 490x }|.</para>
43691 <para>#800| - |{ 800a }{ 800b }{ 800c }{ 800d }{ 800e }{ 800f }{ 800g
43692 }{ 800h }{ 800j }{ 800k }{ 800l }{ 800m }{ 800n }{ 800o }{ 800p }{
43693 800q }{ 800r }{ 800s }{ 800t }{ 800u }{ 800v }|.</para>
43695 <para>#810| - |{ 810a }{ 810b }{ 810c }{ 810d }{ 810e }{ 810f }{ 810g
43696 }{ 810h }{ 810k }{ 810l }{ 810m }{ 810n }{ 810o }{ 810p }{ 810r }{
43697 810s }{ 810t }{ 810u }{ 810v }|.</para>
43699 <para>#811| - |{ 811a }{ 811c }{ 811d }{ 811e }{ 811f }{ 811g }{ 811h
43700 }{ 811k }{ 811l }{ 811n }{ 811p }{ 811q }{ 811s }{ 811t }{ 811u }{
43703 <para>#830| - |{ 830a }{ 830d }{ 830f }{ 830g }{ 830h }{ 830k }{ 830l
43704 }{ 830m }{ 830n }{ 830o }{ 830p }{ 830r }{ 830s }{ 830t }{ 830v
43707 <para>#500|<br/><br/>|{ 5003 }{ 500a }|</para>
43709 <para>#501|<br/><br/>|{ 501a }|</para>
43711 <para>#502|<br/><br/>|{ 502a }|</para>
43713 <para>#504|<br/><br/>|{ 504a }|</para>
43715 <para>#505|<br/><br/>|{ 505a }{ 505t }{ 505r }{ 505g }{
43718 <para>#506|<br/><br/>|{ 5063 }{ 506a }{ 506b }{ 506c }{
43719 506d }{ 506u }|</para>
43721 <para>#507|<br/><br/>|{ 507a }{ 507b }|</para>
43723 <para>#508|<br/><br/>|{ 508a }{ 508a }|</para>
43725 <para>#510|<br/><br/>|{ 5103 }{ 510a }{ 510x }{ 510c }{
43728 <para>#511|<br/><br/>|{ 511a }|</para>
43730 <para>#513|<br/><br/>|{ 513a }{513b }|</para>
43732 <para>#514|<br/><br/>|{ 514z }{ 514a }{ 514b }{ 514c }{
43733 514d }{ 514e }{ 514f }{ 514g }{ 514h }{ 514i }{ 514j }{ 514k }{ 514m
43736 <para>#515|<br/><br/>|{ 515a }|</para>
43738 <para>#516|<br/><br/>|{ 516a }|</para>
43740 <para>#518|<br/><br/>|{ 5183 }{ 518a }|</para>
43742 <para>#520|<br/><br/>|{ 5203 }{ 520a }{ 520b }{ 520u
43745 <para>#521|<br/><br/>|{ 5213 }{ 521a }{ 521b }|</para>
43747 <para>#522|<br/><br/>|{ 522a }|</para>
43749 <para>#524|<br/><br/>|{ 524a }|</para>
43751 <para>#525|<br/><br/>|{ 525a }|</para>
43753 <para>#526|<br/><br/>|{\n510i }{\n510a }{ 510b }{ 510c }{
43754 510d }{\n510x }|</para>
43756 <para>#530|<br/><br/>|{\n5063 }{\n506a }{ 506b }{ 506c }{
43757 506d }{\n506u }|</para>
43759 <para>#533|<br/><br/>|{\n5333 }{\n533a }{\n533b }{\n533c
43760 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }|</para>
43762 <para>#534|<br/><br/>|{\n533p }{\n533a }{\n533b }{\n533c
43763 }{\n533d }{\n533e }{\n533f }{\n533m }{\n533n }{\n533t }{\n533x
43766 <para>#535|<br/><br/>|{\n5353 }{\n535a }{\n535b }{\n535c
43769 <para>#538|<br/><br/>|{\n5383 }{\n538a }{\n538i }{\n538u
43772 <para>#540|<br/><br/>|{\n5403 }{\n540a }{ 540b }{ 540c }{
43773 540d }{\n520u }|</para>
43775 <para>#544|<br/><br/>|{\n5443 }{\n544a }{\n544b }{\n544c
43776 }{\n544d }{\n544e }{\n544n }|</para>
43778 <para>#545|<br/><br/>|{\n545a }{ 545b }{\n545u }|</para>
43780 <para>#546|<br/><br/>|{\n5463 }{\n546a }{ 546b }|</para>
43782 <para>#547|<br/><br/>|{\n547a }|</para>
43784 <para>#550|<br/><br/>|{ 550a }|</para>
43786 <para>#552|<br/><br/>|{ 552z }{ 552a }{ 552b }{ 552c }{
43787 552d }{ 552e }{ 552f }{ 552g }{ 552h }{ 552i }{ 552j }{ 552k }{ 552l
43788 }{ 552m }{ 552n }{ 562o }{ 552p }{ 552u }|</para>
43790 <para>#555|<br/><br/>|{ 5553 }{ 555a }{ 555b }{ 555c }{
43791 555d }{ 555u }|</para>
43793 <para>#556|<br/><br/>|{ 556a }{ 506z }|</para>
43795 <para>#563|<br/><br/>|{ 5633 }{ 563a }{ 563u }|</para>
43797 <para>#565|<br/><br/>|{ 5653 }{ 565a }{ 565b }{ 565c }{
43798 565d }{ 565e }|</para>
43800 <para>#567|<br/><br/>|{ 567a }|</para>
43802 <para>#580|<br/><br/>|{ 580a }|</para>
43804 <para>#581|<br/><br/>|{ 5633 }{ 581a }{ 581z }|</para>
43806 <para>#584|<br/><br/>|{ 5843 }{ 584a }{ 584b }|</para>
43808 <para>#585|<br/><br/>|{ 5853 }{ 585a }|</para>
43810 <para>#586|<br/><br/>|{ 5863 }{ 586a }|</para>
43812 <para>#020|<br/><br/><label>ISBN: </label>|{
43813 020a }{ 020c }|</para>
43815 <para>#022|<br/><br/><label>ISSN: </label>|{
43818 <para>#222| = |{ 222a }{ 222b }|</para>
43820 <para>#210| = |{ 210a }{ 210b }|</para>
43822 <para>#024|<br/><br/><label>Standard No.:
43823 </label>|{ 024a }{ 024c }{ 024d }{ 0242 }|</para>
43825 <para>#027|<br/><br/><label>Standard Tech. Report.
43826 No.: </label>|{ 027a }|</para>
43828 <para>#028|<br/><br/><label>Publisher. No.:
43829 </label>|{ 028a }{ 028b }|</para>
43831 <para>#013|<br/><br/><label>Patent No.:
43832 </label>|{ 013a }{ 013b }{ 013c }{ 013d }{ 013e }{ 013f
43835 <para>#030|<br/><br/><label>CODEN: </label>|{
43838 <para>#037|<br/><br/><label>Source: </label>|{
43839 037a }{ 037b }{ 037c }{ 037f }{ 037g }{ 037n }|</para>
43841 <para>#010|<br/><br/><label>LCCN: </label>|{
43844 <para>#015|<br/><br/><label>Nat. Bib. No.:
43845 </label>|{ 015a }{ 0152 }|</para>
43847 <para>#016|<br/><br/><label>Nat. Bib. Agency Control
43848 No.: </label>|{ 016a }{ 0162 }|</para>
43850 <para>#600|<br/><br/><label>Subjects--Personal
43851 Names: </label>|{\n6003 }{\n600a}{ 600b }{ 600c }{ 600d }{ 600e
43852 }{ 600f }{ 600g }{ 600h }{--600k}{ 600l }{ 600m }{ 600n }{ 600o
43853 }{--600p}{ 600r }{ 600s }{ 600t }{ 600u
43854 }{--600x}{--600z}{--600y}{--600v}|</para>
43856 <para>#610|<br/><br/><label>Subjects--Corporate
43857 Names: </label>|{\n6103 }{\n610a}{ 610b }{ 610c }{ 610d }{ 610e
43858 }{ 610f }{ 610g }{ 610h }{--610k}{ 610l }{ 610m }{ 610n }{ 610o
43859 }{--610p}{ 610r }{ 610s }{ 610t }{ 610u
43860 }{--610x}{--610z}{--610y}{--610v}|</para>
43862 <para>#611|<br/><br/><label>Subjects--Meeting Names:
43863 </label>|{\n6113 }{\n611a}{ 611b }{ 611c }{ 611d }{ 611e }{ 611f
43864 }{ 611g }{ 611h }{--611k}{ 611l }{ 611m }{ 611n }{ 611o }{--611p}{
43865 611r }{ 611s }{ 611t }{ 611u }{--611x}{--611z}{--611y}{--611v}|</para>
43867 <para>#630|<br/><br/><label>Subjects--Uniform
43868 Titles: </label>|{\n630a}{ 630b }{ 630c }{ 630d }{ 630e }{ 630f
43869 }{ 630g }{ 630h }{--630k }{ 630l }{ 630m }{ 630n }{ 630o }{--630p}{
43870 630r }{ 630s }{ 630t }{--630x}{--630z}{--630y}{--630v}|</para>
43872 <para>#648|<br/><br/><label>Subjects--Chronological
43873 Terms: </label>|{\n6483 }{\n648a
43874 }{--648x}{--648z}{--648y}{--648v}|</para>
43876 <para>#650|<br/><br/><label>Subjects--Topical Terms:
43877 </label>|{\n6503 }{\n650a}{ 650b }{ 650c }{ 650d }{ 650e
43878 }{--650x}{--650z}{--650y}{--650v}|</para>
43880 <para>#651|<br/><br/><label>Subjects--Geographic
43881 Terms: </label>|{\n6513 }{\n651a}{ 651b }{ 651c }{ 651d }{ 651e
43882 }{--651x}{--651z}{--651y}{--651v}|</para>
43884 <para>#653|<br/><br/><label>Subjects--Index Terms:
43885 </label>|{ 653a }|</para>
43887 <para>#654|<br/><br/><label>Subjects--Facted Index
43888 Terms: </label>|{\n6543
43889 }{\n654a}{--654b}{--654x}{--654z}{--654y}{--654v}|</para>
43891 <para>#655|<br/><br/><label>Index Terms--Genre/Form:
43892 </label>|{\n6553 }{\n655a}{--655b}{--655x
43893 }{--655z}{--655y}{--655v}|</para>
43895 <para>#656|<br/><br/><label>Index Terms--Occupation:
43896 </label>|{\n6563
43897 }{\n656a}{--656k}{--656x}{--656z}{--656y}{--656v}|</para>
43899 <para>#657|<br/><br/><label>Index Terms--Function:
43900 </label>|{\n6573
43901 }{\n657a}{--657x}{--657z}{--657y}{--657v}|</para>
43903 <para>#658|<br/><br/><label>Index Terms--Curriculum
43905 </label>|{\n658a}{--658b}{--658c}{--658d}{--658v}|</para>
43907 <para>#050|<br/><br/><label>LC Class. No.:
43908 </label>|{ 050a }{ / 050b }|</para>
43910 <para>#082|<br/><br/><label>Dewey Class. No.:
43911 </label>|{ 082a }{ / 082b }|</para>
43913 <para>#080|<br/><br/><label>Universal Decimal Class.
43914 No.: </label>|{ 080a }{ 080x }{ / 080b }|</para>
43916 <para>#070|<br/><br/><label>National Agricultural
43917 Library Call No.: </label>|{ 070a }{ / 070b }|</para>
43919 <para>#060|<br/><br/><label>National Library of
43920 Medicine Call No.: </label>|{ 060a }{ / 060b }|</para>
43922 <para>#074|<br/><br/><label>GPO Item No.:
43923 </label>|{ 074a }|</para>
43925 <para>#086|<br/><br/><label>Gov. Doc. Class. No.:
43926 </label>|{ 086a }|</para>
43928 <para>#088|<br/><br/><label>Report. No.:
43929 </label>|{ 088a }|</para>
43932 <section id="unimarcdefault">
43933 <title>UNIMARC Default</title>
43935 <para>#200|<h2>Title : |{200a}{. 200c}{ : 200e}{200d}{. 200h}{.
43936 200i}|</h2></para>
43938 <para>#461|<label class="ipt">A part of : </label>|<a
43939 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=461t&idx=ti}">{461t}</a>{N∞
43940 461h} {v. 461v}{(461d)}<br/>|</para>
43942 <para>#200b|<label class="ipt">Material Designation :
43943 </label>| {200b }|<br/></para>
43945 <para>#101a|<label class="ipt">Language(s): </label>|<a
43946 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=101a&idx=ln}">{101a}</a>|<br/></para>
43948 <para>#200f|<label class="ipt">Authors : </label>|<a
43949 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200f&idx=au}">{200f
43950 ; }</a>|<br/></para>
43952 <para>#200g|<label class="ipt">Co-authors : </label>|<a
43953 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=200g&idx=au}">{200g
43954 ; }</a>|<br/></para>
43956 <para>#210a|<br/><label class="ipt">Place of pubblication
43957 : </label>|<a
43958 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pl&q={210a}">{210a}</a>|<br/></para>
43960 <para>#210c|<label class="ipt">Publisher : </label>|<a
43961 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=pb&q={210c}">{210c
43962 ; }</a>|<br/></para>
43964 <para>#210d|<label class="ipt">Date of pubblication :
43965 </label>|{ 210d}|<br/></para>
43967 <para>#215|<label class="ipt">Description :
43968 </label>|{215a}{ : 215c}{ ; 215d}{ + 215e}|<br/></para>
43970 <para>#225a|<label class="ipt">Series :</label>|<a
43971 href="/cgi-bin/koha/catalogue/search.pl?op=do_search{&q=225a&idx=se}">{225a
43972 ;}</a> |</para>
43974 <para>#225||{ = 225d}{ : 225e}{. 225h}{. 225i}{ / 225f}{, 225x}{ ;
43975 225v}|<br/></para>
43977 <para>#686|<label>Classification : </label>|{ 686a
43978 }|<br/></para>
43980 <para>#608|<label>Form, Genre : </label>|<a
43981 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={608a}"><img
43982 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
43983 title="Search on {608a}">{
43984 608a}</a>|<br/><br/></para>
43986 <para>#200||<label class="ipt">Subjects :
43987 </label><br/>|<ul></para>
43989 <para>#600|<label class="ipt">Person(s)
43990 </label><br/> |<li><a
43991 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={600a}"><img
43992 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
43993 title="Search on {600a}">{
43994 600a}</a></li>|<br/></para>
43996 <para>#601|<label class="ipt">Organisation(s)
43997 </label><br/>|<li><a
43998 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={601a}"><img
43999 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
44000 title="Search on {601a}">{
44001 601a}</a></li>|<br/></para>
44003 <para>#606|<label class="ipt">Term(s)
44004 </label><br/>|<li><a
44005 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={606a}"><img
44006 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
44007 title="Search on {606a}">{
44008 606a}</a></li>|<br/></para>
44010 <para>#607|<label class="ipt">Place(s)
44011 </label><br/>|<li><a
44012 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={607a}"><img
44013 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
44014 title="Search on {607a}">{
44015 607a}</a></li>|<br/></para>
44017 <para>#610|<label>Keywords</label><br/>|<li><a
44018 href="/cgi-bin/koha/catalogue/search.pl?op=do_search&idx=su&q={610a}"><img
44019 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
44020 title="Search on {610a}">{ 610a}</a></li>|</para>
44022 <para>#200||</ul>|</para>
44024 <para>#856|<label class="ipt">Electronic resource :
44025 </label>|<a href="{856u}">click here</a> to go to
44026 the external resource<br/></para>
44028 <para>#010|<label class="ipt">ISBN : </label>|{010a
44029 ;}|<br/></para>
44031 <para>#011|<label class="ipt">ISSN : </label>|{011a
44032 ;}|<br/></para>
44034 <para>#200||<label class="ipt">Notes :
44035 </label>|<br/><ul></para>
44037 <para>#300||<li>{300a}</li>|</para>
44039 <para>#307||<li>{307a}</li>|</para>
44041 <para>#310||<li>{310a}</li>|</para>
44043 <para>#326||<li>{326a}</li>|</para>
44045 <para>#327||<li>{327a}</li>|</para>
44047 <para>#333|<li>Public : |{333a}</li>|</para>
44049 <para>#200||</ul>|</para>
44051 <para>#330||<label class="ipt">Abstract :
44052 </label>|<br/></para>
44054 <para>#330||{330a}|<br/></para>
44056 <para>#200||<br/><h2>Items</h2>|</para>
44058 <para>#200|<table>|<th>Call
44059 number</th><th>Copy
44060 note</th><th>Fonds</th><th>Genre
44061 detail</th><th>Circulation
44062 type</th><th>Barcode</th>|</para>
44064 <para>#995||<tr><td> {995k}</td><td>
44065 {995u}</td><td>
44066 {995y}</td><td>{995e} </td><td>
44067 {995o}</td><td>{995f}</td></tr>|</table></para>
44072 <appendix id="receiptprint">
44073 <title>Configuring Receipt Printers</title>
44075 <para>The following instructions are for specific receipt printers, but
44076 can probably be used to help with setup of other brands as well.</para>
44078 <section id="epsonprinters">
44080 <corpauthor>NEKLS</corpauthor>
44082 <pubdate>2008</pubdate>
44084 <bibliosource><ulink url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></bibliosource>
44087 <title>For Epson TM-T88III (3) & TM-T88IV (4) Printers</title>
44091 <section id="epsonprintdriver">
44092 <title>In the Print Driver</title>
44094 <para>For these instructions, we are using version 5,0,3,0 of the
44095 Epson TM-T88III print driver; the EPSON TM-T88IV version is ReceiptE4.
44096 Register at the <ulink url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
44097 Center website</ulink> to gain access to the drivers; go to Technical
44098 Resources, then choose the printer model from the Printers drop-down
44101 <para>Click Start > Printers and Faxes > Right click the receipt
44102 printer > Properties:</para>
44106 <para>Advanced Tab, click Printing Defaults button</para>
44110 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
44114 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
44115 Printable Width</para>
44119 <para>TM-T88IV: Check Reduced Size Print; Click OK on the popup
44120 window that appears. Fit to Printable Width should be
44121 automatically selected.</para>
44125 <para>OK your way out of there.</para>
44130 <section id="epsonfirefox">
44131 <title>In Firefox</title>
44133 <para>Under File > Page Setup:</para>
44137 <para>Shrink to fit page on Format & Options tab</para>
44141 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
44142 makes the receipts use all available space on the paper
44147 <para>Set all Headers/Footers to -blank-. This removes all of the
44148 gunk you might normally find on a print from Firefox, such as the
44149 URL, number of pages, etc.</para>
44153 <para>Click OK</para>
44157 <para>Set the default printer settings in Firefox so you don't see a
44158 "Print" dialog:</para>
44162 <para>Go to File > Print</para>
44166 <para>Set the Printer to the receipt printer.</para>
44170 <para>Click the Advanced (or Properties) button</para>
44174 <para>Layout Tab: Paper size: Roll Paper 80 x 297mm</para>
44178 <para>TM-T88III: Layout Tab: Check Reduce Printing and Fit to
44179 Printable Width</para>
44183 <para>TM-T88IV: Check Reduced Size Print; click OK on the popup
44184 window that appears. Fit to Printable Width should be
44185 automatically selected.</para>
44189 <para>OK your way out, go ahead and print whatever page you are
44194 <para>Type about:config, in the address bar. Click "I'll be
44195 careful, I promise!" on the warning message.</para>
44199 <para>Type, print.always in Filter.</para>
44203 <para>Look for print.always_print_silent.</para>
44207 <para>If the preference is there then set the value to
44214 <para>If the preference is not there (and it shouldn't be in most
44215 browsers) you have to add the preference.</para>
44219 <para>Right click the preference area and select New >
44224 <para>Type print.always_print_silent in the dialog box and set
44225 the value to True. This sets the print settings in Firefox to
44226 always use the same settings and print without showing a
44234 <para>Setting the print.always_print_silent setting in about:config
44235 DISABLES the ability to choose a printer in Firefox.</para>
44240 <section id="epson2">
44242 <corpauthor>NEKLS</corpauthor>
44244 <pubdate>2008</pubdate>
44246 <bibliosource><ulink url="http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/">http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/</ulink></bibliosource>
44249 <title>For Epson TM-T88II (2) Printers</title>
44251 <para>Register at the <ulink url="https://www.epsonexpert.com/login">EpsonExpert Technical Resource
44252 Center website</ulink> to gain access to the drivers; go to Technical
44253 Resources, then choose the printer model from the Printers drop-down
44256 <section id="epson2firefox">
44257 <title>In Firefox</title>
44259 <para>Under File > Page Setup:</para>
44263 <para>Shrink to fit page on Format & Options tab</para>
44267 <para>0,0,0,0 for Margins on Margins & Header/Footer Tab. This
44268 makes the receipts use all available space on the paper
44273 <para>Set all Headers/Footers to -blank-. This removes all of the
44274 gunk you might normally find on a print from Firefox, such as the
44275 URL, number of pages, etc.</para>
44279 <para>Click OK</para>
44283 <para>Set the default printer settings in Firefox so you don't see a
44284 "Print" dialog:</para>
44288 <para>Go to File > Print</para>
44292 <para>Set the Printer to the receipt printer.</para>
44296 <para>Print whatever page you are on.</para>
44300 <para>Type about:config, in the address bar. Click "I'll be
44301 careful, I promise!" on the warning message.</para>
44305 <para>Type, print.always in Filter.</para>
44309 <para>Look for, print.always_print_silent.</para>
44313 <para>If the preference is there then set the value to
44320 <para>If the preference is not there (and it shouldn't be in most
44321 browsers) you have to add the preference.</para>
44325 <para>Right click the preference area and select New >
44330 <para>Type, print.always_print_silent in the dialog box and
44331 set the value to True. This sets the print settings in Firefox
44332 to always use the same settings and print without showing a
44340 <para>Setting the print.always_print_silent setting in about:config
44341 DISABLES the ability to choose a printer in Firefox.</para>
44346 <section id="starprinter">
44348 <corpauthor>RHCL</corpauthor>
44351 <firstname>Nicole C.</firstname>
44353 <surname>Engard</surname>
44356 <pubdate>2010</pubdate>
44359 <title>For Star SP542 Printers</title>
44361 <section id="installstarprinter">
44362 <title>Installing the Printer</title>
44364 <para>While the following comments are based on the Star SP542 receipt
44365 printer, they probably apply to all printers in the SP5xx
44368 <para>The Star SP542 receipt printer works well with Koha and <emphasis role="bold">Firefox
44369 on Windows XP SP3</emphasis>. This printer, with either the parallel or USB interface,
44370 is fairly easy to install and configure. You will need the following executable file which
44371 is available from numerous places on the Internet:</para>
44373 <para>linemode_2k-xp_20030205.exe</para>
44375 <para>This executable actually does all of the installation; you will
44376 not need to use the Microsoft Windows "Add Printer" program. We
44377 recommend that when installing, the option for the software monitor
44378 not be selected; we have experienced significant pauses and delays in
44379 printing with it. Instead, simply choose to install the receipt
44380 printer without the monitor.</para>
44382 <para>Additionally, the install program may not put the printer on the
44383 correct port, especially if using the USB interface. This is easily
44384 corrected by going to "Start -> Printers and Faxes -> Properties
44385 for the SP542 printer -> Ports", then check the appropriate
44388 <para>A reboot may be required, even if not indicated by the
44389 installation software or the operating system.</para>
44390 <para><emphasis role="bold">Windows 7</emphasis> users should refer to this page: <ulink
44391 url="http://www.starmicronics.com/supports/win7.aspx"
44392 >http://www.starmicronics.com/supports/win7.aspx</ulink>.
44397 <section id="firefoxreceipt">
44399 <corpauthor>VOKAL</corpauthor>
44402 <firstname>Nicole C.</firstname>
44404 <surname>Engard</surname>
44407 <pubdate>2010</pubdate>
44409 <bibliosource><ulink url="https://docs.google.com/View?id=dcccx9zm_3htvhwzgc#Setting_up_your_SLIP_printer_1_18087191815760117">https://docs.google.com/View?id=dcccx9zm_3htvhwzgc#Setting_up_your_SLIP_printer_1_18087191815760117</ulink></bibliosource>
44412 <title>Configuring Firefox to Print to Receipt Printer</title>
44416 <para>Open File > Page Setup</para>
44420 <para>Make all the headers and footers blank</para>
44424 <para>Set the margins to 0 (zero)</para>
44428 <para>In the address bar of Firefox, type about:config</para>
44432 <para>Search for print.always_print_silent and double click
44437 <para>Change it from false to true</para>
44441 <para>This lets you skip the Print pop up box that comes up, as
44442 well as skipping the step where you have to click OK,
44443 automatically printing the right sized slip.</para>
44449 <para>If print.always_print_silent does not come up</para>
44453 <para>Right click on a blank area of the preference
44458 <para>Select new > Boolean</para>
44462 <para>Enter "print.always_print_silent" as the name (without
44467 <para>Click OK</para>
44471 <para>Select true for the value</para>
44477 <para>You may also want to check what is listed for
44478 print.print_printer</para>
44482 <para>You may have to choose Generic/Text Only (or whatever your
44483 receipt printer might be named)</para>
44490 <appendix id="noticesappendix">
44491 <title>Notice & Slips Guides</title>
44492 <section id="noticesfieldguide">
44496 <firstname>Barton</firstname>
44497 <surname>Chittenden</surname>
44499 <orgname>ByWater Solutions</orgname>
44503 <firstname>Nicole C.</firstname>
44504 <surname>Engard</surname>
44507 <pubdate>2014</pubdate>
44509 <title>Field Guide for Notices & Slips</title>
44510 <para>This guide will break down the notices and slips information in 3 ways. First it will
44511 tell you what file generates the notice, then how you will present the item info in that
44512 notice and finally if the notice can be branch specific or not.</para>
44515 style="border-collapse:collapse;border:1px solid black;font-family:'Times New Roman';letter-spacing:normal;text-indent:0px;text-transform:none;word-spacing:0px">
44518 <th rowspan="1" colspan="1" align="left">Letter Code</th>
44519 <th rowspan="1" colspan="1" align="left">Used In</th>
44520 <th rowspan="1" colspan="1" align="left">Detail tag</th>
44521 <th rowspan="1" colspan="1" align="left">Can be branch specific</th>
44526 <td rowspan="1" colspan="1" align="left">DUE</td>
44527 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
44528 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
44529 <td rowspan="1" colspan="1" align="left">No</td>
44532 <td rowspan="1" colspan="1" align="left">DUEDGST</td>
44533 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
44534 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
44535 <td rowspan="1" colspan="1" align="left">No</td>
44538 <td rowspan="1" colspan="1" align="left">PREDUE</td>
44539 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
44540 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
44541 <td rowspan="1" colspan="1" align="left">No</td>
44544 <td rowspan="1" colspan="1" align="left">PREDUEDGST</td>
44545 <td rowspan="1" colspan="1" align="left">advance_notices.pl</td>
44546 <td rowspan="1" colspan="1" align="left"><<items.content>></td>
44547 <td rowspan="1" colspan="1" align="left">No</td>
44550 <td rowspan="1" colspan="1" align="left">ODUE*</td>
44551 <td rowspan="1" colspan="1" align="left">overdue_notices.pl</td>
44552 <td rowspan="1" colspan="1" align="left"><<items.content>> or <item>
44554 <td rowspan="1" colspan="1" align="left">Yes</td>
44557 <td rowspan="1" colspan="1" align="left">CHECKOUT</td>
44558 <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
44559 <td rowspan="1" colspan="1" align="left">N/A</td>
44560 <td rowspan="1" colspan="1" align="left">Yes</td>
44563 <td rowspan="1" colspan="1" align="left">RENEWAL</td>
44564 <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
44565 <td rowspan="1" colspan="1" align="left">N/A</td>
44566 <td rowspan="1" colspan="1" align="left">Yes</td>
44569 <td rowspan="1" colspan="1" align="left">TRANSFERSLIP</td>
44570 <td rowspan="1" colspan="1" align="left">C4/Circulation.pm</td>
44571 <td rowspan="1" colspan="1" align="left">N/A</td>
44572 <td rowspan="1" colspan="1" align="left">Yes</td>
44575 <td rowspan="1" colspan="1" align="left">ISSUESLIP</td>
44576 <td rowspan="1" colspan="1" align="left">C4/Members.pm</td>
44577 <td rowspan="1" colspan="1" align="left">
44578 <para><checkedout> </checkedout> </para>
44579 <para> <overdue> </overdue> </para>
44580 <para> <news> </news> </para>
44582 <td rowspan="1" colspan="1" align="left">Yes</td>
44585 <td rowspan="1" colspan="1" align="left">ISSUEQSLIP</td>
44586 <td rowspan="1" colspan="1" align="left">C4/Members.pm</td>
44587 <td rowspan="1" colspan="1" align="left"><checkedout> </checkedout></td>
44588 <td rowspan="1" colspan="1" align="left">Yes</td>
44591 <td rowspan="1" colspan="1" align="left">HOLDPLACED</td>
44592 <td rowspan="1" colspan="1" align="left">C4/Reserves.pm</td>
44593 <td rowspan="1" colspan="1" align="left">N/A</td>
44594 <td rowspan="1" colspan="1" align="left">Yes</td>
44597 <td rowspan="1" colspan="1" align="left">RESERVESLIP</td>
44598 <td rowspan="1" colspan="1" align="left">C4/Reserves.pm</td>
44599 <td rowspan="1" colspan="1" align="left">N/A</td>
44600 <td rowspan="1" colspan="1" align="left">Yes</td>
44603 <td rowspan="1" colspan="1" align="left">ASKED</td>
44604 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
44605 <td rowspan="1" colspan="1" align="left">N/A</td>
44606 <td rowspan="1" colspan="1" align="left">Yes</td>
44609 <td rowspan="1" colspan="1" align="left">CHECKED</td>
44610 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
44611 <td rowspan="1" colspan="1" align="left">N/A</td>
44612 <td rowspan="1" colspan="1" align="left">Yes</td>
44615 <td rowspan="1" colspan="1" align="left">ACCEPTED</td>
44616 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
44617 <td rowspan="1" colspan="1" align="left">N/A</td>
44618 <td rowspan="1" colspan="1" align="left">Yes</td>
44621 <td rowspan="1" colspan="1" align="left">REJECTED</td>
44622 <td rowspan="1" colspan="1" align="left">C4/Suggestions.pm</td>
44623 <td rowspan="1" colspan="1" align="left">N/A</td>
44624 <td rowspan="1" colspan="1" align="left">Yes</td>
44627 <td rowspan="1" colspan="1" align="left">PREDUE_PHONE</td>
44628 <td rowspan="1" colspan="1" align="left">TalkingTech_itiva_outbound</td>
44629 <td rowspan="1" colspan="1" align="left">N/A</td>
44630 <td rowspan="1" colspan="1" align="left">No</td>
44633 <td rowspan="1" colspan="1" align="left">OVERDUE_PHONE</td>
44634 <td rowspan="1" colspan="1" align="left">TalkingTech_itiva_outbound</td>
44635 <td rowspan="1" colspan="1" align="left">N/A</td>
44636 <td rowspan="1" colspan="1" align="left">No</td>
44639 <td rowspan="1" colspan="1" align="left">HOLD_PHONE</td>
44640 <td rowspan="1" colspan="1" align="left">TalkingTech_itiva_outbound</td>
44641 <td rowspan="1" colspan="1" align="left">N/A</td>
44642 <td rowspan="1" colspan="1" align="left">No</td>
44645 <td rowspan="1" colspan="1" align="left">OPAC_REG_VERIFY</td>
44646 <td rowspan="1" colspan="1" align="left">opac/opac-memberentry.pl</td>
44647 <td rowspan="1" colspan="1" align="left">N/A</td>
44648 <td rowspan="1" colspan="1" align="left">No</td>
44656 <appendix id="samplenotice">
44657 <title>Example Notice</title>
44659 <para>Nicole Engard</para>
44661 <para>410 Library Rd.</para>
44663 <para>Philadelphia, PA 19107</para>
44665 <para>Dear Nicole Engard (23529000035726),</para>
44667 <para>According to our records, at the time of this notice, you have items
44668 that are overdue. Please return or renew them as soon as possible to avoid
44669 increasing late fines.</para>
44671 <para>If you have registered a password with the library, you may use it
44672 with your library card number to renew online.</para>
44674 <para>If you believe you have returned the items below please call at and
44675 library staff will be happy to help resolve the issue.</para>
44677 <para>The following item(s) are currently overdue:</para>
44679 <para>07/08/2008 Creating drug-free schools and communities : 502326000054
44680 Fox, C. Lynn.</para>
44682 <para>06/27/2008 Eating fractions / 502326000022 McMillan, Bruce.</para>
44684 <para>Sincerely, Library Staff</para>
44687 <appendix id="sampleserialsapp">
44688 <title>Sample Serials</title>
44692 <section id="readersdigestsample">
44693 <title>Reader's Digest (0034-0375)</title>
44697 <para>Published 12 times a year (monthly)</para>
44701 <para>The Volume number changes every 6 months and the numbers
44702 continues on (requires an advanced pattern).</para>
44705 <screeninfo>Sample Reader's Digest Subscription</screeninfo>
44709 <imagedata fileref="images/serialssamples/readersserial.png"/>
44719 <section id="peoplesample">
44720 <title>People Weekly (1076-0091)</title>
44724 <para>Published weekly</para>
44728 <para>The website says "on Saturday except the first week of
44729 August, Thanksgiving week, the first and last weeks of the year"
44730 but this does not match the pattern for 2007 or 2008</para>
44736 <para>In the Jul-Dec there are 26 issues</para>
44740 <para>In the Jan-Jun there are 25 issues (no issue for the first
44741 week of January)</para>
44745 <para>Since the irregularity on the first # 26 does not skip a week,
44746 this would be set up as to roll over on issue 25. The 26th issue in the
44747 second half of the year would have to be received as a
44748 supplemental.</para>
44750 <para>The irregularity check will complain that 52 issues were expected,
44751 but 25 entered. The current irregularity check can only check that the
44752 first position of the numbering pattern matches the expected issue count
44753 of the periodicity. But we do need to trigger the rollover on the
44754 volume, so we need to define the last two weeks of the year as
44755 irregularities. So we receive 50 issues the first 50 weeks, then one
44756 supplemental issue in week 51, which we have to define the enumeration
44757 for, then the next predicted issue will be the following year's first
44761 <section id="hebrewserialsample">
44762 <title>Et-Mol</title>
44764 <para>This journal is published with the following rules:</para>
44768 <para>6 issues a year (every 2 months)</para>
44772 <para>year changes every 6 issues</para>
44776 <para>we start in 2011</para>
44780 <para>the issue number goes up indefinitely</para>
44784 <para>starting from issue 215</para>
44788 <para>The planning would look like this:</para>
44791 <screeninfo>Sample for this Hebrew Journal</screeninfo>
44795 <imagedata fileref="images/serialssamples/hebrewnewspaper.png"/>
44800 <section id="backpackerserial">
44801 <title>Backpacker (0277-867X)</title>
44802 <para>Published 9 times a year irregularly. The issues continues while the volume and number
44803 rolls over every 9 issues. If you're holding Volume 41, Number 3, Issue 302 in your hand
44804 the prediction would look like this:</para>
44806 <screeninfo>Backpacker numbering pattern</screeninfo>
44809 <imagedata fileref="images/serialssamples/backpacker.png"/>
44813 <para>And the received issues would number like this:</para>
44814 <para>v. 41, no. 3, iss. 302 </para>
44815 <para>v. 41, no. 4, iss. 303 </para>
44816 <para>v. 41, no. 5, iss. 304 </para>
44817 <para>v. 41, no. 6, iss. 305 </para>
44818 <para>v. 41, no. 7, iss. 306 </para>
44819 <para>v. 41, no. 8, iss. 307</para>
44820 <para>v. 41, no. 9, iss. 308 </para>
44821 <para>v. 42, no. 1, iss. 309 </para>
44822 <para>v. 42, no. 2, iss. 310 </para>
44823 <para>v. 42, no. 3, iss. 311 </para>
44824 <para>v. 42, no. 4, iss. 312</para>
44826 <section id="keatsserial">
44827 <title>Keats-Shelley Journal (0453-4387)</title>
44828 <para>This journal is published once per year in July. The numbering follows this pattern: <itemizedlist>
44830 <para>Vol. 61 2013</para>
44833 <para>Vol. 62 2014</para>
44836 <para>Vol. 63 2015</para>
44838 </itemizedlist> Setup should look like this (if you're starting in July 2014):</para>
44840 <screeninfo>Serial planning</screeninfo>
44843 <imagedata fileref="images/serialssamples/keatsplanning.png"/>
44848 <para>The prediction test will not show the right pattern, but once you receive you will see
44849 that the above does generate the right pattern.</para>
44852 <section id="cilserial">
44853 <title>Computers in Libraries (1041-7915)</title>
44854 <para>Computers in Libraries is published ten times per year (monthly with January/February
44855 and July/August combined issues).</para>
44857 <screeninfo>Subscription details</screeninfo>
44860 <imagedata fileref="images/serialssamples/cilirregular.png"/>
44865 <screeninfo>Serial Planning</screeninfo>
44868 <imagedata fileref="images/serialssamples/cilpattern.png"/>
44873 <screeninfo>Received details</screeninfo>
44876 <imagedata fileref="images/serialssamples/cilreceived.png"/>
44882 <appendix id="samplelistemail">
44883 <title>Sample List & Cart Emails</title>
44884 <section id="examplelistemail">
44885 <title>Example Email from List</title>
44886 <para>Below is an example of an email from a list in
44887 Koha.<programlisting>Hi,
44889 Here is your list called If You Like Jodi Picoult, sent from our online catalog.
44891 Please note that the attached file is a MARC bibliographic records file
44892 which can be imported into a Personal Bibliographic Software like EndNote,
44893 Reference Manager or ProCite.
44894 ---------------------------------------------
44896 Home safe : a novel /
44898 by Berg, Elizabeth.
44900 Published by: Random House,, 260 p. ;, 25 cm.
44901 Copyright year: 2009
44903 In the online catalog:
44904 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12113
44906 North Branch FIC (FIC Ber) TVSN500088894O
44907 Main Library FIC (FIC Boh) TVSN5000921548
44908 South Branch FIC (FIC Boh) TVSN500092156A
44909 West Branch FIC (FIC Boh) TVSN5000921559
44911 ---------------------------------------------
44915 by Brown, Rosellen.
44917 Published by: Farrar, Straus, and Giroux,, 402 p. ;, 24 cm.
44918 Copyright year: 2000
44920 In the online catalog:
44921 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12501
44923 East Branch (813/.54)
44924 South Branch FIC (FIC Bro) TVSN5000451333</programlisting></para>
44926 <section id="examplecartemail">
44927 <title>Example Email from Cart</title>
44928 <para>Below is a sample of what an email from the Cart in Koha will look
44929 like:<programlisting>Hi,
44931 Joaquin D'Planque sent you a cart from our online catalog.
44933 Please note that the attached file is a MARC bibliographic records
44934 file which can be imported into personal bibliographic software like
44935 EndNote, Reference Manager or ProCite.
44937 ---------------------------------------------------------------------
44941 Author(s): Brookfield, Karen. ;
44942 Published by: Knopf : | Distributed by Random House, , 63 p. : ,
44944 Copyright year: 1993
44945 Notes : Includes index.
44949 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=31644
44953 * East Branch (JNF 002 Bro) TVSN500017618A
44955 -----------------------------------------------------------------
44957 2. The 1965 World book year book :
44959 Published by: Field Enterprises Educational Corp., , 628 p. : , 26
44961 Copyright year: 1965
44962 Notes : Includes index. | Spine title: Year book, 1965. | Cover
44963 title: The World book year book, 1965.
44965 http://www.archive.org/details/1965worldbookyea00chic%20%7C%20http://www.openlibrary.org/books/OL24199089M
44968 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=88666
44970 -----------------------------------------------------------------</programlisting></para>
44974 <appendix id="kohacms">
44975 <title>Using Koha as a Content Management System (CMS)</title>
44979 <section id="kohacmssetup">
44980 <title>Setup</title>
44982 <para>These are instructions for taking a default install of Koha and allowing it to function
44983 as a little content management system. This will allow a library to publish an arbitrary
44984 number of pages based on a template. This example uses the template for the main opac page,
44985 but you could just as well use any template you wish with a bit more editing. This may be
44986 appropriate if you have a small library, want to allow librarians to easily add pages, and
44987 do not want to support a complete CMS. </para>
44991 <para>Copy /usr/share/koha/opac/cgi-bin/opac/opac-main.pl to
44992 /usr/share/koha/opac/cgi-bin/opac/pages.pl (in the same directory) </para>
44996 <para>Edit pages.pl in an editor</para>
45000 <para>At approximately line 33 change this code: </para>
45002 <programlisting>template_name => "opac-main.tmpl",</programlisting>
45006 <para>To this code:</para>
45008 <programlisting>template_name => "pages.tmpl", </programlisting>
45012 <para>At approximately line 62 after this code: </para>
45013 <programlisting>$template->param(
45014 koha_news => $all_koha_news,
45015 koha_news_count => $koha_news_count,
45016 display_daily_quote => C4::Context->preference('QuoteOfTheDay'),
45017 daily_quote => $quote,
45018 );</programlisting>
45021 <para>Add these lines: </para>
45022 <programlisting> my $page = "page_" . $cgi->param('p'); # go for "p" value in URL and do the concatenation
45023 my $preference = C4::Context->preference($page); # Go for preference
45024 $template->{VARS}->{'page_test'} = $preference # pass variable to template pages.tt</programlisting>
45028 <para>Note pages.pl file must have Webserver user execution permissions, you can use
45029 <ulink url="http://en.wikipedia.org/wiki/Chmod">chmod</ulink> command if you are
45030 actually logged in as such user:
45031 <programlisting> $chmod 755 pages.pl</programlisting></para>
45035 <para>In the browser go to Home > Administration > System Preferences > Local Use and add
45036 a New Preference called "page_test" </para>
45040 <para>Fill it out as so</para>
45044 <para>Explanation: test page for pages tiny cms</para>
45048 <para>Variable: page_test</para>
45052 <para>Value: Lorem ipsum</para>
45056 <para>Click the TextArea link (or enter "TextArea" into the
45057 input field below it)</para>
45061 <para>variable options (last field): 80|50</para>
45067 <para>In a browser go to http://youraddress/cgi-bin/koha/pages.pl?p=test The page should
45068 come up with the words "Lorem ipsum" in the main content area of the page. (replace
45069 "youraddress" with localhost, 127.0.0.1, or your domain name depending on how you have
45070 Apache set up.) </para>
45074 <para>To add more pages simply create a system preference where the title begins with
45075 "page_" followed by any arbitrary letters. You can add any markup you want as the value
45076 of the field. Reference the new page by changing the value of the "p" parameter in the
45080 <para>To learn more visit the Koha wiki page on this topic: <ulink url="http://wiki.koha-community.org/wiki/Koha_as_a_CMS">http://wiki.koha-community.org/wiki/Koha_as_a_CMS</ulink></para>
45081 <section id="kohacmstmpl">
45082 <title>Editing the pages template</title>
45083 <para>The file to create / edit for the pages template will depend on your opacthemes system preference setting i.e. bootstrap or prog (deprecated) or ccsr (deprecated)</para>
45084 <section id="kohacmstmplboot">
45085 <title>Editing 'bootstrap' theme template (current)</title>
45088 <para>Copy /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/opac-main.tt to /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/pages.tt</para>
45091 <para>Edit /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/pages.tt</para>
45094 <para>At approximately line 61, change this:
45095 <programlisting> [% IF ( OpacMainUserBlock ) %]<div id="opacmainuserblock">[% OpacMainUserBlock %]</div>[% END %]</programlisting></para>
45099 <programlisting> [% IF ( page_test ) %]<div id="opacmainuserblock">[% page_test %]</div>[% END %]</programlisting></para>
45102 <para>Remark: You may wish to disable your News block of these CMS style pages e.g. when you do not want it displayed on the CMS style pages or where the News block is long enough that it actually makes the 'page_test' include scroll outside the default viewport dimensions. In that case, remove the following code from your pages.tt template.
45104 [% IF ( koha_news_count ) %]
45106 <table class="table table-bordered">
45107 [% FOREACH koha_new IN koha_news %]
45108 <thead><tr><th>[% koha_new.title %]</th></tr></thead>
45109 <tbody><tr><td><p>[% koha_new.new %]</p>
45110 <p class="newsfooter"><i>(published on [% koha_new.newdate %])</i></p></td></tr></tbody>
45118 <section id="kohacmstmplprog">
45119 <title>Editing 'prog' theme template (deprecated)</title>
45122 <para>Copy /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/opac-main.tt to /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/pages.tt</para>
45125 <para>Edit /usr/share/koha/opac/htdocs/opac-tmpl/prog/en/modules/pages.tt</para>
45128 <para>At approximately line 40, change this:
45129 <programlisting> <div id="opacmainuserblock" class="container">[% OpacMainUserBlock %]</div></programlisting></para>
45133 <programlisting> <div id="opacmainuserblock" class="container">[% page_test %]</div></programlisting></para>
45138 <section id="kohacmstrouble">
45139 <title>Troubleshooting</title>
45141 <para>If you have problems check file permissions on pages.pl and
45142 pages.tmpl. They should have the same user and group as other Koha
45143 files like opac-main.pl.</para>
45146 <section id="kohacmsbonus">
45147 <title>Bonus Points</title>
45149 <para>Instead of using the address
45150 http://youraddress/cgi-bin/koha/pages.pl?p=test you can shorten it to
45151 http://youraddress/pages.pl?p=test Just open up
45152 /etc/koha/koha-httpd.conf and add the follow at about line
45153 13:<programlisting>ScriptAlias /pages.pl "/usr/share/koha/opac/cgi-bin/opac/pages.pl" </programlisting></para>
45155 <para>Then restart Apache.</para>
45159 <section id="kohacmsusage">
45160 <title>Usage</title>
45162 <para>After setting up Koha as a CMS you can create new pages following
45163 these instructions:</para>
45165 <section id="kohacmspages">
45166 <title>Adding Pages</title>
45168 <para>To add a new page you need to add a system preference under
45173 <para>Get there: More > Administration > Global System
45174 Preferences > Local Use</para>
45178 <para>Click 'New Preference'</para>
45182 <para>Enter in a description in the Explanation field</para>
45186 <para>Enter a value that starts with 'page_' in the Variable
45191 <para>Enter starting HTML in the Value field</para>
45194 <screeninfo>Add a new preference</screeninfo>
45198 <imagedata fileref="images/appendix-cms/newpreference.png"/>
45205 <para>Set the Variable Type to Textarea</para>
45209 <para>Set the Variable options to something like 20|20 for 20 rows
45210 and 20 columns</para>
45213 <screeninfo>Settings for the new preference</screeninfo>
45217 <imagedata fileref="images/appendix-cms/newpref-settings.png"/>
45225 <section id="kohacmsview">
45226 <title>Viewing your page</title>
45228 <para>You can view your new page at
45229 http://YOUR-OPAC/cgi-bin/koha/pages.pl?p=PAGENAME where PAGENAME is
45230 the part you entered after 'page_' in the Variable field.</para>
45233 <section id="kohacmsexpage">
45234 <title>Example</title>
45236 <para>This process can be used to create recommended reading lists
45237 within Koha. So once the code changes have been made per the
45238 instructions on 'Koha as a CMS' you go through the 'Adding a New Page'
45239 instructions above to great a page for 'Recommended Reading
45243 <screeninfo>Create page by modifying a system
45244 preference</screeninfo>
45248 <imagedata fileref="images/appendix-cms/recommendedreading.png"/>
45253 <para>Next we need to create pages for our various classes (or
45254 categories). To do this, return to the 'Adding a New Page' section and
45255 create a preference for the first class.</para>
45258 <screeninfo>Add a new sys pref for another page</screeninfo>
45262 <imagedata fileref="images/appendix-cms/class101-pref.png"/>
45267 <para>Next you'll want to link your first page to your new second
45268 page, go to the page_recommend preference and click 'Edit.' Now you
45269 want to edit the HTML to include a link to your newest page:</para>
45272 <screeninfo>Edit original preference to add new page</screeninfo>
45276 <imagedata fileref="images/appendix-cms/editrecommendpref.png"/>
45282 <section id="examplecms">
45283 <title>Live Examples</title>
45287 <para>The Crawford Library at Dallas Christian College is using
45288 this method for their recommended reading lists: <ulink url="http://opac.dallas.edu/">http://opac.dallas.edu/</ulink></para>
45295 <appendix id="resetkohadb">
45296 <title>Resetting the Koha Database</title>
45298 <para>These notes on how to reset the database for Koha were derived from the following email
45300 url="http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html"
45301 >http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html</ulink></para>
45303 <para>Resetting the database may be useful if you install Koha with the
45304 sample data, and then wish to use real data without reinstalling the
45307 <section id="truncate">
45308 <title>Truncate Tables</title>
45310 <para>Use your preferred MySQL client to <ulink url="http://dev.mysql.com/doc/refman/5.0/en/truncate.html">truncate</ulink>
45311 the following tables:</para>
45319 <para>biblioitems</para>
45327 <para>auth_header</para>
45331 <para>sessions</para>
45335 <para>zebraqueue</para>
45340 <section id="resetzebra">
45341 <title>Reset the Zebra Index</title>
45343 <para>Run the following commands to reset the authorities and biblios
45344 Zebra indices. <programlisting>$ zebraidx -c /etc/koha/zebradb/zebra-authorities-dom.cfg -g iso2709 -d authorities init
45345 $ zebraidx -c /etc/koha/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
45346 <para>If you are running a package install then you'll want to run the following commands to
45347 reset the authorities and biblios Zebra indices
45348 instead:<programlisting>$ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-authorities-dom.cfg -g iso2709 -d authorities init
45349 $ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-biblios.cfg -g iso2709 -d biblios init </programlisting></para>
45350 <para>Replacing YOURLIBRARY with your Koha installation name.</para>
45354 <appendix id="importantlinks">
45355 <title>Important Links</title>
45359 <section id="koharelatedlinks">
45360 <title>Koha Related</title>
45364 <para>Report Koha Bugs - <ulink url="http://bugs.koha-community.org">http://bugs.koha-community.org</ulink></para>
45368 <para>Koha Versioning Control - <ulink url="http://git.koha-community.org/">http://git.koha-community.org/</ulink></para>
45372 <para>Database Structure - <ulink url="http://schema.koha-community.org"
45373 >http://schema.koha-community.org</ulink></para>
45377 <para>Koha as a CMS - <ulink url="http://wiki.koha-community.org/wiki/Koha_as_a_CMS">http://wiki.koha-community.org/wiki/Koha_as_a_CMS</ulink></para>
45381 <para>Kyles's Koha Tools - <ulink url="http://kylehall.info/index.php/projects/koha/"
45382 >http://kylehall.info/index.php/projects/koha/</ulink></para>
45386 <para>Koha Bibliography - <ulink url="http://www.zotero.org/groups/koha">http://www.zotero.org/groups/koha</ulink></para>
45390 <para>Koha Shared Links - <ulink url="http://groups.diigo.com/group/everything-koha">http://groups.diigo.com/group/everything-koha</ulink></para>
45394 <para>Koha Presentations - <ulink url="http://www.slideshare.net/group/koha-ils/slideshows">http://www.slideshare.net/group/koha-ils/slideshows</ulink></para>
45399 <section id="catalogrelatedlinks">
45400 <title>Cataloging Related</title>
45404 <para>Koha MARC Tutorials - <ulink url="http://www.pakban.net/brooke/">http://www.pakban.net/brooke/</ulink></para>
45408 <para>IRSpy Open Z39.50 Server Search - <ulink url="http://irspy.indexdata.com/"
45409 >http://irspy.indexdata.com/</ulink></para>
45413 <para>Z39.50 Server List - <ulink
45414 url="http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm"
45415 >http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm</ulink></para>
45418 <para>Open Koha Z39.50 Targets - <ulink
45419 url="http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources"
45420 >http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources</ulink></para>
45424 <para>Library of Congress Authorities - <ulink url="http://authorities.loc.gov/">http://authorities.loc.gov/</ulink></para>
45428 <para>MARC Country Codes - <ulink url="http://www.loc.gov/marc/countries/">http://www.loc.gov/marc/countries/</ulink></para>
45432 <para>Search the MARC Code List for Organizations - <ulink url="http://www.loc.gov/marc/organizations/org-search.php">http://www.loc.gov/marc/organizations/org-search.php</ulink></para>
45436 <para>Search for Canadian MARC Codes - <ulink url="http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1">http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1</ulink></para>
45440 <para>Z39.50 Bib-1 Attribute - <ulink url="http://www.loc.gov/z3950/agency/defns/bib1.html">http://www.loc.gov/z3950/agency/defns/bib1.html</ulink></para>
45445 <section id="enhancedcontentlinks">
45446 <title>Enhanced Content Related</title>
45450 <para>Amazon Associates - <ulink url="https://affiliate-program.amazon.com/">https://affiliate-program.amazon.com</ulink></para>
45454 <para>Amazon Web Services - <ulink url="http://aws.amazon.com">http://aws.amazon.com</ulink></para>
45458 <para>WorldCat Affiliate Tools - <ulink url="http://www.worldcat.org/wcpa/do/AffiliateUserServices?method=initSelfRegister">http://www.worldcat.org/wcpa/do/AffiliateUserServices?method=initSelfRegister</ulink></para>
45462 <para>XISBN - <ulink url="http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp">http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp</ulink></para>
45466 <para>LibraryThing for Libraries - <ulink url="http://www.librarything.com/forlibraries">http://www.librarything.com/forlibraries</ulink></para>
45471 <section id="opaclinks">
45472 <title>Design Related</title>
45476 <para>JQuery Library - <ulink url="http://wiki.koha-community.org/wiki/JQuery_Library"
45477 >http://wiki.koha-community.org/wiki/JQuery_Library</ulink></para>
45480 <para>HTML & CSS Library - <ulink
45481 url="http://wiki.koha-community.org/wiki/HTML_%26_CSS_Library"
45482 >http://wiki.koha-community.org/wiki/HTML_%26_CSS_Library</ulink></para>
45486 <para>Owen Leonard's Koha Blog - <ulink url="http://www.myacpl.org/koha">http://www.myacpl.org/koha</ulink></para>
45491 <section id="reportlinks">
45492 <title>Reports Related</title>
45496 <para>SQL Reports Library - <ulink url="http://wiki.koha-community.org/wiki/SQL_Reports_Library">http://wiki.koha-community.org/wiki/SQL_Reports_Library</ulink></para>
45500 <para>Database Schema - <ulink url="http://schema.koha-community.org">http://schema.koha-community.org</ulink></para>
45504 <para>Sample reports from NEKLS - <ulink
45505 url="http://www.nexpresslibrary.org/training/reports-training/"
45506 >http://www.nexpresslibrary.org/training/reports-training/</ulink></para>
45511 <section id="installlinks">
45512 <title>Installation Guides</title>
45516 <para>Installing Koha 3 on Ubuntu - <ulink url="http://www.blazingmoon.org/guides/k3-on-u810-1.html">http://www.blazingmoon.org/guides/k3-on-u810-1.html</ulink></para>
45520 <para>Koha on Debian installation documentation - <ulink url="http://openlib.org/home/krichel/courses/lis508/doc/koha_installation_overview.html">http://openlib.org/home/krichel/courses/lis508/doc/koha_installation_overview.html</ulink></para>
45524 <para>Koha 3.2 on Debian Squeeze - <ulink url="http://wiki.koha-community.org/wiki/Koha_3.2_on_Debian_Squeeze">http://wiki.koha-community.org/wiki/Koha_3.2_on_Debian_Squeeze</ulink></para>
45529 <section id="misclinks">
45530 <title>Misc</title>
45534 <para>Zotero - <ulink url="http://zotero.org">http://zotero.org</ulink></para>
45538 <para>SOPAC - <ulink url="http://thesocialopac.net/">http://thesocialopac.net</ulink></para>
45544 <appendix id="XSLTiTypes">
45545 <title>Koha XSLT Item Types</title>
45547 <para>When you have any of the XSLT system preferences (<link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link>, <link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link>, <link linkend="XSLTDetailsDisplay">XSLTDetailsDisplay</link>, and/or <link linkend="XSLTResultsDisplay">XSLTResultsDisplay</link>) along with the
45548 <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
45549 preference turned on you will see item type icons on the related screen.
45551 <para>These images are coming from values found in your leader, if
45552 your leader is not cataloged properly it might be best to turn off the
45553 <link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link>
45554 preference (which can be done while leaving the other XSLT preferences
45556 </important></para>
45559 <screeninfo>Book image</screeninfo>
45563 <imagedata fileref="images/appendix-xslt/book.png"/>
45570 <para>Book [BK]</para>
45574 <para>leader6 = a (and one of the leader7 values below)</para>
45578 <para>leader7 = a</para>
45582 <para>leader7 = c</para>
45586 <para>leader7 = d</para>
45590 <para>leader7 = m</para>
45596 <para>leader6 = t</para>
45603 <screeninfo>Computer Image</screeninfo>
45607 <imagedata fileref="images/appendix-xslt/comp.png"/>
45614 <para>Computer File [CF]</para>
45618 <para>leader6 = m</para>
45625 <screeninfo>Continuing Resource Image</screeninfo>
45629 <imagedata fileref="images/appendix-xslt/cr.png"/>
45636 <para>Continuing Resource [CR]</para>
45640 <para>leader7 = b</para>
45644 <para>leader7 = i</para>
45648 <para>leader7 = s</para>
45655 <screeninfo>Map Image</screeninfo>
45659 <imagedata fileref="images/appendix-xslt/map.png"/>
45666 <para>Map [MP]</para>
45670 <para>leader6 = e</para>
45674 <para>leader6 = f</para>
45681 <screeninfo>Mixed Materials Image</screeninfo>
45685 <imagedata fileref="images/appendix-xslt/mixed.png"/>
45692 <para>Mixed [MX]</para>
45696 <para>leader6 = p</para>
45703 <screeninfo>Sound Image</screeninfo>
45707 <imagedata fileref="images/appendix-xslt/sound.png"/>
45714 <para>Sound [MU]</para>
45718 <para>leader6 = c</para>
45722 <para>leader6 = d</para>
45726 <para>leader6 = i</para>
45730 <para>leader6 = j</para>
45737 <screeninfo>Visual Material Image</screeninfo>
45741 <imagedata fileref="images/appendix-xslt/visual.png"/>
45748 <para>Visual Material [VM]</para>
45752 <para>leader6 = g</para>
45756 <para>leader6 = k</para>
45760 <para>leader6 = r</para>
45767 <screeninfo>Kit Image</screeninfo>
45771 <imagedata fileref="images/appendix-xslt/kit.png"/>
45782 <para>leader6 = o</para>
45789 <appendix id="marcedit">
45790 <title>MarcEdit</title>
45792 <para>Download MarcEdit : <ulink url="http://marcedit.reeset.net/"
45793 >http://marcedit.reeset.net/</ulink></para>
45795 <section id="marceditprefix">
45796 <title>Adding a prefix to call numbers</title>
45798 <para>When bringing data into Koha, you may want to first clean it up.
45799 One common action among Koha users is to add a prefix to the call
45804 <para>Open MarcEdit</para>
45807 <screeninfo>MarcEdit</screeninfo>
45811 <imagedata fileref="images/appendix-marcedit/marcedit.png"/>
45818 <para>Click 'MarcEditor'</para>
45822 <para>Go to Tools > Edit Subfield Data</para>
45825 <screeninfo>Edit subfield data</screeninfo>
45829 <imagedata fileref="images/appendix-marcedit/marcedit-editsubfield.png"/>
45836 <para>To prepend data the special character is: ^b To simply
45837 prepend data to the beginning of a subfield, add ^b to the Field
45838 Data: textbox and the data to be appended in the Replace</para>
45841 <screeninfo>Prepend data to a field</screeninfo>
45845 <imagedata fileref="images/appendix-marcedit/editsubfield.png"/>
45852 <para>To prepend data to the beginning of the subfield while
45853 replacing a text string, add ^b[string to replace] to the Field
45854 Data textbox and the data to be appended in the Replace With
45862 <section id="marceditexcel">
45866 <firstname>Kanika</firstname>
45867 <surname>Goyal</surname>
45869 <orgname>Delhi Technological University</orgname>
45874 <firstname>Nicole C.</firstname>
45875 <surname>Engard</surname>
45876 <contrib>Edits where necessary.</contrib>
45880 <pubdate>2010</pubdate>
45882 <bibliosource><ulink url="http://www.botskool.com/geeks/how-import-excel-data-koha">http://www.botskool.com/geeks/how-import-excel-data-koha</ulink></bibliosource>
45884 <title>Importing Excel data into Koha</title>
45886 <para>Suppose you have records of your library in excel data sheet
45887 format and want them to import into Koha. But how will you do this? Koha
45888 will not let you import excel records directly. Well here is a very
45889 simple solution for you which will let you import your excel records in
45890 Koha easily. First, we will convert excel file into Marc file and then
45891 will import it into Koha.</para>
45893 <para>Follow the given steps to import your excel records into
45896 <section id="convertexcel">
45897 <title>Converting from Excel format into .mrk format</title>
45899 <para>First, we will convert excel format into .mrk format. For this we will use MarcEdit.
45900 You can download it from <ulink url="http://marcedit.reeset.net/"
45901 >http://marcedit.reeset.net/</ulink></para>
45903 <para>Now open it and select Add-ins-->Delimited Text
45907 <screeninfo>Delimited Text Translator</screeninfo>
45911 <imagedata fileref="images/appendix-marcedit/excelimport/step-1.png"/>
45916 <para>Click Next when the following window appears.</para>
45919 <screeninfo>Delimited Text Translator</screeninfo>
45923 <imagedata fileref="images/appendix-marcedit/excelimport/step-2.png"/>
45928 <para>Browse for your excel file.</para>
45931 <screeninfo>Delimited Text Translator</screeninfo>
45935 <imagedata fileref="images/appendix-marcedit/excelimport/step-3.png"/>
45940 <para>Locate your excel file by choosing the format Excel
45941 File(*.xls).</para>
45944 <screeninfo>Delimited Text Translator</screeninfo>
45948 <imagedata fileref="images/appendix-marcedit/excelimport/step-4.png"/>
45953 <para>Similarly, fill all the other entries such as Output File, Excel
45954 Sheet Name and check UTF-8 Encoded (if required) and Click
45958 <screeninfo>Delimited Text Translator</screeninfo>
45962 <imagedata fileref="images/appendix-marcedit/excelimport/step-5.png"/>
45967 <para>Now you will be prompted for mapping the fields to recognise the
45968 fields by standard marc format.</para>
45970 <para>Suppose for Field 0 that is first column I entered Map to:
45971 022$a( Valid ISSN for the continuing resource) and then click on
45975 <screeninfo>Delimited Text Translator</screeninfo>
45979 <imagedata fileref="images/appendix-marcedit/excelimport/step-6.png"/>
45985 <para>You can customize Indicators and all other things, for more
45986 information on marc21 format visit the <ulink url="http://www.loc.gov/marc/bibliographic/">official library of
45987 congress site</ulink>.</para>
45990 <para>Similarly map all other fields and then Click on Finish.</para>
45993 <screeninfo>Delimited Text Translator</screeninfo>
45997 <imagedata fileref="images/appendix-marcedit/excelimport/step-7.png"/>
46002 <para>And then a window will appear indicating that your Marc Text
46003 File(*.mrk) has been created.</para>
46006 <screeninfo>Delimited Text Translator</screeninfo>
46010 <imagedata fileref="images/appendix-marcedit/excelimport/step-8.png"/>
46015 <para>Click Close and we have created a .mrk file from .xls file in
46016 this step. You can view the file by double clicking on it.</para>
46019 <section id="convertmrk">
46020 <title>Convert .mrk file to .mrc</title>
46022 <para>We will convert .mrk file that we have created in the above step
46023 into raw Marc format that can be directly imported into Koha.</para>
46025 <para>For this again open MarcEdit and Select MARC Tools.</para>
46028 <screeninfo>MARC Tools</screeninfo>
46032 <imagedata fileref="images/appendix-marcedit/excelimport/step-9.png"/>
46037 <para>Next Select MarcMaker to convert .mrk file into .mrc
46041 <screeninfo>MarcMaker</screeninfo>
46045 <imagedata fileref="images/appendix-marcedit/excelimport/step-10.png"/>
46050 <para>Locate your input file and name your output file. Then Click
46054 <screeninfo>MarcMaker</screeninfo>
46058 <imagedata fileref="images/appendix-marcedit/excelimport/step-11.png"/>
46063 <para>And it will show you the Result.</para>
46066 <screeninfo>MarcMaker</screeninfo>
46070 <imagedata fileref="images/appendix-marcedit/excelimport/step-12.png"/>
46075 <para>Click Close and now we have raw Marc records with us (.mrc
46079 <section id="importmrc">
46080 <title>Import .mrc into Koha</title>
46082 <para>More information on importing records into Koha can be found in
46083 the '<link linkend="stagemarc">Stage MARC Records for Import</link>'
46084 section of this manual.</para>
46086 <para>Finally we will import above created .mrc file into Koha.</para>
46088 <para>Click on Tools in your Koha staff client.</para>
46091 <screeninfo>Koha Staff Client</screeninfo>
46095 <imagedata fileref="images/appendix-marcedit/excelimport/step-13.png"/>
46100 <para>Next Click on Stage MARC Records for Import.</para>
46103 <screeninfo>Stage MARC Records for Import</screeninfo>
46107 <imagedata fileref="images/appendix-marcedit/excelimport/step-14.png"/>
46112 <para>After this, choose your previously created .mrc file and click
46116 <screeninfo>Stage File</screeninfo>
46120 <imagedata fileref="images/appendix-marcedit/excelimport/step-15.png"/>
46125 <para>You can also add comment about file and finally click on Stage
46129 <screeninfo>Stage for Import</screeninfo>
46133 <imagedata fileref="images/appendix-marcedit/excelimport/step-17.png"/>
46138 <para>When the import is done, you will get a result something like
46142 <screeninfo>Staged Records Summary</screeninfo>
46146 <imagedata fileref="images/appendix-marcedit/excelimport/step-18.png"/>
46151 <para>Next, click on Manage staged records.</para>
46153 <para>Here you can even change matching rules.</para>
46156 <screeninfo>Manage Staged Records</screeninfo>
46160 <imagedata fileref="images/appendix-marcedit/excelimport/step-19.png"/>
46165 <para>Click on Import this batch into catalog when you are
46168 <para>Thats it. After all the records get imported, check Status and
46169 it should read "imported"</para>
46172 <screeninfo>Finalize Import</screeninfo>
46176 <imagedata fileref="images/appendix-marcedit/excelimport/step-20.png"/>
46181 <para>You can even undo the Import operation.</para>
46183 <para>And within few minutes, we have imported around 10,000 records
46189 <appendix id="talkingtechappendix">
46190 <title>Talking Tech</title>
46192 <para>Talking Tech I-tiva is a third party, proprietary, product that
46193 libraries can subscribe to. Learn more here: <ulink url="http://www.talkingtech.com/solutions/library">http://www.talkingtech.com/solutions/library</ulink>.</para>
46195 <section id="talkingtechinstall">
46196 <title>Installation and Setup Instructions</title>
46198 <para>Be sure you've run
46199 installer/data/mysql/atomicupdate/Bug-4246-Talking-Tech-itiva-phone-notifications.pl
46200 to install the required data pack (new syspref, notice placeholders and
46201 messaging transport preferences)</para>
46203 <para>To use, <link linkend="TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</link>
46204 syspref must be turned on.</para>
46206 <para>If you wish to process PREOVERDUE or RESERVES messages, you'll
46207 need the <link linkend="EnhancedMessagingPreferences">EnhancedMessagingPreferences</link>
46208 system preference turned on, and patrons to have filled in a preference
46209 for receiving these notices by phone.</para>
46211 <para>For OVERDUE messages, overdue notice triggers must be configured
46212 under Koha -> Tools -> <link linkend="noticetriggers">Overdue
46213 Notice Triggers</link>. Either branch-specific triggers or the default
46214 level triggers may be used (script will select whichever is
46215 appropriate).</para>
46218 <section id="talkingtechsend">
46219 <title>Sending Notices File</title>
46223 <para>Add the <link linkend="talkingtechsendcron">TalkingTech_itiva_outbound.pl</link>
46224 script to your crontab</para>
46228 <para>Add an FTP/SFTP or other transport method to send the output
46229 file to the I-tiva server</para>
46233 <para>If you wish, archive the sent notices file in another
46234 directory after sending</para>
46238 <para>Run TalkingTech_itiva_outbound.pl --help for more
46242 <section id="talkingtechreceive">
46243 <title>Receiving Results File</title>
46247 <para>Add an FTP/SFTP or other transport method to send the Results
46248 file to a known directory on your Koha server</para>
46252 <para>Add the <link linkend="talkingtechreceivecron">TalkingTech_itiva_inbound.pl</link>
46253 script to your crontab, aimed at that directory</para>
46257 <para>If you wish, archive the results file in another directory
46258 after processing</para>
46262 <para>Run TalkingTech_itiva_inbound.pl --help for more
46266 <appendix id="oclcappendix">
46267 <title>OCLC Connexion Gateway</title>
46268 <para>Koha can be set to work with the OCLC Connextion Gateway. This allows libraries to use
46269 OCLC Connexion as their cataloging tool and simply send those records to Koha with a single
46270 click. The following instructions will help you set up the OCLC Connexion Gateway, if you
46271 have a system administrator you will want to consult with them on this process.</para>
46272 <section id="oclckohasetup">
46276 <firstname>D. Ruth</firstname>
46277 <surname>Bavousett</surname>
46279 <orgname>ByWater Solutions</orgname>
46284 <firstname>Nicole C.</firstname>
46285 <surname>Engard</surname>
46289 <pubdate>2012</pubdate>
46291 <title>Setting up OCLC service on Koha</title>
46292 <para>First, you'll need to create a file somewhere on your system with configuration
46293 information. You could put this anywhere that is visible to the account that will be
46294 running the service. </para>
46295 <para>The file contains 11 lines. The first 6 will be about your Koha
46296 system:<programlisting>host: The IP address of your Koha server
46297 port: The port you want to use for the Connexion service. This port must be different from your SIP port, or any other service
46298 koha: The full URL of your staff client
46299 log: The location (full file specification) of your log for the service
46300 user: The default Koha username to use for importing
46301 password: The password that goes with that username</programlisting></para>
46302 <para>The remaining lines describe how to do the staging:
46303 <programlisting>match: The name of the matching rule from your system to use
46304 overlay_action: "replace", "create_new", or "ignore"-- what to do if there is a match
46305 nomatch_action: "create_new" or "ignore"-- what to do if there is no match
46306 item_action: "always_add","add_only_for_matches","add_only_for_new", or "ignore" -- what to do with embedded 952 item data
46307 import_mode: "direct" or "stage"</programlisting></para>
46308 <para> A sample file would look like
46309 this:<programlisting>host: 1.2.3.4
46311 log: /home/koha/koha-dev/var/log/connexion.log
46312 koha: http://kohastaff.myuniversity.edu
46313 user: koha_generic_staff
46316 overlay_action: replace
46317 nomatch_action: create_new
46318 item_action: ignore
46319 import_mode: direct</programlisting></para>
46320 <para>When choosing an 'import_mode' if you use "direct" then the staged record will be
46321 immediately imported into Koha, and should be searchable after your indexes catch up. If
46322 you choose "stage", then the record will be placed in a staged batch for you to later go the
46323 <link linkend="managestaged">Managed Staged MARC Records</link> tool to finish the import. </para>
46324 <para>If you import multiple records, they'll be in the same batch, until that batch is
46325 imported, then a new batch will be created. </para>
46326 <para>In "direct" mode, each record will be in its' own batch. </para>
46327 <para>To start the service, run the script:
46328 <programlisting>/location/of/connexion/import/daemon/connexion_import_daemon.pl -d -c /location/of/config/file.cnf</programlisting></para>
46330 <section id="oclcdesktopsetup">
46334 <firstname>D. Ruth</firstname>
46335 <surname>Bavousett</surname>
46337 <orgname>ByWater Solutions</orgname>
46342 <firstname>Heather</firstname>
46343 <surname>Hernandez</surname>
46345 <orgname>San Francisco Maritime National Historical Park</orgname>
46350 <firstname>Nicole C.</firstname>
46351 <surname>Engard</surname>
46355 <pubdate>2012/2014</pubdate>
46357 <title>Setting up your OCLC desktop client</title>
46359 <para>Screenshots are OCLC Connexion Client v.2.50, Koha v.3.12</para>
46361 <para>To set up the OCLC Connexion desktop client to connect to Koha, go to Tools > Options,
46362 then choose the Export tab. <screenshot>
46363 <screeninfo>Connexion Export Tab</screeninfo>
46366 <imagedata fileref="images/appendix-oclc/oclcexporttab.png"/>
46369 </screenshot><itemizedlist>
46371 <para>Click the "Create..." button to set up a new destination, then choose "OCLC
46372 Gateway Export" and click OK.</para>
46375 <para>Enter the following information:</para>
46379 <para>"Host Name:" Your catalog’s appropriate IP address (from your <link
46380 linkend="oclckohasetup">config file above</link>) </para>
46383 <para>"Port:" Your catalog's appropriate port number (from your <link
46384 linkend="oclckohasetup">config file above</link>) </para>
46387 <para>"Login ID:" The cataloger's Koha login </para>
46390 <para>"Password:" The cataloger's Koha password </para>
46393 <para>"Notify Host Before Disconnect" = checked, </para>
46396 <para>"Timeout" = 100, "Retries" = 3, "Delay" = 0 (zero), </para>
46399 <para>"Send Local System Logon ID Password" = checked. </para>
46405 <screeninfo>OCLC Gateway Export Settings</screeninfo>
46408 <imagedata fileref="images/appendix-oclc/oclcgatewaysetup.png"/>
46414 <para>Select "OK" when finished, and you should see your new "Gateway Export" option
46415 listed (The catalog's IP address and port are blacked out in the following
46419 <screeninfo>Gateway Export Added</screeninfo>
46422 <imagedata fileref="images/appendix-oclc/oclcgatewayexport.png"/>
46429 <para>Click on "Record Characteristics" and make sure that the bibliographic records are
46430 using MARC21, UTF-8 Unicode, and click OK to save. </para>
46433 <screeninfo>Record Characteristics</screeninfo>
46436 <imagedata fileref="images/appendix-oclc/oclcrecordchar.png"/>
46442 </itemizedlist></para>
46443 <para>You should be ready to go! To export a record from OCLC Connexion Client to Koha, just
46444 press F5 while the record is on-screen. The export dialog will pop up, and you'll see
46445 Connexion attempting to talk to Koha. You should get a message that the record was added or
46446 overlaid, including its biblio number, and a URL that you can copy into your web browser to
46447 jump straight to the record. </para>
46449 <section id="oclcgateway">
46453 <firstname>Heather</firstname>
46454 <surname>Hernandez</surname>
46456 <orgname>San Francisco Maritime National Historical Park</orgname>
46460 <firstname>Nicole C.</firstname>
46461 <surname>Engard</surname>
46464 <pubdate>2014</pubdate>
46466 <title>Using the OCLC Connexion Gateway</title>
46467 <para>Records can be exported from Connexion either in a batch or one by one. </para>
46468 <section id="oclconeexport">
46469 <title>Exporting records one by one</title>
46470 <para>To export bibliographic records one by one, be sure your "Batch" options are correct:
46471 from the "Tools" menu, select "Options", and select the "Batch" tab. In the "Perform local
46472 actions in batch" area, "Bibliographic Record Export" should be unchecked<screenshot>
46473 <screeninfo>Connexion batch options</screeninfo>
46476 <imagedata fileref="images/appendix-oclc/oclcoptions.png"/>
46479 </screenshot></para>
46480 <para>When ready to export, from the "Action" menu, select "Export" or use the F5 key. You
46481 will see a screen similar to the following if the import is successful and if the record
46482 is new to the Catalog; you may copy & paste the resulting URL into your Koha catalog
46483 to see the new record.<screenshot>
46484 <screeninfo>Connexion Export</screeninfo>
46487 <imagedata fileref="images/appendix-oclc/oclcstatus.png"/>
46490 </screenshot></para>
46491 <para>If the record was overlaid, you will see a message to that effect in the "OCLC Gateway
46492 Export Status" window<screenshot>
46493 <screeninfo>Overlay confirmation</screeninfo>
46496 <imagedata fileref="images/appendix-oclc/oclcoverlay.png"/>
46499 </screenshot></para>
46501 <section id="oclcbatchexport">
46502 <title>Exporting records in a batch</title>
46503 <para>To export bibliographic records in a batch, be sure your "Batch" options are correct:
46504 from the "Tools" menu, select "Options", and select the "Batch" tab. In the "Perform local
46505 actions in batch" area, "Bibliographic Record Export" should be checked<screenshot>
46506 <screeninfo>OCLC Batch Export Options</screeninfo>
46509 <imagedata fileref="images/appendix-oclc/oclcexportbatch.png"/>
46512 </screenshot></para>
46513 <para>When a record is ready to export, from the "Action" menu, select "Export" or use the
46514 F5 key, and it’s export status will be "ready." </para>
46515 <para>When ready to export the batch, from the "Batch" menu, select "Process batch" and
46516 check the appropriate "Path" and "Export" boxes<screenshot>
46517 <screeninfo>Batch import process</screeninfo>
46520 <imagedata fileref="images/appendix-oclc/oclcprocessbatch.png"/>
46523 </screenshot></para>
46524 <para>The export will begin, and the bib records will be exported & imported into Koha
46525 one by one; you will see "OCLC Gateway Export Status" windows, as above, showing you the
46526 results of each export. That window will stay there until you select "Close," and then the
46527 next record’s export/import will begin. The process will continue until all records in the
46528 batch are completed. Then you may or may not see the Connexion Client export report
46529 (depending on your Client options for that). </para>
46534 <appendix id="faqs">
46535 <title>FAQs</title>
46539 <section id="displayfaq">
46540 <title>Display</title>
46544 <section id="customicons">
46545 <title>Custom Item Type/Authorized Value Icons</title>
46547 <para><emphasis role="bold">Question:</emphasis> Can I have my own set
46548 of item type images (or authorized value icons)?</para>
46550 <para><emphasis role="bold">Answer: </emphasis>Absolutely. To add
46551 additional icons to your system you simply add a new directory to
46552 koha-tmpl/intranet-tmpl/prog/img/itemtypeimg/ and to
46553 koha-tmpl/opac-tmpl/prog/itemtypeimg and put your icons in the new
46554 directory. Your icons will show up in a new tab as soon as they are in
46555 the folders.</para>
46560 <para>Remember to put the icons in both places (on the OPAC and
46561 the intranet).</para>
46567 <section id="customkohaimages">
46568 <title>Customizing Koha Images</title>
46570 <para><emphasis role="bold">Question</emphasis>: Can I customize the
46571 images in the OPAC?</para>
46573 <para><emphasis role="bold">Answer</emphasis>: Absolutely. Koha comes
46574 with a series of original images that you can alter to meet your
46575 needs. The originals can be found in the misc/interface_customization/
46579 <section id="opacdisplayfaq">
46580 <title>OPAC Display Fields</title>
46582 <para><emphasis role="bold">Question</emphasis>: What MARC fields
46583 print to the different OPAC screens in Koha?</para>
46585 <para><emphasis role="bold">Answer</emphasis>: The XSLT preference
46586 must be set as follows for the following fields to show</para>
46590 <para><link linkend="OPACXSLTResultsDisplay">OPACXSLTResultsDisplay</link> =
46591 using XSLT stylesheets</para>
46595 <para><link linkend="OPACXSLTDetailsDisplay">OPACXSLTDetailsDisplay</link> =
46596 using XSLT stylesheets</para>
46600 <para><link linkend="DisplayOPACiconsXSLT">DisplayOPACiconsXSLT</link> =
46605 <para>The OPAC Results page shows:</para>
46613 <para>100, 110, 111</para>
46617 <para>700, 710, 711</para>
46637 <para>The OPAC Details page shows:</para>
46645 <para>100, 110, 111</para>
46649 <para>700, 710, 711</para>
46653 <para>440, 490</para>
46681 <para>130, 240</para>
46721 <para>plus all of the 5xx fields in the Notes tab at the
46727 <section id="displaysubtitle">
46728 <title>Subtitle Display on Bib Records</title>
46730 <para><emphasis role="bold">Question</emphasis>: How do I get the
46731 subtitle to display on the detail pages for my bib records?</para>
46733 <para><emphasis role="bold">Answer</emphasis>: Subtitle display now
46734 depends on there being a <link linkend="keywordmapping">keyword
46735 mapping</link> for the MARC field in question. Adding a mapping for
46736 "subtitle" -> "245b" for an item's framework results in display of
46737 the subtitle in OPAC and staff client search and detail pages
46738 (although not in all instances where subtitles might be displayed,
46739 e.g. the Cart).</para>
46742 <section id="customlogo">
46746 <firstname>Owen</firstname>
46747 <surname>Leonard</surname>
46749 <orgname>Athens County Public Library</orgname>
46753 <firstname>Nicole C.</firstname>
46754 <surname>Engard</surname>
46757 <pubdate>July 2010</pubdate>
46760 <title>Customize Logo on Staff Client</title>
46762 <para><emphasis role="bold">Question</emphasis>: How do I change the
46763 Koha logo on the Staff Client login page?</para>
46765 <para><emphasis role="bold">Answer</emphasis>: <link linkend="opacsmallimage">Opacsmallimage</link> controls the display of
46766 the Koha logo in the OPAC, but there is no system preference
46767 controlling the logo on the staff client login page. Luckily the logo
46768 is displayed via CSS so it can be easily customized through some
46771 <para>These are the relevant parts of the staff client default CSS:
46772 <programlisting>#login h1 {
46773 background:url("../../img/koha-logo.gif") no-repeat scroll center
46775 margin-bottom:0.5em;
46780 border-bottom:medium none;
46783 text-indent:-1000px;
46784 }</programlisting></para>
46786 <para>If you have access to the file system on your Koha server you
46787 can add a custom CSS file and specify that file using the <link linkend="intranetcolorstylesheet">intranetcolorstylesheet</link>
46788 system preference.</para>
46790 <para>There is no analogue to the <link linkend="OPACUserCSS">OPACUserCSS</link> preference in the staff
46791 client, but you can get around this by putting this in the <link linkend="intranetuserjs">intranetuserjs</link> preference:
46792 <programlisting>//]]>
46794 <style type="text/css">
46795 /* inline styles */
46797 <script type="text/javascript">
46798 //<![CDATA[</programlisting></para>
46800 <para>In the above snippet where it says /* inline styles */ we'll
46801 redeclare the relevant properties from the styles of the login
46802 image:<programlisting>//]]>
46804 <style type="text/css">
46805 /* inline styles */
46808 background:url("../../img/koha-logo.gif") no-repeat scroll center
46816 <script type="text/javascript">
46818 </programlisting></para>
46820 <para>I've only reproduced the properties necessary to make the change
46821 we want. You can see that the "background:" property sets the path to
46822 the default logo. You can change this to point to any image you want,
46823 on the Koha server or anywhere else. Then you just need to change the
46824 #login h1 a's "height" property to match the height of the image you
46827 <para>For example:</para>
46829 <para><programlisting>//]]>
46831 <style type="text/css">
46832 /* inline styles */
46835 background:url("http://www.myacpl.org/sites/all/themes/npl/logo.png")
46836 no-repeat scroll center top transparent;
46843 <script type="text/javascript">
46844 //<
projects / kohadocs.git / blob